Propagating changes after v9 release

Shopify · Jan 10, 2024 · 04b0f05 · 04b0f05
1 parent 351b9ae
commit 04b0f05
Show file tree

Hide file tree

Showing 30 changed files with 90 additions and 72 deletions.
diff --git a/.changeset/thirty-apples-think.md b/.changeset/thirty-apples-think.md
@@ -3,3 +3,5 @@
 ---
 
 Adding support for the new clients from `@shopify/admin-api-client` and `@shopify/storefront-api-client` that can leverage `@shopify/api-codegen-preset` to automatically type GraphQL operations using Codegen.
+
+For more information on how to add types to your queries, see [the `@shopify/api-codegen-preset` documentation](https://github.com/Shopify/shopify-api-js/tree/main/packages/api-codegen-preset).
diff --git a/packages/shopify-app-express/package.json b/packages/shopify-app-express/package.json
@@ -30,7 +30,7 @@
     "Storefront API"
   ],
   "dependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2",
     "@shopify/shopify-app-session-storage-memory": "^2.0.2",
     "cookie-parser": "^1.4.6",

diff --git a/packages/shopify-app-express/src/__tests__/integration/oauth.test.ts b/packages/shopify-app-express/src/__tests__/integration/oauth.test.ts
@@ -335,7 +335,7 @@ function assertOAuthRequests(
     expect({
       method: 'POST',
       url: `https://${TEST_SHOP}/admin/api/${LATEST_API_VERSION}/graphql.json`,
-      body: expect.stringContaining(query),
+      body: expect.objectContaining({query: expect.stringContaining(query)}),
     }).toMatchMadeHttpRequest(),
   );
 

