@fluidframework/container-runtime 2.0.0-dev-rc.1.0.0.225277 → 2.0.0-dev-rc.1.0.0.232845

package/lib/messageTypes.d.mts

@@ -80,7 +80,7 @@ export type ContainerRuntimeAliasMessage = TypedContainerRuntimeMessage<Containe
 export type ContainerRuntimeIdAllocationMessage = TypedContainerRuntimeMessage<ContainerMessageType.IdAllocation, IdCreationRange>;
 export type ContainerRuntimeGCMessage = TypedContainerRuntimeMessage<ContainerMessageType.GC, GarbageCollectionMessage>;
 /**
- * Represents an unrecognized {@link TypedContainerRuntimeMessage}, e.g. a message from a future version of the container runtime.
+ * Represents an unrecognized TypedContainerRuntimeMessage, e.g. a message from a future version of the container runtime.
  * @internal
  */
 export interface UnknownContainerRuntimeMessage extends Partial<RecentlyAddedContainerRuntimeMessageDetails> {

package/lib/messageTypes.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"messageTypes.mjs","sourceRoot":"","sources":["../src/messageTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAaH;;GAEG;AACH,MAAM,CAAN,IAAY,oBA+BX;AA/BD,WAAY,oBAAoB;IAC/B,iCAAiC;IACjC,sDAA8B,CAAA;IAE9B,sBAAsB;IACtB,yCAAiB,CAAA;IAEjB,qBAAqB;IACrB,+CAAuB,CAAA;IAEvB,yFAAyF;IACzF,iDAAyB,CAAA;IAEzB,oDAAoD;IACpD,yCAAiB,CAAA;IAEjB,sCAAsC;IACtC,uCAAe,CAAA;IAEf;;;;OAIG;IACH,qDAA6B,CAAA;IAE7B;;;OAGG;IACH,iCAAS,CAAA;AACV,CAAC,EA/BW,oBAAoB,KAApB,oBAAoB,QA+B/B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n\tIEnvelope,\n\tInboundAttachMessage,\n\tIAttachMessage,\n} from \"@fluidframework/runtime-definitions\";\nimport type { IdCreationRange } from \"@fluidframework/id-compressor\";\nimport { IDataStoreAliasMessage } from \"./dataStore\";\nimport { GarbageCollectionMessage } from \"./gc\";\nimport { IChunkedOp } from \"./opLifecycle\";\n\n/**\n * @alpha\n */\nexport enum ContainerMessageType {\n\t// An op to be delivered to store\n\tFluidDataStoreOp = \"component\",\n\n\t// Creates a new store\n\tAttach = \"attach\",\n\n\t// Chunked operation.\n\tChunkedOp = \"chunkedOp\",\n\n\t// Signifies that a blob has been attached and should not be garbage collected by storage\n\tBlobAttach = \"blobAttach\",\n\n\t// Ties our new clientId to our old one on reconnect\n\tRejoin = \"rejoin\",\n\n\t// Sets the alias of a root data store\n\tAlias = \"alias\",\n\n\t/**\n\t * An op containing an IdRange of Ids allocated using the runtime's IdCompressor since\n\t * the last allocation op was sent.\n\t * See the [IdCompressor README](./id-compressor/README.md) for more details.\n\t */\n\tIdAllocation = \"idAllocation\",\n\n\t/**\n\t * Garbage collection specific op. This is sent by the summarizer client when GC runs. It's used to synchronize GC\n\t * state across all clients.\n\t */\n\tGC = \"GC\",\n}\n\n/**\n * How should an older client handle an unrecognized remote op type?\n *\n * @internal\n */\nexport type CompatModeBehavior =\n\t/** Ignore the op. It won't be persisted if this client summarizes */\n\t| \"Ignore\"\n\t/** Fail processing immediately. (The container will close) */\n\t| \"FailToProcess\";\n\n/**\n * All the info an older client would need to know how to handle an unrecognized remote op type\n *\n * @internal\n */\nexport interface IContainerRuntimeMessageCompatDetails {\n\t/** How should an older client handle an unrecognized remote op type? */\n\tbehavior: CompatModeBehavior;\n}\n\n/**\n * The unpacked runtime message / details to be handled or dispatched by the ContainerRuntime.\n * Message type are differentiated via a `type` string and contain different contents depending on their type.\n *\n * IMPORTANT: when creating one to be serialized, set the properties in the order they appear here.\n * This way stringified values can be compared.\n */\ninterface TypedContainerRuntimeMessage<TType extends ContainerMessageType, TContents>\n\textends Partial<RecentlyAddedContainerRuntimeMessageDetails> {\n\t/** Type of the op, within the ContainerRuntime's domain */\n\ttype: TType;\n\t/** Domain-specific contents, interpreted according to the type */\n\tcontents: TContents;\n}\n\n/**\n * Additional details expected for any recently added message.\n * @internal\n */\nexport interface RecentlyAddedContainerRuntimeMessageDetails {\n\t/** Info describing how to handle this op in case the type is unrecognized (default: fail to process) */\n\tcompatDetails: IContainerRuntimeMessageCompatDetails;\n}\n\nexport type ContainerRuntimeDataStoreOpMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.FluidDataStoreOp,\n\tIEnvelope\n>;\nexport type InboundContainerRuntimeAttachMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.Attach,\n\tInboundAttachMessage\n>;\nexport type OutboundContainerRuntimeAttachMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.Attach,\n\tIAttachMessage\n>;\nexport type ContainerRuntimeChunkedOpMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.ChunkedOp,\n\tIChunkedOp\n>;\nexport type ContainerRuntimeBlobAttachMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.BlobAttach,\n\tundefined\n>;\nexport type ContainerRuntimeRejoinMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.Rejoin,\n\tundefined\n>;\nexport type ContainerRuntimeAliasMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.Alias,\n\tIDataStoreAliasMessage\n>;\nexport type ContainerRuntimeIdAllocationMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.IdAllocation,\n\tIdCreationRange\n>;\nexport type ContainerRuntimeGCMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.GC,\n\tGarbageCollectionMessage\n>;\n\n/**\n * Represents an unrecognized {@link TypedContainerRuntimeMessage}, e.g. a message from a future version of the container runtime.\n * @internal\n */\nexport interface UnknownContainerRuntimeMessage\n\textends Partial<RecentlyAddedContainerRuntimeMessageDetails> {\n\t/** Invalid type of the op, within the ContainerRuntime's domain. This value should never exist at runtime.\n\t * This is useful for type narrowing but should never be used as an actual message type at runtime.\n\t * Actual value will not be \"__unknown...\", but the type `Exclude<string, ContainerMessageType>` is not supported.\n\t */\n\ttype: \"__unknown_container_message_type__never_use_as_value__\";\n\n\t/** Domain-specific contents, but not decipherable by an unknown op. */\n\tcontents: unknown;\n}\n\n/**\n * A {@link TypedContainerRuntimeMessage} that is received from the server and will be processed by the container runtime.\n */\nexport type InboundContainerRuntimeMessage =\n\t| ContainerRuntimeDataStoreOpMessage\n\t| InboundContainerRuntimeAttachMessage\n\t| ContainerRuntimeChunkedOpMessage\n\t| ContainerRuntimeBlobAttachMessage\n\t| ContainerRuntimeRejoinMessage\n\t| ContainerRuntimeAliasMessage\n\t| ContainerRuntimeIdAllocationMessage\n\t| ContainerRuntimeGCMessage\n\t// Inbound messages may include unknown types from other clients, so we include that as a special case here\n\t| UnknownContainerRuntimeMessage;\n\n/** A {@link TypedContainerRuntimeMessage} that has been generated by the container runtime but is not yet being sent to the server. */\nexport type LocalContainerRuntimeMessage =\n\t| ContainerRuntimeDataStoreOpMessage\n\t| OutboundContainerRuntimeAttachMessage\n\t| ContainerRuntimeChunkedOpMessage\n\t| ContainerRuntimeBlobAttachMessage\n\t| ContainerRuntimeRejoinMessage\n\t| ContainerRuntimeAliasMessage\n\t| ContainerRuntimeIdAllocationMessage\n\t| ContainerRuntimeGCMessage\n\t// In rare cases (e.g. related to stashed ops) we could have a local message of an unknown type\n\t| UnknownContainerRuntimeMessage;\n\n/** A {@link TypedContainerRuntimeMessage} that is being sent to the server from the container runtime. */\nexport type OutboundContainerRuntimeMessage =\n\t| ContainerRuntimeDataStoreOpMessage\n\t| OutboundContainerRuntimeAttachMessage\n\t| ContainerRuntimeChunkedOpMessage\n\t| ContainerRuntimeBlobAttachMessage\n\t| ContainerRuntimeRejoinMessage\n\t| ContainerRuntimeAliasMessage\n\t| ContainerRuntimeIdAllocationMessage\n\t| ContainerRuntimeGCMessage;\n\n/**\n * An unpacked ISequencedDocumentMessage with the inner TypedContainerRuntimeMessage type/contents/etc\n * promoted up to the outer object\n */\nexport type InboundSequencedContainerRuntimeMessage = Omit<\n\tISequencedDocumentMessage,\n\t\"type\" | \"contents\"\n> &\n\tInboundContainerRuntimeMessage;\n\n/** Essentially ISequencedDocumentMessage except that `type` is not `string` to enable narrowing\n * as `Exclude<string, InboundContainerRuntimeMessage['type']>` is not supported.\n * There should never be a runtime value of \"__not_a_...\".\n * Currently additionally replaces `contents` type until protocol-definitions update is taken with `unknown` instead of `any`.\n */\ntype InboundSequencedNonContainerRuntimeMessage = Omit<\n\tISequencedDocumentMessage,\n\t\"type\" | \"contents\"\n> & { type: \"__not_a_container_runtime_message_type__\"; contents: unknown };\n\nexport type InboundSequencedContainerRuntimeMessageOrSystemMessage =\n\t| InboundSequencedContainerRuntimeMessage\n\t| InboundSequencedNonContainerRuntimeMessage;\n\n/** A [loose] InboundSequencedContainerRuntimeMessage that is recent and may contain compat details.\n * It exists solely to to provide access to those details.\n */\nexport type InboundSequencedRecentlyAddedContainerRuntimeMessage = ISequencedDocumentMessage &\n\tPartial<RecentlyAddedContainerRuntimeMessageDetails>;\n\n/**\n * The unpacked runtime message / details to be handled or dispatched by the ContainerRuntime\n *\n * IMPORTANT: when creating one to be serialized, set the properties in the order they appear here.\n * This way stringified values can be compared.\n *\n * @deprecated this is an internal type which should not be used outside of the package.\n * Internally, it is superseded by `TypedContainerRuntimeMessage`.\n *\n * @internal\n */\nexport interface ContainerRuntimeMessage {\n\t/** Type of the op, within the ContainerRuntime's domain */\n\ttype: ContainerMessageType;\n\t/** Domain-specific contents, interpreted according to the type */\n\tcontents: any;\n\t/** Info describing how to handle this op in case the type is unrecognized (default: fail to process) */\n\tcompatDetails?: IContainerRuntimeMessageCompatDetails;\n}\n"]}
+{"version":3,"file":"messageTypes.mjs","sourceRoot":"","sources":["../src/messageTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAaH;;GAEG;AACH,MAAM,CAAN,IAAY,oBA+BX;AA/BD,WAAY,oBAAoB;IAC/B,iCAAiC;IACjC,sDAA8B,CAAA;IAE9B,sBAAsB;IACtB,yCAAiB,CAAA;IAEjB,qBAAqB;IACrB,+CAAuB,CAAA;IAEvB,yFAAyF;IACzF,iDAAyB,CAAA;IAEzB,oDAAoD;IACpD,yCAAiB,CAAA;IAEjB,sCAAsC;IACtC,uCAAe,CAAA;IAEf;;;;OAIG;IACH,qDAA6B,CAAA;IAE7B;;;OAGG;IACH,iCAAS,CAAA;AACV,CAAC,EA/BW,oBAAoB,KAApB,oBAAoB,QA+B/B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n\tIEnvelope,\n\tInboundAttachMessage,\n\tIAttachMessage,\n} from \"@fluidframework/runtime-definitions\";\nimport type { IdCreationRange } from \"@fluidframework/id-compressor\";\nimport { IDataStoreAliasMessage } from \"./dataStore\";\nimport { GarbageCollectionMessage } from \"./gc\";\nimport { IChunkedOp } from \"./opLifecycle\";\n\n/**\n * @alpha\n */\nexport enum ContainerMessageType {\n\t// An op to be delivered to store\n\tFluidDataStoreOp = \"component\",\n\n\t// Creates a new store\n\tAttach = \"attach\",\n\n\t// Chunked operation.\n\tChunkedOp = \"chunkedOp\",\n\n\t// Signifies that a blob has been attached and should not be garbage collected by storage\n\tBlobAttach = \"blobAttach\",\n\n\t// Ties our new clientId to our old one on reconnect\n\tRejoin = \"rejoin\",\n\n\t// Sets the alias of a root data store\n\tAlias = \"alias\",\n\n\t/**\n\t * An op containing an IdRange of Ids allocated using the runtime's IdCompressor since\n\t * the last allocation op was sent.\n\t * See the [IdCompressor README](./id-compressor/README.md) for more details.\n\t */\n\tIdAllocation = \"idAllocation\",\n\n\t/**\n\t * Garbage collection specific op. This is sent by the summarizer client when GC runs. It's used to synchronize GC\n\t * state across all clients.\n\t */\n\tGC = \"GC\",\n}\n\n/**\n * How should an older client handle an unrecognized remote op type?\n *\n * @internal\n */\nexport type CompatModeBehavior =\n\t/** Ignore the op. It won't be persisted if this client summarizes */\n\t| \"Ignore\"\n\t/** Fail processing immediately. (The container will close) */\n\t| \"FailToProcess\";\n\n/**\n * All the info an older client would need to know how to handle an unrecognized remote op type\n *\n * @internal\n */\nexport interface IContainerRuntimeMessageCompatDetails {\n\t/** How should an older client handle an unrecognized remote op type? */\n\tbehavior: CompatModeBehavior;\n}\n\n/**\n * The unpacked runtime message / details to be handled or dispatched by the ContainerRuntime.\n * Message type are differentiated via a `type` string and contain different contents depending on their type.\n *\n * IMPORTANT: when creating one to be serialized, set the properties in the order they appear here.\n * This way stringified values can be compared.\n */\ninterface TypedContainerRuntimeMessage<TType extends ContainerMessageType, TContents>\n\textends Partial<RecentlyAddedContainerRuntimeMessageDetails> {\n\t/** Type of the op, within the ContainerRuntime's domain */\n\ttype: TType;\n\t/** Domain-specific contents, interpreted according to the type */\n\tcontents: TContents;\n}\n\n/**\n * Additional details expected for any recently added message.\n * @internal\n */\nexport interface RecentlyAddedContainerRuntimeMessageDetails {\n\t/** Info describing how to handle this op in case the type is unrecognized (default: fail to process) */\n\tcompatDetails: IContainerRuntimeMessageCompatDetails;\n}\n\nexport type ContainerRuntimeDataStoreOpMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.FluidDataStoreOp,\n\tIEnvelope\n>;\nexport type InboundContainerRuntimeAttachMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.Attach,\n\tInboundAttachMessage\n>;\nexport type OutboundContainerRuntimeAttachMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.Attach,\n\tIAttachMessage\n>;\nexport type ContainerRuntimeChunkedOpMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.ChunkedOp,\n\tIChunkedOp\n>;\nexport type ContainerRuntimeBlobAttachMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.BlobAttach,\n\tundefined\n>;\nexport type ContainerRuntimeRejoinMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.Rejoin,\n\tundefined\n>;\nexport type ContainerRuntimeAliasMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.Alias,\n\tIDataStoreAliasMessage\n>;\nexport type ContainerRuntimeIdAllocationMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.IdAllocation,\n\tIdCreationRange\n>;\nexport type ContainerRuntimeGCMessage = TypedContainerRuntimeMessage<\n\tContainerMessageType.GC,\n\tGarbageCollectionMessage\n>;\n\n/**\n * Represents an unrecognized TypedContainerRuntimeMessage, e.g. a message from a future version of the container runtime.\n * @internal\n */\nexport interface UnknownContainerRuntimeMessage\n\textends Partial<RecentlyAddedContainerRuntimeMessageDetails> {\n\t/** Invalid type of the op, within the ContainerRuntime's domain. This value should never exist at runtime.\n\t * This is useful for type narrowing but should never be used as an actual message type at runtime.\n\t * Actual value will not be \"__unknown...\", but the type `Exclude<string, ContainerMessageType>` is not supported.\n\t */\n\ttype: \"__unknown_container_message_type__never_use_as_value__\";\n\n\t/** Domain-specific contents, but not decipherable by an unknown op. */\n\tcontents: unknown;\n}\n\n/**\n * A {@link TypedContainerRuntimeMessage} that is received from the server and will be processed by the container runtime.\n */\nexport type InboundContainerRuntimeMessage =\n\t| ContainerRuntimeDataStoreOpMessage\n\t| InboundContainerRuntimeAttachMessage\n\t| ContainerRuntimeChunkedOpMessage\n\t| ContainerRuntimeBlobAttachMessage\n\t| ContainerRuntimeRejoinMessage\n\t| ContainerRuntimeAliasMessage\n\t| ContainerRuntimeIdAllocationMessage\n\t| ContainerRuntimeGCMessage\n\t// Inbound messages may include unknown types from other clients, so we include that as a special case here\n\t| UnknownContainerRuntimeMessage;\n\n/** A {@link TypedContainerRuntimeMessage} that has been generated by the container runtime but is not yet being sent to the server. */\nexport type LocalContainerRuntimeMessage =\n\t| ContainerRuntimeDataStoreOpMessage\n\t| OutboundContainerRuntimeAttachMessage\n\t| ContainerRuntimeChunkedOpMessage\n\t| ContainerRuntimeBlobAttachMessage\n\t| ContainerRuntimeRejoinMessage\n\t| ContainerRuntimeAliasMessage\n\t| ContainerRuntimeIdAllocationMessage\n\t| ContainerRuntimeGCMessage\n\t// In rare cases (e.g. related to stashed ops) we could have a local message of an unknown type\n\t| UnknownContainerRuntimeMessage;\n\n/** A {@link TypedContainerRuntimeMessage} that is being sent to the server from the container runtime. */\nexport type OutboundContainerRuntimeMessage =\n\t| ContainerRuntimeDataStoreOpMessage\n\t| OutboundContainerRuntimeAttachMessage\n\t| ContainerRuntimeChunkedOpMessage\n\t| ContainerRuntimeBlobAttachMessage\n\t| ContainerRuntimeRejoinMessage\n\t| ContainerRuntimeAliasMessage\n\t| ContainerRuntimeIdAllocationMessage\n\t| ContainerRuntimeGCMessage;\n\n/**\n * An unpacked ISequencedDocumentMessage with the inner TypedContainerRuntimeMessage type/contents/etc\n * promoted up to the outer object\n */\nexport type InboundSequencedContainerRuntimeMessage = Omit<\n\tISequencedDocumentMessage,\n\t\"type\" | \"contents\"\n> &\n\tInboundContainerRuntimeMessage;\n\n/** Essentially ISequencedDocumentMessage except that `type` is not `string` to enable narrowing\n * as `Exclude<string, InboundContainerRuntimeMessage['type']>` is not supported.\n * There should never be a runtime value of \"__not_a_...\".\n * Currently additionally replaces `contents` type until protocol-definitions update is taken with `unknown` instead of `any`.\n */\ntype InboundSequencedNonContainerRuntimeMessage = Omit<\n\tISequencedDocumentMessage,\n\t\"type\" | \"contents\"\n> & { type: \"__not_a_container_runtime_message_type__\"; contents: unknown };\n\nexport type InboundSequencedContainerRuntimeMessageOrSystemMessage =\n\t| InboundSequencedContainerRuntimeMessage\n\t| InboundSequencedNonContainerRuntimeMessage;\n\n/** A [loose] InboundSequencedContainerRuntimeMessage that is recent and may contain compat details.\n * It exists solely to to provide access to those details.\n */\nexport type InboundSequencedRecentlyAddedContainerRuntimeMessage = ISequencedDocumentMessage &\n\tPartial<RecentlyAddedContainerRuntimeMessageDetails>;\n\n/**\n * The unpacked runtime message / details to be handled or dispatched by the ContainerRuntime\n *\n * IMPORTANT: when creating one to be serialized, set the properties in the order they appear here.\n * This way stringified values can be compared.\n *\n * @deprecated this is an internal type which should not be used outside of the package.\n * Internally, it is superseded by `TypedContainerRuntimeMessage`.\n *\n * @internal\n */\nexport interface ContainerRuntimeMessage {\n\t/** Type of the op, within the ContainerRuntime's domain */\n\ttype: ContainerMessageType;\n\t/** Domain-specific contents, interpreted according to the type */\n\tcontents: any;\n\t/** Info describing how to handle this op in case the type is unrecognized (default: fail to process) */\n\tcompatDetails?: IContainerRuntimeMessageCompatDetails;\n}\n"]}

