Paused Container Inspection Helper

Utility for loading a collaborative container in a paused or frozen state so its state can be inspected safely before resuming live activity.

Capabilities

Paused load to sequence

• Loads a container halted at a requested sequence number and returns a handle that keeps it paused until resume is called; the returned container should not advance past that sequence number before resuming, and resume brings it back to live processing. @test

Paused load without target

• When no target sequence number is provided, loads the container paused at the current head and leaves it paused until resume is called and live processing resumes. @test

Frozen access option

• When freezeServices is true, loading uses read-only/frozen services so attempts to submit new operations while paused fail, but normal writes succeed after resume. @test

Implementation

@generates

API

export interface PauseLoadOptions {
  requestUrl: string;
  loaderServices: {
    codeLoader: any;
    documentServiceFactory: any;
    urlResolver: any;
    logger?: any;
  };
  sequenceNumber?: number;
  freezeServices?: boolean;
  abortSignal?: AbortSignal;
}

export interface PausedContainerHandle {
  container: any;
  resume(): Promise<void>;
}

export function loadPausedContainer(options: PauseLoadOptions): Promise<PausedContainerHandle>;

Dependencies { .dependencies }

@fluidframework/container-loader { .dependency }

Provides paused and frozen container loading support.

@satisfied-by