@fluidframework/driver-base 2.0.0-rc.2.0.1 → 2.0.0-rc.3.0.0

package/dist/driver-base-untrimmed.d.ts

@@ -1,213 +0,0 @@
-import { ConnectionMode } from '@fluidframework/protocol-definitions';
-import { EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils';
-import { IAnyDriverError } from '@fluidframework/driver-definitions';
-import { IClientConfiguration } from '@fluidframework/protocol-definitions';
-import { IConnect } from '@fluidframework/protocol-definitions';
-import { IConnected } from '@fluidframework/protocol-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
-import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalClient } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import type { Socket } from 'socket.io-client';
-
-/**
- * Represents a connection to a stream of delta updates.
- * @internal
- */
-export declare class DocumentDeltaConnection extends EventEmitterWithErrorHandling<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
-    protected readonly socket: Socket;
-    documentId: string;
-    private readonly enableLongPollingDowngrades;
-    protected readonly connectionId?: string | undefined;
-    static readonly eventsToForward: string[];
-    static readonly eventsAlwaysForwarded: string[];
-    /**
-     * Last known sequence number to ordering service at the time of connection
-     * It may lap actual last sequence number (quite a bit, if container  is very active).
-     * But it's best information for client to figure out how far it is behind, at least
-     * for "read" connections. "write" connections may use own "join" op to similar information,
-     * that is likely to be more up-to-date.
-     */
-    checkpointSequenceNumber: number | undefined;
-    protected readonly queuedMessages: ISequencedDocumentMessage[];
-    protected readonly queuedSignals: ISignalMessage[];
-    /**
-     * A flag to indicate whether we have our handler attached.  If it's attached, we're queueing incoming ops
-     * to later be retrieved via initialMessages.
-     */
-    private earlyOpHandlerAttached;
-    private socketConnectionTimeout;
-    private _details;
-    private trackLatencyTimeout;
-    private readonly connectionListeners;
-    private readonly trackedListeners;
-    protected get hasDetails(): boolean;
-    get disposed(): boolean;
-    /**
-     * Flag to indicate whether the DocumentDeltaConnection is expected to still be capable of sending messages.
-     * After disconnection, we flip this to prevent any stale messages from being emitted.
-     */
-    protected _disposed: boolean;
-    private readonly mc;
-    /**
-     * @deprecated Implementors should manage their own logger or monitoring context
-     */
-    protected get logger(): ITelemetryLoggerExt;
-    get details(): IConnected;
-    /**
-     * @param socket - websocket to be used
-     * @param documentId - ID of the document
-     * @param logger - for reporting telemetry events
-     * @param enableLongPollingDowngrades - allow connection to be downgraded to long-polling on websocket failure
-     */
-    protected constructor(socket: Socket, documentId: string, logger: ITelemetryLoggerExt, enableLongPollingDowngrades?: boolean, connectionId?: string | undefined);
-    /**
-     * Get the ID of the client who is sending the message
-     *
-     * @returns the client ID
-     */
-    get clientId(): string;
-    /**
-     * Get the mode of the client
-     *
-     * @returns the client mode
-     */
-    get mode(): ConnectionMode;
-    /**
-     * Get the claims of the client who is sending the message
-     *
-     * @returns client claims
-     */
-    get claims(): ITokenClaims;
-    /**
-     * Get whether or not this is an existing document
-     *
-     * @returns true if the document exists
-     */
-    get existing(): boolean;
-    /**
-     * Get the maximum size of a message before chunking is required
-     *
-     * @returns the maximum size of a message before chunking is required
-     */
-    get maxMessageSize(): number;
-    /**
-     * Semver of protocol being used with the service
-     */
-    get version(): string;
-    /**
-     * Configuration details provided by the service
-     */
-    get serviceConfiguration(): IClientConfiguration;
-    private checkNotDisposed;
-    /**
-     * Get messages sent during the connection
-     *
-     * @returns messages sent during the connection
-     */
-    get initialMessages(): ISequencedDocumentMessage[];
-    /**
-     * Get signals sent during the connection
-     *
-     * @returns signals sent during the connection
-     */
-    get initialSignals(): ISignalMessage[];
-    /**
-     * Get initial client list
-     *
-     * @returns initial client list sent during the connection
-     */
-    get initialClients(): ISignalClient[];
-    protected emitMessages(type: string, messages: IDocumentMessage[][]): void;
-    /**
-     * Submits a new delta operation to the server
-     *
-     * @param message - delta operation to submit
-     */
-    submit(messages: IDocumentMessage[]): void;
-    /**
-     * Submits a new signal to the server
-     *
-     * @param content - Content of the signal.
-     * @param targetClientId - When specified, the signal is only sent to the provided client id.
-     */
-    submitSignal(content: IDocumentMessage, targetClientId?: string): void;
-    /**
-     * Disconnect from the websocket and close the websocket too.
-     */
-    private closeSocket;
-    protected closeSocketCore(error: IAnyDriverError): void;
-    /**
-     * Disconnect from the websocket, and permanently disable this DocumentDeltaConnection and close the socket.
-     * However the OdspDocumentDeltaConnection differ in dispose as in there we don't close the socket. There is no
-     * multiplexing here, so we need to close the socket here.
-     */
-    dispose(): void;
-    protected disconnect(err: IAnyDriverError): void;
-    /**
-     * Disconnect from the websocket.
-     * @param reason - reason for disconnect
-     */
-    protected disconnectCore(): void;
-    protected initialize(connectMessage: IConnect, timeout: number): Promise<void>;
-    private addPropsToError;
-    protected getConnectionDetailsProps(): {
-        disposed: boolean;
-        socketConnected: boolean;
-        clientId: string | undefined;
-        connectionId: string | undefined;
-    };
-    protected earlyOpHandler: (documentId: string, msgs: ISequencedDocumentMessage[]) => void;
-    protected earlySignalHandler: (msg: ISignalMessage | ISignalMessage[]) => void;
-    private removeEarlyOpHandler;
-    private removeEarlySignalHandler;
-    private addConnectionListener;
-    protected addTrackedListener(event: string, listener: (...args: any[]) => void): void;
-    private removeTrackedListeners;
-    private removeConnectionListeners;
-    private getErrorMessage;
-    private createErrorObjectWithProps;
-    /**
-     * Error raising for socket.io issues
-     */
-    protected createErrorObject(handler: string, error?: any, canRetry?: boolean): IAnyDriverError;
-}
-
-/**
- * Extract and return the w3c data.
- * @param url - request url for which w3c data needs to be reported.
- * @param initiatorType - type of the network call
- * @internal
- */
-export declare function getW3CData(url: string, initiatorType: string): {
-    dnsLookupTime: number | undefined;
-    w3cStartTime: number | undefined;
-    redirectTime: number | undefined;
-    tcpHandshakeTime: number | undefined;
-    secureConnectionTime: number | undefined;
-    responseNetworkTime: number | undefined;
-    fetchStartToResponseEndTime: number | undefined;
-    reqStartToResponseEndTime: number | undefined;
-};
-
-/**
- * An implementation of Promise.race that gives you the winner of the promise race.
- * If one of the promises is rejected before any other is resolved, this method will return the error/reason from that rejection.
- * @internal
- */
-export declare function promiseRaceWithWinner<T>(promises: Promise<T>[]): Promise<{
-    index: number;
-    value: T;
-}>;
-
-/**
- * @internal
- */
-export declare function validateMessages(reason: string, messages: ISequencedDocumentMessage[], from: number, logger: ITelemetryLoggerExt, strict?: boolean): void;
-
-export { }

