@salesforce/sfdx-agent-sdk 0.86.0 → 0.87.0

package/CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to `@salesforce/sfdx-agent-sdk` are documented in this file.
 Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [0.87.0] - 2026-09-17
+
+### Fixes
+- **agent-sdk,harness-mastra**: classify aborted turns as finishReason 'cancelled' at the pre-stream sites @W-23749670@ ([#830](https://github.com/forcedotcom/agentic-dx/pull/830))
+
 ## [0.86.0] - 2026-09-16
 
 ### Features

package/dist/chat-session.d.ts

@@ -673,14 +673,11 @@ export declare class DefaultChatSession implements ChatSession {
      * `abortSignal` is `chat()`'s composed signal — `cancelTurn()`'s own per-turn controller
      * folded together with any caller-supplied `options.abortSignal` — checked before starting
      * the occupancy read and again before calling `compactThread`, so an abort from EITHER source
-     * that lands while this is running skips (rather than starts) compaction. This narrows, but
-     * does not close, the window an abort can block on: `AgentHarness.compactThread` takes no
-     * `AbortSignal`, so a `compactThread` call already in flight when the signal aborts cannot be
-     * interrupted — the caller blocks for the remaining compaction latency, and if
-     * `harness.stream()` subsequently runs against an already-aborted signal, the turn can end via
-     * `notifyPreStreamError` with `finishReason: 'error'` rather than `'cancelled'`. See
-     * `cancelTurn()`'s Critical Invariant below for the full contract and why this residual gap is
-     * accepted for now.
+     * that lands while this is running skips (rather than starts) compaction. An abort that instead
+     * lands DURING an in-flight `compactThread` can't preempt it (`compactThread` takes no
+     * `AbortSignal` by design); the post-compaction `stream()` then rejects with an `AbortError`
+     * that `notifyPreStreamError` classifies to `finishReason: 'cancelled'`. See `cancelTurn()`'s
+     * Critical Invariant in ARCHITECTURE.md for the full rationale.
      */
     private maybeAutoCompact;
     /**
@@ -810,6 +807,13 @@ export declare class DefaultChatSession implements ChatSession {
      * same `(agentId, threadId)` pair.
      */
     private emitChatStreamStarted;
+    /**
+     * Terminal {@link FinishReason} for a failure: `'cancelled'` when {@link isAbortError} (a user
+     * cancel), else `'error'`. See the `cancelTurn` Critical Invariant in ARCHITECTURE.md.
+     */
+    private finishReasonForError;
+    /** Terminal `ErrorEvent` for a failure — abort → `code: 'cancelled'`, matching {@link finishReasonForError}. */
+    private errorEventFor;
     /**
      * Emits an `ErrorEvent` + `FinishEvent` to all `subscribe()` listeners and a `chat-stream-error`
      * telemetry event for a failure that occurred before a stream was established. The caller is

package/dist/chat-session.js

@@ -2,7 +2,7 @@
  * Copyright 2026, Salesforce, Inc. All rights reserved.
  * See LICENSE.txt for license terms.
  */
-import { backfillCreatedAt, EventBus, LogBus, RealClock, UUIDGenerator, } from '@salesforce/agentic-common';
+import { backfillCreatedAt, EventBus, isAbortError, LogBus, RealClock, UUIDGenerator, } from '@salesforce/agentic-common';
 import { resolveAutoCompactionThreshold } from './harness/harness-config.js';
 import { resolveToolDeclineModelMessage } from './harness/tool-decline.js';
 import { AgentSDKError, AgentSDKErrorType } from './errors.js';
@@ -382,7 +382,7 @@ export class DefaultChatSession {
         }
         catch (err) {
             const error = err instanceof Error ? err : new Error(String(err));
-            const errorEvent = { type: 'error', error };
+            const errorEvent = this.errorEventFor(error);
             this.chatEventBus.emit(errorEvent);
             yield errorEvent;
             lastError = error;
@@ -405,7 +405,7 @@ export class DefaultChatSession {
             this.turnActive = false;
         }
         if (!sawFinish && lastError !== undefined) {
-            const finishEvent = { type: 'finish', finishReason: 'error' };
+            const finishEvent = { type: 'finish', finishReason: this.finishReasonForError(lastError) };
             this.chatEventBus.emit(finishEvent);
             yield finishEvent;
             // Match the natural-finish branch: every terminal `finish` clears the
@@ -731,14 +731,11 @@ export class DefaultChatSession {
      * `abortSignal` is `chat()`'s composed signal — `cancelTurn()`'s own per-turn controller
      * folded together with any caller-supplied `options.abortSignal` — checked before starting
      * the occupancy read and again before calling `compactThread`, so an abort from EITHER source
-     * that lands while this is running skips (rather than starts) compaction. This narrows, but
-     * does not close, the window an abort can block on: `AgentHarness.compactThread` takes no
-     * `AbortSignal`, so a `compactThread` call already in flight when the signal aborts cannot be
-     * interrupted — the caller blocks for the remaining compaction latency, and if
-     * `harness.stream()` subsequently runs against an already-aborted signal, the turn can end via
-     * `notifyPreStreamError` with `finishReason: 'error'` rather than `'cancelled'`. See
-     * `cancelTurn()`'s Critical Invariant below for the full contract and why this residual gap is
-     * accepted for now.
+     * that lands while this is running skips (rather than starts) compaction. An abort that instead
+     * lands DURING an in-flight `compactThread` can't preempt it (`compactThread` takes no
+     * `AbortSignal` by design); the post-compaction `stream()` then rejects with an `AbortError`
+     * that `notifyPreStreamError` classifies to `finishReason: 'cancelled'`. See `cancelTurn()`'s
+     * Critical Invariant in ARCHITECTURE.md for the full rationale.
      */
     async maybeAutoCompact(abortSignal) {
         if (this.harness.hasNativeAutoCompaction || abortSignal.aborted)
@@ -1132,6 +1129,17 @@ export class DefaultChatSession {
         this.telemetryBus.emitTelemetry({ type: 'chat-stream-started', agentId: this.agentId, threadId: this.threadId, trigger }, startedAt);
         return startedAt;
     }
+    /**
+     * Terminal {@link FinishReason} for a failure: `'cancelled'` when {@link isAbortError} (a user
+     * cancel), else `'error'`. See the `cancelTurn` Critical Invariant in ARCHITECTURE.md.
+     */
+    finishReasonForError(err) {
+        return isAbortError(err) ? 'cancelled' : 'error';
+    }
+    /** Terminal `ErrorEvent` for a failure — abort → `code: 'cancelled'`, matching {@link finishReasonForError}. */
+    errorEventFor(error) {
+        return isAbortError(error) ? { type: 'error', error, code: 'cancelled' } : { type: 'error', error };
+    }
     /**
      * Emits an `ErrorEvent` + `FinishEvent` to all `subscribe()` listeners and a `chat-stream-error`
      * telemetry event for a failure that occurred before a stream was established. The caller is
@@ -1146,8 +1154,8 @@ export class DefaultChatSession {
      */
     notifyPreStreamError(err, startedAt, threadId) {
         const error = err instanceof Error ? err : new Error(String(err));
-        this.chatEventBus.emit({ type: 'error', error });
-        this.chatEventBus.emit({ type: 'finish', finishReason: 'error' });
+        this.chatEventBus.emit(this.errorEventFor(error));
+        this.chatEventBus.emit({ type: 'finish', finishReason: this.finishReasonForError(error) });
         const finishedAt = this.clock.now();
         const durationMs = finishedAt.getTime() - startedAt.getTime();
         // Tier-1 pair: share one tick across the telemetry event and its colocated log sibling.
@@ -1178,8 +1186,8 @@ export class DefaultChatSession {
      */
     notifySettleRejection(err) {
         const error = err instanceof Error ? err : new Error(String(err));
-        this.chatEventBus.emit({ type: 'error', error });
-        this.chatEventBus.emit({ type: 'finish', finishReason: 'error' });
+        this.chatEventBus.emit(this.errorEventFor(error));
+        this.chatEventBus.emit({ type: 'finish', finishReason: this.finishReasonForError(error) });
     }
     assertNotDisposed() {
         if (this.disposed) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sfdx-agent-sdk",
-  "version": "0.86.0",
+  "version": "0.87.0",
   "description": "Harness-agnostic agentic infrastructure for Salesforce developer experience tooling",
   "type": "module",
   "main": "dist/index.js",
@@ -48,9 +48,9 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@salesforce/sfdx-agent-harness-claude": "0.82.0",
-    "@salesforce/sfdx-agent-harness-mastra": "0.85.0",
-    "@salesforce/sfdx-agent-harness-openai": "0.51.0",
+    "@salesforce/sfdx-agent-harness-claude": "0.83.0",
+    "@salesforce/sfdx-agent-harness-mastra": "0.86.0",
+    "@salesforce/sfdx-agent-harness-openai": "0.52.0",
     "@types/node": "^22.20.1",
     "@vitest/coverage-istanbul": "^4.1.11",
     "@vitest/eslint-plugin": "^1.6.27",