@fluidframework/driver-utils 2.0.0-internal.1.1.2 → 2.0.0-internal.1.2.0

package/dist/messageRecognition.d.ts

@@ -4,35 +4,51 @@
  */
 import { IDocumentMessage, ISequencedDocumentMessage } 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 declare function isClientMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean;
 /**
- *
- * @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 declare function isRuntimeMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean;
+export declare function isRuntimeMessage(message: {
+    type: string;
+}): boolean;
 /**
+ * Determines whether or not the message type is one of the following: (legacy)
+ *
+ * - "component"
+ *
+ * - "attach"
+ *
+ * - "chunkedOp"
+ *
+ * - "blobAttach"
+ *
+ * - "rejoin"
+ *
+ * - "alias"
+ *
+ * - "op"
  *
- * @param message-message
- * @returns whether or not the message type is one listed below (legacy)
- * "component"
- * "attach"
- * "chunkedOp"
- * "blobAttach"
- * "rejoin"
- * "alias"
- * "op"
+ * @deprecated This API should not be used.
  */
 export declare function isUnpackedRuntimeMessage(message: ISequencedDocumentMessage): boolean;
+export declare enum MessageType2 {
+    Accept = "accept"
+}
+export declare function canBeCoalescedByService(message: ISequencedDocumentMessage | IDocumentMessage): boolean;
 //# sourceMappingURL=messageRecognition.d.ts.map

