@dynatrace/react-native-plugin 2.337.3 → 2.341.1

package/scripts/core/InstrumentCall.js

@@ -1,20 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.instrumentCommand = void 0;
-const path_1 = require("path");
+const node_path_1 = require("node:path");
 const Logger_1 = require("../Logger");
 const Config_1 = require("../Config");
 const android = require("../Android");
 const PathsConstants_1 = require("../PathsConstants");
-const nodePath = require("path");
 const Ios_1 = require("../Ios");
 const InstrumentUtil_1 = require("../util/InstrumentUtil");
 const CustomArgumentUtil_1 = require("../util/CustomArgumentUtil");
 const Platform_1 = require("../api/model/Platform");
 const SourceMapUtil_1 = require("../util/SourceMapUtil");
-const instrumentCommand = () => {
-    if (process.argv.includes('--help')) {
-        Logger_1.default.logMessageSync(`
+const platformLogPrefix = { info: '  ℹ️  ', warning: '  ⚠️  ', error: '  ❌ ' };
+const logHelpMessage = () => {
+    const iOSDefaultPath = (0, node_path_1.join)(PathsConstants_1.default.getIOSFolder(), '<appName>', 'Info.plist');
+    const iOSSupportingDefaultPath = (0, node_path_1.join)(PathsConstants_1.default.getIOSFolder(), '<appName>', 'Supporting', 'Info.plist');
+    Logger_1.default.logMessageSync(`
         Usage: npx instrumentDynatrace [options]
 
         Options:
@@ -28,8 +29,8 @@ const instrumentCommand = () => {
             plist="/custom/path/to/Info.plist"
                                             Specify a custom path to the Info.plist file of your ios project.
                                             Default: Extracts <appName> from app.json and then tries
-                                            ${nodePath.join(PathsConstants_1.default.getIOSFolder(), "<appName>", 'Info.plist')}
-                                            and ${nodePath.join(PathsConstants_1.default.getIOSFolder(), "<appName>", "Supporting", "Info.plist")}
+                                            ${iOSDefaultPath}
+                                            and ${iOSSupportingDefaultPath}
                                             in that order
 
         Examples:
@@ -38,94 +39,114 @@ const instrumentCommand = () => {
             npx instrumentDynatrace gradle="/custom/path/to/build.gradle"
             npx instrumentDynatrace plist="/custom/path/to/Info.plist"
         `, Logger_1.default.INFO);
+};
+const persistCustomArguments = (argv) => {
+    if (argv.isEmpty()) {
+        (0, CustomArgumentUtil_1.clearCustomArguments)();
         return;
     }
-    Logger_1.default.logMessageSync('⏳ Starting instrumentation of React Native application ..', Logger_1.default.INFO);
-    Logger_1.default.withPrefix({ info: '  ℹ️  ', warning: '  ⚠️  ' }, () => (0, InstrumentUtil_1.showVersionOfPlugin)());
+    (0, CustomArgumentUtil_1.writeCustomArguments)(argv);
+};
+const resolveInstrumentationPaths = (argv) => {
     let pathToConfig = PathsConstants_1.default.getConfigFilePath();
     let pathToGradle = PathsConstants_1.default.getAndroidGradleFile(PathsConstants_1.default.getAndroidFolder());
     let pathToAppGradle = PathsConstants_1.default.getAndroidAppGradleFile(PathsConstants_1.default.getAndroidFolder());
-    let androidAvailable = true;
     let pathToPList;
-    let iosAvailable = true;
-    const argv = (0, CustomArgumentUtil_1.parseCommandLine)(process.argv.slice(2));
-    if (argv.isEmpty()) {
-        (0, CustomArgumentUtil_1.clearCustomArguments)();
-    }
-    else {
-        (0, CustomArgumentUtil_1.writeCustomArguments)(argv);
-    }
     if (argv.isCustomConfigurationPathSet()) {
         pathToConfig = argv.getCustomConfigurationPath();
     }
-    Logger_1.default.withPrefix({ info: '  ℹ️  ', warning: '  ⚠️  ', error: '  ❌ ' }, () => {
-        if (argv.isCustomGradlePathSet()) {
-            pathToGradle = argv.getCustomGradlePath();
-            if (!/build\.gradle(\.kts)?$/.test(pathToGradle)) {
-                throw new Error(`--gradle must point to build.gradle or build.gradle.kts file, got ${pathToGradle}`);
-            }
-            const androidFolder = nodePath.dirname(pathToGradle);
-            pathToAppGradle = PathsConstants_1.default.getAndroidAppGradleFile(androidFolder);
-            androidAvailable = (0, InstrumentUtil_1.isPlatformAvailable)(pathToGradle, Platform_1.Platform.Android);
-        }
-        else {
-            androidAvailable = (0, InstrumentUtil_1.isPlatformAvailable)(PathsConstants_1.default.getAndroidFolder(), Platform_1.Platform.Android);
-        }
-        if (argv.isCustomPlistPathSet()) {
-            pathToPList = (0, path_1.resolve)(argv.getCustomPlistPath());
-            iosAvailable = (0, InstrumentUtil_1.isPlatformAvailable)(pathToPList, Platform_1.Platform.IOS);
+    if (argv.isCustomGradlePathSet()) {
+        pathToGradle = argv.getCustomGradlePath();
+        if (!/build\.gradle(\.kts)?$/.test(pathToGradle)) {
+            throw new Error(`--gradle must point to build.gradle or build.gradle.kts file, got ${pathToGradle}`);
         }
-        else {
-            iosAvailable = (0, InstrumentUtil_1.isPlatformAvailable)(PathsConstants_1.default.getIOSFolder(), Platform_1.Platform.IOS);
-        }
-    });
-    pathToConfig = (0, path_1.resolve)(pathToConfig);
-    pathToGradle = (0, path_1.resolve)(pathToGradle);
-    pathToAppGradle = (0, path_1.resolve)(pathToAppGradle);
-    if (iosAvailable || androidAvailable) {
-        try {
-            Logger_1.default.logMessageSync('⏳ Trying to read configuration file: ' + pathToConfig, Logger_1.default.INFO);
-            const configAgent = (0, Config_1.readConfig)(pathToConfig);
-            if (androidAvailable) {
-                try {
-                    Logger_1.default.logMessageSync('⏳ Starting Android Instrumentation with Dynatrace!', Logger_1.default.INFO);
-                    Logger_1.default.withPrefix({ info: '  ℹ️  ', warning: '  ⚠️  ', error: '  ❌ ' }, () => {
-                        android.instrumentAndroidPlatform(pathToGradle, false);
-                        android.writeGradleConfig(configAgent.android, pathToGradle);
-                        android.ensureRuntimeScriptApplied(pathToAppGradle);
-                    });
-                    Logger_1.default.logMessageSync('  ✅ Finished Android Instrumentation with Dynatrace!', Logger_1.default.INFO);
-                }
-                catch (e) {
-                    if (e instanceof Error) {
-                        Logger_1.default.logMessageSync('  ❌ Android Instrumentation failed: ' + e.message, Logger_1.default.ERROR);
-                    }
-                }
-            }
-            if (iosAvailable) {
-                try {
-                    Logger_1.default.logMessageSync('⏳ Starting iOS Instrumentation with Dynatrace!', Logger_1.default.INFO);
-                    Logger_1.default.withPrefix({ info: '  ℹ️  ', warning: '  ⚠️  ', error: '  ❌ ' }, () => Ios_1.default.modifyPListFile(pathToPList, configAgent.ios, false));
-                    Logger_1.default.logMessageSync('  ✅ Finished iOS Instrumentation with Dynatrace!', Logger_1.default.INFO);
-                }
-                catch (e) {
-                    if (e instanceof Error) {
-                        Logger_1.default.logMessageSync('  ❌ iOS Instrumentation failed: ' + e.message, Logger_1.default.ERROR);
-                    }
-                }
-            }
-            (0, SourceMapUtil_1.patchMetroSourceMap)();
-            Logger_1.default.logMessageSync('🎉 Finished instrumentation of React Native application ..', Logger_1.default.INFO);
+        pathToAppGradle = PathsConstants_1.default.getAndroidAppGradleFile((0, node_path_1.dirname)(pathToGradle));
+    }
+    if (argv.isCustomPlistPathSet()) {
+        pathToPList = argv.getCustomPlistPath();
+    }
+    return {
+        pathToConfig: (0, node_path_1.resolve)(pathToConfig),
+        pathToGradle: (0, node_path_1.resolve)(pathToGradle),
+        pathToAppGradle: (0, node_path_1.resolve)(pathToAppGradle),
+        pathToPList: pathToPList ? (0, node_path_1.resolve)(pathToPList) : undefined,
+    };
+};
+const detectPlatformAvailability = (argv, paths) => {
+    const androidAvailable = argv.isCustomGradlePathSet()
+        ? (0, InstrumentUtil_1.isPlatformAvailable)(paths.pathToGradle, Platform_1.Platform.Android)
+        : (0, InstrumentUtil_1.isPlatformAvailable)(PathsConstants_1.default.getAndroidFolder(), Platform_1.Platform.Android);
+    const iosAvailable = argv.isCustomPlistPathSet()
+        ? (0, InstrumentUtil_1.isPlatformAvailable)(paths.pathToPList, Platform_1.Platform.IOS)
+        : (0, InstrumentUtil_1.isPlatformAvailable)(PathsConstants_1.default.getIOSFolder(), Platform_1.Platform.IOS);
+    return { androidAvailable, iosAvailable };
+};
+const instrumentAndroidIfAvailable = (androidAvailable, pathToGradle, pathToAppGradle, androidConfig) => {
+    if (!androidAvailable) {
+        return;
+    }
+    try {
+        Logger_1.default.logMessageSync('⏳ Starting Android Instrumentation with Dynatrace!', Logger_1.default.INFO);
+        Logger_1.default.withPrefix(platformLogPrefix, () => {
+            android.instrumentAndroidPlatform(pathToGradle, false);
+            android.writeGradleConfig(androidConfig, pathToGradle);
+            android.ensureRuntimeScriptApplied(pathToAppGradle);
+        });
+        Logger_1.default.logMessageSync('  ✅ Finished Android Instrumentation with Dynatrace!', Logger_1.default.INFO);
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            Logger_1.default.logMessageSync('  ❌ Android Instrumentation failed: ' + e.message, Logger_1.default.ERROR);
         }
-        catch (e) {
-            if (e instanceof Error) {
-                Logger_1.default.logMessageSync('❌ Instrumentation failed: ' + e.message, Logger_1.default.ERROR);
-            }
+    }
+};
+const instrumentIosIfAvailable = (iosAvailable, pathToPList, iosConfig) => {
+    if (!iosAvailable) {
+        return;
+    }
+    try {
+        Logger_1.default.logMessageSync('⏳ Starting iOS Instrumentation with Dynatrace!', Logger_1.default.INFO);
+        Logger_1.default.withPrefix(platformLogPrefix, () => Ios_1.default.modifyPListFile(pathToPList, iosConfig, false));
+        Logger_1.default.logMessageSync('  ✅ Finished iOS Instrumentation with Dynatrace!', Logger_1.default.INFO);
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            Logger_1.default.logMessageSync('  ❌ iOS Instrumentation failed: ' + e.message, Logger_1.default.ERROR);
         }
     }
-    else {
+};
+const runPlatformInstrumentation = (paths, availability) => {
+    if (!availability.iosAvailable && !availability.androidAvailable) {
         Logger_1.default.logMessageSync('⚠️  Both Android and iOS Folder are not available - Skip instrumentation.', Logger_1.default.WARNING);
+        return;
     }
+    try {
+        Logger_1.default.logMessageSync('⏳ Trying to read configuration file: ' + paths.pathToConfig, Logger_1.default.INFO);
+        const configAgent = (0, Config_1.readConfig)(paths.pathToConfig);
+        instrumentAndroidIfAvailable(availability.androidAvailable, paths.pathToGradle, paths.pathToAppGradle, configAgent.android);
+        instrumentIosIfAvailable(availability.iosAvailable, paths.pathToPList, configAgent.ios);
+        (0, SourceMapUtil_1.patchMetroSourceMap)();
+        Logger_1.default.logMessageSync('🎉 Finished instrumentation of React Native application ..', Logger_1.default.INFO);
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            Logger_1.default.logMessageSync('❌ Instrumentation failed: ' + e.message, Logger_1.default.ERROR);
+        }
+    }
+};
+const instrumentCommand = () => {
+    const commandArgs = process.argv;
+    if (commandArgs.includes('--help')) {
+        logHelpMessage();
+        return;
+    }
+    Logger_1.default.logMessageSync('⏳ Starting instrumentation of React Native application ..', Logger_1.default.INFO);
+    Logger_1.default.withPrefix({ info: '  ℹ️  ', warning: '  ⚠️  ' }, () => (0, InstrumentUtil_1.showVersionOfPlugin)());
+    const argv = (0, CustomArgumentUtil_1.parseCommandLine)(commandArgs.slice(2));
+    persistCustomArguments(argv);
+    const instrumentationPaths = resolveInstrumentationPaths(argv);
+    const availability = Logger_1.default.withPrefix(platformLogPrefix, () => detectPlatformAvailability(argv, instrumentationPaths));
+    runPlatformInstrumentation(instrumentationPaths, availability);
     Logger_1.default.closeLogFile();
 };
 exports.instrumentCommand = instrumentCommand;

package/scripts/util/CustomArgumentUtil.js

@@ -10,17 +10,19 @@ exports.PROCESS_CUSTOM_ARGUMENT_NAME = 'dtCustomArguments';
 const parseCommandLine = (inputArgs) => {
     const parsedArgs = new CustomArgumentsBuilderImpl_1.CustomArgumentsBuilderImpl();
     inputArgs.forEach((entry) => {
-        const parts = entry.split('=');
-        if (parts.length === 2) {
-            switch (parts[0]) {
+        const eqIndex = entry.indexOf('=');
+        if (eqIndex !== -1) {
+            const key = entry.slice(0, eqIndex);
+            const value = entry.slice(eqIndex + 1);
+            switch (key) {
                 case "gradle":
-                    parsedArgs.withGradleArgument(parts[1]);
+                    parsedArgs.withGradleArgument(value);
                     break;
                 case "config":
-                    parsedArgs.withConfigurationArgument(parts[1]);
+                    parsedArgs.withConfigurationArgument(value);
                     break;
                 case "plist":
-                    parsedArgs.withPlistArgument(parts[1]);
+                    parsedArgs.withPlistArgument(value);
                     break;
             }
         }

package/types.d.ts

@@ -684,17 +684,17 @@ interface IEventModifier {
     modifyEvent(event: JSONObject): JSONObject | null;
 }
 
-/**
- * Represents the allowed types for event property values.
- */
-type EventProperty = string | number | boolean;
-
 type TraceparentHeader = `${string}-${string}-${string}-${string}`;
 interface TraceContext {
     traceparent: TraceparentHeader;
     tracestate: string;
 }
 
+/**
+ * Represents the allowed types for event property values.
+ */
+type EventProperty = string | number | boolean;
+
 /**
  * Base interface for all events.
  */
@@ -1845,8 +1845,8 @@ declare class ManualStartupConfiguration implements IConfiguration {
  * Builder for manual startup configuration used with `Dynatrace.start()`.
  */
 declare class ConfigurationBuilder {
-    private beaconUrl;
-    private applicationId;
+    private readonly beaconUrl;
+    private readonly applicationId;
     private reportCrash;
     private errorHandler;
     private reportFatalErrorAsCrash;
@@ -2346,6 +2346,157 @@ declare class DynatraceWebRequestTiming implements IDynatraceWebRequestTiming {
     getRequestTagHeader(): string;
 }
 
+/**
+ * Configuration for React Native transformer
+ */
+interface TransformerReactConfiguration {
+    /**
+     * Path to an upstream transformer to use before Dynatrace transformation
+     */
+    upstreamTransformer?: string;
+}
+/**
+ * Configuration for React Native instrumentation
+ */
+interface InstrumentationReactConfiguration {
+    /**
+     * Whether to automatically start the Dynatrace agent (and insert instrumentation for startup)
+     */
+    autoStart: boolean;
+    /**
+     * Enable debug mode for additional console output during instrumentation and runtime
+     */
+    debug: boolean;
+    /**
+     * Unique name for the bundle. Required for multiple bundle setups and sourcemap deobfuscation.
+     */
+    bundleName?: string;
+    /**
+     * Version of the bundle
+     */
+    bundleVersion?: string;
+    /**
+     * Error handler configuration
+     */
+    errorHandler: {
+        /**
+         * Enable the Dynatrace error/crash handler
+         */
+        enabled: boolean;
+        /**
+         * Report fatal/unhandled errors as crashes instead of errors
+         *
+         * @remarks
+         * When false, fatal errors are reported as errors and the current session remains open
+         */
+        reportFatalErrorAsCrash: boolean;
+    };
+    /**
+     * Lifecycle event monitoring configuration
+     */
+    lifecycle: {
+        /**
+         * Include React component update lifecycle events
+         */
+        includeUpdate: boolean;
+        /**
+         * Determine which files should have lifecycle instrumentation
+         *
+         * @param filename - Path to the file being instrumented
+         * @returns true to instrument the file, false to skip
+         *
+         * @defaultValue Returns false for all files
+         */
+        instrument: (filename: string) => boolean;
+    };
+    /**
+     * User input monitoring configuration
+     */
+    input: {
+        /**
+         * Determine which files should have input instrumentation
+         *
+         * @param filename - Path to the file being instrumented
+         * @returns true to instrument the file, false to skip
+         *
+         * @defaultValue Returns true for all files
+         */
+        instrument: (filename: string) => boolean;
+        /**
+         * Enable action name privacy to exclude automatic text/label detection
+         *
+         * @defaultValue false
+         *
+         * @remarks
+         * When true, action names will not include accessibility labels, button titles,
+         * or inner text. Use dtActionName property to set custom names.
+         */
+        actionNamePrivacy?: boolean;
+        actionNamePreference?: ActionNamePreference;
+        actionNameAlgorithm?: ActionNameAlgorithm;
+    };
+    /**
+     * Navigation monitoring configuration
+     */
+    navigation: {
+        /**
+         * Enable automatic navigation tracking
+         */
+        enabled: boolean;
+    };
+    userInteraction: boolean;
+    sourcemap: {
+        enabled: boolean;
+        androidSourcemapLocation: string;
+    };
+    debugBabelPlugin?: boolean;
+    useLegacyJscodeshift?: boolean;
+}
+/**
+ * Combined React configuration including transformer and instrumentation settings
+ */
+type ReactConfiguration = TransformerReactConfiguration & InstrumentationReactConfiguration;
+/**
+ * Main Dynatrace configuration structure
+ */
+interface DynatraceConfiguration {
+    /**
+     * React Native specific configuration
+     */
+    react: ReactConfiguration;
+    /**
+     * Android native agent configuration
+     */
+    android?: NativeConfiguration;
+    /**
+     * iOS native agent configuration
+     */
+    ios?: NativeConfiguration;
+}
+/**
+ * The type of dynatrace.config.js
+ * All properties are optional since the user can only specify a subset
+ * Will be merged with defaultConfig to ensure all required values are present
+ * When T is a primitive or a function, then DeepPartial<T> resolves to T for better readability
+ */
+type DeepPartial<T> = T extends Function ? T : T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+type DynatraceUserConfiguration = DeepPartial<DynatraceConfiguration>;
+/**
+ * Native platform (Android/iOS) configuration
+ */
+interface NativeConfiguration {
+    /**
+     * Platform-specific configuration string
+     *
+     * @remarks
+     * For Android: Contains Gradle DSL configuration block
+     * For iOS: Contains plist key-value pairs
+     */
+    config?: string;
+}
+
 declare module 'react' {
     namespace JSX {
         interface IntrinsicAttributes extends IDynatraceProperties {
@@ -2354,4 +2505,4 @@ declare module 'react' {
 }
 
 export { ConfigurationBuilder, DataCollectionLevel, Dynatrace, DynatraceWebRequestTiming, EventData, ExceptionEventData, HttpRequestEventData, LogLevel, ManualStartupConfiguration, Platform, SessionPropertyEventData, UserPrivacyOptions };
-export type { IConfiguration, IDynatraceAction, IDynatraceRootAction, IDynatraceWebRequestTiming, IEventModifier, JSONObject };
+export type { DynatraceUserConfiguration, IConfiguration, IDynatraceAction, IDynatraceRootAction, IDynatraceWebRequestTiming, IEventModifier, JSONObject };