s/defaultRoutingInstrumentation/instrumentRoutingWithDefaults

Author: lobsterkatie

packages/tracing/src/browser/browsertracing.ts

@@ -13,7 +13,7 @@ import {
   instrumentOutgoingRequests,
   RequestInstrumentationOptions,
 } from './request';
-import { defaultRoutingInstrumentation } from './router';
+import { instrumentRoutingWithDefaults } from './router';
 
 export const DEFAULT_MAX_TRANSACTION_DURATION_SECONDS = 600;
 
@@ -87,7 +87,7 @@ const DEFAULT_BROWSER_TRACING_OPTIONS = {
   idleTimeout: DEFAULT_IDLE_TIMEOUT,
   markBackgroundTransactions: true,
   maxTransactionDuration: DEFAULT_MAX_TRANSACTION_DURATION_SECONDS,
-  routingInstrumentation: defaultRoutingInstrumentation,
+  routingInstrumentation: instrumentRoutingWithDefaults,
   startTransactionOnLocationChange: true,
   startTransactionOnPageLoad: true,
   ...defaultRequestInstrumentationOptions,

packages/tracing/src/browser/router.ts

@@ -6,7 +6,7 @@ const global = getGlobalObject<Window>();
 /**
  * Default function implementing pageload and navigation transactions
  */
-export function defaultRoutingInstrumentation<T extends Transaction>(
+export function instrumentRoutingWithDefaults<T extends Transaction>(
   customStartTransaction: (context: TransactionContext) => T | undefined,
   startTransactionOnPageLoad: boolean = true,
   startTransactionOnLocationChange: boolean = true,

packages/tracing/test/browser/browsertracing.test.ts

@@ -12,7 +12,7 @@ import {
   getMetaContent,
 } from '../../src/browser/browsertracing';
 import { defaultRequestInstrumentationOptions } from '../../src/browser/request';
-import { defaultRoutingInstrumentation } from '../../src/browser/router';
+import { instrumentRoutingWithDefaults } from '../../src/browser/router';
 import * as hubExtensions from '../../src/hubextensions';
 import { DEFAULT_IDLE_TIMEOUT, IdleTransaction } from '../../src/idletransaction';
 import { getActiveTransaction, secToMs } from '../../src/utils';
@@ -83,7 +83,7 @@ describe('BrowserTracing', () => {
       idleTimeout: DEFAULT_IDLE_TIMEOUT,
       markBackgroundTransactions: true,
       maxTransactionDuration: DEFAULT_MAX_TRANSACTION_DURATION_SECONDS,
-      routingInstrumentation: defaultRoutingInstrumentation,
+      routingInstrumentation: instrumentRoutingWithDefaults,
       startTransactionOnLocationChange: true,
       startTransactionOnPageLoad: true,
       ...defaultRequestInstrumentationOptions,

packages/tracing/test/browser/router.test.ts

@@ -1,6 +1,6 @@
 import { JSDOM } from 'jsdom';
 
-import { defaultRoutingInstrumentation } from '../../src/browser/router';
+import { instrumentRoutingWithDefaults } from '../../src/browser/router';
 
 let mockChangeHistory: ({ to, from }: { to: string; from?: string }) => void = () => undefined;
 let addInstrumentationHandlerType: string = '';
@@ -15,7 +15,7 @@ jest.mock('@sentry/utils', () => {
   };
 });
 
-describe('defaultRoutingInstrumentation', () => {
+describe('instrumentRoutingWithDefaults', () => {
   const mockFinish = jest.fn();
   const customStartTransaction = jest.fn().mockReturnValue({ finish: mockFinish });
   beforeEach(() => {
@@ -34,18 +34,18 @@ describe('defaultRoutingInstrumentation', () => {
   it('does not start transactions if global location is undefined', () => {
     // @ts-ignore need to override global document
     global.location = undefined;
-    defaultRoutingInstrumentation(customStartTransaction);
+    instrumentRoutingWithDefaults(customStartTransaction);
     expect(customStartTransaction).toHaveBeenCalledTimes(0);
   });
 
   it('starts a pageload transaction', () => {
-    defaultRoutingInstrumentation(customStartTransaction);
+    instrumentRoutingWithDefaults(customStartTransaction);
     expect(customStartTransaction).toHaveBeenCalledTimes(1);
     expect(customStartTransaction).toHaveBeenLastCalledWith({ name: 'blank', op: 'pageload' });
   });
 
   it('does not start a pageload transaction if startTransactionOnPageLoad is false', () => {
-    defaultRoutingInstrumentation(customStartTransaction, false);
+    instrumentRoutingWithDefaults(customStartTransaction, false);
     expect(customStartTransaction).toHaveBeenCalledTimes(0);
   });
 
@@ -56,12 +56,12 @@ describe('defaultRoutingInstrumentation', () => {
     });
 
     it('it is not created automatically', () => {
-      defaultRoutingInstrumentation(customStartTransaction);
+      instrumentRoutingWithDefaults(customStartTransaction);
       expect(customStartTransaction).not.toHaveBeenLastCalledWith({ name: 'blank', op: 'navigation' });
     });
 
     it('is created on location change', () => {
-      defaultRoutingInstrumentation(customStartTransaction);
+      instrumentRoutingWithDefaults(customStartTransaction);
       mockChangeHistory({ to: 'here', from: 'there' });
       expect(addInstrumentationHandlerType).toBe('history');
 
@@ -70,23 +70,23 @@ describe('defaultRoutingInstrumentation', () => {
     });
 
     it('is not created if startTransactionOnLocationChange is false', () => {
-      defaultRoutingInstrumentation(customStartTransaction, true, false);
+      instrumentRoutingWithDefaults(customStartTransaction, true, false);
       mockChangeHistory({ to: 'here', from: 'there' });
       expect(addInstrumentationHandlerType).toBe('');
 
       expect(customStartTransaction).toHaveBeenCalledTimes(1);
     });
 
     it('finishes the last active transaction', () => {
-      defaultRoutingInstrumentation(customStartTransaction);
+      instrumentRoutingWithDefaults(customStartTransaction);
 
       expect(mockFinish).toHaveBeenCalledTimes(0);
       mockChangeHistory({ to: 'here', from: 'there' });
       expect(mockFinish).toHaveBeenCalledTimes(1);
     });
 
     it('will finish active transaction multiple times', () => {
-      defaultRoutingInstrumentation(customStartTransaction);
+      instrumentRoutingWithDefaults(customStartTransaction);
 
       expect(mockFinish).toHaveBeenCalledTimes(0);
       mockChangeHistory({ to: 'here', from: 'there' });
@@ -98,7 +98,7 @@ describe('defaultRoutingInstrumentation', () => {
     });
 
     it('not created if `from` is equal to `to`', () => {
-      defaultRoutingInstrumentation(customStartTransaction);
+      instrumentRoutingWithDefaults(customStartTransaction);
       mockChangeHistory({ to: 'first/path', from: 'first/path' });
       expect(addInstrumentationHandlerType).toBe('history');