Merge pull request #1743 from Shopify/revert-1705-zoey/remove-future-…

…flag

Revert "Remove future flag for released feature"

packages/apps/shopify-app-remix/src/server/__test-helpers/test-config.ts

@@ -14,6 +14,7 @@ import type {FutureFlags, FutureFlagOptions} from '../future/flags';
  */
 const TEST_FUTURE_FLAGS: Required<{[key in keyof FutureFlags]: true}> = {
   unstable_newEmbeddedAuthStrategy: true,
+  wip_optionalScopesApi: true,
 } as const;
 
 // Override the helper's future flags and logger settings for our purposes

packages/apps/shopify-app-remix/src/server/authenticate/admin/authenticate.ts

@@ -132,10 +132,13 @@ export function authStrategyFactory<
   }
 
   function addScopesFeatures(context: AdminContextBase) {
-    return {
-      ...context,
-      scopes: scopesApiFactory(params, context.session, context.admin),
-    };
+    if (config.future.wip_optionalScopesApi) {
+      return {
+        ...context,
+        scopes: scopesApiFactory(params, context.session, context.admin),
+      };
+    }
+    return context;
   }
 
   return async function authenticateAdmin(request: Request) {

packages/apps/shopify-app-remix/src/server/authenticate/admin/scope/__tests__/request.test.ts

@@ -17,13 +17,13 @@ import * as redirect from '../../helpers/redirect-to-install-page';
 
 import * as responses from './mock-responses';
 
-it('scopes api is available without any future flags', async () => {
+it('when the future flag is disabled the scopes api is not available', async () => {
   // GIVEN
   const shopify = shopifyApp(
     testConfig({
       isEmbeddedApp: false,
       scopes: undefined,
-      future: {},
+      future: {wip_optionalScopesApi: false},
     }),
   );
   const session = await setUpValidSession(shopify.sessionStorage);
@@ -39,7 +39,7 @@ it('scopes api is available without any future flags', async () => {
   const adminApi = await shopify.authenticate.admin(request);
 
   // THEN
-  expect(adminApi).toHaveProperty('scopes');
+  expect(adminApi).not.toHaveProperty('scopes');
 });
 
 it('when scopes are empty the request is not redirected', async () => {

packages/apps/shopify-app-remix/src/server/authenticate/admin/types.ts

@@ -3,6 +3,7 @@ import {JwtPayload, Session, ShopifyRestResources} from '@shopify/shopify-api';
 import {EnsureCORSFunction} from '../helpers/ensure-cors-headers';
 import type {AppConfigArg} from '../../config-types';
 import type {AdminApiContext} from '../../clients';
+import {FeatureEnabled} from '../../future/flags';
 
 import type {BillingContext} from './billing/types';
 import {RedirectFunction} from './helpers/redirect';
@@ -204,7 +205,10 @@ export interface ScopesContext {
 export type AdminContext<
   Config extends AppConfigArg,
   Resources extends ShopifyRestResources,
-> = EmbeddedTypedAdminContext<Config, Resources> & ScopesContext;
+> =
+  FeatureEnabled<Config['future'], 'wip_optionalScopesApi'> extends true
+    ? EmbeddedTypedAdminContext<Config, Resources> & ScopesContext
+    : EmbeddedTypedAdminContext<Config, Resources>;
 
 export type AuthenticateAdmin<
   Config extends AppConfigArg,

packages/apps/shopify-app-remix/src/server/future/flags.ts

@@ -18,6 +18,13 @@ export interface FutureFlags {
    * @default false
    */
   unstable_newEmbeddedAuthStrategy?: boolean;
+
+  /**
+   * When enabled, the Scopes API will be available. This feature is in development and requires special permissions from Shopify for now.
+   *
+   * @default false
+   */
+  wip_optionalScopesApi?: boolean;
 }
 
 // When adding new flags, use this format:
@@ -56,4 +63,11 @@ export function logDisabledFutureFlags(
         '\n  Your app must be using Shopify managed install: https://shopify.dev/docs/apps/auth/installation',
     );
   }
+
+  if (!config.future.wip_optionalScopesApi) {
+    logFlag(
+      'wip_optionalScopesApi',
+      'Enable this to use the optionalScopes API to request additional scopes and manage them. ',
+    );
+  }
 }