refactor: move pods installation from init to ios-specific commands (#2077)

* remove pod installation from init process

* create dependency hashes and store it in cache

* move installPods from doctor to platform-ios

* install pods on run-ios and build-ios

* add --force-pods flag to run-ios

* add tests

* add tests for pods installation

* use crypto and rename releaseCacheManager to cacheManager

* move run sudo to cli-tools

* use findPodfilePath

* resolve only native dependencies for pod check

* update pod installation tests

* add version property to dependency config & use it to hash dependencies

* cr updates

* add pod installation prompt to init

* better error handling when package.json not found

* add --install-pods flag to init

* update tests

* fix config tests

* set hash in cache when initializing new project

* try/catch require package.json

* update type for installCocoaPods

Author: TMisiukiewicz

__e2e__/config.test.ts

@@ -49,7 +49,7 @@ beforeAll(() => {
 
   // Initialise React Native project
 
-  runCLI(DIR, ['init', 'TestProject']);
+  runCLI(DIR, ['init', 'TestProject', '--install-pods']);
 
   // Link CLI to the project
   const pkgs = [

__e2e__/init.test.ts

@@ -61,7 +61,14 @@ test('init fails if the directory already exists', () => {
 
 test('init should prompt for the project name', () => {
   createCustomTemplateFiles();
-  const {stdout} = runCLI(DIR, ['init', 'test', '--template', templatePath]);
+  const {stdout} = runCLI(DIR, [
+    'init',
+    'test',
+    '--template',
+    templatePath,
+    '--install-pods',
+    'false',
+  ]);
 
   (prompts as jest.MockedFunction<typeof prompts>).mockReturnValue(
     Promise.resolve({
@@ -79,6 +86,8 @@ test('init --template filepath', () => {
     '--template',
     templatePath,
     'TestInit',
+    '--install-pods',
+    'false',
   ]);
 
   expect(stdout).toContain('Run instructions');
@@ -103,6 +112,8 @@ test('init --template file with custom directory', () => {
     projectName,
     '--directory',
     'custom-path',
+    '--install-pods',
+    'false',
   ]);
 
   // make sure --directory option is used in run instructions
@@ -149,6 +160,8 @@ test('init uses npm as the package manager with --npm', () => {
     templatePath,
     'TestInit',
     '--npm',
+    '--install-pods',
+    'false',
   ]);
 
   expect(stdout).toContain('Run instructions');

__e2e__/root.test.ts

@@ -23,8 +23,7 @@ beforeAll(() => {
   writeFiles(cwd, {});
 
   // Initialise React Native project
-  runCLI(cwd, ['init', 'TestProject']);
-
+  runCLI(cwd, ['init', 'TestProject', '--install-pods']);
   // Link CLI to the project
   const pkgs = [
     '@react-native-community/cli-platform-ios',

docs/commands.md

@@ -96,6 +96,10 @@ module.exports = {
 
 Skip dependencies installation
 
+#### `--install-pods [boolean]`
+
+Determine if CocoaPods should be installed when initializing a project. If set to `true` it will install pods, if set to `false`, it will skip the step entirely. If not used, prompt will be displayed
+
 #### `--npm`
 > [!WARNING]  
 > `--npm` is deprecated and will be removed in the future. Please use `--pm npm` instead.

docs/platforms.md

@@ -111,6 +111,7 @@ On Android and iOS, this function returns a dependency configuration for:
 ```ts
 type IOSDependencyConfig = {
   podspecPath: string;
+  version: string;
   scriptPhases: Array<IOSScriptPhase>;
   configurations: string[];
 };

packages/cli-config/src/__tests__/__snapshots__/index-test.ts.snap

@@ -11,6 +11,7 @@ Object {
       ],
       "podspecPath": "<<REPLACED>>/node_modules/react-native-test/ReactNativeTest.podspec",
       "scriptPhases": Array [],
+      "version": "unresolved",
     },
   },
   "root": "<<REPLACED>>/node_modules/react-native-test",
@@ -57,6 +58,7 @@ Object {
           "path": "./phase.sh",
         },
       ],
+      "version": "unresolved",
     },
   },
   "root": "<<REPLACED>>/node_modules/react-native-test",
@@ -107,6 +109,7 @@ Object {
           "show_env_vars_in_log": false,
         },
       ],
+      "version": "unresolved",
     },
   },
   "root": "<<REPLACED>>/node_modules/react-native-test",
@@ -131,6 +134,7 @@ Object {
         "configurations": Array [],
         "podspecPath": "<<REPLACED>>/node_modules/react-native-test/ReactNativeTest.podspec",
         "scriptPhases": Array [],
+        "version": "unresolved",
       },
     },
     "root": "<<REPLACED>>/node_modules/react-native-test",
@@ -149,6 +153,7 @@ Object {
       ],
       "podspecPath": "<<REPLACED>>/node_modules/react-native-test/ReactNativeTest.podspec",
       "scriptPhases": Array [],
+      "version": "unresolved",
     },
   },
   "root": "<<REPLACED>>/node_modules/react-native-test",

packages/cli-config/src/__tests__/index-test.ts

@@ -241,6 +241,14 @@ test('supports dependencies from user configuration with custom root and propert
   writeFiles(DIR, {
     ...REACT_NATIVE_MOCK,
     'native-libs/local-lib/LocalRNLibrary.podspec': '',
+    'native-libs/local-lib/package.json': `
+    {
+      "name": "local-lib",
+      "version": "0.0.1",
+      "dependencies": {
+        "react-native": "0.0.1"
+      }
+    }`,
     'react-native.config.js': `
 const path = require('path');
 const root = path.resolve('${escapePathSeparator(
@@ -276,6 +284,7 @@ module.exports = {
           "configurations": Array [],
           "podspecPath": "custom-path",
           "scriptPhases": Array [],
+          "version": "0.0.1",
         },
       },
       "root": "<<REPLACED>>/native-libs/local-lib",

packages/cli-config/src/schema.ts

@@ -122,6 +122,7 @@ export const projectConfig = t
               // IOSDependencyConfig
               .object({
                 podspecPath: t.string(),
+                version: t.string(),
                 configurations: t.array().items(t.string()).default([]),
                 scriptPhases: t.array().items(t.object()).default([]),
               })

packages/cli-doctor/package.json

@@ -24,7 +24,6 @@
     "prompts": "^2.4.2",
     "semver": "^7.5.2",
     "strip-ansi": "^5.2.0",
-    "sudo-prompt": "^9.0.0",
     "wcwidth": "^1.0.1",
     "yaml": "^2.2.1"
   },

packages/cli-doctor/src/index.ts

@@ -9,4 +9,3 @@ export const commands = {info, doctor};
  * refactor the init in order to remove that connection.
  */
 export {default as versionRanges} from './tools/versionRanges';
-export {default as installPods} from './tools/installPods';