fix: app display name validation (#344)

mtojek · web-flow · commit 4b3fc653e348 · 2025-02-13T12:32:48.000+01:00
diff --git a/provider/app.go b/provider/app.go
@@ -23,6 +23,8 @@ var (
 	appSlugRegex = regexp.MustCompile(`^[a-z0-9](-?[a-z0-9])*$`)
 )
 
+const appDisplayNameMaxLength = 64 // database column limit
+
 func appResource() *schema.Resource {
 	return &schema.Resource{
 		SchemaVersion: 1,
@@ -124,6 +126,17 @@ func appResource() *schema.Resource {
 				Description: "A display name to identify the app. Defaults to the slug.",
 				ForceNew:    true,
 				Optional:    true,
+				ValidateDiagFunc: func(val interface{}, c cty.Path) diag.Diagnostics {
+					valStr, ok := val.(string)
+					if !ok {
+						return diag.Errorf("expected string, got %T", val)
+					}
+
+					if len(valStr) > appDisplayNameMaxLength {
+						return diag.Errorf("display name is too long (max %d characters)", appDisplayNameMaxLength)
+					}
+					return nil
+				},
 			},
 			"subdomain": {
 				Type: schema.TypeBool,
diff --git a/provider/app_test.go b/provider/app_test.go
@@ -415,4 +415,66 @@ func TestApp(t *testing.T) {
 		}
 	})
 
+	t.Run("DisplayName", func(t *testing.T) {
+		t.Parallel()
+
+		cases := []struct {
+			name        string
+			displayName string
+			expectValue string
+			expectError *regexp.Regexp
+		}{
+			{
+				name:        "Empty",
+				displayName: "",
+			},
+			{
+				name:        "Regular",
+				displayName: "Regular Application",
+			},
+			{
+				name:        "DisplayNameStillOK",
+				displayName: "0123456789012345678901234567890123456789012345678901234567890123",
+			},
+			{
+				name:        "DisplayNameTooLong",
+				displayName: "01234567890123456789012345678901234567890123456789012345678901234",
+				expectError: regexp.MustCompile("display name is too long"),
+			},
+		}
+
+		for _, c := range cases {
+			c := c
+
+			t.Run(c.name, func(t *testing.T) {
+				t.Parallel()
+
+				config := fmt.Sprintf(`
+				provider "coder" {
+				}
+				resource "coder_agent" "dev" {
+					os = "linux"
+					arch = "amd64"
+				}
+				resource "coder_app" "code-server" {
+					agent_id = coder_agent.dev.id
+					slug = "code-server"
+					display_name = "%s"
+					url = "http://localhost:13337"
+					open_in = "slim-window"
+				}
+				`, c.displayName)
+
+				resource.Test(t, resource.TestCase{
+					ProviderFactories: coderFactory(),
+					IsUnitTest:        true,
+					Steps: []resource.TestStep{{
+						Config:      config,
+						ExpectError: c.expectError,
+					}},
+				})
+			})
+		}
+	})
+
 }
