fix(apple): filter Node wrappers before writing env files (#2252)

Author: tido64

ios/node.rb

@@ -0,0 +1,25 @@
+require('json')
+require_relative('pod_helpers')
+
+def find_node
+  # If `pod install` is run inside a "virtual" environment like
+  # [Yarn](https://yarnpkg.com/), we might find Node wrappers instead of the
+  # actual binary.
+  paths = `type --all --path node`.split("\n")
+  i = paths.find_index { |bin| `file #{bin}`.include? 'Mach-O' }
+  raise 'Could not find Node' if i.nil?
+
+  paths[i]
+end
+
+def nearest_node_modules(project_root)
+  path = find_file('node_modules', project_root)
+  assert(!path.nil?, "Could not find 'node_modules'")
+
+  path
+end
+
+def package_version(package_path)
+  package_json = JSON.parse(File.read(File.join(package_path, 'package.json')))
+  Gem::Version.new(package_json['version'])
+end

ios/pod_helpers.rb

@@ -98,12 +98,6 @@ def try_pod(name, podspec, project_root)
   pod name, :podspec => podspec if File.exist?(File.join(project_root, podspec))
 end
 
-def override_build_settings!(build_settings, settings_to_append)
-  settings_to_append&.each do |setting, value|
-    build_settings[setting] = value
-  end
-end
-
 def use_hermes?(options)
   use_hermes = ENV.fetch('USE_HERMES', nil)
   return use_hermes == '1' unless use_hermes.nil?

ios/test_app.rb

@@ -4,6 +4,7 @@
 require_relative('assets_catalog')
 require_relative('entitlements')
 require_relative('info_plist')
+require_relative('node')
 require_relative('pod_helpers')
 require_relative('privacy_manifest')
 require_relative('xcode')
@@ -34,18 +35,6 @@ def autolink_script_path(project_root, target_platform)
   File.join(package_path, 'native_modules')
 end
 
-def nearest_node_modules(project_root)
-  path = find_file('node_modules', project_root)
-  assert(!path.nil?, "Could not find 'node_modules'")
-
-  path
-end
-
-def package_version(package_path)
-  package_json = JSON.parse(File.read(File.join(package_path, 'package.json')))
-  Gem::Version.new(package_json['version'])
-end
-
 def react_native_path(project_root, target_platform)
   @react_native_path ||= {}
 
@@ -217,14 +206,10 @@ def make_project!(xcodeproj, project_root, target_platform, options)
   end
 
   # Note the location of Node so we can use it later in script phases
-  File.open(File.join(project_root, '.xcode.env'), 'w') do |f|
-    node_bin = `which node`.strip!
-    f.write("export NODE_BINARY=#{node_bin}\n")
-  end
-  File.open(File.join(destination, '.env'), 'w') do |f|
-    node_bin = `dirname $(which node)`.strip!
-    f.write("export PATH=#{node_bin}:$PATH\n")
-  end
+  node_bin = find_node
+  File.write(File.join(project_root, '.xcode.env'), "export NODE_BINARY='#{node_bin}'\n")
+  File.write(File.join(destination, '.env'),
+             "export PATH=#{`dirname '#{node_bin}'`.strip!}:$PATH\n")
 
   react_native = react_native_path(project_root, target_platform)
   rn_version = package_version(react_native.to_s).segments

ios/xcode.rb

@@ -14,3 +14,9 @@
 PRODUCT_VERSION = 'PRODUCT_VERSION'.freeze
 USER_HEADER_SEARCH_PATHS = 'USER_HEADER_SEARCH_PATHS'.freeze
 WARNING_CFLAGS = 'WARNING_CFLAGS'.freeze
+
+def override_build_settings!(build_settings, overrides)
+  overrides&.each do |setting, value|
+    build_settings[setting] = value
+  end
+end

test/pack.test.ts

@@ -150,6 +150,7 @@ describe("npm pack", () => {
       "ios/assets_catalog.rb",
       "ios/entitlements.rb",
       "ios/info_plist.rb",
+      "ios/node.rb",
       "ios/pod_helpers.rb",
       "ios/privacy_manifest.rb",
       "ios/test_app.rb",

test/test_node.rb

@@ -0,0 +1,31 @@
+require('minitest/autorun')
+
+require_relative('../ios/node')
+
+def fixture_path(*args)
+  Pathname.new(__dir__).join('__fixtures__', *args)
+end
+
+class TestTestApp < Minitest::Test
+  def test_nearest_node_modules
+    expected = fixture_path('test_app', 'node_modules')
+
+    assert_equal(expected, nearest_node_modules(fixture_path('test_app')))
+
+    react_native = fixture_path('test_app', 'node_modules', 'react-native')
+
+    assert_equal(expected, nearest_node_modules(react_native))
+
+    assert_equal(expected, nearest_node_modules(fixture_path('test_app', 'src')))
+  end
+
+  def test_package_version
+    react_native = fixture_path('test_app', 'node_modules', 'react-native')
+
+    assert_equal(Gem::Version.new('1000.0.0'), package_version(react_native))
+
+    cli = fixture_path('test_app', 'node_modules', '@react-native-community', 'cli-platform-ios')
+
+    assert_equal(Gem::Version.new('4.10.1'), package_version(cli))
+  end
+end

test/test_pod_helpers.rb

@@ -112,30 +112,4 @@ def test_v
     assert_equal(1_001_000, v(1, 1, 0))
     assert_equal(1_001_001, v(1, 1, 1))
   end
-
-  def test_override_build_settings
-    build_settings = { 'OTHER_LDFLAGS' => '-l"Pods-TestApp"', 'ONLY_ACTIVE_ARCH' => 'NO' }
-
-    override_build_settings!(build_settings, {})
-
-    assert_equal('-l"Pods-TestApp"', build_settings['OTHER_LDFLAGS'])
-
-    override_build_settings!(build_settings, { 'OTHER_LDFLAGS' => ' -ObjC' })
-
-    assert_equal(' -ObjC', build_settings['OTHER_LDFLAGS'])
-
-    # Test passing a table
-    build_settings_arr = { 'OTHER_LDFLAGS' => ['$(inherited)', '-l"Pods-TestApp"'] }
-    override_build_settings!(build_settings_arr, { 'OTHER_LDFLAGS' => [' -ObjC'] })
-
-    assert_equal([' -ObjC'], build_settings_arr['OTHER_LDFLAGS'])
-
-    # Test setting a new key
-    override_build_settings!(build_settings, { 'OTHER_CFLAGS' => '-DDEBUG' })
-
-    assert_equal('-DDEBUG', build_settings['OTHER_CFLAGS'])
-    override_build_settings!(build_settings, { 'ONLY_ACTIVE_ARCH' => 'YES' })
-
-    assert_equal('YES', build_settings['ONLY_ACTIVE_ARCH'])
-  end
 end

test/test_test_app.rb

@@ -43,28 +43,6 @@ def test_autolink_script_path
     end
   end
 
-  def test_nearest_node_modules
-    expected = fixture_path('test_app', 'node_modules')
-
-    assert_equal(expected, nearest_node_modules(fixture_path('test_app')))
-
-    react_native = fixture_path('test_app', 'node_modules', 'react-native')
-
-    assert_equal(expected, nearest_node_modules(react_native))
-
-    assert_equal(expected, nearest_node_modules(fixture_path('test_app', 'src')))
-  end
-
-  def test_package_version
-    react_native = fixture_path('test_app', 'node_modules', 'react-native')
-
-    assert_equal(Gem::Version.new('1000.0.0'), package_version(react_native))
-
-    cli = fixture_path('test_app', 'node_modules', '@react-native-community', 'cli-platform-ios')
-
-    assert_equal(Gem::Version.new('4.10.1'), package_version(cli))
-  end
-
   def test_react_native_pods
     [
       [0, '0.71'],

test/test_xcode.rb

@@ -0,0 +1,32 @@
+require('minitest/autorun')
+
+require_relative('../ios/xcode')
+
+class TestXcode < Minitest::Test
+  def test_override_build_settings
+    build_settings = { 'OTHER_LDFLAGS' => '-l"Pods-TestApp"', 'ONLY_ACTIVE_ARCH' => 'NO' }
+
+    override_build_settings!(build_settings, {})
+
+    assert_equal('-l"Pods-TestApp"', build_settings['OTHER_LDFLAGS'])
+
+    override_build_settings!(build_settings, { 'OTHER_LDFLAGS' => '-ObjC' })
+
+    assert_equal('-ObjC', build_settings['OTHER_LDFLAGS'])
+
+    # Test passing a table
+    build_settings_arr = { 'OTHER_LDFLAGS' => ['$(inherited)', '-l"Pods-TestApp"'] }
+    override_build_settings!(build_settings_arr, { 'OTHER_LDFLAGS' => ['-ObjC'] })
+
+    assert_equal(['-ObjC'], build_settings_arr['OTHER_LDFLAGS'])
+
+    # Test setting a new key
+    override_build_settings!(build_settings, { 'OTHER_CFLAGS' => '-DDEBUG' })
+
+    assert_equal('-DDEBUG', build_settings['OTHER_CFLAGS'])
+
+    override_build_settings!(build_settings, { 'ONLY_ACTIVE_ARCH' => 'YES' })
+
+    assert_equal('YES', build_settings['ONLY_ACTIVE_ARCH'])
+  end
+end