package/lib/driver-base-alpha.d.ts

@@ -1,26 +0,0 @@
-import { ConnectionMode } from '@fluidframework/protocol-definitions';
-import { EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils';
-import { IAnyDriverError } from '@fluidframework/driver-definitions';
-import { IClientConfiguration } from '@fluidframework/protocol-definitions';
-import { IConnect } from '@fluidframework/protocol-definitions';
-import { IConnected } from '@fluidframework/protocol-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
-import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalClient } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import type { Socket } from 'socket.io-client';
-
-/* Excluded from this release type: DocumentDeltaConnection */
-
-/* Excluded from this release type: getW3CData */
-
-/* Excluded from this release type: promiseRaceWithWinner */
-
-/* Excluded from this release type: validateMessages */
-
-export { }

package/lib/driver-base-beta.d.ts

@@ -1,32 +0,0 @@
-import { ConnectionMode } from '@fluidframework/protocol-definitions';
-import { EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils';
-import { IAnyDriverError } from '@fluidframework/driver-definitions';
-import { IClientConfiguration } from '@fluidframework/protocol-definitions';
-import { IConnect } from '@fluidframework/protocol-definitions';
-import { IConnected } from '@fluidframework/protocol-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
-import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalClient } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import type { Socket } from 'socket.io-client';
-
-/* Excluded from this release type: DocumentDeltaConnection */
-
-/* Excluded from this release type: EventEmitterWithErrorHandling */
-
-/* Excluded from this release type: getW3CData */
-
-/* Excluded from this release type: IDocumentDeltaConnection */
-
-/* Excluded from this release type: IDocumentDeltaConnectionEvents */
-
-/* Excluded from this release type: promiseRaceWithWinner */
-
-/* Excluded from this release type: validateMessages */
-
-export { }

