@fluidframework/debugger 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/.eslintrc.js

@@ -4,13 +4,12 @@
  */
 
 module.exports = {
-    "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid")
-    ],
-    "rules": {
-        "@typescript-eslint/no-non-null-assertion": "off",
-        "@typescript-eslint/no-use-before-define": "off",
-        "@typescript-eslint/strict-boolean-expressions": "off",
-        "no-inner-declarations": "off",
-    }
-}
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
+	rules: {
+		"@typescript-eslint/no-non-null-assertion": "off",
+		"@typescript-eslint/no-use-before-define": "off",
+		"@typescript-eslint/strict-boolean-expressions": "off",
+		"import/no-nodejs-modules": "off",
+		"no-inner-declarations": "off",
+	},
+};

package/CHANGELOG.md

@@ -0,0 +1,117 @@
+# @fluidframework/debugger
+
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.1.0
+
+Dependency updates only.

package/README.md

@@ -2,64 +2,64 @@
 
 Fluid Debugger is useful tool to replay file history. This can be useful as learning tool, as well as tool to investigate corruption or performance issues, or as content recovery tool. It provides read-only document and ability to start with a particular snapshot (or no snapshot at all), and play ops one by one, or in big batches.
 
-Fluid Debugger works as an adapter on top of any document storage. In other words, it can be integrated into any app using any storage endpoint (like SPO or Routerlicious) with minimal changes to application and can be used to replay history with full app code running, thus helping investigating bugs in any layer of application stack 
+Fluid Debugger works as an adapter on top of any document storage. In other words, it can be integrated into any app using any storage endpoint (like SPO or Routerlicious) with minimal changes to application and can be used to replay history with full app code running, thus helping investigating bugs in any layer of application stack
 
-## How to Enable it ##
+## How to Enable it
 
 In order to use it, these changes are required:
 
