Fix how app name is set from the AppLoader

Author: plvaldes

packages/app/src/cli/models/app/app.ts

@@ -48,6 +48,7 @@ export const LegacyAppSchema = zod
   .object({
     client_id: zod.number().optional(),
     name: zod.string().optional(),
+    handle: zod.string().optional(),
     scopes: zod
       .string()
       .transform((scopes) => normalizeDelimitedString(scopes) ?? '')
@@ -80,14 +81,16 @@ function fixSingleWildcards(value: string[] | undefined) {
  */
 export const AppSchema = zod.object({
   client_id: zod.string(),
+  extension_directories: ExtensionDirectoriesSchema,
+  name: zod.string().optional(),
+  handle: zod.string().optional(),
   build: zod
     .object({
       automatically_update_urls_on_dev: zod.boolean().optional(),
       dev_store_url: zod.string().optional(),
       include_config_on_deploy: zod.boolean().optional(),
     })
     .optional(),
-  extension_directories: ExtensionDirectoriesSchema,
   web_directories: zod.array(zod.string()).optional(),
 })
 
@@ -168,7 +171,7 @@ export function isLegacyAppSchema(item: AppConfiguration): item is LegacyAppConf
  */
 export function isCurrentAppSchema(item: AppConfiguration): item is CurrentAppConfiguration {
   const {path, ...rest} = item
-  return isType(AppSchema.nonstrict(), rest)
+  return isType(AppSchema.passthrough(), rest)
 }
 
 /**

packages/app/src/cli/models/app/loader.test.ts

@@ -264,7 +264,80 @@ wrong = "property"
     const app = await loadApp({directory: tmpDir, specifications: [], userProvidedConfigName: undefined})
 
     // Then
-    expect(app.name).toBe('my_app')
+    expect(app.name).toBe('for-testing')
+  })
+
+  test('uses handle from configuration as app name when present', async () => {
+    // Given
+    const appConfiguration = `
+name = "display-name"
+handle = "app-handle"
+client_id = "1234567890"
+application_url = "https://example.com/lala"
+embedded = true
+
+[webhooks]
+api_version = "2023-07"
+
+[auth]
+redirect_urls = [ "https://example.com/api/auth" ]
+`
+    await writeConfig(appConfiguration)
+
+    // When
+    const app = await loadTestingApp()
+
+    // Then
+    expect(app.name).toBe('app-handle')
+  })
+
+  test('uses name from configuration when handle is not present', async () => {
+    // Given
+    const appConfiguration = `
+name = "config-name"
+client_id = "1234567890"
+application_url = "https://example.com/lala"
+embedded = true
+
+[webhooks]
+api_version = "2023-07"
+
+[auth]
+redirect_urls = [ "https://example.com/api/auth" ]
+`
+    await writeConfig(appConfiguration)
+
+    // When
+    const app = await loadTestingApp()
+
+    // Then
+    expect(app.name).toBe('config-name')
+  })
+
+  test('falls back to package.json name when handle and name are not in configuration', async () => {
+    // Given
+    const appConfiguration = `
+client_id = "1234567890"
+application_url = "https://example.com/lala"
+embedded = true
+
+[webhooks]
+api_version = "2023-07"
+
+[auth]
+redirect_urls = [ "https://example.com/api/auth" ]
+`
+    await writeConfig(appConfiguration, {
+      name: 'package-json-name',
+      dependencies: {},
+      devDependencies: {},
+    })
+
+    // When
+    const app = await loadTestingApp()
+
+    // Then
+    expect(app.name).toBe('package-json-name')
   })
 
   test('defaults to npm as the package manager when the configuration is valid', async () => {

packages/app/src/cli/models/app/loader.ts

@@ -343,7 +343,8 @@ class AppLoader<TConfig extends AppConfiguration, TModuleSpec extends ExtensionS
     const packageJSONPath = joinPath(directory, 'package.json')
 
     // These don't need to be processed again if the app is being reloaded
-    const name = this.previousApp?.name ?? (await loadAppName(directory))
+    const configName = 'name' in configuration ? configuration.name : undefined
+    const name = this.previousApp?.name ?? configuration.handle ?? configName ?? (await loadAppName(directory))
     const nodeDependencies = this.previousApp?.nodeDependencies ?? (await getDependencies(packageJSONPath))
     const packageManager = this.previousApp?.packageManager ?? (await getPackageManager(directory))
     const usesWorkspaces = this.previousApp?.usesWorkspaces ?? (await appUsesWorkspaces(directory))

packages/app/src/cli/services/context/breakdown-extensions.test.ts

@@ -874,7 +874,7 @@ describe('configExtensionsIdentifiersBreakdown', () => {
 
       // Then
       expect(result).toEqual({
-        existingFieldNames: ['name', 'application_url', 'embedded', 'pos', 'app_proxy', 'webhooks'],
+        existingFieldNames: ['application_url', 'embedded', 'pos', 'app_proxy', 'webhooks'],
         existingUpdatedFieldNames: [],
         newFieldNames: [],
         deletedFieldNames: [],
@@ -965,7 +965,7 @@ describe('configExtensionsIdentifiersBreakdown', () => {
 
       // Then
       expect(result).toEqual({
-        existingFieldNames: ['name', 'application_url', 'embedded', 'webhooks'],
+        existingFieldNames: ['application_url', 'embedded', 'webhooks'],
         existingUpdatedFieldNames: [],
         newFieldNames: [],
         deletedFieldNames: [],
@@ -1055,7 +1055,7 @@ describe('configExtensionsIdentifiersBreakdown', () => {
 
       // Then
       expect(result).toEqual({
-        existingFieldNames: ['name', 'webhooks'],
+        existingFieldNames: ['webhooks'],
         existingUpdatedFieldNames: ['application_url', 'embedded'],
         newFieldNames: [],
         deletedFieldNames: [],
@@ -1114,7 +1114,7 @@ describe('configExtensionsIdentifiersBreakdown', () => {
       expect(result).toEqual({
         existingFieldNames: ['application_url', 'embedded'],
         existingUpdatedFieldNames: [],
-        newFieldNames: ['name', 'webhooks', 'pos'],
+        newFieldNames: ['webhooks', 'pos'],
         deletedFieldNames: [],
       })
     })
@@ -1217,7 +1217,7 @@ describe('configExtensionsIdentifiersBreakdown', () => {
 
       // Then
       expect(result).toEqual({
-        existingFieldNames: ['name', 'application_url', 'embedded', 'webhooks'],
+        existingFieldNames: ['application_url', 'embedded', 'webhooks'],
         existingUpdatedFieldNames: [],
         newFieldNames: [],
         deletedFieldNames: ['pos'],
@@ -1808,7 +1808,7 @@ describe('configExtensionsIdentifiersBreakdown', () => {
       expect(result).toEqual({
         existingFieldNames: ['webhooks', 'application_url'],
         existingUpdatedFieldNames: [],
-        newFieldNames: ['name', 'embedded'],
+        newFieldNames: ['embedded'],
         deletedFieldNames: [],
       })
     })
@@ -1847,7 +1847,7 @@ describe('configExtensionsIdentifiersBreakdown', () => {
       expect(result).toEqual({
         existingFieldNames: [],
         existingUpdatedFieldNames: [],
-        newFieldNames: ['name', 'application_url', 'embedded', 'webhooks'],
+        newFieldNames: ['application_url', 'embedded', 'webhooks'],
         deletedFieldNames: [],
       })
     })