@logrocket/react-native 1.35.2 → 1.37.0

package/logrocket-react-native.podspec

@@ -16,7 +16,7 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,c,m,swift}"
   s.requires_arc = true
 
-  s.dependency "LogRocket", "1.35.2"
+  s.dependency "LogRocket", "1.37.0"
   s.dependency "React"
 end
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@logrocket/react-native",
   "title": "Logrocket Native Module",
-  "version": "1.35.2",
+  "version": "1.37.0",
   "description": "LogRocket SDK for react-native",
   "typings": "types.d.ts",
   "files": [
@@ -14,7 +14,8 @@
     "logrocket-react-native.podspec",
     "types.d.ts",
     "app.plugin.js",
-    "plugin/withLogRocket.js"
+    "plugin/withLogRocket.js",
+    "scripts/asset-upload-script.rb"
   ],
   "scripts": {
     "test": "jest"

package/plugin/withLogRocket.js

@@ -1,39 +1,229 @@
 const {
   withProjectBuildGradle,
   createRunOncePlugin,
+  withAppBuildGradle,
+  withXcodeProject,
 } = require('@expo/config-plugins');
+const {
+  getXCConfigurationListEntries,
+  getBuildConfigurationsForListId,
+} = require('@expo/config-plugins/build/ios/utils/Xcodeproj');
+const {
+  removeGeneratedContents,
+  createGeneratedHeaderComment,
+} = require('@expo/config-plugins/build/utils/generateCode');
+const { withBuildProperties } = require('expo-build-properties');
+const fs = require('fs');
+const path = require('path');
+
+const LOGROCKET_MAVEN_URL = 'maven { url "https://storage.googleapis.com/logrocket-maven/" }';
+const LOGROCKET_DEPENDENCY_CLASSPATH = 'classpath "com.logrocket.gradle:android:0.3.0"';
+const LOGROCKET_PLUGIN = 'apply plugin: \'com.logrocket.gradle.android\'';
+
+const buildscriptRepositoriesRegex = new RegExp(/buildscript\s*{.*?repositories\s*{.*?(?=\n\s*})/, 'sg');
+const buildscriptDependenciesRegex = new RegExp(/buildscript\s*{.*?dependencies\s*{.*?(?=\n\s*})/, 'sg');
+
+function createGeneratedHeaderAndFooter(tag) {
+  return {
+    header: createGeneratedHeaderComment(tag, tag, '//'),
+    footer: `// @generated end ${tag}`,
+  };
+}
 
-// Because we need the package to be added AFTER the React and Google maven packages, we create a
-// new allprojects. It's ok to have multiple allprojects.repositories, so we create a new one since
-// it's cheaper than tokenizing the existing block to find the correct place to insert.
-const gradleMaven =
-  'allprojects { repositories { maven { url "https://storage.googleapis.com/logrocket-maven/" } } }';
+function modProjectGradle(buildGradle) {
+  let modifiedGradle = buildGradle;
 
-function setGradleMaven(buildGradle) {
-  if (buildGradle.includes('logrocket-maven')) {
-    return buildGradle;
+  // insert repository
+  removeGeneratedContents(modifiedGradle, 'logrocket-buildscript-repositories');
+  if (buildscriptRepositoriesRegex.exec(modifiedGradle) !== null) {
+    const { header, footer } = createGeneratedHeaderAndFooter('logrocket-buildscript-repositories');
+    modifiedGradle = `
+      ${modifiedGradle.slice(0, buildscriptRepositoriesRegex.lastIndex)}
+      ${header}
+      ${LOGROCKET_MAVEN_URL}
+      ${footer}
+      ${modifiedGradle.slice(buildscriptRepositoriesRegex.lastIndex)}`;
   }
 
-  return `${buildGradle}\n${gradleMaven}\n`;
+  // insert dependency
+  removeGeneratedContents(modifiedGradle, 'logrocket-buildscript-dependencies');
+  if (buildscriptDependenciesRegex.exec(modifiedGradle) !== null) {
+    const { header, footer } = createGeneratedHeaderAndFooter('logrocket-buildscript-dependencies');
+    modifiedGradle = `
+      ${modifiedGradle.slice(0, buildscriptDependenciesRegex.lastIndex)}
+      ${header}
+      ${LOGROCKET_DEPENDENCY_CLASSPATH}
+      ${footer}
+      ${modifiedGradle.slice(buildscriptDependenciesRegex.lastIndex)}`;
+  }
+
+  return modifiedGradle;
 }
 
-const withAndroidLogRocketMaven = config => {
-  return withProjectBuildGradle(config, gradleConfig => {
+function modApplicationGradle(buildGradle, pluginProps) {
+  let modifiedGradle = buildGradle;
+
+  // insert plugin
+  removeGeneratedContents(modifiedGradle, 'logrocket-plugin');
+  const comments = createGeneratedHeaderAndFooter('logrocket-plugin');
+  modifiedGradle += `
+    ${comments.header}
+    ${LOGROCKET_PLUGIN}
+    ${comments.footer}
+    `;
+
+  // insert logrocket config if any plugin props were passed in
+  removeGeneratedContents(modifiedGradle, 'logrocket-config');
+  if (pluginProps.android.assetCapture) {
+    const { header, footer } = createGeneratedHeaderAndFooter('logrocket-config');
+    const assetCapture = pluginProps.android.assetCapture;
+    let configSection = 'logrocket {\n';
+    if (assetCapture.apiKey) {
+      configSection += `\tapiKey = "${assetCapture.apiKey}"\n`;
+    }
+    if (assetCapture.apiHost) {
+      configSection += `\tapiHost = "${assetCapture.apiHost}"\n`;
+    }
+    if (assetCapture.enabledVariants && Array.isArray(assetCapture.enabledVariants)) {
+      const enabledVariants = assetCapture.enabledVariants;
+      configSection += `\tenabledVariants = [${enabledVariants.map(e => `"${e}"`).join(', ')}].toSet()\n`;
+    }
+    configSection += '}';
+    modifiedGradle = `
+      ${modifiedGradle}
+      ${header}
+      ${configSection}
+      ${footer}
+      `;
+  }
+
+  return modifiedGradle;
+}
+
+const withAndroidLogRocket = (config, pluginProps) => {
+  // eslint-disable-next-line no-param-reassign
+  config = withProjectBuildGradle(config, gradleConfig => {
     if (gradleConfig.modResults.language === 'groovy') {
       // eslint-disable-next-line no-param-reassign
-      gradleConfig.modResults.contents = setGradleMaven(gradleConfig.modResults.contents);
+      gradleConfig.modResults.contents = modProjectGradle(gradleConfig.modResults.contents);
     } else {
       throw new Error(
-        'Cannot add LogRocket maven respository because the build.gradle is not groovy'
+        'Cannot add LogRocket gradle config because the project build.gradle is not groovy'
       );
     }
+    return gradleConfig;
+  });
 
+  // eslint-disable-next-line no-param-reassign
+  config = withAppBuildGradle(config, gradleConfig => {
+    if (gradleConfig.modResults.language === 'groovy') {
+    // eslint-disable-next-line no-param-reassign
+      gradleConfig.modResults.contents = modApplicationGradle(gradleConfig.modResults.contents, pluginProps);
+    } else {
+      throw new Error(
+        'Cannot add LogRocket gradle config because the application build.gradle is not groovy'
+      );
+    }
     return gradleConfig;
   });
+
+  return config;
 };
 
-const withLogRocket = config => {
-  return withAndroidLogRocketMaven(config);
+const withIosLogRocket = (config, pluginProps) => {
+  // eslint-disable-next-line no-param-reassign
+  config = withXcodeProject(config, xcodeProjConfig => {
+    const xcodeProject = xcodeProjConfig.modResults;
+    const LOGROCKET_UPLOAD_SCRIPT = fs.readFileSync(
+      path.resolve(__dirname, '../scripts/asset-upload-script.rb'), 'utf-8');
+
+    // add run script build phase to run ruby script
+    const logRocketBuildPhase = xcodeProject.pbxItemByComment(
+      'LogRocket Custom Font Capture',
+      'PBXShellScriptBuildPhase'
+    );
+    if (!logRocketBuildPhase) {
+      xcodeProject.addBuildPhase([], 'PBXShellScriptBuildPhase', 'LogRocket Custom Font Capture', null, {
+        shellPath: '"/usr/bin/env ruby"',
+        shellScript: LOGROCKET_UPLOAD_SCRIPT,
+      });
+    } else {
+      logRocketBuildPhase.shellPath = '"/usr/bin/env ruby"';
+      logRocketBuildPhase.shellScript = JSON.stringify(LOGROCKET_UPLOAD_SCRIPT);
+    }
+
+    // configure environment variables
+    getXCConfigurationListEntries(xcodeProject).forEach(configList => {
+      getBuildConfigurationsForListId(xcodeProject, configList[0]).forEach(configSection => {
+        const buildConfig = configSection[1];
+        if (pluginProps.ios.assetCapture) {
+          const assetCapture = pluginProps.ios.assetCapture;
+          if (assetCapture.apiKey) {
+            buildConfig.buildSettings.LOGROCKET_API_KEY = `"${assetCapture.apiKey}"`;
+          }
+          if (assetCapture.apiHost) {
+            buildConfig.buildSettings.LOGROCKET_API_HOST = `"${assetCapture.apiHost}"`;
+          }
+          if (assetCapture.assetDirectory) {
+            buildConfig.buildSettings.LOGROCKET_ASSET_DIR = `"${assetCapture.assetDirectory}"`;
+          }
+          if (assetCapture.cliPath) {
+            buildConfig.buildSettings.LOGROCKET_CLI_PATH = `"${assetCapture.cliPath}"`;
+          }
+          if (assetCapture.enabledBuildConfigs && Array.isArray(assetCapture.enabledBuildConfigs)) {
+            const enabledBuildConfigs = assetCapture.enabledBuildConfigs;
+            buildConfig.buildSettings.LOGROCKET_ENABLED_BUILD_CONFIGS = `"${enabledBuildConfigs.join(',')}"`;
+          }
+        }
+      });
+    });
+
+    return xcodeProjConfig;
+  });
+  return config;
+};
+
+/*
+  pluginProps schema:
+  {
+    "android": {
+      "assetCapture": {
+        "apiKey": "apphub:android:123abc", REQUIRED
+        "apiHost": "http://localhost:8000",
+        "enabledVariants": ["debug", "release"]
+      }
+    },
+    "ios": {
+      "assetCapture": {
+        "apiKey": "apphub:ios:123abc", REQUIRED
+        "apiHost": "http://localhost:8000",
+        "assetDirectory": "example-directory/logrocket", REQUIRED
+        "cliPath": "example-path/logrocket", REQUIRED (if logrocket-cli hasn't been added to $PATH)
+        "enabledBuildConfigs": ["Debug", "Release"]
+      }
+    }
+  }
+*/
+
+const withLogRocket = (config, pluginProps = {}) => {
+  // eslint-disable-next-line no-param-reassign
+  config = withBuildProperties(config, {
+    android: {
+      extraMavenRepos: ['https://storage.googleapis.com/logrocket-maven/'],
+    },
+  });
+
+  if (pluginProps.android && pluginProps.android.assetCapture) {
+    // eslint-disable-next-line no-param-reassign
+    config = withAndroidLogRocket(config, pluginProps);
+  }
+
+  if (pluginProps.ios && pluginProps.ios.assetCapture) {
+    // eslint-disable-next-line no-param-reassign
+    config = withIosLogRocket(config, pluginProps);
+  }
+
+  return config;
 };
 
 module.exports = createRunOncePlugin(withLogRocket, 'logrocket');

package/scripts/asset-upload-script.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'json'
+
+# Ensure the font data file is freshly generated on each build
+app_build_resources_dir = "#{ENV['BUILT_PRODUCTS_DIR']}/#{ENV['UNLOCALIZED_RESOURCES_FOLDER_PATH']}"
+output_file = "#{app_build_resources_dir}/lr_custom_fonts_data.json"
+if File.exist?(output_file)
+  File.delete(output_file)
+end
+
+
+# Check whether LogRocket asset upload is enabled for this build
+current_build_config = ENV['CONFIGURATION']
+enabled_build_configs = ENV['LOGROCKET_ENABLED_BUILD_CONFIGS']&.split(',')
+
+unless enabled_build_configs&.include?(current_build_config) || current_build_config == 'Release'
+  puts "LogRocket custom asset upload is not enabled for this build."
+  exit 0
+end
+
+# Ensure configuration is set that allows script to find the downloaded LogRocket CLI for execution
+LOGROCKET_CLI_PATH = ENV['LOGROCKET_CLI_PATH'] || `which logrocket-cli`.strip
+if LOGROCKET_CLI_PATH.empty?
+  warn 'Error: LOGROCKET_CLI_PATH is not set and logrocket-cli was not found on $PATH'
+  exit 1
+end
+
+# Ensure configuration is set to authorize asset upload for your LogRocket application
+unless ENV['LOGROCKET_API_KEY']
+  warn 'Error: LOGROCKET_API_KEY is not set'
+  exit 1
+end
+
+# Ensure configuration is set that allows LogRocket CLI to find custom font files
+unless ENV['LOGROCKET_ASSET_DIR']
+  warn 'Error: LOGROCKET_ASSET_DIR is not set'
+  exit 1
+end
+
+# Execute asset_upload CLI command and collect output
+cli_cmd = "#{LOGROCKET_CLI_PATH} asset_upload #{ENV['LOGROCKET_ASSET_DIR']}"
+cli_output = `#{cli_cmd}`
+
+
+# Parse CLI output to report any errors or generate the build resource used by the LogRocket SDK
+urls = []
+cli_output.each_line do |line|
+  data = begin
+    JSON.parse(line)
+  rescue StandardError
+    nil
+  end
+  next unless data
+
+  case data['level']
+  when 'info'
+    if data['url']
+      urls << data['url']
+    else
+      warn "Failed to retrieve cached url for #{data['filepath']}"
+    end
+  when 'error'
+    warn "Error: #{data['message']}"
+    exit 1
+  else
+    warn "Unknown level for LogRocket CLI asset-upload output: #{data['level']}"
+    exit 1
+  end
+end
+
+if urls.empty?
+  warn 'No valid custom font assets found for upload'
+else
+  Dir.mkdir(app_build_resources_dir) unless Dir.exist?(app_build_resources_dir)
+
+  json_data = { urls: urls }.to_json
+  File.write(output_file, json_data)
+end
+
+exit 0