@dynatrace/cordova-plugin 2.327.1 → 2.331.1

package/Package.swift

@@ -0,0 +1,32 @@
+// swift-tools-version: 5.9
+
+import PackageDescription
+
+let package = Package(
+    name: "DynatraceCordovaPlugin",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(
+            name: "DynatraceCordovaPlugin",
+            targets: ["DynatraceCordovaPlugin"]
+        )
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.1")
+    ],
+    targets: [
+        .target(
+            name: "DynatraceCordovaPlugin",
+            dependencies: [
+                .product(name: "Cordova", package: "capacitor-swift-pm"),
+                "Dynatrace"
+            ],
+            path: "ios",
+            publicHeadersPath: "."
+        ),
+        .binaryTarget(
+            name: "Dynatrace",
+            path: "files/iOS/Dynatrace.xcframework"
+        )
+    ]
+)

package/README.md

@@ -22,6 +22,7 @@ For information as to why this is necessary, read more [here](#migration-from-ma
   * Gradle version 7.x+ ([How to update?](#updating-to-gradle-7))
   * Android Gradle Plugin version 7.0+
   * Java 11
+  * Jetpack Compose 1.4 - 1.10 - see [Compose Compatibility Note](#compose-compatibility-note)
 * For iOS users: Minimum iOS 12
 * For JavaScript Agent: access to API of cluster
 * Node: >= 20.x
@@ -31,8 +32,8 @@ For information as to why this is necessary, read more [here](#migration-from-ma
 
 These agent versions are configured in this plugin:
 
-* Android Agent: 8.327.2.1004
-* iOS Agent: 8.327.1.1020
+* Android Agent: 8.331.1.1004
+* iOS Agent: 8.331.1.1008
 
 ## Quick Setup
 
@@ -55,6 +56,7 @@ These agent versions are configured in this plugin:
     * [Plist Path](#plist-path)
 * [Mobile Agent configuration](#mobile-agent-configuration)
     * [Hybrid related configuration](#hybrid-related-configuration)
+    * [iOS only configuration](#ios-only-configuration)
 * [JavaScript Agent configuration](#javascript-agent-configuration)
     * [JavaScript Agent Snippet Mode](#javascript-agent-snippet-mode)
     * [HTML Instrumentation Requirements](#html-instrumentation-requirements)
@@ -80,6 +82,7 @@ These agent versions are configured in this plugin:
 * [Native OneAgent debug logs](#native-oneagent-debug-logs)
     * [Android](#android)
     * [iOS](#ios)
+* [Compose Compatibility Note](#compose-compatibility-note)
 * [Official documentation](#official-documentation)
 * [Doctor Dynatrace](#doctor-dynatrace)
 * [Instrumentation Overhead](#instrumentation-overhead)
@@ -139,6 +142,8 @@ This screen shows what a `combined` sample user session should roughly look like
 
 To instrument your Ionic Capacitor app, you will need to follow the steps below:
 
+**Note for Capacitor iOS:** Starting with Capacitor 8, new iOS projects by default use Swift Package Manager (SPM) instead of CocoaPods. The Dynatrace Cordova Plugin supports SPM based Cordova/Ionic + Capacitor projects. The steps are the same for both CocoaPods and SPM to setup/install the plugin.
+
 1. Install the Dynatrace Cordova Plugin via the following command:
 * `npm install @dynatrace/cordova-plugin`
 ** **Note:** If you do not want our plugin to modify your `package.json`, you can choose to opt-out of that process. See [opt-out](#opt-out) for more details.
@@ -218,7 +223,7 @@ There is flag for updating the CSP (Content Security Policy). By default this va
 
 ### Cookie Proxy
 
-Issues with cookies are somehow a persistent companion in Ionic or Capacitor applications. Therefore we provide a proxy script which is wrapping the document.cookie API and are storing the cookies which are important for the Dynatrace Agents in the session storage. Of course this wrapping is still calling the original API. Please see the [Capacitor Cookie Proxy](#capacitor-cookie-proxy) section below if you are using `CapacitorCookies` in your application. If not, please see the configuration below.
+Issues with cookies are somehow a persistent companion in Ionic or Capacitor applications. Therefore, we provide a proxy script which is wrapping the document.cookie API and are storing the cookies which are important for the Dynatrace Agents in the session storage. Of course this wrapping is still calling the original API. Please see the [Capacitor Cookie Proxy](#capacitor-cookie-proxy) section below if you are using `CapacitorCookies` in your application. If not, please see the configuration below.
 
 Per default the cookie proxy is turned off. To make use of this proxy you need to enable it in the cordova configuration in the dynatrace.config.js:
 
@@ -324,6 +329,40 @@ module.exports = {
 
 * `DTXSetCookiesForDomain` or `hybridWebView.domains` : For hybrid applications using the JavaScript agent, cookies need to be set for each instrumented domain or server the application communicates with. You can specify domains, host or IP addresses. Domains or sub-domains must start with a dot. Separate the list elements with a comma.
 
+### iOS only configuration
+
+The `DTXHybridApplicationMode` flag is available for iOS only. 
+
+Using the default value of `cookies` will set the behavior of the iOS agent to inject Javascript into the webview which allows the JS agent and iOS agent to correlate the mobile and web session via cookies and or local storage.
+
+```js
+module.exports = {
+    ios : {
+		config : `
+    <key>DTXHybridApplicationMode</key>
+    <string>cookies</string>
+		`
+    }  
+}
+```
+
+Using the value of `useragent` will result in modifying the UserAgent header, which appends specific key/values that will allow the JS agent to correlate mobile and web sessions properly. This option requires cluster version (or JavaScript Agent version) 327 or higher.
+
+**Note:** Using this setting will preserve the original UserAgent header and append the following string: `DTHybrid/x.x dtAdk=... dtAdkSettings=...`
+
+```js
+module.exports = {
+    ios : {
+		config : `
+    <key>DTXHybridApplicationMode</key>
+    <string>useragent</string>
+		`
+    }  
+}
+```
+
+* `DTXHybridApplication` or `hybridWebView.enabled` : Set to `true` if you have a Hybrid application. This property is automatically set to true if you are using the dynatrace.config.js file downloaded from the Instrumentation Wizard. Otherwise, the default value is `false`.
+
 ## JavaScript Agent configuration
 
 Basically all needed properties for the JavaScript Agent are predefined by the downloadable `dynatrace.config.js`. There are four available properties: 
@@ -844,6 +883,41 @@ ios: {
 }
 ```
 
+## Compose Compatibility Note
+
+Our Android Agent currently supports **Jetpack Compose 1.4 - 1.10**. If you are using an incompatible version of Jetpack Compose, you may encounter the following error message during build:
+
+```
+Could not resolve all dependencies for configuration ':app:debugCompileClasspath'.
+Version '1.0.0' of artifact 'androidx.compose.material:material' is not supported.
+Please use the latest version of the Dynatrace Android Gradle plugin.
+```
+
+If you encounter compatibility issues or want to disable Jetpack Compose instrumentation, you can configure this in your `dynatrace.config.js` file. **Note: Disabling Jetpack Compose instrumentation will skip the compatibility check, allowing you to build with any version of Jetpack Compose without triggering version validation errors.**
+
+**Important**: The configuration example below shows **only the Compose-specific setting**. You must ensure that your complete `dynatrace.config.js` file includes all other required configuration settings (such as `beaconUrl`, `applicationId`, etc.) as described in the [Android block](#mobile-agent-configuration) section of this documentation.
+
+```js
+module.exports = {
+  // ...
+  android: {
+        config: `
+        dynatrace {
+            configurations {
+                defaultConfig {
+                    userActions {
+                        composeEnabled false
+                    }
+                }
+            }
+        }
+        `,
+  }
+};
+```
+
+For more information about Jetpack Compose instrumentation and monitoring capabilities, please refer to the [official Dynatrace documentation for Android OneAgent](https://docs.dynatrace.com/docs/observe/digital-experience/mobile-applications/instrument-android-app/instrumentation-via-plugin/monitoring-capabilities#compose-enable).
+
 ## Official documentation
 
   * Android Agent: https://www.dynatrace.com/support/help/technology-support/operating-systems/android/
@@ -884,6 +958,8 @@ Basically if you have problems with the plugin please have a look into the logs.
 * If you have problems retrieving the JavaScript Agent and you get error messages that the JavaScript Agent can not be retrieved, you probably don't have access to the API or there is a certificate issue. If this is the certificate use the [allow any certificate](#allow-any-certificate) feature. In any other case a workaround is possible to use the cli and add the `--jsagent=` custom parameter and download the full Javascript Agent and add the path to the downloaded JS Agent file to the custom parameter value - With this the plugin will not retrieve the JS agent and will use the one that is specified.
 * If you are not seeing data when using Capacitor 3+, please make sure you follow the steps in the [Capacitor Instrumentation](#capacitor-instrumentation) section (more specifically step 4 for the proper commands). Please read the note at the bottom of that section for more information.
 * For Android, if you see an error like "Gradle sync failed: Could not find com.dynatrace.tools.android:gradle-plugin:8.221.1.1005.", please see the [MavenCentral](#mavencentral-in-top-level-gradle-file) section for an example and more information.
+* If you see a message like "Error: Could not retrieve JS Agent optionsForbidden", this means that the internal axios library is too old for processing the request correctly. The solution is to update the Cordova Plugin version, which internally uses a newer axios version to retrieve the JavaScript agent.
+
 
 ### iOS Session Correlation Issues
 
@@ -900,10 +976,21 @@ To resolve this issue and allow the Mobile and Web sessions to correlate properl
 
 When using Apple Pay with WKWebView, there are specific checks that WebKit (Apple) uses when loading the Apple Pay SDK. The Apple Pay SDK does not work when using script injection APIs which is what our iOS agent uses to properly communicate with the JS agent and to correlate the Mobile and Web User Sessions.
 
-**Workaround:** You can set the `DTXHybridApplication` flag to false which will remove the injection of our script. This will also remove the correlation of the Mobile and Web Sessions.
+**Solution:** Set the `DTXHybridApplicationMode` flag to `useragent` that will allow our plugin to work properly with Apple Pay. For more information, see [iOS only configuration.](#ios-only-configuration)
+
+**Other Workaround:** You can set the `DTXHybridApplication` flag to false which will remove the injection of our script. This will also remove the correlation of the Mobile and Web Sessions.
 
 ## Changelog
 
+2.331.1
+* Updated Android (8.331.1.1004) & iOS Agent (8.331.1.1008)
+* Added Swift Package Manager (SPM) support for Capacitor iOS projects
+* Added [Compose Compatibility Note](#compose-compatibility-note)
+
+2.329.1
+* Updated Android (8.329.1.1014) & iOS Agent (8.329.1.1017)
+* Updated logic for dynatraceMobile API for iOS to use messageHandler if there is no script injection in WKWebView (see [iOS only configuration](#ios-only-configuration))
+
 2.327.1
 * Updated Android (8.327.2.1004) & iOS Agent (8.327.1.1020)
 

package/files/iOS/Dynatrace.xcframework/Info.plist

@@ -8,7 +8,7 @@
 			<key>BinaryPath</key>
 			<string>Dynatrace.framework/Dynatrace</string>
 			<key>LibraryIdentifier</key>
-			<string>tvos-arm64</string>
+			<string>ios-arm64</string>
 			<key>LibraryPath</key>
 			<string>Dynatrace.framework</string>
 			<key>SupportedArchitectures</key>
@@ -16,30 +16,27 @@
 				<string>arm64</string>
 			</array>
 			<key>SupportedPlatform</key>
-			<string>tvos</string>
+			<string>ios</string>
 		</dict>
 		<dict>
 			<key>BinaryPath</key>
 			<string>Dynatrace.framework/Dynatrace</string>
 			<key>LibraryIdentifier</key>
-			<string>tvos-arm64_x86_64-simulator</string>
+			<string>tvos-arm64</string>
 			<key>LibraryPath</key>
 			<string>Dynatrace.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
-				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>tvos</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
 		</dict>
 		<dict>
 			<key>BinaryPath</key>
 			<string>Dynatrace.framework/Dynatrace</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
+			<string>tvos-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>Dynatrace.framework</string>
 			<key>SupportedArchitectures</key>
@@ -48,7 +45,7 @@
 				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
-			<string>ios</string>
+			<string>tvos</string>
 			<key>SupportedPlatformVariant</key>
 			<string>simulator</string>
 		</dict>
@@ -56,15 +53,18 @@
 			<key>BinaryPath</key>
 			<string>Dynatrace.framework/Dynatrace</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
+			<string>ios-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>Dynatrace.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
+				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
 		</dict>
 	</array>
 	<key>CFBundlePackageType</key>