@fluidframework/debugger 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/api-report/debugger.api.md +6 -6
- package/dist/fluidDebugger.d.ts +1 -1
- package/dist/fluidDebugger.d.ts.map +1 -1
- package/dist/fluidDebugger.js +3 -3
- package/dist/fluidDebugger.js.map +1 -1
- package/dist/fluidDebuggerController.d.ts +3 -3
- package/dist/fluidDebuggerController.d.ts.map +1 -1
- package/dist/fluidDebuggerController.js +16 -16
- package/dist/fluidDebuggerController.js.map +1 -1
- package/dist/fluidDebuggerUi.js +2 -2
- package/dist/fluidDebuggerUi.js.map +1 -1
- package/dist/legacy.d.ts +14 -0
- package/dist/messageSchema.d.ts +0 -6
- package/dist/messageSchema.d.ts.map +1 -1
- package/dist/messageSchema.js +1 -2
- package/dist/messageSchema.js.map +1 -1
- package/dist/public.d.ts +12 -0
- package/dist/sanitize.js +12 -12
- package/dist/sanitize.js.map +1 -1
- package/dist/sanitizer.d.ts +1 -15
- package/dist/sanitizer.d.ts.map +1 -1
- package/dist/sanitizer.js +6 -6
- package/dist/sanitizer.js.map +1 -1
- package/internal.d.ts +11 -0
- package/legacy.d.ts +11 -0
- package/lib/fluidDebugger.d.ts +1 -1
- package/lib/fluidDebugger.d.ts.map +1 -1
- package/lib/fluidDebugger.js +1 -1
- package/lib/fluidDebugger.js.map +1 -1
- package/lib/fluidDebuggerController.d.ts +3 -3
- package/lib/fluidDebuggerController.d.ts.map +1 -1
- package/lib/fluidDebuggerController.js +3 -3
- package/lib/fluidDebuggerController.js.map +1 -1
- package/lib/fluidDebuggerUi.js +1 -1
- package/lib/fluidDebuggerUi.js.map +1 -1
- package/lib/legacy.d.ts +14 -0
- package/lib/messageSchema.d.ts +0 -6
- package/lib/messageSchema.d.ts.map +1 -1
- package/lib/messageSchema.js +1 -2
- package/lib/messageSchema.js.map +1 -1
- package/lib/public.d.ts +12 -0
- package/lib/sanitize.js +2 -2
- package/lib/sanitize.js.map +1 -1
- package/lib/sanitizer.d.ts +1 -15
- package/lib/sanitizer.d.ts.map +1 -1
- package/lib/sanitizer.js +2 -2
- package/lib/sanitizer.js.map +1 -1
- package/package.json +27 -44
- package/src/fluidDebugger.ts +9 -2
- package/src/fluidDebuggerController.ts +6 -5
- package/src/fluidDebuggerUi.ts +1 -1
- package/src/messageSchema.ts +1 -2
- package/src/sanitize.ts +4 -2
- package/src/sanitizer.ts +4 -3
- package/api-extractor-cjs.json +0 -8
- package/dist/debugger-alpha.d.ts +0 -36
- package/dist/debugger-beta.d.ts +0 -35
- package/dist/debugger-public.d.ts +0 -35
- package/dist/debugger-untrimmed.d.ts +0 -193
- package/lib/debugger-alpha.d.ts +0 -36
- package/lib/debugger-beta.d.ts +0 -35
- package/lib/debugger-public.d.ts +0 -35
- package/lib/debugger-untrimmed.d.ts +0 -193
- package/lib/test/types/validateDebuggerPrevious.generated.d.ts +0 -2
- package/lib/test/types/validateDebuggerPrevious.generated.d.ts.map +0 -1
- package/lib/test/types/validateDebuggerPrevious.generated.js +0 -18
- package/lib/test/types/validateDebuggerPrevious.generated.js.map +0 -1
- /package/{dist → lib}/tsdoc-metadata.json +0 -0
|
@@ -1,193 +0,0 @@
|
|
|
1
|
-
import { Deferred } from '@fluidframework/core-utils';
|
|
2
|
-
import { IDocumentService } from '@fluidframework/driver-definitions';
|
|
3
|
-
import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
|
|
4
|
-
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
5
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
6
|
-
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
7
|
-
import { IVersion } from '@fluidframework/protocol-definitions';
|
|
8
|
-
import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
|
|
9
|
-
import { ReplayController } from '@fluidframework/replay-driver';
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
14
|
-
export declare class DebuggerUI {
|
|
15
|
-
private readonly controller;
|
|
16
|
-
private readonly debuggerWindow;
|
|
17
|
-
static create(controller: IDebuggerController): DebuggerUI | null;
|
|
18
|
-
private static formatDate;
|
|
19
|
-
protected selector?: HTMLSelectElement;
|
|
20
|
-
protected versionText: HTMLDivElement;
|
|
21
|
-
protected buttonOps?: HTMLButtonElement;
|
|
22
|
-
protected text1?: HTMLDivElement;
|
|
23
|
-
protected text2?: HTMLDivElement;
|
|
24
|
-
protected text3?: HTMLDivElement;
|
|
25
|
-
protected lastOpText?: HTMLDivElement;
|
|
26
|
-
protected wasVersionSelected: boolean;
|
|
27
|
-
protected versions: IVersion[];
|
|
28
|
-
protected documentClosed: boolean;
|
|
29
|
-
protected constructor(controller: IDebuggerController, debuggerWindow: Window);
|
|
30
|
-
private attachDownloadOpsListener;
|
|
31
|
-
addVersions(versions: IVersion[]): void;
|
|
32
|
-
updateVersion(index: number, version: IVersion, seqNumber: number): void;
|
|
33
|
-
versionSelected(seqNumber: number, version: IVersion | string): void;
|
|
34
|
-
disableNextOpButton(disable: boolean): void;
|
|
35
|
-
updateNextOpText(ops: ISequencedDocumentMessage[]): void;
|
|
36
|
-
updateVersionText(versionCount: number): void;
|
|
37
|
-
updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
|
|
38
|
-
private download;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* @internal
|
|
43
|
-
*/
|
|
44
|
-
export declare type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
|
|
45
|
-
|
|
46
|
-
/**
|
|
47
|
-
* Replay controller that uses pop-up window to control op playback
|
|
48
|
-
* @internal
|
|
49
|
-
*/
|
|
50
|
-
export declare class DebugReplayController extends ReplayController implements IDebuggerController {
|
|
51
|
-
static create(createUi: debuggerUIFactory): DebugReplayController | null;
|
|
52
|
-
protected static readonly WindowClosedSeq = -1;
|
|
53
|
-
protected static seqFromTree(documentStorageService: IDocumentStorageService, tree: ISnapshotTree | null): Promise<number>;
|
|
54
|
-
protected ui: IDebuggerUI;
|
|
55
|
-
protected stepsDeferred?: Deferred<number>;
|
|
56
|
-
protected startSeqDeferred: Deferred<number>;
|
|
57
|
-
protected retryFetchOpsOnEndOfFile: boolean;
|
|
58
|
-
protected documentService?: IDocumentService;
|
|
59
|
-
protected documentStorageService?: IDocumentStorageService;
|
|
60
|
-
protected versions: IVersion[];
|
|
61
|
-
protected stepsToPlay: number;
|
|
62
|
-
protected lastOpReached: boolean;
|
|
63
|
-
protected versionCount: number;
|
|
64
|
-
protected storage?: ReadDocumentStorageServiceBase;
|
|
65
|
-
private shouldUseController;
|
|
66
|
-
connectToUi(ui: IDebuggerUI): void;
|
|
67
|
-
onClose(): void;
|
|
68
|
-
onVersionSelection(version: IVersion): Promise<void>;
|
|
69
|
-
onOpButtonClick(steps: number): void;
|
|
70
|
-
onSnapshotFileSelection(file: File): void;
|
|
71
|
-
onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
|
|
72
|
-
private fetchOpsFromDeltaStorage;
|
|
73
|
-
fetchTo(currentOp: number): number | undefined;
|
|
74
|
-
isSelectionMade(): boolean;
|
|
75
|
-
downloadVersionInfo(documentStorageService: IDocumentStorageService, prevRequest: Promise<void>, index: number, version: IVersion): Promise<void>;
|
|
76
|
-
initStorage(documentService: IDocumentService): Promise<boolean>;
|
|
77
|
-
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
78
|
-
getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
|
|
79
|
-
getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
|
|
80
|
-
getStartingOpSequence(): Promise<number>;
|
|
81
|
-
/**
|
|
82
|
-
* Return true if we are done processing ops
|
|
83
|
-
*/
|
|
84
|
-
isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
|
|
85
|
-
replay(emitter: (op: ISequencedDocumentMessage[]) => void, fetchedOps: ISequencedDocumentMessage[]): Promise<void>;
|
|
86
|
-
protected resolveStorage(seq: number, storage: ReadDocumentStorageServiceBase, version: IVersion | string): void;
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* @alpha
|
|
91
|
-
*/
|
|
92
|
-
export declare namespace FluidDebugger {
|
|
93
|
-
/**
|
|
94
|
-
* Creates document service wrapper that pops up Debugger window and allows user to play ops one by one.
|
|
95
|
-
* User can chose to start with any snapshot
|
|
96
|
-
* If pop-ups are disabled, we continue without debugger.
|
|
97
|
-
* @param documentService - original document service to use to fetch ops / snapshots.
|
|
98
|
-
* @internal
|
|
99
|
-
*/
|
|
100
|
-
export function createFromService(documentService: IDocumentService): Promise<IDocumentService>;
|
|
101
|
-
/**
|
|
102
|
-
* @alpha
|
|
103
|
-
*/
|
|
104
|
-
export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise<IDocumentServiceFactory>;
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
/**
|
|
108
|
-
* @internal
|
|
109
|
-
*/
|
|
110
|
-
export declare interface IDebuggerController {
|
|
111
|
-
/**
|
|
112
|
-
* Initialization. UI layers calls into controller to connect the two.
|
|
113
|
-
* @param ui - UI layer
|
|
114
|
-
*/
|
|
115
|
-
connectToUi(ui: IDebuggerUI): any;
|
|
116
|
-
/**
|
|
117
|
-
* Called by UI layer when debugger window is closed by user
|
|
118
|
-
* If called before user makes selection of snapshot/file, original
|
|
119
|
-
* document service is returned to loader (instead of debugger service) and normal document load continues.
|
|
120
|
-
*/
|
|
121
|
-
onClose(): void;
|
|
122
|
-
/**
|
|
123
|
-
* UI Layer notifies about selection of version to continue.
|
|
124
|
-
* On successful load, versionSelected() is called.
|
|
125
|
-
* @param version - Snapshot version to start from.
|
|
126
|
-
*/
|
|
127
|
-
onVersionSelection(version: IVersion): void;
|
|
128
|
-
/**
|
|
129
|
-
* UI Layer notifies about selection of version to continue.
|
|
130
|
-
* On successful load, versionSelected() is called.
|
|
131
|
-
* @param version - File to load snapshot from
|
|
132
|
-
*/
|
|
133
|
-
onSnapshotFileSelection(file: File): void;
|
|
134
|
-
/**
|
|
135
|
-
* "next op" button is clicked in the UI
|
|
136
|
-
* @param steps - number of ops to play.
|
|
137
|
-
*/
|
|
138
|
-
onOpButtonClick(steps: number): void;
|
|
139
|
-
/**
|
|
140
|
-
* "Download ops" option is clicked in the UI. Returns JSON of the full opStream when available.
|
|
141
|
-
* @param anonymize - anonymize the ops json using the sanitization tool
|
|
142
|
-
*/
|
|
143
|
-
onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
/**
|
|
147
|
-
* @internal
|
|
148
|
-
*/
|
|
149
|
-
export declare interface IDebuggerUI {
|
|
150
|
-
/**
|
|
151
|
-
* Version information is provided.
|
|
152
|
-
* Expect updates (information about seq#, timestamp) through updateVersion() calls
|
|
153
|
-
*/
|
|
154
|
-
addVersions(version: IVersion[]): void;
|
|
155
|
-
/**
|
|
156
|
-
* Call when new version is downloaded from storage
|
|
157
|
-
* Expect multiple callbacks.
|
|
158
|
-
*/
|
|
159
|
-
updateVersion(index: number, version: IVersion, seqNumber: number): void;
|
|
160
|
-
/**
|
|
161
|
-
* Called in response to successful onVersionSelection() or onSnapshotFileSelection() call
|
|
162
|
-
* and provides extra information about selection.
|
|
163
|
-
* It expected that UI layer would change its mode as result of this call, i.e. switch to
|
|
164
|
-
* displaying op playback controls (if this is supported)
|
|
165
|
-
* Note: There maybe no call to versionSelected() in response to onSnapshotFileSelection() call
|
|
166
|
-
* if file does not exist, has wrong name of wrong format.
|
|
167
|
-
* @param version - version, file name, or undefined if playing ops.
|
|
168
|
-
*/
|
|
169
|
-
versionSelected(seqNumber: number, version: IVersion | string): void;
|
|
170
|
-
/**
|
|
171
|
-
* Called by controller in response to new ops being downloaded
|
|
172
|
-
* Called with disable = true if there are no (currently) ops to play
|
|
173
|
-
*/
|
|
174
|
-
disableNextOpButton(disable: boolean): void;
|
|
175
|
-
/**
|
|
176
|
-
* Called by controller when new ops arrive (or we are done playing previous batch)
|
|
177
|
-
* Indicates next batch of ops that would be played when UI calls controller's onOpButtonClick()
|
|
178
|
-
* Called with ops=[] when there are no ops to play.
|
|
179
|
-
*/
|
|
180
|
-
updateNextOpText(ops: ISequencedDocumentMessage[]): void;
|
|
181
|
-
/**
|
|
182
|
-
* Called periodically when new versions are downloaded from server
|
|
183
|
-
*/
|
|
184
|
-
updateVersionText(versionsLeft: number): void;
|
|
185
|
-
/**
|
|
186
|
-
* Called periodically to notify about last known op
|
|
187
|
-
* @param lastKnownOp - seq number of last known op. -1 if can't play ops in this mode (load from file)
|
|
188
|
-
* @param stillLoading - true if we did not reach yet the end of the stream
|
|
189
|
-
*/
|
|
190
|
-
updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
export { }
|
package/lib/debugger-alpha.d.ts
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import { Deferred } from '@fluidframework/core-utils';
|
|
2
|
-
import { IDocumentService } from '@fluidframework/driver-definitions';
|
|
3
|
-
import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
|
|
4
|
-
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
5
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
6
|
-
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
7
|
-
import { IVersion } from '@fluidframework/protocol-definitions';
|
|
8
|
-
import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
|
|
9
|
-
import { ReplayController } from '@fluidframework/replay-driver';
|
|
10
|
-
|
|
11
|
-
/* Excluded from this release type: DebuggerUI */
|
|
12
|
-
|
|
13
|
-
/* Excluded from this release type: debuggerUIFactory */
|
|
14
|
-
|
|
15
|
-
/* Excluded from this release type: DebugReplayController */
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
* @alpha
|
|
19
|
-
*/
|
|
20
|
-
export declare namespace FluidDebugger {
|
|
21
|
-
/* Excluded from this release type: createFromService */
|
|
22
|
-
/**
|
|
23
|
-
* @alpha
|
|
24
|
-
*/
|
|
25
|
-
export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise<IDocumentServiceFactory>;
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
/* Excluded from this release type: IDebuggerController */
|
|
29
|
-
|
|
30
|
-
/* Excluded from this release type: IDebuggerUI */
|
|
31
|
-
|
|
32
|
-
/* Excluded from this release type: ReadDocumentStorageServiceBase */
|
|
33
|
-
|
|
34
|
-
/* Excluded from this release type: ReplayController */
|
|
35
|
-
|
|
36
|
-
export { }
|
package/lib/debugger-beta.d.ts
DELETED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import { Deferred } from '@fluidframework/core-utils';
|
|
2
|
-
import { IDocumentService } from '@fluidframework/driver-definitions';
|
|
3
|
-
import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
|
|
4
|
-
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
5
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
6
|
-
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
7
|
-
import { IVersion } from '@fluidframework/protocol-definitions';
|
|
8
|
-
import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
|
|
9
|
-
import { ReplayController } from '@fluidframework/replay-driver';
|
|
10
|
-
|
|
11
|
-
/* Excluded from this release type: DebuggerUI */
|
|
12
|
-
|
|
13
|
-
/* Excluded from this release type: debuggerUIFactory */
|
|
14
|
-
|
|
15
|
-
/* Excluded from this release type: DebugReplayController */
|
|
16
|
-
|
|
17
|
-
/* Excluded from this release type: Deferred */
|
|
18
|
-
|
|
19
|
-
/* Excluded from this release type: FluidDebugger */
|
|
20
|
-
|
|
21
|
-
/* Excluded from this release type: IDebuggerController */
|
|
22
|
-
|
|
23
|
-
/* Excluded from this release type: IDebuggerUI */
|
|
24
|
-
|
|
25
|
-
/* Excluded from this release type: IDocumentService */
|
|
26
|
-
|
|
27
|
-
/* Excluded from this release type: IDocumentServiceFactory */
|
|
28
|
-
|
|
29
|
-
/* Excluded from this release type: IDocumentStorageService */
|
|
30
|
-
|
|
31
|
-
/* Excluded from this release type: ReadDocumentStorageServiceBase */
|
|
32
|
-
|
|
33
|
-
/* Excluded from this release type: ReplayController */
|
|
34
|
-
|
|
35
|
-
export { }
|
package/lib/debugger-public.d.ts
DELETED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import { Deferred } from '@fluidframework/core-utils';
|
|
2
|
-
import { IDocumentService } from '@fluidframework/driver-definitions';
|
|
3
|
-
import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
|
|
4
|
-
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
5
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
6
|
-
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
7
|
-
import { IVersion } from '@fluidframework/protocol-definitions';
|
|
8
|
-
import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
|
|
9
|
-
import { ReplayController } from '@fluidframework/replay-driver';
|
|
10
|
-
|
|
11
|
-
/* Excluded from this release type: DebuggerUI */
|
|
12
|
-
|
|
13
|
-
/* Excluded from this release type: debuggerUIFactory */
|
|
14
|
-
|
|
15
|
-
/* Excluded from this release type: DebugReplayController */
|
|
16
|
-
|
|
17
|
-
/* Excluded from this release type: Deferred */
|
|
18
|
-
|
|
19
|
-
/* Excluded from this release type: FluidDebugger */
|
|
20
|
-
|
|
21
|
-
/* Excluded from this release type: IDebuggerController */
|
|
22
|
-
|
|
23
|
-
/* Excluded from this release type: IDebuggerUI */
|
|
24
|
-
|
|
25
|
-
/* Excluded from this release type: IDocumentService */
|
|
26
|
-
|
|
27
|
-
/* Excluded from this release type: IDocumentServiceFactory */
|
|
28
|
-
|
|
29
|
-
/* Excluded from this release type: IDocumentStorageService */
|
|
30
|
-
|
|
31
|
-
/* Excluded from this release type: ReadDocumentStorageServiceBase */
|
|
32
|
-
|
|
33
|
-
/* Excluded from this release type: ReplayController */
|
|
34
|
-
|
|
35
|
-
export { }
|
|
@@ -1,193 +0,0 @@
|
|
|
1
|
-
import { Deferred } from '@fluidframework/core-utils';
|
|
2
|
-
import { IDocumentService } from '@fluidframework/driver-definitions';
|
|
3
|
-
import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
|
|
4
|
-
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
5
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
6
|
-
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
7
|
-
import { IVersion } from '@fluidframework/protocol-definitions';
|
|
8
|
-
import { ReadDocumentStorageServiceBase } from '@fluidframework/replay-driver';
|
|
9
|
-
import { ReplayController } from '@fluidframework/replay-driver';
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
14
|
-
export declare class DebuggerUI {
|
|
15
|
-
private readonly controller;
|
|
16
|
-
private readonly debuggerWindow;
|
|
17
|
-
static create(controller: IDebuggerController): DebuggerUI | null;
|
|
18
|
-
private static formatDate;
|
|
19
|
-
protected selector?: HTMLSelectElement;
|
|
20
|
-
protected versionText: HTMLDivElement;
|
|
21
|
-
protected buttonOps?: HTMLButtonElement;
|
|
22
|
-
protected text1?: HTMLDivElement;
|
|
23
|
-
protected text2?: HTMLDivElement;
|
|
24
|
-
protected text3?: HTMLDivElement;
|
|
25
|
-
protected lastOpText?: HTMLDivElement;
|
|
26
|
-
protected wasVersionSelected: boolean;
|
|
27
|
-
protected versions: IVersion[];
|
|
28
|
-
protected documentClosed: boolean;
|
|
29
|
-
protected constructor(controller: IDebuggerController, debuggerWindow: Window);
|
|
30
|
-
private attachDownloadOpsListener;
|
|
31
|
-
addVersions(versions: IVersion[]): void;
|
|
32
|
-
updateVersion(index: number, version: IVersion, seqNumber: number): void;
|
|
33
|
-
versionSelected(seqNumber: number, version: IVersion | string): void;
|
|
34
|
-
disableNextOpButton(disable: boolean): void;
|
|
35
|
-
updateNextOpText(ops: ISequencedDocumentMessage[]): void;
|
|
36
|
-
updateVersionText(versionCount: number): void;
|
|
37
|
-
updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
|
|
38
|
-
private download;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* @internal
|
|
43
|
-
*/
|
|
44
|
-
export declare type debuggerUIFactory = (controller: IDebuggerController) => IDebuggerUI | null;
|
|
45
|
-
|
|
46
|
-
/**
|
|
47
|
-
* Replay controller that uses pop-up window to control op playback
|
|
48
|
-
* @internal
|
|
49
|
-
*/
|
|
50
|
-
export declare class DebugReplayController extends ReplayController implements IDebuggerController {
|
|
51
|
-
static create(createUi: debuggerUIFactory): DebugReplayController | null;
|
|
52
|
-
protected static readonly WindowClosedSeq = -1;
|
|
53
|
-
protected static seqFromTree(documentStorageService: IDocumentStorageService, tree: ISnapshotTree | null): Promise<number>;
|
|
54
|
-
protected ui: IDebuggerUI;
|
|
55
|
-
protected stepsDeferred?: Deferred<number>;
|
|
56
|
-
protected startSeqDeferred: Deferred<number>;
|
|
57
|
-
protected retryFetchOpsOnEndOfFile: boolean;
|
|
58
|
-
protected documentService?: IDocumentService;
|
|
59
|
-
protected documentStorageService?: IDocumentStorageService;
|
|
60
|
-
protected versions: IVersion[];
|
|
61
|
-
protected stepsToPlay: number;
|
|
62
|
-
protected lastOpReached: boolean;
|
|
63
|
-
protected versionCount: number;
|
|
64
|
-
protected storage?: ReadDocumentStorageServiceBase;
|
|
65
|
-
private shouldUseController;
|
|
66
|
-
connectToUi(ui: IDebuggerUI): void;
|
|
67
|
-
onClose(): void;
|
|
68
|
-
onVersionSelection(version: IVersion): Promise<void>;
|
|
69
|
-
onOpButtonClick(steps: number): void;
|
|
70
|
-
onSnapshotFileSelection(file: File): void;
|
|
71
|
-
onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
|
|
72
|
-
private fetchOpsFromDeltaStorage;
|
|
73
|
-
fetchTo(currentOp: number): number | undefined;
|
|
74
|
-
isSelectionMade(): boolean;
|
|
75
|
-
downloadVersionInfo(documentStorageService: IDocumentStorageService, prevRequest: Promise<void>, index: number, version: IVersion): Promise<void>;
|
|
76
|
-
initStorage(documentService: IDocumentService): Promise<boolean>;
|
|
77
|
-
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
78
|
-
getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
|
|
79
|
-
getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
|
|
80
|
-
getStartingOpSequence(): Promise<number>;
|
|
81
|
-
/**
|
|
82
|
-
* Return true if we are done processing ops
|
|
83
|
-
*/
|
|
84
|
-
isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
|
|
85
|
-
replay(emitter: (op: ISequencedDocumentMessage[]) => void, fetchedOps: ISequencedDocumentMessage[]): Promise<void>;
|
|
86
|
-
protected resolveStorage(seq: number, storage: ReadDocumentStorageServiceBase, version: IVersion | string): void;
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* @alpha
|
|
91
|
-
*/
|
|
92
|
-
export declare namespace FluidDebugger {
|
|
93
|
-
/**
|
|
94
|
-
* Creates document service wrapper that pops up Debugger window and allows user to play ops one by one.
|
|
95
|
-
* User can chose to start with any snapshot
|
|
96
|
-
* If pop-ups are disabled, we continue without debugger.
|
|
97
|
-
* @param documentService - original document service to use to fetch ops / snapshots.
|
|
98
|
-
* @internal
|
|
99
|
-
*/
|
|
100
|
-
export function createFromService(documentService: IDocumentService): Promise<IDocumentService>;
|
|
101
|
-
/**
|
|
102
|
-
* @alpha
|
|
103
|
-
*/
|
|
104
|
-
export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise<IDocumentServiceFactory>;
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
/**
|
|
108
|
-
* @internal
|
|
109
|
-
*/
|
|
110
|
-
export declare interface IDebuggerController {
|
|
111
|
-
/**
|
|
112
|
-
* Initialization. UI layers calls into controller to connect the two.
|
|
113
|
-
* @param ui - UI layer
|
|
114
|
-
*/
|
|
115
|
-
connectToUi(ui: IDebuggerUI): any;
|
|
116
|
-
/**
|
|
117
|
-
* Called by UI layer when debugger window is closed by user
|
|
118
|
-
* If called before user makes selection of snapshot/file, original
|
|
119
|
-
* document service is returned to loader (instead of debugger service) and normal document load continues.
|
|
120
|
-
*/
|
|
121
|
-
onClose(): void;
|
|
122
|
-
/**
|
|
123
|
-
* UI Layer notifies about selection of version to continue.
|
|
124
|
-
* On successful load, versionSelected() is called.
|
|
125
|
-
* @param version - Snapshot version to start from.
|
|
126
|
-
*/
|
|
127
|
-
onVersionSelection(version: IVersion): void;
|
|
128
|
-
/**
|
|
129
|
-
* UI Layer notifies about selection of version to continue.
|
|
130
|
-
* On successful load, versionSelected() is called.
|
|
131
|
-
* @param version - File to load snapshot from
|
|
132
|
-
*/
|
|
133
|
-
onSnapshotFileSelection(file: File): void;
|
|
134
|
-
/**
|
|
135
|
-
* "next op" button is clicked in the UI
|
|
136
|
-
* @param steps - number of ops to play.
|
|
137
|
-
*/
|
|
138
|
-
onOpButtonClick(steps: number): void;
|
|
139
|
-
/**
|
|
140
|
-
* "Download ops" option is clicked in the UI. Returns JSON of the full opStream when available.
|
|
141
|
-
* @param anonymize - anonymize the ops json using the sanitization tool
|
|
142
|
-
*/
|
|
143
|
-
onDownloadOpsButtonClick(anonymize: boolean): Promise<string>;
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
/**
|
|
147
|
-
* @internal
|
|
148
|
-
*/
|
|
149
|
-
export declare interface IDebuggerUI {
|
|
150
|
-
/**
|
|
151
|
-
* Version information is provided.
|
|
152
|
-
* Expect updates (information about seq#, timestamp) through updateVersion() calls
|
|
153
|
-
*/
|
|
154
|
-
addVersions(version: IVersion[]): void;
|
|
155
|
-
/**
|
|
156
|
-
* Call when new version is downloaded from storage
|
|
157
|
-
* Expect multiple callbacks.
|
|
158
|
-
*/
|
|
159
|
-
updateVersion(index: number, version: IVersion, seqNumber: number): void;
|
|
160
|
-
/**
|
|
161
|
-
* Called in response to successful onVersionSelection() or onSnapshotFileSelection() call
|
|
162
|
-
* and provides extra information about selection.
|
|
163
|
-
* It expected that UI layer would change its mode as result of this call, i.e. switch to
|
|
164
|
-
* displaying op playback controls (if this is supported)
|
|
165
|
-
* Note: There maybe no call to versionSelected() in response to onSnapshotFileSelection() call
|
|
166
|
-
* if file does not exist, has wrong name of wrong format.
|
|
167
|
-
* @param version - version, file name, or undefined if playing ops.
|
|
168
|
-
*/
|
|
169
|
-
versionSelected(seqNumber: number, version: IVersion | string): void;
|
|
170
|
-
/**
|
|
171
|
-
* Called by controller in response to new ops being downloaded
|
|
172
|
-
* Called with disable = true if there are no (currently) ops to play
|
|
173
|
-
*/
|
|
174
|
-
disableNextOpButton(disable: boolean): void;
|
|
175
|
-
/**
|
|
176
|
-
* Called by controller when new ops arrive (or we are done playing previous batch)
|
|
177
|
-
* Indicates next batch of ops that would be played when UI calls controller's onOpButtonClick()
|
|
178
|
-
* Called with ops=[] when there are no ops to play.
|
|
179
|
-
*/
|
|
180
|
-
updateNextOpText(ops: ISequencedDocumentMessage[]): void;
|
|
181
|
-
/**
|
|
182
|
-
* Called periodically when new versions are downloaded from server
|
|
183
|
-
*/
|
|
184
|
-
updateVersionText(versionsLeft: number): void;
|
|
185
|
-
/**
|
|
186
|
-
* Called periodically to notify about last known op
|
|
187
|
-
* @param lastKnownOp - seq number of last known op. -1 if can't play ops in this mode (load from file)
|
|
188
|
-
* @param stillLoading - true if we did not reach yet the end of the stream
|
|
189
|
-
*/
|
|
190
|
-
updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
export { }
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"validateDebuggerPrevious.generated.d.ts","sourceRoot":"","sources":["../../../src/test/types/validateDebuggerPrevious.generated.ts"],"names":[],"mappings":""}
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
use_current_ClassDeclaration_DebugReplayController(get_old_ClassDeclaration_DebugReplayController());
|
|
2
|
-
use_old_ClassDeclaration_DebugReplayController(
|
|
3
|
-
// @ts-expect-error compatibility expected to be broken
|
|
4
|
-
get_current_ClassDeclaration_DebugReplayController());
|
|
5
|
-
use_current_ClassDeclaration_DebuggerUI(get_old_ClassDeclaration_DebuggerUI());
|
|
6
|
-
use_old_ClassDeclaration_DebuggerUI(get_current_ClassDeclaration_DebuggerUI());
|
|
7
|
-
use_current_FunctionDeclaration_FluidDebugger_createFromService(get_old_FunctionDeclaration_FluidDebugger_createFromService());
|
|
8
|
-
use_old_FunctionDeclaration_FluidDebugger_createFromService(get_current_FunctionDeclaration_FluidDebugger_createFromService());
|
|
9
|
-
use_current_FunctionDeclaration_FluidDebugger_createFromServiceFactory(get_old_FunctionDeclaration_FluidDebugger_createFromServiceFactory());
|
|
10
|
-
use_old_FunctionDeclaration_FluidDebugger_createFromServiceFactory(get_current_FunctionDeclaration_FluidDebugger_createFromServiceFactory());
|
|
11
|
-
use_current_InterfaceDeclaration_IDebuggerController(get_old_InterfaceDeclaration_IDebuggerController());
|
|
12
|
-
use_old_InterfaceDeclaration_IDebuggerController(get_current_InterfaceDeclaration_IDebuggerController());
|
|
13
|
-
use_current_InterfaceDeclaration_IDebuggerUI(get_old_InterfaceDeclaration_IDebuggerUI());
|
|
14
|
-
use_old_InterfaceDeclaration_IDebuggerUI(get_current_InterfaceDeclaration_IDebuggerUI());
|
|
15
|
-
use_current_TypeAliasDeclaration_debuggerUIFactory(get_old_TypeAliasDeclaration_debuggerUIFactory());
|
|
16
|
-
use_old_TypeAliasDeclaration_debuggerUIFactory(get_current_TypeAliasDeclaration_debuggerUIFactory());
|
|
17
|
-
export {};
|
|
18
|
-
//# sourceMappingURL=validateDebuggerPrevious.generated.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"validateDebuggerPrevious.generated.js","sourceRoot":"","sources":["../../../src/test/types/validateDebuggerPrevious.generated.ts"],"names":[],"mappings":"AAgCA,kDAAkD,CAC9C,8CAA8C,EAAE,CAAC,CAAC;AAWtD,8CAA8C;AAC1C,uDAAuD;AACvD,kDAAkD,EAAE,CAAC,CAAC;AAW1D,uCAAuC,CACnC,mCAAmC,EAAE,CAAC,CAAC;AAW3C,mCAAmC,CAC/B,uCAAuC,EAAE,CAAC,CAAC;AAW/C,+DAA+D,CAC3D,2DAA2D,EAAE,CAAC,CAAC;AAWnE,2DAA2D,CACvD,+DAA+D,EAAE,CAAC,CAAC;AAWvE,sEAAsE,CAClE,kEAAkE,EAAE,CAAC,CAAC;AAW1E,kEAAkE,CAC9D,sEAAsE,EAAE,CAAC,CAAC;AAW9E,oDAAoD,CAChD,gDAAgD,EAAE,CAAC,CAAC;AAWxD,gDAAgD,CAC5C,oDAAoD,EAAE,CAAC,CAAC;AAW5D,4CAA4C,CACxC,wCAAwC,EAAE,CAAC,CAAC;AAWhD,wCAAwC,CACpC,4CAA4C,EAAE,CAAC,CAAC;AAWpD,kDAAkD,CAC9C,8CAA8C,EAAE,CAAC,CAAC;AAWtD,8CAA8C,CAC1C,kDAAkD,EAAE,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/*\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.\n * Generated by fluid-type-test-generator in @fluidframework/build-tools.\n */\nimport type * as old from \"@fluidframework/debugger-previous\";\nimport type * as current from \"../../index.js\";\n\n\n// See 'build-tools/src/type-test-generator/compatibility.ts' for more information.\ntype TypeOnly<T> = T extends number\n\t? number\n\t: T extends string\n\t? string\n\t: T extends boolean | bigint | symbol\n\t? T\n\t: {\n\t\t\t[P in keyof T]: TypeOnly<T[P]>;\n\t };\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DebugReplayController\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_DebugReplayController():\n TypeOnly<old.DebugReplayController>;\ndeclare function use_current_ClassDeclaration_DebugReplayController(\n use: TypeOnly<current.DebugReplayController>): void;\nuse_current_ClassDeclaration_DebugReplayController(\n get_old_ClassDeclaration_DebugReplayController());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DebugReplayController\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_DebugReplayController():\n TypeOnly<current.DebugReplayController>;\ndeclare function use_old_ClassDeclaration_DebugReplayController(\n use: TypeOnly<old.DebugReplayController>): void;\nuse_old_ClassDeclaration_DebugReplayController(\n // @ts-expect-error compatibility expected to be broken\n get_current_ClassDeclaration_DebugReplayController());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DebuggerUI\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_DebuggerUI():\n TypeOnly<old.DebuggerUI>;\ndeclare function use_current_ClassDeclaration_DebuggerUI(\n use: TypeOnly<current.DebuggerUI>): void;\nuse_current_ClassDeclaration_DebuggerUI(\n get_old_ClassDeclaration_DebuggerUI());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_DebuggerUI\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_DebuggerUI():\n TypeOnly<current.DebuggerUI>;\ndeclare function use_old_ClassDeclaration_DebuggerUI(\n use: TypeOnly<old.DebuggerUI>): void;\nuse_old_ClassDeclaration_DebuggerUI(\n get_current_ClassDeclaration_DebuggerUI());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"FunctionDeclaration_FluidDebugger.createFromService\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_FunctionDeclaration_FluidDebugger_createFromService():\n TypeOnly<typeof old.FluidDebugger.createFromService>;\ndeclare function use_current_FunctionDeclaration_FluidDebugger_createFromService(\n use: TypeOnly<typeof current.FluidDebugger.createFromService>): void;\nuse_current_FunctionDeclaration_FluidDebugger_createFromService(\n get_old_FunctionDeclaration_FluidDebugger_createFromService());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"FunctionDeclaration_FluidDebugger.createFromService\": {\"backCompat\": false}\n*/\ndeclare function get_current_FunctionDeclaration_FluidDebugger_createFromService():\n TypeOnly<typeof current.FluidDebugger.createFromService>;\ndeclare function use_old_FunctionDeclaration_FluidDebugger_createFromService(\n use: TypeOnly<typeof old.FluidDebugger.createFromService>): void;\nuse_old_FunctionDeclaration_FluidDebugger_createFromService(\n get_current_FunctionDeclaration_FluidDebugger_createFromService());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"FunctionDeclaration_FluidDebugger.createFromServiceFactory\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_FunctionDeclaration_FluidDebugger_createFromServiceFactory():\n TypeOnly<typeof old.FluidDebugger.createFromServiceFactory>;\ndeclare function use_current_FunctionDeclaration_FluidDebugger_createFromServiceFactory(\n use: TypeOnly<typeof current.FluidDebugger.createFromServiceFactory>): void;\nuse_current_FunctionDeclaration_FluidDebugger_createFromServiceFactory(\n get_old_FunctionDeclaration_FluidDebugger_createFromServiceFactory());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"FunctionDeclaration_FluidDebugger.createFromServiceFactory\": {\"backCompat\": false}\n*/\ndeclare function get_current_FunctionDeclaration_FluidDebugger_createFromServiceFactory():\n TypeOnly<typeof current.FluidDebugger.createFromServiceFactory>;\ndeclare function use_old_FunctionDeclaration_FluidDebugger_createFromServiceFactory(\n use: TypeOnly<typeof old.FluidDebugger.createFromServiceFactory>): void;\nuse_old_FunctionDeclaration_FluidDebugger_createFromServiceFactory(\n get_current_FunctionDeclaration_FluidDebugger_createFromServiceFactory());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"InterfaceDeclaration_IDebuggerController\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_InterfaceDeclaration_IDebuggerController():\n TypeOnly<old.IDebuggerController>;\ndeclare function use_current_InterfaceDeclaration_IDebuggerController(\n use: TypeOnly<current.IDebuggerController>): void;\nuse_current_InterfaceDeclaration_IDebuggerController(\n get_old_InterfaceDeclaration_IDebuggerController());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"InterfaceDeclaration_IDebuggerController\": {\"backCompat\": false}\n*/\ndeclare function get_current_InterfaceDeclaration_IDebuggerController():\n TypeOnly<current.IDebuggerController>;\ndeclare function use_old_InterfaceDeclaration_IDebuggerController(\n use: TypeOnly<old.IDebuggerController>): void;\nuse_old_InterfaceDeclaration_IDebuggerController(\n get_current_InterfaceDeclaration_IDebuggerController());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"InterfaceDeclaration_IDebuggerUI\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_InterfaceDeclaration_IDebuggerUI():\n TypeOnly<old.IDebuggerUI>;\ndeclare function use_current_InterfaceDeclaration_IDebuggerUI(\n use: TypeOnly<current.IDebuggerUI>): void;\nuse_current_InterfaceDeclaration_IDebuggerUI(\n get_old_InterfaceDeclaration_IDebuggerUI());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"InterfaceDeclaration_IDebuggerUI\": {\"backCompat\": false}\n*/\ndeclare function get_current_InterfaceDeclaration_IDebuggerUI():\n TypeOnly<current.IDebuggerUI>;\ndeclare function use_old_InterfaceDeclaration_IDebuggerUI(\n use: TypeOnly<old.IDebuggerUI>): void;\nuse_old_InterfaceDeclaration_IDebuggerUI(\n get_current_InterfaceDeclaration_IDebuggerUI());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"TypeAliasDeclaration_debuggerUIFactory\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_TypeAliasDeclaration_debuggerUIFactory():\n TypeOnly<old.debuggerUIFactory>;\ndeclare function use_current_TypeAliasDeclaration_debuggerUIFactory(\n use: TypeOnly<current.debuggerUIFactory>): void;\nuse_current_TypeAliasDeclaration_debuggerUIFactory(\n get_old_TypeAliasDeclaration_debuggerUIFactory());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"TypeAliasDeclaration_debuggerUIFactory\": {\"backCompat\": false}\n*/\ndeclare function get_current_TypeAliasDeclaration_debuggerUIFactory():\n TypeOnly<current.debuggerUIFactory>;\ndeclare function use_old_TypeAliasDeclaration_debuggerUIFactory(\n use: TypeOnly<old.debuggerUIFactory>): void;\nuse_old_TypeAliasDeclaration_debuggerUIFactory(\n get_current_TypeAliasDeclaration_debuggerUIFactory());\n"]}
|
|
File without changes
|