Moved @react-native-community script internally into react-native/scripts

Summary:
This decouples the listing of modules from the linking of those modules into Cocoapods. I've made this backwards compatible, but our internal template wont lean on the community config.

The user can now override how they capture a list of React Native modules, providing an escape hatch for Framework authors to build on.

Changelog: [General][iOS] Use our fork of the react-native-communti/cli-platform-ios use_native_modues.rb script

Reviewed By: cipolleschi

Differential Revision: D56242486

fbshipit-source-id: 78505669ab6abd6718348388c3bfba3290f7071b

Author: blakef

packages/react-native/scripts/cocoapods/autolinking.rb

@@ -0,0 +1,204 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'json'
+require 'pathname'
+require 'cocoapods'
+require_relative './autolinking_utils.rb'
+
+# Your project will have to depend on the @react-native-community/cli if you use this method
+# for listing React native modules.
+#
+# Parameters:
+# - config_command: the command to run to get the application's current config, e.g. ['npx', '@react-native-community/cli', 'config']
+def list_native_modules!(config_command)
+
+  if !(config_command.is_a? Array and config_command.size > 0)
+    Pod::UI.warn "Expected a list_native_modules! to be called with a config command", [
+      "Unable to autolink if no config is provided for the current project."
+    ]
+    exit(1)
+  end
+
+  # Ignore stderr output, we're only interested in stdout and the return code. Libraries can output warnings to
+  # stderr which create problems for JSON deserializing.
+  json, _, status = Pod::Executable.capture_command(config_command[0], config_command[1..], capture: :both)
+
+  if not status.success?
+    Pod::UI.warn "The command: '#{config_command.join(" ").bold.yellow}' returned a status code of #{status.exitstatus.to_s.bold.red}", [
+        "In order to autolink using Cocoapods, this framework uses @react-native-community/cli to discover React Native native modules",
+        "Please either add it: yarn add -D @react-native-community/cli or consult your framework's documentation."
+    ]
+    exit(status.exitstatus)
+  end
+
+  config = JSON.parse(json)
+
+  packages = config["dependencies"]
+  ios_project_root = Pathname.new(config["project"]["ios"]["sourceDir"])
+  react_native_path = Pathname.new(config["reactNativePath"])
+  found_pods = []
+
+  packages.each do |package_name, package|
+    next unless package_config = package["platforms"]["ios"]
+
+    name = package["name"]
+    podspec_path = package_config["podspecPath"]
+    script_phases = package_config["scriptPhases"]
+    configurations = package_config["configurations"]
+
+    # Add a warning to the queue and continue to the next dependency if the podspec_path is nil/empty
+    if podspec_path.nil? || podspec_path.empty?
+      Pod::UI.warn("list_native_modules! skipped the react-native dependency '#{name}'. No podspec file was found.",
+        [
+          "Check to see if there is an updated version that contains the necessary podspec file",
+          "Contact the library maintainers or send them a PR to add a podspec. The react-native-webview podspec is a good example of a package.json driven podspec. See https://github.com/react-native-community/react-native-webview/blob/master/react-native-webview.podspec",
+          "If necessary, you can disable autolinking for the dependency and link it manually. See https://github.com/react-native-community/cli/blob/main/docs/autolinking.md#how-can-i-disable-autolinking-for-unsupported-library"
+        ])
+      next
+    end
+
+    spec = Pod::Specification.from_file(podspec_path)
+
+    # Skip pods that do not support the platform of the current target.
+    next unless AutolinkingUtils.is_platform_supported?(current_target_definition, spec)
+
+    podspec_dir_path = Pathname.new(File.dirname(podspec_path))
+
+    relative_path = podspec_dir_path.relative_path_from ios_project_root
+
+    found_pods.push({
+      "configurations": configurations,
+      "name": name,
+      "path": relative_path.to_path,
+      "podspec_path": podspec_path,
+      "script_phases": script_phases
+    })
+  end
+
+  if found_pods.size > 0
+    pods = found_pods.map { |p| p[:name] }.sort.to_sentence
+    Pod::UI.puts "Found #{found_pods.size} #{"module".pluralize(found_pods.size)} for target `#{current_target_definition.name}`"
+  end
+
+  return {
+    "ios_packages": found_pods,
+    "ios_project_root_path": ios_project_root.to_s,
+    "react_native_path": react_native_path.relative_path_from(ios_project_root).to_s
+  }
+end
+
+# Your project will have to depend on the @react-native-community/cli if you use this method
+# for listing React native modules.
+#
+# Parameters:
+# - config:
+#   - :ios_packages - Array of React Native iOS packages, e.g. [{ package_name: "Foo", package: { .. }}, ...]
+#   - :ios_project_root_path - Absolute path to the react_native project's ios folder, e.g. /Users/foobar/project/rn_project/ios
+#   - :react_native_path - Relative path to the react_native from the project, e.g. ./node_modules/react-native
+def link_native_modules!(config)
+  Pod::UI.puts "link_native_modules! #{config}"
+
+  if !(
+    config[:ios_packages].is_a? Array and
+    config[:ios_project_root_path].is_a? String and
+    config[:react_native_path].is_a? String
+  )
+    Pod::UI.warn("link_native_modules! has been called with a malformed 'config' parameter",
+      [
+        "This is the config argument passed: #{config.inspect}",
+      ]);
+    exit(1)
+  end
+
+  ios_project_root = config[:ios_project_root_path]
+
+  packages = config[:ios_packages]
+  found_pods = []
+
+  packages.each do |package|
+    podspec_path = package[:podspec_path]
+    configurations = package[:configurations]
+
+    # Add a warning to the queue and continue to the next dependency if the podspec_path is nil/empty
+    if podspec_path.nil? || podspec_path.empty?
+      Pod::UI.warn("use_native_modules! skipped the react-native dependency '#{package[:name]}'. No podspec file was found.",
+        [
+          "Check to see if there is an updated version that contains the necessary podspec file",
+          "Contact the library maintainers or send them a PR to add a podspec. The react-native-webview podspec is a good example of a package.json driven podspec. See https://github.com/react-native-community/react-native-webview/blob/master/react-native-webview.podspec",
+          "If necessary, you can disable autolinking for the dependency and link it manually. See https://github.com/react-native-community/cli/blob/main/docs/autolinking.md#how-can-i-disable-autolinking-for-unsupported-library"
+        ])
+      next
+    end
+
+    spec = Pod::Specification.from_file(podspec_path)
+
+    # Don't try track packages that exclude our platforms
+    next unless AutolinkingUtils.is_platform_supported?(current_target_definition, spec)
+
+    # We want to do a look up inside the current CocoaPods target
+    # to see if it's already included, this:
+    #   1. Gives you the chance to define it beforehand
+    #   2. Ensures CocoaPods won't explode if it's included twice
+    #
+    this_target = current_target_definition
+    existing_deps = current_target_definition.dependencies
+
+    # Skip dependencies that the user already activated themselves.
+    next if existing_deps.find do |existing_dep|
+      existing_dep.name.split('/').first == spec.name
+    end
+
+    podspec_dir_path = Pathname.new(File.dirname(podspec_path))
+
+    relative_path = podspec_dir_path.relative_path_from ios_project_root
+
+    # Register the found React Native module into our collection of Pods.
+    pod spec.name, :path => relative_path.to_path, :configurations => configurations
+
+    if package[:script_phases] && !this_target.abstract?
+      # Can be either an object, or an array of objects
+      Array(package[:script_phases]).each do |phase|
+        # see https://www.rubydoc.info/gems/cocoapods-core/Pod/Podfile/DSL#script_phase-instance_method
+        # for the full object keys
+        Pod::UI.puts "Adding a custom script phase for Pod #{spec.name}: #{phase["name"] || 'No name specified.'}"
+
+        # Support passing in a path relative to the root of the package
+        if phase["path"]
+          phase["script"] = File.read(File.expand_path(phase["path"], package["root"]))
+          phase.delete("path")
+        end
+
+        # Support converting the execution position into a symbol
+        phase["execution_position"] = phase["execution_position"]&.to_sym
+
+        phase = Hash[phase.map { |k, v| [k.to_sym, v] }]
+        script_phase phase
+      end
+    end
+
+    found_pods.push spec
+  end
+
+  if found_pods.size > 0
+    pods = found_pods.map { |p| p.name }.sort.to_sentence
+    Pod::UI.puts "Auto-linking React Native #{"module".pluralize(found_pods.size)} for target `#{current_target_definition.name}`: #{pods}"
+  end
+
+  return {
+    :reactNativePath => config[:react_native_path]
+  }
+end
+
+$default_command = ['node', '-e', "process.argv=['', '', 'config'];require('@react-native-community/cli').run()"];
+
+# Autolink your native modules
+#
+# Parameters:
+# - config_command: the command to run to get the application's current config, e.g. ['npx', '@react-native-community/cli', 'config'],
+#                   you can override this if you'd like to avoid the dependency. e.g. ['cat', 'your_config.json']
+def use_native_modules!(config_command = $default_command)
+  return link_native_modules!(list_native_modules!(config_command))
+end

