Merge branch 'sanity/v16.0.0' into feat/fix-expo-plugin

Author: ahmedAlaaInstabug

CHANGELOG.md

@@ -10,6 +10,8 @@
 
 - Add Support Eas updates. ([#1391](https://github.com/Instabug/Instabug-React-Native/pull/1391))
 
+- Add support for uploading sourcemap files in expo apps. ([#1392](https://github.com/Instabug/Instabug-React-Native/pull/1392))
+
 ### Changed
 
 - **BREAKING** Remove deprecated APIs ([#1424](https://github.com/Instabug/Instabug-React-Native/pull/1424)). See migration guide for more details.
@@ -36,8 +38,6 @@
 
 ### Added
 
-- Add support for expo updates versioning ([#1391](https://github.com/Instabug/Instabug-React-Native/pull/1391))
-
 - Add support enable/disable screenshot auto masking. ([#1389](https://github.com/Instabug/Instabug-React-Native/pull/1389))
 
 - Add support for BugReporting user consents. ([#1383](https://github.com/Instabug/Instabug-React-Native/pull/1383))

README.md

@@ -26,7 +26,21 @@ For more info, visit [Instabug.com](https://www.instabug.com).
    yarn add instabug-reactnative
    ```
 
-2. CocoaPods on iOS needs this extra step:
+2. if you are using expo you need to add `instabug-reactnative` plugin to `app.json`:
+
+   ```json
+      "plugins" : [
+         [
+           "instabug-reactnative",
+           {
+              // optional that add Mic,Photo permission on iOS and FOREGROUND_SERVICE_MEDIA_PROJECTION on android
+             "addScreenRecordingBugReportingPermission": true
+           }
+         ]
+   ]
+   ```
+
+3. CocoaPods on iOS needs this extra step:
 
    ```bash
    cd ios && pod install && cd ..

android/sourcemaps.gradle

@@ -15,11 +15,13 @@ project.afterEvaluate {
         def flavor = name.substring(start, end).uncapitalize()
         def defaultVersion = getDefaultVersion(flavor)
 
-        task.finalizedBy createUploadSourcemapsTask(flavor, defaultVersion.name, defaultVersion.code)
+
+
+        task.finalizedBy createUploadSourcemapsTask(flavor, defaultVersion.name, defaultVersion.code,task)
     }
 }
 
-Task createUploadSourcemapsTask(String flavor, String defaultVersionName, String defaultVersionCode) {
+Task createUploadSourcemapsTask(String flavor, String defaultVersionName, String defaultVersionCode, Task task) {
     def name = 'uploadSourcemaps' + flavor.capitalize()
 
     // Don't recreate the task if it already exists.
@@ -39,18 +41,26 @@ Task createUploadSourcemapsTask(String flavor, String defaultVersionName, String
             try {
                 def appProject = project(':app')
                 def appDir = appProject.projectDir
-                def sourceMapFile = getSourceMapFile(appDir, flavor)
+                def sourceMapFile = getSourceMapFile(appDir, flavor,task)
+                println "✅ Resolved sourcemap file path: ${sourceMapFile.absolutePath}"
 
                 def jsProjectDir = rootDir.parentFile
                 def instabugDir = new File(['node', '-p', 'require.resolve("instabug-reactnative/package.json")'].execute(null, rootDir).text.trim()).getParentFile()
 
-                def tokenShellFile = new File(instabugDir, 'scripts/find-token.sh')
-                def inferredToken = executeShellScript(tokenShellFile, jsProjectDir)
+              def tokenJsFile = new File(instabugDir, 'scripts/find-token.js')
+              def inferredToken = executeNodeScript(tokenJsFile, jsProjectDir)
+
+                if (!inferredToken) {
+                    throw new GradleException("❌ Unable to infer Instabug token from script: ${tokenShellFile.absolutePath}")
+                }
+
                 def appToken = resolveVar('App Token', 'INSTABUG_APP_TOKEN', inferredToken)
 
                 def versionName = resolveVar('Version Name', 'INSTABUG_VERSION_NAME', defaultVersionName)
                 def versionCode = resolveVar('Version Code', 'INSTABUG_VERSION_CODE', defaultVersionCode)
 
+                println "📦 Uploading with versionName=${versionName}, versionCode=${versionCode}, appToken=${appToken.take(5)}..."
+
                 exec {
                     def osCompatibility = Os.isFamily(Os.FAMILY_WINDOWS) ? ['cmd', '/c'] : []
                     def args = [
@@ -67,34 +77,57 @@ Task createUploadSourcemapsTask(String flavor, String defaultVersionName, String
             } catch (exception) {
                 project.logger.error "Failed to upload source map file.\n" +
                         "Reason: ${exception.message}"
+                           throw exception
+
             }
         }
     }
 
     return provider.get()
 }
 
-File getSourceMapFile(File appDir, String flavor) {
+File getSourceMapFile(File appDir, String flavor, Task task) {
     def defaultFlavorPath = flavor.empty ? 'release' : "${flavor}Release"
     def defaultSourceMapDest = "build/generated/sourcemaps/react/${defaultFlavorPath}/index.android.bundle.map"
     def defaultSourceMapFile = new File(appDir, defaultSourceMapDest)
+    def props = task.getProperties()
+
+    def bundleAssetName = props.containsKey("bundleAssetName") ? props.bundleAssetName?.getOrNull() : null
+    def jsSourceMapsDir = props.containsKey("jsSourceMapsDir") ? props.jsSourceMapsDir?.getOrNull() : null
+    def jsIntermediateSourceMapsDir = props.containsKey("jsIntermediateSourceMapsDir") ? props.jsIntermediateSourceMapsDir?.getOrNull() : null
+
+    if (bundleAssetName && jsSourceMapsDir) {
+        def outputSourceMap = new File(jsSourceMapsDir.asFile.absolutePath, "${bundleAssetName}.map")
+        if (outputSourceMap.exists()) {
+            return outputSourceMap
+        }
+    }
+
+    if (bundleAssetName && jsIntermediateSourceMapsDir) {
+        def packagerOutputSourceMap = new File(jsIntermediateSourceMapsDir.asFile.absolutePath, "${bundleAssetName}.packager.map")
+        if (packagerOutputSourceMap.exists()) {
+            return packagerOutputSourceMap
+        }
+    }
 
     if (defaultSourceMapFile.exists()) {
         return defaultSourceMapFile
     }
 
     if (flavor.empty) {
-        throw new InvalidUserDataException("Unable to find source map file at: ${defaultSourceMapFile.absolutePath}.")
+         println"Source map file not found at: ${defaultSourceMapFile.absolutePath}. Skipping."
+        return null
     }
 
     def fallbackSourceMapDest = "build/generated/sourcemaps/react/${flavor}/release/index.android.bundle.map"
     def fallbackSourceMapFile = new File(appDir, fallbackSourceMapDest)
 
-    project.logger.info "Unable to find source map file at: ${defaultSourceMapFile.absolutePath}.\n" +
+  println "Unable to find source map file at: ${defaultSourceMapFile.absolutePath}.\n" +
             "Falling back to ${fallbackSourceMapFile.absolutePath}."
 
     if (!fallbackSourceMapFile.exists()) {
-        throw new InvalidUserDataException("Unable to find source map file at: ${fallbackSourceMapFile.absolutePath} either.")
+    println "Fallback source map file not found at: ${fallbackSourceMapFile.absolutePath}. Skipping."
+        return null
     }
 
     return fallbackSourceMapFile
@@ -155,14 +188,56 @@ String resolveVar(String name, String envKey, String defaultValue) {
     return value
 }
 
+static String executeNodeScript(File script, File workingDir) {
+    if (!script.exists()) {
+        println "Script not found: ${script.absolutePath}"
+        return null
+    }
+
+    def output = new StringBuffer()
+    def error = new StringBuffer()
+
+    try {
+        def process = ['node', script.getAbsolutePath()].execute(null, workingDir)
+        process.waitForProcessOutput(output, error)
+
+        if (process.exitValue() != 0) {
+            println "Script failed with exit code ${process.exitValue()}"
+            println "Standard Error:\n${error.toString().trim()}"
+            println "Standard Output:\n${output.toString().trim()}"
+            return null
+        }
+
+        return output.toString().trim()
+
+    } catch (Exception e) {
+        println "Exception while executing Node.js script: ${e.message}"
+        e.printStackTrace()
+        return null
+    }
+}
+
 static String executeShellScript(File script, File workingDir) {
     if (Os.isFamily(Os.FAMILY_WINDOWS)) {
         return null
     }
 
+    if (!script.canExecute()) {
+        // Try to set executable permission
+        script.setExecutable(true)
+    }
+
     def output = new StringBuffer()
+    def error = new StringBuffer()
+
+    // Using 'sh' instead of './' to avoid needing exec permission, but keeping chmod above just in case
     def process = ['sh', script.getAbsolutePath()].execute(null, workingDir)
-    process?.waitForProcessOutput(output, new StringBuffer())
+    process?.waitForProcessOutput(output, error)
+
+    if (process.exitValue() != 0) {
+        println "Error running script: ${error.toString().trim()}"
+        return null
+    }
 
-    return process?.exitValue() == 0 ? output.toString().trim() : null
+    return output.toString().trim()
 }

app.plugin.js

@@ -0,0 +1 @@
+module.exports = require('./expo');

cli/commands/UploadEasUpdatesSourcemaps.ts

@@ -0,0 +1,36 @@
+import { Command, Option } from 'commander';
+import { UploadEasUpdatesSourcemaps, UploadEasUpdatesSourcemapsOptions } from '../upload';
+
+export const uploadEasUpdatesSourcemapsCommand = new Command();
+
+uploadEasUpdatesSourcemapsCommand
+  .name('upload-eas-updates-sourcemaps')
+  .addOption(
+    new Option('-f, --file <path>', 'The path of eas update folder')
+      .makeOptionMandatory()
+      .default('dist'),
+  )
+  .addOption(
+    new Option('-t, --token <value>', 'Your App Token')
+      .env('INSTABUG_APP_TOKEN')
+      .makeOptionMandatory(),
+  )
+  .addOption(
+    new Option('-n, --name <value>', 'The app version name')
+      .env('INSTABUG_APP_VERSION_NAME')
+      .makeOptionMandatory(),
+  )
+  .addOption(
+    new Option('-c, --code <value>', 'The app version code')
+      .env('INSTABUG_APP_VERSION_CODE')
+      .makeOptionMandatory(),
+  )
+  .addOption(
+    new Option('--androidUpdateId <value>', "The CodePush label if it's a CodePush release"),
+  )
+  .addOption(new Option('--iosUpdateId <value>', "The CodePush label if it's a CodePush release"))
+  .action(function (this: Command) {
+    const options = this.opts<UploadEasUpdatesSourcemapsOptions>();
+    UploadEasUpdatesSourcemaps(options);
+  })
+  .showHelpAfterError();

cli/index.ts

@@ -3,6 +3,7 @@ import { Command } from 'commander';
 
 import { uploadSourcemapsCommand } from './commands/UploadSourcemaps';
 import { UploadSoFilesCommand } from './commands/UploadSoFiles';
+import { uploadEasUpdatesSourcemapsCommand } from './commands/UploadEasUpdatesSourcemaps';
 
 const program = new Command();
 
@@ -12,6 +13,7 @@ program
   .description('A CLI for uploading source maps to Instabug dashboard.')
   .usage('[command]')
   .addCommand(uploadSourcemapsCommand)
-  .addCommand(UploadSoFilesCommand);
+  .addCommand(UploadSoFilesCommand)
+  .addCommand(uploadEasUpdatesSourcemapsCommand);
 
 program.parse(process.argv);

cli/upload/index.ts

@@ -1,2 +1,3 @@
 export * from './uploadSourcemaps';
 export * from './uploadSoFiles';
+export * from './uploadEasUpdatesSourcemaps';

cli/upload/uploadEasUpdatesSourcemaps.ts

@@ -0,0 +1,74 @@
+import fs from 'fs';
+import { uploadSourcemaps } from './uploadSourcemaps';
+import * as path from 'path';
+
+export interface UploadEasUpdatesSourcemapsOptions {
+  file: string;
+  token: string;
+  name: string;
+  code: string;
+  androidUpdateId?: string;
+  iosUpdateId?: string;
+  /**
+   * Disables logging to the console and prevents process exit on error.
+   *
+   * @default false
+   * */
+  silent?: boolean;
+}
+
+function getMapFile(folderPath: string): string | null {
+  try {
+    if (fs.existsSync(folderPath)) {
+      const files = fs.readdirSync(folderPath);
+      const mapFile = files.find((file) => file.endsWith('.map'));
+      if (!mapFile) {
+        return null;
+      }
+      return path.join(folderPath, mapFile);
+    }
+    return null;
+  } catch (err) {
+    console.error('Failed to read folder:', err);
+    return null;
+  }
+}
+
+/**
+ * Uploads JavaScript sourcemaps to Instabug.
+ *
+ * @param opts Options for the sourcemaps upload process.
+ * @returns A promise that resolves to a boolean indicating whether the upload was successful.
+ */
+export const UploadEasUpdatesSourcemaps = async (
+  opts: UploadEasUpdatesSourcemapsOptions,
+): Promise<boolean> => {
+  const jsFolderPath = path.join(opts.file, '_expo', 'static', 'js');
+
+  const androidFile = getMapFile(path.join(jsFolderPath, 'android'));
+  const iosFile = getMapFile(path.join(jsFolderPath, 'ios'));
+  if (androidFile && fs.existsSync(androidFile)) {
+    await uploadSourcemaps({
+      platform: 'android',
+      name: opts.name,
+      code: opts.code,
+      token: opts.token,
+      label: opts.androidUpdateId,
+      file: androidFile,
+      silent: opts.silent,
+    });
+  }
+
+  if (iosFile && fs.existsSync(iosFile)) {
+    await uploadSourcemaps({
+      platform: 'ios',
+      name: opts.name,
+      code: opts.code,
+      token: opts.token,
+      label: opts.iosUpdateId,
+      file: iosFile,
+      silent: opts.silent,
+    });
+  }
+  return true;
+};

examples/default/ios/InstabugExample.xcodeproj/project.pbxproj

@@ -430,7 +430,7 @@
 			name = "[CP-User] [instabug-reactnative] Upload Sourcemap";
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "#!/bin/sh\n\n\nexport SOURCEMAP_FILE=\"$DERIVED_FILE_DIR/main.jsbundle.map\"\n\nmain() {\n  # Read environment variables from ios/.xcode.env if it exists\n  env_path=\"$PODS_ROOT/../.xcode.env\"\n  if [ -f \"$env_path\" ]; then\n      source \"$env_path\"\n  fi\n\n  # Read environment variables from ios/.xcode.env.local if it exists\n  local_env_path=\"${ENV_PATH}.local\"\n  if [ -f \"$local_env_path\" ]; then\n      source \"$local_env_path\"\n  fi\n\n  if [[ \"$INSTABUG_SOURCEMAPS_UPLOAD_DISABLE\" = true ]]; then\n    echo \"[Info] \\`INSTABUG_SOURCEMAPS_UPLOAD_DISABLE\\` was set to true, skipping sourcemaps upload...\"\n    exit 0\n  fi\n\n  if [[ \"$CONFIGURATION\" = \"Debug\" ]]; then\n    echo \"[Info] Building in debug mode, skipping sourcemaps upload...\"\n    exit 0\n  fi\n\n  if [[ -z \"$INFOPLIST_FILE\" ]] || [[ -z \"$PROJECT_DIR\" ]]; then\n    echo \"[Error] Instabug sourcemaps script must be invoked by Xcode\"\n    exit 0\n  fi\n\n\nlocal sourcemap_file=\"\"\n  # Use existing sourcemap if available\n  if [[ -f \"$SOURCEMAP_FILE\" ]]; then\n    sourcemap_file=\"$SOURCEMAP_FILE\"\n  else\n   sourcemap_file=$(generate_sourcemaps | tail -n 1)\nfi\n\n  local js_project_dir=\"$PROJECT_DIR/..\"\n  local instabug_dir=$(dirname $(node -p \"require.resolve('instabug-reactnative/package.json')\"))\n  local inferred_token=$(cd $js_project_dir && source $instabug_dir/scripts/find-token.sh)\n  local app_token=$(resolve_var \"App Token\" \"INSTABUG_APP_TOKEN\" \"$inferred_token\" | tail -n 1)\n\n  local inferred_name=$(/usr/libexec/PlistBuddy -c 'print CFBundleShortVersionString' \"$PROJECT_DIR/$INFOPLIST_FILE\")\n  local version_name=$(resolve_var \"Version Name\" \"INSTABUG_APP_VERSION_NAME\" \"$inferred_name\" | tail -n 1)\n\n  local inferred_code=$(/usr/libexec/PlistBuddy -c 'print CFBundleVersion' \"$PROJECT_DIR/$INFOPLIST_FILE\")\n  local version_code=$(resolve_var \"Version Code\" \"INSTABUG_APP_VERSION_CODE\" \"$inferred_code\" | tail -n 1)\n\nif [ -n \"$sourcemap_file\" ]; then\n  node $instabug_dir/bin/index.js upload-sourcemaps \\\n      --platform ios \\\n      --file $sourcemap_file \\\n      --token $app_token \\\n      --name $version_name \\\n      --code $version_code\n      fi\n}\n\ngenerate_sourcemaps() {\n  local react_native_dir=$(dirname $(node -p \"require.resolve('react-native/package.json')\"))\n\n  # Fixes an issue with react-native prior to v0.67.0\n  # For more info: https://github.com/facebook/react-native/issues/32168\n  export RN_DIR=$react_native_dir\n\n  # Used withing `react-native-xcode.sh` to generate sourcemap file\n  export SOURCEMAP_FILE=\"$(pwd)/main.jsbundle.map\";\n\n  source \"$react_native_dir/scripts/react-native-xcode.sh\"\n\n  if [[ ! -f \"$SOURCEMAP_FILE\" ]]; then\n    echo \"[Error] Unable to find source map file at: $SOURCEMAP_FILE\"\n    exit 0\n  fi\n\n  echo $SOURCEMAP_FILE\n}\n\nresolve_var() {\n  local name=$1\n  local env_key=$2\n  local default_value=$3\n\n  local env_value=\"${!env_key}\"\n\n  if [[ -n \"$env_value\" ]] &&  [[ -n \"$default_value\" ]]  && [[ \"$env_value\" != default_value ]]; then\n    echo \"[Warning] Environment variable \\`$env_key\\` might have incorrect value, make sure this was intentional:\"\n    echo \"   Environment Value: $env_value\"\n    echo \"   Default Value: $default_value\"\n  fi\n\n  local value=\"${env_value:-$default_value}\"\n\n  if [[ -z \"$value\" ]]; then\n    echo \"[Error] Unable to find $name! Set the environment variable \\`$env_key\\` and try again.\"\n    exit 0\n  fi\n\n  echo $value\n}\n\nmain \"$@\"; exit\n";
+			shellScript = "#!/bin/sh\n\n\nexport SOURCEMAP_FILE=\"$DERIVED_FILE_DIR/main.jsbundle.map\"\n\nmain() {\n  # Read environment variables from ios/.xcode.env if it exists\n  env_path=\"$PODS_ROOT/../.xcode.env\"\n  if [ -f \"$env_path\" ]; then\n      source \"$env_path\"\n  fi\n\n  # Read environment variables from ios/.xcode.env.local if it exists\n  local_env_path=\"${ENV_PATH}.local\"\n  if [ -f \"$local_env_path\" ]; then\n      source \"$local_env_path\"\n  fi\n\n  if [[ \"$INSTABUG_SOURCEMAPS_UPLOAD_DISABLE\" = true ]]; then\n    echo \"[Info] \\`INSTABUG_SOURCEMAPS_UPLOAD_DISABLE\\` was set to true, skipping sourcemaps upload...\"\n    exit 0\n  fi\n\n  if [[ \"$CONFIGURATION\" = \"Debug\" ]]; then\n    echo \"[Info] Building in debug mode, skipping sourcemaps upload...\"\n    exit 0\n  fi\n\n  if [[ -z \"$INFOPLIST_FILE\" ]] || [[ -z \"$PROJECT_DIR\" ]]; then\n    echo \"[Error] Instabug sourcemaps script must be invoked by Xcode\"\n    exit 0\n  fi\n\n\nlocal sourcemap_file=\"\"\n  # Use existing sourcemap if available\n  if [[ -f \"$SOURCEMAP_FILE\" ]]; then\n    sourcemap_file=\"$SOURCEMAP_FILE\"\n  else\n   sourcemap_file=$(generate_sourcemaps | tail -n 1)\nfi\n\n  local js_project_dir=\"$PROJECT_DIR/..\"\n  local instabug_dir=$(dirname $(node -p \"require.resolve('instabug-reactnative/package.json')\"))\n  local inferred_token=$(cd $js_project_dir && node $instabug_dir/scripts/find-token.js)\n  local app_token=$(resolve_var \"App Token\" \"INSTABUG_APP_TOKEN\" \"$inferred_token\" | tail -n 1)\n\n  local inferred_name=$(/usr/libexec/PlistBuddy -c 'print CFBundleShortVersionString' \"$PROJECT_DIR/$INFOPLIST_FILE\")\n  local version_name=$(resolve_var \"Version Name\" \"INSTABUG_APP_VERSION_NAME\" \"$inferred_name\" | tail -n 1)\n\n  local inferred_code=$(/usr/libexec/PlistBuddy -c 'print CFBundleVersion' \"$PROJECT_DIR/$INFOPLIST_FILE\")\n  local version_code=$(resolve_var \"Version Code\" \"INSTABUG_APP_VERSION_CODE\" \"$inferred_code\" | tail -n 1)\n\nif [ -n \"$sourcemap_file\" ]; then\n  node $instabug_dir/bin/index.js upload-sourcemaps \\\n      --platform ios \\\n      --file $sourcemap_file \\\n      --token $app_token \\\n      --name $version_name \\\n      --code $version_code\n      fi\n}\n\ngenerate_sourcemaps() {\n  local react_native_dir=$(dirname $(node -p \"require.resolve('react-native/package.json')\"))\n\n  # Fixes an issue with react-native prior to v0.67.0\n  # For more info: https://github.com/facebook/react-native/issues/32168\n  export RN_DIR=$react_native_dir\n\n  # Used withing `react-native-xcode.sh` to generate sourcemap file\n  export SOURCEMAP_FILE=\"$(pwd)/main.jsbundle.map\";\n\n  source \"$react_native_dir/scripts/react-native-xcode.sh\"\n\n  if [[ ! -f \"$SOURCEMAP_FILE\" ]]; then\n    echo \"[Error] Unable to find source map file at: $SOURCEMAP_FILE\"\n    exit 0\n  fi\n\n  echo $SOURCEMAP_FILE\n}\n\nresolve_var() {\n  local name=$1\n  local env_key=$2\n  local default_value=$3\n\n  local env_value=\"${!env_key}\"\n\n  if [[ -n \"$env_value\" ]] &&  [[ -n \"$default_value\" ]]  && [[ \"$env_value\" != default_value ]]; then\n    echo \"[Warning] Environment variable \\`$env_key\\` might have incorrect value, make sure this was intentional:\"\n    echo \"   Environment Value: $env_value\"\n    echo \"   Default Value: $default_value\"\n  fi\n\n  local value=\"${env_value:-$default_value}\"\n\n  if [[ -z \"$value\" ]]; then\n    echo \"[Error] Unable to find $name! Set the environment variable \\`$env_key\\` and try again.\"\n    exit 0\n  fi\n\n  echo $value\n}\n\nmain \"$@\"; exit\n";
 		};
 		B77A7BA143DBD17E8AAFD0B4 /* [CP] Embed Pods Frameworks */ = {
 			isa = PBXShellScriptBuildPhase;

expo.d.ts

@@ -0,0 +1 @@
+export * from './plugin/build';