Merge pull request #1297 from Shopify/fix-app-conf-store

Fix: conf store not saving some values on windows
Shopify · Feb 6, 2023 · 50c3606 · 50c3606
2 parents a8ae2c2 + 3314a97
commit 50c3606
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 11 deletions.
diff --git a/.changeset/forty-cobras-warn.md b/.changeset/forty-cobras-warn.md
@@ -0,0 +1,5 @@
+---
+'@shopify/app': patch
+---
+
+Fix windows not storing dev selected values correctly
diff --git a/packages/app/src/cli/services/conf.test.ts b/packages/app/src/cli/services/conf.test.ts
@@ -65,6 +65,20 @@ describe('setAppInfo', async () => {
       expect(got).toEqual(APP2)
     })
   })
+
+  it('creates new info normalizing the path', async () => {
+    await inTemporaryDirectory(async (cwd) => {
+      // Given
+      const conf = new Conf<AppConfSchema>({cwd})
+
+      // When
+      setAppInfo({appId: 'app2', directory: '\\app2\\something', storeFqdn: APP2.storeFqdn, orgId: APP2.orgId}, conf)
+      const got = conf.get('/app2/something')
+
+      // Then
+      expect(got.appId).toEqual(APP2.appId)
+    })
+  })
 })
 
 describe('clearAppInfo', async () => {

diff --git a/packages/app/src/cli/services/conf.ts b/packages/app/src/cli/services/conf.ts
@@ -1,5 +1,6 @@
 import {Conf} from '@shopify/cli-kit/node/conf'
 import {outputDebug, outputContent, outputToken} from '@shopify/cli-kit/node/output'
+import {normalizePath} from '@shopify/cli-kit/node/path'
 
 export interface CachedAppInfo {
   directory: string
@@ -26,13 +27,15 @@ function appConf() {
 }
 
 export function getAppInfo(directory: string, config: Conf<AppConfSchema> = appConf()): CachedAppInfo | undefined {
-  outputDebug(outputContent`Reading cached app information for directory ${outputToken.path(directory)}...`)
-  return config.get(directory)
+  const normalized = normalizePath(directory)
+  outputDebug(outputContent`Reading cached app information for directory ${outputToken.path(normalized)}...`)
+  return config.get(normalized)
 }
 
 export function clearAppInfo(directory: string, config: Conf<AppConfSchema> = appConf()): void {
-  outputDebug(outputContent`Clearing app information for directory ${outputToken.path(directory)}...`)
-  config.delete(directory)
+  const normalized = normalizePath(directory)
+  outputDebug(outputContent`Clearing app information for directory ${outputToken.path(normalized)}...`)
+  config.delete(normalized)
 }
 
 export function clearAllAppInfo(config: Conf<AppConfSchema> = appConf()): void {
@@ -41,15 +44,14 @@ export function clearAllAppInfo(config: Conf<AppConfSchema> = appConf()): void {
 }
 
 export function setAppInfo(options: CachedAppInfo, config: Conf<AppConfSchema> = appConf()): void {
+  const normalized = normalizePath(options.directory)
   outputDebug(
-    outputContent`Storing app information for directory ${outputToken.path(options.directory)}:${outputToken.json(
-      options,
-    )}`,
+    outputContent`Storing app information for directory ${outputToken.path(normalized)}:${outputToken.json(options)}`,
   )
-  const savedApp = config.get(options.directory)
+  const savedApp = config.get(normalized)
   if (savedApp) {
-    config.set(options.directory, {
-      directory: options.directory,
+    config.set(normalized, {
+      directory: normalized,
       appId: options.appId ?? savedApp.appId,
       title: options.title ?? savedApp.title,
       storeFqdn: options.storeFqdn ?? savedApp.storeFqdn,
@@ -58,6 +60,6 @@ export function setAppInfo(options: CachedAppInfo, config: Conf<AppConfSchema> =
       tunnelPlugin: options.tunnelPlugin ?? savedApp.tunnelPlugin,
     })
   } else {
-    config.set(options.directory, options)
+    config.set(normalized, options)
   }
 }