Store session globally to avoid multiple instances

Author: gonzaloriestra

packages/app/src/cli/api/graphql/current_account_info.ts

@@ -1,8 +1,9 @@
-import {AccountInfo} from '../../services/context/partner-account-info.js'
 import {DeveloperPlatformClient} from '../../utilities/developer-platform-client.js'
+import {AccountInfo} from '@shopify/cli-kit/node/session'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {gql} from 'graphql-request'
 
+// eslint-disable-next-line @shopify/cli/no-inline-graphql
 export const CurrentAccountInfoQuery = gql`
   query currentAccountInfo {
     currentAccountInfo {

packages/app/src/cli/models/app/app.test-data.ts

@@ -24,7 +24,6 @@ import {ExtensionInstance} from '../extensions/extension-instance.js'
 import {loadLocalExtensionsSpecifications} from '../extensions/load-specifications.js'
 import {FunctionConfigType} from '../extensions/specifications/function.js'
 import {BaseConfigType} from '../extensions/schemas.js'
-import {PartnersSession} from '../../services/context/partner-account-info.js'
 import {WebhooksConfig} from '../extensions/specifications/types/app_config_webhook.js'
 import {PaymentsAppExtensionConfigType} from '../extensions/specifications/payments_app_extension.js'
 import {
@@ -79,6 +78,7 @@ import {AppProxySpecIdentifier} from '../extensions/specifications/app_config_ap
 import {ExtensionSpecification} from '../extensions/specification.js'
 import {AppLogsOptions} from '../../services/app-logs/utils.js'
 import {AppLogsSubscribeMutationVariables} from '../../api/graphql/app-management/generated/app-logs-subscribe.js'
+import {Session} from '@shopify/cli-kit/node/session'
 import {vi} from 'vitest'
 import {joinPath} from '@shopify/cli-kit/node/path'
 
@@ -1223,7 +1223,7 @@ export const testRemoteExtensionTemplates: ExtensionTemplate[] = [
   themeAppExtensionTemplate,
 ]
 
-export const testPartnersUserSession: PartnersSession = {
+export const testPartnersUserSession: Session = {
   token: 'token',
   businessPlatformToken: 'businessPlatformToken',
   accountInfo: {
@@ -1520,7 +1520,7 @@ export function testDeveloperPlatformClient(stubs: Partial<DeveloperPlatformClie
   return retVal as DeveloperPlatformClient
 }
 
-export const testPartnersServiceSession: PartnersSession = {
+export const testPartnersServiceSession: Session = {
   token: 'partnersToken',
   businessPlatformToken: 'businessPlatformToken',
   accountInfo: {

packages/app/src/cli/services/context/partner-account-info.test.ts

@@ -1,7 +1,8 @@
-import {AccountInfo, fetchCurrentAccountInformation} from './partner-account-info.js'
+import {fetchCurrentAccountInformation} from './partner-account-info.js'
 import {testDeveloperPlatformClient} from '../../models/app/app.test-data.js'
 import {getCurrentAccountInfo} from '../../api/graphql/current_account_info.js'
 import {clearCachedAccountInfo, getCachedAccountInfo, setCachedAccountInfo} from '../../utilities/app-conf-store.js'
+import {AccountInfo} from '@shopify/cli-kit/node/session'
 import {beforeEach, describe, expect, test, vi} from 'vitest'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {outputDebug} from '@shopify/cli-kit/node/output'

packages/app/src/cli/services/context/partner-account-info.ts

@@ -2,37 +2,9 @@ import {getCurrentAccountInfo} from '../../api/graphql/current_account_info.js'
 import {getCachedAccountInfo, setCachedAccountInfo} from '../../utilities/app-conf-store.js'
 import {DeveloperPlatformClient} from '../../utilities/developer-platform-client.js'
 import {outputDebug} from '@shopify/cli-kit/node/output'
+import {AccountInfo, isUserAccount, isServiceAccount} from '@shopify/cli-kit/node/session'
 
-export interface PartnersSession {
-  token: string
-  businessPlatformToken: string
-  accountInfo: AccountInfo
-  userId: string
-}
-
-export type AccountInfo = UserAccountInfo | ServiceAccountInfo | UnknownAccountInfo
-
-interface UserAccountInfo {
-  type: 'UserAccount'
-  email: string
-}
-
-interface ServiceAccountInfo {
-  type: 'ServiceAccount'
-  orgName: string
-}
-
-interface UnknownAccountInfo {
-  type: 'UnknownAccount'
-}
-
-export function isUserAccount(account: AccountInfo): account is UserAccountInfo {
-  return account.type === 'UserAccount'
-}
-
-export function isServiceAccount(account: AccountInfo): account is ServiceAccountInfo {
-  return account.type === 'ServiceAccount'
-}
+export {AccountInfo, isUserAccount, isServiceAccount}
 
 export async function fetchCurrentAccountInformation(
   developerPlatformClient: DeveloperPlatformClient,

packages/app/src/cli/utilities/app-conf-store.test.ts

@@ -4,7 +4,7 @@ import {
   setCachedAccountInfo,
   clearCachedAccountInfo,
 } from './app-conf-store.js'
-import {AccountInfo} from '../services/context/partner-account-info.js'
+import {AccountInfo} from '@shopify/cli-kit/node/session'
 import {vi, describe, test, expect, beforeEach, afterEach} from 'vitest'
 import {LocalStorage} from '@shopify/cli-kit/node/local-storage'
 import {inTemporaryDirectory} from '@shopify/cli-kit/node/fs'

packages/app/src/cli/utilities/app-conf-store.ts

@@ -1,4 +1,4 @@
-import {AccountInfo} from '../services/context/partner-account-info.js'
+import {AccountInfo} from '@shopify/cli-kit/node/session'
 import {LocalStorage} from '@shopify/cli-kit/node/local-storage'
 
 // max age is 72 hours (3 days)

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

@@ -1,6 +1,5 @@
 import {PartnersClient} from './developer-platform-client/partners-client.js'
 import {AppManagementClient} from './developer-platform-client/app-management-client.js'
-import {PartnersSession} from '../../cli/services/context/partner-account-info.js'
 import {
   MinimalAppIdentifiers,
   MinimalOrganizationApp,
@@ -57,6 +56,7 @@ import {
   AppLogsSubscribeMutation,
   AppLogsSubscribeMutationVariables,
 } from '../api/graphql/app-management/generated/app-logs-subscribe.js'
+import {Session} from '@shopify/cli-kit/node/session'
 import {TokenItem} from '@shopify/cli-kit/node/ui'
 import {blockPartnersAccess} from '@shopify/cli-kit/node/environment'
 import {UnauthorizedHandler} from '@shopify/cli-kit/node/api/graphql'
@@ -226,14 +226,14 @@ export interface DeveloperPlatformClient {
   readonly organizationSource: OrganizationSource
   readonly bundleFormat: 'zip' | 'br'
   readonly supportsDashboardManagedExtensions: boolean
-  session: () => Promise<PartnersSession>
+  session: () => Promise<Session>
   /**
    * This is an unsafe method that should only be used when the session is expired.
    * It is not safe to use this method in other contexts as it may lead to race conditions.
    * Use only if you know what you are doing.
    */
   unsafeRefreshToken: () => Promise<string>
-  accountInfo: () => Promise<PartnersSession['accountInfo']>
+  accountInfo: () => Promise<Session['accountInfo']>
   appFromIdentifiers: (apiKey: string) => Promise<OrganizationApp | undefined>
   organizations: () => Promise<Organization[]>
   orgFromId: (orgId: string) => Promise<Organization | undefined>

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

@@ -7,6 +7,7 @@ import {
   encodedGidFromShopId,
   versionDeepLink,
 } from './app-management-client.js'
+import {clearAllGlobalSessions} from './global-session-store.js'
 import {OrganizationBetaFlagsQuerySchema} from './app-management-client/graphql/organization_beta_flags.js'
 import {
   testUIExtension,
@@ -31,7 +32,7 @@ import {MinimalAppIdentifiers} from '../../models/organization.js'
 import {CreateAssetUrl} from '../../api/graphql/app-management/generated/create-asset-url.js'
 import {SourceExtension} from '../../api/graphql/app-management/generated/types.js'
 import {ListOrganizations} from '../../api/graphql/business-platform-destinations/generated/organizations.js'
-import {describe, expect, test, vi} from 'vitest'
+import {describe, expect, test, vi, beforeEach} from 'vitest'
 import {CLI_KIT_VERSION} from '@shopify/cli-kit/common/version'
 import {fetch} from '@shopify/cli-kit/node/http'
 import {
@@ -93,6 +94,11 @@ function moduleFromExtension(extension: ExtensionInstance) {
   }
 }
 
+beforeEach(() => {
+  // Clear global sessions before each test
+  clearAllGlobalSessions()
+})
+
 describe('diffAppModules', () => {
   test('extracts the added, removed and updated modules between two releases', () => {
     // Given

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

@@ -4,6 +4,7 @@ import {
   OrganizationBetaFlagsQueryVariables,
   organizationBetaFlagsQuery,
 } from './app-management-client/graphql/organization_beta_flags.js'
+import {getGlobalSession, setGlobalSession} from './global-session-store.js'
 import {environmentVariableNames} from '../../constants.js'
 import {RemoteSpecification} from '../../api/graphql/extension_specifications.js'
 import {
@@ -25,7 +26,6 @@ import {
   DevSessionDeleteOptions,
   UserError,
 } from '../developer-platform-client.js'
-import {PartnersSession} from '../../services/context/partner-account-info.js'
 import {
   MinimalAppIdentifiers,
   MinimalOrganizationApp,
@@ -139,7 +139,7 @@ import {
 } from '../../api/graphql/app-management/generated/app-logs-subscribe.js'
 import {SourceExtension} from '../../api/graphql/app-management/generated/types.js'
 import {getPartnersToken} from '@shopify/cli-kit/node/environment'
-import {ensureAuthenticatedAppManagementAndBusinessPlatform} from '@shopify/cli-kit/node/session'
+import {ensureAuthenticatedAppManagementAndBusinessPlatform, Session} from '@shopify/cli-kit/node/session'
 import {isUnitTest} from '@shopify/cli-kit/node/context/local'
 import {AbortError, BugError} from '@shopify/cli-kit/node/error'
 import {fetch, shopifyFetch, Response} from '@shopify/cli-kit/node/http'
@@ -191,10 +191,10 @@ export class AppManagementClient implements DeveloperPlatformClient {
   public readonly organizationSource = OrganizationSource.BusinessPlatform
   public readonly bundleFormat = 'br'
   public readonly supportsDashboardManagedExtensions = false
-  private _session: PartnersSession | undefined
-
-  constructor(session?: PartnersSession) {
-    this._session = session
+  constructor(session?: Session) {
+    if (session) {
+      setGlobalSession(this.clientName, session)
+    }
   }
 
   async subscribeToAppLogs(
@@ -256,8 +256,9 @@ export class AppManagementClient implements DeveloperPlatformClient {
     }
   }
 
-  async session(): Promise<PartnersSession> {
-    if (!this._session) {
+  async session(): Promise<Session> {
+    const existingSession = getGlobalSession(this.clientName)
+    if (!existingSession) {
       if (isUnitTest()) {
         throw new Error('AppManagementClient.session() should not be invoked dynamically in a unit test')
       }
@@ -285,7 +286,7 @@ export class AppManagementClient implements DeveloperPlatformClient {
           throw new BugError('Multiple organizations found for the CLI token')
         }
 
-        this._session = {
+        const session: Session = {
           token: appManagementToken,
           businessPlatformToken,
           accountInfo: {
@@ -294,8 +295,9 @@ export class AppManagementClient implements DeveloperPlatformClient {
           },
           userId,
         }
+        setGlobalSession(this.clientName, session)
       } else if (userInfoResult.currentUserAccount) {
-        this._session = {
+        const session: Session = {
           token: appManagementToken,
           businessPlatformToken,
           accountInfo: {
@@ -304,18 +306,20 @@ export class AppManagementClient implements DeveloperPlatformClient {
           },
           userId,
         }
+        setGlobalSession(this.clientName, session)
       } else {
-        this._session = {
+        const session: Session = {
           token: appManagementToken,
           businessPlatformToken,
           accountInfo: {
             type: 'UnknownAccount',
           },
           userId,
         }
+        setGlobalSession(this.clientName, session)
       }
     }
-    return this._session
+    return getGlobalSession(this.clientName)!
   }
 
   async token(): Promise<string> {
@@ -335,7 +339,7 @@ export class AppManagementClient implements DeveloperPlatformClient {
     return session.token
   }
 
-  async accountInfo(): Promise<PartnersSession['accountInfo']> {
+  async accountInfo(): Promise<Session['accountInfo']> {
     return (await this.session()).accountInfo
   }
 

packages/app/src/cli/utilities/developer-platform-client/global-session-store.ts

@@ -0,0 +1,39 @@
+import {ClientName} from '../developer-platform-client.js'
+import {Session} from '@shopify/cli-kit/node/session'
+
+interface GlobalSessionStore {
+  [ClientName.AppManagement]?: Session
+  [ClientName.Partners]?: Session
+}
+
+// Global in-memory session store shared across all client instances
+const globalSessionStore: GlobalSessionStore = {}
+
+/**
+ * Get a session from the global store
+ */
+export function getGlobalSession(clientName: ClientName): Session | undefined {
+  return globalSessionStore[clientName]
+}
+
+/**
+ * Set a session in the global store
+ */
+export function setGlobalSession(clientName: ClientName, session: Session): void {
+  globalSessionStore[clientName] = session
+}
+
+/**
+ * Clear a session from the global store
+ */
+export function clearGlobalSession(clientName: ClientName): void {
+  globalSessionStore[clientName] = undefined
+}
+
+/**
+ * Clear all sessions from the global store (useful for testing)
+ */
+export function clearAllGlobalSessions(): void {
+  globalSessionStore[ClientName.AppManagement] = undefined
+  globalSessionStore[ClientName.Partners] = undefined
+}