@fluidframework/driver-base 2.0.0-internal.7.1.1 → 2.0.0-internal.7.2.1

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/driver-base";
-export declare const pkgVersion = "2.0.0-internal.7.1.1";
+export declare const pkgVersion = "2.0.0-internal.7.2.1";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/driver-base";
-export const pkgVersion = "2.0.0-internal.7.1.1";
+export const pkgVersion = "2.0.0-internal.7.2.1";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-base\";\nexport const pkgVersion = \"2.0.0-internal.7.1.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/driver-base\";\nexport const pkgVersion = \"2.0.0-internal.7.2.1\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-base",
-  "version": "2.0.0-internal.7.1.1",
+  "version": "2.0.0-internal.7.2.1",
   "description": "Shared driver code for Fluid driver implementations",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,26 +35,25 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
-    "@fluidframework/core-utils": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
-    "@fluidframework/driver-utils": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
+    "@fluid-internal/client-utils": ">=2.0.0-internal.7.2.1 <2.0.0-internal.7.3.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.2.1 <2.0.0-internal.7.3.0",
+    "@fluidframework/core-utils": ">=2.0.0-internal.7.2.1 <2.0.0-internal.7.3.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.7.2.1 <2.0.0-internal.7.3.0",
+    "@fluidframework/driver-utils": ">=2.0.0-internal.7.2.1 <2.0.0-internal.7.3.0",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0"
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.2.1 <2.0.0-internal.7.3.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.25.0",
-    "@fluidframework/build-common": "^2.0.1",
-    "@fluidframework/build-tools": "^0.25.0",
+    "@fluid-tools/build-cli": "^0.26.1",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.26.1",
     "@fluidframework/driver-base-previous": "npm:@fluidframework/driver-base@2.0.0-internal.7.1.0",
     "@fluidframework/eslint-config-fluid": "^3.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.1.1 <2.0.0-internal.7.2.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.2.1 <2.0.0-internal.7.3.0",
     "@microsoft/api-extractor": "^7.37.0",
     "@types/mocha": "^9.1.1",
     "@types/node": "^16.18.38",
     "c8": "^7.7.1",
-    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "~8.50.0",
     "mocha": "^10.2.0",
@@ -86,7 +85,7 @@
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
     "ci:build:docs": "api-extractor run",
-    "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp' 'nyc'",
+    "clean": "rimraf --glob dist lib \"*.tsbuildinfo\" \"*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",

package/src/documentDeltaConnection.ts

@@ -9,7 +9,7 @@ import {
 	IDocumentDeltaConnection,
 	IDocumentDeltaConnectionEvents,
 } from "@fluidframework/driver-definitions";
-import { createGenericNetworkError } from "@fluidframework/driver-utils";
+import { UsageError, createGenericNetworkError } from "@fluidframework/driver-utils";
 import {
 	ConnectionMode,
 	IClientConfiguration,
@@ -22,7 +22,7 @@ import {
 	ITokenClaims,
 	ScopeType,
 } from "@fluidframework/protocol-definitions";
-import { IDisposable, ITelemetryProperties } from "@fluidframework/core-interfaces";
+import { IDisposable, ITelemetryProperties, LogLevel } from "@fluidframework/core-interfaces";
 import {
 	ITelemetryLoggerExt,
 	extractLogSafeErrorProperties,
@@ -331,11 +331,17 @@ export class DocumentDeltaConnection
 	/**
 	 * Submits a new signal to the server
 	 *
-	 * @param message - signal to submit
+	 * @param content - Content of the signal.
+	 * @param targetClientId - When specified, the signal is only sent to the provided client id.
 	 */
-	public submitSignal(message: IDocumentMessage): void {
+	public submitSignal(content: IDocumentMessage, targetClientId?: string): void {
 		this.checkNotDisposed();
-		this.emitMessages("submitSignal", [[message]]);
+
+		if (targetClientId && this.details.supportedFeatures?.submit_signals_v2 !== true) {
+			throw new UsageError("Sending signals to specific client ids is not supported.");
+		}
+
+		this.emitMessages("submitSignal", [[content]]);
 	}
 
 	/**
@@ -571,6 +577,15 @@ export class DocumentDeltaConnection
 					}
 				}
 
+				this.logger.sendTelemetryEvent(
+					{
+						eventName: "ConnectDocumentSuccess",
+						pendingClientId: response.clientId,
+					},
+					undefined,
+					LogLevel.verbose,
+				);
+
 				this.checkpointSequenceNumber = response.checkpointSequenceNumber;
 
 				this.removeConnectionListeners();

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-base";
-export const pkgVersion = "2.0.0-internal.7.1.1";
+export const pkgVersion = "2.0.0-internal.7.2.1";

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

@@ -1,215 +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.
- *
- * @public
- */
-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 message - signal to submit
-     */
-    submitSignal(message: IDocumentMessage): 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
- *
- * @public
- */
-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.
- *
- * @public
- */
-export declare function promiseRaceWithWinner<T>(promises: Promise<T>[]): Promise<{
-    index: number;
-    value: T;
-}>;
-
-/**
- * @public
- */
-export declare function validateMessages(reason: string, messages: ISequencedDocumentMessage[], from: number, logger: ITelemetryLoggerExt, strict?: boolean): void;
-
-export { }

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

@@ -1,215 +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.
- *
- * @public
- */
-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 message - signal to submit
-     */
-    submitSignal(message: IDocumentMessage): 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
- *
- * @public
- */
-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.
- *
- * @public
- */
-export declare function promiseRaceWithWinner<T>(promises: Promise<T>[]): Promise<{
-    index: number;
-    value: T;
-}>;
-
-/**
- * @public
- */
-export declare function validateMessages(reason: string, messages: ISequencedDocumentMessage[], from: number, logger: ITelemetryLoggerExt, strict?: boolean): void;
-
-export { }