random cleanup

Author: lobsterkatie

packages/angular/README.md

@@ -76,7 +76,7 @@ components initializations.
 
 #### Install
 
-Registering a Trace Service is a 3 step process.
+Registering a Trace Service is a 3-step process.
 
 1. Register and configure the `BrowserTracing` integration from `@sentry/tracing`, including custom Angular routing
    instrumentation:

packages/node/src/handlers.ts

@@ -15,7 +15,7 @@ import { flush } from './sdk';
 const DEFAULT_SHUTDOWN_TIMEOUT = 2000;
 
 /**
- * Express compatible tracing handler.
+ * Express-compatible tracing handler.
  * @see Exposed as `Handlers.tracingHandler`
  */
 export function tracingHandler(): (
@@ -28,7 +28,7 @@ export function tracingHandler(): (
     res: http.ServerResponse,
     next: (error?: any) => void,
   ): void {
-    // TODO: At this point req.route.path we use in `extractTransaction` is not available
+    // TODO: At this point `req.route.path` (which we use in `extractTransaction`) is not available
     // but `req.path` or `req.url` should do the job as well. We could unify this here.
     const reqMethod = (req.method || '').toUpperCase();
     const reqUrl = req.url;

packages/tracing/src/hubextensions.ts

@@ -104,18 +104,22 @@ function getDefaultSampleContext(): SampleContext {
   const defaultSampleContext: SampleContext = {};
 
   if (isNodeEnv()) {
-    // look at koa TODO
     const domain = getActiveDomain();
-    const nodeHttpModule = dynamicRequire(module, 'http');
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    const requestType = nodeHttpModule.IncomingMessage;
+
     if (domain) {
-      // TODO is the below true?
       // for all node servers that we currently support, we store the incoming request object (which is an instance of
-      // http.IncomingMessage) on the domain the domain is stored as an array, so our only way to find the request is to
-      // iterate through the array and compare types
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
+      // http.IncomingMessage) on the domain
+
+      // the domain members are stored as an array, so our only way to find the request is to iterate through the array
+      // and compare types
+
+      const nodeHttpModule = dynamicRequire(module, 'http');
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      const requestType = nodeHttpModule.IncomingMessage;
+
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const request = domain.members.find((member: any) => isInstanceOf(member, requestType));
+
       if (request) {
         defaultSampleContext.request = extractNodeRequestData(request);
       }

packages/tracing/src/transaction.ts

@@ -68,6 +68,7 @@ export class Transaction extends SpanClass {
       this.name = '<unlabeled transaction>';
     }
 
+    // just sets the end timestamp
     super.finish(endTimestamp);
 
     if (this.sampled !== true) {

packages/types/src/options.ts

@@ -157,5 +157,5 @@ export interface Options {
    *
    * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent).
    */
-  tracesSampler?(traceContext: SampleContext): number;
+  tracesSampler?(sampleContext: SampleContext): number;
 }

packages/types/src/transaction.ts

@@ -51,8 +51,8 @@ export interface Transaction extends TransactionContext, Span {
 
 /**
  * The data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
+ * Combination of default values (which differ per SDK/integration) and data passed to `startTransaction`.
  */
 export interface SampleContext {
-  [key: string]: string;
-  // TODO (kmclb) fill this out
+  [key: string]: any;
 }