chore(various): Small fixes (#3150)

No behavior changes

Author: lobsterkatie

packages/core/src/baseclient.ts

@@ -490,7 +490,11 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
     // 0.0 === 0% events are sent
     // Sampling for transaction happens somewhere else
     if (!isTransaction && typeof sampleRate === 'number' && Math.random() > sampleRate) {
-      return SyncPromise.reject(new SentryError('This event has been sampled, will not send event.'));
+      return SyncPromise.reject(
+        new SentryError(
+          `Discarding event because it's not included in the random sample (sampling rate = ${sampleRate})`,
+        ),
+      );
     }
 
     return this._prepareEvent(event, scope, hint)

packages/core/test/lib/sdk.test.ts

@@ -51,7 +51,7 @@ describe('SDK', () => {
       expect((DEFAULT_INTEGRATIONS[1].setupOnce as jest.Mock).mock.calls.length).toBe(1);
     });
 
-    test('not installs default integrations', () => {
+    test("doesn't install default integrations if told not to", () => {
       const DEFAULT_INTEGRATIONS: Integration[] = [
         new MockIntegration('MockIntegration 1'),
         new MockIntegration('MockIntegration 2'),

packages/node/src/handlers.ts

@@ -139,10 +139,10 @@ function extractExpressTransactionName(
   return info;
 }
 
-type TransactionTypes = 'path' | 'methodPath' | 'handler';
+type TransactionNamingScheme = 'path' | 'methodPath' | 'handler';
 
 /** JSDoc */
-function extractTransaction(req: ExpressRequest, type: boolean | TransactionTypes): string {
+function extractTransaction(req: ExpressRequest, type: boolean | TransactionNamingScheme): string {
   switch (type) {
     case 'path': {
       return extractExpressTransactionName(req, { path: true });
@@ -186,7 +186,7 @@ export interface ParseRequestOptions {
   ip?: boolean;
   request?: boolean | string[];
   serverName?: boolean;
-  transaction?: boolean | TransactionTypes;
+  transaction?: boolean | TransactionNamingScheme;
   user?: boolean | string[];
   version?: boolean;
 }

packages/node/test/handlers.test.ts

@@ -2,7 +2,7 @@ import * as sentryCore from '@sentry/core';
 import { Hub } from '@sentry/hub';
 import * as sentryHub from '@sentry/hub';
 import { SpanStatus, Transaction } from '@sentry/tracing';
-import { Runtime, Transaction as TransactionType } from '@sentry/types';
+import { Runtime } from '@sentry/types';
 import * as http from 'http';
 import * as net from 'net';
 
@@ -255,7 +255,7 @@ describe('tracingHandler', () => {
 
   it('pulls status code from the response', done => {
     const transaction = new Transaction({ name: 'mockTransaction' });
-    jest.spyOn(sentryCore, 'startTransaction').mockReturnValue(transaction as TransactionType);
+    jest.spyOn(sentryCore, 'startTransaction').mockReturnValue(transaction as Transaction);
     const finishTransaction = jest.spyOn(transaction, 'finish');
 
     sentryTracingMiddleware(req, res, next);
@@ -302,7 +302,7 @@ describe('tracingHandler', () => {
 
   it('closes the transaction when request processing is done', done => {
     const transaction = new Transaction({ name: 'mockTransaction' });
-    jest.spyOn(sentryCore, 'startTransaction').mockReturnValue(transaction as TransactionType);
+    jest.spyOn(sentryCore, 'startTransaction').mockReturnValue(transaction as Transaction);
     const finishTransaction = jest.spyOn(transaction, 'finish');
 
     sentryTracingMiddleware(req, res, next);
@@ -321,7 +321,7 @@ describe('tracingHandler', () => {
       description: 'reallyCoolHandler',
       op: 'middleware',
     });
-    jest.spyOn(sentryCore, 'startTransaction').mockReturnValue(transaction as TransactionType);
+    jest.spyOn(sentryCore, 'startTransaction').mockReturnValue(transaction as Transaction);
     const finishSpan = jest.spyOn(span, 'finish');
     const finishTransaction = jest.spyOn(transaction, 'finish');
 

packages/serverless/package.json

@@ -60,8 +60,8 @@
     "fix": "run-s fix:eslint fix:prettier",
     "fix:prettier": "prettier --write \"{src,test}/**/*.ts\"",
     "fix:eslint": "eslint . --format stylish --fix",
-    "test": "jest --passWithNoTests",
-    "test:watch": "jest --watch --passWithNoTests",
+    "test": "jest",
+    "test:watch": "jest --watch",
     "pack": "npm pack"
   },
   "volta": {

packages/tracing/src/browser/browsertracing.ts

@@ -1,5 +1,5 @@
 import { Hub } from '@sentry/hub';
-import { EventProcessor, Integration, Transaction as TransactionType, TransactionContext } from '@sentry/types';
+import { EventProcessor, Integration, Transaction, TransactionContext } from '@sentry/types';
 import { logger } from '@sentry/utils';
 
 import { startIdleTransaction } from '../hubextensions';
@@ -76,7 +76,7 @@ export interface BrowserTracingOptions extends RequestInstrumentationOptions {
    * Instrumentation that creates routing change transactions. By default creates
    * pageload and navigation transactions.
    */
-  routingInstrumentation<T extends TransactionType>(
+  routingInstrumentation<T extends Transaction>(
     startTransaction: (context: TransactionContext) => T | undefined,
     startTransactionOnPageLoad?: boolean,
     startTransactionOnLocationChange?: boolean,
@@ -182,7 +182,7 @@ export class BrowserTracing implements Integration {
   }
 
   /** Create routing idle transaction. */
-  private _createRouteTransaction(context: TransactionContext): TransactionType | undefined {
+  private _createRouteTransaction(context: TransactionContext): Transaction | undefined {
     if (!this._getCurrentHub) {
       logger.warn(`[Tracing] Did not create ${context.op} transaction because _getCurrentHub is invalid.`);
       return undefined;
@@ -216,7 +216,7 @@ export class BrowserTracing implements Integration {
       adjustTransactionDuration(secToMs(maxTransactionDuration), transaction, endTimestamp);
     });
 
-    return idleTransaction as TransactionType;
+    return idleTransaction as Transaction;
   }
 }
 

packages/tracing/src/browser/metrics.ts

@@ -321,7 +321,7 @@ export interface ResourceEntry extends Record<string, unknown> {
   decodedBodySize?: number;
 }
 
-/** Create resource related spans */
+/** Create resource-related spans */
 export function addResourceSpans(
   transaction: Transaction,
   entry: ResourceEntry,
@@ -375,27 +375,27 @@ function addPerformanceNavigationTiming(
     return;
   }
   _startChild(transaction, {
-    description: event,
-    endTimestamp: timeOrigin + msToSec(end),
     op: 'browser',
+    description: event,
     startTimestamp: timeOrigin + msToSec(start),
+    endTimestamp: timeOrigin + msToSec(end),
   });
 }
 
 /** Create request and response related spans */
 function addRequest(transaction: Transaction, entry: Record<string, any>, timeOrigin: number): void {
   _startChild(transaction, {
-    description: 'request',
-    endTimestamp: timeOrigin + msToSec(entry.responseEnd as number),
     op: 'browser',
+    description: 'request',
     startTimestamp: timeOrigin + msToSec(entry.requestStart as number),
+    endTimestamp: timeOrigin + msToSec(entry.responseEnd as number),
   });
 
   _startChild(transaction, {
-    description: 'response',
-    endTimestamp: timeOrigin + msToSec(entry.responseEnd as number),
     op: 'browser',
+    description: 'response',
     startTimestamp: timeOrigin + msToSec(entry.responseStart as number),
+    endTimestamp: timeOrigin + msToSec(entry.responseEnd as number),
   });
 }
 

packages/tracing/src/browser/router.ts

@@ -1,12 +1,12 @@
-import { Transaction as TransactionType, TransactionContext } from '@sentry/types';
+import { Transaction, TransactionContext } from '@sentry/types';
 import { addInstrumentationHandler, getGlobalObject, logger } from '@sentry/utils';
 
 const global = getGlobalObject<Window>();
 
 /**
  * Default function implementing pageload and navigation transactions
  */
-export function defaultRoutingInstrumentation<T extends TransactionType>(
+export function defaultRoutingInstrumentation<T extends Transaction>(
   startTransaction: (context: TransactionContext) => T | undefined,
   startTransactionOnPageLoad: boolean = true,
   startTransactionOnLocationChange: boolean = true,

packages/tracing/test/span.test.ts

@@ -127,9 +127,8 @@ describe('Span', () => {
         traceId: 'c',
       });
       const serialized = spanB.toJSON();
-      expect(serialized).toHaveProperty('start_timestamp');
-      delete (serialized as { start_timestamp: number }).start_timestamp;
       expect(serialized).toStrictEqual({
+        start_timestamp: expect.any(Number),
         parent_span_id: 'b',
         span_id: 'd',
         trace_id: 'c',

packages/utils/src/object.ts

@@ -12,16 +12,17 @@ import { truncate } from './string';
  *
  * @param source An object that contains a method to be wrapped.
  * @param name A name of method to be wrapped.
- * @param replacement A function that should be used to wrap a given method.
+ * @param replacementFactory A function that should be used to wrap a given method, returning the wrapped method which
+ * will be substituted in for `source[name]`.
  * @returns void
  */
-export function fill(source: { [key: string]: any }, name: string, replacement: (...args: any[]) => any): void {
+export function fill(source: { [key: string]: any }, name: string, replacementFactory: (...args: any[]) => any): void {
   if (!(name in source)) {
     return;
   }
 
   const original = source[name] as () => any;
-  const wrapped = replacement(original) as WrappedFunction;
+  const wrapped = replacementFactory(original) as WrappedFunction;
 
   // Make sure it's a function first, as we need to attach an empty prototype for `defineProperties` to work
   // otherwise it'll throw "TypeError: Object.defineProperties called on non-object"
@@ -56,10 +57,10 @@ export function urlEncode(object: { [key: string]: any }): string {
 }
 
 /**
- * Transforms any object into an object literal with all it's attributes
+ * Transforms any object into an object literal with all its attributes
  * attached to it.
  *
- * @param value Initial source that we have to transform in order to be usable by the serializer
+ * @param value Initial source that we have to transform in order for it to be usable by the serializer
  */
 function getWalkSource(
   value: any,
@@ -383,7 +384,7 @@ export function dropUndefinedKeys<T>(val: T): T {
   }
 
   if (Array.isArray(val)) {
-    return val.map(dropUndefinedKeys) as any;
+    return (val as any[]).map(dropUndefinedKeys) as any;
   }
 
   return val;