Deprecate source-login-scripts.sh (expo#18330)

# Why

the `source-login-scripts.sh` introduced a lot of pain where the community reported much build errors from it. it doesn't support shells other than zsh and bash. this pr find a new way to deal with xcode building issues that it cannot find the correct nodejs path.

close ENG-4864
close ENG-5242

# How

react-native introduces `.xcode.env` and `.xcode.env.local` for developers to override the `$NODE_BINARY`: facebook/react-native#33546

to make sure building success from expo-constants, expo-updates, and also the app target when generating bundles. i would like to reuse the `.xcode.env` and `.xcode.env.local` from react-native. this pr further generates `.xcode.env.local` automatically for the app during `pod install`. we can ensure that `pod install` is executed from shell and nodejs is available. so we will generate `export NODE_BINARY="$(command -v node)"` in the `.xcode.env.local`. for xcode, the path will be `$PODS_ROOT/../.xcode.env.local`, every xcode subprojects can source the file to get correct `$NODE_BINARY`.

# Test Plan

- building bare-expo from xcode (opening xcode by macos finder)
- building bare-expo by `yarn ios`
- updates e2e ci passed
- building expo-go (prerequisite: expo#18344) 

Co-authored-by: James Ide <[email protected]>

Author: 2 people

.gitattributes

@@ -1,8 +1,4 @@
-*.pbxproj binary linguist-generated
-ios/Exponent.xcodeproj/project.pbxproj merge=union -text diff linguist-generated
-apps/bare-expo/ios/BareExpo.xcodeproj/project.pbxproj merge=union -text diff linguist-generated
-apps/bare-sandbox/ios/bare-sandbox.xcodeproj/project.pbxproj merge=union -text diff linguist-generated
-templates/expo-template-bare-minimum/ios/HelloWorld.xcodeproj/project.pbxproj merge=union -text diff linguist-generated
+*.pbxproj merge=union -text diff linguist-generated
 packages/*/build/** -diff linguist-generated
 packages/*/plugin/build/** -diff linguist-generated
 packages/@*/*/build/** -diff linguist-generated

.github/actions/expo-caches/action.yml

@@ -107,8 +107,6 @@ runs:
       id: tools-modules-cache
       with:
         path: |
-          bin/et
-          bin/expotools
           tools/node_modules
         key: ${{ runner.os }}-tools-modules-${{ hashFiles('tools/yarn.lock') }}
 

.gitignore

@@ -148,4 +148,5 @@ docs/pages/versions/*/react-native/*.diff
 # iOS
 /ios/Pods
 /ios/build
+**/ios/.xcode.env.local
 /.vs

android/expoview/build.gradle

@@ -235,12 +235,12 @@ class GenerateDynamicMacrosPlugin implements Plugin<Project> {
         it.toLowerCase().contains("release")
       } ? "release" : "debug"
 
-      workingDir '../../tools/bin'
+      workingDir '../../bin'
 
       if (Os.isFamily(Os.FAMILY_WINDOWS)) {
-        commandLine 'cmd.exe', '/c', "expotools.js android-generate-dynamic-macros --configuration ${configuration}"
+        commandLine 'cmd.exe', '/c', "expotools android-generate-dynamic-macros --configuration ${configuration}"
       } else {
-        commandLine "./expotools.js", "android-generate-dynamic-macros", "--configuration", configuration
+        commandLine "./expotools", "android-generate-dynamic-macros", "--configuration", configuration
       }
     }
   }

apps/bare-expo/ios/BareExpo.xcodeproj/project.pbxproj

@@ -2,13 +2,15 @@
 
 set -exo pipefail
 
-if [ -z "$EXPO_TOOLS_DIR" ]; then
+if [[ -z "$EXPO_TOOLS_DIR" ]]; then
   EXPO_TOOLS_DIR="${SRCROOT}/../../../tools"
 fi
 
