Merge pull request #1196 from Shopify/deprecate-unstable-tokenExchang…

…e-flag

Ensure tokenExchange is always available regardless of unstable_tokenExchange setting

.changeset/chilly-gorillas-fix.md

@@ -0,0 +1,5 @@
+---
+"@shopify/shopify-api": patch
+---
+
+Remove gating of the token exchange API behind the unstable_tokenExchange flag.

packages/shopify-api/adapters/__e2etests__/utils.ts

@@ -39,9 +39,7 @@ export const config: ConfigInterface = {
     httpRequests: false,
     timestamps: false,
   },
-  future: {
-    unstable_tokenExchange: true,
-  },
+  future: {},
 };
 
 export const session = new Session({

packages/shopify-api/docs/guides/oauth.md

@@ -47,19 +47,8 @@ See ["new embedded app authorization Strategy"](https://shopify.dev/docs/api/sho
   - [configured through the Shopify CLI](https://shopify.dev/docs/apps/tools/cli/configuration) or
   - install your app through the [authorization code grant flow](#authorization-code-grant-flow) (not recommended)
 
-2. Turn on future flag `unstable_tokenExchange` when configuring shopifyApi
-
-```ts
-shopifyApi({
-  ...
-  isEmbeddedApp: true,
-  future: {
-    unstable_tokenExchange: true,
-  },
-})
-```
-3. Start the OAuth process by calling [shopify.auth.tokenExchange](../reference/auth/tokenExchange.md) to exchange user session token to access token.
-4. Use the exchanged session token to make authenticated API queries, see [After OAuth](#after-oauth)
+2. Start the token acquisition process by calling [shopify.auth.tokenExchange](../reference/auth/tokenExchange.md) to exchange user session token to access token.
+3. Use the exchanged session token to make authenticated API queries, see [After OAuth](#after-oauth)
 
 #### Detecting scope changes
 

packages/shopify-api/future/flags.ts

@@ -2,10 +2,6 @@
  * Future flags are used to enable features that are not yet available by default.
  */
 export interface FutureFlags {
-  /**
-   * Enable the token exchange OAuth flow.
-   */
-  unstable_tokenExchange?: boolean;
   /**
    * Enable line item billing, to make billing configuration more similar to the GraphQL API.
    */

packages/shopify-api/lib/__tests__/test-config.ts

@@ -52,9 +52,10 @@ type TestConfig<Overrides extends TestOverridesOption<Future>, Future> = Modify<
  * This way, we'll always ensure our tests are covering all future flags. Please make sure to also have tests for the
  * old behaviour.
  */
-const TEST_FUTURE_FLAGS: Required<{[key in keyof FutureFlags]: true}> = {
+const TEST_FUTURE_FLAGS: Required<{
+  [key in keyof FutureFlags]: true;
+}> = {
   v10_lineItemBilling: true,
-  unstable_tokenExchange: true,
 } as const;
 
 const TEST_CONFIG = {

packages/shopify-api/lib/auth/index.ts

@@ -1,5 +1,4 @@
 import {ConfigInterface} from '../base-types';
-import {FeatureEnabled, FutureFlagOptions} from '../../future/flags';
 
 import {OAuthBegin, OAuthCallback, begin, callback} from './oauth/oauth';
 import {Nonce, nonce} from './oauth/nonce';
@@ -14,30 +13,26 @@ import {TokenExchange, tokenExchange} from './oauth/token-exchange';
 
 export function shopifyAuth<Config extends ConfigInterface>(
   config: Config,
-): ShopifyAuth<Config['future']> {
+): ShopifyAuth {
   const shopify = {
     begin: begin(config),
     callback: callback(config),
     nonce,
     safeCompare,
     getEmbeddedAppUrl: getEmbeddedAppUrl(config),
     buildEmbeddedAppUrl: buildEmbeddedAppUrl(config),
-  } as ShopifyAuth<Config['future']>;
-
-  if (config.future?.unstable_tokenExchange) {
-    shopify.tokenExchange = tokenExchange(config);
-  }
+    tokenExchange: tokenExchange(config),
+  } as ShopifyAuth;
 
   return shopify;
 }
 
-export type ShopifyAuth<Future extends FutureFlagOptions> = {
+export interface ShopifyAuth {
   begin: OAuthBegin;
   callback: OAuthCallback;
   nonce: Nonce;
   safeCompare: SafeCompare;
   getEmbeddedAppUrl: GetEmbeddedAppUrl;
   buildEmbeddedAppUrl: BuildEmbeddedAppUrl;
-} & (FeatureEnabled<Future, 'unstable_tokenExchange'> extends true
-  ? {tokenExchange: TokenExchange}
-  : Record<string, never>);
+  tokenExchange: TokenExchange;
+}

packages/shopify-api/lib/auth/oauth/__tests__/token-exchange.test.ts

@@ -209,18 +209,4 @@ describe('tokenExchange', () => {
       ).rejects.toThrow(ShopifyErrors.InvalidJwtError);
     });
   });
-
-  describe('with future flag disabled', () => {
-    test('shopifyAuth object does not have tokenExchange property', () => {
-      const shopify = shopifyApi(
-        testConfig({
-          future: {
-            unstable_tokenExchange: false,
-          },
-        }),
-      );
-
-      expect(shopify.auth).not.toHaveProperty('tokenExchange');
-    });
-  });
 });

packages/shopify-api/lib/index.ts

@@ -32,11 +32,11 @@ export * from './flow/types';
 export interface Shopify<
   Params extends ConfigParams = ConfigParams,
   Resources extends ShopifyRestResources = ShopifyRestResources,
-  Future extends FutureFlagOptions = FutureFlagOptions,
+  _Future extends FutureFlagOptions = FutureFlagOptions,
 > {
   config: ConfigInterface<Params>;
   clients: ShopifyClients;
-  auth: ShopifyAuth<Future>;
+  auth: ShopifyAuth;
   session: ShopifySession;
   utils: ShopifyUtils;
   webhooks: ShopifyWebhooks;