Merge pull request #5914 from Shopify/multi-session

Multi-session support

Author: gonzaloriestra

.changeset/thirty-impalas-marry.md

@@ -0,0 +1,7 @@
+---
+'@shopify/cli-kit': minor
+'@shopify/app': minor
+'@shopify/cli': minor
+---
+
+Add `auth login` command with multi-session support

docs-shopify.dev/commands/auth-login.doc.ts

@@ -0,0 +1,34 @@
+// This is an autogenerated file. Don't edit this file manually.
+import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
+
+const data: ReferenceEntityTemplateSchema = {
+  name: 'auth login',
+  description: `Logs you in to your Shopify account.`,
+  overviewPreviewDescription: `Logs you in to your Shopify account.`,
+  type: 'command',
+  isVisualComponent: false,
+  defaultExample: {
+    codeblock: {
+      tabs: [
+        {
+          title: 'auth login',
+          code: './examples/auth-login.example.sh',
+          language: 'bash',
+        },
+      ],
+      title: 'auth login',
+    },
+  },
+  definitions: [
+  {
+    title: 'Flags',
+    description: 'The following flags are available for the `auth login` command:',
+    type: 'authlogin',
+  },
+  ],
+  category: 'general commands',
+  related: [
+  ],
+}
+
+export default data

docs-shopify.dev/commands/examples/auth-login.example.sh

@@ -0,0 +1 @@
+shopify auth login [flags]

docs-shopify.dev/commands/interfaces/auth-login.interface.ts

@@ -0,0 +1,8 @@
+// This is an autogenerated file. Don't edit this file manually.
+export interface authlogin {
+  /**
+   * Alias of the session you want to login to.
+   * @environment SHOPIFY_FLAG_AUTH_ALIAS
+   */
+  '--alias <value>'?: string
+}

docs-shopify.dev/generated/generated_docs_data.json

@@ -2436,6 +2436,53 @@
     "category": "app",
     "related": []
   },