package/lib/driver-base-public.d.ts

@@ -1,32 +0,0 @@
-import { ConnectionMode } from '@fluidframework/protocol-definitions';
-import { EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils';
-import { IAnyDriverError } from '@fluidframework/driver-definitions';
-import { IClientConfiguration } from '@fluidframework/protocol-definitions';
-import { IConnect } from '@fluidframework/protocol-definitions';
-import { IConnected } from '@fluidframework/protocol-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
-import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalClient } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import type { Socket } from 'socket.io-client';
-
-/* Excluded from this release type: DocumentDeltaConnection */
-
-/* Excluded from this release type: EventEmitterWithErrorHandling */
-
-/* Excluded from this release type: getW3CData */
-
-/* Excluded from this release type: IDocumentDeltaConnection */
-
-/* Excluded from this release type: IDocumentDeltaConnectionEvents */
-
-/* Excluded from this release type: promiseRaceWithWinner */
-
-/* Excluded from this release type: validateMessages */
-
-export { }

package/lib/driver-base-untrimmed.d.ts

@@ -1,213 +0,0 @@
-import { ConnectionMode } from '@fluidframework/protocol-definitions';
-import { EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils';
-import { IAnyDriverError } from '@fluidframework/driver-definitions';
-import { IClientConfiguration } from '@fluidframework/protocol-definitions';
-import { IConnect } from '@fluidframework/protocol-definitions';
-import { IConnected } from '@fluidframework/protocol-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
-import { IDocumentDeltaConnectionEvents } from '@fluidframework/driver-definitions';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalClient } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
-import type { Socket } from 'socket.io-client';
-
-/**
- * Represents a connection to a stream of delta updates.
- * @internal
- */
-export declare class DocumentDeltaConnection extends EventEmitterWithErrorHandling<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable {
-    protected readonly socket: Socket;
-    documentId: string;
-    private readonly enableLongPollingDowngrades;
-    protected readonly connectionId?: string | undefined;
-    static readonly eventsToForward: string[];
-    static readonly eventsAlwaysForwarded: string[];
-    /**
-     * Last known sequence number to ordering service at the time of connection
-     * It may lap actual last sequence number (quite a bit, if container  is very active).
-     * But it's best information for client to figure out how far it is behind, at least
-     * for "read" connections. "write" connections may use own "join" op to similar information,
-     * that is likely to be more up-to-date.
-     */
-    checkpointSequenceNumber: number | undefined;
-    protected readonly queuedMessages: ISequencedDocumentMessage[];
-    protected readonly queuedSignals: ISignalMessage[];
-    /**
-     * A flag to indicate whether we have our handler attached.  If it's attached, we're queueing incoming ops
-     * to later be retrieved via initialMessages.
-     */
-    private earlyOpHandlerAttached;
-    private socketConnectionTimeout;
-    private _details;
-    private trackLatencyTimeout;
-    private readonly connectionListeners;
-    private readonly trackedListeners;
-    protected get hasDetails(): boolean;
-    get disposed(): boolean;
-    /**
-     * Flag to indicate whether the DocumentDeltaConnection is expected to still be capable of sending messages.
-     * After disconnection, we flip this to prevent any stale messages from being emitted.
-     */
-    protected _disposed: boolean;
-    private readonly mc;
-    /**
-     * @deprecated Implementors should manage their own logger or monitoring context
-     */
-    protected get logger(): ITelemetryLoggerExt;
-    get details(): IConnected;
-    /**
-     * @param socket - websocket to be used
-     * @param documentId - ID of the document
-     * @param logger - for reporting telemetry events
-     * @param enableLongPollingDowngrades - allow connection to be downgraded to long-polling on websocket failure
-     */
-    protected constructor(socket: Socket, documentId: string, logger: ITelemetryLoggerExt, enableLongPollingDowngrades?: boolean, connectionId?: string | undefined);
-    /**
-     * Get the ID of the client who is sending the message
-     *
-     * @returns the client ID
-     */
-    get clientId(): string;
-    /**
-     * Get the mode of the client
-     *
-     * @returns the client mode
-     */
-    get mode(): ConnectionMode;
-    /**
-     * Get the claims of the client who is sending the message
-     *
-     * @returns client claims
-     */
-    get claims(): ITokenClaims;
-    /**
-     * Get whether or not this is an existing document
-     *
-     * @returns true if the document exists
-     */
-    get existing(): boolean;
-    /**
-     * Get the maximum size of a message before chunking is required
-     *
-     * @returns the maximum size of a message before chunking is required
-     */
-    get maxMessageSize(): number;
-    /**
-     * Semver of protocol being used with the service
-     */
-    get version(): string;
-    /**
-     * Configuration details provided by the service
-     */
-    get serviceConfiguration(): IClientConfiguration;
-    private checkNotDisposed;
-    /**
-     * Get messages sent during the connection
-     *
-     * @returns messages sent during the connection
-     */
-    get initialMessages(): ISequencedDocumentMessage[];
-    /**
-     * Get signals sent during the connection
-     *
-     * @returns signals sent during the connection
-     */
-    get initialSignals(): ISignalMessage[];
-    /**
-     * Get initial client list
-     *
-     * @returns initial client list sent during the connection
-     */
-    get initialClients(): ISignalClient[];
-    protected emitMessages(type: string, messages: IDocumentMessage[][]): void;
-    /**
-     * Submits a new delta operation to the server
-     *
-     * @param message - delta operation to submit
-     */
-    submit(messages: IDocumentMessage[]): void;
-    /**
-     * Submits a new signal to the server
-     *
-     * @param content - Content of the signal.
-     * @param targetClientId - When specified, the signal is only sent to the provided client id.
-     */
-    submitSignal(content: IDocumentMessage, targetClientId?: string): void;
-    /**
-     * Disconnect from the websocket and close the websocket too.
-     */
-    private closeSocket;
-    protected closeSocketCore(error: IAnyDriverError): void;
-    /**
-     * Disconnect from the websocket, and permanently disable this DocumentDeltaConnection and close the socket.
-     * However the OdspDocumentDeltaConnection differ in dispose as in there we don't close the socket. There is no
-     * multiplexing here, so we need to close the socket here.
-     */
-    dispose(): void;
-    protected disconnect(err: IAnyDriverError): void;
-    /**
-     * Disconnect from the websocket.
-     * @param reason - reason for disconnect
-     */
-    protected disconnectCore(): void;
-    protected initialize(connectMessage: IConnect, timeout: number): Promise<void>;
-    private addPropsToError;
-    protected getConnectionDetailsProps(): {
-        disposed: boolean;
-        socketConnected: boolean;
-        clientId: string | undefined;
-        connectionId: string | undefined;
-    };
-    protected earlyOpHandler: (documentId: string, msgs: ISequencedDocumentMessage[]) => void;
-    protected earlySignalHandler: (msg: ISignalMessage | ISignalMessage[]) => void;
-    private removeEarlyOpHandler;
-    private removeEarlySignalHandler;
-    private addConnectionListener;
-    protected addTrackedListener(event: string, listener: (...args: any[]) => void): void;
-    private removeTrackedListeners;
-    private removeConnectionListeners;
-    private getErrorMessage;
-    private createErrorObjectWithProps;
-    /**
-     * Error raising for socket.io issues
-     */
-    protected createErrorObject(handler: string, error?: any, canRetry?: boolean): IAnyDriverError;
-}
-
-/**
- * Extract and return the w3c data.
- * @param url - request url for which w3c data needs to be reported.
- * @param initiatorType - type of the network call
- * @internal
- */
-export declare function getW3CData(url: string, initiatorType: string): {
-    dnsLookupTime: number | undefined;
-    w3cStartTime: number | undefined;
-    redirectTime: number | undefined;
-    tcpHandshakeTime: number | undefined;
-    secureConnectionTime: number | undefined;
-    responseNetworkTime: number | undefined;
-    fetchStartToResponseEndTime: number | undefined;
-    reqStartToResponseEndTime: number | undefined;
-};
-
-/**
- * An implementation of Promise.race that gives you the winner of the promise race.
- * If one of the promises is rejected before any other is resolved, this method will return the error/reason from that rejection.
- * @internal
- */
-export declare function promiseRaceWithWinner<T>(promises: Promise<T>[]): Promise<{
-    index: number;
-    value: T;
-}>;
-
-/**
- * @internal
- */
-export declare function validateMessages(reason: string, messages: ISequencedDocumentMessage[], from: number, logger: ITelemetryLoggerExt, strict?: boolean): void;
-
-export { }

