@fluidframework/register-collection 0.56.5 → 0.57.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -52,7 +52,6 @@ export declare class ConsensusRegisterCollection<T> extends SharedObject<IConsen
52
52
  * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
53
53
  */
54
54
  protected loadCore(storage: IChannelStorageService): Promise<void>;
55
- protected registerCore(): void;
56
55
  protected onDisconnect(): void;
57
56
  protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
58
57
  private readAtomic;
@@ -1 +1 @@
1
- {"version":3,"file":"consensusRegisterCollection.d.ts","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACzB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAA2B,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAC7G,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,4BAA4B,EAAE,UAAU,EAAE,kCAAkC,EAAE,MAAM,cAAc,CAAC;AAoE5G;;GAEG;AACH,qBAAa,2BAA2B,CAAC,CAAC,CACtC,SAAQ,YAAY,CAAC,kCAAkC,CAAE,YAAW,4BAA4B,CAAC,CAAC,CAAC;IACnG;;;;;;OAMG;WAEW,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIpE;;;;OAIG;WACW,UAAU;IAIxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoC;IAEzD;;;OAGG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAKlC;;;;;OAKG;IACU,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB3D;;;;OAIG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,GAAE,UAA8B,GAAG,CAAC,GAAG,SAAS;IAe5E,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,SAAS;IAK1C,IAAI,IAAI,MAAM,EAAE;IAIvB,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAO5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcxE,SAAS,CAAC,YAAY;IAEtB,SAAS,CAAC,YAAY;IAEtB,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAqClG,OAAO,CAAC,UAAU;IAKlB;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IA8D3B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,KAAK;IAKb,SAAS,CAAC,cAAc;CAI3B"}
1
+ {"version":3,"file":"consensusRegisterCollection.d.ts","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACzB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAA2B,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAC7G,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,4BAA4B,EAAE,UAAU,EAAE,kCAAkC,EAAE,MAAM,cAAc,CAAC;AAoE5G;;GAEG;AACH,qBAAa,2BAA2B,CAAC,CAAC,CACtC,SAAQ,YAAY,CAAC,kCAAkC,CAAE,YAAW,4BAA4B,CAAC,CAAC,CAAC;IACnG;;;;;;OAMG;WAEW,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIpE;;;;OAIG;WACW,UAAU;IAIxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoC;IAEzD;;;OAGG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAKlC;;;;;OAKG;IACU,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB3D;;;;OAIG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,GAAE,UAA8B,GAAG,CAAC,GAAG,SAAS;IAe5E,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,SAAS;IAK1C,IAAI,IAAI,MAAM,EAAE;IAIvB,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAO5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcxE,SAAS,CAAC,YAAY;IAEtB,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAqClG,OAAO,CAAC,UAAU;IAKlB;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IA8D3B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,KAAK;IAKb,SAAS,CAAC,cAAc;CAI3B"}
@@ -120,7 +120,6 @@ class ConsensusRegisterCollection extends shared_object_base_1.SharedObject {
120
120
  this.data.set(key, dataObj[key]);
121
121
  }
122
122
  }
123
- registerCore() { }
124
123
  onDisconnect() { }