package/dist/messageRecognition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messageRecognition.d.ts","sourceRoot":"","sources":["../src/messageRecognition.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAEhH;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,yBAAyB,GAAG,gBAAgB,GAAG,OAAO,CAY9F;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,yBAAyB,GAAG,gBAAgB,GAAG,OAAO,CAE/F;AAYD;;;;;;;;;;;GAWG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAKpF"}
+{"version":3,"file":"messageRecognition.d.ts","sourceRoot":"","sources":["../src/messageRecognition.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAEhH;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,yBAAyB,GAAG,gBAAgB,GAAG,OAAO,CAc9F;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;CAAE,GAAG,OAAO,CAEpE;AAYD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAKpF;AAID,oBAAY,YAAY;IACpB,MAAM,WAAW;CACpB;AAGD,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,yBAAyB,GAAG,gBAAgB,GAAG,OAAO,CAItG"}

package/dist/messageRecognition.js

@@ -1,20 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isUnpackedRuntimeMessage = exports.isRuntimeMessage = exports.isClientMessage = void 0;
+exports.canBeCoalescedByService = exports.MessageType2 = exports.isUnpackedRuntimeMessage = exports.isRuntimeMessage = exports.isClientMessage = void 0;
 /*!
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
 const protocol_definitions_1 = require("@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}
  */
 function isClientMessage(message) {
     if (isRuntimeMessage(message)) {
@@ -24,6 +29,8 @@ function isClientMessage(message) {
         case protocol_definitions_1.MessageType.Propose:
         case protocol_definitions_1.MessageType.Reject:
         case protocol_definitions_1.MessageType.NoOp:
+        case MessageType2.Accept:
+        case protocol_definitions_1.MessageType.Summarize:
             return true;
         default:
             return false;
@@ -31,14 +38,12 @@ function isClientMessage(message) {
 }
 exports.isClientMessage = isClientMessage;
 /**
- *
- * @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
  */
 function isRuntimeMessage(message) {
-    return message.type === protocol_definitions_1.MessageType.Operation || message.type === protocol_definitions_1.MessageType.Summarize;
+    return message.type === protocol_definitions_1.MessageType.Operation;
 }
 exports.isRuntimeMessage = isRuntimeMessage;
 var RuntimeMessage;
@@ -52,16 +57,23 @@ var RuntimeMessage;
     RuntimeMessage["Operation"] = "op";
 })(RuntimeMessage || (RuntimeMessage = {}));
 /**
+ * Determines whether or not the message type is one of the following: (legacy)
+ *
+ * - "component"
  *
- * @param message-message
- * @returns whether or not the message type is one listed below (legacy)
- * "component"
- * "attach"
- * "chunkedOp"
- * "blobAttach"
- * "rejoin"
- * "alias"
- * "op"
+ * - "attach"
+ *
+ * - "chunkedOp"
+ *
+ * - "blobAttach"
+ *
+ * - "rejoin"
+ *
+ * - "alias"
+ *
+ * - "op"
+ *
+ * @deprecated This API should not be used.
  */
 function isUnpackedRuntimeMessage(message) {
     if (Object.values(RuntimeMessage).includes(message.type)) {
@@ -70,4 +82,17 @@ function isUnpackedRuntimeMessage(message) {
     return false;
 }
 exports.isUnpackedRuntimeMessage = isUnpackedRuntimeMessage;
+// ADO #1385: staging code changes across layers.
+// Eventually to be replaced by MessageType.accept
+var MessageType2;
+(function (MessageType2) {
+    MessageType2["Accept"] = "accept";
+})(MessageType2 = exports.MessageType2 || (exports.MessageType2 = {}));
+// ADO #1385: To be moved to packages/protocol-base/src/protocol.ts
+function canBeCoalescedByService(message) {
+    // 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 === protocol_definitions_1.MessageType.NoOp || message.type === MessageType2.Accept;
+}
+exports.canBeCoalescedByService = canBeCoalescedByService;
 //# sourceMappingURL=messageRecognition.js.map

package/dist/messageRecognition.js.map

@@ -1 +1 @@
-{"version":3,"file":"messageRecognition.js","sourceRoot":"","sources":["../src/messageRecognition.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+EAAgH;AAEhH;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAAC,OAAqD;IACjF,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE;QAC3B,OAAO,IAAI,CAAC;KACf;IACD,QAAQ,OAAO,CAAC,IAAI,EAAE;QAClB,KAAK,kCAAW,CAAC,OAAO,CAAC;QACzB,KAAK,kCAAW,CAAC,MAAM,CAAC;QACxB,KAAK,kCAAW,CAAC,IAAI;YACjB,OAAO,IAAI,CAAC;QAChB;YACI,OAAO,KAAK,CAAC;KACpB;AACL,CAAC;AAZD,0CAYC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,OAAqD;IAClF,OAAO,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,CAAC;AAC5F,CAAC;AAFD,4CAEC;AAED,IAAK,cAQJ;AARD,WAAK,cAAc;IACf,gDAA8B,CAAA;IAC9B,mCAAiB,CAAA;IACjB,yCAAuB,CAAA;IACvB,2CAAyB,CAAA;IACzB,mCAAiB,CAAA;IACjB,iCAAe,CAAA;IACf,kCAAgB,CAAA;AACpB,CAAC,EARI,cAAc,KAAd,cAAc,QAQlB;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,wBAAwB,CAAC,OAAkC;IACvE,IAAK,MAAM,CAAC,MAAM,CAAC,cAAc,CAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACpE,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AALD,4DAKC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IDocumentMessage, ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\n\n/**\n *\n * @param message-message\n * @returns whether or not the message type is one listed below\n * \"op\"\n * \"summarize\"\n * \"propose\"\n * \"reject\"\n * \"noop\"\n */\nexport function isClientMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean {\n    if (isRuntimeMessage(message)) {\n        return true;\n    }\n    switch (message.type) {\n        case MessageType.Propose:\n        case MessageType.Reject:\n        case MessageType.NoOp:\n            return true;\n        default:\n            return false;\n    }\n}\n\n/**\n *\n * @param message-message\n * @returns whether or not the message type is one listed below\n * \"op\"\n * \"summarize\"\n */\nexport function isRuntimeMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean {\n    return message.type === MessageType.Operation || message.type === MessageType.Summarize;\n}\n\nenum RuntimeMessage {\n    FluidDataStoreOp = \"component\",\n    Attach = \"attach\",\n    ChunkedOp = \"chunkedOp\",\n    BlobAttach = \"blobAttach\",\n    Rejoin = \"rejoin\",\n    Alias = \"alias\",\n    Operation = \"op\",\n}\n\n/**\n *\n * @param message-message\n * @returns whether or not the message type is one listed below (legacy)\n * \"component\"\n * \"attach\"\n * \"chunkedOp\"\n * \"blobAttach\"\n * \"rejoin\"\n * \"alias\"\n * \"op\"\n */\nexport function isUnpackedRuntimeMessage(message: ISequencedDocumentMessage): boolean {\n    if ((Object.values(RuntimeMessage) as string[]).includes(message.type)) {\n        return true;\n    }\n    return false;\n}\n"]}
+{"version":3,"file":"messageRecognition.js","sourceRoot":"","sources":["../src/messageRecognition.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+EAAgH;AAEhH;;;;;;;;;;;;;;GAcG;AACH,SAAgB,eAAe,CAAC,OAAqD;IACjF,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE;QAC3B,OAAO,IAAI,CAAC;KACf;IACD,QAAQ,OAAO,CAAC,IAAI,EAAE;QAClB,KAAK,kCAAW,CAAC,OAAO,CAAC;QACzB,KAAK,kCAAW,CAAC,MAAM,CAAC;QACxB,KAAK,kCAAW,CAAC,IAAI,CAAC;QACtB,KAAK,YAAY,CAAC,MAAM,CAAC;QACzB,KAAK,kCAAW,CAAC,SAAS;YACtB,OAAO,IAAI,CAAC;QAChB;YACI,OAAO,KAAK,CAAC;KACpB;AACL,CAAC;AAdD,0CAcC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,OAA0B;IACvD,OAAO,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,CAAC;AAClD,CAAC;AAFD,4CAEC;AAED,IAAK,cAQJ;AARD,WAAK,cAAc;IACf,gDAA8B,CAAA;IAC9B,mCAAiB,CAAA;IACjB,yCAAuB,CAAA;IACvB,2CAAyB,CAAA;IACzB,mCAAiB,CAAA;IACjB,iCAAe,CAAA;IACf,kCAAgB,CAAA;AACpB,CAAC,EARI,cAAc,KAAd,cAAc,QAQlB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,wBAAwB,CAAC,OAAkC;IACvE,IAAK,MAAM,CAAC,MAAM,CAAC,cAAc,CAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACpE,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AALD,4DAKC;AAED,iDAAiD;AACjD,kDAAkD;AAClD,IAAY,YAEX;AAFD,WAAY,YAAY;IACpB,iCAAiB,CAAA;AACrB,CAAC,EAFW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAEvB;AAED,mEAAmE;AACnE,SAAgB,uBAAuB,CAAC,OAAqD;IACzF,6FAA6F;IAC7F,mEAAmE;IACnE,OAAO,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,MAAM,CAAC;AACrF,CAAC;AAJD,0DAIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IDocumentMessage, ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Determines whether or not the message type is one of the following:\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.Operation}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.Summarize}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.Propose}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.Reject}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType2.Accept}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.NoOp}\n */\nexport function isClientMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean {\n    if (isRuntimeMessage(message)) {\n        return true;\n    }\n    switch (message.type) {\n        case MessageType.Propose:\n        case MessageType.Reject:\n        case MessageType.NoOp:\n        case MessageType2.Accept:\n        case MessageType.Summarize:\n            return true;\n        default:\n            return false;\n    }\n}\n\n/**\n * Tells if message was sent by container runtime\n * @privateRemarks ADO #1385: To be moved to container-definitions\n * @returns whether the message is a runtime message\n */\nexport function isRuntimeMessage(message: { type: string; }): boolean {\n    return message.type === MessageType.Operation;\n}\n\nenum RuntimeMessage {\n    FluidDataStoreOp = \"component\",\n    Attach = \"attach\",\n    ChunkedOp = \"chunkedOp\",\n    BlobAttach = \"blobAttach\",\n    Rejoin = \"rejoin\",\n    Alias = \"alias\",\n    Operation = \"op\",\n}\n\n/**\n * Determines whether or not the message type is one of the following: (legacy)\n *\n * - \"component\"\n *\n * - \"attach\"\n *\n * - \"chunkedOp\"\n *\n * - \"blobAttach\"\n *\n * - \"rejoin\"\n *\n * - \"alias\"\n *\n * - \"op\"\n *\n * @deprecated This API should not be used.\n */\nexport function isUnpackedRuntimeMessage(message: ISequencedDocumentMessage): boolean {\n    if ((Object.values(RuntimeMessage) as string[]).includes(message.type)) {\n        return true;\n    }\n    return false;\n}\n\n// ADO #1385: staging code changes across layers.\n// Eventually to be replaced by MessageType.accept\nexport enum MessageType2 {\n    Accept = \"accept\",\n}\n\n// ADO #1385: To be moved to packages/protocol-base/src/protocol.ts\nexport function canBeCoalescedByService(message: ISequencedDocumentMessage | IDocumentMessage): boolean {\n    // This assumes that in the future relay service may implement coalescing of accept messages,\n    // same way it was doing coalescing of immediate noops in the past.\n    return message.type === MessageType.NoOp || message.type === MessageType2.Accept;\n}\n"]}

package/dist/network.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,yBAAyB,EACzB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEhF,oBAAY,YAAY;IACpB,OAAO,IAAA;IACP,MAAM,IAAA;IACN,OAAO,IAAA;CACV;AAKD,wBAAgB,QAAQ,IAAI,YAAY,CAKvC;AAED;;;;;;;;GAQG;AACF,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IACzE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC9B;AAED,+DAA+D;AAC/D,oBAAY,yBAAyB,GAAG,oBAAoB,GAAG;IAAE,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;CAAE,CAAC;AAEtG;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAa,YAAW,gBAAgB,EAAE,eAAe;IAK1F,QAAQ,CAAC,QAAQ,EAAE,OAAO;IAJ9B,QAAQ,CAAC,SAAS,uCAAuC;gBAGrD,OAAO,EAAE,MAAM,EACN,QAAQ,EAAE,OAAO,EAC1B,KAAK,EAAE,yBAAyB;CAIvC;AAQD,qBAAa,mCAAoC,SAAQ,YAAa,YAAW,eAAe;IAC5F,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAC2D;IAC5F,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAiD;IAC3E,QAAQ,CAAC,QAAQ,SAAS;gBAEd,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,yBAAyB;CAGhE;AAED,qBAAa,kBAAmB,SAAQ,YAAa,YAAW,mBAAmB,EAAE,eAAe;IAM5F,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IACnC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS;IANzC,QAAQ,CAAC,SAAS,sCAAsC;IACxD,QAAQ,CAAC,QAAQ,SAAS;gBAGtB,OAAO,EAAE,MAAM,EACN,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,QAAQ,EAAE,MAAM,GAAG,SAAS,EACrC,KAAK,EAAE,yBAAyB;CAKvC;AAED,qBAAa,wBAAyB,SAAQ,YAAa,YAAW,yBAAyB,EAAE,eAAe;IAMxG,QAAQ,CAAC,WAAW,EAAE,YAAY;IALtC,QAAQ,CAAC,SAAS,uCAAuC;IACzD,QAAQ,CAAC,QAAQ,SAAS;gBAGtB,OAAO,EAAE,MAAM,EACN,WAAW,EAAE,YAAY,EAClC,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,YAAa,YAAW,eAAe;IAGxF,QAAQ,CAAC,SAAS,EAAE,CAAC;IACrB,QAAQ,CAAC,QAAQ,EAAE,OAAO;gBAF1B,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACZ,QAAQ,EAAE,OAAO,EAC1B,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAGrE,QAAQ,CAAC,SAAS,EAAE,CAAC;gBADrB,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACrB,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAGlE,QAAQ,CAAC,SAAS,EAAE,CAAC;gBADrB,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACrB,KAAK,EAAE,yBAAyB;CAIvC;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,YAAa,YAAW,kBAAkB,EAAE,eAAe;IAMxF,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IALtC,QAAQ,CAAC,SAAS,mCAAmC;IACrD,QAAQ,CAAC,QAAQ,QAAQ;gBAGrB,OAAO,EAAE,MAAM,EACN,iBAAiB,EAAE,MAAM,EAClC,KAAK,EAAE,yBAAyB;CAIvC;AAED,eAAO,MAAM,gBAAgB,YAAa,MAAM,SAAS,yBAAyB,kDACb,CAAC;AAEtE,wBAAgB,yBAAyB,CACrC,OAAO,EAAE,MAAM,EACf,SAAS,EAAE;IAAE,QAAQ,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAAE,EACxD,KAAK,EAAE,yBAAyB,GACjC,eAAe,GAAG,mBAAmB,CAMvC;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,UAAW,GAAG,KAAG,OAAmC,CAAC;AAEjF,gDAAgD;AAChD,eAAO,MAAM,6BAA6B,UAAW,GAAG,KAAG,MAAM,GAAG,SAClB,CAAC;AAEnD,kEAAkE;AAClE,eAAO,MAAM,sBAAsB,UAAW,GAAG,KAAG,MAAM,GAAG,SACf,CAAC"}
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,yBAAyB,EACzB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEhF,oBAAY,YAAY;IACpB,OAAO,IAAA;IACP,MAAM,IAAA;IACN,OAAO,IAAA;CACV;AAKD,wBAAgB,QAAQ,IAAI,YAAY,CAKvC;AAED;;;;;;;;GAQG;AACF,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IACzE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC9B;AAED,+DAA+D;AAC/D,oBAAY,yBAAyB,GAAG,oBAAoB,GAAG;IAAE,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;CAAE,CAAC;AAEtG;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAa,YAAW,gBAAgB,EAAE,eAAe;IAK1F,QAAQ,CAAC,QAAQ,EAAE,OAAO;IAJ9B,QAAQ,CAAC,SAAS,uCAAuC;gBAGrD,OAAO,EAAE,MAAM,EACN,QAAQ,EAAE,OAAO,EAC1B,KAAK,EAAE,yBAAyB;CAIvC;AAQD,qBAAa,mCAAoC,SAAQ,YAAa,YAAW,eAAe;IAC5F,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAC2D;IAC5F,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAiD;IAC3E,QAAQ,CAAC,QAAQ,SAAS;gBAEd,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,yBAAyB;CAGhE;AAED,qBAAa,kBAAmB,SAAQ,YAAa,YAAW,mBAAmB,EAAE,eAAe;IAM5F,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IACnC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS;IANzC,QAAQ,CAAC,SAAS,sCAAsC;IACxD,QAAQ,CAAC,QAAQ,SAAS;gBAGtB,OAAO,EAAE,MAAM,EACN,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,QAAQ,EAAE,MAAM,GAAG,SAAS,EACrC,KAAK,EAAE,yBAAyB;CAKvC;AAED,qBAAa,wBAAyB,SAAQ,YAAa,YAAW,yBAAyB,EAAE,eAAe;IAMxG,QAAQ,CAAC,WAAW,EAAE,YAAY;IALtC,QAAQ,CAAC,SAAS,uCAAuC;IACzD,QAAQ,CAAC,QAAQ,SAAS;gBAGtB,OAAO,EAAE,MAAM,EACN,WAAW,EAAE,YAAY,EAClC,KAAK,EAAE,yBAAyB;CAKvC;AAED,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,YAAa,YAAW,eAAe;IAGxF,QAAQ,CAAC,SAAS,EAAE,CAAC;IACrB,QAAQ,CAAC,QAAQ,EAAE,OAAO;gBAF1B,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACZ,QAAQ,EAAE,OAAO,EAC1B,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAGrE,QAAQ,CAAC,SAAS,EAAE,CAAC;gBADrB,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACrB,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAGlE,QAAQ,CAAC,SAAS,EAAE,CAAC;gBADrB,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACrB,KAAK,EAAE,yBAAyB;CAIvC;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,YAAa,YAAW,kBAAkB,EAAE,eAAe;IAMxF,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IALtC,QAAQ,CAAC,SAAS,mCAAmC;IACrD,QAAQ,CAAC,QAAQ,QAAQ;gBAGrB,OAAO,EAAE,MAAM,EACN,iBAAiB,EAAE,MAAM,EAClC,KAAK,EAAE,yBAAyB;CAIvC;AAED,eAAO,MAAM,gBAAgB,YAAa,MAAM,SAAS,yBAAyB,kDACb,CAAC;AAEtE,wBAAgB,yBAAyB,CACrC,OAAO,EAAE,MAAM,EACf,SAAS,EAAE;IAAE,QAAQ,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAAE,EACxD,KAAK,EAAE,yBAAyB,GACjC,eAAe,GAAG,mBAAmB,CAMvC;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,UAAW,GAAG,KAAG,OAAmC,CAAC;AAEjF,gDAAgD;AAChD,eAAO,MAAM,6BAA6B,UAAW,GAAG,KAAG,MAAM,GAAG,SAClB,CAAC;AAEnD,kEAAkE;AAClE,eAAO,MAAM,sBAAsB,UAAW,GAAG,KAAG,MAAM,GAAG,SACf,CAAC"}

package/dist/network.js

@@ -63,7 +63,8 @@ class AuthorizationError extends telemetry_utils_1.LoggingError {
 exports.AuthorizationError = AuthorizationError;
 class LocationRedirectionError extends telemetry_utils_1.LoggingError {
     constructor(message, redirectUrl, props) {
-        super(message, props);
+        // do not log redirectURL
+        super(message, props, new Set(["redirectUrl"]));
         this.redirectUrl = redirectUrl;
         this.errorType = driver_definitions_1.DriverErrorType.locationRedirection;
         this.canRetry = false;

package/dist/network.js.map

@@ -1 +1 @@
-{"version":3,"file":"network.js","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAEH,2EAO4C;AAE5C,qEAAgF;AAEhF,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,qDAAO,CAAA;IACP,mDAAM,CAAA;IACN,qDAAO,CAAA;AACX,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAED,mFAAmF;AACnF,+EAA+E;AAC/E,6DAA6D;AAC7D,SAAgB,QAAQ;IACpB,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE;QAC9F,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC;KACxE;IACD,OAAO,YAAY,CAAC,OAAO,CAAC;AAChC,CAAC;AALD,4BAKC;AAkBD;;GAEG;AACH,MAAa,mBAAoB,SAAQ,8BAAY;IAGjD,YACI,OAAe,EACN,QAAiB,EAC1B,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,aAAQ,GAAR,QAAQ,CAAS;QAJrB,cAAS,GAAG,oCAAe,CAAC,mBAAmB,CAAC;IAQzD,CAAC;CACJ;AAVD,kDAUC;AAED,oFAAoF;AACpF,yEAAyE;AACzE,qEAAqE;AACrE,uEAAuE;AACvE,SAAS;AACT,MAAM,iCAAiC,GAAG,gCAAgC,CAAC;AAC3E,MAAa,mCAAoC,SAAQ,8BAAY;IAMjE,YAAY,OAAe,EAAE,KAAgC;QACzD,KAAK,CAAC,OAAO,kCAAO,KAAK,KAAE,UAAU,EAAE,GAAG,IAAG,CAAC;QAJzC,cAAS,GAAW,mCAAmC,CAAC,SAAS,CAAC;QAClE,aAAQ,GAAG,KAAK,CAAC;IAI1B,CAAC;;AARL,kFASC;AARmB,6CAAS,GACrB,MAAA,oCAAe,CAAC,iCAAiC,CAAC,mCAAI,iCAAiC,CAAC;AAShG,MAAa,kBAAmB,SAAQ,8BAAY;IAIhD,YACI,OAAe,EACN,MAA0B,EAC1B,QAA4B,EACrC,KAAgC;QAEhC,+BAA+B;QAC/B,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;QAL9C,WAAM,GAAN,MAAM,CAAoB;QAC1B,aAAQ,GAAR,QAAQ,CAAoB;QANhC,cAAS,GAAG,oCAAe,CAAC,kBAAkB,CAAC;QAC/C,aAAQ,GAAG,KAAK,CAAC;IAU1B,CAAC;CACJ;AAbD,gDAaC;AAED,MAAa,wBAAyB,SAAQ,8BAAY;IAItD,YACI,OAAe,EACN,WAAyB,EAClC,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,gBAAW,GAAX,WAAW,CAAc;QAL7B,cAAS,GAAG,oCAAe,CAAC,mBAAmB,CAAC;QAChD,aAAQ,GAAG,KAAK,CAAC;IAQ1B,CAAC;CACJ;AAXD,4DAWC;AAED,MAAa,iBAAoC,SAAQ,8BAAY;IACjE,YACI,OAAe,EACN,SAAY,EACZ,QAAiB,EAC1B,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAJb,cAAS,GAAT,SAAS,CAAG;QACZ,aAAQ,GAAR,QAAQ,CAAS;IAI9B,CAAC;CACJ;AATD,8CASC;AAED,MAAa,iBAAoC,SAAQ,iBAAoB;IACzE,YACI,OAAe,EACN,SAAY,EACrB,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAH/B,cAAS,GAAT,SAAS,CAAG;IAIzB,CAAC;CACJ;AARD,8CAQC;AAED,MAAa,cAAiC,SAAQ,iBAAoB;IACtE,YACI,OAAe,EACN,SAAY,EACrB,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAH9B,cAAS,GAAT,SAAS,CAAG;IAIzB,CAAC;CACJ;AARD,wCAQC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,8BAAY;IAI7C,YACI,OAAe,EACN,iBAAyB,EAClC,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,sBAAiB,GAAjB,iBAAiB,CAAQ;QAL7B,cAAS,GAAG,oCAAe,CAAC,eAAe,CAAC;QAC5C,aAAQ,GAAG,IAAI,CAAC;IAQzB,CAAC;CACJ;AAXD,0CAWC;AAEM,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,KAAgC,EAAE,EAAE,CAClF,IAAI,iBAAiB,CAAC,OAAO,EAAE,oCAAe,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;AADzD,QAAA,gBAAgB,oBACyC;AAEtE,SAAgB,yBAAyB,CACrC,OAAe,EACf,SAAwD,EACxD,KAAgC;IAEhC,IAAI,SAAS,CAAC,YAAY,KAAK,SAAS,IAAI,SAAS,CAAC,QAAQ,EAAE;QAC5D,OAAO,IAAI,eAAe,CACtB,OAAO,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC;KACtD;IACD,OAAO,IAAI,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC;AAVD,8DAUC;AAED;;;;GAIG;AACI,MAAM,eAAe,GAAG,CAAC,KAAU,EAAW,EAAE,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,MAAK,IAAI,CAAC;AAApE,QAAA,eAAe,mBAAqD;AAEjF,gDAAgD;AACzC,MAAM,6BAA6B,GAAG,CAAC,KAAU,EAAsB,EAAE,CAC5E,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAuC,CAAC;AADtC,QAAA,6BAA6B,iCACS;AAEnD,kEAAkE;AAC3D,MAAM,sBAAsB,GAAG,CAAC,KAAU,EAAsB,EAAE,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,MAAK,SAAS,CAAC,CAAC;IAC9G,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AADlC,QAAA,sBAAsB,0BACY","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IThrottlingWarning,\n    IDriverErrorBase,\n    IAuthorizationError,\n    DriverErrorType,\n    ILocationRedirectionError,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { IFluidErrorBase, LoggingError } from \"@fluidframework/telemetry-utils\";\n\nexport enum OnlineStatus {\n    Offline,\n    Online,\n    Unknown,\n}\n\n// It tells if we have local connection only - we might not have connection to web.\n// No solution for node.js (other than resolve dns names / ping specific sites)\n// Can also use window.addEventListener(\"online\" / \"offline\")\nexport function isOnline(): OnlineStatus {\n    if (typeof navigator === \"object\" && navigator !== null && typeof navigator.onLine === \"boolean\") {\n        return navigator.onLine ? OnlineStatus.Online : OnlineStatus.Offline;\n    }\n    return OnlineStatus.Unknown;\n}\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either DriverErrorType or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n */\n export interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n    readonly errorType: string;\n}\n\n/** Telemetry props with driver-specific required properties */\nexport type DriverErrorTelemetryProps = ITelemetryProperties & { driverVersion: string | undefined; };\n\n/**\n * Generic network error class.\n */\nexport class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {\n    readonly errorType = DriverErrorType.genericNetworkError;\n\n    constructor(\n        message: string,\n        readonly canRetry: boolean,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\n// Todo GH #6214: Remove after next drive def bump. This is necessary as there is no\n// compatible way to augment an enum, as it can't be optional. So for now\n// we need to duplicate the value here. We likely need to rethink our\n// DriverErrorType strategy so that it supports extension with optional\n// value.\nconst deltaStreamConnectionForbiddenStr = \"deltaStreamConnectionForbidden\";\nexport class DeltaStreamConnectionForbiddenError extends LoggingError implements IFluidErrorBase {\n    static readonly errorType: string =\n        DriverErrorType[deltaStreamConnectionForbiddenStr] ?? deltaStreamConnectionForbiddenStr;\n    readonly errorType: string = DeltaStreamConnectionForbiddenError.errorType;\n    readonly canRetry = false;\n\n    constructor(message: string, props: DriverErrorTelemetryProps) {\n        super(message, { ...props, statusCode: 400 });\n    }\n}\n\nexport class AuthorizationError extends LoggingError implements IAuthorizationError, IFluidErrorBase {\n    readonly errorType = DriverErrorType.authorizationError;\n    readonly canRetry = false;\n\n    constructor(\n        message: string,\n        readonly claims: string | undefined,\n        readonly tenantId: string | undefined,\n        props: DriverErrorTelemetryProps,\n    ) {\n        // don't log claims or tenantId\n        super(message, props, new Set([\"claims\", \"tenantId\"]));\n    }\n}\n\nexport class LocationRedirectionError extends LoggingError implements ILocationRedirectionError, IFluidErrorBase {\n    readonly errorType = DriverErrorType.locationRedirection;\n    readonly canRetry = false;\n\n    constructor(\n        message: string,\n        readonly redirectUrl: IResolvedUrl,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        readonly canRetry: boolean,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, errorType, false, props);\n    }\n}\n\nexport class RetryableError<T extends string> extends NetworkErrorBasic<T> {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, errorType, true, props);\n    }\n}\n\n/**\n * Throttling error class - used to communicate all throttling errors\n */\nexport class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {\n    readonly errorType = DriverErrorType.throttlingError;\n    readonly canRetry = true;\n\n    constructor(\n        message: string,\n        readonly retryAfterSeconds: number,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport const createWriteError = (message: string, props: DriverErrorTelemetryProps) =>\n    new NonRetryableError(message, DriverErrorType.writeError, props);\n\nexport function createGenericNetworkError(\n    message: string,\n    retryInfo: { canRetry: boolean; retryAfterMs?: number; },\n    props: DriverErrorTelemetryProps,\n): ThrottlingError | GenericNetworkError {\n    if (retryInfo.retryAfterMs !== undefined && retryInfo.canRetry) {\n        return new ThrottlingError(\n            message, retryInfo.retryAfterMs / 1000, props);\n    }\n    return new GenericNetworkError(message, retryInfo.canRetry, props);\n}\n\n/**\n * Check if a connection error can be retried.  Unless explicitly allowed, retry is disallowed.\n * I.e. asserts or unexpected exceptions in our code result in container failure.\n * @param error - The error to inspect for ability to retry\n */\nexport const canRetryOnError = (error: any): boolean => error?.canRetry === true;\n\n/** Check retryAfterSeconds property on error */\nexport const getRetryDelaySecondsFromError = (error: any): number | undefined =>\n    error?.retryAfterSeconds as number | undefined;\n\n/** Check retryAfterSeconds property on error and convert to ms */\nexport const getRetryDelayFromError = (error: any): number | undefined => error?.retryAfterSeconds !== undefined ?\n    error.retryAfterSeconds * 1000 : undefined;\n"]}
+{"version":3,"file":"network.js","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAEH,2EAO4C;AAE5C,qEAAgF;AAEhF,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,qDAAO,CAAA;IACP,mDAAM,CAAA;IACN,qDAAO,CAAA;AACX,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAED,mFAAmF;AACnF,+EAA+E;AAC/E,6DAA6D;AAC7D,SAAgB,QAAQ;IACpB,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE;QAC9F,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC;KACxE;IACD,OAAO,YAAY,CAAC,OAAO,CAAC;AAChC,CAAC;AALD,4BAKC;AAkBD;;GAEG;AACH,MAAa,mBAAoB,SAAQ,8BAAY;IAGjD,YACI,OAAe,EACN,QAAiB,EAC1B,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,aAAQ,GAAR,QAAQ,CAAS;QAJrB,cAAS,GAAG,oCAAe,CAAC,mBAAmB,CAAC;IAQzD,CAAC;CACJ;AAVD,kDAUC;AAED,oFAAoF;AACpF,yEAAyE;AACzE,qEAAqE;AACrE,uEAAuE;AACvE,SAAS;AACT,MAAM,iCAAiC,GAAG,gCAAgC,CAAC;AAC3E,MAAa,mCAAoC,SAAQ,8BAAY;IAMjE,YAAY,OAAe,EAAE,KAAgC;QACzD,KAAK,CAAC,OAAO,kCAAO,KAAK,KAAE,UAAU,EAAE,GAAG,IAAG,CAAC;QAJzC,cAAS,GAAW,mCAAmC,CAAC,SAAS,CAAC;QAClE,aAAQ,GAAG,KAAK,CAAC;IAI1B,CAAC;;AARL,kFASC;AARmB,6CAAS,GACrB,MAAA,oCAAe,CAAC,iCAAiC,CAAC,mCAAI,iCAAiC,CAAC;AAShG,MAAa,kBAAmB,SAAQ,8BAAY;IAIhD,YACI,OAAe,EACN,MAA0B,EAC1B,QAA4B,EACrC,KAAgC;QAEhC,+BAA+B;QAC/B,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;QAL9C,WAAM,GAAN,MAAM,CAAoB;QAC1B,aAAQ,GAAR,QAAQ,CAAoB;QANhC,cAAS,GAAG,oCAAe,CAAC,kBAAkB,CAAC;QAC/C,aAAQ,GAAG,KAAK,CAAC;IAU1B,CAAC;CACJ;AAbD,gDAaC;AAED,MAAa,wBAAyB,SAAQ,8BAAY;IAItD,YACI,OAAe,EACN,WAAyB,EAClC,KAAgC;QAEhC,yBAAyB;QACzB,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAJvC,gBAAW,GAAX,WAAW,CAAc;QAL7B,cAAS,GAAG,oCAAe,CAAC,mBAAmB,CAAC;QAChD,aAAQ,GAAG,KAAK,CAAC;IAS1B,CAAC;CACJ;AAZD,4DAYC;AAED,MAAa,iBAAoC,SAAQ,8BAAY;IACjE,YACI,OAAe,EACN,SAAY,EACZ,QAAiB,EAC1B,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAJb,cAAS,GAAT,SAAS,CAAG;QACZ,aAAQ,GAAR,QAAQ,CAAS;IAI9B,CAAC;CACJ;AATD,8CASC;AAED,MAAa,iBAAoC,SAAQ,iBAAoB;IACzE,YACI,OAAe,EACN,SAAY,EACrB,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAH/B,cAAS,GAAT,SAAS,CAAG;IAIzB,CAAC;CACJ;AARD,8CAQC;AAED,MAAa,cAAiC,SAAQ,iBAAoB;IACtE,YACI,OAAe,EACN,SAAY,EACrB,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAH9B,cAAS,GAAT,SAAS,CAAG;IAIzB,CAAC;CACJ;AARD,wCAQC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,8BAAY;IAI7C,YACI,OAAe,EACN,iBAAyB,EAClC,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,sBAAiB,GAAjB,iBAAiB,CAAQ;QAL7B,cAAS,GAAG,oCAAe,CAAC,eAAe,CAAC;QAC5C,aAAQ,GAAG,IAAI,CAAC;IAQzB,CAAC;CACJ;AAXD,0CAWC;AAEM,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,KAAgC,EAAE,EAAE,CAClF,IAAI,iBAAiB,CAAC,OAAO,EAAE,oCAAe,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;AADzD,QAAA,gBAAgB,oBACyC;AAEtE,SAAgB,yBAAyB,CACrC,OAAe,EACf,SAAwD,EACxD,KAAgC;IAEhC,IAAI,SAAS,CAAC,YAAY,KAAK,SAAS,IAAI,SAAS,CAAC,QAAQ,EAAE;QAC5D,OAAO,IAAI,eAAe,CACtB,OAAO,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC;KACtD;IACD,OAAO,IAAI,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC;AAVD,8DAUC;AAED;;;;GAIG;AACI,MAAM,eAAe,GAAG,CAAC,KAAU,EAAW,EAAE,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,MAAK,IAAI,CAAC;AAApE,QAAA,eAAe,mBAAqD;AAEjF,gDAAgD;AACzC,MAAM,6BAA6B,GAAG,CAAC,KAAU,EAAsB,EAAE,CAC5E,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAuC,CAAC;AADtC,QAAA,6BAA6B,iCACS;AAEnD,kEAAkE;AAC3D,MAAM,sBAAsB,GAAG,CAAC,KAAU,EAAsB,EAAE,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,MAAK,SAAS,CAAC,CAAC;IAC9G,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AADlC,QAAA,sBAAsB,0BACY","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IThrottlingWarning,\n    IDriverErrorBase,\n    IAuthorizationError,\n    DriverErrorType,\n    ILocationRedirectionError,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { IFluidErrorBase, LoggingError } from \"@fluidframework/telemetry-utils\";\n\nexport enum OnlineStatus {\n    Offline,\n    Online,\n    Unknown,\n}\n\n// It tells if we have local connection only - we might not have connection to web.\n// No solution for node.js (other than resolve dns names / ping specific sites)\n// Can also use window.addEventListener(\"online\" / \"offline\")\nexport function isOnline(): OnlineStatus {\n    if (typeof navigator === \"object\" && navigator !== null && typeof navigator.onLine === \"boolean\") {\n        return navigator.onLine ? OnlineStatus.Online : OnlineStatus.Offline;\n    }\n    return OnlineStatus.Unknown;\n}\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either DriverErrorType or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n */\n export interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n    readonly errorType: string;\n}\n\n/** Telemetry props with driver-specific required properties */\nexport type DriverErrorTelemetryProps = ITelemetryProperties & { driverVersion: string | undefined; };\n\n/**\n * Generic network error class.\n */\nexport class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {\n    readonly errorType = DriverErrorType.genericNetworkError;\n\n    constructor(\n        message: string,\n        readonly canRetry: boolean,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\n// Todo GH #6214: Remove after next drive def bump. This is necessary as there is no\n// compatible way to augment an enum, as it can't be optional. So for now\n// we need to duplicate the value here. We likely need to rethink our\n// DriverErrorType strategy so that it supports extension with optional\n// value.\nconst deltaStreamConnectionForbiddenStr = \"deltaStreamConnectionForbidden\";\nexport class DeltaStreamConnectionForbiddenError extends LoggingError implements IFluidErrorBase {\n    static readonly errorType: string =\n        DriverErrorType[deltaStreamConnectionForbiddenStr] ?? deltaStreamConnectionForbiddenStr;\n    readonly errorType: string = DeltaStreamConnectionForbiddenError.errorType;\n    readonly canRetry = false;\n\n    constructor(message: string, props: DriverErrorTelemetryProps) {\n        super(message, { ...props, statusCode: 400 });\n    }\n}\n\nexport class AuthorizationError extends LoggingError implements IAuthorizationError, IFluidErrorBase {\n    readonly errorType = DriverErrorType.authorizationError;\n    readonly canRetry = false;\n\n    constructor(\n        message: string,\n        readonly claims: string | undefined,\n        readonly tenantId: string | undefined,\n        props: DriverErrorTelemetryProps,\n    ) {\n        // don't log claims or tenantId\n        super(message, props, new Set([\"claims\", \"tenantId\"]));\n    }\n}\n\nexport class LocationRedirectionError extends LoggingError implements ILocationRedirectionError, IFluidErrorBase {\n    readonly errorType = DriverErrorType.locationRedirection;\n    readonly canRetry = false;\n\n    constructor(\n        message: string,\n        readonly redirectUrl: IResolvedUrl,\n        props: DriverErrorTelemetryProps,\n    ) {\n        // do not log redirectURL\n        super(message, props, new Set([\"redirectUrl\"]));\n    }\n}\n\nexport class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        readonly canRetry: boolean,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, errorType, false, props);\n    }\n}\n\nexport class RetryableError<T extends string> extends NetworkErrorBasic<T> {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, errorType, true, props);\n    }\n}\n\n/**\n * Throttling error class - used to communicate all throttling errors\n */\nexport class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {\n    readonly errorType = DriverErrorType.throttlingError;\n    readonly canRetry = true;\n\n    constructor(\n        message: string,\n        readonly retryAfterSeconds: number,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport const createWriteError = (message: string, props: DriverErrorTelemetryProps) =>\n    new NonRetryableError(message, DriverErrorType.writeError, props);\n\nexport function createGenericNetworkError(\n    message: string,\n    retryInfo: { canRetry: boolean; retryAfterMs?: number; },\n    props: DriverErrorTelemetryProps,\n): ThrottlingError | GenericNetworkError {\n    if (retryInfo.retryAfterMs !== undefined && retryInfo.canRetry) {\n        return new ThrottlingError(\n            message, retryInfo.retryAfterMs / 1000, props);\n    }\n    return new GenericNetworkError(message, retryInfo.canRetry, props);\n}\n\n/**\n * Check if a connection error can be retried.  Unless explicitly allowed, retry is disallowed.\n * I.e. asserts or unexpected exceptions in our code result in container failure.\n * @param error - The error to inspect for ability to retry\n */\nexport const canRetryOnError = (error: any): boolean => error?.canRetry === true;\n\n/** Check retryAfterSeconds property on error */\nexport const getRetryDelaySecondsFromError = (error: any): number | undefined =>\n    error?.retryAfterSeconds as number | undefined;\n\n/** Check retryAfterSeconds property on error and convert to ms */\nexport const getRetryDelayFromError = (error: any): number | undefined => error?.retryAfterSeconds !== undefined ?\n    error.retryAfterSeconds * 1000 : undefined;\n"]}

package/dist/packageVersion.d.ts

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

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/driver-utils";
-exports.pkgVersion = "2.0.0-internal.1.1.2";
+exports.pkgVersion = "2.0.0-internal.1.2.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,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-utils\";\nexport const pkgVersion = \"2.0.0-internal.1.1.2\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,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-utils\";\nexport const pkgVersion = \"2.0.0-internal.1.2.0\";\n"]}

package/dist/runWithRetry.d.ts

@@ -9,14 +9,18 @@ import { ITelemetryLogger } from "@fluidframework/common-definitions";
  */
 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;
     /**

package/dist/runWithRetry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runWithRetry.d.ts","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAOtE;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CACjD;AAED,wBAAsB,YAAY,CAAC,CAAC,EAChC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,EACzC,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,SAAS,GACpB,OAAO,CAAC,CAAC,CAAC,CA2DZ"}
+{"version":3,"file":"runWithRetry.d.ts","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAOtE;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CACjD;AAED,wBAAsB,YAAY,CAAC,CAAC,EAChC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,EACzC,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,SAAS,GACpB,OAAO,CAAC,CAAC,CAAC,CA2DZ"}

package/dist/runWithRetry.js.map

@@ -1 +1 @@
-{"version":3,"file":"runWithRetry.js","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAkE;AAClE,2EAAqE;AACrE,uCAAoE;AACpE,qDAA8C;AAC9C,wBAAsC;AA8B/B,KAAK,UAAU,YAAY,CAC9B,GAAyC,EACzC,aAAqB,EACrB,MAAwB,EACxB,QAAmB;;IAEnB,IAAI,MAAqB,CAAC;IAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,YAAY,GAAG,IAAI,CAAC,CAAC,sBAAsB;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,SAAc,CAAC;IACnB,GAAG;QACC,IAAI;YACA,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,GAAG,IAAI,CAAC;SAClB;QAAC,OAAO,GAAG,EAAE;YACV,qDAAqD;YACrD,IAAI,CAAC,IAAA,yBAAe,EAAC,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,SAAS;oBACpC,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;oBACvC,aAAa;iBAChB,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,GAAG,CAAC;aACb;YAED,IAAI,CAAA,MAAA,QAAQ,CAAC,MAAM,0CAAE,OAAO,MAAK,IAAI,EAAE;gBACnC,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,sBAAsB;oBACjD,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;oBACvC,aAAa;iBAChB,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,IAAI,oBAAiB,CACvB,0BAA0B,EAC1B,oCAAe,CAAC,YAAY,EAC5B,EAAE,aAAa,EAAE,2BAAU,EAAE,aAAa,EAAE,CAC/C,CAAC;aACL;YAED,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,GAAG,CAAC;YAChB,sFAAsF;YACtF,0FAA0F;YAC1F,YAAY,GAAG,MAAA,IAAA,gCAAsB,EAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YAC/E,IAAI,QAAQ,CAAC,OAAO,EAAE;gBAClB,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;aACvC;YACD,MAAM,IAAA,oBAAK,EAAC,YAAY,CAAC,CAAC;SAC7B;KACJ,QAAQ,CAAC,OAAO,EAAE;IACnB,IAAI,UAAU,GAAG,CAAC,EAAE;QAChB,MAAM,CAAC,kBAAkB,CAAC;YACtB,SAAS,EAAE,GAAG,aAAa,YAAY;YACvC,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;YACvC,aAAa;SAChB,EACD,SAAS,CAAC,CAAC;KACd;IACD,oEAAoE;IACpE,OAAO,MAAO,CAAC;AACnB,CAAC;AAhED,oCAgEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { delay, performance } from \"@fluidframework/common-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { canRetryOnError, getRetryDelayFromError } from \"./network\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { NonRetryableError } from \".\";\n\n/**\n * Interface describing an object passed to various network APIs.\n * It allows caller to control cancellation, as well as learn about any delays.\n */\nexport interface IProgress {\n    /**\n     * Abort signal used to cancel operation\n     * Note that most of the layers do not use this signal yet. We need to change that over time.\n     * Please consult with API documentation / implementation.\n     * Note that  number of layers may not check this signal while holding this request in a queue,\n     * so it may take a while it takes effect. This can be improved in the future.\n     * Layers in question are:\n     *    - driver (RateLimiter)\n     *    - runWithRetry\n     */\n    cancel?: AbortSignal;\n\n    /**\n     * Called whenever api returns cancellable error and the call is going to be retried.\n     * Any exception thrown from this call back result in cancellation of operation\n     * and propagation of thrown exception.\n     * @param delayInMs - delay before next retry. This value will depend on internal back-off logic,\n     * as well as information provided by service (like 429 error asking to wait for some time before retry)\n     * @param error - error object returned from the call.\n     */\n    onRetry?(delayInMs: number, error: any): void;\n}\n\nexport async function runWithRetry<T>(\n    api: (cancel?: AbortSignal) => Promise<T>,\n    fetchCallName: string,\n    logger: ITelemetryLogger,\n    progress: IProgress,\n): Promise<T> {\n    let result: T | undefined;\n    let success = false;\n    let retryAfterMs = 1000; // has to be positive!\n    let numRetries = 0;\n    const startTime = performance.now();\n    let lastError: any;\n    do {\n        try {\n            result = await api(progress.cancel);\n            success = true;\n        } catch (err) {\n            // If it is not retriable, then just throw the error.\n            if (!canRetryOnError(err)) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_cancel`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                    fetchCallName,\n                }, err);\n                throw err;\n            }\n\n            if (progress.cancel?.aborted === true) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_runWithRetryAborted`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                    fetchCallName,\n                }, err);\n                throw new NonRetryableError(\n                    \"runWithRetry was Aborted\",\n                    DriverErrorType.genericError,\n                    { driverVersion: pkgVersion, fetchCallName },\n                );\n            }\n\n            numRetries++;\n            lastError = err;\n            // If the error is throttling error, then wait for the specified time before retrying.\n            // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n            retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n            if (progress.onRetry) {\n                progress.onRetry(retryAfterMs, err);\n            }\n            await delay(retryAfterMs);\n        }\n    } while (!success);\n    if (numRetries > 0) {\n        logger.sendTelemetryEvent({\n            eventName: `${fetchCallName}_lastError`,\n            retry: numRetries,\n            duration: performance.now() - startTime,\n            fetchCallName,\n        },\n        lastError);\n    }\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return result!;\n}\n"]}
+{"version":3,"file":"runWithRetry.js","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAkE;AAClE,2EAAqE;AACrE,uCAAoE;AACpE,qDAA8C;AAC9C,wBAAsC;AAkC/B,KAAK,UAAU,YAAY,CAC9B,GAAyC,EACzC,aAAqB,EACrB,MAAwB,EACxB,QAAmB;;IAEnB,IAAI,MAAqB,CAAC;IAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,YAAY,GAAG,IAAI,CAAC,CAAC,sBAAsB;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,SAAc,CAAC;IACnB,GAAG;QACC,IAAI;YACA,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,GAAG,IAAI,CAAC;SAClB;QAAC,OAAO,GAAG,EAAE;YACV,qDAAqD;YACrD,IAAI,CAAC,IAAA,yBAAe,EAAC,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,SAAS;oBACpC,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;oBACvC,aAAa;iBAChB,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,GAAG,CAAC;aACb;YAED,IAAI,CAAA,MAAA,QAAQ,CAAC,MAAM,0CAAE,OAAO,MAAK,IAAI,EAAE;gBACnC,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,sBAAsB;oBACjD,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;oBACvC,aAAa;iBAChB,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,IAAI,oBAAiB,CACvB,0BAA0B,EAC1B,oCAAe,CAAC,YAAY,EAC5B,EAAE,aAAa,EAAE,2BAAU,EAAE,aAAa,EAAE,CAC/C,CAAC;aACL;YAED,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,GAAG,CAAC;YAChB,sFAAsF;YACtF,0FAA0F;YAC1F,YAAY,GAAG,MAAA,IAAA,gCAAsB,EAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YAC/E,IAAI,QAAQ,CAAC,OAAO,EAAE;gBAClB,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;aACvC;YACD,MAAM,IAAA,oBAAK,EAAC,YAAY,CAAC,CAAC;SAC7B;KACJ,QAAQ,CAAC,OAAO,EAAE;IACnB,IAAI,UAAU,GAAG,CAAC,EAAE;QAChB,MAAM,CAAC,kBAAkB,CAAC;YACtB,SAAS,EAAE,GAAG,aAAa,YAAY;YACvC,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,0BAAW,CAAC,GAAG,EAAE,GAAG,SAAS;YACvC,aAAa;SAChB,EACD,SAAS,CAAC,CAAC;KACd;IACD,oEAAoE;IACpE,OAAO,MAAO,CAAC;AACnB,CAAC;AAhED,oCAgEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { delay, performance } from \"@fluidframework/common-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { canRetryOnError, getRetryDelayFromError } from \"./network\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { NonRetryableError } from \".\";\n\n/**\n * Interface describing an object passed to various network APIs.\n * It allows caller to control cancellation, as well as learn about any delays.\n */\nexport interface IProgress {\n    /**\n     * Abort signal used to cancel operation.\n     *\n     * @remarks Note that most of the layers do not use this signal yet. We need to change that over time.\n     * Please consult with API documentation / implementation.\n     * Note that  number of layers may not check this signal while holding this request in a queue,\n     * so it may take a while it takes effect. This can be improved in the future.\n     *\n     * The layers in question are:\n     *\n     * - driver (RateLimiter)\n     *\n     * - runWithRetry\n     */\n    cancel?: AbortSignal;\n\n    /**\n     * Called whenever api returns cancellable error and the call is going to be retried.\n     * Any exception thrown from this call back result in cancellation of operation\n     * and propagation of thrown exception.\n     * @param delayInMs - delay before next retry. This value will depend on internal back-off logic,\n     * as well as information provided by service (like 429 error asking to wait for some time before retry)\n     * @param error - error object returned from the call.\n     */\n    onRetry?(delayInMs: number, error: any): void;\n}\n\nexport async function runWithRetry<T>(\n    api: (cancel?: AbortSignal) => Promise<T>,\n    fetchCallName: string,\n    logger: ITelemetryLogger,\n    progress: IProgress,\n): Promise<T> {\n    let result: T | undefined;\n    let success = false;\n    let retryAfterMs = 1000; // has to be positive!\n    let numRetries = 0;\n    const startTime = performance.now();\n    let lastError: any;\n    do {\n        try {\n            result = await api(progress.cancel);\n            success = true;\n        } catch (err) {\n            // If it is not retriable, then just throw the error.\n            if (!canRetryOnError(err)) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_cancel`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                    fetchCallName,\n                }, err);\n                throw err;\n            }\n\n            if (progress.cancel?.aborted === true) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_runWithRetryAborted`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                    fetchCallName,\n                }, err);\n                throw new NonRetryableError(\n                    \"runWithRetry was Aborted\",\n                    DriverErrorType.genericError,\n                    { driverVersion: pkgVersion, fetchCallName },\n                );\n            }\n\n            numRetries++;\n            lastError = err;\n            // If the error is throttling error, then wait for the specified time before retrying.\n            // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n            retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n            if (progress.onRetry) {\n                progress.onRetry(retryAfterMs, err);\n            }\n            await delay(retryAfterMs);\n        }\n    } while (!success);\n    if (numRetries > 0) {\n        logger.sendTelemetryEvent({\n            eventName: `${fetchCallName}_lastError`,\n            retry: numRetries,\n            duration: performance.now() - startTime,\n            fetchCallName,\n        },\n        lastError);\n    }\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return result!;\n}\n"]}

package/lib/messageRecognition.d.ts

@@ -4,35 +4,51 @@
  */
 import { IDocumentMessage, ISequencedDocumentMessage } 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 declare function isClientMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean;
 /**
- *
- * @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 declare function isRuntimeMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean;
+export declare function isRuntimeMessage(message: {
+    type: string;
+}): boolean;
 /**
+ * Determines whether or not the message type is one of the following: (legacy)
+ *
+ * - "component"
+ *
+ * - "attach"
+ *
+ * - "chunkedOp"
+ *
+ * - "blobAttach"
+ *
+ * - "rejoin"
+ *
+ * - "alias"
+ *
+ * - "op"
  *
- * @param message-message
- * @returns whether or not the message type is one listed below (legacy)
- * "component"
- * "attach"
- * "chunkedOp"
- * "blobAttach"
- * "rejoin"
- * "alias"
- * "op"
+ * @deprecated This API should not be used.
  */
 export declare function isUnpackedRuntimeMessage(message: ISequencedDocumentMessage): boolean;
+export declare enum MessageType2 {
+    Accept = "accept"
+}
+export declare function canBeCoalescedByService(message: ISequencedDocumentMessage | IDocumentMessage): boolean;
 //# sourceMappingURL=messageRecognition.d.ts.map

package/lib/messageRecognition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messageRecognition.d.ts","sourceRoot":"","sources":["../src/messageRecognition.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAEhH;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,yBAAyB,GAAG,gBAAgB,GAAG,OAAO,CAY9F;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,yBAAyB,GAAG,gBAAgB,GAAG,OAAO,CAE/F;AAYD;;;;;;;;;;;GAWG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAKpF"}
+{"version":3,"file":"messageRecognition.d.ts","sourceRoot":"","sources":["../src/messageRecognition.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAEhH;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,yBAAyB,GAAG,gBAAgB,GAAG,OAAO,CAc9F;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;CAAE,GAAG,OAAO,CAEpE;AAYD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAKpF;AAID,oBAAY,YAAY;IACpB,MAAM,WAAW;CACpB;AAGD,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,yBAAyB,GAAG,gBAAgB,GAAG,OAAO,CAItG"}

package/lib/messageRecognition.js

@@ -4,14 +4,19 @@
  */
 import { 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) {
     if (isRuntimeMessage(message)) {
@@ -21,20 +26,20 @@ export function isClientMessage(message) {
         case MessageType.Propose:
         case MessageType.Reject:
         case MessageType.NoOp:
+        case MessageType2.Accept:
+        case MessageType.Summarize:
             return true;
         default:
             return false;
     }
 }
 /**
- *
- * @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) {
-    return message.type === MessageType.Operation || message.type === MessageType.Summarize;
+    return message.type === MessageType.Operation;
 }
 var RuntimeMessage;
 (function (RuntimeMessage) {
@@ -47,16 +52,23 @@ var RuntimeMessage;
     RuntimeMessage["Operation"] = "op";
 })(RuntimeMessage || (RuntimeMessage = {}));
 /**
+ * Determines whether or not the message type is one of the following: (legacy)
+ *
+ * - "component"
  *
- * @param message-message
- * @returns whether or not the message type is one listed below (legacy)
- * "component"
- * "attach"
- * "chunkedOp"
- * "blobAttach"
- * "rejoin"
- * "alias"
- * "op"
+ * - "attach"
+ *
+ * - "chunkedOp"
+ *
+ * - "blobAttach"
+ *
+ * - "rejoin"
+ *
+ * - "alias"
+ *
+ * - "op"
+ *
+ * @deprecated This API should not be used.
  */
 export function isUnpackedRuntimeMessage(message) {
     if (Object.values(RuntimeMessage).includes(message.type)) {
@@ -64,4 +76,16 @@ export function isUnpackedRuntimeMessage(message) {
     }
     return false;
 }
+// ADO #1385: staging code changes across layers.
+// Eventually to be replaced by MessageType.accept
+export var MessageType2;
+(function (MessageType2) {
+    MessageType2["Accept"] = "accept";
+})(MessageType2 || (MessageType2 = {}));
+// ADO #1385: To be moved to packages/protocol-base/src/protocol.ts
+export function canBeCoalescedByService(message) {
+    // 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;
+}
 //# sourceMappingURL=messageRecognition.js.map

package/lib/messageRecognition.js.map

@@ -1 +1 @@
-{"version":3,"file":"messageRecognition.js","sourceRoot":"","sources":["../src/messageRecognition.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAA+C,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAEhH;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAAC,OAAqD;IACjF,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE;QAC3B,OAAO,IAAI,CAAC;KACf;IACD,QAAQ,OAAO,CAAC,IAAI,EAAE;QAClB,KAAK,WAAW,CAAC,OAAO,CAAC;QACzB,KAAK,WAAW,CAAC,MAAM,CAAC;QACxB,KAAK,WAAW,CAAC,IAAI;YACjB,OAAO,IAAI,CAAC;QAChB;YACI,OAAO,KAAK,CAAC;KACpB;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAqD;IAClF,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,CAAC;AAC5F,CAAC;AAED,IAAK,cAQJ;AARD,WAAK,cAAc;IACf,gDAA8B,CAAA;IAC9B,mCAAiB,CAAA;IACjB,yCAAuB,CAAA;IACvB,2CAAyB,CAAA;IACzB,mCAAiB,CAAA;IACjB,iCAAe,CAAA;IACf,kCAAgB,CAAA;AACpB,CAAC,EARI,cAAc,KAAd,cAAc,QAQlB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAkC;IACvE,IAAK,MAAM,CAAC,MAAM,CAAC,cAAc,CAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACpE,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IDocumentMessage, ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\n\n/**\n *\n * @param message-message\n * @returns whether or not the message type is one listed below\n * \"op\"\n * \"summarize\"\n * \"propose\"\n * \"reject\"\n * \"noop\"\n */\nexport function isClientMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean {\n    if (isRuntimeMessage(message)) {\n        return true;\n    }\n    switch (message.type) {\n        case MessageType.Propose:\n        case MessageType.Reject:\n        case MessageType.NoOp:\n            return true;\n        default:\n            return false;\n    }\n}\n\n/**\n *\n * @param message-message\n * @returns whether or not the message type is one listed below\n * \"op\"\n * \"summarize\"\n */\nexport function isRuntimeMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean {\n    return message.type === MessageType.Operation || message.type === MessageType.Summarize;\n}\n\nenum RuntimeMessage {\n    FluidDataStoreOp = \"component\",\n    Attach = \"attach\",\n    ChunkedOp = \"chunkedOp\",\n    BlobAttach = \"blobAttach\",\n    Rejoin = \"rejoin\",\n    Alias = \"alias\",\n    Operation = \"op\",\n}\n\n/**\n *\n * @param message-message\n * @returns whether or not the message type is one listed below (legacy)\n * \"component\"\n * \"attach\"\n * \"chunkedOp\"\n * \"blobAttach\"\n * \"rejoin\"\n * \"alias\"\n * \"op\"\n */\nexport function isUnpackedRuntimeMessage(message: ISequencedDocumentMessage): boolean {\n    if ((Object.values(RuntimeMessage) as string[]).includes(message.type)) {\n        return true;\n    }\n    return false;\n}\n"]}
+{"version":3,"file":"messageRecognition.js","sourceRoot":"","sources":["../src/messageRecognition.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAA+C,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAEhH;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,eAAe,CAAC,OAAqD;IACjF,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE;QAC3B,OAAO,IAAI,CAAC;KACf;IACD,QAAQ,OAAO,CAAC,IAAI,EAAE;QAClB,KAAK,WAAW,CAAC,OAAO,CAAC;QACzB,KAAK,WAAW,CAAC,MAAM,CAAC;QACxB,KAAK,WAAW,CAAC,IAAI,CAAC;QACtB,KAAK,YAAY,CAAC,MAAM,CAAC;QACzB,KAAK,WAAW,CAAC,SAAS;YACtB,OAAO,IAAI,CAAC;QAChB;YACI,OAAO,KAAK,CAAC;KACpB;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAA0B;IACvD,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,CAAC;AAClD,CAAC;AAED,IAAK,cAQJ;AARD,WAAK,cAAc;IACf,gDAA8B,CAAA;IAC9B,mCAAiB,CAAA;IACjB,yCAAuB,CAAA;IACvB,2CAAyB,CAAA;IACzB,mCAAiB,CAAA;IACjB,iCAAe,CAAA;IACf,kCAAgB,CAAA;AACpB,CAAC,EARI,cAAc,KAAd,cAAc,QAQlB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAkC;IACvE,IAAK,MAAM,CAAC,MAAM,CAAC,cAAc,CAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACpE,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,iDAAiD;AACjD,kDAAkD;AAClD,MAAM,CAAN,IAAY,YAEX;AAFD,WAAY,YAAY;IACpB,iCAAiB,CAAA;AACrB,CAAC,EAFW,YAAY,KAAZ,YAAY,QAEvB;AAED,mEAAmE;AACnE,MAAM,UAAU,uBAAuB,CAAC,OAAqD;IACzF,6FAA6F;IAC7F,mEAAmE;IACnE,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,MAAM,CAAC;AACrF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IDocumentMessage, ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Determines whether or not the message type is one of the following:\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.Operation}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.Summarize}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.Propose}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.Reject}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType2.Accept}\n *\n * - {@link @fluidframework/protocol-definitions#MessageType.NoOp}\n */\nexport function isClientMessage(message: ISequencedDocumentMessage | IDocumentMessage): boolean {\n    if (isRuntimeMessage(message)) {\n        return true;\n    }\n    switch (message.type) {\n        case MessageType.Propose:\n        case MessageType.Reject:\n        case MessageType.NoOp:\n        case MessageType2.Accept:\n        case MessageType.Summarize:\n            return true;\n        default:\n            return false;\n    }\n}\n\n/**\n * Tells if message was sent by container runtime\n * @privateRemarks ADO #1385: To be moved to container-definitions\n * @returns whether the message is a runtime message\n */\nexport function isRuntimeMessage(message: { type: string; }): boolean {\n    return message.type === MessageType.Operation;\n}\n\nenum RuntimeMessage {\n    FluidDataStoreOp = \"component\",\n    Attach = \"attach\",\n    ChunkedOp = \"chunkedOp\",\n    BlobAttach = \"blobAttach\",\n    Rejoin = \"rejoin\",\n    Alias = \"alias\",\n    Operation = \"op\",\n}\n\n/**\n * Determines whether or not the message type is one of the following: (legacy)\n *\n * - \"component\"\n *\n * - \"attach\"\n *\n * - \"chunkedOp\"\n *\n * - \"blobAttach\"\n *\n * - \"rejoin\"\n *\n * - \"alias\"\n *\n * - \"op\"\n *\n * @deprecated This API should not be used.\n */\nexport function isUnpackedRuntimeMessage(message: ISequencedDocumentMessage): boolean {\n    if ((Object.values(RuntimeMessage) as string[]).includes(message.type)) {\n        return true;\n    }\n    return false;\n}\n\n// ADO #1385: staging code changes across layers.\n// Eventually to be replaced by MessageType.accept\nexport enum MessageType2 {\n    Accept = \"accept\",\n}\n\n// ADO #1385: To be moved to packages/protocol-base/src/protocol.ts\nexport function canBeCoalescedByService(message: ISequencedDocumentMessage | IDocumentMessage): boolean {\n    // This assumes that in the future relay service may implement coalescing of accept messages,\n    // same way it was doing coalescing of immediate noops in the past.\n    return message.type === MessageType.NoOp || message.type === MessageType2.Accept;\n}\n"]}

package/lib/network.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,yBAAyB,EACzB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEhF,oBAAY,YAAY;IACpB,OAAO,IAAA;IACP,MAAM,IAAA;IACN,OAAO,IAAA;CACV;AAKD,wBAAgB,QAAQ,IAAI,YAAY,CAKvC;AAED;;;;;;;;GAQG;AACF,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IACzE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC9B;AAED,+DAA+D;AAC/D,oBAAY,yBAAyB,GAAG,oBAAoB,GAAG;IAAE,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;CAAE,CAAC;AAEtG;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAa,YAAW,gBAAgB,EAAE,eAAe;IAK1F,QAAQ,CAAC,QAAQ,EAAE,OAAO;IAJ9B,QAAQ,CAAC,SAAS,uCAAuC;gBAGrD,OAAO,EAAE,MAAM,EACN,QAAQ,EAAE,OAAO,EAC1B,KAAK,EAAE,yBAAyB;CAIvC;AAQD,qBAAa,mCAAoC,SAAQ,YAAa,YAAW,eAAe;IAC5F,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAC2D;IAC5F,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAiD;IAC3E,QAAQ,CAAC,QAAQ,SAAS;gBAEd,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,yBAAyB;CAGhE;AAED,qBAAa,kBAAmB,SAAQ,YAAa,YAAW,mBAAmB,EAAE,eAAe;IAM5F,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IACnC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS;IANzC,QAAQ,CAAC,SAAS,sCAAsC;IACxD,QAAQ,CAAC,QAAQ,SAAS;gBAGtB,OAAO,EAAE,MAAM,EACN,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,QAAQ,EAAE,MAAM,GAAG,SAAS,EACrC,KAAK,EAAE,yBAAyB;CAKvC;AAED,qBAAa,wBAAyB,SAAQ,YAAa,YAAW,yBAAyB,EAAE,eAAe;IAMxG,QAAQ,CAAC,WAAW,EAAE,YAAY;IALtC,QAAQ,CAAC,SAAS,uCAAuC;IACzD,QAAQ,CAAC,QAAQ,SAAS;gBAGtB,OAAO,EAAE,MAAM,EACN,WAAW,EAAE,YAAY,EAClC,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,YAAa,YAAW,eAAe;IAGxF,QAAQ,CAAC,SAAS,EAAE,CAAC;IACrB,QAAQ,CAAC,QAAQ,EAAE,OAAO;gBAF1B,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACZ,QAAQ,EAAE,OAAO,EAC1B,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAGrE,QAAQ,CAAC,SAAS,EAAE,CAAC;gBADrB,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACrB,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAGlE,QAAQ,CAAC,SAAS,EAAE,CAAC;gBADrB,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACrB,KAAK,EAAE,yBAAyB;CAIvC;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,YAAa,YAAW,kBAAkB,EAAE,eAAe;IAMxF,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IALtC,QAAQ,CAAC,SAAS,mCAAmC;IACrD,QAAQ,CAAC,QAAQ,QAAQ;gBAGrB,OAAO,EAAE,MAAM,EACN,iBAAiB,EAAE,MAAM,EAClC,KAAK,EAAE,yBAAyB;CAIvC;AAED,eAAO,MAAM,gBAAgB,YAAa,MAAM,SAAS,yBAAyB,kDACb,CAAC;AAEtE,wBAAgB,yBAAyB,CACrC,OAAO,EAAE,MAAM,EACf,SAAS,EAAE;IAAE,QAAQ,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAAE,EACxD,KAAK,EAAE,yBAAyB,GACjC,eAAe,GAAG,mBAAmB,CAMvC;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,UAAW,GAAG,KAAG,OAAmC,CAAC;AAEjF,gDAAgD;AAChD,eAAO,MAAM,6BAA6B,UAAW,GAAG,KAAG,MAAM,GAAG,SAClB,CAAC;AAEnD,kEAAkE;AAClE,eAAO,MAAM,sBAAsB,UAAW,GAAG,KAAG,MAAM,GAAG,SACf,CAAC"}
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,yBAAyB,EACzB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEhF,oBAAY,YAAY;IACpB,OAAO,IAAA;IACP,MAAM,IAAA;IACN,OAAO,IAAA;CACV;AAKD,wBAAgB,QAAQ,IAAI,YAAY,CAKvC;AAED;;;;;;;;GAQG;AACF,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IACzE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC9B;AAED,+DAA+D;AAC/D,oBAAY,yBAAyB,GAAG,oBAAoB,GAAG;IAAE,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;CAAE,CAAC;AAEtG;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAa,YAAW,gBAAgB,EAAE,eAAe;IAK1F,QAAQ,CAAC,QAAQ,EAAE,OAAO;IAJ9B,QAAQ,CAAC,SAAS,uCAAuC;gBAGrD,OAAO,EAAE,MAAM,EACN,QAAQ,EAAE,OAAO,EAC1B,KAAK,EAAE,yBAAyB;CAIvC;AAQD,qBAAa,mCAAoC,SAAQ,YAAa,YAAW,eAAe;IAC5F,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAC2D;IAC5F,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAiD;IAC3E,QAAQ,CAAC,QAAQ,SAAS;gBAEd,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,yBAAyB;CAGhE;AAED,qBAAa,kBAAmB,SAAQ,YAAa,YAAW,mBAAmB,EAAE,eAAe;IAM5F,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IACnC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS;IANzC,QAAQ,CAAC,SAAS,sCAAsC;IACxD,QAAQ,CAAC,QAAQ,SAAS;gBAGtB,OAAO,EAAE,MAAM,EACN,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,QAAQ,EAAE,MAAM,GAAG,SAAS,EACrC,KAAK,EAAE,yBAAyB;CAKvC;AAED,qBAAa,wBAAyB,SAAQ,YAAa,YAAW,yBAAyB,EAAE,eAAe;IAMxG,QAAQ,CAAC,WAAW,EAAE,YAAY;IALtC,QAAQ,CAAC,SAAS,uCAAuC;IACzD,QAAQ,CAAC,QAAQ,SAAS;gBAGtB,OAAO,EAAE,MAAM,EACN,WAAW,EAAE,YAAY,EAClC,KAAK,EAAE,yBAAyB;CAKvC;AAED,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,YAAa,YAAW,eAAe;IAGxF,QAAQ,CAAC,SAAS,EAAE,CAAC;IACrB,QAAQ,CAAC,QAAQ,EAAE,OAAO;gBAF1B,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACZ,QAAQ,EAAE,OAAO,EAC1B,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAGrE,QAAQ,CAAC,SAAS,EAAE,CAAC;gBADrB,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACrB,KAAK,EAAE,yBAAyB;CAIvC;AAED,qBAAa,cAAc,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAGlE,QAAQ,CAAC,SAAS,EAAE,CAAC;gBADrB,OAAO,EAAE,MAAM,EACN,SAAS,EAAE,CAAC,EACrB,KAAK,EAAE,yBAAyB;CAIvC;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,YAAa,YAAW,kBAAkB,EAAE,eAAe;IAMxF,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IALtC,QAAQ,CAAC,SAAS,mCAAmC;IACrD,QAAQ,CAAC,QAAQ,QAAQ;gBAGrB,OAAO,EAAE,MAAM,EACN,iBAAiB,EAAE,MAAM,EAClC,KAAK,EAAE,yBAAyB;CAIvC;AAED,eAAO,MAAM,gBAAgB,YAAa,MAAM,SAAS,yBAAyB,kDACb,CAAC;AAEtE,wBAAgB,yBAAyB,CACrC,OAAO,EAAE,MAAM,EACf,SAAS,EAAE;IAAE,QAAQ,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAAE,EACxD,KAAK,EAAE,yBAAyB,GACjC,eAAe,GAAG,mBAAmB,CAMvC;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,UAAW,GAAG,KAAG,OAAmC,CAAC;AAEjF,gDAAgD;AAChD,eAAO,MAAM,6BAA6B,UAAW,GAAG,KAAG,MAAM,GAAG,SAClB,CAAC;AAEnD,kEAAkE;AAClE,eAAO,MAAM,sBAAsB,UAAW,GAAG,KAAG,MAAM,GAAG,SACf,CAAC"}

package/lib/network.js

@@ -56,7 +56,8 @@ export class AuthorizationError extends LoggingError {
 }
 export class LocationRedirectionError extends LoggingError {
     constructor(message, redirectUrl, props) {
-        super(message, props);
+        // do not log redirectURL
+        super(message, props, new Set(["redirectUrl"]));
         this.redirectUrl = redirectUrl;
         this.errorType = DriverErrorType.locationRedirection;
         this.canRetry = false;

package/lib/network.js.map

@@ -1 +1 @@
-{"version":3,"file":"network.js","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAIH,eAAe,GAGlB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAmB,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEhF,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,qDAAO,CAAA;IACP,mDAAM,CAAA;IACN,qDAAO,CAAA;AACX,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAED,mFAAmF;AACnF,+EAA+E;AAC/E,6DAA6D;AAC7D,MAAM,UAAU,QAAQ;IACpB,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE;QAC9F,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC;KACxE;IACD,OAAO,YAAY,CAAC,OAAO,CAAC;AAChC,CAAC;AAkBD;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IAGjD,YACI,OAAe,EACN,QAAiB,EAC1B,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,aAAQ,GAAR,QAAQ,CAAS;QAJrB,cAAS,GAAG,eAAe,CAAC,mBAAmB,CAAC;IAQzD,CAAC;CACJ;AAED,oFAAoF;AACpF,yEAAyE;AACzE,qEAAqE;AACrE,uEAAuE;AACvE,SAAS;AACT,MAAM,iCAAiC,GAAG,gCAAgC,CAAC;AAC3E,MAAM,OAAO,mCAAoC,SAAQ,YAAY;IAMjE,YAAY,OAAe,EAAE,KAAgC;QACzD,KAAK,CAAC,OAAO,kCAAO,KAAK,KAAE,UAAU,EAAE,GAAG,IAAG,CAAC;QAJzC,cAAS,GAAW,mCAAmC,CAAC,SAAS,CAAC;QAClE,aAAQ,GAAG,KAAK,CAAC;IAI1B,CAAC;;AAPe,6CAAS,GACrB,MAAA,eAAe,CAAC,iCAAiC,CAAC,mCAAI,iCAAiC,CAAC;AAShG,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAIhD,YACI,OAAe,EACN,MAA0B,EAC1B,QAA4B,EACrC,KAAgC;QAEhC,+BAA+B;QAC/B,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;QAL9C,WAAM,GAAN,MAAM,CAAoB;QAC1B,aAAQ,GAAR,QAAQ,CAAoB;QANhC,cAAS,GAAG,eAAe,CAAC,kBAAkB,CAAC;QAC/C,aAAQ,GAAG,KAAK,CAAC;IAU1B,CAAC;CACJ;AAED,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IAItD,YACI,OAAe,EACN,WAAyB,EAClC,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,gBAAW,GAAX,WAAW,CAAc;QAL7B,cAAS,GAAG,eAAe,CAAC,mBAAmB,CAAC;QAChD,aAAQ,GAAG,KAAK,CAAC;IAQ1B,CAAC;CACJ;AAED,MAAM,OAAO,iBAAoC,SAAQ,YAAY;IACjE,YACI,OAAe,EACN,SAAY,EACZ,QAAiB,EAC1B,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAJb,cAAS,GAAT,SAAS,CAAG;QACZ,aAAQ,GAAR,QAAQ,CAAS;IAI9B,CAAC;CACJ;AAED,MAAM,OAAO,iBAAoC,SAAQ,iBAAoB;IACzE,YACI,OAAe,EACN,SAAY,EACrB,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAH/B,cAAS,GAAT,SAAS,CAAG;IAIzB,CAAC;CACJ;AAED,MAAM,OAAO,cAAiC,SAAQ,iBAAoB;IACtE,YACI,OAAe,EACN,SAAY,EACrB,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAH9B,cAAS,GAAT,SAAS,CAAG;IAIzB,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,YAAY;IAI7C,YACI,OAAe,EACN,iBAAyB,EAClC,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,sBAAiB,GAAjB,iBAAiB,CAAQ;QAL7B,cAAS,GAAG,eAAe,CAAC,eAAe,CAAC;QAC5C,aAAQ,GAAG,IAAI,CAAC;IAQzB,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,KAAgC,EAAE,EAAE,CAClF,IAAI,iBAAiB,CAAC,OAAO,EAAE,eAAe,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;AAEtE,MAAM,UAAU,yBAAyB,CACrC,OAAe,EACf,SAAwD,EACxD,KAAgC;IAEhC,IAAI,SAAS,CAAC,YAAY,KAAK,SAAS,IAAI,SAAS,CAAC,QAAQ,EAAE;QAC5D,OAAO,IAAI,eAAe,CACtB,OAAO,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC;KACtD;IACD,OAAO,IAAI,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAU,EAAW,EAAE,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,MAAK,IAAI,CAAC;AAEjF,gDAAgD;AAChD,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,KAAU,EAAsB,EAAE,CAC5E,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAuC,CAAC;AAEnD,kEAAkE;AAClE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,KAAU,EAAsB,EAAE,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,MAAK,SAAS,CAAC,CAAC;IAC9G,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IThrottlingWarning,\n    IDriverErrorBase,\n    IAuthorizationError,\n    DriverErrorType,\n    ILocationRedirectionError,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { IFluidErrorBase, LoggingError } from \"@fluidframework/telemetry-utils\";\n\nexport enum OnlineStatus {\n    Offline,\n    Online,\n    Unknown,\n}\n\n// It tells if we have local connection only - we might not have connection to web.\n// No solution for node.js (other than resolve dns names / ping specific sites)\n// Can also use window.addEventListener(\"online\" / \"offline\")\nexport function isOnline(): OnlineStatus {\n    if (typeof navigator === \"object\" && navigator !== null && typeof navigator.onLine === \"boolean\") {\n        return navigator.onLine ? OnlineStatus.Online : OnlineStatus.Offline;\n    }\n    return OnlineStatus.Unknown;\n}\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either DriverErrorType or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n */\n export interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n    readonly errorType: string;\n}\n\n/** Telemetry props with driver-specific required properties */\nexport type DriverErrorTelemetryProps = ITelemetryProperties & { driverVersion: string | undefined; };\n\n/**\n * Generic network error class.\n */\nexport class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {\n    readonly errorType = DriverErrorType.genericNetworkError;\n\n    constructor(\n        message: string,\n        readonly canRetry: boolean,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\n// Todo GH #6214: Remove after next drive def bump. This is necessary as there is no\n// compatible way to augment an enum, as it can't be optional. So for now\n// we need to duplicate the value here. We likely need to rethink our\n// DriverErrorType strategy so that it supports extension with optional\n// value.\nconst deltaStreamConnectionForbiddenStr = \"deltaStreamConnectionForbidden\";\nexport class DeltaStreamConnectionForbiddenError extends LoggingError implements IFluidErrorBase {\n    static readonly errorType: string =\n        DriverErrorType[deltaStreamConnectionForbiddenStr] ?? deltaStreamConnectionForbiddenStr;\n    readonly errorType: string = DeltaStreamConnectionForbiddenError.errorType;\n    readonly canRetry = false;\n\n    constructor(message: string, props: DriverErrorTelemetryProps) {\n        super(message, { ...props, statusCode: 400 });\n    }\n}\n\nexport class AuthorizationError extends LoggingError implements IAuthorizationError, IFluidErrorBase {\n    readonly errorType = DriverErrorType.authorizationError;\n    readonly canRetry = false;\n\n    constructor(\n        message: string,\n        readonly claims: string | undefined,\n        readonly tenantId: string | undefined,\n        props: DriverErrorTelemetryProps,\n    ) {\n        // don't log claims or tenantId\n        super(message, props, new Set([\"claims\", \"tenantId\"]));\n    }\n}\n\nexport class LocationRedirectionError extends LoggingError implements ILocationRedirectionError, IFluidErrorBase {\n    readonly errorType = DriverErrorType.locationRedirection;\n    readonly canRetry = false;\n\n    constructor(\n        message: string,\n        readonly redirectUrl: IResolvedUrl,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        readonly canRetry: boolean,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, errorType, false, props);\n    }\n}\n\nexport class RetryableError<T extends string> extends NetworkErrorBasic<T> {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, errorType, true, props);\n    }\n}\n\n/**\n * Throttling error class - used to communicate all throttling errors\n */\nexport class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {\n    readonly errorType = DriverErrorType.throttlingError;\n    readonly canRetry = true;\n\n    constructor(\n        message: string,\n        readonly retryAfterSeconds: number,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport const createWriteError = (message: string, props: DriverErrorTelemetryProps) =>\n    new NonRetryableError(message, DriverErrorType.writeError, props);\n\nexport function createGenericNetworkError(\n    message: string,\n    retryInfo: { canRetry: boolean; retryAfterMs?: number; },\n    props: DriverErrorTelemetryProps,\n): ThrottlingError | GenericNetworkError {\n    if (retryInfo.retryAfterMs !== undefined && retryInfo.canRetry) {\n        return new ThrottlingError(\n            message, retryInfo.retryAfterMs / 1000, props);\n    }\n    return new GenericNetworkError(message, retryInfo.canRetry, props);\n}\n\n/**\n * Check if a connection error can be retried.  Unless explicitly allowed, retry is disallowed.\n * I.e. asserts or unexpected exceptions in our code result in container failure.\n * @param error - The error to inspect for ability to retry\n */\nexport const canRetryOnError = (error: any): boolean => error?.canRetry === true;\n\n/** Check retryAfterSeconds property on error */\nexport const getRetryDelaySecondsFromError = (error: any): number | undefined =>\n    error?.retryAfterSeconds as number | undefined;\n\n/** Check retryAfterSeconds property on error and convert to ms */\nexport const getRetryDelayFromError = (error: any): number | undefined => error?.retryAfterSeconds !== undefined ?\n    error.retryAfterSeconds * 1000 : undefined;\n"]}
+{"version":3,"file":"network.js","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAIH,eAAe,GAGlB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAmB,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEhF,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,qDAAO,CAAA;IACP,mDAAM,CAAA;IACN,qDAAO,CAAA;AACX,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAED,mFAAmF;AACnF,+EAA+E;AAC/E,6DAA6D;AAC7D,MAAM,UAAU,QAAQ;IACpB,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE;QAC9F,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC;KACxE;IACD,OAAO,YAAY,CAAC,OAAO,CAAC;AAChC,CAAC;AAkBD;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IAGjD,YACI,OAAe,EACN,QAAiB,EAC1B,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,aAAQ,GAAR,QAAQ,CAAS;QAJrB,cAAS,GAAG,eAAe,CAAC,mBAAmB,CAAC;IAQzD,CAAC;CACJ;AAED,oFAAoF;AACpF,yEAAyE;AACzE,qEAAqE;AACrE,uEAAuE;AACvE,SAAS;AACT,MAAM,iCAAiC,GAAG,gCAAgC,CAAC;AAC3E,MAAM,OAAO,mCAAoC,SAAQ,YAAY;IAMjE,YAAY,OAAe,EAAE,KAAgC;QACzD,KAAK,CAAC,OAAO,kCAAO,KAAK,KAAE,UAAU,EAAE,GAAG,IAAG,CAAC;QAJzC,cAAS,GAAW,mCAAmC,CAAC,SAAS,CAAC;QAClE,aAAQ,GAAG,KAAK,CAAC;IAI1B,CAAC;;AAPe,6CAAS,GACrB,MAAA,eAAe,CAAC,iCAAiC,CAAC,mCAAI,iCAAiC,CAAC;AAShG,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAIhD,YACI,OAAe,EACN,MAA0B,EAC1B,QAA4B,EACrC,KAAgC;QAEhC,+BAA+B;QAC/B,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;QAL9C,WAAM,GAAN,MAAM,CAAoB;QAC1B,aAAQ,GAAR,QAAQ,CAAoB;QANhC,cAAS,GAAG,eAAe,CAAC,kBAAkB,CAAC;QAC/C,aAAQ,GAAG,KAAK,CAAC;IAU1B,CAAC;CACJ;AAED,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IAItD,YACI,OAAe,EACN,WAAyB,EAClC,KAAgC;QAEhC,yBAAyB;QACzB,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAJvC,gBAAW,GAAX,WAAW,CAAc;QAL7B,cAAS,GAAG,eAAe,CAAC,mBAAmB,CAAC;QAChD,aAAQ,GAAG,KAAK,CAAC;IAS1B,CAAC;CACJ;AAED,MAAM,OAAO,iBAAoC,SAAQ,YAAY;IACjE,YACI,OAAe,EACN,SAAY,EACZ,QAAiB,EAC1B,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAJb,cAAS,GAAT,SAAS,CAAG;QACZ,aAAQ,GAAR,QAAQ,CAAS;IAI9B,CAAC;CACJ;AAED,MAAM,OAAO,iBAAoC,SAAQ,iBAAoB;IACzE,YACI,OAAe,EACN,SAAY,EACrB,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAH/B,cAAS,GAAT,SAAS,CAAG;IAIzB,CAAC;CACJ;AAED,MAAM,OAAO,cAAiC,SAAQ,iBAAoB;IACtE,YACI,OAAe,EACN,SAAY,EACrB,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAH9B,cAAS,GAAT,SAAS,CAAG;IAIzB,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,YAAY;IAI7C,YACI,OAAe,EACN,iBAAyB,EAClC,KAAgC;QAEhC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAHb,sBAAiB,GAAjB,iBAAiB,CAAQ;QAL7B,cAAS,GAAG,eAAe,CAAC,eAAe,CAAC;QAC5C,aAAQ,GAAG,IAAI,CAAC;IAQzB,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,KAAgC,EAAE,EAAE,CAClF,IAAI,iBAAiB,CAAC,OAAO,EAAE,eAAe,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;AAEtE,MAAM,UAAU,yBAAyB,CACrC,OAAe,EACf,SAAwD,EACxD,KAAgC;IAEhC,IAAI,SAAS,CAAC,YAAY,KAAK,SAAS,IAAI,SAAS,CAAC,QAAQ,EAAE;QAC5D,OAAO,IAAI,eAAe,CACtB,OAAO,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC;KACtD;IACD,OAAO,IAAI,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAU,EAAW,EAAE,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,MAAK,IAAI,CAAC;AAEjF,gDAAgD;AAChD,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,KAAU,EAAsB,EAAE,CAC5E,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAuC,CAAC;AAEnD,kEAAkE;AAClE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,KAAU,EAAsB,EAAE,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,MAAK,SAAS,CAAC,CAAC;IAC9G,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IThrottlingWarning,\n    IDriverErrorBase,\n    IAuthorizationError,\n    DriverErrorType,\n    ILocationRedirectionError,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { IFluidErrorBase, LoggingError } from \"@fluidframework/telemetry-utils\";\n\nexport enum OnlineStatus {\n    Offline,\n    Online,\n    Unknown,\n}\n\n// It tells if we have local connection only - we might not have connection to web.\n// No solution for node.js (other than resolve dns names / ping specific sites)\n// Can also use window.addEventListener(\"online\" / \"offline\")\nexport function isOnline(): OnlineStatus {\n    if (typeof navigator === \"object\" && navigator !== null && typeof navigator.onLine === \"boolean\") {\n        return navigator.onLine ? OnlineStatus.Online : OnlineStatus.Offline;\n    }\n    return OnlineStatus.Unknown;\n}\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either DriverErrorType or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n */\n export interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n    readonly errorType: string;\n}\n\n/** Telemetry props with driver-specific required properties */\nexport type DriverErrorTelemetryProps = ITelemetryProperties & { driverVersion: string | undefined; };\n\n/**\n * Generic network error class.\n */\nexport class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {\n    readonly errorType = DriverErrorType.genericNetworkError;\n\n    constructor(\n        message: string,\n        readonly canRetry: boolean,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\n// Todo GH #6214: Remove after next drive def bump. This is necessary as there is no\n// compatible way to augment an enum, as it can't be optional. So for now\n// we need to duplicate the value here. We likely need to rethink our\n// DriverErrorType strategy so that it supports extension with optional\n// value.\nconst deltaStreamConnectionForbiddenStr = \"deltaStreamConnectionForbidden\";\nexport class DeltaStreamConnectionForbiddenError extends LoggingError implements IFluidErrorBase {\n    static readonly errorType: string =\n        DriverErrorType[deltaStreamConnectionForbiddenStr] ?? deltaStreamConnectionForbiddenStr;\n    readonly errorType: string = DeltaStreamConnectionForbiddenError.errorType;\n    readonly canRetry = false;\n\n    constructor(message: string, props: DriverErrorTelemetryProps) {\n        super(message, { ...props, statusCode: 400 });\n    }\n}\n\nexport class AuthorizationError extends LoggingError implements IAuthorizationError, IFluidErrorBase {\n    readonly errorType = DriverErrorType.authorizationError;\n    readonly canRetry = false;\n\n    constructor(\n        message: string,\n        readonly claims: string | undefined,\n        readonly tenantId: string | undefined,\n        props: DriverErrorTelemetryProps,\n    ) {\n        // don't log claims or tenantId\n        super(message, props, new Set([\"claims\", \"tenantId\"]));\n    }\n}\n\nexport class LocationRedirectionError extends LoggingError implements ILocationRedirectionError, IFluidErrorBase {\n    readonly errorType = DriverErrorType.locationRedirection;\n    readonly canRetry = false;\n\n    constructor(\n        message: string,\n        readonly redirectUrl: IResolvedUrl,\n        props: DriverErrorTelemetryProps,\n    ) {\n        // do not log redirectURL\n        super(message, props, new Set([\"redirectUrl\"]));\n    }\n}\n\nexport class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        readonly canRetry: boolean,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, errorType, false, props);\n    }\n}\n\nexport class RetryableError<T extends string> extends NetworkErrorBasic<T> {\n    constructor(\n        message: string,\n        readonly errorType: T,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, errorType, true, props);\n    }\n}\n\n/**\n * Throttling error class - used to communicate all throttling errors\n */\nexport class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {\n    readonly errorType = DriverErrorType.throttlingError;\n    readonly canRetry = true;\n\n    constructor(\n        message: string,\n        readonly retryAfterSeconds: number,\n        props: DriverErrorTelemetryProps,\n    ) {\n        super(message, props);\n    }\n}\n\nexport const createWriteError = (message: string, props: DriverErrorTelemetryProps) =>\n    new NonRetryableError(message, DriverErrorType.writeError, props);\n\nexport function createGenericNetworkError(\n    message: string,\n    retryInfo: { canRetry: boolean; retryAfterMs?: number; },\n    props: DriverErrorTelemetryProps,\n): ThrottlingError | GenericNetworkError {\n    if (retryInfo.retryAfterMs !== undefined && retryInfo.canRetry) {\n        return new ThrottlingError(\n            message, retryInfo.retryAfterMs / 1000, props);\n    }\n    return new GenericNetworkError(message, retryInfo.canRetry, props);\n}\n\n/**\n * Check if a connection error can be retried.  Unless explicitly allowed, retry is disallowed.\n * I.e. asserts or unexpected exceptions in our code result in container failure.\n * @param error - The error to inspect for ability to retry\n */\nexport const canRetryOnError = (error: any): boolean => error?.canRetry === true;\n\n/** Check retryAfterSeconds property on error */\nexport const getRetryDelaySecondsFromError = (error: any): number | undefined =>\n    error?.retryAfterSeconds as number | undefined;\n\n/** Check retryAfterSeconds property on error and convert to ms */\nexport const getRetryDelayFromError = (error: any): number | undefined => error?.retryAfterSeconds !== undefined ?\n    error.retryAfterSeconds * 1000 : undefined;\n"]}

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-utils";
-export declare const pkgVersion = "2.0.0-internal.1.1.2";
+export declare const pkgVersion = "2.0.0-internal.1.2.0";
 //# 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-utils";
-export const pkgVersion = "2.0.0-internal.1.1.2";
+export const pkgVersion = "2.0.0-internal.1.2.0";
 //# 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,8BAA8B,CAAC;AACtD,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-utils\";\nexport const pkgVersion = \"2.0.0-internal.1.1.2\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,8BAA8B,CAAC;AACtD,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-utils\";\nexport const pkgVersion = \"2.0.0-internal.1.2.0\";\n"]}

package/lib/runWithRetry.d.ts

@@ -9,14 +9,18 @@ import { ITelemetryLogger } from "@fluidframework/common-definitions";
  */
 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;
     /**

package/lib/runWithRetry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runWithRetry.d.ts","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAOtE;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CACjD;AAED,wBAAsB,YAAY,CAAC,CAAC,EAChC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,EACzC,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,SAAS,GACpB,OAAO,CAAC,CAAC,CAAC,CA2DZ"}
+{"version":3,"file":"runWithRetry.d.ts","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAOtE;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CACjD;AAED,wBAAsB,YAAY,CAAC,CAAC,EAChC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,EACzC,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,SAAS,GACpB,OAAO,CAAC,CAAC,CAAC,CA2DZ"}

package/lib/runWithRetry.js.map

@@ -1 +1 @@
-{"version":3,"file":"runWithRetry.js","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AA8BtC,MAAM,CAAC,KAAK,UAAU,YAAY,CAC9B,GAAyC,EACzC,aAAqB,EACrB,MAAwB,EACxB,QAAmB;;IAEnB,IAAI,MAAqB,CAAC;IAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,YAAY,GAAG,IAAI,CAAC,CAAC,sBAAsB;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,SAAc,CAAC;IACnB,GAAG;QACC,IAAI;YACA,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,GAAG,IAAI,CAAC;SAClB;QAAC,OAAO,GAAG,EAAE;YACV,qDAAqD;YACrD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,SAAS;oBACpC,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;oBACvC,aAAa;iBAChB,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,GAAG,CAAC;aACb;YAED,IAAI,CAAA,MAAA,QAAQ,CAAC,MAAM,0CAAE,OAAO,MAAK,IAAI,EAAE;gBACnC,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,sBAAsB;oBACjD,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;oBACvC,aAAa;iBAChB,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,IAAI,iBAAiB,CACvB,0BAA0B,EAC1B,eAAe,CAAC,YAAY,EAC5B,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,CAC/C,CAAC;aACL;YAED,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,GAAG,CAAC;YAChB,sFAAsF;YACtF,0FAA0F;YAC1F,YAAY,GAAG,MAAA,sBAAsB,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YAC/E,IAAI,QAAQ,CAAC,OAAO,EAAE;gBAClB,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;aACvC;YACD,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;SAC7B;KACJ,QAAQ,CAAC,OAAO,EAAE;IACnB,IAAI,UAAU,GAAG,CAAC,EAAE;QAChB,MAAM,CAAC,kBAAkB,CAAC;YACtB,SAAS,EAAE,GAAG,aAAa,YAAY;YACvC,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;YACvC,aAAa;SAChB,EACD,SAAS,CAAC,CAAC;KACd;IACD,oEAAoE;IACpE,OAAO,MAAO,CAAC;AACnB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { delay, performance } from \"@fluidframework/common-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { canRetryOnError, getRetryDelayFromError } from \"./network\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { NonRetryableError } from \".\";\n\n/**\n * Interface describing an object passed to various network APIs.\n * It allows caller to control cancellation, as well as learn about any delays.\n */\nexport interface IProgress {\n    /**\n     * Abort signal used to cancel operation\n     * Note that most of the layers do not use this signal yet. We need to change that over time.\n     * Please consult with API documentation / implementation.\n     * Note that  number of layers may not check this signal while holding this request in a queue,\n     * so it may take a while it takes effect. This can be improved in the future.\n     * Layers in question are:\n     *    - driver (RateLimiter)\n     *    - runWithRetry\n     */\n    cancel?: AbortSignal;\n\n    /**\n     * Called whenever api returns cancellable error and the call is going to be retried.\n     * Any exception thrown from this call back result in cancellation of operation\n     * and propagation of thrown exception.\n     * @param delayInMs - delay before next retry. This value will depend on internal back-off logic,\n     * as well as information provided by service (like 429 error asking to wait for some time before retry)\n     * @param error - error object returned from the call.\n     */\n    onRetry?(delayInMs: number, error: any): void;\n}\n\nexport async function runWithRetry<T>(\n    api: (cancel?: AbortSignal) => Promise<T>,\n    fetchCallName: string,\n    logger: ITelemetryLogger,\n    progress: IProgress,\n): Promise<T> {\n    let result: T | undefined;\n    let success = false;\n    let retryAfterMs = 1000; // has to be positive!\n    let numRetries = 0;\n    const startTime = performance.now();\n    let lastError: any;\n    do {\n        try {\n            result = await api(progress.cancel);\n            success = true;\n        } catch (err) {\n            // If it is not retriable, then just throw the error.\n            if (!canRetryOnError(err)) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_cancel`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                    fetchCallName,\n                }, err);\n                throw err;\n            }\n\n            if (progress.cancel?.aborted === true) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_runWithRetryAborted`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                    fetchCallName,\n                }, err);\n                throw new NonRetryableError(\n                    \"runWithRetry was Aborted\",\n                    DriverErrorType.genericError,\n                    { driverVersion: pkgVersion, fetchCallName },\n                );\n            }\n\n            numRetries++;\n            lastError = err;\n            // If the error is throttling error, then wait for the specified time before retrying.\n            // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n            retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n            if (progress.onRetry) {\n                progress.onRetry(retryAfterMs, err);\n            }\n            await delay(retryAfterMs);\n        }\n    } while (!success);\n    if (numRetries > 0) {\n        logger.sendTelemetryEvent({\n            eventName: `${fetchCallName}_lastError`,\n            retry: numRetries,\n            duration: performance.now() - startTime,\n            fetchCallName,\n        },\n        lastError);\n    }\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return result!;\n}\n"]}
+{"version":3,"file":"runWithRetry.js","sourceRoot":"","sources":["../src/runWithRetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAkCtC,MAAM,CAAC,KAAK,UAAU,YAAY,CAC9B,GAAyC,EACzC,aAAqB,EACrB,MAAwB,EACxB,QAAmB;;IAEnB,IAAI,MAAqB,CAAC;IAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,YAAY,GAAG,IAAI,CAAC,CAAC,sBAAsB;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,SAAc,CAAC;IACnB,GAAG;QACC,IAAI;YACA,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,GAAG,IAAI,CAAC;SAClB;QAAC,OAAO,GAAG,EAAE;YACV,qDAAqD;YACrD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,SAAS;oBACpC,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;oBACvC,aAAa;iBAChB,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,GAAG,CAAC;aACb;YAED,IAAI,CAAA,MAAA,QAAQ,CAAC,MAAM,0CAAE,OAAO,MAAK,IAAI,EAAE;gBACnC,MAAM,CAAC,kBAAkB,CAAC;oBACtB,SAAS,EAAE,GAAG,aAAa,sBAAsB;oBACjD,KAAK,EAAE,UAAU;oBACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;oBACvC,aAAa;iBAChB,EAAE,GAAG,CAAC,CAAC;gBACR,MAAM,IAAI,iBAAiB,CACvB,0BAA0B,EAC1B,eAAe,CAAC,YAAY,EAC5B,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,CAC/C,CAAC;aACL;YAED,UAAU,EAAE,CAAC;YACb,SAAS,GAAG,GAAG,CAAC;YAChB,sFAAsF;YACtF,0FAA0F;YAC1F,YAAY,GAAG,MAAA,sBAAsB,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YAC/E,IAAI,QAAQ,CAAC,OAAO,EAAE;gBAClB,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;aACvC;YACD,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;SAC7B;KACJ,QAAQ,CAAC,OAAO,EAAE;IACnB,IAAI,UAAU,GAAG,CAAC,EAAE;QAChB,MAAM,CAAC,kBAAkB,CAAC;YACtB,SAAS,EAAE,GAAG,aAAa,YAAY;YACvC,KAAK,EAAE,UAAU;YACjB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;YACvC,aAAa;SAChB,EACD,SAAS,CAAC,CAAC;KACd;IACD,oEAAoE;IACpE,OAAO,MAAO,CAAC;AACnB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { delay, performance } from \"@fluidframework/common-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport { canRetryOnError, getRetryDelayFromError } from \"./network\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { NonRetryableError } from \".\";\n\n/**\n * Interface describing an object passed to various network APIs.\n * It allows caller to control cancellation, as well as learn about any delays.\n */\nexport interface IProgress {\n    /**\n     * Abort signal used to cancel operation.\n     *\n     * @remarks Note that most of the layers do not use this signal yet. We need to change that over time.\n     * Please consult with API documentation / implementation.\n     * Note that  number of layers may not check this signal while holding this request in a queue,\n     * so it may take a while it takes effect. This can be improved in the future.\n     *\n     * The layers in question are:\n     *\n     * - driver (RateLimiter)\n     *\n     * - runWithRetry\n     */\n    cancel?: AbortSignal;\n\n    /**\n     * Called whenever api returns cancellable error and the call is going to be retried.\n     * Any exception thrown from this call back result in cancellation of operation\n     * and propagation of thrown exception.\n     * @param delayInMs - delay before next retry. This value will depend on internal back-off logic,\n     * as well as information provided by service (like 429 error asking to wait for some time before retry)\n     * @param error - error object returned from the call.\n     */\n    onRetry?(delayInMs: number, error: any): void;\n}\n\nexport async function runWithRetry<T>(\n    api: (cancel?: AbortSignal) => Promise<T>,\n    fetchCallName: string,\n    logger: ITelemetryLogger,\n    progress: IProgress,\n): Promise<T> {\n    let result: T | undefined;\n    let success = false;\n    let retryAfterMs = 1000; // has to be positive!\n    let numRetries = 0;\n    const startTime = performance.now();\n    let lastError: any;\n    do {\n        try {\n            result = await api(progress.cancel);\n            success = true;\n        } catch (err) {\n            // If it is not retriable, then just throw the error.\n            if (!canRetryOnError(err)) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_cancel`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                    fetchCallName,\n                }, err);\n                throw err;\n            }\n\n            if (progress.cancel?.aborted === true) {\n                logger.sendTelemetryEvent({\n                    eventName: `${fetchCallName}_runWithRetryAborted`,\n                    retry: numRetries,\n                    duration: performance.now() - startTime,\n                    fetchCallName,\n                }, err);\n                throw new NonRetryableError(\n                    \"runWithRetry was Aborted\",\n                    DriverErrorType.genericError,\n                    { driverVersion: pkgVersion, fetchCallName },\n                );\n            }\n\n            numRetries++;\n            lastError = err;\n            // If the error is throttling error, then wait for the specified time before retrying.\n            // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n            retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n            if (progress.onRetry) {\n                progress.onRetry(retryAfterMs, err);\n            }\n            await delay(retryAfterMs);\n        }\n    } while (!success);\n    if (numRetries > 0) {\n        logger.sendTelemetryEvent({\n            eventName: `${fetchCallName}_lastError`,\n            retry: numRetries,\n            duration: performance.now() - startTime,\n            fetchCallName,\n        },\n        lastError);\n    }\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    return result!;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-utils",
-  "version": "2.0.0-internal.1.1.2",
+  "version": "2.0.0-internal.1.2.0",
   "description": "Collection of utility functions for Fluid drivers",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,23 +62,23 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/core-interfaces": "^2.0.0-internal.1.1.2",
-    "@fluidframework/driver-definitions": "^2.0.0-internal.1.1.2",
-    "@fluidframework/gitresources": "^0.1037.1000",
-    "@fluidframework/protocol-base": "^0.1037.1000",
+    "@fluidframework/core-interfaces": "^2.0.0-internal.1.2.0",
+    "@fluidframework/driver-definitions": "^2.0.0-internal.1.2.0",
+    "@fluidframework/gitresources": "^0.1038.1000",
+    "@fluidframework/protocol-base": "^0.1038.1000",
     "@fluidframework/protocol-definitions": "^1.0.0",
-    "@fluidframework/telemetry-utils": "^2.0.0-internal.1.1.2",
+    "@fluidframework/telemetry-utils": "^2.0.0-internal.1.2.0",
     "axios": "^0.26.0",
     "url": "^0.11.0",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.3.1000",
+    "@fluidframework/build-common": "^1.0.0",
+    "@fluidframework/build-tools": "^0.4.4000",
     "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@^1.0.0",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^2.0.0-internal.1.1.2",
-    "@fluidframework/runtime-utils": "^2.0.0-internal.1.1.2",
+    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluidframework/mocha-test-setup": "^2.0.0-internal.1.2.0",
+    "@fluidframework/runtime-utils": "^2.0.0-internal.1.2.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",

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

@@ -102,7 +102,8 @@ export class LocationRedirectionError extends LoggingError implements ILocationR
         readonly redirectUrl: IResolvedUrl,
         props: DriverErrorTelemetryProps,
     ) {
-        super(message, props);
+        // do not log redirectURL
+        super(message, props, new Set(["redirectUrl"]));
     }
 }
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "2.0.0-internal.1.1.2";
+export const pkgVersion = "2.0.0-internal.1.2.0";

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;