package/lib/test/driverUtilsTests.spec.js

@@ -1,101 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { assert } from "@fluidframework/core-utils";
-import { MockLogger } from "@fluidframework/telemetry-utils";
-import { validateMessages } from "../driverUtils.js";
-describe("driver utils tests", () => {
-    describe("validateMessagesTests", () => {
-        const mockLogger = new MockLogger();
-        const generateOps = (start, count) => {
-            const ops = [];
-            let i = 0;
-            while (i < count) {
-                ops.push({ sequenceNumber: start + i });
-                i++;
-            }
-            return ops;
-        };
-        beforeEach(() => {
-            mockLogger.clear();
-        });
-        it("from not equal to start", () => {
-            const ops = generateOps(1, 5);
-            validateMessages("test1", ops, 0, mockLogger.toTelemetryLogger(), true);
-            assert(ops.length === 0, "no ops should be returned");
-            assert(mockLogger.matchEventStrict([
-                {
-                    eventName: "OpsFetchViolation",
-                    reason: "test1",
-                    from: 0,
-                    start: 1,
-                    last: 5,
-                    length: 5,
-                    details: JSON.stringify({
-                        validLength: 0,
-                        lastValidOpSeqNumber: undefined,
-                        strict: true,
-                    }),
-                },
-            ]), "Ops fetch violation event not correctly recorded");
-        });
-        it("contiguous ops", () => {
-            const ops = generateOps(1, 5);
-            validateMessages("test2", ops, 1, mockLogger.toTelemetryLogger(), true);
-            assert(ops.length === 5, "ops should be returned");
-            assert(mockLogger.events.length === 0, "no events should be there");
-        });
-        it("non contiguous ops: strict = true", () => {
-            const ops = generateOps(1, 5);
-            // Change seq number of last op
-            ops[4].sequenceNumber = 7;
-            validateMessages("test", ops, 1, mockLogger.toTelemetryLogger(), true);
-            assert(ops.length === 0, "no ops should be returned as strict == true");
-            assert(mockLogger.matchEventStrict([
-                {
-                    eventName: "OpsFetchViolation",
-                    reason: "test",
-                    from: 1,
-                    start: 1,
-                    last: 7,
-                    length: 5,
-                    details: JSON.stringify({
-                        validLength: 0,
-                        lastValidOpSeqNumber: undefined,
-                        strict: true,
-                    }),
-                },
-            ]), "Ops fetch violation event not correctly recorded");
-        });
-        it("non contiguous ops: strict = false", () => {
-            const ops = generateOps(1, 5);
-            // Change seq number of last op
-            ops[4].sequenceNumber = 7;
-            validateMessages("test", ops, 1, mockLogger.toTelemetryLogger(), false);
-            assert(ops.length === 4, "some should be returned as strict == false");
-            assert(mockLogger.matchEventStrict([
-                {
-                    eventName: "OpsFetchViolation",
-                    reason: "test",
-                    from: 1,
-                    start: 1,
-                    last: 7,
-                    length: 5,
-                    details: JSON.stringify({
-                        validLength: 4,
-                        lastValidOpSeqNumber: 4,
-                        strict: false,
-                    }),
-                },
-            ]), "Ops fetch violation event not correctly recorded");
-        });
-        it("only 1 op: strict = false", () => {
-            const ops = generateOps(1, 1);
-            validateMessages("test", ops, 1, mockLogger.toTelemetryLogger(), false);
-            assert(ops.length === 1, "some should be returned as strict == false");
-            assert(mockLogger.events.length === 0, "no events should be there");
-        });
-    });
-});
-//# sourceMappingURL=driverUtilsTests.spec.js.map