125
124
  processCore(message, local, localOpMetadata) {
126
125
  if (message.type === protocol_definitions_1.MessageType.Operation) {
@@ -1 +1 @@
1
- {"version":3,"file":"consensusRegisterCollection.js","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAuF;AACvF,+EAA8F;AAO9F,2EAA6G;AAC7G,6FAA0F;AAC1F,6CAA4G;AAqB5G,MAAM,gBAAgB,GAAG,CAAI,cAAsB,EAAE,KAAQ,EAAqB,EAAE,CAAC,CAAC;IAClF,cAAc;IACd,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK;KACR;CACJ,CAAC,CAAC;AAiCH,0EAA0E;AAC1E,MAAM,8BAA8B,GAAG,CAAC,EAAE,EAA4B,EAAE,CAAC,iBAAiB,IAAI,EAAE,CAAC;AAKjG,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAa,2BACT,SAAQ,iCAAgD;IAwBxD;;;OAGG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAXlB,SAAI,GAAG,IAAI,GAAG,EAAyB,CAAC;IAYzD,CAAC;IAjCD;;;;;;OAMG;IACH,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAI,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,uEAAkC,CAAC,IAAI,CAAmC,CAAC;IAChH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,uEAAkC,EAAE,CAAC;IACpD,CAAC;IAgBD;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,KAAQ;QACpC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,wFAAwF;YACxF,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACxF,OAAO,IAAI,CAAC;SACf;QAED,MAAM,OAAO,GAAuB;YAChC,GAAG;YACH,IAAI,EAAE,OAAO;YACb,eAAe;YACf,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB;SACvD,CAAC;QAEF,OAAO,IAAI,CAAC,kBAAkB,CAAU,CAAC,OAAO,EAAE,EAAE;YAChD,8FAA8F;YAC9F,eAAe;YACf,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1C,kGAAkG;QACtG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,GAAW,EAAE,aAAyB,uBAAU,CAAC,MAAM;QAC/D,IAAI,UAAU,KAAK,uBAAU,CAAC,MAAM,EAAE;YAClC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC/B;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,oEAAoE;YACpE,qBAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAElF,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACxC;IACL,CAAC;IAEM,YAAY,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAA0B,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE;IACnF,CAAC;IAEM,IAAI;QACP,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAES,aAAa,CAAC,UAA4B;QAChD,MAAM,OAAO,GAAqC,EAAE,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjD,OAAO,4CAAuB,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;;QACpD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,6BAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACpC,qBAAM,CAAC,OAAA,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,0CAAE,KAAK,CAAC,IAAI,MAAK,QAAQ;YAC/C,mCAAmC;YACnC,KAAK,CAAC,uGAAuG,CAAC,CAAC;YAEnH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACpC;IACL,CAAC;IAES,YAAY,KAAK,CAAC;IAElB,YAAY,KAAI,CAAC;IAEjB,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,EAAE;YACxC,MAAM,EAAE,GAAkC,OAAO,CAAC,QAAQ,CAAC;YAC3D,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,OAAO,CAAC,CAAC;oBACV,uFAAuF;oBACvF,wCAAwC;oBACxC,IAAI,EAAE,CAAC,MAAM,KAAK,SAAS,EAAE;wBACzB,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;qBAC/C;oBACD,uEAAuE;oBACvE,2EAA2E;oBAC3E,MAAM,iBAAiB,GAAG,EAAE,CAAC,MAAM,CAAC;oBACpC,qBAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,uBAAuB,EACvD,KAAK,CAAC,6EAA6E,CAAC,CAAC;oBAEzF,MAAM,KAAK,GAAG,8BAA8B,CAAC,EAAE,CAAC;wBAC5C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAM;wBACtD,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;oBACrB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CACnC,EAAE,CAAC,GAAG,EACN,KAAK,EACL,iBAAiB,EACjB,OAAO,CAAC,cAAc,EACtB,KAAK,CAAC,CAAC;oBACX,IAAI,KAAK,EAAE;wBACP,0FAA0F;wBAC1F,MAAM,OAAO,GAAG,eAAiC,CAAC;wBAClD,OAAO,CAAC,MAAM,CAAC,CAAC;qBACnB;oBACD,MAAM;iBACT;gBACD,OAAO,CAAC,CAAC,8BAAe,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAEO,UAAU,CAAC,GAAW;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB,CACvB,GAAW,EACX,KAAQ,EACR,MAAc,EACd,cAAsB,EACtB,KAAc;QAEd,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,wEAAwE;QACxE,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAI,KAAK,SAAS,IAAI,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAC1E,IAAI,MAAM,EAAE;YACR,MAAM,YAAY,GAAG,gBAAgB,CACjC,cAAc,EACd,KAAK,CACR,CAAC;YACF,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpB,IAAI,GAAG;oBACH,MAAM,EAAE,YAAY;oBACpB,QAAQ,EAAE,EAAE;iBACf,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aAC5B;iBAAM;gBACH,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;aAC9B;SACJ;aACI;YACD,qBAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,mDAAmD,CAAC,CAAC;SAC7E;QAED,4EAA4E;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;YAC1E,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SACzB;QAED,MAAM,aAAa,GAAG,gBAAgB,CAClC,cAAc,EACd,KAAK,CACR,CAAC;QAEF,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,qBAAM,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,EACvC,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAC5E;aACI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,qBAAM,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,EAC1E,KAAK,CAAC,8DAA8D,CAAC,CAAC;SAC7E;QAED,wBAAwB;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAElC,sDAAsD;QACtD,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;SACjD;QACD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAE/C,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,SAAS,CAAC,KAAU,EAAE,UAA4B;QACtD,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,OAAe,EAAE,UAA4B;QACvD,+DAA+D;QAC/D,OAAO,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAES,cAAc;QACpB,uBAAuB;QACvB,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC;IACrB,CAAC;CACJ;AAzPD,kEAyPC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, bufferToString, unreachableCase } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n IChannelAttributes,\n IFluidDataStoreRuntime,\n IChannelStorageService,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { createSingleBlobSummary, IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { ConsensusRegisterCollectionFactory } from \"./consensusRegisterCollectionFactory\";\nimport { IConsensusRegisterCollection, ReadPolicy, IConsensusRegisterCollectionEvents } from \"./interfaces\";\n\ninterface ILocalData<T> {\n // Atomic version\n atomic: ILocalRegister<T>;\n\n // All concurrent versions awaiting consensus\n versions: ILocalRegister<T>[];\n}\n\ninterface ILocalRegister<T> {\n // Register value, wrapped for backwards compatibility with < 0.17\n value: {\n type: \"Plain\",\n value: T,\n };\n\n // The sequence number when last consensus was reached\n sequenceNumber: number;\n}\n\nconst newLocalRegister = <T>(sequenceNumber: number, value: T): ILocalRegister<T> => ({\n sequenceNumber,\n value: {\n type: \"Plain\",\n value,\n },\n});\n\n/**\n * An operation for consensus register collection\n */\ninterface IRegisterOperation {\n key: string;\n type: \"write\";\n serializedValue: string;\n\n // Message can be delivered with delay - resubmitted on reconnect.\n // As such, refSeq needs to reference seq # at the time op was created,\n // not when op was actually sent over wire (ISequencedDocumentMessage.referenceSequenceNumber),\n // as client can ingest ops in between.\n refSeq: number | undefined;\n}\n\n/**\n * IRegisterOperation format in versions < 0.17\n */\ninterface IRegisterOperationOld<T> {\n key: string;\n type: \"write\";\n value: {\n type: \"Plain\",\n value: T,\n };\n refSeq: number;\n}\n\n/** Incoming ops could match any of these types */\ntype IIncomingRegisterOperation<T> = IRegisterOperation | IRegisterOperationOld<T>;\n\n/** Distinguish between incoming op formats so we know which type it is */\nconst incomingOpMatchesCurrentFormat = (op): op is IRegisterOperation => \"serializedValue\" in op;\n\n/** The type of the resolve function to call after the local operation is ack'd */\ntype PendingResolve = (winner: boolean) => void;\n\nconst snapshotFileName = \"header\";\n\n/**\n * Implementation of a consensus register collection\n */\nexport class ConsensusRegisterCollection<T>\n extends SharedObject<IConsensusRegisterCollectionEvents> implements IConsensusRegisterCollection<T> {\n /**\n * Create a new consensus register collection\n *\n * @param runtime - data store runtime the new consensus register collection belongs to\n * @param id - optional name of the consensus register collection\n * @returns newly create consensus register collection (but not attached yet)\n */\n // eslint-disable-next-line @typescript-eslint/no-shadow\n public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {\n return runtime.createChannel(id, ConsensusRegisterCollectionFactory.Type) as ConsensusRegisterCollection<T>;\n }\n\n /**\n * Get a factory for ConsensusRegisterCollection to register with the data store.\n *\n * @returns a factory that creates and load ConsensusRegisterCollection\n */\n public static getFactory() {\n return new ConsensusRegisterCollectionFactory();\n }\n\n private readonly data = new Map<string, ILocalData<T>>();\n\n /**\n * Constructs a new consensus register collection. If the object is non-local an id and service interfaces will\n * be provided\n */\n public constructor(\n id: string,\n runtime: IFluidDataStoreRuntime,\n attributes: IChannelAttributes,\n ) {\n super(id, runtime, attributes);\n }\n\n /**\n * Creates a new register or writes a new value.\n * Returns a promise that will resolve when the write is acked.\n *\n * @returns Promise<true> if write was non-concurrent\n */\n public async write(key: string, value: T): Promise<boolean> {\n const serializedValue = this.stringify(value, this.serializer);\n\n if (!this.isAttached()) {\n // JSON-roundtrip value for local writes to match the behavior of going through the wire\n this.processInboundWrite(key, this.parse(serializedValue, this.serializer), 0, 0, true);\n return true;\n }\n\n const message: IRegisterOperation = {\n key,\n type: \"write\",\n serializedValue,\n refSeq: this.runtime.deltaManager.lastSequenceNumber,\n };\n\n return this.newAckBasedPromise<boolean>((resolve) => {\n // Send the resolve function as the localOpMetadata. This will be provided back to us when the\n // op is ack'd.\n this.submitLocalMessage(message, resolve);\n // If we fail due to runtime being disposed, it's better to return false then unhandled exception.\n }).catch((error) => false);\n }\n\n /**\n * Returns the most recent local value of a register.\n * @param key - The key to read\n * @param readPolicy - The ReadPolicy to apply. Defaults to Atomic.\n */\n public read(key: string, readPolicy: ReadPolicy = ReadPolicy.Atomic): T | undefined {\n if (readPolicy === ReadPolicy.Atomic) {\n return this.readAtomic(key);\n }\n\n const versions = this.readVersions(key);\n\n if (versions !== undefined) {\n // We don't support deletion. So there should be at least one value.\n assert(versions.length > 0, 0x06c /* \"Value should be undefined or non-empty\" */);\n\n return versions[versions.length - 1];\n }\n }\n\n public readVersions(key: string): T[] | undefined {\n const data = this.data.get(key);\n return data?.versions.map((element: ILocalRegister<T>) => element.value.value);\n }\n\n public keys(): string[] {\n return [...this.data.keys()];\n }\n\n protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n const dataObj: { [key: string]: ILocalData<T> } = {};\n this.data.forEach((v, k) => { dataObj[k] = v; });\n\n return createSingleBlobSummary(snapshotFileName, this.stringify(dataObj, serializer));\n }\n\n /**\n * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n */\n protected async loadCore(storage: IChannelStorageService): Promise<void> {\n const blob = await storage.readBlob(snapshotFileName);\n const header = bufferToString(blob, \"utf8\");\n const dataObj = this.parse(header, this.serializer);\n\n for (const key of Object.keys(dataObj)) {\n assert(dataObj[key].atomic?.value.type !== \"Shared\",\n // eslint-disable-next-line max-len\n 0x06d /* \"SharedObjects contained in ConsensusRegisterCollection can no longer be deserialized as of 0.17\" */);\n\n this.data.set(key, dataObj[key]);\n }\n }\n\n protected registerCore() { }\n\n protected onDisconnect() {}\n\n protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n if (message.type === MessageType.Operation) {\n const op: IIncomingRegisterOperation<T> = message.contents;\n switch (op.type) {\n case \"write\": {\n // backward compatibility: File at rest written with runtime <= 0.13 do not have refSeq\n // when the refSeq property didn't exist\n if (op.refSeq === undefined) {\n op.refSeq = message.referenceSequenceNumber;\n }\n // Message can be delivered with delay - e.g. resubmitted on reconnect.\n // Use the refSeq from when the op was created, not when it was transmitted\n const refSeqWhenCreated = op.refSeq;\n assert(refSeqWhenCreated <= message.referenceSequenceNumber,\n 0x06e /* \"Message's reference sequence number < op's reference sequence number!\" */);\n\n const value = incomingOpMatchesCurrentFormat(op)\n ? this.parse(op.serializedValue, this.serializer) as T\n : op.value.value;\n const winner = this.processInboundWrite(\n op.key,\n value,\n refSeqWhenCreated,\n message.sequenceNumber,\n local);\n if (local) {\n // Resolve the pending promise for this operation now that we have received an ack for it.\n const resolve = localOpMetadata as PendingResolve;\n resolve(winner);\n }\n break;\n }\n default: unreachableCase(op.type);\n }\n }\n }\n\n private readAtomic(key: string): T | undefined {\n const data = this.data.get(key);\n return data?.atomic.value.value;\n }\n\n /**\n * Process an inbound write op\n * @param key - Key that was written to\n * @param value - Incoming value\n * @param refSeq - RefSeq at the time of write on the remote client\n * @param sequenceNumber - Sequence Number of this write op\n * @param local - Did this write originate on this client\n */\n private processInboundWrite(\n key: string,\n value: T,\n refSeq: number,\n sequenceNumber: number,\n local: boolean,\n ): boolean {\n let data = this.data.get(key);\n // Atomic update if it's a new register or the write was not concurrent,\n // meaning our state was known to the remote client at the time of write\n const winner = data === undefined || refSeq >= data.atomic.sequenceNumber;\n if (winner) {\n const atomicUpdate = newLocalRegister<T>(\n sequenceNumber,\n value,\n );\n if (data === undefined) {\n data = {\n atomic: atomicUpdate,\n versions: [], // we'll update versions next, leave it empty for now\n };\n this.data.set(key, data);\n } else {\n data.atomic = atomicUpdate;\n }\n }\n else {\n assert(!!data, 0x06f /* \"data missing for non-atomic inbound update!\" */);\n }\n\n // Remove versions that were known to the remote client at the time of write\n while (data.versions.length > 0 && refSeq >= data.versions[0].sequenceNumber) {\n data.versions.shift();\n }\n\n const versionUpdate = newLocalRegister<T>(\n sequenceNumber,\n value,\n );\n\n // Asserts for data integrity\n if (!this.isAttached()) {\n assert(refSeq === 0 && sequenceNumber === 0,\n 0x070 /* \"sequence numbers are expected to be 0 when unattached\" */);\n }\n else if (data.versions.length > 0) {\n assert(sequenceNumber > data.versions[data.versions.length - 1].sequenceNumber,\n 0x071 /* \"Versions should naturally be ordered by sequenceNumber\" */);\n }\n\n // Push the new element.\n data.versions.push(versionUpdate);\n\n // Raise events at the end, to avoid reentrancy issues\n if (winner) {\n this.emit(\"atomicChanged\", key, value, local);\n }\n this.emit(\"versionChanged\", key, value, local);\n\n return winner;\n }\n\n private stringify(value: any, serializer: IFluidSerializer): string {\n return serializer.stringify(value, this.handle);\n }\n\n private parse(content: string, serializer: IFluidSerializer): any {\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return serializer.parse(content);\n }\n\n protected applyStashedOp() {\n // empty implementation\n return () => { };\n }\n}\n"]}
1
+ {"version":3,"file":"consensusRegisterCollection.js","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAuF;AACvF,+EAA8F;AAO9F,2EAA6G;AAC7G,6FAA0F;AAC1F,6CAA4G;AAqB5G,MAAM,gBAAgB,GAAG,CAAI,cAAsB,EAAE,KAAQ,EAAqB,EAAE,CAAC,CAAC;IAClF,cAAc;IACd,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK;KACR;CACJ,CAAC,CAAC;AAiCH,0EAA0E;AAC1E,MAAM,8BAA8B,GAAG,CAAC,EAAE,EAA4B,EAAE,CAAC,iBAAiB,IAAI,EAAE,CAAC;AAKjG,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAa,2BACT,SAAQ,iCAAgD;IAwBxD;;;OAGG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAXlB,SAAI,GAAG,IAAI,GAAG,EAAyB,CAAC;IAYzD,CAAC;IAjCD;;;;;;OAMG;IACH,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAI,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,uEAAkC,CAAC,IAAI,CAAmC,CAAC;IAChH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,uEAAkC,EAAE,CAAC;IACpD,CAAC;IAgBD;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,KAAQ;QACpC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,wFAAwF;YACxF,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACxF,OAAO,IAAI,CAAC;SACf;QAED,MAAM,OAAO,GAAuB;YAChC,GAAG;YACH,IAAI,EAAE,OAAO;YACb,eAAe;YACf,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB;SACvD,CAAC;QAEF,OAAO,IAAI,CAAC,kBAAkB,CAAU,CAAC,OAAO,EAAE,EAAE;YAChD,8FAA8F;YAC9F,eAAe;YACf,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1C,kGAAkG;QACtG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,GAAW,EAAE,aAAyB,uBAAU,CAAC,MAAM;QAC/D,IAAI,UAAU,KAAK,uBAAU,CAAC,MAAM,EAAE;YAClC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC/B;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,oEAAoE;YACpE,qBAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAElF,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACxC;IACL,CAAC;IAEM,YAAY,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAA0B,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE;IACnF,CAAC;IAEM,IAAI;QACP,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAES,aAAa,CAAC,UAA4B;QAChD,MAAM,OAAO,GAAqC,EAAE,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjD,OAAO,4CAAuB,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;;QACpD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,6BAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACpC,qBAAM,CAAC,OAAA,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,0CAAE,KAAK,CAAC,IAAI,MAAK,QAAQ;YAC/C,mCAAmC;YACnC,KAAK,CAAC,uGAAuG,CAAC,CAAC;YAEnH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACpC;IACL,CAAC;IAES,YAAY,KAAI,CAAC;IAEjB,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,EAAE;YACxC,MAAM,EAAE,GAAkC,OAAO,CAAC,QAAQ,CAAC;YAC3D,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,OAAO,CAAC,CAAC;oBACV,uFAAuF;oBACvF,wCAAwC;oBACxC,IAAI,EAAE,CAAC,MAAM,KAAK,SAAS,EAAE;wBACzB,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;qBAC/C;oBACD,uEAAuE;oBACvE,2EAA2E;oBAC3E,MAAM,iBAAiB,GAAG,EAAE,CAAC,MAAM,CAAC;oBACpC,qBAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,uBAAuB,EACvD,KAAK,CAAC,6EAA6E,CAAC,CAAC;oBAEzF,MAAM,KAAK,GAAG,8BAA8B,CAAC,EAAE,CAAC;wBAC5C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAM;wBACtD,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;oBACrB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CACnC,EAAE,CAAC,GAAG,EACN,KAAK,EACL,iBAAiB,EACjB,OAAO,CAAC,cAAc,EACtB,KAAK,CAAC,CAAC;oBACX,IAAI,KAAK,EAAE;wBACP,0FAA0F;wBAC1F,MAAM,OAAO,GAAG,eAAiC,CAAC;wBAClD,OAAO,CAAC,MAAM,CAAC,CAAC;qBACnB;oBACD,MAAM;iBACT;gBACD,OAAO,CAAC,CAAC,8BAAe,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAEO,UAAU,CAAC,GAAW;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB,CACvB,GAAW,EACX,KAAQ,EACR,MAAc,EACd,cAAsB,EACtB,KAAc;QAEd,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,wEAAwE;QACxE,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAI,KAAK,SAAS,IAAI,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAC1E,IAAI,MAAM,EAAE;YACR,MAAM,YAAY,GAAG,gBAAgB,CACjC,cAAc,EACd,KAAK,CACR,CAAC;YACF,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpB,IAAI,GAAG;oBACH,MAAM,EAAE,YAAY;oBACpB,QAAQ,EAAE,EAAE;iBACf,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aAC5B;iBAAM;gBACH,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;aAC9B;SACJ;aACI;YACD,qBAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,mDAAmD,CAAC,CAAC;SAC7E;QAED,4EAA4E;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;YAC1E,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SACzB;QAED,MAAM,aAAa,GAAG,gBAAgB,CAClC,cAAc,EACd,KAAK,CACR,CAAC;QAEF,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,qBAAM,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,EACvC,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAC5E;aACI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,qBAAM,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,EAC1E,KAAK,CAAC,8DAA8D,CAAC,CAAC;SAC7E;QAED,wBAAwB;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAElC,sDAAsD;QACtD,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;SACjD;QACD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAE/C,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,SAAS,CAAC,KAAU,EAAE,UAA4B;QACtD,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,OAAe,EAAE,UAA4B;QACvD,+DAA+D;QAC/D,OAAO,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAES,cAAc;QACpB,uBAAuB;QACvB,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC;IACrB,CAAC;CACJ;AAvPD,kEAuPC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, bufferToString, unreachableCase } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n IChannelAttributes,\n IFluidDataStoreRuntime,\n IChannelStorageService,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { createSingleBlobSummary, IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { ConsensusRegisterCollectionFactory } from \"./consensusRegisterCollectionFactory\";\nimport { IConsensusRegisterCollection, ReadPolicy, IConsensusRegisterCollectionEvents } from \"./interfaces\";\n\ninterface ILocalData<T> {\n // Atomic version\n atomic: ILocalRegister<T>;\n\n // All concurrent versions awaiting consensus\n versions: ILocalRegister<T>[];\n}\n\ninterface ILocalRegister<T> {\n // Register value, wrapped for backwards compatibility with < 0.17\n value: {\n type: \"Plain\",\n value: T,\n };\n\n // The sequence number when last consensus was reached\n sequenceNumber: number;\n}\n\nconst newLocalRegister = <T>(sequenceNumber: number, value: T): ILocalRegister<T> => ({\n sequenceNumber,\n value: {\n type: \"Plain\",\n value,\n },\n});\n\n/**\n * An operation for consensus register collection\n */\ninterface IRegisterOperation {\n key: string;\n type: \"write\";\n serializedValue: string;\n\n // Message can be delivered with delay - resubmitted on reconnect.\n // As such, refSeq needs to reference seq # at the time op was created,\n // not when op was actually sent over wire (ISequencedDocumentMessage.referenceSequenceNumber),\n // as client can ingest ops in between.\n refSeq: number | undefined;\n}\n\n/**\n * IRegisterOperation format in versions < 0.17\n */\ninterface IRegisterOperationOld<T> {\n key: string;\n type: \"write\";\n value: {\n type: \"Plain\",\n value: T,\n };\n refSeq: number;\n}\n\n/** Incoming ops could match any of these types */\ntype IIncomingRegisterOperation<T> = IRegisterOperation | IRegisterOperationOld<T>;\n\n/** Distinguish between incoming op formats so we know which type it is */\nconst incomingOpMatchesCurrentFormat = (op): op is IRegisterOperation => \"serializedValue\" in op;\n\n/** The type of the resolve function to call after the local operation is ack'd */\ntype PendingResolve = (winner: boolean) => void;\n\nconst snapshotFileName = \"header\";\n\n/**\n * Implementation of a consensus register collection\n */\nexport class ConsensusRegisterCollection<T>\n extends SharedObject<IConsensusRegisterCollectionEvents> implements IConsensusRegisterCollection<T> {\n /**\n * Create a new consensus register collection\n *\n * @param runtime - data store runtime the new consensus register collection belongs to\n * @param id - optional name of the consensus register collection\n * @returns newly create consensus register collection (but not attached yet)\n */\n // eslint-disable-next-line @typescript-eslint/no-shadow\n public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {\n return runtime.createChannel(id, ConsensusRegisterCollectionFactory.Type) as ConsensusRegisterCollection<T>;\n }\n\n /**\n * Get a factory for ConsensusRegisterCollection to register with the data store.\n *\n * @returns a factory that creates and load ConsensusRegisterCollection\n */\n public static getFactory() {\n return new ConsensusRegisterCollectionFactory();\n }\n\n private readonly data = new Map<string, ILocalData<T>>();\n\n /**\n * Constructs a new consensus register collection. If the object is non-local an id and service interfaces will\n * be provided\n */\n public constructor(\n id: string,\n runtime: IFluidDataStoreRuntime,\n attributes: IChannelAttributes,\n ) {\n super(id, runtime, attributes);\n }\n\n /**\n * Creates a new register or writes a new value.\n * Returns a promise that will resolve when the write is acked.\n *\n * @returns Promise<true> if write was non-concurrent\n */\n public async write(key: string, value: T): Promise<boolean> {\n const serializedValue = this.stringify(value, this.serializer);\n\n if (!this.isAttached()) {\n // JSON-roundtrip value for local writes to match the behavior of going through the wire\n this.processInboundWrite(key, this.parse(serializedValue, this.serializer), 0, 0, true);\n return true;\n }\n\n const message: IRegisterOperation = {\n key,\n type: \"write\",\n serializedValue,\n refSeq: this.runtime.deltaManager.lastSequenceNumber,\n };\n\n return this.newAckBasedPromise<boolean>((resolve) => {\n // Send the resolve function as the localOpMetadata. This will be provided back to us when the\n // op is ack'd.\n this.submitLocalMessage(message, resolve);\n // If we fail due to runtime being disposed, it's better to return false then unhandled exception.\n }).catch((error) => false);\n }\n\n /**\n * Returns the most recent local value of a register.\n * @param key - The key to read\n * @param readPolicy - The ReadPolicy to apply. Defaults to Atomic.\n */\n public read(key: string, readPolicy: ReadPolicy = ReadPolicy.Atomic): T | undefined {\n if (readPolicy === ReadPolicy.Atomic) {\n return this.readAtomic(key);\n }\n\n const versions = this.readVersions(key);\n\n if (versions !== undefined) {\n // We don't support deletion. So there should be at least one value.\n assert(versions.length > 0, 0x06c /* \"Value should be undefined or non-empty\" */);\n\n return versions[versions.length - 1];\n }\n }\n\n public readVersions(key: string): T[] | undefined {\n const data = this.data.get(key);\n return data?.versions.map((element: ILocalRegister<T>) => element.value.value);\n }\n\n public keys(): string[] {\n return [...this.data.keys()];\n }\n\n protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n const dataObj: { [key: string]: ILocalData<T> } = {};\n this.data.forEach((v, k) => { dataObj[k] = v; });\n\n return createSingleBlobSummary(snapshotFileName, this.stringify(dataObj, serializer));\n }\n\n /**\n * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n */\n protected async loadCore(storage: IChannelStorageService): Promise<void> {\n const blob = await storage.readBlob(snapshotFileName);\n const header = bufferToString(blob, \"utf8\");\n const dataObj = this.parse(header, this.serializer);\n\n for (const key of Object.keys(dataObj)) {\n assert(dataObj[key].atomic?.value.type !== \"Shared\",\n // eslint-disable-next-line max-len\n 0x06d /* \"SharedObjects contained in ConsensusRegisterCollection can no longer be deserialized as of 0.17\" */);\n\n this.data.set(key, dataObj[key]);\n }\n }\n\n protected onDisconnect() {}\n\n protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n if (message.type === MessageType.Operation) {\n const op: IIncomingRegisterOperation<T> = message.contents;\n switch (op.type) {\n case \"write\": {\n // backward compatibility: File at rest written with runtime <= 0.13 do not have refSeq\n // when the refSeq property didn't exist\n if (op.refSeq === undefined) {\n op.refSeq = message.referenceSequenceNumber;\n }\n // Message can be delivered with delay - e.g. resubmitted on reconnect.\n // Use the refSeq from when the op was created, not when it was transmitted\n const refSeqWhenCreated = op.refSeq;\n assert(refSeqWhenCreated <= message.referenceSequenceNumber,\n 0x06e /* \"Message's reference sequence number < op's reference sequence number!\" */);\n\n const value = incomingOpMatchesCurrentFormat(op)\n ? this.parse(op.serializedValue, this.serializer) as T\n : op.value.value;\n const winner = this.processInboundWrite(\n op.key,\n value,\n refSeqWhenCreated,\n message.sequenceNumber,\n local);\n if (local) {\n // Resolve the pending promise for this operation now that we have received an ack for it.\n const resolve = localOpMetadata as PendingResolve;\n resolve(winner);\n }\n break;\n }\n default: unreachableCase(op.type);\n }\n }\n }\n\n private readAtomic(key: string): T | undefined {\n const data = this.data.get(key);\n return data?.atomic.value.value;\n }\n\n /**\n * Process an inbound write op\n * @param key - Key that was written to\n * @param value - Incoming value\n * @param refSeq - RefSeq at the time of write on the remote client\n * @param sequenceNumber - Sequence Number of this write op\n * @param local - Did this write originate on this client\n */\n private processInboundWrite(\n key: string,\n value: T,\n refSeq: number,\n sequenceNumber: number,\n local: boolean,\n ): boolean {\n let data = this.data.get(key);\n // Atomic update if it's a new register or the write was not concurrent,\n // meaning our state was known to the remote client at the time of write\n const winner = data === undefined || refSeq >= data.atomic.sequenceNumber;\n if (winner) {\n const atomicUpdate = newLocalRegister<T>(\n sequenceNumber,\n value,\n );\n if (data === undefined) {\n data = {\n atomic: atomicUpdate,\n versions: [], // we'll update versions next, leave it empty for now\n };\n this.data.set(key, data);\n } else {\n data.atomic = atomicUpdate;\n }\n }\n else {\n assert(!!data, 0x06f /* \"data missing for non-atomic inbound update!\" */);\n }\n\n // Remove versions that were known to the remote client at the time of write\n while (data.versions.length > 0 && refSeq >= data.versions[0].sequenceNumber) {\n data.versions.shift();\n }\n\n const versionUpdate = newLocalRegister<T>(\n sequenceNumber,\n value,\n );\n\n // Asserts for data integrity\n if (!this.isAttached()) {\n assert(refSeq === 0 && sequenceNumber === 0,\n 0x070 /* \"sequence numbers are expected to be 0 when unattached\" */);\n }\n else if (data.versions.length > 0) {\n assert(sequenceNumber > data.versions[data.versions.length - 1].sequenceNumber,\n 0x071 /* \"Versions should naturally be ordered by sequenceNumber\" */);\n }\n\n // Push the new element.\n data.versions.push(versionUpdate);\n\n // Raise events at the end, to avoid reentrancy issues\n if (winner) {\n this.emit(\"atomicChanged\", key, value, local);\n }\n this.emit(\"versionChanged\", key, value, local);\n\n return winner;\n }\n\n private stringify(value: any, serializer: IFluidSerializer): string {\n return serializer.stringify(value, this.handle);\n }\n\n private parse(content: string, serializer: IFluidSerializer): any {\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return serializer.parse(content);\n }\n\n protected applyStashedOp() {\n // empty implementation\n return () => { };\n }\n}\n"]}
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/register-collection";
8
- export declare const pkgVersion = "0.56.5";
8
+ export declare const pkgVersion = "0.57.0";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
@@ -8,5 +8,5 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.pkgVersion = exports.pkgName = void 0;
10
10
  exports.pkgName = "@fluidframework/register-collection";
