fixup! feat: add slug property to app, use in URLs

coder · deansheather · Oct 28, 2022 · Oct 16, 2022 · Oct 16, 2022 · Oct 17, 2022
commit e6ddf3c358cd2a1c401b1c2892a332ccb2748d41
diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -814,8 +814,8 @@ func insertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 			if slug == "" {
 				return xerrors.Errorf("app must have a slug or name set")
 			}
-			if !provisioner.ValidAppNameRegex.MatchString(slug) {
-				return xerrors.Errorf("app slug %q does not match regex %q", slug, provisioner.ValidAppNameRegex.String())
+			if !provisioner.ValidAppSlugRegex.MatchString(slug) {
+				return xerrors.Errorf("app slug %q does not match regex %q", slug, provisioner.ValidAppSlugRegex.String())
 			}
 
 			health := database.WorkspaceAppHealthDisabled

diff --git a/provisioner/appname.go b/provisioner/appname.go
diff --git a/provisioner/appslug.go b/provisioner/appslug.go
@@ -0,0 +1,15 @@
+package provisioner
+
+import "regexp"
+
+var (
+	// ValidAppSlugRegex is the regex used to validate the slug of a coder_app
+	// resource. It must be a valid hostname and cannot contain two consecutive
+	// hyphens or start/end with a hyphen.
+	//
+	// This regex is duplicated in the terraform provider code, so make sure to
+	// update it there as well.
+	//
+	// There are test cases for this regex in appslug_test.go.
+	ValidAppSlugRegex = regexp.MustCompile(`^[a-z0-9](-?[a-z0-9])*$`)
+)
diff --git a/provisioner/appname_test.go → provisioner/appslug_test.go b/provisioner/appname_test.go → provisioner/appslug_test.go
@@ -8,7 +8,7 @@ import (
 	"github.com/coder/coder/provisioner"
 )
 
-func TestValidAppNameRegex(t *testing.T) {
+func TestValidAppSlugRegex(t *testing.T) {
 	t.Parallel()
 
 	t.Run("Valid", func(t *testing.T) {
@@ -32,7 +32,7 @@ func TestValidAppNameRegex(t *testing.T) {
 		}
 
 		for _, s := range validStrings {
-			require.True(t, provisioner.ValidAppNameRegex.MatchString(s), s)
+			require.True(t, provisioner.ValidAppSlugRegex.MatchString(s), s)
 		}
 	})
 
@@ -58,7 +58,7 @@ func TestValidAppNameRegex(t *testing.T) {
 		}
 
 		for _, s := range invalidStrings {
-			require.False(t, provisioner.ValidAppNameRegex.MatchString(s), s)
+			require.False(t, provisioner.ValidAppSlugRegex.MatchString(s), s)
 		}
 	})
 }
diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -221,8 +221,8 @@ func ConvertResources(module *tfjson.StateModule, rawGraph string) ([]*proto.Res
 		}
 
 		slug := resource.Name
-		if !provisioner.ValidAppNameRegex.MatchString(slug) {
-			return nil, xerrors.Errorf("invalid app name, must be a valid hostname (%q, cannot contain two consecutive hyphens or start/end with a hyphen): %q", provisioner.ValidAppNameRegex.String(), slug)
+		if !provisioner.ValidAppSlugRegex.MatchString(slug) {
+			return nil, xerrors.Errorf("invalid app slug, must be a valid hostname (%q, cannot contain two consecutive hyphens or start/end with a hyphen): %q", provisioner.ValidAppSlugRegex.String(), slug)
 		}
 
 		var attrs agentAppAttributes