random language cleanup

Author: lobsterkatie

packages/tracing/src/browser/browsertracing.ts

@@ -201,8 +201,8 @@ export class BrowserTracing implements Integration {
     }
 
     const hub = this._getCurrentHub();
-    logger.log(`[Tracing] starting ${modifiedContext.op} idleTransaction on scope`);
     const idleTransaction = startIdleTransaction(hub, modifiedContext, idleTimeout, true);
+    logger.log(`[Tracing] Starting ${modifiedContext.op} transaction on scope`);
     idleTransaction.registerBeforeFinishCallback((transaction, endTimestamp) => {
       this._metrics.addPerformanceEntries(transaction);
       adjustTransactionDuration(secToMs(maxTransactionDuration), transaction, endTimestamp);

packages/tracing/src/browser/request.ts

@@ -41,7 +41,7 @@ export interface RequestInstrumentationOptions {
 /** Data returned from fetch callback */
 export interface FetchData {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  args: any[];
+  args: any[]; // the arguments passed to the fetch call itself
   fetchData?: {
     method: string;
     url: string;
@@ -217,6 +217,7 @@ function xhrCallback(
     return;
   }
 
+  // check first if the request has finished and is tracked by an existing span which should now end
   if (handlerData.endTimestamp && handlerData.xhr.__sentry_xhr_span_id__) {
     const span = spans[handlerData.xhr.__sentry_xhr_span_id__];
     if (span) {
@@ -231,6 +232,7 @@ function xhrCallback(
     return;
   }
 
+  // if not, create a new span to track it
   const activeTransaction = getActiveTransaction();
   if (activeTransaction) {
     const span = activeTransaction.startChild({

packages/tracing/src/hubextensions.ts

@@ -184,8 +184,9 @@ function isValidSampleRate(rate: unknown): boolean {
 /**
  * Creates a new transaction and adds a sampling decision if it doesn't yet have one.
  *
- * The Hub.startTransaction method delegates to this method to do its work, passing the Hub instance in as `this`.
- * Exists as a separate function so that it can be injected into the class as an "extension method."
+ * The Hub.startTransaction method delegates to this method to do its work, passing the Hub instance in as `this`, as if
+ * it had been called on the hub directly. Exists as a separate function so that it can be injected into the class as an
+ * "extension method."
  *
  * @param this: The Hub starting the transaction
  * @param transactionContext: Data used to configure the transaction

packages/tracing/test/hub.test.ts

@@ -156,14 +156,14 @@ describe('Hub', () => {
         expect(transaction.sampled).toBe(false);
       });
 
-      it('should not sample transactions when tracesSampleRate is 0', () => {
+      it('should set sampled = false if tracesSampleRate is 0', () => {
         const hub = new Hub(new BrowserClient({ tracesSampleRate: 0 }));
         const transaction = hub.startTransaction({ name: 'dogpark' });
 
         expect(transaction.sampled).toBe(false);
       });
 
-      it('should sample transactions when tracesSampleRate is 1', () => {
+      it('should set sampled = true if tracesSampleRate is 1', () => {
         const hub = new Hub(new BrowserClient({ tracesSampleRate: 1 }));
         const transaction = hub.startTransaction({ name: 'dogpark' });
 

packages/utils/src/instrument.ts

@@ -141,7 +141,7 @@ function instrumentFetch(): void {
 
   fill(global, 'fetch', function(originalFetch: () => void): () => void {
     return function(...args: any[]): void {
-      const commonHandlerData = {
+      const handlerData = {
         args,
         fetchData: {
           method: getFetchMethod(args),
@@ -151,22 +151,22 @@ function instrumentFetch(): void {
       };
 
       triggerHandlers('fetch', {
-        ...commonHandlerData,
+        ...handlerData,
       });
 
       // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
       return originalFetch.apply(global, args).then(
         (response: Response) => {
           triggerHandlers('fetch', {
-            ...commonHandlerData,
+            ...handlerData,
             endTimestamp: Date.now(),
             response,
           });
           return response;
         },
         (error: Error) => {
           triggerHandlers('fetch', {
-            ...commonHandlerData,
+            ...handlerData,
             endTimestamp: Date.now(),
             error,
           });
@@ -223,7 +223,7 @@ function instrumentXHR(): void {
     return;
   }
 
-  // Poor man implementation of ES6 `Map` by tracking and keeping in sync key and value separately.
+  // Poor man's implementation of ES6 `Map`, tracking and keeping in sync key and value separately.
   const requestKeys: XMLHttpRequest[] = [];
   const requestValues: Array<any>[] = [];
   const xhrproto = XMLHttpRequest.prototype;
@@ -260,7 +260,7 @@ function instrumentXHR(): void {
           try {
             const requestPos = requestKeys.indexOf(xhr);
             if (requestPos !== -1) {
-              // Make sure to pop both, key and value to keep it in sync.
+              // Make sure to pop both key and value to keep it in sync.
               requestKeys.splice(requestPos);
               const args = requestValues.splice(requestPos)[0];
               if (xhr.__sentry_xhr__ && args[0] !== undefined) {