Fix Replay not being captured on Android (#1028)

* Migrate replay fixes for Android

* ios implementation

* fix native definition

* fix tests

* changelog

* move func to vendor/base64converter

* Update android/src/main/java/io/sentry/capacitor/SentryCapacitor.java

Co-authored-by: Antonis Lilis <antonis.lilis@gmail.com>

* Apply suggestions from code review

Co-authored-by: Antonis Lilis <antonis.lilis@gmail.com>

* missing file

---------

Co-authored-by: Lucas Zimerman <lucaszimerman@Lucass-Mac-mini.local>
Co-authored-by: Antonis Lilis <antonis.lilis@gmail.com>

Author: 3 people

CHANGELOG.md

@@ -6,6 +6,12 @@
 > [migration guide](https://docs.sentry.io/platforms/javascript/guides/capacitor/migration/) first.
 <!-- prettier-ignore-end -->
 
+## Unreleased
+
+### Fixes
+
+- Replay not being captured on Android ([#1028](https://github.com/getsentry/sentry-capacitor/pull/1028))
+
 ## 2.4.0
 
 ## Feature
@@ -209,7 +215,6 @@ Sentry.init({
 ### Dependencies
 
 - Bump JavaScript SDKs from v8.55.0 to v9.0.0 ([#840](https://github.com/getsentry/sentry-capacitor/pull/840))
-
   - [changelog](https://github.com/getsentry/sentry-javascript/blob/9.0.0/CHANGELOG.md#900)
   - [diff](https://github.com/getsentry/sentry-javascript/compare/8.55.0...9.0.0)
 
@@ -230,7 +235,6 @@ Sentry.init({
 ### Dependencies
 
 - Bump JavaScript SDKs from v8.55.0 to v9.11.0 ([#840](https://github.com/getsentry/sentry-capacitor/pull/840), [#872](https://github.com/getsentry/sentry-capacitor/pull/872))
-
   - [changelog](https://github.com/getsentry/sentry-javascript/blob/9.11.0/CHANGELOG.md)
   - [diff](https://github.com/getsentry/sentry-javascript/compare/8.55.0...9.11.0)
 
@@ -276,7 +280,6 @@ Sentry.init({
 ### Dependencies
 
 - Bump JavaScript SDKs from v8.37.1 to v8.42.0 ([#730](https://github.com/getsentry/sentry-capacitor/pull/730))
-
   - [changelog](https://github.com/getsentry/sentry-javascript/blob/develop/CHANGELOG.md#8420)
   - [diff](https://github.com/getsentry/sentry-javascript/compare/8.37.1...8.42.0)
 
@@ -487,12 +490,10 @@ information.
 
   The release data comes from the following parameters:
   Android
-
   - release: `PackageInfo.packageName` + `PackageInfo.versionName` + `PackageInfo.versionCode`
   - dist: `PackageInfo.versionCode`
 
   iOS:
-
   - release: `CFBundleIdentifier` + `CFBundleShortVersionString` + `CFBundleVersion`
   - dist: `CFBundleVersion`
 

android/src/main/java/io/sentry/capacitor/SentryCapacitor.java

@@ -2,7 +2,11 @@
 
 import android.content.Context;
 import android.content.pm.PackageInfo;
-import com.getcapacitor.JSArray;
+
+import io.sentry.ILogger;
+import io.sentry.android.core.AndroidLogger;
+import io.sentry.vendor.Base64;
+
 import com.getcapacitor.JSObject;
 import com.getcapacitor.Plugin;
 import com.getcapacitor.PluginCall;
@@ -12,36 +16,31 @@
 import io.sentry.Breadcrumb;
 import io.sentry.IScope;
 import io.sentry.Integration;
-import io.sentry.ScopesAdapter;
 import io.sentry.Sentry;
 import io.sentry.SentryEvent;
 import io.sentry.SentryLevel;
 import io.sentry.UncaughtExceptionHandlerIntegration;
 import io.sentry.android.core.BuildConfig;
 import io.sentry.android.core.AnrIntegration;
+import io.sentry.android.core.InternalSentrySdk;
 import io.sentry.android.core.NdkIntegration;
 import io.sentry.android.core.SentryAndroid;
 import io.sentry.protocol.SdkVersion;
 import io.sentry.protocol.SentryPackage;
 import io.sentry.protocol.User;
-import java.io.File;
-import java.io.FileOutputStream;
 import java.nio.charset.StandardCharsets;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
-import java.util.UUID;
-import java.util.logging.Level;
-import java.util.logging.Logger;
 
 @CapacitorPlugin
 public class SentryCapacitor extends Plugin {
 
     private static final String NATIVE_SDK_NAME = "sentry.native.android.capacitor";
     private static final String ANDROID_SDK_NAME = "sentry.java.android.capacitor";
 
-    static final Logger logger = Logger.getLogger("capacitor-sentry");
+    static final ILogger logger = new AndroidLogger("capacitor-sentry");
     private Context context;
     private static PackageInfo packageInfo;
 
@@ -57,7 +56,7 @@ public void load() {
             String packageName = this.getContext().getPackageName();
             this.packageInfo = this.context.getPackageManager().getPackageInfo(packageName, 0); // Requires API 33 for deprecation change.
         } catch (Exception e) {
-            logger.info("Error getting package info.");
+            logger.log(SentryLevel.ERROR, "Error getting package info.");
         }
     }
 
@@ -77,15 +76,14 @@ public void initNativeSdk(final PluginCall call) {
 
               if (capOptions.has("debug") && capOptions.getBool("debug")) {
                     options.setDebug(true);
-                    logger.setLevel(Level.INFO);
                 }
 
                 options.setSentryClientName(sdkVersion.getName() + "/" + sdkVersion.getVersion());
                 options.setNativeSdkName(NATIVE_SDK_NAME);
                 options.setSdkVersion(sdkVersion);
 
               String dsn = capOptions.getString("dsn") != null ? capOptions.getString("dsn") : "";
-                logger.info(String.format("Starting with DSN: '%s'", dsn));
+                logger.log(SentryLevel.INFO, String.format("Starting with DSN: '%s'", dsn));
                 options.setDsn(dsn);
 
                 if (capOptions.has("environment") && capOptions.getString("environment") != null) {
@@ -146,7 +144,7 @@ public void initNativeSdk(final PluginCall call) {
 
                 options.getLogs().setEnabled(Boolean.TRUE.equals(capOptions.getBoolean("enableLogs", false)));
 
-                logger.info(String.format("Native Integrations '%s'", options.getIntegrations().toString()));
+                logger.log(SentryLevel.INFO, String.format("Native Integrations '%s'", options.getIntegrations()));
             }
         );
 
@@ -223,34 +221,21 @@ public void fetchNativeRelease(PluginCall call) {
 
     @PluginMethod
     public void captureEnvelope(PluginCall call) {
-        try {
-            JSArray rawIntegers = call.getArray("envelope");
-            byte[] bytes = new byte[rawIntegers.length()];
-            for (int i = 0; i < bytes.length; i++) {
-                bytes[i] = (byte) rawIntegers.getInt(i);
-            }
-
-            final String outboxPath = ScopesAdapter.getInstance().getOptions().getOutboxPath();
-
-            if (outboxPath == null || outboxPath.isEmpty()) {
-                logger.info("Error when writing envelope, no outbox path is present.");
-                call.reject("Missing outboxPath");
-                return;
-            }
-
-            final File installation = new File(outboxPath, UUID.randomUUID().toString());
+        String rawBytes = call.getString("envelope");
+        if  (rawBytes == null) {
+            String  errorMsg = "Can't send envelope due to empty data.";
+            logger.log(SentryLevel.ERROR,  errorMsg);
+            call.reject( errorMsg);
+            return;
+        }
+        byte[] bytes = Base64.decode(rawBytes, Base64.DEFAULT);
 
-            try (FileOutputStream out = new FileOutputStream(installation)) {
-                out.write(bytes);
-                logger.info("Successfully captured envelope.");
-            } catch (Exception e) {
-                logger.info("Error writing envelope.");
-                call.reject(String.valueOf(e));
-                return;
-            }
-        } catch (Exception e) {
-            logger.info("Error reading envelope.");
-            call.reject(String.valueOf(e));
+        try {
+            InternalSentrySdk.captureEnvelope(bytes, false);
+        } catch (Throwable e) { // NOPMD - We don't want to crash in any case
+            String  errorMsg = "Error while capturing envelope";
+            logger.log(SentryLevel.ERROR, errorMsg);
+            call.reject(errorMsg);
             return;
         }
         call.resolve();

ios/Sources/SentryCapacitorPlugin/SentryCapacitorPlugin.swift

@@ -102,19 +102,20 @@ public class SentryCapacitorPlugin: CAPPlugin, CAPBridgedPlugin {
     }
 
     @objc func captureEnvelope(_ call: CAPPluginCall) {
-        guard let bytes = call.getArray("envelope", NSNumber.self) else {
+        guard let base64Bytes = call.getString("envelope") else {
             print("Cannot parse the envelope data")
             call.reject("Envelope is null or empty")
             return
         }
 
-        let pointer = UnsafeMutablePointer<UInt8>.allocate(capacity: bytes.count)
-        for (index, number) in bytes.enumerated() {
-           // The numbers are stored as int32/64 but only the initial bits contains the number so this conversion is safe
-           pointer[index] = UInt8(number.intValue)
+        guard let data = Data(base64Encoded: base64Bytes) else {
+            print("Cannot decode base64 envelope data")
+            call.reject("Failed to decode base64 envelope")
+            return
         }
 
-        let data = Data(buffer: UnsafeMutableBufferPointer<UInt8>(start: pointer, count: bytes.count))
+        let pointer = UnsafeMutablePointer<UInt8>.allocate(capacity: data.count)
+        data.copyBytes(to: pointer, count: data.count)
 
         guard let envelope = PrivateSentrySDKOnly.envelope(with: data) else {
             call.reject("SentryCapacitor", "Failed to parse envelope from byte array.", nil)

src/definitions.ts

@@ -12,7 +12,7 @@ export type NativeDeviceContextsResponse = {
 
 export interface ISentryCapacitorPlugin {
   addBreadcrumb(breadcrumb: Breadcrumb): void;
-  captureEnvelope(payload: { envelope: number[] }): PromiseLike<boolean>;
+  captureEnvelope(payload: { envelope: string }): PromiseLike<boolean>;
 
   clearBreadcrumbs(): void;
   closeNativeSdk(): Promise<void>;

src/vendor/fromByteArray.ts

@@ -0,0 +1,79 @@
+/* eslint-disable */
+
+// The MIT License (MIT)
+
+// Copyright (c) 2014 Jameson Little
+
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+// Adapted from https://github.dev/beatgammit/base64-js/blob/88957c9943c7e2a0f03cdf73e71d579e433627d3/index.js#L119
+
+const lookup: string[] = [];
+
+const code = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
+for (let i = 0, len = code.length; i < len; ++i) {
+  // @ts-expect-error
+  lookup[i] = code[i];
+}
+
+function tripletToBase64(num: number): string {
+  // @ts-expect-error
+  return lookup[(num >> 18) & 0x3f] + lookup[(num >> 12) & 0x3f] + lookup[(num >> 6) & 0x3f] + lookup[num & 0x3f];
+}
+
+function encodeChunk(uint8: Uint8Array | number[], start: number, end: number): string {
+  let tmp;
+  const output = [];
+  for (let i = start; i < end; i += 3) {
+    // @ts-expect-error
+    tmp = ((uint8[i] << 16) & 0xff0000) + ((uint8[i + 1] << 8) & 0xff00) + (uint8[i + 2] & 0xff);
+    output.push(tripletToBase64(tmp));
+  }
+  return output.join('');
+}
+
+/**
+ * Converts a Uint8Array or Array of bytes into a string representation of base64.
+ */
+export function base64StringFromByteArray(uint8: Uint8Array | number[]): string {
+  let tmp;
+  const len = uint8.length;
+  const extraBytes = len % 3; // if we have 1 byte left, pad 2 bytes
+  const parts = [];
+  const maxChunkLength = 16383; // must be multiple of 3
+
+  // go through the array every three bytes, we'll deal with trailing stuff later
+  for (let i = 0, len2 = len - extraBytes; i < len2; i += maxChunkLength) {
+    parts.push(encodeChunk(uint8, i, i + maxChunkLength > len2 ? len2 : i + maxChunkLength));
+  }
+
+  // pad the end with zeros, but make sure to not forget the extra bytes
+  if (extraBytes === 1) {
+    tmp = uint8[len - 1];
+    // @ts-expect-error
+    parts.push(`${lookup[tmp >> 2] + lookup[(tmp << 4) & 0x3f]}==`);
+  } else if (extraBytes === 2) {
+    // @ts-expect-error
+    tmp = (uint8[len - 2] << 8) + uint8[len - 1];
+    // @ts-expect-error
+    parts.push(`${lookup[tmp >> 10] + lookup[(tmp >> 4) & 0x3f] + lookup[(tmp << 2) & 0x3f]}=`);
+  }
+
+  return parts.join('');
+}

src/wrapper.ts

@@ -17,6 +17,7 @@ import type { CapacitorOptions } from './options';
 import { SentryCapacitor } from './plugin';
 import { convertToNormalizedObject } from './utils/normalize';
 import { utf8ToBytes } from './vendor';
+import { base64StringFromByteArray } from './vendor/fromByteArray';
 
 /**
  * Internal interface for calling native functions
@@ -74,7 +75,7 @@ export const NATIVE = {
     }
 
     let transportStatusCode = 200;
-    await SentryCapacitor.captureEnvelope({ envelope: envelopeBytes }).then(
+    await SentryCapacitor.captureEnvelope({ envelope: base64StringFromByteArray(envelopeBytes) }).then(
       _ => _, // We only want to know if it failed.
       failed => {
         debug.error('Failed to capture Envelope: ', failed);

test/vendor/base64Converter.ts

@@ -0,0 +1,9 @@
+export function Base64StringToString(base64String: string): string {
+  const binaryString = atob(base64String);
+  const bytes = new Uint8Array(binaryString.length);
+  for (let i = 0; i < binaryString.length; i++) {
+    bytes[i] = binaryString.charCodeAt(i);
+  }
+  return new TextDecoder().decode(bytes);
+}
+