chore!: fix workspace apps response (#17700)

BrunoQuaresma · web-flow · commit 9fe5b71d31d8 · 2025-05-07T10:05:07.000-03:00
Fix WorkspaceApp response type to better reflect the schema from https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app.
diff --git a/codersdk/workspaceapps.go b/codersdk/workspaceapps.go
@@ -60,14 +60,14 @@ type WorkspaceApp struct {
 	ID uuid.UUID `json:"id" format:"uuid"`
 	// URL is the address being proxied to inside the workspace.
 	// If external is specified, this will be opened on the client.
-	URL string `json:"url"`
+	URL string `json:"url,omitempty"`
 	// External specifies whether the URL should be opened externally on
 	// the client or not.
 	External bool `json:"external"`
 	// Slug is a unique identifier within the agent.
 	Slug string `json:"slug"`
 	// DisplayName is a friendly name for the app.
-	DisplayName string `json:"display_name"`
+	DisplayName string `json:"display_name,omitempty"`
 	Command     string `json:"command,omitempty"`
 	// Icon is a relative path or external URL that specifies
 	// an icon to be displayed in the dashboard.
@@ -81,7 +81,7 @@ type WorkspaceApp struct {
 	SubdomainName string                   `json:"subdomain_name,omitempty"`
 	SharingLevel  WorkspaceAppSharingLevel `json:"sharing_level" enums:"owner,authenticated,public"`
 	// Healthcheck specifies the configuration for checking app health.
-	Healthcheck Healthcheck        `json:"healthcheck"`
+	Healthcheck Healthcheck        `json:"healthcheck,omitempty"`
 	Health      WorkspaceAppHealth `json:"health"`
 	Hidden      bool               `json:"hidden"`
 	OpenIn      WorkspaceAppOpenIn `json:"open_in"`
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/src/modules/resources/AgentRow.test.tsx b/site/src/modules/resources/AgentRow.test.tsx
@@ -150,9 +150,9 @@ describe.each<{
 
 		for (const app of props.agent.apps) {
 			if (app.hidden) {
-				expect(screen.queryByText(app.display_name)).toBeNull();
+				expect(screen.queryByText(app.display_name as string)).toBeNull();
 			} else {
-				expect(screen.getByText(app.display_name)).toBeVisible();
+				expect(screen.getByText(app.display_name as string)).toBeVisible();
 			}
 		}
 	});
diff --git a/site/src/modules/resources/AgentRowPreview.test.tsx b/site/src/modules/resources/AgentRowPreview.test.tsx
@@ -91,8 +91,10 @@ describe("AgentRowPreviewApps", () => {
 		"<AgentRowPreview agent={$testName} /> displays appropriately",
 		({ workspaceAgent }) => {
 			renderComponent(<AgentRowPreview agent={workspaceAgent} />);
-			for (const module of workspaceAgent.apps) {
-				expect(screen.getByText(module.display_name)).toBeInTheDocument();
+			for (const app of workspaceAgent.apps) {
+				expect(
+					screen.getByText(app.display_name as string),
+				).toBeInTheDocument();
 			}
 
 			for (const app of workspaceAgent.display_apps) {
diff --git a/site/src/modules/resources/AgentRowPreview.tsx b/site/src/modules/resources/AgentRowPreview.tsx
@@ -31,7 +31,7 @@ export const AgentRowPreview: FC<AgentRowPreviewProps> = ({
 		>
 			<Stack direction="row" alignItems="baseline">
 				<div css={styles.agentStatusWrapper}>
-					<div css={styles.agentStatusPreview}></div>
+					<div css={styles.agentStatusPreview} />
 				</div>
 				<Stack
 					alignItems="baseline"
diff --git a/site/src/modules/resources/AppLink/AppLink.tsx b/site/src/modules/resources/AppLink/AppLink.tsx
@@ -43,24 +43,15 @@ export const AppLink: FC<AppLinkProps> = ({ app, workspace, agent }) => {
 	const appsHost = proxy.preferredWildcardHostname;
 	const [fetchingSessionToken, setFetchingSessionToken] = useState(false);
 	const [iconError, setIconError] = useState(false);
-
 	const theme = useTheme();
 	const username = workspace.owner_name;
-
-	let appSlug = app.slug;
-	let appDisplayName = app.display_name;
-	if (!appSlug) {
-		appSlug = appDisplayName;
-	}
-	if (!appDisplayName) {
-		appDisplayName = appSlug;
-	}
+	const displayName = app.display_name || app.slug;
 
 	const href = createAppLinkHref(
 		window.location.protocol,
 		preferredPathBase,
 		appsHost,
-		appSlug,
+		app.slug,
 		username,
 		workspace,
 		agent,
@@ -118,7 +109,7 @@ export const AppLink: FC<AppLinkProps> = ({ app, workspace, agent }) => {
 					// This is an external URI like "vscode://", so
 					// it needs to be opened with the browser protocol handler.
 					const shouldOpenAppExternally =
-						app.external && !app.url.startsWith("http");
+						app.external && app.url?.startsWith("http");
 
 					if (shouldOpenAppExternally) {
 						// This is a magic undocumented string that is replaced
@@ -140,9 +131,7 @@ export const AppLink: FC<AppLinkProps> = ({ app, workspace, agent }) => {
 						// an error message will be displayed.
 						const openAppExternallyFailedTimeout = 500;
 						const openAppExternallyFailed = setTimeout(() => {
-							displayError(
-								`${app.display_name !== "" ? app.display_name : app.slug} must be installed first.`,
-							);
+							displayError(`${displayName} must be installed first.`);
 						}, openAppExternallyFailedTimeout);
 						window.addEventListener("blur", () => {
 							clearTimeout(openAppExternallyFailed);
@@ -156,7 +145,7 @@ export const AppLink: FC<AppLinkProps> = ({ app, workspace, agent }) => {
 						case "slim-window": {
 							window.open(
 								href,
-								Language.appTitle(appDisplayName, generateRandomString(12)),
+								Language.appTitle(displayName, generateRandomString(12)),
 								"width=900,height=600",
 							);
 							return;
@@ -169,7 +158,7 @@ export const AppLink: FC<AppLinkProps> = ({ app, workspace, agent }) => {
 				}}
 			>
 				{icon}
-				{appDisplayName}
+				{displayName}
 				{canShare && <ShareIcon app={app} />}
 			</a>
 		</AgentButton>
diff --git a/site/src/modules/workspaces/WorkspaceAppStatus/WorkspaceAppStatus.tsx b/site/src/modules/workspaces/WorkspaceAppStatus/WorkspaceAppStatus.tsx
@@ -124,12 +124,11 @@ export const WorkspaceAppStatus = ({
 
 	let appHref: string | undefined;
 	if (app && agent) {
-		const appSlug = app.slug || app.display_name;
 		appHref = createAppLinkHref(
 			window.location.protocol,
 			preferredPathBase,
 			appsHost,
-			appSlug,
+			app.slug,
 			workspace.owner_name,
 			workspace,
 			agent,
diff --git a/site/src/pages/WorkspacePage/AppStatuses.tsx b/site/src/pages/WorkspacePage/AppStatuses.tsx
@@ -198,12 +198,11 @@ export const AppStatuses: FC<AppStatusesProps> = ({
 				const agent = agents.find((agent) => agent.id === status.agent_id);
 
 				if (currentApp && agent) {
-					const appSlug = currentApp.slug || currentApp.display_name;
 					appHref = createAppLinkHref(
 						window.location.protocol,
 						preferredPathBase,
 						appsHost,
-						appSlug,
+						currentApp.slug,
 						workspace.owner_name,
 						workspace,
 						agent,
diff --git a/site/src/utils/apps.ts b/site/src/utils/apps.ts
@@ -11,7 +11,7 @@ export const createAppLinkHref = (
 	app: TypesGen.WorkspaceApp,
 ): string => {
 	if (app.external) {
-		return app.url;
+		return app.url as string;
 	}
 
 	// The backend redirects if the trailing slash isn't included, so we add it

Original file line number	Diff line number	Diff line change
`@@ -150,9 +150,9 @@ describe.each<{`
`150`	`150`
`151`	`151`	`for (const app of props.agent.apps) {`
`152`	`152`	`if (app.hidden) {`
`153`		`- expect(screen.queryByText(app.display_name)).toBeNull();`
	`153`	`+ expect(screen.queryByText(app.display_name as string)).toBeNull();`
`154`	`154`	`} else {`
`155`		`- expect(screen.getByText(app.display_name)).toBeVisible();`
	`155`	`+ expect(screen.getByText(app.display_name as string)).toBeVisible();`
`156`	`156`	`}`
`157`	`157`	`}`
`158`	`158`	`});`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ export const AgentRowPreview: FC<AgentRowPreviewProps> = ({`
`31`	`31`	`>`
`32`	`32`	`<Stack direction="row" alignItems="baseline">`
`33`	`33`	`<div css={styles.agentStatusWrapper}>`
`34`		`- <div css={styles.agentStatusPreview}></div>`
	`34`	`+ <div css={styles.agentStatusPreview} />`
`35`	`35`	`</div>`
`36`	`36`	`<Stack`
`37`	`37`	`alignItems="baseline"`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ export const createAppLinkHref = (`
`11`	`11`	`app: TypesGen.WorkspaceApp,`
`12`	`12`	`): string => {`
`13`	`13`	`if (app.external) {`
`14`		`- return app.url;`
	`14`	`+ return app.url as string;`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`// The backend redirects if the trailing slash isn't included, so we add it`