11
- exports.pkgVersion = "0.56.5";
11
+ exports.pkgVersion = "0.57.0";
12
12
  //# sourceMappingURL=packageVersion.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,qCAAqC,CAAC;AAChD,QAAA,UAAU,GAAG,QAAQ,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/register-collection\";\nexport const pkgVersion = \"0.56.5\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,qCAAqC,CAAC;AAChD,QAAA,UAAU,GAAG,QAAQ,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/register-collection\";\nexport const pkgVersion = \"0.57.0\";\n"]}
@@ -52,7 +52,6 @@ export declare class ConsensusRegisterCollection<T> extends SharedObject<IConsen
52
52
  * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
53
53
  */
54
54
  protected loadCore(storage: IChannelStorageService): Promise<void>;
55
- protected registerCore(): void;
56
55
  protected onDisconnect(): void;
57
56
  protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
58
57
  private readAtomic;
@@ -1 +1 @@
1
- {"version":3,"file":"consensusRegisterCollection.d.ts","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACzB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAA2B,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAC7G,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,4BAA4B,EAAE,UAAU,EAAE,kCAAkC,EAAE,MAAM,cAAc,CAAC;AAoE5G;;GAEG;AACH,qBAAa,2BAA2B,CAAC,CAAC,CACtC,SAAQ,YAAY,CAAC,kCAAkC,CAAE,YAAW,4BAA4B,CAAC,CAAC,CAAC;IACnG;;;;;;OAMG;WAEW,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIpE;;;;OAIG;WACW,UAAU;IAIxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoC;IAEzD;;;OAGG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAKlC;;;;;OAKG;IACU,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB3D;;;;OAIG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,GAAE,UAA8B,GAAG,CAAC,GAAG,SAAS;IAe5E,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,SAAS;IAK1C,IAAI,IAAI,MAAM,EAAE;IAIvB,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAO5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcxE,SAAS,CAAC,YAAY;IAEtB,SAAS,CAAC,YAAY;IAEtB,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAqClG,OAAO,CAAC,UAAU;IAKlB;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IA8D3B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,KAAK;IAKb,SAAS,CAAC,cAAc;CAI3B"}
1
+ {"version":3,"file":"consensusRegisterCollection.d.ts","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACzB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAA2B,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAC7G,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAE,4BAA4B,EAAE,UAAU,EAAE,kCAAkC,EAAE,MAAM,cAAc,CAAC;AAoE5G;;GAEG;AACH,qBAAa,2BAA2B,CAAC,CAAC,CACtC,SAAQ,YAAY,CAAC,kCAAkC,CAAE,YAAW,4BAA4B,CAAC,CAAC,CAAC;IACnG;;;;;;OAMG;WAEW,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIpE;;;;OAIG;WACW,UAAU;IAIxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoC;IAEzD;;;OAGG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAKlC;;;;;OAKG;IACU,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB3D;;;;OAIG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,GAAE,UAA8B,GAAG,CAAC,GAAG,SAAS;IAe5E,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,SAAS;IAK1C,IAAI,IAAI,MAAM,EAAE;IAIvB,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAO5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcxE,SAAS,CAAC,YAAY;IAEtB,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAqClG,OAAO,CAAC,UAAU;IAKlB;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IA8D3B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,KAAK;IAKb,SAAS,CAAC,cAAc;CAI3B"}
@@ -117,7 +117,6 @@ export class ConsensusRegisterCollection extends SharedObject {
117
117
  this.data.set(key, dataObj[key]);
118
118
  }