packages/react-native/scripts/cocoapods/autolinking_utils.rb

@@ -0,0 +1,25 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+class AutolinkingUtils
+
+    def self.nested_path_exists?(object, *path)
+        path.reduce(object) do |obj, method|
+            return false unless obj.respond_to?(method)
+            obj.public_send(method)
+        end
+        return true
+    end
+
+    def self.is_platform_supported?(current_target_definition, spec)
+        platform = current_target_definition.platform
+        if !platform
+            # Historically we've supported platforms that aren't specifically excluded.
+            return true
+        end
+        return spec.supported_on_platform?(platform.name)
+    end
+
+end

packages/react-native/scripts/native_modules.rb

@@ -16,25 +16,15 @@
 require_relative './cocoapods/local_podspec_patch.rb'
 require_relative './cocoapods/runtime.rb'
 require_relative './cocoapods/helpers.rb'
+# Importing to expose use_native_modules!
+require_relative './cocoapods/autolinking.rb'
 
 $CODEGEN_OUTPUT_DIR = 'build/generated/ios'
 $CODEGEN_COMPONENT_DIR = 'react/renderer/components'
 $CODEGEN_MODULE_DIR = '.'
 
 $START_TIME = Time.now.to_i
 
-# `@react-native-community/cli-platform-ios/native_modules` defines
-# use_native_modules. We use node to resolve its path to allow for
-# different packager and workspace setups. This is reliant on
-# `@react-native-community/cli-platform-ios` being a direct dependency
-# of `react-native`.
-require Pod::Executable.execute_command('node', ['-p',
-  'require.resolve(
-    "@react-native-community/cli-platform-ios/native_modules.rb",
-    {paths: [process.argv[1]]},
-  )', __dir__]).strip
-
-
 def min_ios_version_supported
   return Helpers::Constants.min_ios_version_supported
 end