[eas-build] discourage Expo Go for production

Author: vonovak

packages/eas-cli/src/build/createContext.ts

@@ -75,6 +75,11 @@ export async function createBuildContextAsync<T extends Platform>({
   const projectName = exp.slug;
   const account = await getOwnerAccountForProjectIdAsync(graphqlClient, projectId);
   const workflow = await resolveWorkflowAsync(projectDir, platform, vcsClient);
+  const resourceClass = await resolveBuildResourceClassAsync(
+    buildProfile,
+    platform,
+    resourceClassFlag
+  );
   const accountId = account.id;
   const runFromCI = getenv.boolish('CI', false);
   const developmentClient =
@@ -118,12 +123,6 @@ export async function createBuildContextAsync<T extends Platform>({
   };
   analytics.logEvent(BuildEvent.BUILD_COMMAND, analyticsEventProperties);
 
-  const resourceClass = await resolveBuildResourceClassAsync(
-    buildProfile,
-    platform,
-    resourceClassFlag
-  );
-
   const commonContext: CommonContext<T> = {
     accountName: account.name,
     buildProfile,

packages/eas-cli/src/build/runBuildAndSubmit.ts

@@ -79,6 +79,7 @@ import { truthy } from '../utils/expodash/filter';
 import { printJsonOnlyOutput } from '../utils/json';
 import { ProfileData, getProfilesAsync } from '../utils/profiles';
 import { Client } from '../vcs/vcs';
+import { discourageExpoGoForProd } from '../project/discourageExpoGoForProd';
 
 let metroConfigValidated = false;
 let sdkVersionChecked = false;
@@ -146,6 +147,8 @@ export async function runBuildAndSubmitAsync({
     projectDir,
   });
 
+  discourageExpoGoForProd(buildProfiles, projectDir, vcsClient);
+
   for (const buildProfile of buildProfiles) {
     if (buildProfile.profile.image && ['default', 'stable'].includes(buildProfile.profile.image)) {
       Log.warn(

packages/eas-cli/src/project/__tests__/discourageExpoGoForProd-test.ts

@@ -0,0 +1,83 @@
+import { Platform, Workflow } from '@expo/eas-build-job';
+import getenv from 'getenv';
+import resolveFrom from 'resolve-from';
+
+import type { ProfileData } from '../../utils/profiles';
+import { resolveVcsClient } from '../../vcs';
+import { detectExpoGoProdBuildAsync } from '../discourageExpoGoForProd';
+
+jest.mock('getenv');
+jest.mock('resolve-from');
+jest.mock('../workflow', () => ({
+  resolveWorkflowPerPlatformAsync: jest.fn(),
+}));
+
+const mockResolveWorkflowPerPlatformAsync = jest.mocked(
+  require('../workflow').resolveWorkflowPerPlatformAsync
+);
+
+const projectDir = '/app';
+const vcsClient = resolveVcsClient();
+
+const createMockBuildProfile = (profileName: string): ProfileData<'build'> => ({
+  profileName,
+  platform: Platform.ANDROID,
+  profile: {} as any,
+});
+
+describe(detectExpoGoProdBuildAsync, () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+    jest.mocked(getenv.boolish).mockReturnValue(false);
+    jest.mocked(resolveFrom.silent).mockReturnValue(undefined); // expo-dev-client is not installed
+  });
+
+  describe('should return false', () => {
+    it.each([
+      ['non-production profiles', [createMockBuildProfile('development')]],
+      ['undefined buildProfiles', undefined],
+      ['empty buildProfiles', []],
+    ])('should return false for %s', async (_, buildProfiles) => {
+      const result = await detectExpoGoProdBuildAsync(buildProfiles, projectDir, vcsClient);
+
+      expect(result).toBe(false);
+      expect(mockResolveWorkflowPerPlatformAsync).not.toHaveBeenCalled();
+    });
+
+    it('when expo-dev-client is installed - that signals development build', async () => {
+      jest.mocked(resolveFrom.silent).mockReturnValue('/path/to/expo-dev-client/package.json');
+      const buildProfiles = [createMockBuildProfile('production')];
+
+      const result = await detectExpoGoProdBuildAsync(buildProfiles, projectDir, vcsClient);
+
+      expect(result).toBe(false);
+      expect(mockResolveWorkflowPerPlatformAsync).not.toHaveBeenCalled();
+    });
+
+    it('when either platform is "generic" - likely a bare RN project', async () => {
+      mockResolveWorkflowPerPlatformAsync.mockResolvedValue({
+        android: Workflow.GENERIC,
+        ios: Workflow.GENERIC,
+      });
+      const buildProfiles = [createMockBuildProfile('production')];
+
+      const result = await detectExpoGoProdBuildAsync(buildProfiles, projectDir, vcsClient);
+
+      expect(result).toBe(false);
+    });
+  });
+
+  describe('should return true', () => {
+    it('when production profile is used, there are no native directories (or are gitignored) AND expo-dev-client is not installed', async () => {
+      mockResolveWorkflowPerPlatformAsync.mockResolvedValue({
+        android: Workflow.MANAGED,
+        ios: Workflow.MANAGED,
+      });
+      const buildProfiles = [createMockBuildProfile('production')];
+
+      const result = await detectExpoGoProdBuildAsync(buildProfiles, projectDir, vcsClient);
+
+      expect(result).toBe(true);
+    });
+  });
+});

packages/eas-cli/src/project/discourageExpoGoForProd.ts

@@ -0,0 +1,71 @@
+import { Workflow } from '@expo/eas-build-job';
+import chalk from 'chalk';
+import getenv from 'getenv';
+import resolveFrom from 'resolve-from';
+
+import { resolveWorkflowPerPlatformAsync } from './workflow';
+import Log, { learnMore } from '../log';
+import type { ProfileData } from '../utils/profiles';
+import type { Client } from '../vcs/vcs';
+
+const envVarName = 'EAS_NO_EXPO_GO_WARNING';
+
+export const discourageExpoGoForProd = (
+  buildProfiles: ProfileData<'build'>[] | undefined,
+  projectDir: string,
+  vcsClient: Client
+): void => {
+  detectExpoGoProdBuildAsync(buildProfiles, projectDir, vcsClient)
+    .then(usesExpoGo => {
+      if (usesExpoGo) {
+        Log.newLine();
+        Log.warn(
+          `⚠️ It appears you're trying to build an app based on Expo Go for production. Expo Go is not a suitable environment for production apps.`
+        );
+        Log.warn(
+          learnMore('https://docs.expo.dev/develop/development-builds/expo-go-to-dev-build/', {
+            learnMoreMessage: 'Learn more about converting from Expo Go to a development build',
+            dim: false,
+          })
+        );
+        Log.warn(chalk.dim(`To suppress this warning, set ${chalk.bold(`${envVarName}=true`)}.`));
+        Log.newLine();
+      }
+    })
+    .catch(err => {
+      Log.warn('Error detecting whether Expo Go is used:', err);
+    });
+};
+
+export async function detectExpoGoProdBuildAsync(
+  buildProfiles: ProfileData<'build'>[] | undefined,
+  projectDir: string,
+  vcsClient: Client
+): Promise<boolean> {
+  const shouldSuppressWarning = getenv.boolish(envVarName, false);
+
+  const isProductionBuild = buildProfiles?.map(it => it.profileName).includes('production');
+  if (shouldSuppressWarning || !isProductionBuild) {
+    return false;
+  }
+
+  const hasExpoDevClient = checkIfExpoDevClientInstalled(projectDir);
+  if (hasExpoDevClient) {
+    return false;
+  }
+
+  return await checkIfManagedWorkflowAsync(projectDir, vcsClient);
+}
+
+async function checkIfManagedWorkflowAsync(
+  projectDir: string,
+  vcsClient: Client
+): Promise<boolean> {
+  const workflows = await resolveWorkflowPerPlatformAsync(projectDir, vcsClient);
+
+  return workflows.android === Workflow.MANAGED && workflows.ios === Workflow.MANAGED;
+}
+
+function checkIfExpoDevClientInstalled(projectDir: string): boolean {
+  return resolveFrom.silent(projectDir, 'expo-dev-client/package.json') !== undefined;
+}