-# Sourcing login scripts on macOS-11 runners is broken but can be omitted.
-if [ -z "$CI" ]; then
-  source ${EXPO_TOOLS_DIR}/source-login-scripts.sh
+if [[ -f "$PODS_ROOT/../.xcode.env" ]]; then
+  source "$PODS_ROOT/../.xcode.env"
+fi
+if [[ -f "$PODS_ROOT/../.xcode.env.local" ]]; then
+  source "$PODS_ROOT/../.xcode.env.local"
 fi
 
 export PATH="${SRCROOT}/../../../bin:$PATH"

apps/bare-expo/ios/Build-Phases/generate-dynamic-macros.sh

@@ -9,5 +9,6 @@ else
     yarn
 fi
 
-../../tools/bin/expotools.js android-generate-dynamic-macros --configuration $1 --bare
+CURR_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
+"${CURR_DIR}/../../../bin/expotools" android-generate-dynamic-macros --configuration $1 --bare
 echo " ✅ Generete dynamic macros"

apps/bare-expo/scripts/setup-android-project.sh

@@ -5,5 +5,6 @@ set -euo pipefail
 script_dir=$(dirname "$0")
 repository_root="${script_dir}/.."
 expotools_dir="`cd ${repository_root}/tools;pwd;`"
+NODE_BINARY=${NODE_BINARY:-node}
 
-exec "${expotools_dir}/bin/expotools.js" "$@"
+$NODE_BINARY "${expotools_dir}/bin/expotools.js" "$@"

apps/bare-sandbox/ios/bare-sandbox.xcodeproj/project.pbxproj

@@ -2,13 +2,15 @@
 
 set -exo pipefail
 
-if [ -z "$EXPO_TOOLS_DIR" ]; then
+if [[ -z "$EXPO_TOOLS_DIR" ]]; then
   EXPO_TOOLS_DIR="${SRCROOT}/../tools"
 fi
 
-# Sourcing login scripts on macOS-11 runners is broken but can be omitted.
-if [ -z "$CI" ]; then
-  source ${EXPO_TOOLS_DIR}/source-login-scripts.sh
+if [[ -f "$PODS_ROOT/../.xcode.env" ]]; then
+  source "$PODS_ROOT/../.xcode.env"
+fi
+if [[ -f "$PODS_ROOT/../.xcode.env.local" ]]; then
+  source "$PODS_ROOT/../.xcode.env.local"
 fi
 
 export PATH="${SRCROOT}/../bin:$PATH"

apps/native-tests/ios/NativeTests.xcodeproj/project.pbxproj

@@ -8,6 +8,8 @@
 
 ### 🐛 Bug fixes
 
