Deprecate apiSecretKey being the access token for custom app

Shopify · Nov 21, 2024 · ca4791a · ca4791a
1 parent 709efd0
commit ca4791a
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 18 deletions.
diff --git a/.changeset/clever-taxis-retire.md b/.changeset/clever-taxis-retire.md
@@ -2,4 +2,6 @@
 '@shopify/shopify-api': patch
 ---
 
-[bugfix] Makes GQL client behavior on customn app config consistent with REST client
+[deprecation] Removes conditional check for `adminApiAccessToken` in REST client, deprecates `apiSecretKey` in favor of `adminApiAccessToken`
+[bugfix] Makes GQL client behavior on custom app config consistent with REST client
+[chore] Removes the warning about `adminApiAccessToken` and `apiSecretKey` being the same
diff --git a/packages/apps/shopify-api/lib/clients/admin/graphql/client.ts b/packages/apps/shopify-api/lib/clients/admin/graphql/client.ts
@@ -53,15 +53,12 @@ export class GraphqlClient {
       logger(config).debug(message);
     }
 
-    const customStoreAppAccessToken =
-      config.adminApiAccessToken ?? config.apiSecretKey;
-
     this.session = params.session;
     this.apiVersion = params.apiVersion;
 
     this.client = createAdminApiClient({
       accessToken: config.isCustomStoreApp
-        ? customStoreAppAccessToken
+        ? config.adminApiAccessToken!
         : this.session.accessToken!,
       apiVersion: this.apiVersion ?? config.apiVersion,
       storeDomain: this.session.shop,

diff --git a/packages/apps/shopify-api/lib/clients/admin/rest/client.ts b/packages/apps/shopify-api/lib/clients/admin/rest/client.ts
@@ -80,17 +80,14 @@ export class RestClient {
       logger(config).debug(message);
     }
 
-    const customStoreAppAccessToken =
-      config.adminApiAccessToken ?? config.apiSecretKey;
-
     this.session = session;
     this.apiVersion = apiVersion ?? config.apiVersion;
     this.client = createAdminRestApiClient({
       scheme: config.hostScheme,
       storeDomain: session.shop,
       apiVersion: apiVersion ?? config.apiVersion,
       accessToken: config.isCustomStoreApp
-        ? customStoreAppAccessToken
+        ? config.adminApiAccessToken!
         : session.accessToken!,
       customFetchApi: abstractFetch,
       logger: clientLoggerFactory(config),

diff --git a/packages/apps/shopify-api/lib/config.ts b/packages/apps/shopify-api/lib/config.ts
@@ -98,15 +98,6 @@ export function validateConfig<Params extends ConfigParams>(
     future: future ?? config.future,
   });
 
-  if (
-    config.isCustomStoreApp &&
-    params.adminApiAccessToken === params.apiSecretKey
-  ) {
-    createLogger(config).warning(
-      "adminApiAccessToken is set to the same value as apiSecretKey. adminApiAccessToken should be set to the Admin API access token for custom store apps; apiSecretKey should be set to the custom store app's API secret key.",
-    );
-  }
-
   return config;
 }