119
119
  }
120
- registerCore() { }
121
120
  onDisconnect() { }
122
121
  processCore(message, local, localOpMetadata) {
123
122
  if (message.type === MessageType.Operation) {
@@ -1 +1 @@
1
- {"version":3,"file":"consensusRegisterCollection.js","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACvF,OAAO,EAA6B,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAO9F,OAAO,EAAE,uBAAuB,EAAoB,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAC7G,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAgC,UAAU,EAAsC,MAAM,cAAc,CAAC;AAqB5G,MAAM,gBAAgB,GAAG,CAAI,cAAsB,EAAE,KAAQ,EAAqB,EAAE,CAAC,CAAC;IAClF,cAAc;IACd,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK;KACR;CACJ,CAAC,CAAC;AAiCH,0EAA0E;AAC1E,MAAM,8BAA8B,GAAG,CAAC,EAAE,EAA4B,EAAE,CAAC,iBAAiB,IAAI,EAAE,CAAC;AAKjG,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAM,OAAO,2BACT,SAAQ,YAAgD;IAwBxD;;;OAGG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAXlB,SAAI,GAAG,IAAI,GAAG,EAAyB,CAAC;IAYzD,CAAC;IAjCD;;;;;;OAMG;IACH,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAI,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,kCAAkC,CAAC,IAAI,CAAmC,CAAC;IAChH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,kCAAkC,EAAE,CAAC;IACpD,CAAC;IAgBD;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,KAAQ;QACpC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,wFAAwF;YACxF,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACxF,OAAO,IAAI,CAAC;SACf;QAED,MAAM,OAAO,GAAuB;YAChC,GAAG;YACH,IAAI,EAAE,OAAO;YACb,eAAe;YACf,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB;SACvD,CAAC;QAEF,OAAO,IAAI,CAAC,kBAAkB,CAAU,CAAC,OAAO,EAAE,EAAE;YAChD,8FAA8F;YAC9F,eAAe;YACf,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1C,kGAAkG;QACtG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,GAAW,EAAE,aAAyB,UAAU,CAAC,MAAM;QAC/D,IAAI,UAAU,KAAK,UAAU,CAAC,MAAM,EAAE;YAClC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC/B;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,oEAAoE;YACpE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAElF,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACxC;IACL,CAAC;IAEM,YAAY,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAA0B,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE;IACnF,CAAC;IAEM,IAAI;QACP,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAES,aAAa,CAAC,UAA4B;QAChD,MAAM,OAAO,GAAqC,EAAE,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjD,OAAO,uBAAuB,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;;QACpD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACpC,MAAM,CAAC,OAAA,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,0CAAE,KAAK,CAAC,IAAI,MAAK,QAAQ;YAC/C,mCAAmC;YACnC,KAAK,CAAC,uGAAuG,CAAC,CAAC;YAEnH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACpC;IACL,CAAC;IAES,YAAY,KAAK,CAAC;IAElB,YAAY,KAAI,CAAC;IAEjB,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE;YACxC,MAAM,EAAE,GAAkC,OAAO,CAAC,QAAQ,CAAC;YAC3D,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,OAAO,CAAC,CAAC;oBACV,uFAAuF;oBACvF,wCAAwC;oBACxC,IAAI,EAAE,CAAC,MAAM,KAAK,SAAS,EAAE;wBACzB,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;qBAC/C;oBACD,uEAAuE;oBACvE,2EAA2E;oBAC3E,MAAM,iBAAiB,GAAG,EAAE,CAAC,MAAM,CAAC;oBACpC,MAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,uBAAuB,EACvD,KAAK,CAAC,6EAA6E,CAAC,CAAC;oBAEzF,MAAM,KAAK,GAAG,8BAA8B,CAAC,EAAE,CAAC;wBAC5C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAM;wBACtD,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;oBACrB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CACnC,EAAE,CAAC,GAAG,EACN,KAAK,EACL,iBAAiB,EACjB,OAAO,CAAC,cAAc,EACtB,KAAK,CAAC,CAAC;oBACX,IAAI,KAAK,EAAE;wBACP,0FAA0F;wBAC1F,MAAM,OAAO,GAAG,eAAiC,CAAC;wBAClD,OAAO,CAAC,MAAM,CAAC,CAAC;qBACnB;oBACD,MAAM;iBACT;gBACD,OAAO,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAEO,UAAU,CAAC,GAAW;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB,CACvB,GAAW,EACX,KAAQ,EACR,MAAc,EACd,cAAsB,EACtB,KAAc;QAEd,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,wEAAwE;QACxE,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAI,KAAK,SAAS,IAAI,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAC1E,IAAI,MAAM,EAAE;YACR,MAAM,YAAY,GAAG,gBAAgB,CACjC,cAAc,EACd,KAAK,CACR,CAAC;YACF,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpB,IAAI,GAAG;oBACH,MAAM,EAAE,YAAY;oBACpB,QAAQ,EAAE,EAAE;iBACf,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aAC5B;iBAAM;gBACH,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;aAC9B;SACJ;aACI;YACD,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,mDAAmD,CAAC,CAAC;SAC7E;QAED,4EAA4E;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;YAC1E,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SACzB;QAED,MAAM,aAAa,GAAG,gBAAgB,CAClC,cAAc,EACd,KAAK,CACR,CAAC;QAEF,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,EACvC,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAC5E;aACI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,EAC1E,KAAK,CAAC,8DAA8D,CAAC,CAAC;SAC7E;QAED,wBAAwB;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAElC,sDAAsD;QACtD,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;SACjD;QACD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAE/C,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,SAAS,CAAC,KAAU,EAAE,UAA4B;QACtD,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,OAAe,EAAE,UAA4B;QACvD,+DAA+D;QAC/D,OAAO,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAES,cAAc;QACpB,uBAAuB;QACvB,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC;IACrB,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, bufferToString, unreachableCase } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n IChannelAttributes,\n IFluidDataStoreRuntime,\n IChannelStorageService,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { createSingleBlobSummary, IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { ConsensusRegisterCollectionFactory } from \"./consensusRegisterCollectionFactory\";\nimport { IConsensusRegisterCollection, ReadPolicy, IConsensusRegisterCollectionEvents } from \"./interfaces\";\n\ninterface ILocalData<T> {\n // Atomic version\n atomic: ILocalRegister<T>;\n\n // All concurrent versions awaiting consensus\n versions: ILocalRegister<T>[];\n}\n\ninterface ILocalRegister<T> {\n // Register value, wrapped for backwards compatibility with < 0.17\n value: {\n type: \"Plain\",\n value: T,\n };\n\n // The sequence number when last consensus was reached\n sequenceNumber: number;\n}\n\nconst newLocalRegister = <T>(sequenceNumber: number, value: T): ILocalRegister<T> => ({\n sequenceNumber,\n value: {\n type: \"Plain\",\n value,\n },\n});\n\n/**\n * An operation for consensus register collection\n */\ninterface IRegisterOperation {\n key: string;\n type: \"write\";\n serializedValue: string;\n\n // Message can be delivered with delay - resubmitted on reconnect.\n // As such, refSeq needs to reference seq # at the time op was created,\n // not when op was actually sent over wire (ISequencedDocumentMessage.referenceSequenceNumber),\n // as client can ingest ops in between.\n refSeq: number | undefined;\n}\n\n/**\n * IRegisterOperation format in versions < 0.17\n */\ninterface IRegisterOperationOld<T> {\n key: string;\n type: \"write\";\n value: {\n type: \"Plain\",\n value: T,\n };\n refSeq: number;\n}\n\n/** Incoming ops could match any of these types */\ntype IIncomingRegisterOperation<T> = IRegisterOperation | IRegisterOperationOld<T>;\n\n/** Distinguish between incoming op formats so we know which type it is */\nconst incomingOpMatchesCurrentFormat = (op): op is IRegisterOperation => \"serializedValue\" in op;\n\n/** The type of the resolve function to call after the local operation is ack'd */\ntype PendingResolve = (winner: boolean) => void;\n\nconst snapshotFileName = \"header\";\n\n/**\n * Implementation of a consensus register collection\n */\nexport class ConsensusRegisterCollection<T>\n extends SharedObject<IConsensusRegisterCollectionEvents> implements IConsensusRegisterCollection<T> {\n /**\n * Create a new consensus register collection\n *\n * @param runtime - data store runtime the new consensus register collection belongs to\n * @param id - optional name of the consensus register collection\n * @returns newly create consensus register collection (but not attached yet)\n */\n // eslint-disable-next-line @typescript-eslint/no-shadow\n public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {\n return runtime.createChannel(id, ConsensusRegisterCollectionFactory.Type) as ConsensusRegisterCollection<T>;\n }\n\n /**\n * Get a factory for ConsensusRegisterCollection to register with the data store.\n *\n * @returns a factory that creates and load ConsensusRegisterCollection\n */\n public static getFactory() {\n return new ConsensusRegisterCollectionFactory();\n }\n\n private readonly data = new Map<string, ILocalData<T>>();\n\n /**\n * Constructs a new consensus register collection. If the object is non-local an id and service interfaces will\n * be provided\n */\n public constructor(\n id: string,\n runtime: IFluidDataStoreRuntime,\n attributes: IChannelAttributes,\n ) {\n super(id, runtime, attributes);\n }\n\n /**\n * Creates a new register or writes a new value.\n * Returns a promise that will resolve when the write is acked.\n *\n * @returns Promise<true> if write was non-concurrent\n */\n public async write(key: string, value: T): Promise<boolean> {\n const serializedValue = this.stringify(value, this.serializer);\n\n if (!this.isAttached()) {\n // JSON-roundtrip value for local writes to match the behavior of going through the wire\n this.processInboundWrite(key, this.parse(serializedValue, this.serializer), 0, 0, true);\n return true;\n }\n\n const message: IRegisterOperation = {\n key,\n type: \"write\",\n serializedValue,\n refSeq: this.runtime.deltaManager.lastSequenceNumber,\n };\n\n return this.newAckBasedPromise<boolean>((resolve) => {\n // Send the resolve function as the localOpMetadata. This will be provided back to us when the\n // op is ack'd.\n this.submitLocalMessage(message, resolve);\n // If we fail due to runtime being disposed, it's better to return false then unhandled exception.\n }).catch((error) => false);\n }\n\n /**\n * Returns the most recent local value of a register.\n * @param key - The key to read\n * @param readPolicy - The ReadPolicy to apply. Defaults to Atomic.\n */\n public read(key: string, readPolicy: ReadPolicy = ReadPolicy.Atomic): T | undefined {\n if (readPolicy === ReadPolicy.Atomic) {\n return this.readAtomic(key);\n }\n\n const versions = this.readVersions(key);\n\n if (versions !== undefined) {\n // We don't support deletion. So there should be at least one value.\n assert(versions.length > 0, 0x06c /* \"Value should be undefined or non-empty\" */);\n\n return versions[versions.length - 1];\n }\n }\n\n public readVersions(key: string): T[] | undefined {\n const data = this.data.get(key);\n return data?.versions.map((element: ILocalRegister<T>) => element.value.value);\n }\n\n public keys(): string[] {\n return [...this.data.keys()];\n }\n\n protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n const dataObj: { [key: string]: ILocalData<T> } = {};\n this.data.forEach((v, k) => { dataObj[k] = v; });\n\n return createSingleBlobSummary(snapshotFileName, this.stringify(dataObj, serializer));\n }\n\n /**\n * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n */\n protected async loadCore(storage: IChannelStorageService): Promise<void> {\n const blob = await storage.readBlob(snapshotFileName);\n const header = bufferToString(blob, \"utf8\");\n const dataObj = this.parse(header, this.serializer);\n\n for (const key of Object.keys(dataObj)) {\n assert(dataObj[key].atomic?.value.type !== \"Shared\",\n // eslint-disable-next-line max-len\n 0x06d /* \"SharedObjects contained in ConsensusRegisterCollection can no longer be deserialized as of 0.17\" */);\n\n this.data.set(key, dataObj[key]);\n }\n }\n\n protected registerCore() { }\n\n protected onDisconnect() {}\n\n protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n if (message.type === MessageType.Operation) {\n const op: IIncomingRegisterOperation<T> = message.contents;\n switch (op.type) {\n case \"write\": {\n // backward compatibility: File at rest written with runtime <= 0.13 do not have refSeq\n // when the refSeq property didn't exist\n if (op.refSeq === undefined) {\n op.refSeq = message.referenceSequenceNumber;\n }\n // Message can be delivered with delay - e.g. resubmitted on reconnect.\n // Use the refSeq from when the op was created, not when it was transmitted\n const refSeqWhenCreated = op.refSeq;\n assert(refSeqWhenCreated <= message.referenceSequenceNumber,\n 0x06e /* \"Message's reference sequence number < op's reference sequence number!\" */);\n\n const value = incomingOpMatchesCurrentFormat(op)\n ? this.parse(op.serializedValue, this.serializer) as T\n : op.value.value;\n const winner = this.processInboundWrite(\n op.key,\n value,\n refSeqWhenCreated,\n message.sequenceNumber,\n local);\n if (local) {\n // Resolve the pending promise for this operation now that we have received an ack for it.\n const resolve = localOpMetadata as PendingResolve;\n resolve(winner);\n }\n break;\n }\n default: unreachableCase(op.type);\n }\n }\n }\n\n private readAtomic(key: string): T | undefined {\n const data = this.data.get(key);\n return data?.atomic.value.value;\n }\n\n /**\n * Process an inbound write op\n * @param key - Key that was written to\n * @param value - Incoming value\n * @param refSeq - RefSeq at the time of write on the remote client\n * @param sequenceNumber - Sequence Number of this write op\n * @param local - Did this write originate on this client\n */\n private processInboundWrite(\n key: string,\n value: T,\n refSeq: number,\n sequenceNumber: number,\n local: boolean,\n ): boolean {\n let data = this.data.get(key);\n // Atomic update if it's a new register or the write was not concurrent,\n // meaning our state was known to the remote client at the time of write\n const winner = data === undefined || refSeq >= data.atomic.sequenceNumber;\n if (winner) {\n const atomicUpdate = newLocalRegister<T>(\n sequenceNumber,\n value,\n );\n if (data === undefined) {\n data = {\n atomic: atomicUpdate,\n versions: [], // we'll update versions next, leave it empty for now\n };\n this.data.set(key, data);\n } else {\n data.atomic = atomicUpdate;\n }\n }\n else {\n assert(!!data, 0x06f /* \"data missing for non-atomic inbound update!\" */);\n }\n\n // Remove versions that were known to the remote client at the time of write\n while (data.versions.length > 0 && refSeq >= data.versions[0].sequenceNumber) {\n data.versions.shift();\n }\n\n const versionUpdate = newLocalRegister<T>(\n sequenceNumber,\n value,\n );\n\n // Asserts for data integrity\n if (!this.isAttached()) {\n assert(refSeq === 0 && sequenceNumber === 0,\n 0x070 /* \"sequence numbers are expected to be 0 when unattached\" */);\n }\n else if (data.versions.length > 0) {\n assert(sequenceNumber > data.versions[data.versions.length - 1].sequenceNumber,\n 0x071 /* \"Versions should naturally be ordered by sequenceNumber\" */);\n }\n\n // Push the new element.\n data.versions.push(versionUpdate);\n\n // Raise events at the end, to avoid reentrancy issues\n if (winner) {\n this.emit(\"atomicChanged\", key, value, local);\n }\n this.emit(\"versionChanged\", key, value, local);\n\n return winner;\n }\n\n private stringify(value: any, serializer: IFluidSerializer): string {\n return serializer.stringify(value, this.handle);\n }\n\n private parse(content: string, serializer: IFluidSerializer): any {\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return serializer.parse(content);\n }\n\n protected applyStashedOp() {\n // empty implementation\n return () => { };\n }\n}\n"]}
1
+ {"version":3,"file":"consensusRegisterCollection.js","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACvF,OAAO,EAA6B,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAO9F,OAAO,EAAE,uBAAuB,EAAoB,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAC7G,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,EAAgC,UAAU,EAAsC,MAAM,cAAc,CAAC;AAqB5G,MAAM,gBAAgB,GAAG,CAAI,cAAsB,EAAE,KAAQ,EAAqB,EAAE,CAAC,CAAC;IAClF,cAAc;IACd,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK;KACR;CACJ,CAAC,CAAC;AAiCH,0EAA0E;AAC1E,MAAM,8BAA8B,GAAG,CAAC,EAAE,EAA4B,EAAE,CAAC,iBAAiB,IAAI,EAAE,CAAC;AAKjG,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAM,OAAO,2BACT,SAAQ,YAAgD;IAwBxD;;;OAGG;IACH,YACI,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAXlB,SAAI,GAAG,IAAI,GAAG,EAAyB,CAAC;IAYzD,CAAC;IAjCD;;;;;;OAMG;IACH,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAI,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,kCAAkC,CAAC,IAAI,CAAmC,CAAC;IAChH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,kCAAkC,EAAE,CAAC;IACpD,CAAC;IAgBD;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,KAAQ;QACpC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,wFAAwF;YACxF,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACxF,OAAO,IAAI,CAAC;SACf;QAED,MAAM,OAAO,GAAuB;YAChC,GAAG;YACH,IAAI,EAAE,OAAO;YACb,eAAe;YACf,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB;SACvD,CAAC;QAEF,OAAO,IAAI,CAAC,kBAAkB,CAAU,CAAC,OAAO,EAAE,EAAE;YAChD,8FAA8F;YAC9F,eAAe;YACf,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1C,kGAAkG;QACtG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,GAAW,EAAE,aAAyB,UAAU,CAAC,MAAM;QAC/D,IAAI,UAAU,KAAK,UAAU,CAAC,MAAM,EAAE;YAClC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC/B;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,oEAAoE;YACpE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YAElF,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACxC;IACL,CAAC;IAEM,YAAY,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAA0B,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE;IACnF,CAAC;IAEM,IAAI;QACP,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAES,aAAa,CAAC,UAA4B;QAChD,MAAM,OAAO,GAAqC,EAAE,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjD,OAAO,uBAAuB,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;;QACpD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACpC,MAAM,CAAC,OAAA,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,0CAAE,KAAK,CAAC,IAAI,MAAK,QAAQ;YAC/C,mCAAmC;YACnC,KAAK,CAAC,uGAAuG,CAAC,CAAC;YAEnH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACpC;IACL,CAAC;IAES,YAAY,KAAI,CAAC;IAEjB,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE;YACxC,MAAM,EAAE,GAAkC,OAAO,CAAC,QAAQ,CAAC;YAC3D,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,OAAO,CAAC,CAAC;oBACV,uFAAuF;oBACvF,wCAAwC;oBACxC,IAAI,EAAE,CAAC,MAAM,KAAK,SAAS,EAAE;wBACzB,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;qBAC/C;oBACD,uEAAuE;oBACvE,2EAA2E;oBAC3E,MAAM,iBAAiB,GAAG,EAAE,CAAC,MAAM,CAAC;oBACpC,MAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,uBAAuB,EACvD,KAAK,CAAC,6EAA6E,CAAC,CAAC;oBAEzF,MAAM,KAAK,GAAG,8BAA8B,CAAC,EAAE,CAAC;wBAC5C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAM;wBACtD,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;oBACrB,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CACnC,EAAE,CAAC,GAAG,EACN,KAAK,EACL,iBAAiB,EACjB,OAAO,CAAC,cAAc,EACtB,KAAK,CAAC,CAAC;oBACX,IAAI,KAAK,EAAE;wBACP,0FAA0F;wBAC1F,MAAM,OAAO,GAAG,eAAiC,CAAC;wBAClD,OAAO,CAAC,MAAM,CAAC,CAAC;qBACnB;oBACD,MAAM;iBACT;gBACD,OAAO,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAEO,UAAU,CAAC,GAAW;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB,CACvB,GAAW,EACX,KAAQ,EACR,MAAc,EACd,cAAsB,EACtB,KAAc;QAEd,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,wEAAwE;QACxE,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAI,KAAK,SAAS,IAAI,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;QAC1E,IAAI,MAAM,EAAE;YACR,MAAM,YAAY,GAAG,gBAAgB,CACjC,cAAc,EACd,KAAK,CACR,CAAC;YACF,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpB,IAAI,GAAG;oBACH,MAAM,EAAE,YAAY;oBACpB,QAAQ,EAAE,EAAE;iBACf,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aAC5B;iBAAM;gBACH,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;aAC9B;SACJ;aACI;YACD,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,mDAAmD,CAAC,CAAC;SAC7E;QAED,4EAA4E;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;YAC1E,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SACzB;QAED,MAAM,aAAa,GAAG,gBAAgB,CAClC,cAAc,EACd,KAAK,CACR,CAAC;QAEF,6BAA6B;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACpB,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,EACvC,KAAK,CAAC,6DAA6D,CAAC,CAAC;SAC5E;aACI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,EAC1E,KAAK,CAAC,8DAA8D,CAAC,CAAC;SAC7E;QAED,wBAAwB;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAElC,sDAAsD;QACtD,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;SACjD;QACD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAE/C,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,SAAS,CAAC,KAAU,EAAE,UAA4B;QACtD,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,OAAe,EAAE,UAA4B;QACvD,+DAA+D;QAC/D,OAAO,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAES,cAAc;QACpB,uBAAuB;QACvB,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC;IACrB,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, bufferToString, unreachableCase } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n IChannelAttributes,\n IFluidDataStoreRuntime,\n IChannelStorageService,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { createSingleBlobSummary, IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { ConsensusRegisterCollectionFactory } from \"./consensusRegisterCollectionFactory\";\nimport { IConsensusRegisterCollection, ReadPolicy, IConsensusRegisterCollectionEvents } from \"./interfaces\";\n\ninterface ILocalData<T> {\n // Atomic version\n atomic: ILocalRegister<T>;\n\n // All concurrent versions awaiting consensus\n versions: ILocalRegister<T>[];\n}\n\ninterface ILocalRegister<T> {\n // Register value, wrapped for backwards compatibility with < 0.17\n value: {\n type: \"Plain\",\n value: T,\n };\n\n // The sequence number when last consensus was reached\n sequenceNumber: number;\n}\n\nconst newLocalRegister = <T>(sequenceNumber: number, value: T): ILocalRegister<T> => ({\n sequenceNumber,\n value: {\n type: \"Plain\",\n value,\n },\n});\n\n/**\n * An operation for consensus register collection\n */\ninterface IRegisterOperation {\n key: string;\n type: \"write\";\n serializedValue: string;\n\n // Message can be delivered with delay - resubmitted on reconnect.\n // As such, refSeq needs to reference seq # at the time op was created,\n // not when op was actually sent over wire (ISequencedDocumentMessage.referenceSequenceNumber),\n // as client can ingest ops in between.\n refSeq: number | undefined;\n}\n\n/**\n * IRegisterOperation format in versions < 0.17\n */\ninterface IRegisterOperationOld<T> {\n key: string;\n type: \"write\";\n value: {\n type: \"Plain\",\n value: T,\n };\n refSeq: number;\n}\n\n/** Incoming ops could match any of these types */\ntype IIncomingRegisterOperation<T> = IRegisterOperation | IRegisterOperationOld<T>;\n\n/** Distinguish between incoming op formats so we know which type it is */\nconst incomingOpMatchesCurrentFormat = (op): op is IRegisterOperation => \"serializedValue\" in op;\n\n/** The type of the resolve function to call after the local operation is ack'd */\ntype PendingResolve = (winner: boolean) => void;\n\nconst snapshotFileName = \"header\";\n\n/**\n * Implementation of a consensus register collection\n */\nexport class ConsensusRegisterCollection<T>\n extends SharedObject<IConsensusRegisterCollectionEvents> implements IConsensusRegisterCollection<T> {\n /**\n * Create a new consensus register collection\n *\n * @param runtime - data store runtime the new consensus register collection belongs to\n * @param id - optional name of the consensus register collection\n * @returns newly create consensus register collection (but not attached yet)\n */\n // eslint-disable-next-line @typescript-eslint/no-shadow\n public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {\n return runtime.createChannel(id, ConsensusRegisterCollectionFactory.Type) as ConsensusRegisterCollection<T>;\n }\n\n /**\n * Get a factory for ConsensusRegisterCollection to register with the data store.\n *\n * @returns a factory that creates and load ConsensusRegisterCollection\n */\n public static getFactory() {\n return new ConsensusRegisterCollectionFactory();\n }\n\n private readonly data = new Map<string, ILocalData<T>>();\n\n /**\n * Constructs a new consensus register collection. If the object is non-local an id and service interfaces will\n * be provided\n */\n public constructor(\n id: string,\n runtime: IFluidDataStoreRuntime,\n attributes: IChannelAttributes,\n ) {\n super(id, runtime, attributes);\n }\n\n /**\n * Creates a new register or writes a new value.\n * Returns a promise that will resolve when the write is acked.\n *\n * @returns Promise<true> if write was non-concurrent\n */\n public async write(key: string, value: T): Promise<boolean> {\n const serializedValue = this.stringify(value, this.serializer);\n\n if (!this.isAttached()) {\n // JSON-roundtrip value for local writes to match the behavior of going through the wire\n this.processInboundWrite(key, this.parse(serializedValue, this.serializer), 0, 0, true);\n return true;\n }\n\n const message: IRegisterOperation = {\n key,\n type: \"write\",\n serializedValue,\n refSeq: this.runtime.deltaManager.lastSequenceNumber,\n };\n\n return this.newAckBasedPromise<boolean>((resolve) => {\n // Send the resolve function as the localOpMetadata. This will be provided back to us when the\n // op is ack'd.\n this.submitLocalMessage(message, resolve);\n // If we fail due to runtime being disposed, it's better to return false then unhandled exception.\n }).catch((error) => false);\n }\n\n /**\n * Returns the most recent local value of a register.\n * @param key - The key to read\n * @param readPolicy - The ReadPolicy to apply. Defaults to Atomic.\n */\n public read(key: string, readPolicy: ReadPolicy = ReadPolicy.Atomic): T | undefined {\n if (readPolicy === ReadPolicy.Atomic) {\n return this.readAtomic(key);\n }\n\n const versions = this.readVersions(key);\n\n if (versions !== undefined) {\n // We don't support deletion. So there should be at least one value.\n assert(versions.length > 0, 0x06c /* \"Value should be undefined or non-empty\" */);\n\n return versions[versions.length - 1];\n }\n }\n\n public readVersions(key: string): T[] | undefined {\n const data = this.data.get(key);\n return data?.versions.map((element: ILocalRegister<T>) => element.value.value);\n }\n\n public keys(): string[] {\n return [...this.data.keys()];\n }\n\n protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n const dataObj: { [key: string]: ILocalData<T> } = {};\n this.data.forEach((v, k) => { dataObj[k] = v; });\n\n return createSingleBlobSummary(snapshotFileName, this.stringify(dataObj, serializer));\n }\n\n /**\n * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n */\n protected async loadCore(storage: IChannelStorageService): Promise<void> {\n const blob = await storage.readBlob(snapshotFileName);\n const header = bufferToString(blob, \"utf8\");\n const dataObj = this.parse(header, this.serializer);\n\n for (const key of Object.keys(dataObj)) {\n assert(dataObj[key].atomic?.value.type !== \"Shared\",\n // eslint-disable-next-line max-len\n 0x06d /* \"SharedObjects contained in ConsensusRegisterCollection can no longer be deserialized as of 0.17\" */);\n\n this.data.set(key, dataObj[key]);\n }\n }\n\n protected onDisconnect() {}\n\n protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n if (message.type === MessageType.Operation) {\n const op: IIncomingRegisterOperation<T> = message.contents;\n switch (op.type) {\n case \"write\": {\n // backward compatibility: File at rest written with runtime <= 0.13 do not have refSeq\n // when the refSeq property didn't exist\n if (op.refSeq === undefined) {\n op.refSeq = message.referenceSequenceNumber;\n }\n // Message can be delivered with delay - e.g. resubmitted on reconnect.\n // Use the refSeq from when the op was created, not when it was transmitted\n const refSeqWhenCreated = op.refSeq;\n assert(refSeqWhenCreated <= message.referenceSequenceNumber,\n 0x06e /* \"Message's reference sequence number < op's reference sequence number!\" */);\n\n const value = incomingOpMatchesCurrentFormat(op)\n ? this.parse(op.serializedValue, this.serializer) as T\n : op.value.value;\n const winner = this.processInboundWrite(\n op.key,\n value,\n refSeqWhenCreated,\n message.sequenceNumber,\n local);\n if (local) {\n // Resolve the pending promise for this operation now that we have received an ack for it.\n const resolve = localOpMetadata as PendingResolve;\n resolve(winner);\n }\n break;\n }\n default: unreachableCase(op.type);\n }\n }\n }\n\n private readAtomic(key: string): T | undefined {\n const data = this.data.get(key);\n return data?.atomic.value.value;\n }\n\n /**\n * Process an inbound write op\n * @param key - Key that was written to\n * @param value - Incoming value\n * @param refSeq - RefSeq at the time of write on the remote client\n * @param sequenceNumber - Sequence Number of this write op\n * @param local - Did this write originate on this client\n */\n private processInboundWrite(\n key: string,\n value: T,\n refSeq: number,\n sequenceNumber: number,\n local: boolean,\n ): boolean {\n let data = this.data.get(key);\n // Atomic update if it's a new register or the write was not concurrent,\n // meaning our state was known to the remote client at the time of write\n const winner = data === undefined || refSeq >= data.atomic.sequenceNumber;\n if (winner) {\n const atomicUpdate = newLocalRegister<T>(\n sequenceNumber,\n value,\n );\n if (data === undefined) {\n data = {\n atomic: atomicUpdate,\n versions: [], // we'll update versions next, leave it empty for now\n };\n this.data.set(key, data);\n } else {\n data.atomic = atomicUpdate;\n }\n }\n else {\n assert(!!data, 0x06f /* \"data missing for non-atomic inbound update!\" */);\n }\n\n // Remove versions that were known to the remote client at the time of write\n while (data.versions.length > 0 && refSeq >= data.versions[0].sequenceNumber) {\n data.versions.shift();\n }\n\n const versionUpdate = newLocalRegister<T>(\n sequenceNumber,\n value,\n );\n\n // Asserts for data integrity\n if (!this.isAttached()) {\n assert(refSeq === 0 && sequenceNumber === 0,\n 0x070 /* \"sequence numbers are expected to be 0 when unattached\" */);\n }\n else if (data.versions.length > 0) {\n assert(sequenceNumber > data.versions[data.versions.length - 1].sequenceNumber,\n 0x071 /* \"Versions should naturally be ordered by sequenceNumber\" */);\n }\n\n // Push the new element.\n data.versions.push(versionUpdate);\n\n // Raise events at the end, to avoid reentrancy issues\n if (winner) {\n this.emit(\"atomicChanged\", key, value, local);\n }\n this.emit(\"versionChanged\", key, value, local);\n\n return winner;\n }\n\n private stringify(value: any, serializer: IFluidSerializer): string {\n return serializer.stringify(value, this.handle);\n }\n\n private parse(content: string, serializer: IFluidSerializer): any {\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return serializer.parse(content);\n }\n\n protected applyStashedOp() {\n // empty implementation\n return () => { };\n }\n}\n"]}
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/register-collection";
8
- export declare const pkgVersion = "0.56.5";
8
+ export declare const pkgVersion = "0.57.0";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export const pkgName = "@fluidframework/register-collection";
8
- export const pkgVersion = "0.56.5";
8
+ export const pkgVersion = "0.57.0";
9
9
  //# sourceMappingURL=packageVersion.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,qCAAqC,CAAC;AAC7D,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,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/register-collection\";\nexport const pkgVersion = \"0.56.5\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,qCAAqC,CAAC;AAC7D,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,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/register-collection\";\nexport const pkgVersion = \"0.57.0\";\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/register-collection",