package/lib/test/driverUtilsTests.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"driverUtilsTests.spec.js","sourceRoot":"","sources":["../../src/test/driverUtilsTests.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAE7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IACnC,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACtC,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QACpC,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,KAAa,EAAE,EAAE;YACpD,MAAM,GAAG,GAAgC,EAAE,CAAC;YAC5C,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,OAAO,CAAC,GAAG,KAAK,EAAE;gBACjB,GAAG,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,KAAK,GAAG,CAAC,EAAsC,CAAC,CAAC;gBAC5E,CAAC,EAAE,CAAC;aACJ;YACD,OAAO,GAAG,CAAC;QACZ,CAAC,CAAC;QAEF,UAAU,CAAC,GAAG,EAAE;YACf,UAAU,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YAClC,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC9B,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,UAAU,CAAC,iBAAiB,EAAE,EAAE,IAAI,CAAC,CAAC;YACxE,MAAM,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,2BAA2B,CAAC,CAAC;YACtD,MAAM,CACL,UAAU,CAAC,gBAAgB,CAAC;gBAC3B;oBACC,SAAS,EAAE,mBAAmB;oBAC9B,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,CAAC;oBACP,KAAK,EAAE,CAAC;oBACR,IAAI,EAAE,CAAC;oBACP,MAAM,EAAE,CAAC;oBACT,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;wBACvB,WAAW,EAAE,CAAC;wBACd,oBAAoB,EAAE,SAAS;wBAC/B,MAAM,EAAE,IAAI;qBACZ,CAAC;iBACF;aACD,CAAC,EACF,kDAAkD,CAClD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;YACzB,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC9B,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,UAAU,CAAC,iBAAiB,EAAE,EAAE,IAAI,CAAC,CAAC;YACxE,MAAM,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,wBAAwB,CAAC,CAAC;YACnD,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC5C,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC9B,+BAA+B;YAC/B,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC;YAC1B,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,UAAU,CAAC,iBAAiB,EAAE,EAAE,IAAI,CAAC,CAAC;YACvE,MAAM,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,6CAA6C,CAAC,CAAC;YACxE,MAAM,CACL,UAAU,CAAC,gBAAgB,CAAC;gBAC3B;oBACC,SAAS,EAAE,mBAAmB;oBAC9B,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,CAAC;oBACP,KAAK,EAAE,CAAC;oBACR,IAAI,EAAE,CAAC;oBACP,MAAM,EAAE,CAAC;oBACT,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;wBACvB,WAAW,EAAE,CAAC;wBACd,oBAAoB,EAAE,SAAS;wBAC/B,MAAM,EAAE,IAAI;qBACZ,CAAC;iBACF;aACD,CAAC,EACF,kDAAkD,CAClD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC7C,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC9B,+BAA+B;YAC/B,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC;YAC1B,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,UAAU,CAAC,iBAAiB,EAAE,EAAE,KAAK,CAAC,CAAC;YACxE,MAAM,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,4CAA4C,CAAC,CAAC;YACvE,MAAM,CACL,UAAU,CAAC,gBAAgB,CAAC;gBAC3B;oBACC,SAAS,EAAE,mBAAmB;oBAC9B,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,CAAC;oBACP,KAAK,EAAE,CAAC;oBACR,IAAI,EAAE,CAAC;oBACP,MAAM,EAAE,CAAC;oBACT,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;wBACvB,WAAW,EAAE,CAAC;wBACd,oBAAoB,EAAE,CAAC;wBACvB,MAAM,EAAE,KAAK;qBACb,CAAC;iBACF;aACD,CAAC,EACF,kDAAkD,CAClD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACpC,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC9B,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,UAAU,CAAC,iBAAiB,EAAE,EAAE,KAAK,CAAC,CAAC;YACxE,MAAM,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,4CAA4C,CAAC,CAAC;YACvE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { validateMessages } from \"../driverUtils.js\";\n\ndescribe(\"driver utils tests\", () => {\n\tdescribe(\"validateMessagesTests\", () => {\n\t\tconst mockLogger = new MockLogger();\n\t\tconst generateOps = (start: number, count: number) => {\n\t\t\tconst ops: ISequencedDocumentMessage[] = [];\n\t\t\tlet i = 0;\n\t\t\twhile (i < count) {\n\t\t\t\tops.push({ sequenceNumber: start + i } as any as ISequencedDocumentMessage);\n\t\t\t\ti++;\n\t\t\t}\n\t\t\treturn ops;\n\t\t};\n\n\t\tbeforeEach(() => {\n\t\t\tmockLogger.clear();\n\t\t});\n\n\t\tit(\"from not equal to start\", () => {\n\t\t\tconst ops = generateOps(1, 5);\n\t\t\tvalidateMessages(\"test1\", ops, 0, mockLogger.toTelemetryLogger(), true);\n\t\t\tassert(ops.length === 0, \"no ops should be returned\");\n\t\t\tassert(\n\t\t\t\tmockLogger.matchEventStrict([\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: \"OpsFetchViolation\",\n\t\t\t\t\t\treason: \"test1\",\n\t\t\t\t\t\tfrom: 0,\n\t\t\t\t\t\tstart: 1,\n\t\t\t\t\t\tlast: 5,\n\t\t\t\t\t\tlength: 5,\n\t\t\t\t\t\tdetails: JSON.stringify({\n\t\t\t\t\t\t\tvalidLength: 0,\n\t\t\t\t\t\t\tlastValidOpSeqNumber: undefined,\n\t\t\t\t\t\t\tstrict: true,\n\t\t\t\t\t\t}),\n\t\t\t\t\t},\n\t\t\t\t]),\n\t\t\t\t\"Ops fetch violation event not correctly recorded\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"contiguous ops\", () => {\n\t\t\tconst ops = generateOps(1, 5);\n\t\t\tvalidateMessages(\"test2\", ops, 1, mockLogger.toTelemetryLogger(), true);\n\t\t\tassert(ops.length === 5, \"ops should be returned\");\n\t\t\tassert(mockLogger.events.length === 0, \"no events should be there\");\n\t\t});\n\n\t\tit(\"non contiguous ops: strict = true\", () => {\n\t\t\tconst ops = generateOps(1, 5);\n\t\t\t// Change seq number of last op\n\t\t\tops[4].sequenceNumber = 7;\n\t\t\tvalidateMessages(\"test\", ops, 1, mockLogger.toTelemetryLogger(), true);\n\t\t\tassert(ops.length === 0, \"no ops should be returned as strict == true\");\n\t\t\tassert(\n\t\t\t\tmockLogger.matchEventStrict([\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: \"OpsFetchViolation\",\n\t\t\t\t\t\treason: \"test\",\n\t\t\t\t\t\tfrom: 1,\n\t\t\t\t\t\tstart: 1,\n\t\t\t\t\t\tlast: 7,\n\t\t\t\t\t\tlength: 5,\n\t\t\t\t\t\tdetails: JSON.stringify({\n\t\t\t\t\t\t\tvalidLength: 0,\n\t\t\t\t\t\t\tlastValidOpSeqNumber: undefined,\n\t\t\t\t\t\t\tstrict: true,\n\t\t\t\t\t\t}),\n\t\t\t\t\t},\n\t\t\t\t]),\n\t\t\t\t\"Ops fetch violation event not correctly recorded\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"non contiguous ops: strict = false\", () => {\n\t\t\tconst ops = generateOps(1, 5);\n\t\t\t// Change seq number of last op\n\t\t\tops[4].sequenceNumber = 7;\n\t\t\tvalidateMessages(\"test\", ops, 1, mockLogger.toTelemetryLogger(), false);\n\t\t\tassert(ops.length === 4, \"some should be returned as strict == false\");\n\t\t\tassert(\n\t\t\t\tmockLogger.matchEventStrict([\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: \"OpsFetchViolation\",\n\t\t\t\t\t\treason: \"test\",\n\t\t\t\t\t\tfrom: 1,\n\t\t\t\t\t\tstart: 1,\n\t\t\t\t\t\tlast: 7,\n\t\t\t\t\t\tlength: 5,\n\t\t\t\t\t\tdetails: JSON.stringify({\n\t\t\t\t\t\t\tvalidLength: 4,\n\t\t\t\t\t\t\tlastValidOpSeqNumber: 4,\n\t\t\t\t\t\t\tstrict: false,\n\t\t\t\t\t\t}),\n\t\t\t\t\t},\n\t\t\t\t]),\n\t\t\t\t\"Ops fetch violation event not correctly recorded\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"only 1 op: strict = false\", () => {\n\t\t\tconst ops = generateOps(1, 1);\n\t\t\tvalidateMessages(\"test\", ops, 1, mockLogger.toTelemetryLogger(), false);\n\t\t\tassert(ops.length === 1, \"some should be returned as strict == false\");\n\t\t\tassert(mockLogger.events.length === 0, \"no events should be there\");\n\t\t});\n\t});\n});\n"]}

