feat: add strict typing for supported platforms (#2218)

okwasniewski · web-flow · commit 6eb95951d9a4 · 2023-12-20T16:09:30.000+01:00
diff --git a/packages/cli-platform-apple/src/__tests__/pods.test.ts b/packages/cli-platform-apple/src/__tests__/pods.test.ts
@@ -76,7 +76,7 @@ describe('compareMd5Hashes', () => {
 
 describe('getPlatformDependencies', () => {
   it('should return only dependencies with native code', () => {
-    const result = getPlatformDependencies(dependenciesConfig);
+    const result = getPlatformDependencies(dependenciesConfig, 'ios');
     expect(result).toEqual(['dep1@1.0.0', 'dep2@1.0.0']);
   });
 });
@@ -85,7 +85,7 @@ describe('resolvePods', () => {
   it('should install pods if they are not installed', async () => {
     createTempFiles({'ios/Podfile/Manifest.lock': ''});
 
-    await resolvePods(DIR, {});
+    await resolvePods(DIR, {}, 'ios');
 
     expect(installPods).toHaveBeenCalled();
   });
@@ -101,7 +101,7 @@ describe('resolvePods', () => {
   it('should install pods when there is no cached hash of dependencies', async () => {
     createTempFiles();
 
-    await resolvePods(DIR, {});
+    await resolvePods(DIR, {}, 'ios');
 
     expect(mockSet).toHaveBeenCalledWith(
       packageJson.name,
@@ -115,7 +115,7 @@ describe('resolvePods', () => {
 
     mockGet.mockImplementation(() => dependencyHash);
 
-    await resolvePods(DIR, {});
+    await resolvePods(DIR, {}, 'ios');
 
     expect(installPods).not.toHaveBeenCalled();
   });
@@ -125,12 +125,16 @@ describe('resolvePods', () => {
 
     mockGet.mockImplementation(() => dependencyHash);
 
-    await resolvePods(DIR, {
-      dep1: {
-        name: 'dep1',
-        ...commonDepConfig,
+    await resolvePods(
+      DIR,
+      {
+        dep1: {
+          name: 'dep1',
+          ...commonDepConfig,
+        },
       },
-    });
+      'ios',
+    );
 
     expect(installPods).toHaveBeenCalled();
   });
diff --git a/packages/cli-platform-apple/src/commands/buildCommand/buildProject.ts b/packages/cli-platform-apple/src/commands/buildCommand/buildProject.ts
@@ -12,10 +12,12 @@ import {
 } from '@react-native-community/cli-tools';
 import type {BuildFlags} from './buildOptions';
 import {simulatorDestinationMap} from './simulatorDestinationMap';
+import {supportedPlatforms} from '../../config/supportedPlatforms';
+import {ApplePlatform} from '../../types';
 
 export function buildProject(
   xcodeProject: IOSProjectInfo,
-  platform: string,
+  platform: ApplePlatform,
   udid: string | undefined,
   mode: string,
   scheme: string,
@@ -27,7 +29,9 @@ export function buildProject(
     if (!simulatorDest) {
       reject(
         new CLIError(
-          `Unknown platform: ${platform}. Please, use one of: ios, macos, visionos, tvos.`,
+          `Unknown platform: ${platform}. Please, use one of: ${Object.values(
+            supportedPlatforms,
+          ).join(', ')}.`,
         ),
       );
       return;
diff --git a/packages/cli-platform-apple/src/commands/buildCommand/createBuild.ts b/packages/cli-platform-apple/src/commands/buildCommand/createBuild.ts
@@ -7,12 +7,16 @@ import {buildProject} from './buildProject';
 import {getConfiguration} from './getConfiguration';
 import {getXcodeProjectAndDir} from './getXcodeProjectAndDir';
 import {BuilderCommand} from '../../types';
+import {supportedPlatforms} from '../../config/supportedPlatforms';
 
 const createBuild =
   ({platformName}: BuilderCommand) =>
   async (_: Array<string>, ctx: Config, args: BuildFlags) => {
     const platform = ctx.project[platformName] as IOSProjectConfig;
-    if (platform === undefined) {
+    if (
+      platform === undefined ||
+      supportedPlatforms[platformName] === undefined
+    ) {
       throw new CLIError(`Unable to find ${platform} platform config`);
     }
 
diff --git a/packages/cli-platform-apple/src/commands/buildCommand/simulatorDestinationMap.ts b/packages/cli-platform-apple/src/commands/buildCommand/simulatorDestinationMap.ts
@@ -1,4 +1,6 @@
-export const simulatorDestinationMap: Record<string, string> = {
+import {ApplePlatform} from '../../types';
+
+export const simulatorDestinationMap: Record<ApplePlatform, string> = {
   ios: 'iOS Simulator',
   macos: 'macOS',
   visionos: 'visionOS Simulator',
diff --git a/packages/cli-platform-apple/src/commands/logCommand/createLog.ts b/packages/cli-platform-apple/src/commands/logCommand/createLog.ts
@@ -7,6 +7,7 @@ import getSimulators from '../../tools/getSimulators';
 import listDevices from '../../tools/listDevices';
 import {getPlatformInfo} from '../runCommand/getPlatformInfo';
 import {BuilderCommand} from '../../types';
+import {supportedPlatforms} from '../../config/supportedPlatforms';
 
 /**
  * Starts Apple device syslog tail
@@ -22,7 +23,10 @@ const createLog =
     const platform = ctx.project[platformName] as IOSProjectConfig;
     const {readableName: platformReadableName} = getPlatformInfo(platformName);
 
-    if (platform === undefined) {
+    if (
+      platform === undefined ||
+      supportedPlatforms[platformName] === undefined
+    ) {
       throw new CLIError(`Unable to find ${platform} platform config`);
     }
 
diff --git a/packages/cli-platform-apple/src/commands/runCommand/createRun.ts b/packages/cli-platform-apple/src/commands/runCommand/createRun.ts
@@ -33,6 +33,7 @@ import {printFoundDevices, matchingDevice} from './matchingDevice';
 import {runOnDevice} from './runOnDevice';
 import {runOnSimulator} from './runOnSimulator';
 import {BuilderCommand} from '../../types';
+import {supportedPlatforms} from '../../config/supportedPlatforms';
 
 export interface FlagsT extends BuildFlags {
   simulator?: string;
@@ -54,7 +55,10 @@ const createRun =
     const {sdkNames, readableName: platformReadableName} =
       getPlatformInfo(platformName);
 
-    if (platform === undefined) {
+    if (
+      platform === undefined ||
+      supportedPlatforms[platformName] === undefined
+    ) {
       throw new CLIError(
         `Unable to find ${platformReadableName} platform config`,
       );
diff --git a/packages/cli-platform-apple/src/commands/runCommand/getPlatformInfo.ts b/packages/cli-platform-apple/src/commands/runCommand/getPlatformInfo.ts
@@ -1,3 +1,5 @@
+import {ApplePlatform} from '../../types';
+
 interface PlatformInfo {
   readableName: string;
   sdkNames: string[];
@@ -9,7 +11,7 @@ interface PlatformInfo {
  *
  * Falls back to iOS if platform is not supported.
  */
-export function getPlatformInfo(platform: string): PlatformInfo {
+export function getPlatformInfo(platform: ApplePlatform): PlatformInfo {
   const iosPlatformInfo: PlatformInfo = {
     readableName: 'iOS',
     sdkNames: ['iphonesimulator', 'iphoneos'],
diff --git a/packages/cli-platform-apple/src/commands/runCommand/runOnDevice.ts b/packages/cli-platform-apple/src/commands/runCommand/runOnDevice.ts
@@ -1,5 +1,5 @@
 import child_process from 'child_process';
-import {Device} from '../../types';
+import {ApplePlatform, Device} from '../../types';
 import {IOSProjectInfo} from '@react-native-community/cli-types';
 import {CLIError, logger} from '@react-native-community/cli-tools';
 import chalk from 'chalk';
@@ -9,7 +9,7 @@ import {FlagsT} from './createRun';
 
 export async function runOnDevice(
   selectedDevice: Device,
-  platform: string,
+  platform: ApplePlatform,
   mode: string,
   scheme: string,
   xcodeProject: IOSProjectInfo,
diff --git a/packages/cli-platform-apple/src/commands/runCommand/runOnSimulator.ts b/packages/cli-platform-apple/src/commands/runCommand/runOnSimulator.ts
@@ -3,15 +3,15 @@ import {IOSProjectInfo} from '@react-native-community/cli-types';
 import path from 'path';
 import {logger} from '@react-native-community/cli-tools';
 import chalk from 'chalk';
-import {Device} from '../../types';
+import {ApplePlatform, Device} from '../../types';
 import {buildProject} from '../buildCommand/buildProject';
 import {formattedDeviceName} from './matchingDevice';
 import {getBuildPath} from './getBuildPath';
 import {FlagsT} from './createRun';
 
 export async function runOnSimulator(
   xcodeProject: IOSProjectInfo,
-  platform: string,
+  platform: ApplePlatform,
   mode: string,
   scheme: string,
   args: FlagsT,
diff --git a/packages/cli-platform-apple/src/config/__tests__/findPodfilePath.test.ts b/packages/cli-platform-apple/src/config/__tests__/findPodfilePath.test.ts
@@ -14,12 +14,12 @@ afterEach(() => {
 describe('ios::findPodfilePath', () => {
   it('returns null if there is no Podfile', () => {
     fs.__setMockFilesystem({});
-    expect(findPodfilePath('/')).toBeNull();
+    expect(findPodfilePath('/', 'ios')).toBeNull();
   });
 
   it('returns Podfile path if it exists', () => {
     fs.__setMockFilesystem(projects.project);
-    expect(findPodfilePath('/')).toContain('ios/Podfile');
+    expect(findPodfilePath('/', 'ios')).toContain('ios/Podfile');
   });
 
   it('prints a warning when multile Podfiles are found', () => {
@@ -28,7 +28,7 @@ describe('ios::findPodfilePath', () => {
       foo: projects.project,
       bar: projects.project,
     });
-    expect(findPodfilePath('/')).toContain('bar/ios/Podfile');
+    expect(findPodfilePath('/', 'ios')).toContain('bar/ios/Podfile');
     expect(warn.mock.calls).toMatchSnapshot();
   });
 
diff --git a/packages/cli-platform-apple/src/config/findPodfilePath.ts b/packages/cli-platform-apple/src/config/findPodfilePath.ts
@@ -9,6 +9,7 @@
 import {inlineString, logger} from '@react-native-community/cli-tools';
 import path from 'path';
 import findAllPodfilePaths from './findAllPodfilePaths';
+import {ApplePlatform} from '../types';
 
 // Regexp matching all test projects
 const TEST_PROJECTS = /test|example|sample/i;
@@ -18,7 +19,7 @@ const BUNDLE_VENDORED_PODFILE = 'vendor/bundle/ruby';
 
 export default function findPodfilePath(
   cwd: string,
-  platformName: string = 'ios',
+  platformName: ApplePlatform,
 ) {
   const podfiles = findAllPodfilePaths(cwd)
     /**
diff --git a/packages/cli-platform-apple/src/config/supportedPlatforms.ts b/packages/cli-platform-apple/src/config/supportedPlatforms.ts
@@ -0,0 +1,6 @@
+export const supportedPlatforms = {
+  ios: 'ios',
+  macos: 'macos',
+  visionos: 'visionos',
+  tvos: 'tvos',
+} as const;
diff --git a/packages/cli-platform-apple/src/tools/pods.ts b/packages/cli-platform-apple/src/tools/pods.ts
@@ -13,6 +13,7 @@ import {
   DependencyConfig,
   IOSDependencyConfig,
 } from '@react-native-community/cli-types';
+import {ApplePlatform} from '../types';
 
 interface ResolvePodsOptions {
   forceInstall?: boolean;
@@ -35,7 +36,7 @@ export function getPackageJson(root: string) {
 
 export function getPlatformDependencies(
   dependencies: NativeDependencies,
-  platformName: string = 'ios',
+  platformName: ApplePlatform,
 ) {
   return Object.keys(dependencies)
     .filter((dependency) => dependencies[dependency].platforms?.[platformName])
@@ -91,7 +92,7 @@ async function install(
 export default async function resolvePods(
   root: string,
   nativeDependencies: NativeDependencies,
-  platformName: string = 'ios',
+  platformName: ApplePlatform,
   options?: ResolvePodsOptions,
 ) {
   const packageJson = getPackageJson(root);
diff --git a/packages/cli-platform-apple/src/types.ts b/packages/cli-platform-apple/src/types.ts
@@ -1,3 +1,8 @@
+import {supportedPlatforms} from './config/supportedPlatforms';
+
+type ObjectValues<T> = T[keyof T];
+
+export type ApplePlatform = ObjectValues<typeof supportedPlatforms>;
 export interface Device {
   name: string;
   udid: string;
@@ -23,5 +28,5 @@ export interface BuilderCommand {
    * Lowercase name of the platform.
    * Example: 'ios', 'visionos'
    */
-  platformName: string;
+  platformName: ApplePlatform;
 }
