s/registerRequestInstrumentation/instrumentOutgoingRequests

Author: lobsterkatie

packages/tracing/src/browser/browsertracing.ts

@@ -10,7 +10,7 @@ import { registerBackgroundTabDetection } from './backgroundtab';
 import { MetricsInstrumentation } from './metrics';
 import {
   defaultRequestInstrumentationOptions,
-  registerRequestInstrumentation,
+  instrumentOutgoingRequests,
   RequestInstrumentationOptions,
 } from './request';
 import { defaultRoutingInstrumentation } from './router';
@@ -178,7 +178,7 @@ export class BrowserTracing implements Integration {
       registerBackgroundTabDetection();
     }
 
-    registerRequestInstrumentation({ traceFetch, traceXHR, tracingOrigins, shouldCreateSpanForRequest });
+    instrumentOutgoingRequests({ traceFetch, traceXHR, tracingOrigins, shouldCreateSpanForRequest });
   }
 
   /** Create routing idle transaction. */

packages/tracing/src/browser/index.ts

@@ -1,6 +1,6 @@
 export { BrowserTracing } from './browsertracing';
 export {
-  registerRequestInstrumentation,
+  instrumentOutgoingRequests,
   RequestInstrumentationOptions,
   defaultRequestInstrumentationOptions,
 } from './request';

packages/tracing/src/browser/request.ts

@@ -83,7 +83,7 @@ export const defaultRequestInstrumentationOptions: RequestInstrumentationOptions
 };
 
 /** Registers span creators for xhr and fetch requests  */
-export function registerRequestInstrumentation(_options?: Partial<RequestInstrumentationOptions>): void {
+export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumentationOptions>): void {
   // eslint-disable-next-line @typescript-eslint/unbound-method
   const { traceFetch, traceXHR, tracingOrigins, shouldCreateSpanForRequest } = {
     ...defaultRequestInstrumentationOptions,

packages/tracing/src/index.ts

@@ -8,7 +8,8 @@ export { Integrations };
 export { Span } from './span';
 export { Transaction } from './transaction';
 export {
-  registerRequestInstrumentation,
+  // TODO deprecate old name in v7
+  instrumentOutgoingRequests as registerRequestInstrumentation,
   RequestInstrumentationOptions,
   defaultRequestInstrumentationOptions,
 } from './browser';

packages/tracing/test/browser/request.test.ts

@@ -3,13 +3,7 @@ import { Hub, makeMain } from '@sentry/hub';
 import * as utils from '@sentry/utils';
 
 import { Span, SpanStatus, Transaction } from '../../src';
-import {
-  fetchCallback,
-  FetchData,
-  registerRequestInstrumentation,
-  xhrCallback,
-  XHRData,
-} from '../../src/browser/request';
+import { fetchCallback, FetchData, instrumentOutgoingRequests, xhrCallback, XHRData } from '../../src/browser/request';
 import { addExtensionMethods } from '../../src/hubextensions';
 import * as tracingUtils from '../../src/utils';
 
@@ -24,13 +18,13 @@ const hasTracingEnabled = jest.spyOn(tracingUtils, 'hasTracingEnabled');
 const addInstrumentationHandler = jest.spyOn(utils, 'addInstrumentationHandler');
 const setRequestHeader = jest.fn();
 
-describe('registerRequestInstrumentation', () => {
+describe('instrumentOutgoingRequests', () => {
   beforeEach(() => {
     jest.clearAllMocks();
   });
 
   it('instruments fetch and xhr requests', () => {
-    registerRequestInstrumentation();
+    instrumentOutgoingRequests();
 
     expect(addInstrumentationHandler).toHaveBeenCalledWith({
       callback: expect.any(Function),
@@ -43,13 +37,13 @@ describe('registerRequestInstrumentation', () => {
   });
 
   it('does not instrument fetch requests if traceFetch is false', () => {
-    registerRequestInstrumentation({ traceFetch: false });
+    instrumentOutgoingRequests({ traceFetch: false });
 
     expect(addInstrumentationHandler).not.toHaveBeenCalledWith({ callback: expect.any(Function), type: 'fetch' });
   });
 
   it('does not instrument xhr requests if traceXHR is false', () => {
-    registerRequestInstrumentation({ traceXHR: false });
+    instrumentOutgoingRequests({ traceXHR: false });
 
     expect(addInstrumentationHandler).not.toHaveBeenCalledWith({ callback: expect.any(Function), type: 'xhr' });
   });