-1. Wrap existing storage: 
-    * If you have IDocumentService object, wrap it with __FluidDebugger.createFromService()__ call (note that it's async call) 
-    * Or, If you have IDocumentServiceFactory, wrap it with __FluidDebugger.createFromServiceFactory()__ call
-2. In Dev Tools console, do 
-    > __localStorage.FluidDebugger = 1__
-    >> Fluid app has UI toggle for it  - Settings | debbuger = on
-3. Once you refresh page, look for blocked (by browser) pop-up window notification. Enable pop-ups for your app. 
+1. Wrap existing storage:
+    - If you have IDocumentService object, wrap it with **FluidDebugger.createFromService()** call (note that it's async call)
+    - Or, If you have IDocumentServiceFactory, wrap it with **FluidDebugger.createFromServiceFactory()** call
+2. In Dev Tools console, do
+    > **localStorage.FluidDebugger = 1**
+    >
+    > > Fluid app has UI toggle for it - Settings | debbuger = on
+3. Once you refresh page, look for blocked (by browser) pop-up window notification. Enable pop-ups for your app.
+
+## How to disable it
 
-## How to disable it ##
 1. In Dev Tools console, run
-    > __delete localStorage.FluidDebugger__
+    > **delete localStorage.FluidDebugger**
 
-## How it works ##
+## How it works
 
-### Selecting where to start ###
+### Selecting where to start
 
-Once debugger starts, you have the following choices on first screen: 
+Once debugger starts, you have the following choices on first screen:
 
 ![picture alt](images/Screenshot1.jpg "Screenshot of debugger, first page")
 
-1. Close window. Debugger will be disabled and normal document flow would proceed - document is read/write. In all other options document is read-only, i.e. no local changes are committed to storage. 
+1. Close window. Debugger will be disabled and normal document flow would proceed - document is read/write. In all other options document is read-only, i.e. no local changes are committed to storage.
 
-2. Start with no snapshot, i.e. use only ops to play history of the file from start 
+2. Start with no snapshot, i.e. use only ops to play history of the file from start
 
-3. Use a particular snapshot to start with (use dropdown). You will see a selection of snapshots (with cryptic names) as well as starting sequence number for each of them in dropdown, sorted (with latest at the top). Please note that dropdown is populated asynchronously - there is progress text on the page noting that. 
+3. Use a particular snapshot to start with (use dropdown). You will see a selection of snapshots (with cryptic names) as well as starting sequence number for each of them in dropdown, sorted (with latest at the top). Please note that dropdown is populated asynchronously - there is progress text on the page noting that.
 
-4. Use snapshot stored on disk (_"snapshot.json"_), produced by [replay tool](../../tools/replay-tool/README.md). This option is useful if you want to validate that generation and loading of snapshot (from set of ops) does not introduce a bug. This is useful, given there is no other way to generate snapshot at particular point in time in the past. Notes:  
-    - Currently you can't play ops on top of snapshot in this mode (to be added in the future). 
-    - You can load snapshot from a different file (given above). As long as it's for same application, it does not matter if same file or storage endpoint is used to start an app. 
+4. Use snapshot stored on disk (_"snapshot.json"_), produced by [replay tool](../../tools/replay-tool/README.md). This option is useful if you want to validate that generation and loading of snapshot (from set of ops) does not introduce a bug. This is useful, given there is no other way to generate snapshot at particular point in time in the past. Notes:
+    - Currently you can't play ops on top of snapshot in this mode (to be added in the future).
+    - You can load snapshot from a different file (given above). As long as it's for same application, it does not matter if same file or storage endpoint is used to start an app.
 
-### Playing ops ###
+### Playing ops
 
-If you chose storage snapshot (not snapshot from file) or no snapshot, you are presented with a screen that allows you to play ops (on top of snapshot). You can chose any number of ops to play at once and click "Go" button: 
+If you chose storage snapshot (not snapshot from file) or no snapshot, you are presented with a screen that allows you to play ops (on top of snapshot). You can chose any number of ops to play at once and click "Go" button:
 
 ![picture alt](images/Screenshot2.jpg "Screenshot of debugger, second page")
 
-Please note that playback is asynchronous, so even though Debugger UI might have acknowledged that ops where played out (and you can select next batch), application might be still in the process of processing previous batch. 
+Please note that playback is asynchronous, so even though Debugger UI might have acknowledged that ops where played out (and you can select next batch), application might be still in the process of processing previous batch.
 
-## Internals, or useful piece to use in other workflows ##
+## Internals, or useful piece to use in other workflows
 
 Debugger consists of three mostly independent from each other pieces - UI, Controller & Storage layer. One can substitute UI and/or controller with alternative representation pretty easily, thus build different tool (like document recovery tool).
 
-__IDebuggerController__ is an interface that controls replay logic, but not UI. An implementation of this interface is provided: __DebugReplayController__
-
-__IDebuggerUI__ is an interface that controls UI and has no control logic. __DebuggerUI__ is an implementation of that interface. 
-
-__FluidDebugger.createFluidDebugger()__ is an example of binding logic & UI implementations 
+**IDebuggerController** is an interface that controls replay logic, but not UI. An implementation of this interface is provided: **DebugReplayController**
 
-There are useful stand-alone implementations of __IDocumentStorageService__ interface are provided as part of debugger: 
+**IDebuggerUI** is an interface that controls UI and has no control logic. **DebuggerUI** is an implementation of that interface.
 
-1. __FileSnapshotReader__ - file based storage. It reads content from file (snapshot.json) and expects __IFileSnapshot__ format, uses content of such file to serve document requests. 
-2. __SnapshotStorage__ - storage based on particular snapshot (in real storage). Requires snapshots' root ISnapshotTree to be provided at construction time. 
-3. __OpStorage__ - op-based storage (i.e. it rejects all requests for snapshots / trees). 
+**FluidDebugger.createFluidDebugger()** is an example of binding logic & UI implementations
 
+There are useful stand-alone implementations of **IDocumentStorageService** interface are provided as part of debugger:
 
+1. **FileSnapshotReader** - file based storage. It reads content from file (snapshot.json) and expects **IFileSnapshot** format, uses content of such file to serve document requests.
+2. **SnapshotStorage** - storage based on particular snapshot (in real storage). Requires snapshots' root ISnapshotTree to be provided at construction time.
+3. **OpStorage** - op-based storage (i.e. it rejects all requests for snapshots / trees).

package/api-extractor-esm.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base-esm.json"
+}

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
+}

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.json"
 }

