chore(various): Fix typos and other tiny problems (#3226)

No behavior changes.

Author: lobsterkatie

packages/core/src/api.ts

@@ -9,11 +9,20 @@ const SENTRY_API_VERSION = '7';
  * Supports both envelopes and regular event requests.
  **/
 export class API {
+  /** The DSN as passed to Sentry.init() */
+  public dsn: DsnLike;
+
+  /** Metadata about the SDK (name, version, etc) for inclusion in envelope headers */
+  public metadata: SdkMetadata;
+
   /** The internally used Dsn object. */
   private readonly _dsnObject: Dsn;
+
   /** Create a new instance of API */
-  public constructor(public dsn: DsnLike, public metadata: SdkMetadata = {}) {
+  public constructor(dsn: DsnLike, metadata: SdkMetadata = {}) {
+    this.dsn = dsn;
     this._dsnObject = new Dsn(dsn);
+    this.metadata = metadata;
   }
 
   /** Returns the Dsn object. */

packages/core/src/baseclient.ts

@@ -40,7 +40,7 @@ import { IntegrationIndex, setupIntegrations } from './integration';
  * without a valid Dsn, the SDK will not send any events to Sentry.
  *
  * Before sending an event via the backend, it is passed through
- * {@link BaseClient.prepareEvent} to add SDK information and scope data
+ * {@link BaseClient._prepareEvent} to add SDK information and scope data
  * (breadcrumbs and context). To add more custom information, override this
  * method and extend the resulting prepared event.
  *
@@ -428,7 +428,7 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
 
   /**
    * This function adds all used integrations to the SDK info in the event.
-   * @param sdkInfo The sdkInfo of the event that will be filled with all integrations.
+   * @param event The event that will be filled with all integrations.
    */
   protected _applyIntegrationsMetadata(event: Event): void {
     const sdkInfo = event.sdk;

packages/hub/src/hub.ts

@@ -537,6 +537,7 @@ export function getHubFromCarrier(carrier: Carrier): Hub {
  * This will set passed {@link Hub} on the passed object's __SENTRY__.hub attribute
  * @param carrier object
  * @param hub Hub
+ * @returns A boolean indicating success or failure
  */
 export function setHubOnCarrier(carrier: Carrier, hub: Hub): boolean {
   if (!carrier) return false;

packages/node/test/index.test.ts

@@ -69,7 +69,7 @@ describe('SentryNode', () => {
     });
 
     afterEach(() => {
-      s.mockReset();
+      s.mockRestore();
     });
 
     test('record auto breadcrumbs', done => {
@@ -98,7 +98,7 @@ describe('SentryNode', () => {
     });
 
     afterEach(() => {
-      s.mockReset();
+      s.mockRestore();
     });
 
     test('capture an exception', done => {

packages/serverless/src/gcpfunction/general.ts

@@ -61,3 +61,5 @@ export function configureScopeWithContext(scope: Scope, context: Context): void
   scope.setTag('server_name', process.env.SENTRY_NAME || hostname());
   scope.setContext('gcp.function.context', { ...context } as SentryContext);
 }
+
+export { Request, Response };

packages/serverless/test/awsservices.test.ts

@@ -23,7 +23,7 @@ describe('AWSServices', () => {
     nock.restore();
   });
 
-  describe('S3', () => {
+  describe('S3 tracing', () => {
     const s3 = new AWS.S3({ accessKeyId: '-', secretAccessKey: '-' });
 
     test('getObject', async () => {

packages/serverless/test/google-cloud-grpc.test.ts

@@ -76,7 +76,7 @@ function mockHttp2Session(): FakeSession {
   return session;
 }
 
-describe('GoogleCloudGrpc', () => {
+describe('GoogleCloudGrpc tracing', () => {
   beforeAll(() => {
     new GoogleCloudGrpc().setupOnce();
   });

packages/serverless/test/google-cloud-http.test.ts

@@ -13,7 +13,7 @@ import { GoogleCloudHttp } from '../src/google-cloud-http';
  * Thanks to this, we don't have to do more magic than necessary. Just add and export desired method and assert on it.
  */
 
-describe('GoogleCloudHttp', () => {
+describe('GoogleCloudHttp tracing', () => {
   beforeAll(() => {
     new GoogleCloudHttp().setupOnce();
   });

packages/tracing/src/transaction.ts

@@ -37,7 +37,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
       this._hub = hub as Hub;
     }
 
-    this.name = transactionContext.name ? transactionContext.name : '';
+    this.name = transactionContext.name || '';
 
     this._trimEnd = transactionContext.trimEnd;
 

packages/tracing/test/browser/browsertracing.test.ts

@@ -25,6 +25,7 @@ jest.mock('@sentry/utils', () => {
     ...actual,
     addInstrumentationHandler: ({ callback, type }: any): 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;
       }
     },
@@ -64,17 +65,17 @@ describe('BrowserTracing', () => {
   });
 
   function createBrowserTracing(setup?: boolean, _options?: Partial<BrowserTracingOptions>): BrowserTracing {
-    const inst = new BrowserTracing(_options);
+    const instance = new BrowserTracing(_options);
     if (setup) {
       const processor = () => undefined;
-      inst.setupOnce(processor, () => hub);
+      instance.setupOnce(processor, () => hub);
     }
 
-    return inst;
+    return instance;
   }
 
   // These are important enough to check with a test as incorrect defaults could
-  // break a lot of users configurations.
+  // break a lot of users' configurations.
   it('is created with default settings', () => {
     const browserTracing = createBrowserTracing();
 
@@ -126,7 +127,7 @@ describe('BrowserTracing', () => {
     });
 
     describe('tracingOrigins', () => {
-      it('warns and uses default tracing origins if non are provided', () => {
+      it('warns and uses default tracing origins if none are provided', () => {
         const inst = createBrowserTracing(true, {
           routingInstrumentation: customRoutingInstrumentation,
         });