@fluidframework/replay-driver 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.216897

package/api-extractor-lint.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json",
+	"messages": {
+		"extractorMessageReporting": {
+			// TODO: remove once base config has this enabled as an error
+			"ae-incompatible-release-tags": {
+				"logLevel": "error",
+				"addToApiReportFile": false
+			}
+		}
+	}
+}

package/api-extractor.json

@@ -6,10 +6,6 @@
 	},
 	"messages": {
 		"extractorMessageReporting": {
-			// TODO: Fix violations and remove this rule override
-			"ae-missing-release-tag": {
-				"logLevel": "none"
-			},
 			// TODO: Add missing documentation and remove this rule override
 			"ae-undocumented": {
 				"logLevel": "none"

package/api-report/replay-driver.api.md

@@ -19,7 +19,7 @@ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
 import { ITree } from '@fluidframework/protocol-definitions';
 import { IVersion } from '@fluidframework/protocol-definitions';
 
-// @public (undocumented)
+// @internal (undocumented)
 export class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
     constructor(json: IFileSnapshot);
     // (undocumented)
@@ -46,7 +46,7 @@ export class FileSnapshotReader extends ReadDocumentStorageServiceBase implement
     };
 }
 
-// @public
+// @internal
 export interface IFileSnapshot {
     // (undocumented)
     commits: {
@@ -56,7 +56,7 @@ export interface IFileSnapshot {
     tree: ITree;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export class OpStorage extends ReadDocumentStorageServiceBase {
     // (undocumented)
     getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
@@ -66,7 +66,7 @@ export class OpStorage extends ReadDocumentStorageServiceBase {
     readBlob(blobId: string): Promise<ArrayBufferLike>;
 }
 
-// @public
+// @internal
 export abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
     // (undocumented)
     createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
@@ -84,7 +84,7 @@ export abstract class ReadDocumentStorageServiceBase implements IDocumentStorage
     uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
 }
 
-// @public
+// @internal
 export abstract class ReplayController extends ReadDocumentStorageServiceBase {
     abstract fetchTo(currentOp: number): number | undefined;
     abstract getStartingOpSequence(): Promise<number>;
@@ -93,7 +93,7 @@ export abstract class ReplayController extends ReadDocumentStorageServiceBase {
     abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
 }
 
-// @public
+// @internal
 export class ReplayDocumentService implements api_2.IDocumentService {
     constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
     connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
@@ -107,7 +107,7 @@ export class ReplayDocumentService implements api_2.IDocumentService {
     get resolvedUrl(): api_2.IResolvedUrl;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
     constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
     // (undocumented)
@@ -117,7 +117,7 @@ export class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
     createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export class SnapshotStorage extends ReadDocumentStorageServiceBase {
     constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
     // (undocumented)
@@ -134,7 +134,7 @@ export class SnapshotStorage extends ReadDocumentStorageServiceBase {
     protected readonly storage: IDocumentStorageService;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
     constructor(storage: IDocumentStorageService);
     // (undocumented)

package/dist/replay-driver-alpha.d.ts

@@ -1,168 +1,41 @@
 import * as api from '@fluidframework/protocol-definitions';
 import * as api_2 from '@fluidframework/driver-definitions';
 import { IClient } from '@fluidframework/protocol-definitions';
-import { IDocumentService } from '@fluidframework/driver-definitions';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions';
-import { IResolvedUrl } from '@fluidframework/driver-definitions';
 import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISummaryContext } from '@fluidframework/driver-definitions';
 import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
 import { ITree } from '@fluidframework/protocol-definitions';
 import { IVersion } from '@fluidframework/protocol-definitions';
 
-export declare class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
-    protected docId?: string;
-    protected docTree: ISnapshotTree;
-    protected blobs: Map<string, ArrayBufferLike>;
-    protected readonly commits: {
-        [key: string]: ITree;
-    };
-    protected readonly trees: {
-        [key: string]: ISnapshotTree;
-    };
-    constructor(json: IFileSnapshot);
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
-    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
-    readBlob(blobId: string): Promise<ArrayBufferLike>;
-}
-
-/**
- * Structure of snapshot on disk, when we store snapshot as single file
- */
-export declare interface IFileSnapshot {
-    tree: ITree;
-    commits: {
-        [key: string]: ITree;
-    };
-}
-
-export declare class OpStorage extends ReadDocumentStorageServiceBase {
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
-    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
-    readBlob(blobId: string): Promise<ArrayBufferLike>;
-}
-
-/**
- * Partial implementation of IDocumentStorageService
- */
-export declare abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-    abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-    abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
-    uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
-    createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
-    downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
-    get repositoryUrl(): string;
-}
-
-/**
- * Replay controller object
- * It controls where we start (snapshot, local file, no snapshots)
- * As well as dispatch of ops
- */
-export declare abstract class ReplayController extends ReadDocumentStorageServiceBase {
-    /**
-     * Initialize reply controller
-     * @param documentService - the real document service
-     * @returns Whether or not the controller should be used.
-     * If `false` is returned, caller should fallback to original storage.
-     */
-    abstract initStorage(documentService: IDocumentService): Promise<boolean>;
-    /**
-     * Returns sequence number to start processing ops
-     * Should be zero if not using snapshot, and snapshot seq# otherwise
-     */
-    abstract getStartingOpSequence(): Promise<number>;
-    /**
-     * Returns last op number to fetch from current op
-     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
-     * @param currentOp - current op
-     */
-    abstract fetchTo(currentOp: number): number | undefined;
-    /**
-     * Returns true if no more ops should be processed (or downloaded for future processing).
-     * It's called at end of each batch with latest op timestamp.
-     * Also it's called when there are no more ops available (lastTimeStamp === undefined).
-     * If false is returned and there are no more ops, request for more ops is made every 2 seconds.
-     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
-     * @param currentOp - current op
-     * @param lastTimeStamp - timestamp of last op (if more ops are available). Undefined otherwise.
-     */
-    abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
-    /**
-     * Replay batch of ops
-     * NOTE: new batch of ops is fetched (fetchTo() & isDoneFetch() APIs are called) while this call is in flights
-     * @param emitter - callback to emit ops
-     * @param fetchedOps - ops to process
-     */
-    abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
-}
-
-/**
- * The Replay document service dummies out the snapshot and the delta storage.
- * Delta connection simulates the socket by fetching the ops from delta storage
- * and emitting them with a pre determined delay
- */
-export declare class ReplayDocumentService implements api_2.IDocumentService {
-    private readonly controller;
-    private readonly deltaStorage;
-    static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
-    constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
-    dispose(): void;
-    get resolvedUrl(): api_2.IResolvedUrl;
-    /**
-     * Connects to a storage endpoint for snapshot service and blobs.
-     * @returns returns the dummy document storage service for replay driver.
-     */
-    connectToStorage(): Promise<api_2.IDocumentStorageService>;
-    /**
-     * Connects to a delta storage endpoint for getting ops between a range.
-     * @returns returns the dummy document delta storage service for replay driver.
-     */
-    connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
-    /**
-     * Connects to a delta storage endpoint of provided documentService to get ops and then replaying
-     * them so as to mimic a delta stream endpoint.
-     * @param client - Client that connects to socket.
-     * @returns returns the delta stream service which replay ops from --from to --to arguments.
-     */
-    connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
-}
-
-export declare class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
-    private readonly documentServiceFactory;
-    private readonly controller;
-    static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
-    constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
-    /**
-     * Creates a replay document service which uses the document service of provided
-     * documentServiceFactory for connecting to delta stream endpoint.
-     * @param resolvedUrl - URL to be used for connecting to endpoints.
-     * @returns returns the requested document service
-     */
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-}
-
-export declare class SnapshotStorage extends ReadDocumentStorageServiceBase {
-    protected readonly storage: IDocumentStorageService;
-    protected readonly docTree: ISnapshotTree | null;
-    protected docId?: string;
-    constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
-    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
-    readBlob(blobId: string): Promise<ArrayBufferLike>;
-}
-
-export declare class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
-    protected readonly storage: IDocumentStorageService;
-    constructor(storage: IDocumentStorageService);
-    createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-}
+/* Excluded from this release type: FileSnapshotReader */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IFileSnapshot */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: ISummaryContext */
+
+/* Excluded from this release type: ITelemetryBaseLogger */
+
+/* Excluded from this release type: ITelemetryLoggerExt */
+
+/* Excluded from this release type: OpStorage */
+
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
+
+/* Excluded from this release type: ReplayController */
+
+/* Excluded from this release type: ReplayDocumentService */
+
+/* Excluded from this release type: ReplayDocumentServiceFactory */
+
+/* Excluded from this release type: SnapshotStorage */
+
+/* Excluded from this release type: StaticStorageDocumentServiceFactory */
 
 export { }

package/dist/replay-driver-beta.d.ts

@@ -1,168 +1,41 @@
 import * as api from '@fluidframework/protocol-definitions';
 import * as api_2 from '@fluidframework/driver-definitions';
 import { IClient } from '@fluidframework/protocol-definitions';
-import { IDocumentService } from '@fluidframework/driver-definitions';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions';
-import { IResolvedUrl } from '@fluidframework/driver-definitions';
 import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISummaryContext } from '@fluidframework/driver-definitions';
 import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
 import { ITree } from '@fluidframework/protocol-definitions';
 import { IVersion } from '@fluidframework/protocol-definitions';
 
-export declare class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
-    protected docId?: string;
-    protected docTree: ISnapshotTree;
-    protected blobs: Map<string, ArrayBufferLike>;
-    protected readonly commits: {
-        [key: string]: ITree;
-    };
-    protected readonly trees: {
-        [key: string]: ISnapshotTree;
-    };
-    constructor(json: IFileSnapshot);
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
-    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
-    readBlob(blobId: string): Promise<ArrayBufferLike>;
-}
-
-/**
- * Structure of snapshot on disk, when we store snapshot as single file
- */
-export declare interface IFileSnapshot {
-    tree: ITree;
-    commits: {
-        [key: string]: ITree;
-    };
-}
-
-export declare class OpStorage extends ReadDocumentStorageServiceBase {
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
-    getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
-    readBlob(blobId: string): Promise<ArrayBufferLike>;
-}
-
-/**
- * Partial implementation of IDocumentStorageService
- */
-export declare abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-    abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-    abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
-    uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
-    createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
-    downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
-    get repositoryUrl(): string;
-}
-
-/**
- * Replay controller object
- * It controls where we start (snapshot, local file, no snapshots)
- * As well as dispatch of ops
- */
-export declare abstract class ReplayController extends ReadDocumentStorageServiceBase {
-    /**
-     * Initialize reply controller
-     * @param documentService - the real document service
-     * @returns Whether or not the controller should be used.
-     * If `false` is returned, caller should fallback to original storage.
-     */
-    abstract initStorage(documentService: IDocumentService): Promise<boolean>;
-    /**
-     * Returns sequence number to start processing ops
-     * Should be zero if not using snapshot, and snapshot seq# otherwise
-     */
-    abstract getStartingOpSequence(): Promise<number>;
-    /**
-     * Returns last op number to fetch from current op
-     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
-     * @param currentOp - current op
-     */
-    abstract fetchTo(currentOp: number): number | undefined;
-    /**
-     * Returns true if no more ops should be processed (or downloaded for future processing).
-     * It's called at end of each batch with latest op timestamp.
-     * Also it's called when there are no more ops available (lastTimeStamp === undefined).
-     * If false is returned and there are no more ops, request for more ops is made every 2 seconds.
-     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
-     * @param currentOp - current op
-     * @param lastTimeStamp - timestamp of last op (if more ops are available). Undefined otherwise.
-     */
-    abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
-    /**
-     * Replay batch of ops
-     * NOTE: new batch of ops is fetched (fetchTo() & isDoneFetch() APIs are called) while this call is in flights
-     * @param emitter - callback to emit ops
-     * @param fetchedOps - ops to process
-     */
-    abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
-}
-
-/**
- * The Replay document service dummies out the snapshot and the delta storage.
- * Delta connection simulates the socket by fetching the ops from delta storage
- * and emitting them with a pre determined delay
- */
-export declare class ReplayDocumentService implements api_2.IDocumentService {
-    private readonly controller;
-    private readonly deltaStorage;
-    static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
-    constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
-    dispose(): void;
-    get resolvedUrl(): api_2.IResolvedUrl;
-    /**
-     * Connects to a storage endpoint for snapshot service and blobs.
-     * @returns returns the dummy document storage service for replay driver.
-     */
-    connectToStorage(): Promise<api_2.IDocumentStorageService>;
-    /**
-     * Connects to a delta storage endpoint for getting ops between a range.
-     * @returns returns the dummy document delta storage service for replay driver.
-     */
-    connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
-    /**
-     * Connects to a delta storage endpoint of provided documentService to get ops and then replaying
-     * them so as to mimic a delta stream endpoint.
-     * @param client - Client that connects to socket.
-     * @returns returns the delta stream service which replay ops from --from to --to arguments.
-     */
-    connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
-}
-
-export declare class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
-    private readonly documentServiceFactory;
-    private readonly controller;
-    static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
-    constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
-    /**
-     * Creates a replay document service which uses the document service of provided
-     * documentServiceFactory for connecting to delta stream endpoint.
-     * @param resolvedUrl - URL to be used for connecting to endpoints.
-     * @returns returns the requested document service
-     */
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-}
-
-export declare class SnapshotStorage extends ReadDocumentStorageServiceBase {
-    protected readonly storage: IDocumentStorageService;
-    protected readonly docTree: ISnapshotTree | null;
-    protected docId?: string;
-    constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
-    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
-    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
-    readBlob(blobId: string): Promise<ArrayBufferLike>;
-}
-
-export declare class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
-    protected readonly storage: IDocumentStorageService;
-    constructor(storage: IDocumentStorageService);
-    createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-}
+/* Excluded from this release type: FileSnapshotReader */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IFileSnapshot */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: ISummaryContext */
+
+/* Excluded from this release type: ITelemetryBaseLogger */
+
+/* Excluded from this release type: ITelemetryLoggerExt */
+
+/* Excluded from this release type: OpStorage */
+
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
+
+/* Excluded from this release type: ReplayController */
+
+/* Excluded from this release type: ReplayDocumentService */
+
+/* Excluded from this release type: ReplayDocumentServiceFactory */
+
+/* Excluded from this release type: SnapshotStorage */
+
+/* Excluded from this release type: StaticStorageDocumentServiceFactory */
 
 export { }