@ssml-builder-js/azure-tts-client 2.16.0 → 2.18.0

package/src/safe.ts

@@ -10,15 +10,23 @@ import {
   type AzureTtsSynthesisError,
   type SynthesisErrorKind,
   toSynthesisError,
+  getRetryAfterDelayMs,
 } from "./errors.ts";
 import type { AzureTtsClient } from "./client.ts";
-import { mergeSynthesisResults } from "./synthesis.ts";
+import { computeChunkFingerprint, mergeSynthesisResults } from "./synthesis.ts";
 import type {
   SsmlSynthesisChunk,
   SsmlSynthesisResult,
   SynthesisProgressEvent,
   SynthesizeChunksOptions,
   RetryOptions,
+  SynthesisTimeouts,
+  SynthesizedChunk,
+  PartialChunkSynthesisResult,
+  CustomAudioMerger,
+  PostMergeValidator,
+  ChunkExecutionState,
+  ResumeValidationMode,
 } from "./types.ts";
 import type { AzureTtsOutputFormat } from "./outputFormats.ts";
 
@@ -43,6 +51,29 @@ export class ChunkValidationError extends Error {
   }
 }
 
+export interface ChunkDiagnostics {
+  readonly chunkIndex: number;
+  readonly diagnostics: readonly SsmlDiagnostic[];
+}
+
+export class BatchChunkValidationError extends ChunkValidationError {
+  readonly chunkDiagnostics: readonly ChunkDiagnostics[];
+  readonly totalErrorCount: number;
+  readonly errorCount: number;
+  readonly totalErrors: number;
+
+  constructor(chunkDiagnostics: readonly ChunkDiagnostics[]) {
+    const first = chunkDiagnostics[0];
+    super(first?.chunkIndex ?? -1, first?.diagnostics ?? []);
+    this.name = "BatchChunkValidationError";
+    this.message = `SSML validation failed for ${chunkDiagnostics.length} chunk(s); the Azure Speech API was not called.`;
+    this.chunkDiagnostics = chunkDiagnostics;
+    this.totalErrorCount = chunkDiagnostics.reduce((total, chunk) => total + chunk.diagnostics.length, 0);
+    this.errorCount = this.totalErrorCount;
+    this.totalErrors = this.totalErrorCount;
+  }
+}
+
 export type Result<T, E> =
   | { readonly ok: true; readonly success: true; readonly status: "success"; readonly value: T }
   | (E extends { readonly kind: infer Kind extends SynthesisErrorKind }
@@ -51,18 +82,29 @@ export type Result<T, E> =
           readonly success: false;
           readonly status: Kind;
           readonly error: E;
+          readonly partialResult?: PartialChunkSynthesisResult;
         }
       : {
           readonly ok: false;
           readonly success: false;
           readonly status: SynthesisErrorKind;
           readonly error: E;
+          readonly partialResult?: PartialChunkSynthesisResult;
         });
 
 export type SynthesisResult<T, E> = Result<T, E>;
 
