fix type errors in tracing tests

lobsterkatie · lobsterkatie · commit 2e907bcd4992 · 2022-04-14T10:45:09.000-07:00
diff --git a/packages/tracing/test/browser/browsertracing.test.ts b/packages/tracing/test/browser/browsertracing.test.ts
@@ -1,7 +1,7 @@
 import { BrowserClient } from '@sentry/browser';
 import { setupBrowserTransport } from '@sentry/browser/src/transports';
 import { Hub, makeMain } from '@sentry/hub';
-import { getGlobalObject } from '@sentry/utils';
+import { getGlobalObject, InstrumentHandlerCallback, InstrumentHandlerType } from '@sentry/utils';
 import { JSDOM } from 'jsdom';
 
 import {
@@ -24,7 +24,7 @@ jest.mock('@sentry/utils', () => {
   const actual = jest.requireActual('@sentry/utils');
   return {
     ...actual,
-    addInstrumentationHandler: (type, callback): void => {
+    addInstrumentationHandler: (type: InstrumentHandlerType, callback: InstrumentHandlerCallback): void => {
       if (type === 'history') {
         // rather than actually add the navigation-change handler, grab a reference to it, so we can trigger it manually
         mockChangeHistory = callback;
diff --git a/packages/tracing/test/browser/metrics.test.ts b/packages/tracing/test/browser/metrics.test.ts
@@ -1,11 +1,5 @@
 import { Span, Transaction } from '../../src';
-import {
-  _startChild,
-  addResourceSpans,
-  DEFAULT_METRICS_INSTR_OPTIONS,
-  MetricsInstrumentation,
-  ResourceEntry,
-} from '../../src/browser/metrics';
+import { _startChild, addResourceSpans, MetricsInstrumentation, ResourceEntry } from '../../src/browser/metrics';
 import { addDOMPropertiesToGlobal } from '../testutils';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-var
@@ -186,7 +180,7 @@ describe('MetricsInstrumentation', () => {
       jest.spyOn(MetricsInstrumentation.prototype as any, tracker),
     );
 
-    new MetricsInstrumentation(DEFAULT_METRICS_INSTR_OPTIONS);
+    new MetricsInstrumentation();
 
     trackers.forEach(tracker => expect(tracker).not.toBeCalled());
   });
@@ -200,7 +194,7 @@ describe('MetricsInstrumentation', () => {
     const trackers = ['_trackCLS', '_trackLCP', '_trackFID'].map(tracker =>
       jest.spyOn(MetricsInstrumentation.prototype as any, tracker),
     );
-    new MetricsInstrumentation(DEFAULT_METRICS_INSTR_OPTIONS);
+    new MetricsInstrumentation();
     global.process = backup;
 
     trackers.forEach(tracker => expect(tracker).toBeCalled());
diff --git a/packages/tracing/test/browser/request.test.ts b/packages/tracing/test/browser/request.test.ts
@@ -4,7 +4,7 @@ import { Hub, makeMain } from '@sentry/hub';
 import * as utils from '@sentry/utils';
 
 import { Span, spanStatusfromHttpCode, Transaction } from '../../src';
-import { fetchCallback, FetchData, instrumentOutgoingRequests, xhrCallback, XHRData } from '../../src/browser/request';
+import { fetchCallback, FetchData, instrumentOutgoingRequests, xhrCallback } from '../../src/browser/request';
 import { addExtensionMethods } from '../../src/hubextensions';
 import * as tracingUtils from '../../src/utils';
 
@@ -56,7 +56,7 @@ describe('callbacks', () => {
     fetchData: { url: 'http://dogs.are.great/', method: 'GET' },
     startTimestamp,
   };
-  const xhrHandlerData: XHRData = {
+  const xhrHandlerData = {
     xhr: {
       __sentry_xhr__: {
         method: 'GET',
@@ -130,17 +130,17 @@ describe('callbacks', () => {
       // triggered by request being sent
       fetchCallback(fetchHandlerData, alwaysCreateSpan, spans);
 
-      const newSpan = transaction.spanRecorder?.spans[1];
+      const newSpan = transaction.spanRecorder?.spans[1] as Span;
 
       expect(newSpan).toBeDefined();
       expect(newSpan).toBeInstanceOf(Span);
-      expect(newSpan!.data).toEqual({
+      expect(newSpan.data).toEqual({
         method: 'GET',
         type: 'fetch',
         url: 'http://dogs.are.great/',
       });
-      expect(newSpan!.description).toBe('GET http://dogs.are.great/');
-      expect(newSpan!.op).toBe('http.client');
+      expect(newSpan.description).toBe('GET http://dogs.are.great/');
+      expect(newSpan.op).toBe('http.client');
       expect(fetchHandlerData.fetchData?.__span).toBeDefined();
 
       const postRequestFetchHandlerData = {
@@ -151,7 +151,7 @@ describe('callbacks', () => {
       // triggered by response coming back
       fetchCallback(postRequestFetchHandlerData, alwaysCreateSpan, spans);
 
-      expect(newSpan!.endTimestamp).toBeDefined();
+      expect(newSpan.endTimestamp).toBeDefined();
     });
 
     it('sets response status on finish', () => {
@@ -160,7 +160,7 @@ describe('callbacks', () => {
       // triggered by request being sent
       fetchCallback(fetchHandlerData, alwaysCreateSpan, spans);
 
-      const newSpan = transaction.spanRecorder?.spans[1];
+      const newSpan = transaction.spanRecorder?.spans[1] as Span;
 
       expect(newSpan).toBeDefined();
 
@@ -173,7 +173,7 @@ describe('callbacks', () => {
       // triggered by response coming back
       fetchCallback(postRequestFetchHandlerData, alwaysCreateSpan, spans);
 
-      expect(newSpan!.status).toBe(spanStatusfromHttpCode(404));
+      expect(newSpan.status).toBe(spanStatusfromHttpCode(404));
     });
 
     it('ignores response with no associated span', () => {
@@ -238,18 +238,18 @@ describe('callbacks', () => {
       // triggered by request being sent
       xhrCallback(xhrHandlerData, alwaysCreateSpan, spans);
 
-      const newSpan = transaction.spanRecorder?.spans[1];
+      const newSpan = transaction.spanRecorder?.spans[1] as Span;
 
       expect(newSpan).toBeInstanceOf(Span);
-      expect(newSpan!.data).toEqual({
+      expect(newSpan.data).toEqual({
         method: 'GET',
         type: 'xhr',
         url: 'http://dogs.are.great/',
       });
-      expect(newSpan!.description).toBe('GET http://dogs.are.great/');
-      expect(newSpan!.op).toBe('http.client');
-      expect(xhrHandlerData.xhr!.__sentry_xhr_span_id__).toBeDefined();
-      expect(xhrHandlerData.xhr!.__sentry_xhr_span_id__).toEqual(newSpan?.spanId);
+      expect(newSpan.description).toBe('GET http://dogs.are.great/');
+      expect(newSpan.op).toBe('http.client');
+      expect(xhrHandlerData.xhr.__sentry_xhr_span_id__).toBeDefined();
+      expect(xhrHandlerData.xhr.__sentry_xhr_span_id__).toEqual(newSpan?.spanId);
 
       const postRequestXHRHandlerData = {
         ...xhrHandlerData,
@@ -259,7 +259,7 @@ describe('callbacks', () => {
       // triggered by response coming back
       xhrCallback(postRequestXHRHandlerData, alwaysCreateSpan, spans);
 
-      expect(newSpan!.endTimestamp).toBeDefined();
+      expect(newSpan.endTimestamp).toBeDefined();
     });
 
     it('sets response status on finish', () => {
@@ -268,20 +268,20 @@ describe('callbacks', () => {
       // triggered by request being sent
       xhrCallback(xhrHandlerData, alwaysCreateSpan, spans);
 
-      const newSpan = transaction.spanRecorder?.spans[1];
+      const newSpan = transaction.spanRecorder?.spans[1] as Span;
 
       expect(newSpan).toBeDefined();
 
       const postRequestXHRHandlerData = {
         ...xhrHandlerData,
         endTimestamp,
       };
-      postRequestXHRHandlerData.xhr!.__sentry_xhr__!.status_code = 404;
+      postRequestXHRHandlerData.xhr.__sentry_xhr__.status_code = 404;
 
       // triggered by response coming back
       xhrCallback(postRequestXHRHandlerData, alwaysCreateSpan, spans);
 
-      expect(newSpan!.status).toBe(spanStatusfromHttpCode(404));
+      expect(newSpan.status).toBe(spanStatusfromHttpCode(404));
     });
 
     it('ignores response with no associated span', () => {
diff --git a/packages/tracing/test/browser/router.test.ts b/packages/tracing/test/browser/router.test.ts
@@ -1,3 +1,4 @@
+import { InstrumentHandlerCallback, InstrumentHandlerType } from '@sentry/utils';
 import { JSDOM } from 'jsdom';
 
 import { instrumentRoutingWithDefaults } from '../../src/browser/router';
@@ -8,7 +9,7 @@ jest.mock('@sentry/utils', () => {
   const actual = jest.requireActual('@sentry/utils');
   return {
     ...actual,
-    addInstrumentationHandler: (type, callback): void => {
+    addInstrumentationHandler: (type: InstrumentHandlerType, callback: InstrumentHandlerCallback): void => {
       addInstrumentationHandlerType = type;
       mockChangeHistory = callback;
     },
diff --git a/packages/tracing/test/errors.test.ts b/packages/tracing/test/errors.test.ts
@@ -1,18 +1,19 @@
 import { BrowserClient } from '@sentry/browser';
 import { setupBrowserTransport } from '@sentry/browser/src/transports';
 import { Hub, makeMain } from '@sentry/hub';
+import { InstrumentHandlerCallback, InstrumentHandlerType } from '@sentry/utils';
 
 import { registerErrorInstrumentation } from '../src/errors';
 import { _addTracingExtensions } from '../src/hubextensions';
 
 const mockAddInstrumentationHandler = jest.fn();
-let mockErrorCallback: () => void = () => undefined;
-let mockUnhandledRejectionCallback: () => void = () => undefined;
+let mockErrorCallback: InstrumentHandlerCallback = () => undefined;
+let mockUnhandledRejectionCallback: InstrumentHandlerCallback = () => undefined;
 jest.mock('@sentry/utils', () => {
   const actual = jest.requireActual('@sentry/utils');
   return {
     ...actual,
-    addInstrumentationHandler: (type, callback) => {
+    addInstrumentationHandler: (type: InstrumentHandlerType, callback: InstrumentHandlerCallback) => {
       if (type === 'error') {
         mockErrorCallback = callback;
       }
@@ -55,10 +56,10 @@ describe('registerErrorHandlers()', () => {
     const transaction = hub.startTransaction({ name: 'test' });
     expect(transaction.status).toBe(undefined);
 
-    mockErrorCallback();
+    mockErrorCallback({});
     expect(transaction.status).toBe(undefined);
 
-    mockUnhandledRejectionCallback();
+    mockUnhandledRejectionCallback({});
     expect(transaction.status).toBe(undefined);
     transaction.finish();
   });
@@ -68,7 +69,7 @@ describe('registerErrorHandlers()', () => {
     const transaction = hub.startTransaction({ name: 'test' });
     hub.configureScope(scope => scope.setSpan(transaction));
 
-    mockErrorCallback();
+    mockErrorCallback({});
     expect(transaction.status).toBe('internal_error');
 
     transaction.finish();
@@ -79,7 +80,7 @@ describe('registerErrorHandlers()', () => {
     const transaction = hub.startTransaction({ name: 'test' });
     hub.configureScope(scope => scope.setSpan(transaction));
 
-    mockUnhandledRejectionCallback();
+    mockUnhandledRejectionCallback({});
     expect(transaction.status).toBe('internal_error');
     transaction.finish();
   });
diff --git a/packages/tracing/test/idletransaction.test.ts b/packages/tracing/test/idletransaction.test.ts
@@ -9,7 +9,9 @@ import {
 } from '../src/idletransaction';
 import { Span } from '../src/span';
 
-export class SimpleTransport extends Transports.BaseTransport {}
+// @ts-ignore It's okay that we're not implementing the methods of the abstract `BaseTransport` class, because it's not
+// what we're testing here
+class SimpleTransport extends Transports.BaseTransport {}
 
 const dsn = 'https://123@sentry.io/42';
 let hub: Hub;
@@ -167,9 +169,9 @@ describe('IdleTransaction', () => {
   it('should record dropped transactions', async () => {
     const transaction = new IdleTransaction({ name: 'foo', startTimestamp: 1234, sampled: false }, hub, 1000);
 
-    const transport = hub.getClient()?.getTransport();
+    const transport = hub.getClient()!.getTransport!();
 
-    const spy = jest.spyOn(transport!, 'recordLostEvent');
+    const spy = jest.spyOn(transport, 'recordLostEvent');
 
     transaction.initSpanRecorder(10);
     transaction.finish(transaction.startTimestamp + 10);
diff --git a/packages/utils/src/instrument.ts b/packages/utils/src/instrument.ts
@@ -13,7 +13,7 @@ import { supportsHistory, supportsNativeFetch } from './supports';
 
 const global = getGlobalObject<Window>();
 
-type InstrumentHandlerType =
+export type InstrumentHandlerType =
   | 'console'
   | 'dom'
   | 'fetch'
@@ -22,7 +22,7 @@ type InstrumentHandlerType =
   | 'xhr'
   | 'error'
   | 'unhandledrejection';
-type InstrumentHandlerCallback = (data: any) => void;
+export type InstrumentHandlerCallback = (data: any) => void;
 
 /**
  * Instrument native APIs to call handlers that can be used to create breadcrumbs, APM spans etc.
