On-demand Container Summary Orchestrator

Build a utility that requests an on-demand summary for a collaborative container and reports progress and failure details.

Capabilities

Generate on-demand summary

• Given loader context and a request URL, it produces a summary outcome containing a handle string and final stage marker. @test
• It measures elapsed time for the summarization run and includes a positive duration. @test

Report progress stages

• When a progress callback is supplied, it receives each stage name in order from start through completion. @test

Propagate failure details

• When summarization fails, it resolves with a failure stage, message text, and no summary handle. @test

Implementation

@generates

API

export type SummaryStage = "started" | "running" | "submitted" | "acknowledged" | "failed";

export interface SummaryRequestContext {
  loader: unknown;
  requestUrl: string;
  reason?: string;
  signal?: AbortSignal;
}

export interface SummaryOutcome {
  stage: SummaryStage;
  handle?: string;
  message?: string;
  durationMs: number;
  data?: Record<string, unknown>;
}

export function orchestrateSummary(
  context: SummaryRequestContext,
  onProgress?: (stage: SummaryStage, details?: Record<string, unknown>) => void
): Promise<SummaryOutcome>;

Dependencies { .dependencies }

@fluidframework/container-loader { .dependency }

Provides loader and summarization helpers for Fluid containers.