@ai-sdk/workflow 1.0.66 → 1.0.68

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @ai-sdk/workflow
 
+## 1.0.68
+
+### Patch Changes
+
+- e6064c5: Honor `WorkflowAgent` model-call retry settings without stacking workflow step retries.
+- 83f9b12: Expose the original value from model stream error parts on resolved WorkflowAgent results without retrying the durable model step.
+  - ai@7.0.67
+
+## 1.0.67
+
+### Patch Changes
+
+- e3325bd: Fix `WorkflowAgent` timeout handling by enforcing absolute deadlines inside durable model-call steps and routing timeouts through abort handling.
+
 ## 1.0.66
 
 ### Patch Changes

package/dist/index.d.ts

@@ -137,8 +137,7 @@ interface GenerationSettings {
      */
     seed?: number;
     /**
-     * Maximum number of retries. Set to 0 to disable retries.
-     * Note: In workflow context, retries are typically handled by the workflow step mechanism.
+     * Maximum number of retries for retryable model call failures. Set to 0 to disable retries.
      * @default 2
      */
     maxRetries?: number;
@@ -911,6 +910,14 @@ interface WorkflowAgentStreamResult<TTools extends ToolSet = ToolSet, OUTPUT = n
      * The finish reason from the last step.
      */
     finishReason: FinishReason;
+    /**
+     * The original value from a model stream error part.
+     *
+     * This property is present when the model emitted an error part, including
+     * when the supplied value is `undefined`. Check with `'error' in result` to
+     * distinguish that case from a result without a model stream error.
+     */
+    error?: unknown;
     /**
      * The total token usage across all steps.
      */

package/dist/index.js

@@ -1,6 +1,7 @@
 // src/workflow-agent.ts
 import {
   getErrorMessage,
+  isAbortError as isAbortError2,
   validateTypes,
   withUserAgentSuffix
 } from "@ai-sdk/provider-utils";
@@ -12,7 +13,6 @@ import {
   createRestrictedTelemetryDispatcher as createRestrictedTelemetryDispatcher2,
   collectToolApprovals,
   convertToLanguageModelPrompt,
-  mergeAbortSignals,
   mergeCallbacks,
   standardizePrompt,
   validateApprovedToolApprovals
@@ -74,10 +74,12 @@ import {
 import { createRestrictedTelemetryDispatcher } from "ai/internal";
 
 // src/do-stream-step.ts
+import { isAbortError } from "@ai-sdk/provider-utils";
 import {
   experimental_streamLanguageModelCall as streamModelCall,
   gateway
 } from "ai";
+import { prepareRetries } from "ai/internal";
 
 // src/serializable-schema.ts
 import {
@@ -165,6 +167,12 @@ function resolveSerializableTools(tools) {
 // src/do-stream-step.ts
 async function doStreamStep(conversationPrompt, modelInit, writable, serializedTools, options) {
   "use step";
+  var _a;
+  const timeout = (options == null ? void 0 : options.timeoutAt) == null ? void 0 : options.timeoutAt - Date.now();
+  if (((_a = options == null ? void 0 : options.abortSignal) == null ? void 0 : _a.aborted) || timeout != null && timeout <= 0) {
+    return { aborted: true };
+  }
+  const abortSignal = timeout == null ? options == null ? void 0 : options.abortSignal : (options == null ? void 0 : options.abortSignal) == null ? AbortSignal.timeout(timeout) : AbortSignal.any([options.abortSignal, AbortSignal.timeout(timeout)]);
   const model = typeof modelInit === "string" ? gateway.languageModel(modelInit) : modelInit;
   const tools = serializedTools ? resolveSerializableTools(serializedTools) : void 0;
   const output = (options == null ? void 0 : options.responseFormat) == null ? void 0 : {
@@ -182,31 +190,50 @@ async function doStreamStep(conversationPrompt, modelInit, writable, serializedT
       return void 0;
     }
   };
-  const { stream: modelStream } = await streamModelCall({
-    model,
-    // streamModelCall expects Prompt (ModelMessage[]) but we pass the
-    // pre-converted LanguageModelV4Prompt. standardizePrompt inside
-    // streamModelCall handles both formats.
-    messages: conversationPrompt,
-    allowSystemInMessages: true,
-    tools,
-    toolChoice: options == null ? void 0 : options.toolChoice,
-    includeRawChunks: options == null ? void 0 : options.includeRawChunks,
-    providerOptions: options == null ? void 0 : options.providerOptions,
-    abortSignal: options == null ? void 0 : options.abortSignal,
-    headers: options == null ? void 0 : options.headers,
-    reasoning: options == null ? void 0 : options.reasoning,
-    output,
-    maxOutputTokens: options == null ? void 0 : options.maxOutputTokens,
-    temperature: options == null ? void 0 : options.temperature,
-    topP: options == null ? void 0 : options.topP,
-    topK: options == null ? void 0 : options.topK,
-    presencePenalty: options == null ? void 0 : options.presencePenalty,
-    frequencyPenalty: options == null ? void 0 : options.frequencyPenalty,
-    stopSequences: options == null ? void 0 : options.stopSequences,
-    seed: options == null ? void 0 : options.seed,
-    repairToolCall: options == null ? void 0 : options.repairToolCall
+  const { retry } = prepareRetries({
+    maxRetries: options == null ? void 0 : options.maxRetries,
+    abortSignal
   });
+  const modelStream = await (async () => {
+    try {
+      const { stream } = await retry(
+        () => streamModelCall({
+          model,
+          // streamModelCall expects Prompt (ModelMessage[]) but we pass the
+          // pre-converted LanguageModelV4Prompt. standardizePrompt inside
+          // streamModelCall handles both formats.
+          messages: conversationPrompt,
+          allowSystemInMessages: true,
+          tools,
+          toolChoice: options == null ? void 0 : options.toolChoice,
+          includeRawChunks: options == null ? void 0 : options.includeRawChunks,
+          providerOptions: options == null ? void 0 : options.providerOptions,
+          abortSignal,
+          headers: options == null ? void 0 : options.headers,
+          reasoning: options == null ? void 0 : options.reasoning,
+          output,
+          maxOutputTokens: options == null ? void 0 : options.maxOutputTokens,
+          temperature: options == null ? void 0 : options.temperature,
+          topP: options == null ? void 0 : options.topP,
+          topK: options == null ? void 0 : options.topK,
+          presencePenalty: options == null ? void 0 : options.presencePenalty,
+          frequencyPenalty: options == null ? void 0 : options.frequencyPenalty,
+          stopSequences: options == null ? void 0 : options.stopSequences,
+          seed: options == null ? void 0 : options.seed,
+          repairToolCall: options == null ? void 0 : options.repairToolCall
+        })
+      );
+      return stream;
+    } catch (error) {
+      if ((abortSignal == null ? void 0 : abortSignal.aborted) && isAbortError(error)) {
+        return void 0;
+      }
+      throw error;
+    }
+  })();
+  if (modelStream == null) {
+    return { aborted: true };
+  }
   const toolCalls = [];
   const providerExecutedToolResults = /* @__PURE__ */ new Map();
   let finish;
@@ -214,6 +241,8 @@ async function doStreamStep(conversationPrompt, modelInit, writable, serializedT
   const reasoningParts = [];
   let responseMetadata;
   let warnings;
+  let terminalError;
+  let hasTerminalError = false;
   const writer = writable == null ? void 0 : writable.getWriter();
   try {
     for await (const part of modelStream) {
@@ -279,10 +308,22 @@ async function doStreamStep(conversationPrompt, modelInit, writable, serializedT
       if (writer) {
         await writer.write(part);
       }
+      if (part.type === "error" && !hasTerminalError) {
+        terminalError = part.error;
+        hasTerminalError = true;
+      }
+    }
+  } catch (error) {
+    if ((abortSignal == null ? void 0 : abortSignal.aborted) && isAbortError(error)) {
+      return { aborted: true };
     }
+    throw error;
   } finally {
     writer == null ? void 0 : writer.releaseLock();
   }
+  if ((abortSignal == null ? void 0 : abortSignal.aborted) || (options == null ? void 0 : options.timeoutAt) != null && options.timeoutAt <= Date.now()) {
+    return { aborted: true };
+  }
   return {
     toolCalls,
     finish,
@@ -292,9 +333,11 @@ async function doStreamStep(conversationPrompt, modelInit, writable, serializedT
       responseMetadata,
       warnings
     },
-    providerExecutedToolResults
+    providerExecutedToolResults,
+    ...hasTerminalError ? { terminalError } : {}
   };
 }
+doStreamStep.maxRetries = 0;
 
 // src/stream-text-iterator.ts
 var prepareStepGenerationSettingKeys = [
@@ -339,6 +382,7 @@ async function* streamTextIterator({
   toolsContext,
   telemetry,
   includeRawChunks = false,
+  timeoutAt,
   repairToolCall,
   responseFormat,
   experimental_sandbox: sandbox
@@ -357,6 +401,9 @@ async function* streamTextIterator({
   let stepNumber = 0;
   let lastStep;
   let lastStepWasToolCalls = false;
+  let wasAborted = false;
+  let terminalError;
+  let hasTerminalError = false;
   const telemetryDispatcher = createRestrictedTelemetryDispatcher({
     telemetry,
     includeRuntimeContext: telemetry == null ? void 0 : telemetry.includeRuntimeContext,
@@ -472,7 +519,7 @@ async function* streamTextIterator({
         providerOptions: currentGenerationSettings.providerOptions,
         headers: currentGenerationSettings.headers
       }));
-      const { toolCalls, finish, raw, providerExecutedToolResults } = await doStreamStep(
+      const streamStepResult = await doStreamStep(
         conversationPrompt,
         currentModel,
         writable,
@@ -481,10 +528,20 @@ async function* streamTextIterator({
           ...currentGenerationSettings,
           toolChoice: currentToolChoice,
           includeRawChunks,
+          timeoutAt,
           repairToolCall,
           responseFormat
         }
       );
+      if (streamStepResult.aborted) {
+        wasAborted = true;
+        break;
+      }
+      if ("terminalError" in streamStepResult) {
+        terminalError = streamStepResult.terminalError;
+        hasTerminalError = true;
+      }
+      const { toolCalls, finish, raw, providerExecutedToolResults } = streamStepResult;
       const step = buildStepResult(raw, toolCalls, finish, {
         stepNumber,
         runtimeContext: currentRuntimeContext,
@@ -506,7 +563,9 @@ async function* streamTextIterator({
       lastStep = step;
       lastStepWasToolCalls = false;
       const finishReason = finish == null ? void 0 : finish.finishReason;
-      if (finishReason === "tool-calls") {
+      if (hasTerminalError) {
+        done = true;
+      } else if (finishReason === "tool-calls") {
         lastStepWasToolCalls = true;
         const textContent = step.content.filter(
           (item) => item.type === "text"
@@ -600,6 +659,12 @@ async function* streamTextIterator({
       experimental_sandbox: sandbox
     };
   }
+  if (wasAborted) {
+    return { aborted: true, messages: conversationPrompt };
+  }
+  if (hasTerminalError) {
+    return { error: terminalError, messages: conversationPrompt };
+  }
   return conversationPrompt;
 }
 function getModelInfo(model) {
@@ -763,7 +828,7 @@ var WorkflowAgent = class {
     throw new Error("Not implemented");
   }
   async stream(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B, _C, _D, _E, _F, _G, _H, _I, _J, _K, _L, _M, _N, _O, _P, _Q, _R, _S, _T;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B, _C, _D, _E, _F, _G, _H, _I, _J, _K, _L, _M, _N, _O, _P, _Q, _R, _S, _T, _U;
     const { onFinish, onEnd = onFinish } = options;
     let effectiveModel = this.model;
     let effectiveInstructions = (_b = (_a = options.instructions) != null ? _a : options.system) != null ? _b : this.instructions;
@@ -1108,10 +1173,8 @@ var WorkflowAgent = class {
       supportedUrls: {},
       download
     });
-    const effectiveAbortSignal = mergeAbortSignals(
-      (_r = options.abortSignal) != null ? _r : effectiveGenerationSettings.abortSignal,
-      options.timeout
-    );
+    const effectiveAbortSignal = (_r = options.abortSignal) != null ? _r : effectiveGenerationSettings.abortSignal;
+    const timeoutAt = options.timeout == null ? void 0 : Date.now() + options.timeout;
     const mergedGenerationSettings = {
       ...effectiveGenerationSettings,
       ...options.maxOutputTokens !== void 0 && {
@@ -1389,7 +1452,6 @@ var WorkflowAgent = class {
       stopConditions: effectiveStopWhenFromPrepare,
       onStepEnd: mergedOnStepEnd,
       onStepStart: mergedOnStepStart,
-      onError: options.onError,
       prepareStep: (_z = options.prepareStep) != null ? _z : this.prepareStep,
       generationSettings: mergedGenerationSettings,
       toolChoice: effectiveToolChoice,
@@ -1397,13 +1459,17 @@ var WorkflowAgent = class {
       toolsContext,
       telemetry: effectiveTelemetry,
       includeRawChunks: (_A = options.includeRawChunks) != null ? _A : false,
+      timeoutAt,
       repairToolCall: (_C = (_B = options.repairToolCall) != null ? _B : options.experimental_repairToolCall) != null ? _C : this.repairToolCall,
       responseFormat: await ((_E = (_D = options.output) != null ? _D : this.output) == null ? void 0 : _E.responseFormat),
       experimental_sandbox: sandbox
     });
     let finalMessages;
     let encounteredError;
+    let hasEncounteredError = false;
     let wasAborted = false;
+    let terminalError;
+    let hasTerminalError = false;
     try {
       let result = await iterator.next();
       while (!result.done) {
@@ -1700,11 +1766,24 @@ var WorkflowAgent = class {
         }
       }
       if (result.done) {
-        finalMessages = result.value;
+        if (Array.isArray(result.value)) {
+          finalMessages = result.value;
+        } else if ("error" in result.value) {
+          finalMessages = result.value.messages;
+          terminalError = result.value.error;
+          hasTerminalError = true;
+        } else {
+          finalMessages = result.value.messages;
+          wasAborted = true;
+          if (options.onAbort) {
+            await options.onAbort({ steps });
+          }
+        }
       }
     } catch (error) {
       encounteredError = error;
-      if (error instanceof Error && error.name === "AbortError") {
+      hasEncounteredError = true;
+      if (isAbortError2(error)) {
         wasAborted = true;
         if (options.onAbort) {
           await options.onAbort({ steps });
@@ -1714,8 +1793,14 @@ var WorkflowAgent = class {
       }
       await ((_L = telemetryDispatcher.onError) == null ? void 0 : _L.call(telemetryDispatcher, error));
     }
+    if (hasTerminalError) {
+      if (options.onError) {
+        await options.onError({ error: terminalError });
+      }
+      await ((_M = telemetryDispatcher.onError) == null ? void 0 : _M.call(telemetryDispatcher, terminalError));
+    }
     const messages = finalMessages != null ? finalMessages : prompt.messages;
-    const effectiveOutput = (_M = options.output) != null ? _M : this.output;
+    const effectiveOutput = (_N = options.output) != null ? _N : this.output;
     let experimentalOutput = void 0;
     if (effectiveOutput && steps.length > 0) {
       const lastStep2 = steps[steps.length - 1];
@@ -1731,20 +1816,21 @@ var WorkflowAgent = class {
             }
           );
         } catch (parseError) {
-          if (!encounteredError) {
+          if (!hasEncounteredError) {
             encounteredError = parseError;
+            hasEncounteredError = true;
           }
         }
       }
     }
     const lastStep = steps[steps.length - 1];
     const totalUsage = aggregateUsage(steps);
-    const finishReason = (_N = lastStep == null ? void 0 : lastStep.finishReason) != null ? _N : "other";
+    const finishReason = (_O = lastStep == null ? void 0 : lastStep.finishReason) != null ? _O : "other";
     if (mergedOnEnd && !wasAborted) {
       await mergedOnEnd({
         steps,
         messages,
-        text: (_O = lastStep == null ? void 0 : lastStep.text) != null ? _O : "",
+        text: (_P = lastStep == null ? void 0 : lastStep.text) != null ? _P : "",
         finishReason,
         usage: totalUsage,
         totalUsage,
@@ -1756,17 +1842,17 @@ var WorkflowAgent = class {
     if (!wasAborted && steps.length > 0) {
       const telemetrySteps = steps.map(normalizeStepForTelemetry2);
       const lastTelemetryStep = telemetrySteps[telemetrySteps.length - 1];
-      await ((_P = telemetryDispatcher.onEnd) == null ? void 0 : _P.call(telemetryDispatcher, {
+      await ((_Q = telemetryDispatcher.onEnd) == null ? void 0 : _Q.call(telemetryDispatcher, {
         ...lastTelemetryStep,
         steps: telemetrySteps,
         usage: totalUsage,
         totalUsage
       }));
     }
-    if (encounteredError) {
+    if (hasEncounteredError) {
       if (options.writable) {
-        const sendFinish = (_Q = options.sendFinish) != null ? _Q : true;
-        const preventClose = (_R = options.preventClose) != null ? _R : false;
+        const sendFinish = (_R = options.sendFinish) != null ? _R : true;
+        const preventClose = (_S = options.preventClose) != null ? _S : false;
         if (sendFinish || !preventClose) {
           await closeStream(options.writable, preventClose, sendFinish);
         }
@@ -1774,8 +1860,8 @@ var WorkflowAgent = class {
       throw encounteredError;
     }
     if (options.writable) {
-      const sendFinish = (_S = options.sendFinish) != null ? _S : true;
-      const preventClose = (_T = options.preventClose) != null ? _T : false;
+      const sendFinish = (_T = options.sendFinish) != null ? _T : true;
+      const preventClose = (_U = options.preventClose) != null ? _U : false;
       if (sendFinish || !preventClose) {
         await closeStream(options.writable, preventClose, sendFinish);
       }
@@ -1787,7 +1873,8 @@ var WorkflowAgent = class {
       toolResults: lastStepToolResults,
       finishReason,
       totalUsage,
-      output: experimentalOutput
+      output: experimentalOutput,
+      ...hasTerminalError ? { error: terminalError } : {}
     };
   }
 };