expo-modules-autolinking 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -10,7 +10,13 @@
 
 ### 💡 Others
 
-## 1.2.0 — 2023-04-13
+## 1.3.0 — 2023-05-08
+
+### 🎉 New features
+
+- Generating `ExpoModulesProvider.swift` in the build phase script instead of only `pod install`. ([#21108](https://github.com/expo/expo/pull/21108) by [@tsapeta](https://github.com/tsapeta))
+
+## 1.2.0 - 2023-04-13
 
 ### 🎉 New features
 

package/README.md

@@ -16,7 +16,7 @@ Scripts that autolink Expo modules.
 
 # Installation in managed Expo projects
 
-For [managed](https://docs.expo.dev/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation). If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.
+For [managed](https://docs.expo.dev/archive/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation). If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.
 
 # Installation in bare React Native projects
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-modules-autolinking",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Scripts that autolink Expo modules.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -48,5 +48,5 @@
     "find-up": "^5.0.0",
     "fs-extra": "^9.1.0"
   },
-  "gitHead": "362ed24e78a57e9839afd2925d2af4aff7e28437"
+  "gitHead": "4ba50c428c8369bb6b3a51a860d4898ad4ccbe78"
 }

package/scripts/ios/autolinking_manager.rb

@@ -103,6 +103,11 @@ module Expo
       @options.fetch(:providerName, Constants::MODULES_PROVIDER_FILE_NAME)
     end
 
+    # Absolute path to `Pods/Target Support Files/<pods target name>/<modules provider file>` within the project path
+    public def modules_provider_path(target)
+      File.join(target.support_files_dir, modules_provider_name)
+    end
+
     # For now there is no need to generate the modules provider for testing.
     public def should_generate_modules_provider?
       return !@options.fetch(:testsOnly, false)
@@ -126,20 +131,11 @@ module Expo
       end
     end
 
-    private def node_command_args(command_name)
+    public def base_command_args
       search_paths = @options.fetch(:searchPaths, @options.fetch(:modules_paths, nil))
       ignore_paths = @options.fetch(:ignorePaths, nil)
       exclude = @options.fetch(:exclude, [])
-
-      args = [
-        'node',
-        '--no-warnings',
-        '--eval',
-        'require(\'expo-modules-autolinking\')(process.argv.slice(1))',
-        command_name,
-        '--platform',
-        'ios'
-      ]
+      args = []
 
       if !search_paths.nil? && !search_paths.empty?
         args.concat(search_paths)
@@ -156,11 +152,24 @@ module Expo
       args
     end
 
+    private def node_command_args(command_name)
+      eval_command_args = [
+        'node',
+        '--no-warnings',
+        '--eval',
+        'require(\'expo-modules-autolinking\')(process.argv.slice(1))',
+        command_name,
+        '--platform',
+        'ios'
+      ]
+      return eval_command_args.concat(base_command_args())
+    end
+
     private def resolve_command_args
       node_command_args('resolve').concat(['--json'])
     end
 
-    private def generate_package_list_command_args(target_path)
+    public def generate_package_list_command_args(target_path)
       node_command_args('generate-package-list').concat([
         '--target',
         target_path

package/scripts/ios/constants.rb

@@ -3,5 +3,7 @@ module Expo
   module Constants
     GENERATED_GROUP_NAME = 'ExpoModulesProviders'
     MODULES_PROVIDER_FILE_NAME = 'ExpoModulesProvider.swift'
+    CONFIGURE_PROJECT_BUILD_SCRIPT_NAME = '[Expo] Configure project'
+    CONFIGURE_PROJECT_SCRIPT_FILE_NAME = 'expo-configure-project.sh'
   end
 end

package/scripts/ios/project_integrator.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+require 'colored2'
 
 module Expo
   module ProjectIntegrator
@@ -32,15 +34,15 @@ module Expo
         # The user target name (without `Pods-` prefix which is a part of `target.name`)
         target_name = target.target_definition.name
 
-        UI.message '- Generating the provider for ' << target_name.green << ' target' do
-          # PBXNativeTarget of the user target
-          native_target = project.native_targets.find { |native_target| native_target.name == target_name }
+        # PBXNativeTarget of the user target
+        native_target = project.native_targets.find { |native_target| native_target.name == target_name }
 
-          # Shorthand ref for the autolinking manager.
-          autolinking_manager = target.target_definition.autolinking_manager
+        # Shorthand ref for the autolinking manager.
+        autolinking_manager = target.target_definition.autolinking_manager
 
-          # Absolute path to `Pods/Target Support Files/<pods target name>/<modules provider file>` within the project path
-          modules_provider_path = File.join(target.support_files_dir, autolinking_manager.modules_provider_name)
+        UI.message '- Generating the provider for ' << target_name.green << ' target' do
+          # Get the absolute path to the modules provider
+          modules_provider_path = autolinking_manager.modules_provider_path(target)
 
           # Run `expo-modules-autolinking` command to generate the file
           autolinking_manager.generate_package_list(target_name, modules_provider_path)
@@ -62,6 +64,8 @@ module Expo
             end
           end
         end
+
+        integrate_build_script(autolinking_manager, project, target, native_target)
       end
 
       # Remove the generated group if it has nothing left inside
@@ -128,5 +132,135 @@ module Expo
       end
     end
 
-  end # module ExpoAutolinkingExtension
+    # Makes sure that the build script configuring the project is installed,
+    # is up-to-date and is placed before the "Compile Sources" phase.
+    def self.integrate_build_script(autolinking_manager, project, target, native_target)
+      build_phases = native_target.build_phases
+      modules_provider_path = autolinking_manager.modules_provider_path(target)
+
+      # Look for our own build script phase
+      xcode_build_script = native_target.shell_script_build_phases.find { |script|
+        script.name == Constants::CONFIGURE_PROJECT_BUILD_SCRIPT_NAME
+      }
+
+      if xcode_build_script.nil?
+        # Inform the user that we added a build script.
+        puts "[Expo] ".blue << "Installing the build script for target " << native_target.name.green
+
+        # Create a new build script in the target, it's added as the last phase
+        xcode_build_script = native_target.new_shell_script_build_phase(Constants::CONFIGURE_PROJECT_BUILD_SCRIPT_NAME)
+      end
+
+      # Make sure it is before the "Compile Sources" build phase
+      xcode_build_script_index = build_phases.find_index(xcode_build_script)
+      compile_sources_index = build_phases.find_index { |phase|
+        phase.is_a?(Xcodeproj::Project::PBXSourcesBuildPhase)
+      }
+
+      if xcode_build_script_index.nil?
+        # This is almost impossible to get here as the script was just created with `new_shell_script_build_phase`
+        # that puts the script at the end of the phases, but let's log it just in case.
+        puts "[Expo] ".blue << "Unable to find the configuring build script in the Xcode project".red
+      end
+
+      if compile_sources_index.nil?
+        # In this case the project will probably not compile but that's not our fault
+        # and it doesn't block us from updating our build script.
+        puts "[Expo] ".blue << "Unable to find the compilation build phase in the Xcode project".red
+      end
+
+      # Insert our script before the "Compile Sources" phase when necessary
+      unless compile_sources_index.nil? || xcode_build_script_index < compile_sources_index
+        build_phases.insert(
+          compile_sources_index,
+          build_phases.delete_at(xcode_build_script_index)
+        )
+      end
+
+      # Get path to the script that will be added to the target support files
+      support_script_path = File.join(target.support_files_dir, Constants::CONFIGURE_PROJECT_SCRIPT_FILE_NAME)
+      support_script_relative_path = Pathname.new(support_script_path).relative_path_from(project.project_dir)
+
+      # Write to the shell script so it's always in-sync with the autolinking configuration
+      IO.write(
+        support_script_path,
+        generate_support_script(autolinking_manager, modules_provider_path)
+      )
+
+      # Make the support script executable
+      FileUtils.chmod('+x', support_script_path)
+
+      # Force the build phase script to run on each build (including incremental builds)
+      xcode_build_script.always_out_of_date = '1'
+
+      # Make sure the build script in Xcode is up to date, but probably it's not going to change
+      # as it just runs the script generated in the target support files
+      xcode_build_script.shell_script = generate_xcode_build_script(support_script_relative_path)
+    end
+
+    # Generates the shell script of the build script phase.
+    # Try not to modify this since it involves changes in the pbxproj so
+    # it's better to modify the support script instead, if possible.
+    def self.generate_xcode_build_script(script_relative_path)
+      escaped_path = script_relative_path.to_s.gsub(/[^a-zA-Z0-9,\._\+@%\/\-]/) { |char| "\\#{char}" }
+
+      <<~XCODE_BUILD_SCRIPT
+      # This script configures Expo modules and generates the modules provider file.
+      bash -l -c "./#{escaped_path}"
+      XCODE_BUILD_SCRIPT
+    end
+
+    # Generates the support script that is executed by the build script phase.
+    def self.generate_support_script(autolinking_manager, modules_provider_path)
+      args = autolinking_manager.base_command_args.map { |arg| "\"#{arg}\"" }.join(' ')
+
+      <<~SUPPORT_SCRIPT
+      #!/usr/bin/env bash
+      # @generated by expo-modules-autolinking
+
+      set -eo pipefail
+
+      function with_node() {
+        # Start with a default
+        export NODE_BINARY=$(command -v node)
+
+        # Override the default with the global environment
+        ENV_PATH="$PODS_ROOT/../.xcode.env"
+        if [[ -f "$ENV_PATH" ]]; then
+          source "$ENV_PATH"
+        fi
+
+        # Override the global with the local environment
+        LOCAL_ENV_PATH="${ENV_PATH}.local"
+        if [[ -f "$LOCAL_ENV_PATH" ]]; then
+          source "$LOCAL_ENV_PATH"
+        fi
+
+        if [[ -n "$NODE_BINARY" && -x "$NODE_BINARY" ]]; then
+          echo "Node found at: ${NODE_BINARY}"
+        else
+          cat >&2 << NODE_NOT_FOUND
+      error: Could not find "node" executable while running an Xcode build script.
+      You need to specify the path to your Node.js executable by defining an environment variable named NODE_BINARY in your project's .xcode.env or .xcode.env.local file.
+      You can set this up quickly by running:
+
+      echo "export NODE_BINARY=\\$(command -v node)" >> .xcode.env
+
+      in the ios folder of your project.
+      NODE_NOT_FOUND
+
+          exit 1
+        fi
+
+        # Execute argument, if present
+        if [[ "$#" -gt 0 ]]; then
+          "$NODE_BINARY" "$@"
+        fi
+      }
+
+      with_node --no-warnings --eval "require(\'expo-modules-autolinking\')(process.argv.slice(1))" generate-package-list #{args} --target "#{modules_provider_path}"
+      SUPPORT_SCRIPT
+    end
+
+  end # module ProjectIntegrator
 end # module Expo