+  {
+    "name": "auth login",
+    "description": "Logs you in to your Shopify account.",
+    "overviewPreviewDescription": "Logs you in to your Shopify account.",
+    "type": "command",
+    "isVisualComponent": false,
+    "defaultExample": {
+      "codeblock": {
+        "tabs": [
+          {
+            "title": "auth login",
+            "code": "shopify auth login [flags]",
+            "language": "bash"
+          }
+        ],
+        "title": "auth login"
+      }
+    },
+    "definitions": [
+      {
+        "title": "Flags",
+        "description": "The following flags are available for the `auth login` command:",
+        "type": "authlogin",
+        "typeDefinitions": {
+          "authlogin": {
+            "filePath": "docs-shopify.dev/commands/interfaces/auth-login.interface.ts",
+            "name": "authlogin",
+            "description": "",
+            "members": [
+              {
+                "filePath": "docs-shopify.dev/commands/interfaces/auth-login.interface.ts",
+                "syntaxKind": "PropertySignature",
+                "name": "--alias <value>",
+                "value": "string",
+                "description": "Alias of the session you want to login to.",
+                "isOptional": true,
+                "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS"
+              }
+            ],
+            "value": "export interface authlogin {\n  /**\n   * Alias of the session you want to login to.\n   * @environment SHOPIFY_FLAG_AUTH_ALIAS\n   */\n  '--alias <value>'?: string\n}"
+          }
+        }
+      }
+    ],
+    "category": "general commands",
+    "related": []
+  },
   {
     "name": "auth logout",
     "description": "Logs you out of the Shopify account or Partner account and store.",

packages/app/src/cli/utilities/developer-platform-client/partners-client.ts

@@ -623,13 +623,13 @@ export class PartnersClient implements DeveloperPlatformClient {
 
       if (!response.ok) {
         return {
-          errors: data.errors || [`Request failed with status ${response.status}`],
+          errors: data.errors ?? [`Request failed with status ${response.status}`],
           status: response.status,
         }
       }
 
       return {
-        app_logs: data.app_logs || [],
+        app_logs: data.app_logs ?? [],
         cursor: data.cursor,
         status: response.status,
       }

packages/cli-kit/src/private/node/api/graphql/business-platform-destinations/user-email.ts

@@ -0,0 +1,14 @@
+// UserEmail query for fetching user email from Business Platform API
+export interface UserEmailQuery {
+  currentUserAccount?: {
+    email: string
+  } | null
+}
+
+export const UserEmailQueryString = `
+  query UserEmail {
+    currentUserAccount {
+      email
+    }
+  }
+`

packages/cli-kit/src/private/node/api/headers.test.ts

@@ -1,4 +1,4 @@
-import {buildHeaders, sanitizedHeadersOutput} from './headers.js'
+import {buildHeaders, sanitizedHeadersOutput, GraphQLClientError} from './headers.js'
 import {CLI_KIT_VERSION} from '../../../public/common/version.js'
 import {randomUUID} from '../../../public/node/crypto.js'
 import {firstPartyDev, isUnitTest} from '../../../public/node/context/local.js'
@@ -97,3 +97,33 @@ describe('common API methods', () => {
     `)
   })
 })
+
+describe('GraphQLClientError', () => {
+  test('sets custom tryMessage for 403 status code', () => {
+    // Given
+    const message = 'Forbidden access'
+    const statusCode = 403
+
+    // When
+    const error = new GraphQLClientError(message, statusCode)
+
+    // Then
+    expect(error.message).toBe(message)
+    expect(error.statusCode).toBe(403)
+    expect(error.tryMessage).toBe('Ensure you are using the correct account. You can switch with `shopify auth login`')
+  })
+
+  test('does not set tryMessage for non-403 status codes', () => {
+    // Given
+    const message = 'Server error'
+    const statusCode = 500
+
+    // When
+    const error = new GraphQLClientError(message, statusCode)
+
+    // Then
+    expect(error.message).toBe(message)
+    expect(error.statusCode).toBe(500)
+    expect(error.tryMessage).toBeNull()
+  })
+})

packages/cli-kit/src/private/node/api/headers.ts

@@ -1,12 +1,16 @@
 import {CLI_KIT_VERSION} from '../../../public/common/version.js'
 import {firstPartyDev} from '../../../public/node/context/local.js'
-import {ExtendableError} from '../../../public/node/error.js'
+import {AbortError} from '../../../public/node/error.js'
 import https from 'https'
 
-class RequestClientError extends ExtendableError {
+class RequestClientError extends AbortError {
   statusCode: number
   public constructor(message: string, statusCode: number) {
-    super(message)
+    const tryMessage =
+      statusCode === 403
+        ? 'Ensure you are using the correct account. You can switch with `shopify auth login`'
+        : undefined
+    super(message, tryMessage)
     this.statusCode = statusCode
   }
 }

packages/cli-kit/src/private/node/conf-store.test.ts

@@ -2,9 +2,12 @@ import {
   ConfSchema,
   cacheRetrieve,
   cacheRetrieveOrRepopulate,
-  getSession,
-  removeSession,
-  setSession,
+  getSessions,
+  removeSessions,
+  setSessions,
+  getCurrentSessionId,
+  setCurrentSessionId,
+  removeCurrentSessionId,
   runAtMinimumInterval,
   getConfigStoreForPartnerStatus,
   getCachedPartnerAccountStatus,
@@ -23,7 +26,7 @@ describe('getSession', () => {
       config.set('sessionStore', 'my-session')
 
       // When
-      const got = getSession(config)
+      const got = getSessions(config)
 
       // Then
       expect(got).toEqual('my-session')
@@ -39,7 +42,7 @@ describe('setSession', () => {
       config.set('sessionStore', 'my-session')
 
       // When
-      setSession('my-session', config)
+      setSessions('my-session', config)
 
       // Then
       expect(config.get('sessionStore')).toEqual('my-session')
@@ -55,14 +58,74 @@ describe('removeSession', () => {
       config.set('sessionStore', 'my-session')
 
       // When
-      removeSession(config)
+      removeSessions(config)
 
       // Then
       expect(config.get('sessionStore')).toEqual(undefined)
     })
   })
 })
 
+describe('getCurrentSessionId', () => {
+  test('returns the content of the currentSessionId key', async () => {
+    await inTemporaryDirectory(async (cwd) => {
+      // Given
+      const config = new LocalStorage<ConfSchema>({cwd})
+      config.set('currentSessionId', 'user-123')
+
+      // When
+      const got = getCurrentSessionId(config)
+
+      // Then
+      expect(got).toEqual('user-123')
+    })
+  })
+
+  test('returns undefined when currentSessionId is not set', async () => {
+    await inTemporaryDirectory(async (cwd) => {
+      // Given
+      const config = new LocalStorage<ConfSchema>({cwd})
+
+      // When
+      const got = getCurrentSessionId(config)
+
+      // Then
+      expect(got).toBeUndefined()
+    })
+  })
+})
+
+describe('setCurrentSessionId', () => {
+  test('saves the desired content in the currentSessionId key', async () => {
+    await inTemporaryDirectory(async (cwd) => {
+      // Given
+      const config = new LocalStorage<ConfSchema>({cwd})
+
+      // When
+      setCurrentSessionId('user-456', config)
+
+      // Then
+      expect(config.get('currentSessionId')).toEqual('user-456')
+    })
+  })
+})
+
+describe('removeCurrentSessionId', () => {
+  test('removes the currentSessionId key', async () => {
+    await inTemporaryDirectory(async (cwd) => {
+      // Given
+      const config = new LocalStorage<ConfSchema>({cwd})
+      config.set('currentSessionId', 'user-789')
+
+      // When
+      removeCurrentSessionId(config)
+
+      // Then
+      expect(config.get('currentSessionId')).toBeUndefined()
+    })
+  })
+})
+
 describe('cacheRetrieveOrRepopulate', () => {
   test('returns the cached contents when they exist', async () => {
     await inTemporaryDirectory(async (cwd) => {