+- Deprecated the unreliable `source-login-scripts.sh` and sourcing the Node.js binary path from `.xcode.env` and `.xcode.env.local`. ([#18330](https://github.com/expo/expo/pull/18330) by [@kudo](https://github.com/kudo))
+
 ### 💡 Others
 
 ## 13.2.2 — 2022-07-16

bin/expotools

@@ -4,23 +4,7 @@ set -eo pipefail
 
 DEST="$CONFIGURATION_BUILD_DIR"
 RESOURCE_BUNDLE_NAME="EXConstants.bundle"
-# ref: https://github.com/facebook/react-native/blob/c974cbff04a8d90ac0f856dbada3fc5a75c75b49/scripts/react-native-xcode.sh#L59-L65
-# Path to expo-constants folder inside node_modules
-EXPO_CONSTANTS_PACKAGE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
-
-# Suppress environment errors from sourcing the login scripts
-set +e
-source "$EXPO_CONSTANTS_PACKAGE_DIR/scripts/source-login-scripts.sh"
-set -e
-
-NODE_BINARY=${NODE_BINARY:-node}
-
-if ! [ -x "$(command -v "$NODE_BINARY")" ]; then
-  echo 'Error: cannot find the node binary. Try setting the NODE_BINARY variable in the ' \
-  '"Bundle React Native code and images" Build Phase to the absolute path to your node binary. ' \
-  'You can find it by executing "which node" in a terminal window.' >&2
-  exit 1
-fi
+EXPO_CONSTANTS_PACKAGE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
 
 # For classic main project build phases integration, will be no-op to prevent duplicated app.config creation.
 #
@@ -38,4 +22,4 @@ PROJECT_ROOT=${PROJECT_ROOT:-"$EXPO_CONSTANTS_PACKAGE_DIR/../.."}
 
 cd "$PROJECT_ROOT" || exit
 
-"$NODE_BINARY" "${EXPO_CONSTANTS_PACKAGE_DIR}/scripts/getAppConfig.js" "$PROJECT_ROOT" "$DEST/$RESOURCE_BUNDLE_NAME"
+"${EXPO_CONSTANTS_PACKAGE_DIR}/scripts/with-node.sh" "${EXPO_CONSTANTS_PACKAGE_DIR}/scripts/getAppConfig.js" "$PROJECT_ROOT" "$DEST/$RESOURCE_BUNDLE_NAME"

ios/Build-Phases/generate-dynamic-macros.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# Copyright 2018-present 650 Industries. All rights reserved.
+#
+# @generated by expo-module-scripts
+#
+# USAGE:
+# ./with-node.sh command
+
+CURR_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
+
+# Start with a default
+NODE_BINARY=$(command -v node)
+export NODE_BINARY
+
+# 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 << EOF
+[ERROR] Could not find "node" 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.
+EOF
+  exit 1
+fi
+
+# Execute argument, if present
+if [[ "$#" -gt 0 ]]; then
+  "$NODE_BINARY" $@
+fi

packages/expo-constants/CHANGELOG.md

@@ -14,6 +14,7 @@
 - Fixed `expo-module prepare` error if target packages contain temporary kotlin build files. ([#17023](https://github.com/expo/expo/pull/17023) by [@kudo](https://github.com/kudo))
 - Improved support of nvm sourcing in iOS shell scripts. ([#17109](https://github.com/expo/expo/pull/17109) by [@liamronancb](https://github.com/liamronancb))
 - Fixed `source-login-scripts.sh` ~/zlogin typo. ([#17622](https://github.com/expo/expo/pull/17622) by [@vrgimael](https://github.com/vrgimael))
+- Deprecated the unreliable `source-login-scripts.sh` and sourcing the Node.js binary path from `.xcode.env` and `.xcode.env.local`. ([#18330](https://github.com/expo/expo/pull/18330) by [@kudo](https://github.com/kudo))
 
 ### 💡 Others
 

packages/expo-constants/scripts/get-app-config-ios.sh

@@ -67,7 +67,7 @@ Running `yarn` will now run the `prepare` script, which generates any missing fi
 
 Besides, running `yarn prepare` script will also synchronize optional files from `expo-module-scripts` when the file is present and contains the `@generated` pattern:
 
-- [`source-login-scripts.sh`](./templates/scripts/source-login-scripts.sh): An Xcode build phase script helper for Node.js binary resolution. For example, we need to source login shell configs for `nvm`.
+- [`with-node.sh`](./templates/scripts/with-node.sh): An Xcode build phase script helper for Node.js binary resolution. It sources the project's **.xcode.env** and **.xcode.env.local** files, which may define an environment variable named `NODE_BINARY` to specify the file path of the Node.js binary to run.
 
 ### 🔌 Config Plugin
 

packages/expo-constants/scripts/source-login-scripts.sh

@@ -10,7 +10,7 @@ shopt -s dotglob
 # and its content contains the string `@generated`.
 OPTIONAL_TEMPLATE_FILES=(
   # add a relative file path from `templates/` for each new optional file
-  "scripts/source-login-scripts.sh"
+  "scripts/with-node.sh"
 )
 
 # returns relative file paths inside a given directory without the leading "./".

packages/expo-constants/scripts/with-node.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# Copyright 2018-present 650 Industries. All rights reserved.
+#
+# @generated by expo-module-scripts
+#
+# USAGE:
+# ./with-node.sh command
+
+CURR_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
+
+# Start with a default
+NODE_BINARY=$(command -v node)
+export NODE_BINARY
+
+# 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 << EOF
+[ERROR] Could not find "node" 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.
+EOF
+  exit 1
+fi
+
+# Execute argument, if present
+if [[ "$#" -gt 0 ]]; then
+  "$NODE_BINARY" $@
+fi