chore: update test app to use tarball plugin dependency (#187)

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
         run: npm publish --dry-run
 
   test-plugin:
-    name: Test unit tests for plguin
+    name: Test unit tests for plugin
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.gitignore

@@ -4,6 +4,7 @@ node_modules
 .nvm
 npm-debug.log
 yarn-error.log
+*.tgz
 
 # OS X
 .DS_Store

local-development-readme.md

@@ -33,6 +33,16 @@ npx expo run:android
 npx expo run:ios
 ```
 
+### Plugin Dependency Installation
+
+> Note: For Node.js 18 or newer, this typically runs automatically with `npm install`.
+
+We use tarball dependency to ensure our expo plugin is installed as if it was published, avoiding path issues and ensuring dependencies are resolved consistently. If you face errors, run following command before running `npm install`:
+
+```bash
+npm run preinstall
+``` 
+
 ## Convenience scripts
 
 Sometimes when you are making changes to the plugin, it's helpful to clear out dependencies or rebuild the plugin. There are a couple of convenience scripts that you can use.

scripts/build-all.sh

@@ -9,7 +9,7 @@ print_blue "\nInstalling root dependencies for plugin and tests...\n"
 npm install
 
 print_blue "\nInstalling test-app dependencies...\n"
-(cd test-app && npm install)
+(cd test-app && npm run preinstall && npm install)
 
 print_blue "\nGenerating Android and iOS native projects...\n"
 (cd test-app && npx npx expo prebuild)

scripts/install-plugin-tarball.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+# Script that generates a tarball for the npm package.
+#
+# Designed to be run before installing dependencies in the app.
+#
+# Use script: npm run install (in test-app)
+# Ensures the tarball name is consistent to avoid unnecessary git diffs.
+
+# Includes utils.sh script located in the same directory as this script
+source "$(dirname "$0")/utils.sh"
+set -e
+
+# Define constants
+PLUGIN_NAME="customerio-expo-plugin"
+PLUGIN_PATH_RELATIVE=${1:-..} # Default plugin path to `..` if no argument is provided
+TARBALL_NAME=$PLUGIN_NAME-latest.tgz
+TARBALL_PATTERN=$PLUGIN_NAME-*.tgz
+START_DIR=$(pwd) # Save the current directory (starting directory)
+
+print_heading "Running install-plugin-tarball.sh script..."
+
+print_blue "Starting in directory: '$START_DIR' with relative plugin path: '$PLUGIN_PATH_RELATIVE'"
+print_blue "Generating tarball for expo plugin...\n"
+
+# Navigate to root plugin directory
+cd $PLUGIN_PATH_RELATIVE
+# Remove any existing matching tarball to avoid conflicts
+rm $TARBALL_PATTERN || true
+# Generate the tarball using npm pack
+# This creates a tarball named based on the `name` and `version` fields in the package.json
+npm pack --silent
+# Rename the tarball to a consistent name
+mv $TARBALL_PATTERN $TARBALL_NAME
+print_blue "\nTarball created successfully: '$TARBALL_NAME' at '$(pwd)'"
+
+# Return to the starting directory
+cd $START_DIR
+print_blue "Returned to directory: '$(pwd)'"
+
+print_blue "Uninstalling existing expo plugin and installing tarball dependency to ensure it is up-to-date..."
+npm uninstall $PLUGIN_NAME --no-save
+npm install "$PLUGIN_PATH_RELATIVE/$TARBALL_NAME" --silent
+
+print_success "✅ $TARBALL_NAME dependency installed successfully!"

scripts/setup-test.sh

@@ -7,6 +7,7 @@ echo "Setting up the test project..."
 cd test-app
 
 echo "Installing dependencies..."
+npm run preinstall
 npm install
 
 echo "Running expo prebuild..."

test-app/package.json

@@ -3,6 +3,8 @@
   "version": "1.0.0",
   "main": "index.js",
   "scripts": {
+    "install-plugin": "bash ../scripts/install-plugin-tarball.sh ..",
+    "preinstall": "npm run install-plugin",
     "start": "expo start",
     "android": "expo run:android",
     "ios": "expo run:ios",
@@ -12,7 +14,7 @@
     "@react-native-community/masked-view": "^0.1.11",
     "@react-navigation/native": "^7.0.14",
     "@react-navigation/stack": "^7.1.0",
-    "customerio-expo-plugin": "file:..",
+    "customerio-expo-plugin": "file:../customerio-expo-plugin-latest.tgz",
     "customerio-reactnative": "^4.1.1",
     "expo": "~52.0.11",
     "expo-status-bar": "~2.0.0",