package/lib/test/types/validateDriverBasePrevious.generated.js

@@ -1,10 +0,0 @@
-use_current_ClassDeclaration_DocumentDeltaConnection(get_old_ClassDeclaration_DocumentDeltaConnection());
-use_old_ClassDeclaration_DocumentDeltaConnection(get_current_ClassDeclaration_DocumentDeltaConnection());
-use_current_FunctionDeclaration_getW3CData(get_old_FunctionDeclaration_getW3CData());
-use_old_FunctionDeclaration_getW3CData(get_current_FunctionDeclaration_getW3CData());
-use_current_FunctionDeclaration_promiseRaceWithWinner(get_old_FunctionDeclaration_promiseRaceWithWinner());
-use_old_FunctionDeclaration_promiseRaceWithWinner(get_current_FunctionDeclaration_promiseRaceWithWinner());
-use_current_FunctionDeclaration_validateMessages(get_old_FunctionDeclaration_validateMessages());
-use_old_FunctionDeclaration_validateMessages(get_current_FunctionDeclaration_validateMessages());
-export {};
-//# sourceMappingURL=validateDriverBasePrevious.generated.js.map

package/lib/test/types/validateDriverBasePrevious.generated.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateDriverBasePrevious.generated.js","sourceRoot":"","sources":["../../../src/test/types/validateDriverBasePrevious.generated.ts"],"names":[],"mappings":"AAgCA,oDAAoD,CAChD,gDAAgD,EAAE,CAAC,CAAC;AAWxD,gDAAgD,CAC5C,oDAAoD,EAAE,CAAC,CAAC;AAW5D,0CAA0C,CACtC,sCAAsC,EAAE,CAAC,CAAC;AAW9C,sCAAsC,CAClC,0CAA0C,EAAE,CAAC,CAAC;AAWlD,qDAAqD,CACjD,iDAAiD,EAAE,CAAC,CAAC;AAWzD,iDAAiD,CAC7C,qDAAqD,EAAE,CAAC,CAAC;AAW7D,gDAAgD,CAC5C,4CAA4C,EAAE,CAAC,CAAC;AAWpD,4CAA4C,CACxC,gDAAgD,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/driver-base-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_DocumentDeltaConnection\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_DocumentDeltaConnection():\n    TypeOnly<old.DocumentDeltaConnection>;\ndeclare function use_current_ClassDeclaration_DocumentDeltaConnection(\n    use: TypeOnly<current.DocumentDeltaConnection>): void;\nuse_current_ClassDeclaration_DocumentDeltaConnection(\n    get_old_ClassDeclaration_DocumentDeltaConnection());\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_DocumentDeltaConnection\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_DocumentDeltaConnection():\n    TypeOnly<current.DocumentDeltaConnection>;\ndeclare function use_old_ClassDeclaration_DocumentDeltaConnection(\n    use: TypeOnly<old.DocumentDeltaConnection>): void;\nuse_old_ClassDeclaration_DocumentDeltaConnection(\n    get_current_ClassDeclaration_DocumentDeltaConnection());\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_getW3CData\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_FunctionDeclaration_getW3CData():\n    TypeOnly<typeof old.getW3CData>;\ndeclare function use_current_FunctionDeclaration_getW3CData(\n    use: TypeOnly<typeof current.getW3CData>): void;\nuse_current_FunctionDeclaration_getW3CData(\n    get_old_FunctionDeclaration_getW3CData());\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_getW3CData\": {\"backCompat\": false}\n*/\ndeclare function get_current_FunctionDeclaration_getW3CData():\n    TypeOnly<typeof current.getW3CData>;\ndeclare function use_old_FunctionDeclaration_getW3CData(\n    use: TypeOnly<typeof old.getW3CData>): void;\nuse_old_FunctionDeclaration_getW3CData(\n    get_current_FunctionDeclaration_getW3CData());\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_promiseRaceWithWinner\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_FunctionDeclaration_promiseRaceWithWinner():\n    TypeOnly<typeof old.promiseRaceWithWinner>;\ndeclare function use_current_FunctionDeclaration_promiseRaceWithWinner(\n    use: TypeOnly<typeof current.promiseRaceWithWinner>): void;\nuse_current_FunctionDeclaration_promiseRaceWithWinner(\n    get_old_FunctionDeclaration_promiseRaceWithWinner());\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_promiseRaceWithWinner\": {\"backCompat\": false}\n*/\ndeclare function get_current_FunctionDeclaration_promiseRaceWithWinner():\n    TypeOnly<typeof current.promiseRaceWithWinner>;\ndeclare function use_old_FunctionDeclaration_promiseRaceWithWinner(\n    use: TypeOnly<typeof old.promiseRaceWithWinner>): void;\nuse_old_FunctionDeclaration_promiseRaceWithWinner(\n    get_current_FunctionDeclaration_promiseRaceWithWinner());\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_validateMessages\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_FunctionDeclaration_validateMessages():\n    TypeOnly<typeof old.validateMessages>;\ndeclare function use_current_FunctionDeclaration_validateMessages(\n    use: TypeOnly<typeof current.validateMessages>): void;\nuse_current_FunctionDeclaration_validateMessages(\n    get_old_FunctionDeclaration_validateMessages());\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_validateMessages\": {\"backCompat\": false}\n*/\ndeclare function get_current_FunctionDeclaration_validateMessages():\n    TypeOnly<typeof current.validateMessages>;\ndeclare function use_old_FunctionDeclaration_validateMessages(\n    use: TypeOnly<typeof old.validateMessages>): void;\nuse_old_FunctionDeclaration_validateMessages(\n    get_current_FunctionDeclaration_validateMessages());\n"]}