package/api-report/debugger.api.md

@@ -0,0 +1,157 @@
+## API Report File for "@fluidframework/debugger"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Deferred } from '@fluidframework/core-utils';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
+import { ReplayController } from '@fluidframework/replay-driver';
+
+// @internal (undocumented)
+export class DebuggerUI {
+    protected constructor(controller: IDebuggerController, debuggerWindow: Window);
+    // (undocumented)
+    addVersions(versions: IVersion[]): void;
+    // (undocumented)
+    protected buttonOps?: HTMLButtonElement;
+    // (undocumented)
+    static create(controller: IDebuggerController): DebuggerUI | null;
+    // (undocumented)
+    disableNextOpButton(disable: boolean): void;
+    // (undocumented)
+    protected documentClosed: boolean;
+    // (undocumented)
+    protected lastOpText?: HTMLDivElement;
+    // (undocumented)
+    protected selector?: HTMLSelectElement;
+    // (undocumented)
+    protected text1?: HTMLDivElement;
+    // (undocumented)
+    protected text2?: HTMLDivElement;
+    // (undocumented)
+    protected text3?: HTMLDivElement;
+    // (undocumented)
+    updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
+    // (undocumented)
+    updateNextOpText(ops: ISequencedDocumentMessage[]): void;
+    // (undocumented)
+    updateVersion(index: number, version: IVersion, seqNumber: number): void;
+    // (undocumented)
+    updateVersionText(versionCount: number): void;
+    // (undocumented)
+    protected versions: IVersion[];
+    // (undocumented)
+    versionSelected(seqNumber: number, version: IVersion | string): void;
+    // (undocumented)
+    protected versionText: HTMLDivElement;
+    // (undocumented)
+    protected wasVersionSelected: boolean;
+}
+
+// @internal (undocumented)
+export type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
+
+// @internal
+export class DebugReplayController extends ReplayController implements IDebuggerController {
+    // (undocumented)
+    connectToUi(ui: IDebuggerUI): void;
+    // (undocumented)
+    static create(createUi: debuggerUIFactory): DebugReplayController | null;
+    // (undocumented)
+    protected documentService?: IDocumentService;
+    // (undocumented)
+    protected documentStorageService?: IDocumentStorageService;
+    // (undocumented)
+    downloadVersionInfo(documentStorageService: IDocumentStorageService, prevRequest: Promise<void>, index: number, version: IVersion): Promise<void>;
+    // (undocumented)
+    fetchTo(currentOp: number): number | undefined;
+    // (undocumented)
+    getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
+    // (undocumented)
+    getStartingOpSequence(): Promise<number>;
+    // (undocumented)
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    // (undocumented)
+    initStorage(documentService: IDocumentService): Promise<boolean>;
+    isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
+    // (undocumented)
+    isSelectionMade(): boolean;
+    // (undocumented)
+    protected lastOpReached: boolean;
+    // (undocumented)
+    onClose(): void;
+    // (undocumented)
+    onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
+    // (undocumented)
+    onOpButtonClick(steps: number): void;
+    // (undocumented)
+    onSnapshotFileSelection(file: File): void;
+    // (undocumented)
+    onVersionSelection(version: IVersion): Promise<void>;
+    // (undocumented)
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+    // (undocumented)
+    replay(emitter: (op: ISequencedDocumentMessage[]) => void, fetchedOps: ISequencedDocumentMessage[]): Promise<void>;
+    // (undocumented)
+    protected resolveStorage(seq: number, storage: ReadDocumentStorageServiceBase, version: IVersion | string): void;
+    // (undocumented)
+    protected retryFetchOpsOnEndOfFile: boolean;
+    // (undocumented)
+    protected static seqFromTree(documentStorageService: IDocumentStorageService, tree: ISnapshotTree | null): Promise<number>;
+    // (undocumented)
+    protected startSeqDeferred: Deferred<number>;
+    // (undocumented)
+    protected stepsDeferred?: Deferred<number>;
+    // (undocumented)
+    protected stepsToPlay: number;
+    // (undocumented)
+    protected storage?: ReadDocumentStorageServiceBase;
+    // (undocumented)
+    protected ui: IDebuggerUI;
+    // (undocumented)
+    protected versionCount: number;
+    // (undocumented)
+    protected versions: IVersion[];
+    // (undocumented)
+    protected static readonly WindowClosedSeq = -1;
+}
+
+// @alpha (undocumented)
+export namespace FluidDebugger {
+    // @internal
+    export function createFromService(documentService: IDocumentService): Promise<IDocumentService>;
+    // (undocumented)
+    export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise<IDocumentServiceFactory>;
+}
+
+// @internal (undocumented)
+export interface IDebuggerController {
+    connectToUi(ui: IDebuggerUI): any;
+    onClose(): void;
+    onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
+    onOpButtonClick(steps: number): void;
+    onSnapshotFileSelection(file: File): void;
+    onVersionSelection(version: IVersion): void;
+}
+
+// @internal (undocumented)
+export interface IDebuggerUI {
+    addVersions(version: IVersion[]): void;
+    disableNextOpButton(disable: boolean): void;
+    updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
+    updateNextOpText(ops: ISequencedDocumentMessage[]): void;
+    updateVersion(index: number, version: IVersion, seqNumber: number): void;
+    updateVersionText(versionsLeft: number): void;
+    versionSelected(seqNumber: number, version: IVersion | string): void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/debugger-alpha.d.ts

@@ -0,0 +1,36 @@
+import { Deferred } from '@fluidframework/core-utils';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
+import { ReplayController } from '@fluidframework/replay-driver';
+
+/* Excluded from this release type: DebuggerUI */
+
+/* Excluded from this release type: debuggerUIFactory */
+
+/* Excluded from this release type: DebugReplayController */
+
+/**
+ * @alpha
+ */
+export declare namespace FluidDebugger {
+    /* Excluded from this release type: createFromService */
+    /**
+     * @alpha
+     */
+    export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise<IDocumentServiceFactory>;
+}
+
+/* Excluded from this release type: IDebuggerController */
+
+/* Excluded from this release type: IDebuggerUI */
+
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
+
+/* Excluded from this release type: ReplayController */
+
+export { }

package/dist/debugger-beta.d.ts

@@ -0,0 +1,35 @@
+import { Deferred } from '@fluidframework/core-utils';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
+import { ReplayController } from '@fluidframework/replay-driver';
+
+/* Excluded from this release type: DebuggerUI */
+
+/* Excluded from this release type: debuggerUIFactory */
+
+/* Excluded from this release type: DebugReplayController */
+
+/* Excluded from this release type: Deferred */
+
+/* Excluded from this release type: FluidDebugger */
+
+/* Excluded from this release type: IDebuggerController */
+
+/* Excluded from this release type: IDebuggerUI */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
+
+/* Excluded from this release type: ReplayController */
+
+export { }

package/dist/debugger-public.d.ts

@@ -0,0 +1,35 @@
+import { Deferred } from '@fluidframework/core-utils';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
+import { ReplayController } from '@fluidframework/replay-driver';
+
+/* Excluded from this release type: DebuggerUI */
+
+/* Excluded from this release type: debuggerUIFactory */
+
+/* Excluded from this release type: DebugReplayController */
+
+/* Excluded from this release type: Deferred */
+
+/* Excluded from this release type: FluidDebugger */
+
+/* Excluded from this release type: IDebuggerController */
+
+/* Excluded from this release type: IDebuggerUI */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: ReadDocumentStorageServiceBase */
+
+/* Excluded from this release type: ReplayController */
+
+export { }