3
- "version": "0.56.5",
3
+ "version": "0.57.0",
4
4
  "description": "Consensus Register",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": "https://github.com/microsoft/FluidFramework",
@@ -57,18 +57,18 @@
57
57
  "dependencies": {
58
58
  "@fluidframework/common-utils": "^0.32.1",
59
59
  "@fluidframework/core-interfaces": "^0.42.0",
60
- "@fluidframework/datastore-definitions": "^0.56.5",
60
+ "@fluidframework/datastore-definitions": "^0.57.0",
61
61
  "@fluidframework/protocol-base": "^0.1034.0",
62
62
  "@fluidframework/protocol-definitions": "^0.1026.0",
63
- "@fluidframework/runtime-definitions": "^0.56.5",
64
- "@fluidframework/shared-object-base": "^0.56.5"
63
+ "@fluidframework/runtime-definitions": "^0.57.0",
64
+ "@fluidframework/shared-object-base": "^0.57.0"
65
65
  },
66
66
  "devDependencies": {
67
- "@fluid-internal/test-dds-utils": "^0.56.5",
67
+ "@fluid-internal/test-dds-utils": "^0.57.0",
68
68
  "@fluidframework/build-common": "^0.23.0",
69
- "@fluidframework/eslint-config-fluid": "^0.25.0",
70
- "@fluidframework/mocha-test-setup": "^0.56.5",
71
- "@fluidframework/test-runtime-utils": "^0.56.5",
69
+ "@fluidframework/eslint-config-fluid": "^0.26.0",
70
+ "@fluidframework/mocha-test-setup": "^0.57.0",
71
+ "@fluidframework/test-runtime-utils": "^0.57.0",
72
72
  "@microsoft/api-extractor": "^7.16.1",
73
73
  "@rushstack/eslint-config": "^2.5.1",
74
74
  "@types/mocha": "^8.2.2",
@@ -204,8 +204,6 @@ export class ConsensusRegisterCollection<T>
204
204
  }
205
205
  }
206
206
 
207
- protected registerCore() { }
208
-
209
207
  protected onDisconnect() {}
210
208
 
211
209
  protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/register-collection";
9
- export const pkgVersion = "0.56.5";
9
+ export const pkgVersion = "0.57.0";