Prompt for an alias when logging in from other commands

Author: gonzaloriestra

packages/cli-kit/src/private/node/session.test.ts

@@ -25,6 +25,8 @@ import {themeToken} from '../../public/node/context/local.js'
 import {partnersRequest} from '../../public/node/api/partners.js'
 import {getPartnersToken} from '../../public/node/environment.js'
 import {nonRandomUUID} from '../../public/node/crypto.js'
+import {renderTextPrompt} from '../../public/node/ui.js'
+import {terminalSupportsPrompting} from '../../public/node/system.js'
 import {vi, describe, expect, test, beforeEach} from 'vitest'
 
 const futureDate = new Date(2022, 1, 1, 11)
@@ -110,6 +112,8 @@ vi.mock('../../store')
 vi.mock('../../public/node/environment.js')
 vi.mock('./session/device-authorization')
 vi.mock('./conf-store')
+vi.mock('../../public/node/ui.js')
+vi.mock('../../public/node/system.js')
 
 beforeEach(() => {
   vi.spyOn(fqdnModule, 'identityFqdn').mockResolvedValue(fqdn)
@@ -134,21 +138,29 @@ beforeEach(() => {
     interval: 5,
   })
   vi.mocked(pollForDeviceAuthorization).mockResolvedValue(validIdentityToken)
+  vi.mocked(renderTextPrompt).mockResolvedValue(userId)
+  vi.mocked(terminalSupportsPrompting).mockReturnValue(true)
 })
 
 describe('ensureAuthenticated when previous session is invalid', () => {
   test('executes complete auth flow if there is no session', async () => {
     // Given
     vi.mocked(validateSession).mockResolvedValueOnce('needs_full_auth')
     vi.mocked(fetchSessions).mockResolvedValue(undefined)
+    vi.mocked(renderTextPrompt).mockResolvedValue(userId)
 
     // When
     const got = await ensureAuthenticated(defaultApplications)
 
     // Then
     expect(exchangeAccessForApplicationTokens).toBeCalled()
     expect(refreshAccessToken).not.toBeCalled()
-    expect(storeSessions).toBeCalledWith(validSessions)
+    expect(renderTextPrompt).toHaveBeenCalledWith({
+      message: 'Enter an alias to identify this account',
+      defaultValue: userId,
+      allowEmpty: false,
+    })
+    expect(storeSessions).toHaveBeenCalledOnce()
     expect(got).toEqual(validTokens)
 
     // The userID is cached in memory and the secureStore is not accessed again
@@ -457,6 +469,7 @@ describe('ensureAuthenticated alias functionality', () => {
     // Given
     vi.mocked(validateSession).mockResolvedValueOnce('needs_full_auth')
     vi.mocked(fetchSessions).mockResolvedValue(undefined)
+    vi.mocked(renderTextPrompt).mockResolvedValue('work-account')
     const expectedSessionWithAlias = {
       ...validSessions,
       [fqdn]: {
@@ -522,6 +535,7 @@ describe('ensureAuthenticated alias functionality', () => {
     vi.mocked(validateSession).mockResolvedValueOnce('needs_refresh')
     vi.mocked(fetchSessions).mockResolvedValue(validSessions)
     vi.mocked(refreshAccessToken).mockRejectedValueOnce(tokenResponseError)
+    vi.mocked(renderTextPrompt).mockResolvedValue('fallback-alias')
     const expectedSessionWithAlias = {
       ...validSessions,
       [fqdn]: {

packages/cli-kit/src/private/node/session.ts

@@ -22,6 +22,7 @@ import {getIdentityTokenInformation, getPartnersToken} from '../../public/node/e
 import {AdminSession} from '../../public/node/session.js'
 import {nonRandomUUID} from '../../public/node/crypto.js'
 import {isEmpty} from '../../public/common/object.js'
+import {renderTextPrompt} from '../../public/node/ui.js'
 
 /**
  * A scope supported by the Shopify Admin API.
@@ -211,7 +212,7 @@ ${outputToken.json(applications)}
   if (validationResult === 'needs_full_auth') {
     throwOnNoPrompt(noPrompt)
     outputDebug(outputContent`Initiating the full authentication flow...`)
-    newSession = await executeCompleteFlow(applications)
+    newSession = await executeCompleteFlow(applications, alias)
   } else if (validationResult === 'needs_refresh' || forceRefresh) {
     outputDebug(outputContent`The current session is valid but needs refresh. Refreshing...`)
     try {
@@ -220,7 +221,7 @@ ${outputToken.json(applications)}
     } catch (error) {
       if (error instanceof InvalidGrantError) {
         throwOnNoPrompt(noPrompt)
-        newSession = await executeCompleteFlow(applications)
+        newSession = await executeCompleteFlow(applications, alias)
       } else if (error instanceof InvalidRequestError) {
         await sessionStore.remove()
         throw new AbortError('\nError validating auth session', "We've cleared the current session, please try again")
@@ -271,8 +272,9 @@ The CLI is currently unable to prompt for reauthentication.`,
  * Execute the full authentication flow.
  *
  * @param applications - An object containing the applications we need to be authenticated with.
+ * @param alias - Optional alias to use for the session.
  */
-async function executeCompleteFlow(applications: OAuthApplications): Promise<Session> {
+async function executeCompleteFlow(applications: OAuthApplications, alias?: string): Promise<Session> {
   const scopes = getFlattenScopes(applications)
   const exchangeScopes = getExchangeScopes(applications)
   const store = applications.adminApi?.storeFqdn
@@ -299,12 +301,22 @@ async function executeCompleteFlow(applications: OAuthApplications): Promise<Ses
   outputDebug(outputContent`CLI token received. Exchanging it for application tokens...`)
   const result = await exchangeAccessForApplicationTokens(identityToken, exchangeScopes, store)
 
+  const defaultAlias = alias ?? identityToken.userId
+  const finalAlias = await renderTextPrompt({
+    message: 'Enter an alias to identify this account',
+    defaultValue: defaultAlias,
+    allowEmpty: false,
+  })
+
   const session: Session = {
-    identity: identityToken,
+    identity: {
+      ...identityToken,
+      alias: finalAlias,
+    },
     applications: result,
   }
 
-  outputCompleted('Logged in.')
+  outputCompleted(`Logged in.`)
 
   return session
 }

packages/cli-kit/src/public/node/session-prompt.test.ts

@@ -1,5 +1,5 @@
 import {promptSessionSelect} from './session-prompt.js'
-import {renderSelectPrompt, renderTextPrompt} from './ui.js'
+import {renderSelectPrompt} from './ui.js'
 import {ensureAuthenticatedUser} from './session.js'
 import {identityFqdn} from './context/fqdn.js'
 import {setCurrentSessionId} from '../../private/node/conf-store.js'
@@ -45,8 +45,7 @@ describe('promptSessionSelect', () => {
   beforeEach(() => {
     vi.mocked(identityFqdn).mockResolvedValue('identity.fqdn.com')
     vi.mocked(ensureAuthenticatedUser).mockResolvedValue({userId: 'new-user-id'})
-    vi.mocked(sessionStore.updateSessionAlias).mockResolvedValue()
-    vi.mocked(renderTextPrompt).mockResolvedValue('new-alias')
+    vi.mocked(sessionStore.getSessionAlias).mockResolvedValue('new-alias')
     vi.mocked(sessionStore.findSessionByAlias).mockResolvedValue(undefined)
   })
 
@@ -59,34 +58,24 @@ describe('promptSessionSelect', () => {
 
     // Then
     expect(renderSelectPrompt).not.toHaveBeenCalled()
-    expect(ensureAuthenticatedUser).toHaveBeenCalledWith({}, {forceNewSession: true})
-    expect(renderTextPrompt).toHaveBeenCalledWith({
-      message: 'Enter an alias for this account',
-      defaultValue: '',
-      allowEmpty: false,
-    })
-    expect(sessionStore.updateSessionAlias).toHaveBeenCalledWith('new-user-id', 'new-alias')
-    expect(result).toEqual({userId: 'new-user-id'})
+    expect(ensureAuthenticatedUser).toHaveBeenCalledWith({}, {forceNewSession: true, alias: undefined})
+    expect(sessionStore.getSessionAlias).toHaveBeenCalledWith('new-user-id')
+    expect(result).toEqual('new-alias')
   })
 
   test('prompts user to create new session with alias when no existing sessions', async () => {
     // Given
     vi.mocked(sessionStore.fetch).mockResolvedValue(undefined)
-    vi.mocked(renderTextPrompt).mockResolvedValue('custom-alias')
+    vi.mocked(sessionStore.getSessionAlias).mockResolvedValue('custom-alias')
 
     // When
     const result = await promptSessionSelect('my-alias')
 
     // Then
     expect(renderSelectPrompt).not.toHaveBeenCalled()
-    expect(ensureAuthenticatedUser).toHaveBeenCalledWith({}, {forceNewSession: true})
-    expect(renderTextPrompt).toHaveBeenCalledWith({
-      message: 'Enter an alias for this account',
-      defaultValue: 'my-alias',
-      allowEmpty: false,
-    })
-    expect(sessionStore.updateSessionAlias).toHaveBeenCalledWith('new-user-id', 'custom-alias')
-    expect(result).toEqual({userId: 'new-user-id'})
+    expect(ensureAuthenticatedUser).toHaveBeenCalledWith({}, {forceNewSession: true, alias: 'my-alias'})
+    expect(sessionStore.getSessionAlias).toHaveBeenCalledWith('new-user-id')
+    expect(result).toEqual('custom-alias')
   })
 
   test('shows existing sessions and allows selection', async () => {
@@ -107,7 +96,7 @@ describe('promptSessionSelect', () => {
       ],
     })
     expect(setCurrentSessionId).toHaveBeenCalledWith('user1')
-    expect(result).toEqual({userId: 'user1'})
+    expect(result).toEqual('Work Account')
   })
 
   test('handles missing alias in existing session gracefully', async () => {
@@ -144,7 +133,7 @@ describe('promptSessionSelect', () => {
       ],
     })
     expect(setCurrentSessionId).toHaveBeenCalledWith('user3')
-    expect(result).toEqual({userId: 'user3'})
+    expect(result).toEqual('user3')
   })
 
   test('creates new session when user selects "Log in with a different account"', async () => {
@@ -156,48 +145,24 @@ describe('promptSessionSelect', () => {
     const result = await promptSessionSelect()
 
     // Then
-    expect(ensureAuthenticatedUser).toHaveBeenCalledWith({}, {forceNewSession: true})
-    expect(renderTextPrompt).toHaveBeenCalledWith({
-      message: 'Enter an alias for this account',
-      defaultValue: '',
-      allowEmpty: false,
-    })
-    expect(sessionStore.updateSessionAlias).toHaveBeenCalledWith('new-user-id', 'new-alias')
-    expect(result).toEqual({userId: 'new-user-id'})
+    expect(ensureAuthenticatedUser).toHaveBeenCalledWith({}, {forceNewSession: true, alias: undefined})
+    expect(sessionStore.getSessionAlias).toHaveBeenCalledWith('new-user-id')
+    expect(result).toEqual('new-alias')
   })
 
   test('creates new session with alias when user selects "Log in with a different account"', async () => {
     // Given
     vi.mocked(sessionStore.fetch).mockResolvedValue(mockSessions)
     vi.mocked(renderSelectPrompt).mockResolvedValue('NEW_LOGIN')
-    vi.mocked(renderTextPrompt).mockResolvedValue('custom-alias')
+    vi.mocked(sessionStore.getSessionAlias).mockResolvedValue('custom-alias')
 
     // When
     const result = await promptSessionSelect('work-alias')
 
     // Then
-    expect(ensureAuthenticatedUser).toHaveBeenCalledWith({}, {forceNewSession: true})
-    expect(renderTextPrompt).toHaveBeenCalledWith({
-      message: 'Enter an alias for this account',
-      defaultValue: 'work-alias',
-      allowEmpty: false,
-    })
-    expect(sessionStore.updateSessionAlias).toHaveBeenCalledWith('new-user-id', 'custom-alias')
-    expect(result).toEqual({userId: 'new-user-id'})
-  })
-
-  test('updates alias for existing session when provided', async () => {
-    // Given
-    vi.mocked(sessionStore.fetch).mockResolvedValue(mockSessions)
-    vi.mocked(renderSelectPrompt).mockResolvedValue('user1')
-
-    // When
-    const result = await promptSessionSelect('updated-alias')
-
-    // Then
-    expect(setCurrentSessionId).toHaveBeenCalledWith('user1')
-    expect(sessionStore.updateSessionAlias).toHaveBeenCalledWith('user1', 'updated-alias')
-    expect(result).toEqual({userId: 'user1'})
+    expect(ensureAuthenticatedUser).toHaveBeenCalledWith({}, {forceNewSession: true, alias: 'work-alias'})
+    expect(sessionStore.getSessionAlias).toHaveBeenCalledWith('new-user-id')
+    expect(result).toEqual('custom-alias')
   })
 
   test('does not update alias for existing session when not provided', async () => {
@@ -211,7 +176,7 @@ describe('promptSessionSelect', () => {
     // Then
     expect(setCurrentSessionId).toHaveBeenCalledWith('user1')
     expect(sessionStore.updateSessionAlias).not.toHaveBeenCalled()
-    expect(result).toEqual({userId: 'user1'})
+    expect(result).toEqual('Work Account')
   })
 
   test('switches to existing session when alias is provided and found', async () => {
@@ -227,7 +192,7 @@ describe('promptSessionSelect', () => {
     expect(setCurrentSessionId).toHaveBeenCalledWith('user1')
     expect(renderSelectPrompt).not.toHaveBeenCalled()
     expect(ensureAuthenticatedUser).not.toHaveBeenCalled()
-    expect(result).toEqual({userId: 'user1'})
+    expect(result).toEqual('Work Account')
   })
 
   test('shows session selection when alias is not found', async () => {
@@ -243,6 +208,6 @@ describe('promptSessionSelect', () => {
     expect(sessionStore.findSessionByAlias).toHaveBeenCalledWith('Non-existent Alias')
     expect(renderSelectPrompt).toHaveBeenCalled()
     expect(setCurrentSessionId).toHaveBeenCalledWith('user2')
-    expect(result).toEqual({userId: 'user2'})
+    expect(result).toEqual('user2')
   })
 })