diff --git a/packages/shopify-app-express/src/__tests__/integration/webhooks.test.ts b/packages/shopify-app-express/src/__tests__/integration/webhooks.test.ts
@@ -127,7 +127,9 @@ describe('webhook integration', () => {
             expect({
               method: 'POST',
               url: `https://${TEST_SHOP}/admin/api/${LATEST_API_VERSION}/graphql.json`,
-              body: expect.stringContaining(query),
+              body: expect.objectContaining({
+                query: expect.stringContaining(query),
+              }),
             }).toMatchMadeHttpRequest(),
           );
 

diff --git a/packages/shopify-app-express/src/__tests__/test-helper.ts b/packages/shopify-app-express/src/__tests__/test-helper.ts
@@ -73,7 +73,7 @@ interface AssertHttpRequestParams {
 export function mockShopifyResponse(body: MockBody, init?: MockParams) {
   fetchMock.mockResponse(
     typeof body === 'string' ? body : JSON.stringify(body),
-    init,
+    mockResponseInit(init),
   );
 }
 
@@ -84,13 +84,22 @@ export function mockShopifyResponses(
     ([body, init]) => {
       const bodyString = typeof body === 'string' ? body : JSON.stringify(body);
 
-      return init ? [bodyString, init] : [bodyString, {}];
+      return [bodyString, mockResponseInit(init)];
     },
   );
 
   fetchMock.mockResponses(...parsedResponses);
 }
 
+function mockResponseInit(init?: MockParams): MockParams {
+  const initObj = init ?? {};
+
+  return {
+    ...initObj,
+    headers: {'Content-Type': 'application/json', ...initObj.headers},
+  };
+}
+
 declare global {
   // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace jest {

diff --git a/packages/shopify-app-express/src/auth/auth-callback.ts b/packages/shopify-app-express/src/auth/auth-callback.ts
@@ -2,7 +2,7 @@ import {Request, Response} from 'express';
 import {
   BotActivityDetected,
   CookieNotFound,
-  gdprTopics,
+  privacyTopics,
   InvalidOAuthError,
   Session,
   Shopify,
@@ -83,7 +83,7 @@ async function registerWebhooks(
     }
 
     for (const response of responsesByTopic[topic]) {
-      if (!response.success && !gdprTopics.includes(topic)) {
+      if (!response.success && !privacyTopics.includes(topic)) {
         const result: any = response.result;
 
         if (result.errors) {

diff --git a/packages/shopify-app-express/src/middlewares/__tests__/ensure-installed-on-shop.test.ts b/packages/shopify-app-express/src/middlewares/__tests__/ensure-installed-on-shop.test.ts
@@ -167,7 +167,10 @@ describe('ensureInstalledOnShop', () => {
       )}`,
     ];
 
-    mockShopifyResponse({});
+    mockShopifyResponse({
+      data: {},
+      extensions: {},
+    });
     await shopify.config.sessionStorage.storeSession(session);
 
     await request(app)

diff --git a/...ages/shopify-app-express/src/middlewares/__tests__/validate-authenticated-session.test.ts b/...ages/shopify-app-express/src/middlewares/__tests__/validate-authenticated-session.test.ts
@@ -266,7 +266,10 @@ describe('validateAuthenticatedSession', () => {
     });
 
     it('finds a session with the right cookie', async () => {
-      mockShopifyResponse({});
+      mockShopifyResponse({
+        data: {},
+        extensions: {},
+      });
 
       const response = await request(app)
         .get('/test/shop?shop=my-shop.myshopify.io')

diff --git a/packages/shopify-app-remix/package.json b/packages/shopify-app-remix/package.json
@@ -68,10 +68,10 @@
   },
   "dependencies": {
     "@remix-run/server-runtime": "^2.0.0",
-    "@shopify/admin-api-client": "^0.1.0",
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/admin-api-client": "^0.2.0",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2",
-    "@shopify/storefront-api-client": "^0.1.1",
+    "@shopify/storefront-api-client": "^0.2.0",
     "isbot": "^3.7.1",
     "semver": "^7.5.4",
     "tslib": "^2.6.2"

diff --git a/packages/shopify-app-remix/src/server/__test-helpers/expect-admin-api-client.ts b/packages/shopify-app-remix/src/server/__test-helpers/expect-admin-api-client.ts
@@ -96,15 +96,17 @@ export function expectAdminApiClient(
           headers: {'X-Shopify-Access-Token': actualSession.accessToken!},
         },
       ),
-      response: new Response(JSON.stringify({shop: {name: 'Test shop'}})),
+      response: new Response(
+        JSON.stringify({data: {shop: {name: 'Test shop'}}}),
+      ),
     });
 
     // WHEN
     const response = await admin.graphql('{ shop { name } }');
 
     // THEN
     expect(response.status).toEqual(200);
-    expect(await response.json()).toEqual({shop: {name: 'Test shop'}});
+    expect(await response.json()).toEqual({data: {shop: {name: 'Test shop'}}});
   });
 
   it('returns a session object as part of the context', async () => {

diff --git a/packages/shopify-app-remix/src/server/__test-helpers/expect-storefront-api-client.ts b/packages/shopify-app-remix/src/server/__test-helpers/expect-storefront-api-client.ts
@@ -16,7 +16,7 @@ export function expectStorefrontApiClient(
   it('Storefront client can perform GraphQL Requests', async () => {
     // GIVEN
     const {storefront, actualSession} = await factory();
-    const apiResponse = {blogs: {nodes: [{id: 1}]}};
+    const apiResponse = {data: {blogs: {nodes: [{id: 1}]}}};
     await mockExternalRequest({
       request: new Request(
         `https://${TEST_SHOP}/api/${LATEST_API_VERSION}/graphql.json`,

diff --git a/packages/shopify-app-remix/src/server/__test-helpers/request-mock.ts b/packages/shopify-app-remix/src/server/__test-helpers/request-mock.ts
@@ -45,7 +45,10 @@ async function mockParams(response: Response): Promise<ResponseParams> {
       status: response.status,
       statusText: response.statusText,
       url: response.url,
-      headers: Object.fromEntries(response.headers.entries()),
+      headers: {
+        ...Object.fromEntries(response.headers.entries()),
+        'content-type': 'application/json',
+      },
     },
   };
 }

diff --git a/packages/shopify-app-remix/src/server/authenticate/admin/__tests__/admin-client.test.ts b/packages/shopify-app-remix/src/server/authenticate/admin/__tests__/admin-client.test.ts
@@ -231,7 +231,7 @@ async function mockRestRequest(status) {
 
   await mockExternalRequest({
     request: requestMock,
-    response: new Response(undefined, {status}),
+    response: new Response('{}', {status}),
   });
 
   return requestMock;

diff --git a/...admin/strategies/__tests__/auth-code-flow/auth-code-flow/ensure-installed-on-shop.test.ts b/...admin/strategies/__tests__/auth-code-flow/auth-code-flow/ensure-installed-on-shop.test.ts
@@ -80,10 +80,10 @@ describe('authorize.admin doc request path', () => {
 
       await mockExternalRequest({
         request: new Request(GRAPHQL_URL, {method: 'POST'}),
-        response: new Response(
-          JSON.stringify({errors: [{message: 'Something went wrong!'}]}),
-          {status: 500, statusText: 'Internal Server Error'},
-        ),
+        response: new Response('', {
+          status: 500,
+          statusText: 'Internal Server Error',
+        }),
       });
 
       // WHEN
@@ -96,7 +96,7 @@ describe('authorize.admin doc request path', () => {
       expect(response.status).toBe(500);
       expect(config.logger?.log).toHaveBeenCalledWith(
         LogSeverity.Error,
-        expect.stringContaining('Something went wrong!'),
+        expect.stringContaining('Internal Server Error'),
       );
     });
 
@@ -109,7 +109,7 @@ describe('authorize.admin doc request path', () => {
       await mockExternalRequest({
         request: new Request(GRAPHQL_URL, {method: 'POST'}),
         response: new Response(
-          JSON.stringify({errors: ['Something went wrong!']}),
+          JSON.stringify({errors: [{message: 'Something went wrong!'}]}),
         ),
       });
 

diff --git a/packages/shopify-app-remix/src/server/authenticate/admin/strategies/auth-code-flow.ts b/packages/shopify-app-remix/src/server/authenticate/admin/strategies/auth-code-flow.ts
@@ -223,7 +223,7 @@ export class AuthCodeFlowStrategy<
       session,
     });
 
-    await client.query(`#graphql
+    await client.request(`#graphql
       query shopifyAppShopName {
         shop {
           name

diff --git a/packages/shopify-app-remix/src/server/authenticate/webhooks/__tests__/register.test.ts b/packages/shopify-app-remix/src/server/authenticate/webhooks/__tests__/register.test.ts
@@ -97,9 +97,7 @@ describe('Webhook registration', () => {
           body: 'webhookSubscriptionCreate',
         }),
         response: new Response(
-          JSON.stringify({
-            body: mockResponses.HTTP_WEBHOOK_CREATE_ERROR_RESPONSE,
-          }),
+          JSON.stringify(mockResponses.HTTP_WEBHOOK_CREATE_ERROR_RESPONSE),
         ),
       },
     );

diff --git a/packages/shopify-app-remix/src/server/clients/admin/graphql.ts b/packages/shopify-app-remix/src/server/clients/admin/graphql.ts
@@ -1,4 +1,3 @@
-import {flatHeaders} from '@shopify/shopify-api/runtime';
 import {AdminOperations} from '@shopify/admin-api-client';
 
 import {GraphQLClient} from '../types';
@@ -22,15 +21,13 @@ export function graphqlClientFactory({
 
     try {
       // We convert the incoming response to a Response object to bring this client closer to the Remix client.
-      const apiResponse = await client.query(operation, {
+      const apiResponse = await client.request(operation, {
         variables: options?.variables,
-        tries: options?.tries,
-        extraHeaders: options?.headers,
+        retries: options?.tries ? options.tries - 1 : 0,
+        headers: options?.headers,
       });
 
-      return new Response(JSON.stringify(apiResponse.body), {
-        headers: flatHeaders(apiResponse.headers),
-      });
+      return new Response(JSON.stringify(apiResponse));
     } catch (error) {
       if (handleClientError) {
         throw await handleClientError({error, params, session});

diff --git a/packages/shopify-app-remix/src/server/clients/storefront/factory.ts b/packages/shopify-app-remix/src/server/clients/storefront/factory.ts
@@ -1,4 +1,3 @@
-import {flatHeaders} from '@shopify/shopify-api/runtime';
 import {Session} from '@shopify/shopify-api';
 
 import {BasicParams} from '../../types';
@@ -21,15 +20,13 @@ export function storefrontClientFactory({
         apiVersion: options.apiVersion,
       });
 
-      const apiResponse = await client.query(query, {
+      const apiResponse = await client.request(query, {
         variables: options?.variables,
-        tries: options?.tries,
-        extraHeaders: options?.headers,
+        retries: options?.tries ? options.tries - 1 : 0,
+        headers: options?.headers,
       });
 
-      return new Response(JSON.stringify(apiResponse.body), {
-        headers: flatHeaders(apiResponse.headers),
-      });
+      return new Response(JSON.stringify(apiResponse));
     },
   };
 }
diff --git a/packages/shopify-app-session-storage-dynamodb/package.json b/packages/shopify-app-session-storage-dynamodb/package.json
@@ -37,13 +37,13 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2"
   },
   "devDependencies": {
     "@shopify/eslint-plugin": "^42.1.0",
     "@shopify/prettier-config": "^1.1.2",
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2",
     "@shopify/shopify-app-session-storage-test-utils": "^1.0.2",
     "eslint": "^8.55.0",

diff --git a/packages/shopify-app-session-storage-kv/package.json b/packages/shopify-app-session-storage-kv/package.json
@@ -36,7 +36,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2"
   },
   "devDependencies": {

diff --git a/packages/shopify-app-session-storage-memory/package.json b/packages/shopify-app-session-storage-memory/package.json
@@ -33,7 +33,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2"
   },
   "devDependencies": {

diff --git a/packages/shopify-app-session-storage-mongodb/package.json b/packages/shopify-app-session-storage-mongodb/package.json
@@ -35,7 +35,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2"
   },
   "devDependencies": {

diff --git a/packages/shopify-app-session-storage-mysql/package.json b/packages/shopify-app-session-storage-mysql/package.json
@@ -36,7 +36,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2"
   },
   "devDependencies": {

diff --git a/packages/shopify-app-session-storage-postgresql/package.json b/packages/shopify-app-session-storage-postgresql/package.json
@@ -37,7 +37,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2"
   },
   "devDependencies": {

diff --git a/packages/shopify-app-session-storage-prisma/package.json b/packages/shopify-app-session-storage-prisma/package.json
@@ -35,13 +35,13 @@
   },
   "peerDependencies": {
     "@prisma/client": "^4.13.0",
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2",
     "prisma": "^4.13.0"
   },
   "devDependencies": {
     "@prisma/client": "^4.13.0",
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2",
     "prisma": "^4.13.0",
     "@shopify/eslint-plugin": "^42.1.0",

diff --git a/packages/shopify-app-session-storage-redis/package.json b/packages/shopify-app-session-storage-redis/package.json
@@ -36,7 +36,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2"
   },
   "devDependencies": {

diff --git a/packages/shopify-app-session-storage-sqlite/package.json b/packages/shopify-app-session-storage-sqlite/package.json
@@ -36,7 +36,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2"
   },
   "devDependencies": {

diff --git a/packages/shopify-app-session-storage-test-utils/package.json b/packages/shopify-app-session-storage-test-utils/package.json
@@ -38,7 +38,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1",
+    "@shopify/shopify-api": "^9.0.0",
     "@shopify/shopify-app-session-storage": "^2.0.2"
   },
   "devDependencies": {

diff --git a/packages/shopify-app-session-storage/package.json b/packages/shopify-app-session-storage/package.json
@@ -34,7 +34,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shopify/shopify-api": "^8.1.1"
+    "@shopify/shopify-api": "^9.0.0"
   },
   "devDependencies": {
     "@shopify/eslint-plugin": "^42.1.0",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,5 @@
		---

		Adding support for the new clients from `@shopify/admin-api-client` and `@shopify/storefront-api-client` that can leverage `@shopify/api-codegen-preset` to automatically type GraphQL operations using Codegen.

		For more information on how to add types to your queries, see [the `@shopify/api-codegen-preset` documentation](https://github.com/Shopify/shopify-api-js/tree/main/packages/api-codegen-preset).