fix(core): Permanent idle timeout cancel finishes the transaction with the last finished child

Author: krystofwoldrich

packages/core/src/tracing/idletransaction.ts

@@ -239,10 +239,10 @@ export class IdleTransaction extends Transaction {
       restartOnChildSpanChange: true,
     },
   ): void {
+    this._idleTimeoutCanceledPermanently = restartOnChildSpanChange === false;
     if (this._idleTimeoutID) {
       clearTimeout(this._idleTimeoutID);
       this._idleTimeoutID = undefined;
-      this._idleTimeoutCanceledPermanently = restartOnChildSpanChange === false;
 
       if (Object.keys(this.activities).length === 0 && this._idleTimeoutCanceledPermanently) {
         this._finishReason = IDLE_TRANSACTION_FINISH_REASONS[5];
@@ -269,7 +269,7 @@ export class IdleTransaction extends Transaction {
    * @param spanId The span id that represents the activity
    */
   private _pushActivity(spanId: string): void {
-    this.cancelIdleTimeout();
+    this.cancelIdleTimeout(undefined, { restartOnChildSpanChange: !this._idleTimeoutCanceledPermanently });
     __DEBUG_BUILD__ && logger.log(`[Tracing] pushActivity: ${spanId}`);
     this.activities[spanId] = true;
     __DEBUG_BUILD__ && logger.log('[Tracing] new activities count', Object.keys(this.activities).length);

packages/tracing/test/idletransaction.test.ts

@@ -248,6 +248,40 @@ describe('IdleTransaction', () => {
   });
 
   describe('cancelIdleTimeout', () => {
+    it('permanent idle timeout cancel is not restarted by child span start', () => {
+      const idleTimeout = 10;
+      const transaction = new IdleTransaction({ name: 'foo', startTimestamp: 1234 }, hub, idleTimeout);
+      transaction.initSpanRecorder(10);
+
+      const firstSpan = transaction.startChild({});
+      transaction.cancelIdleTimeout(undefined, { restartOnChildSpanChange: false });
+      const secondSpan = transaction.startChild({});
+      firstSpan.finish();
+      secondSpan.finish();
+
+      expect(transaction.endTimestamp).toBeDefined();
+    });
+
+    it('permanent idle timeout cancel finished the transaction with the last child', () => {
+      const idleTimeout = 10;
+      const transaction = new IdleTransaction({ name: 'foo', startTimestamp: 1234 }, hub, idleTimeout);
+      transaction.initSpanRecorder(10);
+
+      const firstSpan = transaction.startChild({});
+      transaction.cancelIdleTimeout(undefined, { restartOnChildSpanChange: false });
+      const secondSpan = transaction.startChild({});
+      const thirdSpan = transaction.startChild({});
+
+      firstSpan.finish();
+      expect(transaction.endTimestamp).toBeUndefined();
+
+      secondSpan.finish();
+      expect(transaction.endTimestamp).toBeUndefined();
+
+      thirdSpan.finish();
+      expect(transaction.endTimestamp).toBeDefined();
+    });
+
     it('permanent idle timeout cancel finishes transaction if there are no activities', () => {
       const idleTimeout = 10;
       const transaction = new IdleTransaction({ name: 'foo', startTimestamp: 1234 }, hub, idleTimeout);