package/lib/packageVersion.d.mts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/container-runtime";
-export declare const pkgVersion = "2.0.0-dev-rc.1.0.0.225277";
+export declare const pkgVersion = "2.0.0-dev-rc.1.0.0.232845";
 //# sourceMappingURL=packageVersion.d.mts.map

package/lib/packageVersion.mjs

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.0.0-dev-rc.1.0.0.225277";
+export const pkgVersion = "2.0.0-dev-rc.1.0.0.232845";
 //# sourceMappingURL=packageVersion.mjs.map

package/lib/packageVersion.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.mjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,mCAAmC,CAAC;AAC3D,MAAM,CAAC,MAAM,UAAU,GAAG,2BAA2B,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/container-runtime\";\nexport const pkgVersion = \"2.0.0-dev-rc.1.0.0.225277\";\n"]}
+{"version":3,"file":"packageVersion.mjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,mCAAmC,CAAC;AAC3D,MAAM,CAAC,MAAM,UAAU,GAAG,2BAA2B,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/container-runtime\";\nexport const pkgVersion = \"2.0.0-dev-rc.1.0.0.232845\";\n"]}

package/lib/summary/runningSummarizer.d.mts

@@ -56,12 +56,12 @@ export declare class RunningSummarizer extends TypedEventEmitter<ISummarizerEven
     private constructor();
     private handleSummaryAck;
     /**
-     * Responsible for receiving and processing all the summaryAcks.
-     * In case there was a summary ack processed by the running summarizer before processIncomingSummaryAcks is called,
-     * it will wait for the summary ack that is newer than the one indicated by the lastAckRefSeq.
-     * @param lastAckRefSeq - Identifies the minimum reference sequence number the summarizer needs to wait for.
-     * In case of a negative number, the summarizer will wait for ANY summary ack that is greater than the deltaManager's initial sequence number,
-     * and, in case of a positive one, it will wait for a summary ack that is greater than this current reference sequence number.
+     * Responsible for receiving and processing all the summary acks.
+     * It starts processing ACKs after the one for the summary this client loaded from (initialSequenceNumber). Any
+     * ACK before that is not interesting as it will simply be ignored.
+     *
+     * @param referenceSequenceNumber - The referenceSequenceNumber of the summary from which to start processing
+     * acks.
      */
     private processIncomingSummaryAcks;
     dispose(): void;
