Fix native options test (#959)

* fix native options test

* copy test

* small refactor, sdkinfo

* small refactor, sdkinfo

* lots of test logic changes

* make test more flexible

* comment cleanup

Author: lucas-zimerman

test/extensions/sentryCapacitorJest.ts

@@ -0,0 +1,8 @@
+import { Capacitor } from '@capacitor/core';
+
+// Must be imported after the line that mocks Capacitor.
+export function expectPlatformWithReturn(platform: string) {
+  const mockGetPlatform = Capacitor.getPlatform as jest.Mock;
+  expect(mockGetPlatform).toHaveBeenCalled();
+  expect(mockGetPlatform).toHaveReturnedWith(platform);
+}

test/integrations/sdkinfo.test.ts

@@ -30,7 +30,6 @@ jest.mock('../../src/wrapper', () => {
 
 describe('Sdk Info', () => {
   afterEach(() => {
-
     NATIVE.platform = 'ios';
   });
 
@@ -40,7 +39,7 @@ describe('Sdk Info', () => {
     const processedEvent = await processEvent(mockEvent);
 
     expect(processedEvent?.sdk?.packages).toEqual(expect.arrayContaining([mockiOSPackage]));
-    expect(processedEvent?.platform === 'javascript');
+    expect(processedEvent?.platform).toBe('javascript');
     expect(mockedFetchNativeSdkInfo).toHaveBeenCalledTimes(1);
   });
 

test/mocks/capacitor.ts

@@ -0,0 +1,13 @@
+// Shared mock for @capacitor/core to avoid conflicts between test files
+export const mockCapacitor = {
+  WebPlugin: jest.fn(),
+  registerPlugin: jest.fn(),
+  Capacitor: {
+    isPluginAvailable: jest.fn(() => true),
+    getPlatform: jest.fn(() => 'android'),
+  },
+};
+
+export const setupCapacitorMock = () => {
+  jest.doMock('@capacitor/core', () => mockCapacitor);
+};

test/nativeOptions.test.ts

@@ -1,35 +1,44 @@
-import { Capacitor } from '@capacitor/core';
 import type { StackParser } from '@sentry/core';
 import type { CapacitorOptions } from 'src';
-import { FilterNativeOptions } from '../src/nativeOptions';
+// Use shared mock to avoid conflicts
+import { setupCapacitorMock } from './mocks/capacitor';
+
+setupCapacitorMock();
 
-// Mock the Capacitor module
-jest.mock('@capacitor/core', () => ({
-  Capacitor: {
-    getPlatform: jest.fn()
-  }
-}));
+import { Capacitor } from '@capacitor/core';
+import { FilterNativeOptions } from '../src/nativeOptions';
+import { expectPlatformWithReturn } from './extensions/sentryCapacitorJest';
 
 
 describe('nativeOptions', () => {
+  const mockGetPlatform = Capacitor.getPlatform as jest.Mock;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    mockGetPlatform.mockReturnValue('web2');
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
 
-  test('enableWatchdogTerminationTracking is set when defined', async () => {
+  test('enableWatchdogTerminationTracking is set when defined', () => {
     const nativeOptions = FilterNativeOptions(
       {
         enableWatchdogTerminationTracking: true
       });
     expect(nativeOptions.enableWatchdogTerminationTracking).toBeTruthy();
   });
 
-  test('enableCaptureFailedRequests is set when defined', async () => {
+  test('enableCaptureFailedRequests is set when defined', () => {
     const nativeOptions = FilterNativeOptions(
       {
         enableCaptureFailedRequests: true
       });
     expect(nativeOptions.enableCaptureFailedRequests).toBeTruthy();
   });
 
-  test('invalid types not included', async () => {
+  test('invalid types not included', () => {
     const nativeOptions = FilterNativeOptions(
       {
         _experiments: { key: true },
@@ -52,7 +61,6 @@ describe('nativeOptions', () => {
         enableNativeNagger: true,
         enableNdkScopeSync: true,
         enableWatchdogTerminationTracking: true,
-        enableTracing: true,
         enableCaptureFailedRequests: true,
         environment: 'Prod',
         ignoreErrors: ['test'],
@@ -93,22 +101,22 @@ describe('nativeOptions', () => {
     expect(keysFilter.toString()).toBe('');
   });
 
-  test('Should include iOS parameters when running on iOS', async () => {
-    (Capacitor.getPlatform as jest.Mock).mockReturnValue('ios');
-
+  test('Should include iOS parameters when running on iOS', () => {
+    mockGetPlatform.mockReturnValue('ios');
     const expectedOptions: CapacitorOptions = {
       environment: 'abc',
       // iOS parameters
       enableAppHangTracking: true,
       appHangTimeoutInterval: 123
     };
     const nativeOptions = FilterNativeOptions(expectedOptions);
+
+    expectPlatformWithReturn('ios');
     expect(JSON.stringify(nativeOptions)).toEqual(JSON.stringify(expectedOptions));
   });
 
-  test('Should not include iOS parameters when running on android', async () => {
-    (Capacitor.getPlatform as jest.Mock).mockReturnValue('android');
-
+  test('Should not include iOS parameters when running on android', () => {
+    mockGetPlatform.mockReturnValue('android');
     const expectedOptions = {
       environment: 'abc',
     };
@@ -118,12 +126,13 @@ describe('nativeOptions', () => {
         enableAppHangTracking: true
       }
     });
+
+    expectPlatformWithReturn('android');
     expect(nativeOptions).toEqual(expectedOptions);
   });
 
-  test('Set logger on Android', async () => {
-    (Capacitor.getPlatform as jest.Mock).mockReturnValue('android');
-
+  test('Set logger on Android', () => {
+    mockGetPlatform.mockReturnValue('android');
     const filteredOptions: CapacitorOptions = {
       _experiments: { enableLogs : true}
     };
@@ -133,17 +142,20 @@ describe('nativeOptions', () => {
     };
 
     const nativeOptions = FilterNativeOptions(filteredOptions);
+
+    expectPlatformWithReturn('android');
     expect(JSON.stringify(nativeOptions)).toEqual(JSON.stringify(expectedOptions));
   });
 
-  test('Ignore logger on iOS', async () => {
-    (Capacitor.getPlatform as jest.Mock).mockReturnValue('ios');
-
+  test('Ignore logger on iOS', () => {
+    mockGetPlatform.mockReturnValue('ios');
     const filteredOptions: CapacitorOptions = {
       _experiments: { enableLogs : true}
     };
 
     const nativeOptions = FilterNativeOptions(filteredOptions);
+
+    expectPlatformWithReturn('ios');
     expect(nativeOptions).toEqual({});
   });
 });

test/wrapper.test.ts

@@ -2,32 +2,15 @@
 import type { Envelope, EventEnvelope, EventItem, SeverityLevel, TransportMakeRequestResponse } from '@sentry/core';
 import {createEnvelope, dropUndefinedKeys, logger} from '@sentry/core';
 import { utf8ToBytes } from '../src/vendor';
-import { NATIVE } from '../src/wrapper';
 
 let getStringBytesLengthValue = 1;
 
-function NumberArrayToString(numberArray: number[]): string {
-  return new TextDecoder().decode(new Uint8Array(numberArray).buffer);
-}
+// Use shared mock to avoid conflicts
+import { setupCapacitorMock } from './mocks/capacitor';
 
-jest.mock(
-  '@capacitor/core',
-  () => {
-    const original = jest.requireActual('@capacitor/core');
-
-    return {
-      WebPlugin: original.WebPlugin,
-      registerPlugin: jest.fn(),
-      Capacitor: {
-        isPluginAvailable: jest.fn(() => true),
-        getPlatform: jest.fn(() => 'android'),
-      },
-    };
-  },
-  /* virtual allows us to mock modules that aren't in package.json */
-  { virtual: true },
-);
+setupCapacitorMock();
 
+// Mock the plugin before importing wrapper
 jest.mock('../src/plugin', () => {
   return {
     SentryCapacitor: {
@@ -65,7 +48,13 @@ jest.mock('../src/plugin', () => {
   };
 });
 
+// Now import after mocks are set up
 import { SentryCapacitor } from '../src/plugin';
+import { NATIVE } from '../src/wrapper';
+
+function NumberArrayToString(numberArray: number[]): string {
+  return new TextDecoder().decode(new Uint8Array(numberArray).buffer);
+}
 
 beforeEach(() => {
   getStringBytesLengthValue = 1;