Merge pull request #5199 from Shopify/shauns/01-15-support_local_dev_in_cli

Support local dev in CLI

Author: shauns

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

@@ -56,6 +56,8 @@ import {DevSessionCreateMutation} from '../api/graphql/app-dev/generated/dev-ses
 import {DevSessionUpdateMutation} from '../api/graphql/app-dev/generated/dev-session-update.js'
 import {DevSessionDeleteMutation} from '../api/graphql/app-dev/generated/dev-session-delete.js'
 import {isAppManagementDisabled} from '@shopify/cli-kit/node/context/local'
+import {blockPartnersAccess} from '@shopify/cli-kit/node/environment'
+import {AbortError} from '@shopify/cli-kit/node/error'
 
 export enum ClientName {
   AppManagement = 'app-management',
@@ -77,7 +79,17 @@ export interface AppVersionIdentifiers {
 }
 
 export function allDeveloperPlatformClients(): DeveloperPlatformClient[] {
-  return isAppManagementDisabled() ? [new PartnersClient()] : [new PartnersClient(), new AppManagementClient()]
+  const clients: DeveloperPlatformClient[] = []
+  if (!blockPartnersAccess()) {
+    clients.push(new PartnersClient())
+  }
+  if (!isAppManagementDisabled()) {
+    clients.push(new AppManagementClient())
+  }
+  if (clients.length === 0) {
+    throw new AbortError('Both Partners and App Management APIs are deactivated.')
+  }
+  return clients
 }
 
 /**

packages/cli-kit/src/private/node/constants.ts

@@ -45,6 +45,7 @@ export const environmentVariables = {
   otelURL: 'SHOPIFY_CLI_OTEL_EXPORTER_OTLP_ENDPOINT',
   themeKitAccessDomain: 'SHOPIFY_CLI_THEME_KIT_ACCESS_DOMAIN',
   json: 'SHOPIFY_FLAG_JSON',
+  neverUsePartnersApi: 'SHOPIFY_CLI_NEVER_USE_PARTNERS_API',
 }
 
 export const defaultThemeKitAccessDomain = 'theme-kit-access.shopifyapps.com'

packages/cli-kit/src/public/node/context/fqdn.ts

@@ -1,7 +1,8 @@
 import {spinFqdn} from './spin.js'
-import {AbortError} from '../error.js'
+import {AbortError, BugError} from '../error.js'
 import {serviceEnvironment} from '../../../private/node/context/service.js'
 import {DevServer, DevServerCore} from '../vendor/dev_server/DevServer.js'
+import {blockPartnersAccess} from '../environment.js'
 
 export const CouldntObtainPartnersSpinFQDNError = new AbortError(
   "Couldn't obtain the Spin FQDN for Partners when the CLI is not running from a Spin environment.",
@@ -22,6 +23,9 @@ export const NotProvidedStoreFQDNError = new AbortError(
  * @returns Fully-qualified domain of the partners service we should interact with.
  */
 export async function partnersFqdn(): Promise<string> {
+  if (blockPartnersAccess()) {
+    throw new BugError('Partners API is blocked by the SHOPIFY_CLI_NEVER_USE_PARTNERS_API environment variable.')
+  }
   const environment = serviceEnvironment()
   const productionFqdn = 'partners.shopify.com'
   switch (environment) {

packages/cli-kit/src/public/node/environment.ts

@@ -82,3 +82,12 @@ export function getIdentityTokenInformation(): {accessToken: string; refreshToke
 export function jsonOutputEnabled(environment = getEnvironmentVariables()): boolean {
   return sniffForJson() || isTruthy(environment[environmentVariables.json])
 }
+
+/**
+ * If true, the CLI should not use the Partners API.
+ *
+ * @returns True if the SHOPIFY_CLI_NEVER_USE_PARTNERS_API environment variable is set.
+ */
+export function blockPartnersAccess(): boolean {
+  return isTruthy(getEnvironmentVariables()[environmentVariables.neverUsePartnersApi])
+}