@@ -118,6 +118,11 @@ export declare class RunningSummarizer extends TypedEventEmitter<ISummarizerEven
      * For example, summarization may be retried for failures with "retryAfterSeconds" param.
      */
     private trySummarizeWithRetries;
+    /**
+     * Attempts to generate a summary on demand with retries in case of failures. The retry logic is the same
+     * as heuristics based summaries.
+     */
+    private summarizeOnDemandWithRetries;
     /** {@inheritdoc (ISummarizer:interface).summarizeOnDemand} */
     summarizeOnDemand(options: IOnDemandSummarizeOptions, resultsBuilder?: SummarizeResultBuilder): ISummarizeResults;
     /** {@inheritdoc (ISummarizer:interface).enqueueSummarize} */

package/lib/summary/runningSummarizer.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"runningSummarizer.d.mts","sourceRoot":"","sources":["../../src/summary/runningSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,iCAAiC;OAS5E,EAAE,iBAAiB,EAAE,MAAM,8BAA8B;OAEzD,EAAE,yBAAyB,EAAe,MAAM,sCAAsC;OACtF,EAAE,qBAAqB,EAAE;OAGzB,EACN,wBAAwB,EAExB,uBAAuB,EAEvB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EAEjB,kBAAkB,EAElB,yBAAyB,EACzB,iBAAiB,EAEjB;OACM,EAAiB,qBAAqB,EAAE,iBAAiB,EAAE;OAC3D,EAGN,sBAAsB,EAEtB;AAID;;;GAGG;AACH,eAAO,MAAM,kBAAkB,IAAI,CAAC;AACpC;;;GAGG;AACH,eAAO,MAAM,mCAAmC,IAAI,CAAC;AAErD;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,iBAAiB,CAAC,iBAAiB,CAAE,YAAW,WAAW;IAqGhG,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IAGtC,OAAO,CAAC,QAAQ,CAAC,+BAA+B;IAGhD,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO;WAhHL,KAAK,CACxB,MAAM,EAAE,oBAAoB,EAC5B,cAAc,EAAE,qBAAqB,EACrC,aAAa,EAAE,qBAAqB,EACpC,qBAAqB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,mBAAmB,CAAC,EACvF,+BAA+B,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,IAAI,CAAC,EACtF,aAAa,EAAE,uBAAuB,EACtC,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,yBAAyB,EAC5C,sBAAsB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,EAC9D,OAAO,EAAE,kBAAkB,GACzB,OAAO,CAAC,iBAAiB,CAAC;IA0D7B,IAAW,QAAQ,YAElB;IACD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAA4B;IACnD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAe;IAC/C,OAAO,CAAC,eAAe,CAAC,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAC7C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,eAAe,CAOV;IACb,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,uBAAuB,CAAK;IACpC,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IAEjC,8EAA8E;IAC9E,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAS;IAEtD,OAAO;YA4GO,gBAAgB;IA6D9B;;;;;;;OAOG;YACW,0BAA0B;IAsBjC,OAAO,IAAI,IAAI;IAYtB;;;;;OAKG;IACI,sBAAsB,sGAGf;IAEd,wGAAwG;IACxG,OAAO,CAAC,8BAA8B,CAAS;IAExC,QAAQ,CAAC,EAAE,EAAE,yBAAyB,EAAE,cAAc,EAAE,OAAO;IA8BtE;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,6BAA6B;IAWxB,QAAQ,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YA6BjD,SAAS;IAuBvB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,kBAAkB;IAW1B;;;;;;;;OAQG;YACW,mBAAmB;IAsBjC;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IAoCxB,oCAAoC;IACpC,OAAO,CAAC,YAAY;IAyBpB;;;OAGG;YACW,8BAA8B;IAsE5C;;;OAGG;YACW,uBAAuB;IAoIrC,8DAA8D;IACvD,iBAAiB,CACvB,OAAO,EAAE,yBAAyB,EAClC,cAAc,GAAE,sBAAqD,GACnE,iBAAiB;IAqBpB,6DAA6D;IACtD,gBAAgB,CAAC,OAAO,EAAE,wBAAwB,GAAG,sBAAsB;IAiClF,OAAO,CAAC,qBAAqB;IAwB7B,OAAO,CAAC,sBAAsB;CAS9B"}
+{"version":3,"file":"runningSummarizer.d.mts","sourceRoot":"","sources":["../../src/summary/runningSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,iCAAiC;OAS5E,EAAE,iBAAiB,EAAE,MAAM,8BAA8B;OAEzD,EAAE,yBAAyB,EAAe,MAAM,sCAAsC;OACtF,EAAE,qBAAqB,EAAE;OAGzB,EACN,wBAAwB,EAExB,uBAAuB,EAEvB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EAEjB,kBAAkB,EAElB,yBAAyB,EACzB,iBAAiB,EAEjB;OACM,EAAiB,qBAAqB,EAAE,iBAAiB,EAAE;OAC3D,EAGN,sBAAsB,EAEtB;AAID;;;GAGG;AACH,eAAO,MAAM,kBAAkB,IAAI,CAAC;AACpC;;;GAGG;AACH,eAAO,MAAM,mCAAmC,IAAI,CAAC;AAErD;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,iBAAiB,CAAC,iBAAiB,CAAE,YAAW,WAAW;IAgHhG,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IAGtC,OAAO,CAAC,QAAQ,CAAC,+BAA+B;IAGhD,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO;WA3HL,KAAK,CACxB,MAAM,EAAE,oBAAoB,EAC5B,cAAc,EAAE,qBAAqB,EACrC,aAAa,EAAE,qBAAqB,EACpC,qBAAqB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,mBAAmB,CAAC,EACvF,+BAA+B,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,IAAI,CAAC,EACtF,aAAa,EAAE,uBAAuB,EACtC,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,yBAAyB,EAC5C,sBAAsB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,EAC9D,OAAO,EAAE,kBAAkB,GACzB,OAAO,CAAC,iBAAiB,CAAC;IAqE7B,IAAW,QAAQ,YAElB;IACD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAA4B;IACnD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAe;IAC/C,OAAO,CAAC,eAAe,CAAC,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAC7C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,eAAe,CAOV;IACb,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,uBAAuB,CAAK;IACpC,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IAEjC,8EAA8E;IAC9E,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAS;IAEtD,OAAO;YA4GO,gBAAgB;IAsD9B;;;;;;;OAOG;YACW,0BAA0B;IAYjC,OAAO,IAAI,IAAI;IAYtB;;;;;OAKG;IACI,sBAAsB,sGAGf;IAEd,wGAAwG;IACxG,OAAO,CAAC,8BAA8B,CAAS;IAExC,QAAQ,CAAC,EAAE,EAAE,yBAAyB,EAAE,cAAc,EAAE,OAAO;IA8BtE;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,6BAA6B;IAWxB,QAAQ,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YA6BjD,SAAS;IAuBvB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,kBAAkB;IAW1B;;;;;;;;OAQG;YACW,mBAAmB;IAsBjC;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IA8CxB,oCAAoC;IACpC,OAAO,CAAC,YAAY;IAyBpB;;;OAGG;YACW,8BAA8B;IAiF5C;;;OAGG;YACW,uBAAuB;IAoJrC;;;OAGG;YACW,4BAA4B;IAkB1C,8DAA8D;IACvD,iBAAiB,CACvB,OAAO,EAAE,yBAAyB,EAClC,cAAc,GAAE,sBAAqD,GACnE,iBAAiB;IA6BpB,6DAA6D;IACtD,gBAAgB,CAAC,OAAO,EAAE,wBAAwB,GAAG,sBAAsB;IAiClF,OAAO,CAAC,qBAAqB;IAwB7B,OAAO,CAAC,sBAAsB;CAS9B"}

package/lib/summary/runningSummarizer.mjs

@@ -31,13 +31,22 @@ export const defaultMaxAttemptsForSubmitFailures = 5;
 export class RunningSummarizer extends TypedEventEmitter {
     static async start(logger, summaryWatcher, configuration, submitSummaryCallback, refreshLatestSummaryAckCallback, heuristicData, summaryCollection, cancellationToken, stopSummarizerCallback, runtime) {
         const summarizer = new RunningSummarizer(logger, summaryWatcher, configuration, submitSummaryCallback, refreshLatestSummaryAckCallback, heuristicData, summaryCollection, cancellationToken, stopSummarizerCallback, runtime);
-        // Before doing any heuristics or proceeding with its refreshing, if there is a summary ack received while
-        // this summarizer catches up, let's refresh state before proceeding with the summarization.
-        const lastAckRefSeq = await summarizer.handleSummaryAck();
+        // If there have been any acks newer that the one this client loaded from until now, process them before
+        // starting the running summarizer which will trigger summary heuristics.
+        // This is done primarily to handle scenarios where the summarizer loads from a cached snapshot and there
+        // is newer one available. The ack for the newer summary is processed before summarizing because otherwise
+        // that summary would fail as it has an older parent.
+        let nextReferenceSequenceNumber = runtime.deltaManager.initialSequenceNumber + 1;
+        const latestAck = summaryCollection.latestAck;
+        if (latestAck !== undefined &&
+            latestAck.summaryOp.referenceSequenceNumber >= nextReferenceSequenceNumber) {
+            await summarizer.handleSummaryAck(latestAck);
+            nextReferenceSequenceNumber = latestAck.summaryOp.referenceSequenceNumber + 1;
+        }
         await summarizer.waitStart();
-        // Handle summary acks asynchronously
+        // Process summary acks asynchronously
         // Note: no exceptions are thrown from processIncomingSummaryAcks handler as it handles all exceptions
-        summarizer.processIncomingSummaryAcks(lastAckRefSeq).catch((error) => {
+        summarizer.processIncomingSummaryAcks(nextReferenceSequenceNumber).catch((error) => {
             createChildLogger({ logger }).sendErrorEvent({ eventName: "HandleSummaryAckFatalError" }, error);
         });
         // Update heuristic counts
@@ -154,78 +163,63 @@ export class RunningSummarizer extends TypedEventEmitter {
                 ? overrideMaxAttempts
                 : defaultMaxAttemptsForSubmitFailures;
     }
-    async handleSummaryAck() {
-        const lastAck = this.summaryCollection.latestAck;
-        let refSequenceNumber = -1;
-        // In case we haven't received the lastestAck yet, just return.
-        if (lastAck !== undefined) {
-            refSequenceNumber = lastAck.summaryOp.referenceSequenceNumber;
-            const summaryLogger = this.tryGetCorrelatedLogger(refSequenceNumber) ?? this.mc.logger;
-            const summaryOpHandle = lastAck.summaryOp.contents.handle;
-            const summaryAckHandle = lastAck.summaryAck.contents.handle;
-            while (this.summarizingLock !== undefined) {
-                summaryLogger.sendTelemetryEvent({
-                    eventName: "RefreshAttemptWithSummarizerRunning",
-                    referenceSequenceNumber: refSequenceNumber,
-                    proposalHandle: summaryOpHandle,
-                    ackHandle: summaryAckHandle,
-                });
-                await this.summarizingLock;
-            }
-            // Make sure we block any summarizer from being executed/enqueued while
-            // executing the refreshLatestSummaryAck.
-            // https://dev.azure.com/fluidframework/internal/_workitems/edit/779
-            await this.lockedSummaryAction(() => { }, async () => this.refreshLatestSummaryAckCallback({
+    async handleSummaryAck(ack) {
+        const refSequenceNumber = ack.summaryOp.referenceSequenceNumber;
+        const summaryLogger = this.tryGetCorrelatedLogger(refSequenceNumber) ?? this.mc.logger;
+        const summaryOpHandle = ack.summaryOp.contents.handle;
+        const summaryAckHandle = ack.summaryAck.contents.handle;
+        while (this.summarizingLock !== undefined) {
+            summaryLogger.sendTelemetryEvent({
+                eventName: "RefreshAttemptWithSummarizerRunning",
+                referenceSequenceNumber: refSequenceNumber,
                 proposalHandle: summaryOpHandle,
                 ackHandle: summaryAckHandle,
-                summaryRefSeq: refSequenceNumber,
-                summaryLogger,
-            }).catch(async (error) => {
-                // If the error is 404, so maybe the fetched version no longer exists on server. We just
-                // ignore this error in that case, as that means we will have another summaryAck for the
-                // latest version with which we will refresh the state. However in case of single commit
-                // summary, we might me missing a summary ack, so in that case we are still fine as the
-                // code in `submitSummary` function in container runtime, will refresh the latest state
-                // by calling `prefetchLatestSummaryThenClose`. We will load the next summarizer from the
-                // updated state and be fine.
-                const isIgnoredError = isFluidError(error) &&
-                    error.errorType === DriverErrorTypes.fileNotFoundOrAccessDeniedError;
-                summaryLogger.sendTelemetryEvent({
-                    eventName: isIgnoredError
-                        ? "HandleSummaryAckErrorIgnored"
-                        : "HandleLastSummaryAckError",
-                    referenceSequenceNumber: refSequenceNumber,
-                    proposalHandle: summaryOpHandle,
-                    ackHandle: summaryAckHandle,
-                }, error);
-            }), () => { });
-            refSequenceNumber++;
+            });
+            await this.summarizingLock;
         }
-        return refSequenceNumber;
+        // Make sure we block any summarizer from being executed/enqueued while
+        // executing the refreshLatestSummaryAck.
+        // https://dev.azure.com/fluidframework/internal/_workitems/edit/779
+        await this.lockedSummaryAction(() => { }, async () => this.refreshLatestSummaryAckCallback({
+            proposalHandle: summaryOpHandle,
+            ackHandle: summaryAckHandle,
+            summaryRefSeq: refSequenceNumber,
+            summaryLogger,
+        }).catch(async (error) => {
+            // If the error is 404, so maybe the fetched version no longer exists on server. We just
+            // ignore this error in that case, as that means we will have another summaryAck for the
+            // latest version with which we will refresh the state. However in case of single commit
+            // summary, we might me missing a summary ack, so in that case we are still fine as the
+            // code in `submitSummary` function in container runtime, will refresh the latest state
+            // by calling `prefetchLatestSummaryThenClose`. We will load the next summarizer from the
+            // updated state and be fine.
+            const isIgnoredError = isFluidError(error) &&
+                error.errorType === DriverErrorTypes.fileNotFoundOrAccessDeniedError;
+            summaryLogger.sendTelemetryEvent({
+                eventName: isIgnoredError
+                    ? "HandleSummaryAckErrorIgnored"
+                    : "HandleLastSummaryAckError",
+                referenceSequenceNumber: refSequenceNumber,
+                proposalHandle: summaryOpHandle,
+                ackHandle: summaryAckHandle,
+            }, error);
+        }), () => { });
     }
     /**
-     * Responsible for receiving and processing all the summaryAcks.
-     * In case there was a summary ack processed by the running summarizer before processIncomingSummaryAcks is called,
-     * it will wait for the summary ack that is newer than the one indicated by the lastAckRefSeq.
-     * @param lastAckRefSeq - Identifies the minimum reference sequence number the summarizer needs to wait for.
-     * In case of a negative number, the summarizer will wait for ANY summary ack that is greater than the deltaManager's initial sequence number,
-     * and, in case of a positive one, it will wait for a summary ack that is greater than this current reference sequence number.
+     * Responsible for receiving and processing all the summary acks.
+     * It starts processing ACKs after the one for the summary this client loaded from (initialSequenceNumber). Any
+     * ACK before that is not interesting as it will simply be ignored.
+     *
+     * @param referenceSequenceNumber - The referenceSequenceNumber of the summary from which to start processing
+     * acks.
      */
-    async processIncomingSummaryAcks(lastAckRefSeq) {
-        let refSequenceNumber = lastAckRefSeq > 0 ? lastAckRefSeq : this.runtime.deltaManager.initialSequenceNumber;
+    async processIncomingSummaryAcks(referenceSequenceNumber) {
+        // Start waiting for acks that are for summaries newer that the one this client loaded from.
+        let nextReferenceSequenceNumber = referenceSequenceNumber;
         while (!this.disposed) {
-            const summaryLogger = this.tryGetCorrelatedLogger(refSequenceNumber) ?? this.mc.logger;
-            // Initialize ack with undefined if exception happens inside of waitSummaryAck on second iteration,
-            // we record undefined, not previous handles.
-            await this.summaryCollection.waitSummaryAck(refSequenceNumber);
-            summaryLogger.sendTelemetryEvent({
-                eventName: "processIncomingSummaryAcks",
-                referenceSequenceNumber: refSequenceNumber,
-                lastAckRefSeq,
-            });
-            refSequenceNumber = await this.handleSummaryAck();
-            // A valid Summary Ack must have been processed.
-            assert(refSequenceNumber >= 0, 0x58f /* Invalid ref sequence number */);
+            const ackedSummary = await this.summaryCollection.waitSummaryAck(nextReferenceSequenceNumber);
+            await this.handleSummaryAck(ackedSummary);
+            nextReferenceSequenceNumber = ackedSummary.summaryOp.referenceSequenceNumber + 1;
         }
     }
     dispose() {
@@ -382,7 +376,14 @@ export class RunningSummarizer extends TypedEventEmitter {
             };
             const summarizeResult = this.generator.summarize(summaryOptions, resultsBuilder);
             // ensure we wait till the end of the process
-            return summarizeResult.receivedSummaryAckOrNack;
+            const result = await summarizeResult.receivedSummaryAckOrNack;
+            if (!result.success) {
+                this.mc.logger.sendErrorEvent({
+                    eventName: "SummarizeFailed",
+                    maxAttempts: 1,
+                    summaryAttempts: 1,
+                }, result.error);
+            }
         }, () => {
             this.afterSummaryAction();
         }).catch((error) => {
@@ -425,6 +426,7 @@ export class RunningSummarizer extends TypedEventEmitter {
         let summaryAttempts = 0;
         let summaryAttemptsPerPhase = 0;
         let summaryAttemptPhase = 0;
+        let error;
         while (summaryAttemptPhase < attemptOptions.length) {
             if (this.cancellationToken.cancelled) {
                 return;
@@ -458,6 +460,7 @@ export class RunningSummarizer extends TypedEventEmitter {
             if (ackNackResult.success) {
                 return;
             }
+            error = ackNackResult.error;
             // Check for retryDelay that can come from summaryNack, upload summary or submit summary flows.
             // Retry the same step only once per retryAfter response.
             const submitResult = await resultSummarize.summarySubmitted;
@@ -478,6 +481,11 @@ export class RunningSummarizer extends TypedEventEmitter {
                 await delay(delaySeconds * 1000);
             }
         }
+        this.mc.logger.sendErrorEvent({
+            eventName: "SummarizeFailed",
+            maxAttempts: attemptOptions.length,
+            summaryAttempts: summaryAttemptPhase,
+        }, error);
         this.stopSummarizerCallback("failToSummarize");
     }
     /**
@@ -522,19 +530,22 @@ export class RunningSummarizer extends TypedEventEmitter {
         let currentAttempt = 0;
         let retryAfterSeconds;
         let done = false;
-        let result = "success";
+        let status = "success";
+        let results;
+        let error;
         do {
             currentAttempt++;
             if (this.cancellationToken.cancelled) {
-                result = "canceled";
+                status = "canceled";
                 done = true;
                 break;
             }
-            const { summarizeProps, summarizeResult } = attemptSummarize(currentAttempt, false /* finalAttempt */);
+            const attemptResult = attemptSummarize(currentAttempt, false /* finalAttempt */);
+            results = attemptResult.summarizeResult;
             // Ack / nack is the final step, so if it succeeds we're done.
-            const ackNackResult = await summarizeResult.receivedSummaryAckOrNack;
+            const ackNackResult = await results.receivedSummaryAckOrNack;
             if (ackNackResult.success) {
-                result = "success";
+                status = "success";
                 done = true;
                 break;
             }
@@ -542,7 +553,7 @@ export class RunningSummarizer extends TypedEventEmitter {
             // If submit summary failed, use the params from "summarySubmitted" result. Else, use the params
             // from "receivedSummaryAckOrNack" result.
             // Note: Check "summarySubmitted" result first because if it fails, ack nack would fail as well.
-            const submitSummaryResult = await summarizeResult.summarySubmitted;
+            const submitSummaryResult = await results.summarySubmitted;
             if (!submitSummaryResult.success) {
                 maxAttempts = this.maxAttemptsForSubmitFailures;
                 retryAfterSeconds = submitSummaryResult.data?.retryAfterSeconds;
@@ -552,12 +563,13 @@ export class RunningSummarizer extends TypedEventEmitter {
                 retryAfterSeconds = ackNackResult.data?.retryAfterSeconds;
             }
             // Emit "summarize" event for this failed attempt.
-            result = "failure";
+            status = "failure";
+            error = ackNackResult.error;
             const eventProps = {
-                result,
+                result: status,
                 currentAttempt,
                 maxAttempts,
-                error: ackNackResult.error,
+                error,
             };
             this.emit("summarize", eventProps);
             // If the failure doesn't have "retryAfterSeconds" or the max number of attempts have been done, we're done.
@@ -573,15 +585,15 @@ export class RunningSummarizer extends TypedEventEmitter {
                     summaryNackDelay: ackNackResult.data?.retryAfterSeconds !== undefined,
                     stage: submitSummaryResult.data?.stage,
                     dynamicRetries: true,
-                    ...summarizeProps,
+                    ...attemptResult.summarizeProps,
                 });
                 await delay(retryAfterSeconds * 1000);
             }
         } while (!done);
         // If summarize attempt did not fail, emit "summarize" event and return. A failed attempt may be retried below.
-        if (result !== "failure") {
-            this.emit("summarize", { result, currentAttempt, maxAttempts });
-            return;
+        if (status !== "failure") {
+            this.emit("summarize", { result: status, currentAttempt, maxAttempts });
+            return results;
         }
         // If summarization wasn't successful above and the failure contains "retryAfterSeconds", perform one last
         // attempt. This gives a chance to the runtime to perform additional steps in the last attempt.
@@ -589,19 +601,47 @@ export class RunningSummarizer extends TypedEventEmitter {
             const { summarizeResult } = attemptSummarize(++currentAttempt, true /* finalAttempt */);
             // Ack / nack is the final step, so if it succeeds we're done.
             const ackNackResult = await summarizeResult.receivedSummaryAckOrNack;
-            result = ackNackResult.success ? "success" : "failure";
+            status = ackNackResult.success ? "success" : "failure";
+            if (!ackNackResult.success) {
+                error = ackNackResult.error;
+            }
             const eventProps = {
-                result,
+                result: status,
                 currentAttempt,
                 maxAttempts,
                 error: ackNackResult.success ? undefined : ackNackResult.error,
             };
             this.emit("summarize", eventProps);
+            results = summarizeResult;
         }
         // If summarization is still unsuccessful, stop the summarizer.
-        if (result === "failure") {
+        if (status === "failure") {
+            this.mc.logger.sendErrorEvent({
+                eventName: "SummarizeFailed",
+                maxAttempts,
+                summaryAttempts: currentAttempt,
+            }, error);
             this.stopSummarizerCallback("failToSummarize");
         }
+        return results;
+    }
+    /**
+     * Attempts to generate a summary on demand with retries in case of failures. The retry logic is the same
+     * as heuristics based summaries.
+     */
+    async summarizeOnDemandWithRetries(reason, resultsBuilder) {
+        const results = await this.trySummarizeWithRetries(reason);
+        if (results === undefined) {
+            resultsBuilder.fail("Summarization was canceled", undefined);
+            return resultsBuilder.build();
+        }
+        const submitResult = await results.summarySubmitted;
+        const summaryOpBroadcastedResult = await results.summaryOpBroadcasted;
+        const ackNackResult = await results.receivedSummaryAckOrNack;
+        resultsBuilder.summarySubmitted.resolve(submitResult);
+        resultsBuilder.summaryOpBroadcasted.resolve(summaryOpBroadcastedResult);
+        resultsBuilder.receivedSummaryAckOrNack.resolve(ackNackResult);
+        return resultsBuilder.build();
     }
     /** {@inheritdoc (ISummarizer:interface).summarizeOnDemand} */
     summarizeOnDemand(options, resultsBuilder = new SummarizeResultBuilder()) {
@@ -616,8 +656,15 @@ export class RunningSummarizer extends TypedEventEmitter {
             throw new UsageError("Attempted to run an already-running summarizer on demand");
         }
         const { reason, ...summarizeOptions } = options;
-        const result = this.trySummarizeOnce({ summarizeReason: `onDemand/${reason}` }, summarizeOptions, resultsBuilder);
-        return result;
+        if (options.retryOnFailure === true) {
+            this.summarizeOnDemandWithRetries(`onDemand;${reason}`, resultsBuilder).catch((error) => {
+                resultsBuilder.fail("summarize failed", error);
+            });
+        }
+        else {
+            this.trySummarizeOnce({ summarizeReason: `onDemand/${reason}` }, summarizeOptions, resultsBuilder);
+        }
+        return resultsBuilder.build();
     }
     /** {@inheritdoc (ISummarizer:interface).enqueueSummarize} */
     enqueueSummarize(options) {