-function failure<E extends { readonly kind: SynthesisErrorKind }>(error: E): Result<never, E> {
-  return { ok: false, success: false, status: error.kind, error } as Result<never, E>;
+function failure<E extends { readonly kind: SynthesisErrorKind }>(
+  error: E,
+  partialResult?: PartialChunkSynthesisResult,
+): Result<never, E> {
+  return {
+    ok: false,
+    success: false,
+    status: error.kind,
+    error,
+    ...(partialResult ? { partialResult } : {}),
+  } as Result<never, E>;
 }
 
 export type Success<T> = Extract<Result<T, never>, { readonly ok: true }>;
@@ -81,6 +123,7 @@ export interface SynthesizeSsmlSafeOptions extends AzureValidationOptions {
   /** Optional nested form for callers that want to keep validation settings grouped. */
   validation?: AzureValidationOptions;
   signal?: AbortSignal;
+  timeouts?: SynthesisTimeouts;
 }
 
 export interface SynthesizeSsmlChunksSafeOptions extends AzureValidationOptions {
@@ -88,15 +131,24 @@ export interface SynthesizeSsmlChunksSafeOptions extends AzureValidationOptions
   outputFormat?: string;
   signal?: AbortSignal;
   timeoutMs?: number;
+  timeouts?: SynthesisTimeouts;
   sourceNodePath?: string[];
   onProgress?: (event: SynthesisProgressEvent) => void;
   concurrency?: number;
   retryOptions?: RetryOptions;
+  cancelOnFailure?: boolean;
+  resumeChunks?: readonly SynthesizedChunk[];
+  resumeChunkIndices?: readonly number[];
+  customMerger?: CustomAudioMerger;
+  outputMimeType?: string;
+  postMergeValidator?: PostMergeValidator;
+  resumeValidation?: ResumeValidationMode;
 }
 
 export type SsmlSynthesisChunksSafeResult =
   | Result<SsmlSynthesisResult, never>
   | Result<never, ChunkValidationError>
+  | Result<never, BatchChunkValidationError>
   | Result<never, SsmlSynthesisError | ChunkValidationError>;
 
 interface SynthesisClient {
@@ -107,6 +159,44 @@ interface SynthesisClient {
   ): Promise<SsmlSynthesisResult>;
 }
 
+function partialResultFrom(error: unknown): PartialChunkSynthesisResult | undefined {
+  if (!error || typeof error !== "object") return undefined;
+  const partial = (error as { partialResult?: unknown }).partialResult;
+  if (!partial || typeof partial !== "object") return undefined;
+  return partial as PartialChunkSynthesisResult;
+}
+
+interface SafeAbortScope {
+  signal: AbortSignal;
+  timedOut: () => boolean;
+  dispose: () => void;
+  abort: () => void;
+}
+
+function createSafeAbortScope(parent: AbortSignal | undefined, timeoutMs: number | undefined): SafeAbortScope {
+  const controller = new AbortController();
+  let didTimeout = false;
+  const onAbort = () => controller.abort();
+  if (parent?.aborted) controller.abort();
+  parent?.addEventListener("abort", onAbort, { once: true });
+  const timer =
+    timeoutMs !== undefined && timeoutMs > 0
+      ? setTimeout(() => {
+          didTimeout = true;
+          controller.abort();
+        }, timeoutMs)
+      : undefined;
+  return {
+    signal: controller.signal,
+    timedOut: () => didTimeout,
+    dispose: () => {
+      if (timer) clearTimeout(timer);
+      parent?.removeEventListener("abort", onAbort);
+    },
+    abort: () => controller.abort(),
+  };
+}
+
 function isRetryable(error: unknown): boolean {
   if (error instanceof Error && /cancel|abort|tim(?:e|ed) ?out/i.test(error.message)) return false;
   const status =
@@ -123,6 +213,10 @@ function delayForRetry(options: RetryOptions, attempt: number): number {
   return Math.floor(Math.random() * (base + 1));
 }
 
+function retryDelayForError(options: RetryOptions, attempt: number, error: unknown): number {
+  return getRetryAfterDelayMs(error) ?? delayForRetry(options, attempt);
+}
+
 function resolveConcurrency(value: number | undefined, total: number): number {
   if (value === undefined) return 1;
   if (value === Infinity) return Math.max(1, total);
@@ -134,12 +228,14 @@ async function retryableSynthesis(
   options: RetryOptions | undefined,
   signal: AbortSignal | undefined,
   onRetry: (attempt: number, delayMs: number) => void,
+  deadlineAtMs?: number,
 ): Promise<SsmlSynthesisResult> {
   const retry = options
     ? {
         maxRetries: Math.max(0, Math.floor(options.maxRetries)),
         initialDelayMs: options.initialDelayMs,
         maxDelayMs: options.maxDelayMs,
+        shouldRetry: options.shouldRetry,
       }
     : undefined;
   let attempt = 0;
@@ -148,9 +244,18 @@ async function retryableSynthesis(
     try {
       return await synthesize();
     } catch (error) {
-      if (!retry || attempt >= retry.maxRetries || !isRetryable(error)) throw error;
+      if (!retry || attempt >= retry.maxRetries || !(retry.shouldRetry?.(error, attempt + 1) ?? isRetryable(error)))
+        throw error;
       attempt += 1;
-      const delayMs = delayForRetry(retry, attempt);
+      const delayMs = retryDelayForError(retry, attempt, error);
+      const retryAfterMs = getRetryAfterDelayMs(error);
+      const remainingMs = deadlineAtMs === undefined ? undefined : Math.max(0, deadlineAtMs - Date.now());
+      if (
+        retryAfterMs !== undefined &&
+        (retryAfterMs > retry.maxDelayMs || (remainingMs !== undefined && retryAfterMs > remainingMs))
+      ) {
+        throw new Error("Speech synthesis timed out because Retry-After exceeded the available retry budget.");
+      }
       onRetry(attempt, delayMs);
       if (delayMs > 0)
         await new Promise<void>((resolve, reject) => {
@@ -169,13 +274,20 @@ async function retryableSynthesis(
   }
 }
 
-function sharedValidationOptions(options: AzureValidationOptions, signal?: AbortSignal): AzureValidationOptions {
+function sharedValidationOptions(
+  options: AzureValidationOptions & { timeouts?: SynthesisTimeouts },
+  signal?: AbortSignal,
+): AzureValidationOptions {
   const validator = options.urlValidator ?? options.customUrlValidator;
   if (!validator) return signal ? withValidationSignal(options, signal) : options;
   const runner = createAzureUrlValidatorRunner(validator as AzureUrlValidator, {
     ...(options.urlValidation ?? {}),
     ...(options.urlValidatorConcurrency !== undefined ? { concurrency: options.urlValidatorConcurrency } : {}),
-    ...(options.urlValidatorTimeoutMs !== undefined ? { timeoutMs: options.urlValidatorTimeoutMs } : {}),
+    ...(options.timeouts?.urlValidationMs !== undefined
+      ? { timeoutMs: options.timeouts.urlValidationMs }
+      : options.urlValidatorTimeoutMs !== undefined
+        ? { timeoutMs: options.urlValidatorTimeoutMs }
+        : {}),
     ...(signal ? { signal } : {}),
     ...(options.urlValidatorCache ? { cache: options.urlValidatorCache } : {}),
   });
@@ -206,16 +318,27 @@ export async function synthesizeSsmlSafe(
     });
   }
 
+  const jobScope =
+    options.timeouts?.totalJobMs !== undefined
+      ? createSafeAbortScope(options.signal, options.timeouts.totalJobMs)
+      : undefined;
   try {
     return {
       ok: true,
       success: true,
       status: "success",
-      value: await client.synthesizeSsml(ssml, { signal: options.signal }),
+      value: await client.synthesizeSsml(ssml, {
+        signal: jobScope?.signal ?? options.signal,
+        timeoutMs: options.timeouts?.perChunkMs,
+        timeouts: options.timeouts,
+      }),
     };
   } catch (error) {
+    if (jobScope?.timedOut()) return failure(toSynthesisError(new Error("Speech synthesis timed out.")));
     const synthesisError = toSynthesisError(error);
     return failure(synthesisError);
+  } finally {
+    jobScope?.dispose();
   }
 }
 
@@ -225,7 +348,10 @@ export async function synthesizeSsmlChunksSafe(
   chunks: readonly (SsmlSynthesisChunk | string)[],
   options: SynthesizeSsmlChunksSafeOptions = {},
 ): Promise<SsmlSynthesisChunksSafeResult> {
-  const validationOptions = sharedValidationOptions(options.validation ?? options, options.signal);
+  const validationOptions = sharedValidationOptions(
+    { ...(options.validation ?? options), timeouts: options.timeouts },
+    options.signal,
+  );
   if (options.signal?.aborted) {
     const error = toSynthesisError(new Error("Speech synthesis was cancelled."));
     return failure(error);
@@ -261,17 +387,20 @@ export async function synthesizeSsmlChunksSafe(
       return diagnostics.filter((diagnostic) => diagnostic.severity === "error");
     }),
   );
-  const firstInvalidIndex = validations.findIndex((diagnostics) => diagnostics.length > 0);
   if (options.signal?.aborted) {
     const error = toSynthesisError(new Error("Speech synthesis was cancelled."));
     return failure(error);
   }
-  if (firstInvalidIndex >= 0) {
-    const error = new ChunkValidationError(firstInvalidIndex, validations[firstInvalidIndex] ?? []);
-    pending(firstInvalidIndex, "failed", error);
+  const chunkDiagnostics = validations
+    .map((diagnostics, chunkIndex) => ({ chunkIndex, diagnostics }))
+    .filter((entry) => entry.diagnostics.length > 0);
+  if (chunkDiagnostics.length > 0) {
+    const error = new BatchChunkValidationError(chunkDiagnostics);
+    for (const entry of chunkDiagnostics) pending(entry.chunkIndex, "failed", error);
     return failure(error);
   }
 
+  let fallbackJobScope: SafeAbortScope | undefined;
   try {
     if (client.synthesizeChunks) {
       const normalizedChunks = chunks.map((chunk) => {
@@ -283,20 +412,67 @@ export async function synthesizeSsmlChunksSafe(
         outputFormat: options.outputFormat,
         signal: options.signal,
         timeoutMs: options.timeoutMs,
+        timeouts: options.timeouts,
         sourceNodePath: options.sourceNodePath,
         concurrency: options.concurrency,
         retryOptions: options.retryOptions,
+        cancelOnFailure: options.cancelOnFailure,
+        resumeChunks: options.resumeChunks,
+        resumeChunkIndices: options.resumeChunkIndices,
+        customMerger: options.customMerger,
+        outputMimeType: options.outputMimeType,
+        postMergeValidator: options.postMergeValidator,
+        resumeValidation: options.resumeValidation,
       });
       return { ok: true, success: true, status: "success", value };
     }
+    const inputs = chunks.map((chunk) => (typeof chunk === "string" ? { ssml: chunk } : chunk));
+    const fingerprints = inputs.map((chunk) => computeChunkFingerprint(chunk.ssml, options.outputFormat));
     const results: Array<SsmlSynthesisResult | undefined> = new Array(chunks.length);
-    let completed = 0;
+    const chunkStates: ChunkExecutionState[] = inputs.map((_chunk, chunkIndex) => ({
+      chunkIndex,
+      status: "pending",
+      canResume: true,
+    }));
+    const cachedChunks = new Map((options.resumeChunks ?? []).map((chunk) => [chunk.chunkIndex, chunk]));
+    const invalidCachedIndices = new Set<number>();
+    for (const [index, cached] of cachedChunks) {
+      if (index < 0 || index >= chunks.length) continue;
+      if (options.resumeValidation === "disabled" || cached.fingerprint === fingerprints[index]) {
+        results[index] = cached;
+        chunkStates[index] = { chunkIndex: index, status: "succeeded", canResume: true, result: cached };
+      } else invalidCachedIndices.add(index);
+    }
+    const requestedIndices = options.resumeChunkIndices
+      ? new Set(options.resumeChunkIndices.filter((index) => index >= 0 && index < chunks.length))
+      : undefined;
+    const shouldSynthesize = (index: number): boolean =>
+      (!cachedChunks.has(index) || invalidCachedIndices.has(index)) &&
+      (requestedIndices === undefined || requestedIndices.has(index) || invalidCachedIndices.has(index));
+    const jobStartedAt = Date.now();
+    const jobDeadlineAt =
+      options.timeouts?.totalJobMs !== undefined && options.timeouts.totalJobMs > 0
+        ? jobStartedAt + options.timeouts.totalJobMs
+        : undefined;
+    const jobScope =
+      chunks.length > 1 || options.timeouts?.totalJobMs !== undefined
+        ? createSafeAbortScope(options.signal, options.timeouts?.totalJobMs)
+        : undefined;
+    fallbackJobScope = jobScope;
+    const failedIndices = new Set<number>();
+    let firstError: unknown;
+    let completed = [...results].filter((result) => result !== undefined).length;
     let nextIndex = 0;
     const concurrency = resolveConcurrency(options.concurrency, chunks.length);
     const worker = async (): Promise<void> => {
       while (true) {
         const index = nextIndex++;
         if (index >= chunks.length) return;
+        if (!shouldSynthesize(index)) continue;
+        if (firstError && options.cancelOnFailure !== false) {
+          chunkStates[index] = { chunkIndex: index, status: "cancelled", isOriginalFailure: false, canResume: true };
+          return;
+        }
         const chunk = chunks[index];
         const input = typeof chunk === "string" ? { ssml: chunk } : chunk;
         const sourceNodePath = input.sourceNodePath;
@@ -304,30 +480,46 @@ export async function synthesizeSsmlChunksSafe(
         pending(index, "synthesizing");
         const startedAt = Date.now();
         try {
-          const result = await retryableSynthesis(
-            () =>
-              client.synthesizeSsml(input.ssml, {
-                outputFormat: options.outputFormat,
-                signal: options.signal,
-                timeoutMs: options.timeoutMs,
-                sourceNodePath: input.sourceNodePath ?? options.sourceNodePath,
-              }),
-            options.retryOptions,
-            options.signal,
-            (retryAttempt, nextRetryDelayMs) =>
-              options.onProgress?.({
-                currentChunk: completed,
-                totalChunks: chunks.length,
-                percent: chunks.length === 0 ? 100 : Math.round((completed / chunks.length) * 100),
-                chunkIndex: index,
-                originalTextRange: input.originalTextRange,
-                status: "synthesizing",
-                durationMs: Date.now() - startedAt,
-                retryAttempt,
-                nextRetryDelayMs,
-                isRetrying: true,
-              }),
-          );
+          const chunkTimeout = options.timeouts?.chunkWithRetriesMs ?? options.timeouts?.perChunkMs;
+          const chunkScope =
+            chunkTimeout !== undefined || jobScope
+              ? createSafeAbortScope(jobScope?.signal ?? options.signal, chunkTimeout ?? options.timeoutMs)
+              : undefined;
+          const chunkSignal = chunkScope?.signal ?? options.signal;
+          let result: SsmlSynthesisResult;
+          try {
+            result = await retryableSynthesis(
+              () =>
+                client.synthesizeSsml(input.ssml, {
+                  outputFormat: options.outputFormat,
+                  signal: chunkSignal,
+                  timeoutMs: options.timeouts?.perChunkMs ?? options.timeoutMs,
+                  sourceNodePath: input.sourceNodePath ?? options.sourceNodePath,
+                }),
+              options.retryOptions,
+              chunkSignal,
+              (retryAttempt, nextRetryDelayMs) =>
+                options.onProgress?.({
+                  currentChunk: completed,
+                  totalChunks: chunks.length,
+                  percent: chunks.length === 0 ? 100 : Math.round((completed / chunks.length) * 100),
+                  chunkIndex: index,
+                  originalTextRange: input.originalTextRange,
+                  status: "synthesizing",
+                  durationMs: Date.now() - startedAt,
+                  retryAttempt,
+                  nextRetryDelayMs,
+                  isRetrying: true,
+                }),
+              jobDeadlineAt,
+            );
+          } catch (error) {
+            if (chunkScope?.timedOut())
+              throw new Error(`Speech synthesis timed out after ${chunkTimeout ?? options.timeoutMs} ms.`);
+            throw error;
+          } finally {
+            chunkScope?.dispose();
+          }
           results[index] = {
             ...result,
             ...(input.originalTextRange ? { textRange: { ...input.originalTextRange } } : {}),
@@ -397,6 +589,7 @@ export async function synthesizeSsmlChunksSafe(
                 }
               : {}),
           };
+          chunkStates[index] = { chunkIndex: index, status: "succeeded", canResume: true, result: results[index] };
           completed += 1;
           options.onProgress?.({
             currentChunk: completed,
@@ -408,6 +601,16 @@ export async function synthesizeSsmlChunksSafe(
             durationMs: Date.now() - startedAt,
           });
         } catch (error) {
+          const wasCancelled = firstError !== undefined || Boolean(jobScope?.signal.aborted && !jobScope?.timedOut());
+          firstError ??= error;
+          if (!wasCancelled) failedIndices.add(index);
+          chunkStates[index] = {
+            chunkIndex: index,
+            status: wasCancelled ? "cancelled" : "failed",
+            isOriginalFailure: !wasCancelled,
+            canResume: true,
+            error: error as ChunkExecutionState["error"],
+          };
           options.onProgress?.({
             currentChunk: completed,
             totalChunks: chunks.length,
@@ -418,24 +621,59 @@ export async function synthesizeSsmlChunksSafe(
             durationMs: Date.now() - startedAt,
             error,
           });
-          throw error;
+          if (options.cancelOnFailure !== false) jobScope?.abort();
+          return;
         }
       }
     };
     await Promise.all(Array.from({ length: Math.min(concurrency, chunks.length) }, () => worker()));
+    if (firstError && options.cancelOnFailure !== false) {
+      for (const [chunkIndex, state] of chunkStates.entries()) {
+        if (state.status === "pending" && shouldSynthesize(chunkIndex)) {
+          chunkStates[chunkIndex] = { chunkIndex, status: "cancelled", isOriginalFailure: false, canResume: true };
+        }
+      }
+    }
+    if (failedIndices.size > 0) {
+      const error = firstError ?? new Error("One or more SSML chunks failed to synthesize.");
+      const synthesizedChunks = results.flatMap((result, chunkIndex) =>
+        result ? [{ ...result, chunkIndex, fingerprint: fingerprints[chunkIndex] ?? "" }] : [],
+      );
+      (error as { partialResult?: PartialChunkSynthesisResult }).partialResult = {
+        synthesizedChunks,
+        completedChunks: synthesizedChunks,
+        pendingChunkIndices: chunkStates.flatMap((state) =>
+          state.status === "pending" || state.status === "cancelled" || state.status === "failed"
+            ? [state.chunkIndex]
+            : [],
+        ),
+        failedChunkIndices: [...failedIndices],
+        cancelledChunkIndices: chunkStates
+          .filter((state) => state.status === "cancelled")
+          .map((state) => state.chunkIndex),
+        chunkStates,
+        totalChunks: chunks.length,
+      };
+      throw error;
+    }
     const orderedResults = results.filter((result): result is SsmlSynthesisResult => result !== undefined);
     return {
       ok: true,
       success: true,
       status: "success",
-      value: mergeSynthesisResults(orderedResults, {
+      value: await mergeSynthesisResults(orderedResults, {
         format: (options.outputFormat ?? "audio-16khz-128kbitrate-mono-mp3") as AzureTtsOutputFormat,
-        signal: options.signal,
+        signal: jobScope?.signal ?? options.signal,
+        customMerger: options.customMerger,
+        outputMimeType: options.outputMimeType,
+        postMergeValidator: options.postMergeValidator,
       }),
     };
   } catch (error) {
     const synthesisError = toSynthesisError(error);
-    return failure(synthesisError);
+    return failure(synthesisError, partialResultFrom(error));
+  } finally {
+    fallbackJobScope?.dispose();
   }
 }