Force all requests in app management to have an unauthorizedHandler

Author: isaacroldan

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

@@ -80,7 +80,7 @@ export async function adminRequestDoc<TResult, TVariables extends Variables>(
   }
   let unauthorizedHandler: UnauthorizedHandler | undefined
   if ('refresh' in session) {
-    unauthorizedHandler = {type: 'simple', handler: session.refresh as () => Promise<void>}
+    unauthorizedHandler = {type: 'token_refresh', handler: session.refresh as () => Promise<{token: string}>}
   }
   const result = graphqlRequestDoc<TResult, TVariables>({
     ...opts,

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

@@ -1,4 +1,4 @@
-import {appDevRequest} from './app-dev.js'
+import {appDevRequestDoc} from './app-dev.js'
 import {graphqlRequestDoc} from './graphql.js'
 import {serviceEnvironment, Environment} from '../../../private/node/context/service.js'
 import {test, vi, expect, describe} from 'vitest'
@@ -33,7 +33,16 @@ describe('appDevRequest', () => {
     const query = 'query' as unknown as TypedDocumentNode<object, {variables: string}>
 
     // When
-    await appDevRequest(query, shopFqdn, mockedToken, {variables: 'variables'})
+    await appDevRequestDoc({
+      query,
+      shopFqdn,
+      token: mockedToken,
+      variables: {variables: 'variables'},
+      unauthorizedHandler: {
+        type: 'token_refresh',
+        handler: vi.fn().mockResolvedValue({token: mockedToken}),
+      },
+    })
 
     // Then
     expect(graphqlRequestDoc).toHaveBeenLastCalledWith({
@@ -42,6 +51,10 @@ describe('appDevRequest', () => {
       url: 'https://test-shop.shop.dev/app_dev/unstable/graphql.json',
       token: mockedToken,
       variables: {variables: 'variables'},
+      unauthorizedHandler: {
+        type: 'token_refresh',
+        handler: expect.any(Function),
+      },
     })
   })
 
@@ -51,7 +64,16 @@ describe('appDevRequest', () => {
     const query = 'query' as unknown as TypedDocumentNode<object, {variables: string}>
 
     // When
-    await appDevRequest(query, shopFqdn, mockedToken, {variables: 'variables'})
+    await appDevRequestDoc({
+      query,
+      shopFqdn,
+      token: mockedToken,
+      variables: {variables: 'variables'},
+      unauthorizedHandler: {
+        type: 'token_refresh',
+        handler: vi.fn().mockResolvedValue({token: mockedToken}),
+      },
+    })
 
     // Then
     expect(graphqlRequestDoc).toHaveBeenLastCalledWith({
@@ -61,6 +83,10 @@ describe('appDevRequest', () => {
       token: mockedToken,
       addedHeaders: {'x-forwarded-host': shopFqdn},
       variables: {variables: 'variables'},
+      unauthorizedHandler: {
+        type: 'token_refresh',
+        handler: expect.any(Function),
+      },
     })
   })
 })

packages/cli-kit/src/public/node/api/admin.ts

@@ -1,4 +1,4 @@
-import {graphqlRequestDoc} from './graphql.js'
+import {graphqlRequestDoc, UnauthorizedHandler} from './graphql.js'
 import {appDevFqdn, normalizeStoreFqdn} from '../context/fqdn.js'
 import {serviceEnvironment} from '../../../private/node/context/service.js'
 import Bottleneck from 'bottleneck'
@@ -14,36 +14,45 @@ const limiter = new Bottleneck({
 })
 
 /**
- * Executes an org-scoped GraphQL query against the App Management API.
- * Uses typed documents.
- *
  * @param query - GraphQL query to execute.
  * @param shopFqdn - The shop fqdn.
  * @param token - Partners token.
  * @param variables - GraphQL variables to pass to the query.
+ * @param unauthorizedHandler - Unauthorized handler to use.
+ */
+export interface AppDevRequestOptions<TResult, TVariables extends Variables> {
+  query: TypedDocumentNode<TResult, TVariables>
+  shopFqdn: string
+  token: string
+  unauthorizedHandler: UnauthorizedHandler
+  variables?: TVariables
+}
+/**
+ * Executes an org-scoped GraphQL query against the App Management API.
+ * Uses typed documents.
+ *
+ * @param options - The options for the request.
  * @returns The response of the query of generic type <T>.
  */
-export async function appDevRequest<TResult, TVariables extends Variables>(
-  query: TypedDocumentNode<TResult, TVariables>,
-  shopFqdn: string,
-  token: string,
-  variables?: TVariables,
+export async function appDevRequestDoc<TResult, TVariables extends Variables>(
+  options: AppDevRequestOptions<TResult, TVariables>,
 ): Promise<TResult> {
   const api = 'App Dev'
-  const normalizedShopFqdn = await normalizeStoreFqdn(shopFqdn)
+  const normalizedShopFqdn = await normalizeStoreFqdn(options.shopFqdn)
   const fqdn = await appDevFqdn(normalizedShopFqdn)
   const url = `https://${fqdn}/app_dev/unstable/graphql.json`
 
   const addedHeaders = serviceEnvironment() === 'local' ? {'x-forwarded-host': normalizedShopFqdn} : undefined
 
   const result = limiter.schedule<TResult>(() =>
     graphqlRequestDoc<TResult, TVariables>({
-      query,
+      query: options.query,
       api,
       url,
-      token,
+      token: options.token,
       addedHeaders,
-      variables,
+      variables: options.variables,
+      unauthorizedHandler: options.unauthorizedHandler,
     }),
   )
 

packages/cli-kit/src/public/node/api/app-dev.test.ts

@@ -27,13 +27,18 @@ describe('appManagementRequestDoc', () => {
 
     // When
     const query = 'query' as unknown as TypedDocumentNode<object, {variables: string}>
-    await appManagementRequestDoc(
-      orgId,
+    await appManagementRequestDoc({
+      organizationId: orgId,
       query,
-      mockedToken,
-      {variables: 'variables'},
-      {cacheTTL: {hours: 1}, cacheExtraKey: '1234'},
-    )
+      token: mockedToken,
+      variables: {variables: 'variables'},
+      requestOptions: {requestMode: 'slow-request'},
+      cacheOptions: {cacheTTL: {hours: 1}, cacheExtraKey: `1234`},
+      unauthorizedHandler: {
+        type: 'token_refresh',
+        handler: vi.fn().mockResolvedValue({token: mockedToken}),
+      },
+    })
 
     // Then
     expect(graphqlRequestDoc).toHaveBeenLastCalledWith({
@@ -44,6 +49,11 @@ describe('appManagementRequestDoc', () => {
       variables: {variables: 'variables'},
       responseOptions: {onResponse: handleDeprecations},
       cacheOptions: {cacheTTL: {hours: 1}, cacheExtraKey: `1234${orgId}`},
+      preferredBehaviour: 'slow-request',
+      unauthorizedHandler: {
+        type: 'token_refresh',
+        handler: expect.any(Function),
+      },
     })
   })
 })

packages/cli-kit/src/public/node/api/app-dev.ts

@@ -50,38 +50,45 @@ export interface RequestOptions {
 }
 
 /**
- * Executes an org-scoped GraphQL query against the App Management API. Uses typed documents.
- *
  * @param orgId - The organization ID.
  * @param query - GraphQL query to execute.
  * @param token - Partners token.
  * @param variables - GraphQL variables to pass to the query.
  * @param cacheOptions - Cache options for the request. If not present, the request will not be cached.
  * @param requestOptions - Preferred behaviour for the request.
  * @param unauthorizedHandler - Optional handler for unauthorized requests.
+ */
+export interface AppManagementRequestOptions<TResult, TVariables extends Variables> {
+  organizationId: string
+  query: TypedDocumentNode<TResult, TVariables>
+  token: string
+  variables?: TVariables
+  cacheOptions?: CacheOptions
+  requestOptions?: RequestOptions
+  unauthorizedHandler: UnauthorizedHandler
+}
+
+/**
+ * Executes an org-scoped GraphQL query against the App Management API. Uses typed documents.
+ *
+ * @param options - The options for the request.
  * @returns The response of the query of generic type <T>.
  */
 export async function appManagementRequestDoc<TResult, TVariables extends Variables>(
-  orgId: string,
-  query: TypedDocumentNode<TResult, TVariables>,
-  token: string,
-  variables?: TVariables,
-  cacheOptions?: CacheOptions,
-  requestOptions?: RequestOptions,
-  unauthorizedHandler?: UnauthorizedHandler,
+  options: AppManagementRequestOptions<TResult, TVariables>,
 ): Promise<TResult> {
   // For app management, we need to cache the response based on the orgId.
-  const cacheExtraKey = (cacheOptions?.cacheExtraKey ?? '') + orgId
-  const newCacheOptions = cacheOptions ? {...cacheOptions, cacheExtraKey} : undefined
+  const cacheExtraKey = (options.cacheOptions?.cacheExtraKey ?? '') + options.organizationId
+  const newCacheOptions = options.cacheOptions ? {...options.cacheOptions, cacheExtraKey} : undefined
 
   const result = limiter.schedule<TResult>(async () =>
     graphqlRequestDoc<TResult, TVariables>({
-      ...(await setupRequest(orgId, token)),
-      query,
-      variables,
+      ...(await setupRequest(options.organizationId, options.token)),
+      query: options.query,
+      variables: options.variables,
       cacheOptions: newCacheOptions,
-      preferredBehaviour: requestOptions?.requestMode,
-      unauthorizedHandler,
+      preferredBehaviour: options.requestOptions?.requestMode,
+      unauthorizedHandler: options.unauthorizedHandler,
     }),
   )
 

packages/cli-kit/src/public/node/api/app-management.test.ts

@@ -1,4 +1,4 @@
-import {CacheOptions, Exact, GraphQLVariables, graphqlRequest, graphqlRequestDoc} from './graphql.js'
+import {CacheOptions, GraphQLVariables, UnauthorizedHandler, graphqlRequest, graphqlRequestDoc} from './graphql.js'
 import {handleDeprecations} from './partners.js'
 import {businessPlatformFqdn} from '../context/fqdn.js'
 import {TypedDocumentNode} from '@graphql-typed-document-node/core'
@@ -45,25 +45,34 @@ export async function businessPlatformRequest<T>(
 }
 
 /**
- * Executes a GraphQL query against the Business Platform Destinations API. Uses typed documents.
- *
  * @param query - GraphQL query to execute.
  * @param token - Business Platform token.
  * @param variables - GraphQL variables to pass to the query.
  * @param cacheOptions - Cache options for the request. If not present, the request will not be cached.
+ */
+export interface BusinessPlatformRequestOptions<TResult, TVariables extends Variables> {
+  query: TypedDocumentNode<TResult, TVariables>
+  token: string
+  variables?: TVariables
+  cacheOptions?: CacheOptions
+  unauthorizedHandler: UnauthorizedHandler
+}
+
+/**
+ * Executes a GraphQL query against the Business Platform Destinations API. Uses typed documents.
+ *
+ * @param options - The options for the request.
  * @returns The response of the query of generic type <TResult>.
  */
 export async function businessPlatformRequestDoc<TResult, TVariables extends Variables>(
-  query: TypedDocumentNode<TResult, TVariables>,
-  token: string,
-  variables?: TVariables,
-  cacheOptions?: CacheOptions,
+  options: BusinessPlatformRequestOptions<TResult, TVariables>,
 ): Promise<TResult> {
   return graphqlRequestDoc<TResult, TVariables>({
-    ...(await setupRequest(token)),
-    query,
-    variables,
-    cacheOptions,
+    ...(await setupRequest(options.token)),
+    query: options.query,
+    variables: options.variables,
+    cacheOptions: options.cacheOptions,
+    unauthorizedHandler: options.unauthorizedHandler,
   })
 }
 
@@ -85,46 +94,49 @@ async function setupOrganizationsRequest(token: string, organizationId: string)
   }
 }
 
+export interface BusinessPlatformOrganizationsRequestNonTypedOptions {
+  query: string
+  token: string
+  organizationId: string
+  unauthorizedHandler: UnauthorizedHandler
+  variables?: GraphQLVariables
+}
+
 /**
  * Executes a GraphQL query against the Business Platform Organizations API.
  *
- * @param query - GraphQL query to execute.
- * @param token - Business Platform token.
- * @param organizationId - Organization ID as a numeric (non-GID) value.
- * @param variables - GraphQL variables to pass to the query.
+ * @param options - The options for the request.
  * @returns The response of the query of generic type <T>.
  */
 export async function businessPlatformOrganizationsRequest<T>(
-  query: string,
-  token: string,
-  organizationId: string,
-  variables?: GraphQLVariables,
+  options: BusinessPlatformOrganizationsRequestNonTypedOptions,
 ): Promise<T> {
   return graphqlRequest<T>({
-    query,
-    ...(await setupOrganizationsRequest(token, organizationId)),
-    variables,
+    query: options.query,
+    ...(await setupOrganizationsRequest(options.token, options.organizationId)),
+    variables: options.variables,
+    unauthorizedHandler: options.unauthorizedHandler,
   })
 }
 
+export interface BusinessPlatformOrganizationsRequestOptions<TResult, TVariables extends Variables>
+  extends BusinessPlatformRequestOptions<TResult, TVariables> {
+  organizationId: string
+}
+
 /**
  * Executes a GraphQL query against the Business Platform Organizations API. Uses typed documents.
  *
- * @param query - GraphQL query to execute.
- * @param token - Business Platform token.
- * @param organizationId - Organization ID as a numeric value.
- * @param variables - GraphQL variables to pass to the query.
+ * @param options - The options for the request.
  * @returns The response of the query of generic type <T>.
  */
 export async function businessPlatformOrganizationsRequestDoc<TResult, TVariables extends Variables>(
-  query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{[key: string]: never}>>,
-  token: string,
-  organizationId: string,
-  variables?: TVariables,
+  options: BusinessPlatformOrganizationsRequestOptions<TResult, TVariables>,
 ): Promise<TResult> {
   return graphqlRequestDoc<TResult, TVariables>({
-    query,
-    ...(await setupOrganizationsRequest(token, organizationId)),
-    variables,
+    query: options.query,
+    ...(await setupOrganizationsRequest(options.token, options.organizationId)),
+    variables: options.variables,
+    unauthorizedHandler: options.unauthorizedHandler,
   })
 }