set source to 'custom' when name is changed directly on transaction

Author: lobsterkatie

packages/tracing/src/transaction.ts

@@ -15,15 +15,15 @@ import { Span as SpanClass, SpanRecorder } from './span';
 
 /** JSDoc */
 export class Transaction extends SpanClass implements TransactionInterface {
-  public name: string;
-
   public metadata: TransactionMetadata;
 
   /**
    * The reference to the current hub.
    */
   public readonly _hub: Hub;
 
+  private _name: string;
+
   private _measurements: Measurements = {};
 
   private _trimEnd?: boolean;
@@ -40,7 +40,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
 
     this._hub = hub || getCurrentHub();
 
-    this.name = transactionContext.name || '';
+    this._name = transactionContext.name || '';
 
     this.metadata = transactionContext.metadata || {};
     this._trimEnd = transactionContext.trimEnd;
@@ -49,11 +49,23 @@ export class Transaction extends SpanClass implements TransactionInterface {
     this.transaction = this;
   }
 
+  /** Getter for `name` property */
+  public get name(): string {
+    return this._name;
+  }
+
+  /** Setter for `name` property, which also sets `source` */
+  public set name(newName: string) {
+    this._name = newName;
+    this.metadata.source = 'custom';
+  }
+
   /**
    * JSDoc
    */
-  public setName(name: string): void {
+  public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
     this.name = name;
+    this.metadata.source = source;
   }
 
   /**

packages/tracing/test/transaction.test.ts

@@ -0,0 +1,45 @@
+import { Transaction } from '../src/transaction';
+
+describe('`Transaction` class', () => {
+  describe('transaction name source', () => {
+    it('sets source in constructor if provided', () => {
+      const transaction = new Transaction({ name: 'dogpark', metadata: { source: 'route' } });
+
+      expect(transaction.name).toEqual('dogpark');
+      expect(transaction.metadata.source).toEqual('route');
+    });
+
+    it("doesn't set source in constructor if not provided", () => {
+      const transaction = new Transaction({ name: 'dogpark' });
+
+      expect(transaction.name).toEqual('dogpark');
+      expect(transaction.metadata.source).toBeUndefined();
+    });
+
+    it("sets source to `'custom'` when assigning to `name` property", () => {
+      const transaction = new Transaction({ name: 'dogpark' });
+      transaction.name = 'ballpit';
+
+      expect(transaction.name).toEqual('ballpit');
+      expect(transaction.metadata.source).toEqual('custom');
+    });
+
+    describe('`setName` method', () => {
+      it("sets source to `'custom'` if no source provided", () => {
+        const transaction = new Transaction({ name: 'dogpark' });
+        transaction.setName('ballpit');
+
+        expect(transaction.name).toEqual('ballpit');
+        expect(transaction.metadata.source).toEqual('custom');
+      });
+
+      it('uses given `source` value', () => {
+        const transaction = new Transaction({ name: 'dogpark' });
+        transaction.setName('ballpit', 'route');
+
+        expect(transaction.name).toEqual('ballpit');
+        expect(transaction.metadata.source).toEqual('route');
+      });
+    });
+  });
+});