@fluidframework/driver-utils 1.3.0 → 2.0.0-dev.1.4.5.105745

package/src/messageRecognition.ts

@@ -5,14 +5,19 @@
 import { IDocumentMessage, ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
 
 /**
+ * Determines whether or not the message type is one of the following:
  *
- * @param message-message
- * @returns whether or not the message type is one listed below
- * "op"
- * "summarize"
- * "propose"
- * "reject"
- * "noop"
+ * - {@link @fluidframework/protocol-definitions#MessageType.Operation}
+ *
+ * - {@link @fluidframework/protocol-definitions#MessageType.Summarize}
+ *
+ * - {@link @fluidframework/protocol-definitions#MessageType.Propose}
+ *
+ * - {@link @fluidframework/protocol-definitions#MessageType.Reject}
+ *
+ * - {@link @fluidframework/protocol-definitions#MessageType2.Accept}
+ *
+ * - {@link @fluidframework/protocol-definitions#MessageType.NoOp}
  */
 export function isClientMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean {
     if (isRuntimeMessage(message)) {
@@ -22,6 +27,8 @@ export function isClientMessage(message: ISequencedDocumentMessage | IDocumentMe
         case MessageType.Propose:
         case MessageType.Reject:
         case MessageType.NoOp:
+        case MessageType2.Accept:
+        case MessageType.Summarize:
             return true;
         default:
             return false;
@@ -29,14 +36,12 @@ export function isClientMessage(message: ISequencedDocumentMessage | IDocumentMe
 }
 
 /**
- *
- * @param message-message
- * @returns whether or not the message type is one listed below
- * "op"
- * "summarize"
+ * Tells if message was sent by container runtime
+ * @privateRemarks ADO #1385: To be moved to container-definitions
+ * @returns whether the message is a runtime message
  */
-export function isRuntimeMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean {
-    return message.type === MessageType.Operation || message.type === MessageType.Summarize;
+export function isRuntimeMessage(message: { type: string; }): boolean {
+    return message.type === MessageType.Operation;
 }
 
 enum RuntimeMessage {
@@ -50,16 +55,23 @@ enum RuntimeMessage {
 }
 
 /**
+ * Determines whether or not the message type is one of the following: (legacy)
+ *
+ * - "component"
+ *
+ * - "attach"
+ *
+ * - "chunkedOp"
  *
- * @param message-message
- * @returns whether or not the message type is one listed below (legacy)
- * "component"
- * "attach"
- * "chunkedOp"
- * "blobAttach"
- * "rejoin"
- * "alias"
- * "op"
+ * - "blobAttach"
+ *
+ * - "rejoin"
+ *
+ * - "alias"
+ *
+ * - "op"
+ *
+ * @deprecated This API should not be used.
  */
 export function isUnpackedRuntimeMessage(message: ISequencedDocumentMessage): boolean {
     if ((Object.values(RuntimeMessage) as string[]).includes(message.type)) {
@@ -67,3 +79,16 @@ export function isUnpackedRuntimeMessage(message: ISequencedDocumentMessage): bo
     }
     return false;
 }
+
+// ADO #1385: staging code changes across layers.
+// Eventually to be replaced by MessageType.accept
+export enum MessageType2 {
+    Accept = "accept",
+}
+
+// ADO #1385: To be moved to packages/protocol-base/src/protocol.ts
+export function canBeCoalescedByService(message: ISequencedDocumentMessage | IDocumentMessage): boolean {
+    // This assumes that in the future relay service may implement coalescing of accept messages,
+    // same way it was doing coalescing of immediate noops in the past.
+    return message.type === MessageType.NoOp || message.type === MessageType2.Accept;
+}

package/src/network.ts

@@ -8,6 +8,8 @@ import {
     IDriverErrorBase,
     IAuthorizationError,
     DriverErrorType,
+    ILocationRedirectionError,
+    IResolvedUrl,
 } from "@fluidframework/driver-definitions";
 import { ITelemetryProperties } from "@fluidframework/common-definitions";
 import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
@@ -91,6 +93,20 @@ export class AuthorizationError extends LoggingError implements IAuthorizationEr
     }
 }
 
+export class LocationRedirectionError extends LoggingError implements ILocationRedirectionError, IFluidErrorBase {
+    readonly errorType = DriverErrorType.locationRedirection;
+    readonly canRetry = false;
+
+    constructor(
+        message: string,
+        readonly redirectUrl: IResolvedUrl,
+        props: DriverErrorTelemetryProps,
+    ) {
+        // do not log redirectURL
+        super(message, props, new Set(["redirectUrl"]));
+    }
+}
+
 export class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {
     constructor(
         message: string,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "1.3.0";
+export const pkgVersion = "2.0.0-dev.1.4.5.105745";

package/src/parallelRequests.ts

@@ -23,7 +23,7 @@ type WorkingState = "working" | "done" | "canceled";
  * data in the right order. Take a look at UT for examples.
  * @param concurrency - level of concurrency
  * @param from - starting point of fetching data (inclusive)
- * @param to  - ending point of fetching data. exclusive, or undefined if unknown
+ * @param to - ending point of fetching data. exclusive, or undefined if unknown
  * @param payloadSize - batch size
  * @param logger - logger to use
  * @param requestCallback - callback to request batches

package/src/readAndParse.ts

@@ -7,11 +7,16 @@ import { bufferToString } from "@fluidframework/common-utils";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 
 /**
- * Read a blob from IDocumentStorageService and JSON.parse it into object of type T
+ * Read a blob from {@link @fluidframework/driver-definitions#IDocumentStorageService} and
+ * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse | JSON.parse}
+ * it into object of type `T`.
  *
- * @param storage - the IDocumentStorageService to read from
- * @param id - the id of the blob to read and parse
- * @returns the object that we decoded and JSON.parse
+ * @param storage - The `DocumentStorageService` to read from.
+ * @param id - The ID of the blob to read and parse.
+ *
+ * @typeParam T - Output type matching JSON format of inpyt blob data.
+ *
+ * @returns The object that we decoded and parsed via `JSON.parse`.
  */
 export async function readAndParse<T>(storage: Pick<IDocumentStorageService, "readBlob">, id: string): Promise<T> {
     const blob = await storage.readBlob(id);

package/src/runWithRetry.ts

@@ -16,14 +16,18 @@ import { NonRetryableError } from ".";
  */
 export interface IProgress {
     /**
-     * Abort signal used to cancel operation
-     * Note that most of the layers do not use this signal yet. We need to change that over time.
+     * Abort signal used to cancel operation.
+     *
+     * @remarks Note that most of the layers do not use this signal yet. We need to change that over time.
      * Please consult with API documentation / implementation.
      * Note that  number of layers may not check this signal while holding this request in a queue,
      * so it may take a while it takes effect. This can be improved in the future.
-     * Layers in question are:
-     *    - driver (RateLimiter)
-     *    - runWithRetry
+     *
+     * The layers in question are:
+     *
+     * - driver (RateLimiter)
+     *
+     * - runWithRetry
      */
     cancel?: AbortSignal;