From 1aa3660786c8919488148d364c3500bc1e1028e4 Mon Sep 17 00:00:00 2001 From: LucasZF Date: Tue, 19 Mar 2024 17:04:04 +0000 Subject: [PATCH 01/48] revert: Moved message stack trace back to exception (fixes symbolication) (#3635) --- CHANGELOG.md | 6 ++++++ src/js/client.ts | 19 +------------------ src/js/integrations/debugsymbolicator.ts | 1 - test/client.test.ts | 7 ++++--- 4 files changed, 11 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ad7b02e2a0..328808d7dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## Unreleased + +### Fixes + +- CaptureMessage stack-trace is now symbolicated ([#3635](https://github.com/getsentry/sentry-react-native/pull/3635)) + ## 5.20.0 ### Features diff --git a/src/js/client.ts b/src/js/client.ts index 9c62b5ea36..f351a75f67 100644 --- a/src/js/client.ts +++ b/src/js/client.ts @@ -6,10 +6,8 @@ import type { Envelope, Event, EventHint, - Exception, Outcome, SeverityLevel, - Thread, UserFeedback, } from '@sentry/types'; import { dateTimestampInSeconds, logger, SentryError } from '@sentry/utils'; @@ -58,22 +56,7 @@ export class ReactNativeClient extends BaseClient { * @inheritDoc */ public eventFromMessage(message: string, level?: SeverityLevel, hint?: EventHint): PromiseLike { - return eventFromMessage(this._options.stackParser, message, level, hint, this._options.attachStacktrace).then( - (event: Event) => { - // TMP! Remove this function once JS SDK uses threads for messages - if (!event.exception?.values || event.exception.values.length <= 0) { - return event; - } - const values = event.exception.values.map( - (exception: Exception): Thread => ({ - stacktrace: exception.stacktrace, - }), - ); - (event as { threads?: { values: Thread[] } }).threads = { values }; - delete event.exception; - return event; - }, - ); + return eventFromMessage(this._options.stackParser, message, level, hint, this._options.attachStacktrace); } /** diff --git a/src/js/integrations/debugsymbolicator.ts b/src/js/integrations/debugsymbolicator.ts index 1174c79053..048387dfcd 100644 --- a/src/js/integrations/debugsymbolicator.ts +++ b/src/js/integrations/debugsymbolicator.ts @@ -59,7 +59,6 @@ export class DebugSymbolicator implements Integration { symbolicatedFrames && this._replaceExceptionFramesInEvent(event, symbolicatedFrames); } else if (event.threads) { // RN JS doesn't have threads - // syntheticException is used for Sentry.captureMessage() threads symbolicatedFrames && this._replaceThreadFramesInEvent(event, symbolicatedFrames); } } diff --git a/test/client.test.ts b/test/client.test.ts index ffdefc9547..d6dfc5241e 100644 --- a/test/client.test.ts +++ b/test/client.test.ts @@ -368,11 +368,12 @@ describe('Tests ReactNativeClient', () => { const getMessageEventFrom = (func: jest.Mock) => func.mock.calls[0][firstArg][envelopeItems][0][envelopeItemPayload]; - test('captureMessage contains stack trace in threads', async () => { + test('captureMessage contains stack trace in exception', async () => { const mockSyntheticExceptionFromHub = new Error(); client.captureMessage('test message', 'error', { syntheticException: mockSyntheticExceptionFromHub }); - expect(getMessageEventFrom(mockTransportSend).threads.values.length).toBeGreaterThan(0); - expect(getMessageEventFrom(mockTransportSend).exception).toBeUndefined(); + expect(getMessageEventFrom(mockTransportSend).exception.values.length).toBeGreaterThan(0); + expect(getMessageEventFrom(mockTransportSend).exception).toBeDefined(); + expect(getMessageEventFrom(mockTransportSend).threads).toBeUndefined(); }); }); From 2016bc9bc11d761030f93c6e6493ca1d366ee871 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kry=C5=A1tof=20Wold=C5=99ich?= <31292499+krystofwoldrich@users.noreply.github.com> Date: Wed, 3 Apr 2024 12:07:59 +0200 Subject: [PATCH 02/48] test(init): Remove deps on internal JS SDK structures (#3717) --- test/sdk.test.ts | 286 +++++++++++------------------------- test/sdk.withclient.test.ts | 49 ++++++ 2 files changed, 131 insertions(+), 204 deletions(-) create mode 100644 test/sdk.withclient.test.ts diff --git a/test/sdk.test.ts b/test/sdk.test.ts index 201a192762..00a3d893dd 100644 --- a/test/sdk.test.ts +++ b/test/sdk.test.ts @@ -1,88 +1,23 @@ -/** - * @jest-environment jsdom - */ -import { logger } from '@sentry/utils'; - -interface MockedClient { - flush: jest.Mock; -} - -let mockedGetCurrentHubWithScope: jest.Mock; -let mockedGetCurrentHubConfigureScope: jest.Mock; - -jest.mock('@sentry/react', () => { - const actualModule = jest.requireActual('@sentry/react'); - - const mockClient: MockedClient = { - flush: jest.fn(() => Promise.resolve(true)), - }; - - return { - ...actualModule, - getCurrentHub: jest.fn(() => { - mockedGetCurrentHubWithScope = jest.fn(); - mockedGetCurrentHubConfigureScope = jest.fn(); - return { - getClient: jest.fn(() => mockClient), - setTag: jest.fn(), - withScope: mockedGetCurrentHubWithScope, - configureScope: mockedGetCurrentHubConfigureScope, - }; - }), - }; -}); - -jest.mock('@sentry/core', () => { - const originalCore = jest.requireActual('@sentry/core'); - return { - ...originalCore, - initAndBind: jest.fn(), - }; -}); - -jest.mock('@sentry/hub', () => { - const originalHub = jest.requireActual('@sentry/hub'); - return { - ...originalHub, - makeMain: jest.fn(), - }; -}); - -jest.mock('../src/js/scope', () => { - return { - ReactNativeScope: class ReactNativeScopeMock {}, - }; -}); - -jest.mock('../src/js/client', () => { - return { - ReactNativeClient: class ReactNativeClientMock {}, - }; -}); - -import * as mockedWrapper from './mockWrapper'; -jest.mock('../src/js/wrapper', () => mockedWrapper); -jest.mock('../src/js/utils/environment'); - jest.spyOn(logger, 'error'); +jest.mock('../src/js/wrapper', () => jest.requireActual('./mockWrapper')); +jest.mock('../src/js/utils/environment'); +jest.mock('@sentry/core', () => ({ + ...jest.requireActual('@sentry/core'), + initAndBind: jest.fn(), +})); import { initAndBind } from '@sentry/core'; -import { getCurrentHub, makeFetchTransport } from '@sentry/react'; +import { makeFetchTransport } from '@sentry/react'; import type { BaseTransportOptions, ClientOptions, Integration, Scope } from '@sentry/types'; +import { logger } from '@sentry/utils'; -import type { ReactNativeClientOptions } from '../src/js/options'; -import { configureScope, flush, init, withScope } from '../src/js/sdk'; +import { init, withScope } from '../src/js/sdk'; import { ReactNativeTracing, ReactNavigationInstrumentation } from '../src/js/tracing'; import { makeNativeTransport } from '../src/js/transports/native'; import { getDefaultEnvironment, isExpoGo, notWeb } from '../src/js/utils/environment'; import { NATIVE } from './mockWrapper'; import { firstArg, secondArg } from './testutils'; -const mockedInitAndBind = initAndBind as jest.MockedFunction; -const usedOptions = (): ClientOptions | undefined => { - return mockedInitAndBind.mock.calls[0]?.[1]; -}; - describe('Tests the SDK functionality', () => { beforeEach(() => { (NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => true); @@ -95,21 +30,6 @@ describe('Tests the SDK functionality', () => { describe('init', () => { describe('enableAutoPerformanceTracing', () => { - const usedOptions = (): Integration[] => { - const mockCall = mockedInitAndBind.mock.calls[0]; - - if (mockCall) { - const options = mockCall[1]; - - return options.integrations; - } - return []; - }; - - const autoPerformanceIsEnabled = (): boolean => { - return usedOptions().some(integration => integration.name === ReactNativeTracing.id); - }; - const reactNavigationInstrumentation = (): ReactNativeTracing => { const nav = new ReactNavigationInstrumentation(); return new ReactNativeTracing({ routingInstrumentation: nav }); @@ -163,7 +83,7 @@ describe('Tests the SDK functionality', () => { integrations: [tracing], }); - const options = usedOptions(); + const options = usedIntegrations(); expect(options.filter(integration => integration.name === ReactNativeTracing.id).length).toBe(1); expect(options.some(integration => integration === tracing)).toBe(true); }); @@ -176,42 +96,12 @@ describe('Tests the SDK functionality', () => { defaultIntegrations: [tracing], }); - const options = usedOptions(); + const options = usedIntegrations(); expect(options.filter(integration => integration.name === ReactNativeTracing.id).length).toBe(1); expect(options.some(integration => integration === tracing)).toBe(true); }); }); - describe('flush', () => { - it('Calls flush on the client', async () => { - const mockClient = getMockClient(); - - expect(mockClient).toBeTruthy(); - - if (mockClient) { - const flushResult = await flush(); - - expect(mockClient.flush).toBeCalled(); - expect(flushResult).toBe(true); - } - }); - - it('Returns false if flush failed and logs error', async () => { - const mockClient = getMockClient(); - - expect(mockClient).toBeTruthy(); - if (mockClient) { - mockClient.flush = jest.fn(() => Promise.reject()); - - const flushResult = await flush(); - - expect(mockClient.flush).toBeCalled(); - expect(flushResult).toBe(false); - expect(logger.error).toBeCalledWith('Failed to flush the event queue.'); - } - }); - }); - describe('environment', () => { it('detect development environment', () => { (getDefaultEnvironment as jest.Mock).mockImplementation(() => 'development'); @@ -356,7 +246,7 @@ describe('Tests the SDK functionality', () => { init({ initialScope: mockInitialScope }); expect(() => { - (mockedInitAndBind.mock.calls[0][secondArg].initialScope as (scope: Scope) => Scope)({} as any); + (usedOptions()?.initialScope as (scope: Scope) => Scope)({} as any); }).not.toThrow(); expect(mockInitialScope).toBeCalledTimes(1); }); @@ -368,7 +258,7 @@ describe('Tests the SDK functionality', () => { init({ beforeBreadcrumb: mockBeforeBreadcrumb }); expect(() => { - mockedInitAndBind.mock.calls[0][secondArg].beforeBreadcrumb?.({} as any); + usedOptions()?.beforeBreadcrumb?.({} as any); }).not.toThrow(); expect(mockBeforeBreadcrumb).toBeCalledTimes(1); }); @@ -392,7 +282,7 @@ describe('Tests the SDK functionality', () => { init({ tracesSampler: mockTraceSampler }); expect(() => { - mockedInitAndBind.mock.calls[0][secondArg].tracesSampler?.({} as any); + usedOptions()?.tracesSampler?.({} as any); }).not.toThrow(); expect(mockTraceSampler).toBeCalledTimes(1); }); @@ -404,39 +294,20 @@ describe('Tests the SDK functionality', () => { throw 'Test error'; }); - withScope(mockScopeCallback); - - expect(() => { - (mockedGetCurrentHubWithScope.mock.calls[0][firstArg] as (scope: Scope) => void)({} as any); - }).not.toThrow(); - expect(mockScopeCallback).toBeCalledTimes(1); - }); - }); - - describe('configureScope', () => { - test('configureScope callback does not throw', () => { - const mockScopeCallback = jest.fn(() => { - throw 'Test error'; - }); - - configureScope(mockScopeCallback); - - expect(() => { - (mockedGetCurrentHubConfigureScope.mock.calls[0][firstArg] as (scope: Scope) => void)({} as any); - }).not.toThrow(); + expect(() => withScope(mockScopeCallback)).not.toThrow(); expect(mockScopeCallback).toBeCalledTimes(1); }); }); describe('integrations', () => { it('replaces default integrations', () => { - const mockDefaultIntegration = getMockedIntegration(); + const mockDefaultIntegration = createMockedIntegration(); init({ defaultIntegrations: [mockDefaultIntegration], }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual([mockDefaultIntegration]); }); @@ -444,8 +315,8 @@ describe('Tests the SDK functionality', () => { it('no http client integration by default', () => { init({}); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'HttpClient' })])); }); @@ -455,8 +326,8 @@ describe('Tests the SDK functionality', () => { enableCaptureFailedRequests: true, }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'HttpClient' })])); }); @@ -473,8 +344,8 @@ describe('Tests the SDK functionality', () => { ], }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual( expect.arrayContaining([ @@ -484,14 +355,14 @@ describe('Tests the SDK functionality', () => { }), ]), ); - expect(actualIntegrations.filter(integration => integration.name === 'HttpClient')).toHaveLength(1); + expect(actualIntegrations?.filter(integration => integration.name === 'HttpClient')).toHaveLength(1); }); it('no screenshot integration by default', () => { init({}); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'Screenshot' })])); }); @@ -501,8 +372,8 @@ describe('Tests the SDK functionality', () => { attachScreenshot: true, }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Screenshot' })])); }); @@ -510,8 +381,8 @@ describe('Tests the SDK functionality', () => { it('no view hierarchy integration by default', () => { init({}); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual( expect.not.arrayContaining([expect.objectContaining({ name: 'ViewHierarchy' })]), @@ -523,8 +394,8 @@ describe('Tests the SDK functionality', () => { attachViewHierarchy: true, }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'ViewHierarchy' })])); }); @@ -532,8 +403,8 @@ describe('Tests the SDK functionality', () => { it('no profiling integration by default', () => { init({}); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual( expect.not.arrayContaining([expect.objectContaining({ name: 'HermesProfiling' })]), ); @@ -546,8 +417,8 @@ describe('Tests the SDK functionality', () => { }, }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual( expect.arrayContaining([expect.objectContaining({ name: 'HermesProfiling' })]), ); @@ -556,8 +427,8 @@ describe('Tests the SDK functionality', () => { it('no spotlight integration by default', () => { init({}); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'Spotlight' })])); }); @@ -566,8 +437,8 @@ describe('Tests the SDK functionality', () => { enableSpotlight: true, }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Spotlight' })])); }); @@ -576,42 +447,42 @@ describe('Tests the SDK functionality', () => { defaultIntegrations: false, }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual([]); }); it('merges with passed default integrations', () => { - const mockIntegration = getMockedIntegration(); - const mockDefaultIntegration = getMockedIntegration({ name: 'MockedDefaultIntegration' }); + const mockIntegration = createMockedIntegration(); + const mockDefaultIntegration = createMockedIntegration({ name: 'MockedDefaultIntegration' }); init({ integrations: [mockIntegration], defaultIntegrations: [mockDefaultIntegration], }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.arrayContaining([mockIntegration, mockDefaultIntegration])); // order doesn't matter - expect(actualIntegrations.length).toBe(2); // there should be no extra unexpected integrations + expect(actualIntegrations?.length).toBe(2); // there should be no extra unexpected integrations }); it('merges with default integrations', () => { - const mockIntegration = getMockedIntegration(); + const mockIntegration = createMockedIntegration(); init({ integrations: [mockIntegration], }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.arrayContaining([mockIntegration])); - expect(actualIntegrations.length).toBeGreaterThan(1); // there should be default integrations + the test one + expect(actualIntegrations?.length).toBeGreaterThan(1); // there should be default integrations + the test one }); it('passes default integrations to the function', () => { - const mockIntegration = getMockedIntegration(); + const mockIntegration = createMockedIntegration(); const mockIntegrationFactory = jest.fn((_integrations: Integration[]) => [mockIntegration]); init({ integrations: mockIntegrationFactory, @@ -621,15 +492,15 @@ describe('Tests the SDK functionality', () => { expect(actualPassedIntegrations.length).toBeGreaterThan(0); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual([mockIntegration]); }); it('passes custom default integrations to the function', () => { - const mockIntegration = getMockedIntegration(); - const mockDefaultIntegration = getMockedIntegration({ name: 'MockedDefaultIntegration' }); + const mockIntegration = createMockedIntegration(); + const mockDefaultIntegration = createMockedIntegration({ name: 'MockedDefaultIntegration' }); const mockIntegrationFactory = jest.fn((_integrations: Integration[]) => [mockIntegration]); init({ integrations: mockIntegrationFactory, @@ -640,8 +511,8 @@ describe('Tests the SDK functionality', () => { expect(actualPassedIntegrations).toEqual([mockDefaultIntegration]); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual([mockIntegration]); }); @@ -661,8 +532,8 @@ describe('Tests the SDK functionality', () => { it('adds react default integrations', () => { init({}); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual( expect.arrayContaining([ @@ -678,8 +549,8 @@ describe('Tests the SDK functionality', () => { it('adds all platform default integrations', () => { init({}); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual( expect.arrayContaining([ @@ -695,8 +566,8 @@ describe('Tests the SDK functionality', () => { (notWeb as jest.Mock).mockImplementation(() => false); init({}); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual( expect.arrayContaining([ @@ -717,8 +588,8 @@ describe('Tests the SDK functionality', () => { }, }); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual( expect.not.arrayContaining([expect.objectContaining({ name: 'DeviceContext' })]), @@ -740,21 +611,28 @@ describe('Tests the SDK functionality', () => { (isExpoGo as jest.Mock).mockImplementation(() => true); init({}); - const actualOptions = mockedInitAndBind.mock.calls[0][secondArg] as ReactNativeClientOptions; - const actualIntegrations = actualOptions.integrations; + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'ExpoContext' })])); }); }); -function getMockClient(): MockedClient { - const mockClient = getCurrentHub().getClient() as unknown as MockedClient; - return mockClient; -} - -function getMockedIntegration({ name }: { name?: string } = {}): Integration { +function createMockedIntegration({ name }: { name?: string } = {}): Integration { return { name: name ?? 'MockedIntegration', setupOnce: jest.fn(), }; } + +function usedOptions(): ClientOptions | undefined { + return (initAndBind as jest.MockedFunction).mock.calls[0]?.[secondArg]; +} + +function usedIntegrations(): Integration[] { + return usedOptions()?.integrations ?? []; +} + +function autoPerformanceIsEnabled(): boolean { + return usedIntegrations().some(integration => integration.name === ReactNativeTracing.id); +} diff --git a/test/sdk.withclient.test.ts b/test/sdk.withclient.test.ts new file mode 100644 index 0000000000..654b5294e1 --- /dev/null +++ b/test/sdk.withclient.test.ts @@ -0,0 +1,49 @@ +jest.spyOn(logger, 'error'); + +import { setCurrentClient } from '@sentry/core'; +import { logger } from '@sentry/utils'; + +import { configureScope, flush } from '../src/js/sdk'; +import { getDefaultTestClientOptions, TestClient } from './mocks/client'; + +describe('Tests the SDK functionality', () => { + let client: TestClient; + + beforeEach(() => { + client = new TestClient(getDefaultTestClientOptions()); + setCurrentClient(client); + client.init(); + + jest.spyOn(client, 'flush'); + }); + + describe('flush', () => { + it('Calls flush on the client', async () => { + const flushResult = await flush(); + + expect(client.flush).toBeCalled(); + expect(flushResult).toBe(true); + }); + + it('Returns false if flush failed and logs error', async () => { + client.flush = jest.fn(() => Promise.reject()); + + const flushResult = await flush(); + + expect(client.flush).toBeCalled(); + expect(flushResult).toBe(false); + expect(logger.error).toBeCalledWith('Failed to flush the event queue.'); + }); + }); + + describe('configureScope', () => { + test('configureScope callback does not throw', () => { + const mockScopeCallback = jest.fn(() => { + throw 'Test error'; + }); + + expect(() => configureScope(mockScopeCallback)).not.toThrow(); + expect(mockScopeCallback).toBeCalledTimes(1); + }); + }); +}); From 658ea443c7a6431f194dec11bf96383cf971eae8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kry=C5=A1tof=20Wold=C5=99ich?= <31292499+krystofwoldrich@users.noreply.github.com> Date: Wed, 3 Apr 2024 12:12:44 +0200 Subject: [PATCH 03/48] test(errorhandlers): Remove dependencies on JS internal structures (#3720) --- .../integrations/reactnativeerrorhandlers.ts | 11 +- .../reactnativeerrorhandlers.test.ts | 114 +++++------------- test/mocks/client.ts | 2 + 3 files changed, 42 insertions(+), 85 deletions(-) diff --git a/src/js/integrations/reactnativeerrorhandlers.ts b/src/js/integrations/reactnativeerrorhandlers.ts index 934c201ad7..a5a4e7e487 100644 --- a/src/js/integrations/reactnativeerrorhandlers.ts +++ b/src/js/integrations/reactnativeerrorhandlers.ts @@ -1,5 +1,5 @@ import { getCurrentHub } from '@sentry/core'; -import type { EventHint, Integration, SeverityLevel } from '@sentry/types'; +import type { EventHint, Integration } from '@sentry/types'; import { addExceptionMechanism, logger } from '@sentry/utils'; import type { ReactNativeClient } from '../client'; @@ -230,12 +230,19 @@ export class ReactNativeErrorHandlers implements Integration { const event = await client.eventFromException(error, hint); if (isFatal) { - event.level = 'fatal' as SeverityLevel; + event.level = 'fatal'; addExceptionMechanism(event, { handled: false, type: 'onerror', }); + } else { + event.level = 'error'; + + addExceptionMechanism(event, { + handled: true, + type: 'generic', + }); } currentHub.captureEvent(event, hint); diff --git a/test/integrations/reactnativeerrorhandlers.test.ts b/test/integrations/reactnativeerrorhandlers.test.ts index 3a4285f3e0..59dcd35c55 100644 --- a/test/integrations/reactnativeerrorhandlers.test.ts +++ b/test/integrations/reactnativeerrorhandlers.test.ts @@ -1,78 +1,28 @@ -import { BrowserClient, defaultIntegrations, defaultStackParser } from '@sentry/browser'; - -const mockBrowserClient: BrowserClient = new BrowserClient({ - stackParser: defaultStackParser, - integrations: defaultIntegrations, - transport: jest.fn(), -}); - -let mockHubCaptureException: jest.Mock; - -jest.mock('@sentry/core', () => { - const core = jest.requireActual('@sentry/core'); - - const scope = { - getAttachments: jest.fn(), - }; - - const client = { - getOptions: () => ({}), - eventFromException: (_exception: any, _hint?: EventHint): PromiseLike => - mockBrowserClient.eventFromException(_exception, _hint), - }; - - const hub = { - getClient: () => client, - getScope: () => scope, - captureEvent: jest.fn(), - captureException: jest.fn(), - }; - - mockHubCaptureException = hub.captureException; - - return { - ...core, - addGlobalEventProcessor: jest.fn(), - getCurrentHub: () => hub, - }; -}); - -jest.mock('@sentry/utils', () => { - const utils = jest.requireActual('@sentry/utils'); - return { - ...utils, - logger: { - log: jest.fn(), - warn: jest.fn(), - error: jest.fn(), - }, - }; -}); - -import { getCurrentHub } from '@sentry/core'; -import type { Event, EventHint, ExtendedError, Integration, SeverityLevel } from '@sentry/types'; +import { setCurrentClient } from '@sentry/core'; +import type { ExtendedError, Integration, SeverityLevel } from '@sentry/types'; import { ReactNativeErrorHandlers } from '../../src/js/integrations/reactnativeerrorhandlers'; - -interface MockTrackingOptions { - allRejections: boolean; - onUnhandled: jest.Mock; - onHandled: jest.Mock; -} +import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; interface MockedReactNativeErrorHandlers extends Integration { _loadRejectionTracking: jest.Mock< { - disable: jest.Mock; - enable: jest.Mock; + disable: jest.Mock; + enable: jest.Mock; }, [] >; } describe('ReactNativeErrorHandlers', () => { + let client: TestClient; + beforeEach(() => { ErrorUtils.getGlobalHandler = () => jest.fn(); + + client = new TestClient(getDefaultTestClientOptions()); + setCurrentClient(client); + client.init(); }); afterEach(() => { @@ -98,28 +48,31 @@ describe('ReactNativeErrorHandlers', () => { test('Sets handled:false on a fatal error', async () => { await errorHandlerCallback(new Error('Test Error'), true); + await client.flush(); - const [event] = getActualCaptureEventArgs(); + const event = client.event; - expect(event.level).toBe('fatal' as SeverityLevel); - expect(event.exception?.values?.[0].mechanism?.handled).toBe(false); - expect(event.exception?.values?.[0].mechanism?.type).toBe('onerror'); + expect(event?.level).toBe('fatal' as SeverityLevel); + expect(event?.exception?.values?.[0].mechanism?.handled).toBe(false); + expect(event?.exception?.values?.[0].mechanism?.type).toBe('onerror'); }); test('Does not set handled:false on a non-fatal error', async () => { await errorHandlerCallback(new Error('Test Error'), false); + await client.flush(); - const [event] = getActualCaptureEventArgs(); + const event = client.event; - expect(event.level).toBe('error' as SeverityLevel); - expect(event.exception?.values?.[0].mechanism?.handled).toBe(true); - expect(event.exception?.values?.[0].mechanism?.type).toBe('generic'); + expect(event?.level).toBe('error' as SeverityLevel); + expect(event?.exception?.values?.[0].mechanism?.handled).toBe(true); + expect(event?.exception?.values?.[0].mechanism?.type).toBe('generic'); }); test('Includes original exception in hint', async () => { await errorHandlerCallback(new Error('Test Error'), false); + await client.flush(); - const [, hint] = getActualCaptureEventArgs(); + const hint = client.hint; expect(hint).toEqual(expect.objectContaining({ originalException: new Error('Test Error') })); }); @@ -127,10 +80,9 @@ describe('ReactNativeErrorHandlers', () => { describe('onUnhandledRejection', () => { test('unhandled rejected promise is captured with synthetical error', async () => { - mockHubCaptureException.mockClear(); const integration = new ReactNativeErrorHandlers(); const mockDisable = jest.fn(); - const mockEnable = jest.fn(); + const mockEnable = jest.fn(); (integration as unknown as MockedReactNativeErrorHandlers)._loadRejectionTracking = jest.fn(() => ({ disable: mockDisable, enable: mockEnable, @@ -139,7 +91,9 @@ describe('ReactNativeErrorHandlers', () => { const [actualTrackingOptions] = mockEnable.mock.calls[0] || []; actualTrackingOptions?.onUnhandled?.(1, 'Test Error'); - const actualSyntheticError = mockHubCaptureException.mock.calls[0][1].syntheticException; + + await client.flush(); + const actualSyntheticError = client.hint?.syntheticException; expect(mockDisable).not.toHaveBeenCalled(); expect(mockEnable).toHaveBeenCalledWith( @@ -154,10 +108,9 @@ describe('ReactNativeErrorHandlers', () => { }); test('error like unhandled rejected promise is captured without synthetical error', async () => { - mockHubCaptureException.mockClear(); const integration = new ReactNativeErrorHandlers(); const mockDisable = jest.fn(); - const mockEnable = jest.fn(); + const mockEnable = jest.fn(); (integration as unknown as MockedReactNativeErrorHandlers)._loadRejectionTracking = jest.fn(() => ({ disable: mockDisable, enable: mockEnable, @@ -166,7 +119,9 @@ describe('ReactNativeErrorHandlers', () => { const [actualTrackingOptions] = mockEnable.mock.calls[0] || []; actualTrackingOptions?.onUnhandled?.(1, new Error('Test Error')); - const actualSyntheticError = mockHubCaptureException.mock.calls[0][1].syntheticException; + + await client.flush(); + const actualSyntheticError = client.hint?.syntheticException; expect(mockDisable).not.toHaveBeenCalled(); expect(mockEnable).toHaveBeenCalledWith( @@ -181,10 +136,3 @@ describe('ReactNativeErrorHandlers', () => { }); }); }); - -function getActualCaptureEventArgs() { - const hub = getCurrentHub(); - const mockCall = (hub.captureEvent as jest.MockedFunction).mock.calls[0]; - - return mockCall; -} diff --git a/test/mocks/client.ts b/test/mocks/client.ts index 69771204e3..0a83cb404d 100644 --- a/test/mocks/client.ts +++ b/test/mocks/client.ts @@ -39,6 +39,7 @@ export class TestClient extends BaseClient { public static sendEventCalled?: (event: Event) => void; public event?: Event; + public hint?: EventHint; public session?: Session; public constructor(options: TestClientOptions) { @@ -73,6 +74,7 @@ export class TestClient extends BaseClient { public sendEvent(event: Event, hint?: EventHint): void { this.event = event; + this.hint = hint; // In real life, this will get deleted as part of envelope creation. delete event.sdkProcessingMetadata; From 666cd563b71cf3744fa6dae6fdaa56c79881f3d3 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Wed, 29 May 2024 09:55:49 +0200 Subject: [PATCH 04/48] feat(core): Bump sentry-javascript to version 8 (#3836) --- .vscode/launch.json | 2 +- package.json | 20 +- samples/expo/app/_layout.tsx | 7 +- samples/expo/metro.config.js | 1 - samples/react-native/src/App.tsx | 15 +- .../src/Screens/GesturesTracingScreen.tsx | 8 +- scripts/update-javascript.sh | 2 +- src/js/client.ts | 51 +- src/js/index.ts | 43 +- src/js/integrations/debugsymbolicator.ts | 23 +- src/js/integrations/devicecontext.ts | 16 +- src/js/integrations/eventorigin.ts | 16 +- src/js/integrations/expocontext.ts | 23 +- src/js/integrations/index.ts | 16 - src/js/integrations/modulesloader.ts | 16 +- src/js/integrations/nativelinkederrors.ts | 18 +- .../integrations/reactnativeerrorhandlers.ts | 19 +- src/js/integrations/reactnativeinfo.ts | 16 +- src/js/integrations/release.ts | 25 +- src/js/integrations/rewriteframes.ts | 2 +- src/js/integrations/screenshot.ts | 20 +- src/js/integrations/sdkinfo.ts | 23 +- src/js/integrations/spotlight.ts | 23 +- src/js/integrations/viewhierarchy.ts | 16 +- src/js/profiling/integration.ts | 86 ++-- src/js/profiling/utils.ts | 2 +- src/js/sdk.tsx | 66 +-- src/js/touchevents.tsx | 10 +- src/js/tracing/addTracingExtensions.ts | 97 ---- src/js/tracing/gesturetracing.ts | 29 +- src/js/tracing/index.ts | 3 +- src/js/tracing/nativeframes.ts | 222 ++++---- src/js/tracing/onSpanEndUtils.ts | 125 +++++ src/js/tracing/reactnativenavigation.ts | 107 ++-- src/js/tracing/reactnativeprofiler.tsx | 16 +- src/js/tracing/reactnativetracing.ts | 370 +++++++------ src/js/tracing/reactnavigation.ts | 135 ++--- src/js/tracing/reactnavigationv4.ts | 348 ------------- src/js/tracing/routingInstrumentation.ts | 16 +- src/js/tracing/semanticAttributes.ts | 18 + src/js/tracing/stalltracking.ts | 207 ++++---- src/js/tracing/timetodisplay.tsx | 35 +- src/js/tracing/transaction.ts | 46 -- src/js/tracing/types.ts | 12 +- src/js/tracing/utils.ts | 99 ++-- src/js/transports/TextEncoder.ts | 14 - src/js/transports/encodePolyfill.ts | 15 + src/js/transports/native.ts | 7 +- src/js/utils/span.ts | 16 + src/js/wrapper.ts | 3 +- test/client.test.ts | 39 +- test/e2e/src/EndToEndTests.tsx | 2 +- .../integrationsexecutionorder.test.ts | 6 +- test/integrations/spotlight.test.ts | 6 +- test/mocks/client.ts | 4 - test/profiling/integration.test.ts | 153 +++--- test/sdk.test.ts | 2 +- test/sdk.withclient.test.ts | 13 +- test/testutils.ts | 6 +- test/tracing/addTracingExtensions.test.ts | 1 - test/tracing/gesturetracing.test.ts | 16 +- test/tracing/nativeframes.test.ts | 34 +- test/tracing/reactnativenavigation.test.ts | 110 ++-- test/tracing/reactnativetracing.test.ts | 175 +++---- .../reactnavigation.stalltracking.test.ts | 24 +- test/tracing/reactnavigation.test.ts | 124 ++--- test/tracing/reactnavigation.ttid.test.tsx | 10 +- test/tracing/reactnavigationv4.test.ts | 485 ------------------ test/tracing/stalltracking.test.ts | 90 ++-- test/tracing/timetodisplay.test.tsx | 12 +- test/transports/native.test.ts | 4 +- yarn.lock | 245 ++++----- 72 files changed, 1267 insertions(+), 2819 deletions(-) delete mode 100644 src/js/integrations/index.ts delete mode 100644 src/js/tracing/addTracingExtensions.ts create mode 100644 src/js/tracing/onSpanEndUtils.ts delete mode 100644 src/js/tracing/reactnavigationv4.ts create mode 100644 src/js/tracing/semanticAttributes.ts delete mode 100644 src/js/tracing/transaction.ts delete mode 100644 src/js/transports/TextEncoder.ts create mode 100644 src/js/transports/encodePolyfill.ts create mode 100644 src/js/utils/span.ts delete mode 100644 test/tracing/reactnavigationv4.test.ts diff --git a/.vscode/launch.json b/.vscode/launch.json index 0a7cbf2c85..5555cc4e81 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -6,7 +6,7 @@ "type": "node", "request": "launch", "runtimeArgs": ["--inspect-brk", "${workspaceRoot}/node_modules/jest/bin/jest.js"], - "args": ["--runInBand", "-t", "gesture cancel previous interaction transaction"], + "args": ["--runInBand", "-t", ""], "cwd": "${workspaceRoot}", "console": "integratedTerminal", "internalConsoleOptions": "neverOpen", diff --git a/package.json b/package.json index a7e0110e86..0642c76680 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "test:watch": "jest --watch", "run-ios": "cd samples/react-native && yarn react-native run-ios", "run-android": "cd samples/react-native && yarn react-native run-android", - "yalc:add:sentry-javascript": "yalc add @sentry/browser @sentry/core @sentry/hub @sentry/integrations @sentry/react @sentry/types @sentry/utils", + "yalc:add:sentry-javascript": "yalc add @sentry/browser @sentry/core @sentry/react @sentry/types @sentry/utils", "set-version-samples": "bash scripts/set-version-samples.sh" }, "bin": { @@ -67,22 +67,20 @@ "react-native": ">=0.65.0" }, "dependencies": { - "@sentry/browser": "7.113.0", + "@sentry/browser": "8.4.0", "@sentry/cli": "2.31.2", - "@sentry/core": "7.113.0", - "@sentry/hub": "7.113.0", - "@sentry/integrations": "7.113.0", - "@sentry/react": "7.113.0", - "@sentry/types": "7.113.0", - "@sentry/utils": "7.113.0" + "@sentry/core": "8.4.0", + "@sentry/react": "8.4.0", + "@sentry/types": "8.4.0", + "@sentry/utils": "8.4.0" }, "devDependencies": { "@babel/core": "^7.23.5", "@expo/metro-config": "0.17.5", "@mswjs/interceptors": "^0.25.15", - "@sentry-internal/eslint-config-sdk": "7.113.0", - "@sentry-internal/eslint-plugin-sdk": "7.113.0", - "@sentry-internal/typescript": "7.113.0", + "@sentry-internal/eslint-config-sdk": "8.4.0", + "@sentry-internal/eslint-plugin-sdk": "8.4.0", + "@sentry-internal/typescript": "8.4.0", "@sentry/wizard": "3.16.3", "@types/jest": "^29.5.3", "@types/node": "^20.9.3", diff --git a/samples/expo/app/_layout.tsx b/samples/expo/app/_layout.tsx index 6fac65744f..cf626dc6b2 100644 --- a/samples/expo/app/_layout.tsx +++ b/samples/expo/app/_layout.tsx @@ -5,9 +5,9 @@ import { SplashScreen, Stack, useNavigationContainerRef } from 'expo-router'; import { useEffect } from 'react'; import { useColorScheme } from '@/components/useColorScheme'; -import { HttpClient } from '@sentry/integrations'; import { SENTRY_INTERNAL_DSN } from '../utils/dsn'; import * as Sentry from '@sentry/react-native'; +import { ErrorEvent } from '@sentry/types'; import { isExpoGo } from '../utils/isExpoGo'; export { @@ -27,7 +27,7 @@ process.env.EXPO_SKIP_DURING_EXPORT !== 'true' && Sentry.init({ dsn: SENTRY_INTERNAL_DSN, debug: true, environment: 'dev', - beforeSend: (event: Sentry.Event) => { + beforeSend: (event: ErrorEvent) => { console.log('Event beforeSend:', event.event_id); return event; }, @@ -41,7 +41,7 @@ process.env.EXPO_SKIP_DURING_EXPORT !== 'true' && Sentry.init({ }, integrations(integrations) { integrations.push( - new HttpClient({ + Sentry.httpClientIntegration({ // These options are effective only in JS. // This array can contain tuples of `[begin, end]` (both inclusive), // Single status codes, or a combinations of both. @@ -51,7 +51,6 @@ process.env.EXPO_SKIP_DURING_EXPORT !== 'true' && Sentry.init({ // default: [/.*/] failedRequestTargets: [/.*/], }), - Sentry.metrics.metricsAggregatorIntegration(), new Sentry.ReactNativeTracing({ routingInstrumentation, }), diff --git a/samples/expo/metro.config.js b/samples/expo/metro.config.js index b79a919dd8..bea6f90138 100644 --- a/samples/expo/metro.config.js +++ b/samples/expo/metro.config.js @@ -15,7 +15,6 @@ config.watchFolders.push(path.resolve(__dirname, '../../node_modules/@sentry')); config.watchFolders.push(path.resolve(__dirname, '../../node_modules/@sentry-internal')); config.watchFolders.push(path.resolve(__dirname, '../../node_modules/tslib')); config.watchFolders.push(path.resolve(__dirname, '../../node_modules/hoist-non-react-statics')); -config.watchFolders.push(path.resolve(__dirname, '../../node_modules/localforage')); config.watchFolders.push(path.resolve(__dirname, '../../node_modules/@react-native/js-polyfills')); config.watchFolders.push(`${__dirname}/../../dist`); diff --git a/samples/react-native/src/App.tsx b/samples/react-native/src/App.tsx index ad7edc5a20..5d010ecff7 100644 --- a/samples/react-native/src/App.tsx +++ b/samples/react-native/src/App.tsx @@ -23,8 +23,8 @@ import { store } from './reduxApp'; import { GestureHandlerRootView } from 'react-native-gesture-handler'; import GesturesTracingScreen from './Screens/GesturesTracingScreen'; import { Platform, StyleSheet } from 'react-native'; -import { HttpClient } from '@sentry/integrations'; import Ionicons from 'react-native-vector-icons/Ionicons'; +import { ErrorEvent } from '@sentry/types'; const isMobileOs = Platform.OS === 'android' || Platform.OS === 'ios'; @@ -39,7 +39,7 @@ Sentry.init({ dsn: SENTRY_INTERNAL_DSN, debug: true, environment: 'dev', - beforeSend: (event: Sentry.Event) => { + beforeSend: (event: ErrorEvent) => { console.log('Event beforeSend:', event.event_id); return event; }, @@ -59,16 +59,8 @@ Sentry.init({ routingInstrumentation: reactNavigationInstrumentation, enableUserInteractionTracing: true, ignoreEmptyBackNavigationTransactions: true, - beforeNavigate: (context: Sentry.ReactNavigationTransactionContext) => { - // Example of not sending a transaction for the screen with the name "Manual Tracker" - if (context.data.route.name === 'ManualTracker') { - context.sampled = false; - } - - return context; - }, }), - new HttpClient({ + Sentry.httpClientIntegration({ // These options are effective only in JS. // This array can contain tuples of `[begin, end]` (both inclusive), // Single status codes, or a combinations of both. @@ -78,7 +70,6 @@ Sentry.init({ // default: [/.*/] failedRequestTargets: [/.*/], }), - Sentry.metrics.metricsAggregatorIntegration(), ); return integrations.filter(i => i.name !== 'Dedupe'); }, diff --git a/samples/react-native/src/Screens/GesturesTracingScreen.tsx b/samples/react-native/src/Screens/GesturesTracingScreen.tsx index 650a029d7a..16e217dfdb 100644 --- a/samples/react-native/src/Screens/GesturesTracingScreen.tsx +++ b/samples/react-native/src/Screens/GesturesTracingScreen.tsx @@ -1,7 +1,8 @@ import React from 'react'; import { StyleSheet, Text, View } from 'react-native'; import { Gesture, GestureDetector } from 'react-native-gesture-handler'; -import { getCurrentHub, Scope, sentryTraceGesture } from '@sentry/react-native'; +import { sentryTraceGesture, startSpanManual } from '@sentry/react-native'; +import { Span } from '@sentry/types'; const GesturesTracingScreen = () => { const gesture = Gesture.Pinch().onBegin(() => { @@ -18,10 +19,9 @@ const GesturesTracingScreen = () => { }; const startExampleSpan = () => { - getCurrentHub().withScope((scope: Scope) => { - const child = scope.getTransaction()?.startChild({ op: 'example' }); + startSpanManual({ name: 'Example', op: 'example' }, (span: Span) => { setTimeout(() => { - child?.finish(); + span.end(); }, 1000); }); }; diff --git a/scripts/update-javascript.sh b/scripts/update-javascript.sh index ca464d280f..a9cd10b23a 100755 --- a/scripts/update-javascript.sh +++ b/scripts/update-javascript.sh @@ -3,7 +3,7 @@ set -euo pipefail tagPrefix='' repo="https://github.com/getsentry/sentry-javascript.git" -packages=('@sentry/browser' '@sentry/core' '@sentry/hub' '@sentry/integrations' '@sentry/react' '@sentry/types' '@sentry/utils' '@sentry-internal/typescript') +packages=('@sentry/browser' '@sentry/core' '@sentry/react' '@sentry/types' '@sentry/utils' '@sentry-internal/typescript') packages+=('@sentry-internal/eslint-config-sdk' '@sentry-internal/eslint-plugin-sdk') . $(dirname "$0")/update-package-json.sh diff --git a/src/js/client.ts b/src/js/client.ts index 280fd46868..27fbc074e1 100644 --- a/src/js/client.ts +++ b/src/js/client.ts @@ -8,6 +8,7 @@ import type { EventHint, Outcome, SeverityLevel, + TransportMakeRequestResponse, UserFeedback, } from '@sentry/types'; import { dateTimestampInSeconds, logger, SentryError } from '@sentry/utils'; @@ -16,7 +17,7 @@ import { Alert } from 'react-native'; import { createIntegration } from './integrations/factory'; import { defaultSdkInfo } from './integrations/sdkinfo'; import type { ReactNativeClientOptions } from './options'; -import { ReactNativeTracing } from './tracing'; +import type { ReactNativeTracing } from './tracing'; import { createUserFeedbackEnvelope, items } from './utils/envelope'; import { ignoreRequireCycleLogs } from './utils/ignorerequirecyclelogs'; import { mergeOutcomes } from './utils/outcome'; @@ -42,7 +43,6 @@ export class ReactNativeClient extends BaseClient { super(options); this._outcomesBuffer = []; - this._initNativeSdk(); } /** @@ -86,29 +86,14 @@ export class ReactNativeClient extends BaseClient { dsn: this.getDsn(), tunnel: undefined, }); - this._sendEnvelope(envelope); - } - - /** - * Sets up the integrations - */ - public setupIntegrations(): void { - super.setupIntegrations(); - const tracing = this.getIntegration(ReactNativeTracing); - const routingName = tracing?.options.routingInstrumentation?.name; - if (routingName) { - this.addIntegration(createIntegration(routingName)); - } - const enableUserInteractionTracing = tracing?.options.enableUserInteractionTracing; - if (enableUserInteractionTracing) { - this.addIntegration(createIntegration('ReactNativeUserInteractionTracing')); - } + // eslint-disable-next-line @typescript-eslint/no-floating-promises + this.sendEnvelope(envelope); } /** * @inheritdoc */ - protected _sendEnvelope(envelope: Envelope): void { + public sendEnvelope(envelope: Envelope): PromiseLike { const outcomes = this._clearOutcomes(); this._outcomesBuffer = mergeOutcomes(this._outcomesBuffer, outcomes); @@ -137,6 +122,32 @@ export class ReactNativeClient extends BaseClient { if (shouldClearOutcomesBuffer) { this._outcomesBuffer = []; // if send fails synchronously the _outcomesBuffer will stay intact } + + return Promise.resolve({}); + } + + /** + * @inheritDoc + */ + public init(): void { + this._initNativeSdk(); + super.init(); + } + + /** + * @inheritdoc + */ + protected _setupIntegrations(): void { + super._setupIntegrations(); + const tracing = this.getIntegrationByName('ReactNativeTracing'); + const routingName = tracing?.options?.routingInstrumentation?.name; + if (routingName) { + this.addIntegration(createIntegration(routingName)); + } + const enableUserInteractionTracing = tracing?.options.enableUserInteractionTracing; + if (enableUserInteractionTracing) { + this.addIntegration(createIntegration('ReactNativeUserInteractionTracing')); + } } /** diff --git a/src/js/index.ts b/src/js/index.ts index 2864d71e3a..79ca02795d 100644 --- a/src/js/index.ts +++ b/src/js/index.ts @@ -12,14 +12,10 @@ export type { } from '@sentry/types'; export { - addGlobalEventProcessor, addBreadcrumb, captureException, captureEvent, captureMessage, - getHubFromCarrier, - getCurrentHub, - Hub, Scope, setContext, setExtra, @@ -27,9 +23,6 @@ export { setTag, setTags, setUser, - startTransaction, - - // v8 spans startInactiveSpan, startSpan, startSpanManual, @@ -37,22 +30,16 @@ export { spanToJSON, spanIsSampled, setMeasurement, - - // v8 scopes getCurrentScope, getGlobalScope, getIsolationScope, getClient, setCurrentClient, addEventProcessor, - metrics, + metricsDefault as metrics, } from '@sentry/core'; -import { _addTracingExtensions } from './tracing/addTracingExtensions'; -_addTracingExtensions(); - export { - Integrations as BrowserIntegrations, ErrorBoundary, withErrorBoundary, createReduxEnhancer, @@ -61,36 +48,17 @@ export { withProfiler, } from '@sentry/react'; -export { lastEventId } from '@sentry/browser'; - -import * as Integrations from './integrations'; - export * from './integrations/exports'; export { SDK_NAME, SDK_VERSION } from './version'; export type { ReactNativeOptions } from './options'; export { ReactNativeClient } from './client'; -export { - init, - wrap, - // eslint-disable-next-line deprecation/deprecation - setDist, - // eslint-disable-next-line deprecation/deprecation - setRelease, - nativeCrash, - flush, - close, - captureUserFeedback, - withScope, - configureScope, -} from './sdk'; +export { init, wrap, nativeCrash, flush, close, captureUserFeedback, withScope } from './sdk'; export { TouchEventBoundary, withTouchEventBoundary } from './touchevents'; export { ReactNativeTracing, - ReactNavigationV4Instrumentation, - // eslint-disable-next-line deprecation/deprecation ReactNavigationV5Instrumentation, ReactNavigationInstrumentation, ReactNativeNavigationInstrumentation, @@ -102,9 +70,4 @@ export { startTimeToFullDisplaySpan, } from './tracing'; -export type { ReactNavigationTransactionContext, TimeToDisplayProps } from './tracing'; - -export { - /** @deprecated Import the integration function directly, e.g. `screenshotIntegration()` instead of `new Integrations.Screenshot(). */ - Integrations, -}; +export type { TimeToDisplayProps } from './tracing'; diff --git a/src/js/integrations/debugsymbolicator.ts b/src/js/integrations/debugsymbolicator.ts index de7a18c294..aa2ccc1101 100644 --- a/src/js/integrations/debugsymbolicator.ts +++ b/src/js/integrations/debugsymbolicator.ts @@ -1,12 +1,4 @@ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { - Event, - EventHint, - Integration, - IntegrationClass, - IntegrationFnResult, - StackFrame as SentryStackFrame, -} from '@sentry/types'; +import type { Event, EventHint, Integration, StackFrame as SentryStackFrame } from '@sentry/types'; import { addContextToFrame, logger } from '@sentry/utils'; import { getFramesToPop, isErrorLike } from '../utils/error'; @@ -29,7 +21,7 @@ export type ReactNativeError = Error & { }; /** Tries to symbolicate the JS stack trace on the device. */ -export const debugSymbolicatorIntegration = (): IntegrationFnResult => { +export const debugSymbolicatorIntegration = (): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => { @@ -39,17 +31,6 @@ export const debugSymbolicatorIntegration = (): IntegrationFnResult => { }; }; -/** - * Tries to symbolicate the JS stack trace on the device. - * - * @deprecated Use `debugSymbolicatorIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const DebugSymbolicator = convertIntegrationFnToClass( - INTEGRATION_NAME, - debugSymbolicatorIntegration, -) as IntegrationClass; - async function processEvent(event: Event, hint: EventHint): Promise { if (event.exception && isErrorLike(hint.originalException)) { // originalException is ErrorLike object diff --git a/src/js/integrations/devicecontext.ts b/src/js/integrations/devicecontext.ts index 4c7a5a8f5b..942ca5210d 100644 --- a/src/js/integrations/devicecontext.ts +++ b/src/js/integrations/devicecontext.ts @@ -1,6 +1,5 @@ /* eslint-disable complexity */ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { Event, Integration, IntegrationClass, IntegrationFnResult } from '@sentry/types'; +import type { Event, Integration } from '@sentry/types'; import { logger, severityLevelFromString } from '@sentry/utils'; import { AppState } from 'react-native'; @@ -11,7 +10,7 @@ import { NATIVE } from '../wrapper'; const INTEGRATION_NAME = 'DeviceContext'; /** Load device context from native. */ -export const deviceContextIntegration = (): IntegrationFnResult => { +export const deviceContextIntegration = (): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => { @@ -21,17 +20,6 @@ export const deviceContextIntegration = (): IntegrationFnResult => { }; }; -/** - * Load device context from native. - * - * @deprecated Use `deviceContextIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const DeviceContext = convertIntegrationFnToClass( - INTEGRATION_NAME, - deviceContextIntegration, -) as IntegrationClass; - async function processEvent(event: Event): Promise { let native: NativeDeviceContextsResponse | null = null; try { diff --git a/src/js/integrations/eventorigin.ts b/src/js/integrations/eventorigin.ts index ec9d666d49..b5163c55fe 100644 --- a/src/js/integrations/eventorigin.ts +++ b/src/js/integrations/eventorigin.ts @@ -1,10 +1,9 @@ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { Event, Integration, IntegrationClass, IntegrationFnResult } from '@sentry/types'; +import type { Event, Integration } from '@sentry/types'; const INTEGRATION_NAME = 'EventOrigin'; /** Default EventOrigin instrumentation */ -export const eventOriginIntegration = (): IntegrationFnResult => { +export const eventOriginIntegration = (): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => { @@ -20,14 +19,3 @@ export const eventOriginIntegration = (): IntegrationFnResult => { }, }; }; - -/** - * Default EventOrigin instrumentation - * - * @deprecated Use `eventOriginIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const EventOrigin = convertIntegrationFnToClass( - INTEGRATION_NAME, - eventOriginIntegration, -) as IntegrationClass; diff --git a/src/js/integrations/expocontext.ts b/src/js/integrations/expocontext.ts index adf0c1e89e..8a1dc68382 100644 --- a/src/js/integrations/expocontext.ts +++ b/src/js/integrations/expocontext.ts @@ -1,19 +1,11 @@ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { - DeviceContext, - Event, - Integration, - IntegrationClass, - IntegrationFnResult, - OsContext, -} from '@sentry/types'; +import type { DeviceContext, Event, Integration, OsContext } from '@sentry/types'; import { getExpoDevice } from '../utils/expomodules'; const INTEGRATION_NAME = 'ExpoContext'; /** Load device context from expo modules. */ -export const expoContextIntegration = (): IntegrationFnResult => { +export const expoContextIntegration = (): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => { @@ -23,17 +15,6 @@ export const expoContextIntegration = (): IntegrationFnResult => { }; }; -/** - * Load device context from expo modules. - * - * @deprecated Use `expoContextIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const ExpoContext = convertIntegrationFnToClass( - INTEGRATION_NAME, - expoContextIntegration, -) as IntegrationClass; - function processEvent(event: Event): Event { const expoDeviceContext = getExpoDeviceContext(); if (expoDeviceContext) { diff --git a/src/js/integrations/index.ts b/src/js/integrations/index.ts deleted file mode 100644 index 5b9a32f3da..0000000000 --- a/src/js/integrations/index.ts +++ /dev/null @@ -1,16 +0,0 @@ -// THESE EXPORTS WILL BE REMOVED IN THE NEXT MAJOR RELEASE - -export { DebugSymbolicator } from './debugsymbolicator'; -export { DeviceContext } from './devicecontext'; -export { ReactNativeErrorHandlers } from './reactnativeerrorhandlers'; -export { NativeLinkedErrors } from './nativelinkederrors'; -export { Release } from './release'; -export { EventOrigin } from './eventorigin'; -export { SdkInfo } from './sdkinfo'; -export { ReactNativeInfo } from './reactnativeinfo'; -export { ModulesLoader } from './modulesloader'; -export { HermesProfiling } from '../profiling/integration'; -export { Screenshot } from './screenshot'; -export { ViewHierarchy } from './viewhierarchy'; -export { ExpoContext } from './expocontext'; -export { Spotlight } from './spotlight'; diff --git a/src/js/integrations/modulesloader.ts b/src/js/integrations/modulesloader.ts index b49fe164f8..f354b603c9 100644 --- a/src/js/integrations/modulesloader.ts +++ b/src/js/integrations/modulesloader.ts @@ -1,5 +1,4 @@ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { Event, Integration, IntegrationClass, IntegrationFnResult } from '@sentry/types'; +import type { Event, Integration } from '@sentry/types'; import { logger } from '@sentry/utils'; import { NATIVE } from '../wrapper'; @@ -7,7 +6,7 @@ import { NATIVE } from '../wrapper'; const INTEGRATION_NAME = 'ModulesLoader'; /** Loads runtime JS modules from prepared file. */ -export const modulesLoaderIntegration = (): IntegrationFnResult => { +export const modulesLoaderIntegration = (): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => { @@ -17,17 +16,6 @@ export const modulesLoaderIntegration = (): IntegrationFnResult => { }; }; -/** - * Loads runtime JS modules from prepared file. - * - * @deprecated Use `modulesLoaderIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const ModulesLoader = convertIntegrationFnToClass( - INTEGRATION_NAME, - modulesLoaderIntegration, -) as IntegrationClass; - function createProcessEvent(): (event: Event) => Promise { let isSetup = false; let modules: Record | null = null; diff --git a/src/js/integrations/nativelinkederrors.ts b/src/js/integrations/nativelinkederrors.ts index f35d339f63..fc20a67f95 100644 --- a/src/js/integrations/nativelinkederrors.ts +++ b/src/js/integrations/nativelinkederrors.ts @@ -1,5 +1,4 @@ import { exceptionFromError } from '@sentry/browser'; -import { convertIntegrationFnToClass } from '@sentry/core'; import type { Client, DebugImage, @@ -8,8 +7,6 @@ import type { Exception, ExtendedError, Integration, - IntegrationClass, - IntegrationFnResult, StackFrame, StackParser, } from '@sentry/types'; @@ -31,7 +28,7 @@ interface LinkedErrorsOptions { /** * Processes JS and RN native linked errors. */ -export const nativeLinkedErrorsIntegration = (options: Partial = {}): IntegrationFnResult => { +export const nativeLinkedErrorsIntegration = (options: Partial = {}): Integration => { const key = options.key || DEFAULT_KEY; const limit = options.limit || DEFAULT_LIMIT; @@ -45,19 +42,6 @@ export const nativeLinkedErrorsIntegration = (options: Partial & { - new (options?: Partial): Integration; -}; - function preprocessEvent(event: Event, hint: EventHint | undefined, client: Client, limit: number, key: string): void { if (!event.exception || !event.exception.values || !hint || !isInstanceOf(hint.originalException, Error)) { return; diff --git a/src/js/integrations/reactnativeerrorhandlers.ts b/src/js/integrations/reactnativeerrorhandlers.ts index 274c80232d..2f75d45953 100644 --- a/src/js/integrations/reactnativeerrorhandlers.ts +++ b/src/js/integrations/reactnativeerrorhandlers.ts @@ -1,5 +1,5 @@ -import { captureException, convertIntegrationFnToClass, getClient, getCurrentScope } from '@sentry/core'; -import type { EventHint, Integration, IntegrationClass, IntegrationFnResult, SeverityLevel } from '@sentry/types'; +import { captureException, getClient, getCurrentScope } from '@sentry/core'; +import type { EventHint, Integration, SeverityLevel } from '@sentry/types'; import { addExceptionMechanism, logger } from '@sentry/utils'; import { createSyntheticError, isErrorLike } from '../utils/error'; @@ -23,7 +23,7 @@ interface PromiseRejectionTrackingOptions { /** ReactNativeErrorHandlers Integration */ export const reactNativeErrorHandlersIntegration = ( options: Partial = {}, -): IntegrationFnResult => { +): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => @@ -36,19 +36,6 @@ export const reactNativeErrorHandlersIntegration = ( }; }; -/** - * ReactNativeErrorHandlers Integration - * - * @deprecated Use `reactNativeErrorHandlersIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const ReactNativeErrorHandlers = convertIntegrationFnToClass( - INTEGRATION_NAME, - reactNativeErrorHandlersIntegration, -) as IntegrationClass & { - new (options?: Partial): Integration; -}; - function setup(options: ReactNativeErrorHandlersOptions): void { options.onunhandledrejection && setupUnhandledRejectionsTracking(options.patchGlobalPromise); options.onerror && setupErrorUtilsGlobalHandler(); diff --git a/src/js/integrations/reactnativeinfo.ts b/src/js/integrations/reactnativeinfo.ts index a139004b7b..a84285fa9a 100644 --- a/src/js/integrations/reactnativeinfo.ts +++ b/src/js/integrations/reactnativeinfo.ts @@ -1,5 +1,4 @@ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { Context, Event, EventHint, Integration, IntegrationClass, IntegrationFnResult } from '@sentry/types'; +import type { Context, Event, EventHint, Integration } from '@sentry/types'; import { getExpoGoVersion, @@ -29,7 +28,7 @@ export interface ReactNativeContext extends Context { } /** Loads React Native context at runtime */ -export const reactNativeInfoIntegration = (): IntegrationFnResult => { +export const reactNativeInfoIntegration = (): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => { @@ -39,17 +38,6 @@ export const reactNativeInfoIntegration = (): IntegrationFnResult => { }; }; -/** - * Loads React Native context at runtime - * - * @deprecated Use `reactNativeInfoIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const ReactNativeInfo = convertIntegrationFnToClass( - INTEGRATION_NAME, - reactNativeInfoIntegration, -) as IntegrationClass; - function processEvent(event: Event, hint: EventHint): Event { const reactNativeError = hint?.originalException ? (hint?.originalException as ReactNativeError) : undefined; diff --git a/src/js/integrations/release.ts b/src/js/integrations/release.ts index 56c8c6c7b6..66632acbbc 100644 --- a/src/js/integrations/release.ts +++ b/src/js/integrations/release.ts @@ -1,21 +1,11 @@ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { - BaseTransportOptions, - Client, - ClientOptions, - Event, - EventHint, - Integration, - IntegrationClass, - IntegrationFnResult, -} from '@sentry/types'; +import type { BaseTransportOptions, Client, ClientOptions, Event, EventHint, Integration } from '@sentry/types'; import { NATIVE } from '../wrapper'; const INTEGRATION_NAME = 'Release'; /** Release integration responsible to load release from file. */ -export const nativeReleaseIntegration = (): IntegrationFnResult => { +export const nativeReleaseIntegration = (): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => { @@ -25,17 +15,6 @@ export const nativeReleaseIntegration = (): IntegrationFnResult => { }; }; -/** - * Release integration responsible to load release from file. - * - * @deprecated Use `nativeReleaseIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const Release = convertIntegrationFnToClass( - INTEGRATION_NAME, - nativeReleaseIntegration, -) as IntegrationClass; - async function processEvent( event: Event, _: EventHint, diff --git a/src/js/integrations/rewriteframes.ts b/src/js/integrations/rewriteframes.ts index 04170d088a..4b4bbba9be 100644 --- a/src/js/integrations/rewriteframes.ts +++ b/src/js/integrations/rewriteframes.ts @@ -1,4 +1,4 @@ -import { rewriteFramesIntegration } from '@sentry/integrations'; +import { rewriteFramesIntegration } from '@sentry/core'; import type { Integration, StackFrame } from '@sentry/types'; import { Platform } from 'react-native'; diff --git a/src/js/integrations/screenshot.ts b/src/js/integrations/screenshot.ts index 6c59a195ac..3c24948b76 100644 --- a/src/js/integrations/screenshot.ts +++ b/src/js/integrations/screenshot.ts @@ -1,5 +1,4 @@ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { Event, EventHint, Integration, IntegrationClass, IntegrationFnResult } from '@sentry/types'; +import type { Event, EventHint, Integration } from '@sentry/types'; import type { ReactNativeClient } from '../client'; import type { Screenshot as ScreenshotAttachment } from '../wrapper'; @@ -8,7 +7,7 @@ import { NATIVE } from '../wrapper'; const INTEGRATION_NAME = 'Screenshot'; /** Adds screenshots to error events */ -export const screenshotIntegration = (): IntegrationFnResult => { +export const screenshotIntegration = (): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => { @@ -18,22 +17,9 @@ export const screenshotIntegration = (): IntegrationFnResult => { }; }; -/** - * Adds screenshots to error events - * - * @deprecated Use `screenshotIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const Screenshot = convertIntegrationFnToClass( - INTEGRATION_NAME, - screenshotIntegration, -) as IntegrationClass; - async function processEvent(event: Event, hint: EventHint, client: ReactNativeClient): Promise { - const options = client.getOptions(); - const hasException = event.exception && event.exception.values && event.exception.values.length > 0; - if (!hasException || options?.beforeScreenshot?.(event, hint) === false) { + if (!hasException || client.getOptions().beforeScreenshot?.(event, hint) === false) { return event; } diff --git a/src/js/integrations/sdkinfo.ts b/src/js/integrations/sdkinfo.ts index 62ad0a3b0e..86be3f1099 100644 --- a/src/js/integrations/sdkinfo.ts +++ b/src/js/integrations/sdkinfo.ts @@ -1,12 +1,4 @@ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { - Event, - Integration, - IntegrationClass, - IntegrationFnResult, - Package, - SdkInfo as SdkInfoType, -} from '@sentry/types'; +import type { Event, Integration, Package, SdkInfo as SdkInfoType } from '@sentry/types'; import { logger } from '@sentry/utils'; import { isExpoGo, notWeb } from '../utils/environment'; @@ -29,7 +21,7 @@ export const defaultSdkInfo: DefaultSdkInfo = { }; /** Default SdkInfo instrumentation */ -export const sdkInfoIntegration = (): IntegrationFnResult => { +export const sdkInfoIntegration = (): Integration => { const fetchNativeSdkInfo = createCachedFetchNativeSdkInfo(); return { @@ -41,17 +33,6 @@ export const sdkInfoIntegration = (): IntegrationFnResult => { }; }; -/** - * Default SdkInfo instrumentation - * - * @deprecated Use `sdkInfoIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const SdkInfo = convertIntegrationFnToClass( - INTEGRATION_NAME, - sdkInfoIntegration, -) as IntegrationClass; - async function processEvent(event: Event, fetchNativeSdkInfo: () => Promise): Promise { const nativeSdkPackage = await fetchNativeSdkInfo(); diff --git a/src/js/integrations/spotlight.ts b/src/js/integrations/spotlight.ts index 8a07806e6f..2116dd0cf8 100644 --- a/src/js/integrations/spotlight.ts +++ b/src/js/integrations/spotlight.ts @@ -1,14 +1,6 @@ -import type { - BaseTransportOptions, - Client, - ClientOptions, - Envelope, - Integration, - IntegrationFnResult, -} from '@sentry/types'; +import type { BaseTransportOptions, Client, ClientOptions, Envelope, Integration } from '@sentry/types'; import { logger, serializeEnvelope } from '@sentry/utils'; -import { makeUtf8TextEncoder } from '../transports/TextEncoder'; import { ReactNativeLibraries } from '../utils/rnlibraries'; import { createStealthXhr, XHR_READYSTATE_DONE } from '../utils/xhr'; @@ -29,7 +21,7 @@ type SpotlightReactNativeIntegrationOptions = { */ export function spotlightIntegration({ sidecarUrl = getDefaultSidecarUrl(), -}: SpotlightReactNativeIntegrationOptions = {}): IntegrationFnResult { +}: SpotlightReactNativeIntegrationOptions = {}): Integration { logger.info('[Spotlight] Using Sidecar URL', sidecarUrl); return { @@ -45,15 +37,6 @@ export function spotlightIntegration({ }; } -/** - * Use this integration to send errors and transactions to Spotlight. - * - * Learn more about spotlight at https://spotlightjs.com - * - * @deprecated Use `spotlightIntegration()` instead. - */ -export const Spotlight = spotlightIntegration as (...args: Parameters) => Integration; - function setup(client: Client, sidecarUrl: string): void { sendEnvelopesToSidecar(client, sidecarUrl); } @@ -96,7 +79,7 @@ function sendEnvelopesToSidecar(client: Client, sidecarUrl: string): void { } }; - xhr.send(serializeEnvelope(spotlightEnvelope, makeUtf8TextEncoder())); + xhr.send(serializeEnvelope(spotlightEnvelope)); }); } diff --git a/src/js/integrations/viewhierarchy.ts b/src/js/integrations/viewhierarchy.ts index 9804ea8fff..374d8d659a 100644 --- a/src/js/integrations/viewhierarchy.ts +++ b/src/js/integrations/viewhierarchy.ts @@ -1,5 +1,4 @@ -import { convertIntegrationFnToClass } from '@sentry/core'; -import type { Attachment, Event, EventHint, Integration, IntegrationClass, IntegrationFnResult } from '@sentry/types'; +import type { Attachment, Event, EventHint, Integration } from '@sentry/types'; import { logger } from '@sentry/utils'; import { NATIVE } from '../wrapper'; @@ -11,7 +10,7 @@ const attachmentType = 'event.view_hierarchy' as Attachment['attachmentType']; const INTEGRATION_NAME = 'ViewHierarchy'; /** Adds ViewHierarchy to error events */ -export const viewHierarchyIntegration = (): IntegrationFnResult => { +export const viewHierarchyIntegration = (): Integration => { return { name: INTEGRATION_NAME, setupOnce: () => { @@ -21,17 +20,6 @@ export const viewHierarchyIntegration = (): IntegrationFnResult => { }; }; -/** - * Adds ViewHierarchy to error events - * - * @deprecated Use `viewHierarchyIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const ViewHierarchy = convertIntegrationFnToClass( - INTEGRATION_NAME, - viewHierarchyIntegration, -) as IntegrationClass; - async function processEvent(event: Event, hint: EventHint): Promise { const hasException = event.exception && event.exception.values && event.exception.values.length > 0; if (!hasException) { diff --git a/src/js/profiling/integration.ts b/src/js/profiling/integration.ts index 8fb6b7bcef..584b000410 100644 --- a/src/js/profiling/integration.ts +++ b/src/js/profiling/integration.ts @@ -1,18 +1,11 @@ /* eslint-disable complexity */ -import { convertIntegrationFnToClass, getActiveTransaction, getClient, getCurrentHub } from '@sentry/core'; -import type { - Envelope, - Event, - Integration, - IntegrationClass, - IntegrationFn, - ThreadCpuProfile, - Transaction, -} from '@sentry/types'; +import { getActiveSpan, getClient, spanIsSampled } from '@sentry/core'; +import type { Envelope, Event, IntegrationFn, Span, ThreadCpuProfile } from '@sentry/types'; import { logger, uuid4 } from '@sentry/utils'; import { Platform } from 'react-native'; import { isHermesEnabled } from '../utils/environment'; +import { isRootSpan } from '../utils/span'; import { NATIVE } from '../wrapper'; import { PROFILE_QUEUE } from './cache'; import { MAX_PROFILE_DURATION_MS } from './constants'; @@ -38,13 +31,20 @@ const MS_TO_NS: number = 1e6; export const hermesProfilingIntegration: IntegrationFn = () => { let _currentProfile: | { + span_id: string; profile_id: string; startTimestampNs: number; } | undefined; let _currentProfileTimeout: number | undefined; + let isReady: boolean = false; const setupOnce = (): void => { + if (isReady) { + return; + } + isReady = true; + if (!isHermesEnabled()) { logger.log('[Profiling] Hermes is not enabled, not adding profiling integration.'); return; @@ -57,9 +57,9 @@ export const hermesProfilingIntegration: IntegrationFn = () => { } _startCurrentProfileForActiveTransaction(); - client.on('startTransaction', _startCurrentProfile); + client.on('spanStart', _startCurrentProfile); - client.on('finishTransaction', _finishCurrentProfile); + client.on('spanEnd', _finishCurrentProfileForSpan); client.on('beforeEnvelope', (envelope: Envelope) => { if (!PROFILE_QUEUE.size()) { @@ -87,24 +87,28 @@ export const hermesProfilingIntegration: IntegrationFn = () => { if (_currentProfile) { return; } - const transaction = getActiveTransaction(getCurrentHub()); - transaction && _startCurrentProfile(transaction); + const activeSpan = getActiveSpan(); + activeSpan && _startCurrentProfile(activeSpan); }; - const _startCurrentProfile = (transaction: Transaction): void => { + const _startCurrentProfile = (activeSpan: Span): void => { + if (!isRootSpan(activeSpan)) { + return; + } + _finishCurrentProfile(); - const shouldStartProfiling = _shouldStartProfiling(transaction); + const shouldStartProfiling = _shouldStartProfiling(activeSpan); if (!shouldStartProfiling) { return; } _currentProfileTimeout = setTimeout(_finishCurrentProfile, MAX_PROFILE_DURATION_MS); - _startNewProfile(transaction); + _startNewProfile(activeSpan); }; - const _shouldStartProfiling = (transaction: Transaction): boolean => { - if (!transaction.sampled) { + const _shouldStartProfiling = (activeSpan: Span): boolean => { + if (!spanIsSampled(activeSpan)) { logger.log('[Profiling] Transaction is not sampled, skipping profiling'); return false; } @@ -133,22 +137,41 @@ export const hermesProfilingIntegration: IntegrationFn = () => { /** * Starts a new profile and links it to the transaction. */ - const _startNewProfile = (transaction: Transaction): void => { + const _startNewProfile = (activeSpan: Span): void => { const profileStartTimestampNs = startProfiling(); if (!profileStartTimestampNs) { return; } _currentProfile = { + span_id: activeSpan.spanContext().spanId, profile_id: uuid4(), startTimestampNs: profileStartTimestampNs, }; - transaction.setContext('profile', { profile_id: _currentProfile.profile_id }); - // @ts-expect-error profile_id is not part of the metadata type - transaction.setMetadata({ profile_id: _currentProfile.profile_id }); + activeSpan.setAttribute('profile_id', _currentProfile.profile_id); logger.log('[Profiling] started profiling: ', _currentProfile.profile_id); }; + /** + * Stops current profile if the ending span is the currently profiled span. + */ + const _finishCurrentProfileForSpan = (span: Span): void => { + if (!isRootSpan(span)) { + return; + } + + if (span.spanContext().spanId !== _currentProfile?.span_id) { + logger.log( + `[Profiling] Span (${span.spanContext().spanId}) ended is not the currently profiled span (${ + _currentProfile?.span_id + }). Not stopping profiling.`, + ); + return; + } + + _finishCurrentProfile(); + }; + /** * Stops profiling and adds the profile to the queue to be processed on beforeEnvelope. */ @@ -172,7 +195,7 @@ export const hermesProfilingIntegration: IntegrationFn = () => { }; const _createProfileEventFor = (profiledTransaction: Event): ProfileEvent | null => { - const profile_id = profiledTransaction?.contexts?.['profile']?.['profile_id']; + const profile_id = profiledTransaction?.contexts?.trace?.data?.profile_id; if (typeof profile_id !== 'string') { logger.log('[Profiling] cannot find profile for a transaction without a profile context'); @@ -180,8 +203,8 @@ export const hermesProfilingIntegration: IntegrationFn = () => { } // Remove the profile from the transaction context before sending, relay will take care of the rest. - if (profiledTransaction?.contexts?.['.profile']) { - delete profiledTransaction.contexts.profile; + if (profiledTransaction?.contexts?.trace?.data?.profile_id) { + delete profiledTransaction.contexts.trace.data.profile_id; } const profile = PROFILE_QUEUE.get(profile_id); @@ -209,17 +232,6 @@ export const hermesProfilingIntegration: IntegrationFn = () => { }; }; -/** - * Profiling integration creates a profile for each transaction and adds it to the event envelope. - * - * @deprecated Use `hermesProfilingIntegration()` instead. - */ -// eslint-disable-next-line deprecation/deprecation -export const HermesProfiling = convertIntegrationFnToClass( - INTEGRATION_NAME, - hermesProfilingIntegration, -) as IntegrationClass; - /** * Starts Profilers and returns the timestamp when profiling started in nanoseconds. */ diff --git a/src/js/profiling/utils.ts b/src/js/profiling/utils.ts index 40b89108ce..70cd853494 100644 --- a/src/js/profiling/utils.ts +++ b/src/js/profiling/utils.ts @@ -48,7 +48,7 @@ export function findProfiledTransactionsFromEnvelope(envelope: Envelope): Event[ // @ts-expect-error accessing private property // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access - if (event && event.contexts && event.contexts['profile'] && event.contexts['profile']['profile_id']) { + if (event.contexts?.trace?.data?.profile_id) { events.push(item[j] as Event); } } diff --git a/src/js/sdk.tsx b/src/js/sdk.tsx index 3cb764186d..07576d1f9e 100644 --- a/src/js/sdk.tsx +++ b/src/js/sdk.tsx @@ -1,12 +1,10 @@ /* eslint-disable complexity */ -import type { Scope } from '@sentry/core'; -import { getIntegrationsToSetup, Hub, initAndBind, makeMain, setExtra } from '@sentry/core'; +import { getClient, getIntegrationsToSetup, initAndBind, withScope as coreWithScope } from '@sentry/core'; import { defaultStackParser, - getCurrentHub, makeFetchTransport, } from '@sentry/react'; -import type { Integration, UserFeedback } from '@sentry/types'; +import type { Integration, Scope, UserFeedback } from '@sentry/types'; import { logger, stackParserFromStackParserOptions } from '@sentry/utils'; import * as React from 'react'; @@ -14,11 +12,11 @@ import { ReactNativeClient } from './client'; import { getDefaultIntegrations } from './integrations/default'; import type { ReactNativeClientOptions, ReactNativeOptions, ReactNativeWrapperOptions } from './options'; import { shouldEnableNativeNagger } from './options'; -import { ReactNativeScope } from './scope'; import { TouchEventBoundary } from './touchevents'; -import { ReactNativeProfiler, ReactNativeTracing } from './tracing'; +import type { ReactNativeTracing } from './tracing'; +import { ReactNativeProfiler } from './tracing'; +import { useEncodePolyfill } from './transports/encodePolyfill'; import { DEFAULT_BUFFER_SIZE, makeNativeTransportFactory } from './transports/native'; -import { makeUtf8TextEncoder } from './transports/TextEncoder'; import { getDefaultEnvironment, isExpoGo, isRunningInMetroDevServer } from './utils/environment'; import { safeFactory, safeTracesSampler } from './utils/safe'; import { NATIVE } from './wrapper'; @@ -30,9 +28,6 @@ const DEFAULT_OPTIONS: ReactNativeOptions = { enableAutoPerformanceTracing: true, enableWatchdogTerminationTracking: true, patchGlobalPromise: true, - transportOptions: { - textEncoder: makeUtf8TextEncoder(), - }, sendClientReports: true, maxQueueSize: DEFAULT_BUFFER_SIZE, attachStacktrace: true, @@ -48,8 +43,7 @@ export function init(passedOptions: ReactNativeOptions): void { return; } - const reactNativeHub = new Hub(undefined, new ReactNativeScope()); - makeMain(reactNativeHub); + useEncodePolyfill(); const maxQueueSize = passedOptions.maxQueueSize // eslint-disable-next-line deprecation/deprecation @@ -112,7 +106,7 @@ export function wrap

>( RootComponent: React.ComponentType

, options?: ReactNativeWrapperOptions ): React.ComponentType

{ - const tracingIntegration = getCurrentHub().getIntegration(ReactNativeTracing); + const tracingIntegration = getClient()?.getIntegrationByName?.('ReactNativeTracing') as ReactNativeTracing | undefined; if (tracingIntegration) { tracingIntegration.useAppStartWithProfiler = true; } @@ -135,33 +129,12 @@ export function wrap

>( return RootApp; } -/** - * Deprecated. Sets the release on the event. - * NOTE: Does not set the release on sessions. - * @deprecated - */ -export function setRelease(release: string): void { - setExtra('__sentry_release', release); -} - -/** - * Deprecated. Sets the dist on the event. - * NOTE: Does not set the dist on sessions. - * @deprecated - */ -export function setDist(dist: string): void { - setExtra('__sentry_dist', dist); -} - /** * If native client is available it will trigger a native crash. * Use this only for testing purposes. */ export function nativeCrash(): void { - const client = getCurrentHub().getClient(); - if (client) { - client.nativeCrash(); - } + NATIVE.nativeCrash(); } /** @@ -170,7 +143,7 @@ export function nativeCrash(): void { */ export async function flush(): Promise { try { - const client = getCurrentHub().getClient(); + const client = getClient(); if (client) { const result = await client.flush(); @@ -190,7 +163,7 @@ export async function flush(): Promise { */ export async function close(): Promise { try { - const client = getCurrentHub().getClient(); + const client = getClient(); if (client) { await client.close(); @@ -204,7 +177,7 @@ export async function close(): Promise { * Captures user feedback and sends it to Sentry. */ export function captureUserFeedback(feedback: UserFeedback): void { - getCurrentHub().getClient()?.captureUserFeedback(feedback); + getClient()?.captureUserFeedback(feedback); } /** @@ -229,20 +202,5 @@ export function withScope(callback: (scope: Scope) => T): T | undefined { return undefined; } }; - return getCurrentHub().withScope(safeCallback); -} - -/** - * Callback to set context information onto the scope. - * @param callback Callback function that receives Scope. - */ -export function configureScope(callback: (scope: Scope) => void): ReturnType { - const safeCallback = (scope: Scope): void => { - try { - callback(scope); - } catch (e) { - logger.error('Error while running configureScope callback', e); - } - }; - getCurrentHub().configureScope(safeCallback); + return coreWithScope(safeCallback); } diff --git a/src/js/touchevents.tsx b/src/js/touchevents.tsx index fa58273baf..323cc24b75 100644 --- a/src/js/touchevents.tsx +++ b/src/js/touchevents.tsx @@ -1,4 +1,4 @@ -import { addBreadcrumb, getCurrentHub } from '@sentry/core'; +import { addBreadcrumb, getClient } from '@sentry/core'; import type { SeverityLevel } from '@sentry/types'; import { logger } from '@sentry/utils'; import * as React from 'react'; @@ -6,7 +6,7 @@ import type { GestureResponderEvent} from 'react-native'; import { StyleSheet, View } from 'react-native'; import { createIntegration } from './integrations/factory'; -import { ReactNativeTracing } from './tracing'; +import type { ReactNativeTracing } from './tracing'; import { UI_ACTION_TOUCH } from './tracing/ops'; export type TouchEventBoundaryProps = { @@ -88,10 +88,10 @@ class TouchEventBoundary extends React.Component { * Registers the TouchEventBoundary as a Sentry Integration. */ public componentDidMount(): void { - const client = getCurrentHub().getClient(); + const client = getClient(); client?.addIntegration?.(createIntegration(this.name)); if (!this._tracingIntegration && client) { - this._tracingIntegration = client.getIntegration(ReactNativeTracing); + this._tracingIntegration = client.getIntegrationByName('ReactNativeTracing') || null; } } @@ -235,7 +235,7 @@ class TouchEventBoundary extends React.Component { this._logTouchEvent(componentTreeNames, finalLabel); } - this._tracingIntegration?.startUserInteractionTransaction({ + this._tracingIntegration?.startUserInteractionSpan({ elementId: activeLabel, op: UI_ACTION_TOUCH, }); diff --git a/src/js/tracing/addTracingExtensions.ts b/src/js/tracing/addTracingExtensions.ts deleted file mode 100644 index d8b42585ac..0000000000 --- a/src/js/tracing/addTracingExtensions.ts +++ /dev/null @@ -1,97 +0,0 @@ -import type { Hub, Transaction } from '@sentry/core'; -import { addTracingExtensions, getCurrentHub, getMainCarrier } from '@sentry/core'; -import type { CustomSamplingContext, SpanContext, TransactionContext } from '@sentry/types'; - -import { DEFAULT } from '../tracing/ops'; -import { ReactNativeTracing } from '../tracing/reactnativetracing'; - -/** - * Adds React Native's extensions. Needs to be called before any transactions are created. - */ -export function _addTracingExtensions(): void { - addTracingExtensions(); - const carrier = getMainCarrier(); - if (carrier.__SENTRY__) { - carrier.__SENTRY__.extensions = carrier.__SENTRY__.extensions || {}; - if (carrier.__SENTRY__.extensions.startTransaction) { - const originalStartTransaction = carrier.__SENTRY__.extensions.startTransaction as StartTransactionFunction; - - /* - Overwrites the transaction start and finish to start and finish stall tracking. - Preferably instead of overwriting add a callback method for this in the Transaction itself. - */ - const _startTransaction = _patchStartTransaction(originalStartTransaction); - - carrier.__SENTRY__.extensions.startTransaction = _startTransaction; - } - } -} - -export type StartTransactionFunction = ( - this: Hub, - transactionContext: TransactionContext, - customSamplingContext?: CustomSamplingContext, -) => Transaction; - -/** - * Overwrite the startTransaction extension method to start and end stall tracking. - */ -const _patchStartTransaction = (originalStartTransaction: StartTransactionFunction): StartTransactionFunction => { - /** - * Method to overwrite with - */ - function _startTransaction( - this: Hub, - transactionContext: TransactionContext, - customSamplingContext?: CustomSamplingContext, - ): Transaction { - // Native SDKs require op to be set - for JS Relay sets `default` - if (!transactionContext.op) { - transactionContext.op = DEFAULT; - } - - const transaction: Transaction = originalStartTransaction.apply(this, [transactionContext, customSamplingContext]); - const originalStartChild: Transaction['startChild'] = transaction.startChild.bind(transaction); - transaction.startChild = ( - spanContext?: Pick>, - ): ReturnType => { - return originalStartChild({ - ...spanContext, - // Native SDKs require op to be set - op: spanContext?.op || DEFAULT, - }); - }; - - const reactNativeTracing = getCurrentHub().getIntegration(ReactNativeTracing); - - if (reactNativeTracing) { - reactNativeTracing.onTransactionStart(transaction); - - // eslint-disable-next-line @typescript-eslint/unbound-method - const originalFinish = transaction.finish; - - transaction.finish = (endTimestamp: number | undefined) => { - if (reactNativeTracing) { - reactNativeTracing.onTransactionFinish(transaction, endTimestamp); - } - - return originalFinish.apply(transaction, [endTimestamp]); - }; - - // eslint-disable-next-line @typescript-eslint/unbound-method - const originalEnd = transaction.end; - - transaction.end = (endTimestamp: number | undefined) => { - if (reactNativeTracing) { - reactNativeTracing.onTransactionFinish(transaction, endTimestamp); - } - - return originalEnd.apply(transaction, [endTimestamp]); - }; - } - - return transaction; - } - - return _startTransaction; -}; diff --git a/src/js/tracing/gesturetracing.ts b/src/js/tracing/gesturetracing.ts index 8bc6f9d2b6..f7965dab1f 100644 --- a/src/js/tracing/gesturetracing.ts +++ b/src/js/tracing/gesturetracing.ts @@ -1,9 +1,9 @@ -import { getCurrentHub } from '@sentry/core'; -import type { Breadcrumb, Hub } from '@sentry/types'; +import { addBreadcrumb, getClient } from '@sentry/core'; +import type { Breadcrumb } from '@sentry/types'; import { logger } from '@sentry/utils'; import { UI_ACTION } from './ops'; -import { ReactNativeTracing } from './reactnativetracing'; +import type { ReactNativeTracing } from './reactnativetracing'; export const DEFAULT_BREADCRUMB_CATEGORY = 'gesture'; export const DEFAULT_BREADCRUMB_TYPE = 'user'; @@ -33,10 +33,6 @@ interface BaseGesture { handlerName: string; } -interface GestureTracingOptions { - getCurrentHub: () => Hub; -} - /** * Patches React Native Gesture Handler v2 Gesture to start a transaction on gesture begin with the appropriate label. * Example: ShoppingCartScreen.dismissGesture @@ -48,7 +44,6 @@ export function sentryTraceGesture( */ label: string, gesture: GestureT, - options: Partial = {}, ): GestureT { const gestureCandidate = gesture as unknown as BaseGesture | undefined | null; if (!gestureCandidate) { @@ -65,8 +60,6 @@ export function sentryTraceGesture( logger.warn('[GestureTracing] Can not wrap gesture without name.'); return gesture; } - const hub = options.getCurrentHub?.() || getCurrentHub(); - const name = gestureCandidate.handlerName.length > GESTURE_POSTFIX_LENGTH ? gestureCandidate.handlerName @@ -76,12 +69,11 @@ export function sentryTraceGesture( const originalOnBegin = gestureCandidate.handlers.onBegin; (gesture as unknown as Required).handlers.onBegin = (event: GestureEvent) => { - hub - .getClient() - ?.getIntegration(ReactNativeTracing) - ?.startUserInteractionTransaction({ elementId: label, op: `${UI_ACTION}.${name}` }); + getClient() + ?.getIntegrationByName('ReactNativeTracing') + ?.startUserInteractionSpan({ elementId: label, op: `${UI_ACTION}.${name}` }); - addGestureBreadcrumb(`Gesture ${label} begin.`, { event, hub, name }); + addGestureBreadcrumb(`Gesture ${label} begin.`, { event, name }); if (originalOnBegin) { originalOnBegin(event); @@ -90,7 +82,7 @@ export function sentryTraceGesture( const originalOnEnd = gestureCandidate.handlers.onEnd; (gesture as unknown as Required).handlers.onEnd = (event: GestureEvent) => { - addGestureBreadcrumb(`Gesture ${label} end.`, { event, hub, name }); + addGestureBreadcrumb(`Gesture ${label} end.`, { event, name }); if (originalOnEnd) { originalOnEnd(event); @@ -104,11 +96,10 @@ function addGestureBreadcrumb( message: string, options: { event: Record | undefined | null; - hub: Hub; name: string; }, ): void { - const { event, hub, name } = options; + const { event, name } = options; const crumb: Breadcrumb = { message, level: 'info', @@ -129,7 +120,7 @@ function addGestureBreadcrumb( crumb.data = data; } - hub.addBreadcrumb(crumb); + addBreadcrumb(crumb); logger.log(`[GestureTracing] ${crumb.message}`); } diff --git a/src/js/tracing/index.ts b/src/js/tracing/index.ts index 7fd0312a61..bcd0ebd8e7 100644 --- a/src/js/tracing/index.ts +++ b/src/js/tracing/index.ts @@ -8,10 +8,9 @@ export { // eslint-disable-next-line deprecation/deprecation ReactNavigationV5Instrumentation, } from './reactnavigation'; -export { ReactNavigationV4Instrumentation } from './reactnavigationv4'; export { ReactNativeNavigationInstrumentation } from './reactnativenavigation'; -export type { ReactNavigationCurrentRoute, ReactNavigationRoute, ReactNavigationTransactionContext } from './types'; +export type { ReactNavigationCurrentRoute, ReactNavigationRoute } from './types'; export { ReactNativeProfiler } from './reactnativeprofiler'; diff --git a/src/js/tracing/nativeframes.ts b/src/js/tracing/nativeframes.ts index 84eab70ec5..01982b724b 100644 --- a/src/js/tracing/nativeframes.ts +++ b/src/js/tracing/nativeframes.ts @@ -1,10 +1,10 @@ -import type { Span, Transaction } from '@sentry/core'; -import type { Event, EventProcessor, Measurements, MeasurementUnit } from '@sentry/types'; +import { spanToJSON } from '@sentry/core'; +import type { Client, Event, Integration, Measurements, MeasurementUnit, Span } from '@sentry/types'; import { logger, timestampInSeconds } from '@sentry/utils'; import type { NativeFramesResponse } from '../NativeRNSentry'; +import { isRootSpan } from '../utils/span'; import { NATIVE } from '../wrapper'; -import { instrumentChildSpanFinish } from './utils'; export interface FramesMeasurements extends Measurements { frames_total: { value: number; unit: MeasurementUnit }; @@ -12,12 +12,6 @@ export interface FramesMeasurements extends Measurements { frames_frozen: { value: number; unit: MeasurementUnit }; } -/** The listeners for each native frames response, keyed by traceId. This must be global to avoid closure issues and reading outdated values. */ -const _framesListeners: Map void> = new Map(); - -/** The native frames at the transaction finish time, keyed by traceId. This must be global to avoid closure issues and reading outdated values. */ -const _finishFrames: Map = new Map(); - /** * A margin of error of 50ms is allowed for the async native bridge call. * Anything larger would reduce the accuracy of our frames measurements. @@ -27,69 +21,97 @@ const MARGIN_OF_ERROR_SECONDS = 0.05; /** * Instrumentation to add native slow/frozen frames measurements onto transactions. */ -export class NativeFramesInstrumentation { +export class NativeFramesInstrumentation implements Integration { + public name: string = 'NativeFramesInstrumentation'; + + /** The native frames at the transaction finish time, keyed by traceId. */ + private _finishFrames: Map = new Map(); + /** The listeners for each native frames response, keyed by traceId */ + private _framesListeners: Map void> = new Map(); /** The native frames at the finish time of the most recent span. */ private _lastSpanFinishFrames?: { timestamp: number; nativeFrames: NativeFramesResponse; }; + private _spanToNativeFramesAtStartMap: Map = new Map(); - public constructor(addGlobalEventProcessor: (e: EventProcessor) => void, doesExist: () => boolean) { + public constructor() { logger.log('[ReactNativeTracing] Native frames instrumentation initialized.'); + } + + /** + * Hooks into the client start and end span events. + */ + public setup(client: Client): void { + client.on('spanStart', this._onSpanStart); + client.on('spanEnd', this._onSpanFinish); + } - addGlobalEventProcessor(event => this._processEvent(event, doesExist)); + /** + * Adds frames measurements to an event. Called from a valid event processor. + * Awaits for finish frames if needed. + */ + public processEvent(event: Event): Promise { + return this._processEvent(event); } /** - * To be called when a transaction is started. - * Logs the native frames at this start point and instruments child span finishes. + * Fetches the native frames in background if the given span is a root span. + * + * @param {Span} rootSpan - The span that has started. */ - public onTransactionStart(transaction: Transaction): void { - void NATIVE.fetchNativeFrames() - .then(framesMetrics => { - if (framesMetrics) { - transaction.setData('__startFrames', framesMetrics); + private _onSpanStart = (rootSpan: Span): void => { + if (!isRootSpan(rootSpan)) { + return; + } + + NATIVE.fetchNativeFrames() + .then(frames => { + if (!frames) { + return; } + + this._spanToNativeFramesAtStartMap.set(rootSpan.spanContext().traceId, frames); }) .then(undefined, error => { logger.error(`[ReactNativeTracing] Error while fetching native frames: ${error}`); }); - - instrumentChildSpanFinish(transaction, (_: Span, endTimestamp?: number) => { - if (!endTimestamp) { - this._onSpanFinish(); - } - }); - } - - /** - * To be called when a transaction is finished - */ - public onTransactionFinish(transaction: Transaction): void { - this._fetchFramesForTransaction(transaction).then(undefined, (reason: unknown) => { - logger.error(`[ReactNativeTracing] Error while fetching native frames:`, reason); - }); - } + }; /** * Called on a span finish to fetch native frames to support transactions with trimEnd. * Only to be called when a span does not have an end timestamp. */ - private _onSpanFinish(): void { + private _onSpanFinish = (span: Span): void => { + if (isRootSpan(span)) { + return this._onTransactionFinish(span); + } + const timestamp = timestampInSeconds(); void NATIVE.fetchNativeFrames() - .then(nativeFrames => { - if (nativeFrames) { - this._lastSpanFinishFrames = { - timestamp, - nativeFrames, - }; + .then(frames => { + if (!frames) { + return; } + + this._lastSpanFinishFrames = { + timestamp, + nativeFrames: frames, + }; }) .then(undefined, error => { logger.error(`[ReactNativeTracing] Error while fetching native frames: ${error}`); }); + }; + + /** + * To be called when a transaction is finished + */ + private _onTransactionFinish(span: Span): void { + this._fetchFramesForTransaction(span).then(undefined, (reason: unknown) => { + logger.error(`[ReactNativeTracing] Error while fetching native frames:`, reason); + }); } /** @@ -100,22 +122,22 @@ export class NativeFramesInstrumentation { finalEndTimestamp: number, startFrames: NativeFramesResponse, ): Promise { - if (_finishFrames.has(traceId)) { + if (this._finishFrames.has(traceId)) { return this._prepareMeasurements(traceId, finalEndTimestamp, startFrames); } return new Promise(resolve => { const timeout = setTimeout(() => { - _framesListeners.delete(traceId); + this._framesListeners.delete(traceId); resolve(null); }, 2000); - _framesListeners.set(traceId, () => { + this._framesListeners.set(traceId, () => { resolve(this._prepareMeasurements(traceId, finalEndTimestamp, startFrames)); clearTimeout(timeout); - _framesListeners.delete(traceId); + this._framesListeners.delete(traceId); }); }); } @@ -130,7 +152,7 @@ export class NativeFramesInstrumentation { ): FramesMeasurements | null { let finalFinishFrames: NativeFramesResponse | undefined; - const finish = _finishFrames.get(traceId); + const finish = this._finishFrames.get(traceId); if ( finish && finish.nativeFrames && @@ -170,8 +192,13 @@ export class NativeFramesInstrumentation { /** * Fetch finish frames for a transaction at the current time. Calls any awaiting listeners. */ - private async _fetchFramesForTransaction(transaction: Transaction): Promise { - const startFrames = transaction.data.__startFrames as NativeFramesResponse | undefined; + private async _fetchFramesForTransaction(span: Span): Promise { + const traceId = spanToJSON(span).trace_id; + if (!traceId) { + return; + } + + const startFrames = this._spanToNativeFramesAtStartMap.get(span.spanContext().traceId); // This timestamp marks when the finish frames were retrieved. It should be pretty close to the transaction finish. const timestamp = timestampInSeconds(); @@ -180,25 +207,31 @@ export class NativeFramesInstrumentation { finishFrames = await NATIVE.fetchNativeFrames(); } - _finishFrames.set(transaction.traceId, { + this._finishFrames.set(traceId, { nativeFrames: finishFrames, timestamp, }); - _framesListeners.get(transaction.traceId)?.(); + this._framesListeners.get(traceId)?.(); - setTimeout(() => this._cancelFinishFrames(transaction), 2000); + setTimeout(() => this._cancelFinishFrames(span), 2000); } /** * On a finish frames failure, we cancel the await. */ - private _cancelFinishFrames(transaction: Transaction): void { - if (_finishFrames.has(transaction.traceId)) { - _finishFrames.delete(transaction.traceId); + private _cancelFinishFrames(span: Span): void { + const spanJSON = spanToJSON(span); + const traceId = spanJSON.trace_id; + if (!traceId) { + return; + } + + if (this._finishFrames.has(traceId)) { + this._finishFrames.delete(traceId); logger.log( - `[NativeFrames] Native frames timed out for ${transaction.op} transaction ${transaction.name}. Not adding native frames measurements.`, + `[NativeFrames] Native frames timed out for ${spanJSON.op} transaction ${spanJSON.description}. Not adding native frames measurements.`, ); } } @@ -207,51 +240,50 @@ export class NativeFramesInstrumentation { * Adds frames measurements to an event. Called from a valid event processor. * Awaits for finish frames if needed. */ - private async _processEvent(event: Event, doesExist: () => boolean): Promise { - if (!doesExist()) { + private async _processEvent(event: Event): Promise { + if ( + event.type !== 'transaction' || + !event.transaction || + !event.contexts || + !event.contexts.trace || + !event.timestamp || + !event.contexts.trace.trace_id + ) { return event; } - if (event.type === 'transaction' && event.transaction && event.contexts && event.contexts.trace) { - const traceContext = event.contexts.trace as { - data?: { [key: string]: unknown }; - trace_id: string; - name?: string; - op?: string; - }; - - const traceId = traceContext.trace_id; - - if (traceId && traceContext.data?.__startFrames && event.timestamp) { - const measurements = await this._getFramesMeasurements( - traceId, - event.timestamp, - traceContext.data.__startFrames as NativeFramesResponse, - ); - - if (!measurements) { - logger.log( - `[NativeFrames] Could not fetch native frames for ${traceContext.op} transaction ${event.transaction}. Not adding native frames measurements.`, - ); - } else { - logger.log( - `[Measurements] Adding measurements to ${traceContext.op} transaction ${ - event.transaction - }: ${JSON.stringify(measurements, undefined, 2)}`, - ); - - event.measurements = { - ...(event.measurements ?? {}), - ...measurements, - }; - - _finishFrames.delete(traceId); - } + const traceOp = event.contexts.trace.op; + const traceId = event.contexts.trace.trace_id; + const startFrames = this._spanToNativeFramesAtStartMap.get(traceId); + this._spanToNativeFramesAtStartMap.delete(traceId); + if (!startFrames) { + return event; + } + + const measurements = await this._getFramesMeasurements(traceId, event.timestamp, startFrames); - delete traceContext.data.__startFrames; - } + if (!measurements) { + logger.log( + `[NativeFrames] Could not fetch native frames for ${traceOp} transaction ${event.transaction}. Not adding native frames measurements.`, + ); + return event; } + logger.log( + `[Measurements] Adding measurements to ${traceOp} transaction ${event.transaction}: ${JSON.stringify( + measurements, + undefined, + 2, + )}`, + ); + + event.measurements = { + ...(event.measurements ?? {}), + ...measurements, + }; + + this._finishFrames.delete(traceId); + return event; } } diff --git a/src/js/tracing/onSpanEndUtils.ts b/src/js/tracing/onSpanEndUtils.ts new file mode 100644 index 0000000000..90c2acbe06 --- /dev/null +++ b/src/js/tracing/onSpanEndUtils.ts @@ -0,0 +1,125 @@ +import { getSpanDescendants, SPAN_STATUS_ERROR, spanToJSON } from '@sentry/core'; +import type { Client, Span } from '@sentry/types'; +import { logger } from '@sentry/utils'; +import type { AppStateStatus } from 'react-native'; +import { AppState } from 'react-native'; + +import { isRootSpan, isSentrySpan } from '../utils/span'; + +/** + * + */ +export function onThisSpanEnd(client: Client, span: Span, callback: (span: Span) => void): void { + client.on('spanEnd', (endedSpan: Span) => { + if (span !== endedSpan) { + return; + } + callback(endedSpan); + }); +} + +export const adjustTransactionDuration = (client: Client, span: Span, maxDurationMs: number): void => { + if (!isRootSpan(span)) { + logger.warn('Not sampling empty back spans only works for Sentry Transactions (Root Spans).'); + return; + } + + client.on('spanEnd', (endedSpan: Span) => { + if (endedSpan !== span) { + return; + } + + const endTimestamp = spanToJSON(span).timestamp; + const startTimestamp = spanToJSON(span).start_timestamp; + if (!endTimestamp || !startTimestamp) { + return; + } + + const diff = endTimestamp - startTimestamp; + const isOutdatedTransaction = endTimestamp && (diff > maxDurationMs || diff < 0); + if (isOutdatedTransaction) { + span.setStatus({ code: SPAN_STATUS_ERROR, message: 'deadline_exceeded' }); + // TODO: check where was used, might be possible to delete + span.setAttribute('maxTransactionDurationExceeded', 'true'); + } + }); +}; +export const ignoreEmptyBackNavigation = (client: Client, span: Span): void => { + if (!isRootSpan(span) || !isSentrySpan(span)) { + logger.warn('Not sampling empty back spans only works for Sentry Transactions (Root Spans).'); + return; + } + + client.on('spanEnd', (endedSpan: Span) => { + if (endedSpan !== span) { + return; + } + + if (!spanToJSON(span).data?.['route.has_been_seen']) { + return; + } + + const children = getSpanDescendants(span); + const filtered = children.filter( + child => + child.spanContext().spanId !== span.spanContext().spanId && + spanToJSON(child).op !== 'ui.load.initial_display' && + spanToJSON(child).op !== 'navigation.processing', + ); + + if (filtered.length <= 0) { + // filter children must include at least one span not created by the navigation automatic instrumentation + logger.log( + '[ReactNativeTracing] Not sampling transaction as route has been seen before. Pass ignoreEmptyBackNavigationTransactions = false to disable this feature.', + ); + // Route has been seen before and has no child spans. + span['_sampled'] = false; + } + }); +}; + +/** + * Idle Transaction callback to only sample transactions with child spans. + * To avoid side effects of other callbacks this should be hooked as the last callback. + */ +export const onlySampleIfChildSpans = (client: Client, span: Span): void => { + if (!isRootSpan(span) || !isSentrySpan(span)) { + logger.warn('Not sampling childless spans only works for Sentry Transactions (Root Spans).'); + return; + } + + client.on('spanEnd', (endedSpan: Span) => { + if (endedSpan !== span) { + return; + } + + const children = getSpanDescendants(span); + + if (children.length <= 1) { + // Span always has at lest one child, itself + logger.log(`Not sampling as ${spanToJSON(span).op} transaction has no child spans.`); + span['_sampled'] = false; + } + }); +}; + +/** + * Hooks on AppState change to cancel the span if the app goes background. + */ +export const cancelInBackground = (client: Client, span: Span): void => { + const subscription = AppState.addEventListener('change', (newState: AppStateStatus) => { + if (newState === 'background') { + logger.debug(`Setting ${spanToJSON(span).op} transaction to cancelled because the app is in the background.`); + span.setStatus({ code: SPAN_STATUS_ERROR, message: 'cancelled' }); + span.end(); + } + }); + + subscription && + client.on('spanEnd', (endedSpan: Span) => { + if (endedSpan === span) { + logger.debug(`Removing AppState listener for ${spanToJSON(span).op} transaction.`); + subscription && subscription.remove && subscription.remove(); + } + }); +}; diff --git a/src/js/tracing/reactnativenavigation.ts b/src/js/tracing/reactnativenavigation.ts index 29d83fbc50..39d1dddf79 100644 --- a/src/js/tracing/reactnativenavigation.ts +++ b/src/js/tracing/reactnativenavigation.ts @@ -1,11 +1,11 @@ -import type { Transaction as TransactionType, TransactionContext } from '@sentry/types'; -import { logger } from '@sentry/utils'; +import { addBreadcrumb, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core'; +import type { Span } from '@sentry/types'; import type { EmitterSubscription } from '../utils/rnlibrariesinterface'; +import { isSentrySpan } from '../utils/span'; import type { OnConfirmRoute, TransactionCreator } from './routingInstrumentation'; import { InternalRoutingInstrumentation } from './routingInstrumentation'; -import type { BeforeNavigate, RouteChangeContextData } from './types'; -import { customTransactionSource, defaultTransactionSource, getBlankTransactionContext } from './utils'; +import type { BeforeNavigate } from './types'; interface ReactNativeNavigationOptions { /** @@ -78,7 +78,7 @@ export class ReactNativeNavigationInstrumentation extends InternalRoutingInstrum private _prevComponentEvent: ComponentWillAppearEvent | null = null; - private _latestTransaction?: TransactionType; + private _latestTransaction?: Span; private _recentComponentIds: string[] = []; private _stateChangeTimeout?: number | undefined; @@ -124,9 +124,7 @@ export class ReactNativeNavigationInstrumentation extends InternalRoutingInstrum this._discardLatestTransaction(); } - this._latestTransaction = this.onRouteWillChange( - getBlankTransactionContext(ReactNativeNavigationInstrumentation.name), - ); + this._latestTransaction = this.onRouteWillChange({ name: 'Route Change' }); this._stateChangeTimeout = setTimeout( this._discardLatestTransaction.bind(this), @@ -151,79 +149,48 @@ export class ReactNativeNavigationInstrumentation extends InternalRoutingInstrum this._clearStateChangeTimeout(); - const originalContext = this._latestTransaction.toContext(); const routeHasBeenSeen = this._recentComponentIds.includes(event.componentId); - const data: RouteChangeContextData = { - ...originalContext.data, - route: { - ...event, - name: event.componentName, - hasBeenSeen: routeHasBeenSeen, + this._latestTransaction.updateName(event.componentName); + this._latestTransaction.setAttributes({ + // TODO: Should we include pass props? I don't know exactly what it contains, cant find it in the RNavigation docs + 'route.name': event.componentName, + 'route.component_id': event.componentId, + 'route.component_type': event.componentType, + 'route.has_been_seen': routeHasBeenSeen, + 'previous_route.name': this._prevComponentEvent?.componentName, + 'previous_route.component_id': this._prevComponentEvent?.componentId, + 'previous_route.component_type': this._prevComponentEvent?.componentType, + [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', + }); + + this._beforeNavigate?.(this._latestTransaction); + + this._onConfirmRoute?.(event.componentName); + + addBreadcrumb({ + category: 'navigation', + type: 'navigation', + message: `Navigation to ${event.componentName}`, + data: { + from: this._prevComponentEvent?.componentName, + to: event.componentName, }, - previousRoute: this._prevComponentEvent - ? { - ...this._prevComponentEvent, - name: this._prevComponentEvent?.componentName, - } - : null, - }; - - const updatedContext = { - ...originalContext, - name: event.componentName, - tags: { - ...originalContext.tags, - 'routing.route.name': event.componentName, - }, - data, - }; + }); - const finalContext = this._prepareFinalContext(updatedContext); - this._latestTransaction.updateWithContext(finalContext); - - const isCustomName = updatedContext.name !== finalContext.name; - this._latestTransaction.setName( - finalContext.name, - isCustomName ? customTransactionSource : defaultTransactionSource, - ); - - this._onConfirmRoute?.(finalContext); this._prevComponentEvent = event; - this._latestTransaction = undefined; } - /** Creates final transaction context before confirmation */ - private _prepareFinalContext(updatedContext: TransactionContext): TransactionContext { - let finalContext = this._beforeNavigate?.({ ...updatedContext }); - - // This block is to catch users not returning a transaction context - if (!finalContext) { - logger.error( - `[${ReactNativeNavigationInstrumentation.name}] beforeNavigate returned ${finalContext}, return context.sampled = false to not send transaction.`, - ); - - finalContext = { - ...updatedContext, - sampled: false, - }; - } - - if (finalContext.sampled === false) { - logger.log( - `[${ReactNativeNavigationInstrumentation.name}] Will not send transaction "${finalContext.name}" due to beforeNavigate.`, - ); - } - - return finalContext; - } - /** Cancels the latest transaction so it does not get sent to Sentry. */ private _discardLatestTransaction(): void { if (this._latestTransaction) { - this._latestTransaction.sampled = false; - this._latestTransaction.finish(); + if (isSentrySpan(this._latestTransaction)) { + this._latestTransaction['_sampled'] = false; + } + // TODO: What if it's not SentrySpan? + this._latestTransaction.end(); this._latestTransaction = undefined; } diff --git a/src/js/tracing/reactnativeprofiler.tsx b/src/js/tracing/reactnativeprofiler.tsx index 71fcfb8434..a6d15deddf 100644 --- a/src/js/tracing/reactnativeprofiler.tsx +++ b/src/js/tracing/reactnativeprofiler.tsx @@ -1,7 +1,8 @@ -import { getCurrentHub, Profiler } from '@sentry/react'; +import { spanToJSON } from '@sentry/core'; +import { getClient, Profiler } from '@sentry/react'; import { createIntegration } from '../integrations/factory'; -import { ReactNativeTracing } from './reactnativetracing'; +import type { ReactNativeTracing } from './reactnativetracing'; const ReactNativeProfilerGlobalState = { appStartReported: false, @@ -28,8 +29,7 @@ export class ReactNativeProfiler extends Profiler { * Notifies the Tracing integration that the app start has finished. */ private _reportAppStart(): void { - const hub = getCurrentHub(); - const client = hub.getClient(); + const client = getClient(); if (!client) { // We can't use logger here because this will be logged before the `Sentry.init`. @@ -40,11 +40,11 @@ export class ReactNativeProfiler extends Profiler { client.addIntegration && client.addIntegration(createIntegration(this.name)); - const tracingIntegration = hub.getIntegration(ReactNativeTracing); + const endTimestamp = this._mountSpan && typeof spanToJSON(this._mountSpan).timestamp + const tracingIntegration = client.getIntegrationByName && client.getIntegrationByName('ReactNativeTracing'); tracingIntegration - && this._mountSpan - && typeof this._mountSpan.endTimestamp !== 'undefined' + && typeof endTimestamp === 'number' // The first root component mount is the app start finish. - && tracingIntegration.onAppStartFinish(this._mountSpan.endTimestamp); + && tracingIntegration.onAppStartFinish(endTimestamp); } } diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index 397cc1ee50..2ed34dbf0b 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -1,32 +1,49 @@ /* eslint-disable max-lines */ import type { RequestInstrumentationOptions } from '@sentry/browser'; import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from '@sentry/browser'; -import type { Hub, IdleTransaction, Transaction } from '@sentry/core'; -import { getActiveTransaction, getCurrentHub, startIdleTransaction } from '@sentry/core'; -import type { - Event, - EventProcessor, - Integration, - Transaction as TransactionType, - TransactionContext, -} from '@sentry/types'; -import { logger } from '@sentry/utils'; +import { + getActiveSpan, + getCurrentScope, + getSpanDescendants, + SEMANTIC_ATTRIBUTE_SENTRY_OP, + SentryNonRecordingSpan, + setMeasurement, + SPAN_STATUS_ERROR, + spanToJSON, + startIdleSpan, + startInactiveSpan, +} from '@sentry/core'; +import type { Client, Event, Integration, PropagationContext, Scope, Span, StartSpanOptions } from '@sentry/types'; +import { logger, uuid4 } from '@sentry/utils'; import { APP_START_COLD, APP_START_WARM } from '../measurements'; import type { NativeAppStartResponse } from '../NativeRNSentry'; import type { RoutingInstrumentationInstance } from '../tracing/routingInstrumentation'; +import { isRootSpan, isSentrySpan } from '../utils/span'; import { NATIVE } from '../wrapper'; import { NativeFramesInstrumentation } from './nativeframes'; -import { APP_START_COLD as APP_START_COLD_OP, APP_START_WARM as APP_START_WARM_OP, UI_LOAD } from './ops'; -import { StallTrackingInstrumentation } from './stalltracking'; -import { cancelInBackground, onlySampleIfChildSpans } from './transaction'; -import type { BeforeNavigate, RouteChangeContextData } from './types'; import { adjustTransactionDuration, - getTimeOriginMilliseconds, - isNearToNow, - setSpanDurationAsMeasurement, -} from './utils'; + cancelInBackground, + ignoreEmptyBackNavigation, + onlySampleIfChildSpans, + onThisSpanEnd, +} from './onSpanEndUtils'; +import { APP_START_COLD as APP_START_COLD_OP, APP_START_WARM as APP_START_WARM_OP, UI_LOAD } from './ops'; +import { StallTrackingInstrumentation } from './stalltracking'; +import type { BeforeNavigate } from './types'; +import { getTimeOriginMilliseconds, setSpanDurationAsMeasurement } from './utils'; + +const SCOPE_SPAN_FIELD = '_sentrySpan'; + +type ScopeWithMaybeSpan = Scope & { + [SCOPE_SPAN_FIELD]?: Span; +}; + +function clearActiveSpanFromScope(scope: ScopeWithMaybeSpan): void { + // eslint-disable-next-line @typescript-eslint/no-dynamic-delete + delete scope[SCOPE_SPAN_FIELD]; +} export interface ReactNativeTracingOptions extends RequestInstrumentationOptions { /** @@ -144,14 +161,13 @@ export class ReactNativeTracing implements Integration { public stallTrackingInstrumentation?: StallTrackingInstrumentation; public useAppStartWithProfiler: boolean = false; - private _inflightInteractionTransaction?: IdleTransaction; - private _getCurrentHub?: () => Hub; + private _inflightInteractionTransaction?: Span; private _awaitingAppStartData?: NativeAppStartResponse; private _appStartFinishTimestamp?: number; private _currentRoute?: string; private _hasSetTracePropagationTargets: boolean; - private _hasSetTracingOrigins: boolean; private _currentViewName: string | undefined; + private _client: Client | undefined; public constructor(options: Partial = {}) { this._hasSetTracePropagationTargets = !!( @@ -159,11 +175,6 @@ export class ReactNativeTracing implements Integration { // eslint-disable-next-line deprecation/deprecation options.tracePropagationTargets ); - this._hasSetTracingOrigins = !!( - options && - // eslint-disable-next-line deprecation/deprecation - options.tracingOrigins - ); this.options = { ...defaultReactNativeTracingOptions, @@ -187,12 +198,8 @@ export class ReactNativeTracing implements Integration { /** * Registers routing and request instrumentation. */ - public async setupOnce( - addGlobalEventProcessor: (callback: EventProcessor) => void, - getCurrentHub: () => Hub, - ): Promise { - const hub = getCurrentHub(); - const client = hub.getClient(); + public setup(client: Client): void { + this._client = client; const clientOptions = client && client.getOptions(); // eslint-disable-next-line @typescript-eslint/unbound-method @@ -200,7 +207,6 @@ export class ReactNativeTracing implements Integration { traceFetch, traceXHR, // eslint-disable-next-line deprecation/deprecation - tracingOrigins, shouldCreateSpanForRequest, // eslint-disable-next-line deprecation/deprecation tracePropagationTargets: thisOptionsTracePropagationTargets, @@ -209,32 +215,11 @@ export class ReactNativeTracing implements Integration { enableStallTracking, } = this.options; - this._getCurrentHub = getCurrentHub; - const clientOptionsTracePropagationTargets = clientOptions && clientOptions.tracePropagationTargets; - // There are three ways to configure tracePropagationTargets: - // 1. via top level client option `tracePropagationTargets` - // 2. via ReactNativeTracing option `tracePropagationTargets` - // 3. via ReactNativeTracing option `tracingOrigins` (deprecated) - // - // To avoid confusion, favour top level client option `tracePropagationTargets`, and fallback to - // ReactNativeTracing option `tracePropagationTargets` and then `tracingOrigins` (deprecated). - // - // If both 1 and either one of 2 or 3 are set (from above), we log out a warning. const tracePropagationTargets = clientOptionsTracePropagationTargets || (this._hasSetTracePropagationTargets && thisOptionsTracePropagationTargets) || - (this._hasSetTracingOrigins && tracingOrigins) || DEFAULT_TRACE_PROPAGATION_TARGETS; - if ( - __DEV__ && - (this._hasSetTracePropagationTargets || this._hasSetTracingOrigins) && - clientOptionsTracePropagationTargets - ) { - logger.warn( - '[ReactNativeTracing] The `tracePropagationTargets` option was set in the ReactNativeTracing integration and top level `Sentry.init`. The top level `Sentry.init` value is being used.', - ); - } if (enableAppStartTracking) { this._instrumentAppStart().then(undefined, (reason: unknown) => { @@ -242,10 +227,11 @@ export class ReactNativeTracing implements Integration { }); } - this._enableNativeFramesTracking(addGlobalEventProcessor); + this._enableNativeFramesTracking(client); if (enableStallTracking) { this.stallTrackingInstrumentation = new StallTrackingInstrumentation(); + this.stallTrackingInstrumentation.setup(client); } if (routingInstrumentation) { @@ -258,7 +244,7 @@ export class ReactNativeTracing implements Integration { logger.log('[ReactNativeTracing] Not instrumenting route changes as routingInstrumentation has not been set.'); } - addGlobalEventProcessor(this._getCurrentViewEventProcessor.bind(this)); + addDefaultOpForSpanFrom(client); instrumentOutgoingRequests({ traceFetch, @@ -269,22 +255,13 @@ export class ReactNativeTracing implements Integration { } /** - * To be called on a transaction start. Can have async methods + * @inheritdoc */ - public onTransactionStart(transaction: Transaction): void { - if (isNearToNow(transaction.startTimestamp)) { - // Only if this method is called at or within margin of error to the start timestamp. - this.nativeFramesInstrumentation?.onTransactionStart(transaction); - this.stallTrackingInstrumentation?.onTransactionStart(transaction); - } - } - - /** - * To be called on a transaction finish. Cannot have async methods. - */ - public onTransactionFinish(transaction: Transaction, endTimestamp?: number): void { - this.nativeFramesInstrumentation?.onTransactionFinish(transaction); - this.stallTrackingInstrumentation?.onTransactionFinish(transaction, endTimestamp); + public processEvent(event: Event): Promise | Event { + const eventWithView = this._getCurrentViewEventProcessor(event); + return this.nativeFramesInstrumentation + ? this.nativeFramesInstrumentation.processEvent(eventWithView) + : eventWithView; } /** @@ -298,10 +275,12 @@ export class ReactNativeTracing implements Integration { * Starts a new transaction for a user interaction. * @param userInteractionId Consists of `op` representation UI Event and `elementId` unique element identifier on current screen. */ - public startUserInteractionTransaction(userInteractionId: { - elementId: string | undefined; - op: string; - }): TransactionType | undefined { + public startUserInteractionSpan(userInteractionId: { elementId: string | undefined; op: string }): Span | undefined { + const client = this._client; + if (!client) { + return; + } + const { elementId, op } = userInteractionId; if (!this.options.enableUserInteractionTracing) { logger.log('[ReactNativeTracing] User Interaction Tracing is disabled.'); @@ -322,35 +301,52 @@ export class ReactNativeTracing implements Integration { return; } - const hub = this._getCurrentHub?.() || getCurrentHub(); - const activeTransaction = getActiveTransaction(hub); + const activeTransaction = getActiveSpan(); const activeTransactionIsNotInteraction = - activeTransaction?.spanId !== this._inflightInteractionTransaction?.spanId; + !activeTransaction || + !this._inflightInteractionTransaction || + spanToJSON(activeTransaction).span_id !== spanToJSON(this._inflightInteractionTransaction).span_id; if (activeTransaction && activeTransactionIsNotInteraction) { logger.warn( - `[ReactNativeTracing] Did not create ${op} transaction because active transaction ${activeTransaction.name} exists on the scope.`, + `[ReactNativeTracing] Did not create ${op} transaction because active transaction ${ + spanToJSON(activeTransaction).description + } exists on the scope.`, + ); + return; + } + + const name = `${this._currentRoute}.${elementId}`; + if ( + this._inflightInteractionTransaction && + spanToJSON(this._inflightInteractionTransaction).description === name && + spanToJSON(this._inflightInteractionTransaction).op === op + ) { + logger.warn( + `[ReactNativeTracing] Did not create ${op} transaction because it the same transaction ${ + spanToJSON(this._inflightInteractionTransaction).description + } already exists on the scope.`, ); return; } if (this._inflightInteractionTransaction) { - this._inflightInteractionTransaction.cancelIdleTimeout(undefined, { restartOnChildSpanChange: false }); + // TODO: Check the interaction transactions spec, see if can be implemented differently + // this._inflightInteractionTransaction.cancelIdleTimeout(undefined, { restartOnChildSpanChange: false }); this._inflightInteractionTransaction = undefined; } - const name = `${this._currentRoute}.${elementId}`; - const context: TransactionContext = { + const scope = getCurrentScope(); + const context: StartSpanOptions = { name, op, - trimEnd: true, + scope, }; - this._inflightInteractionTransaction = this._startIdleTransaction(context); - this._inflightInteractionTransaction.registerBeforeFinishCallback((transaction: IdleTransaction) => { + clearActiveSpanFromScope(scope); + this._inflightInteractionTransaction = this._startIdleSpan(context); + onThisSpanEnd(client, this._inflightInteractionTransaction, () => { this._inflightInteractionTransaction = undefined; - this.onTransactionFinish(transaction); }); - this._inflightInteractionTransaction.registerBeforeFinishCallback(onlySampleIfChildSpans); - this.onTransactionStart(this._inflightInteractionTransaction); + onlySampleIfChildSpans(client, this._inflightInteractionTransaction); logger.log(`[ReactNativeTracing] User Interaction Tracing Created ${op} transaction ${name}.`); return this._inflightInteractionTransaction; } @@ -358,7 +354,7 @@ export class ReactNativeTracing implements Integration { /** * Enables or disables native frames tracking based on the `enableNativeFramesTracking` option. */ - private _enableNativeFramesTracking(addGlobalEventProcessor: (callback: EventProcessor) => void): void { + private _enableNativeFramesTracking(client: Client): void { if (this.options.enableNativeFramesTracking && !NATIVE.enableNative) { // Do not enable native frames tracking if native is not available. logger.warn( @@ -378,15 +374,8 @@ export class ReactNativeTracing implements Integration { } NATIVE.enableNativeFramesTracking(); - this.nativeFramesInstrumentation = new NativeFramesInstrumentation(addGlobalEventProcessor, () => { - const self = getCurrentHub().getIntegration(ReactNativeTracing); - - if (self) { - return !!self.nativeFramesInstrumentation; - } - - return false; - }); + this.nativeFramesInstrumentation = new NativeFramesInstrumentation(); + this.nativeFramesInstrumentation.setup(client); } /** @@ -447,7 +436,11 @@ export class ReactNativeTracing implements Integration { /** * Adds app start measurements and starts a child span on a transaction. */ - private _addAppStartData(transaction: IdleTransaction, appStart: NativeAppStartResponse): void { + private _addAppStartData(span: Span, appStart: NativeAppStartResponse): void { + if (!isSentrySpan(span)) { + return; + } + const appStartDurationMilliseconds = this._getAppStartDurationMilliseconds(appStart); if (!appStartDurationMilliseconds) { logger.warn('App start was never finished.'); @@ -463,146 +456,139 @@ export class ReactNativeTracing implements Integration { const appStartTimeSeconds = appStart.appStartTime / 1000; - transaction.startTimestamp = appStartTimeSeconds; + span.updateStartTime(appStartTimeSeconds); + const children = getSpanDescendants(span); - const maybeTtidSpan = transaction.spanRecorder?.spans.find(span => span.op === 'ui.load.initial_display'); - if (maybeTtidSpan) { - maybeTtidSpan.startTimestamp = appStartTimeSeconds; + const maybeTtidSpan = children.find(span => spanToJSON(span).op === 'ui.load.initial_display'); + if (maybeTtidSpan && isSentrySpan(maybeTtidSpan)) { + maybeTtidSpan.updateStartTime(appStartTimeSeconds); setSpanDurationAsMeasurement('time_to_initial_display', maybeTtidSpan); } - const maybeTtfdSpan = transaction.spanRecorder?.spans.find(span => span.op === 'ui.load.full_display'); - if (maybeTtfdSpan) { - maybeTtfdSpan.startTimestamp = appStartTimeSeconds; + const maybeTtfdSpan = children.find(span => spanToJSON(span).op === 'ui.load.full_display'); + if (maybeTtfdSpan && isSentrySpan(maybeTtfdSpan)) { + maybeTtfdSpan.updateStartTime(appStartTimeSeconds); setSpanDurationAsMeasurement('time_to_full_display', maybeTtfdSpan); } const op = appStart.isColdStart ? APP_START_COLD_OP : APP_START_WARM_OP; - transaction.startChild({ - description: appStart.isColdStart ? 'Cold App Start' : 'Warm App Start', + startInactiveSpan({ + name: appStart.isColdStart ? 'Cold App Start' : 'Warm App Start', op, - startTimestamp: appStartTimeSeconds, - endTimestamp: this._appStartFinishTimestamp, - }); - + startTime: appStartTimeSeconds, + }).end(this._appStartFinishTimestamp); const measurement = appStart.isColdStart ? APP_START_COLD : APP_START_WARM; - transaction.setMeasurement(measurement, appStartDurationMilliseconds, 'millisecond'); + setMeasurement(measurement, appStartDurationMilliseconds, 'millisecond'); } /** To be called when the route changes, but BEFORE the components of the new route mount. */ - private _onRouteWillChange(context: TransactionContext): TransactionType | undefined { - return this._createRouteTransaction(context); + private _onRouteWillChange(): Span | undefined { + return this._createRouteTransaction(); } /** - * Creates a breadcrumb and sets the current route as a tag. + * Save the current route to set it in context during event processing. */ - private _onConfirmRoute(context: TransactionContext): void { - // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access - this._currentRoute = context.data?.route?.name; - - this._getCurrentHub?.().configureScope(scope => { - if (context.data) { - const contextData = context.data as RouteChangeContextData; - - scope.addBreadcrumb({ - category: 'navigation', - type: 'navigation', - // We assume that context.name is the name of the route. - message: `Navigation to ${context.name}`, - data: { - from: contextData.previousRoute?.name, - to: contextData.route.name, - }, - }); - } - - this._currentViewName = context.name; - /** - * @deprecated tag routing.route.name will be removed in the future. - */ - scope.setTag('routing.route.name', context.name); - }); + private _onConfirmRoute(currentViewName: string | undefined): void { + this._currentViewName = currentViewName; + this._currentRoute = currentViewName; } /** Create routing idle transaction. */ - private _createRouteTransaction(context: TransactionContext): IdleTransaction | undefined { - if (!this._getCurrentHub) { - logger.warn(`[ReactNativeTracing] Did not create ${context.op} transaction because _getCurrentHub is invalid.`); + private _createRouteTransaction({ + name, + op, + }: { + name?: string; + op?: string; + } = {}): Span | undefined { + if (!this._client) { + logger.warn(`[ReactNativeTracing] Can't create route change span, missing client.`); return undefined; } if (this._inflightInteractionTransaction) { logger.log( - `[ReactNativeTracing] Canceling ${this._inflightInteractionTransaction.op} transaction because navigation ${context.op}.`, + `[ReactNativeTracing] Canceling ${ + spanToJSON(this._inflightInteractionTransaction).op + } transaction because of a new navigation root span.`, ); - this._inflightInteractionTransaction.setStatus('cancelled'); - this._inflightInteractionTransaction.finish(); + this._inflightInteractionTransaction.setStatus({ code: SPAN_STATUS_ERROR, message: 'cancelled' }); + this._inflightInteractionTransaction.end(); } const { finalTimeoutMs } = this.options; - const expandedContext = { - ...context, - trimEnd: true, + const expandedContext: StartSpanOptions = { + name: name || 'Route Change', + op, + forceTransaction: true, + scope: getCurrentScope(), }; - const idleTransaction = this._startIdleTransaction(expandedContext); - - this.onTransactionStart(idleTransaction); - - logger.log(`[ReactNativeTracing] Starting ${context.op} transaction "${context.name}" on scope`); - - idleTransaction.registerBeforeFinishCallback((transaction, endTimestamp) => { - this.onTransactionFinish(transaction, endTimestamp); - }); + const addAwaitingAppStartBeforeSpanEnds = (span: Span): void => { + if (!isRootSpan(span)) { + logger.warn('Not sampling empty back spans only works for Sentry Transactions (Root Spans).'); + return; + } - idleTransaction.registerBeforeFinishCallback(transaction => { if (this.options.enableAppStartTracking && this._awaitingAppStartData) { - transaction.op = UI_LOAD; - this._addAppStartData(transaction, this._awaitingAppStartData); + span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, UI_LOAD); + this._addAppStartData(span, this._awaitingAppStartData); this._awaitingAppStartData = undefined; } - }); + }; - idleTransaction.registerBeforeFinishCallback((transaction, endTimestamp) => { - adjustTransactionDuration(finalTimeoutMs, transaction, endTimestamp); - }); + const idleSpan = this._startIdleSpan(expandedContext, addAwaitingAppStartBeforeSpanEnds); + if (!idleSpan) { + return undefined; + } + + logger.log(`[ReactNativeTracing] Starting ${op || 'unknown op'} transaction "${name}" on scope`); + + adjustTransactionDuration(this._client, idleSpan, finalTimeoutMs); if (this.options.ignoreEmptyBackNavigationTransactions) { - idleTransaction.registerBeforeFinishCallback(transaction => { - if ( - // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access - transaction.data?.route?.hasBeenSeen && - (!transaction.spanRecorder || - transaction.spanRecorder.spans.filter( - span => - span.spanId !== transaction.spanId && - span.op !== 'ui.load.initial_display' && - span.op !== 'navigation.processing', - ).length === 0) - ) { - logger.log( - '[ReactNativeTracing] Not sampling transaction as route has been seen before. Pass ignoreEmptyBackNavigationTransactions = false to disable this feature.', - ); - // Route has been seen before and has no child spans. - transaction.sampled = false; - } - }); + ignoreEmptyBackNavigation(this._client, idleSpan); } - return idleTransaction; + return idleSpan; } /** * Start app state aware idle transaction on the scope. */ - private _startIdleTransaction(context: TransactionContext): IdleTransaction { + private _startIdleSpan(startSpanOption: StartSpanOptions, beforeSpanEnd?: (span: Span) => void): Span { + if (!this._client) { + logger.warn(`[ReactNativeTracing] Can't create idle span, missing client.`); + return new SentryNonRecordingSpan(); + } + + getCurrentScope().setPropagationContext(generatePropagationContext()); + const { idleTimeoutMs, finalTimeoutMs } = this.options; - const hub = this._getCurrentHub?.() || getCurrentHub(); - const tx = startIdleTransaction(hub, context, idleTimeoutMs, finalTimeoutMs, true); - cancelInBackground(tx); - return tx; + const span = startIdleSpan(startSpanOption, { + finalTimeout: finalTimeoutMs, + idleTimeout: idleTimeoutMs, + beforeSpanEnd, + }); + cancelInBackground(this._client, span); + return span; } } + +function generatePropagationContext(): PropagationContext { + return { + traceId: uuid4(), + spanId: uuid4().substring(16), + }; +} + +function addDefaultOpForSpanFrom(client: Client): void { + client.on('spanStart', (span: Span) => { + if (!spanToJSON(span).op) { + span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'default'); + } + }); +} diff --git a/src/js/tracing/reactnavigation.ts b/src/js/tracing/reactnavigation.ts index a25abaa792..0b86b4e34d 100644 --- a/src/js/tracing/reactnavigation.ts +++ b/src/js/tracing/reactnavigation.ts @@ -1,17 +1,26 @@ /* eslint-disable max-lines */ -import { getActiveSpan, setMeasurement, spanToJSON, startInactiveSpan } from '@sentry/core'; -import type { Span, Transaction as TransactionType, TransactionContext } from '@sentry/types'; +import { + addBreadcrumb, + getActiveSpan, + SEMANTIC_ATTRIBUTE_SENTRY_OP, + setMeasurement, + SPAN_STATUS_OK, + spanToJSON, + startInactiveSpan, +} from '@sentry/core'; +import type { Span } from '@sentry/types'; import { logger, timestampInSeconds } from '@sentry/utils'; import type { NewFrameEvent } from '../utils/sentryeventemitter'; import { type SentryEventEmitter, createSentryEventEmitter, NewFrameEventName } from '../utils/sentryeventemitter'; +import { isSentrySpan } from '../utils/span'; import { RN_GLOBAL_OBJ } from '../utils/worldwide'; import { NATIVE } from '../wrapper'; import type { OnConfirmRoute, TransactionCreator } from './routingInstrumentation'; import { InternalRoutingInstrumentation } from './routingInstrumentation'; +import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from './semanticAttributes'; import { manualInitialDisplaySpans, startTimeToInitialDisplaySpan } from './timetodisplay'; -import type { BeforeNavigate, ReactNavigationTransactionContext, RouteChangeContextData } from './types'; -import { customTransactionSource, defaultTransactionSource, getBlankTransactionContext } from './utils'; +import type { BeforeNavigate } from './types'; export interface NavigationRoute { name: string; @@ -68,7 +77,7 @@ export class ReactNavigationInstrumentation extends InternalRoutingInstrumentati private readonly _maxRecentRouteLen: number = 200; private _latestRoute?: NavigationRoute; - private _latestTransaction?: TransactionType; + private _latestTransaction?: Span; private _navigationProcessingSpan?: Span; private _initialStateHandled: boolean = false; @@ -183,15 +192,13 @@ export class ReactNavigationInstrumentation extends InternalRoutingInstrumentati this._clearStateChangeTimeout(); } - this._latestTransaction = this.onRouteWillChange( - getBlankTransactionContext(ReactNavigationInstrumentation.instrumentationName), - ); + this._latestTransaction = this.onRouteWillChange({ name: 'Route Change' }); if (this._options.enableTimeToInitialDisplay) { this._navigationProcessingSpan = startInactiveSpan({ op: 'navigation.processing', name: 'Navigation processing', - startTimestamp: this._latestTransaction?.startTimestamp, + startTime: this._latestTransaction && spanToJSON(this._latestTransaction).start_timestamp, }); } @@ -262,7 +269,7 @@ export class ReactNavigationInstrumentation extends InternalRoutingInstrumentati return; } - latestTtidSpan.setStatus('ok'); + latestTtidSpan.setStatus({ code: SPAN_STATUS_OK }); latestTtidSpan.end(newFrameTimestampInSeconds); const ttidSpan = spanToJSON(latestTtidSpan); @@ -277,51 +284,41 @@ export class ReactNavigationInstrumentation extends InternalRoutingInstrumentati ); this._navigationProcessingSpan?.updateName(`Processing navigation to ${route.name}`); - this._navigationProcessingSpan?.setStatus('ok'); + this._navigationProcessingSpan?.setStatus({ code: SPAN_STATUS_OK }); this._navigationProcessingSpan?.end(stateChangedTimestamp); this._navigationProcessingSpan = undefined; - const originalContext = this._latestTransaction.toContext() as typeof BLANK_TRANSACTION_CONTEXT; - - const data: RouteChangeContextData = { - ...originalContext.data, - route: { - name: route.name, - key: route.key, - // TODO: filter PII params instead of dropping them all - params: {}, - hasBeenSeen: routeHasBeenSeen, - }, - previousRoute: previousRoute - ? { - name: previousRoute.name, - key: previousRoute.key, - // TODO: filter PII params instead of dropping them all - params: {}, - } - : null, - }; - - const updatedContext: ReactNavigationTransactionContext = { - ...originalContext, - name: route.name, - tags: { - ...originalContext.tags, - 'routing.route.name': route.name, + this._latestTransaction.updateName(route.name); + this._latestTransaction.setAttributes({ + 'route.name': route.name, + 'route.key': route.key, + // TODO: filter PII params instead of dropping them all + // 'route.params': {}, + 'route.has_been_seen': routeHasBeenSeen, + 'previous_route.name': previousRoute?.name, + 'previous_route.key': previousRoute?.key, + // TODO: filter PII params instead of dropping them all + // 'previous_route.params': {}, + [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', + }); + + this._beforeNavigate?.(this._latestTransaction); + // Clear the timeout so the transaction does not get cancelled. + this._clearStateChangeTimeout(); + + this._onConfirmRoute?.(route.name); + + // TODO: Add test for addBreadcrumb + addBreadcrumb({ + category: 'navigation', + type: 'navigation', + message: `Navigation to ${route.name}`, + data: { + from: previousRoute?.name, + to: route.name, }, - data, - }; - - const finalContext = this._prepareFinalContext(updatedContext); - this._latestTransaction.updateWithContext(finalContext); - - const isCustomName = updatedContext.name !== finalContext.name; - this._latestTransaction.setName( - finalContext.name, - isCustomName ? customTransactionSource : defaultTransactionSource, - ); - - this._onConfirmRoute?.(finalContext); + }); } this._pushRecentRouteKey(route.key); @@ -333,35 +330,6 @@ export class ReactNavigationInstrumentation extends InternalRoutingInstrumentati } } - /** Creates final transaction context before confirmation */ - private _prepareFinalContext(updatedContext: TransactionContext): TransactionContext { - let finalContext = this._beforeNavigate?.({ ...updatedContext }); - - // This block is to catch users not returning a transaction context - if (!finalContext) { - logger.error( - `[ReactNavigationInstrumentation] beforeNavigate returned ${finalContext}, return context.sampled = false to not send transaction.`, - ); - - finalContext = { - ...updatedContext, - sampled: false, - }; - } - - // Note: finalContext.sampled will be false at this point only if the user sets it to be so in beforeNavigate. - if (finalContext.sampled === false) { - logger.log( - `[ReactNavigationInstrumentation] Will not send transaction "${finalContext.name}" due to beforeNavigate.`, - ); - } else { - // Clear the timeout so the transaction does not get cancelled. - this._clearStateChangeTimeout(); - } - - return finalContext; - } - /** Pushes a recent route key, and removes earlier routes when there is greater than the max length */ private _pushRecentRouteKey = (key: string): void => { this._recentRouteKeys.push(key); @@ -374,8 +342,11 @@ export class ReactNavigationInstrumentation extends InternalRoutingInstrumentati /** Cancels the latest transaction so it does not get sent to Sentry. */ private _discardLatestTransaction(): void { if (this._latestTransaction) { - this._latestTransaction.sampled = false; - this._latestTransaction.finish(); + if (isSentrySpan(this._latestTransaction)) { + this._latestTransaction['_sampled'] = false; + } + // TODO: What if it's not SentrySpan? + this._latestTransaction.end(); this._latestTransaction = undefined; } if (this._navigationProcessingSpan) { diff --git a/src/js/tracing/reactnavigationv4.ts b/src/js/tracing/reactnavigationv4.ts deleted file mode 100644 index 789375f50e..0000000000 --- a/src/js/tracing/reactnavigationv4.ts +++ /dev/null @@ -1,348 +0,0 @@ -/* eslint-disable max-lines */ -import type { Transaction, TransactionContext } from '@sentry/types'; -import { logger } from '@sentry/utils'; - -import { RN_GLOBAL_OBJ } from '../utils/worldwide'; -import type { OnConfirmRoute, TransactionCreator } from './routingInstrumentation'; -import { InternalRoutingInstrumentation } from './routingInstrumentation'; -import type { BeforeNavigate, ReactNavigationTransactionContext, RouteChangeContextData } from './types'; -import { customTransactionSource, defaultTransactionSource } from './utils'; - -export interface NavigationRouteV4 { - routeName: string; - key: string; - // eslint-disable-next-line @typescript-eslint/no-explicit-any - params?: Record; -} - -export interface NavigationStateV4 { - index: number; - key: string; - isTransitioning: boolean; - routeName?: string; - routes: (NavigationRouteV4 | NavigationStateV4)[]; -} - -export interface AppContainerInstance { - _navigation: { - state: NavigationStateV4; - router: { - getStateForAction: ( - // eslint-disable-next-line @typescript-eslint/no-explicit-any - action: any, - state: NavigationStateV4, - ) => NavigationStateV4; - }; - }; -} - -interface ReactNavigationV4Options { - /** - * How long the instrumentation will wait for the route to mount after a change has been initiated, - * before the transaction is discarded. - * Time is in ms. - * - * Default: 1000 - */ - routeChangeTimeoutMs: number; -} - -const defaultOptions: ReactNavigationV4Options = { - routeChangeTimeoutMs: 1000, -}; - -/** - * Instrumentation for React-Navigation V4. - * Register the app container with `registerAppContainer` to use, or see docs for more details. - */ -class ReactNavigationV4Instrumentation extends InternalRoutingInstrumentation { - public static instrumentationName: string = 'react-navigation-v4'; - - public readonly name: string = ReactNavigationV4Instrumentation.instrumentationName; - - private _appContainer: AppContainerInstance | null = null; - - private readonly _maxRecentRouteLen: number = 200; - - private _prevRoute?: NavigationRouteV4; - private _recentRouteKeys: string[] = []; - - private _latestTransaction?: Transaction; - private _initialStateHandled: boolean = false; - private _stateChangeTimeout?: number | undefined; - - private _options: ReactNavigationV4Options; - - public constructor(options: Partial = {}) { - super(); - - this._options = { - ...defaultOptions, - ...options, - }; - } - - /** - * Extends by calling _handleInitialState at the end. - */ - public registerRoutingInstrumentation( - listener: TransactionCreator, - beforeNavigate: BeforeNavigate, - onConfirmRoute: OnConfirmRoute, - ): void { - super.registerRoutingInstrumentation(listener, beforeNavigate, onConfirmRoute); - - // Need to handle the initial state as the router patch will only attach transactions on subsequent route changes. - if (!this._initialStateHandled) { - this._latestTransaction = this.onRouteWillChange(INITIAL_TRANSACTION_CONTEXT_V4); - if (this._appContainer) { - this._updateLatestTransaction(); - - this._initialStateHandled = true; - } else { - this._stateChangeTimeout = setTimeout( - this._discardLatestTransaction.bind(this), - this._options.routeChangeTimeoutMs, - ); - } - } - } - - /** - * Pass the ref to the app container to register it to the instrumentation - * @param appContainerRef Ref to an `AppContainer` - */ - // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types - public registerAppContainer(appContainerRef: any): void { - /* We prevent duplicate routing instrumentation to be initialized on fast refreshes - - Explanation: If the user triggers a fast refresh on the file that the instrumentation is - initialized in, it will initialize a new instance and will cause undefined behavior. - */ - if (!RN_GLOBAL_OBJ.__sentry_rn_v4_registered) { - if ('current' in appContainerRef) { - // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access - this._appContainer = appContainerRef.current; - } else { - this._appContainer = appContainerRef; - } - - if (this._appContainer) { - this._patchRouter(); - - if (!this._initialStateHandled) { - if (this._latestTransaction) { - this._updateLatestTransaction(); - } else { - logger.log( - '[ReactNavigationV4Instrumentation] App container registered, but integration has not been setup yet.', - ); - } - this._initialStateHandled = true; - } - - RN_GLOBAL_OBJ.__sentry_rn_v4_registered = true; - } else { - logger.warn('[ReactNavigationV4Instrumentation] Received invalid app container ref!'); - } - } - } - - /** - * Updates the latest transaction with the current state and calls beforeNavigate. - */ - private _updateLatestTransaction(): void { - // We can assume the ref is present as this is called from registerAppContainer - if (this._appContainer && this._latestTransaction) { - const state = this._appContainer._navigation.state; - - if (typeof this._stateChangeTimeout !== 'undefined') { - clearTimeout(this._stateChangeTimeout); - this._stateChangeTimeout = undefined; - } - - this._onStateChange(state, true); - } - } - - /** - * Patches the react navigation router so we can listen to the route changes and attach the `IdleTransaction` before the - * new screen is mounted. - */ - private _patchRouter(): void { - if (this._appContainer) { - const originalGetStateForAction = this._appContainer._navigation.router.getStateForAction; - - this._appContainer._navigation.router.getStateForAction = (action, state) => { - const newState = originalGetStateForAction(action, state); - - this._onStateChange(newState); - - return newState; - }; - } - } - - /** - * To be called on navigation state changes and creates the transaction. - */ - private _onStateChange(state: NavigationStateV4 | undefined, updateLatestTransaction: boolean = false): void { - // it's not guaranteed that a state is always produced. - // see: https://github.com/react-navigation/react-navigation/blob/45d419be93c34e900e8734ce98321ae875ac4997/packages/core/src/routers/SwitchRouter.js?rgh-link-date=2021-09-25T12%3A43%3A36Z#L301 - if (!state || state === undefined) { - logger.warn('[ReactNavigationV4Instrumentation] onStateChange called without a valid state.'); - - return; - } - - const currentRoute = this._getCurrentRouteFromState(state); - - // If the route is a different key, this is so we ignore actions that pertain to the same screen. - if (!this._prevRoute || currentRoute.key !== this._prevRoute.key) { - const originalContext = this._getTransactionContext(currentRoute, this._prevRoute); - - let mergedContext = originalContext; - if (updateLatestTransaction && this._latestTransaction) { - mergedContext = { - ...this._latestTransaction.toContext(), - ...originalContext, - }; - } - - const finalContext = this._prepareFinalContext(mergedContext); - - if (updateLatestTransaction && this._latestTransaction) { - // Update the latest transaction instead of calling onRouteWillChange - this._latestTransaction.updateWithContext(finalContext); - const isCustomName = mergedContext.name !== finalContext.name; - this._latestTransaction.setName( - finalContext.name, - isCustomName ? customTransactionSource : defaultTransactionSource, - ); - } else { - this._latestTransaction = this.onRouteWillChange(finalContext); - } - - this._onConfirmRoute?.(finalContext); - - this._pushRecentRouteKey(currentRoute.key); - this._prevRoute = currentRoute; - } - } - - /** Creates final transaction context before confirmation */ - private _prepareFinalContext(mergedContext: TransactionContext): TransactionContext { - let finalContext = this._beforeNavigate?.({ ...mergedContext }); - - // This block is to catch users not returning a transaction context - if (!finalContext) { - logger.error( - `[ReactNavigationV4Instrumentation] beforeNavigate returned ${finalContext}, return context.sampled = false to not send transaction.`, - ); - - finalContext = { - ...mergedContext, - sampled: false, - }; - } - - if (finalContext.sampled === false) { - this._onBeforeNavigateNotSampled(finalContext.name); - } - - return finalContext; - } - - /** - * Gets the transaction context for a `NavigationRouteV4` - */ - private _getTransactionContext( - route: NavigationRouteV4, - previousRoute?: NavigationRouteV4, - ): ReactNavigationTransactionContext { - const data: RouteChangeContextData = { - route: { - name: route.routeName, // Include name here too for use in `beforeNavigate` - key: route.key, - // TODO: filter PII params instead of dropping them all - params: {}, - hasBeenSeen: this._recentRouteKeys.includes(route.key), - }, - previousRoute: previousRoute - ? { - name: previousRoute.routeName, - key: previousRoute.key, - // TODO: filter PII params instead of dropping them all - params: {}, - } - : null, - }; - - return { - name: route.routeName, - op: 'navigation', - tags: { - 'routing.instrumentation': ReactNavigationV4Instrumentation.instrumentationName, - 'routing.route.name': route.routeName, - }, - data, - }; - } - - /** - * Gets the current route given a navigation state - */ - private _getCurrentRouteFromState(state: NavigationStateV4): NavigationRouteV4 { - const parentRoute = state.routes[state.index]; - - if ( - 'index' in parentRoute && - 'routes' in parentRoute && - typeof parentRoute.index === 'number' && - Array.isArray(parentRoute.routes) - ) { - return this._getCurrentRouteFromState(parentRoute); - } - - return parentRoute as NavigationRouteV4; - } - - /** Pushes a recent route key, and removes earlier routes when there is greater than the max length */ - private _pushRecentRouteKey = (key: string): void => { - this._recentRouteKeys.push(key); - - if (this._recentRouteKeys.length > this._maxRecentRouteLen) { - this._recentRouteKeys = this._recentRouteKeys.slice(this._recentRouteKeys.length - this._maxRecentRouteLen); - } - }; - - /** Helper to log a transaction that was not sampled due to beforeNavigate */ - private _onBeforeNavigateNotSampled = (transactionName: string): void => { - logger.log( - `[ReactNavigationV4Instrumentation] Will not send transaction "${transactionName}" due to beforeNavigate.`, - ); - }; - - /** Cancels the latest transaction so it does not get sent to Sentry. */ - private _discardLatestTransaction(): void { - if (this._latestTransaction) { - this._latestTransaction.sampled = false; - this._latestTransaction.finish(); - this._latestTransaction = undefined; - } - } -} - -const INITIAL_TRANSACTION_CONTEXT_V4: TransactionContext = { - name: 'App Launch', - op: 'navigation', - tags: { - 'routing.instrumentation': ReactNavigationV4Instrumentation.instrumentationName, - }, - data: {}, - metadata: { - source: 'view', - }, -}; - -export { ReactNavigationV4Instrumentation, INITIAL_TRANSACTION_CONTEXT_V4 }; diff --git a/src/js/tracing/routingInstrumentation.ts b/src/js/tracing/routingInstrumentation.ts index c7778fdcb2..8655743499 100644 --- a/src/js/tracing/routingInstrumentation.ts +++ b/src/js/tracing/routingInstrumentation.ts @@ -1,11 +1,10 @@ -import type { Hub } from '@sentry/core'; -import type { Transaction, TransactionContext } from '@sentry/types'; +import type { Span, StartSpanOptions } from '@sentry/types'; import type { BeforeNavigate } from './types'; -export type TransactionCreator = (context: TransactionContext) => Transaction | undefined; +export type TransactionCreator = (context: StartSpanOptions) => Span | undefined; -export type OnConfirmRoute = (context: TransactionContext) => void; +export type OnConfirmRoute = (currentViewName: string | undefined) => void; export interface RoutingInstrumentationInstance { /** @@ -32,7 +31,7 @@ export interface RoutingInstrumentationInstance { * * @param context A `TransactionContext` used to initialize the transaction. */ - onRouteWillChange(context: TransactionContext): Transaction | undefined; + onRouteWillChange(context: StartSpanOptions): Span | undefined; } /** @@ -44,7 +43,6 @@ export class RoutingInstrumentation implements RoutingInstrumentationInstance { public readonly name: string = RoutingInstrumentation.instrumentationName; - protected _getCurrentHub?: () => Hub; protected _beforeNavigate?: BeforeNavigate; protected _onConfirmRoute?: OnConfirmRoute; protected _tracingListener?: TransactionCreator; @@ -61,11 +59,11 @@ export class RoutingInstrumentation implements RoutingInstrumentationInstance { } /** @inheritdoc */ - public onRouteWillChange(context: TransactionContext): Transaction | undefined { + public onRouteWillChange(context: StartSpanOptions): Span | undefined { const transaction = this._tracingListener?.(context); if (transaction) { - this._onConfirmRoute?.(context); + this._onConfirmRoute?.(context.name); } return transaction; @@ -77,7 +75,7 @@ export class RoutingInstrumentation implements RoutingInstrumentationInstance { */ export class InternalRoutingInstrumentation extends RoutingInstrumentation { /** @inheritdoc */ - public onRouteWillChange(context: TransactionContext): Transaction | undefined { + public onRouteWillChange(context: StartSpanOptions): Span | undefined { return this._tracingListener?.(context); } } diff --git a/src/js/tracing/semanticAttributes.ts b/src/js/tracing/semanticAttributes.ts new file mode 100644 index 0000000000..6a0294ea3a --- /dev/null +++ b/src/js/tracing/semanticAttributes.ts @@ -0,0 +1,18 @@ +export { + SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, + SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, + SEMANTIC_ATTRIBUTE_SENTRY_OP, + SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, + SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON, +} from '@sentry/core'; + +export const SEMANTIC_ATTRIBUTE_ROUTING_INSTRUMENTATION = 'routing.instrumentation'; +export const SEMANTIC_ATTRIBUTE_ROUTE_NAME = 'route.name'; +export const SEMANTIC_ATTRIBUTE_ROUTE_KEY = 'route.key'; +export const SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_ID = 'route.component_id'; +export const SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_TYPE = 'route.component_type'; +export const SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN = 'route.has_been_seen'; +export const SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_NAME = 'previous_route.name'; +export const SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_KEY = 'previous_route.key'; +export const SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_COMPONENT_ID = 'previous_route.component_id'; +export const SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_COMPONENT_TYPE = 'previous_route.component_type'; diff --git a/src/js/tracing/stalltracking.ts b/src/js/tracing/stalltracking.ts index 714cc946c9..3e83de1bd2 100644 --- a/src/js/tracing/stalltracking.ts +++ b/src/js/tracing/stalltracking.ts @@ -1,11 +1,13 @@ /* eslint-disable max-lines */ -import type { IdleTransaction, Span, Transaction } from '@sentry/core'; -import type { Measurements, MeasurementUnit } from '@sentry/types'; +import { getRootSpan, spanToJSON } from '@sentry/core'; +import type { Client, Integration, Measurements, MeasurementUnit, Span } from '@sentry/types'; import { logger, timestampInSeconds } from '@sentry/utils'; import type { AppStateStatus } from 'react-native'; import { AppState } from 'react-native'; import { STALL_COUNT, STALL_LONGEST_TIME, STALL_TOTAL_TIME } from '../measurements'; +import { isRootSpan } from '../utils/span'; +import { getLatestChildSpanEndTimestamp, isNearToNow, setSpanMeasurement } from './utils'; export interface StallMeasurements extends Measurements { [STALL_COUNT]: { value: number; unit: MeasurementUnit }; @@ -35,7 +37,9 @@ const MAX_RUNNING_TRANSACTIONS = 10; * However, we modified the interval implementation to instead have a fixed loop timeout interval of `LOOP_TIMEOUT_INTERVAL_MS`. * We then would consider that iteration a stall when the total time for that interval to run is greater than `LOOP_TIMEOUT_INTERVAL_MS + minimumStallThreshold` */ -export class StallTrackingInstrumentation { +export class StallTrackingInstrumentation implements Integration { + public name: string = 'StallTrackingInstrumentation'; + public isTracking: boolean = false; private _minimumStallThreshold: number; @@ -51,8 +55,8 @@ export class StallTrackingInstrumentation { private _isBackground: boolean = false; - private _statsByTransaction: Map< - Transaction, + private _statsByRootSpan: Map< + Span, { longestStallTime: number; atStart: StallMeasurements; @@ -76,167 +80,136 @@ export class StallTrackingInstrumentation { /** * @inheritDoc - * Not used for this integration. Instead call `registerTransactionStart` to start tracking. */ - public setupOnce(): void { - // Do nothing. + public setup(client: Client): void { + client.on('spanStart', this._onSpanStart); + client.on('spanEnd', this._onSpanEnd); } /** * Register a transaction as started. Starts stall tracking if not already running. - * @returns A finish method that returns the stall measurements. */ - public onTransactionStart(transaction: Transaction): void { - if (this._statsByTransaction.has(transaction)) { + private _onSpanStart = (rootSpan: Span): void => { + if (!isRootSpan(rootSpan)) { + return; + } + + if (this._statsByRootSpan.has(rootSpan)) { logger.error( '[StallTracking] Tried to start stall tracking on a transaction already being tracked. Measurements might be lost.', ); - return; } this._startTracking(); - this._statsByTransaction.set(transaction, { + this._statsByRootSpan.set(rootSpan, { longestStallTime: 0, atTimestamp: null, - atStart: this._getCurrentStats(transaction), + atStart: this._getCurrentStats(rootSpan), }); this._flushLeakedTransactions(); - - if (transaction.spanRecorder) { - // eslint-disable-next-line @typescript-eslint/unbound-method - const originalAdd = transaction.spanRecorder.add; - - transaction.spanRecorder.add = (span: Span): void => { - originalAdd.apply(transaction.spanRecorder, [span]); - - // eslint-disable-next-line @typescript-eslint/unbound-method - const originalSpanFinish = span.finish; - - span.finish = (endTimestamp?: number) => { - // We let the span determine its own end timestamp as well in case anything gets changed upstream - originalSpanFinish.apply(span, [endTimestamp]); - - // The span should set a timestamp, so this would be defined. - if (span.endTimestamp) { - this._markSpanFinish(transaction, span.endTimestamp); - } - }; - - // eslint-disable-next-line @typescript-eslint/unbound-method - const originalSpanEnd = span.end; - - span.end = (endTimestamp?: number) => { - // We let the span determine its own end timestamp as well in case anything gets changed upstream - originalSpanEnd.apply(span, [endTimestamp]); - - // The span should set a timestamp, so this would be defined. - if (span.endTimestamp) { - this._markSpanFinish(transaction, span.endTimestamp); - } - }; - }; - } - } + }; /** * Logs a transaction as finished. * Stops stall tracking if no more transactions are running. * @returns The stall measurements */ - public onTransactionFinish(transaction: Transaction | IdleTransaction, passedEndTimestamp?: number): void { - const transactionStats = this._statsByTransaction.get(transaction); + private _onSpanEnd = (rootSpan: Span): void => { + if (!isRootSpan(rootSpan)) { + return this._onChildSpanEnd(rootSpan); + } + + const transactionStats = this._statsByRootSpan.get(rootSpan); if (!transactionStats) { // Transaction has been flushed out somehow, we return null. logger.log('[StallTracking] Stall measurements were not added to transaction due to exceeding the max count.'); - this._statsByTransaction.delete(transaction); + this._statsByRootSpan.delete(rootSpan); this._shouldStopTracking(); return; } - const endTimestamp = passedEndTimestamp ?? transaction.endTimestamp; - - const spans = transaction.spanRecorder ? transaction.spanRecorder.spans : []; - const finishedSpanCount = spans.reduce((count, s) => (s !== transaction && s.endTimestamp ? count + 1 : count), 0); - - const trimEnd = transaction.toContext().trimEnd; - const endWillBeTrimmed = trimEnd && finishedSpanCount > 0; - - /* - This is not safe in the case that something changes upstream, but if we're planning to move this over to @sentry/javascript anyways, - we can have this temporarily for now. - */ - const isIdleTransaction = 'activities' in transaction; + // The endTimestamp is always set, but type-wise it's optional + // https://github.com/getsentry/sentry-javascript/blob/38bd57b0785c97c413f36f89ff931d927e469078/packages/core/src/tracing/sentrySpan.ts#L170 + const endTimestamp = spanToJSON(rootSpan).timestamp; let statsOnFinish: StallMeasurements | undefined; - if (endTimestamp && isIdleTransaction) { - /* - There is different behavior regarding child spans in a normal transaction and an idle transaction. In normal transactions, - the child spans that aren't finished will be dumped, while in an idle transaction they're cancelled and finished. - - Note: `endTimestamp` will always be defined if this is called on an idle transaction finish. This is because we only instrument - idle transactions inside `ReactNativeTracing`, which will pass an `endTimestamp`. - */ - - // There will be cancelled spans, which means that the end won't be trimmed - const spansWillBeCancelled = spans.some( - s => s !== transaction && s.startTimestamp < endTimestamp && !s.endTimestamp, - ); + if (isNearToNow(endTimestamp)) { + statsOnFinish = this._getCurrentStats(rootSpan); + } else { + // The idleSpan in JS V8 is always trimmed to the last span's endTimestamp (timestamp). + // The unfinished child spans are removed from the root span after the `spanEnd` event. - if (endWillBeTrimmed && !spansWillBeCancelled) { - // the last span's timestamp will be used. + const latestChildSpanEnd = getLatestChildSpanEndTimestamp(rootSpan); + if (latestChildSpanEnd !== endTimestamp) { + logger.log( + '[StallTracking] Stall measurements not added due to a custom `endTimestamp` (root end is not equal to the latest child span end).', + ); + } - if (transactionStats.atTimestamp) { - statsOnFinish = transactionStats.atTimestamp.stats; - } - } else { - // this endTimestamp will be used. - statsOnFinish = this._getCurrentStats(transaction); + if (!transactionStats.atTimestamp) { + logger.log( + '[StallTracking] Stall measurements not added due to `endTimestamp` not being close to now. And no previous stats from child end were found.', + ); } - } else if (endWillBeTrimmed) { - // If `trimEnd` is used, and there is a span to trim to. If there isn't, then the transaction should use `endTimestamp` or generate one. - if (transactionStats.atTimestamp) { + + if (latestChildSpanEnd === endTimestamp && transactionStats.atTimestamp) { statsOnFinish = transactionStats.atTimestamp.stats; } - } else if (!endTimestamp) { - statsOnFinish = this._getCurrentStats(transaction); } - this._statsByTransaction.delete(transaction); + this._statsByRootSpan.delete(rootSpan); this._shouldStopTracking(); if (!statsOnFinish) { if (typeof endTimestamp !== 'undefined') { - logger.log('[StallTracking] Stall measurements not added due to `endTimestamp` being set.'); - } else if (trimEnd) { logger.log( - '[StallTracking] Stall measurements not added due to `trimEnd` being set but we could not determine the stall measurements at that time.', + '[StallTracking] Stall measurements not added due to `endTimestamp` not being close to now.', + 'endTimestamp', + endTimestamp, + 'now', + timestampInSeconds(), ); } return; } - transaction.setMeasurement( + setSpanMeasurement( + rootSpan, STALL_COUNT, statsOnFinish.stall_count.value - transactionStats.atStart.stall_count.value, transactionStats.atStart.stall_count.unit, ); - transaction.setMeasurement( + setSpanMeasurement( + rootSpan, STALL_TOTAL_TIME, statsOnFinish.stall_total_time.value - transactionStats.atStart.stall_total_time.value, transactionStats.atStart.stall_total_time.unit, ); - transaction.setMeasurement( + setSpanMeasurement( + rootSpan, STALL_LONGEST_TIME, statsOnFinish.stall_longest_time.value, statsOnFinish.stall_longest_time.unit, ); + }; + + /** + * Marks stalls + */ + private _onChildSpanEnd(childSpan: Span): void { + const rootSpan = getRootSpan(childSpan); + + const finalEndTimestamp = spanToJSON(childSpan).timestamp; + if (finalEndTimestamp) { + this._markSpanFinish(rootSpan, finalEndTimestamp); + } } /** @@ -258,27 +231,27 @@ export class StallTrackingInstrumentation { /** * Logs the finish time of the span for use in `trimEnd: true` transactions. */ - private _markSpanFinish(transaction: Transaction, spanEndTimestamp: number): void { - const previousStats = this._statsByTransaction.get(transaction); + private _markSpanFinish(rootSpan: Span, childSpanEndTime: number): void { + const previousStats = this._statsByRootSpan.get(rootSpan); if (previousStats) { - if (Math.abs(timestampInSeconds() - spanEndTimestamp) > MARGIN_OF_ERROR_SECONDS) { + if (Math.abs(timestampInSeconds() - childSpanEndTime) > MARGIN_OF_ERROR_SECONDS) { logger.log( '[StallTracking] Span end not logged due to end timestamp being outside the margin of error from now.', ); - if (previousStats.atTimestamp && previousStats.atTimestamp.timestamp < spanEndTimestamp) { + if (previousStats.atTimestamp && previousStats.atTimestamp.timestamp < childSpanEndTime) { // We also need to delete the stat for the last span, as the transaction would be trimmed to this span not the last one. - this._statsByTransaction.set(transaction, { + this._statsByRootSpan.set(rootSpan, { ...previousStats, atTimestamp: null, }); } } else { - this._statsByTransaction.set(transaction, { + this._statsByRootSpan.set(rootSpan, { ...previousStats, atTimestamp: { - timestamp: spanEndTimestamp, - stats: this._getCurrentStats(transaction), + timestamp: childSpanEndTime, + stats: this._getCurrentStats(rootSpan), }, }); } @@ -288,12 +261,12 @@ export class StallTrackingInstrumentation { /** * Get the current stats for a transaction at a given time. */ - private _getCurrentStats(transaction: Transaction): StallMeasurements { + private _getCurrentStats(span: Span): StallMeasurements { return { stall_count: { value: this._stallCount, unit: 'none' }, stall_total_time: { value: this._totalStallTime, unit: 'millisecond' }, stall_longest_time: { - value: this._statsByTransaction.get(transaction)?.longestStallTime ?? 0, + value: this._statsByRootSpan.get(span)?.longestStallTime ?? 0, unit: 'millisecond', }, }; @@ -329,7 +302,7 @@ export class StallTrackingInstrumentation { * Will stop tracking if there are no more transactions. */ private _shouldStopTracking(): void { - if (this._statsByTransaction.size === 0) { + if (this._statsByRootSpan.size === 0) { this._stopTracking(); } } @@ -341,7 +314,7 @@ export class StallTrackingInstrumentation { this._stallCount = 0; this._totalStallTime = 0; this._lastIntervalMs = 0; - this._statsByTransaction.clear(); + this._statsByRootSpan.clear(); } /** @@ -357,10 +330,10 @@ export class StallTrackingInstrumentation { this._stallCount += 1; this._totalStallTime += stallTime; - for (const [transaction, value] of this._statsByTransaction.entries()) { + for (const [transaction, value] of this._statsByRootSpan.entries()) { const longestStallTime = Math.max(value.longestStallTime ?? 0, stallTime); - this._statsByTransaction.set(transaction, { + this._statsByRootSpan.set(transaction, { ...value, longestStallTime, }); @@ -378,14 +351,14 @@ export class StallTrackingInstrumentation { * Deletes leaked transactions (Earliest transactions when we have more than MAX_RUNNING_TRANSACTIONS transactions.) */ private _flushLeakedTransactions(): void { - if (this._statsByTransaction.size > MAX_RUNNING_TRANSACTIONS) { + if (this._statsByRootSpan.size > MAX_RUNNING_TRANSACTIONS) { let counter = 0; - const len = this._statsByTransaction.size - MAX_RUNNING_TRANSACTIONS; - const transactions = this._statsByTransaction.keys(); + const len = this._statsByRootSpan.size - MAX_RUNNING_TRANSACTIONS; + const transactions = this._statsByRootSpan.keys(); for (const t of transactions) { if (counter >= len) break; counter += 1; - this._statsByTransaction.delete(t); + this._statsByRootSpan.delete(t); } } } diff --git a/src/js/tracing/timetodisplay.tsx b/src/js/tracing/timetodisplay.tsx index 75fc92bedd..06e2a489ac 100644 --- a/src/js/tracing/timetodisplay.tsx +++ b/src/js/tracing/timetodisplay.tsx @@ -1,4 +1,4 @@ -import { getActiveSpan, Span as SpanClass, spanToJSON, startInactiveSpan } from '@sentry/core'; +import { getActiveSpan, getSpanDescendants, SPAN_STATUS_ERROR, SPAN_STATUS_OK, spanToJSON, startInactiveSpan } from '@sentry/core'; import type { Span,StartSpanOptions } from '@sentry/types'; import { fill, logger } from '@sentry/utils'; import * as React from 'react'; @@ -94,12 +94,7 @@ export function startTimeToInitialDisplaySpan( return; } - if (!(activeSpan instanceof SpanClass)) { - logger.warn(`[TimeToDisplay] Active span is not instance of Span class.`); - return; - } - - const existingSpan = activeSpan.spanRecorder?.spans.find((span) => spanToJSON(span).op === 'ui.load.initial_display'); + const existingSpan = getSpanDescendants(activeSpan).find((span) => spanToJSON(span).op === 'ui.load.initial_display'); if (existingSpan) { logger.debug(`[TimeToDisplay] Found existing ui.load.initial_display span.`); return existingSpan @@ -108,7 +103,7 @@ export function startTimeToInitialDisplaySpan( const initialDisplaySpan = startInactiveSpan({ op: 'ui.load.initial_display', name: 'Time To Initial Display', - startTimestamp: spanToJSON(activeSpan).start_timestamp, + startTime: spanToJSON(activeSpan).start_timestamp, ...options, }); @@ -138,12 +133,7 @@ export function startTimeToFullDisplaySpan( return; } - if (!(activeSpan instanceof SpanClass)) { - logger.warn(`[TimeToDisplay] Active span is not instance of Span class.`); - return; - } - - const descendantSpans = activeSpan.spanRecorder?.spans || []; + const descendantSpans = getSpanDescendants(activeSpan); const initialDisplaySpan = descendantSpans.find((span) => spanToJSON(span).op === 'ui.load.initial_display'); if (!initialDisplaySpan) { @@ -160,7 +150,7 @@ export function startTimeToFullDisplaySpan( const fullDisplaySpan = startInactiveSpan({ op: 'ui.load.full_display', name: 'Time To Full Display', - startTimestamp: spanToJSON(initialDisplaySpan).start_timestamp, + startTime: spanToJSON(initialDisplaySpan).start_timestamp, ...options, }); if (!fullDisplaySpan) { @@ -171,13 +161,13 @@ export function startTimeToFullDisplaySpan( if (spanToJSON(fullDisplaySpan).timestamp) { return; } - fullDisplaySpan.setStatus('deadline_exceeded'); + fullDisplaySpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'deadline_exceeded' }); fullDisplaySpan.end(spanToJSON(initialDisplaySpan).timestamp); setSpanDurationAsMeasurement('time_to_full_display', fullDisplaySpan); logger.warn(`[TimeToDisplay] Full display span deadline_exceeded.`); }, options.timeoutMs); - fill(fullDisplaySpan, 'end', (originalEnd: SpanClass['end']) => (endTimestamp?: Parameters[0]) => { + fill(fullDisplaySpan, 'end', (originalEnd: Span['end']) => (endTimestamp?: Parameters[0]) => { clearTimeout(timeout); originalEnd.call(fullDisplaySpan, endTimestamp); }); @@ -219,7 +209,7 @@ function updateInitialDisplaySpan(frameTimestampSeconds: number): void { } span.end(frameTimestampSeconds); - span.setStatus('ok'); + span.setStatus({ code: SPAN_STATUS_OK }); logger.debug(`[TimeToDisplay] ${spanToJSON(span).description} span updated with end timestamp.`); if (fullDisplayBeforeInitialDisplay.has(activeSpan)) { @@ -237,13 +227,8 @@ function updateFullDisplaySpan(frameTimestampSeconds: number, passedInitialDispl return; } - if (!(activeSpan instanceof SpanClass)) { - logger.warn(`[TimeToDisplay] Active span is not instance of Span class.`); - return; - } - const existingInitialDisplaySpan = passedInitialDisplaySpan - || activeSpan.spanRecorder?.spans.find((span) => spanToJSON(span).op === 'ui.load.initial_display'); + || getSpanDescendants(activeSpan).find((span) => spanToJSON(span).op === 'ui.load.initial_display'); const initialDisplayEndTimestamp = existingInitialDisplaySpan && spanToJSON(existingInitialDisplaySpan).timestamp; if (!initialDisplayEndTimestamp) { fullDisplayBeforeInitialDisplay.set(activeSpan, true); @@ -264,7 +249,7 @@ function updateFullDisplaySpan(frameTimestampSeconds: number, passedInitialDispl span.end(frameTimestampSeconds); - span.setStatus('ok'); + span.setStatus({ code: SPAN_STATUS_OK }); logger.debug(`[TimeToDisplay] ${spanToJSON(span).description} span updated with end timestamp.`); setSpanDurationAsMeasurement('time_to_full_display', span); diff --git a/src/js/tracing/transaction.ts b/src/js/tracing/transaction.ts deleted file mode 100644 index a980f86d95..0000000000 --- a/src/js/tracing/transaction.ts +++ /dev/null @@ -1,46 +0,0 @@ -import { type BeforeFinishCallback, type IdleTransaction } from '@sentry/core'; -import { logger } from '@sentry/utils'; -import type { AppStateStatus, NativeEventSubscription } from 'react-native'; -import { AppState } from 'react-native'; - -/** - * Idle Transaction callback to only sample transactions with child spans. - * To avoid side effects of other callbacks this should be hooked as the last callback. - */ -export const onlySampleIfChildSpans: BeforeFinishCallback = (transaction: IdleTransaction): void => { - const spansCount = - transaction.spanRecorder && - transaction.spanRecorder.spans.filter(span => span.spanId !== transaction.spanId).length; - - if (!spansCount || spansCount <= 0) { - logger.log(`Not sampling as ${transaction.op} transaction has no child spans.`); - transaction.sampled = false; - } -}; - -/** - * Hooks on AppState change to cancel the transaction if the app goes background. - */ -export const cancelInBackground = (transaction: IdleTransaction): void => { - if (!AppState || !AppState.isAvailable) { - logger.warn('AppState is not available, spans will not be canceled in background.'); - return; - } - - // RN Web can return undefined, https://github.com/necolas/react-native-web/blob/8cf720f0e57c74a254bfa7bed0313e33a4b29c11/packages/react-native-web/src/exports/AppState/index.js#L55 - const subscription: NativeEventSubscription | undefined = AppState.addEventListener( - 'change', - (newState: AppStateStatus) => { - if (newState === 'background') { - logger.debug(`Setting ${transaction.op} transaction to cancelled because the app is in the background.`); - transaction.setStatus('cancelled'); - transaction.finish(); - } - }, - ); - subscription && - transaction.registerBeforeFinishCallback(() => { - logger.debug(`Removing AppState listener for ${transaction.op} transaction.`); - subscription && subscription.remove && subscription.remove(); - }); -}; diff --git a/src/js/tracing/types.ts b/src/js/tracing/types.ts index 16f9914eb5..94b2359939 100644 --- a/src/js/tracing/types.ts +++ b/src/js/tracing/types.ts @@ -1,4 +1,4 @@ -import type { TransactionContext } from '@sentry/types'; +import type { Span } from '@sentry/types'; export interface ReactNavigationRoute { name: string; @@ -23,12 +23,4 @@ export type RouteChangeContextData = { }; }; -export interface ReactNavigationTransactionContext extends TransactionContext { - tags: { - 'routing.instrumentation': string; - 'routing.route.name': string; - }; - data: RouteChangeContextData; -} - -export type BeforeNavigate = (context: TransactionContext) => TransactionContext; +export type BeforeNavigate = (context: Span) => void; diff --git a/src/js/tracing/utils.ts b/src/js/tracing/utils.ts index de74bfe447..6de7e801ed 100644 --- a/src/js/tracing/utils.ts +++ b/src/js/tracing/utils.ts @@ -1,30 +1,16 @@ import { - type IdleTransaction, - type Span as SpanClass, - type Transaction, + getSpanDescendants, + SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT, + SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE, setMeasurement, spanToJSON, } from '@sentry/core'; -import type { Span, TransactionContext, TransactionSource } from '@sentry/types'; +import type { MeasurementUnit, Span, TransactionSource } from '@sentry/types'; import { timestampInSeconds } from '@sentry/utils'; export const defaultTransactionSource: TransactionSource = 'component'; export const customTransactionSource: TransactionSource = 'custom'; -export const getBlankTransactionContext = (name: string): TransactionContext => { - return { - name: 'Route Change', - op: 'navigation', - tags: { - 'routing.instrumentation': name, - }, - data: {}, - metadata: { - source: defaultTransactionSource, - }, - }; -}; - /** * A margin of error of 50ms is allowed for the async native bridge call. * Anything larger would reduce the accuracy of our frames measurements. @@ -33,22 +19,6 @@ export const MARGIN_OF_ERROR_SECONDS = 0.05; const timeOriginMilliseconds = Date.now(); -/** - * - */ -export function adjustTransactionDuration( - maxDurationMs: number, - transaction: IdleTransaction, - endTimestamp: number, -): void { - const diff = endTimestamp - transaction.startTimestamp; - const isOutdatedTransaction = endTimestamp && (diff > maxDurationMs || diff < 0); - if (isOutdatedTransaction) { - transaction.setStatus('deadline_exceeded'); - transaction.setTag('maxTransactionDurationExceeded', 'true'); - } -} - /** * Returns the timestamp where the JS global scope was initialized. */ @@ -56,45 +26,13 @@ export function getTimeOriginMilliseconds(): number { return timeOriginMilliseconds; } -/** - * Calls the callback every time a child span of the transaction is finished. - */ -export function instrumentChildSpanFinish( - transaction: Transaction, - callback: (span: SpanClass, endTimestamp?: number) => void, -): void { - if (transaction.spanRecorder) { - // eslint-disable-next-line @typescript-eslint/unbound-method - const originalAdd = transaction.spanRecorder.add; - - transaction.spanRecorder.add = (span: SpanClass): void => { - originalAdd.apply(transaction.spanRecorder, [span]); - - // eslint-disable-next-line @typescript-eslint/unbound-method - const originalSpanFinish = span.finish; - - span.finish = (endTimestamp?: number) => { - originalSpanFinish.apply(span, [endTimestamp]); - - callback(span, endTimestamp); - }; - - // eslint-disable-next-line @typescript-eslint/unbound-method - const originalSpanEnd = span.end; - - span.end = (endTimestamp?: number) => { - originalSpanEnd.apply(span, [endTimestamp]); - - callback(span, endTimestamp); - }; - }; - } -} - /** * Determines if the timestamp is now or within the specified margin of error from now. */ -export function isNearToNow(timestamp: number): boolean { +export function isNearToNow(timestamp: number | undefined): boolean { + if (!timestamp) { + return false; + } return Math.abs(timestampInSeconds() - timestamp) <= MARGIN_OF_ERROR_SECONDS; } @@ -111,3 +49,24 @@ export function setSpanDurationAsMeasurement(name: string, span: Span): void { setMeasurement(name, (spanEnd - spanStart) * 1000, 'millisecond'); } + +/** + * Sets measurement on the give span. + */ +export function setSpanMeasurement(span: Span, key: string, value: number, unit: MeasurementUnit): void { + span.addEvent(key, { + [SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE]: value, + [SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT]: unit as string, + }); +} + +/** + * Returns the latest end timestamp of the child spans of the given span. + */ +export function getLatestChildSpanEndTimestamp(span: Span): number | undefined { + const childEndTimestamps = getSpanDescendants(span) + .map(span => spanToJSON(span).timestamp) + .filter(timestamp => !!timestamp) as number[]; + + return childEndTimestamps.length ? Math.max(...childEndTimestamps) : undefined; +} diff --git a/src/js/transports/TextEncoder.ts b/src/js/transports/TextEncoder.ts deleted file mode 100644 index 05206d44a6..0000000000 --- a/src/js/transports/TextEncoder.ts +++ /dev/null @@ -1,14 +0,0 @@ -import type { TextEncoderInternal } from '@sentry/types'; - -import { utf8ToBytes } from '../vendor'; - -export const makeUtf8TextEncoder = (): TextEncoderInternal => { - const textEncoder = { - encode: (text: string) => { - const bytes = new Uint8Array(utf8ToBytes(text)); - return bytes; - }, - encoding: 'utf-8', - }; - return textEncoder; -}; diff --git a/src/js/transports/encodePolyfill.ts b/src/js/transports/encodePolyfill.ts new file mode 100644 index 0000000000..6e84209ed0 --- /dev/null +++ b/src/js/transports/encodePolyfill.ts @@ -0,0 +1,15 @@ +import { RN_GLOBAL_OBJ } from '../utils/worldwide'; +import { utf8ToBytes } from '../vendor'; + +export const useEncodePolyfill = (): void => { + if (!RN_GLOBAL_OBJ.__SENTRY__) { + (RN_GLOBAL_OBJ.__SENTRY__ as Partial<(typeof RN_GLOBAL_OBJ)['__SENTRY__']>) = {}; + } + + RN_GLOBAL_OBJ.__SENTRY__.encodePolyfill = encodePolyfill; +}; + +export const encodePolyfill = (text: string): Uint8Array => { + const bytes = new Uint8Array(utf8ToBytes(text)); + return bytes; +}; diff --git a/src/js/transports/native.ts b/src/js/transports/native.ts index 9ae0e95689..e46d9587e0 100644 --- a/src/js/transports/native.ts +++ b/src/js/transports/native.ts @@ -1,4 +1,4 @@ -import type { BaseTransportOptions, Envelope, Transport } from '@sentry/types'; +import type { BaseTransportOptions, Envelope, Transport, TransportMakeRequestResponse } from '@sentry/types'; import type { PromiseBuffer } from '@sentry/utils'; import { makePromiseBuffer } from '@sentry/utils'; @@ -26,8 +26,9 @@ export class NativeTransport implements Transport { * * @param envelope Envelope that should be sent to Sentry. */ - public send(envelope: Envelope): PromiseLike { - return this._buffer.add(() => NATIVE.sendEnvelope(envelope)); + public send(envelope: Envelope): PromiseLike { + // TODO: We currently can't retrieve the response information from native + return this._buffer.add(() => NATIVE.sendEnvelope(envelope)).then(() => ({})); } /** diff --git a/src/js/utils/span.ts b/src/js/utils/span.ts new file mode 100644 index 0000000000..fd69de0b64 --- /dev/null +++ b/src/js/utils/span.ts @@ -0,0 +1,16 @@ +import { getRootSpan, SentrySpan } from '@sentry/core'; +import type { Span } from '@sentry/types'; + +/** + * + */ +export function isSentrySpan(span: Span): span is SentrySpan { + return span instanceof SentrySpan; +} + +/** + * + */ +export function isRootSpan(span: Span): boolean { + return span === getRootSpan(span); +} diff --git a/src/js/wrapper.ts b/src/js/wrapper.ts index 1d27a9d056..610d5996a1 100644 --- a/src/js/wrapper.ts +++ b/src/js/wrapper.ts @@ -339,7 +339,8 @@ export const NATIVE: SentryNativeWrapper = { let userDataKeys = null; if (user) { const { id, ip_address, email, username, segment, ...otherKeys } = user; - const requiredUser: RequiredKeysUser = { + // TODO: Update native impl to use geo + const requiredUser: Omit = { id, ip_address, email, diff --git a/test/client.test.ts b/test/client.test.ts index d6dfc5241e..be005ea609 100644 --- a/test/client.test.ts +++ b/test/client.test.ts @@ -2,7 +2,7 @@ import * as mockedtimetodisplaynative from './tracing/mockedtimetodisplaynative' jest.mock('../src/js/tracing/timetodisplaynative', () => mockedtimetodisplaynative); import { defaultStackParser } from '@sentry/browser'; -import type { Envelope, Event, MetricInstance, Outcome, Transport } from '@sentry/types'; +import type { Envelope, Event, Outcome, Transport } from '@sentry/types'; import { rejectedSyncPromise, SentryError } from '@sentry/utils'; import * as RN from 'react-native'; @@ -199,25 +199,6 @@ describe('Tests ReactNativeClient', () => { expect(mockTransport.send).not.toBeCalled(); }); - test('captureAggregateMetrics does not call transport when enabled false', () => { - const mockTransport = createMockTransport(); - const client = createDisabledClientWith(mockTransport); - - client.captureAggregateMetrics([ - { - // https://github.com/getsentry/sentry-javascript/blob/a7097d9ba2a74b2cb323da0ef22988a383782ffb/packages/core/test/lib/metrics/aggregator.test.ts#L115 - metric: { _value: 1 } as unknown as MetricInstance, - metricType: 'c', - name: 'requests', - tags: {}, - timestamp: expect.any(Number), - unit: 'none', - }, - ]); - - expect(mockTransport.send).not.toBeCalled(); - }); - function createDisabledClientWith(transport: Transport) { return new ReactNativeClient({ ...DEFAULT_OPTIONS, @@ -241,7 +222,7 @@ describe('Tests ReactNativeClient', () => { }, transport: () => new NativeTransport(), }), - ); + ).init(); }); test('catches errors from onReady callback', () => { @@ -269,7 +250,7 @@ describe('Tests ReactNativeClient', () => { }, transport: () => new NativeTransport(), }), - ); + ).init(); }); test('calls onReady callback with false if Native SDK failed to initialize', done => { @@ -290,7 +271,7 @@ describe('Tests ReactNativeClient', () => { }, transport: () => new NativeTransport(), }), - ); + ).init(); }); }); @@ -645,9 +626,9 @@ describe('Tests ReactNativeClient', () => { ], }), ); - client.setupIntegrations(); + client.init(); - expect(client.getIntegrationById('MockRoutingInstrumentation')).toBeTruthy(); + expect(client.getIntegrationByName('MockRoutingInstrumentation')).toBeTruthy(); }); }); @@ -663,9 +644,9 @@ describe('Tests ReactNativeClient', () => { ], }), ); - client.setupIntegrations(); + client.init(); - expect(client.getIntegrationById('ReactNativeUserInteractionTracing')).toBeTruthy(); + expect(client.getIntegrationByName('ReactNativeUserInteractionTracing')).toBeTruthy(); }); test('do not register user interactions tracing', () => { @@ -679,9 +660,9 @@ describe('Tests ReactNativeClient', () => { ], }), ); - client.setupIntegrations(); + client.init(); - expect(client.getIntegrationById('ReactNativeUserInteractionTracing')).toBeUndefined(); + expect(client.getIntegrationByName('ReactNativeUserInteractionTracing')).toBeUndefined(); }); }); }); diff --git a/test/e2e/src/EndToEndTests.tsx b/test/e2e/src/EndToEndTests.tsx index 813c71619b..ef348e6d38 100644 --- a/test/e2e/src/EndToEndTests.tsx +++ b/test/e2e/src/EndToEndTests.tsx @@ -18,7 +18,7 @@ const EndToEndTestsScreen = (): JSX.Element => { // !!! WARNING: This is only for testing purposes. // We only do this to render the eventId onto the UI for end to end tests. React.useEffect(() => { - const client: Sentry.ReactNativeClient | undefined = Sentry.getCurrentHub().getClient(); + const client: Sentry.ReactNativeClient | undefined = Sentry.getClient(); client.getOptions().beforeSend = (e: Sentry.Event) => { setEventId(e.event_id || null); return e; diff --git a/test/integrations/integrationsexecutionorder.test.ts b/test/integrations/integrationsexecutionorder.test.ts index bd003eae7a..a81b57a5cd 100644 --- a/test/integrations/integrationsexecutionorder.test.ts +++ b/test/integrations/integrationsexecutionorder.test.ts @@ -28,7 +28,7 @@ describe('Integration execution order', () => { const nativeLinkedErrors = spyOnIntegrationById('NativeLinkedErrors', integrations); const rewriteFrames = spyOnIntegrationById('RewriteFrames', integrations); - client.setupIntegrations(); + client.init(); client.captureException(new Error('test')); await client.flush(); @@ -53,7 +53,7 @@ describe('Integration execution order', () => { const linkedErrors = spyOnIntegrationById('LinkedErrors', integrations); const rewriteFrames = spyOnIntegrationById('RewriteFrames', integrations); - client.setupIntegrations(); + client.init(); client.captureException(new Error('test')); await client.flush(); @@ -76,7 +76,7 @@ function spyOnIntegrationById(id: string, integrations: Integration[]): Integrat throw new Error(`Integration ${id} not found`); } - jest.spyOn(candidate, 'setupOnce'); + candidate.setupOnce && jest.spyOn(candidate, 'setupOnce'); candidate.preprocessEvent && jest.spyOn(candidate, 'preprocessEvent'); candidate.processEvent && jest.spyOn(candidate, 'processEvent'); return candidate as IntegrationSpy; diff --git a/test/integrations/spotlight.test.ts b/test/integrations/spotlight.test.ts index 8c3f0c27a2..13bdfaf6c9 100644 --- a/test/integrations/spotlight.test.ts +++ b/test/integrations/spotlight.test.ts @@ -3,7 +3,7 @@ import { XMLHttpRequestInterceptor } from '@mswjs/interceptors/XMLHttpRequest'; import type { Client, Envelope } from '@sentry/types'; import { XMLHttpRequest } from 'xmlhttprequest'; -import { Spotlight } from '../../src/js/integrations/spotlight'; +import { spotlightIntegration } from '../../src/js/integrations/spotlight'; globalThis.XMLHttpRequest = XMLHttpRequest; const requestListener = jest.fn(); @@ -22,7 +22,7 @@ describe('spotlight', () => { it('should not change the original envelope', () => { const mockClient = createMockClient(); - const spotlight = Spotlight(); + const spotlight = spotlightIntegration(); spotlight.setup?.(mockClient as unknown as Client); const spotlightBeforeEnvelope = mockClient.on.mock.calls[0]?.[1] as ((envelope: Envelope) => void) | undefined; @@ -37,7 +37,7 @@ describe('spotlight', () => { it('should remove image attachments from spotlight envelope', async () => { const mockClient = createMockClient(); - const spotlight = Spotlight(); + const spotlight = spotlightIntegration(); spotlight.setup?.(mockClient as unknown as Client); const spotlightBeforeEnvelope = mockClient.on.mock.calls[0]?.[1] as ((envelope: Envelope) => void) | undefined; diff --git a/test/mocks/client.ts b/test/mocks/client.ts index 70864fe1f3..b8976a41fa 100644 --- a/test/mocks/client.ts +++ b/test/mocks/client.ts @@ -19,8 +19,6 @@ import type { } from '@sentry/types'; import { resolvedSyncPromise } from '@sentry/utils'; -import { _addTracingExtensions } from '../../src/js/tracing/addTracingExtensions'; - export function getDefaultTestClientOptions(options: Partial = {}): TestClientOptions { return { dsn: 'https://1234@some-domain.com/4505526893805568', @@ -115,8 +113,6 @@ export function init(options: TestClientOptions): void { } export function setupTestClient(options: Partial = {}): TestClient { - _addTracingExtensions(); - getCurrentScope().clear(); getIsolationScope().clear(); getGlobalScope().clear(); diff --git a/test/profiling/integration.test.ts b/test/profiling/integration.test.ts index b9acc58c3d..1488c7d4fc 100644 --- a/test/profiling/integration.test.ts +++ b/test/profiling/integration.test.ts @@ -3,8 +3,8 @@ jest.mock('../../src/js/wrapper', () => mockWrapper); jest.mock('../../src/js/utils/environment'); jest.mock('../../src/js/profiling/debugid'); -import { getCurrentHub } from '@sentry/core'; -import type { Envelope, Event, Profile, ThreadCpuProfile, Transaction, Transport } from '@sentry/types'; +import { getClient, spanToJSON } from '@sentry/core'; +import type { Envelope, Event, Integration, Profile, Span, ThreadCpuProfile, Transport } from '@sentry/types'; import * as Sentry from '../../src/js'; import type { NativeDeviceContextsResponse } from '../../src/js/NativeRNSentry'; @@ -12,7 +12,6 @@ import { getDebugMetadata } from '../../src/js/profiling/debugid'; import { hermesProfilingIntegration } from '../../src/js/profiling/integration'; import type { AndroidProfileEvent } from '../../src/js/profiling/types'; import { getDefaultEnvironment, isHermesEnabled, notWeb } from '../../src/js/utils/environment'; -import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { MOCK_DSN } from '../mockDsn'; import { envelopeItemPayload, envelopeItems } from '../testutils'; import { @@ -48,7 +47,6 @@ describe('profiling integration', () => { afterEach(async () => { jest.runAllTimers(); jest.useRealTimers(); - RN_GLOBAL_OBJ.__SENTRY__.globalEventProcessors = []; // resets integrations await Sentry.close(); }); @@ -57,17 +55,24 @@ describe('profiling integration', () => { jest.runAllTimers(); jest.clearAllMocks(); - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - getCurrentHub().getScope()?.setSpan(transaction); - - getCurrentHub().getClient()?.addIntegration?.(hermesProfilingIntegration()); + const transaction = Sentry.startSpanManual( + { + name: 'test-name', + }, + (span: Span) => { + addIntegrationAndForceSetupOnce(hermesProfilingIntegration()); + return span; + }, + ); - transaction.finish(); + transaction.end(); jest.runAllTimers(); - expectEnvelopeToContainProfile(mock.transportSendMock.mock.lastCall?.[0], 'test-name', transaction.traceId); + expectEnvelopeToContainProfile( + mock.transportSendMock.mock.lastCall?.[0], + 'test-name', + spanToJSON(transaction).trace_id, + ); }); describe('environment', () => { @@ -99,10 +104,7 @@ describe('profiling integration', () => { test('should use default environment for transaction and profile', () => { mock = initTestClient(); - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - transaction.finish(); + Sentry.startSpan({ name: 'test-name' }, () => {}); jest.runAllTimers(); @@ -114,10 +116,7 @@ describe('profiling integration', () => { test('should use native environment for transaction and profile if user value is nullish', () => { mock = initTestClient({ withProfiling: true, environment: '' }); - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - transaction.finish(); + Sentry.startSpan({ name: 'test-name' }, () => {}); jest.runAllTimers(); @@ -132,10 +131,7 @@ describe('profiling integration', () => { }); mock = initTestClient({ withProfiling: true, environment: undefined }); - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - transaction.finish(); + Sentry.startSpan({ name: 'test-name' }, () => {}); jest.runAllTimers(); @@ -147,10 +143,7 @@ describe('profiling integration', () => { test('should keep custom environment for transaction and profile', () => { mock = initTestClient({ withProfiling: true, environment: 'custom' }); - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - transaction.finish(); + Sentry.startSpan({ name: 'test-name' }, () => {}); jest.runAllTimers(); @@ -174,15 +167,12 @@ describe('profiling integration', () => { nativeProfile: createMockMinimalValidAppleProfile(), }); - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - transaction.finish(); + const transaction = Sentry.startSpan({ name: 'test-name' }, span => span); jest.runAllTimers(); const envelope: Envelope | undefined = mock.transportSendMock.mock.lastCall?.[0]; - expectEnvelopeToContainProfile(envelope, 'test-name', transaction.traceId); + expectEnvelopeToContainProfile(envelope, 'test-name', spanToJSON(transaction).trace_id); // Expect merged profile expect(getProfileFromEnvelope(envelope)).toEqual( expect.objectContaining(>{ @@ -228,15 +218,12 @@ describe('profiling integration', () => { androidProfile: createMockMinimalValidAndroidProfile(), }); - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - transaction.finish(); + const transaction = Sentry.startSpan({ name: 'test-name' }, span => span); jest.runAllTimers(); const envelope: Envelope | undefined = mock.transportSendMock.mock.lastCall?.[0]; - expectEnvelopeToContainAndroidProfile(envelope, 'test-name', transaction.traceId); + expectEnvelopeToContainAndroidProfile(envelope, 'test-name', spanToJSON(transaction).trace_id); // Expect merged profile expect(getProfileFromEnvelope(envelope)).toEqual( expect.objectContaining(>{ @@ -266,37 +253,39 @@ describe('profiling integration', () => { }); test('should create a new profile and add in to the transaction envelope', () => { - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - transaction.finish(); + const transaction = Sentry.startSpan({ name: 'test-name' }, span => span); jest.runAllTimers(); - expectEnvelopeToContainProfile(mock.transportSendMock.mock.lastCall?.[0], 'test-name', transaction.traceId); + expectEnvelopeToContainProfile( + mock.transportSendMock.mock.lastCall?.[0], + 'test-name', + spanToJSON(transaction).trace_id, + ); }); test('should finish previous profile when a new transaction starts', () => { - const transaction1: Transaction = Sentry.startTransaction({ - name: 'test-name-1', - }); - const transaction2: Transaction = Sentry.startTransaction({ - name: 'test-name-2', - }); - transaction1.finish(); - transaction2.finish(); + const transaction1 = Sentry.startSpanManual({ name: 'test-name-1' }, span => span); + const transaction2 = Sentry.startSpanManual({ name: 'test-name-2' }, span => span); + transaction1.end(); + transaction2.end(); jest.runAllTimers(); - expectEnvelopeToContainProfile(mock.transportSendMock.mock.calls[0][0], 'test-name-1', transaction1.traceId); - expectEnvelopeToContainProfile(mock.transportSendMock.mock.calls[1][0], 'test-name-2', transaction2.traceId); + expectEnvelopeToContainProfile( + mock.transportSendMock.mock.calls[0][0], + 'test-name-1', + spanToJSON(transaction1).trace_id, + ); + expectEnvelopeToContainProfile( + mock.transportSendMock.mock.calls[1][0], + 'test-name-2', + spanToJSON(transaction2).trace_id, + ); }); test('profile should start at the same time as transaction', () => { - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - transaction.finish(); + Sentry.startSpan({ name: 'test-name' }, () => {}); jest.runAllTimers(); @@ -309,46 +298,30 @@ describe('profiling integration', () => { }); test('profile is only recorded until max duration is reached', () => { - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); + const transaction = Sentry.startSpanManual({ name: 'test-name' }, span => span); jest.clearAllMocks(); jest.advanceTimersByTime(40 * 1e6); expect(mockWrapper.NATIVE.stopProfiling.mock.calls.length).toEqual(1); - transaction.finish(); + transaction.end(); }); test('profile that reached max duration is sent', () => { - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); + const transaction = Sentry.startSpanManual({ name: 'test-name' }, span => span); jest.advanceTimersByTime(40 * 1e6); - transaction.finish(); + transaction.end(); jest.runAllTimers(); - expectEnvelopeToContainProfile(mock.transportSendMock.mock.lastCall?.[0], 'test-name', transaction.traceId); - }); - - test('profile timeout is reset when transaction is finished', () => { - const setTimeoutSpy = jest.spyOn(global, 'setTimeout'); - const clearTimeoutSpy = jest.spyOn(global, 'clearTimeout'); - const transaction: Transaction = Sentry.startTransaction({ - name: 'test-name', - }); - const timeoutAfterProfileStarted = setTimeoutSpy.mock.results[0].value; - - jest.advanceTimersByTime(40 * 1e6); - - transaction.finish(); - expect(clearTimeoutSpy).toBeCalledWith(timeoutAfterProfileStarted); - - jest.runAllTimers(); + expectEnvelopeToContainProfile( + mock.transportSendMock.mock.lastCall?.[0], + 'test-name', + spanToJSON(transaction).trace_id, + ); }); }); }); @@ -377,7 +350,7 @@ function initTestClient( return integrations; }, transport: () => ({ - send: transportSendMock.mockResolvedValue(undefined), + send: transportSendMock.mockResolvedValue({}), flush: jest.fn().mockResolvedValue(true), }), }; @@ -387,10 +360,10 @@ function initTestClient( Sentry.init(options); // In production integrations are setup only once, but in the tests we want them to setup on every init - const integrations = Sentry.getCurrentHub().getClient()?.getOptions().integrations; + const integrations = getClient()?.getOptions().integrations; if (integrations) { for (const integration of integrations) { - integration.setupOnce(Sentry.addGlobalEventProcessor, Sentry.getCurrentHub); + integration.setupOnce?.(); } } @@ -440,3 +413,13 @@ function expectEnvelopeToContainAndroidProfile( function getProfileFromEnvelope(envelope: Envelope | undefined): Profile | undefined { return envelope?.[envelopeItems]?.[1]?.[1] as unknown as Profile; } + +function addIntegrationAndForceSetupOnce(integration: Integration): void { + const client = Sentry.getClient(); + if (!client) { + throw new Error('Client is not initialized'); + } + + client.addIntegration(integration); + integration.setupOnce && integration.setupOnce(); +} diff --git a/test/sdk.test.ts b/test/sdk.test.ts index 00a3d893dd..203babf2dd 100644 --- a/test/sdk.test.ts +++ b/test/sdk.test.ts @@ -571,7 +571,7 @@ describe('Tests the SDK functionality', () => { expect(actualIntegrations).toEqual( expect.arrayContaining([ - expect.objectContaining({ name: 'TryCatch' }), + expect.objectContaining({ name: 'BrowserApiErrors' }), expect.objectContaining({ name: 'GlobalHandlers' }), expect.objectContaining({ name: 'LinkedErrors' }), ]), diff --git a/test/sdk.withclient.test.ts b/test/sdk.withclient.test.ts index 654b5294e1..1ed8c1c309 100644 --- a/test/sdk.withclient.test.ts +++ b/test/sdk.withclient.test.ts @@ -3,7 +3,7 @@ jest.spyOn(logger, 'error'); import { setCurrentClient } from '@sentry/core'; import { logger } from '@sentry/utils'; -import { configureScope, flush } from '../src/js/sdk'; +import { flush } from '../src/js/sdk'; import { getDefaultTestClientOptions, TestClient } from './mocks/client'; describe('Tests the SDK functionality', () => { @@ -35,15 +35,4 @@ describe('Tests the SDK functionality', () => { expect(logger.error).toBeCalledWith('Failed to flush the event queue.'); }); }); - - describe('configureScope', () => { - test('configureScope callback does not throw', () => { - const mockScopeCallback = jest.fn(() => { - throw 'Test error'; - }); - - expect(() => configureScope(mockScopeCallback)).not.toThrow(); - expect(mockScopeCallback).toBeCalledTimes(1); - }); - }); }); diff --git a/test/testutils.ts b/test/testutils.ts index c5417d0032..e73b64a688 100644 --- a/test/testutils.ts +++ b/test/testutils.ts @@ -1,5 +1,5 @@ import { Transaction } from '@sentry/core'; -import type { Measurements, Session, Transport, UserFeedback } from '@sentry/types'; +import type { Session, Transport, UserFeedback } from '@sentry/types'; import { rejectedSyncPromise } from '@sentry/utils'; import { getBlankTransactionContext } from '../src/js/tracing/utils'; @@ -81,7 +81,3 @@ export const secondAgoTimestampMs = (): number => { export const secondInFutureTimestampMs = (): number => { return new Date(Date.now() + 1000).getTime(); }; - -export const asObjectWithMeasurements = (span: unknown): { _measurements?: Measurements } => { - return span as { _measurements?: Measurements }; -}; diff --git a/test/tracing/addTracingExtensions.test.ts b/test/tracing/addTracingExtensions.test.ts index 849260af55..bdc60b5578 100644 --- a/test/tracing/addTracingExtensions.test.ts +++ b/test/tracing/addTracingExtensions.test.ts @@ -33,7 +33,6 @@ describe('Tracing extensions', () => { }); test('transaction start span creates default op', async () => { - // TODO: add event listener to spanStart and add default op if not set startSpanManual({ name: 'parent', scope: getCurrentScope() }, () => {}); const span = startSpanManual({ name: 'child', scope: getCurrentScope() }, span => span); diff --git a/test/tracing/gesturetracing.test.ts b/test/tracing/gesturetracing.test.ts index e939b25945..e7d00a7de7 100644 --- a/test/tracing/gesturetracing.test.ts +++ b/test/tracing/gesturetracing.test.ts @@ -1,4 +1,4 @@ -import { addGlobalEventProcessor, getActiveSpan, getCurrentHub, spanToJSON, startSpan } from '@sentry/core'; +import { getActiveSpan, spanToJSON, startSpan } from '@sentry/core'; import type { Breadcrumb } from '@sentry/types'; import { UI_ACTION } from '../../src/js/tracing'; @@ -62,15 +62,7 @@ describe('GestureTracing', () => { enableUserInteractionTracing: true, }); client.addIntegration(tracing); - tracing.setupOnce(addGlobalEventProcessor, getCurrentHub); - mockedRoutingInstrumentation.registeredOnConfirmRoute!({ - name: 'mockedScreenName', - data: { - route: { - name: 'mockedScreenName', - }, - }, - }); + mockedRoutingInstrumentation.registeredOnConfirmRoute!('mockedScreenName'); mockedGesture = { handlers: { onBegin: jest.fn(), @@ -85,7 +77,7 @@ describe('GestureTracing', () => { jest.useRealTimers(); }); - it('gesture creates interaction transaction', async () => { + it('gesture creates interaction transaction', () => { sentryTraceGesture('mockedGesture', mockedGesture); mockedGesture.handlers!.onBegin!(); const transaction = getActiveSpan(); @@ -122,7 +114,7 @@ describe('GestureTracing', () => { sentryTraceGesture('mockedGesture', mockedGesture); const mockedTouchInteractionId = { elementId: 'mockedElementId', op: 'mocked.op' }; - tracing.startUserInteractionTransaction(mockedTouchInteractionId); + tracing.startUserInteractionSpan(mockedTouchInteractionId); startChildSpan(); await jest.advanceTimersByTimeAsync(timeoutCloseToActualIdleTimeoutMs); diff --git a/test/tracing/nativeframes.test.ts b/test/tracing/nativeframes.test.ts index 821e92d94e..86d5287a75 100644 --- a/test/tracing/nativeframes.test.ts +++ b/test/tracing/nativeframes.test.ts @@ -1,16 +1,7 @@ -import { - addGlobalEventProcessor, - getCurrentHub, - getCurrentScope, - getGlobalScope, - getIsolationScope, - setCurrentClient, - startSpan, -} from '@sentry/core'; +import { getCurrentScope, getGlobalScope, getIsolationScope, setCurrentClient, startSpan } from '@sentry/core'; import type { Event, Measurements } from '@sentry/types'; import { ReactNativeTracing } from '../../src/js'; -import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { NATIVE } from '../../src/js/wrapper'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; import { mockFunction } from '../testutils'; @@ -18,7 +9,7 @@ import { mockFunction } from '../testutils'; jest.mock('../../src/js/wrapper', () => { return { NATIVE: { - fetchNativeFrames: jest.fn().mockResolvedValue(null), + fetchNativeFrames: jest.fn(), disableNativeFramesTracking: jest.fn(), enableNative: true, enableNativeFramesTracking: jest.fn(), @@ -35,23 +26,18 @@ describe('NativeFramesInstrumentation', () => { getCurrentScope().clear(); getIsolationScope().clear(); getGlobalScope().clear(); - RN_GLOBAL_OBJ.__SENTRY__.globalEventProcessors = []; // resets integrations - const integration = new ReactNativeTracing({ - enableNativeFramesTracking: true, - }); const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, - integrations: [integration], + integrations: [ + new ReactNativeTracing({ + enableNativeFramesTracking: true, + }), + ], }); client = new TestClient(options); setCurrentClient(client); client.init(); - addGlobalEventProcessor(async event => { - await wait(10); - return event; - }); - integration.setupOnce(addGlobalEventProcessor, getCurrentHub); }); afterEach(() => { @@ -184,9 +170,3 @@ describe('NativeFramesInstrumentation', () => { ); }); }); - -function wait(ms) { - return new Promise(resolve => { - setTimeout(resolve, ms); - }); -} diff --git a/test/tracing/reactnativenavigation.test.ts b/test/tracing/reactnativenavigation.test.ts index 8bdd65e770..b12e86a170 100644 --- a/test/tracing/reactnativenavigation.test.ts +++ b/test/tracing/reactnativenavigation.test.ts @@ -1,15 +1,9 @@ /* eslint-disable @typescript-eslint/no-empty-function */ import { - addGlobalEventProcessor, getActiveSpan, - getCurrentHub, getCurrentScope, getGlobalScope, getIsolationScope, - SEMANTIC_ATTRIBUTE_SENTRY_OP, - SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, - SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, - SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, setCurrentClient, spanToJSON, } from '@sentry/core'; @@ -23,8 +17,21 @@ import type { EventsRegistry, } from '../../src/js/tracing/reactnativenavigation'; import { ReactNativeNavigationInstrumentation } from '../../src/js/tracing/reactnativenavigation'; +import { + SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_COMPONENT_ID, + SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_COMPONENT_TYPE, + SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_NAME, + SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_ID, + SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_TYPE, + SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN, + SEMANTIC_ATTRIBUTE_ROUTE_NAME, + SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON, + SEMANTIC_ATTRIBUTE_SENTRY_OP, + SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, + SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, + SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, +} from '../../src/js/tracing/semanticAttributes'; import type { BeforeNavigate } from '../../src/js/tracing/types'; -import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; interface MockEventsRegistry extends EventsRegistry { @@ -46,7 +53,6 @@ describe('React Native Navigation Instrumentation', () => { getCurrentScope().clear(); getIsolationScope().clear(); getGlobalScope().clear(); - RN_GLOBAL_OBJ.__SENTRY__.globalEventProcessors = []; // resets integrations }); test('Correctly instruments a route change', async () => { @@ -72,19 +78,15 @@ describe('React Native Navigation Instrumentation', () => { contexts: expect.objectContaining({ trace: expect.objectContaining({ data: { - route: { - name: 'Test', - componentName: 'Test', - componentId: '0', - componentType: 'Component', - hasBeenSeen: false, - passProps: {}, - }, - previousRoute: null, + [SEMANTIC_ATTRIBUTE_ROUTE_NAME]: 'Test', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_ID]: '0', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_TYPE]: 'Component', + [SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN]: false, [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual', [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1, + [SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: 'idleTimeout', }, }), }), @@ -95,8 +97,7 @@ describe('React Native Navigation Instrumentation', () => { test('Transaction context is changed with beforeNavigate', async () => { setupTestClient({ beforeNavigate: span => { - span.name = 'New Name'; - return span; + span.updateName('New Name'); }, }); @@ -120,19 +121,15 @@ describe('React Native Navigation Instrumentation', () => { contexts: expect.objectContaining({ trace: expect.objectContaining({ data: { - route: { - name: 'Test', - componentName: 'Test', - componentId: '0', - componentType: 'Component', - hasBeenSeen: false, - passProps: {}, - }, - previousRoute: null, + [SEMANTIC_ATTRIBUTE_ROUTE_NAME]: 'Test', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_ID]: '0', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_TYPE]: 'Component', + [SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN]: false, [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual', - [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom', + [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1, + [SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: 'idleTimeout', }, }), }), @@ -199,19 +196,15 @@ describe('React Native Navigation Instrumentation', () => { contexts: expect.objectContaining({ trace: expect.objectContaining({ data: { - route: { - name: 'TestScreenName', - componentName: 'TestScreenName', - componentId: '0', - componentType: 'Component', - hasBeenSeen: false, - passProps: {}, - }, - previousRoute: null, + [SEMANTIC_ATTRIBUTE_ROUTE_NAME]: 'TestScreenName', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_ID]: '0', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_TYPE]: 'Component', + [SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN]: false, [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual', [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1, + [SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: 'idleTimeout', }, }), }), @@ -288,25 +281,18 @@ describe('React Native Navigation Instrumentation', () => { contexts: expect.objectContaining({ trace: expect.objectContaining({ data: { - route: { - name: 'Test 2', - componentName: 'Test 2', - componentId: '2', - componentType: 'Component', - hasBeenSeen: false, - passProps: {}, - }, - previousRoute: { - name: 'Test 1', - componentName: 'Test 1', - componentId: '1', - componentType: 'Component', - passProps: {}, - }, + [SEMANTIC_ATTRIBUTE_ROUTE_NAME]: 'Test 2', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_ID]: '2', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_TYPE]: 'Component', + [SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN]: false, + [SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_NAME]: 'Test 1', + [SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_COMPONENT_ID]: '1', + [SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_COMPONENT_TYPE]: 'Component', [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual', [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1, + [SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: 'idleTimeout', }, }), }), @@ -346,19 +332,15 @@ describe('React Native Navigation Instrumentation', () => { contexts: expect.objectContaining({ trace: expect.objectContaining({ data: { - route: { - name: 'Test 1', - componentName: 'Test 1', - componentId: '1', - componentType: 'Component', - hasBeenSeen: false, - passProps: {}, - }, - previousRoute: null, + [SEMANTIC_ATTRIBUTE_ROUTE_NAME]: 'Test 1', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_ID]: '1', + [SEMANTIC_ATTRIBUTE_ROUTE_COMPONENT_TYPE]: 'Component', + [SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN]: false, [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual', [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1, + [SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: 'idleTimeout', }, }), }), @@ -391,7 +373,7 @@ describe('React Native Navigation Instrumentation', () => { enableStallTracking: false, enableNativeFramesTracking: false, enableAppStartTracking: false, - beforeNavigate: setupOptions.beforeNavigate || (span => span), + beforeNavigate: setupOptions.beforeNavigate, }); const options = getDefaultTestClientOptions({ @@ -401,8 +383,6 @@ describe('React Native Navigation Instrumentation', () => { client = new TestClient(options); setCurrentClient(client); client.init(); - - rnTracing.setupOnce(addGlobalEventProcessor, getCurrentHub); } function createMockNavigation() { diff --git a/test/tracing/reactnativetracing.test.ts b/test/tracing/reactnativetracing.test.ts index ff1dfd9b6a..039b53cc22 100644 --- a/test/tracing/reactnativetracing.test.ts +++ b/test/tracing/reactnativetracing.test.ts @@ -1,6 +1,6 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ import * as SentryBrowser from '@sentry/browser'; -import type { Event } from '@sentry/types'; +import type { Event, Span } from '@sentry/types'; import type { NativeAppStartResponse } from '../../src/js/NativeRNSentry'; import { RoutingInstrumentation } from '../../src/js/tracing/routingInstrumentation'; @@ -49,8 +49,8 @@ const mockedAppState: AppState & MockAppState = { }; jest.mock('react-native/Libraries/AppState/AppState', () => mockedAppState); -import { getActiveSpan, startSpanManual } from '@sentry/browser'; -import { addGlobalEventProcessor, getCurrentHub, getCurrentScope, spanToJSON, startInactiveSpan } from '@sentry/core'; +import { getActiveSpan, spanToJSON, startSpanManual } from '@sentry/browser'; +import { getCurrentScope, SPAN_STATUS_ERROR, startInactiveSpan } from '@sentry/core'; import type { AppState, AppStateStatus } from 'react-native'; import { APP_START_COLD, APP_START_WARM } from '../../src/js/measurements'; @@ -62,7 +62,6 @@ import { import { APP_START_WARM as APP_SPAN_START_WARM } from '../../src/js/tracing/ops'; import { ReactNativeTracing } from '../../src/js/tracing/reactnativetracing'; import { getTimeOriginMilliseconds } from '../../src/js/tracing/utils'; -import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { NATIVE } from '../../src/js/wrapper'; import type { TestClient } from '../mocks/client'; import { setupTestClient } from '../mocks/client'; @@ -74,7 +73,7 @@ const DEFAULT_IDLE_TIMEOUT = 1000; describe('ReactNativeTracing', () => { beforeEach(() => { - jest.useFakeTimers({ advanceTimers: true }); + jest.useFakeTimers(); NATIVE.enableNative = true; mockedAppState.isAvailable = true; mockedAppState.addEventListener = (_, listener) => { @@ -89,22 +88,20 @@ describe('ReactNativeTracing', () => { jest.runOnlyPendingTimers(); jest.useRealTimers(); jest.clearAllMocks(); - RN_GLOBAL_OBJ.__SENTRY__.globalEventProcessors = []; // resets integrations }); describe('trace propagation targets', () => { it('uses tracePropagationTargets', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); - const integration = new ReactNativeTracing({ - enableStallTracking: false, - tracePropagationTargets: ['test1', 'test2'], - }); setupTestClient({ - integrations: [integration], + integrations: [ + new ReactNativeTracing({ + enableStallTracking: false, + tracePropagationTargets: ['test1', 'test2'], + }), + ], }); - setup(integration); - expect(instrumentOutgoingRequests).toBeCalledWith( expect.objectContaining({ tracePropagationTargets: ['test1', 'test2'], @@ -114,14 +111,11 @@ describe('ReactNativeTracing', () => { it('uses tracePropagationTargets from client options', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); - const integration = new ReactNativeTracing({ enableStallTracking: false }); setupTestClient({ tracePropagationTargets: ['test1', 'test2'], - integrations: [integration], + integrations: [new ReactNativeTracing({ enableStallTracking: false })], }); - setup(integration); - expect(instrumentOutgoingRequests).toBeCalledWith( expect.objectContaining({ tracePropagationTargets: ['test1', 'test2'], @@ -131,13 +125,10 @@ describe('ReactNativeTracing', () => { it('uses defaults', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); - const integration = new ReactNativeTracing({ enableStallTracking: false }); setupTestClient({ - integrations: [integration], + integrations: [new ReactNativeTracing({ enableStallTracking: false })], }); - setup(integration); - expect(instrumentOutgoingRequests).toBeCalledWith( expect.objectContaining({ tracePropagationTargets: ['localhost', /^\/(?!\/)/], @@ -147,17 +138,16 @@ describe('ReactNativeTracing', () => { it('client tracePropagationTargets takes priority over integration options', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); - const integration = new ReactNativeTracing({ - enableStallTracking: false, - tracePropagationTargets: ['test3', 'test4'], - }); setupTestClient({ tracePropagationTargets: ['test1', 'test2'], - integrations: [integration], + integrations: [ + new ReactNativeTracing({ + enableStallTracking: false, + tracePropagationTargets: ['test3', 'test4'], + }), + ], }); - setup(integration); - expect(instrumentOutgoingRequests).toBeCalledWith( expect.objectContaining({ tracePropagationTargets: ['test1', 'test2'], @@ -181,7 +171,7 @@ describe('ReactNativeTracing', () => { const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStartResponse({ cold: true }); - setup(integration); + integration.setup(client); integration.onAppStartFinish(Date.now() / 1000); await jest.advanceTimersByTimeAsync(500); @@ -204,7 +194,7 @@ describe('ReactNativeTracing', () => { const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStartResponse({ cold: false }); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); await jest.runOnlyPendingTimersAsync(); @@ -226,13 +216,12 @@ describe('ReactNativeTracing', () => { mockAppStartResponse({ cold: false }); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); mockedAppState.setState('background'); - await jest.runAllTimersAsync(); - await client.flush(); + jest.runAllTimers(); const transaction = client.event; expect(transaction?.contexts?.trace?.status).toBe('cancelled'); @@ -245,20 +234,16 @@ describe('ReactNativeTracing', () => { return undefined; }) as unknown as (typeof mockedAppState)['addEventListener']; // RN Web can return undefined - const integration = new ReactNativeTracing(); setupTestClient({ - integrations: [integration], + integrations: [new ReactNativeTracing()], }); mockAppStartResponse({ cold: false }); - setup(integration); - await jest.advanceTimersByTimeAsync(500); const transaction = getActiveSpan(); - await jest.runAllTimersAsync(); - await client.flush(); + jest.runAllTimers(); expect(spanToJSON(transaction!).timestamp).toBeDefined(); }); @@ -277,7 +262,7 @@ describe('ReactNativeTracing', () => { mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds); mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); await jest.runOnlyPendingTimersAsync(); @@ -303,7 +288,7 @@ describe('ReactNativeTracing', () => { mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds); mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); await jest.runOnlyPendingTimersAsync(); @@ -320,7 +305,7 @@ describe('ReactNativeTracing', () => { mockAppStartResponse({ cold: false, didFetchAppStart: true }); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); await jest.runOnlyPendingTimersAsync(); @@ -339,7 +324,7 @@ describe('ReactNativeTracing', () => { mockAppStartResponse({ cold: true }); - setup(integration); + integration.setup(client); // wait for internal promises to resolve, fetch app start data from mocked native await Promise.resolve(); @@ -364,14 +349,14 @@ describe('ReactNativeTracing', () => { const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStartResponse({ cold: true }); - setup(integration); + integration.setup(client); // wait for internal promises to resolve, fetch app start data from mocked native await Promise.resolve(); expect(getActiveSpan()).toBeUndefined(); routingInstrumentation.onRouteWillChange({ - name: 'Route Change', + name: 'test', }); expect(getActiveSpan()).toBeDefined(); @@ -379,8 +364,7 @@ describe('ReactNativeTracing', () => { // trigger idle transaction to finish and call before finish callbacks jest.advanceTimersByTime(DEFAULT_IDLE_TIMEOUT); - await jest.runOnlyPendingTimersAsync(); - await client.flush(); + jest.runOnlyPendingTimers(); const routeTransactionEvent = client.event; expect(routeTransactionEvent!.measurements![APP_START_COLD].value).toBe( @@ -390,7 +374,7 @@ describe('ReactNativeTracing', () => { expect(routeTransactionEvent!.contexts!.trace!.op).toBe(UI_LOAD); expect(routeTransactionEvent!.start_timestamp).toBe(appStartTimeMilliseconds / 1000); - const span = spanToJSON(routeTransactionEvent!.spans![routeTransactionEvent!.spans!.length - 1]); + const span = routeTransactionEvent!.spans![routeTransactionEvent!.spans!.length - 1]; expect(span!.op).toBe(APP_START_COLD_OP); expect(span!.description).toBe('Cold App Start'); expect(span!.start_timestamp).toBe(appStartTimeMilliseconds / 1000); @@ -405,14 +389,14 @@ describe('ReactNativeTracing', () => { const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStartResponse({ cold: false }); - setup(integration); + integration.setup(client); // wait for internal promises to resolve, fetch app start data from mocked native await Promise.resolve(); expect(getActiveSpan()).toBeUndefined(); routingInstrumentation.onRouteWillChange({ - name: 'Route Change', + name: 'test', }); expect(getActiveSpan()).toBeDefined(); @@ -420,8 +404,7 @@ describe('ReactNativeTracing', () => { // trigger idle transaction to finish and call before finish callbacks jest.advanceTimersByTime(DEFAULT_IDLE_TIMEOUT); - await jest.runOnlyPendingTimersAsync(); - await client.flush(); + jest.runOnlyPendingTimers(); const routeTransaction = client.event; expect(routeTransaction!.measurements![APP_START_WARM].value).toBe( @@ -431,7 +414,7 @@ describe('ReactNativeTracing', () => { expect(routeTransaction!.contexts!.trace!.op).toBe(UI_LOAD); expect(routeTransaction!.start_timestamp).toBe(appStartTimeMilliseconds / 1000); - const span = spanToJSON(routeTransaction!.spans![routeTransaction!.spans!.length - 1]); + const span = routeTransaction!.spans![routeTransaction!.spans!.length - 1]; expect(span!.op).toBe(APP_START_WARM_OP); expect(span!.description).toBe('Warm App Start'); expect(span!.start_timestamp).toBe(appStartTimeMilliseconds / 1000); @@ -447,14 +430,14 @@ describe('ReactNativeTracing', () => { const [, appStartTimeMilliseconds] = mockAppStartResponse({ cold: false, didFetchAppStart: true }); - setup(integration); + integration.setup(client); // wait for internal promises to resolve, fetch app start data from mocked native await Promise.resolve(); expect(getActiveSpan()).toBeUndefined(); routingInstrumentation.onRouteWillChange({ - name: 'Route Change', + name: 'test', }); expect(getActiveSpan()).toBeDefined(); @@ -462,14 +445,13 @@ describe('ReactNativeTracing', () => { // trigger idle transaction to finish and call before finish callbacks jest.advanceTimersByTime(DEFAULT_IDLE_TIMEOUT); - await jest.runOnlyPendingTimersAsync(); - await client.flush(); + jest.runOnlyPendingTimers(); const routeTransaction = client.event; expect(routeTransaction!.measurements).toBeUndefined(); expect(routeTransaction!.contexts!.trace!.op).not.toBe(UI_LOAD); expect(routeTransaction!.start_timestamp).not.toBe(appStartTimeMilliseconds / 1000); - expect(routeTransaction!.spans!.length).toBe(0); // TODO: check why originally was 2 + expect(routeTransaction!.spans!.length).toBe(0); }); }); @@ -477,7 +459,7 @@ describe('ReactNativeTracing', () => { const integration = new ReactNativeTracing({ enableAppStartTracking: false, }); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); await jest.runOnlyPendingTimersAsync(); @@ -491,7 +473,7 @@ describe('ReactNativeTracing', () => { NATIVE.enableNative = false; const integration = new ReactNativeTracing(); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); await jest.runOnlyPendingTimersAsync(); @@ -505,7 +487,7 @@ describe('ReactNativeTracing', () => { mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(null); const integration = new ReactNativeTracing(); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); await jest.runOnlyPendingTimersAsync(); @@ -517,15 +499,17 @@ describe('ReactNativeTracing', () => { }); describe('Native Frames', () => { + let client: TestClient; + beforeEach(() => { - setupTestClient(); + client = setupTestClient(); }); it('Initialize native frames instrumentation if flag is true', async () => { const integration = new ReactNativeTracing({ enableNativeFramesTracking: true, }); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); @@ -537,7 +521,7 @@ describe('ReactNativeTracing', () => { enableNativeFramesTracking: false, }); - setup(integration); + integration.setup(client); await jest.advanceTimersByTimeAsync(500); @@ -562,7 +546,6 @@ describe('ReactNativeTracing', () => { }); client.addIntegration(integration); - setup(integration); routing.onRouteWillChange({ name: 'First Route' }); await jest.advanceTimersByTimeAsync(500); @@ -571,7 +554,6 @@ describe('ReactNativeTracing', () => { routing.onRouteWillChange({ name: 'Second Route' }); await jest.advanceTimersByTimeAsync(500); await jest.runOnlyPendingTimersAsync(); - await client.flush(); const transaction = client.event; expect(transaction!.contexts!.app).toBeDefined(); @@ -693,8 +675,8 @@ describe('ReactNativeTracing', () => { describe('disabled user interaction', () => { test('User interaction tracing is disabled by default', () => { tracing = new ReactNativeTracing(); - setup(tracing); - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.setup(client); + tracing.startUserInteractionSpan(mockedUserInteractionId); expect(tracing.options.enableUserInteractionTracing).toBeFalsy(); expect(getActiveSpan()).toBeUndefined(); @@ -707,19 +689,12 @@ describe('ReactNativeTracing', () => { routingInstrumentation: mockedRoutingInstrumentation, enableUserInteractionTracing: true, }); - setup(tracing); - mockedRoutingInstrumentation.registeredOnConfirmRoute!({ - name: 'mockedTransactionName', - data: { - route: { - name: 'mockedRouteName', - }, - }, - }); + tracing.setup(client); + mockedRoutingInstrumentation.registeredOnConfirmRoute!('mockedRouteName'); }); test('user interaction tracing is enabled and transaction is bound to scope', () => { - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const actualTransaction = getActiveSpan(); const actualTransactionContext = spanToJSON(actualTransaction!); @@ -733,7 +708,7 @@ describe('ReactNativeTracing', () => { }); test('UI event transaction not sampled if no child spans', () => { - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const actualTransaction = getActiveSpan(); jest.runAllTimers(); @@ -743,7 +718,7 @@ describe('ReactNativeTracing', () => { }); test('does cancel UI event transaction when app goes to background', () => { - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const actualTransaction = getActiveSpan(); mockedAppState.setState('background'); @@ -760,10 +735,10 @@ describe('ReactNativeTracing', () => { }); test('do not overwrite existing status of UI event transactions', () => { - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const actualTransaction = getActiveSpan(); - actualTransaction?.setStatus('mocked_status'); + actualTransaction?.setStatus({ code: SPAN_STATUS_ERROR, message: 'mocked_status' }); jest.runAllTimers(); @@ -778,29 +753,28 @@ describe('ReactNativeTracing', () => { test('same UI event and same element does not reschedule idle timeout', () => { const timeoutCloseToActualIdleTimeoutMs = 800; - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const actualTransaction = getActiveSpan(); jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); expect(spanToJSON(actualTransaction!).timestamp).toEqual(expect.any(Number)); }); - test('different UI event and same element finish first and start new transaction', async () => { + test('different UI event and same element finish first and start new transaction', () => { const timeoutCloseToActualIdleTimeoutMs = 800; - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const firstTransaction = getActiveSpan(); jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); const childFirstTransaction = startInactiveSpan({ name: 'Child Span of the first Tx', op: 'child.op' }); - tracing.startUserInteractionTransaction({ ...mockedUserInteractionId, op: 'different.op' }); + tracing.startUserInteractionSpan({ ...mockedUserInteractionId, op: 'different.op' }); const secondTransaction = getActiveSpan(); jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); childFirstTransaction?.end(); - await jest.runAllTimersAsync(); - await client.flush(); + jest.runAllTimers(); const firstTransactionEvent = client.eventQueue[0]; expect(firstTransaction).toBeDefined(); @@ -827,18 +801,17 @@ describe('ReactNativeTracing', () => { ); }); - test('different UI event and same element finish first transaction with last span', async () => { + test('different UI event and same element finish first transaction with last span', () => { const timeoutCloseToActualIdleTimeoutMs = 800; - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const firstTransaction = getActiveSpan(); jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); const childFirstTransaction = startInactiveSpan({ name: 'Child Span of the first Tx', op: 'child.op' }); - tracing.startUserInteractionTransaction({ ...mockedUserInteractionId, op: 'different.op' }); + tracing.startUserInteractionSpan({ ...mockedUserInteractionId, op: 'different.op' }); jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); childFirstTransaction?.end(); - await jest.runAllTimersAsync(); - await client.flush(); + jest.runAllTimers(); const firstTransactionEvent = client.eventQueue[0]; expect(firstTransaction).toBeDefined(); @@ -855,11 +828,11 @@ describe('ReactNativeTracing', () => { }); test('same ui event after UI event transaction finished', () => { - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const firstTransaction = getActiveSpan(); jest.runAllTimers(); - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const secondTransaction = getActiveSpan(); jest.runAllTimers(); @@ -873,18 +846,18 @@ describe('ReactNativeTracing', () => { test('do not start UI event transaction if active transaction on scope', () => { const activeTransaction = startSpanManual( { name: 'activeTransactionOnScope', scope: getCurrentScope() }, - span => span, + (span: Span) => span, ); expect(activeTransaction).toBeDefined(); expect(activeTransaction).toBe(getActiveSpan()); - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); expect(activeTransaction).toBe(getActiveSpan()); }); test('UI event transaction is canceled when routing transaction starts', () => { const timeoutCloseToActualIdleTimeoutMs = 800; - tracing.startUserInteractionTransaction(mockedUserInteractionId); + tracing.startUserInteractionSpan(mockedUserInteractionId); const interactionTransaction = getActiveSpan(); jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); @@ -928,7 +901,3 @@ function mockAppStartResponse({ cold, didFetchAppStart }: { cold: boolean; didFe return [timeOriginMilliseconds, appStartTimeMilliseconds]; } - -function setup(integration: ReactNativeTracing) { - integration.setupOnce(addGlobalEventProcessor, getCurrentHub); -} diff --git a/test/tracing/reactnavigation.stalltracking.test.ts b/test/tracing/reactnavigation.stalltracking.test.ts index b79a9f86b7..c025de0652 100644 --- a/test/tracing/reactnavigation.stalltracking.test.ts +++ b/test/tracing/reactnavigation.stalltracking.test.ts @@ -1,21 +1,18 @@ -import { - addGlobalEventProcessor, - getCurrentHub, - getCurrentScope, - getGlobalScope, - getIsolationScope, - setCurrentClient, - startSpanManual, -} from '@sentry/core'; +jest.mock('../../src/js/tracing/utils', () => ({ + ...jest.requireActual('../../src/js/tracing/utils'), + isNearToNow: jest.fn(), +})); + +import { getCurrentScope, getGlobalScope, getIsolationScope, setCurrentClient, startSpanManual } from '@sentry/core'; import { ReactNativeTracing, ReactNavigationInstrumentation } from '../../src/js'; -import { _addTracingExtensions } from '../../src/js/tracing/addTracingExtensions'; +import { isNearToNow } from '../../src/js/tracing/utils'; import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; import { createMockNavigationAndAttachTo } from './reactnavigationutils'; import { expectStallMeasurements } from './stalltrackingutils'; -jest.useFakeTimers({ advanceTimers: true }); +jest.useFakeTimers({ advanceTimers: 1 }); describe('StallTracking with ReactNavigation', () => { let client: TestClient; @@ -23,7 +20,6 @@ describe('StallTracking with ReactNavigation', () => { beforeEach(() => { RN_GLOBAL_OBJ.__sentry_rn_v5_registered = false; - _addTracingExtensions(); getCurrentScope().clear(); getIsolationScope().clear(); @@ -46,9 +42,6 @@ describe('StallTracking with ReactNavigation', () => { client = new TestClient(options); setCurrentClient(client); client.init(); - - // We have to call this manually as setupOnce is executed once per runtime (global var check) - rnTracing.setupOnce(addGlobalEventProcessor, getCurrentHub); }); afterEach(() => { @@ -56,6 +49,7 @@ describe('StallTracking with ReactNavigation', () => { }); it('Stall tracking supports idleTransaction with unfinished spans', async () => { + (isNearToNow as jest.Mock).mockReturnValue(true); jest.runOnlyPendingTimers(); // Flush app start transaction mockNavigation.navigateToNewScreen(); startSpanManual({ name: 'This child span will never finish' }, () => {}); diff --git a/test/tracing/reactnavigation.test.ts b/test/tracing/reactnavigation.test.ts index f405df4d0c..cd52e72a70 100644 --- a/test/tracing/reactnavigation.test.ts +++ b/test/tracing/reactnavigation.test.ts @@ -1,22 +1,22 @@ /* eslint-disable deprecation/deprecation */ /* eslint-disable @typescript-eslint/no-explicit-any */ +import { getCurrentScope, getGlobalScope, getIsolationScope, SentrySpan, setCurrentClient } from '@sentry/core'; + +import { ReactNativeTracing } from '../../src/js'; +import type { NavigationRoute } from '../../src/js/tracing/reactnavigation'; +import { ReactNavigationInstrumentation } from '../../src/js/tracing/reactnavigation'; import { - addGlobalEventProcessor, - getCurrentHub, - getCurrentScope, - getGlobalScope, - getIsolationScope, + SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_KEY, + SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_NAME, + SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN, + SEMANTIC_ATTRIBUTE_ROUTE_KEY, + SEMANTIC_ATTRIBUTE_ROUTE_NAME, + SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, - setCurrentClient, - Transaction, -} from '@sentry/core'; - -import { ReactNativeTracing } from '../../src/js'; -import type { NavigationRoute } from '../../src/js/tracing/reactnavigation'; -import { ReactNavigationInstrumentation } from '../../src/js/tracing/reactnavigation'; +} from '../../src/js/tracing/semanticAttributes'; import type { BeforeNavigate } from '../../src/js/tracing/types'; import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; @@ -66,24 +66,15 @@ describe('ReactNavigationInstrumentation', () => { contexts: expect.objectContaining({ trace: expect.objectContaining({ data: { - route: { - hasBeenSeen: false, - key: 'initial_screen', - name: 'Initial Screen', - params: {}, - }, - previousRoute: null, + [SEMANTIC_ATTRIBUTE_ROUTE_NAME]: 'Initial Screen', + [SEMANTIC_ATTRIBUTE_ROUTE_KEY]: 'initial_screen', + [SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN]: false, [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual', [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1, + [SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: 'idleTimeout', }, - op: 'navigation', - origin: 'manual', - tags: expect.objectContaining({ - 'routing.instrumentation': 'react-navigation-v5', - 'routing.route.name': 'Initial Screen', - }), }), }), }), @@ -107,28 +98,17 @@ describe('ReactNavigationInstrumentation', () => { contexts: expect.objectContaining({ trace: expect.objectContaining({ data: { - route: { - hasBeenSeen: false, - key: 'new_screen', - name: 'New Screen', - params: {}, - }, - previousRoute: { - key: 'initial_screen', - name: 'Initial Screen', - params: {}, - }, + [SEMANTIC_ATTRIBUTE_ROUTE_NAME]: 'New Screen', + [SEMANTIC_ATTRIBUTE_ROUTE_KEY]: 'new_screen', + [SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN]: false, + [SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_NAME]: 'Initial Screen', + [SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_KEY]: 'initial_screen', [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual', [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1, + [SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: 'idleTimeout', }, - op: 'navigation', - origin: 'manual', - tags: expect.objectContaining({ - 'routing.instrumentation': 'react-navigation-v5', - 'routing.route.name': 'New Screen', - }), }), }), }), @@ -155,28 +135,17 @@ describe('ReactNavigationInstrumentation', () => { contexts: expect.objectContaining({ trace: expect.objectContaining({ data: { - route: { - hasBeenSeen: false, - key: 'second_screen', - name: 'Second Screen', - params: {}, - }, - previousRoute: { - key: 'new_screen', - name: 'New Screen', - params: {}, - }, + [SEMANTIC_ATTRIBUTE_ROUTE_NAME]: 'Second Screen', + [SEMANTIC_ATTRIBUTE_ROUTE_KEY]: 'second_screen', + [SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN]: false, + [SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_NAME]: 'New Screen', + [SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_KEY]: 'new_screen', [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual', [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1, + [SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: 'idleTimeout', }, - op: 'navigation', - origin: 'manual', - tags: expect.objectContaining({ - 'routing.instrumentation': 'react-navigation-v5', - 'routing.route.name': 'Second Screen', - }), }), }), }), @@ -186,8 +155,7 @@ describe('ReactNavigationInstrumentation', () => { test('transaction context changed with beforeNavigate', async () => { setupTestClient({ beforeNavigate: span => { - span.name = 'New Span Name'; - return span; + span.updateName('New Span Name'); }, }); jest.runOnlyPendingTimers(); // Flush the init transaction @@ -205,28 +173,17 @@ describe('ReactNavigationInstrumentation', () => { contexts: expect.objectContaining({ trace: expect.objectContaining({ data: { - route: { - hasBeenSeen: false, - key: 'new_screen', - name: 'New Screen', - params: {}, - }, - previousRoute: { - key: 'initial_screen', - name: 'Initial Screen', - params: {}, - }, + [SEMANTIC_ATTRIBUTE_ROUTE_NAME]: 'New Screen', + [SEMANTIC_ATTRIBUTE_ROUTE_KEY]: 'new_screen', + [SEMANTIC_ATTRIBUTE_ROUTE_HAS_BEEN_SEEN]: false, + [SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_NAME]: 'Initial Screen', + [SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_KEY]: 'initial_screen', [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual', - [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom', + [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1, + [SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON]: 'idleTimeout', }, - op: 'navigation', - origin: 'manual', - tags: expect.objectContaining({ - 'routing.instrumentation': 'react-navigation-v5', - 'routing.route.name': 'New Screen', - }), }), }), }), @@ -318,7 +275,7 @@ describe('ReactNavigationInstrumentation', () => { const mockNavigationContainer = new MockNavigationContainer(); instrumentation.registerNavigationContainer(mockNavigationContainer); - const mockTransaction = new Transaction({ name: 'Test' }); + const mockTransaction = new SentrySpan(); const tracingListener = jest.fn(() => mockTransaction); instrumentation.registerRoutingInstrumentation( tracingListener as any, @@ -338,7 +295,7 @@ describe('ReactNavigationInstrumentation', () => { routeChangeTimeoutMs: 200, }); - const mockTransaction = new Transaction({ name: 'Test', sampled: true }); + const mockTransaction = new SentrySpan({ sampled: true }); const tracingListener = jest.fn(() => mockTransaction); instrumentation.registerRoutingInstrumentation( tracingListener as any, @@ -379,7 +336,7 @@ describe('ReactNavigationInstrumentation', () => { enableStallTracking: false, enableNativeFramesTracking: false, enableAppStartTracking: false, - beforeNavigate: setupOptions.beforeNavigate || (span => span), + beforeNavigate: setupOptions.beforeNavigate, }); const options = getDefaultTestClientOptions({ @@ -389,8 +346,5 @@ describe('ReactNavigationInstrumentation', () => { client = new TestClient(options); setCurrentClient(client); client.init(); - - // We have to call this manually as setupOnce is executed once per runtime (global var check) - rnTracing.setupOnce(addGlobalEventProcessor, getCurrentHub); } }); diff --git a/test/tracing/reactnavigation.ttid.test.tsx b/test/tracing/reactnavigation.ttid.test.tsx index 200257957f..be5114e78b 100644 --- a/test/tracing/reactnavigation.ttid.test.tsx +++ b/test/tracing/reactnavigation.ttid.test.tsx @@ -536,20 +536,12 @@ function initSentry(sut: ReactNavigationInstrumentation): { }), ], transport: () => ({ - send: transportSendMock.mockResolvedValue(undefined), + send: transportSendMock.mockResolvedValue({}), flush: jest.fn().mockResolvedValue(true), }), }; Sentry.init(options); - // In production integrations are setup only once, but in the tests we want them to setup on every init - const integrations = Sentry.getCurrentHub().getClient()?.getOptions().integrations; - if (integrations) { - for (const integration of integrations) { - integration.setupOnce(Sentry.addGlobalEventProcessor, Sentry.getCurrentHub); - } - } - return { transportSendMock, }; diff --git a/test/tracing/reactnavigationv4.test.ts b/test/tracing/reactnavigationv4.test.ts deleted file mode 100644 index 061102ed25..0000000000 --- a/test/tracing/reactnavigationv4.test.ts +++ /dev/null @@ -1,485 +0,0 @@ -/* eslint-disable @typescript-eslint/no-explicit-any */ -import { Transaction } from '@sentry/core'; -import type { TransactionContext } from '@sentry/types'; - -import type { - AppContainerInstance, - NavigationRouteV4, - NavigationStateV4, -} from '../../src/js/tracing/reactnavigationv4'; -import { - INITIAL_TRANSACTION_CONTEXT_V4, - ReactNavigationV4Instrumentation, -} from '../../src/js/tracing/reactnavigationv4'; -import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; - -const initialRoute = { - routeName: 'Initial Route', - key: 'route0', - params: { - hello: true, - }, -}; - -const getMockTransaction = () => { - const transaction = new Transaction(INITIAL_TRANSACTION_CONTEXT_V4); - - // Assume it's sampled - transaction.sampled = true; - - return transaction; -}; - -class MockAppContainer implements AppContainerInstance { - _navigation: { - state: NavigationStateV4; - router: { - dispatchAction: (action: any) => void; - getStateForAction: (action: any, state: NavigationStateV4) => NavigationStateV4; - }; - }; - - constructor() { - const router = { - dispatchAction: (action: any) => { - const newState = router.getStateForAction(action, this._navigation.state); - - this._navigation.state = newState; - }, - getStateForAction: (action: any, state: NavigationStateV4) => { - if (action.routeName === 'DoNotNavigate') { - return state; - } - - return { - ...state, - index: state.routes.length, - routes: [ - ...state.routes, - { - routeName: action.routeName, - key: action.key, - params: action.params, - }, - ], - }; - }, - }; - - this._navigation = { - state: { - index: 0, - key: '0', - isTransitioning: false, - routes: [initialRoute], - }, - router, - }; - } -} - -afterEach(() => { - RN_GLOBAL_OBJ.__sentry_rn_v4_registered = false; - - jest.resetAllMocks(); -}); - -describe('ReactNavigationV4Instrumentation', () => { - test('transaction set on initialize', () => { - const instrumentation = new ReactNavigationV4Instrumentation(); - - const mockTransaction = getMockTransaction(); - instrumentation.onRouteWillChange = jest.fn(() => mockTransaction); - - const tracingListener = jest.fn(); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); - - const mockAppContainerRef = { - current: new MockAppContainer(), - }; - - instrumentation.registerAppContainer(mockAppContainerRef as any); - - const firstRoute = mockAppContainerRef.current._navigation.state.routes[0] as NavigationRouteV4; - - expect(instrumentation.onRouteWillChange).toHaveBeenCalledTimes(1); - - expect(instrumentation.onRouteWillChange).toHaveBeenLastCalledWith(INITIAL_TRANSACTION_CONTEXT_V4); - - expect(mockTransaction.name).toBe(firstRoute.routeName); - expect(mockTransaction.tags).toStrictEqual({ - 'routing.instrumentation': ReactNavigationV4Instrumentation.instrumentationName, - 'routing.route.name': firstRoute.routeName, - }); - expect(mockTransaction.data).toStrictEqual({ - route: { - name: firstRoute.routeName, - key: firstRoute.key, - params: {}, // expect the data to be stripped - hasBeenSeen: false, - }, - previousRoute: null, - }); - expect(mockTransaction.sampled).toBe(true); - expect(mockTransaction.metadata.source).toBe('component'); - }); - - test('transaction sent on navigation', () => { - const instrumentation = new ReactNavigationV4Instrumentation(); - - const mockTransaction = getMockTransaction(); - instrumentation.onRouteWillChange = jest.fn(() => mockTransaction); - - const tracingListener = jest.fn(); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); - - const mockAppContainerRef = { - current: new MockAppContainer(), - }; - - instrumentation.registerAppContainer(mockAppContainerRef as any); - - const action = { - routeName: 'New Route', - key: 'key1', - params: { - someParam: 42, - }, - }; - mockAppContainerRef.current._navigation.router.dispatchAction(action); - - expect(instrumentation.onRouteWillChange).toHaveBeenCalledTimes(2); - - expect(instrumentation.onRouteWillChange).toHaveBeenLastCalledWith({ - name: action.routeName, - op: 'navigation', - tags: { - 'routing.instrumentation': ReactNavigationV4Instrumentation.instrumentationName, - 'routing.route.name': action.routeName, - }, - data: { - route: { - name: action.routeName, - key: action.key, - params: {}, // expect the data to be stripped - hasBeenSeen: false, - }, - previousRoute: { - name: 'Initial Route', - key: 'route0', - params: {}, // expect the data to be stripped - }, - }, - }); - - expect(mockTransaction.sampled).toBe(true); - expect(mockTransaction.metadata.source).toBe('component'); - }); - - test('transaction context changed with beforeNavigate', () => { - const instrumentation = new ReactNavigationV4Instrumentation(); - - const mockTransaction = getMockTransaction(); - const tracingListener = jest.fn(() => mockTransaction); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => { - context.sampled = false; - context.description = 'Description'; - context.name = 'New Name'; - context.tags = {}; - - return context; - }, - () => {}, - ); - - const mockAppContainerRef = { - current: new MockAppContainer(), - }; - - instrumentation.registerAppContainer(mockAppContainerRef as any); - - const action = { - routeName: 'DoNotSend', - key: 'key1', - params: { - someParam: 42, - }, - }; - mockAppContainerRef.current._navigation.router.dispatchAction(action); - - expect(tracingListener).toHaveBeenCalledTimes(2); - - expect(tracingListener).toHaveBeenLastCalledWith({ - name: 'New Name', - op: 'navigation', - description: 'Description', - tags: {}, - data: { - route: { - name: action.routeName, - key: action.key, - params: {}, // expect the data to be stripped - hasBeenSeen: false, - }, - previousRoute: { - name: 'Initial Route', - key: 'route0', - params: {}, // expect the data to be stripped - }, - }, - sampled: false, - }); - - expect(mockTransaction.sampled).toBe(false); - expect(mockTransaction.metadata.source).toBe('custom'); - }); - - test('transaction not attached on a cancelled navigation', () => { - const instrumentation = new ReactNavigationV4Instrumentation(); - - const mockTransaction = getMockTransaction(); - instrumentation.onRouteWillChange = jest.fn(() => mockTransaction); - - const tracingListener = jest.fn(); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); - - const mockAppContainerRef = { - current: new MockAppContainer(), - }; - - instrumentation.registerAppContainer(mockAppContainerRef as any); - - const action = { - routeName: 'DoNotNavigate', - }; - mockAppContainerRef.current._navigation.router.dispatchAction(action); - - expect(instrumentation.onRouteWillChange).toHaveBeenCalledTimes(1); - }); - - describe('navigation container registration', () => { - test('registers navigation container object ref', () => { - const instrumentation = new ReactNavigationV4Instrumentation(); - const mockTransaction = getMockTransaction(); - instrumentation.onRouteWillChange = jest.fn(() => mockTransaction); - - const tracingListener = jest.fn(); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); - - const mockAppContainer = new MockAppContainer(); - instrumentation.registerAppContainer({ - current: mockAppContainer, - }); - - expect(RN_GLOBAL_OBJ.__sentry_rn_v4_registered).toBe(true); - - expect(instrumentation.onRouteWillChange).toHaveBeenCalledTimes(1); - expect(mockTransaction.name).toBe(initialRoute.routeName); - expect(mockTransaction.sampled).toBe(true); - }); - - test('registers navigation container direct ref', () => { - const instrumentation = new ReactNavigationV4Instrumentation(); - const mockTransaction = getMockTransaction(); - instrumentation.onRouteWillChange = jest.fn(() => mockTransaction); - - const tracingListener = jest.fn(); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); - - const mockAppContainer = new MockAppContainer(); - instrumentation.registerAppContainer(mockAppContainer); - - expect(RN_GLOBAL_OBJ.__sentry_rn_v4_registered).toBe(true); - - expect(instrumentation.onRouteWillChange).toHaveBeenCalledTimes(1); - expect(mockTransaction.name).toBe(initialRoute.routeName); - expect(mockTransaction.sampled).toBe(true); - }); - - test('does not register navigation container if there is an existing one', async () => { - RN_GLOBAL_OBJ.__sentry_rn_v4_registered = true; - - const instrumentation = new ReactNavigationV4Instrumentation(); - const mockTransaction = getMockTransaction(); - instrumentation.onRouteWillChange = jest.fn(() => mockTransaction); - - const tracingListener = jest.fn(); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); - - const mockAppContainer = new MockAppContainer(); - instrumentation.registerAppContainer(mockAppContainer); - - expect(RN_GLOBAL_OBJ.__sentry_rn_v4_registered).toBe(true); - - await new Promise(resolve => { - setTimeout(() => { - expect(mockTransaction.sampled).toBe(false); - resolve(); - }, 1100); - }); - }); - - test('works if routing instrumentation registration is after navigation registration', async () => { - const instrumentation = new ReactNavigationV4Instrumentation(); - - const mockNavigationContainer = new MockAppContainer(); - instrumentation.registerAppContainer(mockNavigationContainer); - - const mockTransaction = getMockTransaction(); - const tracingListener = jest.fn(() => mockTransaction); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); - - await new Promise(resolve => { - setTimeout(() => { - expect(mockTransaction.sampled).toBe(true); - resolve(); - }, 500); - }); - }); - }); - - describe('options', () => { - test('waits until routeChangeTimeoutMs', async () => { - const instrumentation = new ReactNavigationV4Instrumentation({ - routeChangeTimeoutMs: 200, - }); - - const mockTransaction = getMockTransaction(); - const tracingListener = jest.fn(() => mockTransaction); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); - - const mockNavigationContainerRef = { - current: new MockAppContainer(), - }; - - return new Promise(resolve => { - setTimeout(() => { - instrumentation.registerAppContainer(mockNavigationContainerRef as any); - - expect(mockTransaction.sampled).toBe(true); - expect(mockTransaction.name).toBe(initialRoute.routeName); - - resolve(); - }, 190); - }); - }); - - test('discards if after routeChangeTimeoutMs', async () => { - const instrumentation = new ReactNavigationV4Instrumentation({ - routeChangeTimeoutMs: 200, - }); - - const mockTransaction = getMockTransaction(); - const tracingListener = jest.fn(() => mockTransaction); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); - - const mockNavigationContainerRef = { - current: new MockAppContainer(), - }; - - return new Promise(resolve => { - setTimeout(() => { - instrumentation.registerAppContainer(mockNavigationContainerRef as any); - - expect(mockTransaction.sampled).toBe(false); - resolve(); - }, 210); - }); - }); - }); - - describe('onRouteConfirmed', () => { - test('onRouteConfirmed called with correct route data', () => { - const instrumentation = new ReactNavigationV4Instrumentation(); - - const mockTransaction = getMockTransaction(); - instrumentation.onRouteWillChange = jest.fn(() => mockTransaction); - - const tracingListener = jest.fn(); - let confirmedContext: TransactionContext | undefined; - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - context => { - confirmedContext = context; - }, - ); - - const mockAppContainerRef = { - current: new MockAppContainer(), - }; - - instrumentation.registerAppContainer(mockAppContainerRef as any); - - const route1 = { - routeName: 'New Route 1', - key: '1', - params: { - someParam: 42, - }, - }; - mockAppContainerRef.current._navigation.router.dispatchAction(route1); - - const route2 = { - routeName: 'New Route 2', - key: '2', - params: { - someParam: 42, - }, - }; - mockAppContainerRef.current._navigation.router.dispatchAction(route2); - - expect(confirmedContext).toBeDefined(); - if (confirmedContext) { - expect(confirmedContext.name).toBe(route2.routeName); - expect(confirmedContext.data).toBeDefined(); - expect(confirmedContext.metadata).toBeUndefined(); - if (confirmedContext.data) { - expect(confirmedContext.data.route.name).toBe(route2.routeName); - expect(confirmedContext.data.previousRoute).toBeDefined(); - if (confirmedContext.data.previousRoute) { - expect(confirmedContext.data.previousRoute.name).toBe(route1.routeName); - } - } - } - }); - }); -}); diff --git a/test/tracing/stalltracking.test.ts b/test/tracing/stalltracking.test.ts index dab30e0259..af1097566e 100644 --- a/test/tracing/stalltracking.test.ts +++ b/test/tracing/stalltracking.test.ts @@ -1,10 +1,9 @@ import { - addGlobalEventProcessor, - getCurrentHub, getCurrentScope, getGlobalScope, getIsolationScope, setCurrentClient, + startIdleSpan, startSpan, startSpanManual, } from '@sentry/core'; @@ -12,7 +11,6 @@ import type { Span } from '@sentry/types'; import { timestampInSeconds } from '@sentry/utils'; import { ReactNativeTracing } from '../../src/js'; -import { _addTracingExtensions } from '../../src/js/tracing/addTracingExtensions'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; import { expectNonZeroStallMeasurements, expectStallMeasurements } from './stalltrackingutils'; @@ -33,8 +31,6 @@ describe('StallTracking', () => { let client: TestClient; beforeEach(() => { - _addTracingExtensions(); - getCurrentScope().clear(); getIsolationScope().clear(); getGlobalScope().clear(); @@ -52,9 +48,6 @@ describe('StallTracking', () => { client = new TestClient(options); setCurrentClient(client); client.init(); - - // We have to call this manually as setupOnce is executed once per runtime (global var check) - rnTracing.setupOnce(addGlobalEventProcessor, getCurrentHub); }); afterEach(() => { @@ -113,11 +106,11 @@ describe('StallTracking', () => { const t1 = startSpanManual({ name: 'Test Transaction 1', forceTransaction: true }, span => span); const t2 = startSpanManual({ name: 'Test Transaction 2', forceTransaction: true }, span => span); - t0!.end(); + t0.end(); jest.runOnlyPendingTimers(); - t1!.end(); + t1.end(); jest.runOnlyPendingTimers(); - t2!.end(); + t2.end(); jest.runOnlyPendingTimers(); await client.flush(); @@ -153,57 +146,32 @@ describe('StallTracking', () => { expect(client.event?.measurements).toBeUndefined(); }); - it('Stall tracking supports endTimestamp that is from the last span (trimEnd case)', async () => { - startSpanManual({ name: 'Stall will happen during this span', trimEnd: true }, (rootSpan: Span | undefined) => { - let childSpanEnd: number | undefined = undefined; - startSpanManual({ name: 'This is a child of the active span' }, (childSpan: Span | undefined) => { - childSpanEnd = timestampInSeconds(); - childSpan!.end(childSpanEnd); - jest.runOnlyPendingTimers(); - }); + it('Stall tracking supports endTimestamp that is from the last span', async () => { + const rootSpan = startIdleSpan({ name: 'Stall will happen during this span' }); + let childSpanEnd: number | undefined = undefined; + startSpanManual({ name: 'This is a child of the active span' }, (childSpan: Span | undefined) => { + childSpanEnd = timestampInSeconds(); + childSpan!.end(childSpanEnd); jest.runOnlyPendingTimers(); - rootSpan!.end(childSpanEnd); }); + jest.runOnlyPendingTimers(); + rootSpan!.end(childSpanEnd); await client.flush(); expectStallMeasurements(client.event?.measurements); }); - /** - * @deprecated This behavior will be removed in the future. Replaced by close time proximity check. - **/ - it('Stall tracking rejects endTimestamp that is from the last span if trimEnd is false (trimEnd case)', async () => { - startSpanManual({ name: 'Stall will happen during this span', trimEnd: false }, (rootSpan: Span | undefined) => { - let childSpanEnd: number | undefined = undefined; - startSpanManual({ name: 'This is a child of the active span' }, (childSpan: Span | undefined) => { - childSpanEnd = timestampInSeconds(); - childSpan!.end(childSpanEnd); - jest.runOnlyPendingTimers(); - }); + it('Stall tracking rejects custom endTimestamp that is far from now and not equal to the last child end', async () => { + const rootSpan = startIdleSpan({ name: 'Stall will happen during this span' }); + let childSpanEnd: number | undefined = undefined; + startSpanManual({ name: 'This is a child of the active span' }, (childSpan: Span | undefined) => { + childSpanEnd = timestampInSeconds() + 10; + childSpan!.end(childSpanEnd); jest.runOnlyPendingTimers(); - rootSpan!.end(childSpanEnd); - }); - - await client.flush(); - - expect(client.event?.measurements).toBeUndefined(); - }); - - /** - * @deprecated This behavior will be removed in the future. Replaced by close time proximity check. - **/ - it('Stall tracking rejects endTimestamp even if it is a span time (custom endTimestamp case)', async () => { - startSpanManual({ name: 'Stall will happen during this span', trimEnd: false }, (rootSpan: Span | undefined) => { - let childSpanEnd: number | undefined = undefined; - startSpanManual({ name: 'This is a child of the active span' }, (childSpan: Span | undefined) => { - childSpanEnd = timestampInSeconds(); - childSpan!.end(childSpanEnd); - jest.runOnlyPendingTimers(); - }); - jest.runOnlyPendingTimers(); - rootSpan!.end(childSpanEnd! + 0.1); }); + jest.runOnlyPendingTimers(); + rootSpan!.end(childSpanEnd! + 20); await client.flush(); @@ -226,17 +194,17 @@ describe('StallTracking', () => { expectStallMeasurements(client.event?.measurements); }); - it('Stall tracking only measures stalls inside the final time when trimEnd is used', async () => { - startSpan({ name: 'Stall will happen during this span', trimEnd: true }, () => { - startSpan({ name: 'This child span contains expensive operation' }, () => { - expensiveOperation(); - jest.runOnlyPendingTimers(); - }); + it('Stall tracking only measures stalls inside the final time when end is trimmed', async () => { + startIdleSpan({ name: 'Stall will happen during this span' }); - expensiveOperation(); // This should not be recorded - jest.runOnlyPendingTimers(); + startSpan({ name: 'This is a child of the active span' }, () => { + expensiveOperation(); }); + jest.runOnlyPendingTimers(); // This allows the child span end to be processed + expensiveOperation(); // This should not be recorded + jest.runAllTimers(); // This should finish the root span + await client.flush(); const measurements = client.event?.measurements; @@ -252,7 +220,7 @@ describe('StallTracking', () => { return startSpanManual({ name: `Test Transaction ${i}`, forceTransaction: true }, span => span); }) .forEach(t => { - t!.end(); + t.end(); }); await client.flush(); diff --git a/test/tracing/timetodisplay.test.tsx b/test/tracing/timetodisplay.test.tsx index 42db2c115b..9888112a1c 100644 --- a/test/tracing/timetodisplay.test.tsx +++ b/test/tracing/timetodisplay.test.tsx @@ -1,13 +1,11 @@ import * as mockedtimetodisplaynative from './mockedtimetodisplaynative'; jest.mock('../../src/js/tracing/timetodisplaynative', () => mockedtimetodisplaynative); -import type { Span as SpanClass} from '@sentry/core'; -import { getCurrentScope, getGlobalScope, getIsolationScope, setCurrentClient, spanToJSON, startSpanManual} from '@sentry/core'; +import { getCurrentScope, getGlobalScope, getIsolationScope, getSpanDescendants, setCurrentClient, spanToJSON, startSpanManual} from '@sentry/core'; import type { Event, Measurements, Span, SpanJSON} from '@sentry/types'; import React from "react"; import TestRenderer from 'react-test-renderer'; -import { _addTracingExtensions } from '../../src/js/tracing/addTracingExtensions'; import { startTimeToFullDisplaySpan, startTimeToInitialDisplaySpan, TimeToFullDisplay, TimeToInitialDisplay } from '../../src/js/tracing/timetodisplay'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; import { secondAgoTimestampMs, secondInFutureTimestampMs } from '../testutils'; @@ -19,8 +17,6 @@ describe('TimeToDisplay', () => { let client: TestClient; beforeEach(() => { - _addTracingExtensions(); - getCurrentScope().clear(); getIsolationScope().clear(); getGlobalScope().clear(); @@ -376,9 +372,3 @@ function expectNoFullDisplayMeasurementOnSpan(event: Event) { expect.not.objectContaining({ time_to_full_display: expect.anything() }), ]); } - -// Will be replaced by https://github.com/getsentry/sentry-javascript/blob/99d8390f667e8ad31a9b1fd62fbd4941162fab04/packages/core/src/tracing/utils.ts#L54 -// after JS v8 upgrade -function getSpanDescendants(span?: Span) { - return (span as SpanClass)?.spanRecorder?.spans; -} diff --git a/test/transports/native.test.ts b/test/transports/native.test.ts index 148dc13792..1f466ca8c5 100644 --- a/test/transports/native.test.ts +++ b/test/transports/native.test.ts @@ -4,13 +4,13 @@ import { NativeTransport } from '../../src/js/transports/native'; jest.mock('../../src/js/wrapper', () => ({ NATIVE: { - sendEnvelope: jest.fn(() => Promise.resolve({ status: 200 })), + sendEnvelope: jest.fn(() => Promise.resolve(undefined)), }, })); describe('NativeTransport', () => { test('call native sendEvent', async () => { const transport = new NativeTransport(); - await expect(transport.send({} as Envelope)).resolves.toEqual({ status: 200 }); + await expect(transport.send({} as Envelope)).resolves.toEqual({}); }); }); diff --git a/yarn.lock b/yarn.lock index 02c15e9e27..2c75e976fb 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3739,13 +3739,22 @@ component-type "^1.2.1" join-component "^1.1.0" -"@sentry-internal/eslint-config-sdk@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-config-sdk/-/eslint-config-sdk-7.113.0.tgz#37a86b7bdf71cfab47d1108d27306f763bc37862" - integrity sha512-VaIVKbSymUq4FjehYZe+l/VhyD+KDf32HCL/7zdENbZXlgH+SO/oS4Iq1T2hc/W54D3rC1V8+YViaKQEbVmhcg== +"@sentry-internal/browser-utils@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/browser-utils/-/browser-utils-8.4.0.tgz#5b108878e93713757d75e7e8ae7780297d36ad17" + integrity sha512-Mfm3TK3KUlghhuKM3rjTeD4D5kAiB7iVNFoaDJIJBVKa67M9BvlNTnNJMDi7+9rV4RuLQYxXn0p5HEZJFYp3Zw== + dependencies: + "@sentry/core" "8.4.0" + "@sentry/types" "8.4.0" + "@sentry/utils" "8.4.0" + +"@sentry-internal/eslint-config-sdk@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-config-sdk/-/eslint-config-sdk-8.4.0.tgz#432d56a8969c4b1c699cfaa0d5f2be4eb7835dbc" + integrity sha512-9jC2PBUw0Gn2ZlCeKeDfSMKsUPJczyQYoG7x2gHce/zur7jpKIc5DTt5NM74Sjyai7wMyUY2rLP8GnFdYPQosg== dependencies: - "@sentry-internal/eslint-plugin-sdk" "7.113.0" - "@sentry-internal/typescript" "7.113.0" + "@sentry-internal/eslint-plugin-sdk" "8.4.0" + "@sentry-internal/typescript" "8.4.0" "@typescript-eslint/eslint-plugin" "^5.48.0" "@typescript-eslint/parser" "^5.48.0" eslint-config-prettier "^6.11.0" @@ -3755,40 +3764,39 @@ eslint-plugin-jsdoc "^30.0.3" eslint-plugin-simple-import-sort "^5.0.3" -"@sentry-internal/eslint-plugin-sdk@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-plugin-sdk/-/eslint-plugin-sdk-7.113.0.tgz#cafb9b2bc8560c9baf8ffe05eb93703229492e5b" - integrity sha512-c4EGfRX4BECKB9EB9eS1oOvnkPXXRe4i9N3AlVHJrbamoS0Qqrxx1PRDvl3Gd8iI5NEw+1gAlLc2NgR9qRJ2bw== - dependencies: - requireindex "~1.1.0" +"@sentry-internal/eslint-plugin-sdk@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-plugin-sdk/-/eslint-plugin-sdk-8.4.0.tgz#eca0a66d2b4af76139881d4c252db83ca301afbf" + integrity sha512-w1YbQR+c6w0mu3WUvX2tD/E6o3hCQmgutBlQu0qElVmEPwgUgMS6b5036MnYZt7AHCIfuBqEA4DHaQt+3zT/Lw== -"@sentry-internal/feedback@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-7.113.0.tgz#90a3c5493e289d589cfde79330fca549a24f41a4" - integrity sha512-eEmL8QXauUnM3FXGv0GT29RpL0Jo0pkn/uMu3aqjhQo7JKNqUGVYIUxJxiGWbVMbDXqPQ7L66bjjMS3FR1GM2g== +"@sentry-internal/feedback@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-8.4.0.tgz#81067dadda249b354b72f5adba20374dea43fdf4" + integrity sha512-1/WshI2X9seZAQXrOiv6/LU08fbSSvJU0b1ZWMhn+onb/FWPomsL/UN0WufCYA65S5JZGdaWC8fUcJxWC8PATQ== dependencies: - "@sentry/core" "7.113.0" - "@sentry/types" "7.113.0" - "@sentry/utils" "7.113.0" + "@sentry/core" "8.4.0" + "@sentry/types" "8.4.0" + "@sentry/utils" "8.4.0" -"@sentry-internal/replay-canvas@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-7.113.0.tgz#8a0165494b0a0ba7b1ae45166ca90a8749c38b7a" - integrity sha512-K8uA42aobNF/BAXf14el15iSAi9fonLBUrjZi6nPDq7zaA8rPvfcTL797hwCbqkETz2zDf52Jz7I3WFCshDoUw== +"@sentry-internal/replay-canvas@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-8.4.0.tgz#cf5e903d8935ba6b60a5027d0055902987353920" + integrity sha512-g+U4IPQdODCg7fQQVNvH6ix05Tl1mOQXXRexgtp+tXdys4sHQSBUYraJYZy+mY3OGnLRgKFqELM0fnffJSpuyQ== dependencies: - "@sentry/core" "7.113.0" - "@sentry/replay" "7.113.0" - "@sentry/types" "7.113.0" - "@sentry/utils" "7.113.0" + "@sentry-internal/replay" "8.4.0" + "@sentry/core" "8.4.0" + "@sentry/types" "8.4.0" + "@sentry/utils" "8.4.0" -"@sentry-internal/tracing@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/tracing/-/tracing-7.113.0.tgz#936f23205ab53be62f1753b923eddc243cefde86" - integrity sha512-8MDnYENRMnEfQjvN4gkFYFaaBSiMFSU/6SQZfY9pLI3V105z6JQ4D0PGMAUVowXilwNZVpKNYohE7XByuhEC7Q== +"@sentry-internal/replay@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/replay/-/replay-8.4.0.tgz#8fc4a6bf1d5f480fcde2d56cd75042953e44efda" + integrity sha512-RSzQwCF/QTi5/5XAuj0VJImAhu4MheeHYvAbr/PuMSF4o1j89gBA7e3boA4u8633IqUeu5w3S5sb6jVrKaVifg== dependencies: - "@sentry/core" "7.113.0" - "@sentry/types" "7.113.0" - "@sentry/utils" "7.113.0" + "@sentry-internal/browser-utils" "8.4.0" + "@sentry/core" "8.4.0" + "@sentry/types" "8.4.0" + "@sentry/utils" "8.4.0" "@sentry-internal/tracing@7.76.0": version "7.76.0" @@ -3799,24 +3807,23 @@ "@sentry/types" "7.76.0" "@sentry/utils" "7.76.0" -"@sentry-internal/typescript@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/typescript/-/typescript-7.113.0.tgz#beb089d537f5267578e81d5dca47f0cf7fdb5875" - integrity sha512-zUjWxuBzY/ROXyeU487xvTq88BMDi9HRgKJ/XBgkse+tR+gtDTygPdToxNEVEMceLaPsHxi817/cAXIEJ5zyXQ== - -"@sentry/browser@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-7.113.0.tgz#09b77812cbf476eacdccdc714ba4e4ba2c170a88" - integrity sha512-PdyVHPOprwoxGfKGsP2dXDWO0MBDW1eyP7EZlfZvM1A4hjk6ZRNfCv30g+TrqX4hiZDKzyqN3+AdP7N/J2IX0Q== - dependencies: - "@sentry-internal/feedback" "7.113.0" - "@sentry-internal/replay-canvas" "7.113.0" - "@sentry-internal/tracing" "7.113.0" - "@sentry/core" "7.113.0" - "@sentry/integrations" "7.113.0" - "@sentry/replay" "7.113.0" - "@sentry/types" "7.113.0" - "@sentry/utils" "7.113.0" +"@sentry-internal/typescript@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/typescript/-/typescript-8.4.0.tgz#6ebc97285e516ad2c2ef09e368821d9ecb39c57e" + integrity sha512-EgkYnSAi1Ryvb5t2xmMA7mc63ohpFh/CRaDdQUBQdNOK+TVH2wul7h525V3hUkxDJRHZxnNb7a6TWvfCZR7bYA== + +"@sentry/browser@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-8.4.0.tgz#f4aa381eab212432d71366884693a36c2e3a1675" + integrity sha512-hmXeIZBdN0A6yCuoMTcigGxLl42nbeb205fXtouwE7Maa0qM2HM+Ijq0sHzbhxR3zU0JXDtcJh1k6wtJOREJ3g== + dependencies: + "@sentry-internal/browser-utils" "8.4.0" + "@sentry-internal/feedback" "8.4.0" + "@sentry-internal/replay" "8.4.0" + "@sentry-internal/replay-canvas" "8.4.0" + "@sentry/core" "8.4.0" + "@sentry/types" "8.4.0" + "@sentry/utils" "8.4.0" "@sentry/cli-darwin@2.31.2": version "2.31.2" @@ -3885,14 +3892,6 @@ proxy-from-env "^1.1.0" which "^2.0.2" -"@sentry/core@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry/core/-/core-7.113.0.tgz#84307eabf03ece9304894ad24ee15581a220c5c7" - integrity sha512-pg75y3C5PG2+ur27A0Re37YTCEnX0liiEU7EOxWDGutH17x3ySwlYqLQmZsFZTSnvzv7t3MGsNZ8nT5O0746YA== - dependencies: - "@sentry/types" "7.113.0" - "@sentry/utils" "7.113.0" - "@sentry/core@7.76.0": version "7.76.0" resolved "https://registry.yarnpkg.com/@sentry/core/-/core-7.76.0.tgz#b0d1dc399a862ea8a1c8a1c60a409e92eaf8e9e1" @@ -3901,24 +3900,13 @@ "@sentry/types" "7.76.0" "@sentry/utils" "7.76.0" -"@sentry/hub@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry/hub/-/hub-7.113.0.tgz#12f14071f43e657cd36174ba8b06cc955da5492f" - integrity sha512-aoerhlAw3vnY9a27eKAoK862oMXFbyMFWbaZuCeR5gfg7sHsOkVQkCl3yiYfF5hfw9MbwbbY6GqWbCrA89Ci/A== - dependencies: - "@sentry/core" "7.113.0" - "@sentry/types" "7.113.0" - "@sentry/utils" "7.113.0" - -"@sentry/integrations@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry/integrations/-/integrations-7.113.0.tgz#cce71e07cf90c4bf9b22f85c3ce22d9ba926ae5a" - integrity sha512-w0sspGBQ+6+V/9bgCkpuM3CGwTYoQEVeTW6iNebFKbtN7MrM3XsGAM9I2cW1jVxFZROqCBPFtd2cs5n0j14aAg== +"@sentry/core@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry/core/-/core-8.4.0.tgz#ab3f7202f3cae82daf4c3c408f50d2c6fb913620" + integrity sha512-0eACPlJvKloFIlcT1c/vjGnvqxLxpGyGuSsU7uonrkmBqIRwLYXWtR4PoHapysKtjPVoHAn9au50ut6ymC2V8Q== dependencies: - "@sentry/core" "7.113.0" - "@sentry/types" "7.113.0" - "@sentry/utils" "7.113.0" - localforage "^1.8.1" + "@sentry/types" "8.4.0" + "@sentry/utils" "8.4.0" "@sentry/node@^7.69.0": version "7.76.0" @@ -3931,43 +3919,26 @@ "@sentry/utils" "7.76.0" https-proxy-agent "^5.0.0" -"@sentry/react@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry/react/-/react-7.113.0.tgz#8e21c92e9691ea881639596d7e60a996b23ba229" - integrity sha512-+zVPz+h5Wydq4ntekw3/dXq5jeHIpZoQ2iqhB96PA9Y94JIq178i/xIP204S1h6rN7cmWAqtR93vnPKdxnlUbQ== +"@sentry/react@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry/react/-/react-8.4.0.tgz#95f4fed03709b231770a4f32d3c960c544b0dc3c" + integrity sha512-YnDN+szKFm1fQ9311nAulsRbboeMbqNmosMLA6PweBDEwD0HEJsovQT+ZJxXiOL220qsgWVJzk+aTPtf+oY4wA== dependencies: - "@sentry/browser" "7.113.0" - "@sentry/core" "7.113.0" - "@sentry/types" "7.113.0" - "@sentry/utils" "7.113.0" + "@sentry/browser" "8.4.0" + "@sentry/core" "8.4.0" + "@sentry/types" "8.4.0" + "@sentry/utils" "8.4.0" hoist-non-react-statics "^3.3.2" -"@sentry/replay@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry/replay/-/replay-7.113.0.tgz#db41b792e5d9966a9b1ca4eb1695ad7100f39b50" - integrity sha512-UD2IaphOWKFdeGR+ZiaNAQ+wFsnwbJK6PNwcW6cHmWKv9COlKufpFt06lviaqFZ8jmNrM4H+r+R8YVTrqCuxgg== - dependencies: - "@sentry-internal/tracing" "7.113.0" - "@sentry/core" "7.113.0" - "@sentry/types" "7.113.0" - "@sentry/utils" "7.113.0" - -"@sentry/types@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry/types/-/types-7.113.0.tgz#2193c9933838302c82814771b03a8647fa684ffb" - integrity sha512-PJbTbvkcPu/LuRwwXB1He8m+GjDDLKBtu3lWg5xOZaF5IRdXQU2xwtdXXsjge4PZR00tF7MO7X8ZynTgWbYaew== - "@sentry/types@7.76.0": version "7.76.0" resolved "https://registry.yarnpkg.com/@sentry/types/-/types-7.76.0.tgz#628c9899bfa82ea762708314c50fd82f2138587d" integrity sha512-vj6z+EAbVrKAXmJPxSv/clpwS9QjPqzkraMFk2hIdE/kii8s8kwnkBwTSpIrNc8GnzV3qYC4r3qD+BXDxAGPaw== -"@sentry/utils@7.113.0": - version "7.113.0" - resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-7.113.0.tgz#1e6e790c9d84e4809b2bb529bbd33a506b6db7bd" - integrity sha512-nzKsErwmze1mmEsbW2AwL2oB+I5v6cDEJY4sdfLekA4qZbYZ8pV5iWza6IRl4XfzGTE1qpkZmEjPU9eyo0yvYw== - dependencies: - "@sentry/types" "7.113.0" +"@sentry/types@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry/types/-/types-8.4.0.tgz#42500005a198ff8c247490434ed55e0a9f975ad1" + integrity sha512-mHUaaYEQCNukzYsTLp4rP2NNO17vUf+oSGS6qmhrsGqmGNICKw2CIwJlPPGeAkq9Y4tiUOye2m5OT1xsOtxLIw== "@sentry/utils@7.76.0": version "7.76.0" @@ -3976,6 +3947,13 @@ dependencies: "@sentry/types" "7.76.0" +"@sentry/utils@8.4.0": + version "8.4.0" + resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-8.4.0.tgz#1b816e65d8dbf055c5e1554361aaf9a8a8a94102" + integrity sha512-oDF0RVWW0AyEnsP1x4McHUvQSAxJgx3G6wM9Sb4wc1F8rwsHnCtGHc+WRZ5Gd2AXC5EGkfbg5919+1ku/L4Dww== + dependencies: + "@sentry/types" "8.4.0" + "@sentry/wizard@3.16.3": version "3.16.3" resolved "https://registry.yarnpkg.com/@sentry/wizard/-/wizard-3.16.3.tgz#73469136408ad8b33d5761a8a0f74693e8b9cc34" @@ -8252,11 +8230,6 @@ image-size@^1.0.2: dependencies: queue "6.0.2" -immediate@~3.0.5: - version "3.0.6" - resolved "https://registry.yarnpkg.com/immediate/-/immediate-3.0.6.tgz#9db1dbd0faf8de6fbe0f5dd5e56bb606280de69b" - integrity sha1-nbHb0Pr43m++D13V5Wu2BigN5ps= - import-fresh@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-2.0.0.tgz#d81355c15612d386c61f9ddd3922d4304822a546" @@ -9796,13 +9769,6 @@ levn@~0.3.0: prelude-ls "~1.1.2" type-check "~0.3.2" -lie@3.1.1: - version "3.1.1" - resolved "https://registry.yarnpkg.com/lie/-/lie-3.1.1.tgz#9a436b2cc7746ca59de7a41fa469b3efb76bd87e" - integrity sha1-mkNrLMd0bKWd56QfpGmz77dr2H4= - dependencies: - immediate "~3.0.5" - lighthouse-logger@^1.0.0: version "1.4.2" resolved "https://registry.yarnpkg.com/lighthouse-logger/-/lighthouse-logger-1.4.2.tgz#aef90f9e97cd81db367c7634292ee22079280aaa" @@ -9882,13 +9848,6 @@ load-json-file@^2.0.0: pify "^2.0.0" strip-bom "^3.0.0" -localforage@^1.8.1: - version "1.9.0" - resolved "https://registry.yarnpkg.com/localforage/-/localforage-1.9.0.tgz#f3e4d32a8300b362b4634cc4e066d9d00d2f09d1" - integrity sha512-rR1oyNrKulpe+VM9cYmcFn6tsHuokyVHFaCM3+osEmxaHTbEk8oQu6eGDfS6DQLWi/N67XRmB8ECG37OES368g== - dependencies: - lie "3.1.1" - locate-path@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-2.0.0.tgz#2b568b265eec944c6d9c0de9c3dbbbca0354cd8e" @@ -12275,11 +12234,6 @@ requireg@^0.2.2: rc "~1.2.7" resolve "~1.7.1" -requireindex@~1.1.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/requireindex/-/requireindex-1.1.0.tgz#e5404b81557ef75db6e49c5a72004893fe03e162" - integrity sha1-5UBLgVV+91225JxacgBIk/4D4WI= - requirejs-config-file@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/requirejs-config-file/-/requirejs-config-file-4.0.0.tgz#4244da5dd1f59874038cc1091d078d620abb6ebc" @@ -12955,7 +12909,7 @@ string-length@^5.0.1: char-regex "^2.0.0" strip-ansi "^7.0.1" -"string-width-cjs@npm:string-width@^4.2.0": +"string-width-cjs@npm:string-width@^4.2.0", "string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.2.3: version "4.2.3" resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== @@ -12973,15 +12927,6 @@ string-width@^1.0.1: is-fullwidth-code-point "^1.0.0" strip-ansi "^3.0.0" -"string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.2.3: - version "4.2.3" - resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" - integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== - dependencies: - emoji-regex "^8.0.0" - is-fullwidth-code-point "^3.0.0" - strip-ansi "^6.0.1" - string-width@^2.1.0: version "2.1.1" resolved "https://registry.yarnpkg.com/string-width/-/string-width-2.1.1.tgz#ab93f27a8dc13d28cac815c462143a6d9012ae9e" @@ -13133,7 +13078,7 @@ stringify-object@^3.2.1: is-obj "^1.0.1" is-regexp "^1.0.0" -"strip-ansi-cjs@npm:strip-ansi@^6.0.1": +"strip-ansi-cjs@npm:strip-ansi@^6.0.1", strip-ansi@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== @@ -13168,13 +13113,6 @@ strip-ansi@^6.0.0: dependencies: ansi-regex "^5.0.0" -strip-ansi@^6.0.1: - version "6.0.1" - resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" - integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== - dependencies: - ansi-regex "^5.0.1" - strip-ansi@^7.0.1: version "7.1.0" resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.0.tgz#d5b6568ca689d8561370b0707685d22434faff45" @@ -14170,7 +14108,7 @@ word-wrap@^1.2.3, word-wrap@~1.2.3: resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c" integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ== -"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0": +"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0", wrap-ansi@^7.0.0: version "7.0.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== @@ -14188,15 +14126,6 @@ wrap-ansi@^6.2.0: string-width "^4.1.0" strip-ansi "^6.0.0" -wrap-ansi@^7.0.0: - version "7.0.0" - resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" - integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== - dependencies: - ansi-styles "^4.0.0" - string-width "^4.1.0" - strip-ansi "^6.0.0" - wrap-ansi@^8.1.0: version "8.1.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-8.1.0.tgz#56dc22368ee570face1b49819975d9b9a5ead214" From 23db154e2eaa4c8a8cf95fe479f0c12cc14887d7 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Tue, 25 Jun 2024 11:11:34 +0200 Subject: [PATCH 05/48] chore(deps): Update to sentry-javascript 8.11.0 (#3910) --- package.json | 16 +-- src/js/integrations/debugsymbolicator.ts | 2 +- src/js/tools/sentryMetroSerializer.ts | 2 +- src/js/tracing/reactnativetracing.ts | 14 +- src/js/tracing/timetodisplay.tsx | 10 +- src/js/vendor/react-native/index.ts | 10 +- tsconfig.build.json | 3 +- yarn.lock | 162 +++++++++++------------ 8 files changed, 111 insertions(+), 108 deletions(-) diff --git a/package.json b/package.json index d2482963da..fdbe3bd950 100644 --- a/package.json +++ b/package.json @@ -67,20 +67,20 @@ "react-native": ">=0.65.0" }, "dependencies": { - "@sentry/browser": "8.4.0", + "@sentry/browser": "8.11.0", "@sentry/cli": "2.31.2", - "@sentry/core": "8.4.0", - "@sentry/react": "8.4.0", - "@sentry/types": "8.4.0", - "@sentry/utils": "8.4.0" + "@sentry/core": "8.11.0", + "@sentry/react": "8.11.0", + "@sentry/types": "8.11.0", + "@sentry/utils": "8.11.0" }, "devDependencies": { "@babel/core": "^7.23.5", "@expo/metro-config": "0.17.5", "@mswjs/interceptors": "^0.25.15", - "@sentry-internal/eslint-config-sdk": "8.4.0", - "@sentry-internal/eslint-plugin-sdk": "8.4.0", - "@sentry-internal/typescript": "8.4.0", + "@sentry-internal/eslint-config-sdk": "8.11.0", + "@sentry-internal/eslint-plugin-sdk": "8.11.0", + "@sentry-internal/typescript": "8.11.0", "@sentry/wizard": "3.16.3", "@types/jest": "^29.5.3", "@types/node": "^20.9.3", diff --git a/src/js/integrations/debugsymbolicator.ts b/src/js/integrations/debugsymbolicator.ts index aa2ccc1101..f0d5e86141 100644 --- a/src/js/integrations/debugsymbolicator.ts +++ b/src/js/integrations/debugsymbolicator.ts @@ -72,7 +72,7 @@ async function symbolicate(rawStack: string, skipFirstFrames: number = 0): Promi } // This has been changed in an react-native version so stack is contained in here - const newStack = prettyStack.stack || prettyStack; + const newStack = 'stack' in prettyStack ? prettyStack.stack : prettyStack; // https://github.com/getsentry/sentry-javascript/blob/739d904342aaf9327312f409952f14ceff4ae1ab/packages/utils/src/stacktrace.ts#L23 // Match SentryParser which counts lines of stack (-1 for first line with the Error message) diff --git a/src/js/tools/sentryMetroSerializer.ts b/src/js/tools/sentryMetroSerializer.ts index 05ab40d1ac..62c47be247 100644 --- a/src/js/tools/sentryMetroSerializer.ts +++ b/src/js/tools/sentryMetroSerializer.ts @@ -130,7 +130,7 @@ function addDebugIdModule( modifiedPreModules[0].path === PRELUDE_MODULE_PATH ) { // prelude module must be first as it measures the bundle startup time - modifiedPreModules.unshift(preModules[0]); + modifiedPreModules.unshift(preModules[0] as Module); modifiedPreModules[1] = debugIdModule; } else { modifiedPreModules.unshift(debugIdModule); diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index f3947fb876..6a6cbce694 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -287,27 +287,27 @@ export class ReactNativeTracing implements Integration { public startUserInteractionSpan(userInteractionId: { elementId: string | undefined; op: string }): Span | undefined { const client = this._client; if (!client) { - return; + return undefined; } const { elementId, op } = userInteractionId; if (!this.options.enableUserInteractionTracing) { logger.log('[ReactNativeTracing] User Interaction Tracing is disabled.'); - return; + return undefined; } if (!this.options.routingInstrumentation) { logger.error( '[ReactNativeTracing] User Interaction Tracing is not working because no routing instrumentation is set.', ); - return; + return undefined; } if (!elementId) { logger.log('[ReactNativeTracing] User Interaction Tracing can not create transaction with undefined elementId.'); - return; + return undefined; } if (!this._currentRoute) { logger.log('[ReactNativeTracing] User Interaction Tracing can not create transaction without a current route.'); - return; + return undefined; } const activeTransaction = getActiveSpan(); @@ -321,7 +321,7 @@ export class ReactNativeTracing implements Integration { spanToJSON(activeTransaction).description } exists on the scope.`, ); - return; + return undefined; } const name = `${this._currentRoute}.${elementId}`; @@ -335,7 +335,7 @@ export class ReactNativeTracing implements Integration { spanToJSON(this._inflightInteractionTransaction).description } already exists on the scope.`, ); - return; + return undefined; } if (this._inflightInteractionTransaction) { diff --git a/src/js/tracing/timetodisplay.tsx b/src/js/tracing/timetodisplay.tsx index 8a8c6e4236..6976f2025f 100644 --- a/src/js/tracing/timetodisplay.tsx +++ b/src/js/tracing/timetodisplay.tsx @@ -94,7 +94,7 @@ export function startTimeToInitialDisplaySpan( const activeSpan = getActiveSpan(); if (!activeSpan) { logger.warn(`[TimeToDisplay] No active span found to attach ui.load.initial_display to.`); - return; + return undefined; } const existingSpan = getSpanDescendants(activeSpan).find((span) => spanToJSON(span).op === 'ui.load.initial_display'); @@ -111,7 +111,7 @@ export function startTimeToInitialDisplaySpan( }); if (!initialDisplaySpan) { - return; + return undefined; } if (!options?.isAutoInstrumented) { @@ -133,7 +133,7 @@ export function startTimeToFullDisplaySpan( const activeSpan = getActiveSpan(); if (!activeSpan) { logger.warn(`[TimeToDisplay] No active span found to attach ui.load.full_display to.`); - return; + return undefined; } const descendantSpans = getSpanDescendants(activeSpan); @@ -141,7 +141,7 @@ export function startTimeToFullDisplaySpan( const initialDisplaySpan = descendantSpans.find((span) => spanToJSON(span).op === 'ui.load.initial_display'); if (!initialDisplaySpan) { logger.warn(`[TimeToDisplay] No initial display span found to attach ui.load.full_display to.`); - return; + return undefined; } const existingSpan = descendantSpans.find((span) => spanToJSON(span).op === 'ui.load.full_display'); @@ -157,7 +157,7 @@ export function startTimeToFullDisplaySpan( ...options, }); if (!fullDisplaySpan) { - return; + return undefined; } const timeout = setTimeout(() => { diff --git a/src/js/vendor/react-native/index.ts b/src/js/vendor/react-native/index.ts index de54382381..31ef54444a 100644 --- a/src/js/vendor/react-native/index.ts +++ b/src/js/vendor/react-native/index.ts @@ -41,10 +41,12 @@ export type CodeFrame = Readonly<{ }>; // Adapted from https://github.com/facebook/react-native/blob/d09c02f9e2d468e4d0bde51890e312ae7003a3e6/packages/react-native/Libraries/Core/Devtools/symbolicateStackTrace.js#L27 -export type SymbolicatedStackTrace = Readonly<{ - stack: Array; - codeFrame?: CodeFrame; -}>; +export type SymbolicatedStackTrace = + | Readonly<{ + stack: Array; + codeFrame?: CodeFrame; + }> + | Array; // Adapted from https://github.com/facebook/react-native/blob/d09c02f9e2d468e4d0bde51890e312ae7003a3e6/packages/react-native/Libraries/Core/Devtools/getDevServer.js#L17 export type DevServerInfo = { diff --git a/tsconfig.build.json b/tsconfig.build.json index a246661478..84c1ce9e7c 100644 --- a/tsconfig.build.json +++ b/tsconfig.build.json @@ -24,6 +24,7 @@ "module": "es6", "skipLibCheck": true, "allowSyntheticDefaultImports": true, - "strictBindCallApply": true + "strictBindCallApply": true, + "strictNullChecks": false } } diff --git a/yarn.lock b/yarn.lock index 2c75e976fb..669ab7615e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3739,22 +3739,22 @@ component-type "^1.2.1" join-component "^1.1.0" -"@sentry-internal/browser-utils@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/browser-utils/-/browser-utils-8.4.0.tgz#5b108878e93713757d75e7e8ae7780297d36ad17" - integrity sha512-Mfm3TK3KUlghhuKM3rjTeD4D5kAiB7iVNFoaDJIJBVKa67M9BvlNTnNJMDi7+9rV4RuLQYxXn0p5HEZJFYp3Zw== - dependencies: - "@sentry/core" "8.4.0" - "@sentry/types" "8.4.0" - "@sentry/utils" "8.4.0" - -"@sentry-internal/eslint-config-sdk@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-config-sdk/-/eslint-config-sdk-8.4.0.tgz#432d56a8969c4b1c699cfaa0d5f2be4eb7835dbc" - integrity sha512-9jC2PBUw0Gn2ZlCeKeDfSMKsUPJczyQYoG7x2gHce/zur7jpKIc5DTt5NM74Sjyai7wMyUY2rLP8GnFdYPQosg== - dependencies: - "@sentry-internal/eslint-plugin-sdk" "8.4.0" - "@sentry-internal/typescript" "8.4.0" +"@sentry-internal/browser-utils@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/browser-utils/-/browser-utils-8.11.0.tgz#ee73594bde569608b0dd0c8aa499f8497dbb0f53" + integrity sha512-PCnmzeLm7eTdMleVWa1jbdNcB6M5R17CSX8oQF6A/5a2w9qW6HbjEwK6X4yc9MzsFXFaTNekvPQLMRhIE1MgpA== + dependencies: + "@sentry/core" "8.11.0" + "@sentry/types" "8.11.0" + "@sentry/utils" "8.11.0" + +"@sentry-internal/eslint-config-sdk@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-config-sdk/-/eslint-config-sdk-8.11.0.tgz#73009825229e8f1fd8053c42aca8409c94695610" + integrity sha512-Qhwnhx+rEuD6Y1Ar5u74nn51f+rOfqtkyYkVrfJRCH+ob+hTD92TjA4yWer9nzYaVpPJmh09vktyAVAlFDXoaQ== + dependencies: + "@sentry-internal/eslint-plugin-sdk" "8.11.0" + "@sentry-internal/typescript" "8.11.0" "@typescript-eslint/eslint-plugin" "^5.48.0" "@typescript-eslint/parser" "^5.48.0" eslint-config-prettier "^6.11.0" @@ -3764,39 +3764,39 @@ eslint-plugin-jsdoc "^30.0.3" eslint-plugin-simple-import-sort "^5.0.3" -"@sentry-internal/eslint-plugin-sdk@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-plugin-sdk/-/eslint-plugin-sdk-8.4.0.tgz#eca0a66d2b4af76139881d4c252db83ca301afbf" - integrity sha512-w1YbQR+c6w0mu3WUvX2tD/E6o3hCQmgutBlQu0qElVmEPwgUgMS6b5036MnYZt7AHCIfuBqEA4DHaQt+3zT/Lw== +"@sentry-internal/eslint-plugin-sdk@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-plugin-sdk/-/eslint-plugin-sdk-8.11.0.tgz#f79bdb65fc4b6b1e2bbe1400809cb890e783928f" + integrity sha512-1JVY3u2/4IRFuKzXjW6EJ4tbGVoQocWSi2f6xjUndN55cHJe94it/IrYFUnK1wjWOX4JIrJrmuow3yULgTD/Ag== -"@sentry-internal/feedback@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-8.4.0.tgz#81067dadda249b354b72f5adba20374dea43fdf4" - integrity sha512-1/WshI2X9seZAQXrOiv6/LU08fbSSvJU0b1ZWMhn+onb/FWPomsL/UN0WufCYA65S5JZGdaWC8fUcJxWC8PATQ== +"@sentry-internal/feedback@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-8.11.0.tgz#72bfa11678dfa19857a3cf6943a05f0ddb72f12d" + integrity sha512-cMiFAuHP4jXCqWD7/UA5cvl0ee3hN5klAWTDVCZutnZ30pbUurg+nIggYBcaxdtLlqW6BCwyVs2nb/OB75CCSQ== dependencies: - "@sentry/core" "8.4.0" - "@sentry/types" "8.4.0" - "@sentry/utils" "8.4.0" + "@sentry/core" "8.11.0" + "@sentry/types" "8.11.0" + "@sentry/utils" "8.11.0" -"@sentry-internal/replay-canvas@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-8.4.0.tgz#cf5e903d8935ba6b60a5027d0055902987353920" - integrity sha512-g+U4IPQdODCg7fQQVNvH6ix05Tl1mOQXXRexgtp+tXdys4sHQSBUYraJYZy+mY3OGnLRgKFqELM0fnffJSpuyQ== +"@sentry-internal/replay-canvas@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-8.11.0.tgz#c01c1385c426a39189bec151a74bc173b6068a4b" + integrity sha512-SrBFI0vwyeyUjibCbYfxzCNMd07QMDNoi+0SYzhBagp6ALbU8r/pa02JRsnr//qhZt2NOM6S2kks9e2VHr6hYg== dependencies: - "@sentry-internal/replay" "8.4.0" - "@sentry/core" "8.4.0" - "@sentry/types" "8.4.0" - "@sentry/utils" "8.4.0" + "@sentry-internal/replay" "8.11.0" + "@sentry/core" "8.11.0" + "@sentry/types" "8.11.0" + "@sentry/utils" "8.11.0" -"@sentry-internal/replay@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/replay/-/replay-8.4.0.tgz#8fc4a6bf1d5f480fcde2d56cd75042953e44efda" - integrity sha512-RSzQwCF/QTi5/5XAuj0VJImAhu4MheeHYvAbr/PuMSF4o1j89gBA7e3boA4u8633IqUeu5w3S5sb6jVrKaVifg== +"@sentry-internal/replay@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/replay/-/replay-8.11.0.tgz#58c923fbae32204ad32e1e99c01c4040c1e06b2f" + integrity sha512-NyuHW1Ds2GGW6PjN7nnRl/XoM31Y/BUnOhhLbNmbxWj5mgWuUP/7tOlz2PhP0YqZxVteZ99QIssfSRgtYOeQlg== dependencies: - "@sentry-internal/browser-utils" "8.4.0" - "@sentry/core" "8.4.0" - "@sentry/types" "8.4.0" - "@sentry/utils" "8.4.0" + "@sentry-internal/browser-utils" "8.11.0" + "@sentry/core" "8.11.0" + "@sentry/types" "8.11.0" + "@sentry/utils" "8.11.0" "@sentry-internal/tracing@7.76.0": version "7.76.0" @@ -3807,23 +3807,23 @@ "@sentry/types" "7.76.0" "@sentry/utils" "7.76.0" -"@sentry-internal/typescript@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/typescript/-/typescript-8.4.0.tgz#6ebc97285e516ad2c2ef09e368821d9ecb39c57e" - integrity sha512-EgkYnSAi1Ryvb5t2xmMA7mc63ohpFh/CRaDdQUBQdNOK+TVH2wul7h525V3hUkxDJRHZxnNb7a6TWvfCZR7bYA== +"@sentry-internal/typescript@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/typescript/-/typescript-8.11.0.tgz#a4552bf3918671d6723b6ec1fd448180a94217b6" + integrity sha512-AsyiBomA0MCJulIV15+JWqabgfNj/2Wjsu3epAvGtjcNST7tCq0tfEwjXUv4JKGMORmkUqf1Js15wnu3HEXBUA== -"@sentry/browser@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-8.4.0.tgz#f4aa381eab212432d71366884693a36c2e3a1675" - integrity sha512-hmXeIZBdN0A6yCuoMTcigGxLl42nbeb205fXtouwE7Maa0qM2HM+Ijq0sHzbhxR3zU0JXDtcJh1k6wtJOREJ3g== +"@sentry/browser@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-8.11.0.tgz#9e0282a9136d138c8b6c001f0ac9face9a9ce18b" + integrity sha512-++5IrBpzkaAptNjAYnGTnQ2lCjmU6nlu/ABFjUTgi7Vu+ZNiY8qYKEUw65mSxD3EoFLt8IwtjvfAwSMVTB2q8w== dependencies: - "@sentry-internal/browser-utils" "8.4.0" - "@sentry-internal/feedback" "8.4.0" - "@sentry-internal/replay" "8.4.0" - "@sentry-internal/replay-canvas" "8.4.0" - "@sentry/core" "8.4.0" - "@sentry/types" "8.4.0" - "@sentry/utils" "8.4.0" + "@sentry-internal/browser-utils" "8.11.0" + "@sentry-internal/feedback" "8.11.0" + "@sentry-internal/replay" "8.11.0" + "@sentry-internal/replay-canvas" "8.11.0" + "@sentry/core" "8.11.0" + "@sentry/types" "8.11.0" + "@sentry/utils" "8.11.0" "@sentry/cli-darwin@2.31.2": version "2.31.2" @@ -3900,13 +3900,13 @@ "@sentry/types" "7.76.0" "@sentry/utils" "7.76.0" -"@sentry/core@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry/core/-/core-8.4.0.tgz#ab3f7202f3cae82daf4c3c408f50d2c6fb913620" - integrity sha512-0eACPlJvKloFIlcT1c/vjGnvqxLxpGyGuSsU7uonrkmBqIRwLYXWtR4PoHapysKtjPVoHAn9au50ut6ymC2V8Q== +"@sentry/core@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry/core/-/core-8.11.0.tgz#bd78d9b598b6658ad18c8e0457fdffcd5f95b51e" + integrity sha512-rZaM55j5Fw0IGb8lNXOTVoq7WR6JmUzm9x5cURGsjL9gzAurGl817oK3iyOvYQ3JZnfijjh0QF0SQr4NZHKbIg== dependencies: - "@sentry/types" "8.4.0" - "@sentry/utils" "8.4.0" + "@sentry/types" "8.11.0" + "@sentry/utils" "8.11.0" "@sentry/node@^7.69.0": version "7.76.0" @@ -3919,15 +3919,15 @@ "@sentry/utils" "7.76.0" https-proxy-agent "^5.0.0" -"@sentry/react@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry/react/-/react-8.4.0.tgz#95f4fed03709b231770a4f32d3c960c544b0dc3c" - integrity sha512-YnDN+szKFm1fQ9311nAulsRbboeMbqNmosMLA6PweBDEwD0HEJsovQT+ZJxXiOL220qsgWVJzk+aTPtf+oY4wA== +"@sentry/react@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry/react/-/react-8.11.0.tgz#324353df35f6e9a28448fabd7501577be2fbcd7f" + integrity sha512-EyPOxDyRwOMPHRCc1/+dlWygXb6+92d0AbVTo4C8ZPT67aMWiczMzZC9qVUN6OqDVrpKwHMYzRyCdsu5OIIWHw== dependencies: - "@sentry/browser" "8.4.0" - "@sentry/core" "8.4.0" - "@sentry/types" "8.4.0" - "@sentry/utils" "8.4.0" + "@sentry/browser" "8.11.0" + "@sentry/core" "8.11.0" + "@sentry/types" "8.11.0" + "@sentry/utils" "8.11.0" hoist-non-react-statics "^3.3.2" "@sentry/types@7.76.0": @@ -3935,10 +3935,10 @@ resolved "https://registry.yarnpkg.com/@sentry/types/-/types-7.76.0.tgz#628c9899bfa82ea762708314c50fd82f2138587d" integrity sha512-vj6z+EAbVrKAXmJPxSv/clpwS9QjPqzkraMFk2hIdE/kii8s8kwnkBwTSpIrNc8GnzV3qYC4r3qD+BXDxAGPaw== -"@sentry/types@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry/types/-/types-8.4.0.tgz#42500005a198ff8c247490434ed55e0a9f975ad1" - integrity sha512-mHUaaYEQCNukzYsTLp4rP2NNO17vUf+oSGS6qmhrsGqmGNICKw2CIwJlPPGeAkq9Y4tiUOye2m5OT1xsOtxLIw== +"@sentry/types@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry/types/-/types-8.11.0.tgz#613da07f91d58ad5b460b95550e64aa6159ee97f" + integrity sha512-kz9/d2uw7wEXcK8DnCrCuMI75hZnpVAjYr8mq1uatltOx+2JOYPNdaK6ispxXlhb5KXOnVWNgfVDbGlLp0w+Gg== "@sentry/utils@7.76.0": version "7.76.0" @@ -3947,12 +3947,12 @@ dependencies: "@sentry/types" "7.76.0" -"@sentry/utils@8.4.0": - version "8.4.0" - resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-8.4.0.tgz#1b816e65d8dbf055c5e1554361aaf9a8a8a94102" - integrity sha512-oDF0RVWW0AyEnsP1x4McHUvQSAxJgx3G6wM9Sb4wc1F8rwsHnCtGHc+WRZ5Gd2AXC5EGkfbg5919+1ku/L4Dww== +"@sentry/utils@8.11.0": + version "8.11.0" + resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-8.11.0.tgz#b8856db2c1cfc1835df8854cba20cea82f6c6e08" + integrity sha512-iDt5YVMYNgT151bPYVGo8XlpM0MHWy8DH+czmAiAlFTV7ns7lAeHGF6tsFYo7wOZOPDHxtF6F2CM7AvuYnOZGw== dependencies: - "@sentry/types" "8.4.0" + "@sentry/types" "8.11.0" "@sentry/wizard@3.16.3": version "3.16.3" From 6af7578cfcf4b8bd84bdf0056ed51134d477b947 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Tue, 25 Jun 2024 16:25:07 +0200 Subject: [PATCH 06/48] fix(scope): Hooks into Global and Isolations Scopes for Sync with the native scope (#3911) --- src/js/scope.ts | 106 ---------------------- src/js/scopeSync.ts | 78 ++++++++++++++++ src/js/sdk.tsx | 14 ++- src/js/utils/fill.ts | 13 +++ test/scope.test.ts | 102 --------------------- test/scopeSync.test.ts | 199 +++++++++++++++++++++++++++++++++++++++++ 6 files changed, 300 insertions(+), 212 deletions(-) delete mode 100644 src/js/scope.ts create mode 100644 src/js/scopeSync.ts create mode 100644 src/js/utils/fill.ts delete mode 100644 test/scope.test.ts create mode 100644 test/scopeSync.test.ts diff --git a/src/js/scope.ts b/src/js/scope.ts deleted file mode 100644 index bf8454b52f..0000000000 --- a/src/js/scope.ts +++ /dev/null @@ -1,106 +0,0 @@ -import { Scope } from '@sentry/core'; -import type { Attachment, Breadcrumb, User } from '@sentry/types'; - -import { DEFAULT_BREADCRUMB_LEVEL } from './breadcrumb'; -import { convertToNormalizedObject } from './utils/normalize'; -import { NATIVE } from './wrapper'; - -/** - * Extends the scope methods to set scope on the Native SDKs - */ -export class ReactNativeScope extends Scope { - /** - * @inheritDoc - */ - public setUser(user: User | null): this { - NATIVE.setUser(user); - return super.setUser(user); - } - - /** - * @inheritDoc - */ - public setTag(key: string, value: string): this { - NATIVE.setTag(key, value); - return super.setTag(key, value); - } - - /** - * @inheritDoc - */ - public setTags(tags: { [key: string]: string }): this { - // As native only has setTag, we just loop through each tag key. - Object.keys(tags).forEach(key => { - NATIVE.setTag(key, tags[key]); - }); - return super.setTags(tags); - } - - /** - * @inheritDoc - */ - // eslint-disable-next-line @typescript-eslint/no-explicit-any - public setExtras(extras: { [key: string]: any }): this { - Object.keys(extras).forEach(key => { - NATIVE.setExtra(key, extras[key]); - }); - return super.setExtras(extras); - } - - /** - * @inheritDoc - */ - // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types,@typescript-eslint/no-explicit-any - public setExtra(key: string, extra: any): this { - NATIVE.setExtra(key, extra); - return super.setExtra(key, extra); - } - - /** - * @inheritDoc - */ - public addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this { - const mergedBreadcrumb: Breadcrumb = { - ...breadcrumb, - level: breadcrumb.level || DEFAULT_BREADCRUMB_LEVEL, - data: breadcrumb.data ? convertToNormalizedObject(breadcrumb.data) : undefined, - }; - - super.addBreadcrumb(mergedBreadcrumb, maxBreadcrumbs); - - const finalBreadcrumb = this._breadcrumbs[this._breadcrumbs.length - 1]; - NATIVE.addBreadcrumb(finalBreadcrumb); - return this; - } - - /** - * @inheritDoc - */ - public clearBreadcrumbs(): this { - NATIVE.clearBreadcrumbs(); - return super.clearBreadcrumbs(); - } - - /** - * @inheritDoc - */ - // eslint-disable-next-line @typescript-eslint/no-explicit-any - public setContext(key: string, context: { [key: string]: any } | null): this { - NATIVE.setContext(key, context); - return super.setContext(key, context); - } - - /** - * @inheritDoc - */ - public addAttachment(attachment: Attachment): this { - return super.addAttachment(attachment); - } - - /** - * @inheritDoc - */ - public clearAttachments(): this { - return super.clearAttachments(); - } -} diff --git a/src/js/scopeSync.ts b/src/js/scopeSync.ts new file mode 100644 index 0000000000..770d7c9d43 --- /dev/null +++ b/src/js/scopeSync.ts @@ -0,0 +1,78 @@ +import type { Breadcrumb, Scope } from '@sentry/types'; + +import { DEFAULT_BREADCRUMB_LEVEL } from './breadcrumb'; +import { fillTyped } from './utils/fill'; +import { convertToNormalizedObject } from './utils/normalize'; +import { NATIVE } from './wrapper'; + +/** + * This WeakMap is used to keep track of which scopes have been synced to the native SDKs. + * This ensures that we don't double sync the same scope. + */ +const syncedToNativeMap = new WeakMap(); + +/** + * Hooks into the scope set methods and sync new data added to the given scope with the native SDKs. + */ +export function enableSyncToNative(scope: Scope): void { + if (syncedToNativeMap.has(scope)) { + return; + } + syncedToNativeMap.set(scope, true); + + fillTyped(scope, 'setUser', original => (user): Scope => { + NATIVE.setUser(user); + return original.call(scope, user); + }); + + fillTyped(scope, 'setTag', original => (key, value): Scope => { + NATIVE.setTag(key, value as string); + return original.call(scope, key, value); + }); + + fillTyped(scope, 'setTags', original => (tags): Scope => { + // As native only has setTag, we just loop through each tag key. + Object.keys(tags).forEach(key => { + NATIVE.setTag(key, tags[key] as string); + }); + return original.call(scope, tags); + }); + + fillTyped(scope, 'setExtras', original => (extras): Scope => { + Object.keys(extras).forEach(key => { + NATIVE.setExtra(key, extras[key]); + }); + return original.call(scope, extras); + }); + + fillTyped(scope, 'setExtra', original => (key, value): Scope => { + NATIVE.setExtra(key, value); + return original.call(scope, key, value); + }); + + fillTyped(scope, 'addBreadcrumb', original => (breadcrumb, maxBreadcrumbs): Scope => { + const mergedBreadcrumb: Breadcrumb = { + ...breadcrumb, + level: breadcrumb.level || DEFAULT_BREADCRUMB_LEVEL, + data: breadcrumb.data ? convertToNormalizedObject(breadcrumb.data) : undefined, + }; + + original.call(scope, mergedBreadcrumb, maxBreadcrumbs); + + const finalBreadcrumb = scope.getLastBreadcrumb(); + NATIVE.addBreadcrumb(finalBreadcrumb); + + return scope; + }); + + fillTyped(scope, 'clearBreadcrumbs', original => (): Scope => { + NATIVE.clearBreadcrumbs(); + return original.call(scope); + }); + + // eslint-disable-next-line @typescript-eslint/no-explicit-any + fillTyped(scope, 'setContext', original => (key: string, context: { [key: string]: any } | null): Scope => { + NATIVE.setContext(key, context); + return original.call(scope, key, context); + }); +} diff --git a/src/js/sdk.tsx b/src/js/sdk.tsx index 07576d1f9e..776fe00bff 100644 --- a/src/js/sdk.tsx +++ b/src/js/sdk.tsx @@ -1,10 +1,10 @@ /* eslint-disable complexity */ -import { getClient, getIntegrationsToSetup, initAndBind, withScope as coreWithScope } from '@sentry/core'; +import { getClient, getGlobalScope,getIntegrationsToSetup, getIsolationScope,initAndBind, withScope as coreWithScope } from '@sentry/core'; import { defaultStackParser, makeFetchTransport, } from '@sentry/react'; -import type { Integration, Scope, UserFeedback } from '@sentry/types'; +import type { Integration, Scope,UserFeedback } from '@sentry/types'; import { logger, stackParserFromStackParserOptions } from '@sentry/utils'; import * as React from 'react'; @@ -12,6 +12,7 @@ import { ReactNativeClient } from './client'; import { getDefaultIntegrations } from './integrations/default'; import type { ReactNativeClientOptions, ReactNativeOptions, ReactNativeWrapperOptions } from './options'; import { shouldEnableNativeNagger } from './options'; +import { enableSyncToNative } from './scopeSync'; import { TouchEventBoundary } from './touchevents'; import type { ReactNativeTracing } from './tracing'; import { ReactNativeProfiler } from './tracing'; @@ -43,8 +44,6 @@ export function init(passedOptions: ReactNativeOptions): void { return; } - useEncodePolyfill(); - const maxQueueSize = passedOptions.maxQueueSize // eslint-disable-next-line deprecation/deprecation ?? passedOptions.transportOptions?.bufferSize @@ -53,6 +52,13 @@ export function init(passedOptions: ReactNativeOptions): void { const enableNative = passedOptions.enableNative === undefined || passedOptions.enableNative ? NATIVE.isNativeAvailable() : false; + + useEncodePolyfill(); + if (enableNative) { + enableSyncToNative(getGlobalScope()); + enableSyncToNative(getIsolationScope()); + } + const options: ReactNativeClientOptions = { ...DEFAULT_OPTIONS, ...passedOptions, diff --git a/src/js/utils/fill.ts b/src/js/utils/fill.ts new file mode 100644 index 0000000000..25e034ba9e --- /dev/null +++ b/src/js/utils/fill.ts @@ -0,0 +1,13 @@ +import { fill } from '@sentry/utils'; + +/** + * The same as `import { fill } from '@sentry/utils';` but with explicit types. + */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any +export function fillTyped( + source: Source, + name: Name, + replacement: (original: Source[Name]) => Source[Name], +): void { + fill(source, name, replacement); +} diff --git a/test/scope.test.ts b/test/scope.test.ts deleted file mode 100644 index cccf772076..0000000000 --- a/test/scope.test.ts +++ /dev/null @@ -1,102 +0,0 @@ -import type { Breadcrumb } from '@sentry/types'; - -import { ReactNativeScope } from '../src/js/scope'; -import { NATIVE } from '../src/js/wrapper'; - -jest.mock('../src/js/wrapper'); - -type TestScope = ReactNativeScope & { _breadcrumbs: Breadcrumb[] }; -const createScope = (): TestScope => { - return new ReactNativeScope() as TestScope; -}; - -describe('Scope', () => { - describe('addBreadcrumb', () => { - let scope: TestScope; - let nativeAddBreadcrumbMock: jest.Mock; - - beforeEach(() => { - scope = createScope(); - nativeAddBreadcrumbMock = (NATIVE.addBreadcrumb as jest.Mock).mockImplementationOnce(() => { - return; - }); - }); - - afterEach(() => { - jest.resetAllMocks(); - }); - - it('adds default level if no level specified', () => { - const breadcrumb = { - message: 'test', - timestamp: 1234, - }; - scope.addBreadcrumb(breadcrumb); - expect(scope._breadcrumbs).toEqual([ - { - message: 'test', - timestamp: 1234, - level: 'info', - }, - ]); - }); - - it('adds timestamp to breadcrumb without timestamp', () => { - const breadcrumb = { - message: 'test', - }; - scope.addBreadcrumb(breadcrumb); - expect(scope._breadcrumbs).toEqual([expect.objectContaining({ timestamp: expect.any(Number) })]); - }); - - it('passes breadcrumb with timestamp to native', () => { - const breadcrumb = { - message: 'test', - }; - scope.addBreadcrumb(breadcrumb); - expect(nativeAddBreadcrumbMock).toBeCalledWith( - expect.objectContaining({ - timestamp: expect.any(Number), - }), - ); - }); - - test('undefined breadcrumb data is not normalized when passing to the native layer', () => { - const breadcrumb: Breadcrumb = { - data: undefined, - }; - scope.addBreadcrumb(breadcrumb); - expect(nativeAddBreadcrumbMock).toBeCalledWith( - expect.objectContaining({ - data: undefined, - }), - ); - }); - - test('object is normalized when passing to the native layer', () => { - const breadcrumb: Breadcrumb = { - data: { - foo: NaN, - }, - }; - scope.addBreadcrumb(breadcrumb); - expect(nativeAddBreadcrumbMock).toBeCalledWith( - expect.objectContaining({ - data: { foo: '[NaN]' }, - }), - ); - }); - - test('not object data is converted to object', () => { - const breadcrumb: Breadcrumb = { - data: 'foo' as unknown as object, - }; - scope.addBreadcrumb(breadcrumb); - expect(nativeAddBreadcrumbMock).toBeCalledWith( - expect.objectContaining({ - data: { value: 'foo' }, - }), - ); - }); - }); -}); diff --git a/test/scopeSync.test.ts b/test/scopeSync.test.ts new file mode 100644 index 0000000000..e6f7e161fe --- /dev/null +++ b/test/scopeSync.test.ts @@ -0,0 +1,199 @@ +jest.mock('../src/js/wrapper', () => jest.requireActual('./mockWrapper')); +import * as SentryCore from '@sentry/core'; +import { Scope } from '@sentry/core'; +import type { Breadcrumb } from '@sentry/types'; + +import { enableSyncToNative } from '../src/js/scopeSync'; +import { getDefaultTestClientOptions, TestClient } from './mocks/client'; +import { NATIVE } from './mockWrapper'; + +jest.mock('../src/js/wrapper'); + +describe('ScopeSync', () => { + afterEach(() => { + jest.resetAllMocks(); + }); + + describe('scope apis', () => { + let scope: Scope; + + beforeEach(() => { + scope = new Scope(); + enableSyncToNative(scope); + }); + + describe('addBreadcrumb', () => { + it('it only syncs once per scope', () => { + enableSyncToNative(scope); + enableSyncToNative(scope); + + scope.addBreadcrumb({ message: 'test' }); + + expect(NATIVE.addBreadcrumb).toBeCalledTimes(1); + }); + + it('adds default level if no level specified', () => { + const breadcrumb = { + message: 'test', + timestamp: 1234, + }; + scope.addBreadcrumb(breadcrumb); + expect(scope.getLastBreadcrumb()).toEqual({ + message: 'test', + timestamp: 1234, + level: 'info', + }); + }); + + it('adds timestamp to breadcrumb without timestamp', () => { + const breadcrumb = { + message: 'test', + }; + scope.addBreadcrumb(breadcrumb); + expect(scope.getLastBreadcrumb()).toEqual( + expect.objectContaining({ timestamp: expect.any(Number) }), + ); + }); + + it('passes breadcrumb with timestamp to native', () => { + const breadcrumb = { + message: 'test', + }; + scope.addBreadcrumb(breadcrumb); + expect(NATIVE.addBreadcrumb).toBeCalledWith( + expect.objectContaining({ + timestamp: expect.any(Number), + }), + ); + }); + + test('undefined breadcrumb data is not normalized when passing to the native layer', () => { + const breadcrumb: Breadcrumb = { + data: undefined, + }; + scope.addBreadcrumb(breadcrumb); + expect(NATIVE.addBreadcrumb).toBeCalledWith( + expect.objectContaining({ + data: undefined, + }), + ); + }); + + test('object is normalized when passing to the native layer', () => { + const breadcrumb: Breadcrumb = { + data: { + foo: NaN, + }, + }; + scope.addBreadcrumb(breadcrumb); + expect(NATIVE.addBreadcrumb).toBeCalledWith( + expect.objectContaining({ + data: { foo: '[NaN]' }, + }), + ); + }); + + test('not object data is converted to object', () => { + const breadcrumb: Breadcrumb = { + data: 'foo' as unknown as object, + }; + scope.addBreadcrumb(breadcrumb); + expect(NATIVE.addBreadcrumb).toBeCalledWith( + expect.objectContaining({ + data: { value: 'foo' }, + }), + ); + }); + }); + }); + + describe('static apis', () => { + let setUserScopeSpy: jest.SpyInstance; + let setTagScopeSpy: jest.SpyInstance; + let setTagsScopeSpy: jest.SpyInstance; + let setExtraScopeSpy: jest.SpyInstance; + let setExtrasScopeSpy: jest.SpyInstance; + let addBreadcrumbScopeSpy: jest.SpyInstance; + let setContextScopeSpy: jest.SpyInstance; + + beforeAll(() => { + const testScope = SentryCore.getIsolationScope(); + setUserScopeSpy = jest.spyOn(testScope, 'setUser'); + setTagScopeSpy = jest.spyOn(testScope, 'setTag'); + setTagsScopeSpy = jest.spyOn(testScope, 'setTags'); + setExtraScopeSpy = jest.spyOn(testScope, 'setExtra'); + setExtrasScopeSpy = jest.spyOn(testScope, 'setExtras'); + addBreadcrumbScopeSpy = jest.spyOn(testScope, 'addBreadcrumb'); + setContextScopeSpy = jest.spyOn(testScope, 'setContext'); + }); + + beforeEach(() => { + SentryCore.setCurrentClient(new TestClient(getDefaultTestClientOptions())); + enableSyncToNative(SentryCore.getIsolationScope()); + }); + + it('setUser', () => { + expect(SentryCore.getIsolationScope().setUser).not.toBe(setUserScopeSpy); + + const user = { id: '123' }; + SentryCore.setUser(user); + expect(NATIVE.setUser).toHaveBeenCalledExactlyOnceWith({ id: '123' }); + expect(setUserScopeSpy).toHaveBeenCalledExactlyOnceWith({ id: '123' }); + }); + + it('setTag', () => { + expect(SentryCore.getIsolationScope().setTag).not.toBe(setTagScopeSpy); + + SentryCore.setTag('key', 'value'); + expect(NATIVE.setTag).toHaveBeenCalledExactlyOnceWith('key', 'value'); + expect(setTagScopeSpy).toHaveBeenCalledExactlyOnceWith('key', 'value'); + }); + + it('setTags', () => { + expect(SentryCore.getIsolationScope().setTags).not.toBe(setTagsScopeSpy); + + SentryCore.setTags({ key: 'value', second: 'bar' }); + expect(NATIVE.setTag).toBeCalledTimes(2); + expect(NATIVE.setTag).toHaveBeenCalledWith('key', 'value'); + expect(NATIVE.setTag).toHaveBeenCalledWith('second', 'bar'); + expect(setTagsScopeSpy).toHaveBeenCalledExactlyOnceWith({ key: 'value', second: 'bar' }); + }); + + it('setExtra', () => { + expect(SentryCore.getIsolationScope().setExtra).not.toBe(setExtraScopeSpy); + + SentryCore.setExtra('key', 'value'); + expect(NATIVE.setExtra).toHaveBeenCalledExactlyOnceWith('key', 'value'); + expect(setExtraScopeSpy).toHaveBeenCalledExactlyOnceWith('key', 'value'); + }); + + it('setExtras', () => { + expect(SentryCore.getIsolationScope().setExtras).not.toBe(setExtrasScopeSpy); + + SentryCore.setExtras({ key: 'value', second: 'bar' }); + expect(NATIVE.setExtra).toBeCalledTimes(2); + expect(NATIVE.setExtra).toHaveBeenCalledWith('key', 'value'); + expect(NATIVE.setExtra).toHaveBeenCalledWith('second', 'bar'); + expect(setExtrasScopeSpy).toHaveBeenCalledExactlyOnceWith({ key: 'value', second: 'bar' }); + }); + + it('addBreadcrumb', () => { + expect(SentryCore.getIsolationScope().addBreadcrumb).not.toBe(addBreadcrumbScopeSpy); + + SentryCore.addBreadcrumb({ message: 'test' }); + expect(NATIVE.addBreadcrumb).toHaveBeenCalledExactlyOnceWith(expect.objectContaining({ message: 'test' })); + expect(addBreadcrumbScopeSpy).toHaveBeenCalledExactlyOnceWith( + expect.objectContaining({ message: 'test' }), + expect.any(Number), + ); + }); + + it('setContext', () => { + expect(SentryCore.getIsolationScope().setContext).not.toBe(setContextScopeSpy); + + SentryCore.setContext('key', { key: 'value' }); + expect(NATIVE.setContext).toHaveBeenCalledExactlyOnceWith('key', { key: 'value' }); + expect(setContextScopeSpy).toHaveBeenCalledExactlyOnceWith('key', { key: 'value' }); + }); + }); +}); From bfeaaf7730f525dd521c03b4474973202ac70646 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Fri, 9 Aug 2024 10:40:51 +0200 Subject: [PATCH 07/48] ref(tracing): Extract App Start to a standalone integration (#3852) --- CHANGELOG.md | 21 + samples/react-native/src/App.tsx | 3 + src/js/integrations/default.ts | 4 + src/js/integrations/exports.ts | 1 + src/js/options.ts | 10 + src/js/sdk.tsx | 7 +- src/js/tracing/integrations/appStart.ts | 394 +++++++ src/js/tracing/reactnativeprofiler.tsx | 16 +- src/js/tracing/reactnativetracing.ts | 263 +---- src/js/tracing/utils.ts | 43 +- src/js/utils/span.ts | 24 +- test/mocks/client.ts | 5 +- test/sdk.test.ts | 29 + test/tracing/integrations/appStart.test.ts | 957 ++++++++++++++++++ test/tracing/reactnativenavigation.test.ts | 2 +- test/tracing/reactnativetracing.test.ts | 659 +----------- .../reactnavigation.stalltracking.test.ts | 2 +- test/tracing/reactnavigation.test.ts | 2 +- test/tracing/reactnavigation.ttid.test.tsx | 3 + test/tracing/stalltracking.test.ts | 2 +- 20 files changed, 1518 insertions(+), 929 deletions(-) create mode 100644 src/js/tracing/integrations/appStart.ts create mode 100644 test/tracing/integrations/appStart.test.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index f01ac17299..1193f1210b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,27 @@ ## Unreleased +### Changes + +- New App Start Integration ([#3852](https://github.com/getsentry/sentry-react-native/pull/3852)) + + By default app start spans are attached to the first created transaction. + Standalone mode creates single root span (transaction) including only app start data. + + ```js + import Sentry from '@sentry/react-native'; + + Sentry.init({ + tracesSampleRate: 1.0, + enableAppStartTracking: true, // default true + integrations: [ + Sentry.appStartIntegration({ + standalone: false, // default false + }), + ], + }); + ``` + ### Fixes - Pass `sampleRate` option to the Android SDK ([#3979](https://github.com/getsentry/sentry-react-native/pull/3979)) diff --git a/samples/react-native/src/App.tsx b/samples/react-native/src/App.tsx index 25f9cc4751..ece3bb0ae9 100644 --- a/samples/react-native/src/App.tsx +++ b/samples/react-native/src/App.tsx @@ -88,6 +88,9 @@ Sentry.init({ maskAllVectors: true, // maskAllText: false, }), + Sentry.appStartIntegration({ + standalone: false, + }), ); return integrations.filter(i => i.name !== 'Dedupe'); }, diff --git a/src/js/integrations/default.ts b/src/js/integrations/default.ts index e6efd90786..edf7011479 100644 --- a/src/js/integrations/default.ts +++ b/src/js/integrations/default.ts @@ -6,6 +6,7 @@ import type { ReactNativeClientOptions } from '../options'; import { ReactNativeTracing } from '../tracing'; import { isExpoGo, notWeb } from '../utils/environment'; import { + appStartIntegration, breadcrumbsIntegration, browserApiErrorsIntegration, browserGlobalHandlersIntegration, @@ -100,6 +101,9 @@ export function getDefaultIntegrations(options: ReactNativeClientOptions): Integ if (hasTracingEnabled && options.enableAutoPerformanceTracing) { integrations.push(new ReactNativeTracing()); } + if (hasTracingEnabled && options.enableAppStartTracking) { + integrations.push(appStartIntegration()); + } if (options.enableCaptureFailedRequests) { integrations.push(httpClientIntegration()); } diff --git a/src/js/integrations/exports.ts b/src/js/integrations/exports.ts index 1bb337d5c3..2a34136673 100644 --- a/src/js/integrations/exports.ts +++ b/src/js/integrations/exports.ts @@ -13,6 +13,7 @@ export { viewHierarchyIntegration } from './viewhierarchy'; export { expoContextIntegration } from './expocontext'; export { spotlightIntegration } from './spotlight'; export { mobileReplayIntegration } from '../replay/mobilereplay'; +export { appStartIntegration } from '../tracing/integrations/appStart'; export { breadcrumbsIntegration, diff --git a/src/js/options.ts b/src/js/options.ts index 0c5a4baa43..1d4451a952 100644 --- a/src/js/options.ts +++ b/src/js/options.ts @@ -188,6 +188,16 @@ export interface BaseReactNativeOptions { */ beforeScreenshot?: (event: Event, hint: EventHint) => boolean; + /** + * Track the app start time by adding measurements to the first route transaction. If there is no routing instrumentation + * an app start transaction will be started. + * + * Requires performance monitoring to be enabled. + * + * Default: true + */ + enableAppStartTracking?: boolean; + /** * Options which are in beta, or otherwise not guaranteed to be stable. */ diff --git a/src/js/sdk.tsx b/src/js/sdk.tsx index 776fe00bff..246f635eed 100644 --- a/src/js/sdk.tsx +++ b/src/js/sdk.tsx @@ -14,7 +14,6 @@ import type { ReactNativeClientOptions, ReactNativeOptions, ReactNativeWrapperOp import { shouldEnableNativeNagger } from './options'; import { enableSyncToNative } from './scopeSync'; import { TouchEventBoundary } from './touchevents'; -import type { ReactNativeTracing } from './tracing'; import { ReactNativeProfiler } from './tracing'; import { useEncodePolyfill } from './transports/encodePolyfill'; import { DEFAULT_BUFFER_SIZE, makeNativeTransportFactory } from './transports/native'; @@ -34,6 +33,7 @@ const DEFAULT_OPTIONS: ReactNativeOptions = { attachStacktrace: true, enableCaptureFailedRequests: false, enableNdk: true, + enableAppStartTracking: true, }; /** @@ -112,11 +112,6 @@ export function wrap

>( RootComponent: React.ComponentType

, options?: ReactNativeWrapperOptions ): React.ComponentType

{ - const tracingIntegration = getClient()?.getIntegrationByName?.('ReactNativeTracing') as ReactNativeTracing | undefined; - if (tracingIntegration) { - tracingIntegration.useAppStartWithProfiler = true; - } - const profilerProps = { ...(options?.profilerProps ?? {}), name: RootComponent.displayName ?? 'Root', diff --git a/src/js/tracing/integrations/appStart.ts b/src/js/tracing/integrations/appStart.ts new file mode 100644 index 0000000000..db7bd365b2 --- /dev/null +++ b/src/js/tracing/integrations/appStart.ts @@ -0,0 +1,394 @@ +/* eslint-disable complexity */ +import { + getCapturedScopesOnSpan, + getClient, + getCurrentScope, + SentryNonRecordingSpan, + startInactiveSpan, +} from '@sentry/core'; +import type { Client, Event, Integration, SpanJSON, TransactionEvent } from '@sentry/types'; +import { logger, timestampInSeconds } from '@sentry/utils'; + +import { + APP_START_COLD as APP_START_COLD_MEASUREMENT, + APP_START_WARM as APP_START_WARM_MEASUREMENT, +} from '../../measurements'; +import type { NativeAppStartResponse } from '../../NativeRNSentry'; +import type { ReactNativeClientOptions } from '../../options'; +import { convertSpanToTransaction, setEndTimeValue } from '../../utils/span'; +import { NATIVE } from '../../wrapper'; +import { + APP_START_COLD as APP_START_COLD_OP, + APP_START_WARM as APP_START_WARM_OP, + UI_LOAD as UI_LOAD_OP, +} from '../ops'; +import { ReactNativeTracing } from '../reactnativetracing'; +import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '../semanticAttributes'; +import { createChildSpanJSON, createSpanJSON, getBundleStartTimestampMs } from '../utils'; + +const INTEGRATION_NAME = 'AppStart'; + +export type AppStartIntegration = Integration & { + captureStandaloneAppStart: () => Promise; +}; + +/** + * We filter out app start more than 60s. + * This could be due to many different reasons. + * We've seen app starts with hours, days and even months. + */ +const MAX_APP_START_DURATION_MS = 60_000; + +/** We filter out App starts which timestamp is 60s and more before the transaction start */ +const MAX_APP_START_AGE_MS = 60_000; + +/** App Start transaction name */ +const APP_START_TX_NAME = 'App Start'; + +let recordedAppStartEndTimestampMs: number | undefined = undefined; +let rootComponentCreationTimestampMs: number | undefined = undefined; + +/** + * Records the application start end. + * Used automatically by `Sentry.wrap` and `Sentry.ReactNativeProfiler`. + */ +export async function captureAppStart(): Promise { + const client = getClient(); + if (!client) { + logger.warn('[AppStart] Could not capture App Start, missing client.'); + return; + } + + _setAppStartEndTimestampMs(timestampInSeconds() * 1000); + await client.getIntegrationByName(INTEGRATION_NAME)?.captureStandaloneAppStart(); +} + +/** + * Sets the root component first constructor call timestamp. + * Used automatically by `Sentry.wrap` and `Sentry.ReactNativeProfiler`. + */ +export function setRootComponentCreationTimestampMs(timestampMs: number): void { + recordedAppStartEndTimestampMs && + logger.warn('Setting Root component creation timestamp after app start end is set.'); + rootComponentCreationTimestampMs && logger.warn('Overwriting already set root component creation timestamp.'); + rootComponentCreationTimestampMs = timestampMs; +} + +/** + * For internal use only. + * + * @private + */ +export const _setAppStartEndTimestampMs = (timestampMs: number): void => { + recordedAppStartEndTimestampMs && logger.warn('Overwriting already set app start.'); + recordedAppStartEndTimestampMs = timestampMs; +}; + +/** + * For testing purposes only. + * + * @private + */ +export function _clearRootComponentCreationTimestampMs(): void { + rootComponentCreationTimestampMs = undefined; +} + +/** + * Adds AppStart spans from the native layer to the transaction event. + */ +export const appStartIntegration = ({ + standalone: standaloneUserOption, +}: { + /** + * Should the integration send App Start as a standalone root span (transaction)? + * If false, App Start will be added as a child span to the first transaction. + * + * @default false + */ + standalone?: boolean; +} = {}): AppStartIntegration => { + let _client: Client | undefined = undefined; + let standalone = standaloneUserOption; + let isEnabled = true; + let appStartDataFlushed = false; + + const setup = (client: Client): void => { + _client = client; + const clientOptions = client.getOptions() as ReactNativeClientOptions; + + const { enableAppStartTracking } = clientOptions; + if (!enableAppStartTracking) { + isEnabled = false; + logger.warn('[AppStart] App start tracking is disabled.'); + } + }; + + const afterAllSetup = (client: Client): void => { + if (standaloneUserOption === undefined) { + // If not user defined, set based on the routing instrumentation presence + standalone = !client.getIntegrationByName(ReactNativeTracing.id)?.options + .routingInstrumentation; + } + }; + + const processEvent = async (event: Event): Promise => { + if (!isEnabled || standalone) { + return event; + } + + if (event.type !== 'transaction') { + // App start data is only relevant for transactions + return event; + } + + await attachAppStartToTransactionEvent(event as TransactionEvent); + + return event; + }; + + async function captureStandaloneAppStart(): Promise { + if (!standalone) { + logger.debug( + '[AppStart] App start tracking is enabled. App start will be added to the first transaction as a child span.', + ); + return; + } + + logger.debug('[AppStart] App start tracking standalone root span (transaction).'); + + const span = startInactiveSpan({ + forceTransaction: true, + name: APP_START_TX_NAME, + op: UI_LOAD_OP, + }); + if (span instanceof SentryNonRecordingSpan) { + // Tracing is disabled or the transaction was sampled + return; + } + + setEndTimeValue(span, timestampInSeconds()); + _client.emit('spanEnd', span); + + const event = convertSpanToTransaction(span); + if (!event) { + logger.warn('[AppStart] Failed to convert App Start span to transaction.'); + return; + } + + await attachAppStartToTransactionEvent(event); + if (!event.spans || event.spans.length === 0) { + // No spans were added to the transaction, so we don't need to send it + return; + } + + const scope = getCapturedScopesOnSpan(span).scope || getCurrentScope(); + scope.captureEvent(event); + } + + async function attachAppStartToTransactionEvent(event: TransactionEvent): Promise { + if (appStartDataFlushed) { + // App start data is only relevant for the first transaction + return; + } + + if (!event.contexts || !event.contexts.trace) { + logger.warn('[AppStart] Transaction event is missing trace context. Can not attach app start.'); + return; + } + + const appStart = await NATIVE.fetchNativeAppStart(); + if (!appStart) { + logger.warn('[AppStart] Failed to retrieve the app start metrics from the native layer.'); + return; + } + if (appStart.has_fetched) { + logger.warn('[AppStart] Measured app start metrics were already reported from the native layer.'); + return; + } + + const appStartTimestampMs = appStart.app_start_timestamp_ms; + if (!appStartTimestampMs) { + logger.warn('[AppStart] App start timestamp could not be loaded from the native layer.'); + return; + } + + const appStartEndTimestampMs = recordedAppStartEndTimestampMs || getBundleStartTimestampMs(); + if (!appStartEndTimestampMs) { + logger.warn( + '[AppStart] Javascript failed to record app start end. `setAppStartEndTimestampMs` was not called nor could the bundle start be found.', + ); + return; + } + + const isAppStartWithinBounds = + !!event.start_timestamp && appStartTimestampMs >= event.start_timestamp - MAX_APP_START_AGE_MS; + if (!__DEV__ && !isAppStartWithinBounds) { + logger.warn('[AppStart] App start timestamp is too far in the past to be used for app start span.'); + return; + } + + const appStartDurationMs = appStartEndTimestampMs - appStartTimestampMs; + if (!__DEV__ && appStartDurationMs >= MAX_APP_START_DURATION_MS) { + // Dev builds can have long app start waiting over minute for the first bundle to be produced + logger.warn('[AppStart] App start duration is over a minute long, not adding app start span.'); + return; + } + + appStartDataFlushed = true; + + event.contexts.trace.data = event.contexts.trace.data || {}; + event.contexts.trace.data[SEMANTIC_ATTRIBUTE_SENTRY_OP] = UI_LOAD_OP; + event.contexts.trace.op = UI_LOAD_OP; + + const appStartTimestampSeconds = appStartTimestampMs / 1000; + event.start_timestamp = appStartTimestampSeconds; + + event.spans = event.spans || []; + /** event.spans reference */ + const children: SpanJSON[] = event.spans; + + const maybeTtidSpan = children.find(({ op }) => op === 'ui.load.initial_display'); + if (maybeTtidSpan) { + maybeTtidSpan.start_timestamp = appStartTimestampSeconds; + setSpanDurationAsMeasurementOnTransactionEvent(event, 'time_to_initial_display', maybeTtidSpan); + } + + const maybeTtfdSpan = children.find(({ op }) => op === 'ui.load.full_display'); + if (maybeTtfdSpan) { + maybeTtfdSpan.start_timestamp = appStartTimestampSeconds; + setSpanDurationAsMeasurementOnTransactionEvent(event, 'time_to_full_display', maybeTtfdSpan); + } + + const appStartEndTimestampSeconds = appStartEndTimestampMs / 1000; + if (event.timestamp && event.timestamp < appStartEndTimestampSeconds) { + logger.debug( + '[AppStart] Transaction event timestamp is before app start end. Adjusting transaction event timestamp.', + ); + event.timestamp = appStartEndTimestampSeconds; + } + + const op = appStart.type === 'cold' ? APP_START_COLD_OP : APP_START_WARM_OP; + const appStartSpanJSON: SpanJSON = createSpanJSON({ + op, + description: appStart.type === 'cold' ? 'Cold App Start' : 'Warm App Start', + start_timestamp: appStartTimestampSeconds, + timestamp: appStartEndTimestampSeconds, + trace_id: event.contexts.trace.trace_id, + parent_span_id: event.contexts.trace.span_id, + origin: 'auto', + }); + const jsExecutionSpanJSON = createJSExecutionStartSpan(appStartSpanJSON, rootComponentCreationTimestampMs); + + const appStartSpans = [ + appStartSpanJSON, + ...(jsExecutionSpanJSON ? [jsExecutionSpanJSON] : []), + ...convertNativeSpansToSpanJSON(appStartSpanJSON, appStart.spans), + ]; + + children.push(...appStartSpans); + logger.debug('[AppStart] Added app start spans to transaction event.', JSON.stringify(appStartSpans, undefined, 2)); + + const measurementKey = appStart.type === 'cold' ? APP_START_COLD_MEASUREMENT : APP_START_WARM_MEASUREMENT; + const measurementValue = { + value: appStartDurationMs, + unit: 'millisecond', + }; + event.measurements = event.measurements || {}; + event.measurements[measurementKey] = measurementValue; + logger.debug( + `[AppStart] Added app start measurement to transaction event.`, + JSON.stringify(measurementValue, undefined, 2), + ); + } + + return { + name: INTEGRATION_NAME, + setup, + afterAllSetup, + processEvent, + captureStandaloneAppStart, + }; +}; + +function setSpanDurationAsMeasurementOnTransactionEvent(event: TransactionEvent, label: string, span: SpanJSON): void { + if (!span.timestamp || !span.start_timestamp) { + logger.warn('Span is missing start or end timestamp. Cam not set measurement on transaction event.'); + return; + } + + event.measurements = event.measurements || {}; + event.measurements[label] = { + value: (span.timestamp - span.start_timestamp) * 1000, + unit: 'millisecond', + }; +} + +/** + * Adds JS Execution before React Root. If `Sentry.wrap` is not used, create a span for the start of JS Bundle execution. + */ +function createJSExecutionStartSpan( + parentSpan: SpanJSON, + rootComponentCreationTimestampMs: number | undefined, +): SpanJSON | undefined { + const bundleStartTimestampMs = getBundleStartTimestampMs(); + if (!bundleStartTimestampMs) { + return undefined; + } + + if (!rootComponentCreationTimestampMs) { + logger.warn('Missing the root component first constructor call timestamp.'); + return createChildSpanJSON(parentSpan, { + description: 'JS Bundle Execution Start', + start_timestamp: bundleStartTimestampMs / 1000, + timestamp: bundleStartTimestampMs / 1000, + }); + } + + return createChildSpanJSON(parentSpan, { + description: 'JS Bundle Execution Before React Root', + start_timestamp: bundleStartTimestampMs / 1000, + timestamp: rootComponentCreationTimestampMs / 1000, + }); +} + +/** + * Adds native spans to the app start span. + */ +function convertNativeSpansToSpanJSON(parentSpan: SpanJSON, nativeSpans: NativeAppStartResponse['spans']): SpanJSON[] { + return nativeSpans.map(span => { + if (span.description === 'UIKit init') { + return createUIKitSpan(parentSpan, span); + } + + return createChildSpanJSON(parentSpan, { + description: span.description, + start_timestamp: span.start_timestamp_ms / 1000, + timestamp: span.end_timestamp_ms / 1000, + }); + }); +} + +/** + * UIKit init is measured by the native layers till the native SDK start + * RN initializes the native SDK later, the end timestamp would be wrong + */ +function createUIKitSpan(parentSpan: SpanJSON, nativeUIKitSpan: NativeAppStartResponse['spans'][number]): SpanJSON { + const bundleStart = getBundleStartTimestampMs(); + + // If UIKit init ends after the bundle start, the native SDK was auto-initialized + // and so the end timestamp is incorrect. + // The timestamps can't equal, as RN initializes after UIKit. + if (bundleStart && bundleStart < nativeUIKitSpan.end_timestamp_ms) { + return createChildSpanJSON(parentSpan, { + description: 'UIKit Init to JS Exec Start', + start_timestamp: nativeUIKitSpan.start_timestamp_ms / 1000, + timestamp: bundleStart / 1000, + }); + } else { + return createChildSpanJSON(parentSpan, { + description: 'UIKit Init', + start_timestamp: nativeUIKitSpan.start_timestamp_ms / 1000, + timestamp: nativeUIKitSpan.end_timestamp_ms / 1000, + }); + } +} diff --git a/src/js/tracing/reactnativeprofiler.tsx b/src/js/tracing/reactnativeprofiler.tsx index 80c79f4ce3..7fbb05345e 100644 --- a/src/js/tracing/reactnativeprofiler.tsx +++ b/src/js/tracing/reactnativeprofiler.tsx @@ -1,9 +1,8 @@ -import { spanToJSON } from '@sentry/core'; import { getClient, Profiler } from '@sentry/react'; import { timestampInSeconds } from '@sentry/utils'; import { createIntegration } from '../integrations/factory'; -import type { ReactNativeTracing } from './reactnativetracing'; +import { captureAppStart, setRootComponentCreationTimestampMs } from '../tracing/integrations/appStart'; const ReactNativeProfilerGlobalState = { appStartReported: false, @@ -16,9 +15,7 @@ export class ReactNativeProfiler extends Profiler { public readonly name: string = 'ReactNativeProfiler'; public constructor(props: ConstructorParameters[0]) { - const client = getClient(); - const integration = client && client.getIntegrationByName && client.getIntegrationByName('ReactNativeTracing'); - integration && integration.setRootComponentFirstConstructorCallTimestampMs(timestampInSeconds() * 1000); + setRootComponentCreationTimestampMs(timestampInSeconds() * 1000); super(props); } @@ -47,12 +44,7 @@ export class ReactNativeProfiler extends Profiler { } client.addIntegration && client.addIntegration(createIntegration(this.name)); - - const endTimestamp = this._mountSpan && typeof spanToJSON(this._mountSpan).timestamp - const tracingIntegration = client.getIntegrationByName && client.getIntegrationByName('ReactNativeTracing'); - tracingIntegration - && typeof endTimestamp === 'number' - // The first root component mount is the app start finish. - && tracingIntegration.onAppStartFinish(endTimestamp); + // eslint-disable-next-line @typescript-eslint/no-floating-promises + captureAppStart(); } } diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index 4d07c66cb9..0d146190ae 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -4,23 +4,16 @@ import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from import { getActiveSpan, getCurrentScope, - getSpanDescendants, SEMANTIC_ATTRIBUTE_SENTRY_OP, SentryNonRecordingSpan, - setMeasurement, SPAN_STATUS_ERROR, spanToJSON, startIdleSpan, - startInactiveSpan, - startSpanManual, } from '@sentry/core'; import type { Client, Event, Integration, PropagationContext, Scope, Span, StartSpanOptions } from '@sentry/types'; import { logger, uuid4 } from '@sentry/utils'; -import { APP_START_COLD, APP_START_WARM } from '../measurements'; -import type { NativeAppStartResponse } from '../NativeRNSentry'; import type { RoutingInstrumentationInstance } from '../tracing/routingInstrumentation'; -import { isRootSpan, isSentrySpan } from '../utils/span'; import { NATIVE } from '../wrapper'; import { NativeFramesInstrumentation } from './nativeframes'; import { @@ -30,10 +23,8 @@ import { onlySampleIfChildSpans, onThisSpanEnd, } from './onSpanEndUtils'; -import { APP_START_COLD as APP_START_COLD_OP, APP_START_WARM as APP_START_WARM_OP, UI_LOAD } from './ops'; import { StallTrackingInstrumentation } from './stalltracking'; import type { BeforeNavigate } from './types'; -import { getBundleStartTimestampMs, getTimeOriginMilliseconds, setSpanDurationAsMeasurement } from './utils'; const SCOPE_SPAN_FIELD = '_sentrySpan'; @@ -100,14 +91,6 @@ export interface ReactNativeTracingOptions extends RequestInstrumentationOptions */ beforeNavigate: BeforeNavigate; - /** - * Track the app start time by adding measurements to the first route transaction. If there is no routing instrumentation - * an app start transaction will be started. - * - * Default: true - */ - enableAppStartTracking: boolean; - /** * Track slow/frozen frames from the native layer and adds them as measurements to all transactions. */ @@ -134,7 +117,6 @@ const defaultReactNativeTracingOptions: ReactNativeTracingOptions = { finalTimeoutMs: 600000, ignoreEmptyBackNavigationTransactions: true, beforeNavigate: context => context, - enableAppStartTracking: true, enableNativeFramesTracking: true, enableStallTracking: true, enableUserInteractionTracing: false, @@ -148,10 +130,7 @@ export class ReactNativeTracing implements Integration { * @inheritDoc */ public static id: string = 'ReactNativeTracing'; - /** We filter out App starts more than 60s */ - private static _maxAppStart: number = 60000; - /** We filter out App starts which timestamp is 60s and more before the transaction start */ - private static _maxAppStartBeforeTransactionMs: number = 60000; + /** * @inheritDoc */ @@ -165,13 +144,11 @@ export class ReactNativeTracing implements Integration { public useAppStartWithProfiler: boolean = false; private _inflightInteractionTransaction?: Span; - private _awaitingAppStartData?: NativeAppStartResponse; - private _appStartFinishTimestamp?: number; + private _currentRoute?: string; private _hasSetTracePropagationTargets: boolean; private _currentViewName: string | undefined; private _client: Client | undefined; - private _firstConstructorCallTimestampMs: number | undefined; public constructor(options: Partial = {}) { this._hasSetTracePropagationTargets = !!( @@ -215,7 +192,6 @@ export class ReactNativeTracing implements Integration { // eslint-disable-next-line deprecation/deprecation tracePropagationTargets: thisOptionsTracePropagationTargets, routingInstrumentation, - enableAppStartTracking, enableStallTracking, } = this.options; @@ -225,12 +201,6 @@ export class ReactNativeTracing implements Integration { (this._hasSetTracePropagationTargets && thisOptionsTracePropagationTargets) || DEFAULT_TRACE_PROPAGATION_TARGETS; - if (enableAppStartTracking) { - this._instrumentAppStart().then(undefined, (reason: unknown) => { - logger.error(`[ReactNativeTracing] Error while instrumenting app start:`, reason); - }); - } - this._enableNativeFramesTracking(client); if (enableStallTracking) { @@ -268,20 +238,6 @@ export class ReactNativeTracing implements Integration { : eventWithView; } - /** - * Called by the ReactNativeProfiler component on first component mount. - */ - public onAppStartFinish(endTimestamp: number): void { - this._appStartFinishTimestamp = endTimestamp; - } - - /** - * Sets the root component first constructor call timestamp. - */ - public setRootComponentFirstConstructorCallTimestampMs(timestamp: number): void { - this._firstConstructorCallTimestampMs = timestamp; - } - /** * Starts a new transaction for a user interaction. * @param userInteractionId Consists of `op` representation UI Event and `elementId` unique element identifier on current screen. @@ -400,197 +356,6 @@ export class ReactNativeTracing implements Integration { return event; } - /** - * Returns the App Start Duration in Milliseconds. Also returns undefined if not able do - * define the duration. - */ - private _getAppStartDurationMilliseconds(appStartTimestampMs: number): number | undefined { - if (!this._appStartFinishTimestamp) { - return undefined; - } - return this._appStartFinishTimestamp * 1000 - appStartTimestampMs; - } - - /** - * Instruments the app start measurements on the first route transaction. - * Starts a route transaction if there isn't routing instrumentation. - */ - private async _instrumentAppStart(): Promise { - if (!this.options.enableAppStartTracking || !NATIVE.enableNative) { - return; - } - - const appStart = await NATIVE.fetchNativeAppStart(); - - if (!appStart) { - logger.warn('[ReactNativeTracing] Not instrumenting App Start because native returned null.'); - return; - } - - if (appStart.has_fetched) { - logger.warn('[ReactNativeTracing] Not instrumenting App Start because this start was already reported.'); - return; - } - - if (!this.useAppStartWithProfiler) { - logger.warn('[ReactNativeTracing] `Sentry.wrap` not detected, using JS context init as app start end.'); - this._appStartFinishTimestamp = getTimeOriginMilliseconds() / 1000; - } - - if (this.options.routingInstrumentation) { - this._awaitingAppStartData = appStart; - } else { - const idleTransaction = this._createRouteTransaction({ - name: 'App Start', - op: UI_LOAD, - }); - - if (idleTransaction) { - this._addAppStartData(idleTransaction, appStart); - } - } - } - - /** - * Adds app start measurements and starts a child span on a transaction. - */ - private _addAppStartData(span: Span, appStart: NativeAppStartResponse): void { - const appStartTimestampMs = appStart.app_start_timestamp_ms; - if (!appStartTimestampMs) { - logger.warn('App start timestamp could not be loaded from the native layer.'); - return; - } - - if (!isSentrySpan(span)) { - return; - } - - const isAppStartWithinBounds = - appStartTimestampMs >= getSpanStartTimestampMs(span) - ReactNativeTracing._maxAppStartBeforeTransactionMs; - if (!__DEV__ && !isAppStartWithinBounds) { - logger.warn('[ReactNativeTracing] App start timestamp is too far in the past to be used for app start span.'); - return; - } - - const appStartDurationMilliseconds = this._getAppStartDurationMilliseconds(appStartTimestampMs); - - if (!appStartDurationMilliseconds) { - logger.warn('[ReactNativeTracing] App start end has not been recorded, not adding app start span.'); - return; - } - - // we filter out app start more than 60s. - // this could be due to many different reasons. - // we've seen app starts with hours, days and even months. - if (appStartDurationMilliseconds >= ReactNativeTracing._maxAppStart) { - logger.warn('[ReactNativeTracing] App start duration is over a minute long, not adding app start span.'); - return; - } - - const appStartTimeSeconds = appStartTimestampMs / 1000; - - span.updateStartTime(appStartTimeSeconds); - const children = getSpanDescendants(span); - - const maybeTtidSpan = children.find(span => spanToJSON(span).op === 'ui.load.initial_display'); - if (maybeTtidSpan && isSentrySpan(maybeTtidSpan)) { - maybeTtidSpan.updateStartTime(appStartTimeSeconds); - setSpanDurationAsMeasurement('time_to_initial_display', maybeTtidSpan); - } - - const maybeTtfdSpan = children.find(span => spanToJSON(span).op === 'ui.load.full_display'); - if (maybeTtfdSpan && isSentrySpan(maybeTtfdSpan)) { - maybeTtfdSpan.updateStartTime(appStartTimeSeconds); - setSpanDurationAsMeasurement('time_to_full_display', maybeTtfdSpan); - } - - const op = appStart.type === 'cold' ? APP_START_COLD_OP : APP_START_WARM_OP; - startSpanManual( - { - name: appStart.type === 'cold' ? 'Cold App Start' : 'Warm App Start', - op, - startTime: appStartTimeSeconds, - }, - (appStartSpan: Span) => { - this._addJSExecutionBeforeRoot(appStartSpan); - this._addNativeSpansTo(appStartSpan, appStart.spans); - appStartSpan.end(this._appStartFinishTimestamp); - }, - ); - - const measurement = appStart.type === 'cold' ? APP_START_COLD : APP_START_WARM; - setMeasurement(measurement, appStartDurationMilliseconds, 'millisecond'); - } - - /** - * Adds JS Execution before React Root. If `Sentry.wrap` is not used, create a span for the start of JS Bundle execution. - */ - private _addJSExecutionBeforeRoot(appStartSpan: Span): void { - const bundleStartTimestampMs = getBundleStartTimestampMs(); - if (!bundleStartTimestampMs) { - return; - } - - if (!this._firstConstructorCallTimestampMs) { - logger.warn('Missing the root component first constructor call timestamp.'); - startInactiveSpan({ - name: 'JS Bundle Execution Start', - op: spanToJSON(appStartSpan).op, - startTime: bundleStartTimestampMs / 1000, - }).end(bundleStartTimestampMs / 1000); - return; - } - - startInactiveSpan({ - name: 'JS Bundle Execution Before React Root', - op: spanToJSON(appStartSpan).op, - startTime: bundleStartTimestampMs / 1000, - }).end(this._firstConstructorCallTimestampMs / 1000); - } - - /** - * Adds native spans to the app start span. - */ - private _addNativeSpansTo(appStartSpan: Span, nativeSpans: NativeAppStartResponse['spans']): void { - nativeSpans.forEach(span => { - if (span.description === 'UIKit init') { - return this._createUIKitSpan(appStartSpan, span); - } - - startInactiveSpan({ - op: spanToJSON(appStartSpan).op, - name: span.description, - startTime: span.start_timestamp_ms / 1000, - }).end(span.end_timestamp_ms / 1000); - }); - } - - /** - * UIKit init is measured by the native layers till the native SDK start - * RN initializes the native SDK later, the end timestamp would be wrong - */ - private _createUIKitSpan(parentSpan: Span, nativeUIKitSpan: NativeAppStartResponse['spans'][number]): void { - const bundleStart = getBundleStartTimestampMs(); - const parentSpanOp = spanToJSON(parentSpan).op; - - // If UIKit init ends after the bundle start, the native SDK was auto-initialized - // and so the end timestamp is incorrect. - // The timestamps can't equal, as RN initializes after UIKit. - if (bundleStart && bundleStart < nativeUIKitSpan.end_timestamp_ms) { - startInactiveSpan({ - op: parentSpanOp, - name: 'UIKit Init to JS Exec Start', - startTime: nativeUIKitSpan.start_timestamp_ms / 1000, - }).end(bundleStart / 1000); - } else { - startInactiveSpan({ - op: parentSpanOp, - name: 'UIKit Init', - startTime: nativeUIKitSpan.start_timestamp_ms / 1000, - }).end(nativeUIKitSpan.end_timestamp_ms / 1000); - } - } - /** To be called when the route changes, but BEFORE the components of the new route mount. */ private _onRouteWillChange(): Span | undefined { return this._createRouteTransaction(); @@ -636,21 +401,7 @@ export class ReactNativeTracing implements Integration { scope: getCurrentScope(), }; - const addAwaitingAppStartBeforeSpanEnds = (span: Span): void => { - if (!isRootSpan(span)) { - logger.warn('Not sampling empty back spans only works for Sentry Transactions (Root Spans).'); - return; - } - - if (this.options.enableAppStartTracking && this._awaitingAppStartData) { - span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, UI_LOAD); - this._addAppStartData(span, this._awaitingAppStartData); - - this._awaitingAppStartData = undefined; - } - }; - - const idleSpan = this._startIdleSpan(expandedContext, addAwaitingAppStartBeforeSpanEnds); + const idleSpan = this._startIdleSpan(expandedContext); if (!idleSpan) { return undefined; } @@ -702,11 +453,3 @@ function addDefaultOpForSpanFrom(client: Client): void { } }); } - -/** - * Returns transaction start timestamp in milliseconds. - * If start timestamp is not available, returns 0. - */ -function getSpanStartTimestampMs(span: Span): number { - return (spanToJSON(span).start_timestamp || 0) * 1000; -} diff --git a/src/js/tracing/utils.ts b/src/js/tracing/utils.ts index 56774b0ce0..b0dd9e5719 100644 --- a/src/js/tracing/utils.ts +++ b/src/js/tracing/utils.ts @@ -2,11 +2,13 @@ import { getSpanDescendants, SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT, SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE, + SEMANTIC_ATTRIBUTE_SENTRY_OP, + SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, setMeasurement, spanToJSON, } from '@sentry/core'; -import type { MeasurementUnit, Span, TransactionSource } from '@sentry/types'; -import { logger, timestampInSeconds } from '@sentry/utils'; +import type { MeasurementUnit, Span, SpanJSON, TransactionSource } from '@sentry/types'; +import { dropUndefinedKeys, logger, timestampInSeconds, uuid4 } from '@sentry/utils'; import { RN_GLOBAL_OBJ } from '../utils/worldwide'; @@ -94,3 +96,40 @@ export function getBundleStartTimestampMs(): number | undefined { const approxStartingTimeOrigin = Date.now() - RN_GLOBAL_OBJ.nativePerformanceNow(); return approxStartingTimeOrigin + bundleStartTime; } + +/** + * Creates valid span JSON object from the given data. + */ +export function createSpanJSON( + from: Partial & Pick, 'description' | 'start_timestamp' | 'timestamp' | 'origin'>, +): SpanJSON { + return dropUndefinedKeys({ + status: 'ok', + ...from, + span_id: from.span_id ? from.span_id : uuid4().substring(16), + trace_id: from.trace_id ? from.trace_id : uuid4(), + data: dropUndefinedKeys({ + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: from.op, + [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: from.origin, + ...(from.data ? from.data : {}), + }), + }); +} + +const SENTRY_DEFAULT_ORIGIN = 'manual'; + +/** + * + */ +export function createChildSpanJSON( + parent: SpanJSON, + from: Partial & Pick, 'description' | 'start_timestamp' | 'timestamp'>, +): SpanJSON { + return createSpanJSON({ + op: parent.op, + trace_id: parent.trace_id, + parent_span_id: parent.span_id, + origin: parent.origin || SENTRY_DEFAULT_ORIGIN, + ...from, + }); +} diff --git a/src/js/utils/span.ts b/src/js/utils/span.ts index fd69de0b64..900e2414bc 100644 --- a/src/js/utils/span.ts +++ b/src/js/utils/span.ts @@ -1,5 +1,5 @@ import { getRootSpan, SentrySpan } from '@sentry/core'; -import type { Span } from '@sentry/types'; +import type { Span, TransactionEvent } from '@sentry/types'; /** * @@ -14,3 +14,25 @@ export function isSentrySpan(span: Span): span is SentrySpan { export function isRootSpan(span: Span): boolean { return span === getRootSpan(span); } + +const END_TIME_SCOPE_FIELD = '_endTime'; +const CONVERT_SPAN_TO_TRANSACTION_FIELD = '_convertSpanToTransaction'; + +type SpanWithPrivate = Span & { + [END_TIME_SCOPE_FIELD]?: number; + [CONVERT_SPAN_TO_TRANSACTION_FIELD]?: () => TransactionEvent | undefined; +}; + +/** + * + */ +export function setEndTimeValue(span: Span, endTimestamp: number): void { + (span as SpanWithPrivate)['_endTime'] = endTimestamp; +} + +/** + * + */ +export function convertSpanToTransaction(span: Span): TransactionEvent | undefined { + return (span as SpanWithPrivate)['_convertSpanToTransaction']?.(); +} diff --git a/test/mocks/client.ts b/test/mocks/client.ts index b8976a41fa..6d6b4898b4 100644 --- a/test/mocks/client.ts +++ b/test/mocks/client.ts @@ -8,7 +8,6 @@ import { setCurrentClient, } from '@sentry/core'; import type { - ClientOptions, Event, EventHint, Integration, @@ -19,6 +18,8 @@ import type { } from '@sentry/types'; import { resolvedSyncPromise } from '@sentry/utils'; +import type { ReactNativeClientOptions } from '../../src/js/options'; + export function getDefaultTestClientOptions(options: Partial = {}): TestClientOptions { return { dsn: 'https://1234@some-domain.com/4505526893805568', @@ -37,7 +38,7 @@ export function getDefaultTestClientOptions(options: Partial }; } -export interface TestClientOptions extends ClientOptions { +export interface TestClientOptions extends ReactNativeClientOptions { test?: boolean; mockInstallFailure?: boolean; enableSend?: boolean; diff --git a/test/sdk.test.ts b/test/sdk.test.ts index 203babf2dd..672dc1959a 100644 --- a/test/sdk.test.ts +++ b/test/sdk.test.ts @@ -442,6 +442,35 @@ describe('Tests the SDK functionality', () => { expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Spotlight' })])); }); + it('no app start integration by default', () => { + init({}); + + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; + expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'AppStart' })])); + }); + + it('when tracing enabled app start integration added by default', () => { + init({ + tracesSampleRate: 0.5, + }); + + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; + expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'AppStart' })])); + }); + + it('when tracing enabled and app start disabled the integration is not added', () => { + init({ + tracesSampleRate: 0.5, + enableAppStartTracking: false, + }); + + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; + expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'AppStart' })])); + }); + it('no default integrations', () => { init({ defaultIntegrations: false, diff --git a/test/tracing/integrations/appStart.test.ts b/test/tracing/integrations/appStart.test.ts new file mode 100644 index 0000000000..09e8c53294 --- /dev/null +++ b/test/tracing/integrations/appStart.test.ts @@ -0,0 +1,957 @@ +import { + getCurrentScope, + getGlobalScope, + getIsolationScope, + SEMANTIC_ATTRIBUTE_SENTRY_OP, + SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, + setCurrentClient, +} from '@sentry/core'; +import type { ErrorEvent, Event, SpanJSON, TransactionEvent } from '@sentry/types'; +import { timestampInSeconds } from '@sentry/utils'; + +import { + APP_START_COLD as APP_START_COLD_MEASUREMENT, + APP_START_WARM as APP_START_WARM_MEASUREMENT, +} from '../../../src/js/measurements'; +import type { NativeAppStartResponse } from '../../../src/js/NativeRNSentry'; +import { + APP_START_COLD as APP_START_COLD_OP, + APP_START_WARM as APP_START_WARM_OP, + UI_LOAD, +} from '../../../src/js/tracing'; +import { + _clearRootComponentCreationTimestampMs, + _setAppStartEndTimestampMs, + appStartIntegration, + setRootComponentCreationTimestampMs, +} from '../../../src/js/tracing/integrations/appStart'; +import { getTimeOriginMilliseconds } from '../../../src/js/tracing/utils'; +import { RN_GLOBAL_OBJ } from '../../../src/js/utils/worldwide'; +import { NATIVE } from '../../../src/js/wrapper'; +import { getDefaultTestClientOptions, TestClient } from '../../mocks/client'; +import { mockFunction } from '../../testutils'; + +jest.mock('../../../src/js/wrapper', () => { + return { + NATIVE: { + fetchNativeAppStart: jest.fn(), + fetchNativeFrames: jest.fn(() => Promise.resolve()), + disableNativeFramesTracking: jest.fn(() => Promise.resolve()), + enableNativeFramesTracking: jest.fn(() => Promise.resolve()), + enableNative: true, + }, + }; +}); + +jest.mock('../../../src/js/tracing/utils', () => { + const originalUtils = jest.requireActual('../../../src/js/tracing/utils'); + + return { + ...originalUtils, + getTimeOriginMilliseconds: jest.fn(), + }; +}); + +jest.mock('@sentry/utils', () => { + const originalUtils = jest.requireActual('@sentry/utils'); + + return { + ...originalUtils, + timestampInSeconds: jest.fn(originalUtils.timestampInSeconds), + }; +}); + +describe('App Start Integration', () => { + beforeEach(() => { + mockReactNativeBundleExecutionStartTimestamp(); + jest.clearAllMocks(); + }); + + afterEach(() => { + clearReactNativeBundleExecutionStartTimestamp(); + }); + + describe('Standalone App Start', () => { + it('Adds Cold App Start Span to Active Span', async () => { + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStart({ cold: true }); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toEqual( + expectEventWithStandaloneColdAppStart(actualEvent, { timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + }); + + it('Adds Warm App Start Span to Active Span', async () => { + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStart({ cold: false }); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toEqual( + expectEventWithStandaloneWarmAppStart(actualEvent, { timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + }); + + it('Does not add any spans or measurements when App Start Span is longer than threshold', async () => { + set__DEV__(false); + mockTooLongAppStart(); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toStrictEqual(undefined); + }); + + it('Does add App Start Span spans and measurements longer than threshold in development builds', async () => { + set__DEV__(true); + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockTooLongAppStart(); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toEqual( + expectEventWithStandaloneWarmAppStart(actualEvent, { timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + }); + + it('Does not add App Start Span older than threshold', async () => { + set__DEV__(false); + mockTooOldAppStart(); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toStrictEqual(undefined); + }); + + it('Does add App Start Span older than threshold in development builds', async () => { + set__DEV__(true); + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockTooOldAppStart(); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toEqual( + expectEventWithStandaloneWarmAppStart(actualEvent, { timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + }); + + it('Does not create app start transaction if has_fetched == true', async () => { + mockAppStart({ has_fetched: true }); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toStrictEqual(undefined); + }); + + it('Does not add bundle execution span when bundle start time is missing', async () => { + clearReactNativeBundleExecutionStartTimestamp(); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toStrictEqual(undefined); + }); + + it('Adds bundle execution span', async () => { + _clearRootComponentCreationTimestampMs(); + mockReactNativeBundleExecutionStartTimestamp(); + const [timeOriginMilliseconds] = mockAppStart({ cold: true }); + + const actualEvent = await captureStandAloneAppStart(); + + const appStartRootSpan = actualEvent!.spans!.find(({ description }) => description === 'Cold App Start'); + const bundleStartSpan = actualEvent!.spans!.find( + ({ description }) => description === 'JS Bundle Execution Start', + ); + + expect(appStartRootSpan).toEqual( + expect.objectContaining({ + description: 'Cold App Start', + span_id: expect.any(String), + op: APP_START_COLD_OP, + }), + ); + expect(bundleStartSpan).toEqual( + expect.objectContaining({ + description: 'JS Bundle Execution Start', + start_timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), + timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), + parent_span_id: appStartRootSpan!.span_id, // parent is the root app start span + op: appStartRootSpan!.op, // op is the same as the root app start span + }), + ); + }); + + it('adds bundle execution before react root', async () => { + mockReactNativeBundleExecutionStartTimestamp(); + const [timeOriginMilliseconds] = mockAppStart({ cold: true }); + setRootComponentCreationTimestampMs(timeOriginMilliseconds - 10); + + const actualEvent = await captureStandAloneAppStart(); + + const appStartRootSpan = actualEvent!.spans!.find(({ description }) => description === 'Cold App Start'); + const bundleStartSpan = actualEvent!.spans!.find( + ({ description }) => description === 'JS Bundle Execution Before React Root', + ); + + expect(appStartRootSpan).toEqual( + expect.objectContaining({ + description: 'Cold App Start', + span_id: expect.any(String), + op: APP_START_COLD_OP, + }), + ); + expect(bundleStartSpan).toEqual( + expect.objectContaining({ + description: 'JS Bundle Execution Before React Root', + start_timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), + timestamp: (timeOriginMilliseconds - 10) / 1000, + parent_span_id: appStartRootSpan!.span_id, // parent is the root app start span + op: appStartRootSpan!.op, // op is the same as the root app start span + }), + ); + }); + + it('adds native spans as a child of the main app start span', async () => { + const [timeOriginMilliseconds] = mockAppStart({ + cold: true, + enableNativeSpans: true, + }); + + const actualEvent = await captureStandAloneAppStart(); + + const appStartRootSpan = actualEvent!.spans!.find(({ description }) => description === 'Cold App Start'); + const nativeSpan = actualEvent!.spans!.find(({ description }) => description === 'test native app start span'); + + expect(appStartRootSpan).toEqual( + expect.objectContaining({ + description: 'Cold App Start', + span_id: expect.any(String), + op: APP_START_COLD_OP, + }), + ); + expect(nativeSpan).toEqual( + expect.objectContaining({ + description: 'test native app start span', + start_timestamp: (timeOriginMilliseconds - 100) / 1000, + timestamp: (timeOriginMilliseconds - 50) / 1000, + parent_span_id: appStartRootSpan!.span_id, // parent is the root app start span + op: appStartRootSpan!.op, // op is the same as the root app start span + }), + ); + }); + + it('adds ui kit init full length as a child of the main app start span', async () => { + const timeOriginMilliseconds = Date.now(); + mockAppStart({ + cold: true, + enableNativeSpans: true, + customNativeSpans: [ + { + description: 'UIKit init', // init with lower case is emitted by the native layer + start_timestamp_ms: timeOriginMilliseconds - 100, + end_timestamp_ms: timeOriginMilliseconds - 60, + }, + ], + }); + mockReactNativeBundleExecutionStartTimestamp(); + + const actualEvent = await captureStandAloneAppStart(); + + const nativeSpan = actualEvent!.spans!.find(({ description }) => description?.startsWith('UIKit Init')); + + expect(nativeSpan).toBeDefined(); + expect(nativeSpan).toEqual( + expect.objectContaining({ + description: 'UIKit Init', + start_timestamp: (timeOriginMilliseconds - 100) / 1000, + timestamp: (timeOriginMilliseconds - 60) / 1000, + }), + ); + }); + + it('adds ui kit init start mark as a child of the main app start span', async () => { + const timeOriginMilliseconds = Date.now(); + mockAppStart({ + cold: true, + enableNativeSpans: true, + customNativeSpans: [ + { + description: 'UIKit init', // init with lower case is emitted by the native layer + start_timestamp_ms: timeOriginMilliseconds - 100, + end_timestamp_ms: timeOriginMilliseconds - 20, // After mocked bundle execution start + }, + ], + }); + mockReactNativeBundleExecutionStartTimestamp(); + + const actualEvent = await captureStandAloneAppStart(); + + const nativeRuntimeInitSpan = actualEvent!.spans!.find(({ description }) => + description?.startsWith('UIKit Init to JS Exec Start'), + ); + + expect(nativeRuntimeInitSpan).toBeDefined(); + expect(nativeRuntimeInitSpan).toEqual( + expect.objectContaining({ + description: 'UIKit Init to JS Exec Start', + start_timestamp: (timeOriginMilliseconds - 100) / 1000, + timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), + }), + ); + }); + + it('Does not add app start span twice', async () => { + getCurrentScope().clear(); + getIsolationScope().clear(); + getGlobalScope().clear(); + + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStart({ cold: true }); + + const integration = appStartIntegration({ + standalone: true, + }); + const client = new TestClient({ + ...getDefaultTestClientOptions(), + tracesSampleRate: 1.0, + enableAppStartTracking: true, + }); + setCurrentClient(client); + + integration.setup(client); + await integration.captureStandaloneAppStart(); + const actualEvent = client.event; + expect(actualEvent).toEqual( + expectEventWithStandaloneColdAppStart(actualEvent, { timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + + client.event = undefined; + await integration.captureStandaloneAppStart(); + const secondEvent = client.event; + expect(secondEvent).toBe(undefined); + }); + + it('Does not add app start span when marked as fetched from the native layer', async () => { + mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue({ + type: 'cold', + has_fetched: true, + spans: [], + }); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toStrictEqual(undefined); + expect(NATIVE.fetchNativeAppStart).toBeCalledTimes(1); + }); + + it('Does not add app start if native returns null', async () => { + mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(null); + + const actualEvent = await captureStandAloneAppStart(); + expect(actualEvent).toStrictEqual(undefined); + expect(NATIVE.fetchNativeAppStart).toBeCalledTimes(1); + }); + }); + + describe('App Start Attached to the First Root Span', () => { + it('Does not add App Start Span to Error Event', async () => { + const inputEvent: ErrorEvent = { + type: undefined, + }; + + const actualEvent = await processEvent(inputEvent); + expect(actualEvent).toEqual({ + type: undefined, + }); + }); + + it('Adds Cold App Start Span to Active Span', async () => { + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStart({ cold: true }); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + expect(actualEvent).toEqual( + expectEventWithAttachedColdAppStart({ timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + }); + + it('Adds Warm App Start Span to Active Span', async () => { + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStart({ cold: false }); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + expect(actualEvent).toEqual( + expectEventWithAttachedWarmAppStart({ timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + }); + + it('Does not add any spans or measurements when App Start Span is longer than threshold', async () => { + set__DEV__(false); + mockTooLongAppStart(); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + expect(actualEvent).toStrictEqual(getMinimalTransactionEvent()); + }); + + it('Does add App Start Span spans and measurements longer than threshold in development builds', async () => { + set__DEV__(true); + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockTooLongAppStart(); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + expect(actualEvent).toEqual( + expectEventWithAttachedWarmAppStart({ timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + }); + + it('Does not add App Start Span older than threshold', async () => { + set__DEV__(false); + mockTooOldAppStart(); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + expect(actualEvent).toStrictEqual(getMinimalTransactionEvent()); + }); + + it('Does add App Start Span older than threshold in development builds', async () => { + set__DEV__(true); + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockTooOldAppStart(); + + const actualEvent = await processEvent( + getMinimalTransactionEvent({ startTimestampSeconds: timeOriginMilliseconds }), + ); + expect(actualEvent).toEqual( + expectEventWithAttachedWarmAppStart({ timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + }); + + it('Does not create app start transaction if has_fetched == true', async () => { + mockAppStart({ has_fetched: true }); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + expect(actualEvent).toStrictEqual(getMinimalTransactionEvent()); + }); + + it('Does not add bundle execution span when bundle start time is missing', async () => { + clearReactNativeBundleExecutionStartTimestamp(); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + expect(actualEvent).toStrictEqual(getMinimalTransactionEvent()); + }); + + it('Adds bundle execution span', async () => { + _clearRootComponentCreationTimestampMs(); + mockReactNativeBundleExecutionStartTimestamp(); + const [timeOriginMilliseconds] = mockAppStart({ cold: true }); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + + const appStartRootSpan = actualEvent!.spans!.find(({ description }) => description === 'Cold App Start'); + const bundleStartSpan = actualEvent!.spans!.find( + ({ description }) => description === 'JS Bundle Execution Start', + ); + + expect(appStartRootSpan).toEqual( + expect.objectContaining({ + description: 'Cold App Start', + span_id: expect.any(String), + op: APP_START_COLD_OP, + }), + ); + expect(bundleStartSpan).toEqual( + expect.objectContaining({ + description: 'JS Bundle Execution Start', + start_timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), + timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), + parent_span_id: appStartRootSpan!.span_id, // parent is the root app start span + op: appStartRootSpan!.op, // op is the same as the root app start span + }), + ); + }); + + it('adds bundle execution before react root', async () => { + mockReactNativeBundleExecutionStartTimestamp(); + const [timeOriginMilliseconds] = mockAppStart({ cold: true }); + setRootComponentCreationTimestampMs(timeOriginMilliseconds - 10); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + + const appStartRootSpan = actualEvent!.spans!.find(({ description }) => description === 'Cold App Start'); + const bundleStartSpan = actualEvent!.spans!.find( + ({ description }) => description === 'JS Bundle Execution Before React Root', + ); + + expect(appStartRootSpan).toEqual( + expect.objectContaining({ + description: 'Cold App Start', + span_id: expect.any(String), + op: APP_START_COLD_OP, + }), + ); + expect(bundleStartSpan).toEqual( + expect.objectContaining({ + description: 'JS Bundle Execution Before React Root', + start_timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), + timestamp: (timeOriginMilliseconds - 10) / 1000, + parent_span_id: appStartRootSpan!.span_id, // parent is the root app start span + op: appStartRootSpan!.op, // op is the same as the root app start span + }), + ); + }); + + it('adds native spans as a child of the main app start span', async () => { + const [timeOriginMilliseconds] = mockAppStart({ + cold: true, + enableNativeSpans: true, + }); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + + const appStartRootSpan = actualEvent!.spans!.find(({ description }) => description === 'Cold App Start'); + const nativeSpan = actualEvent!.spans!.find(({ description }) => description === 'test native app start span'); + + expect(appStartRootSpan).toEqual( + expect.objectContaining({ + description: 'Cold App Start', + span_id: expect.any(String), + op: APP_START_COLD_OP, + }), + ); + expect(nativeSpan).toEqual( + expect.objectContaining({ + description: 'test native app start span', + start_timestamp: (timeOriginMilliseconds - 100) / 1000, + timestamp: (timeOriginMilliseconds - 50) / 1000, + parent_span_id: appStartRootSpan!.span_id, // parent is the root app start span + op: appStartRootSpan!.op, // op is the same as the root app start span + }), + ); + }); + + it('adds ui kit init full length as a child of the main app start span', async () => { + const timeOriginMilliseconds = Date.now(); + mockAppStart({ + cold: true, + enableNativeSpans: true, + customNativeSpans: [ + { + description: 'UIKit init', // init with lower case is emitted by the native layer + start_timestamp_ms: timeOriginMilliseconds - 100, + end_timestamp_ms: timeOriginMilliseconds - 60, + }, + ], + }); + mockReactNativeBundleExecutionStartTimestamp(); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + + const nativeSpan = actualEvent!.spans!.find(({ description }) => description?.startsWith('UIKit Init')); + + expect(nativeSpan).toBeDefined(); + expect(nativeSpan).toEqual( + expect.objectContaining({ + description: 'UIKit Init', + start_timestamp: (timeOriginMilliseconds - 100) / 1000, + timestamp: (timeOriginMilliseconds - 60) / 1000, + }), + ); + }); + + it('adds ui kit init start mark as a child of the main app start span', async () => { + const timeOriginMilliseconds = Date.now(); + mockAppStart({ + cold: true, + enableNativeSpans: true, + customNativeSpans: [ + { + description: 'UIKit init', // init with lower case is emitted by the native layer + start_timestamp_ms: timeOriginMilliseconds - 100, + end_timestamp_ms: timeOriginMilliseconds - 20, // After mocked bundle execution start + }, + ], + }); + mockReactNativeBundleExecutionStartTimestamp(); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + + const nativeRuntimeInitSpan = actualEvent!.spans!.find(({ description }) => + description?.startsWith('UIKit Init to JS Exec Start'), + ); + + expect(nativeRuntimeInitSpan).toBeDefined(); + expect(nativeRuntimeInitSpan).toEqual( + expect.objectContaining({ + description: 'UIKit Init to JS Exec Start', + start_timestamp: (timeOriginMilliseconds - 100) / 1000, + timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), + }), + ); + }); + + it('Does not add app start span twice', async () => { + const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStart({ cold: true }); + + const integration = appStartIntegration(); + const client = new TestClient(getDefaultTestClientOptions()); + + const actualEvent = await integration.processEvent(getMinimalTransactionEvent(), {}, client); + expect(actualEvent).toEqual( + expectEventWithAttachedColdAppStart({ timeOriginMilliseconds, appStartTimeMilliseconds }), + ); + + const secondEvent = await integration.processEvent(getMinimalTransactionEvent(), {}, client); + expect(secondEvent).toStrictEqual(getMinimalTransactionEvent()); + }); + + it('Does not add app start span when marked as fetched from the native layer', async () => { + mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue({ + type: 'cold', + has_fetched: true, + spans: [], + }); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + expect(actualEvent).toStrictEqual(getMinimalTransactionEvent()); + expect(NATIVE.fetchNativeAppStart).toBeCalledTimes(1); + }); + + it('Does not add app start if native returns null', async () => { + mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(null); + + const actualEvent = await processEvent(getMinimalTransactionEvent()); + expect(actualEvent).toStrictEqual(getMinimalTransactionEvent()); + expect(NATIVE.fetchNativeAppStart).toBeCalledTimes(1); + }); + }); +}); + +function processEvent(event: Event): PromiseLike | Event | null { + const integration = appStartIntegration(); + return integration.processEvent(event, {}, new TestClient(getDefaultTestClientOptions())); +} + +async function captureStandAloneAppStart(): Promise | Event | null> { + getCurrentScope().clear(); + getIsolationScope().clear(); + getGlobalScope().clear(); + + const integration = appStartIntegration({ + standalone: true, + }); + const client = new TestClient({ + ...getDefaultTestClientOptions(), + enableAppStartTracking: true, + tracesSampleRate: 1.0, + }); + setCurrentClient(client); + integration.setup(client); + await integration.captureStandaloneAppStart(); + + return client.event; +} + +function getMinimalTransactionEvent({ + startTimestampSeconds = 100, +}: { + startTimestampSeconds?: number; +} = {}): TransactionEvent { + return { + type: 'transaction', + start_timestamp: startTimestampSeconds, + contexts: { + trace: { + op: 'test', + span_id: '123', + trace_id: '456', + }, + }, + spans: [ + { + start_timestamp: 100, + timestamp: 200, + op: 'test', + description: 'Test', + span_id: '123', + trace_id: '456', + }, + ], + }; +} + +function expectEventWithAttachedColdAppStart({ + timeOriginMilliseconds, + appStartTimeMilliseconds, +}: { + timeOriginMilliseconds: number; + appStartTimeMilliseconds: number; +}) { + return expect.objectContaining({ + type: 'transaction', + start_timestamp: appStartTimeMilliseconds / 1000, + contexts: expect.objectContaining({ + trace: expect.objectContaining({ + op: UI_LOAD, + data: expect.objectContaining({ + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: UI_LOAD, + }), + }), + }), + measurements: expect.objectContaining({ + [APP_START_COLD_MEASUREMENT]: { + value: timeOriginMilliseconds - appStartTimeMilliseconds, + unit: 'millisecond', + }, + }), + spans: expect.arrayContaining([ + { + op: APP_START_COLD_OP, + description: 'Cold App Start', + start_timestamp: appStartTimeMilliseconds / 1000, + timestamp: expect.any(Number), + trace_id: expect.any(String), + span_id: expect.any(String), + parent_span_id: '123', + origin: 'auto', + status: 'ok', + data: { + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: APP_START_COLD_OP, + [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto', + }, + }, + { + start_timestamp: 100, + timestamp: 200, + op: 'test', + description: 'Test', + span_id: '123', + trace_id: '456', + }, + ]), + }); +} + +function expectEventWithAttachedWarmAppStart({ + timeOriginMilliseconds, + appStartTimeMilliseconds, +}: { + timeOriginMilliseconds: number; + appStartTimeMilliseconds: number; +}) { + return expect.objectContaining({ + type: 'transaction', + start_timestamp: appStartTimeMilliseconds / 1000, + contexts: expect.objectContaining({ + trace: expect.objectContaining({ + op: UI_LOAD, + data: expect.objectContaining({ + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: UI_LOAD, + }), + }), + }), + measurements: expect.objectContaining({ + [APP_START_WARM_MEASUREMENT]: { + value: timeOriginMilliseconds - appStartTimeMilliseconds, + unit: 'millisecond', + }, + }), + spans: expect.arrayContaining([ + { + op: APP_START_WARM_OP, + description: 'Warm App Start', + start_timestamp: appStartTimeMilliseconds / 1000, + timestamp: expect.any(Number), + trace_id: expect.any(String), + span_id: expect.any(String), + parent_span_id: '123', + origin: 'auto', + status: 'ok', + data: { + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: APP_START_WARM_OP, + [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto', + }, + }, + { + start_timestamp: 100, + timestamp: 200, + op: 'test', + description: 'Test', + span_id: '123', + trace_id: '456', + }, + ]), + }); +} + +function expectEventWithStandaloneColdAppStart( + actualEvent: Event, + { + timeOriginMilliseconds, + appStartTimeMilliseconds, + }: { + timeOriginMilliseconds: number; + appStartTimeMilliseconds: number; + }, +) { + return expect.objectContaining({ + type: 'transaction', + start_timestamp: appStartTimeMilliseconds / 1000, + contexts: expect.objectContaining({ + trace: expect.objectContaining({ + op: UI_LOAD, + data: expect.objectContaining({ + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: UI_LOAD, + }), + }), + }), + measurements: expect.objectContaining({ + [APP_START_COLD_MEASUREMENT]: { + value: timeOriginMilliseconds - appStartTimeMilliseconds, + unit: 'millisecond', + }, + }), + spans: expect.arrayContaining([ + { + op: APP_START_COLD_OP, + description: 'Cold App Start', + start_timestamp: appStartTimeMilliseconds / 1000, + timestamp: expect.any(Number), + trace_id: expect.any(String), + span_id: expect.any(String), + parent_span_id: actualEvent!.contexts!.trace!.span_id, + origin: 'auto', + status: 'ok', + data: { + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: APP_START_COLD_OP, + [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto', + }, + }, + ]), + }); +} + +function expectEventWithStandaloneWarmAppStart( + actualEvent: Event, + { + timeOriginMilliseconds, + appStartTimeMilliseconds, + }: { + timeOriginMilliseconds: number; + appStartTimeMilliseconds: number; + }, +) { + return expect.objectContaining({ + type: 'transaction', + start_timestamp: appStartTimeMilliseconds / 1000, + contexts: expect.objectContaining({ + trace: expect.objectContaining({ + op: UI_LOAD, + data: expect.objectContaining({ + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: UI_LOAD, + }), + }), + }), + measurements: expect.objectContaining({ + [APP_START_WARM_MEASUREMENT]: { + value: timeOriginMilliseconds - appStartTimeMilliseconds, + unit: 'millisecond', + }, + }), + spans: expect.arrayContaining([ + { + op: APP_START_WARM_OP, + description: 'Warm App Start', + start_timestamp: appStartTimeMilliseconds / 1000, + timestamp: expect.any(Number), + trace_id: expect.any(String), + span_id: expect.any(String), + parent_span_id: actualEvent!.contexts!.trace!.span_id, + origin: 'auto', + status: 'ok', + data: { + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: APP_START_WARM_OP, + [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto', + }, + }, + ]), + }); +} + +function mockAppStart({ + cold = false, + has_fetched = false, + enableNativeSpans = false, + customNativeSpans = [], +}: { + cold?: boolean; + has_fetched?: boolean; + enableNativeSpans?: boolean; + customNativeSpans?: NativeAppStartResponse['spans']; +}) { + const timeOriginMilliseconds = Date.now(); + const appStartTimeMilliseconds = timeOriginMilliseconds - 100; + const mockAppStartResponse: NativeAppStartResponse = { + type: cold ? 'cold' : 'warm', + app_start_timestamp_ms: appStartTimeMilliseconds, + has_fetched: has_fetched, + spans: enableNativeSpans + ? [ + { + description: 'test native app start span', + start_timestamp_ms: timeOriginMilliseconds - 100, + end_timestamp_ms: timeOriginMilliseconds - 50, + }, + ...customNativeSpans, + ] + : [], + }; + + _setAppStartEndTimestampMs(timeOriginMilliseconds); + mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds); + mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse); + + return [timeOriginMilliseconds, appStartTimeMilliseconds]; +} + +function mockTooLongAppStart() { + const timeOriginMilliseconds = Date.now(); + const appStartTimeMilliseconds = timeOriginMilliseconds - 65000; + const mockAppStartResponse: NativeAppStartResponse = { + type: 'warm', + app_start_timestamp_ms: appStartTimeMilliseconds, + has_fetched: false, + spans: [], + }; + + _setAppStartEndTimestampMs(timeOriginMilliseconds); + mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds); + mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse); + + return [timeOriginMilliseconds, appStartTimeMilliseconds]; +} + +function mockTooOldAppStart() { + const timeOriginMilliseconds = Date.now(); + const appStartTimeMilliseconds = timeOriginMilliseconds - 65000; + const mockAppStartResponse: NativeAppStartResponse = { + type: 'warm', + app_start_timestamp_ms: appStartTimeMilliseconds, + has_fetched: false, + spans: [], + }; + + // App start finish timestamp + _setAppStartEndTimestampMs(timeOriginMilliseconds); + mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds - 64000); + mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse); + // Transaction start timestamp + mockFunction(timestampInSeconds).mockReturnValue(timeOriginMilliseconds / 1000 + 65); + + return [timeOriginMilliseconds, appStartTimeMilliseconds]; +} + +/** + * Mocks RN Bundle Start Module + * `var __BUNDLE_START_TIME__=this.nativePerformanceNow?nativePerformanceNow():Date.now()` + */ +function mockReactNativeBundleExecutionStartTimestamp() { + RN_GLOBAL_OBJ.nativePerformanceNow = () => 100; // monotonic clock like `performance.now()` + RN_GLOBAL_OBJ.__BUNDLE_START_TIME__ = 50; // 50ms after time origin +} + +/** + * Removes mock added by mockReactNativeBundleExecutionStartTimestamp + */ +function clearReactNativeBundleExecutionStartTimestamp() { + delete RN_GLOBAL_OBJ.nativePerformanceNow; + delete RN_GLOBAL_OBJ.__BUNDLE_START_TIME__; +} + +function set__DEV__(value: boolean) { + Object.defineProperty(globalThis, '__DEV__', { + value, + writable: true, + }); +} diff --git a/test/tracing/reactnativenavigation.test.ts b/test/tracing/reactnativenavigation.test.ts index b12e86a170..44c3a1abae 100644 --- a/test/tracing/reactnativenavigation.test.ts +++ b/test/tracing/reactnativenavigation.test.ts @@ -372,13 +372,13 @@ describe('React Native Navigation Instrumentation', () => { routingInstrumentation: rNavigation, enableStallTracking: false, enableNativeFramesTracking: false, - enableAppStartTracking: false, beforeNavigate: setupOptions.beforeNavigate, }); const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, integrations: [rnTracing], + enableAppStartTracking: false, }); client = new TestClient(options); setCurrentClient(client); diff --git a/test/tracing/reactnativetracing.test.ts b/test/tracing/reactnativetracing.test.ts index bcd49bbda7..f01d049b60 100644 --- a/test/tracing/reactnativetracing.test.ts +++ b/test/tracing/reactnativetracing.test.ts @@ -8,9 +8,8 @@ jest.mock('@sentry/utils', () => { }); import * as SentryBrowser from '@sentry/browser'; -import type { Event, Span, SpanJSON } from '@sentry/types'; +import type { Event, Span } from '@sentry/types'; -import type { NativeAppStartResponse } from '../../src/js/NativeRNSentry'; import { RoutingInstrumentation } from '../../src/js/tracing/routingInstrumentation'; jest.mock('../../src/js/wrapper', () => { @@ -59,33 +58,17 @@ jest.mock('react-native/Libraries/AppState/AppState', () => mockedAppState); import { getActiveSpan, spanToJSON, startSpanManual } from '@sentry/browser'; import { getCurrentScope, SPAN_STATUS_ERROR, startInactiveSpan } from '@sentry/core'; -import { timestampInSeconds } from '@sentry/utils'; import type { AppState, AppStateStatus } from 'react-native'; -import { APP_START_COLD, APP_START_WARM } from '../../src/js/measurements'; -import { - APP_START_COLD as APP_START_COLD_OP, - APP_START_WARM as APP_START_WARM_OP, - UI_LOAD, -} from '../../src/js/tracing'; -import { APP_START_WARM as APP_SPAN_START_WARM } from '../../src/js/tracing/ops'; import { ReactNativeTracing } from '../../src/js/tracing/reactnativetracing'; -import { getTimeOriginMilliseconds } from '../../src/js/tracing/utils'; -import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { NATIVE } from '../../src/js/wrapper'; import type { TestClient } from '../mocks/client'; import { setupTestClient } from '../mocks/client'; -import { mockFunction } from '../testutils'; import type { MockedRoutingInstrumentation } from './mockedrountinginstrumention'; import { createMockedRoutingInstrumentation } from './mockedrountinginstrumention'; -const originalTimestampInSeconds = mockFunction(timestampInSeconds).getMockImplementation(); - -const DEFAULT_IDLE_TIMEOUT = 1000; - describe('ReactNativeTracing', () => { beforeEach(() => { - clearReactNativeBundleExecutionStartTimestamp(); jest.useFakeTimers(); NATIVE.enableNative = true; mockedAppState.isAvailable = true; @@ -169,432 +152,13 @@ describe('ReactNativeTracing', () => { }); }); - describe('App Start Tracing Instrumentation', () => { + describe('Tracing Instrumentation', () => { let client: TestClient; beforeEach(() => { client = setupTestClient(); }); - describe('App Start without routing instrumentation', () => { - it('Starts route transaction (cold)', async () => { - const integration = new ReactNativeTracing({ - enableNativeFramesTracking: false, - }); - - const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStartResponse({ cold: true }); - - integration.setup(client); - integration.onAppStartFinish(Date.now() / 1000); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - expect(transaction).toBeDefined(); - expect(transaction?.start_timestamp).toBe(appStartTimeMilliseconds / 1000); - expect(transaction?.contexts?.trace?.op).toBe(UI_LOAD); - - expect(transaction?.measurements?.[APP_START_COLD].value).toEqual( - timeOriginMilliseconds - appStartTimeMilliseconds, - ); - expect(transaction?.measurements?.[APP_START_COLD].unit).toBe('millisecond'); - }); - - it('Starts route transaction (warm)', async () => { - const integration = new ReactNativeTracing(); - - const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStartResponse({ cold: false }); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - expect(transaction).toBeDefined(); - expect(transaction?.start_timestamp).toBe(appStartTimeMilliseconds / 1000); - expect(transaction?.contexts?.trace?.op).toBe(UI_LOAD); - - expect(transaction?.measurements?.[APP_START_WARM].value).toEqual( - timeOriginMilliseconds - appStartTimeMilliseconds, - ); - expect(transaction?.measurements?.[APP_START_WARM].unit).toBe('millisecond'); - }); - - it('Cancels route transaction when app goes to background', async () => { - const integration = new ReactNativeTracing(); - - mockAppStartResponse({ cold: false }); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - - mockedAppState.setState('background'); - jest.runAllTimers(); - - const transaction = client.event; - expect(transaction?.contexts?.trace?.status).toBe('cancelled'); - expect(mockedAppState.removeSubscription).toBeCalledTimes(1); - }); - - it('Does not crash when AppState is not available', async () => { - mockedAppState.isAvailable = false; - mockedAppState.addEventListener = ((): void => { - return undefined; - }) as unknown as (typeof mockedAppState)['addEventListener']; // RN Web can return undefined - - setupTestClient({ - integrations: [new ReactNativeTracing()], - }); - - mockAppStartResponse({ cold: false }); - - await jest.advanceTimersByTimeAsync(500); - const transaction = getActiveSpan(); - - jest.runAllTimers(); - - expect(spanToJSON(transaction!).timestamp).toBeDefined(); - }); - - it('Does not add app start measurement if more than 60s', async () => { - const integration = new ReactNativeTracing(); - - const timeOriginMilliseconds = Date.now(); - const appStartTimeMilliseconds = timeOriginMilliseconds - 65000; - const mockAppStartResponse: NativeAppStartResponse = { - type: 'warm', - app_start_timestamp_ms: appStartTimeMilliseconds, - has_fetched: false, - spans: [], - }; - - mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds); - mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - expect(transaction).toBeDefined(); - expect(transaction?.measurements?.[APP_START_WARM]).toBeUndefined(); - expect(transaction?.measurements?.[APP_START_COLD]).toBeUndefined(); - }); - - it('Does not add app start span if more than 60s', async () => { - const integration = new ReactNativeTracing(); - - const timeOriginMilliseconds = Date.now(); - const appStartTimeMilliseconds = timeOriginMilliseconds - 65000; - const mockAppStartResponse: NativeAppStartResponse = { - type: 'warm', - app_start_timestamp_ms: appStartTimeMilliseconds, - has_fetched: false, - spans: [], - }; - - mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds); - mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - expect(transaction).toBeDefined(); - expect(transaction?.spans?.some(span => span.op == APP_SPAN_START_WARM)).toBeFalse(); - expect(transaction?.start_timestamp).toBeGreaterThanOrEqual(timeOriginMilliseconds / 1000); - }); - - describe('old app starts', () => { - let integration: ReactNativeTracing; - let timeOriginMilliseconds: number; - - beforeEach(() => { - integration = new ReactNativeTracing(); - - timeOriginMilliseconds = Date.now(); - const appStartTimeMilliseconds = timeOriginMilliseconds - 65000; - const mockAppStartResponse: NativeAppStartResponse = { - type: 'warm', - app_start_timestamp_ms: appStartTimeMilliseconds, - has_fetched: false, - spans: [], - }; - - // App start finish timestamp - mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds - 64000); - mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse); - // Transaction start timestamp - mockFunction(timestampInSeconds).mockReturnValue(timeOriginMilliseconds / 1000 + 65); - }); - - afterEach(async () => { - mockFunction(timestampInSeconds).mockReset().mockImplementation(originalTimestampInSeconds); - set__DEV__(true); - }); - - it('Does not add app start span older than than 60s in production', async () => { - set__DEV__(false); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - expect(transaction).toBeDefined(); - expect(transaction?.spans?.some(span => span.op == APP_SPAN_START_WARM)).toBeFalse(); - expect(transaction?.start_timestamp).toBeGreaterThanOrEqual(timeOriginMilliseconds / 1000); - }); - - it('Does add app start span older than than 60s in development builds', async () => { - set__DEV__(true); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - expect(transaction).toBeDefined(); - expect(transaction?.spans?.some(span => span.op == APP_SPAN_START_WARM)).toBeTrue(); - expect(transaction?.start_timestamp).toBeGreaterThanOrEqual((timeOriginMilliseconds - 65000) / 1000); - }); - }); - - it('Does not create app start transaction if has_fetched == true', async () => { - const integration = new ReactNativeTracing(); - - mockAppStartResponse({ cold: false, has_fetched: true }); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - expect(transaction).toBeUndefined(); - }); - - describe('bundle execution spans', () => { - it('does not add bundle executions span if __BUNDLE_START_TIME__ is undefined', async () => { - const integration = new ReactNativeTracing(); - - mockAppStartResponse({ cold: true }); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - const bundleStartSpan = transaction!.spans!.find( - ({ description }) => - description === 'JS Bundle Execution Start' || description === 'JS Bundle Execution Before React Root', - ); - - expect(bundleStartSpan).toBeUndefined(); - }); - - it('adds bundle execution span', async () => { - const integration = new ReactNativeTracing(); - - const [timeOriginMilliseconds] = mockAppStartResponse({ cold: true }); - mockReactNativeBundleExecutionStartTimestamp(); - - integration.setup(client); - integration.onAppStartFinish(timeOriginMilliseconds + 200); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - const appStartRootSpan = transaction!.spans!.find(({ description }) => description === 'Cold App Start'); - const bundleStartSpan = transaction!.spans!.find( - ({ description }) => description === 'JS Bundle Execution Start', - ); - - expect(appStartRootSpan).toEqual( - expect.objectContaining({ - description: 'Cold App Start', - span_id: expect.any(String), - op: APP_START_COLD_OP, - }), - ); - expect(bundleStartSpan).toEqual( - expect.objectContaining({ - description: 'JS Bundle Execution Start', - start_timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), - timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), - parent_span_id: appStartRootSpan!.span_id, // parent is the root app start span - op: appStartRootSpan!.op, // op is the same as the root app start span - }), - ); - }); - - it('adds bundle execution before react root', async () => { - const integration = new ReactNativeTracing(); - - const [timeOriginMilliseconds] = mockAppStartResponse({ cold: true }); - mockReactNativeBundleExecutionStartTimestamp(); - - integration.setup(client); - integration.setRootComponentFirstConstructorCallTimestampMs(timeOriginMilliseconds - 10); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - const appStartRootSpan = transaction!.spans!.find(({ description }) => description === 'Cold App Start'); - const bundleStartSpan = transaction!.spans!.find( - ({ description }) => description === 'JS Bundle Execution Before React Root', - ); - - expect(appStartRootSpan).toEqual( - expect.objectContaining({ - description: 'Cold App Start', - span_id: expect.any(String), - op: APP_START_COLD_OP, - }), - ); - expect(bundleStartSpan).toEqual( - expect.objectContaining({ - description: 'JS Bundle Execution Before React Root', - start_timestamp: expect.closeTo((timeOriginMilliseconds - 50) / 1000), - timestamp: (timeOriginMilliseconds - 10) / 1000, - parent_span_id: appStartRootSpan!.span_id, // parent is the root app start span - op: appStartRootSpan!.op, // op is the same as the root app start span - }), - ); - }); - }); - - it('adds native spans as a child of the main app start span', async () => { - const integration = new ReactNativeTracing(); - - const [timeOriginMilliseconds] = mockAppStartResponse({ - cold: true, - enableNativeSpans: true, - }); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - const appStartRootSpan = transaction!.spans!.find(({ description }) => description === 'Cold App Start'); - const nativeSpan = transaction!.spans!.find(({ description }) => description === 'test native app start span'); - - expect(appStartRootSpan).toEqual( - expect.objectContaining({ - description: 'Cold App Start', - span_id: expect.any(String), - op: APP_START_COLD_OP, - }), - ); - expect(nativeSpan).toEqual( - expect.objectContaining({ - description: 'test native app start span', - start_timestamp: (timeOriginMilliseconds - 100) / 1000, - timestamp: (timeOriginMilliseconds - 50) / 1000, - parent_span_id: appStartRootSpan!.span_id, // parent is the root app start span - op: appStartRootSpan!.op, // op is the same as the root app start span - }), - ); - }); - - it('adds ui kit init full length as a child of the main app start span', async () => { - const integration = new ReactNativeTracing(); - - const timeOriginMilliseconds = Date.now(); - mockAppStartResponse({ - cold: true, - enableNativeSpans: true, - customNativeSpans: [ - { - description: 'UIKit init', - start_timestamp_ms: timeOriginMilliseconds - 100, - end_timestamp_ms: timeOriginMilliseconds - 60, - }, - ], - }); - mockReactNativeBundleExecutionStartTimestamp(); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - const nativeSpan = transaction!.spans!.find(({ description }) => description?.startsWith('UIKit Init')); - - expect(nativeSpan).toBeDefined(); - expect(nativeSpan).toEqual( - expect.objectContaining({ - description: 'UIKit Init', - start_timestamp: (timeOriginMilliseconds - 100) / 1000, - timestamp: (timeOriginMilliseconds - 60) / 1000, - }), - ); - }); - - it('adds ui kit init start mark as a child of the main app start span', async () => { - const integration = new ReactNativeTracing(); - - const timeOriginMilliseconds = Date.now(); - mockAppStartResponse({ - cold: true, - enableNativeSpans: true, - customNativeSpans: [ - { - description: 'UIKit init', - start_timestamp_ms: timeOriginMilliseconds - 100, - end_timestamp_ms: timeOriginMilliseconds - 20, // After mocked bundle execution start - }, - ], - }); - mockReactNativeBundleExecutionStartTimestamp(); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - - const nativeRuntimeInitSpan = transaction!.spans!.find(({ description }) => - description?.startsWith('UIKit Init to JS Exec Start'), - ); - - expect(nativeRuntimeInitSpan).toBeDefined(); - expect(nativeRuntimeInitSpan).toEqual( - expect.objectContaining({ - description: 'UIKit Init to JS Exec Start', - start_timestamp: (timeOriginMilliseconds - 100) / 1000, - timestamp: (timeOriginMilliseconds - 50) / 1000, - }), - ); - }); - }); - describe('With routing instrumentation', () => { it('Cancels route transaction when app goes to background', async () => { const routingInstrumentation = new RoutingInstrumentation(); @@ -602,8 +166,6 @@ describe('ReactNativeTracing', () => { routingInstrumentation, }); - mockAppStartResponse({ cold: true }); - integration.setup(client); // wait for internal promises to resolve, fetch app start data from mocked native await Promise.resolve(); @@ -621,160 +183,32 @@ describe('ReactNativeTracing', () => { expect(mockedAppState.removeSubscription).toBeCalledTimes(1); }); - it('Adds measurements and child span onto existing routing transaction and sets the op (cold)', async () => { - const routingInstrumentation = new RoutingInstrumentation(); - const integration = new ReactNativeTracing({ - routingInstrumentation, - }); - - const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStartResponse({ cold: true }); - - integration.setup(client); - // wait for internal promises to resolve, fetch app start data from mocked native - await Promise.resolve(); - - expect(getActiveSpan()).toBeUndefined(); - - routingInstrumentation.onRouteWillChange({ - name: 'test', - }); - - expect(getActiveSpan()).toBeDefined(); - expect(spanToJSON(getActiveSpan()!).description).toEqual('Route Change'); - - // trigger idle transaction to finish and call before finish callbacks - jest.advanceTimersByTime(DEFAULT_IDLE_TIMEOUT); - jest.runOnlyPendingTimers(); - - const routeTransactionEvent = client.event; - expect(routeTransactionEvent!.measurements![APP_START_COLD].value).toBe( - timeOriginMilliseconds - appStartTimeMilliseconds, - ); - - expect(routeTransactionEvent!.contexts!.trace!.op).toBe(UI_LOAD); - expect(routeTransactionEvent!.start_timestamp).toBe(appStartTimeMilliseconds / 1000); - - const span = routeTransactionEvent!.spans![routeTransactionEvent!.spans!.length - 1]; - expect(span!.op).toBe(APP_START_COLD_OP); - expect(span!.description).toBe('Cold App Start'); - expect(span!.start_timestamp).toBe(appStartTimeMilliseconds / 1000); - expect(span!.timestamp).toBe(timeOriginMilliseconds / 1000); - }); - - it('Adds measurements and child span onto existing routing transaction and sets the op (warm)', async () => { - const routingInstrumentation = new RoutingInstrumentation(); - const integration = new ReactNativeTracing({ - routingInstrumentation, - }); - - const [timeOriginMilliseconds, appStartTimeMilliseconds] = mockAppStartResponse({ cold: false }); - - integration.setup(client); - // wait for internal promises to resolve, fetch app start data from mocked native - await Promise.resolve(); - - expect(getActiveSpan()).toBeUndefined(); - - routingInstrumentation.onRouteWillChange({ - name: 'test', - }); - - expect(getActiveSpan()).toBeDefined(); - expect(spanToJSON(getActiveSpan()!).description).toEqual('Route Change'); - - // trigger idle transaction to finish and call before finish callbacks - jest.advanceTimersByTime(DEFAULT_IDLE_TIMEOUT); - jest.runOnlyPendingTimers(); - - const routeTransaction = client.event; - expect(routeTransaction!.measurements![APP_START_WARM].value).toBe( - timeOriginMilliseconds - appStartTimeMilliseconds, - ); - - expect(routeTransaction!.contexts!.trace!.op).toBe(UI_LOAD); - expect(routeTransaction!.start_timestamp).toBe(appStartTimeMilliseconds / 1000); - - const span = routeTransaction!.spans![routeTransaction!.spans!.length - 1]; - expect(span!.op).toBe(APP_START_WARM_OP); - expect(span!.description).toBe('Warm App Start'); - expect(span!.start_timestamp).toBe(appStartTimeMilliseconds / 1000); - expect(span!.timestamp).toBe(timeOriginMilliseconds / 1000); - }); + it('Does not crash when AppState is not available', async () => { + mockedAppState.isAvailable = false; + mockedAppState.addEventListener = ((): void => { + return undefined; + }) as unknown as (typeof mockedAppState)['addEventListener']; // RN Web can return undefined - it('Does not update route transaction if has_fetched == true', async () => { const routingInstrumentation = new RoutingInstrumentation(); - const integration = new ReactNativeTracing({ - enableStallTracking: false, - routingInstrumentation, + setupTestClient({ + integrations: [ + new ReactNativeTracing({ + routingInstrumentation, + }), + ], }); - const [, appStartTimeMilliseconds] = mockAppStartResponse({ cold: false, has_fetched: true }); - - integration.setup(client); - // wait for internal promises to resolve, fetch app start data from mocked native - await Promise.resolve(); - - expect(getActiveSpan()).toBeUndefined(); - routingInstrumentation.onRouteWillChange({ name: 'test', }); - expect(getActiveSpan()).toBeDefined(); - expect(spanToJSON(getActiveSpan()!).description).toEqual('Route Change'); - - // trigger idle transaction to finish and call before finish callbacks - jest.advanceTimersByTime(DEFAULT_IDLE_TIMEOUT); - jest.runOnlyPendingTimers(); + await jest.advanceTimersByTimeAsync(500); + const transaction = getActiveSpan(); - const routeTransaction = client.event; - expect(routeTransaction!.measurements).toBeUndefined(); - expect(routeTransaction!.contexts!.trace!.op).not.toBe(UI_LOAD); - expect(routeTransaction!.start_timestamp).not.toBe(appStartTimeMilliseconds / 1000); - expect(routeTransaction!.spans!.length).toBe(0); - }); - }); + jest.runAllTimers(); - it('Does not instrument app start if app start is disabled', async () => { - const integration = new ReactNativeTracing({ - enableAppStartTracking: false, + expect(spanToJSON(transaction!).timestamp).toBeDefined(); }); - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - expect(transaction).toBeUndefined(); - expect(NATIVE.fetchNativeAppStart).not.toBeCalled(); - }); - - it('Does not instrument app start if native is disabled', async () => { - NATIVE.enableNative = false; - - const integration = new ReactNativeTracing(); - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - expect(transaction).toBeUndefined(); - expect(NATIVE.fetchNativeAppStart).not.toBeCalled(); - }); - - it('Does not instrument app start if fetchNativeAppStart returns null', async () => { - mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(null); - - const integration = new ReactNativeTracing(); - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - const transaction = client.event; - expect(transaction).toBeUndefined(); - expect(NATIVE.fetchNativeAppStart).toBeCalledTimes(1); }); }); @@ -1166,62 +600,3 @@ describe('ReactNativeTracing', () => { }); }); }); - -function mockAppStartResponse({ - cold, - has_fetched, - enableNativeSpans, - customNativeSpans, -}: { - cold: boolean; - has_fetched?: boolean; - enableNativeSpans?: boolean; - customNativeSpans?: NativeAppStartResponse['spans']; -}) { - const timeOriginMilliseconds = Date.now(); - const appStartTimeMilliseconds = timeOriginMilliseconds - 100; - const mockAppStartResponse: NativeAppStartResponse = { - type: cold ? 'cold' : 'warm', - app_start_timestamp_ms: appStartTimeMilliseconds, - has_fetched: has_fetched ?? false, - spans: enableNativeSpans - ? [ - { - description: 'test native app start span', - start_timestamp_ms: timeOriginMilliseconds - 100, - end_timestamp_ms: timeOriginMilliseconds - 50, - }, - ...(customNativeSpans ?? []), - ] - : [], - }; - - mockFunction(getTimeOriginMilliseconds).mockReturnValue(timeOriginMilliseconds); - mockFunction(NATIVE.fetchNativeAppStart).mockResolvedValue(mockAppStartResponse); - - return [timeOriginMilliseconds, appStartTimeMilliseconds]; -} - -/** - * Mocks RN Bundle Start Module - * `var __BUNDLE_START_TIME__=this.nativePerformanceNow?nativePerformanceNow():Date.now()` - */ -function mockReactNativeBundleExecutionStartTimestamp() { - RN_GLOBAL_OBJ.nativePerformanceNow = () => 100; // monotonic clock like `performance.now()` - RN_GLOBAL_OBJ.__BUNDLE_START_TIME__ = 50; // 50ms after time origin -} - -/** - * Removes mock added by mockReactNativeBundleExecutionStartTimestamp - */ -function clearReactNativeBundleExecutionStartTimestamp() { - delete RN_GLOBAL_OBJ.nativePerformanceNow; - delete RN_GLOBAL_OBJ.__BUNDLE_START_TIME__; -} - -function set__DEV__(value: boolean) { - Object.defineProperty(globalThis, '__DEV__', { - value, - writable: true, - }); -} diff --git a/test/tracing/reactnavigation.stalltracking.test.ts b/test/tracing/reactnavigation.stalltracking.test.ts index c025de0652..b8a041aa06 100644 --- a/test/tracing/reactnavigation.stalltracking.test.ts +++ b/test/tracing/reactnavigation.stalltracking.test.ts @@ -32,12 +32,12 @@ describe('StallTracking with ReactNavigation', () => { routingInstrumentation: rnavigation, enableStallTracking: true, enableNativeFramesTracking: false, - enableAppStartTracking: false, }); const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, integrations: [rnTracing], + enableAppStartTracking: false, }); client = new TestClient(options); setCurrentClient(client); diff --git a/test/tracing/reactnavigation.test.ts b/test/tracing/reactnavigation.test.ts index cd52e72a70..1ba51d5d3f 100644 --- a/test/tracing/reactnavigation.test.ts +++ b/test/tracing/reactnavigation.test.ts @@ -335,13 +335,13 @@ describe('ReactNavigationInstrumentation', () => { routingInstrumentation: rNavigation, enableStallTracking: false, enableNativeFramesTracking: false, - enableAppStartTracking: false, beforeNavigate: setupOptions.beforeNavigate, }); const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, integrations: [rnTracing], + enableAppStartTracking: false, }); client = new TestClient(options); setCurrentClient(client); diff --git a/test/tracing/reactnavigation.ttid.test.tsx b/test/tracing/reactnavigation.ttid.test.tsx index 07b6cb267e..f82996c6e0 100644 --- a/test/tracing/reactnavigation.ttid.test.tsx +++ b/test/tracing/reactnavigation.ttid.test.tsx @@ -14,6 +14,7 @@ import TestRenderer from 'react-test-renderer'; import * as Sentry from '../../src/js'; import { ReactNavigationInstrumentation } from '../../src/js'; import { TimeToFullDisplay, TimeToInitialDisplay } from '../../src/js/tracing'; +import { _setAppStartEndTimestampMs } from '../../src/js/tracing/integrations/appStart'; import { isHermesEnabled, notWeb } from '../../src/js/utils/environment'; import { createSentryEventEmitter } from '../../src/js/utils/sentryeventemitter'; import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; @@ -41,6 +42,7 @@ describe('React Navigation - TTID', () => { type: 'cold', spans: [], }); + _setAppStartEndTimestampMs(mockedAppStartTimeSeconds * 1000); mockedEventEmitter = mockedSentryEventEmitter.createMockedSentryEventEmitter(); (createSentryEventEmitter as jest.Mock).mockReturnValue(mockedEventEmitter); @@ -540,6 +542,7 @@ function initSentry(sut: ReactNavigationInstrumentation): { send: transportSendMock.mockResolvedValue({}), flush: jest.fn().mockResolvedValue(true), }), + enableAppStartTracking: true, }; Sentry.init(options); diff --git a/test/tracing/stalltracking.test.ts b/test/tracing/stalltracking.test.ts index af1097566e..f0042a5af8 100644 --- a/test/tracing/stalltracking.test.ts +++ b/test/tracing/stalltracking.test.ts @@ -38,12 +38,12 @@ describe('StallTracking', () => { const rnTracing = new ReactNativeTracing({ enableStallTracking: true, enableNativeFramesTracking: false, - enableAppStartTracking: false, }); const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, integrations: [rnTracing], + enableAppStartTracking: false, }); client = new TestClient(options); setCurrentClient(client); From a9abb9387aba0bca646346300d1aa3775847002b Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Tue, 13 Aug 2024 09:56:47 +0200 Subject: [PATCH 08/48] ref(tracing): Extract NativeFrames as standalone integration (#3996) --- CHANGELOG.md | 9 + src/js/integrations/default.ts | 7 + src/js/integrations/exports.ts | 1 + src/js/options.ts | 10 +- src/js/sdk.tsx | 1 + .../nativeFrames.ts} | 133 ++++++++----- src/js/tracing/reactnativetracing.ts | 42 +--- test/sdk.test.ts | 181 +++++++++--------- .../{ => integrations}/nativeframes.test.ts | 82 ++++---- test/tracing/reactnativetracing.test.ts | 33 ---- 10 files changed, 239 insertions(+), 260 deletions(-) rename src/js/tracing/{nativeframes.ts => integrations/nativeFrames.ts} (72%) rename test/tracing/{ => integrations}/nativeframes.test.ts (77%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4834c2d198..b50dc97854 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,15 @@ }); ``` +- New Native Frames Integration ([#3996](https://github.com/getsentry/sentry-react-native/pull/3996)) + + ```js + Sentry.init({ + tracesSampleRate: 1.0, + enableNativeFramesTracking: true, // default true + }); + ``` + ## 5.28.0 ### Fixes diff --git a/src/js/integrations/default.ts b/src/js/integrations/default.ts index edf7011479..c5fe6d81ab 100644 --- a/src/js/integrations/default.ts +++ b/src/js/integrations/default.ts @@ -24,6 +24,7 @@ import { inboundFiltersIntegration, mobileReplayIntegration, modulesLoaderIntegration, + nativeFramesIntegration, nativeLinkedErrorsIntegration, nativeReleaseIntegration, reactNativeErrorHandlersIntegration, @@ -98,6 +99,12 @@ export function getDefaultIntegrations(options: ReactNativeClientOptions): Integ options.enableTracing || typeof options.tracesSampleRate === 'number' || typeof options.tracesSampler === 'function'; + if (hasTracingEnabled && options.enableAppStartTracking) { + integrations.push(appStartIntegration()); + } + if (hasTracingEnabled && options.enableNativeFramesTracking) { + integrations.push(nativeFramesIntegration()); + } if (hasTracingEnabled && options.enableAutoPerformanceTracing) { integrations.push(new ReactNativeTracing()); } diff --git a/src/js/integrations/exports.ts b/src/js/integrations/exports.ts index 2a34136673..3335cb7128 100644 --- a/src/js/integrations/exports.ts +++ b/src/js/integrations/exports.ts @@ -14,6 +14,7 @@ export { expoContextIntegration } from './expocontext'; export { spotlightIntegration } from './spotlight'; export { mobileReplayIntegration } from '../replay/mobilereplay'; export { appStartIntegration } from '../tracing/integrations/appStart'; +export { nativeFramesIntegration } from '../tracing/integrations/nativeFrames'; export { breadcrumbsIntegration, diff --git a/src/js/options.ts b/src/js/options.ts index c28f0d1581..d7b34191d3 100644 --- a/src/js/options.ts +++ b/src/js/options.ts @@ -194,10 +194,18 @@ export interface BaseReactNativeOptions { * * Requires performance monitoring to be enabled. * - * Default: true + * @default true */ enableAppStartTracking?: boolean; + /** + * Track the slow and frozen frames in the application. Enabling this options will add + * slow and frozen frames measurements to all created root spans (transactions). + * + * @default true + */ + enableNativeFramesTracking?: boolean; + /** * Options which are in beta, or otherwise not guaranteed to be stable. */ diff --git a/src/js/sdk.tsx b/src/js/sdk.tsx index 246f635eed..72e3ed3261 100644 --- a/src/js/sdk.tsx +++ b/src/js/sdk.tsx @@ -34,6 +34,7 @@ const DEFAULT_OPTIONS: ReactNativeOptions = { enableCaptureFailedRequests: false, enableNdk: true, enableAppStartTracking: true, + enableNativeFramesTracking: true, }; /** diff --git a/src/js/tracing/nativeframes.ts b/src/js/tracing/integrations/nativeFrames.ts similarity index 72% rename from src/js/tracing/nativeframes.ts rename to src/js/tracing/integrations/nativeFrames.ts index acf43f5e93..1c00ffddd1 100644 --- a/src/js/tracing/nativeframes.ts +++ b/src/js/tracing/integrations/nativeFrames.ts @@ -2,9 +2,10 @@ import { spanToJSON } from '@sentry/core'; import type { Client, Event, Integration, Measurements, MeasurementUnit, Span } from '@sentry/types'; import { logger, timestampInSeconds } from '@sentry/utils'; -import type { NativeFramesResponse } from '../NativeRNSentry'; -import { isRootSpan } from '../utils/span'; -import { NATIVE } from '../wrapper'; +import type { NativeFramesResponse } from '../../NativeRNSentry'; +import type { ReactNativeClientOptions } from '../../options'; +import { isRootSpan } from '../../utils/span'; +import { NATIVE } from '../../wrapper'; /** * Timeout from the final native frames fetch to processing the associated transaction. @@ -34,42 +35,64 @@ const MARGIN_OF_ERROR_SECONDS = 0.05; /** * Instrumentation to add native slow/frozen frames measurements onto transactions. */ -export class NativeFramesInstrumentation implements Integration { - public name: string = 'NativeFramesInstrumentation'; +export const nativeFramesIntegration = (): Integration => { + const name: string = 'NativeFrames'; /** The native frames at the finish time of the most recent span. */ - private _lastSpanFinishFrames?: { - timestamp: number; - nativeFrames: NativeFramesResponse; - }; - private _spanToNativeFramesAtStartMap: Map = new Map(); - - public constructor() { - logger.log('[ReactNativeTracing] Native frames instrumentation initialized.'); - } + let _lastSpanFinishFrames: + | { + timestamp: number; + nativeFrames: NativeFramesResponse; + } + | undefined = undefined; + const _spanToNativeFramesAtStartMap: Map = new Map(); /** * Hooks into the client start and end span events. */ - public setup(client: Client): void { - client.on('spanStart', this._onSpanStart); - client.on('spanEnd', this._onSpanFinish); - } + const setup = (client: Client): void => { + const { enableNativeFramesTracking } = client.getOptions() as ReactNativeClientOptions; + + if (enableNativeFramesTracking && !NATIVE.enableNative) { + // Do not enable native frames tracking if native is not available. + logger.warn( + '[ReactNativeTracing] NativeFramesTracking is not available on the Web, Expo Go and other platforms without native modules.', + ); + return; + } + + if (!enableNativeFramesTracking && NATIVE.enableNative) { + // Disable native frames tracking when native available and option is false. + NATIVE.disableNativeFramesTracking(); + return; + } + + if (!enableNativeFramesTracking) { + return; + } + + NATIVE.enableNativeFramesTracking(); + + // TODO: Ensure other integrations like ReactNativeTracing and ReactNavigation create spans after all integration are setup. + client.on('spanStart', _onSpanStart); + client.on('spanEnd', _onSpanFinish); + logger.log('[ReactNativeTracing] Native frames instrumentation initialized.'); + }; /** * Adds frames measurements to an event. Called from a valid event processor. * Awaits for finish frames if needed. */ - public processEvent(event: Event): Promise { - return this._processEvent(event); - } + const processEvent = (event: Event): Promise => { + return _processEvent(event); + }; /** * Fetches the native frames in background if the given span is a root span. * * @param {Span} rootSpan - The span that has started. */ - private _onSpanStart = (rootSpan: Span): void => { + const _onSpanStart = (rootSpan: Span): void => { if (!isRootSpan(rootSpan)) { return; } @@ -87,7 +110,7 @@ export class NativeFramesInstrumentation implements Integration { return; } - this._spanToNativeFramesAtStartMap.set(rootSpan.spanContext().traceId, frames); + _spanToNativeFramesAtStartMap.set(rootSpan.spanContext().traceId, frames); }) .then(undefined, error => { logger.error( @@ -101,9 +124,9 @@ export class NativeFramesInstrumentation implements Integration { * Called on a span finish to fetch native frames to support transactions with trimEnd. * Only to be called when a span does not have an end timestamp. */ - private _onSpanFinish = (span: Span): void => { + const _onSpanFinish = (span: Span): void => { if (isRootSpan(span)) { - return this._onTransactionFinish(span); + return _onTransactionFinish(span); } const timestamp = timestampInSeconds(); @@ -114,7 +137,7 @@ export class NativeFramesInstrumentation implements Integration { return; } - this._lastSpanFinishFrames = { + _lastSpanFinishFrames = { timestamp, nativeFrames: frames, }; @@ -127,26 +150,26 @@ export class NativeFramesInstrumentation implements Integration { /** * To be called when a transaction is finished */ - private _onTransactionFinish(span: Span): void { - this._fetchFramesForTransaction(span).then(undefined, (reason: unknown) => { + const _onTransactionFinish = (span: Span): void => { + _fetchFramesForTransaction(span).then(undefined, (reason: unknown) => { logger.error( `[NativeFrames] Error while fetching frames for root span start (${span.spanContext().spanId})`, reason, ); }); - } + }; /** * Returns the computed frames measurements and awaits for them if they are not ready yet. */ - private async _getFramesMeasurements( + const _getFramesMeasurements = ( traceId: string, finalEndTimestamp: number, startFrames: NativeFramesResponse, - ): Promise { + ): Promise => { if (_finishFrames.has(traceId)) { logger.debug(`[NativeFrames] Native end frames already fetched for trace id (${traceId}).`); - return this._prepareMeasurements(traceId, finalEndTimestamp, startFrames); + return Promise.resolve(_prepareMeasurements(traceId, finalEndTimestamp, startFrames)); } return new Promise(resolve => { @@ -159,22 +182,22 @@ export class NativeFramesInstrumentation implements Integration { _framesListeners.set(traceId, () => { logger.debug(`[NativeFrames] Native end frames listener called for trace id (${traceId}).`); - resolve(this._prepareMeasurements(traceId, finalEndTimestamp, startFrames)); + resolve(_prepareMeasurements(traceId, finalEndTimestamp, startFrames)); clearTimeout(timeout); _framesListeners.delete(traceId); }); }); - } + }; /** * Returns the computed frames measurements given ready data */ - private _prepareMeasurements( + const _prepareMeasurements = ( traceId: string, finalEndTimestamp: number, // The actual transaction finish time. startFrames: NativeFramesResponse, - ): FramesMeasurements | null { + ): FramesMeasurements | null => { let finalFinishFrames: NativeFramesResponse | undefined; const finish = _finishFrames.get(traceId); @@ -187,13 +210,13 @@ export class NativeFramesInstrumentation implements Integration { logger.debug(`[NativeFrames] Using frames from root span end (traceId, ${traceId}).`); finalFinishFrames = finish.nativeFrames; } else if ( - this._lastSpanFinishFrames && - Math.abs(this._lastSpanFinishFrames.timestamp - finalEndTimestamp) < MARGIN_OF_ERROR_SECONDS + _lastSpanFinishFrames && + Math.abs(_lastSpanFinishFrames.timestamp - finalEndTimestamp) < MARGIN_OF_ERROR_SECONDS ) { // Fallback to the last span finish if it is within the margin of error of the actual finish timestamp. // This should be the case for trimEnd. logger.debug(`[NativeFrames] Using native frames from last span end (traceId, ${traceId}).`); - finalFinishFrames = this._lastSpanFinishFrames.nativeFrames; + finalFinishFrames = _lastSpanFinishFrames.nativeFrames; } else { logger.warn( `[NativeFrames] Frames were collected within larger than margin of error delay for traceId (${traceId}). Dropping the inaccurate values.`, @@ -228,18 +251,18 @@ export class NativeFramesInstrumentation implements Integration { } return measurements; - } + }; /** * Fetch finish frames for a transaction at the current time. Calls any awaiting listeners. */ - private async _fetchFramesForTransaction(span: Span): Promise { + const _fetchFramesForTransaction = async (span: Span): Promise => { const traceId = spanToJSON(span).trace_id; if (!traceId) { return; } - const startFrames = this._spanToNativeFramesAtStartMap.get(span.spanContext().traceId); + const startFrames = _spanToNativeFramesAtStartMap.get(span.spanContext().traceId); // This timestamp marks when the finish frames were retrieved. It should be pretty close to the transaction finish. const timestamp = timestampInSeconds(); @@ -255,13 +278,13 @@ export class NativeFramesInstrumentation implements Integration { _framesListeners.get(traceId)?.(); - setTimeout(() => this._cancelEndFrames(span), FINAL_FRAMES_TIMEOUT_MS); - } + setTimeout(() => _cancelEndFrames(span), FINAL_FRAMES_TIMEOUT_MS); + }; /** * On a finish frames failure, we cancel the await. */ - private _cancelEndFrames(span: Span): void { + const _cancelEndFrames = (span: Span): void => { const spanJSON = spanToJSON(span); const traceId = spanJSON.trace_id; if (!traceId) { @@ -275,13 +298,13 @@ export class NativeFramesInstrumentation implements Integration { `[NativeFrames] Native frames timed out for ${spanJSON.op} transaction ${spanJSON.description}. Not adding native frames measurements.`, ); } - } + }; /** * Adds frames measurements to an event. Called from a valid event processor. * Awaits for finish frames if needed. */ - private async _processEvent(event: Event): Promise { + const _processEvent = async (event: Event): Promise => { if ( event.type !== 'transaction' || !event.transaction || @@ -295,8 +318,8 @@ export class NativeFramesInstrumentation implements Integration { const traceOp = event.contexts.trace.op; const traceId = event.contexts.trace.trace_id; - const startFrames = this._spanToNativeFramesAtStartMap.get(traceId); - this._spanToNativeFramesAtStartMap.delete(traceId); + const startFrames = _spanToNativeFramesAtStartMap.get(traceId); + _spanToNativeFramesAtStartMap.delete(traceId); if (!startFrames) { logger.warn( `[NativeFrames] Start frames of transaction ${event.transaction} (eventId, ${event.event_id}) are missing, but it already ended.`, @@ -304,7 +327,7 @@ export class NativeFramesInstrumentation implements Integration { return event; } - const measurements = await this._getFramesMeasurements(traceId, event.timestamp, startFrames); + const measurements = await _getFramesMeasurements(traceId, event.timestamp, startFrames); if (!measurements) { logger.log( @@ -329,5 +352,11 @@ export class NativeFramesInstrumentation implements Integration { _finishFrames.delete(traceId); return event; - } -} + }; + + return { + name, + setup, + processEvent, + }; +}; diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index 0d146190ae..8c2e5ef1ac 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -14,8 +14,6 @@ import type { Client, Event, Integration, PropagationContext, Scope, Span, Start import { logger, uuid4 } from '@sentry/utils'; import type { RoutingInstrumentationInstance } from '../tracing/routingInstrumentation'; -import { NATIVE } from '../wrapper'; -import { NativeFramesInstrumentation } from './nativeframes'; import { adjustTransactionDuration, cancelInBackground, @@ -91,11 +89,6 @@ export interface ReactNativeTracingOptions extends RequestInstrumentationOptions */ beforeNavigate: BeforeNavigate; - /** - * Track slow/frozen frames from the native layer and adds them as measurements to all transactions. - */ - enableNativeFramesTracking: boolean; - /** * Track when and how long the JS event loop stalls for. Adds stalls as measurements to all transactions. */ @@ -117,7 +110,6 @@ const defaultReactNativeTracingOptions: ReactNativeTracingOptions = { finalTimeoutMs: 600000, ignoreEmptyBackNavigationTransactions: true, beforeNavigate: context => context, - enableNativeFramesTracking: true, enableStallTracking: true, enableUserInteractionTracing: false, }; @@ -139,7 +131,6 @@ export class ReactNativeTracing implements Integration { /** ReactNativeTracing options */ public options: ReactNativeTracingOptions; - public nativeFramesInstrumentation?: NativeFramesInstrumentation; public stallTrackingInstrumentation?: StallTrackingInstrumentation; public useAppStartWithProfiler: boolean = false; @@ -201,8 +192,6 @@ export class ReactNativeTracing implements Integration { (this._hasSetTracePropagationTargets && thisOptionsTracePropagationTargets) || DEFAULT_TRACE_PROPAGATION_TARGETS; - this._enableNativeFramesTracking(client); - if (enableStallTracking) { this.stallTrackingInstrumentation = new StallTrackingInstrumentation(); this.stallTrackingInstrumentation.setup(client); @@ -233,9 +222,7 @@ export class ReactNativeTracing implements Integration { */ public processEvent(event: Event): Promise | Event { const eventWithView = this._getCurrentViewEventProcessor(event); - return this.nativeFramesInstrumentation - ? this.nativeFramesInstrumentation.processEvent(eventWithView) - : eventWithView; + return eventWithView; } /** @@ -318,33 +305,6 @@ export class ReactNativeTracing implements Integration { return this._inflightInteractionTransaction; } - /** - * Enables or disables native frames tracking based on the `enableNativeFramesTracking` option. - */ - private _enableNativeFramesTracking(client: Client): void { - if (this.options.enableNativeFramesTracking && !NATIVE.enableNative) { - // Do not enable native frames tracking if native is not available. - logger.warn( - '[ReactNativeTracing] NativeFramesTracking is not available on the Web, Expo Go and other platforms without native modules.', - ); - return; - } - - if (!this.options.enableNativeFramesTracking && NATIVE.enableNative) { - // Disable native frames tracking when native available and option is false. - NATIVE.disableNativeFramesTracking(); - return; - } - - if (!this.options.enableNativeFramesTracking) { - return; - } - - NATIVE.enableNativeFramesTracking(); - this.nativeFramesInstrumentation = new NativeFramesInstrumentation(); - this.nativeFramesInstrumentation.setup(client); - } - /** * Sets the current view name into the app context. * @param event Le event. diff --git a/test/sdk.test.ts b/test/sdk.test.ts index 672dc1959a..0882b32184 100644 --- a/test/sdk.test.ts +++ b/test/sdk.test.ts @@ -315,10 +315,7 @@ describe('Tests the SDK functionality', () => { it('no http client integration by default', () => { init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'HttpClient' })])); + expectNotIntegration('HttpClient'); }); it('adds http client integration', () => { @@ -326,10 +323,7 @@ describe('Tests the SDK functionality', () => { enableCaptureFailedRequests: true, }); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'HttpClient' })])); + expectIntegration('HttpClient'); }); it('user defined http client integration overwrites default', () => { @@ -361,10 +355,7 @@ describe('Tests the SDK functionality', () => { it('no screenshot integration by default', () => { init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'Screenshot' })])); + expectNotIntegration('Screenshot'); }); it('adds screenshot integration', () => { @@ -372,21 +363,13 @@ describe('Tests the SDK functionality', () => { attachScreenshot: true, }); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Screenshot' })])); + expectIntegration('Screenshot'); }); it('no view hierarchy integration by default', () => { init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual( - expect.not.arrayContaining([expect.objectContaining({ name: 'ViewHierarchy' })]), - ); + expectNotIntegration('ViewHierarchy'); }); it('adds view hierarchy integration', () => { @@ -394,20 +377,13 @@ describe('Tests the SDK functionality', () => { attachViewHierarchy: true, }); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'ViewHierarchy' })])); + expectIntegration('ViewHierarchy'); }); it('no profiling integration by default', () => { init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - expect(actualIntegrations).toEqual( - expect.not.arrayContaining([expect.objectContaining({ name: 'HermesProfiling' })]), - ); + expectNotIntegration('HermesProfiling'); }); it('adds profiling integration', () => { @@ -417,19 +393,13 @@ describe('Tests the SDK functionality', () => { }, }); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - expect(actualIntegrations).toEqual( - expect.arrayContaining([expect.objectContaining({ name: 'HermesProfiling' })]), - ); + expectIntegration('HermesProfiling'); }); it('no spotlight integration by default', () => { init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'Spotlight' })])); + expectNotIntegration('Spotlight'); }); it('adds spotlight integration', () => { @@ -437,9 +407,53 @@ describe('Tests the SDK functionality', () => { enableSpotlight: true, }); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Spotlight' })])); + expectIntegration('Spotlight'); + }); + + it('no app start integration by default', () => { + init({}); + + expectNotIntegration('AppStart'); + }); + + it('when tracing enabled app start integration added by default', () => { + init({ + tracesSampleRate: 0.5, + }); + + expectIntegration('AppStart'); + }); + + it('when tracing enabled and app start disabled the integration is not added', () => { + init({ + tracesSampleRate: 0.5, + enableAppStartTracking: false, + }); + + expectNotIntegration('AppStart'); + }); + + it('no native frames integration by default', () => { + init({}); + + expectNotIntegration('NativeFrames'); + }); + + it('when tracing enabled native frames integration added by default', () => { + init({ + tracesSampleRate: 0.5, + }); + + expectIntegration('NativeFrames'); + }); + + it('when tracing enabled and native frames disabled the integration is not added', () => { + init({ + tracesSampleRate: 0.5, + enableNativeFramesTracking: false, + }); + + expectNotIntegration('NativeFrames'); }); it('no app start integration by default', () => { @@ -561,50 +575,29 @@ describe('Tests the SDK functionality', () => { it('adds react default integrations', () => { init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual( - expect.arrayContaining([ - expect.objectContaining({ name: 'InboundFilters' }), - expect.objectContaining({ name: 'FunctionToString' }), - expect.objectContaining({ name: 'Breadcrumbs' }), - expect.objectContaining({ name: 'Dedupe' }), - expect.objectContaining({ name: 'HttpContext' }), - ]), - ); + expectIntegration('InboundFilters'); + expectIntegration('FunctionToString'); + expectIntegration('Breadcrumbs'); + expectIntegration('Dedupe'); + expectIntegration('HttpContext'); }); it('adds all platform default integrations', () => { init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual( - expect.arrayContaining([ - expect.objectContaining({ name: 'Release' }), - expect.objectContaining({ name: 'EventOrigin' }), - expect.objectContaining({ name: 'SdkInfo' }), - expect.objectContaining({ name: 'ReactNativeInfo' }), - ]), - ); + expectIntegration('Release'); + expectIntegration('EventOrigin'); + expectIntegration('SdkInfo'); + expectIntegration('ReactNativeInfo'); }); it('adds web platform specific default integrations', () => { (notWeb as jest.Mock).mockImplementation(() => false); init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual( - expect.arrayContaining([ - expect.objectContaining({ name: 'BrowserApiErrors' }), - expect.objectContaining({ name: 'GlobalHandlers' }), - expect.objectContaining({ name: 'LinkedErrors' }), - ]), - ); + expectIntegration('BrowserApiErrors'); + expectIntegration('GlobalHandlers'); + expectIntegration('LinkedErrors'); }); it('does not add native integrations if native disabled', () => { @@ -617,22 +610,11 @@ describe('Tests the SDK functionality', () => { }, }); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual( - expect.not.arrayContaining([expect.objectContaining({ name: 'DeviceContext' })]), - ); - expect(actualIntegrations).toEqual( - expect.not.arrayContaining([expect.objectContaining({ name: 'ModulesLoader' })]), - ); - expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'Screenshot' })])); - expect(actualIntegrations).toEqual( - expect.not.arrayContaining([expect.objectContaining({ name: 'ViewHierarchy' })]), - ); - expect(actualIntegrations).toEqual( - expect.not.arrayContaining([expect.objectContaining({ name: 'HermesProfiling' })]), - ); + expectNotIntegration('DeviceContext'); + expectNotIntegration('ModulesLoader'); + expectNotIntegration('Screenshot'); + expectNotIntegration('ViewHierarchy'); + expectNotIntegration('HermesProfiling'); }); }); @@ -640,13 +622,22 @@ describe('Tests the SDK functionality', () => { (isExpoGo as jest.Mock).mockImplementation(() => true); init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - - expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'ExpoContext' })])); + expectIntegration('ExpoContext'); }); }); +function expectIntegration(name: string): void { + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; + expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name })])); +} + +function expectNotIntegration(name: string): void { + const actualOptions = usedOptions(); + const actualIntegrations = actualOptions?.integrations; + expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name })])); +} + function createMockedIntegration({ name }: { name?: string } = {}): Integration { return { name: name ?? 'MockedIntegration', diff --git a/test/tracing/nativeframes.test.ts b/test/tracing/integrations/nativeframes.test.ts similarity index 77% rename from test/tracing/nativeframes.test.ts rename to test/tracing/integrations/nativeframes.test.ts index 1ca2f70f8f..bcab5bcb2e 100644 --- a/test/tracing/nativeframes.test.ts +++ b/test/tracing/integrations/nativeframes.test.ts @@ -1,12 +1,12 @@ import { getCurrentScope, getGlobalScope, getIsolationScope, setCurrentClient, startSpan } from '@sentry/core'; import type { Event, Measurements } from '@sentry/types'; -import { ReactNativeTracing } from '../../src/js'; -import { NATIVE } from '../../src/js/wrapper'; -import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; -import { mockFunction } from '../testutils'; +import { nativeFramesIntegration } from '../../../src/js'; +import { NATIVE } from '../../../src/js/wrapper'; +import { getDefaultTestClientOptions, TestClient } from '../../mocks/client'; +import { mockFunction } from '../../testutils'; -jest.mock('../../src/js/wrapper', () => { +jest.mock('../../../src/js/wrapper', () => { return { NATIVE: { fetchNativeFrames: jest.fn(), @@ -29,11 +29,8 @@ describe('NativeFramesInstrumentation', () => { const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, - integrations: [ - new ReactNativeTracing({ - enableNativeFramesTracking: true, - }), - ], + enableNativeFramesTracking: true, + integrations: [nativeFramesIntegration()], }); client = new TestClient(options); setCurrentClient(client); @@ -144,18 +141,18 @@ describe('NativeFramesInstrumentation', () => { await jest.runOnlyPendingTimersAsync(); await client.flush(); - expect(client.event!).toEqual( + expect(client.event!).toBeOneOf([ + expect.not.objectContaining>({ + measurements: expect.anything(), + }), expect.objectContaining>({ - measurements: expect.toBeOneOf([ - expect.not.objectContaining({ - frames_total: expect.any(Object), - frames_slow: expect.any(Object), - frames_frozen: expect.any(Object), - }), - undefined, - ]), + measurements: expect.not.objectContaining({ + frames_total: expect.any(Object), + frames_slow: expect.any(Object), + frames_frozen: expect.any(Object), + }), }), - ); + ]); }); it('does not set measurements on transactions without startFrames', async () => { @@ -174,15 +171,18 @@ describe('NativeFramesInstrumentation', () => { await jest.runOnlyPendingTimersAsync(); await client.flush(); - expect(client.event!).toEqual( + expect(client.event!).toBeOneOf([ + expect.not.objectContaining>({ + measurements: expect.anything(), + }), expect.objectContaining>({ - measurements: expect.not.objectContaining({ - frames_total: {}, - frames_slow: {}, - frames_frozen: {}, + measurements: expect.not.objectContaining({ + frames_total: expect.any(Object), + frames_slow: expect.any(Object), + frames_frozen: expect.any(Object), }), }), - ); + ]); }); it('does not set measurements on transactions without finishFrames', async () => { @@ -201,15 +201,18 @@ describe('NativeFramesInstrumentation', () => { await jest.runOnlyPendingTimersAsync(); await client.flush(); - expect(client.event!).toEqual( + expect(client.event!).toBeOneOf([ + expect.not.objectContaining>({ + measurements: expect.anything(), + }), expect.objectContaining>({ - measurements: expect.not.objectContaining({ - frames_total: {}, - frames_slow: {}, - frames_frozen: {}, + measurements: expect.not.objectContaining({ + frames_total: expect.any(Object), + frames_slow: expect.any(Object), + frames_frozen: expect.any(Object), }), }), - ); + ]); }); it('does not set measurements on a transaction event for which finishFrames times out.', async () => { @@ -233,14 +236,17 @@ describe('NativeFramesInstrumentation', () => { await jest.advanceTimersByTimeAsync(2100); // hardcoded final frames timeout 2000ms await client.flush(); - expect(client.event!).toEqual( + expect(client.event!).toBeOneOf([ + expect.not.objectContaining>({ + measurements: expect.anything(), + }), expect.objectContaining>({ - measurements: expect.not.objectContaining({ - frames_total: {}, - frames_slow: {}, - frames_frozen: {}, + measurements: expect.not.objectContaining({ + frames_total: expect.any(Object), + frames_slow: expect.any(Object), + frames_frozen: expect.any(Object), }), }), - ); + ]); }); }); diff --git a/test/tracing/reactnativetracing.test.ts b/test/tracing/reactnativetracing.test.ts index f01d049b60..1d840e0f31 100644 --- a/test/tracing/reactnativetracing.test.ts +++ b/test/tracing/reactnativetracing.test.ts @@ -212,39 +212,6 @@ describe('ReactNativeTracing', () => { }); }); - describe('Native Frames', () => { - let client: TestClient; - - beforeEach(() => { - client = setupTestClient(); - }); - - it('Initialize native frames instrumentation if flag is true', async () => { - const integration = new ReactNativeTracing({ - enableNativeFramesTracking: true, - }); - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - - expect(integration.nativeFramesInstrumentation).toBeDefined(); - expect(NATIVE.enableNativeFramesTracking).toBeCalledTimes(1); - }); - it('Does not initialize native frames instrumentation if flag is false', async () => { - const integration = new ReactNativeTracing({ - enableNativeFramesTracking: false, - }); - - integration.setup(client); - - await jest.advanceTimersByTimeAsync(500); - - expect(integration.nativeFramesInstrumentation).toBeUndefined(); - expect(NATIVE.disableNativeFramesTracking).toBeCalledTimes(1); - expect(NATIVE.fetchNativeFrames).not.toBeCalled(); - }); - }); - describe('Routing Instrumentation', () => { let client: TestClient; From 66c8b93be5428c7b24f702fd55c6d21d9a18dcfe Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Tue, 13 Aug 2024 10:18:53 +0200 Subject: [PATCH 09/48] ref(tracing): Extract Stall Tracking to a standalone integration (#3997) --- CHANGELOG.md | 13 +- src/js/integrations/default.ts | 4 + src/js/integrations/exports.ts | 1 + src/js/options.ts | 7 + src/js/sdk.tsx | 1 + .../{ => integrations}/stalltracking.ts | 311 +++++++++--------- src/js/tracing/reactnativetracing.ts | 14 - test/sdk.test.ts | 20 +- .../stalltracking.background.test.ts | 46 +++ .../stalltracking.iteration.test.ts | 50 +++ .../stallTracking}/stalltracking.test.ts | 12 +- .../stallTracking}/stalltrackingutils.ts | 0 test/tracing/reactnativetracing.test.ts | 10 +- .../reactnavigation.stalltracking.test.ts | 9 +- test/tracing/stalltracking.background.test.ts | 46 --- test/tracing/stalltracking.iteration.test.ts | 50 --- 16 files changed, 286 insertions(+), 308 deletions(-) rename src/js/tracing/{ => integrations}/stalltracking.ts (53%) create mode 100644 test/tracing/integrations/stallTracking/stalltracking.background.test.ts create mode 100644 test/tracing/integrations/stallTracking/stalltracking.iteration.test.ts rename test/tracing/{ => integrations/stallTracking}/stalltracking.test.ts (96%) rename test/tracing/{ => integrations/stallTracking}/stalltrackingutils.ts (100%) delete mode 100644 test/tracing/stalltracking.background.test.ts delete mode 100644 test/tracing/stalltracking.iteration.test.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index b50dc97854..fbcfb0004d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ ### Changes +- New Native Frames Integration ([#3996](https://github.com/getsentry/sentry-react-native/pull/3996)) +- New Stall Tracking Integration ([#3997](https://github.com/getsentry/sentry-react-native/pull/3997)) - New App Start Integration ([#3852](https://github.com/getsentry/sentry-react-native/pull/3852)) By default app start spans are attached to the first created transaction. @@ -15,6 +17,8 @@ Sentry.init({ tracesSampleRate: 1.0, enableAppStartTracking: true, // default true + enableNativeFramesTracking: true, // default true + enableStallTracking: true, // default true integrations: [ Sentry.appStartIntegration({ standalone: false, // default false @@ -23,15 +27,6 @@ }); ``` -- New Native Frames Integration ([#3996](https://github.com/getsentry/sentry-react-native/pull/3996)) - - ```js - Sentry.init({ - tracesSampleRate: 1.0, - enableNativeFramesTracking: true, // default true - }); - ``` - ## 5.28.0 ### Fixes diff --git a/src/js/integrations/default.ts b/src/js/integrations/default.ts index c5fe6d81ab..73ec8f9dec 100644 --- a/src/js/integrations/default.ts +++ b/src/js/integrations/default.ts @@ -32,6 +32,7 @@ import { screenshotIntegration, sdkInfoIntegration, spotlightIntegration, + stallTrackingIntegration, viewHierarchyIntegration, } from './exports'; import { createReactNativeRewriteFrames } from './rewriteframes'; @@ -105,6 +106,9 @@ export function getDefaultIntegrations(options: ReactNativeClientOptions): Integ if (hasTracingEnabled && options.enableNativeFramesTracking) { integrations.push(nativeFramesIntegration()); } + if (hasTracingEnabled && options.enableStallTracking) { + integrations.push(stallTrackingIntegration()); + } if (hasTracingEnabled && options.enableAutoPerformanceTracing) { integrations.push(new ReactNativeTracing()); } diff --git a/src/js/integrations/exports.ts b/src/js/integrations/exports.ts index 3335cb7128..0fc7d5a908 100644 --- a/src/js/integrations/exports.ts +++ b/src/js/integrations/exports.ts @@ -15,6 +15,7 @@ export { spotlightIntegration } from './spotlight'; export { mobileReplayIntegration } from '../replay/mobilereplay'; export { appStartIntegration } from '../tracing/integrations/appStart'; export { nativeFramesIntegration } from '../tracing/integrations/nativeFrames'; +export { stallTrackingIntegration } from '../tracing/integrations/stalltracking'; export { breadcrumbsIntegration, diff --git a/src/js/options.ts b/src/js/options.ts index d7b34191d3..f9012beec0 100644 --- a/src/js/options.ts +++ b/src/js/options.ts @@ -206,6 +206,13 @@ export interface BaseReactNativeOptions { */ enableNativeFramesTracking?: boolean; + /** + * Track when and how long the JS event loop stalls for. Adds stalls as measurements to all transactions. + * + * @default true + */ + enableStallTracking?: boolean; + /** * Options which are in beta, or otherwise not guaranteed to be stable. */ diff --git a/src/js/sdk.tsx b/src/js/sdk.tsx index 72e3ed3261..d8619bdfca 100644 --- a/src/js/sdk.tsx +++ b/src/js/sdk.tsx @@ -35,6 +35,7 @@ const DEFAULT_OPTIONS: ReactNativeOptions = { enableNdk: true, enableAppStartTracking: true, enableNativeFramesTracking: true, + enableStallTracking: true, }; /** diff --git a/src/js/tracing/stalltracking.ts b/src/js/tracing/integrations/stalltracking.ts similarity index 53% rename from src/js/tracing/stalltracking.ts rename to src/js/tracing/integrations/stalltracking.ts index 3e83de1bd2..a109cb7956 100644 --- a/src/js/tracing/stalltracking.ts +++ b/src/js/tracing/integrations/stalltracking.ts @@ -5,9 +5,11 @@ import { logger, timestampInSeconds } from '@sentry/utils'; import type { AppStateStatus } from 'react-native'; import { AppState } from 'react-native'; -import { STALL_COUNT, STALL_LONGEST_TIME, STALL_TOTAL_TIME } from '../measurements'; -import { isRootSpan } from '../utils/span'; -import { getLatestChildSpanEndTimestamp, isNearToNow, setSpanMeasurement } from './utils'; +import { STALL_COUNT, STALL_LONGEST_TIME, STALL_TOTAL_TIME } from '../../measurements'; +import { isRootSpan } from '../../utils/span'; +import { getLatestChildSpanEndTimestamp, isNearToNow, setSpanMeasurement } from '../utils'; + +const INTEGRATION_NAME = 'StallTracking'; export interface StallMeasurements extends Measurements { [STALL_COUNT]: { value: number; unit: MeasurementUnit }; @@ -15,14 +17,6 @@ export interface StallMeasurements extends Measurements { [STALL_LONGEST_TIME]: { value: number; unit: MeasurementUnit }; } -export type StallTrackingOptions = { - /** - * How long in milliseconds an event loop iteration can be delayed for before being considered a "stall." - * @default 100 - */ - minimumStallThreshold: number; -}; - /** Margin of error of 20ms */ const MARGIN_OF_ERROR_SECONDS = 0.02; /** How long between each iteration in the event loop tracker timeout */ @@ -37,25 +31,16 @@ const MAX_RUNNING_TRANSACTIONS = 10; * However, we modified the interval implementation to instead have a fixed loop timeout interval of `LOOP_TIMEOUT_INTERVAL_MS`. * We then would consider that iteration a stall when the total time for that interval to run is greater than `LOOP_TIMEOUT_INTERVAL_MS + minimumStallThreshold` */ -export class StallTrackingInstrumentation implements Integration { - public name: string = 'StallTrackingInstrumentation'; - - public isTracking: boolean = false; - - private _minimumStallThreshold: number; - - /** Total amount of time of all stalls that occurred during the current tracking session */ - private _totalStallTime: number = 0; - /** Total number of stalls that occurred during the current tracking session */ - private _stallCount: number = 0; - - /** The last timestamp the iteration ran in milliseconds */ - private _lastIntervalMs: number = 0; - private _timeout: ReturnType | null = null; - - private _isBackground: boolean = false; - - private _statsByRootSpan: Map< +export const stallTrackingIntegration = ({ + minimumStallThresholdMs = 50, +}: { + /** + * How long in milliseconds an event loop iteration can be delayed for before being considered a "stall." + * @default 50 + */ + minimumStallThresholdMs?: number; +} = {}): Integration => { + const statsByRootSpan: Map< Span, { longestStallTime: number; @@ -67,67 +52,108 @@ export class StallTrackingInstrumentation implements Integration { } > = new Map(); - public constructor(options: StallTrackingOptions = { minimumStallThreshold: 50 }) { - this._minimumStallThreshold = options.minimumStallThreshold; + const state: { + isTracking: boolean; + timeout: ReturnType | null; + isBackground: boolean; + /** Switch that enables the iteration once app moves from background to foreground. */ + backgroundEventListener: (appState: AppStateStatus) => void; + /** The last timestamp the iteration ran in milliseconds */ + lastIntervalMs: number; + /** Total amount of time of all stalls that occurred during the current tracking session */ + totalStallTime: number; + /** Total number of stalls that occurred during the current tracking session */ + stallCount: number; + /** + * Iteration of the stall tracking interval. Measures how long the timer strayed from its expected time of running, and how + * long the stall is for. + */ + iteration: () => void; + } = { + isTracking: false, + timeout: null, + isBackground: false, + lastIntervalMs: 0, + totalStallTime: 0, + stallCount: 0, + backgroundEventListener: (appState: AppStateStatus): void => { + if (appState === ('active' as AppStateStatus)) { + state.isBackground = false; + if (state.timeout != null) { + state.lastIntervalMs = timestampInSeconds() * 1000; + state.iteration(); + } + } else { + state.isBackground = true; + state.timeout !== null && clearTimeout(state.timeout); + } + }, + iteration: (): void => { + const now = timestampInSeconds() * 1000; + const totalTimeTaken = now - state.lastIntervalMs; + + if (totalTimeTaken >= LOOP_TIMEOUT_INTERVAL_MS + minimumStallThresholdMs) { + const stallTime = totalTimeTaken - LOOP_TIMEOUT_INTERVAL_MS; + state.stallCount += 1; + state.totalStallTime += stallTime; + + for (const [transaction, value] of statsByRootSpan.entries()) { + const longestStallTime = Math.max(value.longestStallTime ?? 0, stallTime); + + statsByRootSpan.set(transaction, { + ...value, + longestStallTime, + }); + } + } + + state.lastIntervalMs = now; - this._backgroundEventListener = this._backgroundEventListener.bind(this); - // Avoids throwing any error if using React Native on a environment that doesn't implement AppState. - if (AppState?.isAvailable) { - // eslint-disable-next-line @typescript-eslint/unbound-method - AppState.addEventListener('change', this._backgroundEventListener); - } - } + if (state.isTracking && !state.isBackground) { + state.timeout = setTimeout(state.iteration, LOOP_TIMEOUT_INTERVAL_MS); + } + }, + }; - /** - * @inheritDoc - */ - public setup(client: Client): void { - client.on('spanStart', this._onSpanStart); - client.on('spanEnd', this._onSpanEnd); - } + const setup = (client: Client): void => { + client.on('spanStart', _onSpanStart); + client.on('spanEnd', _onSpanEnd); + }; - /** - * Register a transaction as started. Starts stall tracking if not already running. - */ - private _onSpanStart = (rootSpan: Span): void => { + const _onSpanStart = (rootSpan: Span): void => { if (!isRootSpan(rootSpan)) { return; } - if (this._statsByRootSpan.has(rootSpan)) { + if (statsByRootSpan.has(rootSpan)) { logger.error( '[StallTracking] Tried to start stall tracking on a transaction already being tracked. Measurements might be lost.', ); return; } - this._startTracking(); - this._statsByRootSpan.set(rootSpan, { + _startTracking(); + statsByRootSpan.set(rootSpan, { longestStallTime: 0, atTimestamp: null, - atStart: this._getCurrentStats(rootSpan), + atStart: _getCurrentStats(rootSpan), }); - this._flushLeakedTransactions(); + _flushLeakedTransactions(); }; - /** - * Logs a transaction as finished. - * Stops stall tracking if no more transactions are running. - * @returns The stall measurements - */ - private _onSpanEnd = (rootSpan: Span): void => { + const _onSpanEnd = (rootSpan: Span): void => { if (!isRootSpan(rootSpan)) { - return this._onChildSpanEnd(rootSpan); + return _onChildSpanEnd(rootSpan); } - const transactionStats = this._statsByRootSpan.get(rootSpan); + const transactionStats = statsByRootSpan.get(rootSpan); if (!transactionStats) { // Transaction has been flushed out somehow, we return null. logger.log('[StallTracking] Stall measurements were not added to transaction due to exceeding the max count.'); - this._statsByRootSpan.delete(rootSpan); - this._shouldStopTracking(); + statsByRootSpan.delete(rootSpan); + _shouldStopTracking(); return; } @@ -138,7 +164,7 @@ export class StallTrackingInstrumentation implements Integration { let statsOnFinish: StallMeasurements | undefined; if (isNearToNow(endTimestamp)) { - statsOnFinish = this._getCurrentStats(rootSpan); + statsOnFinish = _getCurrentStats(rootSpan); } else { // The idleSpan in JS V8 is always trimmed to the last span's endTimestamp (timestamp). // The unfinished child spans are removed from the root span after the `spanEnd` event. @@ -161,8 +187,8 @@ export class StallTrackingInstrumentation implements Integration { } } - this._statsByRootSpan.delete(rootSpan); - this._shouldStopTracking(); + statsByRootSpan.delete(rootSpan); + _shouldStopTracking(); if (!statsOnFinish) { if (typeof endTimestamp !== 'undefined') { @@ -200,39 +226,20 @@ export class StallTrackingInstrumentation implements Integration { ); }; - /** - * Marks stalls - */ - private _onChildSpanEnd(childSpan: Span): void { + const _onChildSpanEnd = (childSpan: Span): void => { const rootSpan = getRootSpan(childSpan); const finalEndTimestamp = spanToJSON(childSpan).timestamp; if (finalEndTimestamp) { - this._markSpanFinish(rootSpan, finalEndTimestamp); - } - } - - /** - * Switch that enables the iteraction once app moves from background to foreground. - */ - private _backgroundEventListener(state: AppStateStatus): void { - if (state === ('active' as AppStateStatus)) { - this._isBackground = false; - if (this._timeout != null) { - this._lastIntervalMs = timestampInSeconds() * 1000; - this._iteration(); - } - } else { - this._isBackground = true; - this._timeout !== null && clearTimeout(this._timeout); + _markSpanFinish(rootSpan, finalEndTimestamp); } - } + }; /** * Logs the finish time of the span for use in `trimEnd: true` transactions. */ - private _markSpanFinish(rootSpan: Span, childSpanEndTime: number): void { - const previousStats = this._statsByRootSpan.get(rootSpan); + const _markSpanFinish = (rootSpan: Span, childSpanEndTime: number): void => { + const previousStats = statsByRootSpan.get(rootSpan); if (previousStats) { if (Math.abs(timestampInSeconds() - childSpanEndTime) > MARGIN_OF_ERROR_SECONDS) { logger.log( @@ -241,125 +248,109 @@ export class StallTrackingInstrumentation implements Integration { if (previousStats.atTimestamp && previousStats.atTimestamp.timestamp < childSpanEndTime) { // We also need to delete the stat for the last span, as the transaction would be trimmed to this span not the last one. - this._statsByRootSpan.set(rootSpan, { + statsByRootSpan.set(rootSpan, { ...previousStats, atTimestamp: null, }); } } else { - this._statsByRootSpan.set(rootSpan, { + statsByRootSpan.set(rootSpan, { ...previousStats, atTimestamp: { timestamp: childSpanEndTime, - stats: this._getCurrentStats(rootSpan), + stats: _getCurrentStats(rootSpan), }, }); } } - } + }; /** * Get the current stats for a transaction at a given time. */ - private _getCurrentStats(span: Span): StallMeasurements { + const _getCurrentStats = (span: Span): StallMeasurements => { return { - stall_count: { value: this._stallCount, unit: 'none' }, - stall_total_time: { value: this._totalStallTime, unit: 'millisecond' }, + stall_count: { value: state.stallCount, unit: 'none' }, + stall_total_time: { value: state.totalStallTime, unit: 'millisecond' }, stall_longest_time: { - value: this._statsByRootSpan.get(span)?.longestStallTime ?? 0, + value: statsByRootSpan.get(span)?.longestStallTime ?? 0, unit: 'millisecond', }, }; - } + }; /** * Start tracking stalls */ - private _startTracking(): void { - if (!this.isTracking) { - this.isTracking = true; - this._lastIntervalMs = Math.floor(timestampInSeconds() * 1000); + const _startTracking = (): void => { + if (!state.isTracking) { + state.isTracking = true; + state.lastIntervalMs = Math.floor(timestampInSeconds() * 1000); - this._iteration(); + state.iteration(); } - } + }; /** * Stops the stall tracking interval and calls reset(). */ - private _stopTracking(): void { - this.isTracking = false; + const _stopTracking = (): void => { + state.isTracking = false; - if (this._timeout !== null) { - clearTimeout(this._timeout); - this._timeout = null; + if (state.timeout !== null) { + clearTimeout(state.timeout); + state.timeout = null; } - this._reset(); - } + _reset(); + }; /** * Will stop tracking if there are no more transactions. */ - private _shouldStopTracking(): void { - if (this._statsByRootSpan.size === 0) { - this._stopTracking(); + const _shouldStopTracking = (): void => { + if (statsByRootSpan.size === 0) { + _stopTracking(); } - } + }; /** * Clears all the collected stats */ - private _reset(): void { - this._stallCount = 0; - this._totalStallTime = 0; - this._lastIntervalMs = 0; - this._statsByRootSpan.clear(); - } - - /** - * Iteration of the stall tracking interval. Measures how long the timer strayed from its expected time of running, and how - * long the stall is for. - */ - private _iteration(): void { - const now = timestampInSeconds() * 1000; - const totalTimeTaken = now - this._lastIntervalMs; - - if (totalTimeTaken >= LOOP_TIMEOUT_INTERVAL_MS + this._minimumStallThreshold) { - const stallTime = totalTimeTaken - LOOP_TIMEOUT_INTERVAL_MS; - this._stallCount += 1; - this._totalStallTime += stallTime; - - for (const [transaction, value] of this._statsByRootSpan.entries()) { - const longestStallTime = Math.max(value.longestStallTime ?? 0, stallTime); - - this._statsByRootSpan.set(transaction, { - ...value, - longestStallTime, - }); - } - } - - this._lastIntervalMs = now; - - if (this.isTracking && !this._isBackground) { - this._timeout = setTimeout(this._iteration.bind(this), LOOP_TIMEOUT_INTERVAL_MS); - } - } + const _reset = (): void => { + state.stallCount = 0; + state.totalStallTime = 0; + state.lastIntervalMs = 0; + statsByRootSpan.clear(); + }; /** * Deletes leaked transactions (Earliest transactions when we have more than MAX_RUNNING_TRANSACTIONS transactions.) */ - private _flushLeakedTransactions(): void { - if (this._statsByRootSpan.size > MAX_RUNNING_TRANSACTIONS) { + const _flushLeakedTransactions = (): void => { + if (statsByRootSpan.size > MAX_RUNNING_TRANSACTIONS) { let counter = 0; - const len = this._statsByRootSpan.size - MAX_RUNNING_TRANSACTIONS; - const transactions = this._statsByRootSpan.keys(); + const len = statsByRootSpan.size - MAX_RUNNING_TRANSACTIONS; + const transactions = statsByRootSpan.keys(); for (const t of transactions) { if (counter >= len) break; counter += 1; - this._statsByRootSpan.delete(t); + statsByRootSpan.delete(t); } } + }; + + // Avoids throwing any error if using React Native on a environment that doesn't implement AppState. + if (AppState?.isAvailable) { + // eslint-disable-next-line @typescript-eslint/unbound-method + AppState.addEventListener('change', state.backgroundEventListener); } -} + + return { + name: INTEGRATION_NAME, + setup, + + /** For testing only @private */ + _internalState: state, + } as Integration; +}; diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index 8c2e5ef1ac..3d575b150c 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -21,7 +21,6 @@ import { onlySampleIfChildSpans, onThisSpanEnd, } from './onSpanEndUtils'; -import { StallTrackingInstrumentation } from './stalltracking'; import type { BeforeNavigate } from './types'; const SCOPE_SPAN_FIELD = '_sentrySpan'; @@ -89,11 +88,6 @@ export interface ReactNativeTracingOptions extends RequestInstrumentationOptions */ beforeNavigate: BeforeNavigate; - /** - * Track when and how long the JS event loop stalls for. Adds stalls as measurements to all transactions. - */ - enableStallTracking: boolean; - /** * Trace User Interaction events like touch and gestures. */ @@ -110,7 +104,6 @@ const defaultReactNativeTracingOptions: ReactNativeTracingOptions = { finalTimeoutMs: 600000, ignoreEmptyBackNavigationTransactions: true, beforeNavigate: context => context, - enableStallTracking: true, enableUserInteractionTracing: false, }; @@ -131,7 +124,6 @@ export class ReactNativeTracing implements Integration { /** ReactNativeTracing options */ public options: ReactNativeTracingOptions; - public stallTrackingInstrumentation?: StallTrackingInstrumentation; public useAppStartWithProfiler: boolean = false; private _inflightInteractionTransaction?: Span; @@ -183,7 +175,6 @@ export class ReactNativeTracing implements Integration { // eslint-disable-next-line deprecation/deprecation tracePropagationTargets: thisOptionsTracePropagationTargets, routingInstrumentation, - enableStallTracking, } = this.options; const clientOptionsTracePropagationTargets = clientOptions && clientOptions.tracePropagationTargets; @@ -192,11 +183,6 @@ export class ReactNativeTracing implements Integration { (this._hasSetTracePropagationTargets && thisOptionsTracePropagationTargets) || DEFAULT_TRACE_PROPAGATION_TARGETS; - if (enableStallTracking) { - this.stallTrackingInstrumentation = new StallTrackingInstrumentation(); - this.stallTrackingInstrumentation.setup(client); - } - if (routingInstrumentation) { routingInstrumentation.registerRoutingInstrumentation( this._onRouteWillChange.bind(this), diff --git a/test/sdk.test.ts b/test/sdk.test.ts index 0882b32184..5838e0be30 100644 --- a/test/sdk.test.ts +++ b/test/sdk.test.ts @@ -456,33 +456,27 @@ describe('Tests the SDK functionality', () => { expectNotIntegration('NativeFrames'); }); - it('no app start integration by default', () => { + it('when tracing not set stall tracking the integration is not added', () => { init({}); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'AppStart' })])); + expectNotIntegration('StallTracking'); }); - it('when tracing enabled app start integration added by default', () => { + it('when tracing enabled stall tracking integration added by default', () => { init({ tracesSampleRate: 0.5, }); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'AppStart' })])); + expectIntegration('StallTracking'); }); - it('when tracing enabled and app start disabled the integration is not added', () => { + it('when tracing enabled and stall tracking disabled the integration is not added', () => { init({ tracesSampleRate: 0.5, - enableAppStartTracking: false, + enableStallTracking: false, }); - const actualOptions = usedOptions(); - const actualIntegrations = actualOptions?.integrations; - expect(actualIntegrations).toEqual(expect.not.arrayContaining([expect.objectContaining({ name: 'AppStart' })])); + expectNotIntegration('StallTracking'); }); it('no default integrations', () => { diff --git a/test/tracing/integrations/stallTracking/stalltracking.background.test.ts b/test/tracing/integrations/stallTracking/stalltracking.background.test.ts new file mode 100644 index 0000000000..c8174e3c3f --- /dev/null +++ b/test/tracing/integrations/stallTracking/stalltracking.background.test.ts @@ -0,0 +1,46 @@ +import type { AppStateStatus } from 'react-native'; + +import { stallTrackingIntegration } from '../../../../src/js/tracing/integrations/stalltracking'; + +describe('BackgroundEventListener', () => { + it('Stall tracking should set _isBackground to false, update _lastIntervalMs, and call _iteration when state is active and _timeout is not null', () => { + const stallTracking = stallTrackingIntegration(); + const LOOP_TIMEOUT_INTERVAL_MS = 500; // Change this value based on your actual interval value + const currentTime = Date.now(); + stallTracking['_internalState']['lastIntervalMs'] = currentTime; + stallTracking['_internalState']['timeout'] = setTimeout(() => {}, LOOP_TIMEOUT_INTERVAL_MS); // Create a fake timeout to simulate a running interval + stallTracking['_internalState']['isBackground'] = true; + jest.useFakeTimers(); // Enable fake timers to control timeouts + stallTracking['_internalState']['backgroundEventListener']('active' as AppStateStatus); + // Check if _isBackground is set to false and _lastIntervalMs is updated correctly + expect(stallTracking['_internalState']['isBackground']).toBe(false); + expect(stallTracking['_internalState']['lastIntervalMs']).toBeGreaterThanOrEqual(currentTime); + jest.runOnlyPendingTimers(); // Fast-forward the timer to execute the timeout function + }); + it('Stall tracking should set _isBackground to true when state is not active', () => { + const stallTracking = stallTrackingIntegration(); + stallTracking['_internalState']['isBackground'] = false; + stallTracking['_internalState']['backgroundEventListener']('background' as AppStateStatus); + // Check if _isBackground is set to true + expect(stallTracking['_internalState']['isBackground']).toBe(true); + }); + it('Stall tracking should not call _iteration when state is active but _timeout is null', () => { + const stallTracking = stallTrackingIntegration(); + stallTracking['_internalState']['timeout'] = null; + // Mock _iteration + stallTracking['_internalState']['iteration'] = jest.fn(); + jest.useFakeTimers(); // Enable fake timers to control timeouts + stallTracking['_internalState']['backgroundEventListener']('active' as AppStateStatus); + + expect(stallTracking['_internalState']['iteration']).not.toBeCalled(); + }); + it('Stall tracking should call _iteration when state is active and _timeout is defined', () => { + const stallTracking = stallTrackingIntegration(); + stallTracking['_internalState']['timeout'] = setTimeout(() => {}, 500); + // Mock _iteration + stallTracking['_internalState']['iteration'] = jest.fn(); // Create a fake timeout to simulate a running interval + jest.useFakeTimers(); // Enable fake timers to control timeouts + stallTracking['_internalState']['backgroundEventListener']('active' as AppStateStatus); + expect(stallTracking['_internalState']['iteration']).toBeCalled(); + }); +}); diff --git a/test/tracing/integrations/stallTracking/stalltracking.iteration.test.ts b/test/tracing/integrations/stallTracking/stalltracking.iteration.test.ts new file mode 100644 index 0000000000..95b8506a09 --- /dev/null +++ b/test/tracing/integrations/stallTracking/stalltracking.iteration.test.ts @@ -0,0 +1,50 @@ +import { stallTrackingIntegration } from '../../../../src/js/tracing/integrations/stalltracking'; + +describe('Iteration', () => { + it('Stall tracking does not set _timeout when isTracking is false', () => { + const stallTracking = stallTrackingIntegration(); + stallTracking['isTracking'] = false; + stallTracking['_internalState']['isBackground'] = false; + stallTracking['_internalState']['lastIntervalMs'] = Date.now() - 1000; // Force a timeout + jest.useFakeTimers(); + // Invokes the private _interaction function. + stallTracking['_internalState']['iteration'](); + expect(stallTracking['_internalState']['timeout']).toBeNull(); + }); + it('Stall tracking does not set _timeout when isBackground is true', () => { + const stallTracking = stallTrackingIntegration(); + stallTracking['isTracking'] = true; + stallTracking['_internalState']['isBackground'] = true; + stallTracking['_internalState']['lastIntervalMs'] = Date.now() - 1000; // Force a timeout + jest.useFakeTimers(); + // Invokes the private _interaction function. + stallTracking['_internalState']['iteration'](); + expect(stallTracking['_internalState']['timeout']).toBeNull(); + }); + it('Stall tracking should set _timeout when isTracking is true and isBackground false', () => { + const stallTracking = stallTrackingIntegration(); + stallTracking['isTracking'] = true; + stallTracking['_internalState']['isBackground'] = false; + jest.useFakeTimers(); + stallTracking['_internalState']['lastIntervalMs'] = Date.now(); // Force a timeout + // Invokes the private _interaction function. + stallTracking['_internalState']['iteration'](); + expect(stallTracking['_internalState']['timeout']).toBeDefined(); + }); + it('Stall tracking should update _stallCount and _totalStallTime when timeout condition is met', () => { + const stallTracking = stallTrackingIntegration(); + const LOOP_TIMEOUT_INTERVAL_MS = 50; + const _minimumStallThreshold = 100; + // Call _iteration with totalTimeTaken >= LOOP_TIMEOUT_INTERVAL_MS + _minimumStallThreshold + const totalTimeTaken = LOOP_TIMEOUT_INTERVAL_MS + _minimumStallThreshold; + jest.useFakeTimers(); + stallTracking['_internalState']['lastIntervalMs'] = Date.now() - totalTimeTaken; + stallTracking['_internalState']['statsByTransaction'] = new Map(); + stallTracking['_internalState']['iteration'](); + // Check if _stallCount and _totalStallTime have been updated as expected. + expect(stallTracking['_internalState']['stallCount']).toBe(1); + expect(stallTracking['_internalState']['totalStallTime']).toBeGreaterThanOrEqual( + Math.round(totalTimeTaken - LOOP_TIMEOUT_INTERVAL_MS), + ); + }); +}); diff --git a/test/tracing/stalltracking.test.ts b/test/tracing/integrations/stallTracking/stalltracking.test.ts similarity index 96% rename from test/tracing/stalltracking.test.ts rename to test/tracing/integrations/stallTracking/stalltracking.test.ts index f0042a5af8..a59d74bb7d 100644 --- a/test/tracing/stalltracking.test.ts +++ b/test/tracing/integrations/stallTracking/stalltracking.test.ts @@ -10,8 +10,8 @@ import { import type { Span } from '@sentry/types'; import { timestampInSeconds } from '@sentry/utils'; -import { ReactNativeTracing } from '../../src/js'; -import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; +import { stallTrackingIntegration } from '../../../../src/js/tracing/integrations/stalltracking'; +import { getDefaultTestClientOptions, TestClient } from '../../../mocks/client'; import { expectNonZeroStallMeasurements, expectStallMeasurements } from './stalltrackingutils'; jest.useFakeTimers({ advanceTimers: true }); @@ -35,14 +35,10 @@ describe('StallTracking', () => { getIsolationScope().clear(); getGlobalScope().clear(); - const rnTracing = new ReactNativeTracing({ - enableStallTracking: true, - enableNativeFramesTracking: false, - }); - const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, - integrations: [rnTracing], + enableStallTracking: true, + integrations: [stallTrackingIntegration()], enableAppStartTracking: false, }); client = new TestClient(options); diff --git a/test/tracing/stalltrackingutils.ts b/test/tracing/integrations/stallTracking/stalltrackingutils.ts similarity index 100% rename from test/tracing/stalltrackingutils.ts rename to test/tracing/integrations/stallTracking/stalltrackingutils.ts diff --git a/test/tracing/reactnativetracing.test.ts b/test/tracing/reactnativetracing.test.ts index 1d840e0f31..6db3d5922a 100644 --- a/test/tracing/reactnativetracing.test.ts +++ b/test/tracing/reactnativetracing.test.ts @@ -90,9 +90,9 @@ describe('ReactNativeTracing', () => { it('uses tracePropagationTargets', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); setupTestClient({ + enableStallTracking: false, integrations: [ new ReactNativeTracing({ - enableStallTracking: false, tracePropagationTargets: ['test1', 'test2'], }), ], @@ -109,7 +109,8 @@ describe('ReactNativeTracing', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); setupTestClient({ tracePropagationTargets: ['test1', 'test2'], - integrations: [new ReactNativeTracing({ enableStallTracking: false })], + enableStallTracking: false, + integrations: [new ReactNativeTracing({})], }); expect(instrumentOutgoingRequests).toBeCalledWith( @@ -122,7 +123,8 @@ describe('ReactNativeTracing', () => { it('uses defaults', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); setupTestClient({ - integrations: [new ReactNativeTracing({ enableStallTracking: false })], + enableStallTracking: false, + integrations: [new ReactNativeTracing({})], }); expect(instrumentOutgoingRequests).toBeCalledWith( @@ -136,9 +138,9 @@ describe('ReactNativeTracing', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); setupTestClient({ tracePropagationTargets: ['test1', 'test2'], + enableStallTracking: false, integrations: [ new ReactNativeTracing({ - enableStallTracking: false, tracePropagationTargets: ['test3', 'test4'], }), ], diff --git a/test/tracing/reactnavigation.stalltracking.test.ts b/test/tracing/reactnavigation.stalltracking.test.ts index b8a041aa06..2c01838016 100644 --- a/test/tracing/reactnavigation.stalltracking.test.ts +++ b/test/tracing/reactnavigation.stalltracking.test.ts @@ -6,11 +6,12 @@ jest.mock('../../src/js/tracing/utils', () => ({ import { getCurrentScope, getGlobalScope, getIsolationScope, setCurrentClient, startSpanManual } from '@sentry/core'; import { ReactNativeTracing, ReactNavigationInstrumentation } from '../../src/js'; +import { stallTrackingIntegration } from '../../src/js/tracing/integrations/stalltracking'; import { isNearToNow } from '../../src/js/tracing/utils'; import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; +import { expectStallMeasurements } from './integrations/stallTracking/stalltrackingutils'; import { createMockNavigationAndAttachTo } from './reactnavigationutils'; -import { expectStallMeasurements } from './stalltrackingutils'; jest.useFakeTimers({ advanceTimers: 1 }); @@ -30,14 +31,14 @@ describe('StallTracking with ReactNavigation', () => { const rnTracing = new ReactNativeTracing({ routingInstrumentation: rnavigation, - enableStallTracking: true, - enableNativeFramesTracking: false, }); const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, - integrations: [rnTracing], + integrations: [stallTrackingIntegration(), rnTracing], + enableNativeFramesTracking: false, enableAppStartTracking: false, + enableStallTracking: true, }); client = new TestClient(options); setCurrentClient(client); diff --git a/test/tracing/stalltracking.background.test.ts b/test/tracing/stalltracking.background.test.ts deleted file mode 100644 index 887fd90a56..0000000000 --- a/test/tracing/stalltracking.background.test.ts +++ /dev/null @@ -1,46 +0,0 @@ -import type { AppStateStatus } from 'react-native'; - -import { StallTrackingInstrumentation } from '../../src/js/tracing/stalltracking'; - -describe('BackgroundEventListener', () => { - it('Stall tracking should set _isBackground to false, update _lastIntervalMs, and call _iteration when state is active and _timeout is not null', () => { - const stallTracking = new StallTrackingInstrumentation(); - const LOOP_TIMEOUT_INTERVAL_MS = 500; // Change this value based on your actual interval value - const currentTime = Date.now(); - stallTracking['_lastIntervalMs'] = currentTime; - stallTracking['_timeout'] = setTimeout(() => {}, LOOP_TIMEOUT_INTERVAL_MS); // Create a fake timeout to simulate a running interval - stallTracking['_isBackground'] = true; - jest.useFakeTimers(); // Enable fake timers to control timeouts - stallTracking['_backgroundEventListener']('active' as AppStateStatus); - // Check if _isBackground is set to false and _lastIntervalMs is updated correctly - expect(stallTracking['_isBackground']).toBe(false); - expect(stallTracking['_lastIntervalMs']).toBeGreaterThanOrEqual(currentTime); - jest.runOnlyPendingTimers(); // Fast-forward the timer to execute the timeout function - }); - it('Stall tracking should set _isBackground to true when state is not active', () => { - const stallTracking = new StallTrackingInstrumentation(); - stallTracking['_isBackground'] = false; - stallTracking['_backgroundEventListener']('background' as AppStateStatus); - // Check if _isBackground is set to true - expect(stallTracking['_isBackground']).toBe(true); - }); - it('Stall tracking should not call _iteration when state is active but _timeout is null', () => { - const stallTracking = new StallTrackingInstrumentation(); - stallTracking['_timeout'] = null; - // Mock _iteration - stallTracking['_iteration'] = jest.fn(); - jest.useFakeTimers(); // Enable fake timers to control timeouts - stallTracking['_backgroundEventListener']('active' as AppStateStatus); - - expect(stallTracking['_iteration']).not.toBeCalled(); - }); - it('Stall tracking should call _iteration when state is active and _timeout is defined', () => { - const stallTracking = new StallTrackingInstrumentation(); - stallTracking['_timeout'] = setTimeout(() => {}, 500); - // Mock _iteration - stallTracking['_iteration'] = jest.fn(); // Create a fake timeout to simulate a running interval - jest.useFakeTimers(); // Enable fake timers to control timeouts - stallTracking['_backgroundEventListener']('active' as AppStateStatus); - expect(stallTracking['_iteration']).toBeCalled(); - }); -}); diff --git a/test/tracing/stalltracking.iteration.test.ts b/test/tracing/stalltracking.iteration.test.ts deleted file mode 100644 index 5eeb02f240..0000000000 --- a/test/tracing/stalltracking.iteration.test.ts +++ /dev/null @@ -1,50 +0,0 @@ -import { StallTrackingInstrumentation } from '../../src/js/tracing/stalltracking'; - -describe('Iteration', () => { - it('Stall tracking does not set _timeout when isTracking is false', () => { - const stallTracking = new StallTrackingInstrumentation(); - stallTracking['isTracking'] = false; - stallTracking['_isBackground'] = false; - stallTracking['_lastIntervalMs'] = Date.now() - 1000; // Force a timeout - jest.useFakeTimers(); - // Invokes the private _interaction function. - stallTracking['_iteration'](); - expect(stallTracking['_timeout']).toBeNull(); - }); - it('Stall tracking does not set _timeout when isBackground is true', () => { - const stallTracking = new StallTrackingInstrumentation(); - stallTracking['isTracking'] = true; - stallTracking['_isBackground'] = true; - stallTracking['_lastIntervalMs'] = Date.now() - 1000; // Force a timeout - jest.useFakeTimers(); - // Invokes the private _interaction function. - stallTracking['_iteration'](); - expect(stallTracking['_timeout']).toBeNull(); - }); - it('Stall tracking should set _timeout when isTracking is true and isBackground false', () => { - const stallTracking = new StallTrackingInstrumentation(); - stallTracking['isTracking'] = true; - stallTracking['_isBackground'] = false; - jest.useFakeTimers(); - stallTracking['_lastIntervalMs'] = Date.now(); // Force a timeout - // Invokes the private _interaction function. - stallTracking['_iteration'](); - expect(stallTracking['_timeout']).toBeDefined(); - }); - it('Stall tracking should update _stallCount and _totalStallTime when timeout condition is met', () => { - const stallTracking = new StallTrackingInstrumentation(); - const LOOP_TIMEOUT_INTERVAL_MS = 50; - const _minimumStallThreshold = 100; - // Call _iteration with totalTimeTaken >= LOOP_TIMEOUT_INTERVAL_MS + _minimumStallThreshold - const totalTimeTaken = LOOP_TIMEOUT_INTERVAL_MS + _minimumStallThreshold; - jest.useFakeTimers(); - stallTracking['_lastIntervalMs'] = Date.now() - totalTimeTaken; - stallTracking['_statsByTransaction'] = new Map(); - stallTracking['_iteration'](); - // Check if _stallCount and _totalStallTime have been updated as expected. - expect(stallTracking['_stallCount']).toBe(1); - expect(stallTracking['_totalStallTime']).toBeGreaterThanOrEqual( - Math.round(totalTimeTaken - LOOP_TIMEOUT_INTERVAL_MS), - ); - }); -}); From df80375452a84ab1327bc4187015846cec49d6f5 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Tue, 13 Aug 2024 10:26:20 +0200 Subject: [PATCH 10/48] ref(tracing): Extract UserInteractionTracing as standalone interaction (#3999) --- CHANGELOG.md | 2 + src/js/client.ts | 4 - src/js/integrations/default.ts | 4 + src/js/integrations/exports.ts | 1 + src/js/options.ts | 7 + src/js/sdk.tsx | 1 + src/js/touchevents.tsx | 3 +- src/js/tracing/gesturetracing.ts | 8 +- .../tracing/integrations/userInteraction.ts | 93 ++++++ src/js/tracing/origin.ts | 1 + src/js/tracing/reactnativetracing.ts | 219 ++----------- src/js/tracing/span.ts | 111 +++++++ test/client.test.ts | 66 ---- test/sdk.test.ts | 33 ++ test/tracing/gesturetracing.test.ts | 8 +- .../integrations/userInteraction.test.ts | 296 ++++++++++++++++++ test/tracing/reactnativetracing.test.ts | 281 +---------------- 17 files changed, 586 insertions(+), 552 deletions(-) create mode 100644 src/js/tracing/integrations/userInteraction.ts create mode 100644 src/js/tracing/origin.ts create mode 100644 src/js/tracing/span.ts create mode 100644 test/tracing/integrations/userInteraction.test.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index fbcfb0004d..57f5fc7e1e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ - New Native Frames Integration ([#3996](https://github.com/getsentry/sentry-react-native/pull/3996)) - New Stall Tracking Integration ([#3997](https://github.com/getsentry/sentry-react-native/pull/3997)) +- New User Interaction Tracing Integration ([#3999](https://github.com/getsentry/sentry-react-native/pull/3999)) - New App Start Integration ([#3852](https://github.com/getsentry/sentry-react-native/pull/3852)) By default app start spans are attached to the first created transaction. @@ -19,6 +20,7 @@ enableAppStartTracking: true, // default true enableNativeFramesTracking: true, // default true enableStallTracking: true, // default true + enableUserInteractionTracing: true, // default false integrations: [ Sentry.appStartIntegration({ standalone: false, // default false diff --git a/src/js/client.ts b/src/js/client.ts index a917780c68..8d2d66a09b 100644 --- a/src/js/client.ts +++ b/src/js/client.ts @@ -146,10 +146,6 @@ export class ReactNativeClient extends BaseClient { if (routingName) { this.addIntegration(createIntegration(routingName)); } - const enableUserInteractionTracing = tracing?.options.enableUserInteractionTracing; - if (enableUserInteractionTracing) { - this.addIntegration(createIntegration('ReactNativeUserInteractionTracing')); - } } /** diff --git a/src/js/integrations/default.ts b/src/js/integrations/default.ts index 73ec8f9dec..7e1164c4a2 100644 --- a/src/js/integrations/default.ts +++ b/src/js/integrations/default.ts @@ -33,6 +33,7 @@ import { sdkInfoIntegration, spotlightIntegration, stallTrackingIntegration, + userInteractionIntegration, viewHierarchyIntegration, } from './exports'; import { createReactNativeRewriteFrames } from './rewriteframes'; @@ -109,6 +110,9 @@ export function getDefaultIntegrations(options: ReactNativeClientOptions): Integ if (hasTracingEnabled && options.enableStallTracking) { integrations.push(stallTrackingIntegration()); } + if (hasTracingEnabled && options.enableUserInteractionTracing) { + integrations.push(userInteractionIntegration()); + } if (hasTracingEnabled && options.enableAutoPerformanceTracing) { integrations.push(new ReactNativeTracing()); } diff --git a/src/js/integrations/exports.ts b/src/js/integrations/exports.ts index 0fc7d5a908..345be885a7 100644 --- a/src/js/integrations/exports.ts +++ b/src/js/integrations/exports.ts @@ -16,6 +16,7 @@ export { mobileReplayIntegration } from '../replay/mobilereplay'; export { appStartIntegration } from '../tracing/integrations/appStart'; export { nativeFramesIntegration } from '../tracing/integrations/nativeFrames'; export { stallTrackingIntegration } from '../tracing/integrations/stalltracking'; +export { userInteractionIntegration } from '../tracing/integrations/userInteraction'; export { breadcrumbsIntegration, diff --git a/src/js/options.ts b/src/js/options.ts index f9012beec0..5cb3906877 100644 --- a/src/js/options.ts +++ b/src/js/options.ts @@ -213,6 +213,13 @@ export interface BaseReactNativeOptions { */ enableStallTracking?: boolean; + /** + * Trace User Interaction events like touch and gestures. + * + * @default false + */ + enableUserInteractionTracing?: boolean; + /** * Options which are in beta, or otherwise not guaranteed to be stable. */ diff --git a/src/js/sdk.tsx b/src/js/sdk.tsx index d8619bdfca..1e0a60f29c 100644 --- a/src/js/sdk.tsx +++ b/src/js/sdk.tsx @@ -36,6 +36,7 @@ const DEFAULT_OPTIONS: ReactNativeOptions = { enableAppStartTracking: true, enableNativeFramesTracking: true, enableStallTracking: true, + enableUserInteractionTracing: false, }; /** diff --git a/src/js/touchevents.tsx b/src/js/touchevents.tsx index c9bf18a000..45908a9054 100644 --- a/src/js/touchevents.tsx +++ b/src/js/touchevents.tsx @@ -7,6 +7,7 @@ import { StyleSheet, View } from 'react-native'; import { createIntegration } from './integrations/factory'; import type { ReactNativeTracing } from './tracing'; +import { startUserInteractionSpan } from './tracing/integrations/userInteraction'; import { UI_ACTION_TOUCH } from './tracing/ops'; export type TouchEventBoundaryProps = { @@ -200,7 +201,7 @@ class TouchEventBoundary extends React.Component { this._logTouchEvent(touchPath, label); } - this._tracingIntegration?.startUserInteractionSpan({ + startUserInteractionSpan({ elementId: label, op: UI_ACTION_TOUCH, }); diff --git a/src/js/tracing/gesturetracing.ts b/src/js/tracing/gesturetracing.ts index f7965dab1f..ffa2e38df6 100644 --- a/src/js/tracing/gesturetracing.ts +++ b/src/js/tracing/gesturetracing.ts @@ -1,9 +1,9 @@ -import { addBreadcrumb, getClient } from '@sentry/core'; +import { addBreadcrumb } from '@sentry/core'; import type { Breadcrumb } from '@sentry/types'; import { logger } from '@sentry/utils'; +import { startUserInteractionSpan } from './integrations/userInteraction'; import { UI_ACTION } from './ops'; -import type { ReactNativeTracing } from './reactnativetracing'; export const DEFAULT_BREADCRUMB_CATEGORY = 'gesture'; export const DEFAULT_BREADCRUMB_TYPE = 'user'; @@ -69,9 +69,7 @@ export function sentryTraceGesture( const originalOnBegin = gestureCandidate.handlers.onBegin; (gesture as unknown as Required).handlers.onBegin = (event: GestureEvent) => { - getClient() - ?.getIntegrationByName('ReactNativeTracing') - ?.startUserInteractionSpan({ elementId: label, op: `${UI_ACTION}.${name}` }); + startUserInteractionSpan({ elementId: label, op: `${UI_ACTION}.${name}` }); addGestureBreadcrumb(`Gesture ${label} begin.`, { event, name }); diff --git a/src/js/tracing/integrations/userInteraction.ts b/src/js/tracing/integrations/userInteraction.ts new file mode 100644 index 0000000000..507e99b90c --- /dev/null +++ b/src/js/tracing/integrations/userInteraction.ts @@ -0,0 +1,93 @@ +import { getActiveSpan, getClient, getCurrentScope, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core'; +import type { Integration, Span, StartSpanOptions } from '@sentry/types'; +import { logger } from '@sentry/utils'; + +import type { ReactNativeClientOptions } from '../../options'; +import { onlySampleIfChildSpans } from '../onSpanEndUtils'; +import { SPAN_ORIGIN_AUTO_INTERACTION } from '../origin'; +import { getCurrentReactNativeTracingIntegration } from '../reactnativetracing'; +import { clearActiveSpanFromScope, isSentryInteractionSpan, startIdleSpan } from '../span'; + +const INTEGRATION_NAME = 'UserInteraction'; + +export const userInteractionIntegration = (): Integration => { + return { + name: INTEGRATION_NAME, + }; +}; + +/** + * Starts a new transaction for a user interaction. + * @param userInteractionId Consists of `op` representation UI Event and `elementId` unique element identifier on current screen. + */ +export const startUserInteractionSpan = (userInteractionId: { + elementId: string | undefined; + op: string; +}): Span | undefined => { + const client = getClient(); + if (!client) { + return undefined; + } + + const tracing = getCurrentReactNativeTracingIntegration(); + if (!tracing) { + logger.log(`[${INTEGRATION_NAME}] Tracing integration is not available. Can not start user interaction span.`); + return undefined; + } + + const options = client.getOptions() as ReactNativeClientOptions; + const { elementId, op } = userInteractionId; + if (!options.enableUserInteractionTracing) { + logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing is disabled.`); + return undefined; + } + if (!elementId) { + logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing can not create transaction with undefined elementId.`); + return undefined; + } + if (!tracing.currentRoute) { + logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing can not create transaction without a current route.`); + return undefined; + } + + const activeTransaction = getActiveSpan(); + const activeTransactionIsNotInteraction = activeTransaction && !isSentryInteractionSpan(activeTransaction); + if (activeTransaction && activeTransactionIsNotInteraction) { + logger.warn( + `[${INTEGRATION_NAME}] Did not create ${op} transaction because active transaction ${ + spanToJSON(activeTransaction).description + } exists on the scope.`, + ); + return undefined; + } + + const name = `${tracing.currentRoute}.${elementId}`; + if ( + activeTransaction && + spanToJSON(activeTransaction).description === name && + spanToJSON(activeTransaction).op === op + ) { + logger.warn( + `[${INTEGRATION_NAME}] Did not create ${op} transaction because it the same transaction ${ + spanToJSON(activeTransaction).description + } already exists on the scope.`, + ); + return undefined; + } + + const scope = getCurrentScope(); + const context: StartSpanOptions = { + name, + op, + scope, + }; + clearActiveSpanFromScope(scope); + const newSpan = startIdleSpan(context, { + idleTimeout: tracing.options.idleTimeoutMs, + finalTimeout: tracing.options.finalTimeoutMs, + }); + newSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SPAN_ORIGIN_AUTO_INTERACTION); + onlySampleIfChildSpans(client, newSpan); + logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing Created ${op} transaction ${name}.`); + return newSpan; +}; diff --git a/src/js/tracing/origin.ts b/src/js/tracing/origin.ts new file mode 100644 index 0000000000..830e7f158f --- /dev/null +++ b/src/js/tracing/origin.ts @@ -0,0 +1 @@ +export const SPAN_ORIGIN_AUTO_INTERACTION = 'auto.interaction'; diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index 3d575b150c..b6fec52952 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -1,39 +1,14 @@ /* eslint-disable max-lines */ import type { RequestInstrumentationOptions } from '@sentry/browser'; import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from '@sentry/browser'; -import { - getActiveSpan, - getCurrentScope, - SEMANTIC_ATTRIBUTE_SENTRY_OP, - SentryNonRecordingSpan, - SPAN_STATUS_ERROR, - spanToJSON, - startIdleSpan, -} from '@sentry/core'; -import type { Client, Event, Integration, PropagationContext, Scope, Span, StartSpanOptions } from '@sentry/types'; -import { logger, uuid4 } from '@sentry/utils'; +import { getClient, SEMANTIC_ATTRIBUTE_SENTRY_OP, spanToJSON } from '@sentry/core'; +import type { Client, Event, Integration, Span } from '@sentry/types'; +import { logger } from '@sentry/utils'; import type { RoutingInstrumentationInstance } from '../tracing/routingInstrumentation'; -import { - adjustTransactionDuration, - cancelInBackground, - ignoreEmptyBackNavigation, - onlySampleIfChildSpans, - onThisSpanEnd, -} from './onSpanEndUtils'; +import { startIdleNavigationSpan } from './span'; import type { BeforeNavigate } from './types'; -const SCOPE_SPAN_FIELD = '_sentrySpan'; - -type ScopeWithMaybeSpan = Scope & { - [SCOPE_SPAN_FIELD]?: Span; -}; - -function clearActiveSpanFromScope(scope: ScopeWithMaybeSpan): void { - // eslint-disable-next-line @typescript-eslint/no-dynamic-delete - delete scope[SCOPE_SPAN_FIELD]; -} - export interface ReactNativeTracingOptions extends RequestInstrumentationOptions { /** * @deprecated Replaced by idleTimeoutMs @@ -87,11 +62,6 @@ export interface ReactNativeTracingOptions extends RequestInstrumentationOptions * @returns A (potentially) modified context object, with `sampled = false` if the transaction should be dropped. */ beforeNavigate: BeforeNavigate; - - /** - * Trace User Interaction events like touch and gestures. - */ - enableUserInteractionTracing: boolean; } const DEFAULT_TRACE_PROPAGATION_TARGETS = ['localhost', /^\/(?!\/)/]; @@ -104,7 +74,6 @@ const defaultReactNativeTracingOptions: ReactNativeTracingOptions = { finalTimeoutMs: 600000, ignoreEmptyBackNavigationTransactions: true, beforeNavigate: context => context, - enableUserInteractionTracing: false, }; /** @@ -126,9 +95,8 @@ export class ReactNativeTracing implements Integration { public useAppStartWithProfiler: boolean = false; - private _inflightInteractionTransaction?: Span; + public currentRoute?: string; - private _currentRoute?: string; private _hasSetTracePropagationTargets: boolean; private _currentViewName: string | undefined; private _client: Client | undefined; @@ -163,7 +131,6 @@ export class ReactNativeTracing implements Integration { * Registers routing and request instrumentation. */ public setup(client: Client): void { - this._client = client; const clientOptions = client && client.getOptions(); // eslint-disable-next-line @typescript-eslint/unbound-method @@ -211,86 +178,6 @@ export class ReactNativeTracing implements Integration { return eventWithView; } - /** - * Starts a new transaction for a user interaction. - * @param userInteractionId Consists of `op` representation UI Event and `elementId` unique element identifier on current screen. - */ - public startUserInteractionSpan(userInteractionId: { elementId: string | undefined; op: string }): Span | undefined { - const client = this._client; - if (!client) { - return undefined; - } - - const { elementId, op } = userInteractionId; - if (!this.options.enableUserInteractionTracing) { - logger.log('[ReactNativeTracing] User Interaction Tracing is disabled.'); - return undefined; - } - if (!this.options.routingInstrumentation) { - logger.error( - '[ReactNativeTracing] User Interaction Tracing is not working because no routing instrumentation is set.', - ); - return undefined; - } - if (!elementId) { - logger.log('[ReactNativeTracing] User Interaction Tracing can not create transaction with undefined elementId.'); - return undefined; - } - if (!this._currentRoute) { - logger.log('[ReactNativeTracing] User Interaction Tracing can not create transaction without a current route.'); - return undefined; - } - - const activeTransaction = getActiveSpan(); - const activeTransactionIsNotInteraction = - !activeTransaction || - !this._inflightInteractionTransaction || - spanToJSON(activeTransaction).span_id !== spanToJSON(this._inflightInteractionTransaction).span_id; - if (activeTransaction && activeTransactionIsNotInteraction) { - logger.warn( - `[ReactNativeTracing] Did not create ${op} transaction because active transaction ${ - spanToJSON(activeTransaction).description - } exists on the scope.`, - ); - return undefined; - } - - const name = `${this._currentRoute}.${elementId}`; - if ( - this._inflightInteractionTransaction && - spanToJSON(this._inflightInteractionTransaction).description === name && - spanToJSON(this._inflightInteractionTransaction).op === op - ) { - logger.warn( - `[ReactNativeTracing] Did not create ${op} transaction because it the same transaction ${ - spanToJSON(this._inflightInteractionTransaction).description - } already exists on the scope.`, - ); - return undefined; - } - - if (this._inflightInteractionTransaction) { - // TODO: Check the interaction transactions spec, see if can be implemented differently - // this._inflightInteractionTransaction.cancelIdleTimeout(undefined, { restartOnChildSpanChange: false }); - this._inflightInteractionTransaction = undefined; - } - - const scope = getCurrentScope(); - const context: StartSpanOptions = { - name, - op, - scope, - }; - clearActiveSpanFromScope(scope); - this._inflightInteractionTransaction = this._startIdleSpan(context); - onThisSpanEnd(client, this._inflightInteractionTransaction, () => { - this._inflightInteractionTransaction = undefined; - }); - onlySampleIfChildSpans(client, this._inflightInteractionTransaction); - logger.log(`[ReactNativeTracing] User Interaction Tracing Created ${op} transaction ${name}.`); - return this._inflightInteractionTransaction; - } - /** * Sets the current view name into the app context. * @param event Le event. @@ -304,7 +191,16 @@ export class ReactNativeTracing implements Integration { /** To be called when the route changes, but BEFORE the components of the new route mount. */ private _onRouteWillChange(): Span | undefined { - return this._createRouteTransaction(); + return startIdleNavigationSpan( + { + name: 'Route Change', + }, + { + finalTimeout: this.options.finalTimeoutMs, + idleTimeout: this.options.idleTimeoutMs, + ignoreEmptyBackNavigationTransactions: this.options.ignoreEmptyBackNavigationTransactions, + }, + ); } /** @@ -312,84 +208,19 @@ export class ReactNativeTracing implements Integration { */ private _onConfirmRoute(currentViewName: string | undefined): void { this._currentViewName = currentViewName; - this._currentRoute = currentViewName; - } - - /** Create routing idle transaction. */ - private _createRouteTransaction({ - name, - op, - }: { - name?: string; - op?: string; - } = {}): Span | undefined { - if (!this._client) { - logger.warn(`[ReactNativeTracing] Can't create route change span, missing client.`); - return undefined; - } - - if (this._inflightInteractionTransaction) { - logger.log( - `[ReactNativeTracing] Canceling ${ - spanToJSON(this._inflightInteractionTransaction).op - } transaction because of a new navigation root span.`, - ); - this._inflightInteractionTransaction.setStatus({ code: SPAN_STATUS_ERROR, message: 'cancelled' }); - this._inflightInteractionTransaction.end(); - } - - const { finalTimeoutMs } = this.options; - - const expandedContext: StartSpanOptions = { - name: name || 'Route Change', - op, - forceTransaction: true, - scope: getCurrentScope(), - }; - - const idleSpan = this._startIdleSpan(expandedContext); - if (!idleSpan) { - return undefined; - } - - logger.log(`[ReactNativeTracing] Starting ${op || 'unknown op'} transaction "${name}" on scope`); - - adjustTransactionDuration(this._client, idleSpan, finalTimeoutMs); - - if (this.options.ignoreEmptyBackNavigationTransactions) { - ignoreEmptyBackNavigation(this._client, idleSpan); - } - - return idleSpan; - } - - /** - * Start app state aware idle transaction on the scope. - */ - private _startIdleSpan(startSpanOption: StartSpanOptions, beforeSpanEnd?: (span: Span) => void): Span { - if (!this._client) { - logger.warn(`[ReactNativeTracing] Can't create idle span, missing client.`); - return new SentryNonRecordingSpan(); - } - - getCurrentScope().setPropagationContext(generatePropagationContext()); - - const { idleTimeoutMs, finalTimeoutMs } = this.options; - const span = startIdleSpan(startSpanOption, { - finalTimeout: finalTimeoutMs, - idleTimeout: idleTimeoutMs, - beforeSpanEnd, - }); - cancelInBackground(this._client, span); - return span; + this.currentRoute = currentViewName; } } -function generatePropagationContext(): PropagationContext { - return { - traceId: uuid4(), - spanId: uuid4().substring(16), - }; +/** + * Returns the current React Native Tracing integration. + */ +export function getCurrentReactNativeTracingIntegration(): ReactNativeTracing | undefined { + const client = getClient(); + if (!client) { + return undefined; + } + return client.getIntegrationByName(ReactNativeTracing.id) as ReactNativeTracing | undefined; } function addDefaultOpForSpanFrom(client: Client): void { diff --git a/src/js/tracing/span.ts b/src/js/tracing/span.ts new file mode 100644 index 0000000000..c6d7b8bc83 --- /dev/null +++ b/src/js/tracing/span.ts @@ -0,0 +1,111 @@ +import { + getActiveSpan, + getClient, + getCurrentScope, + SentryNonRecordingSpan, + SPAN_STATUS_ERROR, + spanToJSON, + startIdleSpan as coreStartIdleSpan, +} from '@sentry/core'; +import type { Scope, Span, StartSpanOptions } from '@sentry/types'; +import { generatePropagationContext, logger } from '@sentry/utils'; + +import { isRootSpan } from '../utils/span'; +import { adjustTransactionDuration, cancelInBackground, ignoreEmptyBackNavigation } from './onSpanEndUtils'; +import { SPAN_ORIGIN_AUTO_INTERACTION } from './origin'; + +export const startIdleNavigationSpan = ( + { + name, + op, + }: { + name?: string; + op?: string; + } = {}, + { + finalTimeout, + idleTimeout, + ignoreEmptyBackNavigationTransactions, + }: { + finalTimeout: number; + idleTimeout: number; + ignoreEmptyBackNavigationTransactions: boolean; + }, +): Span | undefined => { + const client = getClient(); + if (!client) { + logger.warn(`[ReactNativeTracing] Can't create route change span, missing client.`); + return undefined; + } + + const activeSpan = getActiveSpan(); + if (activeSpan && isRootSpan(activeSpan) && isSentryInteractionSpan(activeSpan)) { + logger.log( + `[ReactNativeTracing] Canceling ${spanToJSON(activeSpan).op} transaction because of a new navigation root span.`, + ); + activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'cancelled' }); + activeSpan.end(); + } + + const expandedContext: StartSpanOptions = { + name, + op, + forceTransaction: true, + scope: getCurrentScope(), + }; + + const idleSpan = startIdleSpan(expandedContext, { finalTimeout, idleTimeout }); + logger.log(`[ReactNativeTracing] Starting ${op || 'unknown op'} transaction "${name}" on scope`); + + adjustTransactionDuration(client, idleSpan, finalTimeout); + if (ignoreEmptyBackNavigationTransactions) { + ignoreEmptyBackNavigation(client, idleSpan); + } + + return idleSpan; +}; + +/** + * Starts an idle span from `@sentry/core` with React Native application + * context awareness. + * + * - Span will be started with new propagation context. + * - Span will be canceled if the app goes to background. + */ +export const startIdleSpan = ( + startSpanOption: StartSpanOptions, + { finalTimeout, idleTimeout }: { finalTimeout: number | undefined; idleTimeout: number | undefined }, +): Span => { + const client = getClient(); + if (!client) { + logger.warn(`[ReactNativeTracing] Can't create idle span, missing client.`); + return new SentryNonRecordingSpan(); + } + + getCurrentScope().setPropagationContext(generatePropagationContext()); + + const span = coreStartIdleSpan(startSpanOption, { finalTimeout, idleTimeout }); + cancelInBackground(client, span); + return span; +}; + +/** + * Checks if the span is a Sentry User Interaction span. + */ +export function isSentryInteractionSpan(span: Span): boolean { + return spanToJSON(span).origin === SPAN_ORIGIN_AUTO_INTERACTION; +} + +const SCOPE_SPAN_FIELD = '_sentrySpan'; + +type ScopeWithMaybeSpan = Scope & { + [SCOPE_SPAN_FIELD]?: Span; +}; + +/** + * Removes the active span from the scope. + */ +export function clearActiveSpanFromScope(scope: ScopeWithMaybeSpan): void { + // eslint-disable-next-line @typescript-eslint/no-dynamic-delete + delete scope[SCOPE_SPAN_FIELD]; +} diff --git a/test/client.test.ts b/test/client.test.ts index 3745bee0a3..fe0ea65a50 100644 --- a/test/client.test.ts +++ b/test/client.test.ts @@ -632,72 +632,6 @@ describe('Tests ReactNativeClient', () => { expect(client.getIntegrationByName('MockRoutingInstrumentation')).toBeTruthy(); }); }); - - describe('user interactions tracing as integrations', () => { - test('register user interactions tracing', () => { - const client = new ReactNativeClient( - mockedOptions({ - dsn: EXAMPLE_DSN, - integrations: [ - new ReactNativeTracing({ - enableUserInteractionTracing: true, - }), - ], - }), - ); - client.init(); - - expect(client.getIntegrationByName('ReactNativeUserInteractionTracing')).toBeTruthy(); - }); - - test('register user interactions tracing - init()', () => { - const client = new ReactNativeClient( - mockedOptions({ - dsn: EXAMPLE_DSN, - integrations: [ - new ReactNativeTracing({ - enableUserInteractionTracing: true, - }), - ], - }), - ); - client.init(); - - expect(client.getIntegrationByName('ReactNativeUserInteractionTracing')).toBeTruthy(); - }); - - test('do not register user interactions tracing', () => { - const client = new ReactNativeClient( - mockedOptions({ - dsn: EXAMPLE_DSN, - integrations: [ - new ReactNativeTracing({ - enableUserInteractionTracing: false, - }), - ], - }), - ); - client.init(); - - expect(client.getIntegrationByName('ReactNativeUserInteractionTracing')).toBeUndefined(); - }); - - test('do not register user interactions tracing - init()', () => { - const client = new ReactNativeClient( - mockedOptions({ - dsn: EXAMPLE_DSN, - integrations: [ - new ReactNativeTracing({ - enableUserInteractionTracing: false, - }), - ], - }), - ); - client.init(); - - expect(client.getIntegrationByName('ReactNativeUserInteractionTracing')).toBeUndefined(); - }); - }); }); function mockedOptions(options: Partial): ReactNativeClientOptions { diff --git a/test/sdk.test.ts b/test/sdk.test.ts index 5838e0be30..522aa586ab 100644 --- a/test/sdk.test.ts +++ b/test/sdk.test.ts @@ -479,6 +479,39 @@ describe('Tests the SDK functionality', () => { expectNotIntegration('StallTracking'); }); + describe('user interaction integration', () => { + test('no integration when tracing disabled', () => { + init({}); + + expectNotIntegration('UserInteraction'); + }); + test('no integration when tracing enabled', () => { + init({ + tracesSampleRate: 0.5, + }); + + expectNotIntegration('UserInteraction'); + }); + + test('no integration when tracing enabled but user interaction explicitly disabled', () => { + init({ + tracesSampleRate: 0.5, + enableUserInteractionTracing: false, + }); + + expectNotIntegration('UserInteraction'); + }); + + test('integration added when tracing enabled and user interaction enabled', () => { + init({ + tracesSampleRate: 0.5, + enableUserInteractionTracing: true, + }); + + expectIntegration('UserInteraction'); + }); + }); + it('no default integrations', () => { init({ defaultIntegrations: false, diff --git a/test/tracing/gesturetracing.test.ts b/test/tracing/gesturetracing.test.ts index e7d00a7de7..a0171613cf 100644 --- a/test/tracing/gesturetracing.test.ts +++ b/test/tracing/gesturetracing.test.ts @@ -7,6 +7,7 @@ import { DEFAULT_BREADCRUMB_TYPE as DEFAULT_GESTURE_BREADCRUMB_TYPE, sentryTraceGesture, } from '../../src/js/tracing/gesturetracing'; +import { startUserInteractionSpan } from '../../src/js/tracing/integrations/userInteraction'; import { ReactNativeTracing } from '../../src/js/tracing/reactnativetracing'; import { type TestClient, setupTestClient } from '../mocks/client'; import type { MockedRoutingInstrumentation } from './mockedrountinginstrumention'; @@ -55,11 +56,12 @@ describe('GestureTracing', () => { beforeEach(() => { jest.clearAllMocks(); jest.useFakeTimers(); - client = setupTestClient(); + client = setupTestClient({ + enableUserInteractionTracing: true, + }); mockedRoutingInstrumentation = createMockedRoutingInstrumentation(); tracing = new ReactNativeTracing({ routingInstrumentation: mockedRoutingInstrumentation, - enableUserInteractionTracing: true, }); client.addIntegration(tracing); mockedRoutingInstrumentation.registeredOnConfirmRoute!('mockedScreenName'); @@ -114,7 +116,7 @@ describe('GestureTracing', () => { sentryTraceGesture('mockedGesture', mockedGesture); const mockedTouchInteractionId = { elementId: 'mockedElementId', op: 'mocked.op' }; - tracing.startUserInteractionSpan(mockedTouchInteractionId); + startUserInteractionSpan(mockedTouchInteractionId); startChildSpan(); await jest.advanceTimersByTimeAsync(timeoutCloseToActualIdleTimeoutMs); diff --git a/test/tracing/integrations/userInteraction.test.ts b/test/tracing/integrations/userInteraction.test.ts new file mode 100644 index 0000000000..dfd1b44a4d --- /dev/null +++ b/test/tracing/integrations/userInteraction.test.ts @@ -0,0 +1,296 @@ +import { + getActiveSpan, + getCurrentScope, + SPAN_STATUS_ERROR, + spanToJSON, + startInactiveSpan, + startSpanManual, +} from '@sentry/core'; +import type { Span } from '@sentry/types'; +import type { AppState, AppStateStatus } from 'react-native'; + +import { + startUserInteractionSpan, + userInteractionIntegration, +} from '../../../src/js/tracing/integrations/userInteraction'; +import { ReactNativeTracing } from '../../../src/js/tracing/reactnativetracing'; +import { NATIVE } from '../../../src/js/wrapper'; +import type { TestClient } from '../../mocks/client'; +import { setupTestClient } from '../../mocks/client'; +import type { MockedRoutingInstrumentation } from '../mockedrountinginstrumention'; +import { createMockedRoutingInstrumentation } from '../mockedrountinginstrumention'; + +type MockAppState = { + setState: (state: AppStateStatus) => void; + listener: (newState: AppStateStatus) => void; + removeSubscription: jest.Func; +}; +const mockedAppState: AppState & MockAppState = { + removeSubscription: jest.fn(), + listener: jest.fn(), + isAvailable: true, + currentState: 'active', + addEventListener: (_, listener) => { + mockedAppState.listener = listener; + return { + remove: mockedAppState.removeSubscription, + }; + }, + setState: (state: AppStateStatus) => { + mockedAppState.currentState = state; + mockedAppState.listener(state); + }, +}; +jest.mock('react-native/Libraries/AppState/AppState', () => mockedAppState); + +jest.mock('../../../src/js/wrapper', () => { + return { + NATIVE: { + fetchNativeAppStart: jest.fn(), + fetchNativeFrames: jest.fn(() => Promise.resolve()), + disableNativeFramesTracking: jest.fn(() => Promise.resolve()), + enableNativeFramesTracking: jest.fn(() => Promise.resolve()), + enableNative: true, + }, + }; +}); + +describe('User Interaction Tracing', () => { + let client: TestClient; + let tracing: ReactNativeTracing; + let mockedUserInteractionId: { elementId: string | undefined; op: string }; + let mockedRoutingInstrumentation: MockedRoutingInstrumentation; + + beforeEach(() => { + jest.useFakeTimers(); + NATIVE.enableNative = true; + mockedAppState.isAvailable = true; + mockedAppState.addEventListener = (_, listener) => { + mockedAppState.listener = listener; + return { + remove: mockedAppState.removeSubscription, + }; + }; + + mockedUserInteractionId = { elementId: 'mockedElementId', op: 'mocked.op' }; + client = setupTestClient({ + enableUserInteractionTracing: true, + }); + mockedRoutingInstrumentation = createMockedRoutingInstrumentation(); + }); + + afterEach(() => { + jest.runOnlyPendingTimers(); + jest.useRealTimers(); + jest.clearAllMocks(); + }); + + describe('disabled user interaction', () => { + test('User interaction tracing is disabled by default', () => { + client = setupTestClient({}); + mockedRoutingInstrumentation = createMockedRoutingInstrumentation(); + startUserInteractionSpan(mockedUserInteractionId); + + expect(client.getOptions().enableUserInteractionTracing).toBeFalsy(); + expect(getActiveSpan()).toBeUndefined(); + }); + }); + + describe('enabled user interaction', () => { + beforeEach(() => { + tracing = new ReactNativeTracing({ + routingInstrumentation: mockedRoutingInstrumentation, + }); + client.addIntegration(userInteractionIntegration()); + client.addIntegration(tracing); + mockedRoutingInstrumentation.registeredOnConfirmRoute!('mockedRouteName'); + }); + + test('user interaction tracing is enabled and transaction is bound to scope', () => { + startUserInteractionSpan(mockedUserInteractionId); + + const actualTransaction = getActiveSpan(); + const actualTransactionContext = spanToJSON(actualTransaction!); + expect(client.getOptions().enableUserInteractionTracing).toBeTruthy(); + expect(actualTransactionContext).toEqual( + expect.objectContaining({ + description: 'mockedRouteName.mockedElementId', + op: 'mocked.op', + }), + ); + }); + + test('UI event transaction not sampled if no child spans', () => { + startUserInteractionSpan(mockedUserInteractionId); + const actualTransaction = getActiveSpan(); + + jest.runAllTimers(); + + expect(actualTransaction).toBeDefined(); + expect(client.event).toBeUndefined(); + }); + + test('does cancel UI event transaction when app goes to background', () => { + startUserInteractionSpan(mockedUserInteractionId); + const actualTransaction = getActiveSpan(); + + mockedAppState.setState('background'); + jest.runAllTimers(); + + const actualTransactionContext = spanToJSON(actualTransaction!); + expect(actualTransactionContext).toEqual( + expect.objectContaining({ + timestamp: expect.any(Number), + status: 'cancelled', + }), + ); + expect(mockedAppState.removeSubscription).toBeCalledTimes(1); + }); + + test('do not overwrite existing status of UI event transactions', () => { + startUserInteractionSpan(mockedUserInteractionId); + const actualTransaction = getActiveSpan(); + + actualTransaction?.setStatus({ code: SPAN_STATUS_ERROR, message: 'mocked_status' }); + + jest.runAllTimers(); + + const actualTransactionContext = spanToJSON(actualTransaction!); + expect(actualTransactionContext).toEqual( + expect.objectContaining({ + timestamp: expect.any(Number), + status: 'mocked_status', + }), + ); + }); + + test('same UI event and same element does not reschedule idle timeout', () => { + const timeoutCloseToActualIdleTimeoutMs = 800; + startUserInteractionSpan(mockedUserInteractionId); + const actualTransaction = getActiveSpan(); + jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); + + startUserInteractionSpan(mockedUserInteractionId); + jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); + + expect(spanToJSON(actualTransaction!).timestamp).toEqual(expect.any(Number)); + }); + + test('different UI event and same element finish first and start new transaction', () => { + const timeoutCloseToActualIdleTimeoutMs = 800; + startUserInteractionSpan(mockedUserInteractionId); + const firstTransaction = getActiveSpan(); + jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); + const childFirstTransaction = startInactiveSpan({ name: 'Child Span of the first Tx', op: 'child.op' }); + + startUserInteractionSpan({ ...mockedUserInteractionId, op: 'different.op' }); + const secondTransaction = getActiveSpan(); + jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); + childFirstTransaction?.end(); + jest.runAllTimers(); + + const firstTransactionEvent = client.eventQueue[0]; + expect(firstTransaction).toBeDefined(); + expect(firstTransactionEvent).toEqual( + expect.objectContaining({ + timestamp: expect.any(Number), + contexts: expect.objectContaining({ + trace: expect.objectContaining({ + op: 'mocked.op', + }), + }), + }), + ); + + expect(secondTransaction).toBeDefined(); + expect(spanToJSON(secondTransaction!)).toEqual( + expect.objectContaining({ + timestamp: expect.any(Number), + op: 'different.op', + }), + ); + expect(firstTransactionEvent!.timestamp).toBeGreaterThanOrEqual(spanToJSON(secondTransaction!).start_timestamp!); + }); + + test('different UI event and same element finish first transaction with last span', () => { + const timeoutCloseToActualIdleTimeoutMs = 800; + startUserInteractionSpan(mockedUserInteractionId); + const firstTransaction = getActiveSpan(); + jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); + const childFirstTransaction = startInactiveSpan({ name: 'Child Span of the first Tx', op: 'child.op' }); + + startUserInteractionSpan({ ...mockedUserInteractionId, op: 'different.op' }); + jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); + childFirstTransaction?.end(); + jest.runAllTimers(); + + const firstTransactionEvent = client.eventQueue[0]; + expect(firstTransaction).toBeDefined(); + expect(firstTransactionEvent).toEqual( + expect.objectContaining({ + timestamp: expect.any(Number), + contexts: expect.objectContaining({ + trace: expect.objectContaining({ + op: 'mocked.op', + }), + }), + }), + ); + }); + + test('same ui event after UI event transaction finished', () => { + startUserInteractionSpan(mockedUserInteractionId); + const firstTransaction = getActiveSpan(); + jest.runAllTimers(); + + startUserInteractionSpan(mockedUserInteractionId); + const secondTransaction = getActiveSpan(); + jest.runAllTimers(); + + const firstTransactionContext = spanToJSON(firstTransaction!); + const secondTransactionContext = spanToJSON(secondTransaction!); + expect(firstTransactionContext!.timestamp).toEqual(expect.any(Number)); + expect(secondTransactionContext!.timestamp).toEqual(expect.any(Number)); + expect(firstTransactionContext!.span_id).not.toEqual(secondTransactionContext!.span_id); + }); + + test('do not start UI event transaction if active transaction on scope', () => { + const activeTransaction = startSpanManual( + { name: 'activeTransactionOnScope', scope: getCurrentScope() }, + (span: Span) => span, + ); + expect(activeTransaction).toBeDefined(); + expect(activeTransaction).toBe(getActiveSpan()); + + startUserInteractionSpan(mockedUserInteractionId); + expect(activeTransaction).toBe(getActiveSpan()); + }); + + test('UI event transaction is canceled when routing transaction starts', () => { + const timeoutCloseToActualIdleTimeoutMs = 800; + startUserInteractionSpan(mockedUserInteractionId); + const interactionTransaction = getActiveSpan(); + jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); + + const routingTransaction = mockedRoutingInstrumentation.registeredListener!({ + name: 'newMockedRouteName', + }); + jest.runAllTimers(); + + const interactionTransactionContext = spanToJSON(interactionTransaction!); + const routingTransactionContext = spanToJSON(routingTransaction!); + expect(interactionTransactionContext).toEqual( + expect.objectContaining({ + timestamp: expect.any(Number), + status: 'cancelled', + }), + ); + expect(routingTransactionContext).toEqual( + expect.objectContaining({ + timestamp: expect.any(Number), + }), + ); + expect(interactionTransactionContext!.timestamp).toBeLessThanOrEqual(routingTransactionContext!.start_timestamp!); + }); + }); +}); diff --git a/test/tracing/reactnativetracing.test.ts b/test/tracing/reactnativetracing.test.ts index 6db3d5922a..b0d584ca48 100644 --- a/test/tracing/reactnativetracing.test.ts +++ b/test/tracing/reactnativetracing.test.ts @@ -8,7 +8,7 @@ jest.mock('@sentry/utils', () => { }); import * as SentryBrowser from '@sentry/browser'; -import type { Event, Span } from '@sentry/types'; +import type { Event } from '@sentry/types'; import { RoutingInstrumentation } from '../../src/js/tracing/routingInstrumentation'; @@ -56,16 +56,13 @@ const mockedAppState: AppState & MockAppState = { }; jest.mock('react-native/Libraries/AppState/AppState', () => mockedAppState); -import { getActiveSpan, spanToJSON, startSpanManual } from '@sentry/browser'; -import { getCurrentScope, SPAN_STATUS_ERROR, startInactiveSpan } from '@sentry/core'; +import { getActiveSpan, spanToJSON } from '@sentry/browser'; import type { AppState, AppStateStatus } from 'react-native'; import { ReactNativeTracing } from '../../src/js/tracing/reactnativetracing'; import { NATIVE } from '../../src/js/wrapper'; import type { TestClient } from '../mocks/client'; import { setupTestClient } from '../mocks/client'; -import type { MockedRoutingInstrumentation } from './mockedrountinginstrumention'; -import { createMockedRoutingInstrumentation } from './mockedrountinginstrumention'; describe('ReactNativeTracing', () => { beforeEach(() => { @@ -294,278 +291,4 @@ describe('ReactNativeTracing', () => { }); }); }); - describe('Handling deprecated options', () => { - test('finalTimeoutMs overrides maxTransactionDuration', () => { - const tracing = new ReactNativeTracing({ - finalTimeoutMs: 123000, - maxTransactionDuration: 456, - }); - expect(tracing.options.finalTimeoutMs).toBe(123000); - // eslint-disable-next-line deprecation/deprecation - expect(tracing.options.maxTransactionDuration).toBe(456); - }); - test('maxTransactionDuration translates to finalTimeoutMs', () => { - const tracing = new ReactNativeTracing({ - maxTransactionDuration: 123, - }); - expect(tracing.options.finalTimeoutMs).toBe(123000); - // eslint-disable-next-line deprecation/deprecation - expect(tracing.options.maxTransactionDuration).toBe(123); - }); - test('if none maxTransactionDuration and finalTimeoutMs is specified use default', () => { - const tracing = new ReactNativeTracing({}); - expect(tracing.options.finalTimeoutMs).toBe(600000); - // eslint-disable-next-line deprecation/deprecation - expect(tracing.options.maxTransactionDuration).toBe(600); - }); - test('idleTimeoutMs overrides idleTimeout', () => { - const tracing = new ReactNativeTracing({ - idleTimeoutMs: 123, - idleTimeout: 456, - }); - expect(tracing.options.idleTimeoutMs).toBe(123); - // eslint-disable-next-line deprecation/deprecation - expect(tracing.options.idleTimeout).toBe(456); - }); - test('idleTimeout translates to idleTimeoutMs', () => { - const tracing = new ReactNativeTracing({ - idleTimeout: 123, - }); - expect(tracing.options.idleTimeoutMs).toBe(123); - // eslint-disable-next-line deprecation/deprecation - expect(tracing.options.idleTimeout).toBe(123); - }); - test('if none idleTimeout and idleTimeoutMs is specified use default', () => { - const tracing = new ReactNativeTracing({}); - expect(tracing.options.idleTimeoutMs).toBe(1000); - // eslint-disable-next-line deprecation/deprecation - expect(tracing.options.idleTimeout).toBe(1000); - }); - }); - - describe('User Interaction Tracing', () => { - let client: TestClient; - let tracing: ReactNativeTracing; - let mockedUserInteractionId: { elementId: string | undefined; op: string }; - let mockedRoutingInstrumentation: MockedRoutingInstrumentation; - - beforeEach(() => { - mockedUserInteractionId = { elementId: 'mockedElementId', op: 'mocked.op' }; - client = setupTestClient(); - mockedRoutingInstrumentation = createMockedRoutingInstrumentation(); - }); - - describe('disabled user interaction', () => { - test('User interaction tracing is disabled by default', () => { - tracing = new ReactNativeTracing(); - tracing.setup(client); - tracing.startUserInteractionSpan(mockedUserInteractionId); - - expect(tracing.options.enableUserInteractionTracing).toBeFalsy(); - expect(getActiveSpan()).toBeUndefined(); - }); - }); - - describe('enabled user interaction', () => { - beforeEach(() => { - tracing = new ReactNativeTracing({ - routingInstrumentation: mockedRoutingInstrumentation, - enableUserInteractionTracing: true, - }); - tracing.setup(client); - mockedRoutingInstrumentation.registeredOnConfirmRoute!('mockedRouteName'); - }); - - test('user interaction tracing is enabled and transaction is bound to scope', () => { - tracing.startUserInteractionSpan(mockedUserInteractionId); - - const actualTransaction = getActiveSpan(); - const actualTransactionContext = spanToJSON(actualTransaction!); - expect(tracing.options.enableUserInteractionTracing).toBeTruthy(); - expect(actualTransactionContext).toEqual( - expect.objectContaining({ - description: 'mockedRouteName.mockedElementId', - op: 'mocked.op', - }), - ); - }); - - test('UI event transaction not sampled if no child spans', () => { - tracing.startUserInteractionSpan(mockedUserInteractionId); - const actualTransaction = getActiveSpan(); - - jest.runAllTimers(); - - expect(actualTransaction).toBeDefined(); - expect(client.event).toBeUndefined(); - }); - - test('does cancel UI event transaction when app goes to background', () => { - tracing.startUserInteractionSpan(mockedUserInteractionId); - const actualTransaction = getActiveSpan(); - - mockedAppState.setState('background'); - jest.runAllTimers(); - - const actualTransactionContext = spanToJSON(actualTransaction!); - expect(actualTransactionContext).toEqual( - expect.objectContaining({ - timestamp: expect.any(Number), - status: 'cancelled', - }), - ); - expect(mockedAppState.removeSubscription).toBeCalledTimes(1); - }); - - test('do not overwrite existing status of UI event transactions', () => { - tracing.startUserInteractionSpan(mockedUserInteractionId); - const actualTransaction = getActiveSpan(); - - actualTransaction?.setStatus({ code: SPAN_STATUS_ERROR, message: 'mocked_status' }); - - jest.runAllTimers(); - - const actualTransactionContext = spanToJSON(actualTransaction!); - expect(actualTransactionContext).toEqual( - expect.objectContaining({ - timestamp: expect.any(Number), - status: 'mocked_status', - }), - ); - }); - - test('same UI event and same element does not reschedule idle timeout', () => { - const timeoutCloseToActualIdleTimeoutMs = 800; - tracing.startUserInteractionSpan(mockedUserInteractionId); - const actualTransaction = getActiveSpan(); - jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); - - tracing.startUserInteractionSpan(mockedUserInteractionId); - jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); - - expect(spanToJSON(actualTransaction!).timestamp).toEqual(expect.any(Number)); - }); - - test('different UI event and same element finish first and start new transaction', () => { - const timeoutCloseToActualIdleTimeoutMs = 800; - tracing.startUserInteractionSpan(mockedUserInteractionId); - const firstTransaction = getActiveSpan(); - jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); - const childFirstTransaction = startInactiveSpan({ name: 'Child Span of the first Tx', op: 'child.op' }); - - tracing.startUserInteractionSpan({ ...mockedUserInteractionId, op: 'different.op' }); - const secondTransaction = getActiveSpan(); - jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); - childFirstTransaction?.end(); - jest.runAllTimers(); - - const firstTransactionEvent = client.eventQueue[0]; - expect(firstTransaction).toBeDefined(); - expect(firstTransactionEvent).toEqual( - expect.objectContaining({ - timestamp: expect.any(Number), - contexts: expect.objectContaining({ - trace: expect.objectContaining({ - op: 'mocked.op', - }), - }), - }), - ); - - expect(secondTransaction).toBeDefined(); - expect(spanToJSON(secondTransaction!)).toEqual( - expect.objectContaining({ - timestamp: expect.any(Number), - op: 'different.op', - }), - ); - expect(firstTransactionEvent!.timestamp).toBeGreaterThanOrEqual( - spanToJSON(secondTransaction!).start_timestamp!, - ); - }); - - test('different UI event and same element finish first transaction with last span', () => { - const timeoutCloseToActualIdleTimeoutMs = 800; - tracing.startUserInteractionSpan(mockedUserInteractionId); - const firstTransaction = getActiveSpan(); - jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); - const childFirstTransaction = startInactiveSpan({ name: 'Child Span of the first Tx', op: 'child.op' }); - - tracing.startUserInteractionSpan({ ...mockedUserInteractionId, op: 'different.op' }); - jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); - childFirstTransaction?.end(); - jest.runAllTimers(); - - const firstTransactionEvent = client.eventQueue[0]; - expect(firstTransaction).toBeDefined(); - expect(firstTransactionEvent).toEqual( - expect.objectContaining({ - timestamp: expect.any(Number), - contexts: expect.objectContaining({ - trace: expect.objectContaining({ - op: 'mocked.op', - }), - }), - }), - ); - }); - - test('same ui event after UI event transaction finished', () => { - tracing.startUserInteractionSpan(mockedUserInteractionId); - const firstTransaction = getActiveSpan(); - jest.runAllTimers(); - - tracing.startUserInteractionSpan(mockedUserInteractionId); - const secondTransaction = getActiveSpan(); - jest.runAllTimers(); - - const firstTransactionContext = spanToJSON(firstTransaction!); - const secondTransactionContext = spanToJSON(secondTransaction!); - expect(firstTransactionContext!.timestamp).toEqual(expect.any(Number)); - expect(secondTransactionContext!.timestamp).toEqual(expect.any(Number)); - expect(firstTransactionContext!.span_id).not.toEqual(secondTransactionContext!.span_id); - }); - - test('do not start UI event transaction if active transaction on scope', () => { - const activeTransaction = startSpanManual( - { name: 'activeTransactionOnScope', scope: getCurrentScope() }, - (span: Span) => span, - ); - expect(activeTransaction).toBeDefined(); - expect(activeTransaction).toBe(getActiveSpan()); - - tracing.startUserInteractionSpan(mockedUserInteractionId); - expect(activeTransaction).toBe(getActiveSpan()); - }); - - test('UI event transaction is canceled when routing transaction starts', () => { - const timeoutCloseToActualIdleTimeoutMs = 800; - tracing.startUserInteractionSpan(mockedUserInteractionId); - const interactionTransaction = getActiveSpan(); - jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); - - const routingTransaction = mockedRoutingInstrumentation.registeredListener!({ - name: 'newMockedRouteName', - }); - jest.runAllTimers(); - - const interactionTransactionContext = spanToJSON(interactionTransaction!); - const routingTransactionContext = spanToJSON(routingTransaction!); - expect(interactionTransactionContext).toEqual( - expect.objectContaining({ - timestamp: expect.any(Number), - status: 'cancelled', - }), - ); - expect(routingTransactionContext).toEqual( - expect.objectContaining({ - timestamp: expect.any(Number), - }), - ); - expect(interactionTransactionContext!.timestamp).toBeLessThanOrEqual( - routingTransactionContext!.start_timestamp!, - ); - }); - }); - }); }); From e52114bdd072bc9a490f3b6899e340179430ad17 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Tue, 13 Aug 2024 10:38:22 +0200 Subject: [PATCH 11/48] ref(tracing): Remove ReactNativeTracing deprecated options and use new integrations style (#3998) --- CHANGELOG.md | 10 + samples/expo/app/_layout.tsx | 2 +- samples/react-native/src/App.tsx | 5 +- src/js/client.ts | 4 +- src/js/index.ts | 2 +- src/js/integrations/default.ts | 7 +- src/js/touchevents.tsx | 6 - src/js/tracing/index.ts | 6 +- src/js/tracing/integrations/appStart.ts | 5 +- .../tracing/integrations/userInteraction.ts | 4 +- src/js/tracing/reactnativenavigation.ts | 14 +- src/js/tracing/reactnativetracing.ts | 288 ++++++++---------- src/js/tracing/reactnavigation.ts | 8 +- src/js/tracing/span.ts | 37 +-- test/client.test.ts | 4 +- test/sdk.test.ts | 21 +- test/tracing/addTracingExtensions.test.ts | 4 +- test/tracing/gesturetracing.test.ts | 9 +- .../integrations/userInteraction.test.ts | 7 +- test/tracing/reactnativenavigation.test.ts | 22 +- test/tracing/reactnativetracing.test.ts | 67 +--- .../reactnavigation.stalltracking.test.ts | 4 +- test/tracing/reactnavigation.test.ts | 24 +- test/tracing/reactnavigation.ttid.test.tsx | 4 +- 24 files changed, 255 insertions(+), 309 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 57f5fc7e1e..7ba584fde8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ ### Changes +- Removed deprecated ReactNativeTracing option `idleTimeout` use `idleTimeoutMs` instead ([#3998](https://github.com/getsentry/sentry-react-native/pull/3998)) +- Removed deprecated ReactNativeTracing option `maxTransactionDuration` use `finalTimeoutMs` instead ([#3998](https://github.com/getsentry/sentry-react-native/pull/3998)) +- Removed `beforeNavigate` use `beforeStartSpan` instead ([#3998](https://github.com/getsentry/sentry-react-native/pull/3998)) + - `beforeStartSpan` is executed before the span start, compared to `beforeNavigate` which was executed before the navigation ended (after the span was created) - New Native Frames Integration ([#3996](https://github.com/getsentry/sentry-react-native/pull/3996)) - New Stall Tracking Integration ([#3997](https://github.com/getsentry/sentry-react-native/pull/3997)) - New User Interaction Tracing Integration ([#3999](https://github.com/getsentry/sentry-react-native/pull/3999)) @@ -22,6 +26,12 @@ enableStallTracking: true, // default true enableUserInteractionTracing: true, // default false integrations: [ + Sentry.reactNativeTracingIntegration({ + beforeStartSpan: (startSpanOptions) => { + startSpanOptions.name = 'New Name'; + return startSpanOptions; + }, + }), Sentry.appStartIntegration({ standalone: false, // default false }), diff --git a/samples/expo/app/_layout.tsx b/samples/expo/app/_layout.tsx index 126a499b66..539dbb0fad 100644 --- a/samples/expo/app/_layout.tsx +++ b/samples/expo/app/_layout.tsx @@ -54,7 +54,7 @@ process.env.EXPO_SKIP_DURING_EXPORT !== 'true' && Sentry.init({ // default: [/.*/] failedRequestTargets: [/.*/], }), - new Sentry.ReactNativeTracing({ + Sentry.reactNativeTracingIntegration({ routingInstrumentation, }), ); diff --git a/samples/react-native/src/App.tsx b/samples/react-native/src/App.tsx index bbb71ec348..167b404766 100644 --- a/samples/react-native/src/App.tsx +++ b/samples/react-native/src/App.tsx @@ -66,11 +66,10 @@ Sentry.init({ }, integrations(integrations) { integrations.push( - new Sentry.ReactNativeTracing({ + Sentry.reactNativeTracingIntegration({ // The time to wait in ms until the transaction will be finished, For testing, default is 1000 ms - idleTimeout: 5000, + idleTimeoutMs: 5_000, routingInstrumentation: reactNavigationInstrumentation, - enableUserInteractionTracing: true, ignoreEmptyBackNavigationTransactions: true, }), Sentry.httpClientIntegration({ diff --git a/src/js/client.ts b/src/js/client.ts index 8d2d66a09b..b12ec9a722 100644 --- a/src/js/client.ts +++ b/src/js/client.ts @@ -19,7 +19,7 @@ import { defaultSdkInfo } from './integrations/sdkinfo'; import type { ReactNativeClientOptions } from './options'; import type { mobileReplayIntegration } from './replay/mobilereplay'; import { MOBILE_REPLAY_INTEGRATION_NAME } from './replay/mobilereplay'; -import type { ReactNativeTracing } from './tracing'; +import { getReactNativeTracingIntegration } from './tracing/reactnativetracing'; import { createUserFeedbackEnvelope, items } from './utils/envelope'; import { ignoreRequireCycleLogs } from './utils/ignorerequirecyclelogs'; import { mergeOutcomes } from './utils/outcome'; @@ -141,7 +141,7 @@ export class ReactNativeClient extends BaseClient { */ protected _setupIntegrations(): void { super._setupIntegrations(); - const tracing = this.getIntegrationByName('ReactNativeTracing'); + const tracing = getReactNativeTracingIntegration(this); const routingName = tracing?.options?.routingInstrumentation?.name; if (routingName) { this.addIntegration(createIntegration(routingName)); diff --git a/src/js/index.ts b/src/js/index.ts index 79ca02795d..8854f73716 100644 --- a/src/js/index.ts +++ b/src/js/index.ts @@ -58,7 +58,7 @@ export { init, wrap, nativeCrash, flush, close, captureUserFeedback, withScope } export { TouchEventBoundary, withTouchEventBoundary } from './touchevents'; export { - ReactNativeTracing, + reactNativeTracingIntegration, ReactNavigationV5Instrumentation, ReactNavigationInstrumentation, ReactNativeNavigationInstrumentation, diff --git a/src/js/integrations/default.ts b/src/js/integrations/default.ts index 7e1164c4a2..06ad272a70 100644 --- a/src/js/integrations/default.ts +++ b/src/js/integrations/default.ts @@ -3,7 +3,7 @@ import type { BrowserOptions } from '@sentry/react'; import type { Integration } from '@sentry/types'; import type { ReactNativeClientOptions } from '../options'; -import { ReactNativeTracing } from '../tracing'; +import { reactNativeTracingIntegration } from '../tracing'; import { isExpoGo, notWeb } from '../utils/environment'; import { appStartIntegration, @@ -114,10 +114,7 @@ export function getDefaultIntegrations(options: ReactNativeClientOptions): Integ integrations.push(userInteractionIntegration()); } if (hasTracingEnabled && options.enableAutoPerformanceTracing) { - integrations.push(new ReactNativeTracing()); - } - if (hasTracingEnabled && options.enableAppStartTracking) { - integrations.push(appStartIntegration()); + integrations.push(reactNativeTracingIntegration()); } if (options.enableCaptureFailedRequests) { integrations.push(httpClientIntegration()); diff --git a/src/js/touchevents.tsx b/src/js/touchevents.tsx index 45908a9054..06ab4b5523 100644 --- a/src/js/touchevents.tsx +++ b/src/js/touchevents.tsx @@ -6,7 +6,6 @@ import type { GestureResponderEvent } from 'react-native'; import { StyleSheet, View } from 'react-native'; import { createIntegration } from './integrations/factory'; -import type { ReactNativeTracing } from './tracing'; import { startUserInteractionSpan } from './tracing/integrations/userInteraction'; import { UI_ACTION_TOUCH } from './tracing/ops'; @@ -92,17 +91,12 @@ class TouchEventBoundary extends React.Component { public readonly name: string = 'TouchEventBoundary'; - private _tracingIntegration: ReactNativeTracing | null = null; - /** * Registers the TouchEventBoundary as a Sentry Integration. */ public componentDidMount(): void { const client = getClient(); client?.addIntegration?.(createIntegration(this.name)); - if (!this._tracingIntegration && client) { - this._tracingIntegration = client.getIntegrationByName('ReactNativeTracing') || null; - } } /** diff --git a/src/js/tracing/index.ts b/src/js/tracing/index.ts index bcd0ebd8e7..dc071fe236 100644 --- a/src/js/tracing/index.ts +++ b/src/js/tracing/index.ts @@ -1,4 +1,8 @@ -export { ReactNativeTracing } from './reactnativetracing'; +export { + reactNativeTracingIntegration, + INTEGRATION_NAME as REACT_NATIVE_TRACING_INTEGRATION_NAME, +} from './reactnativetracing'; +export type { ReactNativeTracingIntegration } from './reactnativetracing'; export type { RoutingInstrumentationInstance } from './routingInstrumentation'; export { RoutingInstrumentation } from './routingInstrumentation'; diff --git a/src/js/tracing/integrations/appStart.ts b/src/js/tracing/integrations/appStart.ts index db7bd365b2..875507f9c5 100644 --- a/src/js/tracing/integrations/appStart.ts +++ b/src/js/tracing/integrations/appStart.ts @@ -22,7 +22,7 @@ import { APP_START_WARM as APP_START_WARM_OP, UI_LOAD as UI_LOAD_OP, } from '../ops'; -import { ReactNativeTracing } from '../reactnativetracing'; +import { getReactNativeTracingIntegration } from '../reactnativetracing'; import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '../semanticAttributes'; import { createChildSpanJSON, createSpanJSON, getBundleStartTimestampMs } from '../utils'; @@ -126,8 +126,7 @@ export const appStartIntegration = ({ const afterAllSetup = (client: Client): void => { if (standaloneUserOption === undefined) { // If not user defined, set based on the routing instrumentation presence - standalone = !client.getIntegrationByName(ReactNativeTracing.id)?.options - .routingInstrumentation; + standalone = !getReactNativeTracingIntegration(client)?.options.routingInstrumentation; } }; diff --git a/src/js/tracing/integrations/userInteraction.ts b/src/js/tracing/integrations/userInteraction.ts index 507e99b90c..b187f1b306 100644 --- a/src/js/tracing/integrations/userInteraction.ts +++ b/src/js/tracing/integrations/userInteraction.ts @@ -45,7 +45,7 @@ export const startUserInteractionSpan = (userInteractionId: { logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing can not create transaction with undefined elementId.`); return undefined; } - if (!tracing.currentRoute) { + if (!tracing.state.currentRoute) { logger.log(`[${INTEGRATION_NAME}] User Interaction Tracing can not create transaction without a current route.`); return undefined; } @@ -61,7 +61,7 @@ export const startUserInteractionSpan = (userInteractionId: { return undefined; } - const name = `${tracing.currentRoute}.${elementId}`; + const name = `${tracing.state.currentRoute}.${elementId}`; if ( activeTransaction && spanToJSON(activeTransaction).description === name && diff --git a/src/js/tracing/reactnativenavigation.ts b/src/js/tracing/reactnativenavigation.ts index 39d1dddf79..b07d6caff2 100644 --- a/src/js/tracing/reactnativenavigation.ts +++ b/src/js/tracing/reactnativenavigation.ts @@ -1,8 +1,14 @@ -import { addBreadcrumb, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core'; +import { + addBreadcrumb, + SEMANTIC_ATTRIBUTE_SENTRY_OP, + SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, + spanToJSON, +} from '@sentry/core'; import type { Span } from '@sentry/types'; import type { EmitterSubscription } from '../utils/rnlibrariesinterface'; import { isSentrySpan } from '../utils/span'; +import { DEFAULT_NAVIGATION_SPAN_NAME } from './reactnativetracing'; import type { OnConfirmRoute, TransactionCreator } from './routingInstrumentation'; import { InternalRoutingInstrumentation } from './routingInstrumentation'; import type { BeforeNavigate } from './types'; @@ -124,7 +130,7 @@ export class ReactNativeNavigationInstrumentation extends InternalRoutingInstrum this._discardLatestTransaction(); } - this._latestTransaction = this.onRouteWillChange({ name: 'Route Change' }); + this._latestTransaction = this.onRouteWillChange({ name: DEFAULT_NAVIGATION_SPAN_NAME }); this._stateChangeTimeout = setTimeout( this._discardLatestTransaction.bind(this), @@ -151,7 +157,9 @@ export class ReactNativeNavigationInstrumentation extends InternalRoutingInstrum const routeHasBeenSeen = this._recentComponentIds.includes(event.componentId); - this._latestTransaction.updateName(event.componentName); + if (spanToJSON(this._latestTransaction).description === DEFAULT_NAVIGATION_SPAN_NAME) { + this._latestTransaction.updateName(event.componentName); + } this._latestTransaction.setAttributes({ // TODO: Should we include pass props? I don't know exactly what it contains, cant find it in the RNavigation docs 'route.name': event.componentName, diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index b6fec52952..d9e098d682 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -1,43 +1,51 @@ /* eslint-disable max-lines */ -import type { RequestInstrumentationOptions } from '@sentry/browser'; -import { defaultRequestInstrumentationOptions, instrumentOutgoingRequests } from '@sentry/browser'; -import { getClient, SEMANTIC_ATTRIBUTE_SENTRY_OP, spanToJSON } from '@sentry/core'; -import type { Client, Event, Integration, Span } from '@sentry/types'; +import { instrumentOutgoingRequests } from '@sentry/browser'; +import { getClient, getCurrentScope } from '@sentry/core'; +import type { Client, Event, Integration, StartSpanOptions } from '@sentry/types'; import { logger } from '@sentry/utils'; -import type { RoutingInstrumentationInstance } from '../tracing/routingInstrumentation'; -import { startIdleNavigationSpan } from './span'; -import type { BeforeNavigate } from './types'; +import type { RoutingInstrumentationInstance } from './routingInstrumentation'; +import { addDefaultOpForSpanFrom, startIdleNavigationSpan } from './span'; -export interface ReactNativeTracingOptions extends RequestInstrumentationOptions { +export const INTEGRATION_NAME = 'ReactNativeTracing'; + +export interface ReactNativeTracingOptions { /** - * @deprecated Replaced by idleTimeoutMs + * The time that has to pass without any span being created. + * If this time is exceeded, the idle span will finish. + * + * @default 1_000 (ms) */ - idleTimeout: number; + idleTimeoutMs: number; /** - * @deprecated Replaced by maxTransactionDurationMs + * The max. time an idle span may run. + * If this time is exceeded, the idle span will finish no matter what. + * + * @default 60_0000 (ms) */ - maxTransactionDuration: number; + finalTimeoutMs: number; /** - * The time to wait in ms until the transaction will be finished. The transaction will use the end timestamp of - * the last finished span as the endtime for the transaction. - * Time is in ms. + * Flag to disable patching all together for fetch requests. * - * Default: 1000 + * @default true */ - idleTimeoutMs: number; + traceFetch: boolean; /** - * The maximum duration (transaction duration + idle timeout) of a transaction - * before it will be marked as "deadline_exceeded". - * If you never want to mark a transaction set it to 0. - * Time is in ms. + * Flag to disable patching all together for xhr requests. * - * Default: 600000 + * @default true */ - finalTimeoutMs: number; + traceXHR: boolean; + + /** + * If true, Sentry will capture http timings and add them to the corresponding http spans. + * + * @default true + */ + enableHTTPTimings: boolean; /** * The routing instrumentation to be used with the tracing integration. @@ -49,184 +57,132 @@ export interface ReactNativeTracingOptions extends RequestInstrumentationOptions * Does not sample transactions that are from routes that have been seen any more and don't have any spans. * This removes a lot of the clutter as most back navigation transactions are now ignored. * - * Default: true + * @default true */ ignoreEmptyBackNavigationTransactions: boolean; /** - * beforeNavigate is called before a navigation transaction is created and allows users to modify transaction - * context data, or drop the transaction entirely (by setting `sampled = false` in the context). - * - * @param context: The context data which will be passed to `startTransaction` by default + * A callback which is called before a span for a navigation is started. + * It receives the options passed to `startSpan`, and expects to return an updated options object. + */ + beforeStartSpan?: (options: StartSpanOptions) => StartSpanOptions; + + /** + * This function will be called before creating a span for a request with the given url. + * Return false if you don't want a span for the given url. * - * @returns A (potentially) modified context object, with `sampled = false` if the transaction should be dropped. + * @default (url: string) => true */ - beforeNavigate: BeforeNavigate; + shouldCreateSpanForRequest?(this: void, url: string): boolean; } const DEFAULT_TRACE_PROPAGATION_TARGETS = ['localhost', /^\/(?!\/)/]; +export const DEFAULT_NAVIGATION_SPAN_NAME = 'Route Change'; const defaultReactNativeTracingOptions: ReactNativeTracingOptions = { - ...defaultRequestInstrumentationOptions, - idleTimeout: 1000, - maxTransactionDuration: 600, - idleTimeoutMs: 1000, - finalTimeoutMs: 600000, + idleTimeoutMs: 1_000, + finalTimeoutMs: 60_0000, + traceFetch: true, + traceXHR: true, + enableHTTPTimings: true, ignoreEmptyBackNavigationTransactions: true, - beforeNavigate: context => context, }; -/** - * Tracing integration for React Native. - */ -export class ReactNativeTracing implements Integration { - /** - * @inheritDoc - */ - public static id: string = 'ReactNativeTracing'; - - /** - * @inheritDoc - */ - public name: string = ReactNativeTracing.id; - - /** ReactNativeTracing options */ - public options: ReactNativeTracingOptions; - - public useAppStartWithProfiler: boolean = false; - - public currentRoute?: string; - - private _hasSetTracePropagationTargets: boolean; - private _currentViewName: string | undefined; - private _client: Client | undefined; - - public constructor(options: Partial = {}) { - this._hasSetTracePropagationTargets = !!( - options && - // eslint-disable-next-line deprecation/deprecation - options.tracePropagationTargets - ); - - this.options = { - ...defaultReactNativeTracingOptions, - ...options, - finalTimeoutMs: - options.finalTimeoutMs ?? - // eslint-disable-next-line deprecation/deprecation - (typeof options.maxTransactionDuration === 'number' - ? // eslint-disable-next-line deprecation/deprecation - options.maxTransactionDuration * 1000 - : undefined) ?? - defaultReactNativeTracingOptions.finalTimeoutMs, - idleTimeoutMs: - options.idleTimeoutMs ?? - // eslint-disable-next-line deprecation/deprecation - options.idleTimeout ?? - defaultReactNativeTracingOptions.idleTimeoutMs, - }; - } +type ReactNativeTracingState = { + currentRoute: string | undefined; +}; - /** - * Registers routing and request instrumentation. - */ - public setup(client: Client): void { - const clientOptions = client && client.getOptions(); - - // eslint-disable-next-line @typescript-eslint/unbound-method - const { - traceFetch, - traceXHR, - // eslint-disable-next-line deprecation/deprecation - shouldCreateSpanForRequest, - // eslint-disable-next-line deprecation/deprecation - tracePropagationTargets: thisOptionsTracePropagationTargets, - routingInstrumentation, - } = this.options; - - const clientOptionsTracePropagationTargets = clientOptions && clientOptions.tracePropagationTargets; - const tracePropagationTargets = - clientOptionsTracePropagationTargets || - (this._hasSetTracePropagationTargets && thisOptionsTracePropagationTargets) || - DEFAULT_TRACE_PROPAGATION_TARGETS; - - if (routingInstrumentation) { - routingInstrumentation.registerRoutingInstrumentation( - this._onRouteWillChange.bind(this), - this.options.beforeNavigate, - this._onConfirmRoute.bind(this), +export const reactNativeTracingIntegration = ( + options: Partial = {}, +): Integration & { + options: ReactNativeTracingOptions; + state: ReactNativeTracingState; +} => { + const state: ReactNativeTracingState = { + currentRoute: undefined, + }; + + const finalOptions = { + ...defaultReactNativeTracingOptions, + ...options, + beforeStartSpan: options.beforeStartSpan ?? ((options: StartSpanOptions) => options), + finalTimeoutMs: options.finalTimeoutMs ?? defaultReactNativeTracingOptions.finalTimeoutMs, + idleTimeoutMs: options.idleTimeoutMs ?? defaultReactNativeTracingOptions.idleTimeoutMs, + }; + + const setup = (client: Client): void => { + if (finalOptions.routingInstrumentation) { + const idleNavigationSpanOptions = { + finalTimeout: finalOptions.finalTimeoutMs, + idleTimeout: finalOptions.idleTimeoutMs, + ignoreEmptyBackNavigationTransactions: finalOptions.ignoreEmptyBackNavigationTransactions, + }; + finalOptions.routingInstrumentation.registerRoutingInstrumentation( + navigationInstrumentationOptions => + startIdleNavigationSpan( + finalOptions.beforeStartSpan({ + name: DEFAULT_NAVIGATION_SPAN_NAME, + op: 'navigation', + forceTransaction: true, + scope: getCurrentScope(), + ...navigationInstrumentationOptions, + }), + idleNavigationSpanOptions, + ), + () => { + // no-op, replaced by beforeStartSpan, will be removed in the future + }, + (currentViewName: string | undefined) => { + state.currentRoute = currentViewName; + }, ); } else { - logger.log('[ReactNativeTracing] Not instrumenting route changes as routingInstrumentation has not been set.'); + logger.log(`[${INTEGRATION_NAME}] Not instrumenting route changes as routingInstrumentation has not been set.`); } addDefaultOpForSpanFrom(client); instrumentOutgoingRequests({ - traceFetch, - traceXHR, - shouldCreateSpanForRequest, - tracePropagationTargets, + traceFetch: finalOptions.traceFetch, + traceXHR: finalOptions.traceXHR, + shouldCreateSpanForRequest: finalOptions.shouldCreateSpanForRequest, + tracePropagationTargets: client.getOptions().tracePropagationTargets || DEFAULT_TRACE_PROPAGATION_TARGETS, }); - } + }; - /** - * @inheritdoc - */ - public processEvent(event: Event): Promise | Event { - const eventWithView = this._getCurrentViewEventProcessor(event); - return eventWithView; - } - - /** - * Sets the current view name into the app context. - * @param event Le event. - */ - private _getCurrentViewEventProcessor(event: Event): Event { - if (event.contexts && this._currentViewName) { - event.contexts.app = { view_names: [this._currentViewName], ...event.contexts.app }; + const processEvent = (event: Event): Event => { + if (event.contexts && state.currentRoute) { + event.contexts.app = { view_names: [state.currentRoute], ...event.contexts.app }; } return event; - } + }; + + return { + name: INTEGRATION_NAME, + setup, + processEvent, + options: finalOptions, + state, + }; +}; - /** To be called when the route changes, but BEFORE the components of the new route mount. */ - private _onRouteWillChange(): Span | undefined { - return startIdleNavigationSpan( - { - name: 'Route Change', - }, - { - finalTimeout: this.options.finalTimeoutMs, - idleTimeout: this.options.idleTimeoutMs, - ignoreEmptyBackNavigationTransactions: this.options.ignoreEmptyBackNavigationTransactions, - }, - ); - } - - /** - * Save the current route to set it in context during event processing. - */ - private _onConfirmRoute(currentViewName: string | undefined): void { - this._currentViewName = currentViewName; - this.currentRoute = currentViewName; - } -} +export type ReactNativeTracingIntegration = ReturnType; /** * Returns the current React Native Tracing integration. */ -export function getCurrentReactNativeTracingIntegration(): ReactNativeTracing | undefined { +export function getCurrentReactNativeTracingIntegration(): ReactNativeTracingIntegration | undefined { const client = getClient(); if (!client) { return undefined; } - return client.getIntegrationByName(ReactNativeTracing.id) as ReactNativeTracing | undefined; + + return getReactNativeTracingIntegration(client); } -function addDefaultOpForSpanFrom(client: Client): void { - client.on('spanStart', (span: Span) => { - if (!spanToJSON(span).op) { - span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'default'); - } - }); +/** + * Returns React Native Tracing integration of given client. + */ +export function getReactNativeTracingIntegration(client: Client): ReactNativeTracingIntegration | undefined { + return client.getIntegrationByName(INTEGRATION_NAME) as ReactNativeTracingIntegration | undefined; } diff --git a/src/js/tracing/reactnavigation.ts b/src/js/tracing/reactnavigation.ts index 0b86b4e34d..965f7980d0 100644 --- a/src/js/tracing/reactnavigation.ts +++ b/src/js/tracing/reactnavigation.ts @@ -16,6 +16,7 @@ import { type SentryEventEmitter, createSentryEventEmitter, NewFrameEventName } import { isSentrySpan } from '../utils/span'; import { RN_GLOBAL_OBJ } from '../utils/worldwide'; import { NATIVE } from '../wrapper'; +import { DEFAULT_NAVIGATION_SPAN_NAME } from './reactnativetracing'; import type { OnConfirmRoute, TransactionCreator } from './routingInstrumentation'; import { InternalRoutingInstrumentation } from './routingInstrumentation'; import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from './semanticAttributes'; @@ -192,7 +193,7 @@ export class ReactNavigationInstrumentation extends InternalRoutingInstrumentati this._clearStateChangeTimeout(); } - this._latestTransaction = this.onRouteWillChange({ name: 'Route Change' }); + this._latestTransaction = this.onRouteWillChange({ name: DEFAULT_NAVIGATION_SPAN_NAME }); if (this._options.enableTimeToInitialDisplay) { this._navigationProcessingSpan = startInactiveSpan({ @@ -288,7 +289,9 @@ export class ReactNavigationInstrumentation extends InternalRoutingInstrumentati this._navigationProcessingSpan?.end(stateChangedTimestamp); this._navigationProcessingSpan = undefined; - this._latestTransaction.updateName(route.name); + if (spanToJSON(this._latestTransaction).description === DEFAULT_NAVIGATION_SPAN_NAME) { + this._latestTransaction.updateName(route.name); + } this._latestTransaction.setAttributes({ 'route.name': route.name, 'route.key': route.key, @@ -303,7 +306,6 @@ export class ReactNavigationInstrumentation extends InternalRoutingInstrumentati [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', }); - this._beforeNavigate?.(this._latestTransaction); // Clear the timeout so the transaction does not get cancelled. this._clearStateChangeTimeout(); diff --git a/src/js/tracing/span.ts b/src/js/tracing/span.ts index c6d7b8bc83..f73707ccf5 100644 --- a/src/js/tracing/span.ts +++ b/src/js/tracing/span.ts @@ -2,12 +2,13 @@ import { getActiveSpan, getClient, getCurrentScope, + SEMANTIC_ATTRIBUTE_SENTRY_OP, SentryNonRecordingSpan, SPAN_STATUS_ERROR, spanToJSON, startIdleSpan as coreStartIdleSpan, } from '@sentry/core'; -import type { Scope, Span, StartSpanOptions } from '@sentry/types'; +import type { Client, Scope, Span, StartSpanOptions } from '@sentry/types'; import { generatePropagationContext, logger } from '@sentry/utils'; import { isRootSpan } from '../utils/span'; @@ -15,13 +16,7 @@ import { adjustTransactionDuration, cancelInBackground, ignoreEmptyBackNavigatio import { SPAN_ORIGIN_AUTO_INTERACTION } from './origin'; export const startIdleNavigationSpan = ( - { - name, - op, - }: { - name?: string; - op?: string; - } = {}, + startSpanOption: StartSpanOptions, { finalTimeout, idleTimeout, @@ -47,15 +42,12 @@ export const startIdleNavigationSpan = ( activeSpan.end(); } - const expandedContext: StartSpanOptions = { - name, - op, - forceTransaction: true, - scope: getCurrentScope(), - }; - - const idleSpan = startIdleSpan(expandedContext, { finalTimeout, idleTimeout }); - logger.log(`[ReactNativeTracing] Starting ${op || 'unknown op'} transaction "${name}" on scope`); + const idleSpan = startIdleSpan(startSpanOption, { finalTimeout, idleTimeout }); + logger.log( + `[ReactNativeTracing] Starting ${startSpanOption.op || 'unknown op'} transaction "${ + startSpanOption.name + }" on scope`, + ); adjustTransactionDuration(client, idleSpan, finalTimeout); if (ignoreEmptyBackNavigationTransactions) { @@ -109,3 +101,14 @@ export function clearActiveSpanFromScope(scope: ScopeWithMaybeSpan): void { // eslint-disable-next-line @typescript-eslint/no-dynamic-delete delete scope[SCOPE_SPAN_FIELD]; } + +/** + * Ensures that all created spans have an operation name. + */ +export function addDefaultOpForSpanFrom(client: Client): void { + client.on('spanStart', (span: Span) => { + if (!spanToJSON(span).op) { + span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'default'); + } + }); +} diff --git a/test/client.test.ts b/test/client.test.ts index fe0ea65a50..d4a057b316 100644 --- a/test/client.test.ts +++ b/test/client.test.ts @@ -9,7 +9,7 @@ import * as RN from 'react-native'; import { ReactNativeClient } from '../src/js/client'; import type { ReactNativeClientOptions } from '../src/js/options'; import type { RoutingInstrumentationInstance } from '../src/js/tracing'; -import { ReactNativeTracing } from '../src/js/tracing'; +import { reactNativeTracingIntegration } from '../src/js/tracing'; import { NativeTransport } from '../src/js/transports/native'; import { SDK_NAME, SDK_PACKAGE_NAME, SDK_VERSION } from '../src/js/version'; import { NATIVE } from '../src/js/wrapper'; @@ -621,7 +621,7 @@ describe('Tests ReactNativeClient', () => { mockedOptions({ dsn: EXAMPLE_DSN, integrations: [ - new ReactNativeTracing({ + reactNativeTracingIntegration({ routingInstrumentation: mockRoutingInstrumentation, }), ], diff --git a/test/sdk.test.ts b/test/sdk.test.ts index 522aa586ab..1c56a9d465 100644 --- a/test/sdk.test.ts +++ b/test/sdk.test.ts @@ -12,7 +12,12 @@ import type { BaseTransportOptions, ClientOptions, Integration, Scope } from '@s import { logger } from '@sentry/utils'; import { init, withScope } from '../src/js/sdk'; -import { ReactNativeTracing, ReactNavigationInstrumentation } from '../src/js/tracing'; +import type { ReactNativeTracingIntegration } from '../src/js/tracing'; +import { + REACT_NATIVE_TRACING_INTEGRATION_NAME, + reactNativeTracingIntegration, + ReactNavigationInstrumentation, +} from '../src/js/tracing'; import { makeNativeTransport } from '../src/js/transports/native'; import { getDefaultEnvironment, isExpoGo, notWeb } from '../src/js/utils/environment'; import { NATIVE } from './mockWrapper'; @@ -30,9 +35,9 @@ describe('Tests the SDK functionality', () => { describe('init', () => { describe('enableAutoPerformanceTracing', () => { - const reactNavigationInstrumentation = (): ReactNativeTracing => { + const reactNavigationInstrumentation = (): ReactNativeTracingIntegration => { const nav = new ReactNavigationInstrumentation(); - return new ReactNativeTracing({ routingInstrumentation: nav }); + return reactNativeTracingIntegration({ routingInstrumentation: nav }); }; it('Auto Performance is disabled by default', () => { @@ -84,7 +89,9 @@ describe('Tests the SDK functionality', () => { }); const options = usedIntegrations(); - expect(options.filter(integration => integration.name === ReactNativeTracing.id).length).toBe(1); + expect(options.filter(integration => integration.name === REACT_NATIVE_TRACING_INTEGRATION_NAME).length).toBe( + 1, + ); expect(options.some(integration => integration === tracing)).toBe(true); }); @@ -97,7 +104,9 @@ describe('Tests the SDK functionality', () => { }); const options = usedIntegrations(); - expect(options.filter(integration => integration.name === ReactNativeTracing.id).length).toBe(1); + expect(options.filter(integration => integration.name === REACT_NATIVE_TRACING_INTEGRATION_NAME).length).toBe( + 1, + ); expect(options.some(integration => integration === tracing)).toBe(true); }); }); @@ -681,5 +690,5 @@ function usedIntegrations(): Integration[] { } function autoPerformanceIsEnabled(): boolean { - return usedIntegrations().some(integration => integration.name === ReactNativeTracing.id); + return usedIntegrations().some(integration => integration.name === REACT_NATIVE_TRACING_INTEGRATION_NAME); } diff --git a/test/tracing/addTracingExtensions.test.ts b/test/tracing/addTracingExtensions.test.ts index bdc60b5578..4d4c5384c3 100644 --- a/test/tracing/addTracingExtensions.test.ts +++ b/test/tracing/addTracingExtensions.test.ts @@ -1,6 +1,6 @@ import { getCurrentScope, spanToJSON, startSpanManual } from '@sentry/core'; -import { ReactNativeTracing } from '../../src/js'; +import { reactNativeTracingIntegration } from '../../src/js'; import { type TestClient, setupTestClient } from '../mocks/client'; describe('Tracing extensions', () => { @@ -8,7 +8,7 @@ describe('Tracing extensions', () => { beforeEach(() => { client = setupTestClient({ - integrations: [new ReactNativeTracing()], + integrations: [reactNativeTracingIntegration()], }); }); diff --git a/test/tracing/gesturetracing.test.ts b/test/tracing/gesturetracing.test.ts index a0171613cf..d0086827b2 100644 --- a/test/tracing/gesturetracing.test.ts +++ b/test/tracing/gesturetracing.test.ts @@ -8,7 +8,8 @@ import { sentryTraceGesture, } from '../../src/js/tracing/gesturetracing'; import { startUserInteractionSpan } from '../../src/js/tracing/integrations/userInteraction'; -import { ReactNativeTracing } from '../../src/js/tracing/reactnativetracing'; +import type { ReactNativeTracingIntegration } from '../../src/js/tracing/reactnativetracing'; +import { reactNativeTracingIntegration } from '../../src/js/tracing/reactnativetracing'; import { type TestClient, setupTestClient } from '../mocks/client'; import type { MockedRoutingInstrumentation } from './mockedrountinginstrumention'; import { createMockedRoutingInstrumentation } from './mockedrountinginstrumention'; @@ -37,7 +38,7 @@ describe('GestureTracing', () => { describe('gracefully fails on invalid gestures', () => { it('gesture is undefined', () => { - const gesture = undefined; + const gesture: unknown = undefined; expect(sentryTraceGesture(label, gesture)).toBeUndefined(); }); @@ -49,7 +50,7 @@ describe('GestureTracing', () => { describe('traces gestures', () => { let client: TestClient; - let tracing: ReactNativeTracing; + let tracing: ReactNativeTracingIntegration; let mockedRoutingInstrumentation: MockedRoutingInstrumentation; let mockedGesture: MockGesture; @@ -60,7 +61,7 @@ describe('GestureTracing', () => { enableUserInteractionTracing: true, }); mockedRoutingInstrumentation = createMockedRoutingInstrumentation(); - tracing = new ReactNativeTracing({ + tracing = reactNativeTracingIntegration({ routingInstrumentation: mockedRoutingInstrumentation, }); client.addIntegration(tracing); diff --git a/test/tracing/integrations/userInteraction.test.ts b/test/tracing/integrations/userInteraction.test.ts index dfd1b44a4d..01bcd86a0c 100644 --- a/test/tracing/integrations/userInteraction.test.ts +++ b/test/tracing/integrations/userInteraction.test.ts @@ -13,7 +13,8 @@ import { startUserInteractionSpan, userInteractionIntegration, } from '../../../src/js/tracing/integrations/userInteraction'; -import { ReactNativeTracing } from '../../../src/js/tracing/reactnativetracing'; +import type { ReactNativeTracingIntegration } from '../../../src/js/tracing/reactnativetracing'; +import { reactNativeTracingIntegration } from '../../../src/js/tracing/reactnativetracing'; import { NATIVE } from '../../../src/js/wrapper'; import type { TestClient } from '../../mocks/client'; import { setupTestClient } from '../../mocks/client'; @@ -57,7 +58,7 @@ jest.mock('../../../src/js/wrapper', () => { describe('User Interaction Tracing', () => { let client: TestClient; - let tracing: ReactNativeTracing; + let tracing: ReactNativeTracingIntegration; let mockedUserInteractionId: { elementId: string | undefined; op: string }; let mockedRoutingInstrumentation: MockedRoutingInstrumentation; @@ -98,7 +99,7 @@ describe('User Interaction Tracing', () => { describe('enabled user interaction', () => { beforeEach(() => { - tracing = new ReactNativeTracing({ + tracing = reactNativeTracingIntegration({ routingInstrumentation: mockedRoutingInstrumentation, }); client.addIntegration(userInteractionIntegration()); diff --git a/test/tracing/reactnativenavigation.test.ts b/test/tracing/reactnativenavigation.test.ts index 44c3a1abae..f07c7c5505 100644 --- a/test/tracing/reactnativenavigation.test.ts +++ b/test/tracing/reactnativenavigation.test.ts @@ -7,10 +7,10 @@ import { setCurrentClient, spanToJSON, } from '@sentry/core'; -import type { Event } from '@sentry/types'; +import type { Event, StartSpanOptions } from '@sentry/types'; import type { EmitterSubscription } from 'react-native'; -import { ReactNativeTracing } from '../../src/js'; +import { reactNativeTracingIntegration } from '../../src/js'; import type { BottomTabPressedEvent, ComponentWillAppearEvent, @@ -31,7 +31,6 @@ import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, } from '../../src/js/tracing/semanticAttributes'; -import type { BeforeNavigate } from '../../src/js/tracing/types'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; interface MockEventsRegistry extends EventsRegistry { @@ -94,10 +93,11 @@ describe('React Native Navigation Instrumentation', () => { ); }); - test('Transaction context is changed with beforeNavigate', async () => { + test('start span options are changes by before start span callback', async () => { setupTestClient({ - beforeNavigate: span => { - span.updateName('New Name'); + beforeStartSpan: startSpanOptions => { + startSpanOptions.name = 'New Name'; + return startSpanOptions; }, }); @@ -351,7 +351,7 @@ describe('React Native Navigation Instrumentation', () => { function setupTestClient( setupOptions: { - beforeNavigate?: BeforeNavigate; + beforeStartSpan?: (options: StartSpanOptions) => StartSpanOptions; enableTabsInstrumentation?: boolean; } = {}, ) { @@ -368,15 +368,15 @@ describe('React Native Navigation Instrumentation', () => { }, ); - const rnTracing = new ReactNativeTracing({ + const rnTracing = reactNativeTracingIntegration({ routingInstrumentation: rNavigation, - enableStallTracking: false, - enableNativeFramesTracking: false, - beforeNavigate: setupOptions.beforeNavigate, + beforeStartSpan: setupOptions.beforeStartSpan, }); const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, + enableStallTracking: false, + enableNativeFramesTracking: false, integrations: [rnTracing], enableAppStartTracking: false, }); diff --git a/test/tracing/reactnativetracing.test.ts b/test/tracing/reactnativetracing.test.ts index b0d584ca48..916489b1cc 100644 --- a/test/tracing/reactnativetracing.test.ts +++ b/test/tracing/reactnativetracing.test.ts @@ -59,7 +59,7 @@ jest.mock('react-native/Libraries/AppState/AppState', () => mockedAppState); import { getActiveSpan, spanToJSON } from '@sentry/browser'; import type { AppState, AppStateStatus } from 'react-native'; -import { ReactNativeTracing } from '../../src/js/tracing/reactnativetracing'; +import { reactNativeTracingIntegration } from '../../src/js/tracing/reactnativetracing'; import { NATIVE } from '../../src/js/wrapper'; import type { TestClient } from '../mocks/client'; import { setupTestClient } from '../mocks/client'; @@ -84,30 +84,12 @@ describe('ReactNativeTracing', () => { }); describe('trace propagation targets', () => { - it('uses tracePropagationTargets', () => { - const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); - setupTestClient({ - enableStallTracking: false, - integrations: [ - new ReactNativeTracing({ - tracePropagationTargets: ['test1', 'test2'], - }), - ], - }); - - expect(instrumentOutgoingRequests).toBeCalledWith( - expect.objectContaining({ - tracePropagationTargets: ['test1', 'test2'], - }), - ); - }); - it('uses tracePropagationTargets from client options', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); setupTestClient({ tracePropagationTargets: ['test1', 'test2'], enableStallTracking: false, - integrations: [new ReactNativeTracing({})], + integrations: [reactNativeTracingIntegration()], }); expect(instrumentOutgoingRequests).toBeCalledWith( @@ -121,7 +103,7 @@ describe('ReactNativeTracing', () => { const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); setupTestClient({ enableStallTracking: false, - integrations: [new ReactNativeTracing({})], + integrations: [reactNativeTracingIntegration()], }); expect(instrumentOutgoingRequests).toBeCalledWith( @@ -130,25 +112,6 @@ describe('ReactNativeTracing', () => { }), ); }); - - it('client tracePropagationTargets takes priority over integration options', () => { - const instrumentOutgoingRequests = jest.spyOn(SentryBrowser, 'instrumentOutgoingRequests'); - setupTestClient({ - tracePropagationTargets: ['test1', 'test2'], - enableStallTracking: false, - integrations: [ - new ReactNativeTracing({ - tracePropagationTargets: ['test3', 'test4'], - }), - ], - }); - - expect(instrumentOutgoingRequests).toBeCalledWith( - expect.objectContaining({ - tracePropagationTargets: ['test1', 'test2'], - }), - ); - }); }); describe('Tracing Instrumentation', () => { @@ -161,7 +124,7 @@ describe('ReactNativeTracing', () => { describe('With routing instrumentation', () => { it('Cancels route transaction when app goes to background', async () => { const routingInstrumentation = new RoutingInstrumentation(); - const integration = new ReactNativeTracing({ + const integration = reactNativeTracingIntegration({ routingInstrumentation, }); @@ -191,7 +154,7 @@ describe('ReactNativeTracing', () => { const routingInstrumentation = new RoutingInstrumentation(); setupTestClient({ integrations: [ - new ReactNativeTracing({ + reactNativeTracingIntegration({ routingInstrumentation, }), ], @@ -221,7 +184,7 @@ describe('ReactNativeTracing', () => { describe('_onConfirmRoute', () => { it('Sets app context', async () => { const routing = new RoutingInstrumentation(); - const integration = new ReactNativeTracing({ + const integration = reactNativeTracingIntegration({ routingInstrumentation: routing, }); @@ -243,7 +206,7 @@ describe('ReactNativeTracing', () => { describe('View Names event processor', () => { it('Do not overwrite event app context', () => { const routing = new RoutingInstrumentation(); - const integration = new ReactNativeTracing({ + const integration = reactNativeTracingIntegration({ routingInstrumentation: routing, }); @@ -251,16 +214,15 @@ describe('ReactNativeTracing', () => { const event: Event = { contexts: { app: { appKey: 'value' } } }; const expectedEvent: Event = { contexts: { app: { appKey: 'value', view_names: [expectedRouteName] } } }; - // @ts-expect-error only for testing. - integration._currentViewName = expectedRouteName; - const processedEvent = integration['_getCurrentViewEventProcessor'](event); + integration.state.currentRoute = expectedRouteName; + const processedEvent = integration.processEvent(event, {}, client); expect(processedEvent).toEqual(expectedEvent); }); it('Do not add view_names if context is undefined', () => { const routing = new RoutingInstrumentation(); - const integration = new ReactNativeTracing({ + const integration = reactNativeTracingIntegration({ routingInstrumentation: routing, }); @@ -268,23 +230,22 @@ describe('ReactNativeTracing', () => { const event: Event = { release: 'value' }; const expectedEvent: Event = { release: 'value' }; - // @ts-expect-error only for testing. - integration._currentViewName = expectedRouteName; - const processedEvent = integration['_getCurrentViewEventProcessor'](event); + integration.state.currentRoute = expectedRouteName; + const processedEvent = integration.processEvent(event, {}, client); expect(processedEvent).toEqual(expectedEvent); }); it('ignore view_names if undefined', () => { const routing = new RoutingInstrumentation(); - const integration = new ReactNativeTracing({ + const integration = reactNativeTracingIntegration({ routingInstrumentation: routing, }); const event: Event = { contexts: { app: { key: 'value ' } } }; const expectedEvent: Event = { contexts: { app: { key: 'value ' } } }; - const processedEvent = integration['_getCurrentViewEventProcessor'](event); + const processedEvent = integration.processEvent(event, {}, client); expect(processedEvent).toEqual(expectedEvent); }); diff --git a/test/tracing/reactnavigation.stalltracking.test.ts b/test/tracing/reactnavigation.stalltracking.test.ts index 2c01838016..b3548a98ab 100644 --- a/test/tracing/reactnavigation.stalltracking.test.ts +++ b/test/tracing/reactnavigation.stalltracking.test.ts @@ -5,7 +5,7 @@ jest.mock('../../src/js/tracing/utils', () => ({ import { getCurrentScope, getGlobalScope, getIsolationScope, setCurrentClient, startSpanManual } from '@sentry/core'; -import { ReactNativeTracing, ReactNavigationInstrumentation } from '../../src/js'; +import { reactNativeTracingIntegration, ReactNavigationInstrumentation } from '../../src/js'; import { stallTrackingIntegration } from '../../src/js/tracing/integrations/stalltracking'; import { isNearToNow } from '../../src/js/tracing/utils'; import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; @@ -29,7 +29,7 @@ describe('StallTracking with ReactNavigation', () => { const rnavigation = new ReactNavigationInstrumentation(); mockNavigation = createMockNavigationAndAttachTo(rnavigation); - const rnTracing = new ReactNativeTracing({ + const rnTracing = reactNativeTracingIntegration({ routingInstrumentation: rnavigation, }); diff --git a/test/tracing/reactnavigation.test.ts b/test/tracing/reactnavigation.test.ts index 1ba51d5d3f..55f76b40ac 100644 --- a/test/tracing/reactnavigation.test.ts +++ b/test/tracing/reactnavigation.test.ts @@ -1,8 +1,10 @@ /* eslint-disable deprecation/deprecation */ /* eslint-disable @typescript-eslint/no-explicit-any */ import { getCurrentScope, getGlobalScope, getIsolationScope, SentrySpan, setCurrentClient } from '@sentry/core'; +import type { StartSpanOptions } from '@sentry/types'; -import { ReactNativeTracing } from '../../src/js'; +import { reactNativeTracingIntegration } from '../../src/js'; +import { DEFAULT_NAVIGATION_SPAN_NAME } from '../../src/js/tracing/reactnativetracing'; import type { NavigationRoute } from '../../src/js/tracing/reactnavigation'; import { ReactNavigationInstrumentation } from '../../src/js/tracing/reactnavigation'; import { @@ -17,7 +19,6 @@ import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, } from '../../src/js/tracing/semanticAttributes'; -import type { BeforeNavigate } from '../../src/js/tracing/types'; import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; import { createMockNavigationAndAttachTo } from './reactnavigationutils'; @@ -152,10 +153,11 @@ describe('ReactNavigationInstrumentation', () => { ); }); - test('transaction context changed with beforeNavigate', async () => { + test('start span option changed in before start span callback', async () => { setupTestClient({ - beforeNavigate: span => { - span.updateName('New Span Name'); + beforeSpanStart: startSpanOption => { + startSpanOption.name = 'New Span Name'; + return startSpanOption; }, }); jest.runOnlyPendingTimers(); // Flush the init transaction @@ -295,7 +297,7 @@ describe('ReactNavigationInstrumentation', () => { routeChangeTimeoutMs: 200, }); - const mockTransaction = new SentrySpan({ sampled: true }); + const mockTransaction = new SentrySpan({ sampled: true, name: DEFAULT_NAVIGATION_SPAN_NAME }); const tracingListener = jest.fn(() => mockTransaction); instrumentation.registerRoutingInstrumentation( tracingListener as any, @@ -323,7 +325,7 @@ describe('ReactNavigationInstrumentation', () => { function setupTestClient( setupOptions: { - beforeNavigate?: BeforeNavigate; + beforeSpanStart?: (options: StartSpanOptions) => StartSpanOptions; } = {}, ) { const rNavigation = new ReactNavigationInstrumentation({ @@ -331,14 +333,14 @@ describe('ReactNavigationInstrumentation', () => { }); mockNavigation = createMockNavigationAndAttachTo(rNavigation); - const rnTracing = new ReactNativeTracing({ + const rnTracing = reactNativeTracingIntegration({ routingInstrumentation: rNavigation, - enableStallTracking: false, - enableNativeFramesTracking: false, - beforeNavigate: setupOptions.beforeNavigate, + beforeStartSpan: setupOptions.beforeSpanStart, }); const options = getDefaultTestClientOptions({ + enableNativeFramesTracking: false, + enableStallTracking: false, tracesSampleRate: 1.0, integrations: [rnTracing], enableAppStartTracking: false, diff --git a/test/tracing/reactnavigation.ttid.test.tsx b/test/tracing/reactnavigation.ttid.test.tsx index f82996c6e0..e6743fc7d5 100644 --- a/test/tracing/reactnavigation.ttid.test.tsx +++ b/test/tracing/reactnavigation.ttid.test.tsx @@ -531,10 +531,10 @@ function initSentry(sut: ReactNavigationInstrumentation): { const options: Sentry.ReactNativeOptions = { dsn: MOCK_DSN, enableTracing: true, + enableStallTracking: false, integrations: [ - new Sentry.ReactNativeTracing({ + Sentry.reactNativeTracingIntegration({ routingInstrumentation: sut, - enableStallTracking: false, ignoreEmptyBackNavigationTransactions: true, // default true }), ], From eeb83da07d6726c2285b660ce763eb33bc59b166 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Wed, 14 Aug 2024 09:53:27 +0200 Subject: [PATCH 12/48] fix(tracing): ReactNativeTracing and initial navigation spans have to be created after integrations setup (#4000) --- src/js/tracing/integrations/nativeFrames.ts | 1 - src/js/tracing/reactnativetracing.ts | 21 ++--- test/tracing/reactnativetracing.test.ts | 1 + test/tracing/reactnavigation.test.ts | 85 ++++++++++++++++++++- 4 files changed, 96 insertions(+), 12 deletions(-) diff --git a/src/js/tracing/integrations/nativeFrames.ts b/src/js/tracing/integrations/nativeFrames.ts index 1c00ffddd1..012e2d5349 100644 --- a/src/js/tracing/integrations/nativeFrames.ts +++ b/src/js/tracing/integrations/nativeFrames.ts @@ -73,7 +73,6 @@ export const nativeFramesIntegration = (): Integration => { NATIVE.enableNativeFramesTracking(); - // TODO: Ensure other integrations like ReactNativeTracing and ReactNavigation create spans after all integration are setup. client.on('spanStart', _onSpanStart); client.on('spanEnd', _onSpanFinish); logger.log('[ReactNativeTracing] Native frames instrumentation initialized.'); diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index d9e098d682..d4397c2a77 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -111,6 +111,17 @@ export const reactNativeTracingIntegration = ( }; const setup = (client: Client): void => { + addDefaultOpForSpanFrom(client); + + instrumentOutgoingRequests({ + traceFetch: finalOptions.traceFetch, + traceXHR: finalOptions.traceXHR, + shouldCreateSpanForRequest: finalOptions.shouldCreateSpanForRequest, + tracePropagationTargets: client.getOptions().tracePropagationTargets || DEFAULT_TRACE_PROPAGATION_TARGETS, + }); + }; + + const afterAllSetup = (): void => { if (finalOptions.routingInstrumentation) { const idleNavigationSpanOptions = { finalTimeout: finalOptions.finalTimeoutMs, @@ -139,15 +150,6 @@ export const reactNativeTracingIntegration = ( } else { logger.log(`[${INTEGRATION_NAME}] Not instrumenting route changes as routingInstrumentation has not been set.`); } - - addDefaultOpForSpanFrom(client); - - instrumentOutgoingRequests({ - traceFetch: finalOptions.traceFetch, - traceXHR: finalOptions.traceXHR, - shouldCreateSpanForRequest: finalOptions.shouldCreateSpanForRequest, - tracePropagationTargets: client.getOptions().tracePropagationTargets || DEFAULT_TRACE_PROPAGATION_TARGETS, - }); }; const processEvent = (event: Event): Event => { @@ -160,6 +162,7 @@ export const reactNativeTracingIntegration = ( return { name: INTEGRATION_NAME, setup, + afterAllSetup, processEvent, options: finalOptions, state, diff --git a/test/tracing/reactnativetracing.test.ts b/test/tracing/reactnativetracing.test.ts index 916489b1cc..9b84f14b3d 100644 --- a/test/tracing/reactnativetracing.test.ts +++ b/test/tracing/reactnativetracing.test.ts @@ -129,6 +129,7 @@ describe('ReactNativeTracing', () => { }); integration.setup(client); + integration.afterAllSetup(client); // wait for internal promises to resolve, fetch app start data from mocked native await Promise.resolve(); diff --git a/test/tracing/reactnavigation.test.ts b/test/tracing/reactnavigation.test.ts index 55f76b40ac..9806aa891f 100644 --- a/test/tracing/reactnavigation.test.ts +++ b/test/tracing/reactnavigation.test.ts @@ -1,9 +1,9 @@ /* eslint-disable deprecation/deprecation */ /* eslint-disable @typescript-eslint/no-explicit-any */ import { getCurrentScope, getGlobalScope, getIsolationScope, SentrySpan, setCurrentClient } from '@sentry/core'; -import type { StartSpanOptions } from '@sentry/types'; +import type { Event, Measurements, StartSpanOptions } from '@sentry/types'; -import { reactNativeTracingIntegration } from '../../src/js'; +import { nativeFramesIntegration, reactNativeTracingIntegration } from '../../src/js'; import { DEFAULT_NAVIGATION_SPAN_NAME } from '../../src/js/tracing/reactnativetracing'; import type { NavigationRoute } from '../../src/js/tracing/reactnavigation'; import { ReactNavigationInstrumentation } from '../../src/js/tracing/reactnavigation'; @@ -21,6 +21,7 @@ import { } from '../../src/js/tracing/semanticAttributes'; import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; +import { NATIVE } from '../mockWrapper'; import { createMockNavigationAndAttachTo } from './reactnavigationutils'; const dummyRoute = { @@ -28,6 +29,7 @@ const dummyRoute = { key: '0', }; +jest.mock('../../src/js/wrapper.ts', () => jest.requireActual('../mockWrapper.ts')); jest.useFakeTimers({ advanceTimers: true }); class MockNavigationContainer { @@ -82,6 +84,85 @@ describe('ReactNavigationInstrumentation', () => { ); }); + describe('initial navigation span is created after all integrations are setup', () => { + let rnTracing: ReturnType; + + beforeEach(() => { + const startFrames = { + totalFrames: 100, + slowFrames: 20, + frozenFrames: 5, + }; + const finishFrames = { + totalFrames: 200, + slowFrames: 40, + frozenFrames: 10, + }; + NATIVE.fetchNativeFrames.mockResolvedValueOnce(startFrames).mockResolvedValueOnce(finishFrames); + + const rNavigation = new ReactNavigationInstrumentation({ + routeChangeTimeoutMs: 200, + }); + mockNavigation = createMockNavigationAndAttachTo(rNavigation); + + rnTracing = reactNativeTracingIntegration({ + routingInstrumentation: rNavigation, + }); + }); + + test('initial navigation span contains native frames when nativeFrames integration is after react native tracing', async () => { + const options = getDefaultTestClientOptions({ + enableNativeFramesTracking: true, + enableStallTracking: false, + tracesSampleRate: 1.0, + integrations: [rnTracing, nativeFramesIntegration()], + enableAppStartTracking: false, + }); + client = new TestClient(options); + setCurrentClient(client); + client.init(); + + // Flush the init transaction, must be async to allow for the native start frames to be fetched + await jest.runOnlyPendingTimersAsync(); + await client.flush(); + + expectInitNavigationSpanWithNativeFrames(client.event); + }); + + test('initial navigation span contains native frames when nativeFrames integration is before react native tracing', async () => { + const options = getDefaultTestClientOptions({ + enableNativeFramesTracking: true, + enableStallTracking: false, + tracesSampleRate: 1.0, + integrations: [nativeFramesIntegration(), rnTracing], + enableAppStartTracking: false, + }); + client = new TestClient(options); + setCurrentClient(client); + client.init(); + + // Flush the init transaction, must be async to allow for the native start frames to be fetched + await jest.runOnlyPendingTimersAsync(); + await client.flush(); + + expectInitNavigationSpanWithNativeFrames(client.event); + }); + + function expectInitNavigationSpanWithNativeFrames(event: Event): void { + expect(event).toEqual( + expect.objectContaining({ + type: 'transaction', + transaction: 'Initial Screen', + measurements: expect.objectContaining({ + frames_total: expect.toBeObject(), + frames_slow: expect.toBeObject(), + frames_frozen: expect.toBeObject(), + }), + }), + ); + } + }); + test('transaction sent on navigation', async () => { setupTestClient(); jest.runOnlyPendingTimers(); // Flush the init transaction From 643c544ccadab6c3a62ef0c02c50c0c624da28fd Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Wed, 14 Aug 2024 09:58:05 +0200 Subject: [PATCH 13/48] ref: Navigation Integrations with new function style (#4003) --- CHANGELOG.md | 38 ++ samples/expo/app/_layout.tsx | 9 +- samples/react-native/src/App.tsx | 15 +- src/js/client.ts | 14 - src/js/index.ts | 11 +- src/js/tracing/index.ts | 13 +- src/js/tracing/integrations/appStart.ts | 11 +- src/js/tracing/onSpanEndUtils.ts | 17 +- src/js/tracing/reactnativenavigation.ts | 234 ++++---- src/js/tracing/reactnativetracing.ts | 72 +-- src/js/tracing/reactnavigation.ts | 513 +++++++++--------- src/js/tracing/routingInstrumentation.ts | 81 --- src/js/tracing/span.ts | 71 ++- test/client.test.ts | 25 - test/sdk.test.ts | 9 +- test/tracing/gesturetracing.test.ts | 10 +- test/tracing/idleNavigationSpan.test.ts | 82 +++ .../integrations/userInteraction.test.ts | 15 +- test/tracing/mockedrountinginstrumention.ts | 24 - test/tracing/reactnativenavigation.test.ts | 17 +- test/tracing/reactnativetracing.test.ts | 189 +------ .../reactnavigation.stalltracking.test.ts | 8 +- test/tracing/reactnavigation.test.ts | 58 +- test/tracing/reactnavigation.ttid.test.tsx | 14 +- test/tracing/reactnavigationutils.ts | 4 +- 25 files changed, 681 insertions(+), 873 deletions(-) delete mode 100644 src/js/tracing/routingInstrumentation.ts create mode 100644 test/tracing/idleNavigationSpan.test.ts delete mode 100644 test/tracing/mockedrountinginstrumention.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 607efaadf4..a5fb9c0a08 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -39,6 +39,44 @@ }); ``` +- New React Navigation Integration interface ([#4003](https://github.com/getsentry/sentry-react-native/pull/4003)) + + ```js + import Sentry from '@sentry/react-native'; + import { NavigationContainer } from '@react-navigation/native'; + + const reactNavigationIntegration = Sentry.reactNavigationIntegration(); + + Sentry.init({ + tracesSampleRate: 1.0, + integrations: [reactNavigationIntegration], + }); + + function RootComponent() { + const navigation = React.useRef(null); + + return { + reactNavigationIntegration.registerNavigationContainer(navigation); + }}> + ; + } + ``` + +- New React Native Navigation Integration interface ([#4003](https://github.com/getsentry/sentry-react-native/pull/4003)) + + ```js + import Sentry from '@sentry/react-native'; + import { Navigation } from 'react-native-navigation'; + + Sentry.init({ + tracesSampleRate: 1.0, + integrations: [ + Sentry.reactNativeNavigationIntegration({ navigation: Navigation }) + ], + }); + ``` + ### Features - `TimeToInitialDisplay` and `TimeToFullDisplay` start the time to display spans on mount ([#4020](https://github.com/getsentry/sentry-react-native/pull/4020)) diff --git a/samples/expo/app/_layout.tsx b/samples/expo/app/_layout.tsx index 539dbb0fad..bdb9ed49ca 100644 --- a/samples/expo/app/_layout.tsx +++ b/samples/expo/app/_layout.tsx @@ -21,7 +21,7 @@ LogBox.ignoreAllLogs(); // Prevent the splash screen from auto-hiding before asset loading is complete. SplashScreen.preventAutoHideAsync(); -const routingInstrumentation = new Sentry.ReactNavigationInstrumentation({ +const navigationIntegration = Sentry.reactNavigationIntegration({ enableTimeToInitialDisplay: !isExpoGo(), // This is not supported in Expo Go. }); @@ -54,9 +54,8 @@ process.env.EXPO_SKIP_DURING_EXPORT !== 'true' && Sentry.init({ // default: [/.*/] failedRequestTargets: [/.*/], }), - Sentry.reactNativeTracingIntegration({ - routingInstrumentation, - }), + navigationIntegration, + Sentry.reactNativeTracingIntegration(), ); return integrations.filter(i => i.name !== 'Dedupe'); }, @@ -91,7 +90,7 @@ function RootLayout() { useEffect(() => { if (ref) { - routingInstrumentation.registerNavigationContainer(ref); + navigationIntegration.registerNavigationContainer(ref); } }, [ref]); diff --git a/samples/react-native/src/App.tsx b/samples/react-native/src/App.tsx index 167b404766..0ad4c1e1f6 100644 --- a/samples/react-native/src/App.tsx +++ b/samples/react-native/src/App.tsx @@ -38,11 +38,11 @@ LogBox.ignoreAllLogs(); const isMobileOs = Platform.OS === 'android' || Platform.OS === 'ios'; -const reactNavigationInstrumentation = - new Sentry.ReactNavigationInstrumentation({ - routeChangeTimeoutMs: 500, // How long it will wait for the route change to complete. Default is 1000ms - enableTimeToInitialDisplay: isMobileOs, - }); +const reactNavigationIntegration = Sentry.reactNavigationIntegration({ + routeChangeTimeoutMs: 500, // How long it will wait for the route change to complete. Default is 1000ms + enableTimeToInitialDisplay: isMobileOs, + ignoreEmptyBackNavigationTransactions: true, +}); Sentry.init({ // Replace the example DSN below with your own DSN: @@ -66,11 +66,10 @@ Sentry.init({ }, integrations(integrations) { integrations.push( + reactNavigationIntegration, Sentry.reactNativeTracingIntegration({ // The time to wait in ms until the transaction will be finished, For testing, default is 1000 ms idleTimeoutMs: 5_000, - routingInstrumentation: reactNavigationInstrumentation, - ignoreEmptyBackNavigationTransactions: true, }), Sentry.httpClientIntegration({ // These options are effective only in JS. @@ -183,7 +182,7 @@ function BottomTabs() { { - reactNavigationInstrumentation.registerNavigationContainer(navigation); + reactNavigationIntegration.registerNavigationContainer(navigation); }}> { this._initNativeSdk(); } - /** - * @inheritdoc - */ - protected _setupIntegrations(): void { - super._setupIntegrations(); - const tracing = getReactNativeTracingIntegration(this); - const routingName = tracing?.options?.routingInstrumentation?.name; - if (routingName) { - this.addIntegration(createIntegration(routingName)); - } - } - /** * Starts native client with dsn and options */ diff --git a/src/js/index.ts b/src/js/index.ts index 8854f73716..6b60718744 100644 --- a/src/js/index.ts +++ b/src/js/index.ts @@ -59,15 +59,18 @@ export { TouchEventBoundary, withTouchEventBoundary } from './touchevents'; export { reactNativeTracingIntegration, - ReactNavigationV5Instrumentation, - ReactNavigationInstrumentation, - ReactNativeNavigationInstrumentation, - RoutingInstrumentation, + getCurrentReactNativeTracingIntegration, + getReactNativeTracingIntegration, + reactNavigationIntegration, + reactNativeNavigationIntegration, sentryTraceGesture, TimeToInitialDisplay, TimeToFullDisplay, startTimeToInitialDisplaySpan, startTimeToFullDisplaySpan, + startIdleNavigationSpan, + startIdleSpan, + getDefaultIdleNavigationSpanOptions, } from './tracing'; export type { TimeToDisplayProps } from './tracing'; diff --git a/src/js/tracing/index.ts b/src/js/tracing/index.ts index dc071fe236..446d2b82f5 100644 --- a/src/js/tracing/index.ts +++ b/src/js/tracing/index.ts @@ -1,18 +1,15 @@ export { reactNativeTracingIntegration, INTEGRATION_NAME as REACT_NATIVE_TRACING_INTEGRATION_NAME, + getCurrentReactNativeTracingIntegration, + getReactNativeTracingIntegration, } from './reactnativetracing'; export type { ReactNativeTracingIntegration } from './reactnativetracing'; -export type { RoutingInstrumentationInstance } from './routingInstrumentation'; -export { RoutingInstrumentation } from './routingInstrumentation'; +export { reactNavigationIntegration } from './reactnavigation'; +export { reactNativeNavigationIntegration } from './reactnativenavigation'; -export { - ReactNavigationInstrumentation, - // eslint-disable-next-line deprecation/deprecation - ReactNavigationV5Instrumentation, -} from './reactnavigation'; -export { ReactNativeNavigationInstrumentation } from './reactnativenavigation'; +export { startIdleNavigationSpan, startIdleSpan, getDefaultIdleNavigationSpanOptions } from './span'; export type { ReactNavigationCurrentRoute, ReactNavigationRoute } from './types'; diff --git a/src/js/tracing/integrations/appStart.ts b/src/js/tracing/integrations/appStart.ts index 875507f9c5..3b1365b04c 100644 --- a/src/js/tracing/integrations/appStart.ts +++ b/src/js/tracing/integrations/appStart.ts @@ -22,7 +22,6 @@ import { APP_START_WARM as APP_START_WARM_OP, UI_LOAD as UI_LOAD_OP, } from '../ops'; -import { getReactNativeTracingIntegration } from '../reactnativetracing'; import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '../semanticAttributes'; import { createChildSpanJSON, createSpanJSON, getBundleStartTimestampMs } from '../utils'; @@ -97,7 +96,7 @@ export function _clearRootComponentCreationTimestampMs(): void { * Adds AppStart spans from the native layer to the transaction event. */ export const appStartIntegration = ({ - standalone: standaloneUserOption, + standalone = false, }: { /** * Should the integration send App Start as a standalone root span (transaction)? @@ -108,7 +107,6 @@ export const appStartIntegration = ({ standalone?: boolean; } = {}): AppStartIntegration => { let _client: Client | undefined = undefined; - let standalone = standaloneUserOption; let isEnabled = true; let appStartDataFlushed = false; @@ -123,11 +121,8 @@ export const appStartIntegration = ({ } }; - const afterAllSetup = (client: Client): void => { - if (standaloneUserOption === undefined) { - // If not user defined, set based on the routing instrumentation presence - standalone = !getReactNativeTracingIntegration(client)?.options.routingInstrumentation; - } + const afterAllSetup = (_client: Client): void => { + // TODO: automatically set standalone based on the presence of the native layer navigation integration }; const processEvent = async (event: Event): Promise => { diff --git a/src/js/tracing/onSpanEndUtils.ts b/src/js/tracing/onSpanEndUtils.ts index 90c2acbe06..993d22c40f 100644 --- a/src/js/tracing/onSpanEndUtils.ts +++ b/src/js/tracing/onSpanEndUtils.ts @@ -7,7 +7,7 @@ import { AppState } from 'react-native'; import { isRootSpan, isSentrySpan } from '../utils/span'; /** - * + * Hooks on span end event to execute a callback when the span ends. */ export function onThisSpanEnd(client: Client, span: Span, callback: (span: Span) => void): void { client.on('spanEnd', (endedSpan: Span) => { @@ -44,7 +44,18 @@ export const adjustTransactionDuration = (client: Client, span: Span, maxDuratio } }); }; -export const ignoreEmptyBackNavigation = (client: Client, span: Span): void => { + +export const ignoreEmptyBackNavigation = (client: Client | undefined, span: Span): void => { + if (!client) { + logger.warn('Could not hook on spanEnd event because client is not defined.'); + return; + } + + if (!span) { + logger.warn('Could not hook on spanEnd event because span is not defined.'); + return; + } + if (!isRootSpan(span) || !isSentrySpan(span)) { logger.warn('Not sampling empty back spans only works for Sentry Transactions (Root Spans).'); return; @@ -70,7 +81,7 @@ export const ignoreEmptyBackNavigation = (client: Client, span: Span): void => { if (filtered.length <= 0) { // filter children must include at least one span not created by the navigation automatic instrumentation logger.log( - '[ReactNativeTracing] Not sampling transaction as route has been seen before. Pass ignoreEmptyBackNavigationTransactions = false to disable this feature.', + 'Not sampling transaction as route has been seen before. Pass ignoreEmptyBackNavigationTransactions = false to disable this feature.', ); // Route has been seen before and has no child spans. span['_sampled'] = false; diff --git a/src/js/tracing/reactnativenavigation.ts b/src/js/tracing/reactnativenavigation.ts index b07d6caff2..3f0378d96e 100644 --- a/src/js/tracing/reactnativenavigation.ts +++ b/src/js/tracing/reactnativenavigation.ts @@ -1,40 +1,61 @@ import { addBreadcrumb, + getClient, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON, } from '@sentry/core'; -import type { Span } from '@sentry/types'; +import type { Client, Integration, Span } from '@sentry/types'; import type { EmitterSubscription } from '../utils/rnlibrariesinterface'; import { isSentrySpan } from '../utils/span'; -import { DEFAULT_NAVIGATION_SPAN_NAME } from './reactnativetracing'; -import type { OnConfirmRoute, TransactionCreator } from './routingInstrumentation'; -import { InternalRoutingInstrumentation } from './routingInstrumentation'; -import type { BeforeNavigate } from './types'; +import { ignoreEmptyBackNavigation } from './onSpanEndUtils'; +import type { ReactNativeTracingIntegration } from './reactnativetracing'; +import { getReactNativeTracingIntegration } from './reactnativetracing'; +import { + DEFAULT_NAVIGATION_SPAN_NAME, + defaultIdleOptions, + getDefaultIdleNavigationSpanOptions, + startIdleNavigationSpan as startGenericIdleNavigationSpan, +} from './span'; + +export const INTEGRATION_NAME = 'ReactNativeNavigation'; + +const NAVIGATION_HISTORY_MAX_SIZE = 200; interface ReactNativeNavigationOptions { /** * How long the instrumentation will wait for the route to mount after a change has been initiated, * before the transaction is discarded. - * Time is in ms. * - * Default: 1000 + * @default 1_000 (ms) */ - routeChangeTimeoutMs: number; + routeChangeTimeoutMs?: number; + /** * Instrumentation will create a transaction on tab change. * By default only navigation commands create transactions. * - * Default: true + * @default false */ - enableTabsInstrumentation: boolean; -} + enableTabsInstrumentation?: boolean; -const defaultOptions: ReactNativeNavigationOptions = { - routeChangeTimeoutMs: 1000, - enableTabsInstrumentation: true, -}; + /** + * Does not sample transactions that are from routes that have been seen any more and don't have any spans. + * This removes a lot of the clutter as most back navigation transactions are now ignored. + * + * @default true + */ + ignoreEmptyBackNavigationTransactions?: boolean; + + /** The React Native Navigation `NavigationDelegate`. + * + * ```js + * import { Navigation } from 'react-native-navigation'; + * ``` + */ + navigation: unknown; +} interface ComponentEvent { componentId: string; @@ -74,142 +95,135 @@ export interface NavigationDelegate { * - `_onComponentWillAppear` is then called AFTER the state change happens due to a dispatch and sets the route context onto the active transaction. * - If `_onComponentWillAppear` isn't called within `options.routeChangeTimeoutMs` of the dispatch, then the transaction is not sampled and finished. */ -export class ReactNativeNavigationInstrumentation extends InternalRoutingInstrumentation { - public static instrumentationName: string = 'react-native-navigation'; - - public readonly name: string = ReactNativeNavigationInstrumentation.instrumentationName; - - private _navigation: NavigationDelegate; - private _options: ReactNativeNavigationOptions; - - private _prevComponentEvent: ComponentWillAppearEvent | null = null; - - private _latestTransaction?: Span; - private _recentComponentIds: string[] = []; - private _stateChangeTimeout?: number | undefined; - - public constructor( - /** The react native navigation `NavigationDelegate`. This is usually the import named `Navigation`. */ - navigation: unknown, - options: Partial = {}, - ) { - super(); - - this._navigation = navigation as NavigationDelegate; - - this._options = { - ...defaultOptions, - ...options, - }; - } - - /** - * Registers the event listeners for React Native Navigation - */ - public registerRoutingInstrumentation( - listener: TransactionCreator, - beforeNavigate: BeforeNavigate, - onConfirmRoute: OnConfirmRoute, - ): void { - super.registerRoutingInstrumentation(listener, beforeNavigate, onConfirmRoute); - - this._navigation.events().registerCommandListener(this._onNavigation.bind(this)); - - if (this._options.enableTabsInstrumentation) { - this._navigation.events().registerBottomTabPressedListener(this._onNavigation.bind(this)); +export const reactNativeNavigationIntegration = ({ + navigation: optionsNavigation, + routeChangeTimeoutMs = 1_000, + enableTabsInstrumentation = false, + ignoreEmptyBackNavigationTransactions = true, +}: ReactNativeNavigationOptions): Integration => { + const navigation = optionsNavigation as NavigationDelegate; + let recentComponentIds: string[] = []; + + let tracing: ReactNativeTracingIntegration | undefined; + let idleSpanOptions: Parameters[1] = defaultIdleOptions; + + let stateChangeTimeout: ReturnType | undefined; + let prevComponentEvent: ComponentWillAppearEvent | null = null; + let latestNavigationSpan: Span | undefined; + + const afterAllSetup = (client: Client): void => { + tracing = getReactNativeTracingIntegration(client); + if (tracing) { + idleSpanOptions = { + finalTimeout: tracing.options.finalTimeoutMs, + idleTimeout: tracing.options.idleTimeoutMs, + }; } + }; - this._navigation.events().registerComponentWillAppearListener(this._onComponentWillAppear.bind(this)); - } - - /** - * To be called when a navigation is initiated. (Command, BottomTabSelected, etc.) - */ - private _onNavigation(): void { - if (this._latestTransaction) { - this._discardLatestTransaction(); + const startIdleNavigationSpan = (): void => { + if (latestNavigationSpan) { + discardLatestNavigationSpan(); } - this._latestTransaction = this.onRouteWillChange({ name: DEFAULT_NAVIGATION_SPAN_NAME }); - - this._stateChangeTimeout = setTimeout( - this._discardLatestTransaction.bind(this), - this._options.routeChangeTimeoutMs, + latestNavigationSpan = startGenericIdleNavigationSpan( + tracing && tracing.options.beforeStartSpan + ? tracing.options.beforeStartSpan(getDefaultIdleNavigationSpanOptions()) + : getDefaultIdleNavigationSpanOptions(), + idleSpanOptions, ); - } + if (ignoreEmptyBackNavigationTransactions) { + ignoreEmptyBackNavigation(getClient(), latestNavigationSpan); + } - /** - * To be called AFTER the state has been changed to populate the transaction with the current route. - */ - private _onComponentWillAppear(event: ComponentWillAppearEvent): void { - if (!this._latestTransaction) { + stateChangeTimeout = setTimeout(discardLatestNavigationSpan.bind(this), routeChangeTimeoutMs); + }; + + const updateLatestNavigationSpanWithCurrentComponent = (event: ComponentWillAppearEvent): void => { + if (!latestNavigationSpan) { return; } // We ignore actions that pertain to the same screen. - const isSameComponent = this._prevComponentEvent && event.componentId === this._prevComponentEvent.componentId; + const isSameComponent = prevComponentEvent && event.componentId === prevComponentEvent.componentId; if (isSameComponent) { - this._discardLatestTransaction(); + discardLatestNavigationSpan(); return; } - this._clearStateChangeTimeout(); + clearStateChangeTimeout(); - const routeHasBeenSeen = this._recentComponentIds.includes(event.componentId); + const routeHasBeenSeen = recentComponentIds.includes(event.componentId); - if (spanToJSON(this._latestTransaction).description === DEFAULT_NAVIGATION_SPAN_NAME) { - this._latestTransaction.updateName(event.componentName); + if (spanToJSON(latestNavigationSpan).description === DEFAULT_NAVIGATION_SPAN_NAME) { + latestNavigationSpan.updateName(event.componentName); } - this._latestTransaction.setAttributes({ + latestNavigationSpan.setAttributes({ // TODO: Should we include pass props? I don't know exactly what it contains, cant find it in the RNavigation docs 'route.name': event.componentName, 'route.component_id': event.componentId, 'route.component_type': event.componentType, 'route.has_been_seen': routeHasBeenSeen, - 'previous_route.name': this._prevComponentEvent?.componentName, - 'previous_route.component_id': this._prevComponentEvent?.componentId, - 'previous_route.component_type': this._prevComponentEvent?.componentType, + 'previous_route.name': prevComponentEvent?.componentName, + 'previous_route.component_id': prevComponentEvent?.componentId, + 'previous_route.component_type': prevComponentEvent?.componentType, [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', }); - this._beforeNavigate?.(this._latestTransaction); - - this._onConfirmRoute?.(event.componentName); + tracing?.setCurrentRoute(event.componentName); addBreadcrumb({ category: 'navigation', type: 'navigation', message: `Navigation to ${event.componentName}`, data: { - from: this._prevComponentEvent?.componentName, + from: prevComponentEvent?.componentName, to: event.componentName, }, }); - this._prevComponentEvent = event; - this._latestTransaction = undefined; + pushRecentComponentId(event.componentId); + prevComponentEvent = event; + latestNavigationSpan = undefined; + }; + + navigation.events().registerCommandListener(startIdleNavigationSpan); + if (enableTabsInstrumentation) { + navigation.events().registerBottomTabPressedListener(startIdleNavigationSpan); } + navigation.events().registerComponentWillAppearListener(updateLatestNavigationSpanWithCurrentComponent); + + const pushRecentComponentId = (id: string): void => { + recentComponentIds.push(id); + + if (recentComponentIds.length > NAVIGATION_HISTORY_MAX_SIZE) { + recentComponentIds = recentComponentIds.slice(recentComponentIds.length - NAVIGATION_HISTORY_MAX_SIZE); + } + }; - /** Cancels the latest transaction so it does not get sent to Sentry. */ - private _discardLatestTransaction(): void { - if (this._latestTransaction) { - if (isSentrySpan(this._latestTransaction)) { - this._latestTransaction['_sampled'] = false; + const discardLatestNavigationSpan = (): void => { + if (latestNavigationSpan) { + if (isSentrySpan(latestNavigationSpan)) { + latestNavigationSpan['_sampled'] = false; } // TODO: What if it's not SentrySpan? - this._latestTransaction.end(); - this._latestTransaction = undefined; + latestNavigationSpan.end(); + latestNavigationSpan = undefined; } - this._clearStateChangeTimeout(); - } + clearStateChangeTimeout(); + }; - /** Cancels the latest transaction so it does not get sent to Sentry. */ - private _clearStateChangeTimeout(): void { - if (typeof this._stateChangeTimeout !== 'undefined') { - clearTimeout(this._stateChangeTimeout); - this._stateChangeTimeout = undefined; + const clearStateChangeTimeout = (): void => { + if (typeof stateChangeTimeout !== 'undefined') { + clearTimeout(stateChangeTimeout); + stateChangeTimeout = undefined; } - } -} + }; + + return { + name: INTEGRATION_NAME, + afterAllSetup, + }; +}; diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index d4397c2a77..7e66b5d30a 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -1,11 +1,9 @@ /* eslint-disable max-lines */ import { instrumentOutgoingRequests } from '@sentry/browser'; -import { getClient, getCurrentScope } from '@sentry/core'; +import { getClient } from '@sentry/core'; import type { Client, Event, Integration, StartSpanOptions } from '@sentry/types'; -import { logger } from '@sentry/utils'; -import type { RoutingInstrumentationInstance } from './routingInstrumentation'; -import { addDefaultOpForSpanFrom, startIdleNavigationSpan } from './span'; +import { addDefaultOpForSpanFrom, defaultIdleOptions } from './span'; export const INTEGRATION_NAME = 'ReactNativeTracing'; @@ -16,7 +14,7 @@ export interface ReactNativeTracingOptions { * * @default 1_000 (ms) */ - idleTimeoutMs: number; + idleTimeoutMs?: number; /** * The max. time an idle span may run. @@ -24,7 +22,7 @@ export interface ReactNativeTracingOptions { * * @default 60_0000 (ms) */ - finalTimeoutMs: number; + finalTimeoutMs?: number; /** * Flag to disable patching all together for fetch requests. @@ -47,20 +45,6 @@ export interface ReactNativeTracingOptions { */ enableHTTPTimings: boolean; - /** - * The routing instrumentation to be used with the tracing integration. - * There is no routing instrumentation if nothing is passed. - */ - routingInstrumentation?: RoutingInstrumentationInstance; - - /** - * Does not sample transactions that are from routes that have been seen any more and don't have any spans. - * This removes a lot of the clutter as most back navigation transactions are now ignored. - * - * @default true - */ - ignoreEmptyBackNavigationTransactions: boolean; - /** * A callback which is called before a span for a navigation is started. * It receives the options passed to `startSpan`, and expects to return an updated options object. @@ -77,18 +61,14 @@ export interface ReactNativeTracingOptions { } const DEFAULT_TRACE_PROPAGATION_TARGETS = ['localhost', /^\/(?!\/)/]; -export const DEFAULT_NAVIGATION_SPAN_NAME = 'Route Change'; -const defaultReactNativeTracingOptions: ReactNativeTracingOptions = { - idleTimeoutMs: 1_000, - finalTimeoutMs: 60_0000, +export const defaultReactNativeTracingOptions: ReactNativeTracingOptions = { traceFetch: true, traceXHR: true, enableHTTPTimings: true, - ignoreEmptyBackNavigationTransactions: true, }; -type ReactNativeTracingState = { +export type ReactNativeTracingState = { currentRoute: string | undefined; }; @@ -97,6 +77,7 @@ export const reactNativeTracingIntegration = ( ): Integration & { options: ReactNativeTracingOptions; state: ReactNativeTracingState; + setCurrentRoute: (route: string) => void; } => { const state: ReactNativeTracingState = { currentRoute: undefined, @@ -106,8 +87,8 @@ export const reactNativeTracingIntegration = ( ...defaultReactNativeTracingOptions, ...options, beforeStartSpan: options.beforeStartSpan ?? ((options: StartSpanOptions) => options), - finalTimeoutMs: options.finalTimeoutMs ?? defaultReactNativeTracingOptions.finalTimeoutMs, - idleTimeoutMs: options.idleTimeoutMs ?? defaultReactNativeTracingOptions.idleTimeoutMs, + finalTimeoutMs: options.finalTimeoutMs ?? defaultIdleOptions.finalTimeout, + idleTimeoutMs: options.idleTimeoutMs ?? defaultIdleOptions.idleTimeout, }; const setup = (client: Client): void => { @@ -121,37 +102,6 @@ export const reactNativeTracingIntegration = ( }); }; - const afterAllSetup = (): void => { - if (finalOptions.routingInstrumentation) { - const idleNavigationSpanOptions = { - finalTimeout: finalOptions.finalTimeoutMs, - idleTimeout: finalOptions.idleTimeoutMs, - ignoreEmptyBackNavigationTransactions: finalOptions.ignoreEmptyBackNavigationTransactions, - }; - finalOptions.routingInstrumentation.registerRoutingInstrumentation( - navigationInstrumentationOptions => - startIdleNavigationSpan( - finalOptions.beforeStartSpan({ - name: DEFAULT_NAVIGATION_SPAN_NAME, - op: 'navigation', - forceTransaction: true, - scope: getCurrentScope(), - ...navigationInstrumentationOptions, - }), - idleNavigationSpanOptions, - ), - () => { - // no-op, replaced by beforeStartSpan, will be removed in the future - }, - (currentViewName: string | undefined) => { - state.currentRoute = currentViewName; - }, - ); - } else { - logger.log(`[${INTEGRATION_NAME}] Not instrumenting route changes as routingInstrumentation has not been set.`); - } - }; - const processEvent = (event: Event): Event => { if (event.contexts && state.currentRoute) { event.contexts.app = { view_names: [state.currentRoute], ...event.contexts.app }; @@ -162,10 +112,12 @@ export const reactNativeTracingIntegration = ( return { name: INTEGRATION_NAME, setup, - afterAllSetup, processEvent, options: finalOptions, state, + setCurrentRoute: (route: string) => { + state.currentRoute = route; + }, }; }; diff --git a/src/js/tracing/reactnavigation.ts b/src/js/tracing/reactnavigation.ts index fbe460b9e3..7948af888b 100644 --- a/src/js/tracing/reactnavigation.ts +++ b/src/js/tracing/reactnavigation.ts @@ -2,46 +2,43 @@ import { addBreadcrumb, getActiveSpan, + getClient, SEMANTIC_ATTRIBUTE_SENTRY_OP, SPAN_STATUS_OK, spanToJSON, startInactiveSpan, } from '@sentry/core'; -import type { Span } from '@sentry/types'; -import { logger, timestampInSeconds } from '@sentry/utils'; +import type { Client, Integration, Span } from '@sentry/types'; +import { isPlainObject, logger, timestampInSeconds } from '@sentry/utils'; import type { NewFrameEvent } from '../utils/sentryeventemitter'; import { type SentryEventEmitter, createSentryEventEmitter, NewFrameEventName } from '../utils/sentryeventemitter'; import { isSentrySpan } from '../utils/span'; import { RN_GLOBAL_OBJ } from '../utils/worldwide'; import { NATIVE } from '../wrapper'; -import { DEFAULT_NAVIGATION_SPAN_NAME } from './reactnativetracing'; -import type { OnConfirmRoute, TransactionCreator } from './routingInstrumentation'; -import { InternalRoutingInstrumentation } from './routingInstrumentation'; +import { ignoreEmptyBackNavigation } from './onSpanEndUtils'; +import type { ReactNativeTracingIntegration } from './reactnativetracing'; +import { getReactNativeTracingIntegration } from './reactnativetracing'; import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from './semanticAttributes'; +import { + DEFAULT_NAVIGATION_SPAN_NAME, + defaultIdleOptions, + getDefaultIdleNavigationSpanOptions, + startIdleNavigationSpan as startGenericIdleNavigationSpan, +} from './span'; import { manualInitialDisplaySpans, startTimeToInitialDisplaySpan } from './timetodisplay'; -import type { BeforeNavigate } from './types'; import { setSpanDurationAsMeasurementOnSpan } from './utils'; -export interface NavigationRoute { - name: string; - key: string; - // eslint-disable-next-line @typescript-eslint/no-explicit-any - params?: Record; -} +export const INTEGRATION_NAME = 'ReactNavigation'; -interface NavigationContainer { - addListener: (type: string, listener: () => void) => void; - getCurrentRoute: () => NavigationRoute; -} +const NAVIGATION_HISTORY_MAX_SIZE = 200; -interface ReactNavigationOptions { +interface ReactNavigationIntegrationOptions { /** * How long the instrumentation will wait for the route to mount after a change has been initiated, * before the transaction is discarded. - * Time is in ms. * - * @default 1000 + * @default 1_000 (ms) */ routeChangeTimeoutMs: number; @@ -52,12 +49,15 @@ interface ReactNavigationOptions { * @default false */ enableTimeToInitialDisplay: boolean; -} -const defaultOptions: ReactNavigationOptions = { - routeChangeTimeoutMs: 1000, - enableTimeToInitialDisplay: false, -}; + /** + * Does not sample transactions that are from routes that have been seen any more and don't have any spans. + * This removes a lot of the clutter as most back navigation transactions are now ignored. + * + * @default true + */ + ignoreEmptyBackNavigationTransactions: boolean; +} /** * Instrumentation for React-Navigation V5 and above. See docs or sample app for usage. @@ -67,293 +67,294 @@ const defaultOptions: ReactNavigationOptions = { * - `_onStateChange` is then called AFTER the state change happens due to a dispatch and sets the route context onto the active transaction. * - If `_onStateChange` isn't called within `STATE_CHANGE_TIMEOUT_DURATION` of the dispatch, then the transaction is not sampled and finished. */ -export class ReactNavigationInstrumentation extends InternalRoutingInstrumentation { - public static instrumentationName: string = 'react-navigation-v5'; - - public readonly name: string = ReactNavigationInstrumentation.instrumentationName; - - private _navigationContainer: NavigationContainer | null = null; - private _newScreenFrameEventEmitter: SentryEventEmitter | null = null; - - private readonly _maxRecentRouteLen: number = 200; - - private _latestRoute?: NavigationRoute; - private _latestTransaction?: Span; - private _navigationProcessingSpan?: Span; - - private _initialStateHandled: boolean = false; - private _stateChangeTimeout?: number | undefined; - private _recentRouteKeys: string[] = []; +export const reactNavigationIntegration = ({ + routeChangeTimeoutMs = 1_000, + enableTimeToInitialDisplay = false, + ignoreEmptyBackNavigationTransactions = true, +}: Partial = {}): Integration & { + /** + * Pass the ref to the navigation container to register it to the instrumentation + * @param navigationContainerRef Ref to a `NavigationContainer` + */ + registerNavigationContainer: (navigationContainerRef: unknown) => void; +} => { + let navigationContainer: NavigationContainer | undefined; + let newScreenFrameEventEmitter: SentryEventEmitter | undefined; + + let tracing: ReactNativeTracingIntegration | undefined; + let idleSpanOptions: Parameters[1] = defaultIdleOptions; + let latestRoute: NavigationRoute | undefined; + + let latestNavigationSpan: Span | undefined; + let navigationProcessingSpan: Span | undefined; + + let initialStateHandled: boolean = false; + let stateChangeTimeout: ReturnType | undefined; + let recentRouteKeys: string[] = []; + + if (enableTimeToInitialDisplay) { + newScreenFrameEventEmitter = createSentryEventEmitter(); + newScreenFrameEventEmitter.initAsync(NewFrameEventName); + NATIVE.initNativeReactNavigationNewFrameTracking().catch((reason: unknown) => { + logger.error(`${INTEGRATION_NAME} Failed to initialize native new frame tracking: ${reason}`); + }); + } - private _options: ReactNavigationOptions; + /** + * Set the initial state and start initial navigation span for the current screen. + */ + const afterAllSetup = (client: Client): void => { + tracing = getReactNativeTracingIntegration(client); + if (tracing) { + idleSpanOptions = { + finalTimeout: tracing.options.finalTimeoutMs, + idleTimeout: tracing.options.idleTimeoutMs, + }; + } - public constructor(options: Partial = {}) { - super(); + if (initialStateHandled) { + // We create an initial state here to ensure a transaction gets created before the first route mounts. + return undefined; + } - this._options = { - ...defaultOptions, - ...options, - }; + startIdleNavigationSpan(); - if (this._options.enableTimeToInitialDisplay) { - this._newScreenFrameEventEmitter = createSentryEventEmitter(); - this._newScreenFrameEventEmitter.initAsync(NewFrameEventName); - NATIVE.initNativeReactNavigationNewFrameTracking().catch((reason: unknown) => { - logger.error(`[ReactNavigationInstrumentation] Failed to initialize native new frame tracking: ${reason}`); - }); + if (!navigationContainer) { + // This is expected as navigation container is registered after the root component is mounted. + return undefined; } - } - /** - * Extends by calling _handleInitialState at the end. - */ - public registerRoutingInstrumentation( - listener: TransactionCreator, - beforeNavigate: BeforeNavigate, - onConfirmRoute: OnConfirmRoute, - ): void { - super.registerRoutingInstrumentation(listener, beforeNavigate, onConfirmRoute); - - // We create an initial state here to ensure a transaction gets created before the first route mounts. - if (!this._initialStateHandled) { - this._onDispatch(); - if (this._navigationContainer) { - // Navigation container already registered, just populate with route state - this._onStateChange(); - - this._initialStateHandled = true; - } - } - } + // Navigation container already registered, just populate with route state + updateLatestNavigationSpanWithCurrentRoute(); + initialStateHandled = true; + }; - /** - * Pass the ref to the navigation container to register it to the instrumentation - * @param navigationContainerRef Ref to a `NavigationContainer` - */ - // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types - public registerNavigationContainer(navigationContainerRef: any): void { + const registerNavigationContainer = (navigationContainerRef: unknown): void => { /* We prevent duplicate routing instrumentation to be initialized on fast refreshes Explanation: If the user triggers a fast refresh on the file that the instrumentation is initialized in, it will initialize a new instance and will cause undefined behavior. */ - if (!RN_GLOBAL_OBJ.__sentry_rn_v5_registered) { - if ('current' in navigationContainerRef) { - // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access - this._navigationContainer = navigationContainerRef.current; - } else { - this._navigationContainer = navigationContainerRef; - } - - if (this._navigationContainer) { - this._navigationContainer.addListener( - '__unsafe_action__', // This action is emitted on every dispatch - this._onDispatch.bind(this), - ); - this._navigationContainer.addListener( - 'state', // This action is emitted on every state change - this._onStateChange.bind(this), - ); - - if (!this._initialStateHandled) { - if (this._latestTransaction) { - // If registerRoutingInstrumentation was called first _onDispatch has already been called - this._onStateChange(); - - this._initialStateHandled = true; - } else { - logger.log( - '[ReactNavigationInstrumentation] Navigation container registered, but integration has not been setup yet.', - ); - } - } - - RN_GLOBAL_OBJ.__sentry_rn_v5_registered = true; - } else { - logger.warn('[ReactNavigationInstrumentation] Received invalid navigation container ref!'); - } - } else { + if (RN_GLOBAL_OBJ.__sentry_rn_v5_registered) { logger.log( - '[ReactNavigationInstrumentation] Instrumentation already exists, but register has been called again, doing nothing.', + `${INTEGRATION_NAME} Instrumentation already exists, but register has been called again, doing nothing.`, ); + return undefined; + } + + if (isPlainObject(navigationContainerRef) && 'current' in navigationContainerRef) { + navigationContainer = navigationContainerRef.current as NavigationContainer; + } else { + navigationContainer = navigationContainerRef as NavigationContainer; + } + if (!navigationContainer) { + logger.warn(`${INTEGRATION_NAME} Received invalid navigation container ref!`); + return undefined; + } + + // This action is emitted on every dispatch + navigationContainer.addListener('__unsafe_action__', startIdleNavigationSpan); + navigationContainer.addListener('state', updateLatestNavigationSpanWithCurrentRoute); + RN_GLOBAL_OBJ.__sentry_rn_v5_registered = true; + + if (initialStateHandled) { + return undefined; + } + + if (!latestNavigationSpan) { + logger.log(`${INTEGRATION_NAME} Navigation container registered, but integration has not been setup yet.`); + return undefined; } - } + + // Navigation Container is registered after the first navigation + // Initial navigation span was started, after integration setup, + // so now we populate it with the current route. + updateLatestNavigationSpanWithCurrentRoute(); + initialStateHandled = true; + }; /** * To be called on every React-Navigation action dispatch. * It does not name the transaction or populate it with route information. Instead, it waits for the state to fully change - * and gets the route information from there, @see _onStateChange + * and gets the route information from there, @see updateLatestNavigationSpanWithCurrentRoute */ - private _onDispatch(): void { - if (this._latestTransaction) { - logger.log( - '[ReactNavigationInstrumentation] A transaction was detected that turned out to be a noop, discarding.', - ); - this._discardLatestTransaction(); - this._clearStateChangeTimeout(); + const startIdleNavigationSpan = (): void => { + if (latestNavigationSpan) { + logger.log(`${INTEGRATION_NAME} A transaction was detected that turned out to be a noop, discarding.`); + _discardLatestTransaction(); + clearStateChangeTimeout(); } - this._latestTransaction = this.onRouteWillChange({ name: DEFAULT_NAVIGATION_SPAN_NAME }); + latestNavigationSpan = startGenericIdleNavigationSpan( + tracing && tracing.options.beforeStartSpan + ? tracing.options.beforeStartSpan(getDefaultIdleNavigationSpanOptions()) + : getDefaultIdleNavigationSpanOptions(), + idleSpanOptions, + ); + if (ignoreEmptyBackNavigationTransactions) { + ignoreEmptyBackNavigation(getClient(), latestNavigationSpan); + } - if (this._options.enableTimeToInitialDisplay) { - this._navigationProcessingSpan = startInactiveSpan({ + if (enableTimeToInitialDisplay) { + navigationProcessingSpan = startInactiveSpan({ op: 'navigation.processing', name: 'Navigation processing', - startTime: this._latestTransaction && spanToJSON(this._latestTransaction).start_timestamp, + startTime: latestNavigationSpan && spanToJSON(latestNavigationSpan).start_timestamp, }); } - this._stateChangeTimeout = setTimeout( - this._discardLatestTransaction.bind(this), - this._options.routeChangeTimeoutMs, - ); - } + stateChangeTimeout = setTimeout(_discardLatestTransaction, routeChangeTimeoutMs); + }; /** * To be called AFTER the state has been changed to populate the transaction with the current route. */ - private _onStateChange(): void { + const updateLatestNavigationSpanWithCurrentRoute = (): void => { const stateChangedTimestamp = timestampInSeconds(); + const previousRoute = latestRoute; - // Use the getCurrentRoute method to be accurate. - const previousRoute = this._latestRoute; + if (!navigationContainer) { + logger.warn(`${INTEGRATION_NAME} Missing navigation container ref. Route transactions will not be sent.`); + return undefined; + } - if (!this._navigationContainer) { - logger.warn( - '[ReactNavigationInstrumentation] Missing navigation container ref. Route transactions will not be sent.', + const route = navigationContainer.getCurrentRoute(); + if (!route) { + logger.debug(`[${INTEGRATION_NAME}] Navigation state changed, but no route is rendered.`); + return undefined; + } + + if (!latestNavigationSpan) { + logger.debug( + `[${INTEGRATION_NAME}] Navigation state changed, but navigation transaction was not started on dispatch.`, ); + return undefined; + } - return; + if (previousRoute && previousRoute.key === route.key) { + logger.debug(`[${INTEGRATION_NAME}] Navigation state changed, but route is the same as previous.`); + pushRecentRouteKey(route.key); + latestRoute = route; + + // Clear the latest transaction as it has been handled. + latestNavigationSpan = undefined; + return undefined; } - const route = this._navigationContainer.getCurrentRoute(); - - if (route) { - if (this._latestTransaction) { - if (!previousRoute || previousRoute.key !== route.key) { - const routeHasBeenSeen = this._recentRouteKeys.includes(route.key); - const latestTransaction = this._latestTransaction; - const latestTtidSpan = - !routeHasBeenSeen && - this._options.enableTimeToInitialDisplay && - startTimeToInitialDisplaySpan({ - name: `${route.name} initial display`, - isAutoInstrumented: true, - }); - - !routeHasBeenSeen && - latestTtidSpan && - this._newScreenFrameEventEmitter?.once( - NewFrameEventName, - ({ newFrameTimestampInSeconds }: NewFrameEvent) => { - const activeSpan = getActiveSpan(); - if (activeSpan && manualInitialDisplaySpans.has(activeSpan)) { - logger.warn( - '[ReactNavigationInstrumentation] Detected manual instrumentation for the current active span.', - ); - return; - } - - latestTtidSpan.setStatus({ code: SPAN_STATUS_OK }); - latestTtidSpan.end(newFrameTimestampInSeconds); - setSpanDurationAsMeasurementOnSpan('time_to_initial_display', latestTtidSpan, latestTransaction); - }, - ); - - this._navigationProcessingSpan?.updateName(`Processing navigation to ${route.name}`); - this._navigationProcessingSpan?.setStatus({ code: SPAN_STATUS_OK }); - this._navigationProcessingSpan?.end(stateChangedTimestamp); - this._navigationProcessingSpan = undefined; - - if (spanToJSON(this._latestTransaction).description === DEFAULT_NAVIGATION_SPAN_NAME) { - this._latestTransaction.updateName(route.name); - } - this._latestTransaction.setAttributes({ - 'route.name': route.name, - 'route.key': route.key, - // TODO: filter PII params instead of dropping them all - // 'route.params': {}, - 'route.has_been_seen': routeHasBeenSeen, - 'previous_route.name': previousRoute?.name, - 'previous_route.key': previousRoute?.key, - // TODO: filter PII params instead of dropping them all - // 'previous_route.params': {}, - [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', - [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', - }); - - // Clear the timeout so the transaction does not get cancelled. - this._clearStateChangeTimeout(); - - this._onConfirmRoute?.(route.name); - - // TODO: Add test for addBreadcrumb - addBreadcrumb({ - category: 'navigation', - type: 'navigation', - message: `Navigation to ${route.name}`, - data: { - from: previousRoute?.name, - to: route.name, - }, - }); + const routeHasBeenSeen = recentRouteKeys.includes(route.key); + + const latestTtidSpan = + !routeHasBeenSeen && + enableTimeToInitialDisplay && + startTimeToInitialDisplaySpan({ + name: `${route.name} initial display`, + isAutoInstrumented: true, + }); + + const navigationSpanWithTtid = latestNavigationSpan; + !routeHasBeenSeen && + latestTtidSpan && + newScreenFrameEventEmitter?.once(NewFrameEventName, ({ newFrameTimestampInSeconds }: NewFrameEvent) => { + const activeSpan = getActiveSpan(); + if (activeSpan && manualInitialDisplaySpans.has(activeSpan)) { + logger.warn('[ReactNavigationInstrumentation] Detected manual instrumentation for the current active span.'); + return; } - this._pushRecentRouteKey(route.key); - this._latestRoute = route; + latestTtidSpan.setStatus({ code: SPAN_STATUS_OK }); + latestTtidSpan.end(newFrameTimestampInSeconds); + setSpanDurationAsMeasurementOnSpan('time_to_initial_display', latestTtidSpan, navigationSpanWithTtid); + }); - // Clear the latest transaction as it has been handled. - this._latestTransaction = undefined; - } + navigationProcessingSpan?.updateName(`Processing navigation to ${route.name}`); + navigationProcessingSpan?.setStatus({ code: SPAN_STATUS_OK }); + navigationProcessingSpan?.end(stateChangedTimestamp); + navigationProcessingSpan = undefined; + + if (spanToJSON(latestNavigationSpan).description === DEFAULT_NAVIGATION_SPAN_NAME) { + latestNavigationSpan.updateName(route.name); } - } + latestNavigationSpan.setAttributes({ + 'route.name': route.name, + 'route.key': route.key, + // TODO: filter PII params instead of dropping them all + // 'route.params': {}, + 'route.has_been_seen': routeHasBeenSeen, + 'previous_route.name': previousRoute?.name, + 'previous_route.key': previousRoute?.key, + // TODO: filter PII params instead of dropping them all + // 'previous_route.params': {}, + [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'component', + [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', + }); + + // Clear the timeout so the transaction does not get cancelled. + clearStateChangeTimeout(); + + addBreadcrumb({ + category: 'navigation', + type: 'navigation', + message: `Navigation to ${route.name}`, + data: { + from: previousRoute?.name, + to: route.name, + }, + }); + + tracing?.setCurrentRoute(route.key); + + pushRecentRouteKey(route.key); + latestRoute = route; + // Clear the latest transaction as it has been handled. + latestNavigationSpan = undefined; + }; /** Pushes a recent route key, and removes earlier routes when there is greater than the max length */ - private _pushRecentRouteKey = (key: string): void => { - this._recentRouteKeys.push(key); + const pushRecentRouteKey = (key: string): void => { + recentRouteKeys.push(key); - if (this._recentRouteKeys.length > this._maxRecentRouteLen) { - this._recentRouteKeys = this._recentRouteKeys.slice(this._recentRouteKeys.length - this._maxRecentRouteLen); + if (recentRouteKeys.length > NAVIGATION_HISTORY_MAX_SIZE) { + recentRouteKeys = recentRouteKeys.slice(recentRouteKeys.length - NAVIGATION_HISTORY_MAX_SIZE); } }; /** Cancels the latest transaction so it does not get sent to Sentry. */ - private _discardLatestTransaction(): void { - if (this._latestTransaction) { - if (isSentrySpan(this._latestTransaction)) { - this._latestTransaction['_sampled'] = false; + const _discardLatestTransaction = (): void => { + if (latestNavigationSpan) { + if (isSentrySpan(latestNavigationSpan)) { + latestNavigationSpan['_sampled'] = false; } // TODO: What if it's not SentrySpan? - this._latestTransaction.end(); - this._latestTransaction = undefined; + latestNavigationSpan.end(); + latestNavigationSpan = undefined; } - if (this._navigationProcessingSpan) { - this._navigationProcessingSpan = undefined; + if (navigationProcessingSpan) { + navigationProcessingSpan = undefined; } - } + }; - /** - * - */ - private _clearStateChangeTimeout(): void { - if (typeof this._stateChangeTimeout !== 'undefined') { - clearTimeout(this._stateChangeTimeout); - this._stateChangeTimeout = undefined; + const clearStateChangeTimeout = (): void => { + if (typeof stateChangeTimeout !== 'undefined') { + clearTimeout(stateChangeTimeout); + stateChangeTimeout = undefined; } - } -} + }; -/** - * Backwards compatibility alias for ReactNavigationInstrumentation - * @deprecated Use ReactNavigationInstrumentation - */ -export const ReactNavigationV5Instrumentation = ReactNavigationInstrumentation; - -export const BLANK_TRANSACTION_CONTEXT = { - name: 'Route Change', - op: 'navigation', - tags: { - 'routing.instrumentation': ReactNavigationInstrumentation.instrumentationName, - }, - data: {}, + return { + name: INTEGRATION_NAME, + afterAllSetup, + registerNavigationContainer, + }; }; + +export interface NavigationRoute { + name: string; + key: string; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + params?: Record; +} + +interface NavigationContainer { + addListener: (type: string, listener: () => void) => void; + getCurrentRoute: () => NavigationRoute; +} diff --git a/src/js/tracing/routingInstrumentation.ts b/src/js/tracing/routingInstrumentation.ts deleted file mode 100644 index 8655743499..0000000000 --- a/src/js/tracing/routingInstrumentation.ts +++ /dev/null @@ -1,81 +0,0 @@ -import type { Span, StartSpanOptions } from '@sentry/types'; - -import type { BeforeNavigate } from './types'; - -export type TransactionCreator = (context: StartSpanOptions) => Span | undefined; - -export type OnConfirmRoute = (currentViewName: string | undefined) => void; - -export interface RoutingInstrumentationInstance { - /** - * Name of the routing instrumentation - */ - readonly name: string; - /** - * Registers a listener that's called on every route change with a `TransactionContext`. - * - * Do not overwrite this unless you know what you are doing. - * - * @param listener A `RouteListener` - * @param beforeNavigate BeforeNavigate - * @param inConfirmRoute OnConfirmRoute - */ - registerRoutingInstrumentation( - listener: TransactionCreator, - beforeNavigate: BeforeNavigate, - onConfirmRoute: OnConfirmRoute, - ): void; - /** - * To be called when the route changes, BEFORE the new route mounts. - * If this is called after a route mounts the child spans will not be correctly attached. - * - * @param context A `TransactionContext` used to initialize the transaction. - */ - onRouteWillChange(context: StartSpanOptions): Span | undefined; -} - -/** - * Base Routing Instrumentation. Can be used by users to manually instrument custom routers. - * Pass this to the tracing integration, and call `onRouteWillChange` every time before a route changes. - */ -export class RoutingInstrumentation implements RoutingInstrumentationInstance { - public static instrumentationName: string = 'base-routing-instrumentation'; - - public readonly name: string = RoutingInstrumentation.instrumentationName; - - protected _beforeNavigate?: BeforeNavigate; - protected _onConfirmRoute?: OnConfirmRoute; - protected _tracingListener?: TransactionCreator; - - /** @inheritdoc */ - public registerRoutingInstrumentation( - listener: TransactionCreator, - beforeNavigate: BeforeNavigate, - onConfirmRoute: OnConfirmRoute, - ): void { - this._tracingListener = listener; - this._beforeNavigate = beforeNavigate; - this._onConfirmRoute = onConfirmRoute; - } - - /** @inheritdoc */ - public onRouteWillChange(context: StartSpanOptions): Span | undefined { - const transaction = this._tracingListener?.(context); - - if (transaction) { - this._onConfirmRoute?.(context.name); - } - - return transaction; - } -} - -/** - * Internal base routing instrumentation where `_onConfirmRoute` is not called in onRouteWillChange - */ -export class InternalRoutingInstrumentation extends RoutingInstrumentation { - /** @inheritdoc */ - public onRouteWillChange(context: StartSpanOptions): Span | undefined { - return this._tracingListener?.(context); - } -} diff --git a/src/js/tracing/span.ts b/src/js/tracing/span.ts index f73707ccf5..1a9abeb0ad 100644 --- a/src/js/tracing/span.ts +++ b/src/js/tracing/span.ts @@ -12,48 +12,69 @@ import type { Client, Scope, Span, StartSpanOptions } from '@sentry/types'; import { generatePropagationContext, logger } from '@sentry/utils'; import { isRootSpan } from '../utils/span'; -import { adjustTransactionDuration, cancelInBackground, ignoreEmptyBackNavigation } from './onSpanEndUtils'; +import { adjustTransactionDuration, cancelInBackground } from './onSpanEndUtils'; import { SPAN_ORIGIN_AUTO_INTERACTION } from './origin'; +export const DEFAULT_NAVIGATION_SPAN_NAME = 'Route Change'; + +export const defaultIdleOptions: { + /** + * The time that has to pass without any span being created. + * If this time is exceeded, the idle span will finish. + * + * @default 1_000 (ms) + */ + finalTimeout: number; + + /** + * The max. time an idle span may run. + * If this time is exceeded, the idle span will finish no matter what. + * + * @default 60_0000 (ms) + */ + idleTimeout: number; +} = { + idleTimeout: 1_000, + finalTimeout: 60_0000, +}; + export const startIdleNavigationSpan = ( startSpanOption: StartSpanOptions, { - finalTimeout, - idleTimeout, - ignoreEmptyBackNavigationTransactions, - }: { - finalTimeout: number; - idleTimeout: number; - ignoreEmptyBackNavigationTransactions: boolean; - }, + finalTimeout = defaultIdleOptions.finalTimeout, + idleTimeout = defaultIdleOptions.idleTimeout, + }: Partial = {}, ): Span | undefined => { const client = getClient(); if (!client) { - logger.warn(`[ReactNativeTracing] Can't create route change span, missing client.`); + logger.warn(`[startIdleNavigationSpan] Can't create route change span, missing client.`); return undefined; } const activeSpan = getActiveSpan(); if (activeSpan && isRootSpan(activeSpan) && isSentryInteractionSpan(activeSpan)) { logger.log( - `[ReactNativeTracing] Canceling ${spanToJSON(activeSpan).op} transaction because of a new navigation root span.`, + `[startIdleNavigationSpan] Canceling ${ + spanToJSON(activeSpan).op + } transaction because of a new navigation root span.`, ); activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'cancelled' }); activeSpan.end(); } - const idleSpan = startIdleSpan(startSpanOption, { finalTimeout, idleTimeout }); + const finalStartStapOptions = { + ...getDefaultIdleNavigationSpanOptions(), + ...startSpanOption, + }; + + const idleSpan = startIdleSpan(finalStartStapOptions, { finalTimeout, idleTimeout }); logger.log( - `[ReactNativeTracing] Starting ${startSpanOption.op || 'unknown op'} transaction "${ - startSpanOption.name + `[startIdleNavigationSpan] Starting ${finalStartStapOptions.op || 'unknown op'} transaction "${ + finalStartStapOptions.name }" on scope`, ); adjustTransactionDuration(client, idleSpan, finalTimeout); - if (ignoreEmptyBackNavigationTransactions) { - ignoreEmptyBackNavigation(client, idleSpan); - } - return idleSpan; }; @@ -70,7 +91,7 @@ export const startIdleSpan = ( ): Span => { const client = getClient(); if (!client) { - logger.warn(`[ReactNativeTracing] Can't create idle span, missing client.`); + logger.warn(`[startIdleSpan] Can't create idle span, missing client.`); return new SentryNonRecordingSpan(); } @@ -81,6 +102,18 @@ export const startIdleSpan = ( return span; }; +/** + * Returns the default options for the idle navigation span. + */ +export function getDefaultIdleNavigationSpanOptions(): StartSpanOptions { + return { + name: DEFAULT_NAVIGATION_SPAN_NAME, + op: 'navigation', + forceTransaction: true, + scope: getCurrentScope(), + }; +} + /** * Checks if the span is a Sentry User Interaction span. */ diff --git a/test/client.test.ts b/test/client.test.ts index d4a057b316..dee71e7763 100644 --- a/test/client.test.ts +++ b/test/client.test.ts @@ -8,8 +8,6 @@ import * as RN from 'react-native'; import { ReactNativeClient } from '../src/js/client'; import type { ReactNativeClientOptions } from '../src/js/options'; -import type { RoutingInstrumentationInstance } from '../src/js/tracing'; -import { reactNativeTracingIntegration } from '../src/js/tracing'; import { NativeTransport } from '../src/js/transports/native'; import { SDK_NAME, SDK_PACKAGE_NAME, SDK_VERSION } from '../src/js/version'; import { NATIVE } from '../src/js/wrapper'; @@ -609,29 +607,6 @@ describe('Tests ReactNativeClient', () => { client.recordDroppedEvent('before_send', 'error'); } }); - - describe('register enabled instrumentation as integrations', () => { - test('register routing instrumentation', () => { - const mockRoutingInstrumentation: RoutingInstrumentationInstance = { - registerRoutingInstrumentation: jest.fn(), - onRouteWillChange: jest.fn(), - name: 'MockRoutingInstrumentation', - }; - const client = new ReactNativeClient( - mockedOptions({ - dsn: EXAMPLE_DSN, - integrations: [ - reactNativeTracingIntegration({ - routingInstrumentation: mockRoutingInstrumentation, - }), - ], - }), - ); - client.init(); - - expect(client.getIntegrationByName('MockRoutingInstrumentation')).toBeTruthy(); - }); - }); }); function mockedOptions(options: Partial): ReactNativeClientOptions { diff --git a/test/sdk.test.ts b/test/sdk.test.ts index 1c56a9d465..1e89412e45 100644 --- a/test/sdk.test.ts +++ b/test/sdk.test.ts @@ -13,11 +13,7 @@ import { logger } from '@sentry/utils'; import { init, withScope } from '../src/js/sdk'; import type { ReactNativeTracingIntegration } from '../src/js/tracing'; -import { - REACT_NATIVE_TRACING_INTEGRATION_NAME, - reactNativeTracingIntegration, - ReactNavigationInstrumentation, -} from '../src/js/tracing'; +import { REACT_NATIVE_TRACING_INTEGRATION_NAME, reactNativeTracingIntegration } from '../src/js/tracing'; import { makeNativeTransport } from '../src/js/transports/native'; import { getDefaultEnvironment, isExpoGo, notWeb } from '../src/js/utils/environment'; import { NATIVE } from './mockWrapper'; @@ -36,8 +32,7 @@ describe('Tests the SDK functionality', () => { describe('init', () => { describe('enableAutoPerformanceTracing', () => { const reactNavigationInstrumentation = (): ReactNativeTracingIntegration => { - const nav = new ReactNavigationInstrumentation(); - return reactNativeTracingIntegration({ routingInstrumentation: nav }); + return reactNativeTracingIntegration(); }; it('Auto Performance is disabled by default', () => { diff --git a/test/tracing/gesturetracing.test.ts b/test/tracing/gesturetracing.test.ts index d0086827b2..5151466154 100644 --- a/test/tracing/gesturetracing.test.ts +++ b/test/tracing/gesturetracing.test.ts @@ -11,8 +11,6 @@ import { startUserInteractionSpan } from '../../src/js/tracing/integrations/user import type { ReactNativeTracingIntegration } from '../../src/js/tracing/reactnativetracing'; import { reactNativeTracingIntegration } from '../../src/js/tracing/reactnativetracing'; import { type TestClient, setupTestClient } from '../mocks/client'; -import type { MockedRoutingInstrumentation } from './mockedrountinginstrumention'; -import { createMockedRoutingInstrumentation } from './mockedrountinginstrumention'; jest.mock('../../src/js/wrapper', () => { return { @@ -51,7 +49,6 @@ describe('GestureTracing', () => { describe('traces gestures', () => { let client: TestClient; let tracing: ReactNativeTracingIntegration; - let mockedRoutingInstrumentation: MockedRoutingInstrumentation; let mockedGesture: MockGesture; beforeEach(() => { @@ -60,12 +57,9 @@ describe('GestureTracing', () => { client = setupTestClient({ enableUserInteractionTracing: true, }); - mockedRoutingInstrumentation = createMockedRoutingInstrumentation(); - tracing = reactNativeTracingIntegration({ - routingInstrumentation: mockedRoutingInstrumentation, - }); + tracing = reactNativeTracingIntegration(); client.addIntegration(tracing); - mockedRoutingInstrumentation.registeredOnConfirmRoute!('mockedScreenName'); + tracing.setCurrentRoute('mockedScreenName'); mockedGesture = { handlers: { onBegin: jest.fn(), diff --git a/test/tracing/idleNavigationSpan.test.ts b/test/tracing/idleNavigationSpan.test.ts new file mode 100644 index 0000000000..0d00907fad --- /dev/null +++ b/test/tracing/idleNavigationSpan.test.ts @@ -0,0 +1,82 @@ +import { getActiveSpan, spanToJSON } from '@sentry/core'; +import type { AppState, AppStateStatus } from 'react-native'; + +import { startIdleNavigationSpan } from '../../src/js/tracing/span'; +import { NATIVE } from '../../src/js/wrapper'; +import { setupTestClient } from '../mocks/client'; + +type MockAppState = { + setState: (state: AppStateStatus) => void; + listener: (newState: AppStateStatus) => void; + removeSubscription: jest.Func; +}; +const mockedAppState: AppState & MockAppState = { + removeSubscription: jest.fn(), + listener: jest.fn(), + isAvailable: true, + currentState: 'active', + addEventListener: (_, listener) => { + mockedAppState.listener = listener; + return { + remove: mockedAppState.removeSubscription, + }; + }, + setState: (state: AppStateStatus) => { + mockedAppState.currentState = state; + mockedAppState.listener(state); + }, +}; +jest.mock('react-native/Libraries/AppState/AppState', () => mockedAppState); + +describe('startIdleNavigationSpan', () => { + beforeEach(() => { + jest.useFakeTimers(); + NATIVE.enableNative = true; + mockedAppState.isAvailable = true; + mockedAppState.addEventListener = (_, listener) => { + mockedAppState.listener = listener; + return { + remove: mockedAppState.removeSubscription, + }; + }; + setupTestClient(); + }); + + afterEach(() => { + jest.runOnlyPendingTimers(); + jest.useRealTimers(); + jest.clearAllMocks(); + }); + + it('Cancels route transaction when app goes to background', async () => { + const routeTransaction = startIdleNavigationSpan({ + name: 'test', + }); + + mockedAppState.setState('background'); + + jest.runAllTimers(); + + expect(routeTransaction).toBeDefined(); + expect(spanToJSON(routeTransaction!).status).toBe('cancelled'); + expect(mockedAppState.removeSubscription).toBeCalledTimes(1); + }); + + it('Does not crash when AppState is not available', async () => { + mockedAppState.isAvailable = false; + mockedAppState.addEventListener = ((): void => { + return undefined; + }) as unknown as (typeof mockedAppState)['addEventListener']; // RN Web can return undefined + + startIdleNavigationSpan({ + name: 'test', + }); + + await jest.advanceTimersByTimeAsync(500); + const transaction = getActiveSpan(); + + jest.runAllTimers(); + + expect(spanToJSON(transaction!).timestamp).toBeDefined(); + }); +}); diff --git a/test/tracing/integrations/userInteraction.test.ts b/test/tracing/integrations/userInteraction.test.ts index 01bcd86a0c..3ec8905a38 100644 --- a/test/tracing/integrations/userInteraction.test.ts +++ b/test/tracing/integrations/userInteraction.test.ts @@ -15,11 +15,10 @@ import { } from '../../../src/js/tracing/integrations/userInteraction'; import type { ReactNativeTracingIntegration } from '../../../src/js/tracing/reactnativetracing'; import { reactNativeTracingIntegration } from '../../../src/js/tracing/reactnativetracing'; +import { startIdleNavigationSpan } from '../../../src/js/tracing/span'; import { NATIVE } from '../../../src/js/wrapper'; import type { TestClient } from '../../mocks/client'; import { setupTestClient } from '../../mocks/client'; -import type { MockedRoutingInstrumentation } from '../mockedrountinginstrumention'; -import { createMockedRoutingInstrumentation } from '../mockedrountinginstrumention'; type MockAppState = { setState: (state: AppStateStatus) => void; @@ -60,7 +59,6 @@ describe('User Interaction Tracing', () => { let client: TestClient; let tracing: ReactNativeTracingIntegration; let mockedUserInteractionId: { elementId: string | undefined; op: string }; - let mockedRoutingInstrumentation: MockedRoutingInstrumentation; beforeEach(() => { jest.useFakeTimers(); @@ -77,7 +75,6 @@ describe('User Interaction Tracing', () => { client = setupTestClient({ enableUserInteractionTracing: true, }); - mockedRoutingInstrumentation = createMockedRoutingInstrumentation(); }); afterEach(() => { @@ -89,7 +86,6 @@ describe('User Interaction Tracing', () => { describe('disabled user interaction', () => { test('User interaction tracing is disabled by default', () => { client = setupTestClient({}); - mockedRoutingInstrumentation = createMockedRoutingInstrumentation(); startUserInteractionSpan(mockedUserInteractionId); expect(client.getOptions().enableUserInteractionTracing).toBeFalsy(); @@ -99,12 +95,10 @@ describe('User Interaction Tracing', () => { describe('enabled user interaction', () => { beforeEach(() => { - tracing = reactNativeTracingIntegration({ - routingInstrumentation: mockedRoutingInstrumentation, - }); + tracing = reactNativeTracingIntegration(); client.addIntegration(userInteractionIntegration()); client.addIntegration(tracing); - mockedRoutingInstrumentation.registeredOnConfirmRoute!('mockedRouteName'); + tracing.setCurrentRoute('mockedRouteName'); }); test('user interaction tracing is enabled and transaction is bound to scope', () => { @@ -272,8 +266,7 @@ describe('User Interaction Tracing', () => { startUserInteractionSpan(mockedUserInteractionId); const interactionTransaction = getActiveSpan(); jest.advanceTimersByTime(timeoutCloseToActualIdleTimeoutMs); - - const routingTransaction = mockedRoutingInstrumentation.registeredListener!({ + const routingTransaction = startIdleNavigationSpan({ name: 'newMockedRouteName', }); jest.runAllTimers(); diff --git a/test/tracing/mockedrountinginstrumention.ts b/test/tracing/mockedrountinginstrumention.ts deleted file mode 100644 index 53f0d68f74..0000000000 --- a/test/tracing/mockedrountinginstrumention.ts +++ /dev/null @@ -1,24 +0,0 @@ -import type { RoutingInstrumentation } from '../../src/js'; -import type { OnConfirmRoute, TransactionCreator } from '../../src/js/tracing/routingInstrumentation'; -import type { BeforeNavigate } from '../../src/js/tracing/types'; - -export interface MockedRoutingInstrumentation extends RoutingInstrumentation { - registeredListener?: TransactionCreator; - registeredBeforeNavigate?: BeforeNavigate; - registeredOnConfirmRoute?: OnConfirmRoute; -} - -export const createMockedRoutingInstrumentation = (): MockedRoutingInstrumentation => { - const mock: MockedRoutingInstrumentation = { - name: 'TestRoutingInstrumentationInstance', - onRouteWillChange: jest.fn(), - registerRoutingInstrumentation: jest.fn( - (listener: TransactionCreator, beforeNavigate: BeforeNavigate, onConfirmRoute: OnConfirmRoute) => { - mock.registeredListener = listener; - mock.registeredBeforeNavigate = beforeNavigate; - mock.registeredOnConfirmRoute = onConfirmRoute; - }, - ), - }; - return mock; -}; diff --git a/test/tracing/reactnativenavigation.test.ts b/test/tracing/reactnativenavigation.test.ts index f07c7c5505..5e1b9563d6 100644 --- a/test/tracing/reactnativenavigation.test.ts +++ b/test/tracing/reactnativenavigation.test.ts @@ -16,7 +16,7 @@ import type { ComponentWillAppearEvent, EventsRegistry, } from '../../src/js/tracing/reactnativenavigation'; -import { ReactNativeNavigationInstrumentation } from '../../src/js/tracing/reactnativenavigation'; +import { reactNativeNavigationIntegration } from '../../src/js/tracing/reactnativenavigation'; import { SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_COMPONENT_ID, SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_COMPONENT_TYPE, @@ -356,20 +356,17 @@ describe('React Native Navigation Instrumentation', () => { } = {}, ) { createMockNavigation(); - const rNavigation = new ReactNativeNavigationInstrumentation( - { + const rNavigation = reactNativeNavigationIntegration({ + navigation: { events() { return mockEventsRegistry; }, }, - { - routeChangeTimeoutMs: 200, - enableTabsInstrumentation: setupOptions.enableTabsInstrumentation, - }, - ); + routeChangeTimeoutMs: 200, + enableTabsInstrumentation: setupOptions.enableTabsInstrumentation, + }); const rnTracing = reactNativeTracingIntegration({ - routingInstrumentation: rNavigation, beforeStartSpan: setupOptions.beforeStartSpan, }); @@ -377,7 +374,7 @@ describe('React Native Navigation Instrumentation', () => { tracesSampleRate: 1.0, enableStallTracking: false, enableNativeFramesTracking: false, - integrations: [rnTracing], + integrations: [rNavigation, rnTracing], enableAppStartTracking: false, }); client = new TestClient(options); diff --git a/test/tracing/reactnativetracing.test.ts b/test/tracing/reactnativetracing.test.ts index 9b84f14b3d..80ee392ed5 100644 --- a/test/tracing/reactnativetracing.test.ts +++ b/test/tracing/reactnativetracing.test.ts @@ -10,8 +10,6 @@ jest.mock('@sentry/utils', () => { import * as SentryBrowser from '@sentry/browser'; import type { Event } from '@sentry/types'; -import { RoutingInstrumentation } from '../../src/js/tracing/routingInstrumentation'; - jest.mock('../../src/js/wrapper', () => { return { NATIVE: { @@ -33,48 +31,16 @@ jest.mock('../../src/js/tracing/utils', () => { }; }); -type MockAppState = { - setState: (state: AppStateStatus) => void; - listener: (newState: AppStateStatus) => void; - removeSubscription: jest.Func; -}; -const mockedAppState: AppState & MockAppState = { - removeSubscription: jest.fn(), - listener: jest.fn(), - isAvailable: true, - currentState: 'active', - addEventListener: (_, listener) => { - mockedAppState.listener = listener; - return { - remove: mockedAppState.removeSubscription, - }; - }, - setState: (state: AppStateStatus) => { - mockedAppState.currentState = state; - mockedAppState.listener(state); - }, -}; -jest.mock('react-native/Libraries/AppState/AppState', () => mockedAppState); - -import { getActiveSpan, spanToJSON } from '@sentry/browser'; -import type { AppState, AppStateStatus } from 'react-native'; - import { reactNativeTracingIntegration } from '../../src/js/tracing/reactnativetracing'; -import { NATIVE } from '../../src/js/wrapper'; import type { TestClient } from '../mocks/client'; import { setupTestClient } from '../mocks/client'; describe('ReactNativeTracing', () => { + let client: TestClient; + beforeEach(() => { jest.useFakeTimers(); - NATIVE.enableNative = true; - mockedAppState.isAvailable = true; - mockedAppState.addEventListener = (_, listener) => { - mockedAppState.listener = listener; - return { - remove: mockedAppState.removeSubscription, - }; - }; + client = setupTestClient(); }); afterEach(() => { @@ -114,143 +80,42 @@ describe('ReactNativeTracing', () => { }); }); - describe('Tracing Instrumentation', () => { - let client: TestClient; - - beforeEach(() => { - client = setupTestClient(); - }); - - describe('With routing instrumentation', () => { - it('Cancels route transaction when app goes to background', async () => { - const routingInstrumentation = new RoutingInstrumentation(); - const integration = reactNativeTracingIntegration({ - routingInstrumentation, - }); - - integration.setup(client); - integration.afterAllSetup(client); - // wait for internal promises to resolve, fetch app start data from mocked native - await Promise.resolve(); - - const routeTransaction = routingInstrumentation.onRouteWillChange({ - name: 'test', - }); + describe('View Names event processor', () => { + it('Do not overwrite event app context', () => { + const integration = reactNativeTracingIntegration(); - mockedAppState.setState('background'); + const expectedRouteName = 'Route'; + const event: Event = { contexts: { app: { appKey: 'value' } } }; + const expectedEvent: Event = { contexts: { app: { appKey: 'value', view_names: [expectedRouteName] } } }; - jest.runAllTimers(); + integration.setCurrentRoute(expectedRouteName); + const processedEvent = integration.processEvent(event, {}, client); - expect(routeTransaction).toBeDefined(); - expect(spanToJSON(routeTransaction!).status).toBe('cancelled'); - expect(mockedAppState.removeSubscription).toBeCalledTimes(1); - }); - - it('Does not crash when AppState is not available', async () => { - mockedAppState.isAvailable = false; - mockedAppState.addEventListener = ((): void => { - return undefined; - }) as unknown as (typeof mockedAppState)['addEventListener']; // RN Web can return undefined - - const routingInstrumentation = new RoutingInstrumentation(); - setupTestClient({ - integrations: [ - reactNativeTracingIntegration({ - routingInstrumentation, - }), - ], - }); - - routingInstrumentation.onRouteWillChange({ - name: 'test', - }); - - await jest.advanceTimersByTimeAsync(500); - const transaction = getActiveSpan(); - - jest.runAllTimers(); - - expect(spanToJSON(transaction!).timestamp).toBeDefined(); - }); + expect(processedEvent).toEqual(expectedEvent); }); - }); - - describe('Routing Instrumentation', () => { - let client: TestClient; - - beforeEach(() => { - client = setupTestClient(); - }); - - describe('_onConfirmRoute', () => { - it('Sets app context', async () => { - const routing = new RoutingInstrumentation(); - const integration = reactNativeTracingIntegration({ - routingInstrumentation: routing, - }); - - client.addIntegration(integration); - - routing.onRouteWillChange({ name: 'First Route' }); - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - - routing.onRouteWillChange({ name: 'Second Route' }); - await jest.advanceTimersByTimeAsync(500); - await jest.runOnlyPendingTimersAsync(); - const transaction = client.event; - expect(transaction!.contexts!.app).toBeDefined(); - expect(transaction!.contexts!.app!['view_names']).toEqual(['Second Route']); - }); - - describe('View Names event processor', () => { - it('Do not overwrite event app context', () => { - const routing = new RoutingInstrumentation(); - const integration = reactNativeTracingIntegration({ - routingInstrumentation: routing, - }); - - const expectedRouteName = 'Route'; - const event: Event = { contexts: { app: { appKey: 'value' } } }; - const expectedEvent: Event = { contexts: { app: { appKey: 'value', view_names: [expectedRouteName] } } }; - - integration.state.currentRoute = expectedRouteName; - const processedEvent = integration.processEvent(event, {}, client); + it('Do not add view_names if context is undefined', () => { + const integration = reactNativeTracingIntegration(); - expect(processedEvent).toEqual(expectedEvent); - }); + const expectedRouteName = 'Route'; + const event: Event = { release: 'value' }; + const expectedEvent: Event = { release: 'value' }; - it('Do not add view_names if context is undefined', () => { - const routing = new RoutingInstrumentation(); - const integration = reactNativeTracingIntegration({ - routingInstrumentation: routing, - }); + integration.setCurrentRoute(expectedRouteName); + const processedEvent = integration.processEvent(event, {}, client); - const expectedRouteName = 'Route'; - const event: Event = { release: 'value' }; - const expectedEvent: Event = { release: 'value' }; - - integration.state.currentRoute = expectedRouteName; - const processedEvent = integration.processEvent(event, {}, client); - - expect(processedEvent).toEqual(expectedEvent); - }); + expect(processedEvent).toEqual(expectedEvent); + }); - it('ignore view_names if undefined', () => { - const routing = new RoutingInstrumentation(); - const integration = reactNativeTracingIntegration({ - routingInstrumentation: routing, - }); + it('ignore view_names if undefined', () => { + const integration = reactNativeTracingIntegration(); - const event: Event = { contexts: { app: { key: 'value ' } } }; - const expectedEvent: Event = { contexts: { app: { key: 'value ' } } }; + const event: Event = { contexts: { app: { key: 'value ' } } }; + const expectedEvent: Event = { contexts: { app: { key: 'value ' } } }; - const processedEvent = integration.processEvent(event, {}, client); + const processedEvent = integration.processEvent(event, {}, client); - expect(processedEvent).toEqual(expectedEvent); - }); - }); + expect(processedEvent).toEqual(expectedEvent); }); }); }); diff --git a/test/tracing/reactnavigation.stalltracking.test.ts b/test/tracing/reactnavigation.stalltracking.test.ts index b3548a98ab..0fbc3b8627 100644 --- a/test/tracing/reactnavigation.stalltracking.test.ts +++ b/test/tracing/reactnavigation.stalltracking.test.ts @@ -5,7 +5,7 @@ jest.mock('../../src/js/tracing/utils', () => ({ import { getCurrentScope, getGlobalScope, getIsolationScope, setCurrentClient, startSpanManual } from '@sentry/core'; -import { reactNativeTracingIntegration, ReactNavigationInstrumentation } from '../../src/js'; +import { reactNativeTracingIntegration, reactNavigationIntegration } from '../../src/js'; import { stallTrackingIntegration } from '../../src/js/tracing/integrations/stalltracking'; import { isNearToNow } from '../../src/js/tracing/utils'; import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; @@ -26,12 +26,10 @@ describe('StallTracking with ReactNavigation', () => { getIsolationScope().clear(); getGlobalScope().clear(); - const rnavigation = new ReactNavigationInstrumentation(); + const rnavigation = reactNavigationIntegration(); mockNavigation = createMockNavigationAndAttachTo(rnavigation); - const rnTracing = reactNativeTracingIntegration({ - routingInstrumentation: rnavigation, - }); + const rnTracing = reactNativeTracingIntegration(); const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, diff --git a/test/tracing/reactnavigation.test.ts b/test/tracing/reactnavigation.test.ts index 9806aa891f..a7e3ba7a07 100644 --- a/test/tracing/reactnavigation.test.ts +++ b/test/tracing/reactnavigation.test.ts @@ -1,12 +1,12 @@ /* eslint-disable deprecation/deprecation */ /* eslint-disable @typescript-eslint/no-explicit-any */ -import { getCurrentScope, getGlobalScope, getIsolationScope, SentrySpan, setCurrentClient } from '@sentry/core'; +import type { SentrySpan } from '@sentry/core'; +import { getActiveSpan, getCurrentScope, getGlobalScope, getIsolationScope, setCurrentClient } from '@sentry/core'; import type { Event, Measurements, StartSpanOptions } from '@sentry/types'; import { nativeFramesIntegration, reactNativeTracingIntegration } from '../../src/js'; -import { DEFAULT_NAVIGATION_SPAN_NAME } from '../../src/js/tracing/reactnativetracing'; import type { NavigationRoute } from '../../src/js/tracing/reactnavigation'; -import { ReactNavigationInstrumentation } from '../../src/js/tracing/reactnavigation'; +import { reactNavigationIntegration } from '../../src/js/tracing/reactnavigation'; import { SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_KEY, SEMANTIC_ATTRIBUTE_PREVIOUS_ROUTE_NAME, @@ -19,6 +19,7 @@ import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, } from '../../src/js/tracing/semanticAttributes'; +import { DEFAULT_NAVIGATION_SPAN_NAME } from '../../src/js/tracing/span'; import { RN_GLOBAL_OBJ } from '../../src/js/utils/worldwide'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; import { NATIVE } from '../mockWrapper'; @@ -85,7 +86,7 @@ describe('ReactNavigationInstrumentation', () => { }); describe('initial navigation span is created after all integrations are setup', () => { - let rnTracing: ReturnType; + let reactNavigation: ReturnType; beforeEach(() => { const startFrames = { @@ -100,14 +101,10 @@ describe('ReactNavigationInstrumentation', () => { }; NATIVE.fetchNativeFrames.mockResolvedValueOnce(startFrames).mockResolvedValueOnce(finishFrames); - const rNavigation = new ReactNavigationInstrumentation({ + reactNavigation = reactNavigationIntegration({ routeChangeTimeoutMs: 200, }); - mockNavigation = createMockNavigationAndAttachTo(rNavigation); - - rnTracing = reactNativeTracingIntegration({ - routingInstrumentation: rNavigation, - }); + mockNavigation = createMockNavigationAndAttachTo(reactNavigation); }); test('initial navigation span contains native frames when nativeFrames integration is after react native tracing', async () => { @@ -115,7 +112,7 @@ describe('ReactNavigationInstrumentation', () => { enableNativeFramesTracking: true, enableStallTracking: false, tracesSampleRate: 1.0, - integrations: [rnTracing, nativeFramesIntegration()], + integrations: [reactNavigation, nativeFramesIntegration()], enableAppStartTracking: false, }); client = new TestClient(options); @@ -134,7 +131,7 @@ describe('ReactNavigationInstrumentation', () => { enableNativeFramesTracking: true, enableStallTracking: false, tracesSampleRate: 1.0, - integrations: [nativeFramesIntegration(), rnTracing], + integrations: [nativeFramesIntegration(), reactNavigation], enableAppStartTracking: false, }); client = new TestClient(options); @@ -314,7 +311,7 @@ describe('ReactNavigationInstrumentation', () => { describe('navigation container registration', () => { test('registers navigation container object ref', () => { - const instrumentation = new ReactNavigationInstrumentation(); + const instrumentation = reactNavigationIntegration(); const mockNavigationContainer = new MockNavigationContainer(); instrumentation.registerNavigationContainer({ current: mockNavigationContainer, @@ -327,7 +324,7 @@ describe('ReactNavigationInstrumentation', () => { }); test('registers navigation container direct ref', () => { - const instrumentation = new ReactNavigationInstrumentation(); + const instrumentation = reactNavigationIntegration(); const mockNavigationContainer = new MockNavigationContainer(); instrumentation.registerNavigationContainer(mockNavigationContainer); @@ -340,7 +337,7 @@ describe('ReactNavigationInstrumentation', () => { test('does not register navigation container if there is an existing one', () => { RN_GLOBAL_OBJ.__sentry_rn_v5_registered = true; - const instrumentation = new ReactNavigationInstrumentation(); + const instrumentation = reactNavigationIntegration(); const mockNavigationContainer = new MockNavigationContainer(); instrumentation.registerNavigationContainer({ current: mockNavigationContainer, @@ -352,19 +349,14 @@ describe('ReactNavigationInstrumentation', () => { expect(mockNavigationContainer.addListener).not.toHaveBeenCalled(); }); - test('works if routing instrumentation registration is after navigation registration', async () => { - const instrumentation = new ReactNavigationInstrumentation(); + test('works if routing instrumentation setup is after navigation registration', async () => { + const instrumentation = reactNavigationIntegration(); const mockNavigationContainer = new MockNavigationContainer(); instrumentation.registerNavigationContainer(mockNavigationContainer); - const mockTransaction = new SentrySpan(); - const tracingListener = jest.fn(() => mockTransaction); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); + instrumentation.afterAllSetup(client); + const mockTransaction = getActiveSpan() as SentrySpan; await jest.runOnlyPendingTimersAsync(); @@ -374,17 +366,11 @@ describe('ReactNavigationInstrumentation', () => { describe('options', () => { test('waits until routeChangeTimeoutMs', () => { - const instrumentation = new ReactNavigationInstrumentation({ + const instrumentation = reactNavigationIntegration({ routeChangeTimeoutMs: 200, }); - const mockTransaction = new SentrySpan({ sampled: true, name: DEFAULT_NAVIGATION_SPAN_NAME }); - const tracingListener = jest.fn(() => mockTransaction); - instrumentation.registerRoutingInstrumentation( - tracingListener as any, - context => context, - () => {}, - ); + instrumentation.afterAllSetup(client); const mockNavigationContainerRef = { current: new MockNavigationContainer(), @@ -392,11 +378,12 @@ describe('ReactNavigationInstrumentation', () => { instrumentation.registerNavigationContainer(mockNavigationContainerRef as any); mockNavigationContainerRef.current.listeners['__unsafe_action__']({}); + const mockTransaction = getActiveSpan() as SentrySpan; jest.advanceTimersByTime(190); expect(mockTransaction['_sampled']).toBe(true); - expect(mockTransaction['_name']).toBe('Route'); + expect(mockTransaction['_name']).toBe(DEFAULT_NAVIGATION_SPAN_NAME); jest.advanceTimersByTime(20); @@ -409,13 +396,12 @@ describe('ReactNavigationInstrumentation', () => { beforeSpanStart?: (options: StartSpanOptions) => StartSpanOptions; } = {}, ) { - const rNavigation = new ReactNavigationInstrumentation({ + const rNavigation = reactNavigationIntegration({ routeChangeTimeoutMs: 200, }); mockNavigation = createMockNavigationAndAttachTo(rNavigation); const rnTracing = reactNativeTracingIntegration({ - routingInstrumentation: rNavigation, beforeStartSpan: setupOptions.beforeSpanStart, }); @@ -423,7 +409,7 @@ describe('ReactNavigationInstrumentation', () => { enableNativeFramesTracking: false, enableStallTracking: false, tracesSampleRate: 1.0, - integrations: [rnTracing], + integrations: [rNavigation, rnTracing], enableAppStartTracking: false, }); client = new TestClient(options); diff --git a/test/tracing/reactnavigation.ttid.test.tsx b/test/tracing/reactnavigation.ttid.test.tsx index 2f80055442..6e0855390a 100644 --- a/test/tracing/reactnavigation.ttid.test.tsx +++ b/test/tracing/reactnavigation.ttid.test.tsx @@ -13,7 +13,6 @@ import React from "react"; import TestRenderer from 'react-test-renderer'; import * as Sentry from '../../src/js'; -import { ReactNavigationInstrumentation } from '../../src/js'; import { TimeToFullDisplay, TimeToInitialDisplay } from '../../src/js/tracing'; import { _setAppStartEndTimestampMs } from '../../src/js/tracing/integrations/appStart'; import { isHermesEnabled, notWeb } from '../../src/js/utils/environment'; @@ -592,7 +591,10 @@ describe('React Navigation - TTID', () => { } function createTestedInstrumentation(options?: { enableTimeToInitialDisplay?: boolean }) { - const sut = new ReactNavigationInstrumentation(options); + const sut = Sentry.reactNavigationIntegration({ + ...options, + ignoreEmptyBackNavigationTransactions: true, // default true + }); return sut; } @@ -602,7 +604,7 @@ describe('React Navigation - TTID', () => { } }); -function initSentry(sut: ReactNavigationInstrumentation): { +function initSentry(sut: ReturnType): { transportSendMock: jest.Mock, Parameters>; } { RN_GLOBAL_OBJ.__sentry_rn_v5_registered = false; @@ -612,10 +614,8 @@ function initSentry(sut: ReactNavigationInstrumentation): { enableTracing: true, enableStallTracking: false, integrations: [ - Sentry.reactNativeTracingIntegration({ - routingInstrumentation: sut, - ignoreEmptyBackNavigationTransactions: true, // default true - }), + sut, + Sentry.reactNativeTracingIntegration(), ], transport: () => ({ send: transportSendMock.mockResolvedValue({}), diff --git a/test/tracing/reactnavigationutils.ts b/test/tracing/reactnavigationutils.ts index 5bdfa5f199..3aba609d13 100644 --- a/test/tracing/reactnavigationutils.ts +++ b/test/tracing/reactnavigationutils.ts @@ -1,6 +1,6 @@ -import type { NavigationRoute, ReactNavigationInstrumentation } from '../../src/js/tracing/reactnavigation'; +import type { NavigationRoute, reactNavigationIntegration } from '../../src/js/tracing/reactnavigation'; -export function createMockNavigationAndAttachTo(sut: ReactNavigationInstrumentation) { +export function createMockNavigationAndAttachTo(sut: ReturnType) { const mockedNavigationContained = mockNavigationContainer(); const mockedNavigation = { emitCancelledNavigation: () => { From 18c674762193cd0e405d0aab9446346f1a7b4924 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich Date: Wed, 14 Aug 2024 12:46:56 +0200 Subject: [PATCH 14/48] misc(changelog): Add v6 alpha note --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 26d39c3468..f73e85fbbe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## Unreleased +This is an alpha version of the next major version of the Sentry React Native SDK 6.0.0. +Please read the changes listed below as well as the changes made in the underlying +Sentry Javascript SDK 8.0.0 ([JS Docs](https://docs.sentry.io/platforms/javascript/guides/react/migration/v7-to-v8/)). + ### Changes - Removed deprecated ReactNativeTracing option `idleTimeout` use `idleTimeoutMs` instead ([#3998](https://github.com/getsentry/sentry-react-native/pull/3998)) From 14bce22ccbfbd9a66b295b58cc2122489d1bdc4c Mon Sep 17 00:00:00 2001 From: getsentry-bot Date: Wed, 14 Aug 2024 10:52:36 +0000 Subject: [PATCH 15/48] release: 6.0.0-alpha.0 --- CHANGELOG.md | 2 +- package.json | 2 +- samples/expo/app.json | 6 +++--- samples/expo/package.json | 2 +- samples/react-native/android/app/build.gradle | 4 ++-- samples/react-native/ios/sentryreactnativesample/Info.plist | 4 ++-- .../ios/sentryreactnativesampleTests/Info.plist | 4 ++-- samples/react-native/package.json | 2 +- src/js/version.ts | 2 +- 9 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f73e85fbbe..43cda1f349 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## Unreleased +## 6.0.0-alpha.0 This is an alpha version of the next major version of the Sentry React Native SDK 6.0.0. Please read the changes listed below as well as the changes made in the underlying diff --git a/package.json b/package.json index 31cb4b4d3e..1125263926 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@sentry/react-native", "homepage": "https://github.com/getsentry/sentry-react-native", "repository": "https://github.com/getsentry/sentry-react-native", - "version": "5.29.0", + "version": "6.0.0-alpha.0", "description": "Official Sentry SDK for react-native", "typings": "dist/js/index.d.ts", "types": "dist/js/index.d.ts", diff --git a/samples/expo/app.json b/samples/expo/app.json index b852ea20ad..aea13ee7d0 100644 --- a/samples/expo/app.json +++ b/samples/expo/app.json @@ -4,7 +4,7 @@ "slug": "sentry-react-native-expo-sample", "jsEngine": "hermes", "scheme": "sentry-expo-sample", - "version": "5.29.0", + "version": "6.0.0-alpha.0", "orientation": "portrait", "icon": "./assets/icon.png", "userInterfaceStyle": "light", @@ -19,7 +19,7 @@ "ios": { "supportsTablet": true, "bundleIdentifier": "io.sentry.expo.sample", - "buildNumber": "17" + "buildNumber": "18" }, "android": { "adaptiveIcon": { @@ -27,7 +27,7 @@ "backgroundColor": "#ffffff" }, "package": "io.sentry.expo.sample", - "versionCode": 17 + "versionCode": 18 }, "web": { "bundler": "metro", diff --git a/samples/expo/package.json b/samples/expo/package.json index 1645fed671..67601f48bf 100644 --- a/samples/expo/package.json +++ b/samples/expo/package.json @@ -1,6 +1,6 @@ { "name": "sentry-react-native-expo-sample", - "version": "5.29.0", + "version": "6.0.0-alpha.0", "main": "expo-router/entry", "scripts": { "start": "expo start", diff --git a/samples/react-native/android/app/build.gradle b/samples/react-native/android/app/build.gradle index a7c769eee9..37efe6c518 100644 --- a/samples/react-native/android/app/build.gradle +++ b/samples/react-native/android/app/build.gradle @@ -134,8 +134,8 @@ android { applicationId "io.sentry.reactnative.sample" minSdkVersion rootProject.ext.minSdkVersion targetSdkVersion rootProject.ext.targetSdkVersion - versionCode 20 - versionName "5.29.0" + versionCode 21 + versionName "6.0.0-alpha.0" } signingConfigs { diff --git a/samples/react-native/ios/sentryreactnativesample/Info.plist b/samples/react-native/ios/sentryreactnativesample/Info.plist index 54fb4ca448..fe67d75f08 100644 --- a/samples/react-native/ios/sentryreactnativesample/Info.plist +++ b/samples/react-native/ios/sentryreactnativesample/Info.plist @@ -17,11 +17,11 @@ CFBundlePackageType APPL CFBundleShortVersionString - 5.29.0 + 6.0.0 CFBundleSignature ???? CFBundleVersion - 24 + 25 LSRequiresIPhoneOS NSAppTransportSecurity diff --git a/samples/react-native/ios/sentryreactnativesampleTests/Info.plist b/samples/react-native/ios/sentryreactnativesampleTests/Info.plist index 5aa239c641..f79e3c26ee 100644 --- a/samples/react-native/ios/sentryreactnativesampleTests/Info.plist +++ b/samples/react-native/ios/sentryreactnativesampleTests/Info.plist @@ -15,10 +15,10 @@ CFBundlePackageType BNDL CFBundleShortVersionString - 5.29.0 + 6.0.0 CFBundleSignature ???? CFBundleVersion - 24 + 25 diff --git a/samples/react-native/package.json b/samples/react-native/package.json index c7fee1c6a4..89dafa647f 100644 --- a/samples/react-native/package.json +++ b/samples/react-native/package.json @@ -1,6 +1,6 @@ { "name": "sentry-react-native-sample", - "version": "5.29.0", + "version": "6.0.0-alpha.0", "private": true, "scripts": { "postinstall": "patch-package", diff --git a/src/js/version.ts b/src/js/version.ts index 5dcfeab5c1..d09d338d79 100644 --- a/src/js/version.ts +++ b/src/js/version.ts @@ -1,3 +1,3 @@ export const SDK_PACKAGE_NAME = 'npm:@sentry/react-native'; export const SDK_NAME = 'sentry.javascript.react-native'; -export const SDK_VERSION = '5.29.0'; +export const SDK_VERSION = '6.0.0-alpha.0'; From 3c481841da5419773d3b7cafcb93d3c9d86ce753 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Wed, 14 Aug 2024 12:57:41 +0200 Subject: [PATCH 16/48] Update CHANGELOG.md --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 43cda1f349..8af577c278 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -343,7 +343,6 @@ This release does *not* build on iOS. Please use `5.23.1` or newer. ### Fixes - Remove unused `rnpm` config ([#3811](https://github.com/getsentry/sentry-react-native/pull/3811)) -- CaptureMessage stack-trace is now symbolicated ([#3635](https://github.com/getsentry/sentry-react-native/pull/3635)) ### Dependencies From baa02175b811862dfe7b587b18deb80fba306732 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Fri, 16 Aug 2024 12:24:48 +0200 Subject: [PATCH 17/48] misc(tests): Add type check to tests (#4017) --- jest.config.js | 16 +++++--- package.json | 1 + src/js/profiling/integration.ts | 2 +- src/js/tools/metroconfig.ts | 3 +- src/js/tracing/reactnavigation.ts | 1 - test/client.test.ts | 15 ++++--- test/integrations/spotlight.test.ts | 3 +- test/mockConsole.ts | 2 + test/mockWrapper.ts | 5 +++ test/scopeSync.test.ts | 1 + test/sdk.test.ts | 16 ++++---- test/sdk.withclient.test.ts | 4 +- test/testutils.ts | 12 ------ test/tools/metroconfig.test.ts | 14 ++++++- .../tracing/integrations/nativeframes.test.ts | 4 +- .../stalltracking.background.test.ts | 19 +++++++-- .../stalltracking.iteration.test.ts | 21 ++++++++-- test/tracing/mockedtimetodisplaynative.tsx | 2 +- test/tracing/reactnavigation.ttid.test.tsx | 20 ++++----- test/tracing/timetodisplay.test.tsx | 4 +- test/utils/mockedSentryeventemitter.ts | 2 +- test/utils/safe.test.ts | 8 ++-- test/vendor/base64-js/big-data.test.ts | 3 +- test/vendor/buffer/utf8ToBytes.test.ts | 2 - test/wrapper.test.ts | 18 +++++--- yarn.lock | 41 ++++++++++++++++++- 26 files changed, 159 insertions(+), 80 deletions(-) diff --git a/jest.config.js b/jest.config.js index 902b0a443b..f851092fd3 100644 --- a/jest.config.js +++ b/jest.config.js @@ -4,13 +4,17 @@ module.exports = { setupFilesAfterEnv: ['jest-extended/all', '/test/mockConsole.ts'], globals: { __DEV__: true, - 'ts-jest': { - tsConfig: './tsconfig.json', - diagnostics: false, - }, }, - moduleFileExtensions: ['ts', 'tsx', 'js'], + transform: { + '^.+\\.jsx$': 'babel-jest', + '^.+\\.tsx?$': [ + 'ts-jest', + { + tsconfig: 'tsconfig.json', + }, + ], + }, + moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'], testPathIgnorePatterns: ['/test/e2e/', '/test/tools/', '/test/react-native/versions'], - testEnvironment: 'node', testMatch: ['**/*.test.(ts|tsx)'], }; diff --git a/package.json b/package.json index 1125263926..54fc0cb578 100644 --- a/package.json +++ b/package.json @@ -83,6 +83,7 @@ "@sentry-internal/eslint-plugin-sdk": "8.11.0", "@sentry-internal/typescript": "8.11.0", "@sentry/wizard": "3.16.3", + "@testing-library/react-native": "^12.5.3", "@types/jest": "^29.5.3", "@types/node": "^20.9.3", "@types/react": "^18.2.64", diff --git a/src/js/profiling/integration.ts b/src/js/profiling/integration.ts index 584b000410..0859b16971 100644 --- a/src/js/profiling/integration.ts +++ b/src/js/profiling/integration.ts @@ -36,7 +36,7 @@ export const hermesProfilingIntegration: IntegrationFn = () => { startTimestampNs: number; } | undefined; - let _currentProfileTimeout: number | undefined; + let _currentProfileTimeout: ReturnType | undefined; let isReady: boolean = false; const setupOnce = (): void => { diff --git a/src/js/tools/metroconfig.ts b/src/js/tools/metroconfig.ts index 6e58544757..9922924910 100644 --- a/src/js/tools/metroconfig.ts +++ b/src/js/tools/metroconfig.ts @@ -1,5 +1,6 @@ import { logger } from '@sentry/utils'; -import type { MetroConfig, MixedOutput, Module, ReadOnlyGraph } from 'metro'; +import type { MixedOutput, Module, ReadOnlyGraph } from 'metro'; +import type { MetroConfig } from 'metro-config'; import * as process from 'process'; import { env } from 'process'; diff --git a/src/js/tracing/reactnavigation.ts b/src/js/tracing/reactnavigation.ts index 7948af888b..2639cd7402 100644 --- a/src/js/tracing/reactnavigation.ts +++ b/src/js/tracing/reactnavigation.ts @@ -242,7 +242,6 @@ export const reactNavigationIntegration = ({ } const routeHasBeenSeen = recentRouteKeys.includes(route.key); - const latestTtidSpan = !routeHasBeenSeen && enableTimeToInitialDisplay && diff --git a/test/client.test.ts b/test/client.test.ts index dee71e7763..86dcdadba0 100644 --- a/test/client.test.ts +++ b/test/client.test.ts @@ -2,7 +2,7 @@ import * as mockedtimetodisplaynative from './tracing/mockedtimetodisplaynative' jest.mock('../src/js/tracing/timetodisplaynative', () => mockedtimetodisplaynative); import { defaultStackParser } from '@sentry/browser'; -import type { Envelope, Event, Outcome, Transport } from '@sentry/types'; +import type { Envelope, Event, Outcome, Transport, TransportMakeRequestResponse } from '@sentry/types'; import { rejectedSyncPromise, SentryError } from '@sentry/utils'; import * as RN from 'react-native'; @@ -104,7 +104,6 @@ describe('Tests ReactNativeClient', () => { }); await expect(client.eventFromMessage('test')).resolves.toBeDefined(); - // @ts-expect-error: Is Mocked await expect(RN.LogBox.ignoreLogs).toBeCalled(); }); @@ -133,7 +132,7 @@ describe('Tests ReactNativeClient', () => { }); test('use custom transport function', async () => { - const mySend = (_request: Envelope) => Promise.resolve(); + const mySend = (_request: Envelope): Promise => Promise.resolve({}); const myFlush = (timeout?: number) => Promise.resolve(Boolean(timeout)); const myCustomTransportFn = (): Transport => ({ send: mySend, @@ -408,7 +407,7 @@ describe('Tests ReactNativeClient', () => { describe('event data enhancement', () => { test('event contains sdk default information', async () => { - const mockedSend = jest.fn, [Envelope]>().mockResolvedValue(undefined); + const mockedSend = jest.fn, [Envelope]>().mockResolvedValue({}); const mockedTransport = (): Transport => ({ send: mockedSend, flush: jest.fn().mockResolvedValue(true), @@ -436,7 +435,7 @@ describe('Tests ReactNativeClient', () => { describe('normalizes events', () => { test('handles circular input', async () => { - const mockedSend = jest.fn, [Envelope]>(); + const mockedSend = jest.fn, [Envelope]>().mockResolvedValue({}); const mockedTransport = (): Transport => ({ send: mockedSend, flush: jest.fn().mockResolvedValue(true), @@ -469,7 +468,7 @@ describe('Tests ReactNativeClient', () => { describe('clientReports', () => { test('does not send client reports if disabled', () => { - const mockTransportSend = jest.fn((_envelope: Envelope) => Promise.resolve()); + const mockTransportSend = jest.fn, [Envelope]>().mockResolvedValue({}); const client = new ReactNativeClient({ ...DEFAULT_OPTIONS, dsn: EXAMPLE_DSN, @@ -488,7 +487,7 @@ describe('Tests ReactNativeClient', () => { }); test('send client reports on event envelope', () => { - const mockTransportSend = jest.fn((_envelope: Envelope) => Promise.resolve()); + const mockTransportSend = jest.fn, [Envelope]>().mockResolvedValue({}); const client = new ReactNativeClient({ ...DEFAULT_OPTIONS, dsn: EXAMPLE_DSN, @@ -522,7 +521,7 @@ describe('Tests ReactNativeClient', () => { }); test('does not send empty client report', () => { - const mockTransportSend = jest.fn((_envelope: Envelope) => Promise.resolve()); + const mockTransportSend = jest.fn, [Envelope]>().mockResolvedValue({}); const client = new ReactNativeClient({ ...DEFAULT_OPTIONS, dsn: EXAMPLE_DSN, diff --git a/test/integrations/spotlight.test.ts b/test/integrations/spotlight.test.ts index 13bdfaf6c9..306580d669 100644 --- a/test/integrations/spotlight.test.ts +++ b/test/integrations/spotlight.test.ts @@ -1,11 +1,10 @@ import type { HttpRequestEventMap } from '@mswjs/interceptors'; import { XMLHttpRequestInterceptor } from '@mswjs/interceptors/XMLHttpRequest'; import type { Client, Envelope } from '@sentry/types'; -import { XMLHttpRequest } from 'xmlhttprequest'; import { spotlightIntegration } from '../../src/js/integrations/spotlight'; -globalThis.XMLHttpRequest = XMLHttpRequest; +globalThis.XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest; const requestListener = jest.fn(); const interceptor = new XMLHttpRequestInterceptor(); interceptor.on('request', requestListener); diff --git a/test/mockConsole.ts b/test/mockConsole.ts index ac2409d0e0..025071ce14 100644 --- a/test/mockConsole.ts +++ b/test/mockConsole.ts @@ -6,3 +6,5 @@ global.console = { warn: jest.fn(), error: jest.fn(), }; + +export {}; diff --git a/test/mockWrapper.ts b/test/mockWrapper.ts index 360211a40a..3cbb789ba7 100644 --- a/test/mockWrapper.ts +++ b/test/mockWrapper.ts @@ -53,6 +53,9 @@ const NATIVE: MockInterface = { fetchNativeStackFramesBy: jest.fn(), initNativeReactNavigationNewFrameTracking: jest.fn(), + + captureReplay: jest.fn(), + getCurrentReplayId: jest.fn(), }; NATIVE.isNativeAvailable.mockReturnValue(true); @@ -74,6 +77,8 @@ NATIVE.stopProfiling.mockReturnValue(null); NATIVE.fetchNativePackageName.mockReturnValue('mock-native-package-name'); NATIVE.fetchNativeStackFramesBy.mockReturnValue(null); NATIVE.initNativeReactNavigationNewFrameTracking.mockReturnValue(Promise.resolve()); +NATIVE.captureReplay.mockResolvedValue(null); +NATIVE.getCurrentReplayId.mockReturnValue(null); export const getRNSentryModule = jest.fn(); diff --git a/test/scopeSync.test.ts b/test/scopeSync.test.ts index e6f7e161fe..fc0635aa95 100644 --- a/test/scopeSync.test.ts +++ b/test/scopeSync.test.ts @@ -179,6 +179,7 @@ describe('ScopeSync', () => { it('addBreadcrumb', () => { expect(SentryCore.getIsolationScope().addBreadcrumb).not.toBe(addBreadcrumbScopeSpy); + SentryCore.getIsolationScope().getLastBreadcrumb = jest.fn(() => ({ message: 'test' })); SentryCore.addBreadcrumb({ message: 'test' }); expect(NATIVE.addBreadcrumb).toHaveBeenCalledExactlyOnceWith(expect.objectContaining({ message: 'test' })); diff --git a/test/sdk.test.ts b/test/sdk.test.ts index 6fcea1ac67..e01a7b4a8b 100644 --- a/test/sdk.test.ts +++ b/test/sdk.test.ts @@ -1,11 +1,3 @@ -jest.spyOn(logger, 'error'); -jest.mock('../src/js/wrapper', () => jest.requireActual('./mockWrapper')); -jest.mock('../src/js/utils/environment'); -jest.mock('@sentry/core', () => ({ - ...jest.requireActual('@sentry/core'), - initAndBind: jest.fn(), -})); - import { initAndBind } from '@sentry/core'; import { makeFetchTransport } from '@sentry/react'; import type { BaseTransportOptions, ClientOptions, Integration, Scope } from '@sentry/types'; @@ -19,6 +11,14 @@ import { getDefaultEnvironment, isExpoGo, notWeb } from '../src/js/utils/environ import { NATIVE } from './mockWrapper'; import { firstArg, secondArg } from './testutils'; +jest.spyOn(logger, 'error'); +jest.mock('../src/js/wrapper', () => jest.requireActual('./mockWrapper')); +jest.mock('../src/js/utils/environment'); +jest.mock('@sentry/core', () => ({ + ...jest.requireActual('@sentry/core'), + initAndBind: jest.fn(), +})); + describe('Tests the SDK functionality', () => { beforeEach(() => { (NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => true); diff --git a/test/sdk.withclient.test.ts b/test/sdk.withclient.test.ts index 1ed8c1c309..1e3cb131a1 100644 --- a/test/sdk.withclient.test.ts +++ b/test/sdk.withclient.test.ts @@ -1,11 +1,11 @@ -jest.spyOn(logger, 'error'); - import { setCurrentClient } from '@sentry/core'; import { logger } from '@sentry/utils'; import { flush } from '../src/js/sdk'; import { getDefaultTestClientOptions, TestClient } from './mocks/client'; +jest.spyOn(logger, 'error'); + describe('Tests the SDK functionality', () => { let client: TestClient; diff --git a/test/testutils.ts b/test/testutils.ts index e73b64a688..4548eef092 100644 --- a/test/testutils.ts +++ b/test/testutils.ts @@ -1,9 +1,6 @@ -import { Transaction } from '@sentry/core'; import type { Session, Transport, UserFeedback } from '@sentry/types'; import { rejectedSyncPromise } from '@sentry/utils'; -import { getBlankTransactionContext } from '../src/js/tracing/utils'; - export type MockInterface = { [K in keyof T]: T[K] extends (...args: infer A) => infer B ? jest.Mock : T[K]; } & T; @@ -13,15 +10,6 @@ export function mockFunction any>(fn: T): jest.Moc return fn as jest.MockedFunction; } -export const getMockTransaction = (name: string): Transaction => { - const transaction = new Transaction(getBlankTransactionContext(name)); - - // Assume it's sampled - transaction.sampled = true; - - return transaction; -}; - export const firstArg = 0; export const secondArg = 1; export const envelopeHeader = 0; diff --git a/test/tools/metroconfig.test.ts b/test/tools/metroconfig.test.ts index a0ee9533ff..53ab6952e7 100644 --- a/test/tools/metroconfig.test.ts +++ b/test/tools/metroconfig.test.ts @@ -6,12 +6,17 @@ jest.mock('fs', () => { }; }); +import type { getDefaultConfig } from 'expo/metro-config'; import * as fs from 'fs'; import type { MetroConfig } from 'metro'; import * as path from 'path'; import * as process from 'process'; -import { withSentryBabelTransformer, withSentryFramesCollapsed } from '../../src/js/tools/metroconfig'; +import { + getSentryExpoConfig, + withSentryBabelTransformer, + withSentryFramesCollapsed, +} from '../../src/js/tools/metroconfig'; type MetroFrame = Parameters['symbolicator']>['customizeFrame']>[0]; @@ -20,6 +25,13 @@ describe('metroconfig', () => { jest.clearAllMocks(); }); + test('getSentryExpoConfig keeps compatible interface with Expos getDefaultConfig', () => { + const acceptsExpoDefaultConfigFactory = (_factory: typeof getDefaultConfig): void => { + expect(true).toBe(true); + }; + acceptsExpoDefaultConfigFactory(getSentryExpoConfig); + }); + describe('withSentryFramesCollapsed', () => { test('adds customizeFrames if undefined ', () => { const config = withSentryFramesCollapsed({}); diff --git a/test/tracing/integrations/nativeframes.test.ts b/test/tracing/integrations/nativeframes.test.ts index bcab5bcb2e..7c483b0b0a 100644 --- a/test/tracing/integrations/nativeframes.test.ts +++ b/test/tracing/integrations/nativeframes.test.ts @@ -156,7 +156,7 @@ describe('NativeFramesInstrumentation', () => { }); it('does not set measurements on transactions without startFrames', async () => { - const startFrames = null; + const startFrames: null = null; const finishFrames = { totalFrames: 200, slowFrames: 40, @@ -191,7 +191,7 @@ describe('NativeFramesInstrumentation', () => { slowFrames: 20, frozenFrames: 5, }; - const finishFrames = null; + const finishFrames: null = null; mockFunction(NATIVE.fetchNativeFrames).mockResolvedValueOnce(startFrames).mockResolvedValueOnce(finishFrames); await startSpan({ name: 'test' }, async () => { diff --git a/test/tracing/integrations/stallTracking/stalltracking.background.test.ts b/test/tracing/integrations/stallTracking/stalltracking.background.test.ts index c8174e3c3f..2358c77d1e 100644 --- a/test/tracing/integrations/stallTracking/stalltracking.background.test.ts +++ b/test/tracing/integrations/stallTracking/stalltracking.background.test.ts @@ -2,9 +2,20 @@ import type { AppStateStatus } from 'react-native'; import { stallTrackingIntegration } from '../../../../src/js/tracing/integrations/stalltracking'; +type StallTrackingWithTestProperties = ReturnType & { + isTracking: boolean; + _internalState: { + isBackground: boolean; + lastIntervalMs: number; + timeout: ReturnType | null; + iteration: () => void; + backgroundEventListener: (event: string) => void; + }; +}; + describe('BackgroundEventListener', () => { it('Stall tracking should set _isBackground to false, update _lastIntervalMs, and call _iteration when state is active and _timeout is not null', () => { - const stallTracking = stallTrackingIntegration(); + const stallTracking = stallTrackingIntegration() as StallTrackingWithTestProperties; const LOOP_TIMEOUT_INTERVAL_MS = 500; // Change this value based on your actual interval value const currentTime = Date.now(); stallTracking['_internalState']['lastIntervalMs'] = currentTime; @@ -18,14 +29,14 @@ describe('BackgroundEventListener', () => { jest.runOnlyPendingTimers(); // Fast-forward the timer to execute the timeout function }); it('Stall tracking should set _isBackground to true when state is not active', () => { - const stallTracking = stallTrackingIntegration(); + const stallTracking = stallTrackingIntegration() as StallTrackingWithTestProperties; stallTracking['_internalState']['isBackground'] = false; stallTracking['_internalState']['backgroundEventListener']('background' as AppStateStatus); // Check if _isBackground is set to true expect(stallTracking['_internalState']['isBackground']).toBe(true); }); it('Stall tracking should not call _iteration when state is active but _timeout is null', () => { - const stallTracking = stallTrackingIntegration(); + const stallTracking = stallTrackingIntegration() as StallTrackingWithTestProperties; stallTracking['_internalState']['timeout'] = null; // Mock _iteration stallTracking['_internalState']['iteration'] = jest.fn(); @@ -35,7 +46,7 @@ describe('BackgroundEventListener', () => { expect(stallTracking['_internalState']['iteration']).not.toBeCalled(); }); it('Stall tracking should call _iteration when state is active and _timeout is defined', () => { - const stallTracking = stallTrackingIntegration(); + const stallTracking = stallTrackingIntegration() as StallTrackingWithTestProperties; stallTracking['_internalState']['timeout'] = setTimeout(() => {}, 500); // Mock _iteration stallTracking['_internalState']['iteration'] = jest.fn(); // Create a fake timeout to simulate a running interval diff --git a/test/tracing/integrations/stallTracking/stalltracking.iteration.test.ts b/test/tracing/integrations/stallTracking/stalltracking.iteration.test.ts index 95b8506a09..53c6c84439 100644 --- a/test/tracing/integrations/stallTracking/stalltracking.iteration.test.ts +++ b/test/tracing/integrations/stallTracking/stalltracking.iteration.test.ts @@ -1,8 +1,21 @@ import { stallTrackingIntegration } from '../../../../src/js/tracing/integrations/stalltracking'; +type StallTrackingWithTestProperties = ReturnType & { + isTracking: boolean; + _internalState: { + isBackground: boolean; + lastIntervalMs: number; + timeout: ReturnType | null; + stallCount: number; + totalStallTime: number; + statsByTransaction: Map; + iteration: () => void; + }; +}; + describe('Iteration', () => { it('Stall tracking does not set _timeout when isTracking is false', () => { - const stallTracking = stallTrackingIntegration(); + const stallTracking = stallTrackingIntegration() as StallTrackingWithTestProperties; stallTracking['isTracking'] = false; stallTracking['_internalState']['isBackground'] = false; stallTracking['_internalState']['lastIntervalMs'] = Date.now() - 1000; // Force a timeout @@ -12,7 +25,7 @@ describe('Iteration', () => { expect(stallTracking['_internalState']['timeout']).toBeNull(); }); it('Stall tracking does not set _timeout when isBackground is true', () => { - const stallTracking = stallTrackingIntegration(); + const stallTracking = stallTrackingIntegration() as StallTrackingWithTestProperties; stallTracking['isTracking'] = true; stallTracking['_internalState']['isBackground'] = true; stallTracking['_internalState']['lastIntervalMs'] = Date.now() - 1000; // Force a timeout @@ -22,7 +35,7 @@ describe('Iteration', () => { expect(stallTracking['_internalState']['timeout']).toBeNull(); }); it('Stall tracking should set _timeout when isTracking is true and isBackground false', () => { - const stallTracking = stallTrackingIntegration(); + const stallTracking = stallTrackingIntegration() as StallTrackingWithTestProperties; stallTracking['isTracking'] = true; stallTracking['_internalState']['isBackground'] = false; jest.useFakeTimers(); @@ -32,7 +45,7 @@ describe('Iteration', () => { expect(stallTracking['_internalState']['timeout']).toBeDefined(); }); it('Stall tracking should update _stallCount and _totalStallTime when timeout condition is met', () => { - const stallTracking = stallTrackingIntegration(); + const stallTracking = stallTrackingIntegration() as StallTrackingWithTestProperties; const LOOP_TIMEOUT_INTERVAL_MS = 50; const _minimumStallThreshold = 100; // Call _iteration with totalTimeTaken >= LOOP_TIMEOUT_INTERVAL_MS + _minimumStallThreshold diff --git a/test/tracing/mockedtimetodisplaynative.tsx b/test/tracing/mockedtimetodisplaynative.tsx index 82d3ac822d..14c78fc5e0 100644 --- a/test/tracing/mockedtimetodisplaynative.tsx +++ b/test/tracing/mockedtimetodisplaynative.tsx @@ -1,4 +1,4 @@ -import React from 'react'; +import * as React from 'react'; import { View } from 'react-native'; import type { RNSentryOnDrawNextFrameEvent, RNSentryOnDrawReporterProps } from '../../src/js/tracing/timetodisplaynative.types'; diff --git a/test/tracing/reactnavigation.ttid.test.tsx b/test/tracing/reactnavigation.ttid.test.tsx index 6e0855390a..6065625057 100644 --- a/test/tracing/reactnavigation.ttid.test.tsx +++ b/test/tracing/reactnavigation.ttid.test.tsx @@ -1,3 +1,8 @@ +import type { Scope, Span, SpanJSON, TransactionEvent, Transport } from '@sentry/types'; +import { timestampInSeconds } from '@sentry/utils'; +import * as TestRenderer from '@testing-library/react-native' +import * as React from "react"; + import * as mockWrapper from '../mockWrapper'; import * as mockedSentryEventEmitter from '../utils/mockedSentryeventemitter'; import * as mockedtimetodisplaynative from './mockedtimetodisplaynative'; @@ -6,13 +11,8 @@ jest.mock('../../src/js/utils/environment'); jest.mock('../../src/js/utils/sentryeventemitter', () => mockedSentryEventEmitter); jest.mock('../../src/js/tracing/timetodisplaynative', () => mockedtimetodisplaynative); -import { startSpanManual } from '@sentry/core'; -import type { Scope, Span,SpanJSON, TransactionEvent, Transport } from '@sentry/types'; -import { timestampInSeconds } from '@sentry/utils'; -import React from "react"; -import TestRenderer from 'react-test-renderer'; - import * as Sentry from '../../src/js'; +import { startSpanManual } from '../../src/js'; import { TimeToFullDisplay, TimeToInitialDisplay } from '../../src/js/tracing'; import { _setAppStartEndTimestampMs } from '../../src/js/tracing/integrations/appStart'; import { isHermesEnabled, notWeb } from '../../src/js/utils/environment'; @@ -275,7 +275,7 @@ describe('React Navigation - TTID', () => { mockedNavigation.finishAppStartNavigation(); mockedEventEmitter.emitNewFrameEvent(); - TestRenderer.create(); + TestRenderer.render(); emitNativeFullDisplayEvent(); jest.runOnlyPendingTimers(); // Flush ttid transaction @@ -344,7 +344,7 @@ describe('React Navigation - TTID', () => { mockedNavigation.finishAppStartNavigation(); mockedEventEmitter.emitNewFrameEvent(); - TestRenderer.create(); + TestRenderer.render(); emitNativeFullDisplayEvent(); jest.runOnlyPendingTimers(); // Flush ttid transaction @@ -442,7 +442,7 @@ describe('React Navigation - TTID', () => { jest.runOnlyPendingTimers(); // Flush app start transaction mockedNavigation.navigateToNewScreen(); - const timeToDisplayComponent = TestRenderer.create(); + const timeToDisplayComponent = TestRenderer.render(); mockedEventEmitter.emitNewFrameEvent(); timeToDisplayComponent.update(); @@ -479,7 +479,7 @@ describe('React Navigation - TTID', () => { mockedEventEmitter.emitNewFrameEvent(autoInitialDisplayEndTimestampMs); // Initialized too late auto instrumentation finished before manual - TestRenderer.create(); + TestRenderer.render(); emitNativeInitialDisplayEvent(secondInFutureTimestampMs()); jest.runOnlyPendingTimers(); // Flush transaction diff --git a/test/tracing/timetodisplay.test.tsx b/test/tracing/timetodisplay.test.tsx index 611c831101..0b2f80fafb 100644 --- a/test/tracing/timetodisplay.test.tsx +++ b/test/tracing/timetodisplay.test.tsx @@ -3,8 +3,8 @@ jest.mock('../../src/js/tracing/timetodisplaynative', () => mockedtimetodisplayn import { getActiveSpan, getCurrentScope, getGlobalScope, getIsolationScope, getSpanDescendants, setCurrentClient, spanToJSON, startSpanManual} from '@sentry/core'; import type { Event, Measurements, Span, SpanJSON} from '@sentry/types'; -import React from "react"; -import TestRenderer from 'react-test-renderer'; +import * as React from "react"; +import * as TestRenderer from 'react-test-renderer'; import { startTimeToFullDisplaySpan, startTimeToInitialDisplaySpan, TimeToFullDisplay, TimeToInitialDisplay } from '../../src/js/tracing/timetodisplay'; import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; diff --git a/test/utils/mockedSentryeventemitter.ts b/test/utils/mockedSentryeventemitter.ts index 3efc901b55..6849e460be 100644 --- a/test/utils/mockedSentryeventemitter.ts +++ b/test/utils/mockedSentryeventemitter.ts @@ -1,5 +1,5 @@ import { timestampInSeconds } from '@sentry/utils'; -import EventEmitter from 'events'; +import * as EventEmitter from 'events'; import type { NewFrameEvent, SentryEventEmitter } from '../../src/js/utils/sentryeventemitter'; import type { MockInterface } from '../testutils'; diff --git a/test/utils/safe.test.ts b/test/utils/safe.test.ts index a2e887122d..89e063bd35 100644 --- a/test/utils/safe.test.ts +++ b/test/utils/safe.test.ts @@ -38,14 +38,14 @@ describe('safe', () => { test('calls given function with correct args', () => { const mockFn = jest.fn(); const actualSafeFunction = safeTracesSampler(mockFn); - actualSafeFunction?.({ transactionContext: { name: 'foo' } }); + actualSafeFunction?.({ name: 'foo', transactionContext: { name: 'foo' } }); expect(mockFn).toBeCalledTimes(1); - expect(mockFn).toBeCalledWith({ transactionContext: { name: 'foo' } }); + expect(mockFn).toBeCalledWith({ name: 'foo', transactionContext: { name: 'foo' } }); }); test('calls given function amd return its result', () => { const mockFn = jest.fn(() => 0.5); const actualSafeFunction = safeTracesSampler(mockFn); - const actualResult = actualSafeFunction?.({ transactionContext: { name: 'foo' } }); + const actualResult = actualSafeFunction?.({ name: 'foo', transactionContext: { name: 'foo' } }); expect(mockFn).toBeCalledTimes(1); expect(actualResult).toBe(0.5); }); @@ -58,7 +58,7 @@ describe('safe', () => { throw 'Test error'; }); const actualSafeFunction = safeTracesSampler(mockFn); - const actualResult = actualSafeFunction?.({ transactionContext: { name: 'foo' } }); + const actualResult = actualSafeFunction?.({ name: 'foo', transactionContext: { name: 'foo' } }); expect(mockFn).toBeCalledTimes(1); expect(actualResult).toEqual(0); }); diff --git a/test/vendor/base64-js/big-data.test.ts b/test/vendor/base64-js/big-data.test.ts index 750336b0d9..db22201baa 100644 --- a/test/vendor/base64-js/big-data.test.ts +++ b/test/vendor/base64-js/big-data.test.ts @@ -25,7 +25,8 @@ import { base64StringFromByteArray } from '../../../src/js/vendor'; describe('base64-js', () => { - test('convert big data to base64', () => { + // eslint-disable-next-line jest/no-disabled-tests + test.skip('convert big data to base64', () => { const SIZE_2MB = 2e6; // scaled down from original 64MiB const big = new Uint8Array(SIZE_2MB); for (let i = 0, length = big.length; i < length; ++i) { diff --git a/test/vendor/buffer/utf8ToBytes.test.ts b/test/vendor/buffer/utf8ToBytes.test.ts index 07fcdb8af2..6b743fdb54 100644 --- a/test/vendor/buffer/utf8ToBytes.test.ts +++ b/test/vendor/buffer/utf8ToBytes.test.ts @@ -73,9 +73,7 @@ describe('Buffer utf8 tests', () => { describe('test strings', () => { for (const input of testCases) { it(`should encode "${input}"`, () => { - // @ts-expect-error The test run in node where Buffer is available const actual = Buffer.from(utf8ToBytes(input)); - // @ts-expect-error The test run in node where Buffer is available const expected = Buffer.from(input, 'utf8'); expect(actual).toEqual(expected); diff --git a/test/wrapper.test.ts b/test/wrapper.test.ts index 884fd1a83c..524fc0e604 100644 --- a/test/wrapper.test.ts +++ b/test/wrapper.test.ts @@ -96,7 +96,7 @@ describe('Tests Native Wrapper', () => { describe('startWithOptions', () => { test('calls native module', async () => { - await NATIVE.initNativeSdk({ dsn: 'test', enableNative: true }); + await NATIVE.initNativeSdk({ dsn: 'test', enableNative: true, mobileReplayOptions: undefined }); expect(RNSentry.initNativeSdk).toBeCalled(); }); @@ -104,7 +104,7 @@ describe('Tests Native Wrapper', () => { test('warns if there is no dsn', async () => { logger.warn = jest.fn(); - await NATIVE.initNativeSdk({ enableNative: true }); + await NATIVE.initNativeSdk({ enableNative: true, mobileReplayOptions: undefined }); expect(RNSentry.initNativeSdk).not.toBeCalled(); expect(logger.warn).toHaveBeenLastCalledWith( @@ -119,6 +119,7 @@ describe('Tests Native Wrapper', () => { dsn: 'test', enableNative: false, enableNativeNagger: true, + mobileReplayOptions: undefined, }); expect(RNSentry.initNativeSdk).not.toBeCalled(); @@ -132,6 +133,7 @@ describe('Tests Native Wrapper', () => { enableNative: true, autoInitializeNativeSdk: true, beforeSend: jest.fn(), + mobileReplayOptions: undefined, }); expect(RNSentry.initNativeSdk).toBeCalled(); @@ -147,6 +149,7 @@ describe('Tests Native Wrapper', () => { enableNative: true, autoInitializeNativeSdk: true, beforeBreadcrumb: jest.fn(), + mobileReplayOptions: undefined, }); expect(RNSentry.initNativeSdk).toBeCalled(); @@ -162,6 +165,7 @@ describe('Tests Native Wrapper', () => { enableNative: true, autoInitializeNativeSdk: true, beforeSendTransaction: jest.fn(), + mobileReplayOptions: undefined, }); expect(RNSentry.initNativeSdk).toBeCalled(); @@ -177,6 +181,7 @@ describe('Tests Native Wrapper', () => { enableNative: true, autoInitializeNativeSdk: true, integrations: [], + mobileReplayOptions: undefined, }); expect(RNSentry.initNativeSdk).toBeCalled(); @@ -194,6 +199,7 @@ describe('Tests Native Wrapper', () => { dsn: 'test', enableNative: true, autoInitializeNativeSdk: false, + mobileReplayOptions: undefined, }); expect(RNSentry.initNativeSdk).not.toBeCalled(); @@ -232,6 +238,7 @@ describe('Tests Native Wrapper', () => { logger.warn = jest.fn(); await NATIVE.initNativeSdk({ + mobileReplayOptions: undefined, dsn: 'test', enableNative: false, autoInitializeNativeSdk: false, @@ -282,7 +289,7 @@ describe('Tests Native Wrapper', () => { test('serializes class instances', async () => { class TestInstance { value: number = 0; - method = () => null; + method = (): null => null; } const event = { @@ -313,7 +320,7 @@ describe('Tests Native Wrapper', () => { }); test('does not call RNSentry at all if enableNative is false', async () => { try { - await NATIVE.initNativeSdk({ dsn: 'test-dsn', enableNative: false }); + await NATIVE.initNativeSdk({ dsn: 'test-dsn', enableNative: false, mobileReplayOptions: undefined }); // @ts-expect-error for testing, does not accept an empty class. await NATIVE.sendEnvelope({}); @@ -505,7 +512,7 @@ describe('Tests Native Wrapper', () => { expect(RNSentry.crash).toBeCalled(); }); test('does not call crash if enableNative is false', async () => { - await NATIVE.initNativeSdk({ dsn: 'test-dsn', enableNative: false }); + await NATIVE.initNativeSdk({ dsn: 'test-dsn', enableNative: false, mobileReplayOptions: undefined }); NATIVE.nativeCrash(); expect(RNSentry.crash).not.toBeCalled(); @@ -516,7 +523,6 @@ describe('Tests Native Wrapper', () => { test('serializes all user object keys', async () => { NATIVE.setUser({ email: 'hello@sentry.io', - // @ts-expect-error Intentional incorrect type to simulate using a double as an id (We had a user open an issue because this didn't work before) id: 3.14159265359, unique: 123, }); diff --git a/yarn.lock b/yarn.lock index 8bf3e0e793..9e9c7ac511 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4043,6 +4043,15 @@ "@types/react-test-renderer" ">=16.9.0" react-error-boundary "^3.1.0" +"@testing-library/react-native@^12.5.3": + version "12.5.3" + resolved "https://registry.yarnpkg.com/@testing-library/react-native/-/react-native-12.5.3.tgz#0ea753efed505698a79ba4a0d42d4b79cd272abc" + integrity sha512-wSaplzjx51OVJI7MU8Mi2kxwfW0dYETn3jqSVHxtIXmEnmlWXk6f69sEaBbzdp6iDzhFB5E6rDWveqf5V/ap2A== + dependencies: + jest-matcher-utils "^29.7.0" + pretty-format "^29.7.0" + redent "^3.0.0" + "@tootallnate/once@2": version "2.0.0" resolved "https://registry.yarnpkg.com/@tootallnate/once/-/once-2.0.0.tgz#f544a148d3ab35801c1f633a7441fd87c2e484bf" @@ -8949,7 +8958,7 @@ jest-config@^29.6.2: slash "^3.0.0" strip-json-comments "^3.1.1" -jest-diff@^29.0.0: +jest-diff@^29.0.0, jest-diff@^29.7.0: version "29.7.0" resolved "https://registry.yarnpkg.com/jest-diff/-/jest-diff-29.7.0.tgz#017934a66ebb7ecf6f205e84699be10afd70458a" integrity sha512-LMIgiIrhigmPrs03JHpxUh2yISK3vLFPkAodPeo0+BuF7wA2FoQbkEg1u8gBYBThncu7e1oEDUfIXVuTqLRUjw== @@ -9156,6 +9165,16 @@ jest-matcher-utils@^29.6.2: jest-get-type "^29.4.3" pretty-format "^29.6.2" +jest-matcher-utils@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-29.7.0.tgz#ae8fec79ff249fd592ce80e3ee474e83a6c44f12" + integrity sha512-sBkD+Xi9DtcChsI3L3u0+N0opgPYnCRPtGcQYrgXmR+hmt/fYfWAL0xRXYU8eWOdfuLgBe0YCW3AFtnRLagq/g== + dependencies: + chalk "^4.0.0" + jest-diff "^29.7.0" + jest-get-type "^29.6.3" + pretty-format "^29.7.0" + jest-message-util@^29.3.1: version "29.3.1" resolved "https://registry.yarnpkg.com/jest-message-util/-/jest-message-util-29.3.1.tgz#37bc5c468dfe5120712053dd03faf0f053bd6adb" @@ -10528,6 +10547,11 @@ mimic-fn@^4.0.0: resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-4.0.0.tgz#60a90550d5cb0b239cca65d893b1a53b29871ecc" integrity sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw== +min-indent@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/min-indent/-/min-indent-1.0.1.tgz#a63f681673b30571fbe8bc25686ae746eefa9869" + integrity sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg== + "minimatch@2 || 3", minimatch@^3.0.2, minimatch@^3.0.4, minimatch@^3.1.1, minimatch@^3.1.2: version "3.1.2" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" @@ -11987,6 +12011,14 @@ rechoir@^0.6.2: dependencies: resolve "^1.1.6" +redent@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/redent/-/redent-3.0.0.tgz#e557b7998316bb53c9f1f56fa626352c6963059f" + integrity sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg== + dependencies: + indent-string "^4.0.0" + strip-indent "^3.0.0" + reflect.getprototypeof@^1.0.4: version "1.0.4" resolved "https://registry.yarnpkg.com/reflect.getprototypeof/-/reflect.getprototypeof-1.0.4.tgz#aaccbf41aca3821b87bb71d9dcbc7ad0ba50a3f3" @@ -13098,6 +13130,13 @@ strip-final-newline@^3.0.0: resolved "https://registry.yarnpkg.com/strip-final-newline/-/strip-final-newline-3.0.0.tgz#52894c313fbff318835280aed60ff71ebf12b8fd" integrity sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw== +strip-indent@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/strip-indent/-/strip-indent-3.0.0.tgz#c32e1cee940b6b3432c771bc2c54bcce73cd3001" + integrity sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ== + dependencies: + min-indent "^1.0.0" + strip-json-comments@^3.1.0, strip-json-comments@^3.1.1: version "3.1.1" resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" From 3e633e878f769dc816c193a1b4ff10bc490599c3 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich Date: Tue, 27 Aug 2024 17:37:51 +0200 Subject: [PATCH 18/48] chore: update scripts/update-javascript.sh to 8.26.0 --- CHANGELOG.md | 8 ++ package.json | 16 +-- src/js/options.ts | 8 +- src/js/tracing/reactnativetracing.ts | 2 +- test/tracing/reactnativetracing.test.ts | 2 + yarn.lock | 162 ++++++++++++------------ 6 files changed, 106 insertions(+), 92 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3028317d0c..2eda788f82 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## Unreleased + +### Dependencies + +- Bump JavaScript SDK from v7.119.0 to v8.26.0 ([#3895](https://github.com/getsentry/sentry-react-native/pull/3895)) + - [changelog](https://github.com/getsentry/sentry-javascript/blob/develop/CHANGELOG.md#8260) + - [diff](https://github.com/getsentry/sentry-javascript/compare/7.119.0...8.26.0) + ## 6.0.0-alpha.0 This is an alpha version of the next major version of the Sentry React Native SDK 6.0.0. diff --git a/package.json b/package.json index 54fc0cb578..2754c68066 100644 --- a/package.json +++ b/package.json @@ -68,20 +68,20 @@ }, "dependencies": { "@sentry/babel-plugin-component-annotate": "2.20.1", - "@sentry/browser": "8.11.0", + "@sentry/browser": "8.26.0", "@sentry/cli": "2.31.2", - "@sentry/core": "8.11.0", - "@sentry/react": "8.11.0", - "@sentry/types": "8.11.0", - "@sentry/utils": "8.11.0" + "@sentry/core": "8.26.0", + "@sentry/react": "8.26.0", + "@sentry/types": "8.26.0", + "@sentry/utils": "8.26.0" }, "devDependencies": { "@babel/core": "^7.23.5", "@expo/metro-config": "0.17.5", "@mswjs/interceptors": "^0.25.15", - "@sentry-internal/eslint-config-sdk": "8.11.0", - "@sentry-internal/eslint-plugin-sdk": "8.11.0", - "@sentry-internal/typescript": "8.11.0", + "@sentry-internal/eslint-config-sdk": "8.26.0", + "@sentry-internal/eslint-plugin-sdk": "8.26.0", + "@sentry-internal/typescript": "8.26.0", "@sentry/wizard": "3.16.3", "@testing-library/react-native": "^12.5.3", "@types/jest": "^29.5.3", diff --git a/src/js/options.ts b/src/js/options.ts index f5979e3444..19dd2ed816 100644 --- a/src/js/options.ts +++ b/src/js/options.ts @@ -1,11 +1,15 @@ -import type { BrowserTransportOptions } from '@sentry/browser/types/transports/types'; -import type { ProfilerProps } from '@sentry/react/types/profiler'; +import type { makeFetchTransport } from '@sentry/browser'; +import type { Profiler } from '@sentry/react'; import type { CaptureContext, ClientOptions, Event, EventHint, Options } from '@sentry/types'; +import type * as React from 'react'; import { Platform } from 'react-native'; import type { TouchEventBoundaryProps } from './touchevents'; import { getExpoConstants } from './utils/expomodules'; +type ProfilerProps = React.ComponentProps; +type BrowserTransportOptions = Parameters[0]; + export interface BaseReactNativeOptions { /** * Enables native transport + device info + offline caching. diff --git a/src/js/tracing/reactnativetracing.ts b/src/js/tracing/reactnativetracing.ts index 7e66b5d30a..996c85c70d 100644 --- a/src/js/tracing/reactnativetracing.ts +++ b/src/js/tracing/reactnativetracing.ts @@ -94,7 +94,7 @@ export const reactNativeTracingIntegration = ( const setup = (client: Client): void => { addDefaultOpForSpanFrom(client); - instrumentOutgoingRequests({ + instrumentOutgoingRequests(client, { traceFetch: finalOptions.traceFetch, traceXHR: finalOptions.traceXHR, shouldCreateSpanForRequest: finalOptions.shouldCreateSpanForRequest, diff --git a/test/tracing/reactnativetracing.test.ts b/test/tracing/reactnativetracing.test.ts index 80ee392ed5..2b049f5edb 100644 --- a/test/tracing/reactnativetracing.test.ts +++ b/test/tracing/reactnativetracing.test.ts @@ -59,6 +59,7 @@ describe('ReactNativeTracing', () => { }); expect(instrumentOutgoingRequests).toBeCalledWith( + expect.anything(), expect.objectContaining({ tracePropagationTargets: ['test1', 'test2'], }), @@ -73,6 +74,7 @@ describe('ReactNativeTracing', () => { }); expect(instrumentOutgoingRequests).toBeCalledWith( + expect.anything(), expect.objectContaining({ tracePropagationTargets: ['localhost', /^\/(?!\/)/], }), diff --git a/yarn.lock b/yarn.lock index 9e9c7ac511..8ea19a4b4d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3743,22 +3743,22 @@ component-type "^1.2.1" join-component "^1.1.0" -"@sentry-internal/browser-utils@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/browser-utils/-/browser-utils-8.11.0.tgz#ee73594bde569608b0dd0c8aa499f8497dbb0f53" - integrity sha512-PCnmzeLm7eTdMleVWa1jbdNcB6M5R17CSX8oQF6A/5a2w9qW6HbjEwK6X4yc9MzsFXFaTNekvPQLMRhIE1MgpA== - dependencies: - "@sentry/core" "8.11.0" - "@sentry/types" "8.11.0" - "@sentry/utils" "8.11.0" - -"@sentry-internal/eslint-config-sdk@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-config-sdk/-/eslint-config-sdk-8.11.0.tgz#73009825229e8f1fd8053c42aca8409c94695610" - integrity sha512-Qhwnhx+rEuD6Y1Ar5u74nn51f+rOfqtkyYkVrfJRCH+ob+hTD92TjA4yWer9nzYaVpPJmh09vktyAVAlFDXoaQ== - dependencies: - "@sentry-internal/eslint-plugin-sdk" "8.11.0" - "@sentry-internal/typescript" "8.11.0" +"@sentry-internal/browser-utils@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/browser-utils/-/browser-utils-8.26.0.tgz#3c76015e1bddde6775e6a7e115fbb494f247fed1" + integrity sha512-O2Tj+WK33/ZVp5STnz6ZL0OO+/Idk2KqsH0ITQkQmyZ2z0kdzWOeqK7s7q3/My6rB1GfPcyqPcBBv4dVv92FYQ== + dependencies: + "@sentry/core" "8.26.0" + "@sentry/types" "8.26.0" + "@sentry/utils" "8.26.0" + +"@sentry-internal/eslint-config-sdk@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-config-sdk/-/eslint-config-sdk-8.26.0.tgz#f8181ab65453efcc9203fddd21d6cdfd6f461ebb" + integrity sha512-wM6rzTVq660Yay+LLiCuwZGCY/kjlQ/6TqiR1XgN1wAH7pOBIPRj/S4KWOnW/32Y7s6UHIt940hCx8vsl/xg6g== + dependencies: + "@sentry-internal/eslint-plugin-sdk" "8.26.0" + "@sentry-internal/typescript" "8.26.0" "@typescript-eslint/eslint-plugin" "^5.48.0" "@typescript-eslint/parser" "^5.48.0" eslint-config-prettier "^6.11.0" @@ -3768,39 +3768,39 @@ eslint-plugin-jsdoc "^30.0.3" eslint-plugin-simple-import-sort "^5.0.3" -"@sentry-internal/eslint-plugin-sdk@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-plugin-sdk/-/eslint-plugin-sdk-8.11.0.tgz#f79bdb65fc4b6b1e2bbe1400809cb890e783928f" - integrity sha512-1JVY3u2/4IRFuKzXjW6EJ4tbGVoQocWSi2f6xjUndN55cHJe94it/IrYFUnK1wjWOX4JIrJrmuow3yULgTD/Ag== +"@sentry-internal/eslint-plugin-sdk@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-plugin-sdk/-/eslint-plugin-sdk-8.26.0.tgz#9d08c3e342e6cabd2a0f423bd7cbaba3fe062314" + integrity sha512-p9flHwd7ITjcLCTcrhLztFCGPEJvR/txCwcA2gN3YrpAKmLcDxyICsWiYoqBQfk97rsJbADn2ZzxU9fQsZkJPA== -"@sentry-internal/feedback@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-8.11.0.tgz#72bfa11678dfa19857a3cf6943a05f0ddb72f12d" - integrity sha512-cMiFAuHP4jXCqWD7/UA5cvl0ee3hN5klAWTDVCZutnZ30pbUurg+nIggYBcaxdtLlqW6BCwyVs2nb/OB75CCSQ== +"@sentry-internal/feedback@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-8.26.0.tgz#c29a2a4d97d9a9b56344521f3dbb16e2c40d799e" + integrity sha512-hQtw1gg8n6ERK1UH47F7ZI1zOsbhu0J2VX+TrnkpaQR2FgxDW1oe9Ja6oCV4CQKuR4w+1ZI/Kj4imSt0K33kEw== dependencies: - "@sentry/core" "8.11.0" - "@sentry/types" "8.11.0" - "@sentry/utils" "8.11.0" + "@sentry/core" "8.26.0" + "@sentry/types" "8.26.0" + "@sentry/utils" "8.26.0" -"@sentry-internal/replay-canvas@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-8.11.0.tgz#c01c1385c426a39189bec151a74bc173b6068a4b" - integrity sha512-SrBFI0vwyeyUjibCbYfxzCNMd07QMDNoi+0SYzhBagp6ALbU8r/pa02JRsnr//qhZt2NOM6S2kks9e2VHr6hYg== +"@sentry-internal/replay-canvas@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-8.26.0.tgz#005e4ebed631d0e505e117d42ae8bc64748628d1" + integrity sha512-2CFQW6f9aJHIo/DqmqYa9PaYoLn1o36ywc0h8oyGrD4oPCbrnE5F++PmTdc71GBODu41HBn/yoCTLmxOD+UjpA== dependencies: - "@sentry-internal/replay" "8.11.0" - "@sentry/core" "8.11.0" - "@sentry/types" "8.11.0" - "@sentry/utils" "8.11.0" + "@sentry-internal/replay" "8.26.0" + "@sentry/core" "8.26.0" + "@sentry/types" "8.26.0" + "@sentry/utils" "8.26.0" -"@sentry-internal/replay@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/replay/-/replay-8.11.0.tgz#58c923fbae32204ad32e1e99c01c4040c1e06b2f" - integrity sha512-NyuHW1Ds2GGW6PjN7nnRl/XoM31Y/BUnOhhLbNmbxWj5mgWuUP/7tOlz2PhP0YqZxVteZ99QIssfSRgtYOeQlg== +"@sentry-internal/replay@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/replay/-/replay-8.26.0.tgz#7d01b1915343bf8ca3d9ef7500994d4a45f3785e" + integrity sha512-JDY7W2bswlp5c3483lKP4kcb75fHNwGNfwD8x8FsY9xMjv7nxeXjLpR5cCEk1XqPq2+n6w4j7mJOXhEXGiUIKg== dependencies: - "@sentry-internal/browser-utils" "8.11.0" - "@sentry/core" "8.11.0" - "@sentry/types" "8.11.0" - "@sentry/utils" "8.11.0" + "@sentry-internal/browser-utils" "8.26.0" + "@sentry/core" "8.26.0" + "@sentry/types" "8.26.0" + "@sentry/utils" "8.26.0" "@sentry-internal/tracing@7.76.0": version "7.76.0" @@ -3811,28 +3811,28 @@ "@sentry/types" "7.76.0" "@sentry/utils" "7.76.0" -"@sentry-internal/typescript@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/typescript/-/typescript-8.11.0.tgz#a4552bf3918671d6723b6ec1fd448180a94217b6" - integrity sha512-AsyiBomA0MCJulIV15+JWqabgfNj/2Wjsu3epAvGtjcNST7tCq0tfEwjXUv4JKGMORmkUqf1Js15wnu3HEXBUA== +"@sentry-internal/typescript@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/typescript/-/typescript-8.26.0.tgz#ffdb2bf903d91f188dcc8f4fc2b9603ff39db17a" + integrity sha512-v3dZ6QRTyMzJmOIOLXkE8F90uTOzmb9nCHtFysfM+kUyuR3PbnWy3YzlmqNm5CiDoY4mBUDJu+yz4MJA64gy/Q== "@sentry/babel-plugin-component-annotate@2.20.1": version "2.20.1" resolved "https://registry.yarnpkg.com/@sentry/babel-plugin-component-annotate/-/babel-plugin-component-annotate-2.20.1.tgz#204c63ed006a048f48f633876e1b8bacf87a9722" integrity sha512-4mhEwYTK00bIb5Y9UWIELVUfru587Vaeg0DQGswv4aIRHIiMKLyNqCEejaaybQ/fNChIZOKmvyqXk430YVd7Qg== -"@sentry/browser@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-8.11.0.tgz#9e0282a9136d138c8b6c001f0ac9face9a9ce18b" - integrity sha512-++5IrBpzkaAptNjAYnGTnQ2lCjmU6nlu/ABFjUTgi7Vu+ZNiY8qYKEUw65mSxD3EoFLt8IwtjvfAwSMVTB2q8w== +"@sentry/browser@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-8.26.0.tgz#749508ca8d1da857930f41430eb3a77102712f46" + integrity sha512-e5s6eKlwLZWzTwQcBwqyAGZMMuQROW9Z677VzwkSyREWAIkKjfH2VBxHATnNGc0IVkNHjD7iH3ixo3C0rLKM3w== dependencies: - "@sentry-internal/browser-utils" "8.11.0" - "@sentry-internal/feedback" "8.11.0" - "@sentry-internal/replay" "8.11.0" - "@sentry-internal/replay-canvas" "8.11.0" - "@sentry/core" "8.11.0" - "@sentry/types" "8.11.0" - "@sentry/utils" "8.11.0" + "@sentry-internal/browser-utils" "8.26.0" + "@sentry-internal/feedback" "8.26.0" + "@sentry-internal/replay" "8.26.0" + "@sentry-internal/replay-canvas" "8.26.0" + "@sentry/core" "8.26.0" + "@sentry/types" "8.26.0" + "@sentry/utils" "8.26.0" "@sentry/cli-darwin@2.31.2": version "2.31.2" @@ -3909,13 +3909,13 @@ "@sentry/types" "7.76.0" "@sentry/utils" "7.76.0" -"@sentry/core@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry/core/-/core-8.11.0.tgz#bd78d9b598b6658ad18c8e0457fdffcd5f95b51e" - integrity sha512-rZaM55j5Fw0IGb8lNXOTVoq7WR6JmUzm9x5cURGsjL9gzAurGl817oK3iyOvYQ3JZnfijjh0QF0SQr4NZHKbIg== +"@sentry/core@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry/core/-/core-8.26.0.tgz#0673a9e2c5b699cf1bde1ed073a345cc393577da" + integrity sha512-g/tVmTZD4GNbLFf++hKJfBpcCAtduFEMLnbfa9iT/QEZjlmP+EzY+GsH9bafM5VsNe8DiOUp+kJKWtShzlVdBA== dependencies: - "@sentry/types" "8.11.0" - "@sentry/utils" "8.11.0" + "@sentry/types" "8.26.0" + "@sentry/utils" "8.26.0" "@sentry/node@^7.69.0": version "7.76.0" @@ -3928,15 +3928,15 @@ "@sentry/utils" "7.76.0" https-proxy-agent "^5.0.0" -"@sentry/react@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry/react/-/react-8.11.0.tgz#324353df35f6e9a28448fabd7501577be2fbcd7f" - integrity sha512-EyPOxDyRwOMPHRCc1/+dlWygXb6+92d0AbVTo4C8ZPT67aMWiczMzZC9qVUN6OqDVrpKwHMYzRyCdsu5OIIWHw== +"@sentry/react@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry/react/-/react-8.26.0.tgz#b4e72b9759fbf7d3c5ed37bb5ceb2e94b0d10fd1" + integrity sha512-dYoC0xzcqq8zmNMFoTWidhA7mVd3RDz/nAUn6C8yK/hkKA7bUknYCkhpESGLZfHaGwSKzeXRXKd/o/cgUVM9eA== dependencies: - "@sentry/browser" "8.11.0" - "@sentry/core" "8.11.0" - "@sentry/types" "8.11.0" - "@sentry/utils" "8.11.0" + "@sentry/browser" "8.26.0" + "@sentry/core" "8.26.0" + "@sentry/types" "8.26.0" + "@sentry/utils" "8.26.0" hoist-non-react-statics "^3.3.2" "@sentry/types@7.76.0": @@ -3944,10 +3944,10 @@ resolved "https://registry.yarnpkg.com/@sentry/types/-/types-7.76.0.tgz#628c9899bfa82ea762708314c50fd82f2138587d" integrity sha512-vj6z+EAbVrKAXmJPxSv/clpwS9QjPqzkraMFk2hIdE/kii8s8kwnkBwTSpIrNc8GnzV3qYC4r3qD+BXDxAGPaw== -"@sentry/types@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry/types/-/types-8.11.0.tgz#613da07f91d58ad5b460b95550e64aa6159ee97f" - integrity sha512-kz9/d2uw7wEXcK8DnCrCuMI75hZnpVAjYr8mq1uatltOx+2JOYPNdaK6ispxXlhb5KXOnVWNgfVDbGlLp0w+Gg== +"@sentry/types@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry/types/-/types-8.26.0.tgz#c999fdd9e52587570f723d2370244bad8f79b571" + integrity sha512-zKmh6SWsJh630rpt7a9vP4Cm4m1C2gDTUqUiH565CajCL/4cePpNWYrNwalSqsOSL7B9OrczA1+n6a6XvND+ng== "@sentry/utils@7.76.0": version "7.76.0" @@ -3956,12 +3956,12 @@ dependencies: "@sentry/types" "7.76.0" -"@sentry/utils@8.11.0": - version "8.11.0" - resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-8.11.0.tgz#b8856db2c1cfc1835df8854cba20cea82f6c6e08" - integrity sha512-iDt5YVMYNgT151bPYVGo8XlpM0MHWy8DH+czmAiAlFTV7ns7lAeHGF6tsFYo7wOZOPDHxtF6F2CM7AvuYnOZGw== +"@sentry/utils@8.26.0": + version "8.26.0" + resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-8.26.0.tgz#c6629f0f2bc8cbc4fddd124770e9063b4e2d1c65" + integrity sha512-xvlPU9Hd2BlyT+FhWHGNwnxWqdVRk2AHnDtVcW4Ma0Ri5EwS+uy4Jeik5UkSv8C5RVb9VlxFmS8LN3I1MPJsLw== dependencies: - "@sentry/types" "8.11.0" + "@sentry/types" "8.26.0" "@sentry/wizard@3.16.3": version "3.16.3" From 5aa6aff28344fe0791cccc174116cce2a37cefcb Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Mon, 2 Sep 2024 16:45:38 +0200 Subject: [PATCH 19/48] ref: Change native frames from `traceId` to `spanId` (#4030) --- CHANGELOG.md | 4 + src/js/integrations/default.ts | 11 +- src/js/integrations/exports.ts | 3 +- src/js/tracing/integrations/nativeFrames.ts | 418 +++++++----------- src/js/utils/AsyncExpiringMap.ts | 163 +++++++ test/profiling/integration.test.ts | 1 + .../tracing/integrations/nativeframes.test.ts | 28 +- test/utils/AsyncExpiringMap.test.ts | 213 +++++++++ 8 files changed, 572 insertions(+), 269 deletions(-) create mode 100644 src/js/utils/AsyncExpiringMap.ts create mode 100644 test/utils/AsyncExpiringMap.test.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 7626f3625f..a9c1fba551 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## Unreleased +### Changes + +- Native Frames uses `spanId` to attach frames replacing `traceId` ([#4030](https://github.com/getsentry/sentry-react-native/pull/4030)) + ### Dependencies - Bump JavaScript SDK from v8.11.0 to v8.26.0 ([#3851](https://github.com/getsentry/sentry-react-native/pull/3851)) diff --git a/src/js/integrations/default.ts b/src/js/integrations/default.ts index 130dd2766b..3565534bb5 100644 --- a/src/js/integrations/default.ts +++ b/src/js/integrations/default.ts @@ -12,6 +12,8 @@ import { browserGlobalHandlersIntegration, browserLinkedErrorsIntegration, browserReplayIntegration, + createNativeFramesIntegrations, + createReactNativeRewriteFrames, debugSymbolicatorIntegration, dedupeIntegration, deviceContextIntegration, @@ -24,7 +26,6 @@ import { inboundFiltersIntegration, mobileReplayIntegration, modulesLoaderIntegration, - nativeFramesIntegration, nativeLinkedErrorsIntegration, nativeReleaseIntegration, reactNativeErrorHandlersIntegration, @@ -36,7 +37,6 @@ import { userInteractionIntegration, viewHierarchyIntegration, } from './exports'; -import { createReactNativeRewriteFrames } from './rewriteframes'; /** * Returns the default ReactNative integrations based on the current environment. @@ -104,8 +104,11 @@ export function getDefaultIntegrations(options: ReactNativeClientOptions): Integ if (hasTracingEnabled && options.enableAppStartTracking) { integrations.push(appStartIntegration()); } - if (hasTracingEnabled && options.enableNativeFramesTracking) { - integrations.push(nativeFramesIntegration()); + const nativeFramesIntegrationInstance = createNativeFramesIntegrations( + hasTracingEnabled && options.enableNativeFramesTracking, + ); + if (nativeFramesIntegrationInstance) { + integrations.push(nativeFramesIntegrationInstance); } if (hasTracingEnabled && options.enableStallTracking) { integrations.push(stallTrackingIntegration()); diff --git a/src/js/integrations/exports.ts b/src/js/integrations/exports.ts index 345be885a7..07cc3289a9 100644 --- a/src/js/integrations/exports.ts +++ b/src/js/integrations/exports.ts @@ -14,9 +14,10 @@ export { expoContextIntegration } from './expocontext'; export { spotlightIntegration } from './spotlight'; export { mobileReplayIntegration } from '../replay/mobilereplay'; export { appStartIntegration } from '../tracing/integrations/appStart'; -export { nativeFramesIntegration } from '../tracing/integrations/nativeFrames'; +export { nativeFramesIntegration, createNativeFramesIntegrations } from '../tracing/integrations/nativeFrames'; export { stallTrackingIntegration } from '../tracing/integrations/stalltracking'; export { userInteractionIntegration } from '../tracing/integrations/userInteraction'; +export { createReactNativeRewriteFrames } from './rewriteframes'; export { breadcrumbsIntegration, diff --git a/src/js/tracing/integrations/nativeFrames.ts b/src/js/tracing/integrations/nativeFrames.ts index 012e2d5349..cab5256850 100644 --- a/src/js/tracing/integrations/nativeFrames.ts +++ b/src/js/tracing/integrations/nativeFrames.ts @@ -1,18 +1,37 @@ -import { spanToJSON } from '@sentry/core'; import type { Client, Event, Integration, Measurements, MeasurementUnit, Span } from '@sentry/types'; import { logger, timestampInSeconds } from '@sentry/utils'; import type { NativeFramesResponse } from '../../NativeRNSentry'; -import type { ReactNativeClientOptions } from '../../options'; +import { AsyncExpiringMap } from '../../utils/AsyncExpiringMap'; import { isRootSpan } from '../../utils/span'; import { NATIVE } from '../../wrapper'; /** - * Timeout from the final native frames fetch to processing the associated transaction. - * If the transaction is not processed by this time, the native frames will be dropped - * and not added to the event. + * Timeout from the start of a span to fetching the associated native frames. */ -const FINAL_FRAMES_TIMEOUT_MS = 2000; +const FETCH_FRAMES_TIMEOUT_MS = 2_000; + +/** + * This is the time end frames data from the native layer will be + * kept in memory and waiting for the event processing. This ensures that spans + * which are never processed are not leaking memory. + */ +const END_FRAMES_TIMEOUT_MS = 2_000; + +/** + * This is the time start frames data from the native layer will be + * kept in memory and waiting for span end. This ensures that spans + * which never end or are not processed are not leaking memory. + */ +const START_FRAMES_TIMEOUT_MS = 60_000; + +/** + * A margin of error of 50ms is allowed for the async native bridge call. + * Anything larger would reduce the accuracy of our frames measurements. + */ +const MARGIN_OF_ERROR_SECONDS = 0.05; + +const INTEGRATION_NAME = 'NativeFrames'; export interface FramesMeasurements extends Measurements { frames_total: { value: number; unit: MeasurementUnit }; @@ -20,220 +39,163 @@ export interface FramesMeasurements extends Measurements { frames_frozen: { value: number; unit: MeasurementUnit }; } -/** The listeners for each native frames response, keyed by traceId. This must be global to avoid closure issues and reading outdated values. */ -const _framesListeners: Map void> = new Map(); +interface NativeFramesResponseWithTimestamp { + timestamp: number; + nativeFrames: NativeFramesResponse; +} -/** The native frames at the transaction finish time, keyed by traceId. This must be global to avoid closure issues and reading outdated values. */ -const _finishFrames: Map = new Map(); +export const createNativeFramesIntegrations = (enable: boolean | undefined): Integration | undefined => { + if (!enable && NATIVE.enableNative) { + // On Android this will free up resource when JS reloaded (native modules stay) and thus JS side of the SDK reinitialized. + NATIVE.disableNativeFramesTracking(); + return undefined; + } -/** - * A margin of error of 50ms is allowed for the async native bridge call. - * Anything larger would reduce the accuracy of our frames measurements. - */ -const MARGIN_OF_ERROR_SECONDS = 0.05; + return nativeFramesIntegration(); +}; /** * Instrumentation to add native slow/frozen frames measurements onto transactions. */ export const nativeFramesIntegration = (): Integration => { - const name: string = 'NativeFrames'; - /** The native frames at the finish time of the most recent span. */ - let _lastSpanFinishFrames: - | { - timestamp: number; - nativeFrames: NativeFramesResponse; - } - | undefined = undefined; - const _spanToNativeFramesAtStartMap: Map = new Map(); + let _lastChildSpanEndFrames: NativeFramesResponseWithTimestamp | null = null; + const _spanToNativeFramesAtStartMap: AsyncExpiringMap = new AsyncExpiringMap({ + ttl: START_FRAMES_TIMEOUT_MS, + }); + const _spanToNativeFramesAtEndMap: AsyncExpiringMap = + new AsyncExpiringMap({ ttl: END_FRAMES_TIMEOUT_MS }); /** * Hooks into the client start and end span events. */ const setup = (client: Client): void => { - const { enableNativeFramesTracking } = client.getOptions() as ReactNativeClientOptions; - - if (enableNativeFramesTracking && !NATIVE.enableNative) { - // Do not enable native frames tracking if native is not available. + if (!NATIVE.enableNative) { logger.warn( - '[ReactNativeTracing] NativeFramesTracking is not available on the Web, Expo Go and other platforms without native modules.', + `[${INTEGRATION_NAME}] This is not available on the Web, Expo Go and other platforms without native modules.`, ); - return; - } - - if (!enableNativeFramesTracking && NATIVE.enableNative) { - // Disable native frames tracking when native available and option is false. - NATIVE.disableNativeFramesTracking(); - return; - } - - if (!enableNativeFramesTracking) { - return; + return undefined; } NATIVE.enableNativeFramesTracking(); - - client.on('spanStart', _onSpanStart); - client.on('spanEnd', _onSpanFinish); - logger.log('[ReactNativeTracing] Native frames instrumentation initialized.'); - }; - - /** - * Adds frames measurements to an event. Called from a valid event processor. - * Awaits for finish frames if needed. - */ - const processEvent = (event: Event): Promise => { - return _processEvent(event); + client.on('spanStart', fetchStartFramesForSpan); + client.on('spanEnd', fetchEndFramesForSpan); }; - /** - * Fetches the native frames in background if the given span is a root span. - * - * @param {Span} rootSpan - The span that has started. - */ - const _onSpanStart = (rootSpan: Span): void => { + const fetchStartFramesForSpan = (rootSpan: Span): void => { if (!isRootSpan(rootSpan)) { return; } - logger.debug(`[NativeFrames] Fetching frames for root span start (${rootSpan.spanContext().spanId}).`); - - NATIVE.fetchNativeFrames() - .then(frames => { - if (!frames) { - logger.warn( - `[NativeFrames] Fetched frames for root span start (${ - rootSpan.spanContext().spanId - }), but no frames were returned.`, - ); - return; - } - - _spanToNativeFramesAtStartMap.set(rootSpan.spanContext().traceId, frames); - }) - .then(undefined, error => { - logger.error( - `[NativeFrames] Error while fetching frames for root span start (${rootSpan.spanContext().spanId})`, - error, - ); - }); + const spanId = rootSpan.spanContext().spanId; + logger.debug(`[${INTEGRATION_NAME}] Fetching frames for root span start (${spanId}).`); + _spanToNativeFramesAtStartMap.set( + spanId, + new Promise(resolve => { + fetchNativeFrames() + .then(frames => resolve(frames)) + .then(undefined, error => { + logger.debug(`[${INTEGRATION_NAME}] Error while fetching native frames.`, error); + resolve(null); + }); + }), + ); }; - /** - * Called on a span finish to fetch native frames to support transactions with trimEnd. - * Only to be called when a span does not have an end timestamp. - */ - const _onSpanFinish = (span: Span): void => { - if (isRootSpan(span)) { - return _onTransactionFinish(span); - } - + const fetchEndFramesForSpan = (span: Span): void => { const timestamp = timestampInSeconds(); + const spanId = span.spanContext().spanId; - void NATIVE.fetchNativeFrames() - .then(frames => { - if (!frames) { - return; - } - - _lastSpanFinishFrames = { - timestamp, - nativeFrames: frames, - }; - }) - .then(undefined, error => { - logger.error(`[NativeFrames] Error while fetching frames for child span end.`, error); - }); - }; + if (isRootSpan(span)) { + const hasStartFrames = _spanToNativeFramesAtStartMap.has(spanId); + if (!hasStartFrames) { + // We don't have start frames, won't be able to calculate the difference. + return; + } - /** - * To be called when a transaction is finished - */ - const _onTransactionFinish = (span: Span): void => { - _fetchFramesForTransaction(span).then(undefined, (reason: unknown) => { - logger.error( - `[NativeFrames] Error while fetching frames for root span start (${span.spanContext().spanId})`, - reason, + logger.debug(`[${INTEGRATION_NAME}] Fetch frames for root span end (${spanId}).`); + _spanToNativeFramesAtEndMap.set( + spanId, + new Promise(resolve => { + fetchNativeFrames() + .then(frames => { + resolve({ + timestamp, + nativeFrames: frames, + }); + }) + .then(undefined, error => { + logger.debug(`[${INTEGRATION_NAME}] Error while fetching native frames.`, error); + resolve(null); + }); + }), ); - }); + return undefined; + } else { + logger.debug(`[${INTEGRATION_NAME}] Fetch frames for child span end (${spanId}).`); + fetchNativeFrames() + .then(frames => { + _lastChildSpanEndFrames = { + timestamp, + nativeFrames: frames, + }; + }) + .catch(error => logger.debug(`[${INTEGRATION_NAME}] Error while fetching native frames.`, error)); + } }; - /** - * Returns the computed frames measurements and awaits for them if they are not ready yet. - */ - const _getFramesMeasurements = ( - traceId: string, - finalEndTimestamp: number, - startFrames: NativeFramesResponse, - ): Promise => { - if (_finishFrames.has(traceId)) { - logger.debug(`[NativeFrames] Native end frames already fetched for trace id (${traceId}).`); - return Promise.resolve(_prepareMeasurements(traceId, finalEndTimestamp, startFrames)); + const processEvent = async (event: Event): Promise => { + if ( + event.type !== 'transaction' || + !event.transaction || + !event.contexts || + !event.contexts.trace || + !event.timestamp || + !event.contexts.trace.span_id + ) { + return event; } - return new Promise(resolve => { - const timeout = setTimeout(() => { - logger.debug(`[NativeFrames] Native end frames listener removed by timeout for trace id (${traceId}).`); - _framesListeners.delete(traceId); - - resolve(null); - }, 2000); - - _framesListeners.set(traceId, () => { - logger.debug(`[NativeFrames] Native end frames listener called for trace id (${traceId}).`); - resolve(_prepareMeasurements(traceId, finalEndTimestamp, startFrames)); - - clearTimeout(timeout); - _framesListeners.delete(traceId); - }); - }); - }; + const traceOp = event.contexts.trace.op; + const spanId = event.contexts.trace.span_id; + const startFrames = await _spanToNativeFramesAtStartMap.pop(spanId); + if (!startFrames) { + logger.warn( + `[${INTEGRATION_NAME}] Start frames of transaction ${event.transaction} (eventId, ${event.event_id}) are missing, but the transaction already ended.`, + ); + return event; + } - /** - * Returns the computed frames measurements given ready data - */ - const _prepareMeasurements = ( - traceId: string, - finalEndTimestamp: number, // The actual transaction finish time. - startFrames: NativeFramesResponse, - ): FramesMeasurements | null => { - let finalFinishFrames: NativeFramesResponse | undefined; + const endFrames = await _spanToNativeFramesAtEndMap.pop(spanId); + let finalEndFrames: NativeFramesResponse | undefined; - const finish = _finishFrames.get(traceId); - if ( - finish && - finish.nativeFrames && + if (endFrames && isClose(endFrames.timestamp, event.timestamp)) { // Must be in the margin of error of the actual transaction finish time (finalEndTimestamp) - Math.abs(finish.timestamp - finalEndTimestamp) < MARGIN_OF_ERROR_SECONDS - ) { - logger.debug(`[NativeFrames] Using frames from root span end (traceId, ${traceId}).`); - finalFinishFrames = finish.nativeFrames; - } else if ( - _lastSpanFinishFrames && - Math.abs(_lastSpanFinishFrames.timestamp - finalEndTimestamp) < MARGIN_OF_ERROR_SECONDS - ) { + logger.debug(`[${INTEGRATION_NAME}] Using frames from root span end (spanId, ${spanId}).`); + finalEndFrames = endFrames.nativeFrames; + } else if (_lastChildSpanEndFrames && isClose(_lastChildSpanEndFrames.timestamp, event.timestamp)) { // Fallback to the last span finish if it is within the margin of error of the actual finish timestamp. // This should be the case for trimEnd. - logger.debug(`[NativeFrames] Using native frames from last span end (traceId, ${traceId}).`); - finalFinishFrames = _lastSpanFinishFrames.nativeFrames; + logger.debug(`[${INTEGRATION_NAME}] Using native frames from last child span end (spanId, ${spanId}).`); + finalEndFrames = _lastChildSpanEndFrames.nativeFrames; } else { logger.warn( - `[NativeFrames] Frames were collected within larger than margin of error delay for traceId (${traceId}). Dropping the inaccurate values.`, + `[${INTEGRATION_NAME}] Frames were collected within larger than margin of error delay for spanId (${spanId}). Dropping the inaccurate values.`, ); - return null; + return event; } const measurements = { frames_total: { - value: finalFinishFrames.totalFrames - startFrames.totalFrames, + value: finalEndFrames.totalFrames - startFrames.totalFrames, unit: 'none', }, frames_frozen: { - value: finalFinishFrames.frozenFrames - startFrames.frozenFrames, + value: finalEndFrames.frozenFrames - startFrames.frozenFrames, unit: 'none', }, frames_slow: { - value: finalFinishFrames.slowFrames - startFrames.slowFrames, + value: finalEndFrames.slowFrames - startFrames.slowFrames, unit: 'none', }, }; @@ -244,118 +206,52 @@ export const nativeFramesIntegration = (): Integration => { measurements.frames_total.value <= 0 ) { logger.warn( - `[NativeFrames] Detected zero slow or frozen frames. Not adding measurements to traceId (${traceId}).`, - ); - return null; - } - - return measurements; - }; - - /** - * Fetch finish frames for a transaction at the current time. Calls any awaiting listeners. - */ - const _fetchFramesForTransaction = async (span: Span): Promise => { - const traceId = spanToJSON(span).trace_id; - if (!traceId) { - return; - } - - const startFrames = _spanToNativeFramesAtStartMap.get(span.spanContext().traceId); - - // This timestamp marks when the finish frames were retrieved. It should be pretty close to the transaction finish. - const timestamp = timestampInSeconds(); - let finishFrames: NativeFramesResponse | null = null; - if (startFrames) { - finishFrames = await NATIVE.fetchNativeFrames(); - } - - _finishFrames.set(traceId, { - nativeFrames: finishFrames, - timestamp, - }); - - _framesListeners.get(traceId)?.(); - - setTimeout(() => _cancelEndFrames(span), FINAL_FRAMES_TIMEOUT_MS); - }; - - /** - * On a finish frames failure, we cancel the await. - */ - const _cancelEndFrames = (span: Span): void => { - const spanJSON = spanToJSON(span); - const traceId = spanJSON.trace_id; - if (!traceId) { - return; - } - - if (_finishFrames.has(traceId)) { - _finishFrames.delete(traceId); - - logger.log( - `[NativeFrames] Native frames timed out for ${spanJSON.op} transaction ${spanJSON.description}. Not adding native frames measurements.`, - ); - } - }; - - /** - * Adds frames measurements to an event. Called from a valid event processor. - * Awaits for finish frames if needed. - */ - const _processEvent = async (event: Event): Promise => { - if ( - event.type !== 'transaction' || - !event.transaction || - !event.contexts || - !event.contexts.trace || - !event.timestamp || - !event.contexts.trace.trace_id - ) { - return event; - } - - const traceOp = event.contexts.trace.op; - const traceId = event.contexts.trace.trace_id; - const startFrames = _spanToNativeFramesAtStartMap.get(traceId); - _spanToNativeFramesAtStartMap.delete(traceId); - if (!startFrames) { - logger.warn( - `[NativeFrames] Start frames of transaction ${event.transaction} (eventId, ${event.event_id}) are missing, but it already ended.`, - ); - return event; - } - - const measurements = await _getFramesMeasurements(traceId, event.timestamp, startFrames); - - if (!measurements) { - logger.log( - `[NativeFrames] Could not fetch native frames for ${traceOp} transaction ${event.transaction}. Not adding native frames measurements.`, + `[${INTEGRATION_NAME}] Detected zero slow or frozen frames. Not adding measurements to spanId (${spanId}).`, ); return event; } logger.log( - `[Measurements] Adding measurements to ${traceOp} transaction ${event.transaction}: ${JSON.stringify( + `[${INTEGRATION_NAME}] Adding measurements to ${traceOp} transaction ${event.transaction}: ${JSON.stringify( measurements, undefined, 2, )}`, ); - event.measurements = { ...(event.measurements ?? {}), ...measurements, }; - - _finishFrames.delete(traceId); - return event; }; return { - name, + name: INTEGRATION_NAME, setup, processEvent, }; }; + +function fetchNativeFrames(): Promise { + return new Promise((resolve, reject) => { + NATIVE.fetchNativeFrames() + .then(value => { + if (!value) { + reject('Native frames response is null.'); + return; + } + resolve(value); + }) + .then(undefined, error => { + reject(error); + }); + + setTimeout(() => { + reject('Fetching native frames took too long. Dropping frames.'); + }, FETCH_FRAMES_TIMEOUT_MS); + }); +} + +function isClose(t1: number, t2: number): boolean { + return Math.abs(t1 - t2) < MARGIN_OF_ERROR_SECONDS; +} diff --git a/src/js/utils/AsyncExpiringMap.ts b/src/js/utils/AsyncExpiringMap.ts new file mode 100644 index 0000000000..3f3906c9cd --- /dev/null +++ b/src/js/utils/AsyncExpiringMap.ts @@ -0,0 +1,163 @@ +/** + * A Map that automatically removes entries after their TTL has expired. + * + * The map is Promise-aware, meaning it will start TTL countdown only after the promise has resolved. + */ +export class AsyncExpiringMap { + private _ttl: number; + private _cleanupIntervalMs: number; + private _map: Map | null }>; + private _cleanupInterval: ReturnType; + + public constructor({ + cleanupInterval = 5_000, + ttl = 2_000, + }: { + cleanupInterval?: number; + ttl?: number; + } = {}) { + this._ttl = ttl; + this._map = new Map(); + this._cleanupIntervalMs = cleanupInterval; + this.startCleanup(); + } + + /** + * Set a key-value pair. + */ + public set(key: K, promise: PromiseLike | V): void { + if (!this._cleanupInterval) { + this.startCleanup(); + } + + if (typeof promise !== 'object' || !('then' in promise)) { + this._map.set(key, { value: promise, expiresAt: Date.now() + this._ttl, promise: null }); + return; + } + + const entry: { value: V | undefined; expiresAt: number | null; promise: PromiseLike | null } = { + value: undefined, + expiresAt: null, + promise, + }; + this._map.set(key, entry); + + promise.then( + value => { + entry.value = value; + entry.expiresAt = Date.now() + this._ttl; + entry.promise = null; + }, + () => { + entry.expiresAt = Date.now() + this._ttl; + entry.promise = null; + }, + ); + } + + /** + * Pops a key-value pair. + */ + public pop(key: K): PromiseLike | V | undefined { + const entry = this.get(key); + this._map.delete(key); + return entry; + } + + /** + * Get a value by key. + * + * If the values is expired it will be returned and removed from the map. + */ + public get(key: K): PromiseLike | V | undefined { + const entry = this._map.get(key); + + if (!entry) { + return undefined; + } + + if (entry.promise) { + return entry.promise; + } + + if (entry.expiresAt && entry.expiresAt <= Date.now()) { + this._map.delete(key); + } + + return entry.value; + } + + /** + * Check if a key exists in the map. + * + * If the key is expired it's not present in the map. + */ + public has(key: K): boolean { + const entry = this._map.get(key); + + if (!entry) { + return false; + } + + if (entry.promise) { + return true; + } + + if (entry.expiresAt && entry.expiresAt <= Date.now()) { + this._map.delete(key); + return false; + } + + return true; + } + + /** + * Get the remaining time to live of a key. + */ + public ttl(key: K): number | undefined { + const entry = this._map.get(key); + if (entry && entry.expiresAt) { + const remainingTime = entry.expiresAt - Date.now(); + return remainingTime > 0 ? remainingTime : 0; + } + return undefined; + } + + /** + * Remove expired entries. + */ + public cleanup(): void { + const now = Date.now(); + for (const [key, entry] of this._map.entries()) { + if (entry.expiresAt && entry.expiresAt <= now) { + this._map.delete(key); + } + } + const size = this._map.size; + if (!size) { + this.stopCleanup(); + } + } + + /** + * Clear all entries. + */ + public clear(): void { + clearInterval(this._cleanupInterval); + this._map.clear(); + } + + /** + * Stop the cleanup interval. + */ + public stopCleanup(): void { + clearInterval(this._cleanupInterval); + } + + /** + * Start the cleanup interval. + */ + public startCleanup(): void { + this._cleanupInterval = setInterval(() => this.cleanup(), this._cleanupIntervalMs); + } +} diff --git a/test/profiling/integration.test.ts b/test/profiling/integration.test.ts index 1488c7d4fc..6d6cb3ba07 100644 --- a/test/profiling/integration.test.ts +++ b/test/profiling/integration.test.ts @@ -340,6 +340,7 @@ function initTestClient( const options: Sentry.ReactNativeOptions = { dsn: MOCK_DSN, enableTracing: true, + enableNativeFramesTracking: false, _experiments: { profilesSampleRate: 1, }, diff --git a/test/tracing/integrations/nativeframes.test.ts b/test/tracing/integrations/nativeframes.test.ts index 7c483b0b0a..c5453dcc82 100644 --- a/test/tracing/integrations/nativeframes.test.ts +++ b/test/tracing/integrations/nativeframes.test.ts @@ -19,10 +19,16 @@ jest.mock('../../../src/js/wrapper', () => { jest.useFakeTimers({ advanceTimers: true }); +const mockDate = new Date(2024, 7, 14); // Set your desired mock date here +const originalDateNow = Date.now; // Store the original Date.now function + describe('NativeFramesInstrumentation', () => { let client: TestClient; + let asyncProcessorBeforeNativeFrames: (event: Event) => Promise = async (event: Event) => event; beforeEach(() => { + global.Date.now = jest.fn(() => mockDate.getTime()); + getCurrentScope().clear(); getIsolationScope().clear(); getGlobalScope().clear(); @@ -30,7 +36,13 @@ describe('NativeFramesInstrumentation', () => { const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, enableNativeFramesTracking: true, - integrations: [nativeFramesIntegration()], + integrations: [ + { + name: 'MockAsyncIntegration', + processEvent: e => asyncProcessorBeforeNativeFrames(e), + }, + nativeFramesIntegration(), + ], }); client = new TestClient(options); setCurrentClient(client); @@ -39,6 +51,7 @@ describe('NativeFramesInstrumentation', () => { afterEach(() => { jest.clearAllMocks(); + global.Date.now = originalDateNow; }); it('sets native frames measurements on a transaction event', async () => { @@ -216,6 +229,17 @@ describe('NativeFramesInstrumentation', () => { }); it('does not set measurements on a transaction event for which finishFrames times out.', async () => { + asyncProcessorBeforeNativeFrames = async (event: Event) => { + await Promise.resolve(); + await Promise.resolve(); + await Promise.resolve(); + + global.Date.now = jest.fn(() => mockDate.getTime() + 2100); // hardcoded final frames timeout 2000ms + await jest.runOnlyPendingTimersAsync(); + await jest.advanceTimersByTimeAsync(2100); // hardcoded final frames timeout 2000ms + return event; + }; + const startFrames = { totalFrames: 100, slowFrames: 20, @@ -232,8 +256,6 @@ describe('NativeFramesInstrumentation', () => { await Promise.resolve(); // native frames fetch is async call this will flush the start frames fetch promise }); - await jest.runOnlyPendingTimersAsync(); - await jest.advanceTimersByTimeAsync(2100); // hardcoded final frames timeout 2000ms await client.flush(); expect(client.event!).toBeOneOf([ diff --git a/test/utils/AsyncExpiringMap.test.ts b/test/utils/AsyncExpiringMap.test.ts new file mode 100644 index 0000000000..f8953d7e34 --- /dev/null +++ b/test/utils/AsyncExpiringMap.test.ts @@ -0,0 +1,213 @@ +import { AsyncExpiringMap } from '../../src/js/utils/AsyncExpiringMap'; + +describe('AsyncExpiringMap', () => { + let now = 0; + + beforeEach(() => { + jest.useFakeTimers(); + + now = 0; + jest.spyOn(global.performance, 'now').mockImplementation(() => now); + jest.spyOn(global.Date, 'now').mockImplementation(() => now); + }); + + afterEach(() => { + jest.runOnlyPendingTimers(); + jest.useRealTimers(); + jest.restoreAllMocks(); + }); + + it('retrieves a pending promise correctly', () => { + const map = new AsyncExpiringMap>(); + const promise = new Promise(resolve => setTimeout(() => resolve('value'), 1000)); + map.set('key1', promise); + + const retrievedValue = map.get('key1'); + expect(retrievedValue).toBe(promise); + }); + + it('retrieves a resolved promise value correctly', async () => { + const map = new AsyncExpiringMap>(); + const promise = Promise.resolve('value'); + map.set('key1', promise); + + await promise; + + const retrievedValue = map.get('key1'); + expect(retrievedValue).toEqual('value'); + }); + + it('removes a resolved promise after TTL', async () => { + const ttl = 2000; + const cleanupInterval = ttl / 2; + const map = new AsyncExpiringMap({ ttl, cleanupInterval }); + + let resolvePromise: (value: string) => void; + const promise = new Promise(resolve => { + resolvePromise = resolve; + }); + map.set('key2', promise); + + now += ttl; + jest.advanceTimersByTime(ttl); + expect(map.get('key2')).toBe(promise); + + resolvePromise('value'); + await promise; + + now += ttl; + jest.advanceTimersByTime(ttl); + + const retrievedValue = map.get('key2'); + expect(retrievedValue).toBeUndefined(); + }); + + it('handles rejected promises without crashing', async () => { + const cleanupInterval = 1000; + const ttl = 2000; + const map = new AsyncExpiringMap({ ttl, cleanupInterval }); + const rejectedPromise = Promise.reject('error'); + + map.set('key9', rejectedPromise); + await rejectedPromise.catch(() => {}); + + now += ttl; + jest.advanceTimersByTime(ttl); + + const retrievedValue = map.get('key9'); + expect(retrievedValue).toBeUndefined(); + }); + + it('returns expired value if not cleaned up yet', () => { + const ttl = 2000; + const cleanupInterval = 2 * ttl; + const map = new AsyncExpiringMap({ ttl, cleanupInterval }); + + map.set('key1', 'value1'); + now += ttl; + jest.advanceTimersByTime(ttl); + + const retrievedValue = map.get('key1'); + expect(retrievedValue).toBe('value1'); + }); + + it('has function cleans expired value if not cleaned up yet', () => { + const ttl = 2000; + const cleanupInterval = 2 * ttl; + const map = new AsyncExpiringMap({ ttl, cleanupInterval }); + + map.set('key1', 'value1'); + now += ttl; + jest.advanceTimersByTime(ttl); + + const hasKey = map.has('key1'); + expect(hasKey).toBeFalse(); + + const retrievedValue = map.get('key1'); + expect(retrievedValue).toBeUndefined(); + }); + + it('pop removes a key-value pair', () => { + const map = new AsyncExpiringMap(); + + map.set('key1', 'value'); + const retrievedValue = map.pop('key1'); + expect(retrievedValue).toBe('value'); + + const hasKeyAfterPop = map.has('key1'); + expect(hasKeyAfterPop).toBeFalse(); + }); + + it('does not delete unexpired keys during cleanup', () => { + const ttl = 5000; + const map = new AsyncExpiringMap({ ttl }); + + map.set('key3', 'value3'); + + now += 2000; + jest.advanceTimersByTime(2000); + map.cleanup(); + + const retrievedValue = map.get('key3'); + expect(retrievedValue).toBe('value3'); + }); + + it('clears all entries when clear is called', () => { + const map = new AsyncExpiringMap(); + + map.set('key4', 'value4'); + map.clear(); + + const retrievedValue = map.get('key4'); + expect(retrievedValue).toBeUndefined(); + }); + + it('stops cleanup when stopCleanup is called', () => { + const map = new AsyncExpiringMap(); + + map.set('key5', 'value5'); + map.stopCleanup(); + + now += 10000; + jest.advanceTimersByTime(10000); + expect(map.get('key5')).toBe('value5'); + }); + + it('restarts cleanup when startCleanup is called', () => { + const ttl = 2000; + const cleanupInterval = ttl / 2; + const map = new AsyncExpiringMap({ ttl, cleanupInterval }); + + map.set('key6', 'value6'); + map.stopCleanup(); + + now += ttl; + jest.advanceTimersByTime(ttl); + expect(map.get('key6')).toBe('value6'); + + map.startCleanup(); + now += ttl; + jest.advanceTimersByTime(ttl); + + const retrievedValue = map.get('key6'); + expect(retrievedValue).toBeUndefined(); + }); + + it('correctly reports the TTL of an existing entry', () => { + const ttl = 5000; + const map = new AsyncExpiringMap({ ttl }); + + map.set('key7', 'value7'); + now += 2000; + jest.advanceTimersByTime(2000); + + const remainingTTL = map.ttl('key7'); + expect(remainingTTL).toBeGreaterThan(0); + expect(remainingTTL).toBeLessThanOrEqual(ttl - 2000); + }); + + it('handles setting non-promise values correctly', () => { + const map = new AsyncExpiringMap(); + + map.set('key8', 'value8'); + const retrievedValue = map.get('key8'); + + expect(retrievedValue).toBe('value8'); + }); + + it('handles multiple entries with different TTLs correctly', () => { + const cleanupInterval = 1000; + const ttl = 2000; + const map = new AsyncExpiringMap({ ttl, cleanupInterval }); + + map.set('key10', 'value10'); + map.set('key11', 'value11'); + now += ttl; + jest.advanceTimersByTime(ttl); + map.set('key12', 'value12'); + + expect(map.get('key10')).toBeUndefined(); // Expired + expect(map.get('key11')).toBeUndefined(); // Expired + expect(map.get('key12')).toBe('value12'); // Not yet expired + }); +}); From 24b14d0ace4ccccab9df7171a418a4e72f5be462 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich Date: Mon, 2 Sep 2024 17:02:49 +0200 Subject: [PATCH 20/48] chore: update scripts/update-javascript.sh to 8.27.0 --- CHANGELOG.md | 6 +- package.json | 16 ++--- yarn.lock | 162 +++++++++++++++++++++++++-------------------------- 3 files changed, 92 insertions(+), 92 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a9c1fba551..bd4b0b8b1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,9 +8,9 @@ ### Dependencies -- Bump JavaScript SDK from v8.11.0 to v8.26.0 ([#3851](https://github.com/getsentry/sentry-react-native/pull/3851)) - - [changelog](https://github.com/getsentry/sentry-javascript/blob/develop/CHANGELOG.md#8260) - - [diff](https://github.com/getsentry/sentry-javascript/compare/8.11.0...8.26.0) +- Bump JavaScript SDK from v8.11.0 to v8.27.0 ([#3851](https://github.com/getsentry/sentry-react-native/pull/3851)) + - [changelog](https://github.com/getsentry/sentry-javascript/blob/develop/CHANGELOG.md#8270) + - [diff](https://github.com/getsentry/sentry-javascript/compare/8.11.0...8.27.0) ## 5.31.1 diff --git a/package.json b/package.json index 0955f83611..5edaeef28e 100644 --- a/package.json +++ b/package.json @@ -68,20 +68,20 @@ }, "dependencies": { "@sentry/babel-plugin-component-annotate": "2.20.1", - "@sentry/browser": "8.26.0", + "@sentry/browser": "8.27.0", "@sentry/cli": "2.34.0", - "@sentry/core": "8.26.0", - "@sentry/react": "8.26.0", - "@sentry/types": "8.26.0", - "@sentry/utils": "8.26.0" + "@sentry/core": "8.27.0", + "@sentry/react": "8.27.0", + "@sentry/types": "8.27.0", + "@sentry/utils": "8.27.0" }, "devDependencies": { "@babel/core": "^7.23.5", "@expo/metro-config": "0.17.5", "@mswjs/interceptors": "^0.25.15", - "@sentry-internal/eslint-config-sdk": "8.26.0", - "@sentry-internal/eslint-plugin-sdk": "8.26.0", - "@sentry-internal/typescript": "8.26.0", + "@sentry-internal/eslint-config-sdk": "8.27.0", + "@sentry-internal/eslint-plugin-sdk": "8.27.0", + "@sentry-internal/typescript": "8.27.0", "@sentry/wizard": "3.16.3", "@testing-library/react-native": "^12.5.3", "@types/jest": "^29.5.3", diff --git a/yarn.lock b/yarn.lock index 757dcb6558..771328e579 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3743,22 +3743,22 @@ component-type "^1.2.1" join-component "^1.1.0" -"@sentry-internal/browser-utils@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/browser-utils/-/browser-utils-8.26.0.tgz#3c76015e1bddde6775e6a7e115fbb494f247fed1" - integrity sha512-O2Tj+WK33/ZVp5STnz6ZL0OO+/Idk2KqsH0ITQkQmyZ2z0kdzWOeqK7s7q3/My6rB1GfPcyqPcBBv4dVv92FYQ== - dependencies: - "@sentry/core" "8.26.0" - "@sentry/types" "8.26.0" - "@sentry/utils" "8.26.0" - -"@sentry-internal/eslint-config-sdk@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-config-sdk/-/eslint-config-sdk-8.26.0.tgz#f8181ab65453efcc9203fddd21d6cdfd6f461ebb" - integrity sha512-wM6rzTVq660Yay+LLiCuwZGCY/kjlQ/6TqiR1XgN1wAH7pOBIPRj/S4KWOnW/32Y7s6UHIt940hCx8vsl/xg6g== - dependencies: - "@sentry-internal/eslint-plugin-sdk" "8.26.0" - "@sentry-internal/typescript" "8.26.0" +"@sentry-internal/browser-utils@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/browser-utils/-/browser-utils-8.27.0.tgz#b8fd1c5e6b8c01d76abbba7ac5017eebcf7d3ed2" + integrity sha512-YTIwQ1GM1NTRXgN4DvpFSQ2x4pjlqQ0FQAyHW5x2ZYv4z7VmqG4Xkid1P/srQUipECk6nxkebfD4WR19nLsvnQ== + dependencies: + "@sentry/core" "8.27.0" + "@sentry/types" "8.27.0" + "@sentry/utils" "8.27.0" + +"@sentry-internal/eslint-config-sdk@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-config-sdk/-/eslint-config-sdk-8.27.0.tgz#66930344394b6cdf64afdafbad8fbeea503286fb" + integrity sha512-JOx0DUWInhZ+g4IzhbctU+AZTx/GCIM9eX0w60uXxzsoiGCYpdmd/p51ZNmGPOcq2XFcxX+HC4pLGoKM/ptNXA== + dependencies: + "@sentry-internal/eslint-plugin-sdk" "8.27.0" + "@sentry-internal/typescript" "8.27.0" "@typescript-eslint/eslint-plugin" "^5.48.0" "@typescript-eslint/parser" "^5.48.0" eslint-config-prettier "^6.11.0" @@ -3768,39 +3768,39 @@ eslint-plugin-jsdoc "^30.0.3" eslint-plugin-simple-import-sort "^5.0.3" -"@sentry-internal/eslint-plugin-sdk@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-plugin-sdk/-/eslint-plugin-sdk-8.26.0.tgz#9d08c3e342e6cabd2a0f423bd7cbaba3fe062314" - integrity sha512-p9flHwd7ITjcLCTcrhLztFCGPEJvR/txCwcA2gN3YrpAKmLcDxyICsWiYoqBQfk97rsJbADn2ZzxU9fQsZkJPA== +"@sentry-internal/eslint-plugin-sdk@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/eslint-plugin-sdk/-/eslint-plugin-sdk-8.27.0.tgz#b9b45088589c713e3c751a7906a50d5d2f4244cf" + integrity sha512-71qBtnXIfeO+2iBsN8kIoIBq8RA5waQ/RikVVqlwHtfMQrhaFHpBHTNwGKGBKTxdzGageMU6vC9s6JCMWakF1w== -"@sentry-internal/feedback@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-8.26.0.tgz#c29a2a4d97d9a9b56344521f3dbb16e2c40d799e" - integrity sha512-hQtw1gg8n6ERK1UH47F7ZI1zOsbhu0J2VX+TrnkpaQR2FgxDW1oe9Ja6oCV4CQKuR4w+1ZI/Kj4imSt0K33kEw== +"@sentry-internal/feedback@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/feedback/-/feedback-8.27.0.tgz#46a4cbde49d7a1cb182792c28341a8c89249e6b1" + integrity sha512-b71PQc9aK1X9b/SO1DiJlrnAEx4n0MzPZQ/tKd9oRWDyGit6pJWZfQns9r2rvc96kJPMOTxFAa/upXRCkA723A== dependencies: - "@sentry/core" "8.26.0" - "@sentry/types" "8.26.0" - "@sentry/utils" "8.26.0" + "@sentry/core" "8.27.0" + "@sentry/types" "8.27.0" + "@sentry/utils" "8.27.0" -"@sentry-internal/replay-canvas@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-8.26.0.tgz#005e4ebed631d0e505e117d42ae8bc64748628d1" - integrity sha512-2CFQW6f9aJHIo/DqmqYa9PaYoLn1o36ywc0h8oyGrD4oPCbrnE5F++PmTdc71GBODu41HBn/yoCTLmxOD+UjpA== +"@sentry-internal/replay-canvas@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/replay-canvas/-/replay-canvas-8.27.0.tgz#24a154f37b200ed99bb99a39cf98c35f25c2b93b" + integrity sha512-uuEfiWbjwugB9M4KxXxovHYiKRqg/R6U4EF8xM/Ub4laUuEcWsfRp7lQ3MxL3qYojbca8ncIFic2bIoKMPeejA== dependencies: - "@sentry-internal/replay" "8.26.0" - "@sentry/core" "8.26.0" - "@sentry/types" "8.26.0" - "@sentry/utils" "8.26.0" + "@sentry-internal/replay" "8.27.0" + "@sentry/core" "8.27.0" + "@sentry/types" "8.27.0" + "@sentry/utils" "8.27.0" -"@sentry-internal/replay@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/replay/-/replay-8.26.0.tgz#7d01b1915343bf8ca3d9ef7500994d4a45f3785e" - integrity sha512-JDY7W2bswlp5c3483lKP4kcb75fHNwGNfwD8x8FsY9xMjv7nxeXjLpR5cCEk1XqPq2+n6w4j7mJOXhEXGiUIKg== +"@sentry-internal/replay@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/replay/-/replay-8.27.0.tgz#7762647930c3a9b3d99f6d4c486b28f9d3da70c2" + integrity sha512-Ofucncaon98dvlxte2L//hwuG9yILSxNrTz/PmO0k+HzB9q+oBic4667QF+azWR2qv4oKSWpc+vEovP3hVqveA== dependencies: - "@sentry-internal/browser-utils" "8.26.0" - "@sentry/core" "8.26.0" - "@sentry/types" "8.26.0" - "@sentry/utils" "8.26.0" + "@sentry-internal/browser-utils" "8.27.0" + "@sentry/core" "8.27.0" + "@sentry/types" "8.27.0" + "@sentry/utils" "8.27.0" "@sentry-internal/tracing@7.76.0": version "7.76.0" @@ -3811,28 +3811,28 @@ "@sentry/types" "7.76.0" "@sentry/utils" "7.76.0" -"@sentry-internal/typescript@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry-internal/typescript/-/typescript-8.26.0.tgz#ffdb2bf903d91f188dcc8f4fc2b9603ff39db17a" - integrity sha512-v3dZ6QRTyMzJmOIOLXkE8F90uTOzmb9nCHtFysfM+kUyuR3PbnWy3YzlmqNm5CiDoY4mBUDJu+yz4MJA64gy/Q== +"@sentry-internal/typescript@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry-internal/typescript/-/typescript-8.27.0.tgz#118f61036250b8671fcc92479389090dc9ebed6b" + integrity sha512-+hnzaMFaRWeF3SxEfeu80whtbcVkHVnAmHyFmJainf7boMs/RisTKjWqH9aMiqnC44x7a39CEZl9mDicxB2REw== "@sentry/babel-plugin-component-annotate@2.20.1": version "2.20.1" resolved "https://registry.yarnpkg.com/@sentry/babel-plugin-component-annotate/-/babel-plugin-component-annotate-2.20.1.tgz#204c63ed006a048f48f633876e1b8bacf87a9722" integrity sha512-4mhEwYTK00bIb5Y9UWIELVUfru587Vaeg0DQGswv4aIRHIiMKLyNqCEejaaybQ/fNChIZOKmvyqXk430YVd7Qg== -"@sentry/browser@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-8.26.0.tgz#749508ca8d1da857930f41430eb3a77102712f46" - integrity sha512-e5s6eKlwLZWzTwQcBwqyAGZMMuQROW9Z677VzwkSyREWAIkKjfH2VBxHATnNGc0IVkNHjD7iH3ixo3C0rLKM3w== +"@sentry/browser@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry/browser/-/browser-8.27.0.tgz#997eb6b3c298a659a109704a0fb660eae365cd3a" + integrity sha512-eL1eaHwoYUGkp4mpeYesH6WtCrm+0u9jYCW5Lm0MAeTmpx22BZKEmj0OljuUJXGnJwFbvPDlRjyz6QG11m8kZA== dependencies: - "@sentry-internal/browser-utils" "8.26.0" - "@sentry-internal/feedback" "8.26.0" - "@sentry-internal/replay" "8.26.0" - "@sentry-internal/replay-canvas" "8.26.0" - "@sentry/core" "8.26.0" - "@sentry/types" "8.26.0" - "@sentry/utils" "8.26.0" + "@sentry-internal/browser-utils" "8.27.0" + "@sentry-internal/feedback" "8.27.0" + "@sentry-internal/replay" "8.27.0" + "@sentry-internal/replay-canvas" "8.27.0" + "@sentry/core" "8.27.0" + "@sentry/types" "8.27.0" + "@sentry/utils" "8.27.0" "@sentry/cli-darwin@2.34.0": version "2.34.0" @@ -3909,13 +3909,13 @@ "@sentry/types" "7.76.0" "@sentry/utils" "7.76.0" -"@sentry/core@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry/core/-/core-8.26.0.tgz#0673a9e2c5b699cf1bde1ed073a345cc393577da" - integrity sha512-g/tVmTZD4GNbLFf++hKJfBpcCAtduFEMLnbfa9iT/QEZjlmP+EzY+GsH9bafM5VsNe8DiOUp+kJKWtShzlVdBA== +"@sentry/core@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry/core/-/core-8.27.0.tgz#a0ebe31cdd9313186a14d9738238ed9cf7a59c01" + integrity sha512-4frlXluHT3Du+Omw91K04jpvbfMtydvg4Bxj2+gt/DT19Swhm/fbEpzdUjgbAd3Jinj/n0qk/jFRXjr9JZKFjg== dependencies: - "@sentry/types" "8.26.0" - "@sentry/utils" "8.26.0" + "@sentry/types" "8.27.0" + "@sentry/utils" "8.27.0" "@sentry/node@^7.69.0": version "7.76.0" @@ -3928,15 +3928,15 @@ "@sentry/utils" "7.76.0" https-proxy-agent "^5.0.0" -"@sentry/react@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry/react/-/react-8.26.0.tgz#b4e72b9759fbf7d3c5ed37bb5ceb2e94b0d10fd1" - integrity sha512-dYoC0xzcqq8zmNMFoTWidhA7mVd3RDz/nAUn6C8yK/hkKA7bUknYCkhpESGLZfHaGwSKzeXRXKd/o/cgUVM9eA== +"@sentry/react@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry/react/-/react-8.27.0.tgz#3ff4b8ece65af170fe32102ecb8847b53c675ffd" + integrity sha512-8pD+J9UVnSGmPnm5dHJup5OVsHTN/pL4Ozi01yyrpivLkQiMZNac3OXsc0C7zXnztfLQx0kmTyCOzbRROfbpnA== dependencies: - "@sentry/browser" "8.26.0" - "@sentry/core" "8.26.0" - "@sentry/types" "8.26.0" - "@sentry/utils" "8.26.0" + "@sentry/browser" "8.27.0" + "@sentry/core" "8.27.0" + "@sentry/types" "8.27.0" + "@sentry/utils" "8.27.0" hoist-non-react-statics "^3.3.2" "@sentry/types@7.76.0": @@ -3944,10 +3944,10 @@ resolved "https://registry.yarnpkg.com/@sentry/types/-/types-7.76.0.tgz#628c9899bfa82ea762708314c50fd82f2138587d" integrity sha512-vj6z+EAbVrKAXmJPxSv/clpwS9QjPqzkraMFk2hIdE/kii8s8kwnkBwTSpIrNc8GnzV3qYC4r3qD+BXDxAGPaw== -"@sentry/types@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry/types/-/types-8.26.0.tgz#c999fdd9e52587570f723d2370244bad8f79b571" - integrity sha512-zKmh6SWsJh630rpt7a9vP4Cm4m1C2gDTUqUiH565CajCL/4cePpNWYrNwalSqsOSL7B9OrczA1+n6a6XvND+ng== +"@sentry/types@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry/types/-/types-8.27.0.tgz#a5c7d2877c6c3620f812b2b31377b58d390b89d4" + integrity sha512-B6lrP46+m2x0lfqWc9F4VcUbN893mVGnPEd7KIMRk95mPzkFJ3sNxggTQF5/ZfNO7lDQYQb22uysB5sj/BqFiw== "@sentry/utils@7.76.0": version "7.76.0" @@ -3956,12 +3956,12 @@ dependencies: "@sentry/types" "7.76.0" -"@sentry/utils@8.26.0": - version "8.26.0" - resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-8.26.0.tgz#c6629f0f2bc8cbc4fddd124770e9063b4e2d1c65" - integrity sha512-xvlPU9Hd2BlyT+FhWHGNwnxWqdVRk2AHnDtVcW4Ma0Ri5EwS+uy4Jeik5UkSv8C5RVb9VlxFmS8LN3I1MPJsLw== +"@sentry/utils@8.27.0": + version "8.27.0" + resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-8.27.0.tgz#308f6cc34acac175c500e4dd5b5007cdb621c79e" + integrity sha512-gyJM3SyLQe0A3mkQVVNdKYvk3ZoikkYgyA/D+5StFNLKdyUgEbJgXOGXrQSSYPF7BSX6Sc5b0KHCglPII0KuKw== dependencies: - "@sentry/types" "8.26.0" + "@sentry/types" "8.27.0" "@sentry/wizard@3.16.3": version "3.16.3" From a8631eda1964f6bb52990139eb753e7cc86cb6e0 Mon Sep 17 00:00:00 2001 From: getsentry-bot Date: Mon, 2 Sep 2024 15:49:45 +0000 Subject: [PATCH 21/48] release: 6.0.0-alpha.1 --- CHANGELOG.md | 2 +- package.json | 2 +- samples/expo/app.json | 8 ++++---- samples/expo/package.json | 2 +- samples/react-native/android/app/build.gradle | 4 ++-- .../react-native/ios/sentryreactnativesample/Info.plist | 2 +- .../ios/sentryreactnativesampleTests/Info.plist | 2 +- samples/react-native/package.json | 2 +- src/js/version.ts | 2 +- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bd4b0b8b1b..2752c70bdb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## Unreleased +## 6.0.0-alpha.1 ### Changes diff --git a/package.json b/package.json index 5edaeef28e..c527fd9dd1 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@sentry/react-native", "homepage": "https://github.com/getsentry/sentry-react-native", "repository": "https://github.com/getsentry/sentry-react-native", - "version": "6.0.0-alpha.0", + "version": "6.0.0-alpha.1", "description": "Official Sentry SDK for react-native", "typings": "dist/js/index.d.ts", "types": "dist/js/index.d.ts", diff --git a/samples/expo/app.json b/samples/expo/app.json index 3685cde7f9..140ccc71f5 100644 --- a/samples/expo/app.json +++ b/samples/expo/app.json @@ -4,7 +4,7 @@ "slug": "sentry-react-native-expo-sample", "jsEngine": "hermes", "scheme": "sentry-expo-sample", - "version": "6.0.0-alpha.0", + "version": "6.0.0-alpha.1", "orientation": "portrait", "icon": "./assets/icon.png", "userInterfaceStyle": "light", @@ -19,7 +19,7 @@ "ios": { "supportsTablet": true, "bundleIdentifier": "io.sentry.expo.sample", - "buildNumber": "20" + "buildNumber": "21" }, "android": { "adaptiveIcon": { @@ -27,7 +27,7 @@ "backgroundColor": "#ffffff" }, "package": "io.sentry.expo.sample", - "versionCode": 20 + "versionCode": 21 }, "web": { "bundler": "metro", @@ -59,4 +59,4 @@ ] ] } -} +} \ No newline at end of file diff --git a/samples/expo/package.json b/samples/expo/package.json index 67601f48bf..0820119107 100644 --- a/samples/expo/package.json +++ b/samples/expo/package.json @@ -1,6 +1,6 @@ { "name": "sentry-react-native-expo-sample", - "version": "6.0.0-alpha.0", + "version": "6.0.0-alpha.1", "main": "expo-router/entry", "scripts": { "start": "expo start", diff --git a/samples/react-native/android/app/build.gradle b/samples/react-native/android/app/build.gradle index 3de661a21f..4f17a88f32 100644 --- a/samples/react-native/android/app/build.gradle +++ b/samples/react-native/android/app/build.gradle @@ -134,8 +134,8 @@ android { applicationId "io.sentry.reactnative.sample" minSdkVersion rootProject.ext.minSdkVersion targetSdkVersion rootProject.ext.targetSdkVersion - versionCode 22 - versionName "6.0.0-alpha.0" + versionCode 23 + versionName "6.0.0-alpha.1" } signingConfigs { diff --git a/samples/react-native/ios/sentryreactnativesample/Info.plist b/samples/react-native/ios/sentryreactnativesample/Info.plist index ef7fe4fe52..723be353a1 100644 --- a/samples/react-native/ios/sentryreactnativesample/Info.plist +++ b/samples/react-native/ios/sentryreactnativesample/Info.plist @@ -21,7 +21,7 @@ CFBundleSignature ???? CFBundleVersion - 27 + 28 LSRequiresIPhoneOS NSAppTransportSecurity diff --git a/samples/react-native/ios/sentryreactnativesampleTests/Info.plist b/samples/react-native/ios/sentryreactnativesampleTests/Info.plist index 9f58dd5234..5af53e4b7d 100644 --- a/samples/react-native/ios/sentryreactnativesampleTests/Info.plist +++ b/samples/react-native/ios/sentryreactnativesampleTests/Info.plist @@ -19,6 +19,6 @@ CFBundleSignature ???? CFBundleVersion - 27 + 28 diff --git a/samples/react-native/package.json b/samples/react-native/package.json index 89dafa647f..a8ef16c36c 100644 --- a/samples/react-native/package.json +++ b/samples/react-native/package.json @@ -1,6 +1,6 @@ { "name": "sentry-react-native-sample", - "version": "6.0.0-alpha.0", + "version": "6.0.0-alpha.1", "private": true, "scripts": { "postinstall": "patch-package", diff --git a/src/js/version.ts b/src/js/version.ts index d09d338d79..e24d6b6b13 100644 --- a/src/js/version.ts +++ b/src/js/version.ts @@ -1,3 +1,3 @@ export const SDK_PACKAGE_NAME = 'npm:@sentry/react-native'; export const SDK_NAME = 'sentry.javascript.react-native'; -export const SDK_VERSION = '6.0.0-alpha.0'; +export const SDK_VERSION = '6.0.0-alpha.1'; From ddcabffc8bd015392f28deb4f685ed358889c77e Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Wed, 4 Sep 2024 12:20:11 +0200 Subject: [PATCH 22/48] misc: Move to monorepo structure and Yarn V3 (#4057) --- .craft.yml | 2 +- .github/workflows/buildandtest.yml | 133 +- .github/workflows/codegen.yml | 13 +- .github/workflows/e2e.yml | 105 +- .github/workflows/native-tests.yml | 19 +- .github/workflows/release.yml | 8 +- .github/workflows/sample-application.yml | 11 +- .gitignore | 9 +- .yarn/releases/yarn-1.22.22.cjs | 148049 --------------- .yarnrc | 5 - .yarnrc.yml | 4 +- .../e2e => dev-packages/e2e-tests}/.gitignore | 0 dev-packages/e2e-tests/.npmignore | 4 + .../e2e-tests}/babel.config.json | 0 .../e2e.mjs => dev-packages/e2e-tests/cli.mjs | 191 +- .../e2e-tests}/jest.config.json | 0 dev-packages/e2e-tests/package.json | 34 + .../e2e-tests/patch-scripts}/rn.patch | 0 .../rn.patch.app.build.gradle.js | 0 .../e2e-tests/patch-scripts}/rn.patch.app.js | 0 .../rn.patch.gradle.properties.js | 0 .../patch-scripts}/rn.patch.metro.config.js | 0 .../patch-scripts}/rn.patch.podfile.js | 0 .../patch-scripts}/rn.patch.xcode.js | 0 .../e2e-tests/react-native-versions}/.keep | 0 .../e2e-tests}/src/EndToEndTests.tsx | 2 +- .../e2e-tests}/src/index.ts | 0 .../e2e-tests}/src/utils/getTestProps.ts | 0 .../e2e-tests}/test/e2e.test.ts | 0 .../e2e-tests}/test/utils/fetchEvent.ts | 0 .../e2e-tests}/test/utils/waitFor.ts | 0 .../e2e-tests}/tsconfig.build.json | 9 +- .../e2e-tests}/tsconfig.json | 0 dev-packages/type-check/package.json | 8 + dev-packages/type-check/run-type-check.sh | 20 + dev-packages/type-check/ts3.8-test/.gitignore | 1 + .../type-check/ts3.8-test}/index.ts | 0 .../type-check/ts3.8-test}/package.json | 1 + .../ts3.8-test}/tsconfig.build.json | 0 dev-packages/type-check/ts3.8-test/yarn.lock | 0 lerna.json | 11 + package.json | 160 +- .eslintignore => packages/core/.eslintignore | 4 - .eslintrc.js => packages/core/.eslintrc.js | 1 - packages/core/.gitignore | 2 + .npmignore => packages/core/.npmignore | 0 packages/core/LICENSE.md | 21 + .../core/RNSentry.podspec | 0 .../core/RNSentryAndroidTester}/.gitignore | 0 .../RNSentryAndroidTester}/app/.gitignore | 0 .../RNSentryAndroidTester}/app/build.gradle | 0 .../RNSentryMapConverterTest.kt | 0 .../org.mockito.plugins.MockMaker | 0 .../app/src/main/AndroidManifest.xml | 0 .../rnscreens/ScreenStackFragment.kt | 0 .../RNSentryBreadcrumbTest.kt | 0 ...NSentryReactFragmentLifecycleTracerTest.kt | 0 .../RNSentryReplayBreadcrumbConverterTest.kt | 0 .../core/RNSentryAndroidTester}/build.gradle | 0 .../RNSentryAndroidTester}/gradle.properties | 0 .../gradle/wrapper/gradle-wrapper.jar | Bin .../gradle/wrapper/gradle-wrapper.properties | 0 .../core/RNSentryAndroidTester}/gradlew | 0 .../core/RNSentryAndroidTester}/gradlew.bat | 0 .../RNSentryAndroidTester}/settings.gradle | 0 .../core/RNSentryCocoaTester}/Podfile | 0 .../project.pbxproj | 0 .../contents.xcworkspacedata | 0 .../xcshareddata/IDEWorkspaceChecks.plist | 0 .../xcschemes/RNSentryCocoaTester.xcscheme | 0 .../contents.xcworkspacedata | 0 .../xcshareddata/IDEWorkspaceChecks.plist | 0 .../RNSentryBreadcrumbTests.swift | 0 ...RNSentryCocoaTesterTests-Bridging-Header.h | 0 .../RNSentryDependencyContainerTests.h | 0 .../RNSentryDependencyContainerTests.m | 0 .../RNSentryFramesTrackerListenerTests.h | 0 .../RNSentryFramesTrackerListenerTests.m | 0 .../RNSentryOnDrawReporterTests.m | 0 ...SentryReplayBreadcrumbConverterTests.swift | 0 .../RNSentryCocoaTesterTests/RNSentryTests.h | 0 .../RNSentryCocoaTesterTests/RNSentryTests.mm | 0 {android => packages/core/android}/.gitignore | 0 .../core/android}/build.gradle | 0 .../android}/src/main/AndroidManifest.xml | 0 .../io/sentry/react/RNSentryBreadcrumb.java | 0 .../io/sentry/react/RNSentryMapConverter.java | 0 .../io/sentry/react/RNSentryModuleImpl.java | 0 .../react/RNSentryOnDrawReporterManager.java | 0 .../java/io/sentry/react/RNSentryPackage.java | 0 .../RNSentryReactFragmentLifecycleTracer.java | 0 .../RNSentryReplayBreadcrumbConverter.java | 0 .../java/io/sentry/react/RNSentryModule.java | 0 .../java/io/sentry/react/RNSentryModule.java | 0 app.plugin.js => packages/core/app.plugin.js | 0 .../core/assets}/additional-device.png | Bin {assets => packages/core/assets}/enriched.png | Bin .../core/assets}/mixed-stacktrace.png | Bin {assets => packages/core/assets}/raven.png | Bin .../core/babel.config.js | 0 expo.d.ts => packages/core/expo.d.ts | 0 expo.js => packages/core/expo.js | 0 {ios => packages/core/ios}/RNSentry.h | 0 {ios => packages/core/ios}/RNSentry.mm | 0 .../ios}/RNSentry.xcodeproj/project.pbxproj | 0 .../core/ios}/RNSentryBreadcrumb.h | 0 .../core/ios}/RNSentryBreadcrumb.m | 0 .../core/ios}/RNSentryDependencyContainer.h | 0 .../core/ios}/RNSentryDependencyContainer.m | 0 {ios => packages/core/ios}/RNSentryEvents.h | 0 {ios => packages/core/ios}/RNSentryEvents.m | 0 .../core/ios}/RNSentryFramesTrackerListener.h | 0 .../core/ios}/RNSentryFramesTrackerListener.m | 0 {ios => packages/core/ios}/RNSentryId.h | 0 {ios => packages/core/ios}/RNSentryId.m | 0 .../core/ios}/RNSentryOnDrawReporter.h | 0 .../core/ios}/RNSentryOnDrawReporter.m | 0 .../core/ios}/RNSentryRNSScreen.h | 0 .../core/ios}/RNSentryRNSScreen.m | 0 {ios => packages/core/ios}/RNSentryReplay.h | 0 {ios => packages/core/ios}/RNSentryReplay.m | 0 .../ios}/RNSentryReplayBreadcrumbConverter.h | 0 .../ios}/RNSentryReplayBreadcrumbConverter.m | 0 .../core/jest.config.js | 0 .../core/jest.config.tools.js | 0 metro.d.ts => packages/core/metro.d.ts | 0 metro.js => packages/core/metro.js | 0 packages/core/package.json | 131 + packages/core/package.tgz | Bin 0 -> 302053 bytes {plugin => packages/core/plugin}/src/index.ts | 0 {plugin => packages/core/plugin}/src/utils.ts | 0 .../core/plugin}/src/withSentry.ts | 0 .../core/plugin}/src/withSentryAndroid.ts | 0 .../core/plugin}/src/withSentryIOS.ts | 0 .../core/plugin}/tsconfig.json | 0 .../core/react-native.config.js | 0 packages/core/scripts/build-tarball.sh | 7 + .../core/scripts}/collect-modules.sh | 0 .../core/scripts}/copy-debugid.js | 0 .../core/scripts}/expo-upload-sourcemaps.js | 0 .../core/scripts}/has-sourcemap-debugid.js | 0 .../scripts}/hermes-profile-transformer.js | 0 .../sentry-debugid-injection-snippet.js | 0 .../core/scripts}/sentry-xcode-debug-files.sh | 0 .../core/scripts}/sentry-xcode.sh | 0 .../core/scripts}/sentry_utils.rb | 0 sentry.gradle => packages/core/sentry.gradle | 0 .../core/src}/js/NativeRNSentry.ts | 0 {src => packages/core/src}/js/breadcrumb.ts | 0 {src => packages/core/src}/js/client.ts | 0 {src => packages/core/src}/js/index.ts | 0 .../src}/js/integrations/debugsymbolicator.ts | 0 .../js/integrations/debugsymbolicatorutils.ts | 0 .../core/src}/js/integrations/default.ts | 0 .../src}/js/integrations/devicecontext.ts | 0 .../core/src}/js/integrations/eventorigin.ts | 0 .../core/src}/js/integrations/expocontext.ts | 0 .../core/src}/js/integrations/exports.ts | 0 .../core/src}/js/integrations/factory.ts | 0 .../src}/js/integrations/modulesloader.ts | 0 .../js/integrations/nativelinkederrors.ts | 0 .../integrations/reactnativeerrorhandlers.ts | 0 .../reactnativeerrorhandlersutils.ts | 0 .../src}/js/integrations/reactnativeinfo.ts | 0 .../core/src}/js/integrations/release.ts | 0 .../src}/js/integrations/rewriteframes.ts | 0 .../core/src}/js/integrations/screenshot.ts | 0 .../core/src}/js/integrations/sdkinfo.ts | 0 .../core/src}/js/integrations/spotlight.ts | 0 .../src}/js/integrations/viewhierarchy.ts | 0 {src => packages/core/src}/js/measurements.ts | 0 {src => packages/core/src}/js/misc.ts | 0 {src => packages/core/src}/js/options.ts | 0 .../core/src}/js/profiling/cache.ts | 0 .../core/src}/js/profiling/constants.ts | 0 .../src}/js/profiling/convertHermesProfile.ts | 0 .../core/src}/js/profiling/debugid.ts | 0 .../core/src}/js/profiling/hermes.ts | 0 .../core/src}/js/profiling/integration.ts | 0 .../core/src}/js/profiling/nativeTypes.ts | 0 .../core/src}/js/profiling/types.ts | 0 .../core/src}/js/profiling/utils.ts | 0 .../core/src}/js/replay/mobilereplay.ts | 0 .../core/src}/js/replay/networkUtils.ts | 0 .../core/src}/js/replay/xhrUtils.ts | 0 {src => packages/core/src}/js/scopeSync.ts | 0 {src => packages/core/src}/js/sdk.tsx | 0 .../core/src}/js/tools/ModulesCollector.ts | 0 .../core/src}/js/tools/collectModules.ts | 0 .../core/src}/js/tools/enableLogger.ts | 0 .../core/src}/js/tools/metroconfig.ts | 0 .../src}/js/tools/sentryBabelTransformer.ts | 0 .../js/tools/sentryBabelTransformerUtils.ts | 0 .../src}/js/tools/sentryMetroSerializer.ts | 2 + {src => packages/core/src}/js/tools/utils.ts | 4 +- .../src}/js/tools/vendor/expo/expoconfig.ts | 0 .../src}/js/tools/vendor/metro/metro.d.ts | 0 .../vendor/metro/metroBabelTransformer.ts | 0 .../core/src}/js/tools/vendor/metro/utils.ts | 4 + {src => packages/core/src}/js/touchevents.tsx | 0 .../core/src}/js/tracing/gesturetracing.ts | 0 .../core/src}/js/tracing/index.ts | 0 .../src}/js/tracing/integrations/appStart.ts | 0 .../js/tracing/integrations/nativeFrames.ts | 0 .../js/tracing/integrations/stalltracking.ts | 0 .../tracing/integrations/userInteraction.ts | 0 .../core/src}/js/tracing/onSpanEndUtils.ts | 0 {src => packages/core/src}/js/tracing/ops.ts | 0 .../core/src}/js/tracing/origin.ts | 0 .../src}/js/tracing/reactnativenavigation.ts | 0 .../src}/js/tracing/reactnativeprofiler.tsx | 0 .../src}/js/tracing/reactnativetracing.ts | 0 .../core/src}/js/tracing/reactnavigation.ts | 0 .../src}/js/tracing/semanticAttributes.ts | 0 {src => packages/core/src}/js/tracing/span.ts | 0 .../core/src}/js/tracing/timetodisplay.tsx | 0 .../src}/js/tracing/timetodisplaynative.tsx | 0 .../js/tracing/timetodisplaynative.types.ts | 0 .../core/src}/js/tracing/types.ts | 0 .../core/src}/js/tracing/utils.ts | 0 .../core/src}/js/transports/encodePolyfill.ts | 0 .../core/src}/js/transports/native.ts | 0 {src => packages/core/src}/js/user.ts | 0 .../core/src}/js/utils/AsyncExpiringMap.ts | 0 .../core/src}/js/utils/clientutils.ts | 0 .../core/src}/js/utils/envelope.ts | 0 .../core/src}/js/utils/environment.ts | 0 {src => packages/core/src}/js/utils/error.ts | 0 .../core/src}/js/utils/expoglobalobject.ts | 0 .../core/src}/js/utils/expomodules.ts | 0 {src => packages/core/src}/js/utils/fill.ts | 0 .../src}/js/utils/ignorerequirecyclelogs.ts | 0 .../core/src}/js/utils/normalize.ts | 0 .../core/src}/js/utils/outcome.ts | 0 .../core/src}/js/utils/rnlibraries.ts | 0 .../core/src}/js/utils/rnlibraries.web.ts | 0 .../src}/js/utils/rnlibrariesinterface.ts | 0 {src => packages/core/src}/js/utils/safe.ts | 0 .../core/src}/js/utils/sentryeventemitter.ts | 0 {src => packages/core/src}/js/utils/span.ts | 0 .../core/src}/js/utils/worldwide.ts | 0 {src => packages/core/src}/js/utils/xhr.ts | 0 .../src}/js/vendor/base64-js/fromByteArray.ts | 0 .../core/src}/js/vendor/base64-js/index.ts | 0 .../core/src}/js/vendor/buffer/index.ts | 0 .../core/src}/js/vendor/buffer/utf8ToBytes.ts | 0 {src => packages/core/src}/js/vendor/index.ts | 0 .../core/src}/js/vendor/react-native/index.ts | 0 {src => packages/core/src}/js/version.ts | 0 {src => packages/core/src}/js/wrapper.ts | 0 .../core/test}/breadcrumb.test.ts | 0 {test => packages/core/test}/client.test.ts | 0 {test => packages/core/test}/error.test.ts | 0 .../expo-plugin/modifyAppBuildGradle.test.ts | 0 .../expo-plugin/modifyXcodeProject.test.ts | 0 .../integrations/debugsymbolicator.test.ts | 0 .../test}/integrations/devicecontext.test.ts | 0 .../test}/integrations/eventorigin.test.ts | 0 .../test}/integrations/expocontext.test.ts | 0 .../integrationsexecutionorder.test.ts | 0 .../test}/integrations/modulesloader.test.ts | 0 .../integrations/nativelinkederrors.test.ts | 0 .../reactnativeerrorhandlers.test.ts | 0 .../integrations/reactnativeinfo.test.ts | 0 .../core/test}/integrations/release.test.ts | 0 .../test}/integrations/rewriteframes.test.ts | 0 .../core/test}/integrations/sdkinfo.test.ts | 0 .../core/test}/integrations/spotlight.test.ts | 0 .../test}/integrations/viewhierarchy.test.ts | 0 {test => packages/core/test}/misc.test.ts | 0 {test => packages/core/test}/mockConsole.ts | 0 {test => packages/core/test}/mockDsn.ts | 0 {test => packages/core/test}/mockWrapper.ts | 0 {test => packages/core/test}/mocks/client.ts | 0 .../profiling/convertHermesProfile.test.ts | 0 .../core/test}/profiling/fixtures.ts | 0 .../core/test}/profiling/hermes.test.ts | 0 .../profiling/integration.android.test.ts | 0 .../test}/profiling/integration.ios.test.ts | 0 .../core/test}/profiling/integration.test.ts | 0 .../test}/profiling/integrationmerge.test.ts | 0 .../core/test}/replay/networkUtils.test.ts | 0 .../core/test}/replay/xhrUtils.test.ts | 0 .../core/test}/scopeSync.test.ts | 0 {test => packages/core/test}/sdk.test.ts | 0 .../core/test}/sdk.withclient.test.ts | 0 {test => packages/core/test}/testutils.ts | 0 .../core/test}/tools/collectModules.test.ts | 0 .../fixtures/bundleWithPrelude.js.fixture | 0 .../fixtures/bundleWithPrelude.js.fixture.map | 0 .../core/test}/tools/fixtures/mock.map | 0 .../tools/fixtures/mockBabelTransformer.js | 0 .../@organization/module3/package.json | 0 .../modules/not-collected/package.json | 0 .../root-module/modules/module1/package.json | 0 .../root-module/modules/module2/package.json | 0 .../tools/fixtures/root-module/package.json | 0 .../core/test}/tools/metroconfig.test.ts | 0 .../tools/sentryBabelTransformer.test.ts | 0 .../test}/tools/sentryMetroSerializer.test.ts | 0 .../core/test}/touchevents.test.tsx | 0 .../tracing/addTracingExtensions.test.ts | 0 .../core/test}/tracing/gesturetracing.test.ts | 0 .../test}/tracing/idleNavigationSpan.test.ts | 0 .../tracing/integrations/appStart.test.ts | 0 .../tracing/integrations/nativeframes.test.ts | 0 .../stalltracking.background.test.ts | 0 .../stalltracking.iteration.test.ts | 0 .../stallTracking/stalltracking.test.ts | 0 .../stallTracking/stalltrackingutils.ts | 0 .../integrations/userInteraction.test.ts | 0 .../tracing/mockedtimetodisplaynative.tsx | 0 .../tracing/reactnativenavigation.test.ts | 0 .../test}/tracing/reactnativetracing.test.ts | 0 .../reactnavigation.stalltracking.test.ts | 0 .../test}/tracing/reactnavigation.test.ts | 0 .../tracing/reactnavigation.ttid.test.tsx | 0 .../test}/tracing/reactnavigationutils.ts | 0 .../core/test}/tracing/timetodisplay.test.tsx | 0 .../tracing/timetodisplaynative.web.test.tsx | 0 .../core/test}/transports/native.test.ts | 0 .../core/test}/utils/AsyncExpiringMap.test.ts | 0 .../test}/utils/mockedSentryeventemitter.ts | 0 .../core/test}/utils/normalize.test.ts | 0 .../core/test}/utils/safe.test.ts | 0 .../test}/utils/sentryeventemitter.test.ts | 0 .../core/test}/utils/xhr.test.ts | 0 .../test}/vendor/base64-js/big-data.test.ts | 0 .../test}/vendor/base64-js/convert.test.ts | 0 .../test}/vendor/buffer/utf8ToBytes.test.ts | 0 .../vendor/buffer/utf8ToBytesSize.test.ts | 0 {test => packages/core/test}/wrap.test.tsx | 0 {test => packages/core/test}/wrapper.test.ts | 0 .../core/tsconfig.build.json | 8 +- .../core/tsconfig.build.tools.json | 4 +- tsconfig.json => packages/core/tsconfig.json | 0 .../core/typings}/jest-extended.d.ts | 0 .../TestAppPlain/.buckconfig | 0 .../TestAppPlain/.flowconfig | 0 .../TestAppPlain/.gitignore | 0 .../TestAppPlain/.watchmanconfig | 0 .../TestAppPlain/App.js | 0 .../TestAppPlain/Gemfile | 0 .../TestAppPlain/__tests__/App-test.js | 0 .../TestAppPlain/_bundle/config | 0 .../TestAppPlain/_ruby-version | 0 .../TestAppPlain/android/app/_BUCK | 0 .../TestAppPlain/android/app/build.gradle | 0 .../TestAppPlain/android/app/build_defs.bzl | 0 .../TestAppPlain/android/app/debug.keystore | Bin .../android/app/proguard-rules.pro | 0 .../android/app/src/debug/AndroidManifest.xml | 0 .../com/testappplain/ReactNativeFlipper.java | 0 .../android/app/src/main/AndroidManifest.xml | 0 .../java/com/testappplain/MainActivity.java | 0 .../com/testappplain/MainApplication.java | 0 .../MainApplicationReactNativeHost.java | 0 .../components/MainComponentsRegistry.java | 0 ...ApplicationTurboModuleManagerDelegate.java | 0 .../android/app/src/main/jni/CMakeLists.txt | 0 .../jni/MainApplicationModuleProvider.cpp | 0 .../main/jni/MainApplicationModuleProvider.h | 0 ...nApplicationTurboModuleManagerDelegate.cpp | 0 ...ainApplicationTurboModuleManagerDelegate.h | 0 .../src/main/jni/MainComponentsRegistry.cpp | 0 .../app/src/main/jni/MainComponentsRegistry.h | 0 .../android/app/src/main/jni/OnLoad.cpp | 0 .../res/drawable/rn_edit_text_material.xml | 0 .../src/main/res/mipmap-hdpi/ic_launcher.png | Bin .../res/mipmap-hdpi/ic_launcher_round.png | Bin .../src/main/res/mipmap-mdpi/ic_launcher.png | Bin .../res/mipmap-mdpi/ic_launcher_round.png | Bin .../src/main/res/mipmap-xhdpi/ic_launcher.png | Bin .../res/mipmap-xhdpi/ic_launcher_round.png | Bin .../main/res/mipmap-xxhdpi/ic_launcher.png | Bin .../res/mipmap-xxhdpi/ic_launcher_round.png | Bin .../main/res/mipmap-xxxhdpi/ic_launcher.png | Bin .../res/mipmap-xxxhdpi/ic_launcher_round.png | Bin .../app/src/main/res/values/strings.xml | 0 .../app/src/main/res/values/styles.xml | 0 .../TestAppPlain/android/build.gradle | 0 .../TestAppPlain/android/debug.keystore | Bin .../TestAppPlain/android/gradle.properties | 0 .../android/gradle/wrapper/gradle-wrapper.jar | Bin .../gradle/wrapper/gradle-wrapper.properties | 0 .../TestAppPlain/android/gradlew | 0 .../TestAppPlain/android/gradlew.bat | 0 .../TestAppPlain/android/settings.gradle | 0 .../TestAppPlain/app.json | 0 .../TestAppPlain/babel.config.js | 0 .../TestAppPlain/index.js | 0 .../TestAppPlain/ios/Podfile | 0 .../TestAppPlain.xcodeproj/project.pbxproj | 0 .../xcschemes/TestAppPlain.xcscheme | 0 .../contents.xcworkspacedata | 0 .../xcshareddata/IDEWorkspaceChecks.plist | 0 .../ios/TestAppPlain/AppDelegate.h | 0 .../ios/TestAppPlain/AppDelegate.mm | 0 .../AppIcon.appiconset/Contents.json | 0 .../Images.xcassets/Contents.json | 0 .../TestAppPlain/ios/TestAppPlain/Info.plist | 0 .../ios/TestAppPlain/LaunchScreen.storyboard | 0 .../TestAppPlain/ios/TestAppPlain/main.m | 0 .../ios/TestAppPlainTests/Info.plist | 0 .../ios/TestAppPlainTests/TestAppPlainTests.m | 0 .../TestAppPlain/ios/_xcode.env | 0 .../TestAppPlain/metro.config.js | 0 .../TestAppPlain/package.json | 6 +- .../TestAppSentry/.buckconfig | 0 .../TestAppSentry/.flowconfig | 0 .../TestAppSentry/.gitignore | 0 .../TestAppSentry/.watchmanconfig | 0 .../TestAppSentry/App.js | 0 .../TestAppSentry/Gemfile | 0 .../TestAppSentry/__tests__/App-test.js | 0 .../TestAppSentry/_bundle/config | 0 .../TestAppSentry/_ruby-version | 0 .../TestAppSentry/android/app/_BUCK | 0 .../TestAppSentry/android/app/build.gradle | 0 .../TestAppSentry/android/app/build_defs.bzl | 0 .../TestAppSentry/android/app/debug.keystore | Bin .../android/app/proguard-rules.pro | 0 .../android/app/src/debug/AndroidManifest.xml | 0 .../com/testappsentry/ReactNativeFlipper.java | 0 .../android/app/src/main/AndroidManifest.xml | 0 .../java/com/testappsentry/MainActivity.java | 0 .../com/testappsentry/MainApplication.java | 0 .../MainApplicationReactNativeHost.java | 0 .../components/MainComponentsRegistry.java | 0 ...ApplicationTurboModuleManagerDelegate.java | 0 .../android/app/src/main/jni/CMakeLists.txt | 0 .../jni/MainApplicationModuleProvider.cpp | 0 .../main/jni/MainApplicationModuleProvider.h | 0 ...nApplicationTurboModuleManagerDelegate.cpp | 0 ...ainApplicationTurboModuleManagerDelegate.h | 0 .../src/main/jni/MainComponentsRegistry.cpp | 0 .../app/src/main/jni/MainComponentsRegistry.h | 0 .../android/app/src/main/jni/OnLoad.cpp | 0 .../res/drawable/rn_edit_text_material.xml | 0 .../src/main/res/mipmap-hdpi/ic_launcher.png | Bin .../res/mipmap-hdpi/ic_launcher_round.png | Bin .../src/main/res/mipmap-mdpi/ic_launcher.png | Bin .../res/mipmap-mdpi/ic_launcher_round.png | Bin .../src/main/res/mipmap-xhdpi/ic_launcher.png | Bin .../res/mipmap-xhdpi/ic_launcher_round.png | Bin .../main/res/mipmap-xxhdpi/ic_launcher.png | Bin .../res/mipmap-xxhdpi/ic_launcher_round.png | Bin .../main/res/mipmap-xxxhdpi/ic_launcher.png | Bin .../res/mipmap-xxxhdpi/ic_launcher_round.png | Bin .../app/src/main/res/values/strings.xml | 0 .../app/src/main/res/values/styles.xml | 0 .../TestAppSentry/android/build.gradle | 0 .../TestAppSentry/android/debug.keystore | Bin .../TestAppSentry/android/gradle.properties | 0 .../android/gradle/wrapper/gradle-wrapper.jar | Bin .../gradle/wrapper/gradle-wrapper.properties | 0 .../TestAppSentry/android/gradlew | 0 .../TestAppSentry/android/gradlew.bat | 0 .../TestAppSentry/android/settings.gradle | 0 .../TestAppSentry/app.json | 0 .../TestAppSentry/babel.config.js | 0 .../TestAppSentry/index.js | 0 .../TestAppSentry/ios/Podfile | 0 .../TestAppSentry.xcodeproj/project.pbxproj | 0 .../xcschemes/TestAppSentry.xcscheme | 0 .../contents.xcworkspacedata | 0 .../xcshareddata/IDEWorkspaceChecks.plist | 0 .../ios/TestAppSentry/AppDelegate.h | 0 .../ios/TestAppSentry/AppDelegate.mm | 0 .../AppIcon.appiconset/Contents.json | 0 .../Images.xcassets/Contents.json | 0 .../ios/TestAppSentry/Info.plist | 0 .../ios/TestAppSentry/LaunchScreen.storyboard | 0 .../TestAppSentry/ios/TestAppSentry/main.m | 0 .../ios/TestAppSentryTests/Info.plist | 0 .../TestAppSentryTests/TestAppSentryTests.m | 0 .../TestAppSentry/ios/_xcode.env | 0 .../TestAppSentry/metro.config.js | 50 + .../TestAppSentry/package.json | 9 +- .../fastlane/.gitignore | 0 .../fastlane/Appfile | 0 .../fastlane/Fastfile | 0 .../fastlane/Matchfile | 0 .../fastlane/Pluginfile | 0 .../metrics-android.yml | 0 .../metrics-ios.yml | 0 samples/expo/app.json | 3 +- samples/expo/babel.config.js | 10 - samples/expo/metro.config.js | 54 +- samples/expo/package.json | 5 +- samples/expo/tsconfig.json | 3 - samples/expo/withSampleSentry.js | 2 - samples/expo/withSampleSentry.ts | 153 - samples/expo/yarn.lock | 7452 - samples/react-native/android/app/build.gradle | 15 +- samples/react-native/babel.config.js | 12 +- samples/react-native/ios/Podfile | 4 - .../project.pbxproj | 20 +- samples/react-native/main.jsbundle.map | 1 + samples/react-native/metro.config.js | 63 +- samples/react-native/package.json | 11 +- samples/react-native/react-native.config.js | 5 - samples/react-native/src/App.tsx | 2 +- samples/react-native/tsconfig.json | 3 - samples/react-native/yarn.lock | 8673 - scripts/craft-pre-release.sh | 12 +- scripts/set-version-samples.sh | 10 - scripts/version-bump.js | 5 +- test/e2e/package.json | 22 - test/e2e/yarn.lock | 8273 - test/perf/TestAppPlain/.eslintrc.js | 4 - test/perf/TestAppPlain/.prettierrc.js | 7 - test/perf/TestAppPlain/yarn.lock | 6786 - test/perf/TestAppSentry/.eslintrc.js | 4 - test/perf/TestAppSentry/.prettierrc.js | 7 - test/perf/TestAppSentry/metro.config.js | 17 - test/perf/TestAppSentry/yarn.lock | 6786 - test/typescript/ts3.8/yarn.lock | 4267 - yarn.lock | 41077 ++-- 519 files changed, 27416 insertions(+), 205404 deletions(-) delete mode 100755 .yarn/releases/yarn-1.22.22.cjs delete mode 100644 .yarnrc rename {test/e2e => dev-packages/e2e-tests}/.gitignore (100%) create mode 100644 dev-packages/e2e-tests/.npmignore rename {test/e2e => dev-packages/e2e-tests}/babel.config.json (100%) rename scripts/e2e.mjs => dev-packages/e2e-tests/cli.mjs (58%) rename {test/e2e => dev-packages/e2e-tests}/jest.config.json (100%) create mode 100644 dev-packages/e2e-tests/package.json rename {test/react-native => dev-packages/e2e-tests/patch-scripts}/rn.patch (100%) rename {test/react-native => dev-packages/e2e-tests/patch-scripts}/rn.patch.app.build.gradle.js (100%) rename {test/react-native => dev-packages/e2e-tests/patch-scripts}/rn.patch.app.js (100%) rename {test/react-native => dev-packages/e2e-tests/patch-scripts}/rn.patch.gradle.properties.js (100%) rename {test/react-native => dev-packages/e2e-tests/patch-scripts}/rn.patch.metro.config.js (100%) rename {test/react-native => dev-packages/e2e-tests/patch-scripts}/rn.patch.podfile.js (100%) rename {test/react-native => dev-packages/e2e-tests/patch-scripts}/rn.patch.xcode.js (100%) rename {test/react-native/versions => dev-packages/e2e-tests/react-native-versions}/.keep (100%) rename {test/e2e => dev-packages/e2e-tests}/src/EndToEndTests.tsx (97%) rename {test/e2e => dev-packages/e2e-tests}/src/index.ts (100%) rename {test/e2e => dev-packages/e2e-tests}/src/utils/getTestProps.ts (100%) rename {test/e2e => dev-packages/e2e-tests}/test/e2e.test.ts (100%) rename {test/e2e => dev-packages/e2e-tests}/test/utils/fetchEvent.ts (100%) rename {test/e2e => dev-packages/e2e-tests}/test/utils/waitFor.ts (100%) rename {test/e2e => dev-packages/e2e-tests}/tsconfig.build.json (62%) rename {test/e2e => dev-packages/e2e-tests}/tsconfig.json (100%) create mode 100644 dev-packages/type-check/package.json create mode 100755 dev-packages/type-check/run-type-check.sh create mode 100644 dev-packages/type-check/ts3.8-test/.gitignore rename {test/typescript/ts3.8 => dev-packages/type-check/ts3.8-test}/index.ts (100%) rename {test/typescript/ts3.8 => dev-packages/type-check/ts3.8-test}/package.json (96%) rename {test/typescript/ts3.8 => dev-packages/type-check/ts3.8-test}/tsconfig.build.json (100%) create mode 100644 dev-packages/type-check/ts3.8-test/yarn.lock create mode 100644 lerna.json rename .eslintignore => packages/core/.eslintignore (68%) rename .eslintrc.js => packages/core/.eslintrc.js (98%) create mode 100644 packages/core/.gitignore rename .npmignore => packages/core/.npmignore (100%) create mode 100644 packages/core/LICENSE.md rename RNSentry.podspec => packages/core/RNSentry.podspec (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/.gitignore (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/app/.gitignore (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/app/build.gradle (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/app/src/androidTest/java/io/sentry/rnsentryandroidtester/RNSentryMapConverterTest.kt (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/app/src/androidTest/resources/mockito-extensions/org.mockito.plugins.MockMaker (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/app/src/main/AndroidManifest.xml (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/app/src/test/java/com/swmansion/rnscreens/ScreenStackFragment.kt (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/app/src/test/java/io/sentry/rnsentryandroidtester/RNSentryBreadcrumbTest.kt (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/app/src/test/java/io/sentry/rnsentryandroidtester/RNSentryReactFragmentLifecycleTracerTest.kt (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/app/src/test/java/io/sentry/rnsentryandroidtester/RNSentryReplayBreadcrumbConverterTest.kt (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/build.gradle (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/gradle.properties (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/gradle/wrapper/gradle-wrapper.jar (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/gradle/wrapper/gradle-wrapper.properties (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/gradlew (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/gradlew.bat (100%) rename {RNSentryAndroidTester => packages/core/RNSentryAndroidTester}/settings.gradle (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/Podfile (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTester.xcodeproj/project.pbxproj (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTester.xcodeproj/project.xcworkspace/contents.xcworkspacedata (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTester.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTester.xcodeproj/xcshareddata/xcschemes/RNSentryCocoaTester.xcscheme (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTester.xcworkspace/contents.xcworkspacedata (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTester.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryBreadcrumbTests.swift (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryCocoaTesterTests-Bridging-Header.h (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryDependencyContainerTests.h (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryDependencyContainerTests.m (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryFramesTrackerListenerTests.h (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryFramesTrackerListenerTests.m (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryOnDrawReporterTests.m (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryReplayBreadcrumbConverterTests.swift (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryTests.h (100%) rename {RNSentryCocoaTester => packages/core/RNSentryCocoaTester}/RNSentryCocoaTesterTests/RNSentryTests.mm (100%) rename {android => packages/core/android}/.gitignore (100%) rename {android => packages/core/android}/build.gradle (100%) rename {android => packages/core/android}/src/main/AndroidManifest.xml (100%) rename {android => packages/core/android}/src/main/java/io/sentry/react/RNSentryBreadcrumb.java (100%) rename {android => packages/core/android}/src/main/java/io/sentry/react/RNSentryMapConverter.java (100%) rename {android => packages/core/android}/src/main/java/io/sentry/react/RNSentryModuleImpl.java (100%) rename {android => packages/core/android}/src/main/java/io/sentry/react/RNSentryOnDrawReporterManager.java (100%) rename {android => packages/core/android}/src/main/java/io/sentry/react/RNSentryPackage.java (100%) rename {android => packages/core/android}/src/main/java/io/sentry/react/RNSentryReactFragmentLifecycleTracer.java (100%) rename {android => packages/core/android}/src/main/java/io/sentry/react/RNSentryReplayBreadcrumbConverter.java (100%) rename {android => packages/core/android}/src/newarch/java/io/sentry/react/RNSentryModule.java (100%) rename {android => packages/core/android}/src/oldarch/java/io/sentry/react/RNSentryModule.java (100%) rename app.plugin.js => packages/core/app.plugin.js (100%) rename {assets => packages/core/assets}/additional-device.png (100%) rename {assets => packages/core/assets}/enriched.png (100%) rename {assets => packages/core/assets}/mixed-stacktrace.png (100%) rename {assets => packages/core/assets}/raven.png (100%) rename babel.config.js => packages/core/babel.config.js (100%) rename expo.d.ts => packages/core/expo.d.ts (100%) rename expo.js => packages/core/expo.js (100%) rename {ios => packages/core/ios}/RNSentry.h (100%) rename {ios => packages/core/ios}/RNSentry.mm (100%) rename {ios => packages/core/ios}/RNSentry.xcodeproj/project.pbxproj (100%) rename {ios => packages/core/ios}/RNSentryBreadcrumb.h (100%) rename {ios => packages/core/ios}/RNSentryBreadcrumb.m (100%) rename {ios => packages/core/ios}/RNSentryDependencyContainer.h (100%) rename {ios => packages/core/ios}/RNSentryDependencyContainer.m (100%) rename {ios => packages/core/ios}/RNSentryEvents.h (100%) rename {ios => packages/core/ios}/RNSentryEvents.m (100%) rename {ios => packages/core/ios}/RNSentryFramesTrackerListener.h (100%) rename {ios => packages/core/ios}/RNSentryFramesTrackerListener.m (100%) rename {ios => packages/core/ios}/RNSentryId.h (100%) rename {ios => packages/core/ios}/RNSentryId.m (100%) rename {ios => packages/core/ios}/RNSentryOnDrawReporter.h (100%) rename {ios => packages/core/ios}/RNSentryOnDrawReporter.m (100%) rename {ios => packages/core/ios}/RNSentryRNSScreen.h (100%) rename {ios => packages/core/ios}/RNSentryRNSScreen.m (100%) rename {ios => packages/core/ios}/RNSentryReplay.h (100%) rename {ios => packages/core/ios}/RNSentryReplay.m (100%) rename {ios => packages/core/ios}/RNSentryReplayBreadcrumbConverter.h (100%) rename {ios => packages/core/ios}/RNSentryReplayBreadcrumbConverter.m (100%) rename jest.config.js => packages/core/jest.config.js (100%) rename jest.config.tools.js => packages/core/jest.config.tools.js (100%) rename metro.d.ts => packages/core/metro.d.ts (100%) rename metro.js => packages/core/metro.js (100%) create mode 100644 packages/core/package.json create mode 100644 packages/core/package.tgz rename {plugin => packages/core/plugin}/src/index.ts (100%) rename {plugin => packages/core/plugin}/src/utils.ts (100%) rename {plugin => packages/core/plugin}/src/withSentry.ts (100%) rename {plugin => packages/core/plugin}/src/withSentryAndroid.ts (100%) rename {plugin => packages/core/plugin}/src/withSentryIOS.ts (100%) rename {plugin => packages/core/plugin}/tsconfig.json (100%) rename react-native.config.js => packages/core/react-native.config.js (100%) create mode 100755 packages/core/scripts/build-tarball.sh rename {scripts => packages/core/scripts}/collect-modules.sh (100%) rename {scripts => packages/core/scripts}/copy-debugid.js (100%) rename {scripts => packages/core/scripts}/expo-upload-sourcemaps.js (100%) rename {scripts => packages/core/scripts}/has-sourcemap-debugid.js (100%) rename {scripts => packages/core/scripts}/hermes-profile-transformer.js (100%) rename {scripts => packages/core/scripts}/sentry-debugid-injection-snippet.js (100%) rename {scripts => packages/core/scripts}/sentry-xcode-debug-files.sh (100%) rename {scripts => packages/core/scripts}/sentry-xcode.sh (100%) rename {scripts => packages/core/scripts}/sentry_utils.rb (100%) rename sentry.gradle => packages/core/sentry.gradle (100%) rename {src => packages/core/src}/js/NativeRNSentry.ts (100%) rename {src => packages/core/src}/js/breadcrumb.ts (100%) rename {src => packages/core/src}/js/client.ts (100%) rename {src => packages/core/src}/js/index.ts (100%) rename {src => packages/core/src}/js/integrations/debugsymbolicator.ts (100%) rename {src => packages/core/src}/js/integrations/debugsymbolicatorutils.ts (100%) rename {src => packages/core/src}/js/integrations/default.ts (100%) rename {src => packages/core/src}/js/integrations/devicecontext.ts (100%) rename {src => packages/core/src}/js/integrations/eventorigin.ts (100%) rename {src => packages/core/src}/js/integrations/expocontext.ts (100%) rename {src => packages/core/src}/js/integrations/exports.ts (100%) rename {src => packages/core/src}/js/integrations/factory.ts (100%) rename {src => packages/core/src}/js/integrations/modulesloader.ts (100%) rename {src => packages/core/src}/js/integrations/nativelinkederrors.ts (100%) rename {src => packages/core/src}/js/integrations/reactnativeerrorhandlers.ts (100%) rename {src => packages/core/src}/js/integrations/reactnativeerrorhandlersutils.ts (100%) rename {src => packages/core/src}/js/integrations/reactnativeinfo.ts (100%) rename {src => packages/core/src}/js/integrations/release.ts (100%) rename {src => packages/core/src}/js/integrations/rewriteframes.ts (100%) rename {src => packages/core/src}/js/integrations/screenshot.ts (100%) rename {src => packages/core/src}/js/integrations/sdkinfo.ts (100%) rename {src => packages/core/src}/js/integrations/spotlight.ts (100%) rename {src => packages/core/src}/js/integrations/viewhierarchy.ts (100%) rename {src => packages/core/src}/js/measurements.ts (100%) rename {src => packages/core/src}/js/misc.ts (100%) rename {src => packages/core/src}/js/options.ts (100%) rename {src => packages/core/src}/js/profiling/cache.ts (100%) rename {src => packages/core/src}/js/profiling/constants.ts (100%) rename {src => packages/core/src}/js/profiling/convertHermesProfile.ts (100%) rename {src => packages/core/src}/js/profiling/debugid.ts (100%) rename {src => packages/core/src}/js/profiling/hermes.ts (100%) rename {src => packages/core/src}/js/profiling/integration.ts (100%) rename {src => packages/core/src}/js/profiling/nativeTypes.ts (100%) rename {src => packages/core/src}/js/profiling/types.ts (100%) rename {src => packages/core/src}/js/profiling/utils.ts (100%) rename {src => packages/core/src}/js/replay/mobilereplay.ts (100%) rename {src => packages/core/src}/js/replay/networkUtils.ts (100%) rename {src => packages/core/src}/js/replay/xhrUtils.ts (100%) rename {src => packages/core/src}/js/scopeSync.ts (100%) rename {src => packages/core/src}/js/sdk.tsx (100%) rename {src => packages/core/src}/js/tools/ModulesCollector.ts (100%) rename {src => packages/core/src}/js/tools/collectModules.ts (100%) rename {src => packages/core/src}/js/tools/enableLogger.ts (100%) rename {src => packages/core/src}/js/tools/metroconfig.ts (100%) rename {src => packages/core/src}/js/tools/sentryBabelTransformer.ts (100%) rename {src => packages/core/src}/js/tools/sentryBabelTransformerUtils.ts (100%) rename {src => packages/core/src}/js/tools/sentryMetroSerializer.ts (98%) rename {src => packages/core/src}/js/tools/utils.ts (95%) rename {src => packages/core/src}/js/tools/vendor/expo/expoconfig.ts (100%) rename {src => packages/core/src}/js/tools/vendor/metro/metro.d.ts (100%) rename {src => packages/core/src}/js/tools/vendor/metro/metroBabelTransformer.ts (100%) rename {src => packages/core/src}/js/tools/vendor/metro/utils.ts (94%) rename {src => packages/core/src}/js/touchevents.tsx (100%) rename {src => packages/core/src}/js/tracing/gesturetracing.ts (100%) rename {src => packages/core/src}/js/tracing/index.ts (100%) rename {src => packages/core/src}/js/tracing/integrations/appStart.ts (100%) rename {src => packages/core/src}/js/tracing/integrations/nativeFrames.ts (100%) rename {src => packages/core/src}/js/tracing/integrations/stalltracking.ts (100%) rename {src => packages/core/src}/js/tracing/integrations/userInteraction.ts (100%) rename {src => packages/core/src}/js/tracing/onSpanEndUtils.ts (100%) rename {src => packages/core/src}/js/tracing/ops.ts (100%) rename {src => packages/core/src}/js/tracing/origin.ts (100%) rename {src => packages/core/src}/js/tracing/reactnativenavigation.ts (100%) rename {src => packages/core/src}/js/tracing/reactnativeprofiler.tsx (100%) rename {src => packages/core/src}/js/tracing/reactnativetracing.ts (100%) rename {src => packages/core/src}/js/tracing/reactnavigation.ts (100%) rename {src => packages/core/src}/js/tracing/semanticAttributes.ts (100%) rename {src => packages/core/src}/js/tracing/span.ts (100%) rename {src => packages/core/src}/js/tracing/timetodisplay.tsx (100%) rename {src => packages/core/src}/js/tracing/timetodisplaynative.tsx (100%) rename {src => packages/core/src}/js/tracing/timetodisplaynative.types.ts (100%) rename {src => packages/core/src}/js/tracing/types.ts (100%) rename {src => packages/core/src}/js/tracing/utils.ts (100%) rename {src => packages/core/src}/js/transports/encodePolyfill.ts (100%) rename {src => packages/core/src}/js/transports/native.ts (100%) rename {src => packages/core/src}/js/user.ts (100%) rename {src => packages/core/src}/js/utils/AsyncExpiringMap.ts (100%) rename {src => packages/core/src}/js/utils/clientutils.ts (100%) rename {src => packages/core/src}/js/utils/envelope.ts (100%) rename {src => packages/core/src}/js/utils/environment.ts (100%) rename {src => packages/core/src}/js/utils/error.ts (100%) rename {src => packages/core/src}/js/utils/expoglobalobject.ts (100%) rename {src => packages/core/src}/js/utils/expomodules.ts (100%) rename {src => packages/core/src}/js/utils/fill.ts (100%) rename {src => packages/core/src}/js/utils/ignorerequirecyclelogs.ts (100%) rename {src => packages/core/src}/js/utils/normalize.ts (100%) rename {src => packages/core/src}/js/utils/outcome.ts (100%) rename {src => packages/core/src}/js/utils/rnlibraries.ts (100%) rename {src => packages/core/src}/js/utils/rnlibraries.web.ts (100%) rename {src => packages/core/src}/js/utils/rnlibrariesinterface.ts (100%) rename {src => packages/core/src}/js/utils/safe.ts (100%) rename {src => packages/core/src}/js/utils/sentryeventemitter.ts (100%) rename {src => packages/core/src}/js/utils/span.ts (100%) rename {src => packages/core/src}/js/utils/worldwide.ts (100%) rename {src => packages/core/src}/js/utils/xhr.ts (100%) rename {src => packages/core/src}/js/vendor/base64-js/fromByteArray.ts (100%) rename {src => packages/core/src}/js/vendor/base64-js/index.ts (100%) rename {src => packages/core/src}/js/vendor/buffer/index.ts (100%) rename {src => packages/core/src}/js/vendor/buffer/utf8ToBytes.ts (100%) rename {src => packages/core/src}/js/vendor/index.ts (100%) rename {src => packages/core/src}/js/vendor/react-native/index.ts (100%) rename {src => packages/core/src}/js/version.ts (100%) rename {src => packages/core/src}/js/wrapper.ts (100%) rename {test => packages/core/test}/breadcrumb.test.ts (100%) rename {test => packages/core/test}/client.test.ts (100%) rename {test => packages/core/test}/error.test.ts (100%) rename {test => packages/core/test}/expo-plugin/modifyAppBuildGradle.test.ts (100%) rename {test => packages/core/test}/expo-plugin/modifyXcodeProject.test.ts (100%) rename {test => packages/core/test}/integrations/debugsymbolicator.test.ts (100%) rename {test => packages/core/test}/integrations/devicecontext.test.ts (100%) rename {test => packages/core/test}/integrations/eventorigin.test.ts (100%) rename {test => packages/core/test}/integrations/expocontext.test.ts (100%) rename {test => packages/core/test}/integrations/integrationsexecutionorder.test.ts (100%) rename {test => packages/core/test}/integrations/modulesloader.test.ts (100%) rename {test => packages/core/test}/integrations/nativelinkederrors.test.ts (100%) rename {test => packages/core/test}/integrations/reactnativeerrorhandlers.test.ts (100%) rename {test => packages/core/test}/integrations/reactnativeinfo.test.ts (100%) rename {test => packages/core/test}/integrations/release.test.ts (100%) rename {test => packages/core/test}/integrations/rewriteframes.test.ts (100%) rename {test => packages/core/test}/integrations/sdkinfo.test.ts (100%) rename {test => packages/core/test}/integrations/spotlight.test.ts (100%) rename {test => packages/core/test}/integrations/viewhierarchy.test.ts (100%) rename {test => packages/core/test}/misc.test.ts (100%) rename {test => packages/core/test}/mockConsole.ts (100%) rename {test => packages/core/test}/mockDsn.ts (100%) rename {test => packages/core/test}/mockWrapper.ts (100%) rename {test => packages/core/test}/mocks/client.ts (100%) rename {test => packages/core/test}/profiling/convertHermesProfile.test.ts (100%) rename {test => packages/core/test}/profiling/fixtures.ts (100%) rename {test => packages/core/test}/profiling/hermes.test.ts (100%) rename {test => packages/core/test}/profiling/integration.android.test.ts (100%) rename {test => packages/core/test}/profiling/integration.ios.test.ts (100%) rename {test => packages/core/test}/profiling/integration.test.ts (100%) rename {test => packages/core/test}/profiling/integrationmerge.test.ts (100%) rename {test => packages/core/test}/replay/networkUtils.test.ts (100%) rename {test => packages/core/test}/replay/xhrUtils.test.ts (100%) rename {test => packages/core/test}/scopeSync.test.ts (100%) rename {test => packages/core/test}/sdk.test.ts (100%) rename {test => packages/core/test}/sdk.withclient.test.ts (100%) rename {test => packages/core/test}/testutils.ts (100%) rename {test => packages/core/test}/tools/collectModules.test.ts (100%) rename {test => packages/core/test}/tools/fixtures/bundleWithPrelude.js.fixture (100%) rename {test => packages/core/test}/tools/fixtures/bundleWithPrelude.js.fixture.map (100%) rename {test => packages/core/test}/tools/fixtures/mock.map (100%) rename {test => packages/core/test}/tools/fixtures/mockBabelTransformer.js (100%) rename {test => packages/core/test}/tools/fixtures/root-module/modules/@organization/module3/package.json (100%) rename {test => packages/core/test}/tools/fixtures/root-module/modules/module1/modules/not-collected/package.json (100%) rename {test => packages/core/test}/tools/fixtures/root-module/modules/module1/package.json (100%) rename {test => packages/core/test}/tools/fixtures/root-module/modules/module2/package.json (100%) rename {test => packages/core/test}/tools/fixtures/root-module/package.json (100%) rename {test => packages/core/test}/tools/metroconfig.test.ts (100%) rename {test => packages/core/test}/tools/sentryBabelTransformer.test.ts (100%) rename {test => packages/core/test}/tools/sentryMetroSerializer.test.ts (100%) rename {test => packages/core/test}/touchevents.test.tsx (100%) rename {test => packages/core/test}/tracing/addTracingExtensions.test.ts (100%) rename {test => packages/core/test}/tracing/gesturetracing.test.ts (100%) rename {test => packages/core/test}/tracing/idleNavigationSpan.test.ts (100%) rename {test => packages/core/test}/tracing/integrations/appStart.test.ts (100%) rename {test => packages/core/test}/tracing/integrations/nativeframes.test.ts (100%) rename {test => packages/core/test}/tracing/integrations/stallTracking/stalltracking.background.test.ts (100%) rename {test => packages/core/test}/tracing/integrations/stallTracking/stalltracking.iteration.test.ts (100%) rename {test => packages/core/test}/tracing/integrations/stallTracking/stalltracking.test.ts (100%) rename {test => packages/core/test}/tracing/integrations/stallTracking/stalltrackingutils.ts (100%) rename {test => packages/core/test}/tracing/integrations/userInteraction.test.ts (100%) rename {test => packages/core/test}/tracing/mockedtimetodisplaynative.tsx (100%) rename {test => packages/core/test}/tracing/reactnativenavigation.test.ts (100%) rename {test => packages/core/test}/tracing/reactnativetracing.test.ts (100%) rename {test => packages/core/test}/tracing/reactnavigation.stalltracking.test.ts (100%) rename {test => packages/core/test}/tracing/reactnavigation.test.ts (100%) rename {test => packages/core/test}/tracing/reactnavigation.ttid.test.tsx (100%) rename {test => packages/core/test}/tracing/reactnavigationutils.ts (100%) rename {test => packages/core/test}/tracing/timetodisplay.test.tsx (100%) rename {test => packages/core/test}/tracing/timetodisplaynative.web.test.tsx (100%) rename {test => packages/core/test}/transports/native.test.ts (100%) rename {test => packages/core/test}/utils/AsyncExpiringMap.test.ts (100%) rename {test => packages/core/test}/utils/mockedSentryeventemitter.ts (100%) rename {test => packages/core/test}/utils/normalize.test.ts (100%) rename {test => packages/core/test}/utils/safe.test.ts (100%) rename {test => packages/core/test}/utils/sentryeventemitter.test.ts (100%) rename {test => packages/core/test}/utils/xhr.test.ts (100%) rename {test => packages/core/test}/vendor/base64-js/big-data.test.ts (100%) rename {test => packages/core/test}/vendor/base64-js/convert.test.ts (100%) rename {test => packages/core/test}/vendor/buffer/utf8ToBytes.test.ts (100%) rename {test => packages/core/test}/vendor/buffer/utf8ToBytesSize.test.ts (100%) rename {test => packages/core/test}/wrap.test.tsx (100%) rename {test => packages/core/test}/wrapper.test.ts (100%) rename tsconfig.build.json => packages/core/tsconfig.build.json (79%) rename tsconfig.build.tools.json => packages/core/tsconfig.build.tools.json (80%) rename tsconfig.json => packages/core/tsconfig.json (100%) rename {typings => packages/core/typings}/jest-extended.d.ts (100%) rename {test/perf => performance-tests}/TestAppPlain/.buckconfig (100%) rename {test/perf => performance-tests}/TestAppPlain/.flowconfig (100%) rename {test/perf => performance-tests}/TestAppPlain/.gitignore (100%) rename {test/perf => performance-tests}/TestAppPlain/.watchmanconfig (100%) rename {test/perf => performance-tests}/TestAppPlain/App.js (100%) rename {test/perf => performance-tests}/TestAppPlain/Gemfile (100%) rename {test/perf => performance-tests}/TestAppPlain/__tests__/App-test.js (100%) rename {test/perf => performance-tests}/TestAppPlain/_bundle/config (100%) rename {test/perf => performance-tests}/TestAppPlain/_ruby-version (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/_BUCK (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/build.gradle (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/build_defs.bzl (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/debug.keystore (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/proguard-rules.pro (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/debug/AndroidManifest.xml (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/debug/java/com/testappplain/ReactNativeFlipper.java (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/AndroidManifest.xml (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/java/com/testappplain/MainActivity.java (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/java/com/testappplain/MainApplication.java (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/java/com/testappplain/newarchitecture/MainApplicationReactNativeHost.java (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/java/com/testappplain/newarchitecture/components/MainComponentsRegistry.java (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/java/com/testappplain/newarchitecture/modules/MainApplicationTurboModuleManagerDelegate.java (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/jni/CMakeLists.txt (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/jni/MainApplicationModuleProvider.cpp (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/jni/MainApplicationModuleProvider.h (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/jni/MainApplicationTurboModuleManagerDelegate.cpp (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/jni/MainApplicationTurboModuleManagerDelegate.h (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/jni/MainComponentsRegistry.cpp (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/jni/MainComponentsRegistry.h (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/jni/OnLoad.cpp (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/drawable/rn_edit_text_material.xml (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-hdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-hdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-mdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-mdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/values/strings.xml (100%) rename {test/perf => performance-tests}/TestAppPlain/android/app/src/main/res/values/styles.xml (100%) rename {test/perf => performance-tests}/TestAppPlain/android/build.gradle (100%) rename {test/perf => performance-tests}/TestAppPlain/android/debug.keystore (100%) rename {test/perf => performance-tests}/TestAppPlain/android/gradle.properties (100%) rename {test/perf => performance-tests}/TestAppPlain/android/gradle/wrapper/gradle-wrapper.jar (100%) rename {test/perf => performance-tests}/TestAppPlain/android/gradle/wrapper/gradle-wrapper.properties (100%) rename {test/perf => performance-tests}/TestAppPlain/android/gradlew (100%) rename {test/perf => performance-tests}/TestAppPlain/android/gradlew.bat (100%) rename {test/perf => performance-tests}/TestAppPlain/android/settings.gradle (100%) rename {test/perf => performance-tests}/TestAppPlain/app.json (100%) rename {test/perf => performance-tests}/TestAppPlain/babel.config.js (100%) rename {test/perf => performance-tests}/TestAppPlain/index.js (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/Podfile (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain.xcodeproj/project.pbxproj (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain.xcodeproj/xcshareddata/xcschemes/TestAppPlain.xcscheme (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain.xcworkspace/contents.xcworkspacedata (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain/AppDelegate.h (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain/AppDelegate.mm (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain/Images.xcassets/AppIcon.appiconset/Contents.json (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain/Images.xcassets/Contents.json (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain/Info.plist (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain/LaunchScreen.storyboard (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlain/main.m (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlainTests/Info.plist (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/TestAppPlainTests/TestAppPlainTests.m (100%) rename {test/perf => performance-tests}/TestAppPlain/ios/_xcode.env (100%) rename {test/perf => performance-tests}/TestAppPlain/metro.config.js (100%) rename {test/perf => performance-tests}/TestAppPlain/package.json (85%) rename {test/perf => performance-tests}/TestAppSentry/.buckconfig (100%) rename {test/perf => performance-tests}/TestAppSentry/.flowconfig (100%) rename {test/perf => performance-tests}/TestAppSentry/.gitignore (100%) rename {test/perf => performance-tests}/TestAppSentry/.watchmanconfig (100%) rename {test/perf => performance-tests}/TestAppSentry/App.js (100%) rename {test/perf => performance-tests}/TestAppSentry/Gemfile (100%) rename {test/perf => performance-tests}/TestAppSentry/__tests__/App-test.js (100%) rename {test/perf => performance-tests}/TestAppSentry/_bundle/config (100%) rename {test/perf => performance-tests}/TestAppSentry/_ruby-version (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/_BUCK (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/build.gradle (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/build_defs.bzl (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/debug.keystore (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/proguard-rules.pro (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/debug/AndroidManifest.xml (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/debug/java/com/testappsentry/ReactNativeFlipper.java (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/AndroidManifest.xml (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/java/com/testappsentry/MainActivity.java (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/java/com/testappsentry/MainApplication.java (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/java/com/testappsentry/newarchitecture/MainApplicationReactNativeHost.java (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/java/com/testappsentry/newarchitecture/components/MainComponentsRegistry.java (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/java/com/testappsentry/newarchitecture/modules/MainApplicationTurboModuleManagerDelegate.java (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/jni/CMakeLists.txt (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/jni/MainApplicationModuleProvider.cpp (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/jni/MainApplicationModuleProvider.h (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/jni/MainApplicationTurboModuleManagerDelegate.cpp (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/jni/MainApplicationTurboModuleManagerDelegate.h (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/jni/MainComponentsRegistry.cpp (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/jni/MainComponentsRegistry.h (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/jni/OnLoad.cpp (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/drawable/rn_edit_text_material.xml (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-hdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-hdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-mdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-mdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/values/strings.xml (100%) rename {test/perf => performance-tests}/TestAppSentry/android/app/src/main/res/values/styles.xml (100%) rename {test/perf => performance-tests}/TestAppSentry/android/build.gradle (100%) rename {test/perf => performance-tests}/TestAppSentry/android/debug.keystore (100%) rename {test/perf => performance-tests}/TestAppSentry/android/gradle.properties (100%) rename {test/perf => performance-tests}/TestAppSentry/android/gradle/wrapper/gradle-wrapper.jar (100%) rename {test/perf => performance-tests}/TestAppSentry/android/gradle/wrapper/gradle-wrapper.properties (100%) rename {test/perf => performance-tests}/TestAppSentry/android/gradlew (100%) rename {test/perf => performance-tests}/TestAppSentry/android/gradlew.bat (100%) rename {test/perf => performance-tests}/TestAppSentry/android/settings.gradle (100%) rename {test/perf => performance-tests}/TestAppSentry/app.json (100%) rename {test/perf => performance-tests}/TestAppSentry/babel.config.js (100%) rename {test/perf => performance-tests}/TestAppSentry/index.js (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/Podfile (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry.xcodeproj/project.pbxproj (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry.xcodeproj/xcshareddata/xcschemes/TestAppSentry.xcscheme (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry.xcworkspace/contents.xcworkspacedata (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry/AppDelegate.h (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry/AppDelegate.mm (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry/Images.xcassets/AppIcon.appiconset/Contents.json (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry/Images.xcassets/Contents.json (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry/Info.plist (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry/LaunchScreen.storyboard (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentry/main.m (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentryTests/Info.plist (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/TestAppSentryTests/TestAppSentryTests.m (100%) rename {test/perf => performance-tests}/TestAppSentry/ios/_xcode.env (100%) create mode 100644 performance-tests/TestAppSentry/metro.config.js rename {test/perf => performance-tests}/TestAppSentry/package.json (73%) rename {test/perf => performance-tests}/fastlane/.gitignore (100%) rename {test/perf => performance-tests}/fastlane/Appfile (100%) rename {test/perf => performance-tests}/fastlane/Fastfile (100%) rename {test/perf => performance-tests}/fastlane/Matchfile (100%) rename {test/perf => performance-tests}/fastlane/Pluginfile (100%) rename {test/perf => performance-tests}/metrics-android.yml (100%) rename {test/perf => performance-tests}/metrics-ios.yml (100%) delete mode 100644 samples/expo/withSampleSentry.js delete mode 100644 samples/expo/withSampleSentry.ts delete mode 100644 samples/expo/yarn.lock create mode 100644 samples/react-native/main.jsbundle.map delete mode 100644 samples/react-native/yarn.lock delete mode 100755 scripts/set-version-samples.sh delete mode 100644 test/e2e/package.json delete mode 100644 test/e2e/yarn.lock delete mode 100644 test/perf/TestAppPlain/.eslintrc.js delete mode 100644 test/perf/TestAppPlain/.prettierrc.js delete mode 100644 test/perf/TestAppPlain/yarn.lock delete mode 100644 test/perf/TestAppSentry/.eslintrc.js delete mode 100644 test/perf/TestAppSentry/.prettierrc.js delete mode 100644 test/perf/TestAppSentry/metro.config.js delete mode 100644 test/perf/TestAppSentry/yarn.lock delete mode 100644 test/typescript/ts3.8/yarn.lock diff --git a/.craft.yml b/.craft.yml index 7cb0aeb992..9022463820 100644 --- a/.craft.yml +++ b/.craft.yml @@ -7,4 +7,4 @@ targets: - name: registry sdks: npm:@sentry/react-native: - includeNames: /none/ + includeNames: /^sentry-react-native-\d.*\.tgz$/ diff --git a/.github/workflows/buildandtest.yml b/.github/workflows/buildandtest.yml index 53f9a7c901..ace7a64e13 100644 --- a/.github/workflows/buildandtest.yml +++ b/.github/workflows/buildandtest.yml @@ -18,16 +18,13 @@ jobs: if: ${{ needs.diff_check.outputs.skip_ci != 'true' }} steps: - uses: actions/checkout@v4 + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 18 - - uses: actions/cache@v4 - id: cache - with: - path: node_modules - key: ${{ runner.os }}-${{ github.sha }} + cache: 'yarn' + cache-dependency-path: yarn.lock - name: Install Dependencies - if: ${{ steps.cache.outputs['cache-hit'] != 'true' }} run: yarn install - name: Test run: yarn test @@ -39,37 +36,17 @@ jobs: if: ${{ needs.diff_check.outputs.skip_ci != 'true' }} steps: - uses: actions/checkout@v4 - - uses: actions/cache@v4 - id: cache + - run: corepack enable + - uses: actions/setup-node@v4 with: - path: node_modules - key: ${{ runner.os }}-${{ github.sha }} + node-version: 18 + cache: 'yarn' + cache-dependency-path: yarn.lock - name: Install Dependencies - if: ${{ steps.cache.outputs['cache-hit'] != 'true' }} run: yarn install - name: Lint run: yarn lint - job_lint_sample_new_arch: - name: Lint Sample - runs-on: ubuntu-latest - needs: [diff_check] - if: ${{ needs.diff_check.outputs.skip_ci != 'true' }} - steps: - - uses: actions/checkout@v4 - - uses: actions/cache@v4 - id: cache - with: - path: samples/react-native/node_modules - key: ${{ runner.os }}-${{ github.sha }} - - name: Install Dependencies - if: steps.cache.outputs['cache-hit'] != 'true' - run: yarn install - working-directory: samples/react-native - - name: Lint Sample - run: yarn lint - working-directory: samples/react-native - job_check_integrity: name: Check package integrity runs-on: ubuntu-latest @@ -77,11 +54,14 @@ jobs: if: ${{ needs.diff_check.outputs.skip_ci != 'true' }} steps: - uses: actions/checkout@v4 - - uses: actions/cache@v4 - id: cache + - run: corepack enable + - uses: actions/setup-node@v4 with: - path: node_modules - key: ${{ runner.os }}-${{ github.sha }} + node-version: 18 + cache: 'yarn' + cache-dependency-path: yarn.lock + - name: Install Dependencies + run: yarn install - name: Save initial lock file run: cp yarn.lock yarn.lock.initial - name: Install Dependencies (update lock if necessary) @@ -97,16 +77,13 @@ jobs: if: ${{ needs.diff_check.outputs.skip_ci != 'true' }} steps: - uses: actions/checkout@v4 + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 18 - - uses: actions/cache@v4 - id: cache - with: - path: node_modules - key: ${{ runner.os }}-${{ github.sha }} + cache: 'yarn' + cache-dependency-path: yarn.lock - name: Install Dependencies - if: ${{ steps.cache.outputs['cache-hit'] != 'true' }} run: yarn install - name: Build run: yarn build @@ -114,66 +91,58 @@ jobs: uses: actions/upload-artifact@v4 with: name: dist - path: dist + path: packages/core/dist - name: Archive ts3.8 uses: actions/upload-artifact@v4 with: name: ts3.8 - path: ts3.8 + path: packages/core/ts3.8 - name: Archive Expo Plugin uses: actions/upload-artifact@v4 with: name: expo-plugin - path: plugin/build + path: packages/core/plugin/build - name: Pack - run: yarn pack + run: yarn build:tarball - name: Archive Artifacts uses: actions/upload-artifact@v4 with: name: ${{ github.sha }} path: | - ${{ github.workspace }}/*.tgz + ${{ github.workspace }}/packages/core/*.tgz job_type_check: name: Type Check Typescript 3.8 runs-on: ubuntu-latest needs: [job_build, diff_check] if: ${{ needs.diff_check.outputs.skip_ci != 'true' }} + env: + YARN_ENABLE_IMMUTABLE_INSTALLS: false steps: - uses: actions/checkout@v4 + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 18 - - uses: actions/cache@v4 - id: cache - with: - path: test/typescript/ts3.8/node_modules - key: ${{ runner.os }}-${{ github.sha }}-ts3.8 + cache: 'yarn' + cache-dependency-path: yarn.lock + - name: Install Dependencies + run: yarn install - name: Download dist uses: actions/download-artifact@v4 with: name: dist - path: dist + path: packages/core/dist - name: Download ts3.8 uses: actions/download-artifact@v4 with: name: ts3.8 - path: ts3.8 + path: packages/core/ts3.8 - name: Install Global Dependencies - run: yarn global add yalc - - name: Publish SDK - run: yalc publish - - name: Install SDK - working-directory: test/typescript/ts3.8 - run: yalc add @sentry/react-native - - name: Install Dependencies - if: ${{ steps.cache.outputs['cache-hit'] != 'true' }} - working-directory: test/typescript/ts3.8 - run: yarn install + run: npm i -g add yalc - name: Type Check - working-directory: test/typescript/ts3.8 + working-directory: dev-packages/type-check run: yarn type-check - job_circular_dep_check: name: Circular Dependency Check runs-on: ubuntu-latest @@ -181,28 +150,24 @@ jobs: if: ${{ needs.diff_check.outputs.skip_ci != 'true' }} steps: - uses: actions/checkout@v4 + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 18 - - name: Cache Dependencies - uses: actions/cache@v4 - id: cache - with: - path: node_modules - key: ${{ runner.os }}-${{ github.sha }} + cache: 'yarn' + cache-dependency-path: yarn.lock - name: Install Dependencies - if: ${{ steps.cache.outputs['cache-hit'] != 'true' }} run: yarn install - name: Download dist uses: actions/download-artifact@v4 with: name: dist - path: dist + path: packages/core/dist - name: Download Expo Plugin uses: actions/download-artifact@v4 with: name: expo-plugin - path: plugin/build + path: packages/core/plugin/build - name: Run madge run: yarn circularDepCheck @@ -219,28 +184,14 @@ jobs: dev: [true, false] steps: - uses: actions/checkout@v4 + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 18 - - name: Cache Dependencies - uses: actions/cache@v4 - id: cache - with: - path: node_modules - key: ${{ runner.os }}-${{ github.sha }} - - name: Cache Sample Dependencies - uses: actions/cache@v4 - id: cache-sample - with: - path: samples/react-native/node_modules - key: ${{ runner.os }}-${{ hashFiles('samples/react-native/yarn.lock') }} + cache: 'yarn' + cache-dependency-path: yarn.lock - name: Install Dependencies - if: ${{ steps.cache.outputs['cache-hit'] != 'true' }} - run: yarn install - - name: Install Sample Dependencies - if: ${{ steps.cache-sample.outputs['cache-hit'] != 'true' }} run: yarn install - working-directory: samples/react-native - name: Build run: yarn build - name: Make Sample Build Directory diff --git a/.github/workflows/codegen.yml b/.github/workflows/codegen.yml index 884705b915..44a9973de2 100644 --- a/.github/workflows/codegen.yml +++ b/.github/workflows/codegen.yml @@ -31,24 +31,19 @@ jobs: --outputPath codegen steps: - uses: actions/checkout@v4 + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 18 + cache: 'yarn' + cache-dependency-path: yarn.lock - uses: actions/setup-java@v4 with: java-version: '17' distribution: "adopt" - name: Gradle cache uses: gradle/gradle-build-action@v3 - - uses: actions/cache@v4 - id: cache - with: - path: samples/react-native/node_modules - key: ${{ runner.os }}-${{ github.sha }} - name: Install Dependencies - if: steps.cache.outputs['cache-hit'] != 'true' - run: | - cd samples/react-native - yarn install + run: yarn install - name: Codegen run: ${{ matrix.command }} diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml index 4a2e0e2735..29386e80e5 100644 --- a/.github/workflows/e2e.yml +++ b/.github/workflows/e2e.yml @@ -42,11 +42,11 @@ jobs: - platform: ios runs-on: macos-12 name: iOS - appPlain: test/perf/test-app-plain.ipa + appPlain: performance-tests/test-app-plain.ipa - platform: android runs-on: ubuntu-latest name: Android - appPlain: test/perf/TestAppPlain/android/app/build/outputs/apk/release/app-release.apk + appPlain: performance-tests/TestAppPlain/android/app/build/outputs/apk/release/app-release.apk steps: - uses: actions/checkout@v4 @@ -56,9 +56,13 @@ jobs: - run: sudo xcode-select -s /Applications/Xcode_14.2.app/Contents/Developer if: ${{ matrix.platform == 'ios' }} + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 18 + cache: 'yarn' + cache-dependency-path: yarn.lock + - uses: actions/setup-java@v4 with: java-version: '17' @@ -66,24 +70,12 @@ jobs: - name: Gradle cache uses: gradle/gradle-build-action@v3 - name: Install Global Dependencies - run: yarn global add react-native-cli @sentry/cli yalc - - uses: actions/cache@v4 - id: deps-cache - with: - path: | - node_modules - test/perf/TestAppSentry/node_modules - key: ${{ github.workflow }}-${{ github.job }}-${{ hashFiles('yarn.lock', 'test/perf/TestAppSentry/yarn.lock') }} + run: npm i -g react-native-cli @sentry/cli - name: Install Dependencies - if: steps.deps-cache.outputs['cache-hit'] != 'true' run: yarn install - name: Build SDK run: yarn build - - name: Package SDK - run: yalc publish - - uses: actions/setup-node@v4 - with: - node-version: 18 + - uses: actions/cache@v4 id: app-plain-cache with: @@ -91,12 +83,13 @@ jobs: # if the whole plain app folder is hashed the cache is never hit as there are files generated in the folder # the cache key is calculated both at cache retrieval and save time # hashFiles fails when there are rn android new arch generated files in the folder (exact reason unknown) - key: ${{ github.workflow }}-${{ github.job }}-appplain-${{ matrix.platform }}-${{ matrix.rn-architecture }}-${{ hashFiles('test/perf/TestAppPlain/yarn.lock') }} + # we removed the lock file of the app due to monorepo changes, we use the package.json instead + # to avoid frequent rebuilds of the app + key: ${{ github.workflow }}-${{ github.job }}-appplain-${{ matrix.platform }}-${{ matrix.rn-architecture }}-${{ hashFiles('performance-tests/TestAppSentry/package.json') }} - name: Build app plain if: steps.app-plain-cache.outputs['cache-hit'] != 'true' - working-directory: ./test/perf/TestAppPlain + working-directory: ./performance-tests/TestAppPlain run: | - yarn install cd ${{ matrix.platform }} if [[ "${{ matrix.platform }}" == "android" ]]; then if [[ ${{ matrix.rn-architecture }} == 'new' ]]; then @@ -121,10 +114,8 @@ jobs: MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }} MATCH_USERNAME: ${{ secrets.MATCH_USERNAME }} - name: Build app with Sentry - working-directory: ./test/perf/TestAppSentry + working-directory: ./performance-tests/TestAppSentry run: | - yalc add @sentry/react-native - yarn install cd ${{ matrix.platform }} if [[ "${{ matrix.platform }}" == "android" ]]; then if [[ ${{ matrix.rn-architecture }} == 'new' ]]; then @@ -141,8 +132,6 @@ jobs: fastlane build_perf_test_app_sentry cd TestAppSentry fi - # Remove after build so that the cache isn't invaldiated due to the changes in yarn.lock. - yarn remove @sentry/react-native env: APP_STORE_CONNECT_KEY_ID: ${{ secrets.APP_STORE_CONNECT_KEY_ID }} APP_STORE_CONNECT_ISSUER_ID: ${{ secrets.APP_STORE_CONNECT_ISSUER_ID }} @@ -155,7 +144,7 @@ jobs: uses: getsentry/action-app-sdk-overhead-metrics@v1 with: name: ${{ matrix.name }} (${{ matrix.rn-architecture }}) - config: ./test/perf/metrics-${{ matrix.platform }}.yml + config: ./performance-tests/metrics-${{ matrix.platform }}.yml sauce-user: ${{ secrets.SAUCE_USERNAME }} sauce-key: ${{ secrets.SAUCE_ACCESS_KEY }} @@ -241,13 +230,12 @@ jobs: - run: sudo xcode-select -s /Applications/Xcode_14.2.app/Contents/Developer if: ${{ matrix.platform == 'ios' && matrix.rn-version == '0.65.3' }} - - name: Enable Corepack # RN 0.73.9 and newer are using yarn 3 which requires corepack - if: ${{ matrix.rn-version == '0.73.9' }} - run: corepack enable - + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 18 + cache: 'yarn' + cache-dependency-path: yarn.lock - uses: actions/setup-java@v4 with: @@ -259,60 +247,43 @@ jobs: - name: Setup Global Tools run: | - yarn global add yalc semver + npm i -g yalc semver - name: Setup Global Xcode Tools if: ${{ matrix.platform == 'ios' }} run: which xcbeautify || brew install xcbeautify - - name: NPM cache SDK - uses: actions/cache@v4 - id: deps-cache - with: - path: node_modules - key: ${{ github.workflow }}-${{ github.job }}-npm-${{ hashFiles('yarn.lock') }} - - - name: NPM cache E2E Tests Library - uses: actions/cache@v4 - id: deps-cache-e2e-library - with: - path: test/e2e/node_modules - key: ${{ github.workflow }}-${{ github.job }}-npm-${{ hashFiles('test/e2e/yarn.lock') }} - - - name: Install SDK JS Dependencies - if: steps.deps-cache.outputs['cache-hit'] != 'true' + - name: Install JS Dependencies run: yarn install - - name: Install E2E Tests Library JS Dependencies - if: steps.deps-cache-e2e-library.outputs['cache-hit'] != 'true' - working-directory: test/e2e - run: yarn install + - name: Setup Plain RN ${{ matrix.rn-version }} App + run: ./dev-packages/e2e-tests/cli.mjs ${{ matrix.platform }} --create + # The old node has to be enabled after creating the test app + # to avoid issues with the old node version + - run: corepack disable - uses: actions/setup-node@v4 if: ${{ matrix.rn-version == '0.65.3' }} with: node-version: 16 - - name: Setup Plain RN ${{ matrix.rn-version }} App - run: ./scripts/e2e.mjs ${{ matrix.platform }} --create - - uses: ruby/setup-ruby@v1 if: ${{ matrix.platform == 'ios' }} with: - working-directory: test/react-native/versions/${{ matrix.rn-version }}/RnDiffApp + working-directory: dev-packages/e2e-tests/react-native-versions/${{ matrix.rn-version }}/RnDiffApp ruby-version: '3.3.0' # based on what is used in the sample bundler-cache: true # runs 'bundle install' and caches installed gems automatically cache-version: 1 # cache the installed gems - name: Build Plain RN ${{ matrix.rn-version }} App - run: ./scripts/e2e.mjs ${{ matrix.platform }} --build + run: ./dev-packages/e2e-tests/cli.mjs ${{ matrix.platform }} --build - name: Upload App if: matrix.build-type == 'production' uses: actions/upload-artifact@v4 with: name: ${{ matrix.rn-version }}-${{ matrix.rn-architecture }}-${{ matrix.engine }}-${{ matrix.platform }}-${{ matrix.build-type }}-${{ matrix.ios-use-frameworks }}-app-package - path: test/e2e/RnDiffApp.ap* + path: dev-packages/e2e-tests/RnDiffApp.ap* retention-days: 1 - name: Upload logs @@ -320,7 +291,7 @@ jobs: uses: actions/upload-artifact@v4 with: name: rn-build-logs-${{ matrix.rn-version }}-${{ matrix.rn-architecture }}-${{ matrix.engine }}-${{ matrix.platform }}-${{ matrix.build-type }}-${{ matrix.ios-use-frameworks }} - path: test/react-native/versions/${{ matrix.rn-version }}/RnDiffApp/ios/*.log + path: dev-packages/e2e-tests/react-native-versions/${{ matrix.rn-version }}/RnDiffApp/ios/*.log react-native-test: name: @@ -383,11 +354,14 @@ jobs: uses: actions/download-artifact@v4 with: name: ${{ matrix.rn-version }}-${{ matrix.rn-architecture }}-${{ matrix.engine }}-${{ matrix.platform }}-${{ matrix.build-type }}-${{ matrix.ios-use-frameworks }}-app-package - path: test/e2e + path: dev-packages/e2e-tests + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 20 + cache: 'yarn' + cache-dependency-path: yarn.lock - uses: actions/setup-java@v4 with: @@ -409,16 +383,7 @@ jobs: sudo udevadm control --reload-rules sudo udevadm trigger --name-match=kvm - - name: NPM cache E2E Tests Library - uses: actions/cache@v4 - id: deps-cache-e2e-library - with: - path: test/e2e/node_modules - key: ${{ github.workflow }}-${{ github.job }}-npm-${{ hashFiles('test/e2e/yarn.lock') }} - - - name: Install E2E Tests Library JS Dependencies - if: steps.deps-cache-e2e-library.outputs['cache-hit'] != 'true' - working-directory: test/e2e + - name: Install JS Dependencies run: yarn install - name: Run tests on Android @@ -440,7 +405,7 @@ jobs: -camera-back none -camera-front none -timezone US/Pacific - script: ./scripts/e2e.mjs ${{ matrix.platform }} --test + script: ./dev-packages/e2e-tests/cli.mjs ${{ matrix.platform }} --test - uses: actions/cache@v4 if: ${{ matrix.platform == 'ios' }} @@ -450,7 +415,7 @@ jobs: - name: Run tests on iOS if: ${{ matrix.platform == 'ios' }} - run: ./scripts/e2e.mjs ${{ matrix.platform }} --test + run: ./dev-packages/e2e-tests/cli.mjs ${{ matrix.platform }} --test - name: Upload logs if: ${{ always() }} diff --git a/.github/workflows/native-tests.yml b/.github/workflows/native-tests.yml index b8f4f6b10d..d8583a6e08 100644 --- a/.github/workflows/native-tests.yml +++ b/.github/workflows/native-tests.yml @@ -27,23 +27,22 @@ jobs: steps: - uses: actions/checkout@v4 - - name: NPM cache - uses: actions/cache@v4 - id: deps-cache + - run: corepack enable + - uses: actions/setup-node@v4 with: - path: node_modules - key: ${{ github.workflow }}-${{ github.job }}-npm-${{ hashFiles('yarn.lock') }} + node-version: 18 + cache: 'yarn' + cache-dependency-path: yarn.lock - name: Install SDK JS Dependencies - if: steps.deps-cache.outputs['cache-hit'] != 'true' run: yarn install - name: Install App Pods - working-directory: RNSentryCocoaTester + working-directory: packages/core/RNSentryCocoaTester run: pod install - name: Run iOS Tests - working-directory: RNSentryCocoaTester + working-directory: packages/core/RNSentryCocoaTester env: SCHEME: RNSentryCocoaTester CONFIGURATION: Release @@ -74,7 +73,7 @@ jobs: uses: gradle/gradle-build-action@v3 - name: Run unit tests - working-directory: RNSentryAndroidTester + working-directory: packages/core/RNSentryAndroidTester run: ./gradlew testDebugUnitTest - name: Setup KVM @@ -91,7 +90,7 @@ jobs: - name: Run connected tests uses: reactivecircus/android-emulator-runner@f0d1ed2dcad93c7479e8b2f2226c83af54494915 #pin@v2.32.0 with: - working-directory: RNSentryAndroidTester + working-directory: packages/core/RNSentryAndroidTester api-level: 30 force-avd-creation: false disable-animations: true diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index bf89dec2c8..ee35eb2d86 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -22,8 +22,12 @@ jobs: with: token: ${{ secrets.GH_RELEASE_PAT }} fetch-depth: 0 - - name: Install Dependencies - run: yarn install + - run: corepack enable + - uses: actions/setup-node@v4 + with: + node-version: 18 + cache: 'yarn' + cache-dependency-path: yarn.lock - name: Prepare release uses: getsentry/action-prepare-release@v1 env: diff --git a/.github/workflows/sample-application.yml b/.github/workflows/sample-application.yml index 015e0a1d2b..af4cb7477d 100644 --- a/.github/workflows/sample-application.yml +++ b/.github/workflows/sample-application.yml @@ -63,13 +63,12 @@ jobs: steps: - uses: actions/checkout@v4 + - run: corepack enable - uses: actions/setup-node@v4 with: node-version: 18 cache: 'yarn' - cache-dependency-path: | - yarn.lock - samples/react-native/yarn.lock + cache-dependency-path: yarn.lock - uses: ruby/setup-ruby@v1 if: ${{ matrix.platform == 'ios' || matrix.platform == 'macos' }} @@ -92,15 +91,11 @@ jobs: run: which xcbeautify || brew install xcbeautify - name: Install SDK Dependencies - run: yarn install --frozen-lockfile + run: yarn install - name: Build SDK run: yarn build - - name: Install Sample Dependencies - working-directory: samples/react-native - run: yarn install --frozen-lockfile - - name: Install App Pods if: ${{ matrix.platform == 'ios' || matrix.platform == 'macos' }} working-directory: samples/react-native diff --git a/.gitignore b/.gitignore index 0fd72ba7be..541bd5cf8e 100644 --- a/.gitignore +++ b/.gitignore @@ -11,7 +11,6 @@ node_modules build/ DerivedData dist -ts3.8 coverage ## Various settings @@ -73,8 +72,14 @@ wheelhouse yalc.lock # E2E tests -test/react-native/versions +dev-packages/e2e-tests/react-native-versions node_modules.bak # Created by Sentry Metro Plugin .sentry/ + +# Yarn +.yarn/* +!.yarn/releases +!.yarn/plugins +.pnp.* diff --git a/.yarn/releases/yarn-1.22.22.cjs b/.yarn/releases/yarn-1.22.22.cjs deleted file mode 100755 index 3ff8687a11..0000000000 --- a/.yarn/releases/yarn-1.22.22.cjs +++ /dev/null @@ -1,148049 +0,0 @@ -#!/usr/bin/env node -module.exports = -/******/ (function(modules) { // webpackBootstrap -/******/ // The module cache -/******/ var installedModules = {}; -/******/ -/******/ // The require function -/******/ function __webpack_require__(moduleId) { -/******/ -/******/ // Check if module is in cache -/******/ if(installedModules[moduleId]) { -/******/ return installedModules[moduleId].exports; -/******/ } -/******/ // Create a new module (and put it into the cache) -/******/ var module = installedModules[moduleId] = { -/******/ i: moduleId, -/******/ l: false, -/******/ exports: {} -/******/ }; -/******/ -/******/ // Execute the module function -/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); -/******/ -/******/ // Flag the module as loaded -/******/ module.l = true; -/******/ -/******/ // Return the exports of the module -/******/ return module.exports; -/******/ } -/******/ -/******/ -/******/ // expose the modules object (__webpack_modules__) -/******/ __webpack_require__.m = modules; -/******/ -/******/ // expose the module cache -/******/ __webpack_require__.c = installedModules; -/******/ -/******/ // identity function for calling harmony imports with the correct context -/******/ __webpack_require__.i = function(value) { return value; }; -/******/ -/******/ // define getter function for harmony exports -/******/ __webpack_require__.d = function(exports, name, getter) { -/******/ if(!__webpack_require__.o(exports, name)) { -/******/ Object.defineProperty(exports, name, { -/******/ configurable: false, -/******/ enumerable: true, -/******/ get: getter -/******/ }); -/******/ } -/******/ }; -/******/ -/******/ // getDefaultExport function for compatibility with non-harmony modules -/******/ __webpack_require__.n = function(module) { -/******/ var getter = module && module.__esModule ? -/******/ function getDefault() { return module['default']; } : -/******/ function getModuleExports() { return module; }; -/******/ __webpack_require__.d(getter, 'a', getter); -/******/ return getter; -/******/ }; -/******/ -/******/ // Object.prototype.hasOwnProperty.call -/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); }; -/******/ -/******/ // __webpack_public_path__ -/******/ __webpack_require__.p = ""; -/******/ -/******/ // Load entry module and return exports -/******/ return __webpack_require__(__webpack_require__.s = 517); -/******/ }) -/************************************************************************/ -/******/ ([ -/* 0 */ -/***/ (function(module, exports) { - -module.exports = require("path"); - -/***/ }), -/* 1 */ -/***/ (function(module, __webpack_exports__, __webpack_require__) { - -"use strict"; -/* harmony export (immutable) */ __webpack_exports__["a"] = __extends; -/* unused harmony export __assign */ -/* unused harmony export __rest */ -/* unused harmony export __decorate */ -/* unused harmony export __param */ -/* unused harmony export __metadata */ -/* unused harmony export __awaiter */ -/* unused harmony export __generator */ -/* unused harmony export __exportStar */ -/* unused harmony export __values */ -/* unused harmony export __read */ -/* unused harmony export __spread */ -/* unused harmony export __await */ -/* unused harmony export __asyncGenerator */ -/* unused harmony export __asyncDelegator */ -/* unused harmony export __asyncValues */ -/* unused harmony export __makeTemplateObject */ -/* unused harmony export __importStar */ -/* unused harmony export __importDefault */ -/*! ***************************************************************************** -Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the Apache License, Version 2.0 (the "License"); you may not use -this file except in compliance with the License. You may obtain a copy of the -License at http://www.apache.org/licenses/LICENSE-2.0 - -THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED -WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, -MERCHANTABLITY OR NON-INFRINGEMENT. - -See the Apache Version 2.0 License for specific language governing permissions -and limitations under the License. -***************************************************************************** */ -/* global Reflect, Promise */ - -var extendStatics = function(d, b) { - extendStatics = Object.setPrototypeOf || - ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) || - function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; }; - return extendStatics(d, b); -}; - -function __extends(d, b) { - extendStatics(d, b); - function __() { this.constructor = d; } - d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); -} - -var __assign = function() { - __assign = Object.assign || function __assign(t) { - for (var s, i = 1, n = arguments.length; i < n; i++) { - s = arguments[i]; - for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p]; - } - return t; - } - return __assign.apply(this, arguments); -} - -function __rest(s, e) { - var t = {}; - for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) - t[p] = s[p]; - if (s != null && typeof Object.getOwnPropertySymbols === "function") - for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) if (e.indexOf(p[i]) < 0) - t[p[i]] = s[p[i]]; - return t; -} - -function __decorate(decorators, target, key, desc) { - var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d; - if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc); - else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r; - return c > 3 && r && Object.defineProperty(target, key, r), r; -} - -function __param(paramIndex, decorator) { - return function (target, key) { decorator(target, key, paramIndex); } -} - -function __metadata(metadataKey, metadataValue) { - if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(metadataKey, metadataValue); -} - -function __awaiter(thisArg, _arguments, P, generator) { - return new (P || (P = Promise))(function (resolve, reject) { - function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } - function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } - function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); } - step((generator = generator.apply(thisArg, _arguments || [])).next()); - }); -} - -function __generator(thisArg, body) { - var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g; - return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g; - function verb(n) { return function (v) { return step([n, v]); }; } - function step(op) { - if (f) throw new TypeError("Generator is already executing."); - while (_) try { - if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t; - if (y = 0, t) op = [op[0] & 2, t.value]; - switch (op[0]) { - case 0: case 1: t = op; break; - case 4: _.label++; return { value: op[1], done: false }; - case 5: _.label++; y = op[1]; op = [0]; continue; - case 7: op = _.ops.pop(); _.trys.pop(); continue; - default: - if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; } - if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; } - if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; } - if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; } - if (t[2]) _.ops.pop(); - _.trys.pop(); continue; - } - op = body.call(thisArg, _); - } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; } - if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true }; - } -} - -function __exportStar(m, exports) { - for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p]; -} - -function __values(o) { - var m = typeof Symbol === "function" && o[Symbol.iterator], i = 0; - if (m) return m.call(o); - return { - next: function () { - if (o && i >= o.length) o = void 0; - return { value: o && o[i++], done: !o }; - } - }; -} - -function __read(o, n) { - var m = typeof Symbol === "function" && o[Symbol.iterator]; - if (!m) return o; - var i = m.call(o), r, ar = [], e; - try { - while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value); - } - catch (error) { e = { error: error }; } - finally { - try { - if (r && !r.done && (m = i["return"])) m.call(i); - } - finally { if (e) throw e.error; } - } - return ar; -} - -function __spread() { - for (var ar = [], i = 0; i < arguments.length; i++) - ar = ar.concat(__read(arguments[i])); - return ar; -} - -function __await(v) { - return this instanceof __await ? (this.v = v, this) : new __await(v); -} - -function __asyncGenerator(thisArg, _arguments, generator) { - if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined."); - var g = generator.apply(thisArg, _arguments || []), i, q = []; - return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i; - function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; } - function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } } - function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); } - function fulfill(value) { resume("next", value); } - function reject(value) { resume("throw", value); } - function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); } -} - -function __asyncDelegator(o) { - var i, p; - return i = {}, verb("next"), verb("throw", function (e) { throw e; }), verb("return"), i[Symbol.iterator] = function () { return this; }, i; - function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === "return" } : f ? f(v) : v; } : f; } -} - -function __asyncValues(o) { - if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined."); - var m = o[Symbol.asyncIterator], i; - return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i); - function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; } - function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); } -} - -function __makeTemplateObject(cooked, raw) { - if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; } - return cooked; -}; - -function __importStar(mod) { - if (mod && mod.__esModule) return mod; - var result = {}; - if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; - result.default = mod; - return result; -} - -function __importDefault(mod) { - return (mod && mod.__esModule) ? mod : { default: mod }; -} - - -/***/ }), -/* 2 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -exports.__esModule = true; - -var _promise = __webpack_require__(224); - -var _promise2 = _interopRequireDefault(_promise); - -function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } - -exports.default = function (fn) { - return function () { - var gen = fn.apply(this, arguments); - return new _promise2.default(function (resolve, reject) { - function step(key, arg) { - try { - var info = gen[key](arg); - var value = info.value; - } catch (error) { - reject(error); - return; - } - - if (info.done) { - resolve(value); - } else { - return _promise2.default.resolve(value).then(function (value) { - step("next", value); - }, function (err) { - step("throw", err); - }); - } - } - - return step("next"); - }); - }; -}; - -/***/ }), -/* 3 */ -/***/ (function(module, exports) { - -module.exports = require("util"); - -/***/ }), -/* 4 */ -/***/ (function(module, exports) { - -module.exports = require("fs"); - -/***/ }), -/* 5 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); -exports.getFirstSuitableFolder = exports.readFirstAvailableStream = exports.makeTempDir = exports.hardlinksWork = exports.writeFilePreservingEol = exports.getFileSizeOnDisk = exports.walk = exports.symlink = exports.find = exports.readJsonAndFile = exports.readJson = exports.readFileAny = exports.hardlinkBulk = exports.copyBulk = exports.unlink = exports.glob = exports.link = exports.chmod = exports.lstat = exports.exists = exports.mkdirp = exports.stat = exports.access = exports.rename = exports.readdir = exports.realpath = exports.readlink = exports.writeFile = exports.open = exports.readFileBuffer = exports.lockQueue = exports.constants = undefined; - -var _asyncToGenerator2; - -function _load_asyncToGenerator() { - return _asyncToGenerator2 = _interopRequireDefault(__webpack_require__(2)); -} - -let buildActionsForCopy = (() => { - var _ref = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (queue, events, possibleExtraneous, reporter) { - - // - let build = (() => { - var _ref5 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (data) { - const src = data.src, - dest = data.dest, - type = data.type; - - const onFresh = data.onFresh || noop; - const onDone = data.onDone || noop; - - // TODO https://github.com/yarnpkg/yarn/issues/3751 - // related to bundled dependencies handling - if (files.has(dest.toLowerCase())) { - reporter.verbose(`The case-insensitive file ${dest} shouldn't be copied twice in one bulk copy`); - } else { - files.add(dest.toLowerCase()); - } - - if (type === 'symlink') { - yield mkdirp((_path || _load_path()).default.dirname(dest)); - onFresh(); - actions.symlink.push({ - dest, - linkname: src - }); - onDone(); - return; - } - - if (events.ignoreBasenames.indexOf((_path || _load_path()).default.basename(src)) >= 0) { - // ignored file - return; - } - - const srcStat = yield lstat(src); - let srcFiles; - - if (srcStat.isDirectory()) { - srcFiles = yield readdir(src); - } - - let destStat; - try { - // try accessing the destination - destStat = yield lstat(dest); - } catch (e) { - // proceed if destination doesn't exist, otherwise error - if (e.code !== 'ENOENT') { - throw e; - } - } - - // if destination exists - if (destStat) { - const bothSymlinks = srcStat.isSymbolicLink() && destStat.isSymbolicLink(); - const bothFolders = srcStat.isDirectory() && destStat.isDirectory(); - const bothFiles = srcStat.isFile() && destStat.isFile(); - - // EINVAL access errors sometimes happen which shouldn't because node shouldn't be giving - // us modes that aren't valid. investigate this, it's generally safe to proceed. - - /* if (srcStat.mode !== destStat.mode) { - try { - await access(dest, srcStat.mode); - } catch (err) {} - } */ - - if (bothFiles && artifactFiles.has(dest)) { - // this file gets changed during build, likely by a custom install script. Don't bother checking it. - onDone(); - reporter.verbose(reporter.lang('verboseFileSkipArtifact', src)); - return; - } - - if (bothFiles && srcStat.size === destStat.size && (0, (_fsNormalized || _load_fsNormalized()).fileDatesEqual)(srcStat.mtime, destStat.mtime)) { - // we can safely assume this is the same file - onDone(); - reporter.verbose(reporter.lang('verboseFileSkip', src, dest, srcStat.size, +srcStat.mtime)); - return; - } - - if (bothSymlinks) { - const srcReallink = yield readlink(src); - if (srcReallink === (yield readlink(dest))) { - // if both symlinks are the same then we can continue on - onDone(); - reporter.verbose(reporter.lang('verboseFileSkipSymlink', src, dest, srcReallink)); - return; - } - } - - if (bothFolders) { - // mark files that aren't in this folder as possibly extraneous - const destFiles = yield readdir(dest); - invariant(srcFiles, 'src files not initialised'); - - for (var _iterator4 = destFiles, _isArray4 = Array.isArray(_iterator4), _i4 = 0, _iterator4 = _isArray4 ? _iterator4 : _iterator4[Symbol.iterator]();;) { - var _ref6; - - if (_isArray4) { - if (_i4 >= _iterator4.length) break; - _ref6 = _iterator4[_i4++]; - } else { - _i4 = _iterator4.next(); - if (_i4.done) break; - _ref6 = _i4.value; - } - - const file = _ref6; - - if (srcFiles.indexOf(file) < 0) { - const loc = (_path || _load_path()).default.join(dest, file); - possibleExtraneous.add(loc); - - if ((yield lstat(loc)).isDirectory()) { - for (var _iterator5 = yield readdir(loc), _isArray5 = Array.isArray(_iterator5), _i5 = 0, _iterator5 = _isArray5 ? _iterator5 : _iterator5[Symbol.iterator]();;) { - var _ref7; - - if (_isArray5) { - if (_i5 >= _iterator5.length) break; - _ref7 = _iterator5[_i5++]; - } else { - _i5 = _iterator5.next(); - if (_i5.done) break; - _ref7 = _i5.value; - } - - const file = _ref7; - - possibleExtraneous.add((_path || _load_path()).default.join(loc, file)); - } - } - } - } - } - } - - if (destStat && destStat.isSymbolicLink()) { - yield (0, (_fsNormalized || _load_fsNormalized()).unlink)(dest); - destStat = null; - } - - if (srcStat.isSymbolicLink()) { - onFresh(); - const linkname = yield readlink(src); - actions.symlink.push({ - dest, - linkname - }); - onDone(); - } else if (srcStat.isDirectory()) { - if (!destStat) { - reporter.verbose(reporter.lang('verboseFileFolder', dest)); - yield mkdirp(dest); - } - - const destParts = dest.split((_path || _load_path()).default.sep); - while (destParts.length) { - files.add(destParts.join((_path || _load_path()).default.sep).toLowerCase()); - destParts.pop(); - } - - // push all files to queue - invariant(srcFiles, 'src files not initialised'); - let remaining = srcFiles.length; - if (!remaining) { - onDone(); - } - for (var _iterator6 = srcFiles, _isArray6 = Array.isArray(_iterator6), _i6 = 0, _iterator6 = _isArray6 ? _iterator6 : _iterator6[Symbol.iterator]();;) { - var _ref8; - - if (_isArray6) { - if (_i6 >= _iterator6.length) break; - _ref8 = _iterator6[_i6++]; - } else { - _i6 = _iterator6.next(); - if (_i6.done) break; - _ref8 = _i6.value; - } - - const file = _ref8; - - queue.push({ - dest: (_path || _load_path()).default.join(dest, file), - onFresh, - onDone: function (_onDone) { - function onDone() { - return _onDone.apply(this, arguments); - } - - onDone.toString = function () { - return _onDone.toString(); - }; - - return onDone; - }(function () { - if (--remaining === 0) { - onDone(); - } - }), - src: (_path || _load_path()).default.join(src, file) - }); - } - } else if (srcStat.isFile()) { - onFresh(); - actions.file.push({ - src, - dest, - atime: srcStat.atime, - mtime: srcStat.mtime, - mode: srcStat.mode - }); - onDone(); - } else { - throw new Error(`unsure how to copy this: ${src}`); - } - }); - - return function build(_x5) { - return _ref5.apply(this, arguments); - }; - })(); - - const artifactFiles = new Set(events.artifactFiles || []); - const files = new Set(); - - // initialise events - for (var _iterator = queue, _isArray = Array.isArray(_iterator), _i = 0, _iterator = _isArray ? _iterator : _iterator[Symbol.iterator]();;) { - var _ref2; - - if (_isArray) { - if (_i >= _iterator.length) break; - _ref2 = _iterator[_i++]; - } else { - _i = _iterator.next(); - if (_i.done) break; - _ref2 = _i.value; - } - - const item = _ref2; - - const onDone = item.onDone; - item.onDone = function () { - events.onProgress(item.dest); - if (onDone) { - onDone(); - } - }; - } - events.onStart(queue.length); - - // start building actions - const actions = { - file: [], - symlink: [], - link: [] - }; - - // custom concurrency logic as we're always executing stacks of CONCURRENT_QUEUE_ITEMS queue items - // at a time due to the requirement to push items onto the queue - while (queue.length) { - const items = queue.splice(0, CONCURRENT_QUEUE_ITEMS); - yield Promise.all(items.map(build)); - } - - // simulate the existence of some files to prevent considering them extraneous - for (var _iterator2 = artifactFiles, _isArray2 = Array.isArray(_iterator2), _i2 = 0, _iterator2 = _isArray2 ? _iterator2 : _iterator2[Symbol.iterator]();;) { - var _ref3; - - if (_isArray2) { - if (_i2 >= _iterator2.length) break; - _ref3 = _iterator2[_i2++]; - } else { - _i2 = _iterator2.next(); - if (_i2.done) break; - _ref3 = _i2.value; - } - - const file = _ref3; - - if (possibleExtraneous.has(file)) { - reporter.verbose(reporter.lang('verboseFilePhantomExtraneous', file)); - possibleExtraneous.delete(file); - } - } - - for (var _iterator3 = possibleExtraneous, _isArray3 = Array.isArray(_iterator3), _i3 = 0, _iterator3 = _isArray3 ? _iterator3 : _iterator3[Symbol.iterator]();;) { - var _ref4; - - if (_isArray3) { - if (_i3 >= _iterator3.length) break; - _ref4 = _iterator3[_i3++]; - } else { - _i3 = _iterator3.next(); - if (_i3.done) break; - _ref4 = _i3.value; - } - - const loc = _ref4; - - if (files.has(loc.toLowerCase())) { - possibleExtraneous.delete(loc); - } - } - - return actions; - }); - - return function buildActionsForCopy(_x, _x2, _x3, _x4) { - return _ref.apply(this, arguments); - }; -})(); - -let buildActionsForHardlink = (() => { - var _ref9 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (queue, events, possibleExtraneous, reporter) { - - // - let build = (() => { - var _ref13 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (data) { - const src = data.src, - dest = data.dest; - - const onFresh = data.onFresh || noop; - const onDone = data.onDone || noop; - if (files.has(dest.toLowerCase())) { - // Fixes issue https://github.com/yarnpkg/yarn/issues/2734 - // When bulk hardlinking we have A -> B structure that we want to hardlink to A1 -> B1, - // package-linker passes that modules A1 and B1 need to be hardlinked, - // the recursive linking algorithm of A1 ends up scheduling files in B1 to be linked twice which will case - // an exception. - onDone(); - return; - } - files.add(dest.toLowerCase()); - - if (events.ignoreBasenames.indexOf((_path || _load_path()).default.basename(src)) >= 0) { - // ignored file - return; - } - - const srcStat = yield lstat(src); - let srcFiles; - - if (srcStat.isDirectory()) { - srcFiles = yield readdir(src); - } - - const destExists = yield exists(dest); - if (destExists) { - const destStat = yield lstat(dest); - - const bothSymlinks = srcStat.isSymbolicLink() && destStat.isSymbolicLink(); - const bothFolders = srcStat.isDirectory() && destStat.isDirectory(); - const bothFiles = srcStat.isFile() && destStat.isFile(); - - if (srcStat.mode !== destStat.mode) { - try { - yield access(dest, srcStat.mode); - } catch (err) { - // EINVAL access errors sometimes happen which shouldn't because node shouldn't be giving - // us modes that aren't valid. investigate this, it's generally safe to proceed. - reporter.verbose(err); - } - } - - if (bothFiles && artifactFiles.has(dest)) { - // this file gets changed during build, likely by a custom install script. Don't bother checking it. - onDone(); - reporter.verbose(reporter.lang('verboseFileSkipArtifact', src)); - return; - } - - // correct hardlink - if (bothFiles && srcStat.ino !== null && srcStat.ino === destStat.ino) { - onDone(); - reporter.verbose(reporter.lang('verboseFileSkip', src, dest, srcStat.ino)); - return; - } - - if (bothSymlinks) { - const srcReallink = yield readlink(src); - if (srcReallink === (yield readlink(dest))) { - // if both symlinks are the same then we can continue on - onDone(); - reporter.verbose(reporter.lang('verboseFileSkipSymlink', src, dest, srcReallink)); - return; - } - } - - if (bothFolders) { - // mark files that aren't in this folder as possibly extraneous - const destFiles = yield readdir(dest); - invariant(srcFiles, 'src files not initialised'); - - for (var _iterator10 = destFiles, _isArray10 = Array.isArray(_iterator10), _i10 = 0, _iterator10 = _isArray10 ? _iterator10 : _iterator10[Symbol.iterator]();;) { - var _ref14; - - if (_isArray10) { - if (_i10 >= _iterator10.length) break; - _ref14 = _iterator10[_i10++]; - } else { - _i10 = _iterator10.next(); - if (_i10.done) break; - _ref14 = _i10.value; - } - - const file = _ref14; - - if (srcFiles.indexOf(file) < 0) { - const loc = (_path || _load_path()).default.join(dest, file); - possibleExtraneous.add(loc); - - if ((yield lstat(loc)).isDirectory()) { - for (var _iterator11 = yield readdir(loc), _isArray11 = Array.isArray(_iterator11), _i11 = 0, _iterator11 = _isArray11 ? _iterator11 : _iterator11[Symbol.iterator]();;) { - var _ref15; - - if (_isArray11) { - if (_i11 >= _iterator11.length) break; - _ref15 = _iterator11[_i11++]; - } else { - _i11 = _iterator11.next(); - if (_i11.done) break; - _ref15 = _i11.value; - } - - const file = _ref15; - - possibleExtraneous.add((_path || _load_path()).default.join(loc, file)); - } - } - } - } - } - } - - if (srcStat.isSymbolicLink()) { - onFresh(); - const linkname = yield readlink(src); - actions.symlink.push({ - dest, - linkname - }); - onDone(); - } else if (srcStat.isDirectory()) { - reporter.verbose(reporter.lang('verboseFileFolder', dest)); - yield mkdirp(dest); - - const destParts = dest.split((_path || _load_path()).default.sep); - while (destParts.length) { - files.add(destParts.join((_path || _load_path()).default.sep).toLowerCase()); - destParts.pop(); - } - - // push all files to queue - invariant(srcFiles, 'src files not initialised'); - let remaining = srcFiles.length; - if (!remaining) { - onDone(); - } - for (var _iterator12 = srcFiles, _isArray12 = Array.isArray(_iterator12), _i12 = 0, _iterator12 = _isArray12 ? _iterator12 : _iterator12[Symbol.iterator]();;) { - var _ref16; - - if (_isArray12) { - if (_i12 >= _iterator12.length) break; - _ref16 = _iterator12[_i12++]; - } else { - _i12 = _iterator12.next(); - if (_i12.done) break; - _ref16 = _i12.value; - } - - const file = _ref16; - - queue.push({ - onFresh, - src: (_path || _load_path()).default.join(src, file), - dest: (_path || _load_path()).default.join(dest, file), - onDone: function (_onDone2) { - function onDone() { - return _onDone2.apply(this, arguments); - } - - onDone.toString = function () { - return _onDone2.toString(); - }; - - return onDone; - }(function () { - if (--remaining === 0) { - onDone(); - } - }) - }); - } - } else if (srcStat.isFile()) { - onFresh(); - actions.link.push({ - src, - dest, - removeDest: destExists - }); - onDone(); - } else { - throw new Error(`unsure how to copy this: ${src}`); - } - }); - - return function build(_x10) { - return _ref13.apply(this, arguments); - }; - })(); - - const artifactFiles = new Set(events.artifactFiles || []); - const files = new Set(); - - // initialise events - for (var _iterator7 = queue, _isArray7 = Array.isArray(_iterator7), _i7 = 0, _iterator7 = _isArray7 ? _iterator7 : _iterator7[Symbol.iterator]();;) { - var _ref10; - - if (_isArray7) { - if (_i7 >= _iterator7.length) break; - _ref10 = _iterator7[_i7++]; - } else { - _i7 = _iterator7.next(); - if (_i7.done) break; - _ref10 = _i7.value; - } - - const item = _ref10; - - const onDone = item.onDone || noop; - item.onDone = function () { - events.onProgress(item.dest); - onDone(); - }; - } - events.onStart(queue.length); - - // start building actions - const actions = { - file: [], - symlink: [], - link: [] - }; - - // custom concurrency logic as we're always executing stacks of CONCURRENT_QUEUE_ITEMS queue items - // at a time due to the requirement to push items onto the queue - while (queue.length) { - const items = queue.splice(0, CONCURRENT_QUEUE_ITEMS); - yield Promise.all(items.map(build)); - } - - // simulate the existence of some files to prevent considering them extraneous - for (var _iterator8 = artifactFiles, _isArray8 = Array.isArray(_iterator8), _i8 = 0, _iterator8 = _isArray8 ? _iterator8 : _iterator8[Symbol.iterator]();;) { - var _ref11; - - if (_isArray8) { - if (_i8 >= _iterator8.length) break; - _ref11 = _iterator8[_i8++]; - } else { - _i8 = _iterator8.next(); - if (_i8.done) break; - _ref11 = _i8.value; - } - - const file = _ref11; - - if (possibleExtraneous.has(file)) { - reporter.verbose(reporter.lang('verboseFilePhantomExtraneous', file)); - possibleExtraneous.delete(file); - } - } - - for (var _iterator9 = possibleExtraneous, _isArray9 = Array.isArray(_iterator9), _i9 = 0, _iterator9 = _isArray9 ? _iterator9 : _iterator9[Symbol.iterator]();;) { - var _ref12; - - if (_isArray9) { - if (_i9 >= _iterator9.length) break; - _ref12 = _iterator9[_i9++]; - } else { - _i9 = _iterator9.next(); - if (_i9.done) break; - _ref12 = _i9.value; - } - - const loc = _ref12; - - if (files.has(loc.toLowerCase())) { - possibleExtraneous.delete(loc); - } - } - - return actions; - }); - - return function buildActionsForHardlink(_x6, _x7, _x8, _x9) { - return _ref9.apply(this, arguments); - }; -})(); - -let copyBulk = exports.copyBulk = (() => { - var _ref17 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (queue, reporter, _events) { - const events = { - onStart: _events && _events.onStart || noop, - onProgress: _events && _events.onProgress || noop, - possibleExtraneous: _events ? _events.possibleExtraneous : new Set(), - ignoreBasenames: _events && _events.ignoreBasenames || [], - artifactFiles: _events && _events.artifactFiles || [] - }; - - const actions = yield buildActionsForCopy(queue, events, events.possibleExtraneous, reporter); - events.onStart(actions.file.length + actions.symlink.length + actions.link.length); - - const fileActions = actions.file; - - const currentlyWriting = new Map(); - - yield (_promise || _load_promise()).queue(fileActions, (() => { - var _ref18 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (data) { - let writePromise; - while (writePromise = currentlyWriting.get(data.dest)) { - yield writePromise; - } - - reporter.verbose(reporter.lang('verboseFileCopy', data.src, data.dest)); - const copier = (0, (_fsNormalized || _load_fsNormalized()).copyFile)(data, function () { - return currentlyWriting.delete(data.dest); - }); - currentlyWriting.set(data.dest, copier); - events.onProgress(data.dest); - return copier; - }); - - return function (_x14) { - return _ref18.apply(this, arguments); - }; - })(), CONCURRENT_QUEUE_ITEMS); - - // we need to copy symlinks last as they could reference files we were copying - const symlinkActions = actions.symlink; - yield (_promise || _load_promise()).queue(symlinkActions, function (data) { - const linkname = (_path || _load_path()).default.resolve((_path || _load_path()).default.dirname(data.dest), data.linkname); - reporter.verbose(reporter.lang('verboseFileSymlink', data.dest, linkname)); - return symlink(linkname, data.dest); - }); - }); - - return function copyBulk(_x11, _x12, _x13) { - return _ref17.apply(this, arguments); - }; -})(); - -let hardlinkBulk = exports.hardlinkBulk = (() => { - var _ref19 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (queue, reporter, _events) { - const events = { - onStart: _events && _events.onStart || noop, - onProgress: _events && _events.onProgress || noop, - possibleExtraneous: _events ? _events.possibleExtraneous : new Set(), - artifactFiles: _events && _events.artifactFiles || [], - ignoreBasenames: [] - }; - - const actions = yield buildActionsForHardlink(queue, events, events.possibleExtraneous, reporter); - events.onStart(actions.file.length + actions.symlink.length + actions.link.length); - - const fileActions = actions.link; - - yield (_promise || _load_promise()).queue(fileActions, (() => { - var _ref20 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (data) { - reporter.verbose(reporter.lang('verboseFileLink', data.src, data.dest)); - if (data.removeDest) { - yield (0, (_fsNormalized || _load_fsNormalized()).unlink)(data.dest); - } - yield link(data.src, data.dest); - }); - - return function (_x18) { - return _ref20.apply(this, arguments); - }; - })(), CONCURRENT_QUEUE_ITEMS); - - // we need to copy symlinks last as they could reference files we were copying - const symlinkActions = actions.symlink; - yield (_promise || _load_promise()).queue(symlinkActions, function (data) { - const linkname = (_path || _load_path()).default.resolve((_path || _load_path()).default.dirname(data.dest), data.linkname); - reporter.verbose(reporter.lang('verboseFileSymlink', data.dest, linkname)); - return symlink(linkname, data.dest); - }); - }); - - return function hardlinkBulk(_x15, _x16, _x17) { - return _ref19.apply(this, arguments); - }; -})(); - -let readFileAny = exports.readFileAny = (() => { - var _ref21 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (files) { - for (var _iterator13 = files, _isArray13 = Array.isArray(_iterator13), _i13 = 0, _iterator13 = _isArray13 ? _iterator13 : _iterator13[Symbol.iterator]();;) { - var _ref22; - - if (_isArray13) { - if (_i13 >= _iterator13.length) break; - _ref22 = _iterator13[_i13++]; - } else { - _i13 = _iterator13.next(); - if (_i13.done) break; - _ref22 = _i13.value; - } - - const file = _ref22; - - if (yield exists(file)) { - return readFile(file); - } - } - return null; - }); - - return function readFileAny(_x19) { - return _ref21.apply(this, arguments); - }; -})(); - -let readJson = exports.readJson = (() => { - var _ref23 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (loc) { - return (yield readJsonAndFile(loc)).object; - }); - - return function readJson(_x20) { - return _ref23.apply(this, arguments); - }; -})(); - -let readJsonAndFile = exports.readJsonAndFile = (() => { - var _ref24 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (loc) { - const file = yield readFile(loc); - try { - return { - object: (0, (_map || _load_map()).default)(JSON.parse(stripBOM(file))), - content: file - }; - } catch (err) { - err.message = `${loc}: ${err.message}`; - throw err; - } - }); - - return function readJsonAndFile(_x21) { - return _ref24.apply(this, arguments); - }; -})(); - -let find = exports.find = (() => { - var _ref25 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (filename, dir) { - const parts = dir.split((_path || _load_path()).default.sep); - - while (parts.length) { - const loc = parts.concat(filename).join((_path || _load_path()).default.sep); - - if (yield exists(loc)) { - return loc; - } else { - parts.pop(); - } - } - - return false; - }); - - return function find(_x22, _x23) { - return _ref25.apply(this, arguments); - }; -})(); - -let symlink = exports.symlink = (() => { - var _ref26 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (src, dest) { - if (process.platform !== 'win32') { - // use relative paths otherwise which will be retained if the directory is moved - src = (_path || _load_path()).default.relative((_path || _load_path()).default.dirname(dest), src); - // When path.relative returns an empty string for the current directory, we should instead use - // '.', which is a valid fs.symlink target. - src = src || '.'; - } - - try { - const stats = yield lstat(dest); - if (stats.isSymbolicLink()) { - const resolved = dest; - if (resolved === src) { - return; - } - } - } catch (err) { - if (err.code !== 'ENOENT') { - throw err; - } - } - - // We use rimraf for unlink which never throws an ENOENT on missing target - yield (0, (_fsNormalized || _load_fsNormalized()).unlink)(dest); - - if (process.platform === 'win32') { - // use directory junctions if possible on win32, this requires absolute paths - yield fsSymlink(src, dest, 'junction'); - } else { - yield fsSymlink(src, dest); - } - }); - - return function symlink(_x24, _x25) { - return _ref26.apply(this, arguments); - }; -})(); - -let walk = exports.walk = (() => { - var _ref27 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (dir, relativeDir, ignoreBasenames = new Set()) { - let files = []; - - let filenames = yield readdir(dir); - if (ignoreBasenames.size) { - filenames = filenames.filter(function (name) { - return !ignoreBasenames.has(name); - }); - } - - for (var _iterator14 = filenames, _isArray14 = Array.isArray(_iterator14), _i14 = 0, _iterator14 = _isArray14 ? _iterator14 : _iterator14[Symbol.iterator]();;) { - var _ref28; - - if (_isArray14) { - if (_i14 >= _iterator14.length) break; - _ref28 = _iterator14[_i14++]; - } else { - _i14 = _iterator14.next(); - if (_i14.done) break; - _ref28 = _i14.value; - } - - const name = _ref28; - - const relative = relativeDir ? (_path || _load_path()).default.join(relativeDir, name) : name; - const loc = (_path || _load_path()).default.join(dir, name); - const stat = yield lstat(loc); - - files.push({ - relative, - basename: name, - absolute: loc, - mtime: +stat.mtime - }); - - if (stat.isDirectory()) { - files = files.concat((yield walk(loc, relative, ignoreBasenames))); - } - } - - return files; - }); - - return function walk(_x26, _x27) { - return _ref27.apply(this, arguments); - }; -})(); - -let getFileSizeOnDisk = exports.getFileSizeOnDisk = (() => { - var _ref29 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (loc) { - const stat = yield lstat(loc); - const size = stat.size, - blockSize = stat.blksize; - - - return Math.ceil(size / blockSize) * blockSize; - }); - - return function getFileSizeOnDisk(_x28) { - return _ref29.apply(this, arguments); - }; -})(); - -let getEolFromFile = (() => { - var _ref30 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (path) { - if (!(yield exists(path))) { - return undefined; - } - - const buffer = yield readFileBuffer(path); - - for (let i = 0; i < buffer.length; ++i) { - if (buffer[i] === cr) { - return '\r\n'; - } - if (buffer[i] === lf) { - return '\n'; - } - } - return undefined; - }); - - return function getEolFromFile(_x29) { - return _ref30.apply(this, arguments); - }; -})(); - -let writeFilePreservingEol = exports.writeFilePreservingEol = (() => { - var _ref31 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (path, data) { - const eol = (yield getEolFromFile(path)) || (_os || _load_os()).default.EOL; - if (eol !== '\n') { - data = data.replace(/\n/g, eol); - } - yield writeFile(path, data); - }); - - return function writeFilePreservingEol(_x30, _x31) { - return _ref31.apply(this, arguments); - }; -})(); - -let hardlinksWork = exports.hardlinksWork = (() => { - var _ref32 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (dir) { - const filename = 'test-file' + Math.random(); - const file = (_path || _load_path()).default.join(dir, filename); - const fileLink = (_path || _load_path()).default.join(dir, filename + '-link'); - try { - yield writeFile(file, 'test'); - yield link(file, fileLink); - } catch (err) { - return false; - } finally { - yield (0, (_fsNormalized || _load_fsNormalized()).unlink)(file); - yield (0, (_fsNormalized || _load_fsNormalized()).unlink)(fileLink); - } - return true; - }); - - return function hardlinksWork(_x32) { - return _ref32.apply(this, arguments); - }; -})(); - -// not a strict polyfill for Node's fs.mkdtemp - - -let makeTempDir = exports.makeTempDir = (() => { - var _ref33 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (prefix) { - const dir = (_path || _load_path()).default.join((_os || _load_os()).default.tmpdir(), `yarn-${prefix || ''}-${Date.now()}-${Math.random()}`); - yield (0, (_fsNormalized || _load_fsNormalized()).unlink)(dir); - yield mkdirp(dir); - return dir; - }); - - return function makeTempDir(_x33) { - return _ref33.apply(this, arguments); - }; -})(); - -let readFirstAvailableStream = exports.readFirstAvailableStream = (() => { - var _ref34 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (paths) { - for (var _iterator15 = paths, _isArray15 = Array.isArray(_iterator15), _i15 = 0, _iterator15 = _isArray15 ? _iterator15 : _iterator15[Symbol.iterator]();;) { - var _ref35; - - if (_isArray15) { - if (_i15 >= _iterator15.length) break; - _ref35 = _iterator15[_i15++]; - } else { - _i15 = _iterator15.next(); - if (_i15.done) break; - _ref35 = _i15.value; - } - - const path = _ref35; - - try { - const fd = yield open(path, 'r'); - return (_fs || _load_fs()).default.createReadStream(path, { fd }); - } catch (err) { - // Try the next one - } - } - return null; - }); - - return function readFirstAvailableStream(_x34) { - return _ref34.apply(this, arguments); - }; -})(); - -let getFirstSuitableFolder = exports.getFirstSuitableFolder = (() => { - var _ref36 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (paths, mode = constants.W_OK | constants.X_OK) { - const result = { - skipped: [], - folder: null - }; - - for (var _iterator16 = paths, _isArray16 = Array.isArray(_iterator16), _i16 = 0, _iterator16 = _isArray16 ? _iterator16 : _iterator16[Symbol.iterator]();;) { - var _ref37; - - if (_isArray16) { - if (_i16 >= _iterator16.length) break; - _ref37 = _iterator16[_i16++]; - } else { - _i16 = _iterator16.next(); - if (_i16.done) break; - _ref37 = _i16.value; - } - - const folder = _ref37; - - try { - yield mkdirp(folder); - yield access(folder, mode); - - result.folder = folder; - - return result; - } catch (error) { - result.skipped.push({ - error, - folder - }); - } - } - return result; - }); - - return function getFirstSuitableFolder(_x35) { - return _ref36.apply(this, arguments); - }; -})(); - -exports.copy = copy; -exports.readFile = readFile; -exports.readFileRaw = readFileRaw; -exports.normalizeOS = normalizeOS; - -var _fs; - -function _load_fs() { - return _fs = _interopRequireDefault(__webpack_require__(4)); -} - -var _glob; - -function _load_glob() { - return _glob = _interopRequireDefault(__webpack_require__(99)); -} - -var _os; - -function _load_os() { - return _os = _interopRequireDefault(__webpack_require__(42)); -} - -var _path; - -function _load_path() { - return _path = _interopRequireDefault(__webpack_require__(0)); -} - -var _blockingQueue; - -function _load_blockingQueue() { - return _blockingQueue = _interopRequireDefault(__webpack_require__(110)); -} - -var _promise; - -function _load_promise() { - return _promise = _interopRequireWildcard(__webpack_require__(51)); -} - -var _promise2; - -function _load_promise2() { - return _promise2 = __webpack_require__(51); -} - -var _map; - -function _load_map() { - return _map = _interopRequireDefault(__webpack_require__(30)); -} - -var _fsNormalized; - -function _load_fsNormalized() { - return _fsNormalized = __webpack_require__(216); -} - -function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } } - -function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } - -const constants = exports.constants = typeof (_fs || _load_fs()).default.constants !== 'undefined' ? (_fs || _load_fs()).default.constants : { - R_OK: (_fs || _load_fs()).default.R_OK, - W_OK: (_fs || _load_fs()).default.W_OK, - X_OK: (_fs || _load_fs()).default.X_OK -}; - -const lockQueue = exports.lockQueue = new (_blockingQueue || _load_blockingQueue()).default('fs lock'); - -const readFileBuffer = exports.readFileBuffer = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.readFile); -const open = exports.open = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.open); -const writeFile = exports.writeFile = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.writeFile); -const readlink = exports.readlink = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.readlink); -const realpath = exports.realpath = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.realpath); -const readdir = exports.readdir = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.readdir); -const rename = exports.rename = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.rename); -const access = exports.access = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.access); -const stat = exports.stat = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.stat); -const mkdirp = exports.mkdirp = (0, (_promise2 || _load_promise2()).promisify)(__webpack_require__(146)); -const exists = exports.exists = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.exists, true); -const lstat = exports.lstat = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.lstat); -const chmod = exports.chmod = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.chmod); -const link = exports.link = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.link); -const glob = exports.glob = (0, (_promise2 || _load_promise2()).promisify)((_glob || _load_glob()).default); -exports.unlink = (_fsNormalized || _load_fsNormalized()).unlink; - -// fs.copyFile uses the native file copying instructions on the system, performing much better -// than any JS-based solution and consumes fewer resources. Repeated testing to fine tune the -// concurrency level revealed 128 as the sweet spot on a quad-core, 16 CPU Intel system with SSD. - -const CONCURRENT_QUEUE_ITEMS = (_fs || _load_fs()).default.copyFile ? 128 : 4; - -const fsSymlink = (0, (_promise2 || _load_promise2()).promisify)((_fs || _load_fs()).default.symlink); -const invariant = __webpack_require__(9); -const stripBOM = __webpack_require__(161); - -const noop = () => {}; - -function copy(src, dest, reporter) { - return copyBulk([{ src, dest }], reporter); -} - -function _readFile(loc, encoding) { - return new Promise((resolve, reject) => { - (_fs || _load_fs()).default.readFile(loc, encoding, function (err, content) { - if (err) { - reject(err); - } else { - resolve(content); - } - }); - }); -} - -function readFile(loc) { - return _readFile(loc, 'utf8').then(normalizeOS); -} - -function readFileRaw(loc) { - return _readFile(loc, 'binary'); -} - -function normalizeOS(body) { - return body.replace(/\r\n/g, '\n'); -} - -const cr = '\r'.charCodeAt(0); -const lf = '\n'.charCodeAt(0); - -/***/ }), -/* 6 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); -class MessageError extends Error { - constructor(msg, code) { - super(msg); - this.code = code; - } - -} - -exports.MessageError = MessageError; -class ProcessSpawnError extends MessageError { - constructor(msg, code, process) { - super(msg, code); - this.process = process; - } - -} - -exports.ProcessSpawnError = ProcessSpawnError; -class SecurityError extends MessageError {} - -exports.SecurityError = SecurityError; -class ProcessTermError extends MessageError {} - -exports.ProcessTermError = ProcessTermError; -class ResponseError extends Error { - constructor(msg, responseCode) { - super(msg); - this.responseCode = responseCode; - } - -} - -exports.ResponseError = ResponseError; -class OneTimePasswordError extends Error { - constructor(notice) { - super(); - this.notice = notice; - } - -} -exports.OneTimePasswordError = OneTimePasswordError; - -/***/ }), -/* 7 */ -/***/ (function(module, __webpack_exports__, __webpack_require__) { - -"use strict"; -/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return Subscriber; }); -/* unused harmony export SafeSubscriber */ -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_0_tslib__ = __webpack_require__(1); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_1__util_isFunction__ = __webpack_require__(155); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_2__Observer__ = __webpack_require__(420); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_3__Subscription__ = __webpack_require__(25); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_4__internal_symbol_rxSubscriber__ = __webpack_require__(322); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_5__config__ = __webpack_require__(186); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_6__util_hostReportError__ = __webpack_require__(324); -/** PURE_IMPORTS_START tslib,_util_isFunction,_Observer,_Subscription,_internal_symbol_rxSubscriber,_config,_util_hostReportError PURE_IMPORTS_END */ - - - - - - - -var Subscriber = /*@__PURE__*/ (function (_super) { - __WEBPACK_IMPORTED_MODULE_0_tslib__["a" /* __extends */](Subscriber, _super); - function Subscriber(destinationOrNext, error, complete) { - var _this = _super.call(this) || this; - _this.syncErrorValue = null; - _this.syncErrorThrown = false; - _this.syncErrorThrowable = false; - _this.isStopped = false; - _this._parentSubscription = null; - switch (arguments.length) { - case 0: - _this.destination = __WEBPACK_IMPORTED_MODULE_2__Observer__["a" /* empty */]; - break; - case 1: - if (!destinationOrNext) { - _this.destination = __WEBPACK_IMPORTED_MODULE_2__Observer__["a" /* empty */]; - break; - } - if (typeof destinationOrNext === 'object') { - if (destinationOrNext instanceof Subscriber) { - _this.syncErrorThrowable = destinationOrNext.syncErrorThrowable; - _this.destination = destinationOrNext; - destinationOrNext.add(_this); - } - else { - _this.syncErrorThrowable = true; - _this.destination = new SafeSubscriber(_this, destinationOrNext); - } - break; - } - default: - _this.syncErrorThrowable = true; - _this.destination = new SafeSubscriber(_this, destinationOrNext, error, complete); - break; - } - return _this; - } - Subscriber.prototype[__WEBPACK_IMPORTED_MODULE_4__internal_symbol_rxSubscriber__["a" /* rxSubscriber */]] = function () { return this; }; - Subscriber.create = function (next, error, complete) { - var subscriber = new Subscriber(next, error, complete); - subscriber.syncErrorThrowable = false; - return subscriber; - }; - Subscriber.prototype.next = function (value) { - if (!this.isStopped) { - this._next(value); - } - }; - Subscriber.prototype.error = function (err) { - if (!this.isStopped) { - this.isStopped = true; - this._error(err); - } - }; - Subscriber.prototype.complete = function () { - if (!this.isStopped) { - this.isStopped = true; - this._complete(); - } - }; - Subscriber.prototype.unsubscribe = function () { - if (this.closed) { - return; - } - this.isStopped = true; - _super.prototype.unsubscribe.call(this); - }; - Subscriber.prototype._next = function (value) { - this.destination.next(value); - }; - Subscriber.prototype._error = function (err) { - this.destination.error(err); - this.unsubscribe(); - }; - Subscriber.prototype._complete = function () { - this.destination.complete(); - this.unsubscribe(); - }; - Subscriber.prototype._unsubscribeAndRecycle = function () { - var _a = this, _parent = _a._parent, _parents = _a._parents; - this._parent = null; - this._parents = null; - this.unsubscribe(); - this.closed = false; - this.isStopped = false; - this._parent = _parent; - this._parents = _parents; - this._parentSubscription = null; - return this; - }; - return Subscriber; -}(__WEBPACK_IMPORTED_MODULE_3__Subscription__["a" /* Subscription */])); - -var SafeSubscriber = /*@__PURE__*/ (function (_super) { - __WEBPACK_IMPORTED_MODULE_0_tslib__["a" /* __extends */](SafeSubscriber, _super); - function SafeSubscriber(_parentSubscriber, observerOrNext, error, complete) { - var _this = _super.call(this) || this; - _this._parentSubscriber = _parentSubscriber; - var next; - var context = _this; - if (__webpack_require__.i(__WEBPACK_IMPORTED_MODULE_1__util_isFunction__["a" /* isFunction */])(observerOrNext)) { - next = observerOrNext; - } - else if (observerOrNext) { - next = observerOrNext.next; - error = observerOrNext.error; - complete = observerOrNext.complete; - if (observerOrNext !== __WEBPACK_IMPORTED_MODULE_2__Observer__["a" /* empty */]) { - context = Object.create(observerOrNext); - if (__webpack_require__.i(__WEBPACK_IMPORTED_MODULE_1__util_isFunction__["a" /* isFunction */])(context.unsubscribe)) { - _this.add(context.unsubscribe.bind(context)); - } - context.unsubscribe = _this.unsubscribe.bind(_this); - } - } - _this._context = context; - _this._next = next; - _this._error = error; - _this._complete = complete; - return _this; - } - SafeSubscriber.prototype.next = function (value) { - if (!this.isStopped && this._next) { - var _parentSubscriber = this._parentSubscriber; - if (!__WEBPACK_IMPORTED_MODULE_5__config__["a" /* config */].useDeprecatedSynchronousErrorHandling || !_parentSubscriber.syncErrorThrowable) { - this.__tryOrUnsub(this._next, value); - } - else if (this.__tryOrSetError(_parentSubscriber, this._next, value)) { - this.unsubscribe(); - } - } - }; - SafeSubscriber.prototype.error = function (err) { - if (!this.isStopped) { - var _parentSubscriber = this._parentSubscriber; - var useDeprecatedSynchronousErrorHandling = __WEBPACK_IMPORTED_MODULE_5__config__["a" /* config */].useDeprecatedSynchronousErrorHandling; - if (this._error) { - if (!useDeprecatedSynchronousErrorHandling || !_parentSubscriber.syncErrorThrowable) { - this.__tryOrUnsub(this._error, err); - this.unsubscribe(); - } - else { - this.__tryOrSetError(_parentSubscriber, this._error, err); - this.unsubscribe(); - } - } - else if (!_parentSubscriber.syncErrorThrowable) { - this.unsubscribe(); - if (useDeprecatedSynchronousErrorHandling) { - throw err; - } - __webpack_require__.i(__WEBPACK_IMPORTED_MODULE_6__util_hostReportError__["a" /* hostReportError */])(err); - } - else { - if (useDeprecatedSynchronousErrorHandling) { - _parentSubscriber.syncErrorValue = err; - _parentSubscriber.syncErrorThrown = true; - } - else { - __webpack_require__.i(__WEBPACK_IMPORTED_MODULE_6__util_hostReportError__["a" /* hostReportError */])(err); - } - this.unsubscribe(); - } - } - }; - SafeSubscriber.prototype.complete = function () { - var _this = this; - if (!this.isStopped) { - var _parentSubscriber = this._parentSubscriber; - if (this._complete) { - var wrappedComplete = function () { return _this._complete.call(_this._context); }; - if (!__WEBPACK_IMPORTED_MODULE_5__config__["a" /* config */].useDeprecatedSynchronousErrorHandling || !_parentSubscriber.syncErrorThrowable) { - this.__tryOrUnsub(wrappedComplete); - this.unsubscribe(); - } - else { - this.__tryOrSetError(_parentSubscriber, wrappedComplete); - this.unsubscribe(); - } - } - else { - this.unsubscribe(); - } - } - }; - SafeSubscriber.prototype.__tryOrUnsub = function (fn, value) { - try { - fn.call(this._context, value); - } - catch (err) { - this.unsubscribe(); - if (__WEBPACK_IMPORTED_MODULE_5__config__["a" /* config */].useDeprecatedSynchronousErrorHandling) { - throw err; - } - else { - __webpack_require__.i(__WEBPACK_IMPORTED_MODULE_6__util_hostReportError__["a" /* hostReportError */])(err); - } - } - }; - SafeSubscriber.prototype.__tryOrSetError = function (parent, fn, value) { - if (!__WEBPACK_IMPORTED_MODULE_5__config__["a" /* config */].useDeprecatedSynchronousErrorHandling) { - throw new Error('bad call'); - } - try { - fn.call(this._context, value); - } - catch (err) { - if (__WEBPACK_IMPORTED_MODULE_5__config__["a" /* config */].useDeprecatedSynchronousErrorHandling) { - parent.syncErrorValue = err; - parent.syncErrorThrown = true; - return true; - } - else { - __webpack_require__.i(__WEBPACK_IMPORTED_MODULE_6__util_hostReportError__["a" /* hostReportError */])(err); - return true; - } - } - return false; - }; - SafeSubscriber.prototype._unsubscribe = function () { - var _parentSubscriber = this._parentSubscriber; - this._context = null; - this._parentSubscriber = null; - _parentSubscriber.unsubscribe(); - }; - return SafeSubscriber; -}(Subscriber)); - -//# sourceMappingURL=Subscriber.js.map - - -/***/ }), -/* 8 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); -exports.getPathKey = getPathKey; -const os = __webpack_require__(42); -const path = __webpack_require__(0); -const userHome = __webpack_require__(67).default; - -var _require = __webpack_require__(222); - -const getCacheDir = _require.getCacheDir, - getConfigDir = _require.getConfigDir, - getDataDir = _require.getDataDir; - -const isWebpackBundle = __webpack_require__(278); - -const DEPENDENCY_TYPES = exports.DEPENDENCY_TYPES = ['devDependencies', 'dependencies', 'optionalDependencies', 'peerDependencies']; -const OWNED_DEPENDENCY_TYPES = exports.OWNED_DEPENDENCY_TYPES = ['devDependencies', 'dependencies', 'optionalDependencies']; - -const RESOLUTIONS = exports.RESOLUTIONS = 'resolutions'; -const MANIFEST_FIELDS = exports.MANIFEST_FIELDS = [RESOLUTIONS, ...DEPENDENCY_TYPES]; - -const SUPPORTED_NODE_VERSIONS = exports.SUPPORTED_NODE_VERSIONS = '^4.8.0 || ^5.7.0 || ^6.2.2 || >=8.0.0'; - -const YARN_REGISTRY = exports.YARN_REGISTRY = 'https://registry.yarnpkg.com'; -const NPM_REGISTRY_RE = exports.NPM_REGISTRY_RE = /https?:\/\/registry\.npmjs\.org/g; - -const YARN_DOCS = exports.YARN_DOCS = 'https://yarnpkg.com/en/docs/cli/'; -const YARN_INSTALLER_SH = exports.YARN_INSTALLER_SH = 'https://yarnpkg.com/install.sh'; -const YARN_INSTALLER_MSI = exports.YARN_INSTALLER_MSI = 'https://yarnpkg.com/latest.msi'; - -const SELF_UPDATE_VERSION_URL = exports.SELF_UPDATE_VERSION_URL = 'https://yarnpkg.com/latest-version'; - -// cache version, bump whenever we make backwards incompatible changes -const CACHE_VERSION = exports.CACHE_VERSION = 6; - -// lockfile version, bump whenever we make backwards incompatible changes -const LOCKFILE_VERSION = exports.LOCKFILE_VERSION = 1; - -// max amount of network requests to perform concurrently -const NETWORK_CONCURRENCY = exports.NETWORK_CONCURRENCY = 8; - -// HTTP timeout used when downloading packages -const NETWORK_TIMEOUT = exports.NETWORK_TIMEOUT = 30 * 1000; // in milliseconds - -// max amount of child processes to execute concurrently -const CHILD_CONCURRENCY = exports.CHILD_CONCURRENCY = 5; - -const REQUIRED_PACKAGE_KEYS = exports.REQUIRED_PACKAGE_KEYS = ['name', 'version', '_uid']; - -function getPreferredCacheDirectories() { - const preferredCacheDirectories = [getCacheDir()]; - - if (process.getuid) { - // $FlowFixMe: process.getuid exists, dammit - preferredCacheDirectories.push(path.join(os.tmpdir(), `.yarn-cache-${process.getuid()}`)); - } - - preferredCacheDirectories.push(path.join(os.tmpdir(), `.yarn-cache`)); - - return preferredCacheDirectories; -} - -const PREFERRED_MODULE_CACHE_DIRECTORIES = exports.PREFERRED_MODULE_CACHE_DIRECTORIES = getPreferredCacheDirectories(); -const CONFIG_DIRECTORY = exports.CONFIG_DIRECTORY = getConfigDir(); -const DATA_DIRECTORY = exports.DATA_DIRECTORY = getDataDir(); -const LINK_REGISTRY_DIRECTORY = exports.LINK_REGISTRY_DIRECTORY = path.join(DATA_DIRECTORY, 'link'); -const GLOBAL_MODULE_DIRECTORY = exports.GLOBAL_MODULE_DIRECTORY = path.join(DATA_DIRECTORY, 'global'); - -const NODE_BIN_PATH = exports.NODE_BIN_PATH = process.execPath; -const YARN_BIN_PATH = exports.YARN_BIN_PATH = getYarnBinPath(); - -// Webpack needs to be configured with node.__dirname/__filename = false -function getYarnBinPath() { - if (isWebpackBundle) { - return __filename; - } else { - return path.join(__dirname, '..', 'bin', 'yarn.js'); - } -} - -const NODE_MODULES_FOLDER = exports.NODE_MODULES_FOLDER = 'node_modules'; -const NODE_PACKAGE_JSON = exports.NODE_PACKAGE_JSON = 'package.json'; - -const PNP_FILENAME = exports.PNP_FILENAME = '.pnp.js'; - -const POSIX_GLOBAL_PREFIX = exports.POSIX_GLOBAL_PREFIX = `${process.env.DESTDIR || ''}/usr/local`; -const FALLBACK_GLOBAL_PREFIX = exports.FALLBACK_GLOBAL_PREFIX = path.join(userHome, '.yarn'); - -const META_FOLDER = exports.META_FOLDER = '.yarn-meta'; -const INTEGRITY_FILENAME = exports.INTEGRITY_FILENAME = '.yarn-integrity'; -const LOCKFILE_FILENAME = exports.LOCKFILE_FILENAME = 'yarn.lock'; -const METADATA_FILENAME = exports.METADATA_FILENAME = '.yarn-metadata.json'; -const TARBALL_FILENAME = exports.TARBALL_FILENAME = '.yarn-tarball.tgz'; -const CLEAN_FILENAME = exports.CLEAN_FILENAME = '.yarnclean'; - -const NPM_LOCK_FILENAME = exports.NPM_LOCK_FILENAME = 'package-lock.json'; -const NPM_SHRINKWRAP_FILENAME = exports.NPM_SHRINKWRAP_FILENAME = 'npm-shrinkwrap.json'; - -const DEFAULT_INDENT = exports.DEFAULT_INDENT = ' '; -const SINGLE_INSTANCE_PORT = exports.SINGLE_INSTANCE_PORT = 31997; -const SINGLE_INSTANCE_FILENAME = exports.SINGLE_INSTANCE_FILENAME = '.yarn-single-instance'; - -const ENV_PATH_KEY = exports.ENV_PATH_KEY = getPathKey(process.platform, process.env); - -function getPathKey(platform, env) { - let pathKey = 'PATH'; - - // windows calls its path "Path" usually, but this is not guaranteed. - if (platform === 'win32') { - pathKey = 'Path'; - - for (const key in env) { - if (key.toLowerCase() === 'path') { - pathKey = key; - } - } - } - - return pathKey; -} - -const VERSION_COLOR_SCHEME = exports.VERSION_COLOR_SCHEME = { - major: 'red', - premajor: 'red', - minor: 'yellow', - preminor: 'yellow', - patch: 'green', - prepatch: 'green', - prerelease: 'red', - unchanged: 'white', - unknown: 'red' -}; - -/***/ }), -/* 9 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; -/** - * Copyright (c) 2013-present, Facebook, Inc. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - - - -/** - * Use invariant() to assert state which your program assumes to be true. - * - * Provide sprintf-style format (only %s is supported) and arguments - * to provide information about what broke and what you were - * expecting. - * - * The invariant message will be stripped in production, but the invariant - * will remain to ensure logic does not differ in production. - */ - -var NODE_ENV = process.env.NODE_ENV; - -var invariant = function(condition, format, a, b, c, d, e, f) { - if (NODE_ENV !== 'production') { - if (format === undefined) { - throw new Error('invariant requires an error message argument'); - } - } - - if (!condition) { - var error; - if (format === undefined) { - error = new Error( - 'Minified exception occurred; use the non-minified dev environment ' + - 'for the full error message and additional helpful warnings.' - ); - } else { - var args = [a, b, c, d, e, f]; - var argIndex = 0; - error = new Error( - format.replace(/%s/g, function() { return args[argIndex++]; }) - ); - error.name = 'Invariant Violation'; - } - - error.framesToPop = 1; // we don't care about invariant's own frame - throw error; - } -}; - -module.exports = invariant; - - -/***/ }), -/* 10 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -var YAMLException = __webpack_require__(55); - -var TYPE_CONSTRUCTOR_OPTIONS = [ - 'kind', - 'resolve', - 'construct', - 'instanceOf', - 'predicate', - 'represent', - 'defaultStyle', - 'styleAliases' -]; - -var YAML_NODE_KINDS = [ - 'scalar', - 'sequence', - 'mapping' -]; - -function compileStyleAliases(map) { - var result = {}; - - if (map !== null) { - Object.keys(map).forEach(function (style) { - map[style].forEach(function (alias) { - result[String(alias)] = style; - }); - }); - } - - return result; -} - -function Type(tag, options) { - options = options || {}; - - Object.keys(options).forEach(function (name) { - if (TYPE_CONSTRUCTOR_OPTIONS.indexOf(name) === -1) { - throw new YAMLException('Unknown option "' + name + '" is met in definition of "' + tag + '" YAML type.'); - } - }); - - // TODO: Add tag format check. - this.tag = tag; - this.kind = options['kind'] || null; - this.resolve = options['resolve'] || function () { return true; }; - this.construct = options['construct'] || function (data) { return data; }; - this.instanceOf = options['instanceOf'] || null; - this.predicate = options['predicate'] || null; - this.represent = options['represent'] || null; - this.defaultStyle = options['defaultStyle'] || null; - this.styleAliases = compileStyleAliases(options['styleAliases'] || null); - - if (YAML_NODE_KINDS.indexOf(this.kind) === -1) { - throw new YAMLException('Unknown kind "' + this.kind + '" is specified for "' + tag + '" YAML type.'); - } -} - -module.exports = Type; - - -/***/ }), -/* 11 */ -/***/ (function(module, exports) { - -module.exports = require("crypto"); - -/***/ }), -/* 12 */ -/***/ (function(module, __webpack_exports__, __webpack_require__) { - -"use strict"; -/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return Observable; }); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_0__util_canReportError__ = __webpack_require__(323); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_1__util_toSubscriber__ = __webpack_require__(932); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_2__internal_symbol_observable__ = __webpack_require__(118); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_3__util_pipe__ = __webpack_require__(325); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_4__config__ = __webpack_require__(186); -/** PURE_IMPORTS_START _util_canReportError,_util_toSubscriber,_internal_symbol_observable,_util_pipe,_config PURE_IMPORTS_END */ - - - - - -var Observable = /*@__PURE__*/ (function () { - function Observable(subscribe) { - this._isScalar = false; - if (subscribe) { - this._subscribe = subscribe; - } - } - Observable.prototype.lift = function (operator) { - var observable = new Observable(); - observable.source = this; - observable.operator = operator; - return observable; - }; - Observable.prototype.subscribe = function (observerOrNext, error, complete) { - var operator = this.operator; - var sink = __webpack_require__.i(__WEBPACK_IMPORTED_MODULE_1__util_toSubscriber__["a" /* toSubscriber */])(observerOrNext, error, complete); - if (operator) { - operator.call(sink, this.source); - } - else { - sink.add(this.source || (__WEBPACK_IMPORTED_MODULE_4__config__["a" /* config */].useDeprecatedSynchronousErrorHandling && !sink.syncErrorThrowable) ? - this._subscribe(sink) : - this._trySubscribe(sink)); - } - if (__WEBPACK_IMPORTED_MODULE_4__config__["a" /* config */].useDeprecatedSynchronousErrorHandling) { - if (sink.syncErrorThrowable) { - sink.syncErrorThrowable = false; - if (sink.syncErrorThrown) { - throw sink.syncErrorValue; - } - } - } - return sink; - }; - Observable.prototype._trySubscribe = function (sink) { - try { - return this._subscribe(sink); - } - catch (err) { - if (__WEBPACK_IMPORTED_MODULE_4__config__["a" /* config */].useDeprecatedSynchronousErrorHandling) { - sink.syncErrorThrown = true; - sink.syncErrorValue = err; - } - if (__webpack_require__.i(__WEBPACK_IMPORTED_MODULE_0__util_canReportError__["a" /* canReportError */])(sink)) { - sink.error(err); - } - else { - console.warn(err); - } - } - }; - Observable.prototype.forEach = function (next, promiseCtor) { - var _this = this; - promiseCtor = getPromiseCtor(promiseCtor); - return new promiseCtor(function (resolve, reject) { - var subscription; - subscription = _this.subscribe(function (value) { - try { - next(value); - } - catch (err) { - reject(err); - if (subscription) { - subscription.unsubscribe(); - } - } - }, reject, resolve); - }); - }; - Observable.prototype._subscribe = function (subscriber) { - var source = this.source; - return source && source.subscribe(subscriber); - }; - Observable.prototype[__WEBPACK_IMPORTED_MODULE_2__internal_symbol_observable__["a" /* observable */]] = function () { - return this; - }; - Observable.prototype.pipe = function () { - var operations = []; - for (var _i = 0; _i < arguments.length; _i++) { - operations[_i] = arguments[_i]; - } - if (operations.length === 0) { - return this; - } - return __webpack_require__.i(__WEBPACK_IMPORTED_MODULE_3__util_pipe__["b" /* pipeFromArray */])(operations)(this); - }; - Observable.prototype.toPromise = function (promiseCtor) { - var _this = this; - promiseCtor = getPromiseCtor(promiseCtor); - return new promiseCtor(function (resolve, reject) { - var value; - _this.subscribe(function (x) { return value = x; }, function (err) { return reject(err); }, function () { return resolve(value); }); - }); - }; - Observable.create = function (subscribe) { - return new Observable(subscribe); - }; - return Observable; -}()); - -function getPromiseCtor(promiseCtor) { - if (!promiseCtor) { - promiseCtor = __WEBPACK_IMPORTED_MODULE_4__config__["a" /* config */].Promise || Promise; - } - if (!promiseCtor) { - throw new Error('no Promise impl found'); - } - return promiseCtor; -} -//# sourceMappingURL=Observable.js.map - - -/***/ }), -/* 13 */ -/***/ (function(module, __webpack_exports__, __webpack_require__) { - -"use strict"; -/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return OuterSubscriber; }); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_0_tslib__ = __webpack_require__(1); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_1__Subscriber__ = __webpack_require__(7); -/** PURE_IMPORTS_START tslib,_Subscriber PURE_IMPORTS_END */ - - -var OuterSubscriber = /*@__PURE__*/ (function (_super) { - __WEBPACK_IMPORTED_MODULE_0_tslib__["a" /* __extends */](OuterSubscriber, _super); - function OuterSubscriber() { - return _super !== null && _super.apply(this, arguments) || this; - } - OuterSubscriber.prototype.notifyNext = function (outerValue, innerValue, outerIndex, innerIndex, innerSub) { - this.destination.next(innerValue); - }; - OuterSubscriber.prototype.notifyError = function (error, innerSub) { - this.destination.error(error); - }; - OuterSubscriber.prototype.notifyComplete = function (innerSub) { - this.destination.complete(); - }; - return OuterSubscriber; -}(__WEBPACK_IMPORTED_MODULE_1__Subscriber__["a" /* Subscriber */])); - -//# sourceMappingURL=OuterSubscriber.js.map - - -/***/ }), -/* 14 */ -/***/ (function(module, __webpack_exports__, __webpack_require__) { - -"use strict"; -/* harmony export (immutable) */ __webpack_exports__["a"] = subscribeToResult; -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_0__InnerSubscriber__ = __webpack_require__(84); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_1__subscribeTo__ = __webpack_require__(446); -/** PURE_IMPORTS_START _InnerSubscriber,_subscribeTo PURE_IMPORTS_END */ - - -function subscribeToResult(outerSubscriber, result, outerValue, outerIndex, destination) { - if (destination === void 0) { - destination = new __WEBPACK_IMPORTED_MODULE_0__InnerSubscriber__["a" /* InnerSubscriber */](outerSubscriber, outerValue, outerIndex); - } - if (destination.closed) { - return; - } - return __webpack_require__.i(__WEBPACK_IMPORTED_MODULE_1__subscribeTo__["a" /* subscribeTo */])(result)(destination); -} -//# sourceMappingURL=subscribeToResult.js.map - - -/***/ }), -/* 15 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; -/* eslint-disable node/no-deprecated-api */ - - - -var buffer = __webpack_require__(64) -var Buffer = buffer.Buffer - -var safer = {} - -var key - -for (key in buffer) { - if (!buffer.hasOwnProperty(key)) continue - if (key === 'SlowBuffer' || key === 'Buffer') continue - safer[key] = buffer[key] -} - -var Safer = safer.Buffer = {} -for (key in Buffer) { - if (!Buffer.hasOwnProperty(key)) continue - if (key === 'allocUnsafe' || key === 'allocUnsafeSlow') continue - Safer[key] = Buffer[key] -} - -safer.Buffer.prototype = Buffer.prototype - -if (!Safer.from || Safer.from === Uint8Array.from) { - Safer.from = function (value, encodingOrOffset, length) { - if (typeof value === 'number') { - throw new TypeError('The "value" argument must not be of type number. Received type ' + typeof value) - } - if (value && typeof value.length === 'undefined') { - throw new TypeError('The first argument must be one of type string, Buffer, ArrayBuffer, Array, or Array-like Object. Received type ' + typeof value) - } - return Buffer(value, encodingOrOffset, length) - } -} - -if (!Safer.alloc) { - Safer.alloc = function (size, fill, encoding) { - if (typeof size !== 'number') { - throw new TypeError('The "size" argument must be of type number. Received type ' + typeof size) - } - if (size < 0 || size >= 2 * (1 << 30)) { - throw new RangeError('The value "' + size + '" is invalid for option "size"') - } - var buf = Buffer(size) - if (!fill || fill.length === 0) { - buf.fill(0) - } else if (typeof encoding === 'string') { - buf.fill(fill, encoding) - } else { - buf.fill(fill) - } - return buf - } -} - -if (!safer.kStringMaxLength) { - try { - safer.kStringMaxLength = process.binding('buffer').kStringMaxLength - } catch (e) { - // we can't determine kStringMaxLength in environments where process.binding - // is unsupported, so let's not set it - } -} - -if (!safer.constants) { - safer.constants = { - MAX_LENGTH: safer.kMaxLength - } - if (safer.kStringMaxLength) { - safer.constants.MAX_STRING_LENGTH = safer.kStringMaxLength - } -} - -module.exports = safer - - -/***/ }), -/* 16 */ -/***/ (function(module, exports, __webpack_require__) { - -// Copyright (c) 2012, Mark Cavage. All rights reserved. -// Copyright 2015 Joyent, Inc. - -var assert = __webpack_require__(29); -var Stream = __webpack_require__(23).Stream; -var util = __webpack_require__(3); - - -///--- Globals - -/* JSSTYLED */ -var UUID_REGEXP = /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/; - - -///--- Internal - -function _capitalize(str) { - return (str.charAt(0).toUpperCase() + str.slice(1)); -} - -function _toss(name, expected, oper, arg, actual) { - throw new assert.AssertionError({ - message: util.format('%s (%s) is required', name, expected), - actual: (actual === undefined) ? typeof (arg) : actual(arg), - expected: expected, - operator: oper || '===', - stackStartFunction: _toss.caller - }); -} - -function _getClass(arg) { - return (Object.prototype.toString.call(arg).slice(8, -1)); -} - -function noop() { - // Why even bother with asserts? -} - - -///--- Exports - -var types = { - bool: { - check: function (arg) { return typeof (arg) === 'boolean'; } - }, - func: { - check: function (arg) { return typeof (arg) === 'function'; } - }, - string: { - check: function (arg) { return typeof (arg) === 'string'; } - }, - object: { - check: function (arg) { - return typeof (arg) === 'object' && arg !== null; - } - }, - number: { - check: function (arg) { - return typeof (arg) === 'number' && !isNaN(arg); - } - }, - finite: { - check: function (arg) { - return typeof (arg) === 'number' && !isNaN(arg) && isFinite(arg); - } - }, - buffer: { - check: function (arg) { return Buffer.isBuffer(arg); }, - operator: 'Buffer.isBuffer' - }, - array: { - check: function (arg) { return Array.isArray(arg); }, - operator: 'Array.isArray' - }, - stream: { - check: function (arg) { return arg instanceof Stream; }, - operator: 'instanceof', - actual: _getClass - }, - date: { - check: function (arg) { return arg instanceof Date; }, - operator: 'instanceof', - actual: _getClass - }, - regexp: { - check: function (arg) { return arg instanceof RegExp; }, - operator: 'instanceof', - actual: _getClass - }, - uuid: { - check: function (arg) { - return typeof (arg) === 'string' && UUID_REGEXP.test(arg); - }, - operator: 'isUUID' - } -}; - -function _setExports(ndebug) { - var keys = Object.keys(types); - var out; - - /* re-export standard assert */ - if (process.env.NODE_NDEBUG) { - out = noop; - } else { - out = function (arg, msg) { - if (!arg) { - _toss(msg, 'true', arg); - } - }; - } - - /* standard checks */ - keys.forEach(function (k) { - if (ndebug) { - out[k] = noop; - return; - } - var type = types[k]; - out[k] = function (arg, msg) { - if (!type.check(arg)) { - _toss(msg, k, type.operator, arg, type.actual); - } - }; - }); - - /* optional checks */ - keys.forEach(function (k) { - var name = 'optional' + _capitalize(k); - if (ndebug) { - out[name] = noop; - return; - } - var type = types[k]; - out[name] = function (arg, msg) { - if (arg === undefined || arg === null) { - return; - } - if (!type.check(arg)) { - _toss(msg, k, type.operator, arg, type.actual); - } - }; - }); - - /* arrayOf checks */ - keys.forEach(function (k) { - var name = 'arrayOf' + _capitalize(k); - if (ndebug) { - out[name] = noop; - return; - } - var type = types[k]; - var expected = '[' + k + ']'; - out[name] = function (arg, msg) { - if (!Array.isArray(arg)) { - _toss(msg, expected, type.operator, arg, type.actual); - } - var i; - for (i = 0; i < arg.length; i++) { - if (!type.check(arg[i])) { - _toss(msg, expected, type.operator, arg, type.actual); - } - } - }; - }); - - /* optionalArrayOf checks */ - keys.forEach(function (k) { - var name = 'optionalArrayOf' + _capitalize(k); - if (ndebug) { - out[name] = noop; - return; - } - var type = types[k]; - var expected = '[' + k + ']'; - out[name] = function (arg, msg) { - if (arg === undefined || arg === null) { - return; - } - if (!Array.isArray(arg)) { - _toss(msg, expected, type.operator, arg, type.actual); - } - var i; - for (i = 0; i < arg.length; i++) { - if (!type.check(arg[i])) { - _toss(msg, expected, type.operator, arg, type.actual); - } - } - }; - }); - - /* re-export built-in assertions */ - Object.keys(assert).forEach(function (k) { - if (k === 'AssertionError') { - out[k] = assert[k]; - return; - } - if (ndebug) { - out[k] = noop; - return; - } - out[k] = assert[k]; - }); - - /* export ourselves (for unit tests _only_) */ - out._setExports = _setExports; - - return out; -} - -module.exports = _setExports(process.env.NODE_NDEBUG); - - -/***/ }), -/* 17 */ -/***/ (function(module, exports) { - -// https://github.com/zloirock/core-js/issues/86#issuecomment-115759028 -var global = module.exports = typeof window != 'undefined' && window.Math == Math - ? window : typeof self != 'undefined' && self.Math == Math ? self - // eslint-disable-next-line no-new-func - : Function('return this')(); -if (typeof __g == 'number') __g = global; // eslint-disable-line no-undef - - -/***/ }), -/* 18 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); -exports.sortAlpha = sortAlpha; -exports.sortOptionsByFlags = sortOptionsByFlags; -exports.entries = entries; -exports.removePrefix = removePrefix; -exports.removeSuffix = removeSuffix; -exports.addSuffix = addSuffix; -exports.hyphenate = hyphenate; -exports.camelCase = camelCase; -exports.compareSortedArrays = compareSortedArrays; -exports.sleep = sleep; -const _camelCase = __webpack_require__(227); - -function sortAlpha(a, b) { - // sort alphabetically in a deterministic way - const shortLen = Math.min(a.length, b.length); - for (let i = 0; i < shortLen; i++) { - const aChar = a.charCodeAt(i); - const bChar = b.charCodeAt(i); - if (aChar !== bChar) { - return aChar - bChar; - } - } - return a.length - b.length; -} - -function sortOptionsByFlags(a, b) { - const aOpt = a.flags.replace(/-/g, ''); - const bOpt = b.flags.replace(/-/g, ''); - return sortAlpha(aOpt, bOpt); -} - -function entries(obj) { - const entries = []; - if (obj) { - for (const key in obj) { - entries.push([key, obj[key]]); - } - } - return entries; -} - -function removePrefix(pattern, prefix) { - if (pattern.startsWith(prefix)) { - pattern = pattern.slice(prefix.length); - } - - return pattern; -} - -function removeSuffix(pattern, suffix) { - if (pattern.endsWith(suffix)) { - return pattern.slice(0, -suffix.length); - } - - return pattern; -} - -function addSuffix(pattern, suffix) { - if (!pattern.endsWith(suffix)) { - return pattern + suffix; - } - - return pattern; -} - -function hyphenate(str) { - return str.replace(/[A-Z]/g, match => { - return '-' + match.charAt(0).toLowerCase(); - }); -} - -function camelCase(str) { - if (/[A-Z]/.test(str)) { - return null; - } else { - return _camelCase(str); - } -} - -function compareSortedArrays(array1, array2) { - if (array1.length !== array2.length) { - return false; - } - for (let i = 0, len = array1.length; i < len; i++) { - if (array1[i] !== array2[i]) { - return false; - } - } - return true; -} - -function sleep(ms) { - return new Promise(resolve => { - setTimeout(resolve, ms); - }); -} - -/***/ }), -/* 19 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); -exports.stringify = exports.parse = undefined; - -var _asyncToGenerator2; - -function _load_asyncToGenerator() { - return _asyncToGenerator2 = _interopRequireDefault(__webpack_require__(2)); -} - -var _parse; - -function _load_parse() { - return _parse = __webpack_require__(106); -} - -Object.defineProperty(exports, 'parse', { - enumerable: true, - get: function get() { - return _interopRequireDefault(_parse || _load_parse()).default; - } -}); - -var _stringify; - -function _load_stringify() { - return _stringify = __webpack_require__(200); -} - -Object.defineProperty(exports, 'stringify', { - enumerable: true, - get: function get() { - return _interopRequireDefault(_stringify || _load_stringify()).default; - } -}); -exports.implodeEntry = implodeEntry; -exports.explodeEntry = explodeEntry; - -var _misc; - -function _load_misc() { - return _misc = __webpack_require__(18); -} - -var _normalizePattern; - -function _load_normalizePattern() { - return _normalizePattern = __webpack_require__(37); -} - -var _parse2; - -function _load_parse2() { - return _parse2 = _interopRequireDefault(__webpack_require__(106)); -} - -var _constants; - -function _load_constants() { - return _constants = __webpack_require__(8); -} - -var _fs; - -function _load_fs() { - return _fs = _interopRequireWildcard(__webpack_require__(5)); -} - -function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } } - -function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } - -const invariant = __webpack_require__(9); - -const path = __webpack_require__(0); -const ssri = __webpack_require__(65); - -function getName(pattern) { - return (0, (_normalizePattern || _load_normalizePattern()).normalizePattern)(pattern).name; -} - -function blankObjectUndefined(obj) { - return obj && Object.keys(obj).length ? obj : undefined; -} - -function keyForRemote(remote) { - return remote.resolved || (remote.reference && remote.hash ? `${remote.reference}#${remote.hash}` : null); -} - -function serializeIntegrity(integrity) { - // We need this because `Integrity.toString()` does not use sorting to ensure a stable string output - // See https://git.io/vx2Hy - return integrity.toString().split(' ').sort().join(' '); -} - -function implodeEntry(pattern, obj) { - const inferredName = getName(pattern); - const integrity = obj.integrity ? serializeIntegrity(obj.integrity) : ''; - const imploded = { - name: inferredName === obj.name ? undefined : obj.name, - version: obj.version, - uid: obj.uid === obj.version ? undefined : obj.uid, - resolved: obj.resolved, - registry: obj.registry === 'npm' ? undefined : obj.registry, - dependencies: blankObjectUndefined(obj.dependencies), - optionalDependencies: blankObjectUndefined(obj.optionalDependencies), - permissions: blankObjectUndefined(obj.permissions), - prebuiltVariants: blankObjectUndefined(obj.prebuiltVariants) - }; - if (integrity) { - imploded.integrity = integrity; - } - return imploded; -} - -function explodeEntry(pattern, obj) { - obj.optionalDependencies = obj.optionalDependencies || {}; - obj.dependencies = obj.dependencies || {}; - obj.uid = obj.uid || obj.version; - obj.permissions = obj.permissions || {}; - obj.registry = obj.registry || 'npm'; - obj.name = obj.name || getName(pattern); - const integrity = obj.integrity; - if (integrity && integrity.isIntegrity) { - obj.integrity = ssri.parse(integrity); - } - return obj; -} - -class Lockfile { - constructor({ cache, source, parseResultType } = {}) { - this.source = source || ''; - this.cache = cache; - this.parseResultType = parseResultType; - } - - // source string if the `cache` was parsed - - - // if true, we're parsing an old yarn file and need to update integrity fields - hasEntriesExistWithoutIntegrity() { - if (!this.cache) { - return false; - } - - for (const key in this.cache) { - // $FlowFixMe - `this.cache` is clearly defined at this point - if (!/^.*@(file:|http)/.test(key) && this.cache[key] && !this.cache[key].integrity) { - return true; - } - } - - return false; - } - - static fromDirectory(dir, reporter) { - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - // read the manifest in this directory - const lockfileLoc = path.join(dir, (_constants || _load_constants()).LOCKFILE_FILENAME); - - let lockfile; - let rawLockfile = ''; - let parseResult; - - if (yield (_fs || _load_fs()).exists(lockfileLoc)) { - rawLockfile = yield (_fs || _load_fs()).readFile(lockfileLoc); - parseResult = (0, (_parse2 || _load_parse2()).default)(rawLockfile, lockfileLoc); - - if (reporter) { - if (parseResult.type === 'merge') { - reporter.info(reporter.lang('lockfileMerged')); - } else if (parseResult.type === 'conflict') { - reporter.warn(reporter.lang('lockfileConflict')); - } - } - - lockfile = parseResult.object; - } else if (reporter) { - reporter.info(reporter.lang('noLockfileFound')); - } - - if (lockfile && lockfile.__metadata) { - const lockfilev2 = lockfile; - lockfile = {}; - } - - return new Lockfile({ cache: lockfile, source: rawLockfile, parseResultType: parseResult && parseResult.type }); - })(); - } - - getLocked(pattern) { - const cache = this.cache; - if (!cache) { - return undefined; - } - - const shrunk = pattern in cache && cache[pattern]; - - if (typeof shrunk === 'string') { - return this.getLocked(shrunk); - } else if (shrunk) { - explodeEntry(pattern, shrunk); - return shrunk; - } - - return undefined; - } - - removePattern(pattern) { - const cache = this.cache; - if (!cache) { - return; - } - delete cache[pattern]; - } - - getLockfile(patterns) { - const lockfile = {}; - const seen = new Map(); - - // order by name so that lockfile manifest is assigned to the first dependency with this manifest - // the others that have the same remoteKey will just refer to the first - // ordering allows for consistency in lockfile when it is serialized - const sortedPatternsKeys = Object.keys(patterns).sort((_misc || _load_misc()).sortAlpha); - - for (var _iterator = sortedPatternsKeys, _isArray = Array.isArray(_iterator), _i = 0, _iterator = _isArray ? _iterator : _iterator[Symbol.iterator]();;) { - var _ref; - - if (_isArray) { - if (_i >= _iterator.length) break; - _ref = _iterator[_i++]; - } else { - _i = _iterator.next(); - if (_i.done) break; - _ref = _i.value; - } - - const pattern = _ref; - - const pkg = patterns[pattern]; - const remote = pkg._remote, - ref = pkg._reference; - - invariant(ref, 'Package is missing a reference'); - invariant(remote, 'Package is missing a remote'); - - const remoteKey = keyForRemote(remote); - const pkgName = getName(pattern); - - const seenKey = remoteKey ? `${remoteKey}#${pkgName}` : null; - const seenPattern = seenKey ? seen.get(seenKey) : null; - - if (seenPattern) { - // no point in duplicating it - lockfile[pattern] = seenPattern; - continue; - } - - const obj = implodeEntry(pattern, { - name: pkgName, - version: pkg.version, - uid: pkg._uid, - resolved: remote.resolved, - integrity: remote.integrity, - registry: remote.registry, - dependencies: pkg.dependencies, - peerDependencies: pkg.peerDependencies, - optionalDependencies: pkg.optionalDependencies, - permissions: ref.permissions, - prebuiltVariants: pkg.prebuiltVariants - }); - - lockfile[pattern] = obj; - - if (seenKey) { - seen.set(seenKey, obj); - } - } - - return lockfile; - } -} -exports.default = Lockfile; - -/***/ }), -/* 20 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -exports.__esModule = true; - -var _assign = __webpack_require__(559); - -var _assign2 = _interopRequireDefault(_assign); - -function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } - -exports.default = _assign2.default || function (target) { - for (var i = 1; i < arguments.length; i++) { - var source = arguments[i]; - - for (var key in source) { - if (Object.prototype.hasOwnProperty.call(source, key)) { - target[key] = source[key]; - } - } - } - - return target; -}; - -/***/ }), -/* 21 */ -/***/ (function(module, exports, __webpack_require__) { - -var store = __webpack_require__(134)('wks'); -var uid = __webpack_require__(138); -var Symbol = __webpack_require__(17).Symbol; -var USE_SYMBOL = typeof Symbol == 'function'; - -var $exports = module.exports = function (name) { - return store[name] || (store[name] = - USE_SYMBOL && Symbol[name] || (USE_SYMBOL ? Symbol : uid)('Symbol.' + name)); -}; - -$exports.store = store; - - -/***/ }), -/* 22 */ -/***/ (function(module, exports) { - -exports = module.exports = SemVer; - -// The debug function is excluded entirely from the minified version. -/* nomin */ var debug; -/* nomin */ if (typeof process === 'object' && - /* nomin */ process.env && - /* nomin */ process.env.NODE_DEBUG && - /* nomin */ /\bsemver\b/i.test(process.env.NODE_DEBUG)) - /* nomin */ debug = function() { - /* nomin */ var args = Array.prototype.slice.call(arguments, 0); - /* nomin */ args.unshift('SEMVER'); - /* nomin */ console.log.apply(console, args); - /* nomin */ }; -/* nomin */ else - /* nomin */ debug = function() {}; - -// Note: this is the semver.org version of the spec that it implements -// Not necessarily the package version of this code. -exports.SEMVER_SPEC_VERSION = '2.0.0'; - -var MAX_LENGTH = 256; -var MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || 9007199254740991; - -// Max safe segment length for coercion. -var MAX_SAFE_COMPONENT_LENGTH = 16; - -// The actual regexps go on exports.re -var re = exports.re = []; -var src = exports.src = []; -var R = 0; - -// The following Regular Expressions can be used for tokenizing, -// validating, and parsing SemVer version strings. - -// ## Numeric Identifier -// A single `0`, or a non-zero digit followed by zero or more digits. - -var NUMERICIDENTIFIER = R++; -src[NUMERICIDENTIFIER] = '0|[1-9]\\d*'; -var NUMERICIDENTIFIERLOOSE = R++; -src[NUMERICIDENTIFIERLOOSE] = '[0-9]+'; - - -// ## Non-numeric Identifier -// Zero or more digits, followed by a letter or hyphen, and then zero or -// more letters, digits, or hyphens. - -var NONNUMERICIDENTIFIER = R++; -src[NONNUMERICIDENTIFIER] = '\\d*[a-zA-Z-][a-zA-Z0-9-]*'; - - -// ## Main Version -// Three dot-separated numeric identifiers. - -var MAINVERSION = R++; -src[MAINVERSION] = '(' + src[NUMERICIDENTIFIER] + ')\\.' + - '(' + src[NUMERICIDENTIFIER] + ')\\.' + - '(' + src[NUMERICIDENTIFIER] + ')'; - -var MAINVERSIONLOOSE = R++; -src[MAINVERSIONLOOSE] = '(' + src[NUMERICIDENTIFIERLOOSE] + ')\\.' + - '(' + src[NUMERICIDENTIFIERLOOSE] + ')\\.' + - '(' + src[NUMERICIDENTIFIERLOOSE] + ')'; - -// ## Pre-release Version Identifier -// A numeric identifier, or a non-numeric identifier. - -var PRERELEASEIDENTIFIER = R++; -src[PRERELEASEIDENTIFIER] = '(?:' + src[NUMERICIDENTIFIER] + - '|' + src[NONNUMERICIDENTIFIER] + ')'; - -var PRERELEASEIDENTIFIERLOOSE = R++; -src[PRERELEASEIDENTIFIERLOOSE] = '(?:' + src[NUMERICIDENTIFIERLOOSE] + - '|' + src[NONNUMERICIDENTIFIER] + ')'; - - -// ## Pre-release Version -// Hyphen, followed by one or more dot-separated pre-release version -// identifiers. - -var PRERELEASE = R++; -src[PRERELEASE] = '(?:-(' + src[PRERELEASEIDENTIFIER] + - '(?:\\.' + src[PRERELEASEIDENTIFIER] + ')*))'; - -var PRERELEASELOOSE = R++; -src[PRERELEASELOOSE] = '(?:-?(' + src[PRERELEASEIDENTIFIERLOOSE] + - '(?:\\.' + src[PRERELEASEIDENTIFIERLOOSE] + ')*))'; - -// ## Build Metadata Identifier -// Any combination of digits, letters, or hyphens. - -var BUILDIDENTIFIER = R++; -src[BUILDIDENTIFIER] = '[0-9A-Za-z-]+'; - -// ## Build Metadata -// Plus sign, followed by one or more period-separated build metadata -// identifiers. - -var BUILD = R++; -src[BUILD] = '(?:\\+(' + src[BUILDIDENTIFIER] + - '(?:\\.' + src[BUILDIDENTIFIER] + ')*))'; - - -// ## Full Version String -// A main version, followed optionally by a pre-release version and -// build metadata. - -// Note that the only major, minor, patch, and pre-release sections of -// the version string are capturing groups. The build metadata is not a -// capturing group, because it should not ever be used in version -// comparison. - -var FULL = R++; -var FULLPLAIN = 'v?' + src[MAINVERSION] + - src[PRERELEASE] + '?' + - src[BUILD] + '?'; - -src[FULL] = '^' + FULLPLAIN + '$'; - -// like full, but allows v1.2.3 and =1.2.3, which people do sometimes. -// also, 1.0.0alpha1 (prerelease without the hyphen) which is pretty -// common in the npm registry. -var LOOSEPLAIN = '[v=\\s]*' + src[MAINVERSIONLOOSE] + - src[PRERELEASELOOSE] + '?' + - src[BUILD] + '?'; - -var LOOSE = R++; -src[LOOSE] = '^' + LOOSEPLAIN + '$'; - -var GTLT = R++; -src[GTLT] = '((?:<|>)?=?)'; - -// Something like "2.*" or "1.2.x". -// Note that "x.x" is a valid xRange identifer, meaning "any version" -// Only the first item is strictly required. -var XRANGEIDENTIFIERLOOSE = R++; -src[XRANGEIDENTIFIERLOOSE] = src[NUMERICIDENTIFIERLOOSE] + '|x|X|\\*'; -var XRANGEIDENTIFIER = R++; -src[XRANGEIDENTIFIER] = src[NUMERICIDENTIFIER] + '|x|X|\\*'; - -var XRANGEPLAIN = R++; -src[XRANGEPLAIN] = '[v=\\s]*(' + src[XRANGEIDENTIFIER] + ')' + - '(?:\\.(' + src[XRANGEIDENTIFIER] + ')' + - '(?:\\.(' + src[XRANGEIDENTIFIER] + ')' + - '(?:' + src[PRERELEASE] + ')?' + - src[BUILD] + '?' + - ')?)?'; - -var XRANGEPLAINLOOSE = R++; -src[XRANGEPLAINLOOSE] = '[v=\\s]*(' + src[XRANGEIDENTIFIERLOOSE] + ')' + - '(?:\\.(' + src[XRANGEIDENTIFIERLOOSE] + ')' + - '(?:\\.(' + src[XRANGEIDENTIFIERLOOSE] + ')' + - '(?:' + src[PRERELEASELOOSE] + ')?' + - src[BUILD] + '?' + - ')?)?'; - -var XRANGE = R++; -src[XRANGE] = '^' + src[GTLT] + '\\s*' + src[XRANGEPLAIN] + '$'; -var XRANGELOOSE = R++; -src[XRANGELOOSE] = '^' + src[GTLT] + '\\s*' + src[XRANGEPLAINLOOSE] + '$'; - -// Coercion. -// Extract anything that could conceivably be a part of a valid semver -var COERCE = R++; -src[COERCE] = '(?:^|[^\\d])' + - '(\\d{1,' + MAX_SAFE_COMPONENT_LENGTH + '})' + - '(?:\\.(\\d{1,' + MAX_SAFE_COMPONENT_LENGTH + '}))?' + - '(?:\\.(\\d{1,' + MAX_SAFE_COMPONENT_LENGTH + '}))?' + - '(?:$|[^\\d])'; - -// Tilde ranges. -// Meaning is "reasonably at or greater than" -var LONETILDE = R++; -src[LONETILDE] = '(?:~>?)'; - -var TILDETRIM = R++; -src[TILDETRIM] = '(\\s*)' + src[LONETILDE] + '\\s+'; -re[TILDETRIM] = new RegExp(src[TILDETRIM], 'g'); -var tildeTrimReplace = '$1~'; - -var TILDE = R++; -src[TILDE] = '^' + src[LONETILDE] + src[XRANGEPLAIN] + '$'; -var TILDELOOSE = R++; -src[TILDELOOSE] = '^' + src[LONETILDE] + src[XRANGEPLAINLOOSE] + '$'; - -// Caret ranges. -// Meaning is "at least and backwards compatible with" -var LONECARET = R++; -src[LONECARET] = '(?:\\^)'; - -var CARETTRIM = R++; -src[CARETTRIM] = '(\\s*)' + src[LONECARET] + '\\s+'; -re[CARETTRIM] = new RegExp(src[CARETTRIM], 'g'); -var caretTrimReplace = '$1^'; - -var CARET = R++; -src[CARET] = '^' + src[LONECARET] + src[XRANGEPLAIN] + '$'; -var CARETLOOSE = R++; -src[CARETLOOSE] = '^' + src[LONECARET] + src[XRANGEPLAINLOOSE] + '$'; - -// A simple gt/lt/eq thing, or just "" to indicate "any version" -var COMPARATORLOOSE = R++; -src[COMPARATORLOOSE] = '^' + src[GTLT] + '\\s*(' + LOOSEPLAIN + ')$|^$'; -var COMPARATOR = R++; -src[COMPARATOR] = '^' + src[GTLT] + '\\s*(' + FULLPLAIN + ')$|^$'; - - -// An expression to strip any whitespace between the gtlt and the thing -// it modifies, so that `> 1.2.3` ==> `>1.2.3` -var COMPARATORTRIM = R++; -src[COMPARATORTRIM] = '(\\s*)' + src[GTLT] + - '\\s*(' + LOOSEPLAIN + '|' + src[XRANGEPLAIN] + ')'; - -// this one has to use the /g flag -re[COMPARATORTRIM] = new RegExp(src[COMPARATORTRIM], 'g'); -var comparatorTrimReplace = '$1$2$3'; - - -// Something like `1.2.3 - 1.2.4` -// Note that these all use the loose form, because they'll be -// checked against either the strict or loose comparator form -// later. -var HYPHENRANGE = R++; -src[HYPHENRANGE] = '^\\s*(' + src[XRANGEPLAIN] + ')' + - '\\s+-\\s+' + - '(' + src[XRANGEPLAIN] + ')' + - '\\s*$'; - -var HYPHENRANGELOOSE = R++; -src[HYPHENRANGELOOSE] = '^\\s*(' + src[XRANGEPLAINLOOSE] + ')' + - '\\s+-\\s+' + - '(' + src[XRANGEPLAINLOOSE] + ')' + - '\\s*$'; - -// Star ranges basically just allow anything at all. -var STAR = R++; -src[STAR] = '(<|>)?=?\\s*\\*'; - -// Compile to actual regexp objects. -// All are flag-free, unless they were created above with a flag. -for (var i = 0; i < R; i++) { - debug(i, src[i]); - if (!re[i]) - re[i] = new RegExp(src[i]); -} - -exports.parse = parse; -function parse(version, loose) { - if (version instanceof SemVer) - return version; - - if (typeof version !== 'string') - return null; - - if (version.length > MAX_LENGTH) - return null; - - var r = loose ? re[LOOSE] : re[FULL]; - if (!r.test(version)) - return null; - - try { - return new SemVer(version, loose); - } catch (er) { - return null; - } -} - -exports.valid = valid; -function valid(version, loose) { - var v = parse(version, loose); - return v ? v.version : null; -} - - -exports.clean = clean; -function clean(version, loose) { - var s = parse(version.trim().replace(/^[=v]+/, ''), loose); - return s ? s.version : null; -} - -exports.SemVer = SemVer; - -function SemVer(version, loose) { - if (version instanceof SemVer) { - if (version.loose === loose) - return version; - else - version = version.version; - } else if (typeof version !== 'string') { - throw new TypeError('Invalid Version: ' + version); - } - - if (version.length > MAX_LENGTH) - throw new TypeError('version is longer than ' + MAX_LENGTH + ' characters') - - if (!(this instanceof SemVer)) - return new SemVer(version, loose); - - debug('SemVer', version, loose); - this.loose = loose; - var m = version.trim().match(loose ? re[LOOSE] : re[FULL]); - - if (!m) - throw new TypeError('Invalid Version: ' + version); - - this.raw = version; - - // these are actually numbers - this.major = +m[1]; - this.minor = +m[2]; - this.patch = +m[3]; - - if (this.major > MAX_SAFE_INTEGER || this.major < 0) - throw new TypeError('Invalid major version') - - if (this.minor > MAX_SAFE_INTEGER || this.minor < 0) - throw new TypeError('Invalid minor version') - - if (this.patch > MAX_SAFE_INTEGER || this.patch < 0) - throw new TypeError('Invalid patch version') - - // numberify any prerelease numeric ids - if (!m[4]) - this.prerelease = []; - else - this.prerelease = m[4].split('.').map(function(id) { - if (/^[0-9]+$/.test(id)) { - var num = +id; - if (num >= 0 && num < MAX_SAFE_INTEGER) - return num; - } - return id; - }); - - this.build = m[5] ? m[5].split('.') : []; - this.format(); -} - -SemVer.prototype.format = function() { - this.version = this.major + '.' + this.minor + '.' + this.patch; - if (this.prerelease.length) - this.version += '-' + this.prerelease.join('.'); - return this.version; -}; - -SemVer.prototype.toString = function() { - return this.version; -}; - -SemVer.prototype.compare = function(other) { - debug('SemVer.compare', this.version, this.loose, other); - if (!(other instanceof SemVer)) - other = new SemVer(other, this.loose); - - return this.compareMain(other) || this.comparePre(other); -}; - -SemVer.prototype.compareMain = function(other) { - if (!(other instanceof SemVer)) - other = new SemVer(other, this.loose); - - return compareIdentifiers(this.major, other.major) || - compareIdentifiers(this.minor, other.minor) || - compareIdentifiers(this.patch, other.patch); -}; - -SemVer.prototype.comparePre = function(other) { - if (!(other instanceof SemVer)) - other = new SemVer(other, this.loose); - - // NOT having a prerelease is > having one - if (this.prerelease.length && !other.prerelease.length) - return -1; - else if (!this.prerelease.length && other.prerelease.length) - return 1; - else if (!this.prerelease.length && !other.prerelease.length) - return 0; - - var i = 0; - do { - var a = this.prerelease[i]; - var b = other.prerelease[i]; - debug('prerelease compare', i, a, b); - if (a === undefined && b === undefined) - return 0; - else if (b === undefined) - return 1; - else if (a === undefined) - return -1; - else if (a === b) - continue; - else - return compareIdentifiers(a, b); - } while (++i); -}; - -// preminor will bump the version up to the next minor release, and immediately -// down to pre-release. premajor and prepatch work the same way. -SemVer.prototype.inc = function(release, identifier) { - switch (release) { - case 'premajor': - this.prerelease.length = 0; - this.patch = 0; - this.minor = 0; - this.major++; - this.inc('pre', identifier); - break; - case 'preminor': - this.prerelease.length = 0; - this.patch = 0; - this.minor++; - this.inc('pre', identifier); - break; - case 'prepatch': - // If this is already a prerelease, it will bump to the next version - // drop any prereleases that might already exist, since they are not - // relevant at this point. - this.prerelease.length = 0; - this.inc('patch', identifier); - this.inc('pre', identifier); - break; - // If the input is a non-prerelease version, this acts the same as - // prepatch. - case 'prerelease': - if (this.prerelease.length === 0) - this.inc('patch', identifier); - this.inc('pre', identifier); - break; - - case 'major': - // If this is a pre-major version, bump up to the same major version. - // Otherwise increment major. - // 1.0.0-5 bumps to 1.0.0 - // 1.1.0 bumps to 2.0.0 - if (this.minor !== 0 || this.patch !== 0 || this.prerelease.length === 0) - this.major++; - this.minor = 0; - this.patch = 0; - this.prerelease = []; - break; - case 'minor': - // If this is a pre-minor version, bump up to the same minor version. - // Otherwise increment minor. - // 1.2.0-5 bumps to 1.2.0 - // 1.2.1 bumps to 1.3.0 - if (this.patch !== 0 || this.prerelease.length === 0) - this.minor++; - this.patch = 0; - this.prerelease = []; - break; - case 'patch': - // If this is not a pre-release version, it will increment the patch. - // If it is a pre-release it will bump up to the same patch version. - // 1.2.0-5 patches to 1.2.0 - // 1.2.0 patches to 1.2.1 - if (this.prerelease.length === 0) - this.patch++; - this.prerelease = []; - break; - // This probably shouldn't be used publicly. - // 1.0.0 "pre" would become 1.0.0-0 which is the wrong direction. - case 'pre': - if (this.prerelease.length === 0) - this.prerelease = [0]; - else { - var i = this.prerelease.length; - while (--i >= 0) { - if (typeof this.prerelease[i] === 'number') { - this.prerelease[i]++; - i = -2; - } - } - if (i === -1) // didn't increment anything - this.prerelease.push(0); - } - if (identifier) { - // 1.2.0-beta.1 bumps to 1.2.0-beta.2, - // 1.2.0-beta.fooblz or 1.2.0-beta bumps to 1.2.0-beta.0 - if (this.prerelease[0] === identifier) { - if (isNaN(this.prerelease[1])) - this.prerelease = [identifier, 0]; - } else - this.prerelease = [identifier, 0]; - } - break; - - default: - throw new Error('invalid increment argument: ' + release); - } - this.format(); - this.raw = this.version; - return this; -}; - -exports.inc = inc; -function inc(version, release, loose, identifier) { - if (typeof(loose) === 'string') { - identifier = loose; - loose = undefined; - } - - try { - return new SemVer(version, loose).inc(release, identifier).version; - } catch (er) { - return null; - } -} - -exports.diff = diff; -function diff(version1, version2) { - if (eq(version1, version2)) { - return null; - } else { - var v1 = parse(version1); - var v2 = parse(version2); - if (v1.prerelease.length || v2.prerelease.length) { - for (var key in v1) { - if (key === 'major' || key === 'minor' || key === 'patch') { - if (v1[key] !== v2[key]) { - return 'pre'+key; - } - } - } - return 'prerelease'; - } - for (var key in v1) { - if (key === 'major' || key === 'minor' || key === 'patch') { - if (v1[key] !== v2[key]) { - return key; - } - } - } - } -} - -exports.compareIdentifiers = compareIdentifiers; - -var numeric = /^[0-9]+$/; -function compareIdentifiers(a, b) { - var anum = numeric.test(a); - var bnum = numeric.test(b); - - if (anum && bnum) { - a = +a; - b = +b; - } - - return (anum && !bnum) ? -1 : - (bnum && !anum) ? 1 : - a < b ? -1 : - a > b ? 1 : - 0; -} - -exports.rcompareIdentifiers = rcompareIdentifiers; -function rcompareIdentifiers(a, b) { - return compareIdentifiers(b, a); -} - -exports.major = major; -function major(a, loose) { - return new SemVer(a, loose).major; -} - -exports.minor = minor; -function minor(a, loose) { - return new SemVer(a, loose).minor; -} - -exports.patch = patch; -function patch(a, loose) { - return new SemVer(a, loose).patch; -} - -exports.compare = compare; -function compare(a, b, loose) { - return new SemVer(a, loose).compare(new SemVer(b, loose)); -} - -exports.compareLoose = compareLoose; -function compareLoose(a, b) { - return compare(a, b, true); -} - -exports.rcompare = rcompare; -function rcompare(a, b, loose) { - return compare(b, a, loose); -} - -exports.sort = sort; -function sort(list, loose) { - return list.sort(function(a, b) { - return exports.compare(a, b, loose); - }); -} - -exports.rsort = rsort; -function rsort(list, loose) { - return list.sort(function(a, b) { - return exports.rcompare(a, b, loose); - }); -} - -exports.gt = gt; -function gt(a, b, loose) { - return compare(a, b, loose) > 0; -} - -exports.lt = lt; -function lt(a, b, loose) { - return compare(a, b, loose) < 0; -} - -exports.eq = eq; -function eq(a, b, loose) { - return compare(a, b, loose) === 0; -} - -exports.neq = neq; -function neq(a, b, loose) { - return compare(a, b, loose) !== 0; -} - -exports.gte = gte; -function gte(a, b, loose) { - return compare(a, b, loose) >= 0; -} - -exports.lte = lte; -function lte(a, b, loose) { - return compare(a, b, loose) <= 0; -} - -exports.cmp = cmp; -function cmp(a, op, b, loose) { - var ret; - switch (op) { - case '===': - if (typeof a === 'object') a = a.version; - if (typeof b === 'object') b = b.version; - ret = a === b; - break; - case '!==': - if (typeof a === 'object') a = a.version; - if (typeof b === 'object') b = b.version; - ret = a !== b; - break; - case '': case '=': case '==': ret = eq(a, b, loose); break; - case '!=': ret = neq(a, b, loose); break; - case '>': ret = gt(a, b, loose); break; - case '>=': ret = gte(a, b, loose); break; - case '<': ret = lt(a, b, loose); break; - case '<=': ret = lte(a, b, loose); break; - default: throw new TypeError('Invalid operator: ' + op); - } - return ret; -} - -exports.Comparator = Comparator; -function Comparator(comp, loose) { - if (comp instanceof Comparator) { - if (comp.loose === loose) - return comp; - else - comp = comp.value; - } - - if (!(this instanceof Comparator)) - return new Comparator(comp, loose); - - debug('comparator', comp, loose); - this.loose = loose; - this.parse(comp); - - if (this.semver === ANY) - this.value = ''; - else - this.value = this.operator + this.semver.version; - - debug('comp', this); -} - -var ANY = {}; -Comparator.prototype.parse = function(comp) { - var r = this.loose ? re[COMPARATORLOOSE] : re[COMPARATOR]; - var m = comp.match(r); - - if (!m) - throw new TypeError('Invalid comparator: ' + comp); - - this.operator = m[1]; - if (this.operator === '=') - this.operator = ''; - - // if it literally is just '>' or '' then allow anything. - if (!m[2]) - this.semver = ANY; - else - this.semver = new SemVer(m[2], this.loose); -}; - -Comparator.prototype.toString = function() { - return this.value; -}; - -Comparator.prototype.test = function(version) { - debug('Comparator.test', version, this.loose); - - if (this.semver === ANY) - return true; - - if (typeof version === 'string') - version = new SemVer(version, this.loose); - - return cmp(version, this.operator, this.semver, this.loose); -}; - -Comparator.prototype.intersects = function(comp, loose) { - if (!(comp instanceof Comparator)) { - throw new TypeError('a Comparator is required'); - } - - var rangeTmp; - - if (this.operator === '') { - rangeTmp = new Range(comp.value, loose); - return satisfies(this.value, rangeTmp, loose); - } else if (comp.operator === '') { - rangeTmp = new Range(this.value, loose); - return satisfies(comp.semver, rangeTmp, loose); - } - - var sameDirectionIncreasing = - (this.operator === '>=' || this.operator === '>') && - (comp.operator === '>=' || comp.operator === '>'); - var sameDirectionDecreasing = - (this.operator === '<=' || this.operator === '<') && - (comp.operator === '<=' || comp.operator === '<'); - var sameSemVer = this.semver.version === comp.semver.version; - var differentDirectionsInclusive = - (this.operator === '>=' || this.operator === '<=') && - (comp.operator === '>=' || comp.operator === '<='); - var oppositeDirectionsLessThan = - cmp(this.semver, '<', comp.semver, loose) && - ((this.operator === '>=' || this.operator === '>') && - (comp.operator === '<=' || comp.operator === '<')); - var oppositeDirectionsGreaterThan = - cmp(this.semver, '>', comp.semver, loose) && - ((this.operator === '<=' || this.operator === '<') && - (comp.operator === '>=' || comp.operator === '>')); - - return sameDirectionIncreasing || sameDirectionDecreasing || - (sameSemVer && differentDirectionsInclusive) || - oppositeDirectionsLessThan || oppositeDirectionsGreaterThan; -}; - - -exports.Range = Range; -function Range(range, loose) { - if (range instanceof Range) { - if (range.loose === loose) { - return range; - } else { - return new Range(range.raw, loose); - } - } - - if (range instanceof Comparator) { - return new Range(range.value, loose); - } - - if (!(this instanceof Range)) - return new Range(range, loose); - - this.loose = loose; - - // First, split based on boolean or || - this.raw = range; - this.set = range.split(/\s*\|\|\s*/).map(function(range) { - return this.parseRange(range.trim()); - }, this).filter(function(c) { - // throw out any that are not relevant for whatever reason - return c.length; - }); - - if (!this.set.length) { - throw new TypeError('Invalid SemVer Range: ' + range); - } - - this.format(); -} - -Range.prototype.format = function() { - this.range = this.set.map(function(comps) { - return comps.join(' ').trim(); - }).join('||').trim(); - return this.range; -}; - -Range.prototype.toString = function() { - return this.range; -}; - -Range.prototype.parseRange = function(range) { - var loose = this.loose; - range = range.trim(); - debug('range', range, loose); - // `1.2.3 - 1.2.4` => `>=1.2.3 <=1.2.4` - var hr = loose ? re[HYPHENRANGELOOSE] : re[HYPHENRANGE]; - range = range.replace(hr, hyphenReplace); - debug('hyphen replace', range); - // `> 1.2.3 < 1.2.5` => `>1.2.3 <1.2.5` - range = range.replace(re[COMPARATORTRIM], comparatorTrimReplace); - debug('comparator trim', range, re[COMPARATORTRIM]); - - // `~ 1.2.3` => `~1.2.3` - range = range.replace(re[TILDETRIM], tildeTrimReplace); - - // `^ 1.2.3` => `^1.2.3` - range = range.replace(re[CARETTRIM], caretTrimReplace); - - // normalize spaces - range = range.split(/\s+/).join(' '); - - // At this point, the range is completely trimmed and - // ready to be split into comparators. - - var compRe = loose ? re[COMPARATORLOOSE] : re[COMPARATOR]; - var set = range.split(' ').map(function(comp) { - return parseComparator(comp, loose); - }).join(' ').split(/\s+/); - if (this.loose) { - // in loose mode, throw out any that are not valid comparators - set = set.filter(function(comp) { - return !!comp.match(compRe); - }); - } - set = set.map(function(comp) { - return new Comparator(comp, loose); - }); - - return set; -}; - -Range.prototype.intersects = function(range, loose) { - if (!(range instanceof Range)) { - throw new TypeError('a Range is required'); - } - - return this.set.some(function(thisComparators) { - return thisComparators.every(function(thisComparator) { - return range.set.some(function(rangeComparators) { - return rangeComparators.every(function(rangeComparator) { - return thisComparator.intersects(rangeComparator, loose); - }); - }); - }); - }); -}; - -// Mostly just for testing and legacy API reasons -exports.toComparators = toComparators; -function toComparators(range, loose) { - return new Range(range, loose).set.map(function(comp) { - return comp.map(function(c) { - return c.value; - }).join(' ').trim().split(' '); - }); -} - -// comprised of xranges, tildes, stars, and gtlt's at this point. -// already replaced the hyphen ranges -// turn into a set of JUST comparators. -function parseComparator(comp, loose) { - debug('comp', comp); - comp = replaceCarets(comp, loose); - debug('caret', comp); - comp = replaceTildes(comp, loose); - debug('tildes', comp); - comp = replaceXRanges(comp, loose); - debug('xrange', comp); - comp = replaceStars(comp, loose); - debug('stars', comp); - return comp; -} - -function isX(id) { - return !id || id.toLowerCase() === 'x' || id === '*'; -} - -// ~, ~> --> * (any, kinda silly) -// ~2, ~2.x, ~2.x.x, ~>2, ~>2.x ~>2.x.x --> >=2.0.0 <3.0.0 -// ~2.0, ~2.0.x, ~>2.0, ~>2.0.x --> >=2.0.0 <2.1.0 -// ~1.2, ~1.2.x, ~>1.2, ~>1.2.x --> >=1.2.0 <1.3.0 -// ~1.2.3, ~>1.2.3 --> >=1.2.3 <1.3.0 -// ~1.2.0, ~>1.2.0 --> >=1.2.0 <1.3.0 -function replaceTildes(comp, loose) { - return comp.trim().split(/\s+/).map(function(comp) { - return replaceTilde(comp, loose); - }).join(' '); -} - -function replaceTilde(comp, loose) { - var r = loose ? re[TILDELOOSE] : re[TILDE]; - return comp.replace(r, function(_, M, m, p, pr) { - debug('tilde', comp, _, M, m, p, pr); - var ret; - - if (isX(M)) - ret = ''; - else if (isX(m)) - ret = '>=' + M + '.0.0 <' + (+M + 1) + '.0.0'; - else if (isX(p)) - // ~1.2 == >=1.2.0 <1.3.0 - ret = '>=' + M + '.' + m + '.0 <' + M + '.' + (+m + 1) + '.0'; - else if (pr) { - debug('replaceTilde pr', pr); - if (pr.charAt(0) !== '-') - pr = '-' + pr; - ret = '>=' + M + '.' + m + '.' + p + pr + - ' <' + M + '.' + (+m + 1) + '.0'; - } else - // ~1.2.3 == >=1.2.3 <1.3.0 - ret = '>=' + M + '.' + m + '.' + p + - ' <' + M + '.' + (+m + 1) + '.0'; - - debug('tilde return', ret); - return ret; - }); -} - -// ^ --> * (any, kinda silly) -// ^2, ^2.x, ^2.x.x --> >=2.0.0 <3.0.0 -// ^2.0, ^2.0.x --> >=2.0.0 <3.0.0 -// ^1.2, ^1.2.x --> >=1.2.0 <2.0.0 -// ^1.2.3 --> >=1.2.3 <2.0.0 -// ^1.2.0 --> >=1.2.0 <2.0.0 -function replaceCarets(comp, loose) { - return comp.trim().split(/\s+/).map(function(comp) { - return replaceCaret(comp, loose); - }).join(' '); -} - -function replaceCaret(comp, loose) { - debug('caret', comp, loose); - var r = loose ? re[CARETLOOSE] : re[CARET]; - return comp.replace(r, function(_, M, m, p, pr) { - debug('caret', comp, _, M, m, p, pr); - var ret; - - if (isX(M)) - ret = ''; - else if (isX(m)) - ret = '>=' + M + '.0.0 <' + (+M + 1) + '.0.0'; - else if (isX(p)) { - if (M === '0') - ret = '>=' + M + '.' + m + '.0 <' + M + '.' + (+m + 1) + '.0'; - else - ret = '>=' + M + '.' + m + '.0 <' + (+M + 1) + '.0.0'; - } else if (pr) { - debug('replaceCaret pr', pr); - if (pr.charAt(0) !== '-') - pr = '-' + pr; - if (M === '0') { - if (m === '0') - ret = '>=' + M + '.' + m + '.' + p + pr + - ' <' + M + '.' + m + '.' + (+p + 1); - else - ret = '>=' + M + '.' + m + '.' + p + pr + - ' <' + M + '.' + (+m + 1) + '.0'; - } else - ret = '>=' + M + '.' + m + '.' + p + pr + - ' <' + (+M + 1) + '.0.0'; - } else { - debug('no pr'); - if (M === '0') { - if (m === '0') - ret = '>=' + M + '.' + m + '.' + p + - ' <' + M + '.' + m + '.' + (+p + 1); - else - ret = '>=' + M + '.' + m + '.' + p + - ' <' + M + '.' + (+m + 1) + '.0'; - } else - ret = '>=' + M + '.' + m + '.' + p + - ' <' + (+M + 1) + '.0.0'; - } - - debug('caret return', ret); - return ret; - }); -} - -function replaceXRanges(comp, loose) { - debug('replaceXRanges', comp, loose); - return comp.split(/\s+/).map(function(comp) { - return replaceXRange(comp, loose); - }).join(' '); -} - -function replaceXRange(comp, loose) { - comp = comp.trim(); - var r = loose ? re[XRANGELOOSE] : re[XRANGE]; - return comp.replace(r, function(ret, gtlt, M, m, p, pr) { - debug('xRange', comp, ret, gtlt, M, m, p, pr); - var xM = isX(M); - var xm = xM || isX(m); - var xp = xm || isX(p); - var anyX = xp; - - if (gtlt === '=' && anyX) - gtlt = ''; - - if (xM) { - if (gtlt === '>' || gtlt === '<') { - // nothing is allowed - ret = '<0.0.0'; - } else { - // nothing is forbidden - ret = '*'; - } - } else if (gtlt && anyX) { - // replace X with 0 - if (xm) - m = 0; - if (xp) - p = 0; - - if (gtlt === '>') { - // >1 => >=2.0.0 - // >1.2 => >=1.3.0 - // >1.2.3 => >= 1.2.4 - gtlt = '>='; - if (xm) { - M = +M + 1; - m = 0; - p = 0; - } else if (xp) { - m = +m + 1; - p = 0; - } - } else if (gtlt === '<=') { - // <=0.7.x is actually <0.8.0, since any 0.7.x should - // pass. Similarly, <=7.x is actually <8.0.0, etc. - gtlt = '<'; - if (xm) - M = +M + 1; - else - m = +m + 1; - } - - ret = gtlt + M + '.' + m + '.' + p; - } else if (xm) { - ret = '>=' + M + '.0.0 <' + (+M + 1) + '.0.0'; - } else if (xp) { - ret = '>=' + M + '.' + m + '.0 <' + M + '.' + (+m + 1) + '.0'; - } - - debug('xRange return', ret); - - return ret; - }); -} - -// Because * is AND-ed with everything else in the comparator, -// and '' means "any version", just remove the *s entirely. -function replaceStars(comp, loose) { - debug('replaceStars', comp, loose); - // Looseness is ignored here. star is always as loose as it gets! - return comp.trim().replace(re[STAR], ''); -} - -// This function is passed to string.replace(re[HYPHENRANGE]) -// M, m, patch, prerelease, build -// 1.2 - 3.4.5 => >=1.2.0 <=3.4.5 -// 1.2.3 - 3.4 => >=1.2.0 <3.5.0 Any 3.4.x will do -// 1.2 - 3.4 => >=1.2.0 <3.5.0 -function hyphenReplace($0, - from, fM, fm, fp, fpr, fb, - to, tM, tm, tp, tpr, tb) { - - if (isX(fM)) - from = ''; - else if (isX(fm)) - from = '>=' + fM + '.0.0'; - else if (isX(fp)) - from = '>=' + fM + '.' + fm + '.0'; - else - from = '>=' + from; - - if (isX(tM)) - to = ''; - else if (isX(tm)) - to = '<' + (+tM + 1) + '.0.0'; - else if (isX(tp)) - to = '<' + tM + '.' + (+tm + 1) + '.0'; - else if (tpr) - to = '<=' + tM + '.' + tm + '.' + tp + '-' + tpr; - else - to = '<=' + to; - - return (from + ' ' + to).trim(); -} - - -// if ANY of the sets match ALL of its comparators, then pass -Range.prototype.test = function(version) { - if (!version) - return false; - - if (typeof version === 'string') - version = new SemVer(version, this.loose); - - for (var i = 0; i < this.set.length; i++) { - if (testSet(this.set[i], version)) - return true; - } - return false; -}; - -function testSet(set, version) { - for (var i = 0; i < set.length; i++) { - if (!set[i].test(version)) - return false; - } - - if (version.prerelease.length) { - // Find the set of versions that are allowed to have prereleases - // For example, ^1.2.3-pr.1 desugars to >=1.2.3-pr.1 <2.0.0 - // That should allow `1.2.3-pr.2` to pass. - // However, `1.2.4-alpha.notready` should NOT be allowed, - // even though it's within the range set by the comparators. - for (var i = 0; i < set.length; i++) { - debug(set[i].semver); - if (set[i].semver === ANY) - continue; - - if (set[i].semver.prerelease.length > 0) { - var allowed = set[i].semver; - if (allowed.major === version.major && - allowed.minor === version.minor && - allowed.patch === version.patch) - return true; - } - } - - // Version has a -pre, but it's not one of the ones we like. - return false; - } - - return true; -} - -exports.satisfies = satisfies; -function satisfies(version, range, loose) { - try { - range = new Range(range, loose); - } catch (er) { - return false; - } - return range.test(version); -} - -exports.maxSatisfying = maxSatisfying; -function maxSatisfying(versions, range, loose) { - var max = null; - var maxSV = null; - try { - var rangeObj = new Range(range, loose); - } catch (er) { - return null; - } - versions.forEach(function (v) { - if (rangeObj.test(v)) { // satisfies(v, range, loose) - if (!max || maxSV.compare(v) === -1) { // compare(max, v, true) - max = v; - maxSV = new SemVer(max, loose); - } - } - }) - return max; -} - -exports.minSatisfying = minSatisfying; -function minSatisfying(versions, range, loose) { - var min = null; - var minSV = null; - try { - var rangeObj = new Range(range, loose); - } catch (er) { - return null; - } - versions.forEach(function (v) { - if (rangeObj.test(v)) { // satisfies(v, range, loose) - if (!min || minSV.compare(v) === 1) { // compare(min, v, true) - min = v; - minSV = new SemVer(min, loose); - } - } - }) - return min; -} - -exports.validRange = validRange; -function validRange(range, loose) { - try { - // Return '*' instead of '' so that truthiness works. - // This will throw if it's invalid anyway - return new Range(range, loose).range || '*'; - } catch (er) { - return null; - } -} - -// Determine if version is less than all the versions possible in the range -exports.ltr = ltr; -function ltr(version, range, loose) { - return outside(version, range, '<', loose); -} - -// Determine if version is greater than all the versions possible in the range. -exports.gtr = gtr; -function gtr(version, range, loose) { - return outside(version, range, '>', loose); -} - -exports.outside = outside; -function outside(version, range, hilo, loose) { - version = new SemVer(version, loose); - range = new Range(range, loose); - - var gtfn, ltefn, ltfn, comp, ecomp; - switch (hilo) { - case '>': - gtfn = gt; - ltefn = lte; - ltfn = lt; - comp = '>'; - ecomp = '>='; - break; - case '<': - gtfn = lt; - ltefn = gte; - ltfn = gt; - comp = '<'; - ecomp = '<='; - break; - default: - throw new TypeError('Must provide a hilo val of "<" or ">"'); - } - - // If it satisifes the range it is not outside - if (satisfies(version, range, loose)) { - return false; - } - - // From now on, variable terms are as if we're in "gtr" mode. - // but note that everything is flipped for the "ltr" function. - - for (var i = 0; i < range.set.length; ++i) { - var comparators = range.set[i]; - - var high = null; - var low = null; - - comparators.forEach(function(comparator) { - if (comparator.semver === ANY) { - comparator = new Comparator('>=0.0.0') - } - high = high || comparator; - low = low || comparator; - if (gtfn(comparator.semver, high.semver, loose)) { - high = comparator; - } else if (ltfn(comparator.semver, low.semver, loose)) { - low = comparator; - } - }); - - // If the edge version comparator has a operator then our version - // isn't outside it - if (high.operator === comp || high.operator === ecomp) { - return false; - } - - // If the lowest version comparator has an operator and our version - // is less than it then it isn't higher than the range - if ((!low.operator || low.operator === comp) && - ltefn(version, low.semver)) { - return false; - } else if (low.operator === ecomp && ltfn(version, low.semver)) { - return false; - } - } - return true; -} - -exports.prerelease = prerelease; -function prerelease(version, loose) { - var parsed = parse(version, loose); - return (parsed && parsed.prerelease.length) ? parsed.prerelease : null; -} - -exports.intersects = intersects; -function intersects(r1, r2, loose) { - r1 = new Range(r1, loose) - r2 = new Range(r2, loose) - return r1.intersects(r2) -} - -exports.coerce = coerce; -function coerce(version) { - if (version instanceof SemVer) - return version; - - if (typeof version !== 'string') - return null; - - var match = version.match(re[COERCE]); - - if (match == null) - return null; - - return parse((match[1] || '0') + '.' + (match[2] || '0') + '.' + (match[3] || '0')); -} - - -/***/ }), -/* 23 */ -/***/ (function(module, exports) { - -module.exports = require("stream"); - -/***/ }), -/* 24 */ -/***/ (function(module, exports) { - -module.exports = require("url"); - -/***/ }), -/* 25 */ -/***/ (function(module, __webpack_exports__, __webpack_require__) { - -"use strict"; -/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return Subscription; }); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_0__util_isArray__ = __webpack_require__(41); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_1__util_isObject__ = __webpack_require__(444); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_2__util_isFunction__ = __webpack_require__(155); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_3__util_tryCatch__ = __webpack_require__(57); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_4__util_errorObject__ = __webpack_require__(48); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_5__util_UnsubscriptionError__ = __webpack_require__(441); -/** PURE_IMPORTS_START _util_isArray,_util_isObject,_util_isFunction,_util_tryCatch,_util_errorObject,_util_UnsubscriptionError PURE_IMPORTS_END */ - - - - - - -var Subscription = /*@__PURE__*/ (function () { - function Subscription(unsubscribe) { - this.closed = false; - this._parent = null; - this._parents = null; - this._subscriptions = null; - if (unsubscribe) { - this._unsubscribe = unsubscribe; - } - } - Subscription.prototype.unsubscribe = function () { - var hasErrors = false; - var errors; - if (this.closed) { - return; - } - var _a = this, _parent = _a._parent, _parents = _a._parents, _unsubscribe = _a._unsubscribe, _subscriptions = _a._subscriptions; - this.closed = true; - this._parent = null; - this._parents = null; - this._subscriptions = null; - var index = -1; - var len = _parents ? _parents.length : 0; - while (_parent) { - _parent.remove(this); - _parent = ++index < len && _parents[index] || null; - } - if (__webpack_require__.i(__WEBPACK_IMPORTED_MODULE_2__util_isFunction__["a" /* isFunction */])(_unsubscribe)) { - var trial = __webpack_require__.i(__WEBPACK_IMPORTED_MODULE_3__util_tryCatch__["a" /* tryCatch */])(_unsubscribe).call(this); - if (trial === __WEBPACK_IMPORTED_MODULE_4__util_errorObject__["a" /* errorObject */]) { - hasErrors = true; - errors = errors || (__WEBPACK_IMPORTED_MODULE_4__util_errorObject__["a" /* errorObject */].e instanceof __WEBPACK_IMPORTED_MODULE_5__util_UnsubscriptionError__["a" /* UnsubscriptionError */] ? - flattenUnsubscriptionErrors(__WEBPACK_IMPORTED_MODULE_4__util_errorObject__["a" /* errorObject */].e.errors) : [__WEBPACK_IMPORTED_MODULE_4__util_errorObject__["a" /* errorObject */].e]); - } - } - if (__webpack_require__.i(__WEBPACK_IMPORTED_MODULE_0__util_isArray__["a" /* isArray */])(_subscriptions)) { - index = -1; - len = _subscriptions.length; - while (++index < len) { - var sub = _subscriptions[index]; - if (__webpack_require__.i(__WEBPACK_IMPORTED_MODULE_1__util_isObject__["a" /* isObject */])(sub)) { - var trial = __webpack_require__.i(__WEBPACK_IMPORTED_MODULE_3__util_tryCatch__["a" /* tryCatch */])(sub.unsubscribe).call(sub); - if (trial === __WEBPACK_IMPORTED_MODULE_4__util_errorObject__["a" /* errorObject */]) { - hasErrors = true; - errors = errors || []; - var err = __WEBPACK_IMPORTED_MODULE_4__util_errorObject__["a" /* errorObject */].e; - if (err instanceof __WEBPACK_IMPORTED_MODULE_5__util_UnsubscriptionError__["a" /* UnsubscriptionError */]) { - errors = errors.concat(flattenUnsubscriptionErrors(err.errors)); - } - else { - errors.push(err); - } - } - } - } - } - if (hasErrors) { - throw new __WEBPACK_IMPORTED_MODULE_5__util_UnsubscriptionError__["a" /* UnsubscriptionError */](errors); - } - }; - Subscription.prototype.add = function (teardown) { - if (!teardown || (teardown === Subscription.EMPTY)) { - return Subscription.EMPTY; - } - if (teardown === this) { - return this; - } - var subscription = teardown; - switch (typeof teardown) { - case 'function': - subscription = new Subscription(teardown); - case 'object': - if (subscription.closed || typeof subscription.unsubscribe !== 'function') { - return subscription; - } - else if (this.closed) { - subscription.unsubscribe(); - return subscription; - } - else if (typeof subscription._addParent !== 'function') { - var tmp = subscription; - subscription = new Subscription(); - subscription._subscriptions = [tmp]; - } - break; - default: - throw new Error('unrecognized teardown ' + teardown + ' added to Subscription.'); - } - var subscriptions = this._subscriptions || (this._subscriptions = []); - subscriptions.push(subscription); - subscription._addParent(this); - return subscription; - }; - Subscription.prototype.remove = function (subscription) { - var subscriptions = this._subscriptions; - if (subscriptions) { - var subscriptionIndex = subscriptions.indexOf(subscription); - if (subscriptionIndex !== -1) { - subscriptions.splice(subscriptionIndex, 1); - } - } - }; - Subscription.prototype._addParent = function (parent) { - var _a = this, _parent = _a._parent, _parents = _a._parents; - if (!_parent || _parent === parent) { - this._parent = parent; - } - else if (!_parents) { - this._parents = [parent]; - } - else if (_parents.indexOf(parent) === -1) { - _parents.push(parent); - } - }; - Subscription.EMPTY = (function (empty) { - empty.closed = true; - return empty; - }(new Subscription())); - return Subscription; -}()); - -function flattenUnsubscriptionErrors(errors) { - return errors.reduce(function (errs, err) { return errs.concat((err instanceof __WEBPACK_IMPORTED_MODULE_5__util_UnsubscriptionError__["a" /* UnsubscriptionError */]) ? err.errors : err); }, []); -} -//# sourceMappingURL=Subscription.js.map - - -/***/ }), -/* 26 */ -/***/ (function(module, exports, __webpack_require__) { - -// Copyright 2015 Joyent, Inc. - -module.exports = { - bufferSplit: bufferSplit, - addRSAMissing: addRSAMissing, - calculateDSAPublic: calculateDSAPublic, - calculateED25519Public: calculateED25519Public, - calculateX25519Public: calculateX25519Public, - mpNormalize: mpNormalize, - mpDenormalize: mpDenormalize, - ecNormalize: ecNormalize, - countZeros: countZeros, - assertCompatible: assertCompatible, - isCompatible: isCompatible, - opensslKeyDeriv: opensslKeyDeriv, - opensshCipherInfo: opensshCipherInfo, - publicFromPrivateECDSA: publicFromPrivateECDSA, - zeroPadToLength: zeroPadToLength, - writeBitString: writeBitString, - readBitString: readBitString -}; - -var assert = __webpack_require__(16); -var Buffer = __webpack_require__(15).Buffer; -var PrivateKey = __webpack_require__(33); -var Key = __webpack_require__(28); -var crypto = __webpack_require__(11); -var algs = __webpack_require__(32); -var asn1 = __webpack_require__(66); - -var ec, jsbn; -var nacl; - -var MAX_CLASS_DEPTH = 3; - -function isCompatible(obj, klass, needVer) { - if (obj === null || typeof (obj) !== 'object') - return (false); - if (needVer === undefined) - needVer = klass.prototype._sshpkApiVersion; - if (obj instanceof klass && - klass.prototype._sshpkApiVersion[0] == needVer[0]) - return (true); - var proto = Object.getPrototypeOf(obj); - var depth = 0; - while (proto.constructor.name !== klass.name) { - proto = Object.getPrototypeOf(proto); - if (!proto || ++depth > MAX_CLASS_DEPTH) - return (false); - } - if (proto.constructor.name !== klass.name) - return (false); - var ver = proto._sshpkApiVersion; - if (ver === undefined) - ver = klass._oldVersionDetect(obj); - if (ver[0] != needVer[0] || ver[1] < needVer[1]) - return (false); - return (true); -} - -function assertCompatible(obj, klass, needVer, name) { - if (name === undefined) - name = 'object'; - assert.ok(obj, name + ' must not be null'); - assert.object(obj, name + ' must be an object'); - if (needVer === undefined) - needVer = klass.prototype._sshpkApiVersion; - if (obj instanceof klass && - klass.prototype._sshpkApiVersion[0] == needVer[0]) - return; - var proto = Object.getPrototypeOf(obj); - var depth = 0; - while (proto.constructor.name !== klass.name) { - proto = Object.getPrototypeOf(proto); - assert.ok(proto && ++depth <= MAX_CLASS_DEPTH, - name + ' must be a ' + klass.name + ' instance'); - } - assert.strictEqual(proto.constructor.name, klass.name, - name + ' must be a ' + klass.name + ' instance'); - var ver = proto._sshpkApiVersion; - if (ver === undefined) - ver = klass._oldVersionDetect(obj); - assert.ok(ver[0] == needVer[0] && ver[1] >= needVer[1], - name + ' must be compatible with ' + klass.name + ' klass ' + - 'version ' + needVer[0] + '.' + needVer[1]); -} - -var CIPHER_LEN = { - 'des-ede3-cbc': { key: 7, iv: 8 }, - 'aes-128-cbc': { key: 16, iv: 16 } -}; -var PKCS5_SALT_LEN = 8; - -function opensslKeyDeriv(cipher, salt, passphrase, count) { - assert.buffer(salt, 'salt'); - assert.buffer(passphrase, 'passphrase'); - assert.number(count, 'iteration count'); - - var clen = CIPHER_LEN[cipher]; - assert.object(clen, 'supported cipher'); - - salt = salt.slice(0, PKCS5_SALT_LEN); - - var D, D_prev, bufs; - var material = Buffer.alloc(0); - while (material.length < clen.key + clen.iv) { - bufs = []; - if (D_prev) - bufs.push(D_prev); - bufs.push(passphrase); - bufs.push(salt); - D = Buffer.concat(bufs); - for (var j = 0; j < count; ++j) - D = crypto.createHash('md5').update(D).digest(); - material = Buffer.concat([material, D]); - D_prev = D; - } - - return ({ - key: material.slice(0, clen.key), - iv: material.slice(clen.key, clen.key + clen.iv) - }); -} - -/* Count leading zero bits on a buffer */ -function countZeros(buf) { - var o = 0, obit = 8; - while (o < buf.length) { - var mask = (1 << obit); - if ((buf[o] & mask) === mask) - break; - obit--; - if (obit < 0) { - o++; - obit = 8; - } - } - return (o*8 + (8 - obit) - 1); -} - -function bufferSplit(buf, chr) { - assert.buffer(buf); - assert.string(chr); - - var parts = []; - var lastPart = 0; - var matches = 0; - for (var i = 0; i < buf.length; ++i) { - if (buf[i] === chr.charCodeAt(matches)) - ++matches; - else if (buf[i] === chr.charCodeAt(0)) - matches = 1; - else - matches = 0; - - if (matches >= chr.length) { - var newPart = i + 1; - parts.push(buf.slice(lastPart, newPart - matches)); - lastPart = newPart; - matches = 0; - } - } - if (lastPart <= buf.length) - parts.push(buf.slice(lastPart, buf.length)); - - return (parts); -} - -function ecNormalize(buf, addZero) { - assert.buffer(buf); - if (buf[0] === 0x00 && buf[1] === 0x04) { - if (addZero) - return (buf); - return (buf.slice(1)); - } else if (buf[0] === 0x04) { - if (!addZero) - return (buf); - } else { - while (buf[0] === 0x00) - buf = buf.slice(1); - if (buf[0] === 0x02 || buf[0] === 0x03) - throw (new Error('Compressed elliptic curve points ' + - 'are not supported')); - if (buf[0] !== 0x04) - throw (new Error('Not a valid elliptic curve point')); - if (!addZero) - return (buf); - } - var b = Buffer.alloc(buf.length + 1); - b[0] = 0x0; - buf.copy(b, 1); - return (b); -} - -function readBitString(der, tag) { - if (tag === undefined) - tag = asn1.Ber.BitString; - var buf = der.readString(tag, true); - assert.strictEqual(buf[0], 0x00, 'bit strings with unused bits are ' + - 'not supported (0x' + buf[0].toString(16) + ')'); - return (buf.slice(1)); -} - -function writeBitString(der, buf, tag) { - if (tag === undefined) - tag = asn1.Ber.BitString; - var b = Buffer.alloc(buf.length + 1); - b[0] = 0x00; - buf.copy(b, 1); - der.writeBuffer(b, tag); -} - -function mpNormalize(buf) { - assert.buffer(buf); - while (buf.length > 1 && buf[0] === 0x00 && (buf[1] & 0x80) === 0x00) - buf = buf.slice(1); - if ((buf[0] & 0x80) === 0x80) { - var b = Buffer.alloc(buf.length + 1); - b[0] = 0x00; - buf.copy(b, 1); - buf = b; - } - return (buf); -} - -function mpDenormalize(buf) { - assert.buffer(buf); - while (buf.length > 1 && buf[0] === 0x00) - buf = buf.slice(1); - return (buf); -} - -function zeroPadToLength(buf, len) { - assert.buffer(buf); - assert.number(len); - while (buf.length > len) { - assert.equal(buf[0], 0x00); - buf = buf.slice(1); - } - while (buf.length < len) { - var b = Buffer.alloc(buf.length + 1); - b[0] = 0x00; - buf.copy(b, 1); - buf = b; - } - return (buf); -} - -function bigintToMpBuf(bigint) { - var buf = Buffer.from(bigint.toByteArray()); - buf = mpNormalize(buf); - return (buf); -} - -function calculateDSAPublic(g, p, x) { - assert.buffer(g); - assert.buffer(p); - assert.buffer(x); - try { - var bigInt = __webpack_require__(81).BigInteger; - } catch (e) { - throw (new Error('To load a PKCS#8 format DSA private key, ' + - 'the node jsbn library is required.')); - } - g = new bigInt(g); - p = new bigInt(p); - x = new bigInt(x); - var y = g.modPow(x, p); - var ybuf = bigintToMpBuf(y); - return (ybuf); -} - -function calculateED25519Public(k) { - assert.buffer(k); - - if (nacl === undefined) - nacl = __webpack_require__(76); - - var kp = nacl.sign.keyPair.fromSeed(new Uint8Array(k)); - return (Buffer.from(kp.publicKey)); -} - -function calculateX25519Public(k) { - assert.buffer(k); - - if (nacl === undefined) - nacl = __webpack_require__(76); - - var kp = nacl.box.keyPair.fromSeed(new Uint8Array(k)); - return (Buffer.from(kp.publicKey)); -} - -function addRSAMissing(key) { - assert.object(key); - assertCompatible(key, PrivateKey, [1, 1]); - try { - var bigInt = __webpack_require__(81).BigInteger; - } catch (e) { - throw (new Error('To write a PEM private key from ' + - 'this source, the node jsbn lib is required.')); - } - - var d = new bigInt(key.part.d.data); - var buf; - - if (!key.part.dmodp) { - var p = new bigInt(key.part.p.data); - var dmodp = d.mod(p.subtract(1)); - - buf = bigintToMpBuf(dmodp); - key.part.dmodp = {name: 'dmodp', data: buf}; - key.parts.push(key.part.dmodp); - } - if (!key.part.dmodq) { - var q = new bigInt(key.part.q.data); - var dmodq = d.mod(q.subtract(1)); - - buf = bigintToMpBuf(dmodq); - key.part.dmodq = {name: 'dmodq', data: buf}; - key.parts.push(key.part.dmodq); - } -} - -function publicFromPrivateECDSA(curveName, priv) { - assert.string(curveName, 'curveName'); - assert.buffer(priv); - if (ec === undefined) - ec = __webpack_require__(140); - if (jsbn === undefined) - jsbn = __webpack_require__(81).BigInteger; - var params = algs.curves[curveName]; - var p = new jsbn(params.p); - var a = new jsbn(params.a); - var b = new jsbn(params.b); - var curve = new ec.ECCurveFp(p, a, b); - var G = curve.decodePointHex(params.G.toString('hex')); - - var d = new jsbn(mpNormalize(priv)); - var pub = G.multiply(d); - pub = Buffer.from(curve.encodePointHex(pub), 'hex'); - - var parts = []; - parts.push({name: 'curve', data: Buffer.from(curveName)}); - parts.push({name: 'Q', data: pub}); - - var key = new Key({type: 'ecdsa', curve: curve, parts: parts}); - return (key); -} - -function opensshCipherInfo(cipher) { - var inf = {}; - switch (cipher) { - case '3des-cbc': - inf.keySize = 24; - inf.blockSize = 8; - inf.opensslName = 'des-ede3-cbc'; - break; - case 'blowfish-cbc': - inf.keySize = 16; - inf.blockSize = 8; - inf.opensslName = 'bf-cbc'; - break; - case 'aes128-cbc': - case 'aes128-ctr': - case 'aes128-gcm@openssh.com': - inf.keySize = 16; - inf.blockSize = 16; - inf.opensslName = 'aes-128-' + cipher.slice(7, 10); - break; - case 'aes192-cbc': - case 'aes192-ctr': - case 'aes192-gcm@openssh.com': - inf.keySize = 24; - inf.blockSize = 16; - inf.opensslName = 'aes-192-' + cipher.slice(7, 10); - break; - case 'aes256-cbc': - case 'aes256-ctr': - case 'aes256-gcm@openssh.com': - inf.keySize = 32; - inf.blockSize = 16; - inf.opensslName = 'aes-256-' + cipher.slice(7, 10); - break; - default: - throw (new Error( - 'Unsupported openssl cipher "' + cipher + '"')); - } - return (inf); -} - - -/***/ }), -/* 27 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -const escapeStringRegexp = __webpack_require__(382); -const ansiStyles = __webpack_require__(474); -const stdoutColor = __webpack_require__(566).stdout; - -const template = __webpack_require__(567); - -const isSimpleWindowsTerm = process.platform === 'win32' && !(process.env.TERM || '').toLowerCase().startsWith('xterm'); - -// `supportsColor.level` → `ansiStyles.color[name]` mapping -const levelMapping = ['ansi', 'ansi', 'ansi256', 'ansi16m']; - -// `color-convert` models to exclude from the Chalk API due to conflicts and such -const skipModels = new Set(['gray']); - -const styles = Object.create(null); - -function applyOptions(obj, options) { - options = options || {}; - - // Detect level if not set manually - const scLevel = stdoutColor ? stdoutColor.level : 0; - obj.level = options.level === undefined ? scLevel : options.level; - obj.enabled = 'enabled' in options ? options.enabled : obj.level > 0; -} - -function Chalk(options) { - // We check for this.template here since calling `chalk.constructor()` - // by itself will have a `this` of a previously constructed chalk object - if (!this || !(this instanceof Chalk) || this.template) { - const chalk = {}; - applyOptions(chalk, options); - - chalk.template = function () { - const args = [].slice.call(arguments); - return chalkTag.apply(null, [chalk.template].concat(args)); - }; - - Object.setPrototypeOf(chalk, Chalk.prototype); - Object.setPrototypeOf(chalk.template, chalk); - - chalk.template.constructor = Chalk; - - return chalk.template; - } - - applyOptions(this, options); -} - -// Use bright blue on Windows as the normal blue color is illegible -if (isSimpleWindowsTerm) { - ansiStyles.blue.open = '\u001B[94m'; -} - -for (const key of Object.keys(ansiStyles)) { - ansiStyles[key].closeRe = new RegExp(escapeStringRegexp(ansiStyles[key].close), 'g'); - - styles[key] = { - get() { - const codes = ansiStyles[key]; - return build.call(this, this._styles ? this._styles.concat(codes) : [codes], this._empty, key); - } - }; -} - -styles.visible = { - get() { - return build.call(this, this._styles || [], true, 'visible'); - } -}; - -ansiStyles.color.closeRe = new RegExp(escapeStringRegexp(ansiStyles.color.close), 'g'); -for (const model of Object.keys(ansiStyles.color.ansi)) { - if (skipModels.has(model)) { - continue; - } - - styles[model] = { - get() { - const level = this.level; - return function () { - const open = ansiStyles.color[levelMapping[level]][model].apply(null, arguments); - const codes = { - open, - close: ansiStyles.color.close, - closeRe: ansiStyles.color.closeRe - }; - return build.call(this, this._styles ? this._styles.concat(codes) : [codes], this._empty, model); - }; - } - }; -} - -ansiStyles.bgColor.closeRe = new RegExp(escapeStringRegexp(ansiStyles.bgColor.close), 'g'); -for (const model of Object.keys(ansiStyles.bgColor.ansi)) { - if (skipModels.has(model)) { - continue; - } - - const bgModel = 'bg' + model[0].toUpperCase() + model.slice(1); - styles[bgModel] = { - get() { - const level = this.level; - return function () { - const open = ansiStyles.bgColor[levelMapping[level]][model].apply(null, arguments); - const codes = { - open, - close: ansiStyles.bgColor.close, - closeRe: ansiStyles.bgColor.closeRe - }; - return build.call(this, this._styles ? this._styles.concat(codes) : [codes], this._empty, model); - }; - } - }; -} - -const proto = Object.defineProperties(() => {}, styles); - -function build(_styles, _empty, key) { - const builder = function () { - return applyStyle.apply(builder, arguments); - }; - - builder._styles = _styles; - builder._empty = _empty; - - const self = this; - - Object.defineProperty(builder, 'level', { - enumerable: true, - get() { - return self.level; - }, - set(level) { - self.level = level; - } - }); - - Object.defineProperty(builder, 'enabled', { - enumerable: true, - get() { - return self.enabled; - }, - set(enabled) { - self.enabled = enabled; - } - }); - - // See below for fix regarding invisible grey/dim combination on Windows - builder.hasGrey = this.hasGrey || key === 'gray' || key === 'grey'; - - // `__proto__` is used because we must return a function, but there is - // no way to create a function with a different prototype - builder.__proto__ = proto; // eslint-disable-line no-proto - - return builder; -} - -function applyStyle() { - // Support varags, but simply cast to string in case there's only one arg - const args = arguments; - const argsLen = args.length; - let str = String(arguments[0]); - - if (argsLen === 0) { - return ''; - } - - if (argsLen > 1) { - // Don't slice `arguments`, it prevents V8 optimizations - for (let a = 1; a < argsLen; a++) { - str += ' ' + args[a]; - } - } - - if (!this.enabled || this.level <= 0 || !str) { - return this._empty ? '' : str; - } - - // Turns out that on Windows dimmed gray text becomes invisible in cmd.exe, - // see https://github.com/chalk/chalk/issues/58 - // If we're on Windows and we're dealing with a gray color, temporarily make 'dim' a noop. - const originalDim = ansiStyles.dim.open; - if (isSimpleWindowsTerm && this.hasGrey) { - ansiStyles.dim.open = ''; - } - - for (const code of this._styles.slice().reverse()) { - // Replace any instances already present with a re-opening code - // otherwise only the part of the string until said closing code - // will be colored, and the rest will simply be 'plain'. - str = code.open + str.replace(code.closeRe, code.open) + code.close; - - // Close the styling before a linebreak and reopen - // after next line to fix a bleed issue on macOS - // https://github.com/chalk/chalk/pull/92 - str = str.replace(/\r?\n/g, `${code.close}$&${code.open}`); - } - - // Reset the original `dim` if we changed it to work around the Windows dimmed gray issue - ansiStyles.dim.open = originalDim; - - return str; -} - -function chalkTag(chalk, strings) { - if (!Array.isArray(strings)) { - // If chalk() was called by itself or with a string, - // return the string itself as a string. - return [].slice.call(arguments, 1).join(' '); - } - - const args = [].slice.call(arguments, 2); - const parts = [strings.raw[0]]; - - for (let i = 1; i < strings.length; i++) { - parts.push(String(args[i - 1]).replace(/[{}\\]/g, '\\$&')); - parts.push(String(strings.raw[i])); - } - - return template(chalk, parts.join('')); -} - -Object.defineProperties(Chalk.prototype, styles); - -module.exports = Chalk(); // eslint-disable-line new-cap -module.exports.supportsColor = stdoutColor; -module.exports.default = module.exports; // For TypeScript - - -/***/ }), -/* 28 */ -/***/ (function(module, exports, __webpack_require__) { - -// Copyright 2017 Joyent, Inc. - -module.exports = Key; - -var assert = __webpack_require__(16); -var algs = __webpack_require__(32); -var crypto = __webpack_require__(11); -var Fingerprint = __webpack_require__(157); -var Signature = __webpack_require__(75); -var DiffieHellman = __webpack_require__(326).DiffieHellman; -var errs = __webpack_require__(74); -var utils = __webpack_require__(26); -var PrivateKey = __webpack_require__(33); -var edCompat; - -try { - edCompat = __webpack_require__(454); -} catch (e) { - /* Just continue through, and bail out if we try to use it. */ -} - -var InvalidAlgorithmError = errs.InvalidAlgorithmError; -var KeyParseError = errs.KeyParseError; - -var formats = {}; -formats['auto'] = __webpack_require__(455); -formats['pem'] = __webpack_require__(86); -formats['pkcs1'] = __webpack_require__(328); -formats['pkcs8'] = __webpack_require__(158); -formats['rfc4253'] = __webpack_require__(103); -formats['ssh'] = __webpack_require__(456); -formats['ssh-private'] = __webpack_require__(193); -formats['openssh'] = formats['ssh-private']; -formats['dnssec'] = __webpack_require__(327); - -function Key(opts) { - assert.object(opts, 'options'); - assert.arrayOfObject(opts.parts, 'options.parts'); - assert.string(opts.type, 'options.type'); - assert.optionalString(opts.comment, 'options.comment'); - - var algInfo = algs.info[opts.type]; - if (typeof (algInfo) !== 'object') - throw (new InvalidAlgorithmError(opts.type)); - - var partLookup = {}; - for (var i = 0; i < opts.parts.length; ++i) { - var part = opts.parts[i]; - partLookup[part.name] = part; - } - - this.type = opts.type; - this.parts = opts.parts; - this.part = partLookup; - this.comment = undefined; - this.source = opts.source; - - /* for speeding up hashing/fingerprint operations */ - this._rfc4253Cache = opts._rfc4253Cache; - this._hashCache = {}; - - var sz; - this.curve = undefined; - if (this.type === 'ecdsa') { - var curve = this.part.curve.data.toString(); - this.curve = curve; - sz = algs.curves[curve].size; - } else if (this.type === 'ed25519' || this.type === 'curve25519') { - sz = 256; - this.curve = 'curve25519'; - } else { - var szPart = this.part[algInfo.sizePart]; - sz = szPart.data.length; - sz = sz * 8 - utils.countZeros(szPart.data); - } - this.size = sz; -} - -Key.formats = formats; - -Key.prototype.toBuffer = function (format, options) { - if (format === undefined) - format = 'ssh'; - assert.string(format, 'format'); - assert.object(formats[format], 'formats[format]'); - assert.optionalObject(options, 'options'); - - if (format === 'rfc4253') { - if (this._rfc4253Cache === undefined) - this._rfc4253Cache = formats['rfc4253'].write(this); - return (this._rfc4253Cache); - } - - return (formats[format].write(this, options)); -}; - -Key.prototype.toString = function (format, options) { - return (this.toBuffer(format, options).toString()); -}; - -Key.prototype.hash = function (algo) { - assert.string(algo, 'algorithm'); - algo = algo.toLowerCase(); - if (algs.hashAlgs[algo] === undefined) - throw (new InvalidAlgorithmError(algo)); - - if (this._hashCache[algo]) - return (this._hashCache[algo]); - var hash = crypto.createHash(algo). - update(this.toBuffer('rfc4253')).digest(); - this._hashCache[algo] = hash; - return (hash); -}; - -Key.prototype.fingerprint = function (algo) { - if (algo === undefined) - algo = 'sha256'; - assert.string(algo, 'algorithm'); - var opts = { - type: 'key', - hash: this.hash(algo), - algorithm: algo - }; - return (new Fingerprint(opts)); -}; - -Key.prototype.defaultHashAlgorithm = function () { - var hashAlgo = 'sha1'; - if (this.type === 'rsa') - hashAlgo = 'sha256'; - if (this.type === 'dsa' && this.size > 1024) - hashAlgo = 'sha256'; - if (this.type === 'ed25519') - hashAlgo = 'sha512'; - if (this.type === 'ecdsa') { - if (this.size <= 256) - hashAlgo = 'sha256'; - else if (this.size <= 384) - hashAlgo = 'sha384'; - else - hashAlgo = 'sha512'; - } - return (hashAlgo); -}; - -Key.prototype.createVerify = function (hashAlgo) { - if (hashAlgo === undefined) - hashAlgo = this.defaultHashAlgorithm(); - assert.string(hashAlgo, 'hash algorithm'); - - /* ED25519 is not supported by OpenSSL, use a javascript impl. */ - if (this.type === 'ed25519' && edCompat !== undefined) - return (new edCompat.Verifier(this, hashAlgo)); - if (this.type === 'curve25519') - throw (new Error('Curve25519 keys are not suitable for ' + - 'signing or verification')); - - var v, nm, err; - try { - nm = hashAlgo.toUpperCase(); - v = crypto.createVerify(nm); - } catch (e) { - err = e; - } - if (v === undefined || (err instanceof Error && - err.message.match(/Unknown message digest/))) { - nm = 'RSA-'; - nm += hashAlgo.toUpperCase(); - v = crypto.createVerify(nm); - } - assert.ok(v, 'failed to create verifier'); - var oldVerify = v.verify.bind(v); - var key = this.toBuffer('pkcs8'); - var curve = this.curve; - var self = this; - v.verify = function (signature, fmt) { - if (Signature.isSignature(signature, [2, 0])) { - if (signature.type !== self.type) - return (false); - if (signature.hashAlgorithm && - signature.hashAlgorithm !== hashAlgo) - return (false); - if (signature.curve && self.type === 'ecdsa' && - signature.curve !== curve) - return (false); - return (oldVerify(key, signature.toBuffer('asn1'))); - - } else if (typeof (signature) === 'string' || - Buffer.isBuffer(signature)) { - return (oldVerify(key, signature, fmt)); - - /* - * Avoid doing this on valid arguments, walking the prototype - * chain can be quite slow. - */ - } else if (Signature.isSignature(signature, [1, 0])) { - throw (new Error('signature was created by too old ' + - 'a version of sshpk and cannot be verified')); - - } else { - throw (new TypeError('signature must be a string, ' + - 'Buffer, or Signature object')); - } - }; - return (v); -}; - -Key.prototype.createDiffieHellman = function () { - if (this.type === 'rsa') - throw (new Error('RSA keys do not support Diffie-Hellman')); - - return (new DiffieHellman(this)); -}; -Key.prototype.createDH = Key.prototype.createDiffieHellman; - -Key.parse = function (data, format, options) { - if (typeof (data) !== 'string') - assert.buffer(data, 'data'); - if (format === undefined) - format = 'auto'; - assert.string(format, 'format'); - if (typeof (options) === 'string') - options = { filename: options }; - assert.optionalObject(options, 'options'); - if (options === undefined) - options = {}; - assert.optionalString(options.filename, 'options.filename'); - if (options.filename === undefined) - options.filename = '(unnamed)'; - - assert.object(formats[format], 'formats[format]'); - - try { - var k = formats[format].read(data, options); - if (k instanceof PrivateKey) - k = k.toPublic(); - if (!k.comment) - k.comment = options.filename; - return (k); - } catch (e) { - if (e.name === 'KeyEncryptedError') - throw (e); - throw (new KeyParseError(options.filename, format, e)); - } -}; - -Key.isKey = function (obj, ver) { - return (utils.isCompatible(obj, Key, ver)); -}; - -/* - * API versions for Key: - * [1,0] -- initial ver, may take Signature for createVerify or may not - * [1,1] -- added pkcs1, pkcs8 formats - * [1,2] -- added auto, ssh-private, openssh formats - * [1,3] -- added defaultHashAlgorithm - * [1,4] -- added ed support, createDH - * [1,5] -- first explicitly tagged version - * [1,6] -- changed ed25519 part names - */ -Key.prototype._sshpkApiVersion = [1, 6]; - -Key._oldVersionDetect = function (obj) { - assert.func(obj.toBuffer); - assert.func(obj.fingerprint); - if (obj.createDH) - return ([1, 4]); - if (obj.defaultHashAlgorithm) - return ([1, 3]); - if (obj.formats['auto']) - return ([1, 2]); - if (obj.formats['pkcs1']) - return ([1, 1]); - return ([1, 0]); -}; - - -/***/ }), -/* 29 */ -/***/ (function(module, exports) { - -module.exports = require("assert"); - -/***/ }), -/* 30 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); -exports.default = nullify; -function nullify(obj = {}) { - if (Array.isArray(obj)) { - for (var _iterator = obj, _isArray = Array.isArray(_iterator), _i = 0, _iterator = _isArray ? _iterator : _iterator[Symbol.iterator]();;) { - var _ref; - - if (_isArray) { - if (_i >= _iterator.length) break; - _ref = _iterator[_i++]; - } else { - _i = _iterator.next(); - if (_i.done) break; - _ref = _i.value; - } - - const item = _ref; - - nullify(item); - } - } else if (obj !== null && typeof obj === 'object' || typeof obj === 'function') { - Object.setPrototypeOf(obj, null); - - // for..in can only be applied to 'object', not 'function' - if (typeof obj === 'object') { - for (const key in obj) { - nullify(obj[key]); - } - } - } - - return obj; -} - -/***/ }), -/* 31 */ -/***/ (function(module, exports) { - -var core = module.exports = { version: '2.5.7' }; -if (typeof __e == 'number') __e = core; // eslint-disable-line no-undef - - -/***/ }), -/* 32 */ -/***/ (function(module, exports, __webpack_require__) { - -// Copyright 2015 Joyent, Inc. - -var Buffer = __webpack_require__(15).Buffer; - -var algInfo = { - 'dsa': { - parts: ['p', 'q', 'g', 'y'], - sizePart: 'p' - }, - 'rsa': { - parts: ['e', 'n'], - sizePart: 'n' - }, - 'ecdsa': { - parts: ['curve', 'Q'], - sizePart: 'Q' - }, - 'ed25519': { - parts: ['A'], - sizePart: 'A' - } -}; -algInfo['curve25519'] = algInfo['ed25519']; - -var algPrivInfo = { - 'dsa': { - parts: ['p', 'q', 'g', 'y', 'x'] - }, - 'rsa': { - parts: ['n', 'e', 'd', 'iqmp', 'p', 'q'] - }, - 'ecdsa': { - parts: ['curve', 'Q', 'd'] - }, - 'ed25519': { - parts: ['A', 'k'] - } -}; -algPrivInfo['curve25519'] = algPrivInfo['ed25519']; - -var hashAlgs = { - 'md5': true, - 'sha1': true, - 'sha256': true, - 'sha384': true, - 'sha512': true -}; - -/* - * Taken from - * http://csrc.nist.gov/groups/ST/toolkit/documents/dss/NISTReCur.pdf - */ -var curves = { - 'nistp256': { - size: 256, - pkcs8oid: '1.2.840.10045.3.1.7', - p: Buffer.from(('00' + - 'ffffffff 00000001 00000000 00000000' + - '00000000 ffffffff ffffffff ffffffff'). - replace(/ /g, ''), 'hex'), - a: Buffer.from(('00' + - 'FFFFFFFF 00000001 00000000 00000000' + - '00000000 FFFFFFFF FFFFFFFF FFFFFFFC'). - replace(/ /g, ''), 'hex'), - b: Buffer.from(( - '5ac635d8 aa3a93e7 b3ebbd55 769886bc' + - '651d06b0 cc53b0f6 3bce3c3e 27d2604b'). - replace(/ /g, ''), 'hex'), - s: Buffer.from(('00' + - 'c49d3608 86e70493 6a6678e1 139d26b7' + - '819f7e90'). - replace(/ /g, ''), 'hex'), - n: Buffer.from(('00' + - 'ffffffff 00000000 ffffffff ffffffff' + - 'bce6faad a7179e84 f3b9cac2 fc632551'). - replace(/ /g, ''), 'hex'), - G: Buffer.from(('04' + - '6b17d1f2 e12c4247 f8bce6e5 63a440f2' + - '77037d81 2deb33a0 f4a13945 d898c296' + - '4fe342e2 fe1a7f9b 8ee7eb4a 7c0f9e16' + - '2bce3357 6b315ece cbb64068 37bf51f5'). - replace(/ /g, ''), 'hex') - }, - 'nistp384': { - size: 384, - pkcs8oid: '1.3.132.0.34', - p: Buffer.from(('00' + - 'ffffffff ffffffff ffffffff ffffffff' + - 'ffffffff ffffffff ffffffff fffffffe' + - 'ffffffff 00000000 00000000 ffffffff'). - replace(/ /g, ''), 'hex'), - a: Buffer.from(('00' + - 'FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF' + - 'FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE' + - 'FFFFFFFF 00000000 00000000 FFFFFFFC'). - replace(/ /g, ''), 'hex'), - b: Buffer.from(( - 'b3312fa7 e23ee7e4 988e056b e3f82d19' + - '181d9c6e fe814112 0314088f 5013875a' + - 'c656398d 8a2ed19d 2a85c8ed d3ec2aef'). - replace(/ /g, ''), 'hex'), - s: Buffer.from(('00' + - 'a335926a a319a27a 1d00896a 6773a482' + - '7acdac73'). - replace(/ /g, ''), 'hex'), - n: Buffer.from(('00' + - 'ffffffff ffffffff ffffffff ffffffff' + - 'ffffffff ffffffff c7634d81 f4372ddf' + - '581a0db2 48b0a77a ecec196a ccc52973'). - replace(/ /g, ''), 'hex'), - G: Buffer.from(('04' + - 'aa87ca22 be8b0537 8eb1c71e f320ad74' + - '6e1d3b62 8ba79b98 59f741e0 82542a38' + - '5502f25d bf55296c 3a545e38 72760ab7' + - '3617de4a 96262c6f 5d9e98bf 9292dc29' + - 'f8f41dbd 289a147c e9da3113 b5f0b8c0' + - '0a60b1ce 1d7e819d 7a431d7c 90ea0e5f'). - replace(/ /g, ''), 'hex') - }, - 'nistp521': { - size: 521, - pkcs8oid: '1.3.132.0.35', - p: Buffer.from(( - '01ffffff ffffffff ffffffff ffffffff' + - 'ffffffff ffffffff ffffffff ffffffff' + - 'ffffffff ffffffff ffffffff ffffffff' + - 'ffffffff ffffffff ffffffff ffffffff' + - 'ffff').replace(/ /g, ''), 'hex'), - a: Buffer.from(('01FF' + - 'FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF' + - 'FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF' + - 'FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF' + - 'FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFC'). - replace(/ /g, ''), 'hex'), - b: Buffer.from(('51' + - '953eb961 8e1c9a1f 929a21a0 b68540ee' + - 'a2da725b 99b315f3 b8b48991 8ef109e1' + - '56193951 ec7e937b 1652c0bd 3bb1bf07' + - '3573df88 3d2c34f1 ef451fd4 6b503f00'). - replace(/ /g, ''), 'hex'), - s: Buffer.from(('00' + - 'd09e8800 291cb853 96cc6717 393284aa' + - 'a0da64ba').replace(/ /g, ''), 'hex'), - n: Buffer.from(('01ff' + - 'ffffffff ffffffff ffffffff ffffffff' + - 'ffffffff ffffffff ffffffff fffffffa' + - '51868783 bf2f966b 7fcc0148 f709a5d0' + - '3bb5c9b8 899c47ae bb6fb71e 91386409'). - replace(/ /g, ''), 'hex'), - G: Buffer.from(('04' + - '00c6 858e06b7 0404e9cd 9e3ecb66 2395b442' + - '9c648139 053fb521 f828af60 6b4d3dba' + - 'a14b5e77 efe75928 fe1dc127 a2ffa8de' + - '3348b3c1 856a429b f97e7e31 c2e5bd66' + - '0118 39296a78 9a3bc004 5c8a5fb4 2c7d1bd9' + - '98f54449 579b4468 17afbd17 273e662c' + - '97ee7299 5ef42640 c550b901 3fad0761' + - '353c7086 a272c240 88be9476 9fd16650'). - replace(/ /g, ''), 'hex') - } -}; - -module.exports = { - info: algInfo, - privInfo: algPrivInfo, - hashAlgs: hashAlgs, - curves: curves -}; - - -/***/ }), -/* 33 */ -/***/ (function(module, exports, __webpack_require__) { - -// Copyright 2017 Joyent, Inc. - -module.exports = PrivateKey; - -var assert = __webpack_require__(16); -var Buffer = __webpack_require__(15).Buffer; -var algs = __webpack_require__(32); -var crypto = __webpack_require__(11); -var Fingerprint = __webpack_require__(157); -var Signature = __webpack_require__(75); -var errs = __webpack_require__(74); -var util = __webpack_require__(3); -var utils = __webpack_require__(26); -var dhe = __webpack_require__(326); -var generateECDSA = dhe.generateECDSA; -var generateED25519 = dhe.generateED25519; -var edCompat; -var nacl; - -try { - edCompat = __webpack_require__(454); -} catch (e) { - /* Just continue through, and bail out if we try to use it. */ -} - -var Key = __webpack_require__(28); - -var InvalidAlgorithmError = errs.InvalidAlgorithmError; -var KeyParseError = errs.KeyParseError; -var KeyEncryptedError = errs.KeyEncryptedError; - -var formats = {}; -formats['auto'] = __webpack_require__(455); -formats['pem'] = __webpack_require__(86); -formats['pkcs1'] = __webpack_require__(328); -formats['pkcs8'] = __webpack_require__(158); -formats['rfc4253'] = __webpack_require__(103); -formats['ssh-private'] = __webpack_require__(193); -formats['openssh'] = formats['ssh-private']; -formats['ssh'] = formats['ssh-private']; -formats['dnssec'] = __webpack_require__(327); - -function PrivateKey(opts) { - assert.object(opts, 'options'); - Key.call(this, opts); - - this._pubCache = undefined; -} -util.inherits(PrivateKey, Key); - -PrivateKey.formats = formats; - -PrivateKey.prototype.toBuffer = function (format, options) { - if (format === undefined) - format = 'pkcs1'; - assert.string(format, 'format'); - assert.object(formats[format], 'formats[format]'); - assert.optionalObject(options, 'options'); - - return (formats[format].write(this, options)); -}; - -PrivateKey.prototype.hash = function (algo) { - return (this.toPublic().hash(algo)); -}; - -PrivateKey.prototype.toPublic = function () { - if (this._pubCache) - return (this._pubCache); - - var algInfo = algs.info[this.type]; - var pubParts = []; - for (var i = 0; i < algInfo.parts.length; ++i) { - var p = algInfo.parts[i]; - pubParts.push(this.part[p]); - } - - this._pubCache = new Key({ - type: this.type, - source: this, - parts: pubParts - }); - if (this.comment) - this._pubCache.comment = this.comment; - return (this._pubCache); -}; - -PrivateKey.prototype.derive = function (newType) { - assert.string(newType, 'type'); - var priv, pub, pair; - - if (this.type === 'ed25519' && newType === 'curve25519') { - if (nacl === undefined) - nacl = __webpack_require__(76); - - priv = this.part.k.data; - if (priv[0] === 0x00) - priv = priv.slice(1); - - pair = nacl.box.keyPair.fromSecretKey(new Uint8Array(priv)); - pub = Buffer.from(pair.publicKey); - - return (new PrivateKey({ - type: 'curve25519', - parts: [ - { name: 'A', data: utils.mpNormalize(pub) }, - { name: 'k', data: utils.mpNormalize(priv) } - ] - })); - } else if (this.type === 'curve25519' && newType === 'ed25519') { - if (nacl === undefined) - nacl = __webpack_require__(76); - - priv = this.part.k.data; - if (priv[0] === 0x00) - priv = priv.slice(1); - - pair = nacl.sign.keyPair.fromSeed(new Uint8Array(priv)); - pub = Buffer.from(pair.publicKey); - - return (new PrivateKey({ - type: 'ed25519', - parts: [ - { name: 'A', data: utils.mpNormalize(pub) }, - { name: 'k', data: utils.mpNormalize(priv) } - ] - })); - } - throw (new Error('Key derivation not supported from ' + this.type + - ' to ' + newType)); -}; - -PrivateKey.prototype.createVerify = function (hashAlgo) { - return (this.toPublic().createVerify(hashAlgo)); -}; - -PrivateKey.prototype.createSign = function (hashAlgo) { - if (hashAlgo === undefined) - hashAlgo = this.defaultHashAlgorithm(); - assert.string(hashAlgo, 'hash algorithm'); - - /* ED25519 is not supported by OpenSSL, use a javascript impl. */ - if (this.type === 'ed25519' && edCompat !== undefined) - return (new edCompat.Signer(this, hashAlgo)); - if (this.type === 'curve25519') - throw (new Error('Curve25519 keys are not suitable for ' + - 'signing or verification')); - - var v, nm, err; - try { - nm = hashAlgo.toUpperCase(); - v = crypto.createSign(nm); - } catch (e) { - err = e; - } - if (v === undefined || (err instanceof Error && - err.message.match(/Unknown message digest/))) { - nm = 'RSA-'; - nm += hashAlgo.toUpperCase(); - v = crypto.createSign(nm); - } - assert.ok(v, 'failed to create verifier'); - var oldSign = v.sign.bind(v); - var key = this.toBuffer('pkcs1'); - var type = this.type; - var curve = this.curve; - v.sign = function () { - var sig = oldSign(key); - if (typeof (sig) === 'string') - sig = Buffer.from(sig, 'binary'); - sig = Signature.parse(sig, type, 'asn1'); - sig.hashAlgorithm = hashAlgo; - sig.curve = curve; - return (sig); - }; - return (v); -}; - -PrivateKey.parse = function (data, format, options) { - if (typeof (data) !== 'string') - assert.buffer(data, 'data'); - if (format === undefined) - format = 'auto'; - assert.string(format, 'format'); - if (typeof (options) === 'string') - options = { filename: options }; - assert.optionalObject(options, 'options'); - if (options === undefined) - options = {}; - assert.optionalString(options.filename, 'options.filename'); - if (options.filename === undefined) - options.filename = '(unnamed)'; - - assert.object(formats[format], 'formats[format]'); - - try { - var k = formats[format].read(data, options); - assert.ok(k instanceof PrivateKey, 'key is not a private key'); - if (!k.comment) - k.comment = options.filename; - return (k); - } catch (e) { - if (e.name === 'KeyEncryptedError') - throw (e); - throw (new KeyParseError(options.filename, format, e)); - } -}; - -PrivateKey.isPrivateKey = function (obj, ver) { - return (utils.isCompatible(obj, PrivateKey, ver)); -}; - -PrivateKey.generate = function (type, options) { - if (options === undefined) - options = {}; - assert.object(options, 'options'); - - switch (type) { - case 'ecdsa': - if (options.curve === undefined) - options.curve = 'nistp256'; - assert.string(options.curve, 'options.curve'); - return (generateECDSA(options.curve)); - case 'ed25519': - return (generateED25519()); - default: - throw (new Error('Key generation not supported with key ' + - 'type "' + type + '"')); - } -}; - -/* - * API versions for PrivateKey: - * [1,0] -- initial ver - * [1,1] -- added auto, pkcs[18], openssh/ssh-private formats - * [1,2] -- added defaultHashAlgorithm - * [1,3] -- added derive, ed, createDH - * [1,4] -- first tagged version - * [1,5] -- changed ed25519 part names and format - */ -PrivateKey.prototype._sshpkApiVersion = [1, 5]; - -PrivateKey._oldVersionDetect = function (obj) { - assert.func(obj.toPublic); - assert.func(obj.createSign); - if (obj.derive) - return ([1, 3]); - if (obj.defaultHashAlgorithm) - return ([1, 2]); - if (obj.formats['auto']) - return ([1, 1]); - return ([1, 0]); -}; - - -/***/ }), -/* 34 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); -exports.wrapLifecycle = exports.run = exports.install = exports.Install = undefined; - -var _extends2; - -function _load_extends() { - return _extends2 = _interopRequireDefault(__webpack_require__(20)); -} - -var _asyncToGenerator2; - -function _load_asyncToGenerator() { - return _asyncToGenerator2 = _interopRequireDefault(__webpack_require__(2)); -} - -let install = exports.install = (() => { - var _ref29 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (config, reporter, flags, lockfile) { - yield wrapLifecycle(config, flags, (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - const install = new Install(flags, config, reporter, lockfile); - yield install.init(); - })); - }); - - return function install(_x7, _x8, _x9, _x10) { - return _ref29.apply(this, arguments); - }; -})(); - -let run = exports.run = (() => { - var _ref31 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (config, reporter, flags, args) { - let lockfile; - let error = 'installCommandRenamed'; - if (flags.lockfile === false) { - lockfile = new (_lockfile || _load_lockfile()).default(); - } else { - lockfile = yield (_lockfile || _load_lockfile()).default.fromDirectory(config.lockfileFolder, reporter); - } - - if (args.length) { - const exampleArgs = args.slice(); - - if (flags.saveDev) { - exampleArgs.push('--dev'); - } - if (flags.savePeer) { - exampleArgs.push('--peer'); - } - if (flags.saveOptional) { - exampleArgs.push('--optional'); - } - if (flags.saveExact) { - exampleArgs.push('--exact'); - } - if (flags.saveTilde) { - exampleArgs.push('--tilde'); - } - let command = 'add'; - if (flags.global) { - error = 'globalFlagRemoved'; - command = 'global add'; - } - throw new (_errors || _load_errors()).MessageError(reporter.lang(error, `yarn ${command} ${exampleArgs.join(' ')}`)); - } - - yield install(config, reporter, flags, lockfile); - }); - - return function run(_x11, _x12, _x13, _x14) { - return _ref31.apply(this, arguments); - }; -})(); - -let wrapLifecycle = exports.wrapLifecycle = (() => { - var _ref32 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (config, flags, factory) { - yield config.executeLifecycleScript('preinstall'); - - yield factory(); - - // npm behaviour, seems kinda funky but yay compatibility - yield config.executeLifecycleScript('install'); - yield config.executeLifecycleScript('postinstall'); - - if (!config.production) { - if (!config.disablePrepublish) { - yield config.executeLifecycleScript('prepublish'); - } - yield config.executeLifecycleScript('prepare'); - } - }); - - return function wrapLifecycle(_x15, _x16, _x17) { - return _ref32.apply(this, arguments); - }; -})(); - -exports.hasWrapper = hasWrapper; -exports.setFlags = setFlags; - -var _objectPath; - -function _load_objectPath() { - return _objectPath = _interopRequireDefault(__webpack_require__(304)); -} - -var _hooks; - -function _load_hooks() { - return _hooks = __webpack_require__(368); -} - -var _index; - -function _load_index() { - return _index = _interopRequireDefault(__webpack_require__(218)); -} - -var _errors; - -function _load_errors() { - return _errors = __webpack_require__(6); -} - -var _integrityChecker; - -function _load_integrityChecker() { - return _integrityChecker = _interopRequireDefault(__webpack_require__(206)); -} - -var _lockfile; - -function _load_lockfile() { - return _lockfile = _interopRequireDefault(__webpack_require__(19)); -} - -var _lockfile2; - -function _load_lockfile2() { - return _lockfile2 = __webpack_require__(19); -} - -var _packageFetcher; - -function _load_packageFetcher() { - return _packageFetcher = _interopRequireWildcard(__webpack_require__(208)); -} - -var _packageInstallScripts; - -function _load_packageInstallScripts() { - return _packageInstallScripts = _interopRequireDefault(__webpack_require__(525)); -} - -var _packageCompatibility; - -function _load_packageCompatibility() { - return _packageCompatibility = _interopRequireWildcard(__webpack_require__(207)); -} - -var _packageResolver; - -function _load_packageResolver() { - return _packageResolver = _interopRequireDefault(__webpack_require__(360)); -} - -var _packageLinker; - -function _load_packageLinker() { - return _packageLinker = _interopRequireDefault(__webpack_require__(209)); -} - -var _index2; - -function _load_index2() { - return _index2 = __webpack_require__(58); -} - -var _index3; - -function _load_index3() { - return _index3 = __webpack_require__(78); -} - -var _autoclean; - -function _load_autoclean() { - return _autoclean = __webpack_require__(348); -} - -var _constants; - -function _load_constants() { - return _constants = _interopRequireWildcard(__webpack_require__(8)); -} - -var _normalizePattern; - -function _load_normalizePattern() { - return _normalizePattern = __webpack_require__(37); -} - -var _fs; - -function _load_fs() { - return _fs = _interopRequireWildcard(__webpack_require__(5)); -} - -var _map; - -function _load_map() { - return _map = _interopRequireDefault(__webpack_require__(30)); -} - -var _yarnVersion; - -function _load_yarnVersion() { - return _yarnVersion = __webpack_require__(105); -} - -var _generatePnpMap; - -function _load_generatePnpMap() { - return _generatePnpMap = __webpack_require__(547); -} - -var _workspaceLayout; - -function _load_workspaceLayout() { - return _workspaceLayout = _interopRequireDefault(__webpack_require__(90)); -} - -var _resolutionMap; - -function _load_resolutionMap() { - return _resolutionMap = _interopRequireDefault(__webpack_require__(212)); -} - -var _guessName; - -function _load_guessName() { - return _guessName = _interopRequireDefault(__webpack_require__(169)); -} - -var _audit; - -function _load_audit() { - return _audit = _interopRequireDefault(__webpack_require__(347)); -} - -function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } } - -function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } - -const deepEqual = __webpack_require__(599); - -const emoji = __webpack_require__(302); -const invariant = __webpack_require__(9); -const path = __webpack_require__(0); -const semver = __webpack_require__(22); -const uuid = __webpack_require__(120); -const ssri = __webpack_require__(65); - -const ONE_DAY = 1000 * 60 * 60 * 24; - -/** - * Try and detect the installation method for Yarn and provide a command to update it with. - */ - -function getUpdateCommand(installationMethod) { - if (installationMethod === 'tar') { - return `curl --compressed -o- -L ${(_constants || _load_constants()).YARN_INSTALLER_SH} | bash`; - } - - if (installationMethod === 'homebrew') { - return 'brew upgrade yarn'; - } - - if (installationMethod === 'deb') { - return 'sudo apt-get update && sudo apt-get install yarn'; - } - - if (installationMethod === 'rpm') { - return 'sudo yum install yarn'; - } - - if (installationMethod === 'npm') { - return 'npm install --global yarn'; - } - - if (installationMethod === 'chocolatey') { - return 'choco upgrade yarn'; - } - - if (installationMethod === 'apk') { - return 'apk update && apk add -u yarn'; - } - - if (installationMethod === 'portage') { - return 'sudo emerge --sync && sudo emerge -au sys-apps/yarn'; - } - - return null; -} - -function getUpdateInstaller(installationMethod) { - // Windows - if (installationMethod === 'msi') { - return (_constants || _load_constants()).YARN_INSTALLER_MSI; - } - - return null; -} - -function normalizeFlags(config, rawFlags) { - const flags = { - // install - har: !!rawFlags.har, - ignorePlatform: !!rawFlags.ignorePlatform, - ignoreEngines: !!rawFlags.ignoreEngines, - ignoreScripts: !!rawFlags.ignoreScripts, - ignoreOptional: !!rawFlags.ignoreOptional, - force: !!rawFlags.force, - flat: !!rawFlags.flat, - lockfile: rawFlags.lockfile !== false, - pureLockfile: !!rawFlags.pureLockfile, - updateChecksums: !!rawFlags.updateChecksums, - skipIntegrityCheck: !!rawFlags.skipIntegrityCheck, - frozenLockfile: !!rawFlags.frozenLockfile, - linkDuplicates: !!rawFlags.linkDuplicates, - checkFiles: !!rawFlags.checkFiles, - audit: !!rawFlags.audit, - - // add - peer: !!rawFlags.peer, - dev: !!rawFlags.dev, - optional: !!rawFlags.optional, - exact: !!rawFlags.exact, - tilde: !!rawFlags.tilde, - ignoreWorkspaceRootCheck: !!rawFlags.ignoreWorkspaceRootCheck, - - // outdated, update-interactive - includeWorkspaceDeps: !!rawFlags.includeWorkspaceDeps, - - // add, remove, update - workspaceRootIsCwd: rawFlags.workspaceRootIsCwd !== false - }; - - if (config.getOption('ignore-scripts')) { - flags.ignoreScripts = true; - } - - if (config.getOption('ignore-platform')) { - flags.ignorePlatform = true; - } - - if (config.getOption('ignore-engines')) { - flags.ignoreEngines = true; - } - - if (config.getOption('ignore-optional')) { - flags.ignoreOptional = true; - } - - if (config.getOption('force')) { - flags.force = true; - } - - return flags; -} - -class Install { - constructor(flags, config, reporter, lockfile) { - this.rootManifestRegistries = []; - this.rootPatternsToOrigin = (0, (_map || _load_map()).default)(); - this.lockfile = lockfile; - this.reporter = reporter; - this.config = config; - this.flags = normalizeFlags(config, flags); - this.resolutions = (0, (_map || _load_map()).default)(); // Legacy resolutions field used for flat install mode - this.resolutionMap = new (_resolutionMap || _load_resolutionMap()).default(config); // Selective resolutions for nested dependencies - this.resolver = new (_packageResolver || _load_packageResolver()).default(config, lockfile, this.resolutionMap); - this.integrityChecker = new (_integrityChecker || _load_integrityChecker()).default(config); - this.linker = new (_packageLinker || _load_packageLinker()).default(config, this.resolver); - this.scripts = new (_packageInstallScripts || _load_packageInstallScripts()).default(config, this.resolver, this.flags.force); - } - - /** - * Create a list of dependency requests from the current directories manifests. - */ - - fetchRequestFromCwd(excludePatterns = [], ignoreUnusedPatterns = false) { - var _this = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - const patterns = []; - const deps = []; - let resolutionDeps = []; - const manifest = {}; - - const ignorePatterns = []; - const usedPatterns = []; - let workspaceLayout; - - // some commands should always run in the context of the entire workspace - const cwd = _this.flags.includeWorkspaceDeps || _this.flags.workspaceRootIsCwd ? _this.config.lockfileFolder : _this.config.cwd; - - // non-workspaces are always root, otherwise check for workspace root - const cwdIsRoot = !_this.config.workspaceRootFolder || _this.config.lockfileFolder === cwd; - - // exclude package names that are in install args - const excludeNames = []; - for (var _iterator = excludePatterns, _isArray = Array.isArray(_iterator), _i = 0, _iterator = _isArray ? _iterator : _iterator[Symbol.iterator]();;) { - var _ref; - - if (_isArray) { - if (_i >= _iterator.length) break; - _ref = _iterator[_i++]; - } else { - _i = _iterator.next(); - if (_i.done) break; - _ref = _i.value; - } - - const pattern = _ref; - - if ((0, (_index3 || _load_index3()).getExoticResolver)(pattern)) { - excludeNames.push((0, (_guessName || _load_guessName()).default)(pattern)); - } else { - // extract the name - const parts = (0, (_normalizePattern || _load_normalizePattern()).normalizePattern)(pattern); - excludeNames.push(parts.name); - } - } - - const stripExcluded = function stripExcluded(manifest) { - for (var _iterator2 = excludeNames, _isArray2 = Array.isArray(_iterator2), _i2 = 0, _iterator2 = _isArray2 ? _iterator2 : _iterator2[Symbol.iterator]();;) { - var _ref2; - - if (_isArray2) { - if (_i2 >= _iterator2.length) break; - _ref2 = _iterator2[_i2++]; - } else { - _i2 = _iterator2.next(); - if (_i2.done) break; - _ref2 = _i2.value; - } - - const exclude = _ref2; - - if (manifest.dependencies && manifest.dependencies[exclude]) { - delete manifest.dependencies[exclude]; - } - if (manifest.devDependencies && manifest.devDependencies[exclude]) { - delete manifest.devDependencies[exclude]; - } - if (manifest.optionalDependencies && manifest.optionalDependencies[exclude]) { - delete manifest.optionalDependencies[exclude]; - } - } - }; - - for (var _iterator3 = Object.keys((_index2 || _load_index2()).registries), _isArray3 = Array.isArray(_iterator3), _i3 = 0, _iterator3 = _isArray3 ? _iterator3 : _iterator3[Symbol.iterator]();;) { - var _ref3; - - if (_isArray3) { - if (_i3 >= _iterator3.length) break; - _ref3 = _iterator3[_i3++]; - } else { - _i3 = _iterator3.next(); - if (_i3.done) break; - _ref3 = _i3.value; - } - - const registry = _ref3; - - const filename = (_index2 || _load_index2()).registries[registry].filename; - - const loc = path.join(cwd, filename); - if (!(yield (_fs || _load_fs()).exists(loc))) { - continue; - } - - _this.rootManifestRegistries.push(registry); - - const projectManifestJson = yield _this.config.readJson(loc); - yield (0, (_index || _load_index()).default)(projectManifestJson, cwd, _this.config, cwdIsRoot); - - Object.assign(_this.resolutions, projectManifestJson.resolutions); - Object.assign(manifest, projectManifestJson); - - _this.resolutionMap.init(_this.resolutions); - for (var _iterator4 = Object.keys(_this.resolutionMap.resolutionsByPackage), _isArray4 = Array.isArray(_iterator4), _i4 = 0, _iterator4 = _isArray4 ? _iterator4 : _iterator4[Symbol.iterator]();;) { - var _ref4; - - if (_isArray4) { - if (_i4 >= _iterator4.length) break; - _ref4 = _iterator4[_i4++]; - } else { - _i4 = _iterator4.next(); - if (_i4.done) break; - _ref4 = _i4.value; - } - - const packageName = _ref4; - - const optional = (_objectPath || _load_objectPath()).default.has(manifest.optionalDependencies, packageName) && _this.flags.ignoreOptional; - for (var _iterator8 = _this.resolutionMap.resolutionsByPackage[packageName], _isArray8 = Array.isArray(_iterator8), _i8 = 0, _iterator8 = _isArray8 ? _iterator8 : _iterator8[Symbol.iterator]();;) { - var _ref9; - - if (_isArray8) { - if (_i8 >= _iterator8.length) break; - _ref9 = _iterator8[_i8++]; - } else { - _i8 = _iterator8.next(); - if (_i8.done) break; - _ref9 = _i8.value; - } - - const _ref8 = _ref9; - const pattern = _ref8.pattern; - - resolutionDeps = [...resolutionDeps, { registry, pattern, optional, hint: 'resolution' }]; - } - } - - const pushDeps = function pushDeps(depType, manifest, { hint, optional }, isUsed) { - if (ignoreUnusedPatterns && !isUsed) { - return; - } - // We only take unused dependencies into consideration to get deterministic hoisting. - // Since flat mode doesn't care about hoisting and everything is top level and specified then we can safely - // leave these out. - if (_this.flags.flat && !isUsed) { - return; - } - const depMap = manifest[depType]; - for (const name in depMap) { - if (excludeNames.indexOf(name) >= 0) { - continue; - } - - let pattern = name; - if (!_this.lockfile.getLocked(pattern)) { - // when we use --save we save the dependency to the lockfile with just the name rather than the - // version combo - pattern += '@' + depMap[name]; - } - - // normalization made sure packages are mentioned only once - if (isUsed) { - usedPatterns.push(pattern); - } else { - ignorePatterns.push(pattern); - } - - _this.rootPatternsToOrigin[pattern] = depType; - patterns.push(pattern); - deps.push({ pattern, registry, hint, optional, workspaceName: manifest.name, workspaceLoc: manifest._loc }); - } - }; - - if (cwdIsRoot) { - pushDeps('dependencies', projectManifestJson, { hint: null, optional: false }, true); - pushDeps('devDependencies', projectManifestJson, { hint: 'dev', optional: false }, !_this.config.production); - pushDeps('optionalDependencies', projectManifestJson, { hint: 'optional', optional: true }, true); - } - - if (_this.config.workspaceRootFolder) { - const workspaceLoc = cwdIsRoot ? loc : path.join(_this.config.lockfileFolder, filename); - const workspacesRoot = path.dirname(workspaceLoc); - - let workspaceManifestJson = projectManifestJson; - if (!cwdIsRoot) { - // the manifest we read before was a child workspace, so get the root - workspaceManifestJson = yield _this.config.readJson(workspaceLoc); - yield (0, (_index || _load_index()).default)(workspaceManifestJson, workspacesRoot, _this.config, true); - } - - const workspaces = yield _this.config.resolveWorkspaces(workspacesRoot, workspaceManifestJson); - workspaceLayout = new (_workspaceLayout || _load_workspaceLayout()).default(workspaces, _this.config); - - // add virtual manifest that depends on all workspaces, this way package hoisters and resolvers will work fine - const workspaceDependencies = (0, (_extends2 || _load_extends()).default)({}, workspaceManifestJson.dependencies); - for (var _iterator5 = Object.keys(workspaces), _isArray5 = Array.isArray(_iterator5), _i5 = 0, _iterator5 = _isArray5 ? _iterator5 : _iterator5[Symbol.iterator]();;) { - var _ref5; - - if (_isArray5) { - if (_i5 >= _iterator5.length) break; - _ref5 = _iterator5[_i5++]; - } else { - _i5 = _iterator5.next(); - if (_i5.done) break; - _ref5 = _i5.value; - } - - const workspaceName = _ref5; - - const workspaceManifest = workspaces[workspaceName].manifest; - workspaceDependencies[workspaceName] = workspaceManifest.version; - - // include dependencies from all workspaces - if (_this.flags.includeWorkspaceDeps) { - pushDeps('dependencies', workspaceManifest, { hint: null, optional: false }, true); - pushDeps('devDependencies', workspaceManifest, { hint: 'dev', optional: false }, !_this.config.production); - pushDeps('optionalDependencies', workspaceManifest, { hint: 'optional', optional: true }, true); - } - } - const virtualDependencyManifest = { - _uid: '', - name: `workspace-aggregator-${uuid.v4()}`, - version: '1.0.0', - _registry: 'npm', - _loc: workspacesRoot, - dependencies: workspaceDependencies, - devDependencies: (0, (_extends2 || _load_extends()).default)({}, workspaceManifestJson.devDependencies), - optionalDependencies: (0, (_extends2 || _load_extends()).default)({}, workspaceManifestJson.optionalDependencies), - private: workspaceManifestJson.private, - workspaces: workspaceManifestJson.workspaces - }; - workspaceLayout.virtualManifestName = virtualDependencyManifest.name; - const virtualDep = {}; - virtualDep[virtualDependencyManifest.name] = virtualDependencyManifest.version; - workspaces[virtualDependencyManifest.name] = { loc: workspacesRoot, manifest: virtualDependencyManifest }; - - // ensure dependencies that should be excluded are stripped from the correct manifest - stripExcluded(cwdIsRoot ? virtualDependencyManifest : workspaces[projectManifestJson.name].manifest); - - pushDeps('workspaces', { workspaces: virtualDep }, { hint: 'workspaces', optional: false }, true); - - const implicitWorkspaceDependencies = (0, (_extends2 || _load_extends()).default)({}, workspaceDependencies); - - for (var _iterator6 = (_constants || _load_constants()).OWNED_DEPENDENCY_TYPES, _isArray6 = Array.isArray(_iterator6), _i6 = 0, _iterator6 = _isArray6 ? _iterator6 : _iterator6[Symbol.iterator]();;) { - var _ref6; - - if (_isArray6) { - if (_i6 >= _iterator6.length) break; - _ref6 = _iterator6[_i6++]; - } else { - _i6 = _iterator6.next(); - if (_i6.done) break; - _ref6 = _i6.value; - } - - const type = _ref6; - - for (var _iterator7 = Object.keys(projectManifestJson[type] || {}), _isArray7 = Array.isArray(_iterator7), _i7 = 0, _iterator7 = _isArray7 ? _iterator7 : _iterator7[Symbol.iterator]();;) { - var _ref7; - - if (_isArray7) { - if (_i7 >= _iterator7.length) break; - _ref7 = _iterator7[_i7++]; - } else { - _i7 = _iterator7.next(); - if (_i7.done) break; - _ref7 = _i7.value; - } - - const dependencyName = _ref7; - - delete implicitWorkspaceDependencies[dependencyName]; - } - } - - pushDeps('dependencies', { dependencies: implicitWorkspaceDependencies }, { hint: 'workspaces', optional: false }, true); - } - - break; - } - - // inherit root flat flag - if (manifest.flat) { - _this.flags.flat = true; - } - - return { - requests: [...resolutionDeps, ...deps], - patterns, - manifest, - usedPatterns, - ignorePatterns, - workspaceLayout - }; - })(); - } - - /** - * TODO description - */ - - prepareRequests(requests) { - return requests; - } - - preparePatterns(patterns) { - return patterns; - } - preparePatternsForLinking(patterns, cwdManifest, cwdIsRoot) { - return patterns; - } - - prepareManifests() { - var _this2 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - const manifests = yield _this2.config.getRootManifests(); - return manifests; - })(); - } - - bailout(patterns, workspaceLayout) { - var _this3 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - // We don't want to skip the audit - it could yield important errors - if (_this3.flags.audit) { - return false; - } - // PNP is so fast that the integrity check isn't pertinent - if (_this3.config.plugnplayEnabled) { - return false; - } - if (_this3.flags.skipIntegrityCheck || _this3.flags.force) { - return false; - } - const lockfileCache = _this3.lockfile.cache; - if (!lockfileCache) { - return false; - } - const lockfileClean = _this3.lockfile.parseResultType === 'success'; - const match = yield _this3.integrityChecker.check(patterns, lockfileCache, _this3.flags, workspaceLayout); - if (_this3.flags.frozenLockfile && (!lockfileClean || match.missingPatterns.length > 0)) { - throw new (_errors || _load_errors()).MessageError(_this3.reporter.lang('frozenLockfileError')); - } - - const haveLockfile = yield (_fs || _load_fs()).exists(path.join(_this3.config.lockfileFolder, (_constants || _load_constants()).LOCKFILE_FILENAME)); - - const lockfileIntegrityPresent = !_this3.lockfile.hasEntriesExistWithoutIntegrity(); - const integrityBailout = lockfileIntegrityPresent || !_this3.config.autoAddIntegrity; - - if (match.integrityMatches && haveLockfile && lockfileClean && integrityBailout) { - _this3.reporter.success(_this3.reporter.lang('upToDate')); - return true; - } - - if (match.integrityFileMissing && haveLockfile) { - // Integrity file missing, force script installations - _this3.scripts.setForce(true); - return false; - } - - if (match.hardRefreshRequired) { - // e.g. node version doesn't match, force script installations - _this3.scripts.setForce(true); - return false; - } - - if (!patterns.length && !match.integrityFileMissing) { - _this3.reporter.success(_this3.reporter.lang('nothingToInstall')); - yield _this3.createEmptyManifestFolders(); - yield _this3.saveLockfileAndIntegrity(patterns, workspaceLayout); - return true; - } - - return false; - })(); - } - - /** - * Produce empty folders for all used root manifests. - */ - - createEmptyManifestFolders() { - var _this4 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - if (_this4.config.modulesFolder) { - // already created - return; - } - - for (var _iterator9 = _this4.rootManifestRegistries, _isArray9 = Array.isArray(_iterator9), _i9 = 0, _iterator9 = _isArray9 ? _iterator9 : _iterator9[Symbol.iterator]();;) { - var _ref10; - - if (_isArray9) { - if (_i9 >= _iterator9.length) break; - _ref10 = _iterator9[_i9++]; - } else { - _i9 = _iterator9.next(); - if (_i9.done) break; - _ref10 = _i9.value; - } - - const registryName = _ref10; - const folder = _this4.config.registries[registryName].folder; - - yield (_fs || _load_fs()).mkdirp(path.join(_this4.config.lockfileFolder, folder)); - } - })(); - } - - /** - * TODO description - */ - - markIgnored(patterns) { - for (var _iterator10 = patterns, _isArray10 = Array.isArray(_iterator10), _i10 = 0, _iterator10 = _isArray10 ? _iterator10 : _iterator10[Symbol.iterator]();;) { - var _ref11; - - if (_isArray10) { - if (_i10 >= _iterator10.length) break; - _ref11 = _iterator10[_i10++]; - } else { - _i10 = _iterator10.next(); - if (_i10.done) break; - _ref11 = _i10.value; - } - - const pattern = _ref11; - - const manifest = this.resolver.getStrictResolvedPattern(pattern); - const ref = manifest._reference; - invariant(ref, 'expected package reference'); - - // just mark the package as ignored. if the package is used by a required package, the hoister - // will take care of that. - ref.ignore = true; - } - } - - /** - * helper method that gets only recent manifests - * used by global.ls command - */ - getFlattenedDeps() { - var _this5 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - var _ref12 = yield _this5.fetchRequestFromCwd(); - - const depRequests = _ref12.requests, - rawPatterns = _ref12.patterns; - - - yield _this5.resolver.init(depRequests, {}); - - const manifests = yield (_packageFetcher || _load_packageFetcher()).fetch(_this5.resolver.getManifests(), _this5.config); - _this5.resolver.updateManifests(manifests); - - return _this5.flatten(rawPatterns); - })(); - } - - /** - * TODO description - */ - - init() { - var _this6 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - _this6.checkUpdate(); - - // warn if we have a shrinkwrap - if (yield (_fs || _load_fs()).exists(path.join(_this6.config.lockfileFolder, (_constants || _load_constants()).NPM_SHRINKWRAP_FILENAME))) { - _this6.reporter.warn(_this6.reporter.lang('shrinkwrapWarning')); - } - - // warn if we have an npm lockfile - if (yield (_fs || _load_fs()).exists(path.join(_this6.config.lockfileFolder, (_constants || _load_constants()).NPM_LOCK_FILENAME))) { - _this6.reporter.warn(_this6.reporter.lang('npmLockfileWarning')); - } - - if (_this6.config.plugnplayEnabled) { - _this6.reporter.info(_this6.reporter.lang('plugnplaySuggestV2L1')); - _this6.reporter.info(_this6.reporter.lang('plugnplaySuggestV2L2')); - } - - let flattenedTopLevelPatterns = []; - const steps = []; - - var _ref13 = yield _this6.fetchRequestFromCwd(); - - const depRequests = _ref13.requests, - rawPatterns = _ref13.patterns, - ignorePatterns = _ref13.ignorePatterns, - workspaceLayout = _ref13.workspaceLayout, - manifest = _ref13.manifest; - - let topLevelPatterns = []; - - const artifacts = yield _this6.integrityChecker.getArtifacts(); - if (artifacts) { - _this6.linker.setArtifacts(artifacts); - _this6.scripts.setArtifacts(artifacts); - } - - if ((_packageCompatibility || _load_packageCompatibility()).shouldCheck(manifest, _this6.flags)) { - steps.push((() => { - var _ref14 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (curr, total) { - _this6.reporter.step(curr, total, _this6.reporter.lang('checkingManifest'), emoji.get('mag')); - yield _this6.checkCompatibility(); - }); - - return function (_x, _x2) { - return _ref14.apply(this, arguments); - }; - })()); - } - - const audit = new (_audit || _load_audit()).default(_this6.config, _this6.reporter, { groups: (_constants || _load_constants()).OWNED_DEPENDENCY_TYPES }); - let auditFoundProblems = false; - - steps.push(function (curr, total) { - return (0, (_hooks || _load_hooks()).callThroughHook)('resolveStep', (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - _this6.reporter.step(curr, total, _this6.reporter.lang('resolvingPackages'), emoji.get('mag')); - yield _this6.resolver.init(_this6.prepareRequests(depRequests), { - isFlat: _this6.flags.flat, - isFrozen: _this6.flags.frozenLockfile, - workspaceLayout - }); - topLevelPatterns = _this6.preparePatterns(rawPatterns); - flattenedTopLevelPatterns = yield _this6.flatten(topLevelPatterns); - return { bailout: !_this6.flags.audit && (yield _this6.bailout(topLevelPatterns, workspaceLayout)) }; - })); - }); - - if (_this6.flags.audit) { - steps.push(function (curr, total) { - return (0, (_hooks || _load_hooks()).callThroughHook)('auditStep', (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - _this6.reporter.step(curr, total, _this6.reporter.lang('auditRunning'), emoji.get('mag')); - if (_this6.flags.offline) { - _this6.reporter.warn(_this6.reporter.lang('auditOffline')); - return { bailout: false }; - } - const preparedManifests = yield _this6.prepareManifests(); - // $FlowFixMe - Flow considers `m` in the map operation to be "mixed", so does not recognize `m.object` - const mergedManifest = Object.assign({}, ...Object.values(preparedManifests).map(function (m) { - return m.object; - })); - const auditVulnerabilityCounts = yield audit.performAudit(mergedManifest, _this6.lockfile, _this6.resolver, _this6.linker, topLevelPatterns); - auditFoundProblems = auditVulnerabilityCounts.info || auditVulnerabilityCounts.low || auditVulnerabilityCounts.moderate || auditVulnerabilityCounts.high || auditVulnerabilityCounts.critical; - return { bailout: yield _this6.bailout(topLevelPatterns, workspaceLayout) }; - })); - }); - } - - steps.push(function (curr, total) { - return (0, (_hooks || _load_hooks()).callThroughHook)('fetchStep', (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - _this6.markIgnored(ignorePatterns); - _this6.reporter.step(curr, total, _this6.reporter.lang('fetchingPackages'), emoji.get('truck')); - const manifests = yield (_packageFetcher || _load_packageFetcher()).fetch(_this6.resolver.getManifests(), _this6.config); - _this6.resolver.updateManifests(manifests); - yield (_packageCompatibility || _load_packageCompatibility()).check(_this6.resolver.getManifests(), _this6.config, _this6.flags.ignoreEngines); - })); - }); - - steps.push(function (curr, total) { - return (0, (_hooks || _load_hooks()).callThroughHook)('linkStep', (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - // remove integrity hash to make this operation atomic - yield _this6.integrityChecker.removeIntegrityFile(); - _this6.reporter.step(curr, total, _this6.reporter.lang('linkingDependencies'), emoji.get('link')); - flattenedTopLevelPatterns = _this6.preparePatternsForLinking(flattenedTopLevelPatterns, manifest, _this6.config.lockfileFolder === _this6.config.cwd); - yield _this6.linker.init(flattenedTopLevelPatterns, workspaceLayout, { - linkDuplicates: _this6.flags.linkDuplicates, - ignoreOptional: _this6.flags.ignoreOptional - }); - })); - }); - - if (_this6.config.plugnplayEnabled) { - steps.push(function (curr, total) { - return (0, (_hooks || _load_hooks()).callThroughHook)('pnpStep', (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - const pnpPath = `${_this6.config.lockfileFolder}/${(_constants || _load_constants()).PNP_FILENAME}`; - - const code = yield (0, (_generatePnpMap || _load_generatePnpMap()).generatePnpMap)(_this6.config, flattenedTopLevelPatterns, { - resolver: _this6.resolver, - reporter: _this6.reporter, - targetPath: pnpPath, - workspaceLayout - }); - - try { - const file = yield (_fs || _load_fs()).readFile(pnpPath); - if (file === code) { - return; - } - } catch (error) {} - - yield (_fs || _load_fs()).writeFile(pnpPath, code); - yield (_fs || _load_fs()).chmod(pnpPath, 0o755); - })); - }); - } - - steps.push(function (curr, total) { - return (0, (_hooks || _load_hooks()).callThroughHook)('buildStep', (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - _this6.reporter.step(curr, total, _this6.flags.force ? _this6.reporter.lang('rebuildingPackages') : _this6.reporter.lang('buildingFreshPackages'), emoji.get('hammer')); - - if (_this6.config.ignoreScripts) { - _this6.reporter.warn(_this6.reporter.lang('ignoredScripts')); - } else { - yield _this6.scripts.init(flattenedTopLevelPatterns); - } - })); - }); - - if (_this6.flags.har) { - steps.push((() => { - var _ref21 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (curr, total) { - const formattedDate = new Date().toISOString().replace(/:/g, '-'); - const filename = `yarn-install_${formattedDate}.har`; - _this6.reporter.step(curr, total, _this6.reporter.lang('savingHar', filename), emoji.get('black_circle_for_record')); - yield _this6.config.requestManager.saveHar(filename); - }); - - return function (_x3, _x4) { - return _ref21.apply(this, arguments); - }; - })()); - } - - if (yield _this6.shouldClean()) { - steps.push((() => { - var _ref22 = (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* (curr, total) { - _this6.reporter.step(curr, total, _this6.reporter.lang('cleaningModules'), emoji.get('recycle')); - yield (0, (_autoclean || _load_autoclean()).clean)(_this6.config, _this6.reporter); - }); - - return function (_x5, _x6) { - return _ref22.apply(this, arguments); - }; - })()); - } - - let currentStep = 0; - for (var _iterator11 = steps, _isArray11 = Array.isArray(_iterator11), _i11 = 0, _iterator11 = _isArray11 ? _iterator11 : _iterator11[Symbol.iterator]();;) { - var _ref23; - - if (_isArray11) { - if (_i11 >= _iterator11.length) break; - _ref23 = _iterator11[_i11++]; - } else { - _i11 = _iterator11.next(); - if (_i11.done) break; - _ref23 = _i11.value; - } - - const step = _ref23; - - const stepResult = yield step(++currentStep, steps.length); - if (stepResult && stepResult.bailout) { - if (_this6.flags.audit) { - audit.summary(); - } - if (auditFoundProblems) { - _this6.reporter.warn(_this6.reporter.lang('auditRunAuditForDetails')); - } - _this6.maybeOutputUpdate(); - return flattenedTopLevelPatterns; - } - } - - // fin! - if (_this6.flags.audit) { - audit.summary(); - } - if (auditFoundProblems) { - _this6.reporter.warn(_this6.reporter.lang('auditRunAuditForDetails')); - } - yield _this6.saveLockfileAndIntegrity(topLevelPatterns, workspaceLayout); - yield _this6.persistChanges(); - _this6.maybeOutputUpdate(); - _this6.config.requestManager.clearCache(); - return flattenedTopLevelPatterns; - })(); - } - - checkCompatibility() { - var _this7 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - var _ref24 = yield _this7.fetchRequestFromCwd(); - - const manifest = _ref24.manifest; - - yield (_packageCompatibility || _load_packageCompatibility()).checkOne(manifest, _this7.config, _this7.flags.ignoreEngines); - })(); - } - - persistChanges() { - var _this8 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - // get all the different registry manifests in this folder - const manifests = yield _this8.config.getRootManifests(); - - if (yield _this8.applyChanges(manifests)) { - yield _this8.config.saveRootManifests(manifests); - } - })(); - } - - applyChanges(manifests) { - let hasChanged = false; - - if (this.config.plugnplayPersist) { - const object = manifests.npm.object; - - - if (typeof object.installConfig !== 'object') { - object.installConfig = {}; - } - - if (this.config.plugnplayEnabled && object.installConfig.pnp !== true) { - object.installConfig.pnp = true; - hasChanged = true; - } else if (!this.config.plugnplayEnabled && typeof object.installConfig.pnp !== 'undefined') { - delete object.installConfig.pnp; - hasChanged = true; - } - - if (Object.keys(object.installConfig).length === 0) { - delete object.installConfig; - } - } - - return Promise.resolve(hasChanged); - } - - /** - * Check if we should run the cleaning step. - */ - - shouldClean() { - return (_fs || _load_fs()).exists(path.join(this.config.lockfileFolder, (_constants || _load_constants()).CLEAN_FILENAME)); - } - - /** - * TODO - */ - - flatten(patterns) { - var _this9 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - if (!_this9.flags.flat) { - return patterns; - } - - const flattenedPatterns = []; - - for (var _iterator12 = _this9.resolver.getAllDependencyNamesByLevelOrder(patterns), _isArray12 = Array.isArray(_iterator12), _i12 = 0, _iterator12 = _isArray12 ? _iterator12 : _iterator12[Symbol.iterator]();;) { - var _ref25; - - if (_isArray12) { - if (_i12 >= _iterator12.length) break; - _ref25 = _iterator12[_i12++]; - } else { - _i12 = _iterator12.next(); - if (_i12.done) break; - _ref25 = _i12.value; - } - - const name = _ref25; - - const infos = _this9.resolver.getAllInfoForPackageName(name).filter(function (manifest) { - const ref = manifest._reference; - invariant(ref, 'expected package reference'); - return !ref.ignore; - }); - - if (infos.length === 0) { - continue; - } - - if (infos.length === 1) { - // single version of this package - // take out a single pattern as multiple patterns may have resolved to this package - flattenedPatterns.push(_this9.resolver.patternsByPackage[name][0]); - continue; - } - - const options = infos.map(function (info) { - const ref = info._reference; - invariant(ref, 'expected reference'); - return { - // TODO `and is required by {PARENT}`, - name: _this9.reporter.lang('manualVersionResolutionOption', ref.patterns.join(', '), info.version), - - value: info.version - }; - }); - const versions = infos.map(function (info) { - return info.version; - }); - let version; - - const resolutionVersion = _this9.resolutions[name]; - if (resolutionVersion && versions.indexOf(resolutionVersion) >= 0) { - // use json `resolution` version - version = resolutionVersion; - } else { - version = yield _this9.reporter.select(_this9.reporter.lang('manualVersionResolution', name), _this9.reporter.lang('answer'), options); - _this9.resolutions[name] = version; - } - - flattenedPatterns.push(_this9.resolver.collapseAllVersionsOfPackage(name, version)); - } - - // save resolutions to their appropriate root manifest - if (Object.keys(_this9.resolutions).length) { - const manifests = yield _this9.config.getRootManifests(); - - for (const name in _this9.resolutions) { - const version = _this9.resolutions[name]; - - const patterns = _this9.resolver.patternsByPackage[name]; - if (!patterns) { - continue; - } - - let manifest; - for (var _iterator13 = patterns, _isArray13 = Array.isArray(_iterator13), _i13 = 0, _iterator13 = _isArray13 ? _iterator13 : _iterator13[Symbol.iterator]();;) { - var _ref26; - - if (_isArray13) { - if (_i13 >= _iterator13.length) break; - _ref26 = _iterator13[_i13++]; - } else { - _i13 = _iterator13.next(); - if (_i13.done) break; - _ref26 = _i13.value; - } - - const pattern = _ref26; - - manifest = _this9.resolver.getResolvedPattern(pattern); - if (manifest) { - break; - } - } - invariant(manifest, 'expected manifest'); - - const ref = manifest._reference; - invariant(ref, 'expected reference'); - - const object = manifests[ref.registry].object; - object.resolutions = object.resolutions || {}; - object.resolutions[name] = version; - } - - yield _this9.config.saveRootManifests(manifests); - } - - return flattenedPatterns; - })(); - } - - /** - * Remove offline tarballs that are no longer required - */ - - pruneOfflineMirror(lockfile) { - var _this10 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - const mirror = _this10.config.getOfflineMirrorPath(); - if (!mirror) { - return; - } - - const requiredTarballs = new Set(); - for (const dependency in lockfile) { - const resolved = lockfile[dependency].resolved; - if (resolved) { - const basename = path.basename(resolved.split('#')[0]); - if (dependency[0] === '@' && basename[0] !== '@') { - requiredTarballs.add(`${dependency.split('/')[0]}-${basename}`); - } - requiredTarballs.add(basename); - } - } - - const mirrorFiles = yield (_fs || _load_fs()).walk(mirror); - for (var _iterator14 = mirrorFiles, _isArray14 = Array.isArray(_iterator14), _i14 = 0, _iterator14 = _isArray14 ? _iterator14 : _iterator14[Symbol.iterator]();;) { - var _ref27; - - if (_isArray14) { - if (_i14 >= _iterator14.length) break; - _ref27 = _iterator14[_i14++]; - } else { - _i14 = _iterator14.next(); - if (_i14.done) break; - _ref27 = _i14.value; - } - - const file = _ref27; - - const isTarball = path.extname(file.basename) === '.tgz'; - // if using experimental-pack-script-packages-in-mirror flag, don't unlink prebuilt packages - const hasPrebuiltPackage = file.relative.startsWith('prebuilt/'); - if (isTarball && !hasPrebuiltPackage && !requiredTarballs.has(file.basename)) { - yield (_fs || _load_fs()).unlink(file.absolute); - } - } - })(); - } - - /** - * Save updated integrity and lockfiles. - */ - - saveLockfileAndIntegrity(patterns, workspaceLayout) { - var _this11 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - const resolvedPatterns = {}; - Object.keys(_this11.resolver.patterns).forEach(function (pattern) { - if (!workspaceLayout || !workspaceLayout.getManifestByPattern(pattern)) { - resolvedPatterns[pattern] = _this11.resolver.patterns[pattern]; - } - }); - - // TODO this code is duplicated in a few places, need a common way to filter out workspace patterns from lockfile - patterns = patterns.filter(function (p) { - return !workspaceLayout || !workspaceLayout.getManifestByPattern(p); - }); - - const lockfileBasedOnResolver = _this11.lockfile.getLockfile(resolvedPatterns); - - if (_this11.config.pruneOfflineMirror) { - yield _this11.pruneOfflineMirror(lockfileBasedOnResolver); - } - - // write integrity hash - if (!_this11.config.plugnplayEnabled) { - yield _this11.integrityChecker.save(patterns, lockfileBasedOnResolver, _this11.flags, workspaceLayout, _this11.scripts.getArtifacts()); - } - - // --no-lockfile or --pure-lockfile or --frozen-lockfile - if (_this11.flags.lockfile === false || _this11.flags.pureLockfile || _this11.flags.frozenLockfile) { - return; - } - - const lockFileHasAllPatterns = patterns.every(function (p) { - return _this11.lockfile.getLocked(p); - }); - const lockfilePatternsMatch = Object.keys(_this11.lockfile.cache || {}).every(function (p) { - return lockfileBasedOnResolver[p]; - }); - const resolverPatternsAreSameAsInLockfile = Object.keys(lockfileBasedOnResolver).every(function (pattern) { - const manifest = _this11.lockfile.getLocked(pattern); - return manifest && manifest.resolved === lockfileBasedOnResolver[pattern].resolved && deepEqual(manifest.prebuiltVariants, lockfileBasedOnResolver[pattern].prebuiltVariants); - }); - const integrityPatternsAreSameAsInLockfile = Object.keys(lockfileBasedOnResolver).every(function (pattern) { - const existingIntegrityInfo = lockfileBasedOnResolver[pattern].integrity; - if (!existingIntegrityInfo) { - // if this entry does not have an integrity, no need to re-write the lockfile because of it - return true; - } - const manifest = _this11.lockfile.getLocked(pattern); - if (manifest && manifest.integrity) { - const manifestIntegrity = ssri.stringify(manifest.integrity); - return manifestIntegrity === existingIntegrityInfo; - } - return false; - }); - - // remove command is followed by install with force, lockfile will be rewritten in any case then - if (!_this11.flags.force && _this11.lockfile.parseResultType === 'success' && lockFileHasAllPatterns && lockfilePatternsMatch && resolverPatternsAreSameAsInLockfile && integrityPatternsAreSameAsInLockfile && patterns.length) { - return; - } - - // build lockfile location - const loc = path.join(_this11.config.lockfileFolder, (_constants || _load_constants()).LOCKFILE_FILENAME); - - // write lockfile - const lockSource = (0, (_lockfile2 || _load_lockfile2()).stringify)(lockfileBasedOnResolver, false, _this11.config.enableLockfileVersions); - yield (_fs || _load_fs()).writeFilePreservingEol(loc, lockSource); - - _this11._logSuccessSaveLockfile(); - })(); - } - - _logSuccessSaveLockfile() { - this.reporter.success(this.reporter.lang('savedLockfile')); - } - - /** - * Load the dependency graph of the current install. Only does package resolving and wont write to the cwd. - */ - hydrate(ignoreUnusedPatterns) { - var _this12 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - const request = yield _this12.fetchRequestFromCwd([], ignoreUnusedPatterns); - const depRequests = request.requests, - rawPatterns = request.patterns, - ignorePatterns = request.ignorePatterns, - workspaceLayout = request.workspaceLayout; - - - yield _this12.resolver.init(depRequests, { - isFlat: _this12.flags.flat, - isFrozen: _this12.flags.frozenLockfile, - workspaceLayout - }); - yield _this12.flatten(rawPatterns); - _this12.markIgnored(ignorePatterns); - - // fetch packages, should hit cache most of the time - const manifests = yield (_packageFetcher || _load_packageFetcher()).fetch(_this12.resolver.getManifests(), _this12.config); - _this12.resolver.updateManifests(manifests); - yield (_packageCompatibility || _load_packageCompatibility()).check(_this12.resolver.getManifests(), _this12.config, _this12.flags.ignoreEngines); - - // expand minimal manifests - for (var _iterator15 = _this12.resolver.getManifests(), _isArray15 = Array.isArray(_iterator15), _i15 = 0, _iterator15 = _isArray15 ? _iterator15 : _iterator15[Symbol.iterator]();;) { - var _ref28; - - if (_isArray15) { - if (_i15 >= _iterator15.length) break; - _ref28 = _iterator15[_i15++]; - } else { - _i15 = _iterator15.next(); - if (_i15.done) break; - _ref28 = _i15.value; - } - - const manifest = _ref28; - - const ref = manifest._reference; - invariant(ref, 'expected reference'); - const type = ref.remote.type; - // link specifier won't ever hit cache - - let loc = ''; - if (type === 'link') { - continue; - } else if (type === 'workspace') { - if (!ref.remote.reference) { - continue; - } - loc = ref.remote.reference; - } else { - loc = _this12.config.generateModuleCachePath(ref); - } - const newPkg = yield _this12.config.readManifest(loc); - yield _this12.resolver.updateManifest(ref, newPkg); - } - - return request; - })(); - } - - /** - * Check for updates every day and output a nag message if there's a newer version. - */ - - checkUpdate() { - if (this.config.nonInteractive) { - // don't show upgrade dialog on CI or non-TTY terminals - return; - } - - // don't check if disabled - if (this.config.getOption('disable-self-update-check')) { - return; - } - - // only check for updates once a day - const lastUpdateCheck = Number(this.config.getOption('lastUpdateCheck')) || 0; - if (lastUpdateCheck && Date.now() - lastUpdateCheck < ONE_DAY) { - return; - } - - // don't bug for updates on tagged releases - if ((_yarnVersion || _load_yarnVersion()).version.indexOf('-') >= 0) { - return; - } - - this._checkUpdate().catch(() => { - // swallow errors - }); - } - - _checkUpdate() { - var _this13 = this; - - return (0, (_asyncToGenerator2 || _load_asyncToGenerator()).default)(function* () { - let latestVersion = yield _this13.config.requestManager.request({ - url: (_constants || _load_constants()).SELF_UPDATE_VERSION_URL - }); - invariant(typeof latestVersion === 'string', 'expected string'); - latestVersion = latestVersion.trim(); - if (!semver.valid(latestVersion)) { - return; - } - - // ensure we only check for updates periodically - _this13.config.registries.yarn.saveHomeConfig({ - lastUpdateCheck: Date.now() - }); - - if (semver.gt(latestVersion, (_yarnVersion || _load_yarnVersion()).version)) { - const installationMethod = yield (0, (_yarnVersion || _load_yarnVersion()).getInstallationMethod)(); - _this13.maybeOutputUpdate = function () { - _this13.reporter.warn(_this13.reporter.lang('yarnOutdated', latestVersion, (_yarnVersion || _load_yarnVersion()).version)); - - const command = getUpdateCommand(installationMethod); - if (command) { - _this13.reporter.info(_this13.reporter.lang('yarnOutdatedCommand')); - _this13.reporter.command(command); - } else { - const installer = getUpdateInstaller(installationMethod); - if (installer) { - _this13.reporter.info(_this13.reporter.lang('yarnOutdatedInstaller', installer)); - } - } - }; - } - })(); - } - - /** - * Method to override with a possible upgrade message. - */ - - maybeOutputUpdate() {} -} - -exports.Install = Install; -function hasWrapper(commander, args) { - return true; -} - -function setFlags(commander) { - commander.description('Yarn install is used to install all dependencies for a project.'); - commander.usage('install [flags]'); - commander.option('-A, --audit', 'Run vulnerability audit on installed packages'); - commander.option('-g, --global', 'DEPRECATED'); - commander.option('-S, --save', 'DEPRECATED - save package to your `dependencies`'); - commander.option('-D, --save-dev', 'DEPRECATED - save package to your `devDependencies`'); - commander.option('-P, --save-peer', 'DEPRECATED - save package to your `peerDependencies`'); - commander.option('-O, --save-optional', 'DEPRECATED - save package to your `optionalDependencies`'); - commander.option('-E, --save-exact', 'DEPRECATED'); - commander.option('-T, --save-tilde', 'DEPRECATED'); -} - -/***/ }), -/* 35 */ -/***/ (function(module, exports, __webpack_require__) { - -var isObject = __webpack_require__(53); -module.exports = function (it) { - if (!isObject(it)) throw TypeError(it + ' is not an object!'); - return it; -}; - - -/***/ }), -/* 36 */ -/***/ (function(module, __webpack_exports__, __webpack_require__) { - -"use strict"; -/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "b", function() { return SubjectSubscriber; }); -/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return Subject; }); -/* unused harmony export AnonymousSubject */ -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_0_tslib__ = __webpack_require__(1); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_1__Observable__ = __webpack_require__(12); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_2__Subscriber__ = __webpack_require__(7); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_3__Subscription__ = __webpack_require__(25); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_4__util_ObjectUnsubscribedError__ = __webpack_require__(190); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_5__SubjectSubscription__ = __webpack_require__(422); -/* harmony import */ var __WEBPACK_IMPORTED_MODULE_6__internal_symbol_rxSubscriber__ = __webpack_require__(322); -/** PURE_IMPORTS_START tslib,_Observable,_Subscriber,_Subscription,_util_ObjectUnsubscribedError,_SubjectSubscription,_internal_symbol_rxSubscriber PURE_IMPORTS_END */ - - - - - - - -var SubjectSubscriber = /*@__PURE__*/ (function (_super) { - __WEBPACK_IMPORTED_MODULE_0_tslib__["a" /* __extends */](SubjectSubscriber, _super); - function SubjectSubscriber(destination) { - var _this = _super.call(this, destination) || this; - _this.destination = destination; - return _this; - } - return SubjectSubscriber; -}(__WEBPACK_IMPORTED_MODULE_2__Subscriber__["a" /* Subscriber */])); - -var Subject = /*@__PURE__*/ (function (_super) { - __WEBPACK_IMPORTED_MODULE_0_tslib__["a" /* __extends */](Subject, _super); - function Subject() { - var _this = _super.call(this) || this; - _this.observers = []; - _this.closed = false; - _this.isStopped = false; - _this.hasError = false; - _this.thrownError = null; - return _this; - } - Subject.prototype[__WEBPACK_IMPORTED_MODULE_6__internal_symbol_rxSubscriber__["a" /* rxSubscriber */]] = function () { - return new SubjectSubscriber(this); - }; - Subject.prototype.lift = function (operator) { - var subject = new AnonymousSubject(this, this); - subject.operator = operator; - return subject; - }; - Subject.prototype.next = function (value) { - if (this.closed) { - throw new __WEBPACK_IMPORTED_MODULE_4__util_ObjectUnsubscribedError__["a" /* ObjectUnsubscribedError */](); - } - if (!this.isStopped) { - var observers = this.observers; - var len = observers.length; - var copy = observers.slice(); - for (var i = 0; i < len; i++) { - copy[i].next(value); - } - } - }; - Subject.prototype.error = function (err) { - if (this.closed) { - throw new __WEBPACK_IMPORTED_MODULE_4__util_ObjectUnsubscribedError__["a" /* ObjectUnsubscribedError */](); - } - this.hasError = true; - this.thrownError = err; - this.isStopped = true; - var observers = this.observers; - var len = observers.length; - var copy = observers.slice(); - for (var i = 0; i < len; i++) { - copy[i].error(err); - } - this.observers.length = 0; - }; - Subject.prototype.complete = function () { - if (this.closed) { - throw new __WEBPACK_IMPORTED_MODULE_4__util_ObjectUnsubscribedError__["a" /* ObjectUnsubscribedError */](); - } - this.isStopped = true; - var observers = this.observers; - var len = observers.length; - var copy = observers.slice(); - for (var i = 0; i < len; i++) { - copy[i].complete(); - } - this.observers.length = 0; - }; - Subject.prototype.unsubscribe = function () { - this.isStopped = true; - this.closed = true; - this.observers = null; - }; - Subject.prototype._trySubscribe = function (subscriber) { - if (this.closed) { - throw new __WEBPACK_IMPORTED_MODULE_4__util_ObjectUnsubscribedError__["a" /* ObjectUnsubscribedError */](); - } - else { - return _super.prototype._trySubscribe.call(this, subscriber); - } - }; - Subject.prototype._subscribe = function (subscriber) { - if (this.closed) { - throw new __WEBPACK_IMPORTED_MODULE_4__util_ObjectUnsubscribedError__["a" /* ObjectUnsubscribedError */](); - } - else if (this.hasError) { - subscriber.error(this.thrownError); - return __WEBPACK_IMPORTED_MODULE_3__Subscription__["a" /* Subscription */].EMPTY; - } - else if (this.isStopped) { - subscriber.complete(); - return __WEBPACK_IMPORTED_MODULE_3__Subscription__["a" /* Subscription */].EMPTY; - } - else { - this.observers.push(subscriber); - return new __WEBPACK_IMPORTED_MODULE_5__SubjectSubscription__["a" /* SubjectSubscription */](this, subscriber); - } - }; - Subject.prototype.asObservable = function () { - var observable = new __WEBPACK_IMPORTED_MODULE_1__Observable__["a" /* Observable */](); - observable.source = this; - return observable; - }; - Subject.create = function (destination, source) { - return new AnonymousSubject(destination, source); - }; - return Subject; -}(__WEBPACK_IMPORTED_MODULE_1__Observable__["a" /* Observable */])); - -var AnonymousSubject = /*@__PURE__*/ (function (_super) { - __WEBPACK_IMPORTED_MODULE_0_tslib__["a" /* __extends */](AnonymousSubject, _super); - function AnonymousSubject(destination, source) { - var _this = _super.call(this) || this; - _this.destination = destination; - _this.source = source; - return _this; - } - AnonymousSubject.prototype.next = function (value) { - var destination = this.destination; - if (destination && destination.next) { - destination.next(value); - } - }; - AnonymousSubject.prototype.error = function (err) { - var destination = this.destination; - if (destination && destination.error) { - this.destination.error(err); - } - }; - AnonymousSubject.prototype.complete = function () { - var destination = this.destination; - if (destination && destination.complete) { - this.destination.complete(); - } - }; - AnonymousSubject.prototype._subscribe = function (subscriber) { - var source = this.source; - if (source) { - return this.source.subscribe(subscriber); - } - else { - return __WEBPACK_IMPORTED_MODULE_3__Subscription__["a" /* Subscription */].EMPTY; - } - }; - return AnonymousSubject; -}(Subject)); - -//# sourceMappingURL=Subject.js.map - - -/***/ }), -/* 37 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); -exports.normalizePattern = normalizePattern; - -/** - * Explode and normalize a pattern into its name and range. - */ - -function normalizePattern(pattern) { - let hasVersion = false; - let range = 'latest'; - let name = pattern; - - // if we're a scope then remove the @ and add it back later - let isScoped = false; - if (name[0] === '@') { - isScoped = true; - name = name.slice(1); - } - - // take first part as the name - const parts = name.split('@'); - if (parts.length > 1) { - name = parts.shift(); - range = parts.join('@'); - - if (range) { - hasVersion = true; - } else { - range = '*'; - } - } - - // add back @ scope suffix - if (isScoped) { - name = `@${name}`; - } - - return { name, range, hasVersion }; -} - -/***/ }), -/* 38 */ -/***/ (function(module, exports, __webpack_require__) { - -/* WEBPACK VAR INJECTION */(function(module) {var __WEBPACK_AMD_DEFINE_RESULT__;/** - * @license - * Lodash - * Copyright JS Foundation and other contributors - * Released under MIT license - * Based on Underscore.js 1.8.3 - * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors - */ -;(function() { - - /** Used as a safe reference for `undefined` in pre-ES5 environments. */ - var undefined; - - /** Used as the semantic version number. */ - var VERSION = '4.17.10'; - - /** Used as the size to enable large array optimizations. */ - var LARGE_ARRAY_SIZE = 200; - - /** Error message constants. */ - var CORE_ERROR_TEXT = 'Unsupported core-js use. Try https://npms.io/search?q=ponyfill.', - FUNC_ERROR_TEXT = 'Expected a function'; - - /** Used to stand-in for `undefined` hash values. */ - var HASH_UNDEFINED = '__lodash_hash_undefined__'; - - /** Used as the maximum memoize cache size. */ - var MAX_MEMOIZE_SIZE = 500; - - /** Used as the internal argument placeholder. */ - var PLACEHOLDER = '__lodash_placeholder__'; - - /** Used to compose bitmasks for cloning. */ - var CLONE_DEEP_FLAG = 1, - CLONE_FLAT_FLAG = 2, - CLONE_SYMBOLS_FLAG = 4; - - /** Used to compose bitmasks for value comparisons. */ - var COMPARE_PARTIAL_FLAG = 1, - COMPARE_UNORDERED_FLAG = 2; - - /** Used to compose bitmasks for function metadata. */ - var WRAP_BIND_FLAG = 1, - WRAP_BIND_KEY_FLAG = 2, - WRAP_CURRY_BOUND_FLAG = 4, - WRAP_CURRY_FLAG = 8, - WRAP_CURRY_RIGHT_FLAG = 16, - WRAP_PARTIAL_FLAG = 32, - WRAP_PARTIAL_RIGHT_FLAG = 64, - WRAP_ARY_FLAG = 128, - WRAP_REARG_FLAG = 256, - WRAP_FLIP_FLAG = 512; - - /** Used as default options for `_.truncate`. */ - var DEFAULT_TRUNC_LENGTH = 30, - DEFAULT_TRUNC_OMISSION = '...'; - - /** Used to detect hot functions by number of calls within a span of milliseconds. */ - var HOT_COUNT = 800, - HOT_SPAN = 16; - - /** Used to indicate the type of lazy iteratees. */ - var LAZY_FILTER_FLAG = 1, - LAZY_MAP_FLAG = 2, - LAZY_WHILE_FLAG = 3; - - /** Used as references for various `Number` constants. */ - var INFINITY = 1 / 0, - MAX_SAFE_INTEGER = 9007199254740991, - MAX_INTEGER = 1.7976931348623157e+308, - NAN = 0 / 0; - - /** Used as references for the maximum length and index of an array. */ - var MAX_ARRAY_LENGTH = 4294967295, - MAX_ARRAY_INDEX = MAX_ARRAY_LENGTH - 1, - HALF_MAX_ARRAY_LENGTH = MAX_ARRAY_LENGTH >>> 1; - - /** Used to associate wrap methods with their bit flags. */ - var wrapFlags = [ - ['ary', WRAP_ARY_FLAG], - ['bind', WRAP_BIND_FLAG], - ['bindKey', WRAP_BIND_KEY_FLAG], - ['curry', WRAP_CURRY_FLAG], - ['curryRight', WRAP_CURRY_RIGHT_FLAG], - ['flip', WRAP_FLIP_FLAG], - ['partial', WRAP_PARTIAL_FLAG], - ['partialRight', WRAP_PARTIAL_RIGHT_FLAG], - ['rearg', WRAP_REARG_FLAG] - ]; - - /** `Object#toString` result references. */ - var argsTag = '[object Arguments]', - arrayTag = '[object Array]', - asyncTag = '[object AsyncFunction]', - boolTag = '[object Boolean]', - dateTag = '[object Date]', - domExcTag = '[object DOMException]', - errorTag = '[object Error]', - funcTag = '[object Function]', - genTag = '[object GeneratorFunction]', - mapTag = '[object Map]', - numberTag = '[object Number]', - nullTag = '[object Null]', - objectTag = '[object Object]', - promiseTag = '[object Promise]', - proxyTag = '[object Proxy]', - regexpTag = '[object RegExp]', - setTag = '[object Set]', - stringTag = '[object String]', - symbolTag = '[object Symbol]', - undefinedTag = '[object Undefined]', - weakMapTag = '[object WeakMap]', - weakSetTag = '[object WeakSet]'; - - var arrayBufferTag = '[object ArrayBuffer]', - dataViewTag = '[object DataView]', - float32Tag = '[object Float32Array]', - float64Tag = '[object Float64Array]', - int8Tag = '[object Int8Array]', - int16Tag = '[object Int16Array]', - int32Tag = '[object Int32Array]', - uint8Tag = '[object Uint8Array]', - uint8ClampedTag = '[object Uint8ClampedArray]', - uint16Tag = '[object Uint16Array]', - uint32Tag = '[object Uint32Array]'; - - /** Used to match empty string literals in compiled template source. */ - var reEmptyStringLeading = /\b__p \+= '';/g, - reEmptyStringMiddle = /\b(__p \+=) '' \+/g, - reEmptyStringTrailing = /(__e\(.*?\)|\b__t\)) \+\n'';/g; - - /** Used to match HTML entities and HTML characters. */ - var reEscapedHtml = /&(?:amp|lt|gt|quot|#39);/g, - reUnescapedHtml = /[&<>"']/g, - reHasEscapedHtml = RegExp(reEscapedHtml.source), - reHasUnescapedHtml = RegExp(reUnescapedHtml.source); - - /** Used to match template delimiters. */ - var reEscape = /<%-([\s\S]+?)%>/g, - reEvaluate = /<%([\s\S]+?)%>/g, - reInterpolate = /<%=([\s\S]+?)%>/g; - - /** Used to match property names within property paths. */ - var reIsDeepProp = /\.|\[(?:[^[\]]*|(["'])(?:(?!\1)[^\\]|\\.)*?\1)\]/, - reIsPlainProp = /^\w*$/, - rePropName = /[^.[\]]+|\[(?:(-?\d+(?:\.\d+)?)|(["'])((?:(?!\2)[^\\]|\\.)*?)\2)\]|(?=(?:\.|\[\])(?:\.|\[\]|$))/g; - - /** - * Used to match `RegExp` - * [syntax characters](http://ecma-international.org/ecma-262/7.0/#sec-patterns). - */ - var reRegExpChar = /[\\^$.*+?()[\]{}|]/g, - reHasRegExpChar = RegExp(reRegExpChar.source); - - /** Used to match leading and trailing whitespace. */ - var reTrim = /^\s+|\s+$/g, - reTrimStart = /^\s+/, - reTrimEnd = /\s+$/; - - /** Used to match wrap detail comments. */ - var reWrapComment = /\{(?:\n\/\* \[wrapped with .+\] \*\/)?\n?/, - reWrapDetails = /\{\n\/\* \[wrapped with (.+)\] \*/, - reSplitDetails = /,? & /; - - /** Used to match words composed of alphanumeric characters. */ - var reAsciiWord = /[^\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\x7f]+/g; - - /** Used to match backslashes in property paths. */ - var reEscapeChar = /\\(\\)?/g; - - /** - * Used to match - * [ES template delimiters](http://ecma-international.org/ecma-262/7.0/#sec-template-literal-lexical-components). - */ - var reEsTemplate = /\$\{([^\\}]*(?:\\.[^\\}]*)*)\}/g; - - /** Used to match `RegExp` flags from their coerced string values. */ - var reFlags = /\w*$/; - - /** Used to detect bad signed hexadecimal string values. */ - var reIsBadHex = /^[-+]0x[0-9a-f]+$/i; - - /** Used to detect binary string values. */ - var reIsBinary = /^0b[01]+$/i; - - /** Used to detect host constructors (Safari). */ - var reIsHostCtor = /^\[object .+?Constructor\]$/; - - /** Used to detect octal string values. */ - var reIsOctal = /^0o[0-7]+$/i; - - /** Used to detect unsigned integer values. */ - var reIsUint = /^(?:0|[1-9]\d*)$/; - - /** Used to match Latin Unicode letters (excluding mathematical operators). */ - var reLatin = /[\xc0-\xd6\xd8-\xf6\xf8-\xff\u0100-\u017f]/g; - - /** Used to ensure capturing order of template delimiters. */ - var reNoMatch = /($^)/; - - /** Used to match unescaped characters in compiled string literals. */ - var reUnescapedString = /['\n\r\u2028\u2029\\]/g; - - /** Used to compose unicode character classes. */ - var rsAstralRange = '\\ud800-\\udfff', - rsComboMarksRange = '\\u0300-\\u036f', - reComboHalfMarksRange = '\\ufe20-\\ufe2f', - rsComboSymbolsRange = '\\u20d0-\\u20ff', - rsComboRange = rsComboMarksRange + reComboHalfMarksRange + rsComboSymbolsRange, - rsDingbatRange = '\\u2700-\\u27bf', - rsLowerRange = 'a-z\\xdf-\\xf6\\xf8-\\xff', - rsMathOpRange = '\\xac\\xb1\\xd7\\xf7', - rsNonCharRange = '\\x00-\\x2f\\x3a-\\x40\\x5b-\\x60\\x7b-\\xbf', - rsPunctuationRange = '\\u2000-\\u206f', - rsSpaceRange = ' \\t\\x0b\\f\\xa0\\ufeff\\n\\r\\u2028\\u2029\\u1680\\u180e\\u2000\\u2001\\u2002\\u2003\\u2004\\u2005\\u2006\\u2007\\u2008\\u2009\\u200a\\u202f\\u205f\\u3000', - rsUpperRange = 'A-Z\\xc0-\\xd6\\xd8-\\xde', - rsVarRange = '\\ufe0e\\ufe0f', - rsBreakRange = rsMathOpRange + rsNonCharRange + rsPunctuationRange + rsSpaceRange; - - /** Used to compose unicode capture groups. */ - var rsApos = "['\u2019]", - rsAstral = '[' + rsAstralRange + ']', - rsBreak = '[' + rsBreakRange + ']', - rsCombo = '[' + rsComboRange + ']', - rsDigits = '\\d+', - rsDingbat = '[' + rsDingbatRange + ']', - rsLower = '[' + rsLowerRange + ']', - rsMisc = '[^' + rsAstralRange + rsBreakRange + rsDigits + rsDingbatRange + rsLowerRange + rsUpperRange + ']', - rsFitz = '\\ud83c[\\udffb-\\udfff]', - rsModifier = '(?:' + rsCombo + '|' + rsFitz + ')', - rsNonAstral = '[^' + rsAstralRange + ']', - rsRegional = '(?:\\ud83c[\\udde6-\\uddff]){2}', - rsSurrPair = '[\\ud800-\\udbff][\\udc00-\\udfff]', - rsUpper = '[' + rsUpperRange + ']', - rsZWJ = '\\u200d'; - - /** Used to compose unicode regexes. */ - var rsMiscLower = '(?:' + rsLower + '|' + rsMisc + ')', - rsMiscUpper = '(?:' + rsUpper + '|' + rsMisc + ')', - rsOptContrLower = '(?:' + rsApos + '(?:d|ll|m|re|s|t|ve))?', - rsOptContrUpper = '(?:' + rsApos + '(?:D|LL|M|RE|S|T|VE))?', - reOptMod = rsModifier + '?', - rsOptVar = '[' + rsVarRange + ']?', - rsOptJoin = '(?:' + rsZWJ + '(?:' + [rsNonAstral, rsRegional, rsSurrPair].join('|') + ')' + rsOptVar + reOptMod + ')*', - rsOrdLower = '\\d*(?:1st|2nd|3rd|(?![123])\\dth)(?=\\b|[A-Z_])', - rsOrdUpper = '\\d*(?:1ST|2ND|3RD|(?![123])\\dTH)(?=\\b|[a-z_])', - rsSeq = rsOptVar + reOptMod + rsOptJoin, - rsEmoji = '(?:' + [rsDingbat, rsRegional, rsSurrPair].join('|') + ')' + rsSeq, - rsSymbol = '(?:' + [rsNonAstral + rsCombo + '?', rsCombo, rsRegional, rsSurrPair, rsAstral].join('|') + ')'; - - /** Used to match apostrophes. */ - var reApos = RegExp(rsApos, 'g'); - - /** - * Used to match [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks) and - * [combining diacritical marks for symbols](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks_for_Symbols). - */ - var reComboMark = RegExp(rsCombo, 'g'); - - /** Used to match [string symbols](https://mathiasbynens.be/notes/javascript-unicode). */ - var reUnicode = RegExp(rsFitz + '(?=' + rsFitz + ')|' + rsSymbol + rsSeq, 'g'); - - /** Used to match complex or compound words. */ - var reUnicodeWord = RegExp([ - rsUpper + '?' + rsLower + '+' + rsOptContrLower + '(?=' + [rsBreak, rsUpper, '$'].join('|') + ')', - rsMiscUpper + '+' + rsOptContrUpper + '(?=' + [rsBreak, rsUpper + rsMiscLower, '$'].join('|') + ')', - rsUpper + '?' + rsMiscLower + '+' + rsOptContrLower, - rsUpper + '+' + rsOptContrUpper, - rsOrdUpper, - rsOrdLower, - rsDigits, - rsEmoji - ].join('|'), 'g'); - - /** Used to detect strings with [zero-width joiners or code points from the astral planes](http://eev.ee/blog/2015/09/12/dark-corners-of-unicode/). */ - var reHasUnicode = RegExp('[' + rsZWJ + rsAstralRange + rsComboRange + rsVarRange + ']'); - - /** Used to detect strings that need a more robust regexp to match words. */ - var reHasUnicodeWord = /[a-z][A-Z]|[A-Z]{2,}[a-z]|[0-9][a-zA-Z]|[a-zA-Z][0-9]|[^a-zA-Z0-9 ]/; - - /** Used to assign default `context` object properties. */ - var contextProps = [ - 'Array', 'Buffer', 'DataView', 'Date', 'Error', 'Float32Array', 'Float64Array', - 'Function', 'Int8Array', 'Int16Array', 'Int32Array', 'Map', 'Math', 'Object', - 'Promise', 'RegExp', 'Set', 'String', 'Symbol', 'TypeError', 'Uint8Array', - 'Uint8ClampedArray', 'Uint16Array', 'Uint32Array', 'WeakMap', - '_', 'clearTimeout', 'isFinite', 'parseInt', 'setTimeout' - ]; - - /** Used to make template sourceURLs easier to identify. */ - var templateCounter = -1; - - /** Used to identify `toStringTag` values of typed arrays. */ - var typedArrayTags = {}; - typedArrayTags[float32Tag] = typedArrayTags[float64Tag] = - typedArrayTags[int8Tag] = typedArrayTags[int16Tag] = - typedArrayTags[int32Tag] = typedArrayTags[uint8Tag] = - typedArrayTags[uint8ClampedTag] = typedArrayTags[uint16Tag] = - typedArrayTags[uint32Tag] = true; - typedArrayTags[argsTag] = typedArrayTags[arrayTag] = - typedArrayTags[arrayBufferTag] = typedArrayTags[boolTag] = - typedArrayTags[dataViewTag] = typedArrayTags[dateTag] = - typedArrayTags[errorTag] = typedArrayTags[funcTag] = - typedArrayTags[mapTag] = typedArrayTags[numberTag] = - typedArrayTags[objectTag] = typedArrayTags[regexpTag] = - typedArrayTags[setTag] = typedArrayTags[stringTag] = - typedArrayTags[weakMapTag] = false; - - /** Used to identify `toStringTag` values supported by `_.clone`. */ - var cloneableTags = {}; - cloneableTags[argsTag] = cloneableTags[arrayTag] = - cloneableTags[arrayBufferTag] = cloneableTags[dataViewTag] = - cloneableTags[boolTag] = cloneableTags[dateTag] = - cloneableTags[float32Tag] = cloneableTags[float64Tag] = - cloneableTags[int8Tag] = cloneableTags[int16Tag] = - cloneableTags[int32Tag] = cloneableTags[mapTag] = - cloneableTags[numberTag] = cloneableTags[objectTag] = - cloneableTags[regexpTag] = cloneableTags[setTag] = - cloneableTags[stringTag] = cloneableTags[symbolTag] = - cloneableTags[uint8Tag] = cloneableTags[uint8ClampedTag] = - cloneableTags[uint16Tag] = cloneableTags[uint32Tag] = true; - cloneableTags[errorTag] = cloneableTags[funcTag] = - cloneableTags[weakMapTag] = false; - - /** Used to map Latin Unicode letters to basic Latin letters. */ - var deburredLetters = { - // Latin-1 Supplement block. - '\xc0': 'A', '\xc1': 'A', '\xc2': 'A', '\xc3': 'A', '\xc4': 'A', '\xc5': 'A', - '\xe0': 'a', '\xe1': 'a', '\xe2': 'a', '\xe3': 'a', '\xe4': 'a', '\xe5': 'a', - '\xc7': 'C', '\xe7': 'c', - '\xd0': 'D', '\xf0': 'd', - '\xc8': 'E', '\xc9': 'E', '\xca': 'E', '\xcb': 'E', - '\xe8': 'e', '\xe9': 'e', '\xea': 'e', '\xeb': 'e', - '\xcc': 'I', '\xcd': 'I', '\xce': 'I', '\xcf': 'I', - '\xec': 'i', '\xed': 'i', '\xee': 'i', '\xef': 'i', - '\xd1': 'N', '\xf1': 'n', - '\xd2': 'O', '\xd3': 'O', '\xd4': 'O', '\xd5': 'O', '\xd6': 'O', '\xd8': 'O', - '\xf2': 'o', '\xf3': 'o', '\xf4': 'o', '\xf5': 'o', '\xf6': 'o', '\xf8': 'o', - '\xd9': 'U', '\xda': 'U', '\xdb': 'U', '\xdc': 'U', - '\xf9': 'u', '\xfa': 'u', '\xfb': 'u', '\xfc': 'u', - '\xdd': 'Y', '\xfd': 'y', '\xff': 'y', - '\xc6': 'Ae', '\xe6': 'ae', - '\xde': 'Th', '\xfe': 'th', - '\xdf': 'ss', - // Latin Extended-A block. - '\u0100': 'A', '\u0102': 'A', '\u0104': 'A', - '\u0101': 'a', '\u0103': 'a', '\u0105': 'a', - '\u0106': 'C', '\u0108': 'C', '\u010a': 'C', '\u010c': 'C', - '\u0107': 'c', '\u0109': 'c', '\u010b': 'c', '\u010d': 'c', - '\u010e': 'D', '\u0110': 'D', '\u010f': 'd', '\u0111': 'd', - '\u0112': 'E', '\u0114': 'E', '\u0116': 'E', '\u0118': 'E', '\u011a': 'E', - '\u0113': 'e', '\u0115': 'e', '\u0117': 'e', '\u0119': 'e', '\u011b': 'e', - '\u011c': 'G', '\u011e': 'G', '\u0120': 'G', '\u0122': 'G', - '\u011d': 'g', '\u011f': 'g', '\u0121': 'g', '\u0123': 'g', - '\u0124': 'H', '\u0126': 'H', '\u0125': 'h', '\u0127': 'h', - '\u0128': 'I', '\u012a': 'I', '\u012c': 'I', '\u012e': 'I', '\u0130': 'I', - '\u0129': 'i', '\u012b': 'i', '\u012d': 'i', '\u012f': 'i', '\u0131': 'i', - '\u0134': 'J', '\u0135': 'j', - '\u0136': 'K', '\u0137': 'k', '\u0138': 'k', - '\u0139': 'L', '\u013b': 'L', '\u013d': 'L', '\u013f': 'L', '\u0141': 'L', - '\u013a': 'l', '\u013c': 'l', '\u013e': 'l', '\u0140': 'l', '\u0142': 'l', - '\u0143': 'N', '\u0145': 'N', '\u0147': 'N', '\u014a': 'N', - '\u0144': 'n', '\u0146': 'n', '\u0148': 'n', '\u014b': 'n', - '\u014c': 'O', '\u014e': 'O', '\u0150': 'O', - '\u014d': 'o', '\u014f': 'o', '\u0151': 'o', - '\u0154': 'R', '\u0156': 'R', '\u0158': 'R', - '\u0155': 'r', '\u0157': 'r', '\u0159': 'r', - '\u015a': 'S', '\u015c': 'S', '\u015e': 'S', '\u0160': 'S', - '\u015b': 's', '\u015d': 's', '\u015f': 's', '\u0161': 's', - '\u0162': 'T', '\u0164': 'T', '\u0166': 'T', - '\u0163': 't', '\u0165': 't', '\u0167': 't', - '\u0168': 'U', '\u016a': 'U', '\u016c': 'U', '\u016e': 'U', '\u0170': 'U', '\u0172': 'U', - '\u0169': 'u', '\u016b': 'u', '\u016d': 'u', '\u016f': 'u', '\u0171': 'u', '\u0173': 'u', - '\u0174': 'W', '\u0175': 'w', - '\u0176': 'Y', '\u0177': 'y', '\u0178': 'Y', - '\u0179': 'Z', '\u017b': 'Z', '\u017d': 'Z', - '\u017a': 'z', '\u017c': 'z', '\u017e': 'z', - '\u0132': 'IJ', '\u0133': 'ij', - '\u0152': 'Oe', '\u0153': 'oe', - '\u0149': "'n", '\u017f': 's' - }; - - /** Used to map characters to HTML entities. */ - var htmlEscapes = { - '&': '&', - '<': '<', - '>': '>', - '"': '"', - "'": ''' - }; - - /** Used to map HTML entities to characters. */ - var htmlUnescapes = { - '&': '&', - '<': '<', - '>': '>', - '"': '"', - ''': "'" - }; - - /** Used to escape characters for inclusion in compiled string literals. */ - var stringEscapes = { - '\\': '\\', - "'": "'", - '\n': 'n', - '\r': 'r', - '\u2028': 'u2028', - '\u2029': 'u2029' - }; - - /** Built-in method references without a dependency on `root`. */ - var freeParseFloat = parseFloat, - freeParseInt = parseInt; - - /** Detect free variable `global` from Node.js. */ - var freeGlobal = typeof global == 'object' && global && global.Object === Object && global; - - /** Detect free variable `self`. */ - var freeSelf = typeof self == 'object' && self && self.Object === Object && self; - - /** Used as a reference to the global object. */ - var root = freeGlobal || freeSelf || Function('return this')(); - - /** Detect free variable `exports`. */ - var freeExports = typeof exports == 'object' && exports && !exports.nodeType && exports; - - /** Detect free variable `module`. */ - var freeModule = freeExports && typeof module == 'object' && module && !module.nodeType && module; - - /** Detect the popular CommonJS extension `module.exports`. */ - var moduleExports = freeModule && freeModule.exports === freeExports; - - /** Detect free variable `process` from Node.js. */ - var freeProcess = moduleExports && freeGlobal.process; - - /** Used to access faster Node.js helpers. */ - var nodeUtil = (function() { - try { - // Use `util.types` for Node.js 10+. - var types = freeModule && freeModule.require && freeModule.require('util').types; - - if (types) { - return types; - } - - // Legacy `process.binding('util')` for Node.js < 10. - return freeProcess && freeProcess.binding && freeProcess.binding('util'); - } catch (e) {} - }()); - - /* Node.js helper references. */ - var nodeIsArrayBuffer = nodeUtil && nodeUtil.isArrayBuffer, - nodeIsDate = nodeUtil && nodeUtil.isDate, - nodeIsMap = nodeUtil && nodeUtil.isMap, - nodeIsRegExp = nodeUtil && nodeUtil.isRegExp, - nodeIsSet = nodeUtil && nodeUtil.isSet, - nodeIsTypedArray = nodeUtil && nodeUtil.isTypedArray; - - /*--------------------------------------------------------------------------*/ - - /** - * A faster alternative to `Function#apply`, this function invokes `func` - * with the `this` binding of `thisArg` and the arguments of `args`. - * - * @private - * @param {Function} func The function to invoke. - * @param {*} thisArg The `this` binding of `func`. - * @param {Array} args The arguments to invoke `func` with. - * @returns {*} Returns the result of `func`. - */ - function apply(func, thisArg, args) { - switch (args.length) { - case 0: return func.call(thisArg); - case 1: return func.call(thisArg, args[0]); - case 2: return func.call(thisArg, args[0], args[1]); - case 3: return func.call(thisArg, args[0], args[1], args[2]); - } - return func.apply(thisArg, args); - } - - /** - * A specialized version of `baseAggregator` for arrays. - * - * @private - * @param {Array} [array] The array to iterate over. - * @param {Function} setter The function to set `accumulator` values. - * @param {Function} iteratee The iteratee to transform keys. - * @param {Object} accumulator The initial aggregated object. - * @returns {Function} Returns `accumulator`. - */ - function arrayAggregator(array, setter, iteratee, accumulator) { - var index = -1, - length = array == null ? 0 : array.length; - - while (++index < length) { - var value = array[index]; - setter(accumulator, value, iteratee(value), array); - } - return accumulator; - } - - /** - * A specialized version of `_.forEach` for arrays without support for - * iteratee shorthands. - * - * @private - * @param {Array} [array] The array to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {Array} Returns `array`. - */ - function arrayEach(array, iteratee) { - var index = -1, - length = array == null ? 0 : array.length; - - while (++index < length) { - if (iteratee(array[index], index, array) === false) { - break; - } - } - return array; - } - - /** - * A specialized version of `_.forEachRight` for arrays without support for - * iteratee shorthands. - * - * @private - * @param {Array} [array] The array to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {Array} Returns `array`. - */ - function arrayEachRight(array, iteratee) { - var length = array == null ? 0 : array.length; - - while (length--) { - if (iteratee(array[length], length, array) === false) { - break; - } - } - return array; - } - - /** - * A specialized version of `_.every` for arrays without support for - * iteratee shorthands. - * - * @private - * @param {Array} [array] The array to iterate over. - * @param {Function} predicate The function invoked per iteration. - * @returns {boolean} Returns `true` if all elements pass the predicate check, - * else `false`. - */ - function arrayEvery(array, predicate) { - var index = -1, - length = array == null ? 0 : array.length; - - while (++index < length) { - if (!predicate(array[index], index, array)) { - return false; - } - } - return true; - } - - /** - * A specialized version of `_.filter` for arrays without support for - * iteratee shorthands. - * - * @private - * @param {Array} [array] The array to iterate over. - * @param {Function} predicate The function invoked per iteration. - * @returns {Array} Returns the new filtered array. - */ - function arrayFilter(array, predicate) { - var index = -1, - length = array == null ? 0 : array.length, - resIndex = 0, - result = []; - - while (++index < length) { - var value = array[index]; - if (predicate(value, index, array)) { - result[resIndex++] = value; - } - } - return result; - } - - /** - * A specialized version of `_.includes` for arrays without support for - * specifying an index to search from. - * - * @private - * @param {Array} [array] The array to inspect. - * @param {*} target The value to search for. - * @returns {boolean} Returns `true` if `target` is found, else `false`. - */ - function arrayIncludes(array, value) { - var length = array == null ? 0 : array.length; - return !!length && baseIndexOf(array, value, 0) > -1; - } - - /** - * This function is like `arrayIncludes` except that it accepts a comparator. - * - * @private - * @param {Array} [array] The array to inspect. - * @param {*} target The value to search for. - * @param {Function} comparator The comparator invoked per element. - * @returns {boolean} Returns `true` if `target` is found, else `false`. - */ - function arrayIncludesWith(array, value, comparator) { - var index = -1, - length = array == null ? 0 : array.length; - - while (++index < length) { - if (comparator(value, array[index])) { - return true; - } - } - return false; - } - - /** - * A specialized version of `_.map` for arrays without support for iteratee - * shorthands. - * - * @private - * @param {Array} [array] The array to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {Array} Returns the new mapped array. - */ - function arrayMap(array, iteratee) { - var index = -1, - length = array == null ? 0 : array.length, - result = Array(length); - - while (++index < length) { - result[index] = iteratee(array[index], index, array); - } - return result; - } - - /** - * Appends the elements of `values` to `array`. - * - * @private - * @param {Array} array The array to modify. - * @param {Array} values The values to append. - * @returns {Array} Returns `array`. - */ - function arrayPush(array, values) { - var index = -1, - length = values.length, - offset = array.length; - - while (++index < length) { - array[offset + index] = values[index]; - } - return array; - } - - /** - * A specialized version of `_.reduce` for arrays without support for - * iteratee shorthands. - * - * @private - * @param {Array} [array] The array to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @param {*} [accumulator] The initial value. - * @param {boolean} [initAccum] Specify using the first element of `array` as - * the initial value. - * @returns {*} Returns the accumulated value. - */ - function arrayReduce(array, iteratee, accumulator, initAccum) { - var index = -1, - length = array == null ? 0 : array.length; - - if (initAccum && length) { - accumulator = array[++index]; - } - while (++index < length) { - accumulator = iteratee(accumulator, array[index], index, array); - } - return accumulator; - } - - /** - * A specialized version of `_.reduceRight` for arrays without support for - * iteratee shorthands. - * - * @private - * @param {Array} [array] The array to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @param {*} [accumulator] The initial value. - * @param {boolean} [initAccum] Specify using the last element of `array` as - * the initial value. - * @returns {*} Returns the accumulated value. - */ - function arrayReduceRight(array, iteratee, accumulator, initAccum) { - var length = array == null ? 0 : array.length; - if (initAccum && length) { - accumulator = array[--length]; - } - while (length--) { - accumulator = iteratee(accumulator, array[length], length, array); - } - return accumulator; - } - - /** - * A specialized version of `_.some` for arrays without support for iteratee - * shorthands. - * - * @private - * @param {Array} [array] The array to iterate over. - * @param {Function} predicate The function invoked per iteration. - * @returns {boolean} Returns `true` if any element passes the predicate check, - * else `false`. - */ - function arraySome(array, predicate) { - var index = -1, - length = array == null ? 0 : array.length; - - while (++index < length) { - if (predicate(array[index], index, array)) { - return true; - } - } - return false; - } - - /** - * Gets the size of an ASCII `string`. - * - * @private - * @param {string} string The string inspect. - * @returns {number} Returns the string size. - */ - var asciiSize = baseProperty('length'); - - /** - * Converts an ASCII `string` to an array. - * - * @private - * @param {string} string The string to convert. - * @returns {Array} Returns the converted array. - */ - function asciiToArray(string) { - return string.split(''); - } - - /** - * Splits an ASCII `string` into an array of its words. - * - * @private - * @param {string} The string to inspect. - * @returns {Array} Returns the words of `string`. - */ - function asciiWords(string) { - return string.match(reAsciiWord) || []; - } - - /** - * The base implementation of methods like `_.findKey` and `_.findLastKey`, - * without support for iteratee shorthands, which iterates over `collection` - * using `eachFunc`. - * - * @private - * @param {Array|Object} collection The collection to inspect. - * @param {Function} predicate The function invoked per iteration. - * @param {Function} eachFunc The function to iterate over `collection`. - * @returns {*} Returns the found element or its key, else `undefined`. - */ - function baseFindKey(collection, predicate, eachFunc) { - var result; - eachFunc(collection, function(value, key, collection) { - if (predicate(value, key, collection)) { - result = key; - return false; - } - }); - return result; - } - - /** - * The base implementation of `_.findIndex` and `_.findLastIndex` without - * support for iteratee shorthands. - * - * @private - * @param {Array} array The array to inspect. - * @param {Function} predicate The function invoked per iteration. - * @param {number} fromIndex The index to search from. - * @param {boolean} [fromRight] Specify iterating from right to left. - * @returns {number} Returns the index of the matched value, else `-1`. - */ - function baseFindIndex(array, predicate, fromIndex, fromRight) { - var length = array.length, - index = fromIndex + (fromRight ? 1 : -1); - - while ((fromRight ? index-- : ++index < length)) { - if (predicate(array[index], index, array)) { - return index; - } - } - return -1; - } - - /** - * The base implementation of `_.indexOf` without `fromIndex` bounds checks. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} value The value to search for. - * @param {number} fromIndex The index to search from. - * @returns {number} Returns the index of the matched value, else `-1`. - */ - function baseIndexOf(array, value, fromIndex) { - return value === value - ? strictIndexOf(array, value, fromIndex) - : baseFindIndex(array, baseIsNaN, fromIndex); - } - - /** - * This function is like `baseIndexOf` except that it accepts a comparator. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} value The value to search for. - * @param {number} fromIndex The index to search from. - * @param {Function} comparator The comparator invoked per element. - * @returns {number} Returns the index of the matched value, else `-1`. - */ - function baseIndexOfWith(array, value, fromIndex, comparator) { - var index = fromIndex - 1, - length = array.length; - - while (++index < length) { - if (comparator(array[index], value)) { - return index; - } - } - return -1; - } - - /** - * The base implementation of `_.isNaN` without support for number objects. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is `NaN`, else `false`. - */ - function baseIsNaN(value) { - return value !== value; - } - - /** - * The base implementation of `_.mean` and `_.meanBy` without support for - * iteratee shorthands. - * - * @private - * @param {Array} array The array to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {number} Returns the mean. - */ - function baseMean(array, iteratee) { - var length = array == null ? 0 : array.length; - return length ? (baseSum(array, iteratee) / length) : NAN; - } - - /** - * The base implementation of `_.property` without support for deep paths. - * - * @private - * @param {string} key The key of the property to get. - * @returns {Function} Returns the new accessor function. - */ - function baseProperty(key) { - return function(object) { - return object == null ? undefined : object[key]; - }; - } - - /** - * The base implementation of `_.propertyOf` without support for deep paths. - * - * @private - * @param {Object} object The object to query. - * @returns {Function} Returns the new accessor function. - */ - function basePropertyOf(object) { - return function(key) { - return object == null ? undefined : object[key]; - }; - } - - /** - * The base implementation of `_.reduce` and `_.reduceRight`, without support - * for iteratee shorthands, which iterates over `collection` using `eachFunc`. - * - * @private - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @param {*} accumulator The initial value. - * @param {boolean} initAccum Specify using the first or last element of - * `collection` as the initial value. - * @param {Function} eachFunc The function to iterate over `collection`. - * @returns {*} Returns the accumulated value. - */ - function baseReduce(collection, iteratee, accumulator, initAccum, eachFunc) { - eachFunc(collection, function(value, index, collection) { - accumulator = initAccum - ? (initAccum = false, value) - : iteratee(accumulator, value, index, collection); - }); - return accumulator; - } - - /** - * The base implementation of `_.sortBy` which uses `comparer` to define the - * sort order of `array` and replaces criteria objects with their corresponding - * values. - * - * @private - * @param {Array} array The array to sort. - * @param {Function} comparer The function to define sort order. - * @returns {Array} Returns `array`. - */ - function baseSortBy(array, comparer) { - var length = array.length; - - array.sort(comparer); - while (length--) { - array[length] = array[length].value; - } - return array; - } - - /** - * The base implementation of `_.sum` and `_.sumBy` without support for - * iteratee shorthands. - * - * @private - * @param {Array} array The array to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {number} Returns the sum. - */ - function baseSum(array, iteratee) { - var result, - index = -1, - length = array.length; - - while (++index < length) { - var current = iteratee(array[index]); - if (current !== undefined) { - result = result === undefined ? current : (result + current); - } - } - return result; - } - - /** - * The base implementation of `_.times` without support for iteratee shorthands - * or max array length checks. - * - * @private - * @param {number} n The number of times to invoke `iteratee`. - * @param {Function} iteratee The function invoked per iteration. - * @returns {Array} Returns the array of results. - */ - function baseTimes(n, iteratee) { - var index = -1, - result = Array(n); - - while (++index < n) { - result[index] = iteratee(index); - } - return result; - } - - /** - * The base implementation of `_.toPairs` and `_.toPairsIn` which creates an array - * of key-value pairs for `object` corresponding to the property names of `props`. - * - * @private - * @param {Object} object The object to query. - * @param {Array} props The property names to get values for. - * @returns {Object} Returns the key-value pairs. - */ - function baseToPairs(object, props) { - return arrayMap(props, function(key) { - return [key, object[key]]; - }); - } - - /** - * The base implementation of `_.unary` without support for storing metadata. - * - * @private - * @param {Function} func The function to cap arguments for. - * @returns {Function} Returns the new capped function. - */ - function baseUnary(func) { - return function(value) { - return func(value); - }; - } - - /** - * The base implementation of `_.values` and `_.valuesIn` which creates an - * array of `object` property values corresponding to the property names - * of `props`. - * - * @private - * @param {Object} object The object to query. - * @param {Array} props The property names to get values for. - * @returns {Object} Returns the array of property values. - */ - function baseValues(object, props) { - return arrayMap(props, function(key) { - return object[key]; - }); - } - - /** - * Checks if a `cache` value for `key` exists. - * - * @private - * @param {Object} cache The cache to query. - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ - function cacheHas(cache, key) { - return cache.has(key); - } - - /** - * Used by `_.trim` and `_.trimStart` to get the index of the first string symbol - * that is not found in the character symbols. - * - * @private - * @param {Array} strSymbols The string symbols to inspect. - * @param {Array} chrSymbols The character symbols to find. - * @returns {number} Returns the index of the first unmatched string symbol. - */ - function charsStartIndex(strSymbols, chrSymbols) { - var index = -1, - length = strSymbols.length; - - while (++index < length && baseIndexOf(chrSymbols, strSymbols[index], 0) > -1) {} - return index; - } - - /** - * Used by `_.trim` and `_.trimEnd` to get the index of the last string symbol - * that is not found in the character symbols. - * - * @private - * @param {Array} strSymbols The string symbols to inspect. - * @param {Array} chrSymbols The character symbols to find. - * @returns {number} Returns the index of the last unmatched string symbol. - */ - function charsEndIndex(strSymbols, chrSymbols) { - var index = strSymbols.length; - - while (index-- && baseIndexOf(chrSymbols, strSymbols[index], 0) > -1) {} - return index; - } - - /** - * Gets the number of `placeholder` occurrences in `array`. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} placeholder The placeholder to search for. - * @returns {number} Returns the placeholder count. - */ - function countHolders(array, placeholder) { - var length = array.length, - result = 0; - - while (length--) { - if (array[length] === placeholder) { - ++result; - } - } - return result; - } - - /** - * Used by `_.deburr` to convert Latin-1 Supplement and Latin Extended-A - * letters to basic Latin letters. - * - * @private - * @param {string} letter The matched letter to deburr. - * @returns {string} Returns the deburred letter. - */ - var deburrLetter = basePropertyOf(deburredLetters); - - /** - * Used by `_.escape` to convert characters to HTML entities. - * - * @private - * @param {string} chr The matched character to escape. - * @returns {string} Returns the escaped character. - */ - var escapeHtmlChar = basePropertyOf(htmlEscapes); - - /** - * Used by `_.template` to escape characters for inclusion in compiled string literals. - * - * @private - * @param {string} chr The matched character to escape. - * @returns {string} Returns the escaped character. - */ - function escapeStringChar(chr) { - return '\\' + stringEscapes[chr]; - } - - /** - * Gets the value at `key` of `object`. - * - * @private - * @param {Object} [object] The object to query. - * @param {string} key The key of the property to get. - * @returns {*} Returns the property value. - */ - function getValue(object, key) { - return object == null ? undefined : object[key]; - } - - /** - * Checks if `string` contains Unicode symbols. - * - * @private - * @param {string} string The string to inspect. - * @returns {boolean} Returns `true` if a symbol is found, else `false`. - */ - function hasUnicode(string) { - return reHasUnicode.test(string); - } - - /** - * Checks if `string` contains a word composed of Unicode symbols. - * - * @private - * @param {string} string The string to inspect. - * @returns {boolean} Returns `true` if a word is found, else `false`. - */ - function hasUnicodeWord(string) { - return reHasUnicodeWord.test(string); - } - - /** - * Converts `iterator` to an array. - * - * @private - * @param {Object} iterator The iterator to convert. - * @returns {Array} Returns the converted array. - */ - function iteratorToArray(iterator) { - var data, - result = []; - - while (!(data = iterator.next()).done) { - result.push(data.value); - } - return result; - } - - /** - * Converts `map` to its key-value pairs. - * - * @private - * @param {Object} map The map to convert. - * @returns {Array} Returns the key-value pairs. - */ - function mapToArray(map) { - var index = -1, - result = Array(map.size); - - map.forEach(function(value, key) { - result[++index] = [key, value]; - }); - return result; - } - - /** - * Creates a unary function that invokes `func` with its argument transformed. - * - * @private - * @param {Function} func The function to wrap. - * @param {Function} transform The argument transform. - * @returns {Function} Returns the new function. - */ - function overArg(func, transform) { - return function(arg) { - return func(transform(arg)); - }; - } - - /** - * Replaces all `placeholder` elements in `array` with an internal placeholder - * and returns an array of their indexes. - * - * @private - * @param {Array} array The array to modify. - * @param {*} placeholder The placeholder to replace. - * @returns {Array} Returns the new array of placeholder indexes. - */ - function replaceHolders(array, placeholder) { - var index = -1, - length = array.length, - resIndex = 0, - result = []; - - while (++index < length) { - var value = array[index]; - if (value === placeholder || value === PLACEHOLDER) { - array[index] = PLACEHOLDER; - result[resIndex++] = index; - } - } - return result; - } - - /** - * Gets the value at `key`, unless `key` is "__proto__". - * - * @private - * @param {Object} object The object to query. - * @param {string} key The key of the property to get. - * @returns {*} Returns the property value. - */ - function safeGet(object, key) { - return key == '__proto__' - ? undefined - : object[key]; - } - - /** - * Converts `set` to an array of its values. - * - * @private - * @param {Object} set The set to convert. - * @returns {Array} Returns the values. - */ - function setToArray(set) { - var index = -1, - result = Array(set.size); - - set.forEach(function(value) { - result[++index] = value; - }); - return result; - } - - /** - * Converts `set` to its value-value pairs. - * - * @private - * @param {Object} set The set to convert. - * @returns {Array} Returns the value-value pairs. - */ - function setToPairs(set) { - var index = -1, - result = Array(set.size); - - set.forEach(function(value) { - result[++index] = [value, value]; - }); - return result; - } - - /** - * A specialized version of `_.indexOf` which performs strict equality - * comparisons of values, i.e. `===`. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} value The value to search for. - * @param {number} fromIndex The index to search from. - * @returns {number} Returns the index of the matched value, else `-1`. - */ - function strictIndexOf(array, value, fromIndex) { - var index = fromIndex - 1, - length = array.length; - - while (++index < length) { - if (array[index] === value) { - return index; - } - } - return -1; - } - - /** - * A specialized version of `_.lastIndexOf` which performs strict equality - * comparisons of values, i.e. `===`. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} value The value to search for. - * @param {number} fromIndex The index to search from. - * @returns {number} Returns the index of the matched value, else `-1`. - */ - function strictLastIndexOf(array, value, fromIndex) { - var index = fromIndex + 1; - while (index--) { - if (array[index] === value) { - return index; - } - } - return index; - } - - /** - * Gets the number of symbols in `string`. - * - * @private - * @param {string} string The string to inspect. - * @returns {number} Returns the string size. - */ - function stringSize(string) { - return hasUnicode(string) - ? unicodeSize(string) - : asciiSize(string); - } - - /** - * Converts `string` to an array. - * - * @private - * @param {string} string The string to convert. - * @returns {Array} Returns the converted array. - */ - function stringToArray(string) { - return hasUnicode(string) - ? unicodeToArray(string) - : asciiToArray(string); - } - - /** - * Used by `_.unescape` to convert HTML entities to characters. - * - * @private - * @param {string} chr The matched character to unescape. - * @returns {string} Returns the unescaped character. - */ - var unescapeHtmlChar = basePropertyOf(htmlUnescapes); - - /** - * Gets the size of a Unicode `string`. - * - * @private - * @param {string} string The string inspect. - * @returns {number} Returns the string size. - */ - function unicodeSize(string) { - var result = reUnicode.lastIndex = 0; - while (reUnicode.test(string)) { - ++result; - } - return result; - } - - /** - * Converts a Unicode `string` to an array. - * - * @private - * @param {string} string The string to convert. - * @returns {Array} Returns the converted array. - */ - function unicodeToArray(string) { - return string.match(reUnicode) || []; - } - - /** - * Splits a Unicode `string` into an array of its words. - * - * @private - * @param {string} The string to inspect. - * @returns {Array} Returns the words of `string`. - */ - function unicodeWords(string) { - return string.match(reUnicodeWord) || []; - } - - /*--------------------------------------------------------------------------*/ - - /** - * Create a new pristine `lodash` function using the `context` object. - * - * @static - * @memberOf _ - * @since 1.1.0 - * @category Util - * @param {Object} [context=root] The context object. - * @returns {Function} Returns a new `lodash` function. - * @example - * - * _.mixin({ 'foo': _.constant('foo') }); - * - * var lodash = _.runInContext(); - * lodash.mixin({ 'bar': lodash.constant('bar') }); - * - * _.isFunction(_.foo); - * // => true - * _.isFunction(_.bar); - * // => false - * - * lodash.isFunction(lodash.foo); - * // => false - * lodash.isFunction(lodash.bar); - * // => true - * - * // Create a suped-up `defer` in Node.js. - * var defer = _.runInContext({ 'setTimeout': setImmediate }).defer; - */ - var runInContext = (function runInContext(context) { - context = context == null ? root : _.defaults(root.Object(), context, _.pick(root, contextProps)); - - /** Built-in constructor references. */ - var Array = context.Array, - Date = context.Date, - Error = context.Error, - Function = context.Function, - Math = context.Math, - Object = context.Object, - RegExp = context.RegExp, - String = context.String, - TypeError = context.TypeError; - - /** Used for built-in method references. */ - var arrayProto = Array.prototype, - funcProto = Function.prototype, - objectProto = Object.prototype; - - /** Used to detect overreaching core-js shims. */ - var coreJsData = context['__core-js_shared__']; - - /** Used to resolve the decompiled source of functions. */ - var funcToString = funcProto.toString; - - /** Used to check objects for own properties. */ - var hasOwnProperty = objectProto.hasOwnProperty; - - /** Used to generate unique IDs. */ - var idCounter = 0; - - /** Used to detect methods masquerading as native. */ - var maskSrcKey = (function() { - var uid = /[^.]+$/.exec(coreJsData && coreJsData.keys && coreJsData.keys.IE_PROTO || ''); - return uid ? ('Symbol(src)_1.' + uid) : ''; - }()); - - /** - * Used to resolve the - * [`toStringTag`](http://ecma-international.org/ecma-262/7.0/#sec-object.prototype.tostring) - * of values. - */ - var nativeObjectToString = objectProto.toString; - - /** Used to infer the `Object` constructor. */ - var objectCtorString = funcToString.call(Object); - - /** Used to restore the original `_` reference in `_.noConflict`. */ - var oldDash = root._; - - /** Used to detect if a method is native. */ - var reIsNative = RegExp('^' + - funcToString.call(hasOwnProperty).replace(reRegExpChar, '\\$&') - .replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g, '$1.*?') + '$' - ); - - /** Built-in value references. */ - var Buffer = moduleExports ? context.Buffer : undefined, - Symbol = context.Symbol, - Uint8Array = context.Uint8Array, - allocUnsafe = Buffer ? Buffer.allocUnsafe : undefined, - getPrototype = overArg(Object.getPrototypeOf, Object), - objectCreate = Object.create, - propertyIsEnumerable = objectProto.propertyIsEnumerable, - splice = arrayProto.splice, - spreadableSymbol = Symbol ? Symbol.isConcatSpreadable : undefined, - symIterator = Symbol ? Symbol.iterator : undefined, - symToStringTag = Symbol ? Symbol.toStringTag : undefined; - - var defineProperty = (function() { - try { - var func = getNative(Object, 'defineProperty'); - func({}, '', {}); - return func; - } catch (e) {} - }()); - - /** Mocked built-ins. */ - var ctxClearTimeout = context.clearTimeout !== root.clearTimeout && context.clearTimeout, - ctxNow = Date && Date.now !== root.Date.now && Date.now, - ctxSetTimeout = context.setTimeout !== root.setTimeout && context.setTimeout; - - /* Built-in method references for those with the same name as other `lodash` methods. */ - var nativeCeil = Math.ceil, - nativeFloor = Math.floor, - nativeGetSymbols = Object.getOwnPropertySymbols, - nativeIsBuffer = Buffer ? Buffer.isBuffer : undefined, - nativeIsFinite = context.isFinite, - nativeJoin = arrayProto.join, - nativeKeys = overArg(Object.keys, Object), - nativeMax = Math.max, - nativeMin = Math.min, - nativeNow = Date.now, - nativeParseInt = context.parseInt, - nativeRandom = Math.random, - nativeReverse = arrayProto.reverse; - - /* Built-in method references that are verified to be native. */ - var DataView = getNative(context, 'DataView'), - Map = getNative(context, 'Map'), - Promise = getNative(context, 'Promise'), - Set = getNative(context, 'Set'), - WeakMap = getNative(context, 'WeakMap'), - nativeCreate = getNative(Object, 'create'); - - /** Used to store function metadata. */ - var metaMap = WeakMap && new WeakMap; - - /** Used to lookup unminified function names. */ - var realNames = {}; - - /** Used to detect maps, sets, and weakmaps. */ - var dataViewCtorString = toSource(DataView), - mapCtorString = toSource(Map), - promiseCtorString = toSource(Promise), - setCtorString = toSource(Set), - weakMapCtorString = toSource(WeakMap); - - /** Used to convert symbols to primitives and strings. */ - var symbolProto = Symbol ? Symbol.prototype : undefined, - symbolValueOf = symbolProto ? symbolProto.valueOf : undefined, - symbolToString = symbolProto ? symbolProto.toString : undefined; - - /*------------------------------------------------------------------------*/ - - /** - * Creates a `lodash` object which wraps `value` to enable implicit method - * chain sequences. Methods that operate on and return arrays, collections, - * and functions can be chained together. Methods that retrieve a single value - * or may return a primitive value will automatically end the chain sequence - * and return the unwrapped value. Otherwise, the value must be unwrapped - * with `_#value`. - * - * Explicit chain sequences, which must be unwrapped with `_#value`, may be - * enabled using `_.chain`. - * - * The execution of chained methods is lazy, that is, it's deferred until - * `_#value` is implicitly or explicitly called. - * - * Lazy evaluation allows several methods to support shortcut fusion. - * Shortcut fusion is an optimization to merge iteratee calls; this avoids - * the creation of intermediate arrays and can greatly reduce the number of - * iteratee executions. Sections of a chain sequence qualify for shortcut - * fusion if the section is applied to an array and iteratees accept only - * one argument. The heuristic for whether a section qualifies for shortcut - * fusion is subject to change. - * - * Chaining is supported in custom builds as long as the `_#value` method is - * directly or indirectly included in the build. - * - * In addition to lodash methods, wrappers have `Array` and `String` methods. - * - * The wrapper `Array` methods are: - * `concat`, `join`, `pop`, `push`, `shift`, `sort`, `splice`, and `unshift` - * - * The wrapper `String` methods are: - * `replace` and `split` - * - * The wrapper methods that support shortcut fusion are: - * `at`, `compact`, `drop`, `dropRight`, `dropWhile`, `filter`, `find`, - * `findLast`, `head`, `initial`, `last`, `map`, `reject`, `reverse`, `slice`, - * `tail`, `take`, `takeRight`, `takeRightWhile`, `takeWhile`, and `toArray` - * - * The chainable wrapper methods are: - * `after`, `ary`, `assign`, `assignIn`, `assignInWith`, `assignWith`, `at`, - * `before`, `bind`, `bindAll`, `bindKey`, `castArray`, `chain`, `chunk`, - * `commit`, `compact`, `concat`, `conforms`, `constant`, `countBy`, `create`, - * `curry`, `debounce`, `defaults`, `defaultsDeep`, `defer`, `delay`, - * `difference`, `differenceBy`, `differenceWith`, `drop`, `dropRight`, - * `dropRightWhile`, `dropWhile`, `extend`, `extendWith`, `fill`, `filter`, - * `flatMap`, `flatMapDeep`, `flatMapDepth`, `flatten`, `flattenDeep`, - * `flattenDepth`, `flip`, `flow`, `flowRight`, `fromPairs`, `functions`, - * `functionsIn`, `groupBy`, `initial`, `intersection`, `intersectionBy`, - * `intersectionWith`, `invert`, `invertBy`, `invokeMap`, `iteratee`, `keyBy`, - * `keys`, `keysIn`, `map`, `mapKeys`, `mapValues`, `matches`, `matchesProperty`, - * `memoize`, `merge`, `mergeWith`, `method`, `methodOf`, `mixin`, `negate`, - * `nthArg`, `omit`, `omitBy`, `once`, `orderBy`, `over`, `overArgs`, - * `overEvery`, `overSome`, `partial`, `partialRight`, `partition`, `pick`, - * `pickBy`, `plant`, `property`, `propertyOf`, `pull`, `pullAll`, `pullAllBy`, - * `pullAllWith`, `pullAt`, `push`, `range`, `rangeRight`, `rearg`, `reject`, - * `remove`, `rest`, `reverse`, `sampleSize`, `set`, `setWith`, `shuffle`, - * `slice`, `sort`, `sortBy`, `splice`, `spread`, `tail`, `take`, `takeRight`, - * `takeRightWhile`, `takeWhile`, `tap`, `throttle`, `thru`, `toArray`, - * `toPairs`, `toPairsIn`, `toPath`, `toPlainObject`, `transform`, `unary`, - * `union`, `unionBy`, `unionWith`, `uniq`, `uniqBy`, `uniqWith`, `unset`, - * `unshift`, `unzip`, `unzipWith`, `update`, `updateWith`, `values`, - * `valuesIn`, `without`, `wrap`, `xor`, `xorBy`, `xorWith`, `zip`, - * `zipObject`, `zipObjectDeep`, and `zipWith` - * - * The wrapper methods that are **not** chainable by default are: - * `add`, `attempt`, `camelCase`, `capitalize`, `ceil`, `clamp`, `clone`, - * `cloneDeep`, `cloneDeepWith`, `cloneWith`, `conformsTo`, `deburr`, - * `defaultTo`, `divide`, `each`, `eachRight`, `endsWith`, `eq`, `escape`, - * `escapeRegExp`, `every`, `find`, `findIndex`, `findKey`, `findLast`, - * `findLastIndex`, `findLastKey`, `first`, `floor`, `forEach`, `forEachRight`, - * `forIn`, `forInRight`, `forOwn`, `forOwnRight`, `get`, `gt`, `gte`, `has`, - * `hasIn`, `head`, `identity`, `includes`, `indexOf`, `inRange`, `invoke`, - * `isArguments`, `isArray`, `isArrayBuffer`, `isArrayLike`, `isArrayLikeObject`, - * `isBoolean`, `isBuffer`, `isDate`, `isElement`, `isEmpty`, `isEqual`, - * `isEqualWith`, `isError`, `isFinite`, `isFunction`, `isInteger`, `isLength`, - * `isMap`, `isMatch`, `isMatchWith`, `isNaN`, `isNative`, `isNil`, `isNull`, - * `isNumber`, `isObject`, `isObjectLike`, `isPlainObject`, `isRegExp`, - * `isSafeInteger`, `isSet`, `isString`, `isUndefined`, `isTypedArray`, - * `isWeakMap`, `isWeakSet`, `join`, `kebabCase`, `last`, `lastIndexOf`, - * `lowerCase`, `lowerFirst`, `lt`, `lte`, `max`, `maxBy`, `mean`, `meanBy`, - * `min`, `minBy`, `multiply`, `noConflict`, `noop`, `now`, `nth`, `pad`, - * `padEnd`, `padStart`, `parseInt`, `pop`, `random`, `reduce`, `reduceRight`, - * `repeat`, `result`, `round`, `runInContext`, `sample`, `shift`, `size`, - * `snakeCase`, `some`, `sortedIndex`, `sortedIndexBy`, `sortedLastIndex`, - * `sortedLastIndexBy`, `startCase`, `startsWith`, `stubArray`, `stubFalse`, - * `stubObject`, `stubString`, `stubTrue`, `subtract`, `sum`, `sumBy`, - * `template`, `times`, `toFinite`, `toInteger`, `toJSON`, `toLength`, - * `toLower`, `toNumber`, `toSafeInteger`, `toString`, `toUpper`, `trim`, - * `trimEnd`, `trimStart`, `truncate`, `unescape`, `uniqueId`, `upperCase`, - * `upperFirst`, `value`, and `words` - * - * @name _ - * @constructor - * @category Seq - * @param {*} value The value to wrap in a `lodash` instance. - * @returns {Object} Returns the new `lodash` wrapper instance. - * @example - * - * function square(n) { - * return n * n; - * } - * - * var wrapped = _([1, 2, 3]); - * - * // Returns an unwrapped value. - * wrapped.reduce(_.add); - * // => 6 - * - * // Returns a wrapped value. - * var squares = wrapped.map(square); - * - * _.isArray(squares); - * // => false - * - * _.isArray(squares.value()); - * // => true - */ - function lodash(value) { - if (isObjectLike(value) && !isArray(value) && !(value instanceof LazyWrapper)) { - if (value instanceof LodashWrapper) { - return value; - } - if (hasOwnProperty.call(value, '__wrapped__')) { - return wrapperClone(value); - } - } - return new LodashWrapper(value); - } - - /** - * The base implementation of `_.create` without support for assigning - * properties to the created object. - * - * @private - * @param {Object} proto The object to inherit from. - * @returns {Object} Returns the new object. - */ - var baseCreate = (function() { - function object() {} - return function(proto) { - if (!isObject(proto)) { - return {}; - } - if (objectCreate) { - return objectCreate(proto); - } - object.prototype = proto; - var result = new object; - object.prototype = undefined; - return result; - }; - }()); - - /** - * The function whose prototype chain sequence wrappers inherit from. - * - * @private - */ - function baseLodash() { - // No operation performed. - } - - /** - * The base constructor for creating `lodash` wrapper objects. - * - * @private - * @param {*} value The value to wrap. - * @param {boolean} [chainAll] Enable explicit method chain sequences. - */ - function LodashWrapper(value, chainAll) { - this.__wrapped__ = value; - this.__actions__ = []; - this.__chain__ = !!chainAll; - this.__index__ = 0; - this.__values__ = undefined; - } - - /** - * By default, the template delimiters used by lodash are like those in - * embedded Ruby (ERB) as well as ES2015 template strings. Change the - * following template settings to use alternative delimiters. - * - * @static - * @memberOf _ - * @type {Object} - */ - lodash.templateSettings = { - - /** - * Used to detect `data` property values to be HTML-escaped. - * - * @memberOf _.templateSettings - * @type {RegExp} - */ - 'escape': reEscape, - - /** - * Used to detect code to be evaluated. - * - * @memberOf _.templateSettings - * @type {RegExp} - */ - 'evaluate': reEvaluate, - - /** - * Used to detect `data` property values to inject. - * - * @memberOf _.templateSettings - * @type {RegExp} - */ - 'interpolate': reInterpolate, - - /** - * Used to reference the data object in the template text. - * - * @memberOf _.templateSettings - * @type {string} - */ - 'variable': '', - - /** - * Used to import variables into the compiled template. - * - * @memberOf _.templateSettings - * @type {Object} - */ - 'imports': { - - /** - * A reference to the `lodash` function. - * - * @memberOf _.templateSettings.imports - * @type {Function} - */ - '_': lodash - } - }; - - // Ensure wrappers are instances of `baseLodash`. - lodash.prototype = baseLodash.prototype; - lodash.prototype.constructor = lodash; - - LodashWrapper.prototype = baseCreate(baseLodash.prototype); - LodashWrapper.prototype.constructor = LodashWrapper; - - /*------------------------------------------------------------------------*/ - - /** - * Creates a lazy wrapper object which wraps `value` to enable lazy evaluation. - * - * @private - * @constructor - * @param {*} value The value to wrap. - */ - function LazyWrapper(value) { - this.__wrapped__ = value; - this.__actions__ = []; - this.__dir__ = 1; - this.__filtered__ = false; - this.__iteratees__ = []; - this.__takeCount__ = MAX_ARRAY_LENGTH; - this.__views__ = []; - } - - /** - * Creates a clone of the lazy wrapper object. - * - * @private - * @name clone - * @memberOf LazyWrapper - * @returns {Object} Returns the cloned `LazyWrapper` object. - */ - function lazyClone() { - var result = new LazyWrapper(this.__wrapped__); - result.__actions__ = copyArray(this.__actions__); - result.__dir__ = this.__dir__; - result.__filtered__ = this.__filtered__; - result.__iteratees__ = copyArray(this.__iteratees__); - result.__takeCount__ = this.__takeCount__; - result.__views__ = copyArray(this.__views__); - return result; - } - - /** - * Reverses the direction of lazy iteration. - * - * @private - * @name reverse - * @memberOf LazyWrapper - * @returns {Object} Returns the new reversed `LazyWrapper` object. - */ - function lazyReverse() { - if (this.__filtered__) { - var result = new LazyWrapper(this); - result.__dir__ = -1; - result.__filtered__ = true; - } else { - result = this.clone(); - result.__dir__ *= -1; - } - return result; - } - - /** - * Extracts the unwrapped value from its lazy wrapper. - * - * @private - * @name value - * @memberOf LazyWrapper - * @returns {*} Returns the unwrapped value. - */ - function lazyValue() { - var array = this.__wrapped__.value(), - dir = this.__dir__, - isArr = isArray(array), - isRight = dir < 0, - arrLength = isArr ? array.length : 0, - view = getView(0, arrLength, this.__views__), - start = view.start, - end = view.end, - length = end - start, - index = isRight ? end : (start - 1), - iteratees = this.__iteratees__, - iterLength = iteratees.length, - resIndex = 0, - takeCount = nativeMin(length, this.__takeCount__); - - if (!isArr || (!isRight && arrLength == length && takeCount == length)) { - return baseWrapperValue(array, this.__actions__); - } - var result = []; - - outer: - while (length-- && resIndex < takeCount) { - index += dir; - - var iterIndex = -1, - value = array[index]; - - while (++iterIndex < iterLength) { - var data = iteratees[iterIndex], - iteratee = data.iteratee, - type = data.type, - computed = iteratee(value); - - if (type == LAZY_MAP_FLAG) { - value = computed; - } else if (!computed) { - if (type == LAZY_FILTER_FLAG) { - continue outer; - } else { - break outer; - } - } - } - result[resIndex++] = value; - } - return result; - } - - // Ensure `LazyWrapper` is an instance of `baseLodash`. - LazyWrapper.prototype = baseCreate(baseLodash.prototype); - LazyWrapper.prototype.constructor = LazyWrapper; - - /*------------------------------------------------------------------------*/ - - /** - * Creates a hash object. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ - function Hash(entries) { - var index = -1, - length = entries == null ? 0 : entries.length; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } - } - - /** - * Removes all key-value entries from the hash. - * - * @private - * @name clear - * @memberOf Hash - */ - function hashClear() { - this.__data__ = nativeCreate ? nativeCreate(null) : {}; - this.size = 0; - } - - /** - * Removes `key` and its value from the hash. - * - * @private - * @name delete - * @memberOf Hash - * @param {Object} hash The hash to modify. - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ - function hashDelete(key) { - var result = this.has(key) && delete this.__data__[key]; - this.size -= result ? 1 : 0; - return result; - } - - /** - * Gets the hash value for `key`. - * - * @private - * @name get - * @memberOf Hash - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ - function hashGet(key) { - var data = this.__data__; - if (nativeCreate) { - var result = data[key]; - return result === HASH_UNDEFINED ? undefined : result; - } - return hasOwnProperty.call(data, key) ? data[key] : undefined; - } - - /** - * Checks if a hash value for `key` exists. - * - * @private - * @name has - * @memberOf Hash - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ - function hashHas(key) { - var data = this.__data__; - return nativeCreate ? (data[key] !== undefined) : hasOwnProperty.call(data, key); - } - - /** - * Sets the hash `key` to `value`. - * - * @private - * @name set - * @memberOf Hash - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the hash instance. - */ - function hashSet(key, value) { - var data = this.__data__; - this.size += this.has(key) ? 0 : 1; - data[key] = (nativeCreate && value === undefined) ? HASH_UNDEFINED : value; - return this; - } - - // Add methods to `Hash`. - Hash.prototype.clear = hashClear; - Hash.prototype['delete'] = hashDelete; - Hash.prototype.get = hashGet; - Hash.prototype.has = hashHas; - Hash.prototype.set = hashSet; - - /*------------------------------------------------------------------------*/ - - /** - * Creates an list cache object. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ - function ListCache(entries) { - var index = -1, - length = entries == null ? 0 : entries.length; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } - } - - /** - * Removes all key-value entries from the list cache. - * - * @private - * @name clear - * @memberOf ListCache - */ - function listCacheClear() { - this.__data__ = []; - this.size = 0; - } - - /** - * Removes `key` and its value from the list cache. - * - * @private - * @name delete - * @memberOf ListCache - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ - function listCacheDelete(key) { - var data = this.__data__, - index = assocIndexOf(data, key); - - if (index < 0) { - return false; - } - var lastIndex = data.length - 1; - if (index == lastIndex) { - data.pop(); - } else { - splice.call(data, index, 1); - } - --this.size; - return true; - } - - /** - * Gets the list cache value for `key`. - * - * @private - * @name get - * @memberOf ListCache - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ - function listCacheGet(key) { - var data = this.__data__, - index = assocIndexOf(data, key); - - return index < 0 ? undefined : data[index][1]; - } - - /** - * Checks if a list cache value for `key` exists. - * - * @private - * @name has - * @memberOf ListCache - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ - function listCacheHas(key) { - return assocIndexOf(this.__data__, key) > -1; - } - - /** - * Sets the list cache `key` to `value`. - * - * @private - * @name set - * @memberOf ListCache - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the list cache instance. - */ - function listCacheSet(key, value) { - var data = this.__data__, - index = assocIndexOf(data, key); - - if (index < 0) { - ++this.size; - data.push([key, value]); - } else { - data[index][1] = value; - } - return this; - } - - // Add methods to `ListCache`. - ListCache.prototype.clear = listCacheClear; - ListCache.prototype['delete'] = listCacheDelete; - ListCache.prototype.get = listCacheGet; - ListCache.prototype.has = listCacheHas; - ListCache.prototype.set = listCacheSet; - - /*------------------------------------------------------------------------*/ - - /** - * Creates a map cache object to store key-value pairs. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ - function MapCache(entries) { - var index = -1, - length = entries == null ? 0 : entries.length; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } - } - - /** - * Removes all key-value entries from the map. - * - * @private - * @name clear - * @memberOf MapCache - */ - function mapCacheClear() { - this.size = 0; - this.__data__ = { - 'hash': new Hash, - 'map': new (Map || ListCache), - 'string': new Hash - }; - } - - /** - * Removes `key` and its value from the map. - * - * @private - * @name delete - * @memberOf MapCache - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ - function mapCacheDelete(key) { - var result = getMapData(this, key)['delete'](key); - this.size -= result ? 1 : 0; - return result; - } - - /** - * Gets the map value for `key`. - * - * @private - * @name get - * @memberOf MapCache - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ - function mapCacheGet(key) { - return getMapData(this, key).get(key); - } - - /** - * Checks if a map value for `key` exists. - * - * @private - * @name has - * @memberOf MapCache - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ - function mapCacheHas(key) { - return getMapData(this, key).has(key); - } - - /** - * Sets the map `key` to `value`. - * - * @private - * @name set - * @memberOf MapCache - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the map cache instance. - */ - function mapCacheSet(key, value) { - var data = getMapData(this, key), - size = data.size; - - data.set(key, value); - this.size += data.size == size ? 0 : 1; - return this; - } - - // Add methods to `MapCache`. - MapCache.prototype.clear = mapCacheClear; - MapCache.prototype['delete'] = mapCacheDelete; - MapCache.prototype.get = mapCacheGet; - MapCache.prototype.has = mapCacheHas; - MapCache.prototype.set = mapCacheSet; - - /*------------------------------------------------------------------------*/ - - /** - * - * Creates an array cache object to store unique values. - * - * @private - * @constructor - * @param {Array} [values] The values to cache. - */ - function SetCache(values) { - var index = -1, - length = values == null ? 0 : values.length; - - this.__data__ = new MapCache; - while (++index < length) { - this.add(values[index]); - } - } - - /** - * Adds `value` to the array cache. - * - * @private - * @name add - * @memberOf SetCache - * @alias push - * @param {*} value The value to cache. - * @returns {Object} Returns the cache instance. - */ - function setCacheAdd(value) { - this.__data__.set(value, HASH_UNDEFINED); - return this; - } - - /** - * Checks if `value` is in the array cache. - * - * @private - * @name has - * @memberOf SetCache - * @param {*} value The value to search for. - * @returns {number} Returns `true` if `value` is found, else `false`. - */ - function setCacheHas(value) { - return this.__data__.has(value); - } - - // Add methods to `SetCache`. - SetCache.prototype.add = SetCache.prototype.push = setCacheAdd; - SetCache.prototype.has = setCacheHas; - - /*------------------------------------------------------------------------*/ - - /** - * Creates a stack cache object to store key-value pairs. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ - function Stack(entries) { - var data = this.__data__ = new ListCache(entries); - this.size = data.size; - } - - /** - * Removes all key-value entries from the stack. - * - * @private - * @name clear - * @memberOf Stack - */ - function stackClear() { - this.__data__ = new ListCache; - this.size = 0; - } - - /** - * Removes `key` and its value from the stack. - * - * @private - * @name delete - * @memberOf Stack - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ - function stackDelete(key) { - var data = this.__data__, - result = data['delete'](key); - - this.size = data.size; - return result; - } - - /** - * Gets the stack value for `key`. - * - * @private - * @name get - * @memberOf Stack - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ - function stackGet(key) { - return this.__data__.get(key); - } - - /** - * Checks if a stack value for `key` exists. - * - * @private - * @name has - * @memberOf Stack - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ - function stackHas(key) { - return this.__data__.has(key); - } - - /** - * Sets the stack `key` to `value`. - * - * @private - * @name set - * @memberOf Stack - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the stack cache instance. - */ - function stackSet(key, value) { - var data = this.__data__; - if (data instanceof ListCache) { - var pairs = data.__data__; - if (!Map || (pairs.length < LARGE_ARRAY_SIZE - 1)) { - pairs.push([key, value]); - this.size = ++data.size; - return this; - } - data = this.__data__ = new MapCache(pairs); - } - data.set(key, value); - this.size = data.size; - return this; - } - - // Add methods to `Stack`. - Stack.prototype.clear = stackClear; - Stack.prototype['delete'] = stackDelete; - Stack.prototype.get = stackGet; - Stack.prototype.has = stackHas; - Stack.prototype.set = stackSet; - - /*------------------------------------------------------------------------*/ - - /** - * Creates an array of the enumerable property names of the array-like `value`. - * - * @private - * @param {*} value The value to query. - * @param {boolean} inherited Specify returning inherited property names. - * @returns {Array} Returns the array of property names. - */ - function arrayLikeKeys(value, inherited) { - var isArr = isArray(value), - isArg = !isArr && isArguments(value), - isBuff = !isArr && !isArg && isBuffer(value), - isType = !isArr && !isArg && !isBuff && isTypedArray(value), - skipIndexes = isArr || isArg || isBuff || isType, - result = skipIndexes ? baseTimes(value.length, String) : [], - length = result.length; - - for (var key in value) { - if ((inherited || hasOwnProperty.call(value, key)) && - !(skipIndexes && ( - // Safari 9 has enumerable `arguments.length` in strict mode. - key == 'length' || - // Node.js 0.10 has enumerable non-index properties on buffers. - (isBuff && (key == 'offset' || key == 'parent')) || - // PhantomJS 2 has enumerable non-index properties on typed arrays. - (isType && (key == 'buffer' || key == 'byteLength' || key == 'byteOffset')) || - // Skip index properties. - isIndex(key, length) - ))) { - result.push(key); - } - } - return result; - } - - /** - * A specialized version of `_.sample` for arrays. - * - * @private - * @param {Array} array The array to sample. - * @returns {*} Returns the random element. - */ - function arraySample(array) { - var length = array.length; - return length ? array[baseRandom(0, length - 1)] : undefined; - } - - /** - * A specialized version of `_.sampleSize` for arrays. - * - * @private - * @param {Array} array The array to sample. - * @param {number} n The number of elements to sample. - * @returns {Array} Returns the random elements. - */ - function arraySampleSize(array, n) { - return shuffleSelf(copyArray(array), baseClamp(n, 0, array.length)); - } - - /** - * A specialized version of `_.shuffle` for arrays. - * - * @private - * @param {Array} array The array to shuffle. - * @returns {Array} Returns the new shuffled array. - */ - function arrayShuffle(array) { - return shuffleSelf(copyArray(array)); - } - - /** - * This function is like `assignValue` except that it doesn't assign - * `undefined` values. - * - * @private - * @param {Object} object The object to modify. - * @param {string} key The key of the property to assign. - * @param {*} value The value to assign. - */ - function assignMergeValue(object, key, value) { - if ((value !== undefined && !eq(object[key], value)) || - (value === undefined && !(key in object))) { - baseAssignValue(object, key, value); - } - } - - /** - * Assigns `value` to `key` of `object` if the existing value is not equivalent - * using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons. - * - * @private - * @param {Object} object The object to modify. - * @param {string} key The key of the property to assign. - * @param {*} value The value to assign. - */ - function assignValue(object, key, value) { - var objValue = object[key]; - if (!(hasOwnProperty.call(object, key) && eq(objValue, value)) || - (value === undefined && !(key in object))) { - baseAssignValue(object, key, value); - } - } - - /** - * Gets the index at which the `key` is found in `array` of key-value pairs. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} key The key to search for. - * @returns {number} Returns the index of the matched value, else `-1`. - */ - function assocIndexOf(array, key) { - var length = array.length; - while (length--) { - if (eq(array[length][0], key)) { - return length; - } - } - return -1; - } - - /** - * Aggregates elements of `collection` on `accumulator` with keys transformed - * by `iteratee` and values set by `setter`. - * - * @private - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} setter The function to set `accumulator` values. - * @param {Function} iteratee The iteratee to transform keys. - * @param {Object} accumulator The initial aggregated object. - * @returns {Function} Returns `accumulator`. - */ - function baseAggregator(collection, setter, iteratee, accumulator) { - baseEach(collection, function(value, key, collection) { - setter(accumulator, value, iteratee(value), collection); - }); - return accumulator; - } - - /** - * The base implementation of `_.assign` without support for multiple sources - * or `customizer` functions. - * - * @private - * @param {Object} object The destination object. - * @param {Object} source The source object. - * @returns {Object} Returns `object`. - */ - function baseAssign(object, source) { - return object && copyObject(source, keys(source), object); - } - - /** - * The base implementation of `_.assignIn` without support for multiple sources - * or `customizer` functions. - * - * @private - * @param {Object} object The destination object. - * @param {Object} source The source object. - * @returns {Object} Returns `object`. - */ - function baseAssignIn(object, source) { - return object && copyObject(source, keysIn(source), object); - } - - /** - * The base implementation of `assignValue` and `assignMergeValue` without - * value checks. - * - * @private - * @param {Object} object The object to modify. - * @param {string} key The key of the property to assign. - * @param {*} value The value to assign. - */ - function baseAssignValue(object, key, value) { - if (key == '__proto__' && defineProperty) { - defineProperty(object, key, { - 'configurable': true, - 'enumerable': true, - 'value': value, - 'writable': true - }); - } else { - object[key] = value; - } - } - - /** - * The base implementation of `_.at` without support for individual paths. - * - * @private - * @param {Object} object The object to iterate over. - * @param {string[]} paths The property paths to pick. - * @returns {Array} Returns the picked elements. - */ - function baseAt(object, paths) { - var index = -1, - length = paths.length, - result = Array(length), - skip = object == null; - - while (++index < length) { - result[index] = skip ? undefined : get(object, paths[index]); - } - return result; - } - - /** - * The base implementation of `_.clamp` which doesn't coerce arguments. - * - * @private - * @param {number} number The number to clamp. - * @param {number} [lower] The lower bound. - * @param {number} upper The upper bound. - * @returns {number} Returns the clamped number. - */ - function baseClamp(number, lower, upper) { - if (number === number) { - if (upper !== undefined) { - number = number <= upper ? number : upper; - } - if (lower !== undefined) { - number = number >= lower ? number : lower; - } - } - return number; - } - - /** - * The base implementation of `_.clone` and `_.cloneDeep` which tracks - * traversed objects. - * - * @private - * @param {*} value The value to clone. - * @param {boolean} bitmask The bitmask flags. - * 1 - Deep clone - * 2 - Flatten inherited properties - * 4 - Clone symbols - * @param {Function} [customizer] The function to customize cloning. - * @param {string} [key] The key of `value`. - * @param {Object} [object] The parent object of `value`. - * @param {Object} [stack] Tracks traversed objects and their clone counterparts. - * @returns {*} Returns the cloned value. - */ - function baseClone(value, bitmask, customizer, key, object, stack) { - var result, - isDeep = bitmask & CLONE_DEEP_FLAG, - isFlat = bitmask & CLONE_FLAT_FLAG, - isFull = bitmask & CLONE_SYMBOLS_FLAG; - - if (customizer) { - result = object ? customizer(value, key, object, stack) : customizer(value); - } - if (result !== undefined) { - return result; - } - if (!isObject(value)) { - return value; - } - var isArr = isArray(value); - if (isArr) { - result = initCloneArray(value); - if (!isDeep) { - return copyArray(value, result); - } - } else { - var tag = getTag(value), - isFunc = tag == funcTag || tag == genTag; - - if (isBuffer(value)) { - return cloneBuffer(value, isDeep); - } - if (tag == objectTag || tag == argsTag || (isFunc && !object)) { - result = (isFlat || isFunc) ? {} : initCloneObject(value); - if (!isDeep) { - return isFlat - ? copySymbolsIn(value, baseAssignIn(result, value)) - : copySymbols(value, baseAssign(result, value)); - } - } else { - if (!cloneableTags[tag]) { - return object ? value : {}; - } - result = initCloneByTag(value, tag, isDeep); - } - } - // Check for circular references and return its corresponding clone. - stack || (stack = new Stack); - var stacked = stack.get(value); - if (stacked) { - return stacked; - } - stack.set(value, result); - - if (isSet(value)) { - value.forEach(function(subValue) { - result.add(baseClone(subValue, bitmask, customizer, subValue, value, stack)); - }); - - return result; - } - - if (isMap(value)) { - value.forEach(function(subValue, key) { - result.set(key, baseClone(subValue, bitmask, customizer, key, value, stack)); - }); - - return result; - } - - var keysFunc = isFull - ? (isFlat ? getAllKeysIn : getAllKeys) - : (isFlat ? keysIn : keys); - - var props = isArr ? undefined : keysFunc(value); - arrayEach(props || value, function(subValue, key) { - if (props) { - key = subValue; - subValue = value[key]; - } - // Recursively populate clone (susceptible to call stack limits). - assignValue(result, key, baseClone(subValue, bitmask, customizer, key, value, stack)); - }); - return result; - } - - /** - * The base implementation of `_.conforms` which doesn't clone `source`. - * - * @private - * @param {Object} source The object of property predicates to conform to. - * @returns {Function} Returns the new spec function. - */ - function baseConforms(source) { - var props = keys(source); - return function(object) { - return baseConformsTo(object, source, props); - }; - } - - /** - * The base implementation of `_.conformsTo` which accepts `props` to check. - * - * @private - * @param {Object} object The object to inspect. - * @param {Object} source The object of property predicates to conform to. - * @returns {boolean} Returns `true` if `object` conforms, else `false`. - */ - function baseConformsTo(object, source, props) { - var length = props.length; - if (object == null) { - return !length; - } - object = Object(object); - while (length--) { - var key = props[length], - predicate = source[key], - value = object[key]; - - if ((value === undefined && !(key in object)) || !predicate(value)) { - return false; - } - } - return true; - } - - /** - * The base implementation of `_.delay` and `_.defer` which accepts `args` - * to provide to `func`. - * - * @private - * @param {Function} func The function to delay. - * @param {number} wait The number of milliseconds to delay invocation. - * @param {Array} args The arguments to provide to `func`. - * @returns {number|Object} Returns the timer id or timeout object. - */ - function baseDelay(func, wait, args) { - if (typeof func != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - return setTimeout(function() { func.apply(undefined, args); }, wait); - } - - /** - * The base implementation of methods like `_.difference` without support - * for excluding multiple arrays or iteratee shorthands. - * - * @private - * @param {Array} array The array to inspect. - * @param {Array} values The values to exclude. - * @param {Function} [iteratee] The iteratee invoked per element. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new array of filtered values. - */ - function baseDifference(array, values, iteratee, comparator) { - var index = -1, - includes = arrayIncludes, - isCommon = true, - length = array.length, - result = [], - valuesLength = values.length; - - if (!length) { - return result; - } - if (iteratee) { - values = arrayMap(values, baseUnary(iteratee)); - } - if (comparator) { - includes = arrayIncludesWith; - isCommon = false; - } - else if (values.length >= LARGE_ARRAY_SIZE) { - includes = cacheHas; - isCommon = false; - values = new SetCache(values); - } - outer: - while (++index < length) { - var value = array[index], - computed = iteratee == null ? value : iteratee(value); - - value = (comparator || value !== 0) ? value : 0; - if (isCommon && computed === computed) { - var valuesIndex = valuesLength; - while (valuesIndex--) { - if (values[valuesIndex] === computed) { - continue outer; - } - } - result.push(value); - } - else if (!includes(values, computed, comparator)) { - result.push(value); - } - } - return result; - } - - /** - * The base implementation of `_.forEach` without support for iteratee shorthands. - * - * @private - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {Array|Object} Returns `collection`. - */ - var baseEach = createBaseEach(baseForOwn); - - /** - * The base implementation of `_.forEachRight` without support for iteratee shorthands. - * - * @private - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {Array|Object} Returns `collection`. - */ - var baseEachRight = createBaseEach(baseForOwnRight, true); - - /** - * The base implementation of `_.every` without support for iteratee shorthands. - * - * @private - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} predicate The function invoked per iteration. - * @returns {boolean} Returns `true` if all elements pass the predicate check, - * else `false` - */ - function baseEvery(collection, predicate) { - var result = true; - baseEach(collection, function(value, index, collection) { - result = !!predicate(value, index, collection); - return result; - }); - return result; - } - - /** - * The base implementation of methods like `_.max` and `_.min` which accepts a - * `comparator` to determine the extremum value. - * - * @private - * @param {Array} array The array to iterate over. - * @param {Function} iteratee The iteratee invoked per iteration. - * @param {Function} comparator The comparator used to compare values. - * @returns {*} Returns the extremum value. - */ - function baseExtremum(array, iteratee, comparator) { - var index = -1, - length = array.length; - - while (++index < length) { - var value = array[index], - current = iteratee(value); - - if (current != null && (computed === undefined - ? (current === current && !isSymbol(current)) - : comparator(current, computed) - )) { - var computed = current, - result = value; - } - } - return result; - } - - /** - * The base implementation of `_.fill` without an iteratee call guard. - * - * @private - * @param {Array} array The array to fill. - * @param {*} value The value to fill `array` with. - * @param {number} [start=0] The start position. - * @param {number} [end=array.length] The end position. - * @returns {Array} Returns `array`. - */ - function baseFill(array, value, start, end) { - var length = array.length; - - start = toInteger(start); - if (start < 0) { - start = -start > length ? 0 : (length + start); - } - end = (end === undefined || end > length) ? length : toInteger(end); - if (end < 0) { - end += length; - } - end = start > end ? 0 : toLength(end); - while (start < end) { - array[start++] = value; - } - return array; - } - - /** - * The base implementation of `_.filter` without support for iteratee shorthands. - * - * @private - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} predicate The function invoked per iteration. - * @returns {Array} Returns the new filtered array. - */ - function baseFilter(collection, predicate) { - var result = []; - baseEach(collection, function(value, index, collection) { - if (predicate(value, index, collection)) { - result.push(value); - } - }); - return result; - } - - /** - * The base implementation of `_.flatten` with support for restricting flattening. - * - * @private - * @param {Array} array The array to flatten. - * @param {number} depth The maximum recursion depth. - * @param {boolean} [predicate=isFlattenable] The function invoked per iteration. - * @param {boolean} [isStrict] Restrict to values that pass `predicate` checks. - * @param {Array} [result=[]] The initial result value. - * @returns {Array} Returns the new flattened array. - */ - function baseFlatten(array, depth, predicate, isStrict, result) { - var index = -1, - length = array.length; - - predicate || (predicate = isFlattenable); - result || (result = []); - - while (++index < length) { - var value = array[index]; - if (depth > 0 && predicate(value)) { - if (depth > 1) { - // Recursively flatten arrays (susceptible to call stack limits). - baseFlatten(value, depth - 1, predicate, isStrict, result); - } else { - arrayPush(result, value); - } - } else if (!isStrict) { - result[result.length] = value; - } - } - return result; - } - - /** - * The base implementation of `baseForOwn` which iterates over `object` - * properties returned by `keysFunc` and invokes `iteratee` for each property. - * Iteratee functions may exit iteration early by explicitly returning `false`. - * - * @private - * @param {Object} object The object to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @param {Function} keysFunc The function to get the keys of `object`. - * @returns {Object} Returns `object`. - */ - var baseFor = createBaseFor(); - - /** - * This function is like `baseFor` except that it iterates over properties - * in the opposite order. - * - * @private - * @param {Object} object The object to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @param {Function} keysFunc The function to get the keys of `object`. - * @returns {Object} Returns `object`. - */ - var baseForRight = createBaseFor(true); - - /** - * The base implementation of `_.forOwn` without support for iteratee shorthands. - * - * @private - * @param {Object} object The object to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {Object} Returns `object`. - */ - function baseForOwn(object, iteratee) { - return object && baseFor(object, iteratee, keys); - } - - /** - * The base implementation of `_.forOwnRight` without support for iteratee shorthands. - * - * @private - * @param {Object} object The object to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {Object} Returns `object`. - */ - function baseForOwnRight(object, iteratee) { - return object && baseForRight(object, iteratee, keys); - } - - /** - * The base implementation of `_.functions` which creates an array of - * `object` function property names filtered from `props`. - * - * @private - * @param {Object} object The object to inspect. - * @param {Array} props The property names to filter. - * @returns {Array} Returns the function names. - */ - function baseFunctions(object, props) { - return arrayFilter(props, function(key) { - return isFunction(object[key]); - }); - } - - /** - * The base implementation of `_.get` without support for default values. - * - * @private - * @param {Object} object The object to query. - * @param {Array|string} path The path of the property to get. - * @returns {*} Returns the resolved value. - */ - function baseGet(object, path) { - path = castPath(path, object); - - var index = 0, - length = path.length; - - while (object != null && index < length) { - object = object[toKey(path[index++])]; - } - return (index && index == length) ? object : undefined; - } - - /** - * The base implementation of `getAllKeys` and `getAllKeysIn` which uses - * `keysFunc` and `symbolsFunc` to get the enumerable property names and - * symbols of `object`. - * - * @private - * @param {Object} object The object to query. - * @param {Function} keysFunc The function to get the keys of `object`. - * @param {Function} symbolsFunc The function to get the symbols of `object`. - * @returns {Array} Returns the array of property names and symbols. - */ - function baseGetAllKeys(object, keysFunc, symbolsFunc) { - var result = keysFunc(object); - return isArray(object) ? result : arrayPush(result, symbolsFunc(object)); - } - - /** - * The base implementation of `getTag` without fallbacks for buggy environments. - * - * @private - * @param {*} value The value to query. - * @returns {string} Returns the `toStringTag`. - */ - function baseGetTag(value) { - if (value == null) { - return value === undefined ? undefinedTag : nullTag; - } - return (symToStringTag && symToStringTag in Object(value)) - ? getRawTag(value) - : objectToString(value); - } - - /** - * The base implementation of `_.gt` which doesn't coerce arguments. - * - * @private - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if `value` is greater than `other`, - * else `false`. - */ - function baseGt(value, other) { - return value > other; - } - - /** - * The base implementation of `_.has` without support for deep paths. - * - * @private - * @param {Object} [object] The object to query. - * @param {Array|string} key The key to check. - * @returns {boolean} Returns `true` if `key` exists, else `false`. - */ - function baseHas(object, key) { - return object != null && hasOwnProperty.call(object, key); - } - - /** - * The base implementation of `_.hasIn` without support for deep paths. - * - * @private - * @param {Object} [object] The object to query. - * @param {Array|string} key The key to check. - * @returns {boolean} Returns `true` if `key` exists, else `false`. - */ - function baseHasIn(object, key) { - return object != null && key in Object(object); - } - - /** - * The base implementation of `_.inRange` which doesn't coerce arguments. - * - * @private - * @param {number} number The number to check. - * @param {number} start The start of the range. - * @param {number} end The end of the range. - * @returns {boolean} Returns `true` if `number` is in the range, else `false`. - */ - function baseInRange(number, start, end) { - return number >= nativeMin(start, end) && number < nativeMax(start, end); - } - - /** - * The base implementation of methods like `_.intersection`, without support - * for iteratee shorthands, that accepts an array of arrays to inspect. - * - * @private - * @param {Array} arrays The arrays to inspect. - * @param {Function} [iteratee] The iteratee invoked per element. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new array of shared values. - */ - function baseIntersection(arrays, iteratee, comparator) { - var includes = comparator ? arrayIncludesWith : arrayIncludes, - length = arrays[0].length, - othLength = arrays.length, - othIndex = othLength, - caches = Array(othLength), - maxLength = Infinity, - result = []; - - while (othIndex--) { - var array = arrays[othIndex]; - if (othIndex && iteratee) { - array = arrayMap(array, baseUnary(iteratee)); - } - maxLength = nativeMin(array.length, maxLength); - caches[othIndex] = !comparator && (iteratee || (length >= 120 && array.length >= 120)) - ? new SetCache(othIndex && array) - : undefined; - } - array = arrays[0]; - - var index = -1, - seen = caches[0]; - - outer: - while (++index < length && result.length < maxLength) { - var value = array[index], - computed = iteratee ? iteratee(value) : value; - - value = (comparator || value !== 0) ? value : 0; - if (!(seen - ? cacheHas(seen, computed) - : includes(result, computed, comparator) - )) { - othIndex = othLength; - while (--othIndex) { - var cache = caches[othIndex]; - if (!(cache - ? cacheHas(cache, computed) - : includes(arrays[othIndex], computed, comparator)) - ) { - continue outer; - } - } - if (seen) { - seen.push(computed); - } - result.push(value); - } - } - return result; - } - - /** - * The base implementation of `_.invert` and `_.invertBy` which inverts - * `object` with values transformed by `iteratee` and set by `setter`. - * - * @private - * @param {Object} object The object to iterate over. - * @param {Function} setter The function to set `accumulator` values. - * @param {Function} iteratee The iteratee to transform values. - * @param {Object} accumulator The initial inverted object. - * @returns {Function} Returns `accumulator`. - */ - function baseInverter(object, setter, iteratee, accumulator) { - baseForOwn(object, function(value, key, object) { - setter(accumulator, iteratee(value), key, object); - }); - return accumulator; - } - - /** - * The base implementation of `_.invoke` without support for individual - * method arguments. - * - * @private - * @param {Object} object The object to query. - * @param {Array|string} path The path of the method to invoke. - * @param {Array} args The arguments to invoke the method with. - * @returns {*} Returns the result of the invoked method. - */ - function baseInvoke(object, path, args) { - path = castPath(path, object); - object = parent(object, path); - var func = object == null ? object : object[toKey(last(path))]; - return func == null ? undefined : apply(func, object, args); - } - - /** - * The base implementation of `_.isArguments`. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an `arguments` object, - */ - function baseIsArguments(value) { - return isObjectLike(value) && baseGetTag(value) == argsTag; - } - - /** - * The base implementation of `_.isArrayBuffer` without Node.js optimizations. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an array buffer, else `false`. - */ - function baseIsArrayBuffer(value) { - return isObjectLike(value) && baseGetTag(value) == arrayBufferTag; - } - - /** - * The base implementation of `_.isDate` without Node.js optimizations. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a date object, else `false`. - */ - function baseIsDate(value) { - return isObjectLike(value) && baseGetTag(value) == dateTag; - } - - /** - * The base implementation of `_.isEqual` which supports partial comparisons - * and tracks traversed objects. - * - * @private - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @param {boolean} bitmask The bitmask flags. - * 1 - Unordered comparison - * 2 - Partial comparison - * @param {Function} [customizer] The function to customize comparisons. - * @param {Object} [stack] Tracks traversed `value` and `other` objects. - * @returns {boolean} Returns `true` if the values are equivalent, else `false`. - */ - function baseIsEqual(value, other, bitmask, customizer, stack) { - if (value === other) { - return true; - } - if (value == null || other == null || (!isObjectLike(value) && !isObjectLike(other))) { - return value !== value && other !== other; - } - return baseIsEqualDeep(value, other, bitmask, customizer, baseIsEqual, stack); - } - - /** - * A specialized version of `baseIsEqual` for arrays and objects which performs - * deep comparisons and tracks traversed objects enabling objects with circular - * references to be compared. - * - * @private - * @param {Object} object The object to compare. - * @param {Object} other The other object to compare. - * @param {number} bitmask The bitmask flags. See `baseIsEqual` for more details. - * @param {Function} customizer The function to customize comparisons. - * @param {Function} equalFunc The function to determine equivalents of values. - * @param {Object} [stack] Tracks traversed `object` and `other` objects. - * @returns {boolean} Returns `true` if the objects are equivalent, else `false`. - */ - function baseIsEqualDeep(object, other, bitmask, customizer, equalFunc, stack) { - var objIsArr = isArray(object), - othIsArr = isArray(other), - objTag = objIsArr ? arrayTag : getTag(object), - othTag = othIsArr ? arrayTag : getTag(other); - - objTag = objTag == argsTag ? objectTag : objTag; - othTag = othTag == argsTag ? objectTag : othTag; - - var objIsObj = objTag == objectTag, - othIsObj = othTag == objectTag, - isSameTag = objTag == othTag; - - if (isSameTag && isBuffer(object)) { - if (!isBuffer(other)) { - return false; - } - objIsArr = true; - objIsObj = false; - } - if (isSameTag && !objIsObj) { - stack || (stack = new Stack); - return (objIsArr || isTypedArray(object)) - ? equalArrays(object, other, bitmask, customizer, equalFunc, stack) - : equalByTag(object, other, objTag, bitmask, customizer, equalFunc, stack); - } - if (!(bitmask & COMPARE_PARTIAL_FLAG)) { - var objIsWrapped = objIsObj && hasOwnProperty.call(object, '__wrapped__'), - othIsWrapped = othIsObj && hasOwnProperty.call(other, '__wrapped__'); - - if (objIsWrapped || othIsWrapped) { - var objUnwrapped = objIsWrapped ? object.value() : object, - othUnwrapped = othIsWrapped ? other.value() : other; - - stack || (stack = new Stack); - return equalFunc(objUnwrapped, othUnwrapped, bitmask, customizer, stack); - } - } - if (!isSameTag) { - return false; - } - stack || (stack = new Stack); - return equalObjects(object, other, bitmask, customizer, equalFunc, stack); - } - - /** - * The base implementation of `_.isMap` without Node.js optimizations. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a map, else `false`. - */ - function baseIsMap(value) { - return isObjectLike(value) && getTag(value) == mapTag; - } - - /** - * The base implementation of `_.isMatch` without support for iteratee shorthands. - * - * @private - * @param {Object} object The object to inspect. - * @param {Object} source The object of property values to match. - * @param {Array} matchData The property names, values, and compare flags to match. - * @param {Function} [customizer] The function to customize comparisons. - * @returns {boolean} Returns `true` if `object` is a match, else `false`. - */ - function baseIsMatch(object, source, matchData, customizer) { - var index = matchData.length, - length = index, - noCustomizer = !customizer; - - if (object == null) { - return !length; - } - object = Object(object); - while (index--) { - var data = matchData[index]; - if ((noCustomizer && data[2]) - ? data[1] !== object[data[0]] - : !(data[0] in object) - ) { - return false; - } - } - while (++index < length) { - data = matchData[index]; - var key = data[0], - objValue = object[key], - srcValue = data[1]; - - if (noCustomizer && data[2]) { - if (objValue === undefined && !(key in object)) { - return false; - } - } else { - var stack = new Stack; - if (customizer) { - var result = customizer(objValue, srcValue, key, object, source, stack); - } - if (!(result === undefined - ? baseIsEqual(srcValue, objValue, COMPARE_PARTIAL_FLAG | COMPARE_UNORDERED_FLAG, customizer, stack) - : result - )) { - return false; - } - } - } - return true; - } - - /** - * The base implementation of `_.isNative` without bad shim checks. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a native function, - * else `false`. - */ - function baseIsNative(value) { - if (!isObject(value) || isMasked(value)) { - return false; - } - var pattern = isFunction(value) ? reIsNative : reIsHostCtor; - return pattern.test(toSource(value)); - } - - /** - * The base implementation of `_.isRegExp` without Node.js optimizations. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a regexp, else `false`. - */ - function baseIsRegExp(value) { - return isObjectLike(value) && baseGetTag(value) == regexpTag; - } - - /** - * The base implementation of `_.isSet` without Node.js optimizations. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a set, else `false`. - */ - function baseIsSet(value) { - return isObjectLike(value) && getTag(value) == setTag; - } - - /** - * The base implementation of `_.isTypedArray` without Node.js optimizations. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a typed array, else `false`. - */ - function baseIsTypedArray(value) { - return isObjectLike(value) && - isLength(value.length) && !!typedArrayTags[baseGetTag(value)]; - } - - /** - * The base implementation of `_.iteratee`. - * - * @private - * @param {*} [value=_.identity] The value to convert to an iteratee. - * @returns {Function} Returns the iteratee. - */ - function baseIteratee(value) { - // Don't store the `typeof` result in a variable to avoid a JIT bug in Safari 9. - // See https://bugs.webkit.org/show_bug.cgi?id=156034 for more details. - if (typeof value == 'function') { - return value; - } - if (value == null) { - return identity; - } - if (typeof value == 'object') { - return isArray(value) - ? baseMatchesProperty(value[0], value[1]) - : baseMatches(value); - } - return property(value); - } - - /** - * The base implementation of `_.keys` which doesn't treat sparse arrays as dense. - * - * @private - * @param {Object} object The object to query. - * @returns {Array} Returns the array of property names. - */ - function baseKeys(object) { - if (!isPrototype(object)) { - return nativeKeys(object); - } - var result = []; - for (var key in Object(object)) { - if (hasOwnProperty.call(object, key) && key != 'constructor') { - result.push(key); - } - } - return result; - } - - /** - * The base implementation of `_.keysIn` which doesn't treat sparse arrays as dense. - * - * @private - * @param {Object} object The object to query. - * @returns {Array} Returns the array of property names. - */ - function baseKeysIn(object) { - if (!isObject(object)) { - return nativeKeysIn(object); - } - var isProto = isPrototype(object), - result = []; - - for (var key in object) { - if (!(key == 'constructor' && (isProto || !hasOwnProperty.call(object, key)))) { - result.push(key); - } - } - return result; - } - - /** - * The base implementation of `_.lt` which doesn't coerce arguments. - * - * @private - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if `value` is less than `other`, - * else `false`. - */ - function baseLt(value, other) { - return value < other; - } - - /** - * The base implementation of `_.map` without support for iteratee shorthands. - * - * @private - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} iteratee The function invoked per iteration. - * @returns {Array} Returns the new mapped array. - */ - function baseMap(collection, iteratee) { - var index = -1, - result = isArrayLike(collection) ? Array(collection.length) : []; - - baseEach(collection, function(value, key, collection) { - result[++index] = iteratee(value, key, collection); - }); - return result; - } - - /** - * The base implementation of `_.matches` which doesn't clone `source`. - * - * @private - * @param {Object} source The object of property values to match. - * @returns {Function} Returns the new spec function. - */ - function baseMatches(source) { - var matchData = getMatchData(source); - if (matchData.length == 1 && matchData[0][2]) { - return matchesStrictComparable(matchData[0][0], matchData[0][1]); - } - return function(object) { - return object === source || baseIsMatch(object, source, matchData); - }; - } - - /** - * The base implementation of `_.matchesProperty` which doesn't clone `srcValue`. - * - * @private - * @param {string} path The path of the property to get. - * @param {*} srcValue The value to match. - * @returns {Function} Returns the new spec function. - */ - function baseMatchesProperty(path, srcValue) { - if (isKey(path) && isStrictComparable(srcValue)) { - return matchesStrictComparable(toKey(path), srcValue); - } - return function(object) { - var objValue = get(object, path); - return (objValue === undefined && objValue === srcValue) - ? hasIn(object, path) - : baseIsEqual(srcValue, objValue, COMPARE_PARTIAL_FLAG | COMPARE_UNORDERED_FLAG); - }; - } - - /** - * The base implementation of `_.merge` without support for multiple sources. - * - * @private - * @param {Object} object The destination object. - * @param {Object} source The source object. - * @param {number} srcIndex The index of `source`. - * @param {Function} [customizer] The function to customize merged values. - * @param {Object} [stack] Tracks traversed source values and their merged - * counterparts. - */ - function baseMerge(object, source, srcIndex, customizer, stack) { - if (object === source) { - return; - } - baseFor(source, function(srcValue, key) { - if (isObject(srcValue)) { - stack || (stack = new Stack); - baseMergeDeep(object, source, key, srcIndex, baseMerge, customizer, stack); - } - else { - var newValue = customizer - ? customizer(safeGet(object, key), srcValue, (key + ''), object, source, stack) - : undefined; - - if (newValue === undefined) { - newValue = srcValue; - } - assignMergeValue(object, key, newValue); - } - }, keysIn); - } - - /** - * A specialized version of `baseMerge` for arrays and objects which performs - * deep merges and tracks traversed objects enabling objects with circular - * references to be merged. - * - * @private - * @param {Object} object The destination object. - * @param {Object} source The source object. - * @param {string} key The key of the value to merge. - * @param {number} srcIndex The index of `source`. - * @param {Function} mergeFunc The function to merge values. - * @param {Function} [customizer] The function to customize assigned values. - * @param {Object} [stack] Tracks traversed source values and their merged - * counterparts. - */ - function baseMergeDeep(object, source, key, srcIndex, mergeFunc, customizer, stack) { - var objValue = safeGet(object, key), - srcValue = safeGet(source, key), - stacked = stack.get(srcValue); - - if (stacked) { - assignMergeValue(object, key, stacked); - return; - } - var newValue = customizer - ? customizer(objValue, srcValue, (key + ''), object, source, stack) - : undefined; - - var isCommon = newValue === undefined; - - if (isCommon) { - var isArr = isArray(srcValue), - isBuff = !isArr && isBuffer(srcValue), - isTyped = !isArr && !isBuff && isTypedArray(srcValue); - - newValue = srcValue; - if (isArr || isBuff || isTyped) { - if (isArray(objValue)) { - newValue = objValue; - } - else if (isArrayLikeObject(objValue)) { - newValue = copyArray(objValue); - } - else if (isBuff) { - isCommon = false; - newValue = cloneBuffer(srcValue, true); - } - else if (isTyped) { - isCommon = false; - newValue = cloneTypedArray(srcValue, true); - } - else { - newValue = []; - } - } - else if (isPlainObject(srcValue) || isArguments(srcValue)) { - newValue = objValue; - if (isArguments(objValue)) { - newValue = toPlainObject(objValue); - } - else if (!isObject(objValue) || (srcIndex && isFunction(objValue))) { - newValue = initCloneObject(srcValue); - } - } - else { - isCommon = false; - } - } - if (isCommon) { - // Recursively merge objects and arrays (susceptible to call stack limits). - stack.set(srcValue, newValue); - mergeFunc(newValue, srcValue, srcIndex, customizer, stack); - stack['delete'](srcValue); - } - assignMergeValue(object, key, newValue); - } - - /** - * The base implementation of `_.nth` which doesn't coerce arguments. - * - * @private - * @param {Array} array The array to query. - * @param {number} n The index of the element to return. - * @returns {*} Returns the nth element of `array`. - */ - function baseNth(array, n) { - var length = array.length; - if (!length) { - return; - } - n += n < 0 ? length : 0; - return isIndex(n, length) ? array[n] : undefined; - } - - /** - * The base implementation of `_.orderBy` without param guards. - * - * @private - * @param {Array|Object} collection The collection to iterate over. - * @param {Function[]|Object[]|string[]} iteratees The iteratees to sort by. - * @param {string[]} orders The sort orders of `iteratees`. - * @returns {Array} Returns the new sorted array. - */ - function baseOrderBy(collection, iteratees, orders) { - var index = -1; - iteratees = arrayMap(iteratees.length ? iteratees : [identity], baseUnary(getIteratee())); - - var result = baseMap(collection, function(value, key, collection) { - var criteria = arrayMap(iteratees, function(iteratee) { - return iteratee(value); - }); - return { 'criteria': criteria, 'index': ++index, 'value': value }; - }); - - return baseSortBy(result, function(object, other) { - return compareMultiple(object, other, orders); - }); - } - - /** - * The base implementation of `_.pick` without support for individual - * property identifiers. - * - * @private - * @param {Object} object The source object. - * @param {string[]} paths The property paths to pick. - * @returns {Object} Returns the new object. - */ - function basePick(object, paths) { - return basePickBy(object, paths, function(value, path) { - return hasIn(object, path); - }); - } - - /** - * The base implementation of `_.pickBy` without support for iteratee shorthands. - * - * @private - * @param {Object} object The source object. - * @param {string[]} paths The property paths to pick. - * @param {Function} predicate The function invoked per property. - * @returns {Object} Returns the new object. - */ - function basePickBy(object, paths, predicate) { - var index = -1, - length = paths.length, - result = {}; - - while (++index < length) { - var path = paths[index], - value = baseGet(object, path); - - if (predicate(value, path)) { - baseSet(result, castPath(path, object), value); - } - } - return result; - } - - /** - * A specialized version of `baseProperty` which supports deep paths. - * - * @private - * @param {Array|string} path The path of the property to get. - * @returns {Function} Returns the new accessor function. - */ - function basePropertyDeep(path) { - return function(object) { - return baseGet(object, path); - }; - } - - /** - * The base implementation of `_.pullAllBy` without support for iteratee - * shorthands. - * - * @private - * @param {Array} array The array to modify. - * @param {Array} values The values to remove. - * @param {Function} [iteratee] The iteratee invoked per element. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns `array`. - */ - function basePullAll(array, values, iteratee, comparator) { - var indexOf = comparator ? baseIndexOfWith : baseIndexOf, - index = -1, - length = values.length, - seen = array; - - if (array === values) { - values = copyArray(values); - } - if (iteratee) { - seen = arrayMap(array, baseUnary(iteratee)); - } - while (++index < length) { - var fromIndex = 0, - value = values[index], - computed = iteratee ? iteratee(value) : value; - - while ((fromIndex = indexOf(seen, computed, fromIndex, comparator)) > -1) { - if (seen !== array) { - splice.call(seen, fromIndex, 1); - } - splice.call(array, fromIndex, 1); - } - } - return array; - } - - /** - * The base implementation of `_.pullAt` without support for individual - * indexes or capturing the removed elements. - * - * @private - * @param {Array} array The array to modify. - * @param {number[]} indexes The indexes of elements to remove. - * @returns {Array} Returns `array`. - */ - function basePullAt(array, indexes) { - var length = array ? indexes.length : 0, - lastIndex = length - 1; - - while (length--) { - var index = indexes[length]; - if (length == lastIndex || index !== previous) { - var previous = index; - if (isIndex(index)) { - splice.call(array, index, 1); - } else { - baseUnset(array, index); - } - } - } - return array; - } - - /** - * The base implementation of `_.random` without support for returning - * floating-point numbers. - * - * @private - * @param {number} lower The lower bound. - * @param {number} upper The upper bound. - * @returns {number} Returns the random number. - */ - function baseRandom(lower, upper) { - return lower + nativeFloor(nativeRandom() * (upper - lower + 1)); - } - - /** - * The base implementation of `_.range` and `_.rangeRight` which doesn't - * coerce arguments. - * - * @private - * @param {number} start The start of the range. - * @param {number} end The end of the range. - * @param {number} step The value to increment or decrement by. - * @param {boolean} [fromRight] Specify iterating from right to left. - * @returns {Array} Returns the range of numbers. - */ - function baseRange(start, end, step, fromRight) { - var index = -1, - length = nativeMax(nativeCeil((end - start) / (step || 1)), 0), - result = Array(length); - - while (length--) { - result[fromRight ? length : ++index] = start; - start += step; - } - return result; - } - - /** - * The base implementation of `_.repeat` which doesn't coerce arguments. - * - * @private - * @param {string} string The string to repeat. - * @param {number} n The number of times to repeat the string. - * @returns {string} Returns the repeated string. - */ - function baseRepeat(string, n) { - var result = ''; - if (!string || n < 1 || n > MAX_SAFE_INTEGER) { - return result; - } - // Leverage the exponentiation by squaring algorithm for a faster repeat. - // See https://en.wikipedia.org/wiki/Exponentiation_by_squaring for more details. - do { - if (n % 2) { - result += string; - } - n = nativeFloor(n / 2); - if (n) { - string += string; - } - } while (n); - - return result; - } - - /** - * The base implementation of `_.rest` which doesn't validate or coerce arguments. - * - * @private - * @param {Function} func The function to apply a rest parameter to. - * @param {number} [start=func.length-1] The start position of the rest parameter. - * @returns {Function} Returns the new function. - */ - function baseRest(func, start) { - return setToString(overRest(func, start, identity), func + ''); - } - - /** - * The base implementation of `_.sample`. - * - * @private - * @param {Array|Object} collection The collection to sample. - * @returns {*} Returns the random element. - */ - function baseSample(collection) { - return arraySample(values(collection)); - } - - /** - * The base implementation of `_.sampleSize` without param guards. - * - * @private - * @param {Array|Object} collection The collection to sample. - * @param {number} n The number of elements to sample. - * @returns {Array} Returns the random elements. - */ - function baseSampleSize(collection, n) { - var array = values(collection); - return shuffleSelf(array, baseClamp(n, 0, array.length)); - } - - /** - * The base implementation of `_.set`. - * - * @private - * @param {Object} object The object to modify. - * @param {Array|string} path The path of the property to set. - * @param {*} value The value to set. - * @param {Function} [customizer] The function to customize path creation. - * @returns {Object} Returns `object`. - */ - function baseSet(object, path, value, customizer) { - if (!isObject(object)) { - return object; - } - path = castPath(path, object); - - var index = -1, - length = path.length, - lastIndex = length - 1, - nested = object; - - while (nested != null && ++index < length) { - var key = toKey(path[index]), - newValue = value; - - if (index != lastIndex) { - var objValue = nested[key]; - newValue = customizer ? customizer(objValue, key, nested) : undefined; - if (newValue === undefined) { - newValue = isObject(objValue) - ? objValue - : (isIndex(path[index + 1]) ? [] : {}); - } - } - assignValue(nested, key, newValue); - nested = nested[key]; - } - return object; - } - - /** - * The base implementation of `setData` without support for hot loop shorting. - * - * @private - * @param {Function} func The function to associate metadata with. - * @param {*} data The metadata. - * @returns {Function} Returns `func`. - */ - var baseSetData = !metaMap ? identity : function(func, data) { - metaMap.set(func, data); - return func; - }; - - /** - * The base implementation of `setToString` without support for hot loop shorting. - * - * @private - * @param {Function} func The function to modify. - * @param {Function} string The `toString` result. - * @returns {Function} Returns `func`. - */ - var baseSetToString = !defineProperty ? identity : function(func, string) { - return defineProperty(func, 'toString', { - 'configurable': true, - 'enumerable': false, - 'value': constant(string), - 'writable': true - }); - }; - - /** - * The base implementation of `_.shuffle`. - * - * @private - * @param {Array|Object} collection The collection to shuffle. - * @returns {Array} Returns the new shuffled array. - */ - function baseShuffle(collection) { - return shuffleSelf(values(collection)); - } - - /** - * The base implementation of `_.slice` without an iteratee call guard. - * - * @private - * @param {Array} array The array to slice. - * @param {number} [start=0] The start position. - * @param {number} [end=array.length] The end position. - * @returns {Array} Returns the slice of `array`. - */ - function baseSlice(array, start, end) { - var index = -1, - length = array.length; - - if (start < 0) { - start = -start > length ? 0 : (length + start); - } - end = end > length ? length : end; - if (end < 0) { - end += length; - } - length = start > end ? 0 : ((end - start) >>> 0); - start >>>= 0; - - var result = Array(length); - while (++index < length) { - result[index] = array[index + start]; - } - return result; - } - - /** - * The base implementation of `_.some` without support for iteratee shorthands. - * - * @private - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} predicate The function invoked per iteration. - * @returns {boolean} Returns `true` if any element passes the predicate check, - * else `false`. - */ - function baseSome(collection, predicate) { - var result; - - baseEach(collection, function(value, index, collection) { - result = predicate(value, index, collection); - return !result; - }); - return !!result; - } - - /** - * The base implementation of `_.sortedIndex` and `_.sortedLastIndex` which - * performs a binary search of `array` to determine the index at which `value` - * should be inserted into `array` in order to maintain its sort order. - * - * @private - * @param {Array} array The sorted array to inspect. - * @param {*} value The value to evaluate. - * @param {boolean} [retHighest] Specify returning the highest qualified index. - * @returns {number} Returns the index at which `value` should be inserted - * into `array`. - */ - function baseSortedIndex(array, value, retHighest) { - var low = 0, - high = array == null ? low : array.length; - - if (typeof value == 'number' && value === value && high <= HALF_MAX_ARRAY_LENGTH) { - while (low < high) { - var mid = (low + high) >>> 1, - computed = array[mid]; - - if (computed !== null && !isSymbol(computed) && - (retHighest ? (computed <= value) : (computed < value))) { - low = mid + 1; - } else { - high = mid; - } - } - return high; - } - return baseSortedIndexBy(array, value, identity, retHighest); - } - - /** - * The base implementation of `_.sortedIndexBy` and `_.sortedLastIndexBy` - * which invokes `iteratee` for `value` and each element of `array` to compute - * their sort ranking. The iteratee is invoked with one argument; (value). - * - * @private - * @param {Array} array The sorted array to inspect. - * @param {*} value The value to evaluate. - * @param {Function} iteratee The iteratee invoked per element. - * @param {boolean} [retHighest] Specify returning the highest qualified index. - * @returns {number} Returns the index at which `value` should be inserted - * into `array`. - */ - function baseSortedIndexBy(array, value, iteratee, retHighest) { - value = iteratee(value); - - var low = 0, - high = array == null ? 0 : array.length, - valIsNaN = value !== value, - valIsNull = value === null, - valIsSymbol = isSymbol(value), - valIsUndefined = value === undefined; - - while (low < high) { - var mid = nativeFloor((low + high) / 2), - computed = iteratee(array[mid]), - othIsDefined = computed !== undefined, - othIsNull = computed === null, - othIsReflexive = computed === computed, - othIsSymbol = isSymbol(computed); - - if (valIsNaN) { - var setLow = retHighest || othIsReflexive; - } else if (valIsUndefined) { - setLow = othIsReflexive && (retHighest || othIsDefined); - } else if (valIsNull) { - setLow = othIsReflexive && othIsDefined && (retHighest || !othIsNull); - } else if (valIsSymbol) { - setLow = othIsReflexive && othIsDefined && !othIsNull && (retHighest || !othIsSymbol); - } else if (othIsNull || othIsSymbol) { - setLow = false; - } else { - setLow = retHighest ? (computed <= value) : (computed < value); - } - if (setLow) { - low = mid + 1; - } else { - high = mid; - } - } - return nativeMin(high, MAX_ARRAY_INDEX); - } - - /** - * The base implementation of `_.sortedUniq` and `_.sortedUniqBy` without - * support for iteratee shorthands. - * - * @private - * @param {Array} array The array to inspect. - * @param {Function} [iteratee] The iteratee invoked per element. - * @returns {Array} Returns the new duplicate free array. - */ - function baseSortedUniq(array, iteratee) { - var index = -1, - length = array.length, - resIndex = 0, - result = []; - - while (++index < length) { - var value = array[index], - computed = iteratee ? iteratee(value) : value; - - if (!index || !eq(computed, seen)) { - var seen = computed; - result[resIndex++] = value === 0 ? 0 : value; - } - } - return result; - } - - /** - * The base implementation of `_.toNumber` which doesn't ensure correct - * conversions of binary, hexadecimal, or octal string values. - * - * @private - * @param {*} value The value to process. - * @returns {number} Returns the number. - */ - function baseToNumber(value) { - if (typeof value == 'number') { - return value; - } - if (isSymbol(value)) { - return NAN; - } - return +value; - } - - /** - * The base implementation of `_.toString` which doesn't convert nullish - * values to empty strings. - * - * @private - * @param {*} value The value to process. - * @returns {string} Returns the string. - */ - function baseToString(value) { - // Exit early for strings to avoid a performance hit in some environments. - if (typeof value == 'string') { - return value; - } - if (isArray(value)) { - // Recursively convert values (susceptible to call stack limits). - return arrayMap(value, baseToString) + ''; - } - if (isSymbol(value)) { - return symbolToString ? symbolToString.call(value) : ''; - } - var result = (value + ''); - return (result == '0' && (1 / value) == -INFINITY) ? '-0' : result; - } - - /** - * The base implementation of `_.uniqBy` without support for iteratee shorthands. - * - * @private - * @param {Array} array The array to inspect. - * @param {Function} [iteratee] The iteratee invoked per element. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new duplicate free array. - */ - function baseUniq(array, iteratee, comparator) { - var index = -1, - includes = arrayIncludes, - length = array.length, - isCommon = true, - result = [], - seen = result; - - if (comparator) { - isCommon = false; - includes = arrayIncludesWith; - } - else if (length >= LARGE_ARRAY_SIZE) { - var set = iteratee ? null : createSet(array); - if (set) { - return setToArray(set); - } - isCommon = false; - includes = cacheHas; - seen = new SetCache; - } - else { - seen = iteratee ? [] : result; - } - outer: - while (++index < length) { - var value = array[index], - computed = iteratee ? iteratee(value) : value; - - value = (comparator || value !== 0) ? value : 0; - if (isCommon && computed === computed) { - var seenIndex = seen.length; - while (seenIndex--) { - if (seen[seenIndex] === computed) { - continue outer; - } - } - if (iteratee) { - seen.push(computed); - } - result.push(value); - } - else if (!includes(seen, computed, comparator)) { - if (seen !== result) { - seen.push(computed); - } - result.push(value); - } - } - return result; - } - - /** - * The base implementation of `_.unset`. - * - * @private - * @param {Object} object The object to modify. - * @param {Array|string} path The property path to unset. - * @returns {boolean} Returns `true` if the property is deleted, else `false`. - */ - function baseUnset(object, path) { - path = castPath(path, object); - object = parent(object, path); - return object == null || delete object[toKey(last(path))]; - } - - /** - * The base implementation of `_.update`. - * - * @private - * @param {Object} object The object to modify. - * @param {Array|string} path The path of the property to update. - * @param {Function} updater The function to produce the updated value. - * @param {Function} [customizer] The function to customize path creation. - * @returns {Object} Returns `object`. - */ - function baseUpdate(object, path, updater, customizer) { - return baseSet(object, path, updater(baseGet(object, path)), customizer); - } - - /** - * The base implementation of methods like `_.dropWhile` and `_.takeWhile` - * without support for iteratee shorthands. - * - * @private - * @param {Array} array The array to query. - * @param {Function} predicate The function invoked per iteration. - * @param {boolean} [isDrop] Specify dropping elements instead of taking them. - * @param {boolean} [fromRight] Specify iterating from right to left. - * @returns {Array} Returns the slice of `array`. - */ - function baseWhile(array, predicate, isDrop, fromRight) { - var length = array.length, - index = fromRight ? length : -1; - - while ((fromRight ? index-- : ++index < length) && - predicate(array[index], index, array)) {} - - return isDrop - ? baseSlice(array, (fromRight ? 0 : index), (fromRight ? index + 1 : length)) - : baseSlice(array, (fromRight ? index + 1 : 0), (fromRight ? length : index)); - } - - /** - * The base implementation of `wrapperValue` which returns the result of - * performing a sequence of actions on the unwrapped `value`, where each - * successive action is supplied the return value of the previous. - * - * @private - * @param {*} value The unwrapped value. - * @param {Array} actions Actions to perform to resolve the unwrapped value. - * @returns {*} Returns the resolved value. - */ - function baseWrapperValue(value, actions) { - var result = value; - if (result instanceof LazyWrapper) { - result = result.value(); - } - return arrayReduce(actions, function(result, action) { - return action.func.apply(action.thisArg, arrayPush([result], action.args)); - }, result); - } - - /** - * The base implementation of methods like `_.xor`, without support for - * iteratee shorthands, that accepts an array of arrays to inspect. - * - * @private - * @param {Array} arrays The arrays to inspect. - * @param {Function} [iteratee] The iteratee invoked per element. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new array of values. - */ - function baseXor(arrays, iteratee, comparator) { - var length = arrays.length; - if (length < 2) { - return length ? baseUniq(arrays[0]) : []; - } - var index = -1, - result = Array(length); - - while (++index < length) { - var array = arrays[index], - othIndex = -1; - - while (++othIndex < length) { - if (othIndex != index) { - result[index] = baseDifference(result[index] || array, arrays[othIndex], iteratee, comparator); - } - } - } - return baseUniq(baseFlatten(result, 1), iteratee, comparator); - } - - /** - * This base implementation of `_.zipObject` which assigns values using `assignFunc`. - * - * @private - * @param {Array} props The property identifiers. - * @param {Array} values The property values. - * @param {Function} assignFunc The function to assign values. - * @returns {Object} Returns the new object. - */ - function baseZipObject(props, values, assignFunc) { - var index = -1, - length = props.length, - valsLength = values.length, - result = {}; - - while (++index < length) { - var value = index < valsLength ? values[index] : undefined; - assignFunc(result, props[index], value); - } - return result; - } - - /** - * Casts `value` to an empty array if it's not an array like object. - * - * @private - * @param {*} value The value to inspect. - * @returns {Array|Object} Returns the cast array-like object. - */ - function castArrayLikeObject(value) { - return isArrayLikeObject(value) ? value : []; - } - - /** - * Casts `value` to `identity` if it's not a function. - * - * @private - * @param {*} value The value to inspect. - * @returns {Function} Returns cast function. - */ - function castFunction(value) { - return typeof value == 'function' ? value : identity; - } - - /** - * Casts `value` to a path array if it's not one. - * - * @private - * @param {*} value The value to inspect. - * @param {Object} [object] The object to query keys on. - * @returns {Array} Returns the cast property path array. - */ - function castPath(value, object) { - if (isArray(value)) { - return value; - } - return isKey(value, object) ? [value] : stringToPath(toString(value)); - } - - /** - * A `baseRest` alias which can be replaced with `identity` by module - * replacement plugins. - * - * @private - * @type {Function} - * @param {Function} func The function to apply a rest parameter to. - * @returns {Function} Returns the new function. - */ - var castRest = baseRest; - - /** - * Casts `array` to a slice if it's needed. - * - * @private - * @param {Array} array The array to inspect. - * @param {number} start The start position. - * @param {number} [end=array.length] The end position. - * @returns {Array} Returns the cast slice. - */ - function castSlice(array, start, end) { - var length = array.length; - end = end === undefined ? length : end; - return (!start && end >= length) ? array : baseSlice(array, start, end); - } - - /** - * A simple wrapper around the global [`clearTimeout`](https://mdn.io/clearTimeout). - * - * @private - * @param {number|Object} id The timer id or timeout object of the timer to clear. - */ - var clearTimeout = ctxClearTimeout || function(id) { - return root.clearTimeout(id); - }; - - /** - * Creates a clone of `buffer`. - * - * @private - * @param {Buffer} buffer The buffer to clone. - * @param {boolean} [isDeep] Specify a deep clone. - * @returns {Buffer} Returns the cloned buffer. - */ - function cloneBuffer(buffer, isDeep) { - if (isDeep) { - return buffer.slice(); - } - var length = buffer.length, - result = allocUnsafe ? allocUnsafe(length) : new buffer.constructor(length); - - buffer.copy(result); - return result; - } - - /** - * Creates a clone of `arrayBuffer`. - * - * @private - * @param {ArrayBuffer} arrayBuffer The array buffer to clone. - * @returns {ArrayBuffer} Returns the cloned array buffer. - */ - function cloneArrayBuffer(arrayBuffer) { - var result = new arrayBuffer.constructor(arrayBuffer.byteLength); - new Uint8Array(result).set(new Uint8Array(arrayBuffer)); - return result; - } - - /** - * Creates a clone of `dataView`. - * - * @private - * @param {Object} dataView The data view to clone. - * @param {boolean} [isDeep] Specify a deep clone. - * @returns {Object} Returns the cloned data view. - */ - function cloneDataView(dataView, isDeep) { - var buffer = isDeep ? cloneArrayBuffer(dataView.buffer) : dataView.buffer; - return new dataView.constructor(buffer, dataView.byteOffset, dataView.byteLength); - } - - /** - * Creates a clone of `regexp`. - * - * @private - * @param {Object} regexp The regexp to clone. - * @returns {Object} Returns the cloned regexp. - */ - function cloneRegExp(regexp) { - var result = new regexp.constructor(regexp.source, reFlags.exec(regexp)); - result.lastIndex = regexp.lastIndex; - return result; - } - - /** - * Creates a clone of the `symbol` object. - * - * @private - * @param {Object} symbol The symbol object to clone. - * @returns {Object} Returns the cloned symbol object. - */ - function cloneSymbol(symbol) { - return symbolValueOf ? Object(symbolValueOf.call(symbol)) : {}; - } - - /** - * Creates a clone of `typedArray`. - * - * @private - * @param {Object} typedArray The typed array to clone. - * @param {boolean} [isDeep] Specify a deep clone. - * @returns {Object} Returns the cloned typed array. - */ - function cloneTypedArray(typedArray, isDeep) { - var buffer = isDeep ? cloneArrayBuffer(typedArray.buffer) : typedArray.buffer; - return new typedArray.constructor(buffer, typedArray.byteOffset, typedArray.length); - } - - /** - * Compares values to sort them in ascending order. - * - * @private - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {number} Returns the sort order indicator for `value`. - */ - function compareAscending(value, other) { - if (value !== other) { - var valIsDefined = value !== undefined, - valIsNull = value === null, - valIsReflexive = value === value, - valIsSymbol = isSymbol(value); - - var othIsDefined = other !== undefined, - othIsNull = other === null, - othIsReflexive = other === other, - othIsSymbol = isSymbol(other); - - if ((!othIsNull && !othIsSymbol && !valIsSymbol && value > other) || - (valIsSymbol && othIsDefined && othIsReflexive && !othIsNull && !othIsSymbol) || - (valIsNull && othIsDefined && othIsReflexive) || - (!valIsDefined && othIsReflexive) || - !valIsReflexive) { - return 1; - } - if ((!valIsNull && !valIsSymbol && !othIsSymbol && value < other) || - (othIsSymbol && valIsDefined && valIsReflexive && !valIsNull && !valIsSymbol) || - (othIsNull && valIsDefined && valIsReflexive) || - (!othIsDefined && valIsReflexive) || - !othIsReflexive) { - return -1; - } - } - return 0; - } - - /** - * Used by `_.orderBy` to compare multiple properties of a value to another - * and stable sort them. - * - * If `orders` is unspecified, all values are sorted in ascending order. Otherwise, - * specify an order of "desc" for descending or "asc" for ascending sort order - * of corresponding values. - * - * @private - * @param {Object} object The object to compare. - * @param {Object} other The other object to compare. - * @param {boolean[]|string[]} orders The order to sort by for each property. - * @returns {number} Returns the sort order indicator for `object`. - */ - function compareMultiple(object, other, orders) { - var index = -1, - objCriteria = object.criteria, - othCriteria = other.criteria, - length = objCriteria.length, - ordersLength = orders.length; - - while (++index < length) { - var result = compareAscending(objCriteria[index], othCriteria[index]); - if (result) { - if (index >= ordersLength) { - return result; - } - var order = orders[index]; - return result * (order == 'desc' ? -1 : 1); - } - } - // Fixes an `Array#sort` bug in the JS engine embedded in Adobe applications - // that causes it, under certain circumstances, to provide the same value for - // `object` and `other`. See https://github.com/jashkenas/underscore/pull/1247 - // for more details. - // - // This also ensures a stable sort in V8 and other engines. - // See https://bugs.chromium.org/p/v8/issues/detail?id=90 for more details. - return object.index - other.index; - } - - /** - * Creates an array that is the composition of partially applied arguments, - * placeholders, and provided arguments into a single array of arguments. - * - * @private - * @param {Array} args The provided arguments. - * @param {Array} partials The arguments to prepend to those provided. - * @param {Array} holders The `partials` placeholder indexes. - * @params {boolean} [isCurried] Specify composing for a curried function. - * @returns {Array} Returns the new array of composed arguments. - */ - function composeArgs(args, partials, holders, isCurried) { - var argsIndex = -1, - argsLength = args.length, - holdersLength = holders.length, - leftIndex = -1, - leftLength = partials.length, - rangeLength = nativeMax(argsLength - holdersLength, 0), - result = Array(leftLength + rangeLength), - isUncurried = !isCurried; - - while (++leftIndex < leftLength) { - result[leftIndex] = partials[leftIndex]; - } - while (++argsIndex < holdersLength) { - if (isUncurried || argsIndex < argsLength) { - result[holders[argsIndex]] = args[argsIndex]; - } - } - while (rangeLength--) { - result[leftIndex++] = args[argsIndex++]; - } - return result; - } - - /** - * This function is like `composeArgs` except that the arguments composition - * is tailored for `_.partialRight`. - * - * @private - * @param {Array} args The provided arguments. - * @param {Array} partials The arguments to append to those provided. - * @param {Array} holders The `partials` placeholder indexes. - * @params {boolean} [isCurried] Specify composing for a curried function. - * @returns {Array} Returns the new array of composed arguments. - */ - function composeArgsRight(args, partials, holders, isCurried) { - var argsIndex = -1, - argsLength = args.length, - holdersIndex = -1, - holdersLength = holders.length, - rightIndex = -1, - rightLength = partials.length, - rangeLength = nativeMax(argsLength - holdersLength, 0), - result = Array(rangeLength + rightLength), - isUncurried = !isCurried; - - while (++argsIndex < rangeLength) { - result[argsIndex] = args[argsIndex]; - } - var offset = argsIndex; - while (++rightIndex < rightLength) { - result[offset + rightIndex] = partials[rightIndex]; - } - while (++holdersIndex < holdersLength) { - if (isUncurried || argsIndex < argsLength) { - result[offset + holders[holdersIndex]] = args[argsIndex++]; - } - } - return result; - } - - /** - * Copies the values of `source` to `array`. - * - * @private - * @param {Array} source The array to copy values from. - * @param {Array} [array=[]] The array to copy values to. - * @returns {Array} Returns `array`. - */ - function copyArray(source, array) { - var index = -1, - length = source.length; - - array || (array = Array(length)); - while (++index < length) { - array[index] = source[index]; - } - return array; - } - - /** - * Copies properties of `source` to `object`. - * - * @private - * @param {Object} source The object to copy properties from. - * @param {Array} props The property identifiers to copy. - * @param {Object} [object={}] The object to copy properties to. - * @param {Function} [customizer] The function to customize copied values. - * @returns {Object} Returns `object`. - */ - function copyObject(source, props, object, customizer) { - var isNew = !object; - object || (object = {}); - - var index = -1, - length = props.length; - - while (++index < length) { - var key = props[index]; - - var newValue = customizer - ? customizer(object[key], source[key], key, object, source) - : undefined; - - if (newValue === undefined) { - newValue = source[key]; - } - if (isNew) { - baseAssignValue(object, key, newValue); - } else { - assignValue(object, key, newValue); - } - } - return object; - } - - /** - * Copies own symbols of `source` to `object`. - * - * @private - * @param {Object} source The object to copy symbols from. - * @param {Object} [object={}] The object to copy symbols to. - * @returns {Object} Returns `object`. - */ - function copySymbols(source, object) { - return copyObject(source, getSymbols(source), object); - } - - /** - * Copies own and inherited symbols of `source` to `object`. - * - * @private - * @param {Object} source The object to copy symbols from. - * @param {Object} [object={}] The object to copy symbols to. - * @returns {Object} Returns `object`. - */ - function copySymbolsIn(source, object) { - return copyObject(source, getSymbolsIn(source), object); - } - - /** - * Creates a function like `_.groupBy`. - * - * @private - * @param {Function} setter The function to set accumulator values. - * @param {Function} [initializer] The accumulator object initializer. - * @returns {Function} Returns the new aggregator function. - */ - function createAggregator(setter, initializer) { - return function(collection, iteratee) { - var func = isArray(collection) ? arrayAggregator : baseAggregator, - accumulator = initializer ? initializer() : {}; - - return func(collection, setter, getIteratee(iteratee, 2), accumulator); - }; - } - - /** - * Creates a function like `_.assign`. - * - * @private - * @param {Function} assigner The function to assign values. - * @returns {Function} Returns the new assigner function. - */ - function createAssigner(assigner) { - return baseRest(function(object, sources) { - var index = -1, - length = sources.length, - customizer = length > 1 ? sources[length - 1] : undefined, - guard = length > 2 ? sources[2] : undefined; - - customizer = (assigner.length > 3 && typeof customizer == 'function') - ? (length--, customizer) - : undefined; - - if (guard && isIterateeCall(sources[0], sources[1], guard)) { - customizer = length < 3 ? undefined : customizer; - length = 1; - } - object = Object(object); - while (++index < length) { - var source = sources[index]; - if (source) { - assigner(object, source, index, customizer); - } - } - return object; - }); - } - - /** - * Creates a `baseEach` or `baseEachRight` function. - * - * @private - * @param {Function} eachFunc The function to iterate over a collection. - * @param {boolean} [fromRight] Specify iterating from right to left. - * @returns {Function} Returns the new base function. - */ - function createBaseEach(eachFunc, fromRight) { - return function(collection, iteratee) { - if (collection == null) { - return collection; - } - if (!isArrayLike(collection)) { - return eachFunc(collection, iteratee); - } - var length = collection.length, - index = fromRight ? length : -1, - iterable = Object(collection); - - while ((fromRight ? index-- : ++index < length)) { - if (iteratee(iterable[index], index, iterable) === false) { - break; - } - } - return collection; - }; - } - - /** - * Creates a base function for methods like `_.forIn` and `_.forOwn`. - * - * @private - * @param {boolean} [fromRight] Specify iterating from right to left. - * @returns {Function} Returns the new base function. - */ - function createBaseFor(fromRight) { - return function(object, iteratee, keysFunc) { - var index = -1, - iterable = Object(object), - props = keysFunc(object), - length = props.length; - - while (length--) { - var key = props[fromRight ? length : ++index]; - if (iteratee(iterable[key], key, iterable) === false) { - break; - } - } - return object; - }; - } - - /** - * Creates a function that wraps `func` to invoke it with the optional `this` - * binding of `thisArg`. - * - * @private - * @param {Function} func The function to wrap. - * @param {number} bitmask The bitmask flags. See `createWrap` for more details. - * @param {*} [thisArg] The `this` binding of `func`. - * @returns {Function} Returns the new wrapped function. - */ - function createBind(func, bitmask, thisArg) { - var isBind = bitmask & WRAP_BIND_FLAG, - Ctor = createCtor(func); - - function wrapper() { - var fn = (this && this !== root && this instanceof wrapper) ? Ctor : func; - return fn.apply(isBind ? thisArg : this, arguments); - } - return wrapper; - } - - /** - * Creates a function like `_.lowerFirst`. - * - * @private - * @param {string} methodName The name of the `String` case method to use. - * @returns {Function} Returns the new case function. - */ - function createCaseFirst(methodName) { - return function(string) { - string = toString(string); - - var strSymbols = hasUnicode(string) - ? stringToArray(string) - : undefined; - - var chr = strSymbols - ? strSymbols[0] - : string.charAt(0); - - var trailing = strSymbols - ? castSlice(strSymbols, 1).join('') - : string.slice(1); - - return chr[methodName]() + trailing; - }; - } - - /** - * Creates a function like `_.camelCase`. - * - * @private - * @param {Function} callback The function to combine each word. - * @returns {Function} Returns the new compounder function. - */ - function createCompounder(callback) { - return function(string) { - return arrayReduce(words(deburr(string).replace(reApos, '')), callback, ''); - }; - } - - /** - * Creates a function that produces an instance of `Ctor` regardless of - * whether it was invoked as part of a `new` expression or by `call` or `apply`. - * - * @private - * @param {Function} Ctor The constructor to wrap. - * @returns {Function} Returns the new wrapped function. - */ - function createCtor(Ctor) { - return function() { - // Use a `switch` statement to work with class constructors. See - // http://ecma-international.org/ecma-262/7.0/#sec-ecmascript-function-objects-call-thisargument-argumentslist - // for more details. - var args = arguments; - switch (args.length) { - case 0: return new Ctor; - case 1: return new Ctor(args[0]); - case 2: return new Ctor(args[0], args[1]); - case 3: return new Ctor(args[0], args[1], args[2]); - case 4: return new Ctor(args[0], args[1], args[2], args[3]); - case 5: return new Ctor(args[0], args[1], args[2], args[3], args[4]); - case 6: return new Ctor(args[0], args[1], args[2], args[3], args[4], args[5]); - case 7: return new Ctor(args[0], args[1], args[2], args[3], args[4], args[5], args[6]); - } - var thisBinding = baseCreate(Ctor.prototype), - result = Ctor.apply(thisBinding, args); - - // Mimic the constructor's `return` behavior. - // See https://es5.github.io/#x13.2.2 for more details. - return isObject(result) ? result : thisBinding; - }; - } - - /** - * Creates a function that wraps `func` to enable currying. - * - * @private - * @param {Function} func The function to wrap. - * @param {number} bitmask The bitmask flags. See `createWrap` for more details. - * @param {number} arity The arity of `func`. - * @returns {Function} Returns the new wrapped function. - */ - function createCurry(func, bitmask, arity) { - var Ctor = createCtor(func); - - function wrapper() { - var length = arguments.length, - args = Array(length), - index = length, - placeholder = getHolder(wrapper); - - while (index--) { - args[index] = arguments[index]; - } - var holders = (length < 3 && args[0] !== placeholder && args[length - 1] !== placeholder) - ? [] - : replaceHolders(args, placeholder); - - length -= holders.length; - if (length < arity) { - return createRecurry( - func, bitmask, createHybrid, wrapper.placeholder, undefined, - args, holders, undefined, undefined, arity - length); - } - var fn = (this && this !== root && this instanceof wrapper) ? Ctor : func; - return apply(fn, this, args); - } - return wrapper; - } - - /** - * Creates a `_.find` or `_.findLast` function. - * - * @private - * @param {Function} findIndexFunc The function to find the collection index. - * @returns {Function} Returns the new find function. - */ - function createFind(findIndexFunc) { - return function(collection, predicate, fromIndex) { - var iterable = Object(collection); - if (!isArrayLike(collection)) { - var iteratee = getIteratee(predicate, 3); - collection = keys(collection); - predicate = function(key) { return iteratee(iterable[key], key, iterable); }; - } - var index = findIndexFunc(collection, predicate, fromIndex); - return index > -1 ? iterable[iteratee ? collection[index] : index] : undefined; - }; - } - - /** - * Creates a `_.flow` or `_.flowRight` function. - * - * @private - * @param {boolean} [fromRight] Specify iterating from right to left. - * @returns {Function} Returns the new flow function. - */ - function createFlow(fromRight) { - return flatRest(function(funcs) { - var length = funcs.length, - index = length, - prereq = LodashWrapper.prototype.thru; - - if (fromRight) { - funcs.reverse(); - } - while (index--) { - var func = funcs[index]; - if (typeof func != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - if (prereq && !wrapper && getFuncName(func) == 'wrapper') { - var wrapper = new LodashWrapper([], true); - } - } - index = wrapper ? index : length; - while (++index < length) { - func = funcs[index]; - - var funcName = getFuncName(func), - data = funcName == 'wrapper' ? getData(func) : undefined; - - if (data && isLaziable(data[0]) && - data[1] == (WRAP_ARY_FLAG | WRAP_CURRY_FLAG | WRAP_PARTIAL_FLAG | WRAP_REARG_FLAG) && - !data[4].length && data[9] == 1 - ) { - wrapper = wrapper[getFuncName(data[0])].apply(wrapper, data[3]); - } else { - wrapper = (func.length == 1 && isLaziable(func)) - ? wrapper[funcName]() - : wrapper.thru(func); - } - } - return function() { - var args = arguments, - value = args[0]; - - if (wrapper && args.length == 1 && isArray(value)) { - return wrapper.plant(value).value(); - } - var index = 0, - result = length ? funcs[index].apply(this, args) : value; - - while (++index < length) { - result = funcs[index].call(this, result); - } - return result; - }; - }); - } - - /** - * Creates a function that wraps `func` to invoke it with optional `this` - * binding of `thisArg`, partial application, and currying. - * - * @private - * @param {Function|string} func The function or method name to wrap. - * @param {number} bitmask The bitmask flags. See `createWrap` for more details. - * @param {*} [thisArg] The `this` binding of `func`. - * @param {Array} [partials] The arguments to prepend to those provided to - * the new function. - * @param {Array} [holders] The `partials` placeholder indexes. - * @param {Array} [partialsRight] The arguments to append to those provided - * to the new function. - * @param {Array} [holdersRight] The `partialsRight` placeholder indexes. - * @param {Array} [argPos] The argument positions of the new function. - * @param {number} [ary] The arity cap of `func`. - * @param {number} [arity] The arity of `func`. - * @returns {Function} Returns the new wrapped function. - */ - function createHybrid(func, bitmask, thisArg, partials, holders, partialsRight, holdersRight, argPos, ary, arity) { - var isAry = bitmask & WRAP_ARY_FLAG, - isBind = bitmask & WRAP_BIND_FLAG, - isBindKey = bitmask & WRAP_BIND_KEY_FLAG, - isCurried = bitmask & (WRAP_CURRY_FLAG | WRAP_CURRY_RIGHT_FLAG), - isFlip = bitmask & WRAP_FLIP_FLAG, - Ctor = isBindKey ? undefined : createCtor(func); - - function wrapper() { - var length = arguments.length, - args = Array(length), - index = length; - - while (index--) { - args[index] = arguments[index]; - } - if (isCurried) { - var placeholder = getHolder(wrapper), - holdersCount = countHolders(args, placeholder); - } - if (partials) { - args = composeArgs(args, partials, holders, isCurried); - } - if (partialsRight) { - args = composeArgsRight(args, partialsRight, holdersRight, isCurried); - } - length -= holdersCount; - if (isCurried && length < arity) { - var newHolders = replaceHolders(args, placeholder); - return createRecurry( - func, bitmask, createHybrid, wrapper.placeholder, thisArg, - args, newHolders, argPos, ary, arity - length - ); - } - var thisBinding = isBind ? thisArg : this, - fn = isBindKey ? thisBinding[func] : func; - - length = args.length; - if (argPos) { - args = reorder(args, argPos); - } else if (isFlip && length > 1) { - args.reverse(); - } - if (isAry && ary < length) { - args.length = ary; - } - if (this && this !== root && this instanceof wrapper) { - fn = Ctor || createCtor(fn); - } - return fn.apply(thisBinding, args); - } - return wrapper; - } - - /** - * Creates a function like `_.invertBy`. - * - * @private - * @param {Function} setter The function to set accumulator values. - * @param {Function} toIteratee The function to resolve iteratees. - * @returns {Function} Returns the new inverter function. - */ - function createInverter(setter, toIteratee) { - return function(object, iteratee) { - return baseInverter(object, setter, toIteratee(iteratee), {}); - }; - } - - /** - * Creates a function that performs a mathematical operation on two values. - * - * @private - * @param {Function} operator The function to perform the operation. - * @param {number} [defaultValue] The value used for `undefined` arguments. - * @returns {Function} Returns the new mathematical operation function. - */ - function createMathOperation(operator, defaultValue) { - return function(value, other) { - var result; - if (value === undefined && other === undefined) { - return defaultValue; - } - if (value !== undefined) { - result = value; - } - if (other !== undefined) { - if (result === undefined) { - return other; - } - if (typeof value == 'string' || typeof other == 'string') { - value = baseToString(value); - other = baseToString(other); - } else { - value = baseToNumber(value); - other = baseToNumber(other); - } - result = operator(value, other); - } - return result; - }; - } - - /** - * Creates a function like `_.over`. - * - * @private - * @param {Function} arrayFunc The function to iterate over iteratees. - * @returns {Function} Returns the new over function. - */ - function createOver(arrayFunc) { - return flatRest(function(iteratees) { - iteratees = arrayMap(iteratees, baseUnary(getIteratee())); - return baseRest(function(args) { - var thisArg = this; - return arrayFunc(iteratees, function(iteratee) { - return apply(iteratee, thisArg, args); - }); - }); - }); - } - - /** - * Creates the padding for `string` based on `length`. The `chars` string - * is truncated if the number of characters exceeds `length`. - * - * @private - * @param {number} length The padding length. - * @param {string} [chars=' '] The string used as padding. - * @returns {string} Returns the padding for `string`. - */ - function createPadding(length, chars) { - chars = chars === undefined ? ' ' : baseToString(chars); - - var charsLength = chars.length; - if (charsLength < 2) { - return charsLength ? baseRepeat(chars, length) : chars; - } - var result = baseRepeat(chars, nativeCeil(length / stringSize(chars))); - return hasUnicode(chars) - ? castSlice(stringToArray(result), 0, length).join('') - : result.slice(0, length); - } - - /** - * Creates a function that wraps `func` to invoke it with the `this` binding - * of `thisArg` and `partials` prepended to the arguments it receives. - * - * @private - * @param {Function} func The function to wrap. - * @param {number} bitmask The bitmask flags. See `createWrap` for more details. - * @param {*} thisArg The `this` binding of `func`. - * @param {Array} partials The arguments to prepend to those provided to - * the new function. - * @returns {Function} Returns the new wrapped function. - */ - function createPartial(func, bitmask, thisArg, partials) { - var isBind = bitmask & WRAP_BIND_FLAG, - Ctor = createCtor(func); - - function wrapper() { - var argsIndex = -1, - argsLength = arguments.length, - leftIndex = -1, - leftLength = partials.length, - args = Array(leftLength + argsLength), - fn = (this && this !== root && this instanceof wrapper) ? Ctor : func; - - while (++leftIndex < leftLength) { - args[leftIndex] = partials[leftIndex]; - } - while (argsLength--) { - args[leftIndex++] = arguments[++argsIndex]; - } - return apply(fn, isBind ? thisArg : this, args); - } - return wrapper; - } - - /** - * Creates a `_.range` or `_.rangeRight` function. - * - * @private - * @param {boolean} [fromRight] Specify iterating from right to left. - * @returns {Function} Returns the new range function. - */ - function createRange(fromRight) { - return function(start, end, step) { - if (step && typeof step != 'number' && isIterateeCall(start, end, step)) { - end = step = undefined; - } - // Ensure the sign of `-0` is preserved. - start = toFinite(start); - if (end === undefined) { - end = start; - start = 0; - } else { - end = toFinite(end); - } - step = step === undefined ? (start < end ? 1 : -1) : toFinite(step); - return baseRange(start, end, step, fromRight); - }; - } - - /** - * Creates a function that performs a relational operation on two values. - * - * @private - * @param {Function} operator The function to perform the operation. - * @returns {Function} Returns the new relational operation function. - */ - function createRelationalOperation(operator) { - return function(value, other) { - if (!(typeof value == 'string' && typeof other == 'string')) { - value = toNumber(value); - other = toNumber(other); - } - return operator(value, other); - }; - } - - /** - * Creates a function that wraps `func` to continue currying. - * - * @private - * @param {Function} func The function to wrap. - * @param {number} bitmask The bitmask flags. See `createWrap` for more details. - * @param {Function} wrapFunc The function to create the `func` wrapper. - * @param {*} placeholder The placeholder value. - * @param {*} [thisArg] The `this` binding of `func`. - * @param {Array} [partials] The arguments to prepend to those provided to - * the new function. - * @param {Array} [holders] The `partials` placeholder indexes. - * @param {Array} [argPos] The argument positions of the new function. - * @param {number} [ary] The arity cap of `func`. - * @param {number} [arity] The arity of `func`. - * @returns {Function} Returns the new wrapped function. - */ - function createRecurry(func, bitmask, wrapFunc, placeholder, thisArg, partials, holders, argPos, ary, arity) { - var isCurry = bitmask & WRAP_CURRY_FLAG, - newHolders = isCurry ? holders : undefined, - newHoldersRight = isCurry ? undefined : holders, - newPartials = isCurry ? partials : undefined, - newPartialsRight = isCurry ? undefined : partials; - - bitmask |= (isCurry ? WRAP_PARTIAL_FLAG : WRAP_PARTIAL_RIGHT_FLAG); - bitmask &= ~(isCurry ? WRAP_PARTIAL_RIGHT_FLAG : WRAP_PARTIAL_FLAG); - - if (!(bitmask & WRAP_CURRY_BOUND_FLAG)) { - bitmask &= ~(WRAP_BIND_FLAG | WRAP_BIND_KEY_FLAG); - } - var newData = [ - func, bitmask, thisArg, newPartials, newHolders, newPartialsRight, - newHoldersRight, argPos, ary, arity - ]; - - var result = wrapFunc.apply(undefined, newData); - if (isLaziable(func)) { - setData(result, newData); - } - result.placeholder = placeholder; - return setWrapToString(result, func, bitmask); - } - - /** - * Creates a function like `_.round`. - * - * @private - * @param {string} methodName The name of the `Math` method to use when rounding. - * @returns {Function} Returns the new round function. - */ - function createRound(methodName) { - var func = Math[methodName]; - return function(number, precision) { - number = toNumber(number); - precision = precision == null ? 0 : nativeMin(toInteger(precision), 292); - if (precision) { - // Shift with exponential notation to avoid floating-point issues. - // See [MDN](https://mdn.io/round#Examples) for more details. - var pair = (toString(number) + 'e').split('e'), - value = func(pair[0] + 'e' + (+pair[1] + precision)); - - pair = (toString(value) + 'e').split('e'); - return +(pair[0] + 'e' + (+pair[1] - precision)); - } - return func(number); - }; - } - - /** - * Creates a set object of `values`. - * - * @private - * @param {Array} values The values to add to the set. - * @returns {Object} Returns the new set. - */ - var createSet = !(Set && (1 / setToArray(new Set([,-0]))[1]) == INFINITY) ? noop : function(values) { - return new Set(values); - }; - - /** - * Creates a `_.toPairs` or `_.toPairsIn` function. - * - * @private - * @param {Function} keysFunc The function to get the keys of a given object. - * @returns {Function} Returns the new pairs function. - */ - function createToPairs(keysFunc) { - return function(object) { - var tag = getTag(object); - if (tag == mapTag) { - return mapToArray(object); - } - if (tag == setTag) { - return setToPairs(object); - } - return baseToPairs(object, keysFunc(object)); - }; - } - - /** - * Creates a function that either curries or invokes `func` with optional - * `this` binding and partially applied arguments. - * - * @private - * @param {Function|string} func The function or method name to wrap. - * @param {number} bitmask The bitmask flags. - * 1 - `_.bind` - * 2 - `_.bindKey` - * 4 - `_.curry` or `_.curryRight` of a bound function - * 8 - `_.curry` - * 16 - `_.curryRight` - * 32 - `_.partial` - * 64 - `_.partialRight` - * 128 - `_.rearg` - * 256 - `_.ary` - * 512 - `_.flip` - * @param {*} [thisArg] The `this` binding of `func`. - * @param {Array} [partials] The arguments to be partially applied. - * @param {Array} [holders] The `partials` placeholder indexes. - * @param {Array} [argPos] The argument positions of the new function. - * @param {number} [ary] The arity cap of `func`. - * @param {number} [arity] The arity of `func`. - * @returns {Function} Returns the new wrapped function. - */ - function createWrap(func, bitmask, thisArg, partials, holders, argPos, ary, arity) { - var isBindKey = bitmask & WRAP_BIND_KEY_FLAG; - if (!isBindKey && typeof func != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - var length = partials ? partials.length : 0; - if (!length) { - bitmask &= ~(WRAP_PARTIAL_FLAG | WRAP_PARTIAL_RIGHT_FLAG); - partials = holders = undefined; - } - ary = ary === undefined ? ary : nativeMax(toInteger(ary), 0); - arity = arity === undefined ? arity : toInteger(arity); - length -= holders ? holders.length : 0; - - if (bitmask & WRAP_PARTIAL_RIGHT_FLAG) { - var partialsRight = partials, - holdersRight = holders; - - partials = holders = undefined; - } - var data = isBindKey ? undefined : getData(func); - - var newData = [ - func, bitmask, thisArg, partials, holders, partialsRight, holdersRight, - argPos, ary, arity - ]; - - if (data) { - mergeData(newData, data); - } - func = newData[0]; - bitmask = newData[1]; - thisArg = newData[2]; - partials = newData[3]; - holders = newData[4]; - arity = newData[9] = newData[9] === undefined - ? (isBindKey ? 0 : func.length) - : nativeMax(newData[9] - length, 0); - - if (!arity && bitmask & (WRAP_CURRY_FLAG | WRAP_CURRY_RIGHT_FLAG)) { - bitmask &= ~(WRAP_CURRY_FLAG | WRAP_CURRY_RIGHT_FLAG); - } - if (!bitmask || bitmask == WRAP_BIND_FLAG) { - var result = createBind(func, bitmask, thisArg); - } else if (bitmask == WRAP_CURRY_FLAG || bitmask == WRAP_CURRY_RIGHT_FLAG) { - result = createCurry(func, bitmask, arity); - } else if ((bitmask == WRAP_PARTIAL_FLAG || bitmask == (WRAP_BIND_FLAG | WRAP_PARTIAL_FLAG)) && !holders.length) { - result = createPartial(func, bitmask, thisArg, partials); - } else { - result = createHybrid.apply(undefined, newData); - } - var setter = data ? baseSetData : setData; - return setWrapToString(setter(result, newData), func, bitmask); - } - - /** - * Used by `_.defaults` to customize its `_.assignIn` use to assign properties - * of source objects to the destination object for all destination properties - * that resolve to `undefined`. - * - * @private - * @param {*} objValue The destination value. - * @param {*} srcValue The source value. - * @param {string} key The key of the property to assign. - * @param {Object} object The parent object of `objValue`. - * @returns {*} Returns the value to assign. - */ - function customDefaultsAssignIn(objValue, srcValue, key, object) { - if (objValue === undefined || - (eq(objValue, objectProto[key]) && !hasOwnProperty.call(object, key))) { - return srcValue; - } - return objValue; - } - - /** - * Used by `_.defaultsDeep` to customize its `_.merge` use to merge source - * objects into destination objects that are passed thru. - * - * @private - * @param {*} objValue The destination value. - * @param {*} srcValue The source value. - * @param {string} key The key of the property to merge. - * @param {Object} object The parent object of `objValue`. - * @param {Object} source The parent object of `srcValue`. - * @param {Object} [stack] Tracks traversed source values and their merged - * counterparts. - * @returns {*} Returns the value to assign. - */ - function customDefaultsMerge(objValue, srcValue, key, object, source, stack) { - if (isObject(objValue) && isObject(srcValue)) { - // Recursively merge objects and arrays (susceptible to call stack limits). - stack.set(srcValue, objValue); - baseMerge(objValue, srcValue, undefined, customDefaultsMerge, stack); - stack['delete'](srcValue); - } - return objValue; - } - - /** - * Used by `_.omit` to customize its `_.cloneDeep` use to only clone plain - * objects. - * - * @private - * @param {*} value The value to inspect. - * @param {string} key The key of the property to inspect. - * @returns {*} Returns the uncloned value or `undefined` to defer cloning to `_.cloneDeep`. - */ - function customOmitClone(value) { - return isPlainObject(value) ? undefined : value; - } - - /** - * A specialized version of `baseIsEqualDeep` for arrays with support for - * partial deep comparisons. - * - * @private - * @param {Array} array The array to compare. - * @param {Array} other The other array to compare. - * @param {number} bitmask The bitmask flags. See `baseIsEqual` for more details. - * @param {Function} customizer The function to customize comparisons. - * @param {Function} equalFunc The function to determine equivalents of values. - * @param {Object} stack Tracks traversed `array` and `other` objects. - * @returns {boolean} Returns `true` if the arrays are equivalent, else `false`. - */ - function equalArrays(array, other, bitmask, customizer, equalFunc, stack) { - var isPartial = bitmask & COMPARE_PARTIAL_FLAG, - arrLength = array.length, - othLength = other.length; - - if (arrLength != othLength && !(isPartial && othLength > arrLength)) { - return false; - } - // Assume cyclic values are equal. - var stacked = stack.get(array); - if (stacked && stack.get(other)) { - return stacked == other; - } - var index = -1, - result = true, - seen = (bitmask & COMPARE_UNORDERED_FLAG) ? new SetCache : undefined; - - stack.set(array, other); - stack.set(other, array); - - // Ignore non-index properties. - while (++index < arrLength) { - var arrValue = array[index], - othValue = other[index]; - - if (customizer) { - var compared = isPartial - ? customizer(othValue, arrValue, index, other, array, stack) - : customizer(arrValue, othValue, index, array, other, stack); - } - if (compared !== undefined) { - if (compared) { - continue; - } - result = false; - break; - } - // Recursively compare arrays (susceptible to call stack limits). - if (seen) { - if (!arraySome(other, function(othValue, othIndex) { - if (!cacheHas(seen, othIndex) && - (arrValue === othValue || equalFunc(arrValue, othValue, bitmask, customizer, stack))) { - return seen.push(othIndex); - } - })) { - result = false; - break; - } - } else if (!( - arrValue === othValue || - equalFunc(arrValue, othValue, bitmask, customizer, stack) - )) { - result = false; - break; - } - } - stack['delete'](array); - stack['delete'](other); - return result; - } - - /** - * A specialized version of `baseIsEqualDeep` for comparing objects of - * the same `toStringTag`. - * - * **Note:** This function only supports comparing values with tags of - * `Boolean`, `Date`, `Error`, `Number`, `RegExp`, or `String`. - * - * @private - * @param {Object} object The object to compare. - * @param {Object} other The other object to compare. - * @param {string} tag The `toStringTag` of the objects to compare. - * @param {number} bitmask The bitmask flags. See `baseIsEqual` for more details. - * @param {Function} customizer The function to customize comparisons. - * @param {Function} equalFunc The function to determine equivalents of values. - * @param {Object} stack Tracks traversed `object` and `other` objects. - * @returns {boolean} Returns `true` if the objects are equivalent, else `false`. - */ - function equalByTag(object, other, tag, bitmask, customizer, equalFunc, stack) { - switch (tag) { - case dataViewTag: - if ((object.byteLength != other.byteLength) || - (object.byteOffset != other.byteOffset)) { - return false; - } - object = object.buffer; - other = other.buffer; - - case arrayBufferTag: - if ((object.byteLength != other.byteLength) || - !equalFunc(new Uint8Array(object), new Uint8Array(other))) { - return false; - } - return true; - - case boolTag: - case dateTag: - case numberTag: - // Coerce booleans to `1` or `0` and dates to milliseconds. - // Invalid dates are coerced to `NaN`. - return eq(+object, +other); - - case errorTag: - return object.name == other.name && object.message == other.message; - - case regexpTag: - case stringTag: - // Coerce regexes to strings and treat strings, primitives and objects, - // as equal. See http://www.ecma-international.org/ecma-262/7.0/#sec-regexp.prototype.tostring - // for more details. - return object == (other + ''); - - case mapTag: - var convert = mapToArray; - - case setTag: - var isPartial = bitmask & COMPARE_PARTIAL_FLAG; - convert || (convert = setToArray); - - if (object.size != other.size && !isPartial) { - return false; - } - // Assume cyclic values are equal. - var stacked = stack.get(object); - if (stacked) { - return stacked == other; - } - bitmask |= COMPARE_UNORDERED_FLAG; - - // Recursively compare objects (susceptible to call stack limits). - stack.set(object, other); - var result = equalArrays(convert(object), convert(other), bitmask, customizer, equalFunc, stack); - stack['delete'](object); - return result; - - case symbolTag: - if (symbolValueOf) { - return symbolValueOf.call(object) == symbolValueOf.call(other); - } - } - return false; - } - - /** - * A specialized version of `baseIsEqualDeep` for objects with support for - * partial deep comparisons. - * - * @private - * @param {Object} object The object to compare. - * @param {Object} other The other object to compare. - * @param {number} bitmask The bitmask flags. See `baseIsEqual` for more details. - * @param {Function} customizer The function to customize comparisons. - * @param {Function} equalFunc The function to determine equivalents of values. - * @param {Object} stack Tracks traversed `object` and `other` objects. - * @returns {boolean} Returns `true` if the objects are equivalent, else `false`. - */ - function equalObjects(object, other, bitmask, customizer, equalFunc, stack) { - var isPartial = bitmask & COMPARE_PARTIAL_FLAG, - objProps = getAllKeys(object), - objLength = objProps.length, - othProps = getAllKeys(other), - othLength = othProps.length; - - if (objLength != othLength && !isPartial) { - return false; - } - var index = objLength; - while (index--) { - var key = objProps[index]; - if (!(isPartial ? key in other : hasOwnProperty.call(other, key))) { - return false; - } - } - // Assume cyclic values are equal. - var stacked = stack.get(object); - if (stacked && stack.get(other)) { - return stacked == other; - } - var result = true; - stack.set(object, other); - stack.set(other, object); - - var skipCtor = isPartial; - while (++index < objLength) { - key = objProps[index]; - var objValue = object[key], - othValue = other[key]; - - if (customizer) { - var compared = isPartial - ? customizer(othValue, objValue, key, other, object, stack) - : customizer(objValue, othValue, key, object, other, stack); - } - // Recursively compare objects (susceptible to call stack limits). - if (!(compared === undefined - ? (objValue === othValue || equalFunc(objValue, othValue, bitmask, customizer, stack)) - : compared - )) { - result = false; - break; - } - skipCtor || (skipCtor = key == 'constructor'); - } - if (result && !skipCtor) { - var objCtor = object.constructor, - othCtor = other.constructor; - - // Non `Object` object instances with different constructors are not equal. - if (objCtor != othCtor && - ('constructor' in object && 'constructor' in other) && - !(typeof objCtor == 'function' && objCtor instanceof objCtor && - typeof othCtor == 'function' && othCtor instanceof othCtor)) { - result = false; - } - } - stack['delete'](object); - stack['delete'](other); - return result; - } - - /** - * A specialized version of `baseRest` which flattens the rest array. - * - * @private - * @param {Function} func The function to apply a rest parameter to. - * @returns {Function} Returns the new function. - */ - function flatRest(func) { - return setToString(overRest(func, undefined, flatten), func + ''); - } - - /** - * Creates an array of own enumerable property names and symbols of `object`. - * - * @private - * @param {Object} object The object to query. - * @returns {Array} Returns the array of property names and symbols. - */ - function getAllKeys(object) { - return baseGetAllKeys(object, keys, getSymbols); - } - - /** - * Creates an array of own and inherited enumerable property names and - * symbols of `object`. - * - * @private - * @param {Object} object The object to query. - * @returns {Array} Returns the array of property names and symbols. - */ - function getAllKeysIn(object) { - return baseGetAllKeys(object, keysIn, getSymbolsIn); - } - - /** - * Gets metadata for `func`. - * - * @private - * @param {Function} func The function to query. - * @returns {*} Returns the metadata for `func`. - */ - var getData = !metaMap ? noop : function(func) { - return metaMap.get(func); - }; - - /** - * Gets the name of `func`. - * - * @private - * @param {Function} func The function to query. - * @returns {string} Returns the function name. - */ - function getFuncName(func) { - var result = (func.name + ''), - array = realNames[result], - length = hasOwnProperty.call(realNames, result) ? array.length : 0; - - while (length--) { - var data = array[length], - otherFunc = data.func; - if (otherFunc == null || otherFunc == func) { - return data.name; - } - } - return result; - } - - /** - * Gets the argument placeholder value for `func`. - * - * @private - * @param {Function} func The function to inspect. - * @returns {*} Returns the placeholder value. - */ - function getHolder(func) { - var object = hasOwnProperty.call(lodash, 'placeholder') ? lodash : func; - return object.placeholder; - } - - /** - * Gets the appropriate "iteratee" function. If `_.iteratee` is customized, - * this function returns the custom method, otherwise it returns `baseIteratee`. - * If arguments are provided, the chosen function is invoked with them and - * its result is returned. - * - * @private - * @param {*} [value] The value to convert to an iteratee. - * @param {number} [arity] The arity of the created iteratee. - * @returns {Function} Returns the chosen function or its result. - */ - function getIteratee() { - var result = lodash.iteratee || iteratee; - result = result === iteratee ? baseIteratee : result; - return arguments.length ? result(arguments[0], arguments[1]) : result; - } - - /** - * Gets the data for `map`. - * - * @private - * @param {Object} map The map to query. - * @param {string} key The reference key. - * @returns {*} Returns the map data. - */ - function getMapData(map, key) { - var data = map.__data__; - return isKeyable(key) - ? data[typeof key == 'string' ? 'string' : 'hash'] - : data.map; - } - - /** - * Gets the property names, values, and compare flags of `object`. - * - * @private - * @param {Object} object The object to query. - * @returns {Array} Returns the match data of `object`. - */ - function getMatchData(object) { - var result = keys(object), - length = result.length; - - while (length--) { - var key = result[length], - value = object[key]; - - result[length] = [key, value, isStrictComparable(value)]; - } - return result; - } - - /** - * Gets the native function at `key` of `object`. - * - * @private - * @param {Object} object The object to query. - * @param {string} key The key of the method to get. - * @returns {*} Returns the function if it's native, else `undefined`. - */ - function getNative(object, key) { - var value = getValue(object, key); - return baseIsNative(value) ? value : undefined; - } - - /** - * A specialized version of `baseGetTag` which ignores `Symbol.toStringTag` values. - * - * @private - * @param {*} value The value to query. - * @returns {string} Returns the raw `toStringTag`. - */ - function getRawTag(value) { - var isOwn = hasOwnProperty.call(value, symToStringTag), - tag = value[symToStringTag]; - - try { - value[symToStringTag] = undefined; - var unmasked = true; - } catch (e) {} - - var result = nativeObjectToString.call(value); - if (unmasked) { - if (isOwn) { - value[symToStringTag] = tag; - } else { - delete value[symToStringTag]; - } - } - return result; - } - - /** - * Creates an array of the own enumerable symbols of `object`. - * - * @private - * @param {Object} object The object to query. - * @returns {Array} Returns the array of symbols. - */ - var getSymbols = !nativeGetSymbols ? stubArray : function(object) { - if (object == null) { - return []; - } - object = Object(object); - return arrayFilter(nativeGetSymbols(object), function(symbol) { - return propertyIsEnumerable.call(object, symbol); - }); - }; - - /** - * Creates an array of the own and inherited enumerable symbols of `object`. - * - * @private - * @param {Object} object The object to query. - * @returns {Array} Returns the array of symbols. - */ - var getSymbolsIn = !nativeGetSymbols ? stubArray : function(object) { - var result = []; - while (object) { - arrayPush(result, getSymbols(object)); - object = getPrototype(object); - } - return result; - }; - - /** - * Gets the `toStringTag` of `value`. - * - * @private - * @param {*} value The value to query. - * @returns {string} Returns the `toStringTag`. - */ - var getTag = baseGetTag; - - // Fallback for data views, maps, sets, and weak maps in IE 11 and promises in Node.js < 6. - if ((DataView && getTag(new DataView(new ArrayBuffer(1))) != dataViewTag) || - (Map && getTag(new Map) != mapTag) || - (Promise && getTag(Promise.resolve()) != promiseTag) || - (Set && getTag(new Set) != setTag) || - (WeakMap && getTag(new WeakMap) != weakMapTag)) { - getTag = function(value) { - var result = baseGetTag(value), - Ctor = result == objectTag ? value.constructor : undefined, - ctorString = Ctor ? toSource(Ctor) : ''; - - if (ctorString) { - switch (ctorString) { - case dataViewCtorString: return dataViewTag; - case mapCtorString: return mapTag; - case promiseCtorString: return promiseTag; - case setCtorString: return setTag; - case weakMapCtorString: return weakMapTag; - } - } - return result; - }; - } - - /** - * Gets the view, applying any `transforms` to the `start` and `end` positions. - * - * @private - * @param {number} start The start of the view. - * @param {number} end The end of the view. - * @param {Array} transforms The transformations to apply to the view. - * @returns {Object} Returns an object containing the `start` and `end` - * positions of the view. - */ - function getView(start, end, transforms) { - var index = -1, - length = transforms.length; - - while (++index < length) { - var data = transforms[index], - size = data.size; - - switch (data.type) { - case 'drop': start += size; break; - case 'dropRight': end -= size; break; - case 'take': end = nativeMin(end, start + size); break; - case 'takeRight': start = nativeMax(start, end - size); break; - } - } - return { 'start': start, 'end': end }; - } - - /** - * Extracts wrapper details from the `source` body comment. - * - * @private - * @param {string} source The source to inspect. - * @returns {Array} Returns the wrapper details. - */ - function getWrapDetails(source) { - var match = source.match(reWrapDetails); - return match ? match[1].split(reSplitDetails) : []; - } - - /** - * Checks if `path` exists on `object`. - * - * @private - * @param {Object} object The object to query. - * @param {Array|string} path The path to check. - * @param {Function} hasFunc The function to check properties. - * @returns {boolean} Returns `true` if `path` exists, else `false`. - */ - function hasPath(object, path, hasFunc) { - path = castPath(path, object); - - var index = -1, - length = path.length, - result = false; - - while (++index < length) { - var key = toKey(path[index]); - if (!(result = object != null && hasFunc(object, key))) { - break; - } - object = object[key]; - } - if (result || ++index != length) { - return result; - } - length = object == null ? 0 : object.length; - return !!length && isLength(length) && isIndex(key, length) && - (isArray(object) || isArguments(object)); - } - - /** - * Initializes an array clone. - * - * @private - * @param {Array} array The array to clone. - * @returns {Array} Returns the initialized clone. - */ - function initCloneArray(array) { - var length = array.length, - result = new array.constructor(length); - - // Add properties assigned by `RegExp#exec`. - if (length && typeof array[0] == 'string' && hasOwnProperty.call(array, 'index')) { - result.index = array.index; - result.input = array.input; - } - return result; - } - - /** - * Initializes an object clone. - * - * @private - * @param {Object} object The object to clone. - * @returns {Object} Returns the initialized clone. - */ - function initCloneObject(object) { - return (typeof object.constructor == 'function' && !isPrototype(object)) - ? baseCreate(getPrototype(object)) - : {}; - } - - /** - * Initializes an object clone based on its `toStringTag`. - * - * **Note:** This function only supports cloning values with tags of - * `Boolean`, `Date`, `Error`, `Map`, `Number`, `RegExp`, `Set`, or `String`. - * - * @private - * @param {Object} object The object to clone. - * @param {string} tag The `toStringTag` of the object to clone. - * @param {boolean} [isDeep] Specify a deep clone. - * @returns {Object} Returns the initialized clone. - */ - function initCloneByTag(object, tag, isDeep) { - var Ctor = object.constructor; - switch (tag) { - case arrayBufferTag: - return cloneArrayBuffer(object); - - case boolTag: - case dateTag: - return new Ctor(+object); - - case dataViewTag: - return cloneDataView(object, isDeep); - - case float32Tag: case float64Tag: - case int8Tag: case int16Tag: case int32Tag: - case uint8Tag: case uint8ClampedTag: case uint16Tag: case uint32Tag: - return cloneTypedArray(object, isDeep); - - case mapTag: - return new Ctor; - - case numberTag: - case stringTag: - return new Ctor(object); - - case regexpTag: - return cloneRegExp(object); - - case setTag: - return new Ctor; - - case symbolTag: - return cloneSymbol(object); - } - } - - /** - * Inserts wrapper `details` in a comment at the top of the `source` body. - * - * @private - * @param {string} source The source to modify. - * @returns {Array} details The details to insert. - * @returns {string} Returns the modified source. - */ - function insertWrapDetails(source, details) { - var length = details.length; - if (!length) { - return source; - } - var lastIndex = length - 1; - details[lastIndex] = (length > 1 ? '& ' : '') + details[lastIndex]; - details = details.join(length > 2 ? ', ' : ' '); - return source.replace(reWrapComment, '{\n/* [wrapped with ' + details + '] */\n'); - } - - /** - * Checks if `value` is a flattenable `arguments` object or array. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is flattenable, else `false`. - */ - function isFlattenable(value) { - return isArray(value) || isArguments(value) || - !!(spreadableSymbol && value && value[spreadableSymbol]); - } - - /** - * Checks if `value` is a valid array-like index. - * - * @private - * @param {*} value The value to check. - * @param {number} [length=MAX_SAFE_INTEGER] The upper bounds of a valid index. - * @returns {boolean} Returns `true` if `value` is a valid index, else `false`. - */ - function isIndex(value, length) { - var type = typeof value; - length = length == null ? MAX_SAFE_INTEGER : length; - - return !!length && - (type == 'number' || - (type != 'symbol' && reIsUint.test(value))) && - (value > -1 && value % 1 == 0 && value < length); - } - - /** - * Checks if the given arguments are from an iteratee call. - * - * @private - * @param {*} value The potential iteratee value argument. - * @param {*} index The potential iteratee index or key argument. - * @param {*} object The potential iteratee object argument. - * @returns {boolean} Returns `true` if the arguments are from an iteratee call, - * else `false`. - */ - function isIterateeCall(value, index, object) { - if (!isObject(object)) { - return false; - } - var type = typeof index; - if (type == 'number' - ? (isArrayLike(object) && isIndex(index, object.length)) - : (type == 'string' && index in object) - ) { - return eq(object[index], value); - } - return false; - } - - /** - * Checks if `value` is a property name and not a property path. - * - * @private - * @param {*} value The value to check. - * @param {Object} [object] The object to query keys on. - * @returns {boolean} Returns `true` if `value` is a property name, else `false`. - */ - function isKey(value, object) { - if (isArray(value)) { - return false; - } - var type = typeof value; - if (type == 'number' || type == 'symbol' || type == 'boolean' || - value == null || isSymbol(value)) { - return true; - } - return reIsPlainProp.test(value) || !reIsDeepProp.test(value) || - (object != null && value in Object(object)); - } - - /** - * Checks if `value` is suitable for use as unique object key. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is suitable, else `false`. - */ - function isKeyable(value) { - var type = typeof value; - return (type == 'string' || type == 'number' || type == 'symbol' || type == 'boolean') - ? (value !== '__proto__') - : (value === null); - } - - /** - * Checks if `func` has a lazy counterpart. - * - * @private - * @param {Function} func The function to check. - * @returns {boolean} Returns `true` if `func` has a lazy counterpart, - * else `false`. - */ - function isLaziable(func) { - var funcName = getFuncName(func), - other = lodash[funcName]; - - if (typeof other != 'function' || !(funcName in LazyWrapper.prototype)) { - return false; - } - if (func === other) { - return true; - } - var data = getData(other); - return !!data && func === data[0]; - } - - /** - * Checks if `func` has its source masked. - * - * @private - * @param {Function} func The function to check. - * @returns {boolean} Returns `true` if `func` is masked, else `false`. - */ - function isMasked(func) { - return !!maskSrcKey && (maskSrcKey in func); - } - - /** - * Checks if `func` is capable of being masked. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `func` is maskable, else `false`. - */ - var isMaskable = coreJsData ? isFunction : stubFalse; - - /** - * Checks if `value` is likely a prototype object. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a prototype, else `false`. - */ - function isPrototype(value) { - var Ctor = value && value.constructor, - proto = (typeof Ctor == 'function' && Ctor.prototype) || objectProto; - - return value === proto; - } - - /** - * Checks if `value` is suitable for strict equality comparisons, i.e. `===`. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` if suitable for strict - * equality comparisons, else `false`. - */ - function isStrictComparable(value) { - return value === value && !isObject(value); - } - - /** - * A specialized version of `matchesProperty` for source values suitable - * for strict equality comparisons, i.e. `===`. - * - * @private - * @param {string} key The key of the property to get. - * @param {*} srcValue The value to match. - * @returns {Function} Returns the new spec function. - */ - function matchesStrictComparable(key, srcValue) { - return function(object) { - if (object == null) { - return false; - } - return object[key] === srcValue && - (srcValue !== undefined || (key in Object(object))); - }; - } - - /** - * A specialized version of `_.memoize` which clears the memoized function's - * cache when it exceeds `MAX_MEMOIZE_SIZE`. - * - * @private - * @param {Function} func The function to have its output memoized. - * @returns {Function} Returns the new memoized function. - */ - function memoizeCapped(func) { - var result = memoize(func, function(key) { - if (cache.size === MAX_MEMOIZE_SIZE) { - cache.clear(); - } - return key; - }); - - var cache = result.cache; - return result; - } - - /** - * Merges the function metadata of `source` into `data`. - * - * Merging metadata reduces the number of wrappers used to invoke a function. - * This is possible because methods like `_.bind`, `_.curry`, and `_.partial` - * may be applied regardless of execution order. Methods like `_.ary` and - * `_.rearg` modify function arguments, making the order in which they are - * executed important, preventing the merging of metadata. However, we make - * an exception for a safe combined case where curried functions have `_.ary` - * and or `_.rearg` applied. - * - * @private - * @param {Array} data The destination metadata. - * @param {Array} source The source metadata. - * @returns {Array} Returns `data`. - */ - function mergeData(data, source) { - var bitmask = data[1], - srcBitmask = source[1], - newBitmask = bitmask | srcBitmask, - isCommon = newBitmask < (WRAP_BIND_FLAG | WRAP_BIND_KEY_FLAG | WRAP_ARY_FLAG); - - var isCombo = - ((srcBitmask == WRAP_ARY_FLAG) && (bitmask == WRAP_CURRY_FLAG)) || - ((srcBitmask == WRAP_ARY_FLAG) && (bitmask == WRAP_REARG_FLAG) && (data[7].length <= source[8])) || - ((srcBitmask == (WRAP_ARY_FLAG | WRAP_REARG_FLAG)) && (source[7].length <= source[8]) && (bitmask == WRAP_CURRY_FLAG)); - - // Exit early if metadata can't be merged. - if (!(isCommon || isCombo)) { - return data; - } - // Use source `thisArg` if available. - if (srcBitmask & WRAP_BIND_FLAG) { - data[2] = source[2]; - // Set when currying a bound function. - newBitmask |= bitmask & WRAP_BIND_FLAG ? 0 : WRAP_CURRY_BOUND_FLAG; - } - // Compose partial arguments. - var value = source[3]; - if (value) { - var partials = data[3]; - data[3] = partials ? composeArgs(partials, value, source[4]) : value; - data[4] = partials ? replaceHolders(data[3], PLACEHOLDER) : source[4]; - } - // Compose partial right arguments. - value = source[5]; - if (value) { - partials = data[5]; - data[5] = partials ? composeArgsRight(partials, value, source[6]) : value; - data[6] = partials ? replaceHolders(data[5], PLACEHOLDER) : source[6]; - } - // Use source `argPos` if available. - value = source[7]; - if (value) { - data[7] = value; - } - // Use source `ary` if it's smaller. - if (srcBitmask & WRAP_ARY_FLAG) { - data[8] = data[8] == null ? source[8] : nativeMin(data[8], source[8]); - } - // Use source `arity` if one is not provided. - if (data[9] == null) { - data[9] = source[9]; - } - // Use source `func` and merge bitmasks. - data[0] = source[0]; - data[1] = newBitmask; - - return data; - } - - /** - * This function is like - * [`Object.keys`](http://ecma-international.org/ecma-262/7.0/#sec-object.keys) - * except that it includes inherited enumerable properties. - * - * @private - * @param {Object} object The object to query. - * @returns {Array} Returns the array of property names. - */ - function nativeKeysIn(object) { - var result = []; - if (object != null) { - for (var key in Object(object)) { - result.push(key); - } - } - return result; - } - - /** - * Converts `value` to a string using `Object.prototype.toString`. - * - * @private - * @param {*} value The value to convert. - * @returns {string} Returns the converted string. - */ - function objectToString(value) { - return nativeObjectToString.call(value); - } - - /** - * A specialized version of `baseRest` which transforms the rest array. - * - * @private - * @param {Function} func The function to apply a rest parameter to. - * @param {number} [start=func.length-1] The start position of the rest parameter. - * @param {Function} transform The rest array transform. - * @returns {Function} Returns the new function. - */ - function overRest(func, start, transform) { - start = nativeMax(start === undefined ? (func.length - 1) : start, 0); - return function() { - var args = arguments, - index = -1, - length = nativeMax(args.length - start, 0), - array = Array(length); - - while (++index < length) { - array[index] = args[start + index]; - } - index = -1; - var otherArgs = Array(start + 1); - while (++index < start) { - otherArgs[index] = args[index]; - } - otherArgs[start] = transform(array); - return apply(func, this, otherArgs); - }; - } - - /** - * Gets the parent value at `path` of `object`. - * - * @private - * @param {Object} object The object to query. - * @param {Array} path The path to get the parent value of. - * @returns {*} Returns the parent value. - */ - function parent(object, path) { - return path.length < 2 ? object : baseGet(object, baseSlice(path, 0, -1)); - } - - /** - * Reorder `array` according to the specified indexes where the element at - * the first index is assigned as the first element, the element at - * the second index is assigned as the second element, and so on. - * - * @private - * @param {Array} array The array to reorder. - * @param {Array} indexes The arranged array indexes. - * @returns {Array} Returns `array`. - */ - function reorder(array, indexes) { - var arrLength = array.length, - length = nativeMin(indexes.length, arrLength), - oldArray = copyArray(array); - - while (length--) { - var index = indexes[length]; - array[length] = isIndex(index, arrLength) ? oldArray[index] : undefined; - } - return array; - } - - /** - * Sets metadata for `func`. - * - * **Note:** If this function becomes hot, i.e. is invoked a lot in a short - * period of time, it will trip its breaker and transition to an identity - * function to avoid garbage collection pauses in V8. See - * [V8 issue 2070](https://bugs.chromium.org/p/v8/issues/detail?id=2070) - * for more details. - * - * @private - * @param {Function} func The function to associate metadata with. - * @param {*} data The metadata. - * @returns {Function} Returns `func`. - */ - var setData = shortOut(baseSetData); - - /** - * A simple wrapper around the global [`setTimeout`](https://mdn.io/setTimeout). - * - * @private - * @param {Function} func The function to delay. - * @param {number} wait The number of milliseconds to delay invocation. - * @returns {number|Object} Returns the timer id or timeout object. - */ - var setTimeout = ctxSetTimeout || function(func, wait) { - return root.setTimeout(func, wait); - }; - - /** - * Sets the `toString` method of `func` to return `string`. - * - * @private - * @param {Function} func The function to modify. - * @param {Function} string The `toString` result. - * @returns {Function} Returns `func`. - */ - var setToString = shortOut(baseSetToString); - - /** - * Sets the `toString` method of `wrapper` to mimic the source of `reference` - * with wrapper details in a comment at the top of the source body. - * - * @private - * @param {Function} wrapper The function to modify. - * @param {Function} reference The reference function. - * @param {number} bitmask The bitmask flags. See `createWrap` for more details. - * @returns {Function} Returns `wrapper`. - */ - function setWrapToString(wrapper, reference, bitmask) { - var source = (reference + ''); - return setToString(wrapper, insertWrapDetails(source, updateWrapDetails(getWrapDetails(source), bitmask))); - } - - /** - * Creates a function that'll short out and invoke `identity` instead - * of `func` when it's called `HOT_COUNT` or more times in `HOT_SPAN` - * milliseconds. - * - * @private - * @param {Function} func The function to restrict. - * @returns {Function} Returns the new shortable function. - */ - function shortOut(func) { - var count = 0, - lastCalled = 0; - - return function() { - var stamp = nativeNow(), - remaining = HOT_SPAN - (stamp - lastCalled); - - lastCalled = stamp; - if (remaining > 0) { - if (++count >= HOT_COUNT) { - return arguments[0]; - } - } else { - count = 0; - } - return func.apply(undefined, arguments); - }; - } - - /** - * A specialized version of `_.shuffle` which mutates and sets the size of `array`. - * - * @private - * @param {Array} array The array to shuffle. - * @param {number} [size=array.length] The size of `array`. - * @returns {Array} Returns `array`. - */ - function shuffleSelf(array, size) { - var index = -1, - length = array.length, - lastIndex = length - 1; - - size = size === undefined ? length : size; - while (++index < size) { - var rand = baseRandom(index, lastIndex), - value = array[rand]; - - array[rand] = array[index]; - array[index] = value; - } - array.length = size; - return array; - } - - /** - * Converts `string` to a property path array. - * - * @private - * @param {string} string The string to convert. - * @returns {Array} Returns the property path array. - */ - var stringToPath = memoizeCapped(function(string) { - var result = []; - if (string.charCodeAt(0) === 46 /* . */) { - result.push(''); - } - string.replace(rePropName, function(match, number, quote, subString) { - result.push(quote ? subString.replace(reEscapeChar, '$1') : (number || match)); - }); - return result; - }); - - /** - * Converts `value` to a string key if it's not a string or symbol. - * - * @private - * @param {*} value The value to inspect. - * @returns {string|symbol} Returns the key. - */ - function toKey(value) { - if (typeof value == 'string' || isSymbol(value)) { - return value; - } - var result = (value + ''); - return (result == '0' && (1 / value) == -INFINITY) ? '-0' : result; - } - - /** - * Converts `func` to its source code. - * - * @private - * @param {Function} func The function to convert. - * @returns {string} Returns the source code. - */ - function toSource(func) { - if (func != null) { - try { - return funcToString.call(func); - } catch (e) {} - try { - return (func + ''); - } catch (e) {} - } - return ''; - } - - /** - * Updates wrapper `details` based on `bitmask` flags. - * - * @private - * @returns {Array} details The details to modify. - * @param {number} bitmask The bitmask flags. See `createWrap` for more details. - * @returns {Array} Returns `details`. - */ - function updateWrapDetails(details, bitmask) { - arrayEach(wrapFlags, function(pair) { - var value = '_.' + pair[0]; - if ((bitmask & pair[1]) && !arrayIncludes(details, value)) { - details.push(value); - } - }); - return details.sort(); - } - - /** - * Creates a clone of `wrapper`. - * - * @private - * @param {Object} wrapper The wrapper to clone. - * @returns {Object} Returns the cloned wrapper. - */ - function wrapperClone(wrapper) { - if (wrapper instanceof LazyWrapper) { - return wrapper.clone(); - } - var result = new LodashWrapper(wrapper.__wrapped__, wrapper.__chain__); - result.__actions__ = copyArray(wrapper.__actions__); - result.__index__ = wrapper.__index__; - result.__values__ = wrapper.__values__; - return result; - } - - /*------------------------------------------------------------------------*/ - - /** - * Creates an array of elements split into groups the length of `size`. - * If `array` can't be split evenly, the final chunk will be the remaining - * elements. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to process. - * @param {number} [size=1] The length of each chunk - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Array} Returns the new array of chunks. - * @example - * - * _.chunk(['a', 'b', 'c', 'd'], 2); - * // => [['a', 'b'], ['c', 'd']] - * - * _.chunk(['a', 'b', 'c', 'd'], 3); - * // => [['a', 'b', 'c'], ['d']] - */ - function chunk(array, size, guard) { - if ((guard ? isIterateeCall(array, size, guard) : size === undefined)) { - size = 1; - } else { - size = nativeMax(toInteger(size), 0); - } - var length = array == null ? 0 : array.length; - if (!length || size < 1) { - return []; - } - var index = 0, - resIndex = 0, - result = Array(nativeCeil(length / size)); - - while (index < length) { - result[resIndex++] = baseSlice(array, index, (index += size)); - } - return result; - } - - /** - * Creates an array with all falsey values removed. The values `false`, `null`, - * `0`, `""`, `undefined`, and `NaN` are falsey. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to compact. - * @returns {Array} Returns the new array of filtered values. - * @example - * - * _.compact([0, 1, false, 2, '', 3]); - * // => [1, 2, 3] - */ - function compact(array) { - var index = -1, - length = array == null ? 0 : array.length, - resIndex = 0, - result = []; - - while (++index < length) { - var value = array[index]; - if (value) { - result[resIndex++] = value; - } - } - return result; - } - - /** - * Creates a new array concatenating `array` with any additional arrays - * and/or values. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to concatenate. - * @param {...*} [values] The values to concatenate. - * @returns {Array} Returns the new concatenated array. - * @example - * - * var array = [1]; - * var other = _.concat(array, 2, [3], [[4]]); - * - * console.log(other); - * // => [1, 2, 3, [4]] - * - * console.log(array); - * // => [1] - */ - function concat() { - var length = arguments.length; - if (!length) { - return []; - } - var args = Array(length - 1), - array = arguments[0], - index = length; - - while (index--) { - args[index - 1] = arguments[index]; - } - return arrayPush(isArray(array) ? copyArray(array) : [array], baseFlatten(args, 1)); - } - - /** - * Creates an array of `array` values not included in the other given arrays - * using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons. The order and references of result values are - * determined by the first array. - * - * **Note:** Unlike `_.pullAll`, this method returns a new array. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {...Array} [values] The values to exclude. - * @returns {Array} Returns the new array of filtered values. - * @see _.without, _.xor - * @example - * - * _.difference([2, 1], [2, 3]); - * // => [1] - */ - var difference = baseRest(function(array, values) { - return isArrayLikeObject(array) - ? baseDifference(array, baseFlatten(values, 1, isArrayLikeObject, true)) - : []; - }); - - /** - * This method is like `_.difference` except that it accepts `iteratee` which - * is invoked for each element of `array` and `values` to generate the criterion - * by which they're compared. The order and references of result values are - * determined by the first array. The iteratee is invoked with one argument: - * (value). - * - * **Note:** Unlike `_.pullAllBy`, this method returns a new array. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {...Array} [values] The values to exclude. - * @param {Function} [iteratee=_.identity] The iteratee invoked per element. - * @returns {Array} Returns the new array of filtered values. - * @example - * - * _.differenceBy([2.1, 1.2], [2.3, 3.4], Math.floor); - * // => [1.2] - * - * // The `_.property` iteratee shorthand. - * _.differenceBy([{ 'x': 2 }, { 'x': 1 }], [{ 'x': 1 }], 'x'); - * // => [{ 'x': 2 }] - */ - var differenceBy = baseRest(function(array, values) { - var iteratee = last(values); - if (isArrayLikeObject(iteratee)) { - iteratee = undefined; - } - return isArrayLikeObject(array) - ? baseDifference(array, baseFlatten(values, 1, isArrayLikeObject, true), getIteratee(iteratee, 2)) - : []; - }); - - /** - * This method is like `_.difference` except that it accepts `comparator` - * which is invoked to compare elements of `array` to `values`. The order and - * references of result values are determined by the first array. The comparator - * is invoked with two arguments: (arrVal, othVal). - * - * **Note:** Unlike `_.pullAllWith`, this method returns a new array. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {...Array} [values] The values to exclude. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new array of filtered values. - * @example - * - * var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; - * - * _.differenceWith(objects, [{ 'x': 1, 'y': 2 }], _.isEqual); - * // => [{ 'x': 2, 'y': 1 }] - */ - var differenceWith = baseRest(function(array, values) { - var comparator = last(values); - if (isArrayLikeObject(comparator)) { - comparator = undefined; - } - return isArrayLikeObject(array) - ? baseDifference(array, baseFlatten(values, 1, isArrayLikeObject, true), undefined, comparator) - : []; - }); - - /** - * Creates a slice of `array` with `n` elements dropped from the beginning. - * - * @static - * @memberOf _ - * @since 0.5.0 - * @category Array - * @param {Array} array The array to query. - * @param {number} [n=1] The number of elements to drop. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Array} Returns the slice of `array`. - * @example - * - * _.drop([1, 2, 3]); - * // => [2, 3] - * - * _.drop([1, 2, 3], 2); - * // => [3] - * - * _.drop([1, 2, 3], 5); - * // => [] - * - * _.drop([1, 2, 3], 0); - * // => [1, 2, 3] - */ - function drop(array, n, guard) { - var length = array == null ? 0 : array.length; - if (!length) { - return []; - } - n = (guard || n === undefined) ? 1 : toInteger(n); - return baseSlice(array, n < 0 ? 0 : n, length); - } - - /** - * Creates a slice of `array` with `n` elements dropped from the end. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to query. - * @param {number} [n=1] The number of elements to drop. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Array} Returns the slice of `array`. - * @example - * - * _.dropRight([1, 2, 3]); - * // => [1, 2] - * - * _.dropRight([1, 2, 3], 2); - * // => [1] - * - * _.dropRight([1, 2, 3], 5); - * // => [] - * - * _.dropRight([1, 2, 3], 0); - * // => [1, 2, 3] - */ - function dropRight(array, n, guard) { - var length = array == null ? 0 : array.length; - if (!length) { - return []; - } - n = (guard || n === undefined) ? 1 : toInteger(n); - n = length - n; - return baseSlice(array, 0, n < 0 ? 0 : n); - } - - /** - * Creates a slice of `array` excluding elements dropped from the end. - * Elements are dropped until `predicate` returns falsey. The predicate is - * invoked with three arguments: (value, index, array). - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to query. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {Array} Returns the slice of `array`. - * @example - * - * var users = [ - * { 'user': 'barney', 'active': true }, - * { 'user': 'fred', 'active': false }, - * { 'user': 'pebbles', 'active': false } - * ]; - * - * _.dropRightWhile(users, function(o) { return !o.active; }); - * // => objects for ['barney'] - * - * // The `_.matches` iteratee shorthand. - * _.dropRightWhile(users, { 'user': 'pebbles', 'active': false }); - * // => objects for ['barney', 'fred'] - * - * // The `_.matchesProperty` iteratee shorthand. - * _.dropRightWhile(users, ['active', false]); - * // => objects for ['barney'] - * - * // The `_.property` iteratee shorthand. - * _.dropRightWhile(users, 'active'); - * // => objects for ['barney', 'fred', 'pebbles'] - */ - function dropRightWhile(array, predicate) { - return (array && array.length) - ? baseWhile(array, getIteratee(predicate, 3), true, true) - : []; - } - - /** - * Creates a slice of `array` excluding elements dropped from the beginning. - * Elements are dropped until `predicate` returns falsey. The predicate is - * invoked with three arguments: (value, index, array). - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to query. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {Array} Returns the slice of `array`. - * @example - * - * var users = [ - * { 'user': 'barney', 'active': false }, - * { 'user': 'fred', 'active': false }, - * { 'user': 'pebbles', 'active': true } - * ]; - * - * _.dropWhile(users, function(o) { return !o.active; }); - * // => objects for ['pebbles'] - * - * // The `_.matches` iteratee shorthand. - * _.dropWhile(users, { 'user': 'barney', 'active': false }); - * // => objects for ['fred', 'pebbles'] - * - * // The `_.matchesProperty` iteratee shorthand. - * _.dropWhile(users, ['active', false]); - * // => objects for ['pebbles'] - * - * // The `_.property` iteratee shorthand. - * _.dropWhile(users, 'active'); - * // => objects for ['barney', 'fred', 'pebbles'] - */ - function dropWhile(array, predicate) { - return (array && array.length) - ? baseWhile(array, getIteratee(predicate, 3), true) - : []; - } - - /** - * Fills elements of `array` with `value` from `start` up to, but not - * including, `end`. - * - * **Note:** This method mutates `array`. - * - * @static - * @memberOf _ - * @since 3.2.0 - * @category Array - * @param {Array} array The array to fill. - * @param {*} value The value to fill `array` with. - * @param {number} [start=0] The start position. - * @param {number} [end=array.length] The end position. - * @returns {Array} Returns `array`. - * @example - * - * var array = [1, 2, 3]; - * - * _.fill(array, 'a'); - * console.log(array); - * // => ['a', 'a', 'a'] - * - * _.fill(Array(3), 2); - * // => [2, 2, 2] - * - * _.fill([4, 6, 8, 10], '*', 1, 3); - * // => [4, '*', '*', 10] - */ - function fill(array, value, start, end) { - var length = array == null ? 0 : array.length; - if (!length) { - return []; - } - if (start && typeof start != 'number' && isIterateeCall(array, value, start)) { - start = 0; - end = length; - } - return baseFill(array, value, start, end); - } - - /** - * This method is like `_.find` except that it returns the index of the first - * element `predicate` returns truthy for instead of the element itself. - * - * @static - * @memberOf _ - * @since 1.1.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @param {number} [fromIndex=0] The index to search from. - * @returns {number} Returns the index of the found element, else `-1`. - * @example - * - * var users = [ - * { 'user': 'barney', 'active': false }, - * { 'user': 'fred', 'active': false }, - * { 'user': 'pebbles', 'active': true } - * ]; - * - * _.findIndex(users, function(o) { return o.user == 'barney'; }); - * // => 0 - * - * // The `_.matches` iteratee shorthand. - * _.findIndex(users, { 'user': 'fred', 'active': false }); - * // => 1 - * - * // The `_.matchesProperty` iteratee shorthand. - * _.findIndex(users, ['active', false]); - * // => 0 - * - * // The `_.property` iteratee shorthand. - * _.findIndex(users, 'active'); - * // => 2 - */ - function findIndex(array, predicate, fromIndex) { - var length = array == null ? 0 : array.length; - if (!length) { - return -1; - } - var index = fromIndex == null ? 0 : toInteger(fromIndex); - if (index < 0) { - index = nativeMax(length + index, 0); - } - return baseFindIndex(array, getIteratee(predicate, 3), index); - } - - /** - * This method is like `_.findIndex` except that it iterates over elements - * of `collection` from right to left. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @param {number} [fromIndex=array.length-1] The index to search from. - * @returns {number} Returns the index of the found element, else `-1`. - * @example - * - * var users = [ - * { 'user': 'barney', 'active': true }, - * { 'user': 'fred', 'active': false }, - * { 'user': 'pebbles', 'active': false } - * ]; - * - * _.findLastIndex(users, function(o) { return o.user == 'pebbles'; }); - * // => 2 - * - * // The `_.matches` iteratee shorthand. - * _.findLastIndex(users, { 'user': 'barney', 'active': true }); - * // => 0 - * - * // The `_.matchesProperty` iteratee shorthand. - * _.findLastIndex(users, ['active', false]); - * // => 2 - * - * // The `_.property` iteratee shorthand. - * _.findLastIndex(users, 'active'); - * // => 0 - */ - function findLastIndex(array, predicate, fromIndex) { - var length = array == null ? 0 : array.length; - if (!length) { - return -1; - } - var index = length - 1; - if (fromIndex !== undefined) { - index = toInteger(fromIndex); - index = fromIndex < 0 - ? nativeMax(length + index, 0) - : nativeMin(index, length - 1); - } - return baseFindIndex(array, getIteratee(predicate, 3), index, true); - } - - /** - * Flattens `array` a single level deep. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to flatten. - * @returns {Array} Returns the new flattened array. - * @example - * - * _.flatten([1, [2, [3, [4]], 5]]); - * // => [1, 2, [3, [4]], 5] - */ - function flatten(array) { - var length = array == null ? 0 : array.length; - return length ? baseFlatten(array, 1) : []; - } - - /** - * Recursively flattens `array`. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to flatten. - * @returns {Array} Returns the new flattened array. - * @example - * - * _.flattenDeep([1, [2, [3, [4]], 5]]); - * // => [1, 2, 3, 4, 5] - */ - function flattenDeep(array) { - var length = array == null ? 0 : array.length; - return length ? baseFlatten(array, INFINITY) : []; - } - - /** - * Recursively flatten `array` up to `depth` times. - * - * @static - * @memberOf _ - * @since 4.4.0 - * @category Array - * @param {Array} array The array to flatten. - * @param {number} [depth=1] The maximum recursion depth. - * @returns {Array} Returns the new flattened array. - * @example - * - * var array = [1, [2, [3, [4]], 5]]; - * - * _.flattenDepth(array, 1); - * // => [1, 2, [3, [4]], 5] - * - * _.flattenDepth(array, 2); - * // => [1, 2, 3, [4], 5] - */ - function flattenDepth(array, depth) { - var length = array == null ? 0 : array.length; - if (!length) { - return []; - } - depth = depth === undefined ? 1 : toInteger(depth); - return baseFlatten(array, depth); - } - - /** - * The inverse of `_.toPairs`; this method returns an object composed - * from key-value `pairs`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} pairs The key-value pairs. - * @returns {Object} Returns the new object. - * @example - * - * _.fromPairs([['a', 1], ['b', 2]]); - * // => { 'a': 1, 'b': 2 } - */ - function fromPairs(pairs) { - var index = -1, - length = pairs == null ? 0 : pairs.length, - result = {}; - - while (++index < length) { - var pair = pairs[index]; - result[pair[0]] = pair[1]; - } - return result; - } - - /** - * Gets the first element of `array`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @alias first - * @category Array - * @param {Array} array The array to query. - * @returns {*} Returns the first element of `array`. - * @example - * - * _.head([1, 2, 3]); - * // => 1 - * - * _.head([]); - * // => undefined - */ - function head(array) { - return (array && array.length) ? array[0] : undefined; - } - - /** - * Gets the index at which the first occurrence of `value` is found in `array` - * using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons. If `fromIndex` is negative, it's used as the - * offset from the end of `array`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {*} value The value to search for. - * @param {number} [fromIndex=0] The index to search from. - * @returns {number} Returns the index of the matched value, else `-1`. - * @example - * - * _.indexOf([1, 2, 1, 2], 2); - * // => 1 - * - * // Search from the `fromIndex`. - * _.indexOf([1, 2, 1, 2], 2, 2); - * // => 3 - */ - function indexOf(array, value, fromIndex) { - var length = array == null ? 0 : array.length; - if (!length) { - return -1; - } - var index = fromIndex == null ? 0 : toInteger(fromIndex); - if (index < 0) { - index = nativeMax(length + index, 0); - } - return baseIndexOf(array, value, index); - } - - /** - * Gets all but the last element of `array`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to query. - * @returns {Array} Returns the slice of `array`. - * @example - * - * _.initial([1, 2, 3]); - * // => [1, 2] - */ - function initial(array) { - var length = array == null ? 0 : array.length; - return length ? baseSlice(array, 0, -1) : []; - } - - /** - * Creates an array of unique values that are included in all given arrays - * using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons. The order and references of result values are - * determined by the first array. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {...Array} [arrays] The arrays to inspect. - * @returns {Array} Returns the new array of intersecting values. - * @example - * - * _.intersection([2, 1], [2, 3]); - * // => [2] - */ - var intersection = baseRest(function(arrays) { - var mapped = arrayMap(arrays, castArrayLikeObject); - return (mapped.length && mapped[0] === arrays[0]) - ? baseIntersection(mapped) - : []; - }); - - /** - * This method is like `_.intersection` except that it accepts `iteratee` - * which is invoked for each element of each `arrays` to generate the criterion - * by which they're compared. The order and references of result values are - * determined by the first array. The iteratee is invoked with one argument: - * (value). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {...Array} [arrays] The arrays to inspect. - * @param {Function} [iteratee=_.identity] The iteratee invoked per element. - * @returns {Array} Returns the new array of intersecting values. - * @example - * - * _.intersectionBy([2.1, 1.2], [2.3, 3.4], Math.floor); - * // => [2.1] - * - * // The `_.property` iteratee shorthand. - * _.intersectionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x'); - * // => [{ 'x': 1 }] - */ - var intersectionBy = baseRest(function(arrays) { - var iteratee = last(arrays), - mapped = arrayMap(arrays, castArrayLikeObject); - - if (iteratee === last(mapped)) { - iteratee = undefined; - } else { - mapped.pop(); - } - return (mapped.length && mapped[0] === arrays[0]) - ? baseIntersection(mapped, getIteratee(iteratee, 2)) - : []; - }); - - /** - * This method is like `_.intersection` except that it accepts `comparator` - * which is invoked to compare elements of `arrays`. The order and references - * of result values are determined by the first array. The comparator is - * invoked with two arguments: (arrVal, othVal). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {...Array} [arrays] The arrays to inspect. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new array of intersecting values. - * @example - * - * var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; - * var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }]; - * - * _.intersectionWith(objects, others, _.isEqual); - * // => [{ 'x': 1, 'y': 2 }] - */ - var intersectionWith = baseRest(function(arrays) { - var comparator = last(arrays), - mapped = arrayMap(arrays, castArrayLikeObject); - - comparator = typeof comparator == 'function' ? comparator : undefined; - if (comparator) { - mapped.pop(); - } - return (mapped.length && mapped[0] === arrays[0]) - ? baseIntersection(mapped, undefined, comparator) - : []; - }); - - /** - * Converts all elements in `array` into a string separated by `separator`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to convert. - * @param {string} [separator=','] The element separator. - * @returns {string} Returns the joined string. - * @example - * - * _.join(['a', 'b', 'c'], '~'); - * // => 'a~b~c' - */ - function join(array, separator) { - return array == null ? '' : nativeJoin.call(array, separator); - } - - /** - * Gets the last element of `array`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to query. - * @returns {*} Returns the last element of `array`. - * @example - * - * _.last([1, 2, 3]); - * // => 3 - */ - function last(array) { - var length = array == null ? 0 : array.length; - return length ? array[length - 1] : undefined; - } - - /** - * This method is like `_.indexOf` except that it iterates over elements of - * `array` from right to left. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {*} value The value to search for. - * @param {number} [fromIndex=array.length-1] The index to search from. - * @returns {number} Returns the index of the matched value, else `-1`. - * @example - * - * _.lastIndexOf([1, 2, 1, 2], 2); - * // => 3 - * - * // Search from the `fromIndex`. - * _.lastIndexOf([1, 2, 1, 2], 2, 2); - * // => 1 - */ - function lastIndexOf(array, value, fromIndex) { - var length = array == null ? 0 : array.length; - if (!length) { - return -1; - } - var index = length; - if (fromIndex !== undefined) { - index = toInteger(fromIndex); - index = index < 0 ? nativeMax(length + index, 0) : nativeMin(index, length - 1); - } - return value === value - ? strictLastIndexOf(array, value, index) - : baseFindIndex(array, baseIsNaN, index, true); - } - - /** - * Gets the element at index `n` of `array`. If `n` is negative, the nth - * element from the end is returned. - * - * @static - * @memberOf _ - * @since 4.11.0 - * @category Array - * @param {Array} array The array to query. - * @param {number} [n=0] The index of the element to return. - * @returns {*} Returns the nth element of `array`. - * @example - * - * var array = ['a', 'b', 'c', 'd']; - * - * _.nth(array, 1); - * // => 'b' - * - * _.nth(array, -2); - * // => 'c'; - */ - function nth(array, n) { - return (array && array.length) ? baseNth(array, toInteger(n)) : undefined; - } - - /** - * Removes all given values from `array` using - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons. - * - * **Note:** Unlike `_.without`, this method mutates `array`. Use `_.remove` - * to remove elements from an array by predicate. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @category Array - * @param {Array} array The array to modify. - * @param {...*} [values] The values to remove. - * @returns {Array} Returns `array`. - * @example - * - * var array = ['a', 'b', 'c', 'a', 'b', 'c']; - * - * _.pull(array, 'a', 'c'); - * console.log(array); - * // => ['b', 'b'] - */ - var pull = baseRest(pullAll); - - /** - * This method is like `_.pull` except that it accepts an array of values to remove. - * - * **Note:** Unlike `_.difference`, this method mutates `array`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to modify. - * @param {Array} values The values to remove. - * @returns {Array} Returns `array`. - * @example - * - * var array = ['a', 'b', 'c', 'a', 'b', 'c']; - * - * _.pullAll(array, ['a', 'c']); - * console.log(array); - * // => ['b', 'b'] - */ - function pullAll(array, values) { - return (array && array.length && values && values.length) - ? basePullAll(array, values) - : array; - } - - /** - * This method is like `_.pullAll` except that it accepts `iteratee` which is - * invoked for each element of `array` and `values` to generate the criterion - * by which they're compared. The iteratee is invoked with one argument: (value). - * - * **Note:** Unlike `_.differenceBy`, this method mutates `array`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to modify. - * @param {Array} values The values to remove. - * @param {Function} [iteratee=_.identity] The iteratee invoked per element. - * @returns {Array} Returns `array`. - * @example - * - * var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }]; - * - * _.pullAllBy(array, [{ 'x': 1 }, { 'x': 3 }], 'x'); - * console.log(array); - * // => [{ 'x': 2 }] - */ - function pullAllBy(array, values, iteratee) { - return (array && array.length && values && values.length) - ? basePullAll(array, values, getIteratee(iteratee, 2)) - : array; - } - - /** - * This method is like `_.pullAll` except that it accepts `comparator` which - * is invoked to compare elements of `array` to `values`. The comparator is - * invoked with two arguments: (arrVal, othVal). - * - * **Note:** Unlike `_.differenceWith`, this method mutates `array`. - * - * @static - * @memberOf _ - * @since 4.6.0 - * @category Array - * @param {Array} array The array to modify. - * @param {Array} values The values to remove. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns `array`. - * @example - * - * var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }]; - * - * _.pullAllWith(array, [{ 'x': 3, 'y': 4 }], _.isEqual); - * console.log(array); - * // => [{ 'x': 1, 'y': 2 }, { 'x': 5, 'y': 6 }] - */ - function pullAllWith(array, values, comparator) { - return (array && array.length && values && values.length) - ? basePullAll(array, values, undefined, comparator) - : array; - } - - /** - * Removes elements from `array` corresponding to `indexes` and returns an - * array of removed elements. - * - * **Note:** Unlike `_.at`, this method mutates `array`. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to modify. - * @param {...(number|number[])} [indexes] The indexes of elements to remove. - * @returns {Array} Returns the new array of removed elements. - * @example - * - * var array = ['a', 'b', 'c', 'd']; - * var pulled = _.pullAt(array, [1, 3]); - * - * console.log(array); - * // => ['a', 'c'] - * - * console.log(pulled); - * // => ['b', 'd'] - */ - var pullAt = flatRest(function(array, indexes) { - var length = array == null ? 0 : array.length, - result = baseAt(array, indexes); - - basePullAt(array, arrayMap(indexes, function(index) { - return isIndex(index, length) ? +index : index; - }).sort(compareAscending)); - - return result; - }); - - /** - * Removes all elements from `array` that `predicate` returns truthy for - * and returns an array of the removed elements. The predicate is invoked - * with three arguments: (value, index, array). - * - * **Note:** Unlike `_.filter`, this method mutates `array`. Use `_.pull` - * to pull elements from an array by value. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @category Array - * @param {Array} array The array to modify. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {Array} Returns the new array of removed elements. - * @example - * - * var array = [1, 2, 3, 4]; - * var evens = _.remove(array, function(n) { - * return n % 2 == 0; - * }); - * - * console.log(array); - * // => [1, 3] - * - * console.log(evens); - * // => [2, 4] - */ - function remove(array, predicate) { - var result = []; - if (!(array && array.length)) { - return result; - } - var index = -1, - indexes = [], - length = array.length; - - predicate = getIteratee(predicate, 3); - while (++index < length) { - var value = array[index]; - if (predicate(value, index, array)) { - result.push(value); - indexes.push(index); - } - } - basePullAt(array, indexes); - return result; - } - - /** - * Reverses `array` so that the first element becomes the last, the second - * element becomes the second to last, and so on. - * - * **Note:** This method mutates `array` and is based on - * [`Array#reverse`](https://mdn.io/Array/reverse). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to modify. - * @returns {Array} Returns `array`. - * @example - * - * var array = [1, 2, 3]; - * - * _.reverse(array); - * // => [3, 2, 1] - * - * console.log(array); - * // => [3, 2, 1] - */ - function reverse(array) { - return array == null ? array : nativeReverse.call(array); - } - - /** - * Creates a slice of `array` from `start` up to, but not including, `end`. - * - * **Note:** This method is used instead of - * [`Array#slice`](https://mdn.io/Array/slice) to ensure dense arrays are - * returned. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to slice. - * @param {number} [start=0] The start position. - * @param {number} [end=array.length] The end position. - * @returns {Array} Returns the slice of `array`. - */ - function slice(array, start, end) { - var length = array == null ? 0 : array.length; - if (!length) { - return []; - } - if (end && typeof end != 'number' && isIterateeCall(array, start, end)) { - start = 0; - end = length; - } - else { - start = start == null ? 0 : toInteger(start); - end = end === undefined ? length : toInteger(end); - } - return baseSlice(array, start, end); - } - - /** - * Uses a binary search to determine the lowest index at which `value` - * should be inserted into `array` in order to maintain its sort order. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The sorted array to inspect. - * @param {*} value The value to evaluate. - * @returns {number} Returns the index at which `value` should be inserted - * into `array`. - * @example - * - * _.sortedIndex([30, 50], 40); - * // => 1 - */ - function sortedIndex(array, value) { - return baseSortedIndex(array, value); - } - - /** - * This method is like `_.sortedIndex` except that it accepts `iteratee` - * which is invoked for `value` and each element of `array` to compute their - * sort ranking. The iteratee is invoked with one argument: (value). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The sorted array to inspect. - * @param {*} value The value to evaluate. - * @param {Function} [iteratee=_.identity] The iteratee invoked per element. - * @returns {number} Returns the index at which `value` should be inserted - * into `array`. - * @example - * - * var objects = [{ 'x': 4 }, { 'x': 5 }]; - * - * _.sortedIndexBy(objects, { 'x': 4 }, function(o) { return o.x; }); - * // => 0 - * - * // The `_.property` iteratee shorthand. - * _.sortedIndexBy(objects, { 'x': 4 }, 'x'); - * // => 0 - */ - function sortedIndexBy(array, value, iteratee) { - return baseSortedIndexBy(array, value, getIteratee(iteratee, 2)); - } - - /** - * This method is like `_.indexOf` except that it performs a binary - * search on a sorted `array`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {*} value The value to search for. - * @returns {number} Returns the index of the matched value, else `-1`. - * @example - * - * _.sortedIndexOf([4, 5, 5, 5, 6], 5); - * // => 1 - */ - function sortedIndexOf(array, value) { - var length = array == null ? 0 : array.length; - if (length) { - var index = baseSortedIndex(array, value); - if (index < length && eq(array[index], value)) { - return index; - } - } - return -1; - } - - /** - * This method is like `_.sortedIndex` except that it returns the highest - * index at which `value` should be inserted into `array` in order to - * maintain its sort order. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The sorted array to inspect. - * @param {*} value The value to evaluate. - * @returns {number} Returns the index at which `value` should be inserted - * into `array`. - * @example - * - * _.sortedLastIndex([4, 5, 5, 5, 6], 5); - * // => 4 - */ - function sortedLastIndex(array, value) { - return baseSortedIndex(array, value, true); - } - - /** - * This method is like `_.sortedLastIndex` except that it accepts `iteratee` - * which is invoked for `value` and each element of `array` to compute their - * sort ranking. The iteratee is invoked with one argument: (value). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The sorted array to inspect. - * @param {*} value The value to evaluate. - * @param {Function} [iteratee=_.identity] The iteratee invoked per element. - * @returns {number} Returns the index at which `value` should be inserted - * into `array`. - * @example - * - * var objects = [{ 'x': 4 }, { 'x': 5 }]; - * - * _.sortedLastIndexBy(objects, { 'x': 4 }, function(o) { return o.x; }); - * // => 1 - * - * // The `_.property` iteratee shorthand. - * _.sortedLastIndexBy(objects, { 'x': 4 }, 'x'); - * // => 1 - */ - function sortedLastIndexBy(array, value, iteratee) { - return baseSortedIndexBy(array, value, getIteratee(iteratee, 2), true); - } - - /** - * This method is like `_.lastIndexOf` except that it performs a binary - * search on a sorted `array`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {*} value The value to search for. - * @returns {number} Returns the index of the matched value, else `-1`. - * @example - * - * _.sortedLastIndexOf([4, 5, 5, 5, 6], 5); - * // => 3 - */ - function sortedLastIndexOf(array, value) { - var length = array == null ? 0 : array.length; - if (length) { - var index = baseSortedIndex(array, value, true) - 1; - if (eq(array[index], value)) { - return index; - } - } - return -1; - } - - /** - * This method is like `_.uniq` except that it's designed and optimized - * for sorted arrays. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to inspect. - * @returns {Array} Returns the new duplicate free array. - * @example - * - * _.sortedUniq([1, 1, 2]); - * // => [1, 2] - */ - function sortedUniq(array) { - return (array && array.length) - ? baseSortedUniq(array) - : []; - } - - /** - * This method is like `_.uniqBy` except that it's designed and optimized - * for sorted arrays. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {Function} [iteratee] The iteratee invoked per element. - * @returns {Array} Returns the new duplicate free array. - * @example - * - * _.sortedUniqBy([1.1, 1.2, 2.3, 2.4], Math.floor); - * // => [1.1, 2.3] - */ - function sortedUniqBy(array, iteratee) { - return (array && array.length) - ? baseSortedUniq(array, getIteratee(iteratee, 2)) - : []; - } - - /** - * Gets all but the first element of `array`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to query. - * @returns {Array} Returns the slice of `array`. - * @example - * - * _.tail([1, 2, 3]); - * // => [2, 3] - */ - function tail(array) { - var length = array == null ? 0 : array.length; - return length ? baseSlice(array, 1, length) : []; - } - - /** - * Creates a slice of `array` with `n` elements taken from the beginning. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to query. - * @param {number} [n=1] The number of elements to take. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Array} Returns the slice of `array`. - * @example - * - * _.take([1, 2, 3]); - * // => [1] - * - * _.take([1, 2, 3], 2); - * // => [1, 2] - * - * _.take([1, 2, 3], 5); - * // => [1, 2, 3] - * - * _.take([1, 2, 3], 0); - * // => [] - */ - function take(array, n, guard) { - if (!(array && array.length)) { - return []; - } - n = (guard || n === undefined) ? 1 : toInteger(n); - return baseSlice(array, 0, n < 0 ? 0 : n); - } - - /** - * Creates a slice of `array` with `n` elements taken from the end. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to query. - * @param {number} [n=1] The number of elements to take. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Array} Returns the slice of `array`. - * @example - * - * _.takeRight([1, 2, 3]); - * // => [3] - * - * _.takeRight([1, 2, 3], 2); - * // => [2, 3] - * - * _.takeRight([1, 2, 3], 5); - * // => [1, 2, 3] - * - * _.takeRight([1, 2, 3], 0); - * // => [] - */ - function takeRight(array, n, guard) { - var length = array == null ? 0 : array.length; - if (!length) { - return []; - } - n = (guard || n === undefined) ? 1 : toInteger(n); - n = length - n; - return baseSlice(array, n < 0 ? 0 : n, length); - } - - /** - * Creates a slice of `array` with elements taken from the end. Elements are - * taken until `predicate` returns falsey. The predicate is invoked with - * three arguments: (value, index, array). - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to query. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {Array} Returns the slice of `array`. - * @example - * - * var users = [ - * { 'user': 'barney', 'active': true }, - * { 'user': 'fred', 'active': false }, - * { 'user': 'pebbles', 'active': false } - * ]; - * - * _.takeRightWhile(users, function(o) { return !o.active; }); - * // => objects for ['fred', 'pebbles'] - * - * // The `_.matches` iteratee shorthand. - * _.takeRightWhile(users, { 'user': 'pebbles', 'active': false }); - * // => objects for ['pebbles'] - * - * // The `_.matchesProperty` iteratee shorthand. - * _.takeRightWhile(users, ['active', false]); - * // => objects for ['fred', 'pebbles'] - * - * // The `_.property` iteratee shorthand. - * _.takeRightWhile(users, 'active'); - * // => [] - */ - function takeRightWhile(array, predicate) { - return (array && array.length) - ? baseWhile(array, getIteratee(predicate, 3), false, true) - : []; - } - - /** - * Creates a slice of `array` with elements taken from the beginning. Elements - * are taken until `predicate` returns falsey. The predicate is invoked with - * three arguments: (value, index, array). - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Array - * @param {Array} array The array to query. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {Array} Returns the slice of `array`. - * @example - * - * var users = [ - * { 'user': 'barney', 'active': false }, - * { 'user': 'fred', 'active': false }, - * { 'user': 'pebbles', 'active': true } - * ]; - * - * _.takeWhile(users, function(o) { return !o.active; }); - * // => objects for ['barney', 'fred'] - * - * // The `_.matches` iteratee shorthand. - * _.takeWhile(users, { 'user': 'barney', 'active': false }); - * // => objects for ['barney'] - * - * // The `_.matchesProperty` iteratee shorthand. - * _.takeWhile(users, ['active', false]); - * // => objects for ['barney', 'fred'] - * - * // The `_.property` iteratee shorthand. - * _.takeWhile(users, 'active'); - * // => [] - */ - function takeWhile(array, predicate) { - return (array && array.length) - ? baseWhile(array, getIteratee(predicate, 3)) - : []; - } - - /** - * Creates an array of unique values, in order, from all given arrays using - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {...Array} [arrays] The arrays to inspect. - * @returns {Array} Returns the new array of combined values. - * @example - * - * _.union([2], [1, 2]); - * // => [2, 1] - */ - var union = baseRest(function(arrays) { - return baseUniq(baseFlatten(arrays, 1, isArrayLikeObject, true)); - }); - - /** - * This method is like `_.union` except that it accepts `iteratee` which is - * invoked for each element of each `arrays` to generate the criterion by - * which uniqueness is computed. Result values are chosen from the first - * array in which the value occurs. The iteratee is invoked with one argument: - * (value). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {...Array} [arrays] The arrays to inspect. - * @param {Function} [iteratee=_.identity] The iteratee invoked per element. - * @returns {Array} Returns the new array of combined values. - * @example - * - * _.unionBy([2.1], [1.2, 2.3], Math.floor); - * // => [2.1, 1.2] - * - * // The `_.property` iteratee shorthand. - * _.unionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x'); - * // => [{ 'x': 1 }, { 'x': 2 }] - */ - var unionBy = baseRest(function(arrays) { - var iteratee = last(arrays); - if (isArrayLikeObject(iteratee)) { - iteratee = undefined; - } - return baseUniq(baseFlatten(arrays, 1, isArrayLikeObject, true), getIteratee(iteratee, 2)); - }); - - /** - * This method is like `_.union` except that it accepts `comparator` which - * is invoked to compare elements of `arrays`. Result values are chosen from - * the first array in which the value occurs. The comparator is invoked - * with two arguments: (arrVal, othVal). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {...Array} [arrays] The arrays to inspect. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new array of combined values. - * @example - * - * var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; - * var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }]; - * - * _.unionWith(objects, others, _.isEqual); - * // => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }] - */ - var unionWith = baseRest(function(arrays) { - var comparator = last(arrays); - comparator = typeof comparator == 'function' ? comparator : undefined; - return baseUniq(baseFlatten(arrays, 1, isArrayLikeObject, true), undefined, comparator); - }); - - /** - * Creates a duplicate-free version of an array, using - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons, in which only the first occurrence of each element - * is kept. The order of result values is determined by the order they occur - * in the array. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to inspect. - * @returns {Array} Returns the new duplicate free array. - * @example - * - * _.uniq([2, 1, 2]); - * // => [2, 1] - */ - function uniq(array) { - return (array && array.length) ? baseUniq(array) : []; - } - - /** - * This method is like `_.uniq` except that it accepts `iteratee` which is - * invoked for each element in `array` to generate the criterion by which - * uniqueness is computed. The order of result values is determined by the - * order they occur in the array. The iteratee is invoked with one argument: - * (value). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {Function} [iteratee=_.identity] The iteratee invoked per element. - * @returns {Array} Returns the new duplicate free array. - * @example - * - * _.uniqBy([2.1, 1.2, 2.3], Math.floor); - * // => [2.1, 1.2] - * - * // The `_.property` iteratee shorthand. - * _.uniqBy([{ 'x': 1 }, { 'x': 2 }, { 'x': 1 }], 'x'); - * // => [{ 'x': 1 }, { 'x': 2 }] - */ - function uniqBy(array, iteratee) { - return (array && array.length) ? baseUniq(array, getIteratee(iteratee, 2)) : []; - } - - /** - * This method is like `_.uniq` except that it accepts `comparator` which - * is invoked to compare elements of `array`. The order of result values is - * determined by the order they occur in the array.The comparator is invoked - * with two arguments: (arrVal, othVal). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new duplicate free array. - * @example - * - * var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 2 }]; - * - * _.uniqWith(objects, _.isEqual); - * // => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }] - */ - function uniqWith(array, comparator) { - comparator = typeof comparator == 'function' ? comparator : undefined; - return (array && array.length) ? baseUniq(array, undefined, comparator) : []; - } - - /** - * This method is like `_.zip` except that it accepts an array of grouped - * elements and creates an array regrouping the elements to their pre-zip - * configuration. - * - * @static - * @memberOf _ - * @since 1.2.0 - * @category Array - * @param {Array} array The array of grouped elements to process. - * @returns {Array} Returns the new array of regrouped elements. - * @example - * - * var zipped = _.zip(['a', 'b'], [1, 2], [true, false]); - * // => [['a', 1, true], ['b', 2, false]] - * - * _.unzip(zipped); - * // => [['a', 'b'], [1, 2], [true, false]] - */ - function unzip(array) { - if (!(array && array.length)) { - return []; - } - var length = 0; - array = arrayFilter(array, function(group) { - if (isArrayLikeObject(group)) { - length = nativeMax(group.length, length); - return true; - } - }); - return baseTimes(length, function(index) { - return arrayMap(array, baseProperty(index)); - }); - } - - /** - * This method is like `_.unzip` except that it accepts `iteratee` to specify - * how regrouped values should be combined. The iteratee is invoked with the - * elements of each group: (...group). - * - * @static - * @memberOf _ - * @since 3.8.0 - * @category Array - * @param {Array} array The array of grouped elements to process. - * @param {Function} [iteratee=_.identity] The function to combine - * regrouped values. - * @returns {Array} Returns the new array of regrouped elements. - * @example - * - * var zipped = _.zip([1, 2], [10, 20], [100, 200]); - * // => [[1, 10, 100], [2, 20, 200]] - * - * _.unzipWith(zipped, _.add); - * // => [3, 30, 300] - */ - function unzipWith(array, iteratee) { - if (!(array && array.length)) { - return []; - } - var result = unzip(array); - if (iteratee == null) { - return result; - } - return arrayMap(result, function(group) { - return apply(iteratee, undefined, group); - }); - } - - /** - * Creates an array excluding all given values using - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons. - * - * **Note:** Unlike `_.pull`, this method returns a new array. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to inspect. - * @param {...*} [values] The values to exclude. - * @returns {Array} Returns the new array of filtered values. - * @see _.difference, _.xor - * @example - * - * _.without([2, 1, 2, 3], 1, 2); - * // => [3] - */ - var without = baseRest(function(array, values) { - return isArrayLikeObject(array) - ? baseDifference(array, values) - : []; - }); - - /** - * Creates an array of unique values that is the - * [symmetric difference](https://en.wikipedia.org/wiki/Symmetric_difference) - * of the given arrays. The order of result values is determined by the order - * they occur in the arrays. - * - * @static - * @memberOf _ - * @since 2.4.0 - * @category Array - * @param {...Array} [arrays] The arrays to inspect. - * @returns {Array} Returns the new array of filtered values. - * @see _.difference, _.without - * @example - * - * _.xor([2, 1], [2, 3]); - * // => [1, 3] - */ - var xor = baseRest(function(arrays) { - return baseXor(arrayFilter(arrays, isArrayLikeObject)); - }); - - /** - * This method is like `_.xor` except that it accepts `iteratee` which is - * invoked for each element of each `arrays` to generate the criterion by - * which by which they're compared. The order of result values is determined - * by the order they occur in the arrays. The iteratee is invoked with one - * argument: (value). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {...Array} [arrays] The arrays to inspect. - * @param {Function} [iteratee=_.identity] The iteratee invoked per element. - * @returns {Array} Returns the new array of filtered values. - * @example - * - * _.xorBy([2.1, 1.2], [2.3, 3.4], Math.floor); - * // => [1.2, 3.4] - * - * // The `_.property` iteratee shorthand. - * _.xorBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x'); - * // => [{ 'x': 2 }] - */ - var xorBy = baseRest(function(arrays) { - var iteratee = last(arrays); - if (isArrayLikeObject(iteratee)) { - iteratee = undefined; - } - return baseXor(arrayFilter(arrays, isArrayLikeObject), getIteratee(iteratee, 2)); - }); - - /** - * This method is like `_.xor` except that it accepts `comparator` which is - * invoked to compare elements of `arrays`. The order of result values is - * determined by the order they occur in the arrays. The comparator is invoked - * with two arguments: (arrVal, othVal). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Array - * @param {...Array} [arrays] The arrays to inspect. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new array of filtered values. - * @example - * - * var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; - * var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }]; - * - * _.xorWith(objects, others, _.isEqual); - * // => [{ 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }] - */ - var xorWith = baseRest(function(arrays) { - var comparator = last(arrays); - comparator = typeof comparator == 'function' ? comparator : undefined; - return baseXor(arrayFilter(arrays, isArrayLikeObject), undefined, comparator); - }); - - /** - * Creates an array of grouped elements, the first of which contains the - * first elements of the given arrays, the second of which contains the - * second elements of the given arrays, and so on. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {...Array} [arrays] The arrays to process. - * @returns {Array} Returns the new array of grouped elements. - * @example - * - * _.zip(['a', 'b'], [1, 2], [true, false]); - * // => [['a', 1, true], ['b', 2, false]] - */ - var zip = baseRest(unzip); - - /** - * This method is like `_.fromPairs` except that it accepts two arrays, - * one of property identifiers and one of corresponding values. - * - * @static - * @memberOf _ - * @since 0.4.0 - * @category Array - * @param {Array} [props=[]] The property identifiers. - * @param {Array} [values=[]] The property values. - * @returns {Object} Returns the new object. - * @example - * - * _.zipObject(['a', 'b'], [1, 2]); - * // => { 'a': 1, 'b': 2 } - */ - function zipObject(props, values) { - return baseZipObject(props || [], values || [], assignValue); - } - - /** - * This method is like `_.zipObject` except that it supports property paths. - * - * @static - * @memberOf _ - * @since 4.1.0 - * @category Array - * @param {Array} [props=[]] The property identifiers. - * @param {Array} [values=[]] The property values. - * @returns {Object} Returns the new object. - * @example - * - * _.zipObjectDeep(['a.b[0].c', 'a.b[1].d'], [1, 2]); - * // => { 'a': { 'b': [{ 'c': 1 }, { 'd': 2 }] } } - */ - function zipObjectDeep(props, values) { - return baseZipObject(props || [], values || [], baseSet); - } - - /** - * This method is like `_.zip` except that it accepts `iteratee` to specify - * how grouped values should be combined. The iteratee is invoked with the - * elements of each group: (...group). - * - * @static - * @memberOf _ - * @since 3.8.0 - * @category Array - * @param {...Array} [arrays] The arrays to process. - * @param {Function} [iteratee=_.identity] The function to combine - * grouped values. - * @returns {Array} Returns the new array of grouped elements. - * @example - * - * _.zipWith([1, 2], [10, 20], [100, 200], function(a, b, c) { - * return a + b + c; - * }); - * // => [111, 222] - */ - var zipWith = baseRest(function(arrays) { - var length = arrays.length, - iteratee = length > 1 ? arrays[length - 1] : undefined; - - iteratee = typeof iteratee == 'function' ? (arrays.pop(), iteratee) : undefined; - return unzipWith(arrays, iteratee); - }); - - /*------------------------------------------------------------------------*/ - - /** - * Creates a `lodash` wrapper instance that wraps `value` with explicit method - * chain sequences enabled. The result of such sequences must be unwrapped - * with `_#value`. - * - * @static - * @memberOf _ - * @since 1.3.0 - * @category Seq - * @param {*} value The value to wrap. - * @returns {Object} Returns the new `lodash` wrapper instance. - * @example - * - * var users = [ - * { 'user': 'barney', 'age': 36 }, - * { 'user': 'fred', 'age': 40 }, - * { 'user': 'pebbles', 'age': 1 } - * ]; - * - * var youngest = _ - * .chain(users) - * .sortBy('age') - * .map(function(o) { - * return o.user + ' is ' + o.age; - * }) - * .head() - * .value(); - * // => 'pebbles is 1' - */ - function chain(value) { - var result = lodash(value); - result.__chain__ = true; - return result; - } - - /** - * This method invokes `interceptor` and returns `value`. The interceptor - * is invoked with one argument; (value). The purpose of this method is to - * "tap into" a method chain sequence in order to modify intermediate results. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Seq - * @param {*} value The value to provide to `interceptor`. - * @param {Function} interceptor The function to invoke. - * @returns {*} Returns `value`. - * @example - * - * _([1, 2, 3]) - * .tap(function(array) { - * // Mutate input array. - * array.pop(); - * }) - * .reverse() - * .value(); - * // => [2, 1] - */ - function tap(value, interceptor) { - interceptor(value); - return value; - } - - /** - * This method is like `_.tap` except that it returns the result of `interceptor`. - * The purpose of this method is to "pass thru" values replacing intermediate - * results in a method chain sequence. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Seq - * @param {*} value The value to provide to `interceptor`. - * @param {Function} interceptor The function to invoke. - * @returns {*} Returns the result of `interceptor`. - * @example - * - * _(' abc ') - * .chain() - * .trim() - * .thru(function(value) { - * return [value]; - * }) - * .value(); - * // => ['abc'] - */ - function thru(value, interceptor) { - return interceptor(value); - } - - /** - * This method is the wrapper version of `_.at`. - * - * @name at - * @memberOf _ - * @since 1.0.0 - * @category Seq - * @param {...(string|string[])} [paths] The property paths to pick. - * @returns {Object} Returns the new `lodash` wrapper instance. - * @example - * - * var object = { 'a': [{ 'b': { 'c': 3 } }, 4] }; - * - * _(object).at(['a[0].b.c', 'a[1]']).value(); - * // => [3, 4] - */ - var wrapperAt = flatRest(function(paths) { - var length = paths.length, - start = length ? paths[0] : 0, - value = this.__wrapped__, - interceptor = function(object) { return baseAt(object, paths); }; - - if (length > 1 || this.__actions__.length || - !(value instanceof LazyWrapper) || !isIndex(start)) { - return this.thru(interceptor); - } - value = value.slice(start, +start + (length ? 1 : 0)); - value.__actions__.push({ - 'func': thru, - 'args': [interceptor], - 'thisArg': undefined - }); - return new LodashWrapper(value, this.__chain__).thru(function(array) { - if (length && !array.length) { - array.push(undefined); - } - return array; - }); - }); - - /** - * Creates a `lodash` wrapper instance with explicit method chain sequences enabled. - * - * @name chain - * @memberOf _ - * @since 0.1.0 - * @category Seq - * @returns {Object} Returns the new `lodash` wrapper instance. - * @example - * - * var users = [ - * { 'user': 'barney', 'age': 36 }, - * { 'user': 'fred', 'age': 40 } - * ]; - * - * // A sequence without explicit chaining. - * _(users).head(); - * // => { 'user': 'barney', 'age': 36 } - * - * // A sequence with explicit chaining. - * _(users) - * .chain() - * .head() - * .pick('user') - * .value(); - * // => { 'user': 'barney' } - */ - function wrapperChain() { - return chain(this); - } - - /** - * Executes the chain sequence and returns the wrapped result. - * - * @name commit - * @memberOf _ - * @since 3.2.0 - * @category Seq - * @returns {Object} Returns the new `lodash` wrapper instance. - * @example - * - * var array = [1, 2]; - * var wrapped = _(array).push(3); - * - * console.log(array); - * // => [1, 2] - * - * wrapped = wrapped.commit(); - * console.log(array); - * // => [1, 2, 3] - * - * wrapped.last(); - * // => 3 - * - * console.log(array); - * // => [1, 2, 3] - */ - function wrapperCommit() { - return new LodashWrapper(this.value(), this.__chain__); - } - - /** - * Gets the next value on a wrapped object following the - * [iterator protocol](https://mdn.io/iteration_protocols#iterator). - * - * @name next - * @memberOf _ - * @since 4.0.0 - * @category Seq - * @returns {Object} Returns the next iterator value. - * @example - * - * var wrapped = _([1, 2]); - * - * wrapped.next(); - * // => { 'done': false, 'value': 1 } - * - * wrapped.next(); - * // => { 'done': false, 'value': 2 } - * - * wrapped.next(); - * // => { 'done': true, 'value': undefined } - */ - function wrapperNext() { - if (this.__values__ === undefined) { - this.__values__ = toArray(this.value()); - } - var done = this.__index__ >= this.__values__.length, - value = done ? undefined : this.__values__[this.__index__++]; - - return { 'done': done, 'value': value }; - } - - /** - * Enables the wrapper to be iterable. - * - * @name Symbol.iterator - * @memberOf _ - * @since 4.0.0 - * @category Seq - * @returns {Object} Returns the wrapper object. - * @example - * - * var wrapped = _([1, 2]); - * - * wrapped[Symbol.iterator]() === wrapped; - * // => true - * - * Array.from(wrapped); - * // => [1, 2] - */ - function wrapperToIterator() { - return this; - } - - /** - * Creates a clone of the chain sequence planting `value` as the wrapped value. - * - * @name plant - * @memberOf _ - * @since 3.2.0 - * @category Seq - * @param {*} value The value to plant. - * @returns {Object} Returns the new `lodash` wrapper instance. - * @example - * - * function square(n) { - * return n * n; - * } - * - * var wrapped = _([1, 2]).map(square); - * var other = wrapped.plant([3, 4]); - * - * other.value(); - * // => [9, 16] - * - * wrapped.value(); - * // => [1, 4] - */ - function wrapperPlant(value) { - var result, - parent = this; - - while (parent instanceof baseLodash) { - var clone = wrapperClone(parent); - clone.__index__ = 0; - clone.__values__ = undefined; - if (result) { - previous.__wrapped__ = clone; - } else { - result = clone; - } - var previous = clone; - parent = parent.__wrapped__; - } - previous.__wrapped__ = value; - return result; - } - - /** - * This method is the wrapper version of `_.reverse`. - * - * **Note:** This method mutates the wrapped array. - * - * @name reverse - * @memberOf _ - * @since 0.1.0 - * @category Seq - * @returns {Object} Returns the new `lodash` wrapper instance. - * @example - * - * var array = [1, 2, 3]; - * - * _(array).reverse().value() - * // => [3, 2, 1] - * - * console.log(array); - * // => [3, 2, 1] - */ - function wrapperReverse() { - var value = this.__wrapped__; - if (value instanceof LazyWrapper) { - var wrapped = value; - if (this.__actions__.length) { - wrapped = new LazyWrapper(this); - } - wrapped = wrapped.reverse(); - wrapped.__actions__.push({ - 'func': thru, - 'args': [reverse], - 'thisArg': undefined - }); - return new LodashWrapper(wrapped, this.__chain__); - } - return this.thru(reverse); - } - - /** - * Executes the chain sequence to resolve the unwrapped value. - * - * @name value - * @memberOf _ - * @since 0.1.0 - * @alias toJSON, valueOf - * @category Seq - * @returns {*} Returns the resolved unwrapped value. - * @example - * - * _([1, 2, 3]).value(); - * // => [1, 2, 3] - */ - function wrapperValue() { - return baseWrapperValue(this.__wrapped__, this.__actions__); - } - - /*------------------------------------------------------------------------*/ - - /** - * Creates an object composed of keys generated from the results of running - * each element of `collection` thru `iteratee`. The corresponding value of - * each key is the number of times the key was returned by `iteratee`. The - * iteratee is invoked with one argument: (value). - * - * @static - * @memberOf _ - * @since 0.5.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The iteratee to transform keys. - * @returns {Object} Returns the composed aggregate object. - * @example - * - * _.countBy([6.1, 4.2, 6.3], Math.floor); - * // => { '4': 1, '6': 2 } - * - * // The `_.property` iteratee shorthand. - * _.countBy(['one', 'two', 'three'], 'length'); - * // => { '3': 2, '5': 1 } - */ - var countBy = createAggregator(function(result, value, key) { - if (hasOwnProperty.call(result, key)) { - ++result[key]; - } else { - baseAssignValue(result, key, 1); - } - }); - - /** - * Checks if `predicate` returns truthy for **all** elements of `collection`. - * Iteration is stopped once `predicate` returns falsey. The predicate is - * invoked with three arguments: (value, index|key, collection). - * - * **Note:** This method returns `true` for - * [empty collections](https://en.wikipedia.org/wiki/Empty_set) because - * [everything is true](https://en.wikipedia.org/wiki/Vacuous_truth) of - * elements of empty collections. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {boolean} Returns `true` if all elements pass the predicate check, - * else `false`. - * @example - * - * _.every([true, 1, null, 'yes'], Boolean); - * // => false - * - * var users = [ - * { 'user': 'barney', 'age': 36, 'active': false }, - * { 'user': 'fred', 'age': 40, 'active': false } - * ]; - * - * // The `_.matches` iteratee shorthand. - * _.every(users, { 'user': 'barney', 'active': false }); - * // => false - * - * // The `_.matchesProperty` iteratee shorthand. - * _.every(users, ['active', false]); - * // => true - * - * // The `_.property` iteratee shorthand. - * _.every(users, 'active'); - * // => false - */ - function every(collection, predicate, guard) { - var func = isArray(collection) ? arrayEvery : baseEvery; - if (guard && isIterateeCall(collection, predicate, guard)) { - predicate = undefined; - } - return func(collection, getIteratee(predicate, 3)); - } - - /** - * Iterates over elements of `collection`, returning an array of all elements - * `predicate` returns truthy for. The predicate is invoked with three - * arguments: (value, index|key, collection). - * - * **Note:** Unlike `_.remove`, this method returns a new array. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {Array} Returns the new filtered array. - * @see _.reject - * @example - * - * var users = [ - * { 'user': 'barney', 'age': 36, 'active': true }, - * { 'user': 'fred', 'age': 40, 'active': false } - * ]; - * - * _.filter(users, function(o) { return !o.active; }); - * // => objects for ['fred'] - * - * // The `_.matches` iteratee shorthand. - * _.filter(users, { 'age': 36, 'active': true }); - * // => objects for ['barney'] - * - * // The `_.matchesProperty` iteratee shorthand. - * _.filter(users, ['active', false]); - * // => objects for ['fred'] - * - * // The `_.property` iteratee shorthand. - * _.filter(users, 'active'); - * // => objects for ['barney'] - */ - function filter(collection, predicate) { - var func = isArray(collection) ? arrayFilter : baseFilter; - return func(collection, getIteratee(predicate, 3)); - } - - /** - * Iterates over elements of `collection`, returning the first element - * `predicate` returns truthy for. The predicate is invoked with three - * arguments: (value, index|key, collection). - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to inspect. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @param {number} [fromIndex=0] The index to search from. - * @returns {*} Returns the matched element, else `undefined`. - * @example - * - * var users = [ - * { 'user': 'barney', 'age': 36, 'active': true }, - * { 'user': 'fred', 'age': 40, 'active': false }, - * { 'user': 'pebbles', 'age': 1, 'active': true } - * ]; - * - * _.find(users, function(o) { return o.age < 40; }); - * // => object for 'barney' - * - * // The `_.matches` iteratee shorthand. - * _.find(users, { 'age': 1, 'active': true }); - * // => object for 'pebbles' - * - * // The `_.matchesProperty` iteratee shorthand. - * _.find(users, ['active', false]); - * // => object for 'fred' - * - * // The `_.property` iteratee shorthand. - * _.find(users, 'active'); - * // => object for 'barney' - */ - var find = createFind(findIndex); - - /** - * This method is like `_.find` except that it iterates over elements of - * `collection` from right to left. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @category Collection - * @param {Array|Object} collection The collection to inspect. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @param {number} [fromIndex=collection.length-1] The index to search from. - * @returns {*} Returns the matched element, else `undefined`. - * @example - * - * _.findLast([1, 2, 3, 4], function(n) { - * return n % 2 == 1; - * }); - * // => 3 - */ - var findLast = createFind(findLastIndex); - - /** - * Creates a flattened array of values by running each element in `collection` - * thru `iteratee` and flattening the mapped results. The iteratee is invoked - * with three arguments: (value, index|key, collection). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Array} Returns the new flattened array. - * @example - * - * function duplicate(n) { - * return [n, n]; - * } - * - * _.flatMap([1, 2], duplicate); - * // => [1, 1, 2, 2] - */ - function flatMap(collection, iteratee) { - return baseFlatten(map(collection, iteratee), 1); - } - - /** - * This method is like `_.flatMap` except that it recursively flattens the - * mapped results. - * - * @static - * @memberOf _ - * @since 4.7.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Array} Returns the new flattened array. - * @example - * - * function duplicate(n) { - * return [[[n, n]]]; - * } - * - * _.flatMapDeep([1, 2], duplicate); - * // => [1, 1, 2, 2] - */ - function flatMapDeep(collection, iteratee) { - return baseFlatten(map(collection, iteratee), INFINITY); - } - - /** - * This method is like `_.flatMap` except that it recursively flattens the - * mapped results up to `depth` times. - * - * @static - * @memberOf _ - * @since 4.7.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @param {number} [depth=1] The maximum recursion depth. - * @returns {Array} Returns the new flattened array. - * @example - * - * function duplicate(n) { - * return [[[n, n]]]; - * } - * - * _.flatMapDepth([1, 2], duplicate, 2); - * // => [[1, 1], [2, 2]] - */ - function flatMapDepth(collection, iteratee, depth) { - depth = depth === undefined ? 1 : toInteger(depth); - return baseFlatten(map(collection, iteratee), depth); - } - - /** - * Iterates over elements of `collection` and invokes `iteratee` for each element. - * The iteratee is invoked with three arguments: (value, index|key, collection). - * Iteratee functions may exit iteration early by explicitly returning `false`. - * - * **Note:** As with other "Collections" methods, objects with a "length" - * property are iterated like arrays. To avoid this behavior use `_.forIn` - * or `_.forOwn` for object iteration. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @alias each - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Array|Object} Returns `collection`. - * @see _.forEachRight - * @example - * - * _.forEach([1, 2], function(value) { - * console.log(value); - * }); - * // => Logs `1` then `2`. - * - * _.forEach({ 'a': 1, 'b': 2 }, function(value, key) { - * console.log(key); - * }); - * // => Logs 'a' then 'b' (iteration order is not guaranteed). - */ - function forEach(collection, iteratee) { - var func = isArray(collection) ? arrayEach : baseEach; - return func(collection, getIteratee(iteratee, 3)); - } - - /** - * This method is like `_.forEach` except that it iterates over elements of - * `collection` from right to left. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @alias eachRight - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Array|Object} Returns `collection`. - * @see _.forEach - * @example - * - * _.forEachRight([1, 2], function(value) { - * console.log(value); - * }); - * // => Logs `2` then `1`. - */ - function forEachRight(collection, iteratee) { - var func = isArray(collection) ? arrayEachRight : baseEachRight; - return func(collection, getIteratee(iteratee, 3)); - } - - /** - * Creates an object composed of keys generated from the results of running - * each element of `collection` thru `iteratee`. The order of grouped values - * is determined by the order they occur in `collection`. The corresponding - * value of each key is an array of elements responsible for generating the - * key. The iteratee is invoked with one argument: (value). - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The iteratee to transform keys. - * @returns {Object} Returns the composed aggregate object. - * @example - * - * _.groupBy([6.1, 4.2, 6.3], Math.floor); - * // => { '4': [4.2], '6': [6.1, 6.3] } - * - * // The `_.property` iteratee shorthand. - * _.groupBy(['one', 'two', 'three'], 'length'); - * // => { '3': ['one', 'two'], '5': ['three'] } - */ - var groupBy = createAggregator(function(result, value, key) { - if (hasOwnProperty.call(result, key)) { - result[key].push(value); - } else { - baseAssignValue(result, key, [value]); - } - }); - - /** - * Checks if `value` is in `collection`. If `collection` is a string, it's - * checked for a substring of `value`, otherwise - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * is used for equality comparisons. If `fromIndex` is negative, it's used as - * the offset from the end of `collection`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object|string} collection The collection to inspect. - * @param {*} value The value to search for. - * @param {number} [fromIndex=0] The index to search from. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.reduce`. - * @returns {boolean} Returns `true` if `value` is found, else `false`. - * @example - * - * _.includes([1, 2, 3], 1); - * // => true - * - * _.includes([1, 2, 3], 1, 2); - * // => false - * - * _.includes({ 'a': 1, 'b': 2 }, 1); - * // => true - * - * _.includes('abcd', 'bc'); - * // => true - */ - function includes(collection, value, fromIndex, guard) { - collection = isArrayLike(collection) ? collection : values(collection); - fromIndex = (fromIndex && !guard) ? toInteger(fromIndex) : 0; - - var length = collection.length; - if (fromIndex < 0) { - fromIndex = nativeMax(length + fromIndex, 0); - } - return isString(collection) - ? (fromIndex <= length && collection.indexOf(value, fromIndex) > -1) - : (!!length && baseIndexOf(collection, value, fromIndex) > -1); - } - - /** - * Invokes the method at `path` of each element in `collection`, returning - * an array of the results of each invoked method. Any additional arguments - * are provided to each invoked method. If `path` is a function, it's invoked - * for, and `this` bound to, each element in `collection`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Array|Function|string} path The path of the method to invoke or - * the function invoked per iteration. - * @param {...*} [args] The arguments to invoke each method with. - * @returns {Array} Returns the array of results. - * @example - * - * _.invokeMap([[5, 1, 7], [3, 2, 1]], 'sort'); - * // => [[1, 5, 7], [1, 2, 3]] - * - * _.invokeMap([123, 456], String.prototype.split, ''); - * // => [['1', '2', '3'], ['4', '5', '6']] - */ - var invokeMap = baseRest(function(collection, path, args) { - var index = -1, - isFunc = typeof path == 'function', - result = isArrayLike(collection) ? Array(collection.length) : []; - - baseEach(collection, function(value) { - result[++index] = isFunc ? apply(path, value, args) : baseInvoke(value, path, args); - }); - return result; - }); - - /** - * Creates an object composed of keys generated from the results of running - * each element of `collection` thru `iteratee`. The corresponding value of - * each key is the last element responsible for generating the key. The - * iteratee is invoked with one argument: (value). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The iteratee to transform keys. - * @returns {Object} Returns the composed aggregate object. - * @example - * - * var array = [ - * { 'dir': 'left', 'code': 97 }, - * { 'dir': 'right', 'code': 100 } - * ]; - * - * _.keyBy(array, function(o) { - * return String.fromCharCode(o.code); - * }); - * // => { 'a': { 'dir': 'left', 'code': 97 }, 'd': { 'dir': 'right', 'code': 100 } } - * - * _.keyBy(array, 'dir'); - * // => { 'left': { 'dir': 'left', 'code': 97 }, 'right': { 'dir': 'right', 'code': 100 } } - */ - var keyBy = createAggregator(function(result, value, key) { - baseAssignValue(result, key, value); - }); - - /** - * Creates an array of values by running each element in `collection` thru - * `iteratee`. The iteratee is invoked with three arguments: - * (value, index|key, collection). - * - * Many lodash methods are guarded to work as iteratees for methods like - * `_.every`, `_.filter`, `_.map`, `_.mapValues`, `_.reject`, and `_.some`. - * - * The guarded methods are: - * `ary`, `chunk`, `curry`, `curryRight`, `drop`, `dropRight`, `every`, - * `fill`, `invert`, `parseInt`, `random`, `range`, `rangeRight`, `repeat`, - * `sampleSize`, `slice`, `some`, `sortBy`, `split`, `take`, `takeRight`, - * `template`, `trim`, `trimEnd`, `trimStart`, and `words` - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Array} Returns the new mapped array. - * @example - * - * function square(n) { - * return n * n; - * } - * - * _.map([4, 8], square); - * // => [16, 64] - * - * _.map({ 'a': 4, 'b': 8 }, square); - * // => [16, 64] (iteration order is not guaranteed) - * - * var users = [ - * { 'user': 'barney' }, - * { 'user': 'fred' } - * ]; - * - * // The `_.property` iteratee shorthand. - * _.map(users, 'user'); - * // => ['barney', 'fred'] - */ - function map(collection, iteratee) { - var func = isArray(collection) ? arrayMap : baseMap; - return func(collection, getIteratee(iteratee, 3)); - } - - /** - * This method is like `_.sortBy` except that it allows specifying the sort - * orders of the iteratees to sort by. If `orders` is unspecified, all values - * are sorted in ascending order. Otherwise, specify an order of "desc" for - * descending or "asc" for ascending sort order of corresponding values. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Array[]|Function[]|Object[]|string[]} [iteratees=[_.identity]] - * The iteratees to sort by. - * @param {string[]} [orders] The sort orders of `iteratees`. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.reduce`. - * @returns {Array} Returns the new sorted array. - * @example - * - * var users = [ - * { 'user': 'fred', 'age': 48 }, - * { 'user': 'barney', 'age': 34 }, - * { 'user': 'fred', 'age': 40 }, - * { 'user': 'barney', 'age': 36 } - * ]; - * - * // Sort by `user` in ascending order and by `age` in descending order. - * _.orderBy(users, ['user', 'age'], ['asc', 'desc']); - * // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 40]] - */ - function orderBy(collection, iteratees, orders, guard) { - if (collection == null) { - return []; - } - if (!isArray(iteratees)) { - iteratees = iteratees == null ? [] : [iteratees]; - } - orders = guard ? undefined : orders; - if (!isArray(orders)) { - orders = orders == null ? [] : [orders]; - } - return baseOrderBy(collection, iteratees, orders); - } - - /** - * Creates an array of elements split into two groups, the first of which - * contains elements `predicate` returns truthy for, the second of which - * contains elements `predicate` returns falsey for. The predicate is - * invoked with one argument: (value). - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {Array} Returns the array of grouped elements. - * @example - * - * var users = [ - * { 'user': 'barney', 'age': 36, 'active': false }, - * { 'user': 'fred', 'age': 40, 'active': true }, - * { 'user': 'pebbles', 'age': 1, 'active': false } - * ]; - * - * _.partition(users, function(o) { return o.active; }); - * // => objects for [['fred'], ['barney', 'pebbles']] - * - * // The `_.matches` iteratee shorthand. - * _.partition(users, { 'age': 1, 'active': false }); - * // => objects for [['pebbles'], ['barney', 'fred']] - * - * // The `_.matchesProperty` iteratee shorthand. - * _.partition(users, ['active', false]); - * // => objects for [['barney', 'pebbles'], ['fred']] - * - * // The `_.property` iteratee shorthand. - * _.partition(users, 'active'); - * // => objects for [['fred'], ['barney', 'pebbles']] - */ - var partition = createAggregator(function(result, value, key) { - result[key ? 0 : 1].push(value); - }, function() { return [[], []]; }); - - /** - * Reduces `collection` to a value which is the accumulated result of running - * each element in `collection` thru `iteratee`, where each successive - * invocation is supplied the return value of the previous. If `accumulator` - * is not given, the first element of `collection` is used as the initial - * value. The iteratee is invoked with four arguments: - * (accumulator, value, index|key, collection). - * - * Many lodash methods are guarded to work as iteratees for methods like - * `_.reduce`, `_.reduceRight`, and `_.transform`. - * - * The guarded methods are: - * `assign`, `defaults`, `defaultsDeep`, `includes`, `merge`, `orderBy`, - * and `sortBy` - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @param {*} [accumulator] The initial value. - * @returns {*} Returns the accumulated value. - * @see _.reduceRight - * @example - * - * _.reduce([1, 2], function(sum, n) { - * return sum + n; - * }, 0); - * // => 3 - * - * _.reduce({ 'a': 1, 'b': 2, 'c': 1 }, function(result, value, key) { - * (result[value] || (result[value] = [])).push(key); - * return result; - * }, {}); - * // => { '1': ['a', 'c'], '2': ['b'] } (iteration order is not guaranteed) - */ - function reduce(collection, iteratee, accumulator) { - var func = isArray(collection) ? arrayReduce : baseReduce, - initAccum = arguments.length < 3; - - return func(collection, getIteratee(iteratee, 4), accumulator, initAccum, baseEach); - } - - /** - * This method is like `_.reduce` except that it iterates over elements of - * `collection` from right to left. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @param {*} [accumulator] The initial value. - * @returns {*} Returns the accumulated value. - * @see _.reduce - * @example - * - * var array = [[0, 1], [2, 3], [4, 5]]; - * - * _.reduceRight(array, function(flattened, other) { - * return flattened.concat(other); - * }, []); - * // => [4, 5, 2, 3, 0, 1] - */ - function reduceRight(collection, iteratee, accumulator) { - var func = isArray(collection) ? arrayReduceRight : baseReduce, - initAccum = arguments.length < 3; - - return func(collection, getIteratee(iteratee, 4), accumulator, initAccum, baseEachRight); - } - - /** - * The opposite of `_.filter`; this method returns the elements of `collection` - * that `predicate` does **not** return truthy for. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {Array} Returns the new filtered array. - * @see _.filter - * @example - * - * var users = [ - * { 'user': 'barney', 'age': 36, 'active': false }, - * { 'user': 'fred', 'age': 40, 'active': true } - * ]; - * - * _.reject(users, function(o) { return !o.active; }); - * // => objects for ['fred'] - * - * // The `_.matches` iteratee shorthand. - * _.reject(users, { 'age': 40, 'active': true }); - * // => objects for ['barney'] - * - * // The `_.matchesProperty` iteratee shorthand. - * _.reject(users, ['active', false]); - * // => objects for ['fred'] - * - * // The `_.property` iteratee shorthand. - * _.reject(users, 'active'); - * // => objects for ['barney'] - */ - function reject(collection, predicate) { - var func = isArray(collection) ? arrayFilter : baseFilter; - return func(collection, negate(getIteratee(predicate, 3))); - } - - /** - * Gets a random element from `collection`. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @category Collection - * @param {Array|Object} collection The collection to sample. - * @returns {*} Returns the random element. - * @example - * - * _.sample([1, 2, 3, 4]); - * // => 2 - */ - function sample(collection) { - var func = isArray(collection) ? arraySample : baseSample; - return func(collection); - } - - /** - * Gets `n` random elements at unique keys from `collection` up to the - * size of `collection`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Collection - * @param {Array|Object} collection The collection to sample. - * @param {number} [n=1] The number of elements to sample. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Array} Returns the random elements. - * @example - * - * _.sampleSize([1, 2, 3], 2); - * // => [3, 1] - * - * _.sampleSize([1, 2, 3], 4); - * // => [2, 3, 1] - */ - function sampleSize(collection, n, guard) { - if ((guard ? isIterateeCall(collection, n, guard) : n === undefined)) { - n = 1; - } else { - n = toInteger(n); - } - var func = isArray(collection) ? arraySampleSize : baseSampleSize; - return func(collection, n); - } - - /** - * Creates an array of shuffled values, using a version of the - * [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle). - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to shuffle. - * @returns {Array} Returns the new shuffled array. - * @example - * - * _.shuffle([1, 2, 3, 4]); - * // => [4, 1, 3, 2] - */ - function shuffle(collection) { - var func = isArray(collection) ? arrayShuffle : baseShuffle; - return func(collection); - } - - /** - * Gets the size of `collection` by returning its length for array-like - * values or the number of own enumerable string keyed properties for objects. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object|string} collection The collection to inspect. - * @returns {number} Returns the collection size. - * @example - * - * _.size([1, 2, 3]); - * // => 3 - * - * _.size({ 'a': 1, 'b': 2 }); - * // => 2 - * - * _.size('pebbles'); - * // => 7 - */ - function size(collection) { - if (collection == null) { - return 0; - } - if (isArrayLike(collection)) { - return isString(collection) ? stringSize(collection) : collection.length; - } - var tag = getTag(collection); - if (tag == mapTag || tag == setTag) { - return collection.size; - } - return baseKeys(collection).length; - } - - /** - * Checks if `predicate` returns truthy for **any** element of `collection`. - * Iteration is stopped once `predicate` returns truthy. The predicate is - * invoked with three arguments: (value, index|key, collection). - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {boolean} Returns `true` if any element passes the predicate check, - * else `false`. - * @example - * - * _.some([null, 0, 'yes', false], Boolean); - * // => true - * - * var users = [ - * { 'user': 'barney', 'active': true }, - * { 'user': 'fred', 'active': false } - * ]; - * - * // The `_.matches` iteratee shorthand. - * _.some(users, { 'user': 'barney', 'active': false }); - * // => false - * - * // The `_.matchesProperty` iteratee shorthand. - * _.some(users, ['active', false]); - * // => true - * - * // The `_.property` iteratee shorthand. - * _.some(users, 'active'); - * // => true - */ - function some(collection, predicate, guard) { - var func = isArray(collection) ? arraySome : baseSome; - if (guard && isIterateeCall(collection, predicate, guard)) { - predicate = undefined; - } - return func(collection, getIteratee(predicate, 3)); - } - - /** - * Creates an array of elements, sorted in ascending order by the results of - * running each element in a collection thru each iteratee. This method - * performs a stable sort, that is, it preserves the original sort order of - * equal elements. The iteratees are invoked with one argument: (value). - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Collection - * @param {Array|Object} collection The collection to iterate over. - * @param {...(Function|Function[])} [iteratees=[_.identity]] - * The iteratees to sort by. - * @returns {Array} Returns the new sorted array. - * @example - * - * var users = [ - * { 'user': 'fred', 'age': 48 }, - * { 'user': 'barney', 'age': 36 }, - * { 'user': 'fred', 'age': 40 }, - * { 'user': 'barney', 'age': 34 } - * ]; - * - * _.sortBy(users, [function(o) { return o.user; }]); - * // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 40]] - * - * _.sortBy(users, ['user', 'age']); - * // => objects for [['barney', 34], ['barney', 36], ['fred', 40], ['fred', 48]] - */ - var sortBy = baseRest(function(collection, iteratees) { - if (collection == null) { - return []; - } - var length = iteratees.length; - if (length > 1 && isIterateeCall(collection, iteratees[0], iteratees[1])) { - iteratees = []; - } else if (length > 2 && isIterateeCall(iteratees[0], iteratees[1], iteratees[2])) { - iteratees = [iteratees[0]]; - } - return baseOrderBy(collection, baseFlatten(iteratees, 1), []); - }); - - /*------------------------------------------------------------------------*/ - - /** - * Gets the timestamp of the number of milliseconds that have elapsed since - * the Unix epoch (1 January 1970 00:00:00 UTC). - * - * @static - * @memberOf _ - * @since 2.4.0 - * @category Date - * @returns {number} Returns the timestamp. - * @example - * - * _.defer(function(stamp) { - * console.log(_.now() - stamp); - * }, _.now()); - * // => Logs the number of milliseconds it took for the deferred invocation. - */ - var now = ctxNow || function() { - return root.Date.now(); - }; - - /*------------------------------------------------------------------------*/ - - /** - * The opposite of `_.before`; this method creates a function that invokes - * `func` once it's called `n` or more times. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {number} n The number of calls before `func` is invoked. - * @param {Function} func The function to restrict. - * @returns {Function} Returns the new restricted function. - * @example - * - * var saves = ['profile', 'settings']; - * - * var done = _.after(saves.length, function() { - * console.log('done saving!'); - * }); - * - * _.forEach(saves, function(type) { - * asyncSave({ 'type': type, 'complete': done }); - * }); - * // => Logs 'done saving!' after the two async saves have completed. - */ - function after(n, func) { - if (typeof func != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - n = toInteger(n); - return function() { - if (--n < 1) { - return func.apply(this, arguments); - } - }; - } - - /** - * Creates a function that invokes `func`, with up to `n` arguments, - * ignoring any additional arguments. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Function - * @param {Function} func The function to cap arguments for. - * @param {number} [n=func.length] The arity cap. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Function} Returns the new capped function. - * @example - * - * _.map(['6', '8', '10'], _.ary(parseInt, 1)); - * // => [6, 8, 10] - */ - function ary(func, n, guard) { - n = guard ? undefined : n; - n = (func && n == null) ? func.length : n; - return createWrap(func, WRAP_ARY_FLAG, undefined, undefined, undefined, undefined, n); - } - - /** - * Creates a function that invokes `func`, with the `this` binding and arguments - * of the created function, while it's called less than `n` times. Subsequent - * calls to the created function return the result of the last `func` invocation. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Function - * @param {number} n The number of calls at which `func` is no longer invoked. - * @param {Function} func The function to restrict. - * @returns {Function} Returns the new restricted function. - * @example - * - * jQuery(element).on('click', _.before(5, addContactToList)); - * // => Allows adding up to 4 contacts to the list. - */ - function before(n, func) { - var result; - if (typeof func != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - n = toInteger(n); - return function() { - if (--n > 0) { - result = func.apply(this, arguments); - } - if (n <= 1) { - func = undefined; - } - return result; - }; - } - - /** - * Creates a function that invokes `func` with the `this` binding of `thisArg` - * and `partials` prepended to the arguments it receives. - * - * The `_.bind.placeholder` value, which defaults to `_` in monolithic builds, - * may be used as a placeholder for partially applied arguments. - * - * **Note:** Unlike native `Function#bind`, this method doesn't set the "length" - * property of bound functions. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {Function} func The function to bind. - * @param {*} thisArg The `this` binding of `func`. - * @param {...*} [partials] The arguments to be partially applied. - * @returns {Function} Returns the new bound function. - * @example - * - * function greet(greeting, punctuation) { - * return greeting + ' ' + this.user + punctuation; - * } - * - * var object = { 'user': 'fred' }; - * - * var bound = _.bind(greet, object, 'hi'); - * bound('!'); - * // => 'hi fred!' - * - * // Bound with placeholders. - * var bound = _.bind(greet, object, _, '!'); - * bound('hi'); - * // => 'hi fred!' - */ - var bind = baseRest(function(func, thisArg, partials) { - var bitmask = WRAP_BIND_FLAG; - if (partials.length) { - var holders = replaceHolders(partials, getHolder(bind)); - bitmask |= WRAP_PARTIAL_FLAG; - } - return createWrap(func, bitmask, thisArg, partials, holders); - }); - - /** - * Creates a function that invokes the method at `object[key]` with `partials` - * prepended to the arguments it receives. - * - * This method differs from `_.bind` by allowing bound functions to reference - * methods that may be redefined or don't yet exist. See - * [Peter Michaux's article](http://peter.michaux.ca/articles/lazy-function-definition-pattern) - * for more details. - * - * The `_.bindKey.placeholder` value, which defaults to `_` in monolithic - * builds, may be used as a placeholder for partially applied arguments. - * - * @static - * @memberOf _ - * @since 0.10.0 - * @category Function - * @param {Object} object The object to invoke the method on. - * @param {string} key The key of the method. - * @param {...*} [partials] The arguments to be partially applied. - * @returns {Function} Returns the new bound function. - * @example - * - * var object = { - * 'user': 'fred', - * 'greet': function(greeting, punctuation) { - * return greeting + ' ' + this.user + punctuation; - * } - * }; - * - * var bound = _.bindKey(object, 'greet', 'hi'); - * bound('!'); - * // => 'hi fred!' - * - * object.greet = function(greeting, punctuation) { - * return greeting + 'ya ' + this.user + punctuation; - * }; - * - * bound('!'); - * // => 'hiya fred!' - * - * // Bound with placeholders. - * var bound = _.bindKey(object, 'greet', _, '!'); - * bound('hi'); - * // => 'hiya fred!' - */ - var bindKey = baseRest(function(object, key, partials) { - var bitmask = WRAP_BIND_FLAG | WRAP_BIND_KEY_FLAG; - if (partials.length) { - var holders = replaceHolders(partials, getHolder(bindKey)); - bitmask |= WRAP_PARTIAL_FLAG; - } - return createWrap(key, bitmask, object, partials, holders); - }); - - /** - * Creates a function that accepts arguments of `func` and either invokes - * `func` returning its result, if at least `arity` number of arguments have - * been provided, or returns a function that accepts the remaining `func` - * arguments, and so on. The arity of `func` may be specified if `func.length` - * is not sufficient. - * - * The `_.curry.placeholder` value, which defaults to `_` in monolithic builds, - * may be used as a placeholder for provided arguments. - * - * **Note:** This method doesn't set the "length" property of curried functions. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @category Function - * @param {Function} func The function to curry. - * @param {number} [arity=func.length] The arity of `func`. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Function} Returns the new curried function. - * @example - * - * var abc = function(a, b, c) { - * return [a, b, c]; - * }; - * - * var curried = _.curry(abc); - * - * curried(1)(2)(3); - * // => [1, 2, 3] - * - * curried(1, 2)(3); - * // => [1, 2, 3] - * - * curried(1, 2, 3); - * // => [1, 2, 3] - * - * // Curried with placeholders. - * curried(1)(_, 3)(2); - * // => [1, 2, 3] - */ - function curry(func, arity, guard) { - arity = guard ? undefined : arity; - var result = createWrap(func, WRAP_CURRY_FLAG, undefined, undefined, undefined, undefined, undefined, arity); - result.placeholder = curry.placeholder; - return result; - } - - /** - * This method is like `_.curry` except that arguments are applied to `func` - * in the manner of `_.partialRight` instead of `_.partial`. - * - * The `_.curryRight.placeholder` value, which defaults to `_` in monolithic - * builds, may be used as a placeholder for provided arguments. - * - * **Note:** This method doesn't set the "length" property of curried functions. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Function - * @param {Function} func The function to curry. - * @param {number} [arity=func.length] The arity of `func`. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Function} Returns the new curried function. - * @example - * - * var abc = function(a, b, c) { - * return [a, b, c]; - * }; - * - * var curried = _.curryRight(abc); - * - * curried(3)(2)(1); - * // => [1, 2, 3] - * - * curried(2, 3)(1); - * // => [1, 2, 3] - * - * curried(1, 2, 3); - * // => [1, 2, 3] - * - * // Curried with placeholders. - * curried(3)(1, _)(2); - * // => [1, 2, 3] - */ - function curryRight(func, arity, guard) { - arity = guard ? undefined : arity; - var result = createWrap(func, WRAP_CURRY_RIGHT_FLAG, undefined, undefined, undefined, undefined, undefined, arity); - result.placeholder = curryRight.placeholder; - return result; - } - - /** - * Creates a debounced function that delays invoking `func` until after `wait` - * milliseconds have elapsed since the last time the debounced function was - * invoked. The debounced function comes with a `cancel` method to cancel - * delayed `func` invocations and a `flush` method to immediately invoke them. - * Provide `options` to indicate whether `func` should be invoked on the - * leading and/or trailing edge of the `wait` timeout. The `func` is invoked - * with the last arguments provided to the debounced function. Subsequent - * calls to the debounced function return the result of the last `func` - * invocation. - * - * **Note:** If `leading` and `trailing` options are `true`, `func` is - * invoked on the trailing edge of the timeout only if the debounced function - * is invoked more than once during the `wait` timeout. - * - * If `wait` is `0` and `leading` is `false`, `func` invocation is deferred - * until to the next tick, similar to `setTimeout` with a timeout of `0`. - * - * See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/) - * for details over the differences between `_.debounce` and `_.throttle`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {Function} func The function to debounce. - * @param {number} [wait=0] The number of milliseconds to delay. - * @param {Object} [options={}] The options object. - * @param {boolean} [options.leading=false] - * Specify invoking on the leading edge of the timeout. - * @param {number} [options.maxWait] - * The maximum time `func` is allowed to be delayed before it's invoked. - * @param {boolean} [options.trailing=true] - * Specify invoking on the trailing edge of the timeout. - * @returns {Function} Returns the new debounced function. - * @example - * - * // Avoid costly calculations while the window size is in flux. - * jQuery(window).on('resize', _.debounce(calculateLayout, 150)); - * - * // Invoke `sendMail` when clicked, debouncing subsequent calls. - * jQuery(element).on('click', _.debounce(sendMail, 300, { - * 'leading': true, - * 'trailing': false - * })); - * - * // Ensure `batchLog` is invoked once after 1 second of debounced calls. - * var debounced = _.debounce(batchLog, 250, { 'maxWait': 1000 }); - * var source = new EventSource('/stream'); - * jQuery(source).on('message', debounced); - * - * // Cancel the trailing debounced invocation. - * jQuery(window).on('popstate', debounced.cancel); - */ - function debounce(func, wait, options) { - var lastArgs, - lastThis, - maxWait, - result, - timerId, - lastCallTime, - lastInvokeTime = 0, - leading = false, - maxing = false, - trailing = true; - - if (typeof func != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - wait = toNumber(wait) || 0; - if (isObject(options)) { - leading = !!options.leading; - maxing = 'maxWait' in options; - maxWait = maxing ? nativeMax(toNumber(options.maxWait) || 0, wait) : maxWait; - trailing = 'trailing' in options ? !!options.trailing : trailing; - } - - function invokeFunc(time) { - var args = lastArgs, - thisArg = lastThis; - - lastArgs = lastThis = undefined; - lastInvokeTime = time; - result = func.apply(thisArg, args); - return result; - } - - function leadingEdge(time) { - // Reset any `maxWait` timer. - lastInvokeTime = time; - // Start the timer for the trailing edge. - timerId = setTimeout(timerExpired, wait); - // Invoke the leading edge. - return leading ? invokeFunc(time) : result; - } - - function remainingWait(time) { - var timeSinceLastCall = time - lastCallTime, - timeSinceLastInvoke = time - lastInvokeTime, - timeWaiting = wait - timeSinceLastCall; - - return maxing - ? nativeMin(timeWaiting, maxWait - timeSinceLastInvoke) - : timeWaiting; - } - - function shouldInvoke(time) { - var timeSinceLastCall = time - lastCallTime, - timeSinceLastInvoke = time - lastInvokeTime; - - // Either this is the first call, activity has stopped and we're at the - // trailing edge, the system time has gone backwards and we're treating - // it as the trailing edge, or we've hit the `maxWait` limit. - return (lastCallTime === undefined || (timeSinceLastCall >= wait) || - (timeSinceLastCall < 0) || (maxing && timeSinceLastInvoke >= maxWait)); - } - - function timerExpired() { - var time = now(); - if (shouldInvoke(time)) { - return trailingEdge(time); - } - // Restart the timer. - timerId = setTimeout(timerExpired, remainingWait(time)); - } - - function trailingEdge(time) { - timerId = undefined; - - // Only invoke if we have `lastArgs` which means `func` has been - // debounced at least once. - if (trailing && lastArgs) { - return invokeFunc(time); - } - lastArgs = lastThis = undefined; - return result; - } - - function cancel() { - if (timerId !== undefined) { - clearTimeout(timerId); - } - lastInvokeTime = 0; - lastArgs = lastCallTime = lastThis = timerId = undefined; - } - - function flush() { - return timerId === undefined ? result : trailingEdge(now()); - } - - function debounced() { - var time = now(), - isInvoking = shouldInvoke(time); - - lastArgs = arguments; - lastThis = this; - lastCallTime = time; - - if (isInvoking) { - if (timerId === undefined) { - return leadingEdge(lastCallTime); - } - if (maxing) { - // Handle invocations in a tight loop. - timerId = setTimeout(timerExpired, wait); - return invokeFunc(lastCallTime); - } - } - if (timerId === undefined) { - timerId = setTimeout(timerExpired, wait); - } - return result; - } - debounced.cancel = cancel; - debounced.flush = flush; - return debounced; - } - - /** - * Defers invoking the `func` until the current call stack has cleared. Any - * additional arguments are provided to `func` when it's invoked. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {Function} func The function to defer. - * @param {...*} [args] The arguments to invoke `func` with. - * @returns {number} Returns the timer id. - * @example - * - * _.defer(function(text) { - * console.log(text); - * }, 'deferred'); - * // => Logs 'deferred' after one millisecond. - */ - var defer = baseRest(function(func, args) { - return baseDelay(func, 1, args); - }); - - /** - * Invokes `func` after `wait` milliseconds. Any additional arguments are - * provided to `func` when it's invoked. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {Function} func The function to delay. - * @param {number} wait The number of milliseconds to delay invocation. - * @param {...*} [args] The arguments to invoke `func` with. - * @returns {number} Returns the timer id. - * @example - * - * _.delay(function(text) { - * console.log(text); - * }, 1000, 'later'); - * // => Logs 'later' after one second. - */ - var delay = baseRest(function(func, wait, args) { - return baseDelay(func, toNumber(wait) || 0, args); - }); - - /** - * Creates a function that invokes `func` with arguments reversed. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Function - * @param {Function} func The function to flip arguments for. - * @returns {Function} Returns the new flipped function. - * @example - * - * var flipped = _.flip(function() { - * return _.toArray(arguments); - * }); - * - * flipped('a', 'b', 'c', 'd'); - * // => ['d', 'c', 'b', 'a'] - */ - function flip(func) { - return createWrap(func, WRAP_FLIP_FLAG); - } - - /** - * Creates a function that memoizes the result of `func`. If `resolver` is - * provided, it determines the cache key for storing the result based on the - * arguments provided to the memoized function. By default, the first argument - * provided to the memoized function is used as the map cache key. The `func` - * is invoked with the `this` binding of the memoized function. - * - * **Note:** The cache is exposed as the `cache` property on the memoized - * function. Its creation may be customized by replacing the `_.memoize.Cache` - * constructor with one whose instances implement the - * [`Map`](http://ecma-international.org/ecma-262/7.0/#sec-properties-of-the-map-prototype-object) - * method interface of `clear`, `delete`, `get`, `has`, and `set`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {Function} func The function to have its output memoized. - * @param {Function} [resolver] The function to resolve the cache key. - * @returns {Function} Returns the new memoized function. - * @example - * - * var object = { 'a': 1, 'b': 2 }; - * var other = { 'c': 3, 'd': 4 }; - * - * var values = _.memoize(_.values); - * values(object); - * // => [1, 2] - * - * values(other); - * // => [3, 4] - * - * object.a = 2; - * values(object); - * // => [1, 2] - * - * // Modify the result cache. - * values.cache.set(object, ['a', 'b']); - * values(object); - * // => ['a', 'b'] - * - * // Replace `_.memoize.Cache`. - * _.memoize.Cache = WeakMap; - */ - function memoize(func, resolver) { - if (typeof func != 'function' || (resolver != null && typeof resolver != 'function')) { - throw new TypeError(FUNC_ERROR_TEXT); - } - var memoized = function() { - var args = arguments, - key = resolver ? resolver.apply(this, args) : args[0], - cache = memoized.cache; - - if (cache.has(key)) { - return cache.get(key); - } - var result = func.apply(this, args); - memoized.cache = cache.set(key, result) || cache; - return result; - }; - memoized.cache = new (memoize.Cache || MapCache); - return memoized; - } - - // Expose `MapCache`. - memoize.Cache = MapCache; - - /** - * Creates a function that negates the result of the predicate `func`. The - * `func` predicate is invoked with the `this` binding and arguments of the - * created function. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Function - * @param {Function} predicate The predicate to negate. - * @returns {Function} Returns the new negated function. - * @example - * - * function isEven(n) { - * return n % 2 == 0; - * } - * - * _.filter([1, 2, 3, 4, 5, 6], _.negate(isEven)); - * // => [1, 3, 5] - */ - function negate(predicate) { - if (typeof predicate != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - return function() { - var args = arguments; - switch (args.length) { - case 0: return !predicate.call(this); - case 1: return !predicate.call(this, args[0]); - case 2: return !predicate.call(this, args[0], args[1]); - case 3: return !predicate.call(this, args[0], args[1], args[2]); - } - return !predicate.apply(this, args); - }; - } - - /** - * Creates a function that is restricted to invoking `func` once. Repeat calls - * to the function return the value of the first invocation. The `func` is - * invoked with the `this` binding and arguments of the created function. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {Function} func The function to restrict. - * @returns {Function} Returns the new restricted function. - * @example - * - * var initialize = _.once(createApplication); - * initialize(); - * initialize(); - * // => `createApplication` is invoked once - */ - function once(func) { - return before(2, func); - } - - /** - * Creates a function that invokes `func` with its arguments transformed. - * - * @static - * @since 4.0.0 - * @memberOf _ - * @category Function - * @param {Function} func The function to wrap. - * @param {...(Function|Function[])} [transforms=[_.identity]] - * The argument transforms. - * @returns {Function} Returns the new function. - * @example - * - * function doubled(n) { - * return n * 2; - * } - * - * function square(n) { - * return n * n; - * } - * - * var func = _.overArgs(function(x, y) { - * return [x, y]; - * }, [square, doubled]); - * - * func(9, 3); - * // => [81, 6] - * - * func(10, 5); - * // => [100, 10] - */ - var overArgs = castRest(function(func, transforms) { - transforms = (transforms.length == 1 && isArray(transforms[0])) - ? arrayMap(transforms[0], baseUnary(getIteratee())) - : arrayMap(baseFlatten(transforms, 1), baseUnary(getIteratee())); - - var funcsLength = transforms.length; - return baseRest(function(args) { - var index = -1, - length = nativeMin(args.length, funcsLength); - - while (++index < length) { - args[index] = transforms[index].call(this, args[index]); - } - return apply(func, this, args); - }); - }); - - /** - * Creates a function that invokes `func` with `partials` prepended to the - * arguments it receives. This method is like `_.bind` except it does **not** - * alter the `this` binding. - * - * The `_.partial.placeholder` value, which defaults to `_` in monolithic - * builds, may be used as a placeholder for partially applied arguments. - * - * **Note:** This method doesn't set the "length" property of partially - * applied functions. - * - * @static - * @memberOf _ - * @since 0.2.0 - * @category Function - * @param {Function} func The function to partially apply arguments to. - * @param {...*} [partials] The arguments to be partially applied. - * @returns {Function} Returns the new partially applied function. - * @example - * - * function greet(greeting, name) { - * return greeting + ' ' + name; - * } - * - * var sayHelloTo = _.partial(greet, 'hello'); - * sayHelloTo('fred'); - * // => 'hello fred' - * - * // Partially applied with placeholders. - * var greetFred = _.partial(greet, _, 'fred'); - * greetFred('hi'); - * // => 'hi fred' - */ - var partial = baseRest(function(func, partials) { - var holders = replaceHolders(partials, getHolder(partial)); - return createWrap(func, WRAP_PARTIAL_FLAG, undefined, partials, holders); - }); - - /** - * This method is like `_.partial` except that partially applied arguments - * are appended to the arguments it receives. - * - * The `_.partialRight.placeholder` value, which defaults to `_` in monolithic - * builds, may be used as a placeholder for partially applied arguments. - * - * **Note:** This method doesn't set the "length" property of partially - * applied functions. - * - * @static - * @memberOf _ - * @since 1.0.0 - * @category Function - * @param {Function} func The function to partially apply arguments to. - * @param {...*} [partials] The arguments to be partially applied. - * @returns {Function} Returns the new partially applied function. - * @example - * - * function greet(greeting, name) { - * return greeting + ' ' + name; - * } - * - * var greetFred = _.partialRight(greet, 'fred'); - * greetFred('hi'); - * // => 'hi fred' - * - * // Partially applied with placeholders. - * var sayHelloTo = _.partialRight(greet, 'hello', _); - * sayHelloTo('fred'); - * // => 'hello fred' - */ - var partialRight = baseRest(function(func, partials) { - var holders = replaceHolders(partials, getHolder(partialRight)); - return createWrap(func, WRAP_PARTIAL_RIGHT_FLAG, undefined, partials, holders); - }); - - /** - * Creates a function that invokes `func` with arguments arranged according - * to the specified `indexes` where the argument value at the first index is - * provided as the first argument, the argument value at the second index is - * provided as the second argument, and so on. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Function - * @param {Function} func The function to rearrange arguments for. - * @param {...(number|number[])} indexes The arranged argument indexes. - * @returns {Function} Returns the new function. - * @example - * - * var rearged = _.rearg(function(a, b, c) { - * return [a, b, c]; - * }, [2, 0, 1]); - * - * rearged('b', 'c', 'a') - * // => ['a', 'b', 'c'] - */ - var rearg = flatRest(function(func, indexes) { - return createWrap(func, WRAP_REARG_FLAG, undefined, undefined, undefined, indexes); - }); - - /** - * Creates a function that invokes `func` with the `this` binding of the - * created function and arguments from `start` and beyond provided as - * an array. - * - * **Note:** This method is based on the - * [rest parameter](https://mdn.io/rest_parameters). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Function - * @param {Function} func The function to apply a rest parameter to. - * @param {number} [start=func.length-1] The start position of the rest parameter. - * @returns {Function} Returns the new function. - * @example - * - * var say = _.rest(function(what, names) { - * return what + ' ' + _.initial(names).join(', ') + - * (_.size(names) > 1 ? ', & ' : '') + _.last(names); - * }); - * - * say('hello', 'fred', 'barney', 'pebbles'); - * // => 'hello fred, barney, & pebbles' - */ - function rest(func, start) { - if (typeof func != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - start = start === undefined ? start : toInteger(start); - return baseRest(func, start); - } - - /** - * Creates a function that invokes `func` with the `this` binding of the - * create function and an array of arguments much like - * [`Function#apply`](http://www.ecma-international.org/ecma-262/7.0/#sec-function.prototype.apply). - * - * **Note:** This method is based on the - * [spread operator](https://mdn.io/spread_operator). - * - * @static - * @memberOf _ - * @since 3.2.0 - * @category Function - * @param {Function} func The function to spread arguments over. - * @param {number} [start=0] The start position of the spread. - * @returns {Function} Returns the new function. - * @example - * - * var say = _.spread(function(who, what) { - * return who + ' says ' + what; - * }); - * - * say(['fred', 'hello']); - * // => 'fred says hello' - * - * var numbers = Promise.all([ - * Promise.resolve(40), - * Promise.resolve(36) - * ]); - * - * numbers.then(_.spread(function(x, y) { - * return x + y; - * })); - * // => a Promise of 76 - */ - function spread(func, start) { - if (typeof func != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - start = start == null ? 0 : nativeMax(toInteger(start), 0); - return baseRest(function(args) { - var array = args[start], - otherArgs = castSlice(args, 0, start); - - if (array) { - arrayPush(otherArgs, array); - } - return apply(func, this, otherArgs); - }); - } - - /** - * Creates a throttled function that only invokes `func` at most once per - * every `wait` milliseconds. The throttled function comes with a `cancel` - * method to cancel delayed `func` invocations and a `flush` method to - * immediately invoke them. Provide `options` to indicate whether `func` - * should be invoked on the leading and/or trailing edge of the `wait` - * timeout. The `func` is invoked with the last arguments provided to the - * throttled function. Subsequent calls to the throttled function return the - * result of the last `func` invocation. - * - * **Note:** If `leading` and `trailing` options are `true`, `func` is - * invoked on the trailing edge of the timeout only if the throttled function - * is invoked more than once during the `wait` timeout. - * - * If `wait` is `0` and `leading` is `false`, `func` invocation is deferred - * until to the next tick, similar to `setTimeout` with a timeout of `0`. - * - * See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/) - * for details over the differences between `_.throttle` and `_.debounce`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {Function} func The function to throttle. - * @param {number} [wait=0] The number of milliseconds to throttle invocations to. - * @param {Object} [options={}] The options object. - * @param {boolean} [options.leading=true] - * Specify invoking on the leading edge of the timeout. - * @param {boolean} [options.trailing=true] - * Specify invoking on the trailing edge of the timeout. - * @returns {Function} Returns the new throttled function. - * @example - * - * // Avoid excessively updating the position while scrolling. - * jQuery(window).on('scroll', _.throttle(updatePosition, 100)); - * - * // Invoke `renewToken` when the click event is fired, but not more than once every 5 minutes. - * var throttled = _.throttle(renewToken, 300000, { 'trailing': false }); - * jQuery(element).on('click', throttled); - * - * // Cancel the trailing throttled invocation. - * jQuery(window).on('popstate', throttled.cancel); - */ - function throttle(func, wait, options) { - var leading = true, - trailing = true; - - if (typeof func != 'function') { - throw new TypeError(FUNC_ERROR_TEXT); - } - if (isObject(options)) { - leading = 'leading' in options ? !!options.leading : leading; - trailing = 'trailing' in options ? !!options.trailing : trailing; - } - return debounce(func, wait, { - 'leading': leading, - 'maxWait': wait, - 'trailing': trailing - }); - } - - /** - * Creates a function that accepts up to one argument, ignoring any - * additional arguments. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Function - * @param {Function} func The function to cap arguments for. - * @returns {Function} Returns the new capped function. - * @example - * - * _.map(['6', '8', '10'], _.unary(parseInt)); - * // => [6, 8, 10] - */ - function unary(func) { - return ary(func, 1); - } - - /** - * Creates a function that provides `value` to `wrapper` as its first - * argument. Any additional arguments provided to the function are appended - * to those provided to the `wrapper`. The wrapper is invoked with the `this` - * binding of the created function. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {*} value The value to wrap. - * @param {Function} [wrapper=identity] The wrapper function. - * @returns {Function} Returns the new function. - * @example - * - * var p = _.wrap(_.escape, function(func, text) { - * return '

' + func(text) + '

'; - * }); - * - * p('fred, barney, & pebbles'); - * // => '

fred, barney, & pebbles

' - */ - function wrap(value, wrapper) { - return partial(castFunction(wrapper), value); - } - - /*------------------------------------------------------------------------*/ - - /** - * Casts `value` as an array if it's not one. - * - * @static - * @memberOf _ - * @since 4.4.0 - * @category Lang - * @param {*} value The value to inspect. - * @returns {Array} Returns the cast array. - * @example - * - * _.castArray(1); - * // => [1] - * - * _.castArray({ 'a': 1 }); - * // => [{ 'a': 1 }] - * - * _.castArray('abc'); - * // => ['abc'] - * - * _.castArray(null); - * // => [null] - * - * _.castArray(undefined); - * // => [undefined] - * - * _.castArray(); - * // => [] - * - * var array = [1, 2, 3]; - * console.log(_.castArray(array) === array); - * // => true - */ - function castArray() { - if (!arguments.length) { - return []; - } - var value = arguments[0]; - return isArray(value) ? value : [value]; - } - - /** - * Creates a shallow clone of `value`. - * - * **Note:** This method is loosely based on the - * [structured clone algorithm](https://mdn.io/Structured_clone_algorithm) - * and supports cloning arrays, array buffers, booleans, date objects, maps, - * numbers, `Object` objects, regexes, sets, strings, symbols, and typed - * arrays. The own enumerable properties of `arguments` objects are cloned - * as plain objects. An empty object is returned for uncloneable values such - * as error objects, functions, DOM nodes, and WeakMaps. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to clone. - * @returns {*} Returns the cloned value. - * @see _.cloneDeep - * @example - * - * var objects = [{ 'a': 1 }, { 'b': 2 }]; - * - * var shallow = _.clone(objects); - * console.log(shallow[0] === objects[0]); - * // => true - */ - function clone(value) { - return baseClone(value, CLONE_SYMBOLS_FLAG); - } - - /** - * This method is like `_.clone` except that it accepts `customizer` which - * is invoked to produce the cloned value. If `customizer` returns `undefined`, - * cloning is handled by the method instead. The `customizer` is invoked with - * up to four arguments; (value [, index|key, object, stack]). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to clone. - * @param {Function} [customizer] The function to customize cloning. - * @returns {*} Returns the cloned value. - * @see _.cloneDeepWith - * @example - * - * function customizer(value) { - * if (_.isElement(value)) { - * return value.cloneNode(false); - * } - * } - * - * var el = _.cloneWith(document.body, customizer); - * - * console.log(el === document.body); - * // => false - * console.log(el.nodeName); - * // => 'BODY' - * console.log(el.childNodes.length); - * // => 0 - */ - function cloneWith(value, customizer) { - customizer = typeof customizer == 'function' ? customizer : undefined; - return baseClone(value, CLONE_SYMBOLS_FLAG, customizer); - } - - /** - * This method is like `_.clone` except that it recursively clones `value`. - * - * @static - * @memberOf _ - * @since 1.0.0 - * @category Lang - * @param {*} value The value to recursively clone. - * @returns {*} Returns the deep cloned value. - * @see _.clone - * @example - * - * var objects = [{ 'a': 1 }, { 'b': 2 }]; - * - * var deep = _.cloneDeep(objects); - * console.log(deep[0] === objects[0]); - * // => false - */ - function cloneDeep(value) { - return baseClone(value, CLONE_DEEP_FLAG | CLONE_SYMBOLS_FLAG); - } - - /** - * This method is like `_.cloneWith` except that it recursively clones `value`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to recursively clone. - * @param {Function} [customizer] The function to customize cloning. - * @returns {*} Returns the deep cloned value. - * @see _.cloneWith - * @example - * - * function customizer(value) { - * if (_.isElement(value)) { - * return value.cloneNode(true); - * } - * } - * - * var el = _.cloneDeepWith(document.body, customizer); - * - * console.log(el === document.body); - * // => false - * console.log(el.nodeName); - * // => 'BODY' - * console.log(el.childNodes.length); - * // => 20 - */ - function cloneDeepWith(value, customizer) { - customizer = typeof customizer == 'function' ? customizer : undefined; - return baseClone(value, CLONE_DEEP_FLAG | CLONE_SYMBOLS_FLAG, customizer); - } - - /** - * Checks if `object` conforms to `source` by invoking the predicate - * properties of `source` with the corresponding property values of `object`. - * - * **Note:** This method is equivalent to `_.conforms` when `source` is - * partially applied. - * - * @static - * @memberOf _ - * @since 4.14.0 - * @category Lang - * @param {Object} object The object to inspect. - * @param {Object} source The object of property predicates to conform to. - * @returns {boolean} Returns `true` if `object` conforms, else `false`. - * @example - * - * var object = { 'a': 1, 'b': 2 }; - * - * _.conformsTo(object, { 'b': function(n) { return n > 1; } }); - * // => true - * - * _.conformsTo(object, { 'b': function(n) { return n > 2; } }); - * // => false - */ - function conformsTo(object, source) { - return source == null || baseConformsTo(object, source, keys(source)); - } - - /** - * Performs a - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * comparison between two values to determine if they are equivalent. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if the values are equivalent, else `false`. - * @example - * - * var object = { 'a': 1 }; - * var other = { 'a': 1 }; - * - * _.eq(object, object); - * // => true - * - * _.eq(object, other); - * // => false - * - * _.eq('a', 'a'); - * // => true - * - * _.eq('a', Object('a')); - * // => false - * - * _.eq(NaN, NaN); - * // => true - */ - function eq(value, other) { - return value === other || (value !== value && other !== other); - } - - /** - * Checks if `value` is greater than `other`. - * - * @static - * @memberOf _ - * @since 3.9.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if `value` is greater than `other`, - * else `false`. - * @see _.lt - * @example - * - * _.gt(3, 1); - * // => true - * - * _.gt(3, 3); - * // => false - * - * _.gt(1, 3); - * // => false - */ - var gt = createRelationalOperation(baseGt); - - /** - * Checks if `value` is greater than or equal to `other`. - * - * @static - * @memberOf _ - * @since 3.9.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if `value` is greater than or equal to - * `other`, else `false`. - * @see _.lte - * @example - * - * _.gte(3, 1); - * // => true - * - * _.gte(3, 3); - * // => true - * - * _.gte(1, 3); - * // => false - */ - var gte = createRelationalOperation(function(value, other) { - return value >= other; - }); - - /** - * Checks if `value` is likely an `arguments` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an `arguments` object, - * else `false`. - * @example - * - * _.isArguments(function() { return arguments; }()); - * // => true - * - * _.isArguments([1, 2, 3]); - * // => false - */ - var isArguments = baseIsArguments(function() { return arguments; }()) ? baseIsArguments : function(value) { - return isObjectLike(value) && hasOwnProperty.call(value, 'callee') && - !propertyIsEnumerable.call(value, 'callee'); - }; - - /** - * Checks if `value` is classified as an `Array` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an array, else `false`. - * @example - * - * _.isArray([1, 2, 3]); - * // => true - * - * _.isArray(document.body.children); - * // => false - * - * _.isArray('abc'); - * // => false - * - * _.isArray(_.noop); - * // => false - */ - var isArray = Array.isArray; - - /** - * Checks if `value` is classified as an `ArrayBuffer` object. - * - * @static - * @memberOf _ - * @since 4.3.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an array buffer, else `false`. - * @example - * - * _.isArrayBuffer(new ArrayBuffer(2)); - * // => true - * - * _.isArrayBuffer(new Array(2)); - * // => false - */ - var isArrayBuffer = nodeIsArrayBuffer ? baseUnary(nodeIsArrayBuffer) : baseIsArrayBuffer; - - /** - * Checks if `value` is array-like. A value is considered array-like if it's - * not a function and has a `value.length` that's an integer greater than or - * equal to `0` and less than or equal to `Number.MAX_SAFE_INTEGER`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is array-like, else `false`. - * @example - * - * _.isArrayLike([1, 2, 3]); - * // => true - * - * _.isArrayLike(document.body.children); - * // => true - * - * _.isArrayLike('abc'); - * // => true - * - * _.isArrayLike(_.noop); - * // => false - */ - function isArrayLike(value) { - return value != null && isLength(value.length) && !isFunction(value); - } - - /** - * This method is like `_.isArrayLike` except that it also checks if `value` - * is an object. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an array-like object, - * else `false`. - * @example - * - * _.isArrayLikeObject([1, 2, 3]); - * // => true - * - * _.isArrayLikeObject(document.body.children); - * // => true - * - * _.isArrayLikeObject('abc'); - * // => false - * - * _.isArrayLikeObject(_.noop); - * // => false - */ - function isArrayLikeObject(value) { - return isObjectLike(value) && isArrayLike(value); - } - - /** - * Checks if `value` is classified as a boolean primitive or object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a boolean, else `false`. - * @example - * - * _.isBoolean(false); - * // => true - * - * _.isBoolean(null); - * // => false - */ - function isBoolean(value) { - return value === true || value === false || - (isObjectLike(value) && baseGetTag(value) == boolTag); - } - - /** - * Checks if `value` is a buffer. - * - * @static - * @memberOf _ - * @since 4.3.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a buffer, else `false`. - * @example - * - * _.isBuffer(new Buffer(2)); - * // => true - * - * _.isBuffer(new Uint8Array(2)); - * // => false - */ - var isBuffer = nativeIsBuffer || stubFalse; - - /** - * Checks if `value` is classified as a `Date` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a date object, else `false`. - * @example - * - * _.isDate(new Date); - * // => true - * - * _.isDate('Mon April 23 2012'); - * // => false - */ - var isDate = nodeIsDate ? baseUnary(nodeIsDate) : baseIsDate; - - /** - * Checks if `value` is likely a DOM element. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a DOM element, else `false`. - * @example - * - * _.isElement(document.body); - * // => true - * - * _.isElement(''); - * // => false - */ - function isElement(value) { - return isObjectLike(value) && value.nodeType === 1 && !isPlainObject(value); - } - - /** - * Checks if `value` is an empty object, collection, map, or set. - * - * Objects are considered empty if they have no own enumerable string keyed - * properties. - * - * Array-like values such as `arguments` objects, arrays, buffers, strings, or - * jQuery-like collections are considered empty if they have a `length` of `0`. - * Similarly, maps and sets are considered empty if they have a `size` of `0`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is empty, else `false`. - * @example - * - * _.isEmpty(null); - * // => true - * - * _.isEmpty(true); - * // => true - * - * _.isEmpty(1); - * // => true - * - * _.isEmpty([1, 2, 3]); - * // => false - * - * _.isEmpty({ 'a': 1 }); - * // => false - */ - function isEmpty(value) { - if (value == null) { - return true; - } - if (isArrayLike(value) && - (isArray(value) || typeof value == 'string' || typeof value.splice == 'function' || - isBuffer(value) || isTypedArray(value) || isArguments(value))) { - return !value.length; - } - var tag = getTag(value); - if (tag == mapTag || tag == setTag) { - return !value.size; - } - if (isPrototype(value)) { - return !baseKeys(value).length; - } - for (var key in value) { - if (hasOwnProperty.call(value, key)) { - return false; - } - } - return true; - } - - /** - * Performs a deep comparison between two values to determine if they are - * equivalent. - * - * **Note:** This method supports comparing arrays, array buffers, booleans, - * date objects, error objects, maps, numbers, `Object` objects, regexes, - * sets, strings, symbols, and typed arrays. `Object` objects are compared - * by their own, not inherited, enumerable properties. Functions and DOM - * nodes are compared by strict equality, i.e. `===`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if the values are equivalent, else `false`. - * @example - * - * var object = { 'a': 1 }; - * var other = { 'a': 1 }; - * - * _.isEqual(object, other); - * // => true - * - * object === other; - * // => false - */ - function isEqual(value, other) { - return baseIsEqual(value, other); - } - - /** - * This method is like `_.isEqual` except that it accepts `customizer` which - * is invoked to compare values. If `customizer` returns `undefined`, comparisons - * are handled by the method instead. The `customizer` is invoked with up to - * six arguments: (objValue, othValue [, index|key, object, other, stack]). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @param {Function} [customizer] The function to customize comparisons. - * @returns {boolean} Returns `true` if the values are equivalent, else `false`. - * @example - * - * function isGreeting(value) { - * return /^h(?:i|ello)$/.test(value); - * } - * - * function customizer(objValue, othValue) { - * if (isGreeting(objValue) && isGreeting(othValue)) { - * return true; - * } - * } - * - * var array = ['hello', 'goodbye']; - * var other = ['hi', 'goodbye']; - * - * _.isEqualWith(array, other, customizer); - * // => true - */ - function isEqualWith(value, other, customizer) { - customizer = typeof customizer == 'function' ? customizer : undefined; - var result = customizer ? customizer(value, other) : undefined; - return result === undefined ? baseIsEqual(value, other, undefined, customizer) : !!result; - } - - /** - * Checks if `value` is an `Error`, `EvalError`, `RangeError`, `ReferenceError`, - * `SyntaxError`, `TypeError`, or `URIError` object. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an error object, else `false`. - * @example - * - * _.isError(new Error); - * // => true - * - * _.isError(Error); - * // => false - */ - function isError(value) { - if (!isObjectLike(value)) { - return false; - } - var tag = baseGetTag(value); - return tag == errorTag || tag == domExcTag || - (typeof value.message == 'string' && typeof value.name == 'string' && !isPlainObject(value)); - } - - /** - * Checks if `value` is a finite primitive number. - * - * **Note:** This method is based on - * [`Number.isFinite`](https://mdn.io/Number/isFinite). - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a finite number, else `false`. - * @example - * - * _.isFinite(3); - * // => true - * - * _.isFinite(Number.MIN_VALUE); - * // => true - * - * _.isFinite(Infinity); - * // => false - * - * _.isFinite('3'); - * // => false - */ - function isFinite(value) { - return typeof value == 'number' && nativeIsFinite(value); - } - - /** - * Checks if `value` is classified as a `Function` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a function, else `false`. - * @example - * - * _.isFunction(_); - * // => true - * - * _.isFunction(/abc/); - * // => false - */ - function isFunction(value) { - if (!isObject(value)) { - return false; - } - // The use of `Object#toString` avoids issues with the `typeof` operator - // in Safari 9 which returns 'object' for typed arrays and other constructors. - var tag = baseGetTag(value); - return tag == funcTag || tag == genTag || tag == asyncTag || tag == proxyTag; - } - - /** - * Checks if `value` is an integer. - * - * **Note:** This method is based on - * [`Number.isInteger`](https://mdn.io/Number/isInteger). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an integer, else `false`. - * @example - * - * _.isInteger(3); - * // => true - * - * _.isInteger(Number.MIN_VALUE); - * // => false - * - * _.isInteger(Infinity); - * // => false - * - * _.isInteger('3'); - * // => false - */ - function isInteger(value) { - return typeof value == 'number' && value == toInteger(value); - } - - /** - * Checks if `value` is a valid array-like length. - * - * **Note:** This method is loosely based on - * [`ToLength`](http://ecma-international.org/ecma-262/7.0/#sec-tolength). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a valid length, else `false`. - * @example - * - * _.isLength(3); - * // => true - * - * _.isLength(Number.MIN_VALUE); - * // => false - * - * _.isLength(Infinity); - * // => false - * - * _.isLength('3'); - * // => false - */ - function isLength(value) { - return typeof value == 'number' && - value > -1 && value % 1 == 0 && value <= MAX_SAFE_INTEGER; - } - - /** - * Checks if `value` is the - * [language type](http://www.ecma-international.org/ecma-262/7.0/#sec-ecmascript-language-types) - * of `Object`. (e.g. arrays, functions, objects, regexes, `new Number(0)`, and `new String('')`) - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an object, else `false`. - * @example - * - * _.isObject({}); - * // => true - * - * _.isObject([1, 2, 3]); - * // => true - * - * _.isObject(_.noop); - * // => true - * - * _.isObject(null); - * // => false - */ - function isObject(value) { - var type = typeof value; - return value != null && (type == 'object' || type == 'function'); - } - - /** - * Checks if `value` is object-like. A value is object-like if it's not `null` - * and has a `typeof` result of "object". - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is object-like, else `false`. - * @example - * - * _.isObjectLike({}); - * // => true - * - * _.isObjectLike([1, 2, 3]); - * // => true - * - * _.isObjectLike(_.noop); - * // => false - * - * _.isObjectLike(null); - * // => false - */ - function isObjectLike(value) { - return value != null && typeof value == 'object'; - } - - /** - * Checks if `value` is classified as a `Map` object. - * - * @static - * @memberOf _ - * @since 4.3.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a map, else `false`. - * @example - * - * _.isMap(new Map); - * // => true - * - * _.isMap(new WeakMap); - * // => false - */ - var isMap = nodeIsMap ? baseUnary(nodeIsMap) : baseIsMap; - - /** - * Performs a partial deep comparison between `object` and `source` to - * determine if `object` contains equivalent property values. - * - * **Note:** This method is equivalent to `_.matches` when `source` is - * partially applied. - * - * Partial comparisons will match empty array and empty object `source` - * values against any array or object value, respectively. See `_.isEqual` - * for a list of supported value comparisons. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Lang - * @param {Object} object The object to inspect. - * @param {Object} source The object of property values to match. - * @returns {boolean} Returns `true` if `object` is a match, else `false`. - * @example - * - * var object = { 'a': 1, 'b': 2 }; - * - * _.isMatch(object, { 'b': 2 }); - * // => true - * - * _.isMatch(object, { 'b': 1 }); - * // => false - */ - function isMatch(object, source) { - return object === source || baseIsMatch(object, source, getMatchData(source)); - } - - /** - * This method is like `_.isMatch` except that it accepts `customizer` which - * is invoked to compare values. If `customizer` returns `undefined`, comparisons - * are handled by the method instead. The `customizer` is invoked with five - * arguments: (objValue, srcValue, index|key, object, source). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {Object} object The object to inspect. - * @param {Object} source The object of property values to match. - * @param {Function} [customizer] The function to customize comparisons. - * @returns {boolean} Returns `true` if `object` is a match, else `false`. - * @example - * - * function isGreeting(value) { - * return /^h(?:i|ello)$/.test(value); - * } - * - * function customizer(objValue, srcValue) { - * if (isGreeting(objValue) && isGreeting(srcValue)) { - * return true; - * } - * } - * - * var object = { 'greeting': 'hello' }; - * var source = { 'greeting': 'hi' }; - * - * _.isMatchWith(object, source, customizer); - * // => true - */ - function isMatchWith(object, source, customizer) { - customizer = typeof customizer == 'function' ? customizer : undefined; - return baseIsMatch(object, source, getMatchData(source), customizer); - } - - /** - * Checks if `value` is `NaN`. - * - * **Note:** This method is based on - * [`Number.isNaN`](https://mdn.io/Number/isNaN) and is not the same as - * global [`isNaN`](https://mdn.io/isNaN) which returns `true` for - * `undefined` and other non-number values. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is `NaN`, else `false`. - * @example - * - * _.isNaN(NaN); - * // => true - * - * _.isNaN(new Number(NaN)); - * // => true - * - * isNaN(undefined); - * // => true - * - * _.isNaN(undefined); - * // => false - */ - function isNaN(value) { - // An `NaN` primitive is the only value that is not equal to itself. - // Perform the `toStringTag` check first to avoid errors with some - // ActiveX objects in IE. - return isNumber(value) && value != +value; - } - - /** - * Checks if `value` is a pristine native function. - * - * **Note:** This method can't reliably detect native functions in the presence - * of the core-js package because core-js circumvents this kind of detection. - * Despite multiple requests, the core-js maintainer has made it clear: any - * attempt to fix the detection will be obstructed. As a result, we're left - * with little choice but to throw an error. Unfortunately, this also affects - * packages, like [babel-polyfill](https://www.npmjs.com/package/babel-polyfill), - * which rely on core-js. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a native function, - * else `false`. - * @example - * - * _.isNative(Array.prototype.push); - * // => true - * - * _.isNative(_); - * // => false - */ - function isNative(value) { - if (isMaskable(value)) { - throw new Error(CORE_ERROR_TEXT); - } - return baseIsNative(value); - } - - /** - * Checks if `value` is `null`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is `null`, else `false`. - * @example - * - * _.isNull(null); - * // => true - * - * _.isNull(void 0); - * // => false - */ - function isNull(value) { - return value === null; - } - - /** - * Checks if `value` is `null` or `undefined`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is nullish, else `false`. - * @example - * - * _.isNil(null); - * // => true - * - * _.isNil(void 0); - * // => true - * - * _.isNil(NaN); - * // => false - */ - function isNil(value) { - return value == null; - } - - /** - * Checks if `value` is classified as a `Number` primitive or object. - * - * **Note:** To exclude `Infinity`, `-Infinity`, and `NaN`, which are - * classified as numbers, use the `_.isFinite` method. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a number, else `false`. - * @example - * - * _.isNumber(3); - * // => true - * - * _.isNumber(Number.MIN_VALUE); - * // => true - * - * _.isNumber(Infinity); - * // => true - * - * _.isNumber('3'); - * // => false - */ - function isNumber(value) { - return typeof value == 'number' || - (isObjectLike(value) && baseGetTag(value) == numberTag); - } - - /** - * Checks if `value` is a plain object, that is, an object created by the - * `Object` constructor or one with a `[[Prototype]]` of `null`. - * - * @static - * @memberOf _ - * @since 0.8.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a plain object, else `false`. - * @example - * - * function Foo() { - * this.a = 1; - * } - * - * _.isPlainObject(new Foo); - * // => false - * - * _.isPlainObject([1, 2, 3]); - * // => false - * - * _.isPlainObject({ 'x': 0, 'y': 0 }); - * // => true - * - * _.isPlainObject(Object.create(null)); - * // => true - */ - function isPlainObject(value) { - if (!isObjectLike(value) || baseGetTag(value) != objectTag) { - return false; - } - var proto = getPrototype(value); - if (proto === null) { - return true; - } - var Ctor = hasOwnProperty.call(proto, 'constructor') && proto.constructor; - return typeof Ctor == 'function' && Ctor instanceof Ctor && - funcToString.call(Ctor) == objectCtorString; - } - - /** - * Checks if `value` is classified as a `RegExp` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a regexp, else `false`. - * @example - * - * _.isRegExp(/abc/); - * // => true - * - * _.isRegExp('/abc/'); - * // => false - */ - var isRegExp = nodeIsRegExp ? baseUnary(nodeIsRegExp) : baseIsRegExp; - - /** - * Checks if `value` is a safe integer. An integer is safe if it's an IEEE-754 - * double precision number which isn't the result of a rounded unsafe integer. - * - * **Note:** This method is based on - * [`Number.isSafeInteger`](https://mdn.io/Number/isSafeInteger). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a safe integer, else `false`. - * @example - * - * _.isSafeInteger(3); - * // => true - * - * _.isSafeInteger(Number.MIN_VALUE); - * // => false - * - * _.isSafeInteger(Infinity); - * // => false - * - * _.isSafeInteger('3'); - * // => false - */ - function isSafeInteger(value) { - return isInteger(value) && value >= -MAX_SAFE_INTEGER && value <= MAX_SAFE_INTEGER; - } - - /** - * Checks if `value` is classified as a `Set` object. - * - * @static - * @memberOf _ - * @since 4.3.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a set, else `false`. - * @example - * - * _.isSet(new Set); - * // => true - * - * _.isSet(new WeakSet); - * // => false - */ - var isSet = nodeIsSet ? baseUnary(nodeIsSet) : baseIsSet; - - /** - * Checks if `value` is classified as a `String` primitive or object. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a string, else `false`. - * @example - * - * _.isString('abc'); - * // => true - * - * _.isString(1); - * // => false - */ - function isString(value) { - return typeof value == 'string' || - (!isArray(value) && isObjectLike(value) && baseGetTag(value) == stringTag); - } - - /** - * Checks if `value` is classified as a `Symbol` primitive or object. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a symbol, else `false`. - * @example - * - * _.isSymbol(Symbol.iterator); - * // => true - * - * _.isSymbol('abc'); - * // => false - */ - function isSymbol(value) { - return typeof value == 'symbol' || - (isObjectLike(value) && baseGetTag(value) == symbolTag); - } - - /** - * Checks if `value` is classified as a typed array. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a typed array, else `false`. - * @example - * - * _.isTypedArray(new Uint8Array); - * // => true - * - * _.isTypedArray([]); - * // => false - */ - var isTypedArray = nodeIsTypedArray ? baseUnary(nodeIsTypedArray) : baseIsTypedArray; - - /** - * Checks if `value` is `undefined`. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is `undefined`, else `false`. - * @example - * - * _.isUndefined(void 0); - * // => true - * - * _.isUndefined(null); - * // => false - */ - function isUndefined(value) { - return value === undefined; - } - - /** - * Checks if `value` is classified as a `WeakMap` object. - * - * @static - * @memberOf _ - * @since 4.3.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a weak map, else `false`. - * @example - * - * _.isWeakMap(new WeakMap); - * // => true - * - * _.isWeakMap(new Map); - * // => false - */ - function isWeakMap(value) { - return isObjectLike(value) && getTag(value) == weakMapTag; - } - - /** - * Checks if `value` is classified as a `WeakSet` object. - * - * @static - * @memberOf _ - * @since 4.3.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a weak set, else `false`. - * @example - * - * _.isWeakSet(new WeakSet); - * // => true - * - * _.isWeakSet(new Set); - * // => false - */ - function isWeakSet(value) { - return isObjectLike(value) && baseGetTag(value) == weakSetTag; - } - - /** - * Checks if `value` is less than `other`. - * - * @static - * @memberOf _ - * @since 3.9.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if `value` is less than `other`, - * else `false`. - * @see _.gt - * @example - * - * _.lt(1, 3); - * // => true - * - * _.lt(3, 3); - * // => false - * - * _.lt(3, 1); - * // => false - */ - var lt = createRelationalOperation(baseLt); - - /** - * Checks if `value` is less than or equal to `other`. - * - * @static - * @memberOf _ - * @since 3.9.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if `value` is less than or equal to - * `other`, else `false`. - * @see _.gte - * @example - * - * _.lte(1, 3); - * // => true - * - * _.lte(3, 3); - * // => true - * - * _.lte(3, 1); - * // => false - */ - var lte = createRelationalOperation(function(value, other) { - return value <= other; - }); - - /** - * Converts `value` to an array. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Lang - * @param {*} value The value to convert. - * @returns {Array} Returns the converted array. - * @example - * - * _.toArray({ 'a': 1, 'b': 2 }); - * // => [1, 2] - * - * _.toArray('abc'); - * // => ['a', 'b', 'c'] - * - * _.toArray(1); - * // => [] - * - * _.toArray(null); - * // => [] - */ - function toArray(value) { - if (!value) { - return []; - } - if (isArrayLike(value)) { - return isString(value) ? stringToArray(value) : copyArray(value); - } - if (symIterator && value[symIterator]) { - return iteratorToArray(value[symIterator]()); - } - var tag = getTag(value), - func = tag == mapTag ? mapToArray : (tag == setTag ? setToArray : values); - - return func(value); - } - - /** - * Converts `value` to a finite number. - * - * @static - * @memberOf _ - * @since 4.12.0 - * @category Lang - * @param {*} value The value to convert. - * @returns {number} Returns the converted number. - * @example - * - * _.toFinite(3.2); - * // => 3.2 - * - * _.toFinite(Number.MIN_VALUE); - * // => 5e-324 - * - * _.toFinite(Infinity); - * // => 1.7976931348623157e+308 - * - * _.toFinite('3.2'); - * // => 3.2 - */ - function toFinite(value) { - if (!value) { - return value === 0 ? value : 0; - } - value = toNumber(value); - if (value === INFINITY || value === -INFINITY) { - var sign = (value < 0 ? -1 : 1); - return sign * MAX_INTEGER; - } - return value === value ? value : 0; - } - - /** - * Converts `value` to an integer. - * - * **Note:** This method is loosely based on - * [`ToInteger`](http://www.ecma-international.org/ecma-262/7.0/#sec-tointeger). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to convert. - * @returns {number} Returns the converted integer. - * @example - * - * _.toInteger(3.2); - * // => 3 - * - * _.toInteger(Number.MIN_VALUE); - * // => 0 - * - * _.toInteger(Infinity); - * // => 1.7976931348623157e+308 - * - * _.toInteger('3.2'); - * // => 3 - */ - function toInteger(value) { - var result = toFinite(value), - remainder = result % 1; - - return result === result ? (remainder ? result - remainder : result) : 0; - } - - /** - * Converts `value` to an integer suitable for use as the length of an - * array-like object. - * - * **Note:** This method is based on - * [`ToLength`](http://ecma-international.org/ecma-262/7.0/#sec-tolength). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to convert. - * @returns {number} Returns the converted integer. - * @example - * - * _.toLength(3.2); - * // => 3 - * - * _.toLength(Number.MIN_VALUE); - * // => 0 - * - * _.toLength(Infinity); - * // => 4294967295 - * - * _.toLength('3.2'); - * // => 3 - */ - function toLength(value) { - return value ? baseClamp(toInteger(value), 0, MAX_ARRAY_LENGTH) : 0; - } - - /** - * Converts `value` to a number. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to process. - * @returns {number} Returns the number. - * @example - * - * _.toNumber(3.2); - * // => 3.2 - * - * _.toNumber(Number.MIN_VALUE); - * // => 5e-324 - * - * _.toNumber(Infinity); - * // => Infinity - * - * _.toNumber('3.2'); - * // => 3.2 - */ - function toNumber(value) { - if (typeof value == 'number') { - return value; - } - if (isSymbol(value)) { - return NAN; - } - if (isObject(value)) { - var other = typeof value.valueOf == 'function' ? value.valueOf() : value; - value = isObject(other) ? (other + '') : other; - } - if (typeof value != 'string') { - return value === 0 ? value : +value; - } - value = value.replace(reTrim, ''); - var isBinary = reIsBinary.test(value); - return (isBinary || reIsOctal.test(value)) - ? freeParseInt(value.slice(2), isBinary ? 2 : 8) - : (reIsBadHex.test(value) ? NAN : +value); - } - - /** - * Converts `value` to a plain object flattening inherited enumerable string - * keyed properties of `value` to own properties of the plain object. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Lang - * @param {*} value The value to convert. - * @returns {Object} Returns the converted plain object. - * @example - * - * function Foo() { - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.assign({ 'a': 1 }, new Foo); - * // => { 'a': 1, 'b': 2 } - * - * _.assign({ 'a': 1 }, _.toPlainObject(new Foo)); - * // => { 'a': 1, 'b': 2, 'c': 3 } - */ - function toPlainObject(value) { - return copyObject(value, keysIn(value)); - } - - /** - * Converts `value` to a safe integer. A safe integer can be compared and - * represented correctly. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to convert. - * @returns {number} Returns the converted integer. - * @example - * - * _.toSafeInteger(3.2); - * // => 3 - * - * _.toSafeInteger(Number.MIN_VALUE); - * // => 0 - * - * _.toSafeInteger(Infinity); - * // => 9007199254740991 - * - * _.toSafeInteger('3.2'); - * // => 3 - */ - function toSafeInteger(value) { - return value - ? baseClamp(toInteger(value), -MAX_SAFE_INTEGER, MAX_SAFE_INTEGER) - : (value === 0 ? value : 0); - } - - /** - * Converts `value` to a string. An empty string is returned for `null` - * and `undefined` values. The sign of `-0` is preserved. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to convert. - * @returns {string} Returns the converted string. - * @example - * - * _.toString(null); - * // => '' - * - * _.toString(-0); - * // => '-0' - * - * _.toString([1, 2, 3]); - * // => '1,2,3' - */ - function toString(value) { - return value == null ? '' : baseToString(value); - } - - /*------------------------------------------------------------------------*/ - - /** - * Assigns own enumerable string keyed properties of source objects to the - * destination object. Source objects are applied from left to right. - * Subsequent sources overwrite property assignments of previous sources. - * - * **Note:** This method mutates `object` and is loosely based on - * [`Object.assign`](https://mdn.io/Object/assign). - * - * @static - * @memberOf _ - * @since 0.10.0 - * @category Object - * @param {Object} object The destination object. - * @param {...Object} [sources] The source objects. - * @returns {Object} Returns `object`. - * @see _.assignIn - * @example - * - * function Foo() { - * this.a = 1; - * } - * - * function Bar() { - * this.c = 3; - * } - * - * Foo.prototype.b = 2; - * Bar.prototype.d = 4; - * - * _.assign({ 'a': 0 }, new Foo, new Bar); - * // => { 'a': 1, 'c': 3 } - */ - var assign = createAssigner(function(object, source) { - if (isPrototype(source) || isArrayLike(source)) { - copyObject(source, keys(source), object); - return; - } - for (var key in source) { - if (hasOwnProperty.call(source, key)) { - assignValue(object, key, source[key]); - } - } - }); - - /** - * This method is like `_.assign` except that it iterates over own and - * inherited source properties. - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @alias extend - * @category Object - * @param {Object} object The destination object. - * @param {...Object} [sources] The source objects. - * @returns {Object} Returns `object`. - * @see _.assign - * @example - * - * function Foo() { - * this.a = 1; - * } - * - * function Bar() { - * this.c = 3; - * } - * - * Foo.prototype.b = 2; - * Bar.prototype.d = 4; - * - * _.assignIn({ 'a': 0 }, new Foo, new Bar); - * // => { 'a': 1, 'b': 2, 'c': 3, 'd': 4 } - */ - var assignIn = createAssigner(function(object, source) { - copyObject(source, keysIn(source), object); - }); - - /** - * This method is like `_.assignIn` except that it accepts `customizer` - * which is invoked to produce the assigned values. If `customizer` returns - * `undefined`, assignment is handled by the method instead. The `customizer` - * is invoked with five arguments: (objValue, srcValue, key, object, source). - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @alias extendWith - * @category Object - * @param {Object} object The destination object. - * @param {...Object} sources The source objects. - * @param {Function} [customizer] The function to customize assigned values. - * @returns {Object} Returns `object`. - * @see _.assignWith - * @example - * - * function customizer(objValue, srcValue) { - * return _.isUndefined(objValue) ? srcValue : objValue; - * } - * - * var defaults = _.partialRight(_.assignInWith, customizer); - * - * defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 }); - * // => { 'a': 1, 'b': 2 } - */ - var assignInWith = createAssigner(function(object, source, srcIndex, customizer) { - copyObject(source, keysIn(source), object, customizer); - }); - - /** - * This method is like `_.assign` except that it accepts `customizer` - * which is invoked to produce the assigned values. If `customizer` returns - * `undefined`, assignment is handled by the method instead. The `customizer` - * is invoked with five arguments: (objValue, srcValue, key, object, source). - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Object - * @param {Object} object The destination object. - * @param {...Object} sources The source objects. - * @param {Function} [customizer] The function to customize assigned values. - * @returns {Object} Returns `object`. - * @see _.assignInWith - * @example - * - * function customizer(objValue, srcValue) { - * return _.isUndefined(objValue) ? srcValue : objValue; - * } - * - * var defaults = _.partialRight(_.assignWith, customizer); - * - * defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 }); - * // => { 'a': 1, 'b': 2 } - */ - var assignWith = createAssigner(function(object, source, srcIndex, customizer) { - copyObject(source, keys(source), object, customizer); - }); - - /** - * Creates an array of values corresponding to `paths` of `object`. - * - * @static - * @memberOf _ - * @since 1.0.0 - * @category Object - * @param {Object} object The object to iterate over. - * @param {...(string|string[])} [paths] The property paths to pick. - * @returns {Array} Returns the picked values. - * @example - * - * var object = { 'a': [{ 'b': { 'c': 3 } }, 4] }; - * - * _.at(object, ['a[0].b.c', 'a[1]']); - * // => [3, 4] - */ - var at = flatRest(baseAt); - - /** - * Creates an object that inherits from the `prototype` object. If a - * `properties` object is given, its own enumerable string keyed properties - * are assigned to the created object. - * - * @static - * @memberOf _ - * @since 2.3.0 - * @category Object - * @param {Object} prototype The object to inherit from. - * @param {Object} [properties] The properties to assign to the object. - * @returns {Object} Returns the new object. - * @example - * - * function Shape() { - * this.x = 0; - * this.y = 0; - * } - * - * function Circle() { - * Shape.call(this); - * } - * - * Circle.prototype = _.create(Shape.prototype, { - * 'constructor': Circle - * }); - * - * var circle = new Circle; - * circle instanceof Circle; - * // => true - * - * circle instanceof Shape; - * // => true - */ - function create(prototype, properties) { - var result = baseCreate(prototype); - return properties == null ? result : baseAssign(result, properties); - } - - /** - * Assigns own and inherited enumerable string keyed properties of source - * objects to the destination object for all destination properties that - * resolve to `undefined`. Source objects are applied from left to right. - * Once a property is set, additional values of the same property are ignored. - * - * **Note:** This method mutates `object`. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Object - * @param {Object} object The destination object. - * @param {...Object} [sources] The source objects. - * @returns {Object} Returns `object`. - * @see _.defaultsDeep - * @example - * - * _.defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 }); - * // => { 'a': 1, 'b': 2 } - */ - var defaults = baseRest(function(object, sources) { - object = Object(object); - - var index = -1; - var length = sources.length; - var guard = length > 2 ? sources[2] : undefined; - - if (guard && isIterateeCall(sources[0], sources[1], guard)) { - length = 1; - } - - while (++index < length) { - var source = sources[index]; - var props = keysIn(source); - var propsIndex = -1; - var propsLength = props.length; - - while (++propsIndex < propsLength) { - var key = props[propsIndex]; - var value = object[key]; - - if (value === undefined || - (eq(value, objectProto[key]) && !hasOwnProperty.call(object, key))) { - object[key] = source[key]; - } - } - } - - return object; - }); - - /** - * This method is like `_.defaults` except that it recursively assigns - * default properties. - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 3.10.0 - * @category Object - * @param {Object} object The destination object. - * @param {...Object} [sources] The source objects. - * @returns {Object} Returns `object`. - * @see _.defaults - * @example - * - * _.defaultsDeep({ 'a': { 'b': 2 } }, { 'a': { 'b': 1, 'c': 3 } }); - * // => { 'a': { 'b': 2, 'c': 3 } } - */ - var defaultsDeep = baseRest(function(args) { - args.push(undefined, customDefaultsMerge); - return apply(mergeWith, undefined, args); - }); - - /** - * This method is like `_.find` except that it returns the key of the first - * element `predicate` returns truthy for instead of the element itself. - * - * @static - * @memberOf _ - * @since 1.1.0 - * @category Object - * @param {Object} object The object to inspect. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {string|undefined} Returns the key of the matched element, - * else `undefined`. - * @example - * - * var users = { - * 'barney': { 'age': 36, 'active': true }, - * 'fred': { 'age': 40, 'active': false }, - * 'pebbles': { 'age': 1, 'active': true } - * }; - * - * _.findKey(users, function(o) { return o.age < 40; }); - * // => 'barney' (iteration order is not guaranteed) - * - * // The `_.matches` iteratee shorthand. - * _.findKey(users, { 'age': 1, 'active': true }); - * // => 'pebbles' - * - * // The `_.matchesProperty` iteratee shorthand. - * _.findKey(users, ['active', false]); - * // => 'fred' - * - * // The `_.property` iteratee shorthand. - * _.findKey(users, 'active'); - * // => 'barney' - */ - function findKey(object, predicate) { - return baseFindKey(object, getIteratee(predicate, 3), baseForOwn); - } - - /** - * This method is like `_.findKey` except that it iterates over elements of - * a collection in the opposite order. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @category Object - * @param {Object} object The object to inspect. - * @param {Function} [predicate=_.identity] The function invoked per iteration. - * @returns {string|undefined} Returns the key of the matched element, - * else `undefined`. - * @example - * - * var users = { - * 'barney': { 'age': 36, 'active': true }, - * 'fred': { 'age': 40, 'active': false }, - * 'pebbles': { 'age': 1, 'active': true } - * }; - * - * _.findLastKey(users, function(o) { return o.age < 40; }); - * // => returns 'pebbles' assuming `_.findKey` returns 'barney' - * - * // The `_.matches` iteratee shorthand. - * _.findLastKey(users, { 'age': 36, 'active': true }); - * // => 'barney' - * - * // The `_.matchesProperty` iteratee shorthand. - * _.findLastKey(users, ['active', false]); - * // => 'fred' - * - * // The `_.property` iteratee shorthand. - * _.findLastKey(users, 'active'); - * // => 'pebbles' - */ - function findLastKey(object, predicate) { - return baseFindKey(object, getIteratee(predicate, 3), baseForOwnRight); - } - - /** - * Iterates over own and inherited enumerable string keyed properties of an - * object and invokes `iteratee` for each property. The iteratee is invoked - * with three arguments: (value, key, object). Iteratee functions may exit - * iteration early by explicitly returning `false`. - * - * @static - * @memberOf _ - * @since 0.3.0 - * @category Object - * @param {Object} object The object to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Object} Returns `object`. - * @see _.forInRight - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.forIn(new Foo, function(value, key) { - * console.log(key); - * }); - * // => Logs 'a', 'b', then 'c' (iteration order is not guaranteed). - */ - function forIn(object, iteratee) { - return object == null - ? object - : baseFor(object, getIteratee(iteratee, 3), keysIn); - } - - /** - * This method is like `_.forIn` except that it iterates over properties of - * `object` in the opposite order. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @category Object - * @param {Object} object The object to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Object} Returns `object`. - * @see _.forIn - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.forInRight(new Foo, function(value, key) { - * console.log(key); - * }); - * // => Logs 'c', 'b', then 'a' assuming `_.forIn` logs 'a', 'b', then 'c'. - */ - function forInRight(object, iteratee) { - return object == null - ? object - : baseForRight(object, getIteratee(iteratee, 3), keysIn); - } - - /** - * Iterates over own enumerable string keyed properties of an object and - * invokes `iteratee` for each property. The iteratee is invoked with three - * arguments: (value, key, object). Iteratee functions may exit iteration - * early by explicitly returning `false`. - * - * @static - * @memberOf _ - * @since 0.3.0 - * @category Object - * @param {Object} object The object to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Object} Returns `object`. - * @see _.forOwnRight - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.forOwn(new Foo, function(value, key) { - * console.log(key); - * }); - * // => Logs 'a' then 'b' (iteration order is not guaranteed). - */ - function forOwn(object, iteratee) { - return object && baseForOwn(object, getIteratee(iteratee, 3)); - } - - /** - * This method is like `_.forOwn` except that it iterates over properties of - * `object` in the opposite order. - * - * @static - * @memberOf _ - * @since 2.0.0 - * @category Object - * @param {Object} object The object to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Object} Returns `object`. - * @see _.forOwn - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.forOwnRight(new Foo, function(value, key) { - * console.log(key); - * }); - * // => Logs 'b' then 'a' assuming `_.forOwn` logs 'a' then 'b'. - */ - function forOwnRight(object, iteratee) { - return object && baseForOwnRight(object, getIteratee(iteratee, 3)); - } - - /** - * Creates an array of function property names from own enumerable properties - * of `object`. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Object - * @param {Object} object The object to inspect. - * @returns {Array} Returns the function names. - * @see _.functionsIn - * @example - * - * function Foo() { - * this.a = _.constant('a'); - * this.b = _.constant('b'); - * } - * - * Foo.prototype.c = _.constant('c'); - * - * _.functions(new Foo); - * // => ['a', 'b'] - */ - function functions(object) { - return object == null ? [] : baseFunctions(object, keys(object)); - } - - /** - * Creates an array of function property names from own and inherited - * enumerable properties of `object`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Object - * @param {Object} object The object to inspect. - * @returns {Array} Returns the function names. - * @see _.functions - * @example - * - * function Foo() { - * this.a = _.constant('a'); - * this.b = _.constant('b'); - * } - * - * Foo.prototype.c = _.constant('c'); - * - * _.functionsIn(new Foo); - * // => ['a', 'b', 'c'] - */ - function functionsIn(object) { - return object == null ? [] : baseFunctions(object, keysIn(object)); - } - - /** - * Gets the value at `path` of `object`. If the resolved value is - * `undefined`, the `defaultValue` is returned in its place. - * - * @static - * @memberOf _ - * @since 3.7.0 - * @category Object - * @param {Object} object The object to query. - * @param {Array|string} path The path of the property to get. - * @param {*} [defaultValue] The value returned for `undefined` resolved values. - * @returns {*} Returns the resolved value. - * @example - * - * var object = { 'a': [{ 'b': { 'c': 3 } }] }; - * - * _.get(object, 'a[0].b.c'); - * // => 3 - * - * _.get(object, ['a', '0', 'b', 'c']); - * // => 3 - * - * _.get(object, 'a.b.c', 'default'); - * // => 'default' - */ - function get(object, path, defaultValue) { - var result = object == null ? undefined : baseGet(object, path); - return result === undefined ? defaultValue : result; - } - - /** - * Checks if `path` is a direct property of `object`. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Object - * @param {Object} object The object to query. - * @param {Array|string} path The path to check. - * @returns {boolean} Returns `true` if `path` exists, else `false`. - * @example - * - * var object = { 'a': { 'b': 2 } }; - * var other = _.create({ 'a': _.create({ 'b': 2 }) }); - * - * _.has(object, 'a'); - * // => true - * - * _.has(object, 'a.b'); - * // => true - * - * _.has(object, ['a', 'b']); - * // => true - * - * _.has(other, 'a'); - * // => false - */ - function has(object, path) { - return object != null && hasPath(object, path, baseHas); - } - - /** - * Checks if `path` is a direct or inherited property of `object`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Object - * @param {Object} object The object to query. - * @param {Array|string} path The path to check. - * @returns {boolean} Returns `true` if `path` exists, else `false`. - * @example - * - * var object = _.create({ 'a': _.create({ 'b': 2 }) }); - * - * _.hasIn(object, 'a'); - * // => true - * - * _.hasIn(object, 'a.b'); - * // => true - * - * _.hasIn(object, ['a', 'b']); - * // => true - * - * _.hasIn(object, 'b'); - * // => false - */ - function hasIn(object, path) { - return object != null && hasPath(object, path, baseHasIn); - } - - /** - * Creates an object composed of the inverted keys and values of `object`. - * If `object` contains duplicate values, subsequent values overwrite - * property assignments of previous values. - * - * @static - * @memberOf _ - * @since 0.7.0 - * @category Object - * @param {Object} object The object to invert. - * @returns {Object} Returns the new inverted object. - * @example - * - * var object = { 'a': 1, 'b': 2, 'c': 1 }; - * - * _.invert(object); - * // => { '1': 'c', '2': 'b' } - */ - var invert = createInverter(function(result, value, key) { - if (value != null && - typeof value.toString != 'function') { - value = nativeObjectToString.call(value); - } - - result[value] = key; - }, constant(identity)); - - /** - * This method is like `_.invert` except that the inverted object is generated - * from the results of running each element of `object` thru `iteratee`. The - * corresponding inverted value of each inverted key is an array of keys - * responsible for generating the inverted value. The iteratee is invoked - * with one argument: (value). - * - * @static - * @memberOf _ - * @since 4.1.0 - * @category Object - * @param {Object} object The object to invert. - * @param {Function} [iteratee=_.identity] The iteratee invoked per element. - * @returns {Object} Returns the new inverted object. - * @example - * - * var object = { 'a': 1, 'b': 2, 'c': 1 }; - * - * _.invertBy(object); - * // => { '1': ['a', 'c'], '2': ['b'] } - * - * _.invertBy(object, function(value) { - * return 'group' + value; - * }); - * // => { 'group1': ['a', 'c'], 'group2': ['b'] } - */ - var invertBy = createInverter(function(result, value, key) { - if (value != null && - typeof value.toString != 'function') { - value = nativeObjectToString.call(value); - } - - if (hasOwnProperty.call(result, value)) { - result[value].push(key); - } else { - result[value] = [key]; - } - }, getIteratee); - - /** - * Invokes the method at `path` of `object`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Object - * @param {Object} object The object to query. - * @param {Array|string} path The path of the method to invoke. - * @param {...*} [args] The arguments to invoke the method with. - * @returns {*} Returns the result of the invoked method. - * @example - * - * var object = { 'a': [{ 'b': { 'c': [1, 2, 3, 4] } }] }; - * - * _.invoke(object, 'a[0].b.c.slice', 1, 3); - * // => [2, 3] - */ - var invoke = baseRest(baseInvoke); - - /** - * Creates an array of the own enumerable property names of `object`. - * - * **Note:** Non-object values are coerced to objects. See the - * [ES spec](http://ecma-international.org/ecma-262/7.0/#sec-object.keys) - * for more details. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Object - * @param {Object} object The object to query. - * @returns {Array} Returns the array of property names. - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.keys(new Foo); - * // => ['a', 'b'] (iteration order is not guaranteed) - * - * _.keys('hi'); - * // => ['0', '1'] - */ - function keys(object) { - return isArrayLike(object) ? arrayLikeKeys(object) : baseKeys(object); - } - - /** - * Creates an array of the own and inherited enumerable property names of `object`. - * - * **Note:** Non-object values are coerced to objects. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Object - * @param {Object} object The object to query. - * @returns {Array} Returns the array of property names. - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.keysIn(new Foo); - * // => ['a', 'b', 'c'] (iteration order is not guaranteed) - */ - function keysIn(object) { - return isArrayLike(object) ? arrayLikeKeys(object, true) : baseKeysIn(object); - } - - /** - * The opposite of `_.mapValues`; this method creates an object with the - * same values as `object` and keys generated by running each own enumerable - * string keyed property of `object` thru `iteratee`. The iteratee is invoked - * with three arguments: (value, key, object). - * - * @static - * @memberOf _ - * @since 3.8.0 - * @category Object - * @param {Object} object The object to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Object} Returns the new mapped object. - * @see _.mapValues - * @example - * - * _.mapKeys({ 'a': 1, 'b': 2 }, function(value, key) { - * return key + value; - * }); - * // => { 'a1': 1, 'b2': 2 } - */ - function mapKeys(object, iteratee) { - var result = {}; - iteratee = getIteratee(iteratee, 3); - - baseForOwn(object, function(value, key, object) { - baseAssignValue(result, iteratee(value, key, object), value); - }); - return result; - } - - /** - * Creates an object with the same keys as `object` and values generated - * by running each own enumerable string keyed property of `object` thru - * `iteratee`. The iteratee is invoked with three arguments: - * (value, key, object). - * - * @static - * @memberOf _ - * @since 2.4.0 - * @category Object - * @param {Object} object The object to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @returns {Object} Returns the new mapped object. - * @see _.mapKeys - * @example - * - * var users = { - * 'fred': { 'user': 'fred', 'age': 40 }, - * 'pebbles': { 'user': 'pebbles', 'age': 1 } - * }; - * - * _.mapValues(users, function(o) { return o.age; }); - * // => { 'fred': 40, 'pebbles': 1 } (iteration order is not guaranteed) - * - * // The `_.property` iteratee shorthand. - * _.mapValues(users, 'age'); - * // => { 'fred': 40, 'pebbles': 1 } (iteration order is not guaranteed) - */ - function mapValues(object, iteratee) { - var result = {}; - iteratee = getIteratee(iteratee, 3); - - baseForOwn(object, function(value, key, object) { - baseAssignValue(result, key, iteratee(value, key, object)); - }); - return result; - } - - /** - * This method is like `_.assign` except that it recursively merges own and - * inherited enumerable string keyed properties of source objects into the - * destination object. Source properties that resolve to `undefined` are - * skipped if a destination value exists. Array and plain object properties - * are merged recursively. Other objects and value types are overridden by - * assignment. Source objects are applied from left to right. Subsequent - * sources overwrite property assignments of previous sources. - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 0.5.0 - * @category Object - * @param {Object} object The destination object. - * @param {...Object} [sources] The source objects. - * @returns {Object} Returns `object`. - * @example - * - * var object = { - * 'a': [{ 'b': 2 }, { 'd': 4 }] - * }; - * - * var other = { - * 'a': [{ 'c': 3 }, { 'e': 5 }] - * }; - * - * _.merge(object, other); - * // => { 'a': [{ 'b': 2, 'c': 3 }, { 'd': 4, 'e': 5 }] } - */ - var merge = createAssigner(function(object, source, srcIndex) { - baseMerge(object, source, srcIndex); - }); - - /** - * This method is like `_.merge` except that it accepts `customizer` which - * is invoked to produce the merged values of the destination and source - * properties. If `customizer` returns `undefined`, merging is handled by the - * method instead. The `customizer` is invoked with six arguments: - * (objValue, srcValue, key, object, source, stack). - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Object - * @param {Object} object The destination object. - * @param {...Object} sources The source objects. - * @param {Function} customizer The function to customize assigned values. - * @returns {Object} Returns `object`. - * @example - * - * function customizer(objValue, srcValue) { - * if (_.isArray(objValue)) { - * return objValue.concat(srcValue); - * } - * } - * - * var object = { 'a': [1], 'b': [2] }; - * var other = { 'a': [3], 'b': [4] }; - * - * _.mergeWith(object, other, customizer); - * // => { 'a': [1, 3], 'b': [2, 4] } - */ - var mergeWith = createAssigner(function(object, source, srcIndex, customizer) { - baseMerge(object, source, srcIndex, customizer); - }); - - /** - * The opposite of `_.pick`; this method creates an object composed of the - * own and inherited enumerable property paths of `object` that are not omitted. - * - * **Note:** This method is considerably slower than `_.pick`. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Object - * @param {Object} object The source object. - * @param {...(string|string[])} [paths] The property paths to omit. - * @returns {Object} Returns the new object. - * @example - * - * var object = { 'a': 1, 'b': '2', 'c': 3 }; - * - * _.omit(object, ['a', 'c']); - * // => { 'b': '2' } - */ - var omit = flatRest(function(object, paths) { - var result = {}; - if (object == null) { - return result; - } - var isDeep = false; - paths = arrayMap(paths, function(path) { - path = castPath(path, object); - isDeep || (isDeep = path.length > 1); - return path; - }); - copyObject(object, getAllKeysIn(object), result); - if (isDeep) { - result = baseClone(result, CLONE_DEEP_FLAG | CLONE_FLAT_FLAG | CLONE_SYMBOLS_FLAG, customOmitClone); - } - var length = paths.length; - while (length--) { - baseUnset(result, paths[length]); - } - return result; - }); - - /** - * The opposite of `_.pickBy`; this method creates an object composed of - * the own and inherited enumerable string keyed properties of `object` that - * `predicate` doesn't return truthy for. The predicate is invoked with two - * arguments: (value, key). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Object - * @param {Object} object The source object. - * @param {Function} [predicate=_.identity] The function invoked per property. - * @returns {Object} Returns the new object. - * @example - * - * var object = { 'a': 1, 'b': '2', 'c': 3 }; - * - * _.omitBy(object, _.isNumber); - * // => { 'b': '2' } - */ - function omitBy(object, predicate) { - return pickBy(object, negate(getIteratee(predicate))); - } - - /** - * Creates an object composed of the picked `object` properties. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Object - * @param {Object} object The source object. - * @param {...(string|string[])} [paths] The property paths to pick. - * @returns {Object} Returns the new object. - * @example - * - * var object = { 'a': 1, 'b': '2', 'c': 3 }; - * - * _.pick(object, ['a', 'c']); - * // => { 'a': 1, 'c': 3 } - */ - var pick = flatRest(function(object, paths) { - return object == null ? {} : basePick(object, paths); - }); - - /** - * Creates an object composed of the `object` properties `predicate` returns - * truthy for. The predicate is invoked with two arguments: (value, key). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Object - * @param {Object} object The source object. - * @param {Function} [predicate=_.identity] The function invoked per property. - * @returns {Object} Returns the new object. - * @example - * - * var object = { 'a': 1, 'b': '2', 'c': 3 }; - * - * _.pickBy(object, _.isNumber); - * // => { 'a': 1, 'c': 3 } - */ - function pickBy(object, predicate) { - if (object == null) { - return {}; - } - var props = arrayMap(getAllKeysIn(object), function(prop) { - return [prop]; - }); - predicate = getIteratee(predicate); - return basePickBy(object, props, function(value, path) { - return predicate(value, path[0]); - }); - } - - /** - * This method is like `_.get` except that if the resolved value is a - * function it's invoked with the `this` binding of its parent object and - * its result is returned. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Object - * @param {Object} object The object to query. - * @param {Array|string} path The path of the property to resolve. - * @param {*} [defaultValue] The value returned for `undefined` resolved values. - * @returns {*} Returns the resolved value. - * @example - * - * var object = { 'a': [{ 'b': { 'c1': 3, 'c2': _.constant(4) } }] }; - * - * _.result(object, 'a[0].b.c1'); - * // => 3 - * - * _.result(object, 'a[0].b.c2'); - * // => 4 - * - * _.result(object, 'a[0].b.c3', 'default'); - * // => 'default' - * - * _.result(object, 'a[0].b.c3', _.constant('default')); - * // => 'default' - */ - function result(object, path, defaultValue) { - path = castPath(path, object); - - var index = -1, - length = path.length; - - // Ensure the loop is entered when path is empty. - if (!length) { - length = 1; - object = undefined; - } - while (++index < length) { - var value = object == null ? undefined : object[toKey(path[index])]; - if (value === undefined) { - index = length; - value = defaultValue; - } - object = isFunction(value) ? value.call(object) : value; - } - return object; - } - - /** - * Sets the value at `path` of `object`. If a portion of `path` doesn't exist, - * it's created. Arrays are created for missing index properties while objects - * are created for all other missing properties. Use `_.setWith` to customize - * `path` creation. - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 3.7.0 - * @category Object - * @param {Object} object The object to modify. - * @param {Array|string} path The path of the property to set. - * @param {*} value The value to set. - * @returns {Object} Returns `object`. - * @example - * - * var object = { 'a': [{ 'b': { 'c': 3 } }] }; - * - * _.set(object, 'a[0].b.c', 4); - * console.log(object.a[0].b.c); - * // => 4 - * - * _.set(object, ['x', '0', 'y', 'z'], 5); - * console.log(object.x[0].y.z); - * // => 5 - */ - function set(object, path, value) { - return object == null ? object : baseSet(object, path, value); - } - - /** - * This method is like `_.set` except that it accepts `customizer` which is - * invoked to produce the objects of `path`. If `customizer` returns `undefined` - * path creation is handled by the method instead. The `customizer` is invoked - * with three arguments: (nsValue, key, nsObject). - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Object - * @param {Object} object The object to modify. - * @param {Array|string} path The path of the property to set. - * @param {*} value The value to set. - * @param {Function} [customizer] The function to customize assigned values. - * @returns {Object} Returns `object`. - * @example - * - * var object = {}; - * - * _.setWith(object, '[0][1]', 'a', Object); - * // => { '0': { '1': 'a' } } - */ - function setWith(object, path, value, customizer) { - customizer = typeof customizer == 'function' ? customizer : undefined; - return object == null ? object : baseSet(object, path, value, customizer); - } - - /** - * Creates an array of own enumerable string keyed-value pairs for `object` - * which can be consumed by `_.fromPairs`. If `object` is a map or set, its - * entries are returned. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @alias entries - * @category Object - * @param {Object} object The object to query. - * @returns {Array} Returns the key-value pairs. - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.toPairs(new Foo); - * // => [['a', 1], ['b', 2]] (iteration order is not guaranteed) - */ - var toPairs = createToPairs(keys); - - /** - * Creates an array of own and inherited enumerable string keyed-value pairs - * for `object` which can be consumed by `_.fromPairs`. If `object` is a map - * or set, its entries are returned. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @alias entriesIn - * @category Object - * @param {Object} object The object to query. - * @returns {Array} Returns the key-value pairs. - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.toPairsIn(new Foo); - * // => [['a', 1], ['b', 2], ['c', 3]] (iteration order is not guaranteed) - */ - var toPairsIn = createToPairs(keysIn); - - /** - * An alternative to `_.reduce`; this method transforms `object` to a new - * `accumulator` object which is the result of running each of its own - * enumerable string keyed properties thru `iteratee`, with each invocation - * potentially mutating the `accumulator` object. If `accumulator` is not - * provided, a new object with the same `[[Prototype]]` will be used. The - * iteratee is invoked with four arguments: (accumulator, value, key, object). - * Iteratee functions may exit iteration early by explicitly returning `false`. - * - * @static - * @memberOf _ - * @since 1.3.0 - * @category Object - * @param {Object} object The object to iterate over. - * @param {Function} [iteratee=_.identity] The function invoked per iteration. - * @param {*} [accumulator] The custom accumulator value. - * @returns {*} Returns the accumulated value. - * @example - * - * _.transform([2, 3, 4], function(result, n) { - * result.push(n *= n); - * return n % 2 == 0; - * }, []); - * // => [4, 9] - * - * _.transform({ 'a': 1, 'b': 2, 'c': 1 }, function(result, value, key) { - * (result[value] || (result[value] = [])).push(key); - * }, {}); - * // => { '1': ['a', 'c'], '2': ['b'] } - */ - function transform(object, iteratee, accumulator) { - var isArr = isArray(object), - isArrLike = isArr || isBuffer(object) || isTypedArray(object); - - iteratee = getIteratee(iteratee, 4); - if (accumulator == null) { - var Ctor = object && object.constructor; - if (isArrLike) { - accumulator = isArr ? new Ctor : []; - } - else if (isObject(object)) { - accumulator = isFunction(Ctor) ? baseCreate(getPrototype(object)) : {}; - } - else { - accumulator = {}; - } - } - (isArrLike ? arrayEach : baseForOwn)(object, function(value, index, object) { - return iteratee(accumulator, value, index, object); - }); - return accumulator; - } - - /** - * Removes the property at `path` of `object`. - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Object - * @param {Object} object The object to modify. - * @param {Array|string} path The path of the property to unset. - * @returns {boolean} Returns `true` if the property is deleted, else `false`. - * @example - * - * var object = { 'a': [{ 'b': { 'c': 7 } }] }; - * _.unset(object, 'a[0].b.c'); - * // => true - * - * console.log(object); - * // => { 'a': [{ 'b': {} }] }; - * - * _.unset(object, ['a', '0', 'b', 'c']); - * // => true - * - * console.log(object); - * // => { 'a': [{ 'b': {} }] }; - */ - function unset(object, path) { - return object == null ? true : baseUnset(object, path); - } - - /** - * This method is like `_.set` except that accepts `updater` to produce the - * value to set. Use `_.updateWith` to customize `path` creation. The `updater` - * is invoked with one argument: (value). - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 4.6.0 - * @category Object - * @param {Object} object The object to modify. - * @param {Array|string} path The path of the property to set. - * @param {Function} updater The function to produce the updated value. - * @returns {Object} Returns `object`. - * @example - * - * var object = { 'a': [{ 'b': { 'c': 3 } }] }; - * - * _.update(object, 'a[0].b.c', function(n) { return n * n; }); - * console.log(object.a[0].b.c); - * // => 9 - * - * _.update(object, 'x[0].y.z', function(n) { return n ? n + 1 : 0; }); - * console.log(object.x[0].y.z); - * // => 0 - */ - function update(object, path, updater) { - return object == null ? object : baseUpdate(object, path, castFunction(updater)); - } - - /** - * This method is like `_.update` except that it accepts `customizer` which is - * invoked to produce the objects of `path`. If `customizer` returns `undefined` - * path creation is handled by the method instead. The `customizer` is invoked - * with three arguments: (nsValue, key, nsObject). - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 4.6.0 - * @category Object - * @param {Object} object The object to modify. - * @param {Array|string} path The path of the property to set. - * @param {Function} updater The function to produce the updated value. - * @param {Function} [customizer] The function to customize assigned values. - * @returns {Object} Returns `object`. - * @example - * - * var object = {}; - * - * _.updateWith(object, '[0][1]', _.constant('a'), Object); - * // => { '0': { '1': 'a' } } - */ - function updateWith(object, path, updater, customizer) { - customizer = typeof customizer == 'function' ? customizer : undefined; - return object == null ? object : baseUpdate(object, path, castFunction(updater), customizer); - } - - /** - * Creates an array of the own enumerable string keyed property values of `object`. - * - * **Note:** Non-object values are coerced to objects. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category Object - * @param {Object} object The object to query. - * @returns {Array} Returns the array of property values. - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.values(new Foo); - * // => [1, 2] (iteration order is not guaranteed) - * - * _.values('hi'); - * // => ['h', 'i'] - */ - function values(object) { - return object == null ? [] : baseValues(object, keys(object)); - } - - /** - * Creates an array of the own and inherited enumerable string keyed property - * values of `object`. - * - * **Note:** Non-object values are coerced to objects. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category Object - * @param {Object} object The object to query. - * @returns {Array} Returns the array of property values. - * @example - * - * function Foo() { - * this.a = 1; - * this.b = 2; - * } - * - * Foo.prototype.c = 3; - * - * _.valuesIn(new Foo); - * // => [1, 2, 3] (iteration order is not guaranteed) - */ - function valuesIn(object) { - return object == null ? [] : baseValues(object, keysIn(object)); - } - - /*------------------------------------------------------------------------*/ - - /** - * Clamps `number` within the inclusive `lower` and `upper` bounds. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Number - * @param {number} number The number to clamp. - * @param {number} [lower] The lower bound. - * @param {number} upper The upper bound. - * @returns {number} Returns the clamped number. - * @example - * - * _.clamp(-10, -5, 5); - * // => -5 - * - * _.clamp(10, -5, 5); - * // => 5 - */ - function clamp(number, lower, upper) { - if (upper === undefined) { - upper = lower; - lower = undefined; - } - if (upper !== undefined) { - upper = toNumber(upper); - upper = upper === upper ? upper : 0; - } - if (lower !== undefined) { - lower = toNumber(lower); - lower = lower === lower ? lower : 0; - } - return baseClamp(toNumber(number), lower, upper); - } - - /** - * Checks if `n` is between `start` and up to, but not including, `end`. If - * `end` is not specified, it's set to `start` with `start` then set to `0`. - * If `start` is greater than `end` the params are swapped to support - * negative ranges. - * - * @static - * @memberOf _ - * @since 3.3.0 - * @category Number - * @param {number} number The number to check. - * @param {number} [start=0] The start of the range. - * @param {number} end The end of the range. - * @returns {boolean} Returns `true` if `number` is in the range, else `false`. - * @see _.range, _.rangeRight - * @example - * - * _.inRange(3, 2, 4); - * // => true - * - * _.inRange(4, 8); - * // => true - * - * _.inRange(4, 2); - * // => false - * - * _.inRange(2, 2); - * // => false - * - * _.inRange(1.2, 2); - * // => true - * - * _.inRange(5.2, 4); - * // => false - * - * _.inRange(-3, -2, -6); - * // => true - */ - function inRange(number, start, end) { - start = toFinite(start); - if (end === undefined) { - end = start; - start = 0; - } else { - end = toFinite(end); - } - number = toNumber(number); - return baseInRange(number, start, end); - } - - /** - * Produces a random number between the inclusive `lower` and `upper` bounds. - * If only one argument is provided a number between `0` and the given number - * is returned. If `floating` is `true`, or either `lower` or `upper` are - * floats, a floating-point number is returned instead of an integer. - * - * **Note:** JavaScript follows the IEEE-754 standard for resolving - * floating-point values which can produce unexpected results. - * - * @static - * @memberOf _ - * @since 0.7.0 - * @category Number - * @param {number} [lower=0] The lower bound. - * @param {number} [upper=1] The upper bound. - * @param {boolean} [floating] Specify returning a floating-point number. - * @returns {number} Returns the random number. - * @example - * - * _.random(0, 5); - * // => an integer between 0 and 5 - * - * _.random(5); - * // => also an integer between 0 and 5 - * - * _.random(5, true); - * // => a floating-point number between 0 and 5 - * - * _.random(1.2, 5.2); - * // => a floating-point number between 1.2 and 5.2 - */ - function random(lower, upper, floating) { - if (floating && typeof floating != 'boolean' && isIterateeCall(lower, upper, floating)) { - upper = floating = undefined; - } - if (floating === undefined) { - if (typeof upper == 'boolean') { - floating = upper; - upper = undefined; - } - else if (typeof lower == 'boolean') { - floating = lower; - lower = undefined; - } - } - if (lower === undefined && upper === undefined) { - lower = 0; - upper = 1; - } - else { - lower = toFinite(lower); - if (upper === undefined) { - upper = lower; - lower = 0; - } else { - upper = toFinite(upper); - } - } - if (lower > upper) { - var temp = lower; - lower = upper; - upper = temp; - } - if (floating || lower % 1 || upper % 1) { - var rand = nativeRandom(); - return nativeMin(lower + (rand * (upper - lower + freeParseFloat('1e-' + ((rand + '').length - 1)))), upper); - } - return baseRandom(lower, upper); - } - - /*------------------------------------------------------------------------*/ - - /** - * Converts `string` to [camel case](https://en.wikipedia.org/wiki/CamelCase). - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to convert. - * @returns {string} Returns the camel cased string. - * @example - * - * _.camelCase('Foo Bar'); - * // => 'fooBar' - * - * _.camelCase('--foo-bar--'); - * // => 'fooBar' - * - * _.camelCase('__FOO_BAR__'); - * // => 'fooBar' - */ - var camelCase = createCompounder(function(result, word, index) { - word = word.toLowerCase(); - return result + (index ? capitalize(word) : word); - }); - - /** - * Converts the first character of `string` to upper case and the remaining - * to lower case. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to capitalize. - * @returns {string} Returns the capitalized string. - * @example - * - * _.capitalize('FRED'); - * // => 'Fred' - */ - function capitalize(string) { - return upperFirst(toString(string).toLowerCase()); - } - - /** - * Deburrs `string` by converting - * [Latin-1 Supplement](https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)#Character_table) - * and [Latin Extended-A](https://en.wikipedia.org/wiki/Latin_Extended-A) - * letters to basic Latin letters and removing - * [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks). - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to deburr. - * @returns {string} Returns the deburred string. - * @example - * - * _.deburr('déjà vu'); - * // => 'deja vu' - */ - function deburr(string) { - string = toString(string); - return string && string.replace(reLatin, deburrLetter).replace(reComboMark, ''); - } - - /** - * Checks if `string` ends with the given target string. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to inspect. - * @param {string} [target] The string to search for. - * @param {number} [position=string.length] The position to search up to. - * @returns {boolean} Returns `true` if `string` ends with `target`, - * else `false`. - * @example - * - * _.endsWith('abc', 'c'); - * // => true - * - * _.endsWith('abc', 'b'); - * // => false - * - * _.endsWith('abc', 'b', 2); - * // => true - */ - function endsWith(string, target, position) { - string = toString(string); - target = baseToString(target); - - var length = string.length; - position = position === undefined - ? length - : baseClamp(toInteger(position), 0, length); - - var end = position; - position -= target.length; - return position >= 0 && string.slice(position, end) == target; - } - - /** - * Converts the characters "&", "<", ">", '"', and "'" in `string` to their - * corresponding HTML entities. - * - * **Note:** No other characters are escaped. To escape additional - * characters use a third-party library like [_he_](https://mths.be/he). - * - * Though the ">" character is escaped for symmetry, characters like - * ">" and "/" don't need escaping in HTML and have no special meaning - * unless they're part of a tag or unquoted attribute value. See - * [Mathias Bynens's article](https://mathiasbynens.be/notes/ambiguous-ampersands) - * (under "semi-related fun fact") for more details. - * - * When working with HTML you should always - * [quote attribute values](http://wonko.com/post/html-escaping) to reduce - * XSS vectors. - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category String - * @param {string} [string=''] The string to escape. - * @returns {string} Returns the escaped string. - * @example - * - * _.escape('fred, barney, & pebbles'); - * // => 'fred, barney, & pebbles' - */ - function escape(string) { - string = toString(string); - return (string && reHasUnescapedHtml.test(string)) - ? string.replace(reUnescapedHtml, escapeHtmlChar) - : string; - } - - /** - * Escapes the `RegExp` special characters "^", "$", "\", ".", "*", "+", - * "?", "(", ")", "[", "]", "{", "}", and "|" in `string`. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to escape. - * @returns {string} Returns the escaped string. - * @example - * - * _.escapeRegExp('[lodash](https://lodash.com/)'); - * // => '\[lodash\]\(https://lodash\.com/\)' - */ - function escapeRegExp(string) { - string = toString(string); - return (string && reHasRegExpChar.test(string)) - ? string.replace(reRegExpChar, '\\$&') - : string; - } - - /** - * Converts `string` to - * [kebab case](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles). - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to convert. - * @returns {string} Returns the kebab cased string. - * @example - * - * _.kebabCase('Foo Bar'); - * // => 'foo-bar' - * - * _.kebabCase('fooBar'); - * // => 'foo-bar' - * - * _.kebabCase('__FOO_BAR__'); - * // => 'foo-bar' - */ - var kebabCase = createCompounder(function(result, word, index) { - return result + (index ? '-' : '') + word.toLowerCase(); - }); - - /** - * Converts `string`, as space separated words, to lower case. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category String - * @param {string} [string=''] The string to convert. - * @returns {string} Returns the lower cased string. - * @example - * - * _.lowerCase('--Foo-Bar--'); - * // => 'foo bar' - * - * _.lowerCase('fooBar'); - * // => 'foo bar' - * - * _.lowerCase('__FOO_BAR__'); - * // => 'foo bar' - */ - var lowerCase = createCompounder(function(result, word, index) { - return result + (index ? ' ' : '') + word.toLowerCase(); - }); - - /** - * Converts the first character of `string` to lower case. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category String - * @param {string} [string=''] The string to convert. - * @returns {string} Returns the converted string. - * @example - * - * _.lowerFirst('Fred'); - * // => 'fred' - * - * _.lowerFirst('FRED'); - * // => 'fRED' - */ - var lowerFirst = createCaseFirst('toLowerCase'); - - /** - * Pads `string` on the left and right sides if it's shorter than `length`. - * Padding characters are truncated if they can't be evenly divided by `length`. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to pad. - * @param {number} [length=0] The padding length. - * @param {string} [chars=' '] The string used as padding. - * @returns {string} Returns the padded string. - * @example - * - * _.pad('abc', 8); - * // => ' abc ' - * - * _.pad('abc', 8, '_-'); - * // => '_-abc_-_' - * - * _.pad('abc', 3); - * // => 'abc' - */ - function pad(string, length, chars) { - string = toString(string); - length = toInteger(length); - - var strLength = length ? stringSize(string) : 0; - if (!length || strLength >= length) { - return string; - } - var mid = (length - strLength) / 2; - return ( - createPadding(nativeFloor(mid), chars) + - string + - createPadding(nativeCeil(mid), chars) - ); - } - - /** - * Pads `string` on the right side if it's shorter than `length`. Padding - * characters are truncated if they exceed `length`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category String - * @param {string} [string=''] The string to pad. - * @param {number} [length=0] The padding length. - * @param {string} [chars=' '] The string used as padding. - * @returns {string} Returns the padded string. - * @example - * - * _.padEnd('abc', 6); - * // => 'abc ' - * - * _.padEnd('abc', 6, '_-'); - * // => 'abc_-_' - * - * _.padEnd('abc', 3); - * // => 'abc' - */ - function padEnd(string, length, chars) { - string = toString(string); - length = toInteger(length); - - var strLength = length ? stringSize(string) : 0; - return (length && strLength < length) - ? (string + createPadding(length - strLength, chars)) - : string; - } - - /** - * Pads `string` on the left side if it's shorter than `length`. Padding - * characters are truncated if they exceed `length`. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category String - * @param {string} [string=''] The string to pad. - * @param {number} [length=0] The padding length. - * @param {string} [chars=' '] The string used as padding. - * @returns {string} Returns the padded string. - * @example - * - * _.padStart('abc', 6); - * // => ' abc' - * - * _.padStart('abc', 6, '_-'); - * // => '_-_abc' - * - * _.padStart('abc', 3); - * // => 'abc' - */ - function padStart(string, length, chars) { - string = toString(string); - length = toInteger(length); - - var strLength = length ? stringSize(string) : 0; - return (length && strLength < length) - ? (createPadding(length - strLength, chars) + string) - : string; - } - - /** - * Converts `string` to an integer of the specified radix. If `radix` is - * `undefined` or `0`, a `radix` of `10` is used unless `value` is a - * hexadecimal, in which case a `radix` of `16` is used. - * - * **Note:** This method aligns with the - * [ES5 implementation](https://es5.github.io/#x15.1.2.2) of `parseInt`. - * - * @static - * @memberOf _ - * @since 1.1.0 - * @category String - * @param {string} string The string to convert. - * @param {number} [radix=10] The radix to interpret `value` by. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {number} Returns the converted integer. - * @example - * - * _.parseInt('08'); - * // => 8 - * - * _.map(['6', '08', '10'], _.parseInt); - * // => [6, 8, 10] - */ - function parseInt(string, radix, guard) { - if (guard || radix == null) { - radix = 0; - } else if (radix) { - radix = +radix; - } - return nativeParseInt(toString(string).replace(reTrimStart, ''), radix || 0); - } - - /** - * Repeats the given string `n` times. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to repeat. - * @param {number} [n=1] The number of times to repeat the string. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {string} Returns the repeated string. - * @example - * - * _.repeat('*', 3); - * // => '***' - * - * _.repeat('abc', 2); - * // => 'abcabc' - * - * _.repeat('abc', 0); - * // => '' - */ - function repeat(string, n, guard) { - if ((guard ? isIterateeCall(string, n, guard) : n === undefined)) { - n = 1; - } else { - n = toInteger(n); - } - return baseRepeat(toString(string), n); - } - - /** - * Replaces matches for `pattern` in `string` with `replacement`. - * - * **Note:** This method is based on - * [`String#replace`](https://mdn.io/String/replace). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category String - * @param {string} [string=''] The string to modify. - * @param {RegExp|string} pattern The pattern to replace. - * @param {Function|string} replacement The match replacement. - * @returns {string} Returns the modified string. - * @example - * - * _.replace('Hi Fred', 'Fred', 'Barney'); - * // => 'Hi Barney' - */ - function replace() { - var args = arguments, - string = toString(args[0]); - - return args.length < 3 ? string : string.replace(args[1], args[2]); - } - - /** - * Converts `string` to - * [snake case](https://en.wikipedia.org/wiki/Snake_case). - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to convert. - * @returns {string} Returns the snake cased string. - * @example - * - * _.snakeCase('Foo Bar'); - * // => 'foo_bar' - * - * _.snakeCase('fooBar'); - * // => 'foo_bar' - * - * _.snakeCase('--FOO-BAR--'); - * // => 'foo_bar' - */ - var snakeCase = createCompounder(function(result, word, index) { - return result + (index ? '_' : '') + word.toLowerCase(); - }); - - /** - * Splits `string` by `separator`. - * - * **Note:** This method is based on - * [`String#split`](https://mdn.io/String/split). - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category String - * @param {string} [string=''] The string to split. - * @param {RegExp|string} separator The separator pattern to split by. - * @param {number} [limit] The length to truncate results to. - * @returns {Array} Returns the string segments. - * @example - * - * _.split('a-b-c', '-', 2); - * // => ['a', 'b'] - */ - function split(string, separator, limit) { - if (limit && typeof limit != 'number' && isIterateeCall(string, separator, limit)) { - separator = limit = undefined; - } - limit = limit === undefined ? MAX_ARRAY_LENGTH : limit >>> 0; - if (!limit) { - return []; - } - string = toString(string); - if (string && ( - typeof separator == 'string' || - (separator != null && !isRegExp(separator)) - )) { - separator = baseToString(separator); - if (!separator && hasUnicode(string)) { - return castSlice(stringToArray(string), 0, limit); - } - } - return string.split(separator, limit); - } - - /** - * Converts `string` to - * [start case](https://en.wikipedia.org/wiki/Letter_case#Stylistic_or_specialised_usage). - * - * @static - * @memberOf _ - * @since 3.1.0 - * @category String - * @param {string} [string=''] The string to convert. - * @returns {string} Returns the start cased string. - * @example - * - * _.startCase('--foo-bar--'); - * // => 'Foo Bar' - * - * _.startCase('fooBar'); - * // => 'Foo Bar' - * - * _.startCase('__FOO_BAR__'); - * // => 'FOO BAR' - */ - var startCase = createCompounder(function(result, word, index) { - return result + (index ? ' ' : '') + upperFirst(word); - }); - - /** - * Checks if `string` starts with the given target string. - * - * @static - * @memberOf _ - * @since 3.0.0 - * @category String - * @param {string} [string=''] The string to inspect. - * @param {string} [target] The string to search for. - * @param {number} [position=0] The position to search from. - * @returns {boolean} Returns `true` if `string` starts with `target`, - * else `false`. - * @example - * - * _.startsWith('abc', 'a'); - * // => true - * - * _.startsWith('abc', 'b'); - * // => false - * - * _.startsWith('abc', 'b', 1); - * // => true - */ - function startsWith(string, target, position) { - string = toString(string); - position = position == null - ? 0 - : baseClamp(toInteger(position), 0, string.length); - - target = baseToString(target); - return string.slice(position, position + target.length) == target; - } - - /** - * Creates a compiled template function that can interpolate data properties - * in "interpolate" delimiters, HTML-escape interpolated data properties in - * "escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data - * properties may be accessed as free variables in the template. If a setting - * object is given, it takes precedence over `_.templateSettings` values. - * - * **Note:** In the development build `_.template` utilizes - * [sourceURLs](http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/#toc-sourceurl) - * for easier debugging. - * - * For more information on precompiling templates see - * [lodash's custom builds documentation](https://lodash.com/custom-builds). - * - * For more information on Chrome extension sandboxes see - * [Chrome's extensions documentation](https://developer.chrome.com/extensions/sandboxingEval). - * - * @static - * @since 0.1.0 - * @memberOf _ - * @category String - * @param {string} [string=''] The template string. - * @param {Object} [options={}] The options object. - * @param {RegExp} [options.escape=_.templateSettings.escape] - * The HTML "escape" delimiter. - * @param {RegExp} [options.evaluate=_.templateSettings.evaluate] - * The "evaluate" delimiter. - * @param {Object} [options.imports=_.templateSettings.imports] - * An object to import into the template as free variables. - * @param {RegExp} [options.interpolate=_.templateSettings.interpolate] - * The "interpolate" delimiter. - * @param {string} [options.sourceURL='lodash.templateSources[n]'] - * The sourceURL of the compiled template. - * @param {string} [options.variable='obj'] - * The data object variable name. - * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`. - * @returns {Function} Returns the compiled template function. - * @example - * - * // Use the "interpolate" delimiter to create a compiled template. - * var compiled = _.template('hello <%= user %>!'); - * compiled({ 'user': 'fred' }); - * // => 'hello fred!' - * - * // Use the HTML "escape" delimiter to escape data property values. - * var compiled = _.template('<%- value %>'); - * compiled({ 'value': '