Merge pull request #5989 from Shopify/auth-error-handling

added error handling for authorization when backend server may not be reachable

Author: EvilGenius13

.changeset/young-rocks-watch.md

@@ -0,0 +1,5 @@
+---
+'@shopify/cli-kit': patch
+---
+
+Add error handling when the authorization service is not reachable

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

@@ -63,6 +63,32 @@ describe('requestDeviceAuthorization', () => {
     })
     expect(got).toEqual(dataExpected)
   })
+
+  test('when the response is not valid JSON, throw an error', async () => {
+    // Given
+    const response = new Response('not valid JSON')
+    vi.mocked(shopifyFetch).mockResolvedValue(response)
+    vi.mocked(identityFqdn).mockResolvedValue('fqdn.com')
+    vi.mocked(clientId).mockReturnValue('clientId')
+
+    // When/Then
+    await expect(requestDeviceAuthorization(['scope1', 'scope2'])).rejects.toThrow(
+      'Received unexpected response from the authorization service. If this issue persists, please contact support at https://help.shopify.com',
+    )
+  })
+
+  test('when the response is empty, throw an error', async () => {
+    // Given
+    const response = new Response('')
+    vi.mocked(shopifyFetch).mockResolvedValue(response)
+    vi.mocked(identityFqdn).mockResolvedValue('fqdn.com')
+    vi.mocked(clientId).mockReturnValue('clientId')
+
+    // When/Then
+    await expect(requestDeviceAuthorization(['scope1', 'scope2'])).rejects.toThrow(
+      'Received unexpected response from the authorization service. If this issue persists, please contact support at https://help.shopify.com',
+    )
+  })
 })
 
 describe('pollForDeviceAuthorization', () => {

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

@@ -41,7 +41,14 @@ export async function requestDeviceAuthorization(scopes: string[]): Promise<Devi
   })
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const jsonResult: any = await response.json()
+  let jsonResult: any
+  try {
+    jsonResult = await response.json()
+  } catch (error) {
+    throw new BugError(
+      'Received unexpected response from the authorization service. If this issue persists, please contact support at https://help.shopify.com',
+    )
+  }
 
   outputDebug(outputContent`Received device authorization code: ${outputToken.json(jsonResult)}`)
   if (!jsonResult.device_code || !jsonResult.verification_uri_complete) {