@fluidframework/container-loader 2.93.0 → 2.101.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.
Files changed (118) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/api-report/container-loader.legacy.alpha.api.md +13 -1
  3. package/dist/captureReferencedContents.d.ts +154 -0
  4. package/dist/captureReferencedContents.d.ts.map +1 -0
  5. package/dist/captureReferencedContents.js +349 -0
  6. package/dist/captureReferencedContents.js.map +1 -0
  7. package/dist/connectionManager.d.ts +2 -1
  8. package/dist/connectionManager.d.ts.map +1 -1
  9. package/dist/connectionManager.js +39 -8
  10. package/dist/connectionManager.js.map +1 -1
  11. package/dist/connectionStateHandler.d.ts.map +1 -1
  12. package/dist/connectionStateHandler.js +3 -1
  13. package/dist/connectionStateHandler.js.map +1 -1
  14. package/dist/container.d.ts.map +1 -1
  15. package/dist/container.js +13 -4
  16. package/dist/container.js.map +1 -1
  17. package/dist/containerStorageAdapter.d.ts +20 -2
  18. package/dist/containerStorageAdapter.d.ts.map +1 -1
  19. package/dist/containerStorageAdapter.js +2 -2
  20. package/dist/containerStorageAdapter.js.map +1 -1
  21. package/dist/createAndLoadContainerUtils.d.ts +95 -0
  22. package/dist/createAndLoadContainerUtils.d.ts.map +1 -1
  23. package/dist/createAndLoadContainerUtils.js +137 -11
  24. package/dist/createAndLoadContainerUtils.js.map +1 -1
  25. package/dist/frozenServices.d.ts +113 -30
  26. package/dist/frozenServices.d.ts.map +1 -1
  27. package/dist/frozenServices.js +236 -58
  28. package/dist/frozenServices.js.map +1 -1
  29. package/dist/index.d.ts +2 -1
  30. package/dist/index.d.ts.map +1 -1
  31. package/dist/index.js +5 -1
  32. package/dist/index.js.map +1 -1
  33. package/dist/legacyAlpha.d.ts +2 -0
  34. package/dist/loader.d.ts +1 -1
  35. package/dist/loader.d.ts.map +1 -1
  36. package/dist/loader.js +1 -1
  37. package/dist/loader.js.map +1 -1
  38. package/dist/loaderLayerCompatState.d.ts +1 -1
  39. package/dist/packageVersion.d.ts +1 -1
  40. package/dist/packageVersion.d.ts.map +1 -1
  41. package/dist/packageVersion.js +1 -1
  42. package/dist/packageVersion.js.map +1 -1
  43. package/dist/pendingLocalStateStore.d.ts.map +1 -1
  44. package/dist/pendingLocalStateStore.js +9 -3
  45. package/dist/pendingLocalStateStore.js.map +1 -1
  46. package/dist/retriableDocumentStorageService.d.ts +2 -1
  47. package/dist/retriableDocumentStorageService.d.ts.map +1 -1
  48. package/dist/retriableDocumentStorageService.js +3 -2
  49. package/dist/retriableDocumentStorageService.js.map +1 -1
  50. package/dist/serializedStateManager.d.ts +16 -1
  51. package/dist/serializedStateManager.d.ts.map +1 -1
  52. package/dist/serializedStateManager.js +11 -1
  53. package/dist/serializedStateManager.js.map +1 -1
  54. package/lib/captureReferencedContents.d.ts +154 -0
  55. package/lib/captureReferencedContents.d.ts.map +1 -0
  56. package/lib/captureReferencedContents.js +338 -0
  57. package/lib/captureReferencedContents.js.map +1 -0
  58. package/lib/connectionManager.d.ts +2 -1
  59. package/lib/connectionManager.d.ts.map +1 -1
  60. package/lib/connectionManager.js +40 -9
  61. package/lib/connectionManager.js.map +1 -1
  62. package/lib/connectionStateHandler.d.ts.map +1 -1
  63. package/lib/connectionStateHandler.js +3 -1
  64. package/lib/connectionStateHandler.js.map +1 -1
  65. package/lib/container.d.ts.map +1 -1
  66. package/lib/container.js +14 -5
  67. package/lib/container.js.map +1 -1
  68. package/lib/containerStorageAdapter.d.ts +20 -2
  69. package/lib/containerStorageAdapter.d.ts.map +1 -1
  70. package/lib/containerStorageAdapter.js +2 -2
  71. package/lib/containerStorageAdapter.js.map +1 -1
  72. package/lib/createAndLoadContainerUtils.d.ts +95 -0
  73. package/lib/createAndLoadContainerUtils.d.ts.map +1 -1
  74. package/lib/createAndLoadContainerUtils.js +128 -3
  75. package/lib/createAndLoadContainerUtils.js.map +1 -1
  76. package/lib/frozenServices.d.ts +113 -30
  77. package/lib/frozenServices.d.ts.map +1 -1
  78. package/lib/frozenServices.js +233 -57
  79. package/lib/frozenServices.js.map +1 -1
  80. package/lib/index.d.ts +2 -1
  81. package/lib/index.d.ts.map +1 -1
  82. package/lib/index.js +2 -1
  83. package/lib/index.js.map +1 -1
  84. package/lib/legacyAlpha.d.ts +2 -0
  85. package/lib/loader.d.ts +1 -1
  86. package/lib/loader.d.ts.map +1 -1
  87. package/lib/loader.js +2 -2
  88. package/lib/loader.js.map +1 -1
  89. package/lib/loaderLayerCompatState.d.ts +1 -1
  90. package/lib/packageVersion.d.ts +1 -1
  91. package/lib/packageVersion.d.ts.map +1 -1
  92. package/lib/packageVersion.js +1 -1
  93. package/lib/packageVersion.js.map +1 -1
  94. package/lib/pendingLocalStateStore.d.ts.map +1 -1
  95. package/lib/pendingLocalStateStore.js +9 -3
  96. package/lib/pendingLocalStateStore.js.map +1 -1
  97. package/lib/retriableDocumentStorageService.d.ts +2 -1
  98. package/lib/retriableDocumentStorageService.d.ts.map +1 -1
  99. package/lib/retriableDocumentStorageService.js +3 -2
  100. package/lib/retriableDocumentStorageService.js.map +1 -1
  101. package/lib/serializedStateManager.d.ts +16 -1
  102. package/lib/serializedStateManager.d.ts.map +1 -1
  103. package/lib/serializedStateManager.js +11 -1
  104. package/lib/serializedStateManager.js.map +1 -1
  105. package/package.json +13 -13
  106. package/src/captureReferencedContents.ts +446 -0
  107. package/src/connectionManager.ts +47 -8
  108. package/src/connectionStateHandler.ts +14 -9
  109. package/src/container.ts +18 -4
  110. package/src/containerStorageAdapter.ts +22 -2
  111. package/src/createAndLoadContainerUtils.ts +229 -2
  112. package/src/frozenServices.ts +285 -64
  113. package/src/index.ts +7 -0
  114. package/src/loader.ts +4 -2
  115. package/src/packageVersion.ts +1 -1
  116. package/src/pendingLocalStateStore.ts +8 -1
  117. package/src/retriableDocumentStorageService.ts +11 -4
  118. package/src/serializedStateManager.ts +28 -1
@@ -1 +1 @@
1
- {"version":3,"file":"serializedStateManager.js","sourceRoot":"","sources":["../src/serializedStateManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAQ9D,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EACN,WAAW,GAQX,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC/F,OAAO,EAEN,gBAAgB,EAChB,UAAU,EACV,4BAA4B,GAC5B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,uBAAuB,GAGvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EACN,mCAAmC,EACnC,6BAA6B,EAC7B,qBAAqB,GACrB,MAAM,YAAY,CAAC;AAyGpB;;;;;;GAMG;AACH,MAAM,OAAO,sBAAsB;IASlC;;;;;;OAMG;IACH,YACC,SAA+B,EACd,cAA6D,EAC7D,kBAA2B,EAC5C,cAAgD,EAC/B,cAA6B,EAC7B,qBAAoC,EACrD,wBAAiC;QALhB,mBAAc,GAAd,cAAc,CAA+C;QAC7D,uBAAkB,GAAlB,kBAAkB,CAAS;QAE3B,mBAAc,GAAd,cAAc,CAAe;QAC7B,0BAAqB,GAArB,qBAAqB,CAAe;QArBrC,iBAAY,GAAgC,EAAE,CAAC;QAIxD,8BAAyB,GAAW,CAAC,CAAC;QAE9C,2CAAqB,KAAK,EAAC;QAkB1B,IAAI,CAAC,EAAE,GAAG,4BAA4B,CAAC;YACtC,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,wBAAwB;SACnC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,kBAAkB;YAC/C,CAAC,CAAC,IAAI,iBAAiB,CACrB,SAAS,EACT,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,qBAAqB,EAC1B,CAAC,QAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,EACnE,wBAAwB,CACxB;YACF,CAAC,CAAC,SAAS,CAAC;QAEb,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC,CAAC;IAC7E,CAAC;IACD,IAAW,QAAQ;QAClB,OAAO,uBAAA,IAAI,wCAAU,CAAC;IACvB,CAAC;IACD,OAAO;QACN,uBAAA,IAAI,oCAAa,IAAI,MAAA,CAAC;QACtB,IAAI,CAAC,iBAAiB,EAAE,OAAO,EAAE,CAAC;IACnC,CAAC;IAEO,iBAAiB;QACxB,IAAI,uBAAA,IAAI,wCAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAC/D,CAAC;IACF,CAAC;IAED;;;;OAIG;IACH,IAAW,gBAAgB;QAC1B,OAAO,IAAI,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,OAAkC;QACvD,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,CAAC,kCAAkC,EAAE,CAAC;QAC3C,CAAC;IACF,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,aAAa,CACzB,gBAAoC,EACpC,iBAAqD;QAMrD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,WAAW,CAC9C,IAAI,CAAC,EAAE,EACP,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,qBAAqB,EAAE,EAC5B,gBAAgB,CAChB,CAAC;YACF,MAAM,gBAAgB,GAA8B,eAAe,CAAC,QAAQ,CAAC,CAAC;YAC9E,MAAM,UAAU,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;YACtF,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC7B,IAAI,CAAC,iBAAiB,EAAE,UAAU,EAAE,CAAC;gBACrC,IAAI,CAAC,YAAY,GAAG;oBACnB,QAAQ;oBACR,sBAAsB,EAAE,UAAU,CAAC,cAAc;iBACjD,CAAC;YACH,CAAC;YACD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;QAC1C,CAAC;aAAM,CAAC;YACP,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,iBAAiB,CAAC;YACpE,MAAM,YAAY,GAAG,IAAI,GAAG,EAAuB,CAAC;YACpD,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBACzD,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;YACrD,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;YACrD,MAAM,UAAU,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAElF,MAAM,QAAQ,GAAc;gBAC3B,cAAc,EAAE,UAAU,CAAC,cAAc;gBACzC,YAAY,EAAE,YAAY;gBAC1B,YAAY;gBACZ,oBAAoB,EAAE,SAAS;gBAC/B,GAAG,EAAE,EAAE;gBACP,eAAe,EAAE,CAAC;aAClB,CAAC;YAEF,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC7B,oEAAoE;gBACpE,sEAAsE;gBACtE,+DAA+D;gBAC/D,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzB,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC;oBACrC,IAAI,CAAC,yBAAyB,GAAG,QAAQ,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC;gBAC5E,CAAC;gBAED,IAAI,CAAC,YAAY,GAAG;oBACnB,QAAQ;oBACR,sBAAsB,EAAE,UAAU,CAAC,cAAc;iBACjD,CAAC;gBACF,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;YAC9C,CAAC;YACD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;QACrD,CAAC;IACF,CAAC;IAED;;;;OAIG;IACK,uBAAuB,CAAC,cAA6B;QAC5D,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,OAAO,IAAI,CAAC,kCAAkC,EAAE,CAAC;IAClD,CAAC;IAED;;OAEG;IACK,kCAAkC;QACzC,MAAM,sBAAsB,GAAG,IAAI,CAAC,cAAc,EAAE,sBAAsB,CAAC;QAC3E,IACC,uBAAA,IAAI,wCAAU;YACd,sBAAsB,KAAK,SAAS;YACpC,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC;YAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc;gBAC7D,IAAI,CAAC,yBAAyB;YAC/B,IAAI,CAAC,cAAc,EAAE,EACpB,CAAC;YACF,0EAA0E;YAC1E,qDAAqD;YACrD,OAAO,CAAC,CAAC,CAAC;QACX,CAAC;QACD,MAAM,8BAA8B,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;QAC3E,MAAM,6BAA6B,GAClC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC;QAEhE,IAAI,sBAAsB,GAAG,8BAA8B,EAAE,CAAC;YAC7D,4FAA4F;YAC5F,qGAAqG;YACrG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBACjC,SAAS,EAAE,iCAAiC;gBAC5C,sBAAsB;gBACtB,8BAA8B;gBAC9B,6BAA6B;gBAC7B,6BAA6B,EAAE,IAAI,CAAC,YAAY,EAAE,sBAAsB;aACxE,CAAC,CAAC;YACH,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;YAC9C,IAAI,CAAC,iBAAiB,EAAE,YAAY,EAAE,CAAC;QACxC,CAAC;aAAM,IAAI,sBAAsB,IAAI,6BAA6B,EAAE,CAAC;YACpE,+DAA+D;YAC/D,uDAAuD;YACvD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,sBAAsB,GAAG,8BAA8B,GAAG,CAAC,CAAC,CAAC;YACzF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;YAC9C,IAAI,CAAC,iBAAiB,EAAE,YAAY,EAAE,CAAC;YACvC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBACjC,SAAS,EAAE,mBAAmB;gBAC9B,sBAAsB;gBACtB,8BAA8B;gBAC9B,iCAAiC,EAChC,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc;aACjF,CAAC,CAAC;QACJ,CAAC;QACD,OAAO,sBAAsB,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,QAAmB;QAC5C,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,IAAI,CAAC,YAAY,GAAG;gBACnB,QAAQ;gBACR,sBAAsB,EAAE,QAAQ,CAAC,cAAc,IAAI,CAAC;gBACpD,mBAAmB,EAAE,IAAI,CAAC,GAAG,EAAE;aAC/B,CAAC;YACF,IAAI,CAAC,iBAAiB,EAAE,UAAU,EAAE,CAAC;QACtC,CAAC;IACF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAChC,QAA4B,EAC5B,OAA+C,EAC/C,WAAyB;QAEzB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9B,MAAM,IAAI,UAAU,CAAC,8DAA8D,CAAC,CAAC;QACtF,CAAC;QAED,OAAO,gBAAgB,CAAC,cAAc,CACrC,IAAI,CAAC,EAAE,CAAC,MAAM,EACd;YACC,SAAS,EAAE,sBAAsB;YACjC,OAAO,EAAE;gBACR,qBAAqB,EAAE,KAAK;gBAC5B,yBAAyB,EAAE,SAAS;gBACpC,sBAAsB,EAAE,SAAS;gBACjC,gBAAgB,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM;aAC1C;YACD,QAAQ;SACR,EACD,KAAK,IAAI,EAAE;YACV,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAClE,MAAM,mBAAmB,GAAG,MAAM,OAAO,CAAC,oBAAoB,CAAC;gBAC9D,qBAAqB,EAAE,KAAK;gBAC5B,sBAAsB,EAAE,IAAI,CAAC,YAAY,CAAC,sBAAsB;gBAChE,yBAAyB,EAAE,IAAI,CAAC,YAAY,CAAC,mBAAmB;aAChE,CAAC,CAAC;YACH,qFAAqF;YACrF,MAAM,sBAAsB,GAA2C,EAAE,CAAC;YAC1E,IAAI,mBAAmB,GAAG,KAAK,CAAC;YAChC,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;YACpF,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACjC,KAAK,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,gBAAgB,EAAE,CAAC;oBACpD,mBAAmB,GAAG,IAAI,CAAC;oBAC3B,sBAAsB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAAC;gBAC3E,CAAC;YACF,CAAC;YAED,MAAM,iBAAiB,GAAsB,qBAAqB,CACjE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAC1B;gBACA,CAAC,CAAC,mCAAmC,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;gBACjE,CAAC,CAAC,MAAM,sCAAsC,CAC5C,IAAI,CAAC,YAAY,CAAC,QAAQ,EAC1B,IAAI,CAAC,cAAc,CACnB,CAAC;YAEJ,MAAM,YAAY,GAA2B;gBAC5C,QAAQ,EAAE,IAAI;gBACd,mBAAmB;gBACnB,GAAG,iBAAiB;gBACpB,sBAAsB,EAAE,mBAAmB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS;gBAChF,QAAQ,EAAE,IAAI,CAAC,YAAY;gBAC3B,GAAG,EAAE,WAAW,CAAC,GAAG;gBACpB,QAAQ;aACR,CAAC;YAEF,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACrC,CAAC,CACD,CAAC;IACH,CAAC;CACD;;AAED,KAAK,UAAU,sCAAsC,CACpD,QAAuB,EACvB,cAA6D;IAE7D,MAAM,aAAa,GAAG,MAAM,uBAAuB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IAC9E,OAAO;QACN,YAAY,EAAE,QAAQ;QACtB,aAAa;KACb,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAC1C,EAAqB,EACrB,cAA6D,EAC7D,qBAA8B;IAE9B,OAAO,gBAAgB,CAAC,cAAc,CACrC,EAAE,CAAC,MAAM,EACT,EAAE,SAAS,EAAE,uBAAuB,EAAE,EACtC,KAAK,EAAE,KAAK,EAAE,EAAE;QACf,IAAI,CAAC;YACJ,6CAA6C;YAC7C,MAAM,gBAAgB,GAAe,MAAM,cAAc,CAAC,WAAW;YACpE,2CAA2C;YAC3C,IAAI,EACJ,CAAC,EACD,uBAAuB,EACvB,WAAW,CAAC,OAAO,CACnB,CAAC;YACF,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,MAAM,WAAW,CACnD,EAAE,EACF,cAAc,EACd,qBAAqB,EACrB,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAAE,CACvB,CAAC;YAEF,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,qBAAqB,CAAC,YAAY,CAAC;gBAC3E,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC;YAE7D,MAAM,sBAAsB,GAC3B,cAAc;gBACd,CAAC,MAAM,qBAAqB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,IAAI,CAC9D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CACvB,CAAC,CAAC;YACJ,OAAO;gBACN,QAAQ,EAAE,YAAY;gBACtB,sBAAsB;gBACtB,mBAAmB,EAAE,IAAI,CAAC,GAAG,EAAE;aAC/B,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,SAAS,CAAC;IAClB,CAAC,CACD,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,WAAW,CACzB,EAAqB,EACrB,cAGC,EACD,qBAA8B,EAC9B,gBAAoC;IAEpC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,qBAAqB;QAClD,CAAC,CAAC,MAAM,cAAc,CAAC,EAAE,EAAE,cAAc,EAAE,gBAAgB,CAAC;QAC5D,CAAC,CAAC,MAAM,kBAAkB,CAAC,EAAE,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC;IAClE,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAClE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CACnC,EAAqB,EACrB,cAA4D,EAC5D,gBAAoC;IAEpC,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,WAAW,EAAE,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACrF,MAAM,OAAO,GACZ,QAAQ,EAAE,YAAY,CAAC,EAAE,KAAK,SAAS;QACtC,CAAC,CAAC,SAAS;QACX,CAAC,CAAC;YACA,EAAE,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE;YAC5B,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE;SAChC,CAAC;IAEL,IAAI,QAAQ,KAAK,SAAS,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAC9D,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;YACxB,SAAS,EAAE,uBAAuB;YAClC,EAAE,EAAE,gBAAgB;SACpB,CAAC,CAAC;IACJ,CAAC;SAAM,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,EAAE,EAAE,KAAK,SAAS,EAAE,CAAC;QAChE,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;YACxB,SAAS,EAAE,wCAAwC;YACnD,UAAU,EAAE,OAAO,KAAK,SAAS,EAAE,mFAAmF;SACtH,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACvC,EAAqB,EACrB,cAAgF,EAChF,gBAAoC;IAEpC,gBAAgB;IAChB,2CAA2C;IAC3C,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,gBAAgB,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;IAC/E,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE5B,IAAI,OAAO,KAAK,SAAS,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAC7D,+EAA+E;QAC/E,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;YACxB,SAAS,EAAE,6BAA6B;YACxC,EAAE,EAAE,gBAAgB;SACpB,CAAC,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,CAAC,MAAM,cAAc,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,IAAI,SAAS,CAAC;IAE9E,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACrD,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;SAAM,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,EAAE,EAAE,KAAK,SAAS,EAAE,CAAC;QAChE,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;YACxB,SAAS,EAAE,wCAAwC;YACnD,UAAU,EAAE,OAAO,KAAK,SAAS,EAAE,mFAAmF;SACtH,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { stringToBuffer } from \"@fluid-internal/client-utils\";\nimport type { IRuntime } from \"@fluidframework/container-definitions/internal\";\nimport type {\n\tIEventProvider,\n\tIEvent,\n\tITelemetryBaseLogger,\n} from \"@fluidframework/core-interfaces\";\nimport type { IDisposable } from \"@fluidframework/core-interfaces/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\tFetchSource,\n\ttype IDocumentStorageService,\n\ttype IResolvedUrl,\n\ttype ISnapshot,\n\ttype IDocumentAttributes,\n\ttype ISnapshotTree,\n\ttype IVersion,\n\ttype ISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\nimport { getSnapshotTree, isInstanceOfISnapshot } from \"@fluidframework/driver-utils/internal\";\nimport {\n\ttype MonitoringContext,\n\tPerformanceEvent,\n\tUsageError,\n\tcreateChildMonitoringContext,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\tgetBlobContentsFromTree,\n\ttype ContainerStorageAdapter,\n\ttype ISerializableBlobContents,\n} from \"./containerStorageAdapter.js\";\nimport { SnapshotRefresher } from \"./snapshotRefresher.js\";\nimport {\n\tconvertISnapshotToSnapshotWithBlobs,\n\tconvertSnapshotToSnapshotInfo,\n\tgetDocumentAttributes,\n} from \"./utils.js\";\n\n/**\n * This is very similar to {@link @fluidframework/protocol-definitions/internal#ISnapshot}, but the difference is\n * that the blobs of ISnapshot are of type ArrayBufferLike, while the blobs of this interface are serializable because\n * they are already converted to string.\n */\nexport interface SnapshotWithBlobs {\n\t/**\n\t * Snapshot from which container initially loaded.\n\t */\n\tbaseSnapshot: ISnapshotTree;\n\t/**\n\t * Serializable blobs from the base snapshot. Used to load offline since\n\t * storage is not available.\n\t */\n\tsnapshotBlobs: ISerializableBlobContents;\n}\n\n/**\n * State saved by a container at close time, to be used to load a new instance\n * of the container to the same state\n *\n * This is very similar to {@link @fluidframework/protocol-definitions/internal#ISnapshot}, but the difference is\n * that the blobs of ISnapshot are of type ArrayBufferLike, while the blobs of this interface are serializable because\n * they are already converted to string.\n *\n * @internal\n */\nexport interface IPendingContainerState extends SnapshotWithBlobs {\n\t/**\n\t * This container was attached (as opposed to IPendingDetachedContainerState.attached which is false)\n\t */\n\tattached: true;\n\t/**\n\t * Runtime-specific state that will be needed to properly rehydrate\n\t * (it's included in ContainerContext passed to instantiateRuntime)\n\t */\n\tpendingRuntimeState: unknown;\n\t/**\n\t * Any group snapshots (aka delay-loaded) we've downloaded from the service for this container\n\t */\n\tloadedGroupIdSnapshots?: Record<string, SerializedSnapshotInfo>;\n\t/**\n\t * All ops since base snapshot sequence number up to the latest op\n\t * seen when the container was closed. Used to apply stashed (saved pending)\n\t * ops at the same sequence number at which they were made.\n\t */\n\tsavedOps: ISequencedDocumentMessage[];\n\t/**\n\t * The Container's URL in the service, needed to hook up the driver during rehydration\n\t */\n\turl: string;\n\t/**\n\t * If the Container was connected when serialized, its clientId. Used as the initial clientId upon rehydration, until reconnected.\n\t */\n\tclientId?: string;\n}\n\n/**\n * State saved by a container in detached state, to be used to load a new instance\n * of the container to the same state (rehydrate)\n * @internal\n */\nexport interface IPendingDetachedContainerState extends SnapshotWithBlobs {\n\t/**\n\t * This container was not attached (as opposed to IPendingContainerState.attached which is true)\n\t */\n\tattached: false;\n\t/**\n\t * Indicates whether we expect the rehydrated container to have non-empty Detached Blob Storage\n\t */\n\thasAttachmentBlobs: boolean;\n\t/**\n\t * Used by the memory blob storage to persisted attachment blobs\n\t */\n\tattachmentBlobs?: string;\n\t/**\n\t * Runtime-specific state that will be needed to properly rehydrate\n\t * (it's included in ContainerContext passed to instantiateRuntime)\n\t */\n\tpendingRuntimeState?: unknown;\n}\n\nexport interface SerializedSnapshotInfo extends SnapshotWithBlobs {\n\tsnapshotSequenceNumber: number;\n}\n\nexport interface ISnapshotInfo {\n\tsnapshotSequenceNumber: number;\n\tsnapshotFetchedTime?: number | undefined;\n\tsnapshot: ISnapshot | ISnapshotTree;\n}\n\nexport type ISerializedStateManagerDocumentStorageService = Pick<\n\tContainerStorageAdapter,\n\t\"getSnapshot\" | \"getSnapshotTree\" | \"getVersions\" | \"readBlob\" | \"cacheSnapshotBlobs\"\n> & {\n\tloadedGroupIdSnapshots: Record<string, ISnapshot>;\n};\n\ninterface ISerializerEvent extends IEvent {\n\t(event: \"saved\", listener: (dirty: boolean) => void): void;\n}\n\n/**\n * Helper class to manage the state of the container needed for proper serialization.\n *\n * It holds the pendingLocalState the container was rehydrated from (if any),\n * as well as the snapshot to be used for serialization.\n * It also keeps track of container dirty state and which local ops have been processed\n */\nexport class SerializedStateManager implements IDisposable {\n\tprivate readonly processedOps: ISequencedDocumentMessage[] = [];\n\tprivate readonly mc: MonitoringContext;\n\tprivate snapshotInfo: ISnapshotInfo | undefined;\n\tprivate latestSnapshot: ISnapshotInfo | undefined;\n\tprivate lastSavedOpSequenceNumber: number = 0;\n\tprivate readonly snapshotRefresher: SnapshotRefresher | undefined;\n\t#disposed: boolean = false;\n\n\t/**\n\t * @param subLogger - Container's logger to use as parent for our logger\n\t * @param storageAdapter - Storage adapter for fetching snapshots\n\t * @param offlineLoadEnabled - Is serializing/rehydrating containers allowed?\n\t * @param containerEvent - Source of the \"saved\" event when the container has all its pending state uploaded\n\t * @param containerDirty - Is the container \"dirty\"? That's the opposite of \"saved\" - there is pending state that may not have been received yet by the service.\n\t */\n\tconstructor(\n\t\tsubLogger: ITelemetryBaseLogger,\n\t\tprivate readonly storageAdapter: ISerializedStateManagerDocumentStorageService,\n\t\tprivate readonly offlineLoadEnabled: boolean,\n\t\tcontainerEvent: IEventProvider<ISerializerEvent>,\n\t\tprivate readonly containerDirty: () => boolean,\n\t\tprivate readonly supportGetSnapshotApi: () => boolean,\n\t\tsnapshotRefreshTimeoutMs?: number,\n\t) {\n\t\tthis.mc = createChildMonitoringContext({\n\t\t\tlogger: subLogger,\n\t\t\tnamespace: \"serializedStateManager\",\n\t\t});\n\n\t\tthis.snapshotRefresher = this.offlineLoadEnabled\n\t\t\t? new SnapshotRefresher(\n\t\t\t\t\tsubLogger,\n\t\t\t\t\tthis.storageAdapter,\n\t\t\t\t\tthis.offlineLoadEnabled,\n\t\t\t\t\tthis.supportGetSnapshotApi,\n\t\t\t\t\t(snapshot: ISnapshotInfo) => this.handleSnapshotRefreshed(snapshot),\n\t\t\t\t\tsnapshotRefreshTimeoutMs,\n\t\t\t\t)\n\t\t\t: undefined;\n\n\t\tcontainerEvent.on(\"saved\", () => this.updateSnapshotAndProcessedOpsMaybe());\n\t}\n\tpublic get disposed(): boolean {\n\t\treturn this.#disposed;\n\t}\n\tdispose(): void {\n\t\tthis.#disposed = true;\n\t\tthis.snapshotRefresher?.dispose();\n\t}\n\n\tprivate verifyNotDisposed(): void {\n\t\tif (this.#disposed) {\n\t\t\tthrow new Error(\"SerializedStateManager used after dispose.\");\n\t\t}\n\t}\n\n\t/**\n\t * Promise that will resolve (or reject) once we've tried to download the latest snapshot(s) from storage\n\t * only intended to be used for testing purposes.\n\t * @returns The snapshot sequence number associated with the latest fetched snapshot\n\t */\n\tpublic get refreshSnapshotP(): Promise<number> | undefined {\n\t\treturn this.snapshotRefresher?.refreshSnapshotP;\n\t}\n\n\t/**\n\t * Called whenever an incoming op is processed by the Container\n\t */\n\tpublic addProcessedOp(message: ISequencedDocumentMessage): void {\n\t\tif (this.offlineLoadEnabled) {\n\t\t\tthis.processedOps.push(message);\n\t\t\tthis.updateSnapshotAndProcessedOpsMaybe();\n\t\t}\n\t}\n\n\t/**\n\t * This wraps the basic functionality of fetching the snapshot for this container during Container load.\n\t *\n\t * If we have pendingLocalState, we get the snapshot from there.\n\t * Otherwise, fetch it from storage (according to specifiedVersion if provided).\n\t *\n\t * @param specifiedVersion - If a version is specified and we don't have pendingLocalState, fetch this version from storage.\n\t * @param pendingLocalState - The pendingLocalState being rehydrated, if any (undefined when loading directly from storage)\n\t * @returns The snapshot to boot the container from\n\t */\n\tpublic async fetchSnapshot(\n\t\tspecifiedVersion: string | undefined,\n\t\tpendingLocalState: IPendingContainerState | undefined,\n\t): Promise<{\n\t\tsnapshot: ISnapshot | ISnapshotTree;\n\t\tversion: IVersion | undefined;\n\t\tattributes: IDocumentAttributes;\n\t}> {\n\t\tthis.verifyNotDisposed();\n\t\tif (pendingLocalState === undefined) {\n\t\t\tconst { snapshot, version } = await getSnapshot(\n\t\t\t\tthis.mc,\n\t\t\t\tthis.storageAdapter,\n\t\t\t\tthis.supportGetSnapshotApi(),\n\t\t\t\tspecifiedVersion,\n\t\t\t);\n\t\t\tconst baseSnapshotTree: ISnapshotTree | undefined = getSnapshotTree(snapshot);\n\t\t\tconst attributes = await getDocumentAttributes(this.storageAdapter, baseSnapshotTree);\n\t\t\tif (this.offlineLoadEnabled) {\n\t\t\t\tthis.snapshotRefresher?.startTimer();\n\t\t\t\tthis.snapshotInfo = {\n\t\t\t\t\tsnapshot,\n\t\t\t\t\tsnapshotSequenceNumber: attributes.sequenceNumber,\n\t\t\t\t};\n\t\t\t}\n\t\t\treturn { snapshot, version, attributes };\n\t\t} else {\n\t\t\tconst { baseSnapshot, snapshotBlobs, savedOps } = pendingLocalState;\n\t\t\tconst blobContents = new Map<string, ArrayBuffer>();\n\t\t\tfor (const [id, value] of Object.entries(snapshotBlobs)) {\n\t\t\t\tblobContents.set(id, stringToBuffer(value, \"utf8\"));\n\t\t\t}\n\t\t\tthis.storageAdapter.cacheSnapshotBlobs(blobContents);\n\t\t\tconst attributes = await getDocumentAttributes(this.storageAdapter, baseSnapshot);\n\n\t\t\tconst snapshot: ISnapshot = {\n\t\t\t\tsequenceNumber: attributes.sequenceNumber,\n\t\t\t\tsnapshotTree: baseSnapshot,\n\t\t\t\tblobContents,\n\t\t\t\tlatestSequenceNumber: undefined,\n\t\t\t\tops: [],\n\t\t\t\tsnapshotFormatV: 1,\n\t\t\t};\n\n\t\t\tif (this.offlineLoadEnabled) {\n\t\t\t\t// special case handle. Obtaining the last saved op seq num to avoid\n\t\t\t\t// refreshing the snapshot before we have processed it. It could cause\n\t\t\t\t// a subsequent stashing to have a newer snapshot than allowed.\n\t\t\t\tif (savedOps.length > 0) {\n\t\t\t\t\tconst savedOpsSize = savedOps.length;\n\t\t\t\t\tthis.lastSavedOpSequenceNumber = savedOps[savedOpsSize - 1].sequenceNumber;\n\t\t\t\t}\n\n\t\t\t\tthis.snapshotInfo = {\n\t\t\t\t\tsnapshot,\n\t\t\t\t\tsnapshotSequenceNumber: attributes.sequenceNumber,\n\t\t\t\t};\n\t\t\t\tthis.snapshotRefresher?.tryRefreshSnapshot();\n\t\t\t}\n\t\t\treturn { snapshot, version: undefined, attributes };\n\t\t}\n\t}\n\n\t/**\n\t * Handles the snapshotRefreshed event from SnapshotRefresher.\n\t * Decides whether to accept the new snapshot based on processed ops.\n\t * @returns The snapshot sequence number if updated, -1 otherwise\n\t */\n\tprivate handleSnapshotRefreshed(latestSnapshot: ISnapshotInfo): number {\n\t\tthis.latestSnapshot = latestSnapshot;\n\t\treturn this.updateSnapshotAndProcessedOpsMaybe();\n\t}\n\n\t/**\n\t * Updates class snapshot and processedOps if we have a new snapshot and it's among processedOps range.\n\t */\n\tprivate updateSnapshotAndProcessedOpsMaybe(): number {\n\t\tconst snapshotSequenceNumber = this.latestSnapshot?.snapshotSequenceNumber;\n\t\tif (\n\t\t\tthis.#disposed ||\n\t\t\tsnapshotSequenceNumber === undefined ||\n\t\t\tthis.processedOps.length === 0 ||\n\t\t\tthis.processedOps[this.processedOps.length - 1].sequenceNumber <\n\t\t\t\tthis.lastSavedOpSequenceNumber ||\n\t\t\tthis.containerDirty()\n\t\t) {\n\t\t\t// can't refresh latest snapshot until we have processed the ops up to it.\n\t\t\t// Pending state would be behind the latest snapshot.\n\t\t\treturn -1;\n\t\t}\n\t\tconst firstProcessedOpSequenceNumber = this.processedOps[0].sequenceNumber;\n\t\tconst lastProcessedOpSequenceNumber =\n\t\t\tthis.processedOps[this.processedOps.length - 1].sequenceNumber;\n\n\t\tif (snapshotSequenceNumber < firstProcessedOpSequenceNumber) {\n\t\t\t// Snapshot seq number is older than our first processed op, which could mean we're fetching\n\t\t\t// the same snapshot that we already have or snapshot is too old, implicating an unexpected behavior.\n\t\t\tthis.mc.logger.sendTelemetryEvent({\n\t\t\t\teventName: \"OldSnapshotFetchWhileRefreshing\",\n\t\t\t\tsnapshotSequenceNumber,\n\t\t\t\tfirstProcessedOpSequenceNumber,\n\t\t\t\tlastProcessedOpSequenceNumber,\n\t\t\t\tstashedSnapshotSequenceNumber: this.snapshotInfo?.snapshotSequenceNumber,\n\t\t\t});\n\t\t\tthis.latestSnapshot = undefined;\n\t\t\tthis.snapshotRefresher?.clearLatestSnapshot();\n\t\t\tthis.snapshotRefresher?.restartTimer();\n\t\t} else if (snapshotSequenceNumber <= lastProcessedOpSequenceNumber) {\n\t\t\t// Snapshot seq num is between the first and last processed op.\n\t\t\t// Remove the ops that are already part of the snapshot\n\t\t\tthis.processedOps.splice(0, snapshotSequenceNumber - firstProcessedOpSequenceNumber + 1);\n\t\t\tthis.snapshotInfo = this.latestSnapshot;\n\t\t\tthis.latestSnapshot = undefined;\n\t\t\tthis.snapshotRefresher?.clearLatestSnapshot();\n\t\t\tthis.snapshotRefresher?.restartTimer();\n\t\t\tthis.mc.logger.sendTelemetryEvent({\n\t\t\t\teventName: \"SnapshotRefreshed\",\n\t\t\t\tsnapshotSequenceNumber,\n\t\t\t\tfirstProcessedOpSequenceNumber,\n\t\t\t\tnewFirstProcessedOpSequenceNumber:\n\t\t\t\t\tthis.processedOps.length === 0 ? undefined : this.processedOps[0].sequenceNumber,\n\t\t\t});\n\t\t}\n\t\treturn snapshotSequenceNumber;\n\t}\n\n\t/**\n\t * When the Container attaches, we need to stash the initial snapshot (a form of the attach summary).\n\t * This method is only meant to be used by Container.attach() to set the initial\n\t * base snapshot when attaching.\n\t * @param snapshot - snapshot and blobs collected while attaching (a form of the attach summary)\n\t */\n\tpublic setInitialSnapshot(snapshot: ISnapshot): void {\n\t\tthis.verifyNotDisposed();\n\t\tif (this.offlineLoadEnabled) {\n\t\t\tthis.snapshotInfo = {\n\t\t\t\tsnapshot,\n\t\t\t\tsnapshotSequenceNumber: snapshot.sequenceNumber ?? 0,\n\t\t\t\tsnapshotFetchedTime: Date.now(),\n\t\t\t};\n\t\t\tthis.snapshotRefresher?.startTimer();\n\t\t}\n\t}\n\n\t/**\n\t * Assembles and serializes the {@link IPendingContainerState} for the container,\n\t * to be stored and used to rehydrate the container at a later time.\n\t */\n\tpublic async getPendingLocalState(\n\t\tclientId: string | undefined,\n\t\truntime: Pick<IRuntime, \"getPendingLocalState\">,\n\t\tresolvedUrl: IResolvedUrl,\n\t): Promise<string> {\n\t\tthis.verifyNotDisposed();\n\t\tif (!this.offlineLoadEnabled) {\n\t\t\tthrow new UsageError(\"Can't get pending local state unless offline load is enabled\");\n\t\t}\n\n\t\treturn PerformanceEvent.timedExecAsync(\n\t\t\tthis.mc.logger,\n\t\t\t{\n\t\t\t\teventName: \"getPendingLocalState\",\n\t\t\t\tdetails: {\n\t\t\t\t\tnotifyImminentClosure: false,\n\t\t\t\t\tsessionExpiryTimerStarted: undefined,\n\t\t\t\t\tsnapshotSequenceNumber: undefined,\n\t\t\t\t\tprocessedOpsSize: this.processedOps.length,\n\t\t\t\t},\n\t\t\t\tclientId,\n\t\t\t},\n\t\t\tasync () => {\n\t\t\t\tassert(this.snapshotInfo !== undefined, 0x8e5 /* no base data */);\n\t\t\t\tconst pendingRuntimeState = await runtime.getPendingLocalState({\n\t\t\t\t\tnotifyImminentClosure: false,\n\t\t\t\t\tsnapshotSequenceNumber: this.snapshotInfo.snapshotSequenceNumber,\n\t\t\t\t\tsessionExpiryTimerStarted: this.snapshotInfo.snapshotFetchedTime,\n\t\t\t\t});\n\t\t\t\t// This conversion is required because ArrayBufferLike doesn't survive JSON.stringify\n\t\t\t\tconst loadedGroupIdSnapshots: Record<string, SerializedSnapshotInfo> = {};\n\t\t\t\tlet hasGroupIdSnapshots = false;\n\t\t\t\tconst groupIdSnapshots = Object.entries(this.storageAdapter.loadedGroupIdSnapshots);\n\t\t\t\tif (groupIdSnapshots.length > 0) {\n\t\t\t\t\tfor (const [groupId, snapshot] of groupIdSnapshots) {\n\t\t\t\t\t\thasGroupIdSnapshots = true;\n\t\t\t\t\t\tloadedGroupIdSnapshots[groupId] = convertSnapshotToSnapshotInfo(snapshot);\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tconst snapshotWithBlobs: SnapshotWithBlobs = isInstanceOfISnapshot(\n\t\t\t\t\tthis.snapshotInfo.snapshot,\n\t\t\t\t)\n\t\t\t\t\t? convertISnapshotToSnapshotWithBlobs(this.snapshotInfo.snapshot)\n\t\t\t\t\t: await convertSnapshotTreeToSnapshotWithBlobs(\n\t\t\t\t\t\t\tthis.snapshotInfo.snapshot,\n\t\t\t\t\t\t\tthis.storageAdapter,\n\t\t\t\t\t\t);\n\n\t\t\t\tconst pendingState: IPendingContainerState = {\n\t\t\t\t\tattached: true,\n\t\t\t\t\tpendingRuntimeState,\n\t\t\t\t\t...snapshotWithBlobs,\n\t\t\t\t\tloadedGroupIdSnapshots: hasGroupIdSnapshots ? loadedGroupIdSnapshots : undefined,\n\t\t\t\t\tsavedOps: this.processedOps,\n\t\t\t\t\turl: resolvedUrl.url,\n\t\t\t\t\tclientId,\n\t\t\t\t};\n\n\t\t\t\treturn JSON.stringify(pendingState);\n\t\t\t},\n\t\t);\n\t}\n}\n\nasync function convertSnapshotTreeToSnapshotWithBlobs(\n\tsnapshot: ISnapshotTree,\n\tstorageAdapter: ISerializedStateManagerDocumentStorageService,\n): Promise<SnapshotWithBlobs> {\n\tconst snapshotBlobs = await getBlobContentsFromTree(snapshot, storageAdapter);\n\treturn {\n\t\tbaseSnapshot: snapshot,\n\t\tsnapshotBlobs,\n\t};\n}\n\n/**\n * Retrieves the most recent snapshot and returns its info.\n *\n * @param mc - The monitoring context.\n * @param storageAdapter - The storage adapter providing methods to retrieve the snapshot.\n * @param supportGetSnapshotApi - a boolean indicating whether to use the fetchISnapshot or fetchISnapshotTree.\n * @returns a SnapshotInfo object containing the snapshot tree, snapshot blobs and its sequence number.\n */\nexport async function getLatestSnapshotInfo(\n\tmc: MonitoringContext,\n\tstorageAdapter: ISerializedStateManagerDocumentStorageService,\n\tsupportGetSnapshotApi: boolean,\n): Promise<ISnapshotInfo | undefined> {\n\treturn PerformanceEvent.timedExecAsync<ISnapshotInfo | undefined>(\n\t\tmc.logger,\n\t\t{ eventName: \"GetLatestSnapshotInfo\" },\n\t\tasync (event) => {\n\t\t\ttry {\n\t\t\t\t// get the latest non cached snapshot version\n\t\t\t\tconst specifiedVersion: IVersion[] = await storageAdapter.getVersions(\n\t\t\t\t\t// eslint-disable-next-line unicorn/no-null\n\t\t\t\t\tnull,\n\t\t\t\t\t1,\n\t\t\t\t\t\"getLatestSnapshotInfo\",\n\t\t\t\t\tFetchSource.noCache,\n\t\t\t\t);\n\t\t\t\tconst { snapshot: baseSnapshot } = await getSnapshot(\n\t\t\t\t\tmc,\n\t\t\t\t\tstorageAdapter,\n\t\t\t\t\tsupportGetSnapshotApi,\n\t\t\t\t\tspecifiedVersion[0]?.id,\n\t\t\t\t);\n\n\t\t\t\tconst { sequenceNumber, snapshotTree } = isInstanceOfISnapshot(baseSnapshot)\n\t\t\t\t\t? baseSnapshot\n\t\t\t\t\t: { snapshotTree: baseSnapshot, sequenceNumber: undefined };\n\n\t\t\t\tconst snapshotSequenceNumber: number =\n\t\t\t\t\tsequenceNumber ??\n\t\t\t\t\t(await getDocumentAttributes(storageAdapter, snapshotTree).then(\n\t\t\t\t\t\t(a) => a.sequenceNumber,\n\t\t\t\t\t));\n\t\t\t\treturn {\n\t\t\t\t\tsnapshot: baseSnapshot,\n\t\t\t\t\tsnapshotSequenceNumber,\n\t\t\t\t\tsnapshotFetchedTime: Date.now(),\n\t\t\t\t};\n\t\t\t} catch (error) {\n\t\t\t\tevent.cancel(undefined, error);\n\t\t\t}\n\t\t\treturn undefined;\n\t\t},\n\t);\n}\n\n/**\n * Retrieves a snapshot from the storage adapter and transforms it into an ISnapshotTree object.\n *\n * @param mc - The monitoring context.\n * @param storageAdapter - The storage adapter providing methods to retrieve the snapshot.\n * @param supportGetSnapshotApi - a boolean indicating whether to use the fetchISnapshot or fetchISnapshotTree.\n * @param specifiedVersion - An optional version string specifying the version of the snapshot tree to fetch.\n * @returns An ISnapshotTree and its version.\n */\nasync function getSnapshot(\n\tmc: MonitoringContext,\n\tstorageAdapter: Pick<\n\t\tIDocumentStorageService,\n\t\t\"getSnapshot\" | \"getSnapshotTree\" | \"getVersions\"\n\t>,\n\tsupportGetSnapshotApi: boolean,\n\tspecifiedVersion: string | undefined,\n): Promise<{ snapshot: ISnapshot | ISnapshotTree; version?: IVersion }> {\n\tconst { snapshot, version } = supportGetSnapshotApi\n\t\t? await fetchISnapshot(mc, storageAdapter, specifiedVersion)\n\t\t: await fetchISnapshotTree(mc, storageAdapter, specifiedVersion);\n\tassert(snapshot !== undefined, 0x8e4 /* Snapshot should exist */);\n\treturn { snapshot, version };\n}\n\n/**\n * Fetches an ISnapshot from a storage adapter based on the specified version.\n *\n * @param mc - The monitoring context.\n * @param storageAdapter - The storage adapter providing a getSnapshot method to retrieve the ISnapshot and version.\n * @param specifiedVersion - An optional version string specifying the version of the snapshot tree to fetch.\n * @returns The fetched snapshot tree and its version.\n */\nexport async function fetchISnapshot(\n\tmc: MonitoringContext,\n\tstorageAdapter: Pick<IDocumentStorageService, \"getSnapshot\">,\n\tspecifiedVersion: string | undefined,\n): Promise<{ snapshot?: ISnapshot; version?: IVersion }> {\n\tconst snapshot = await storageAdapter.getSnapshot?.({ versionId: specifiedVersion });\n\tconst version: IVersion | undefined =\n\t\tsnapshot?.snapshotTree.id === undefined\n\t\t\t? undefined\n\t\t\t: {\n\t\t\t\t\tid: snapshot.snapshotTree.id,\n\t\t\t\t\ttreeId: snapshot.snapshotTree.id,\n\t\t\t\t};\n\n\tif (snapshot === undefined && specifiedVersion !== undefined) {\n\t\tmc.logger.sendErrorEvent({\n\t\t\teventName: \"getSnapshotTreeFailed\",\n\t\t\tid: specifiedVersion,\n\t\t});\n\t} else if (snapshot !== undefined && version?.id === undefined) {\n\t\tmc.logger.sendErrorEvent({\n\t\t\teventName: \"getSnapshotFetchedTreeWithoutVersionId\",\n\t\t\thasVersion: version !== undefined, // if hasVersion is true, this means that the contract with the service was broken.\n\t\t});\n\t}\n\treturn { snapshot, version };\n}\n\n/**\n * Fetches an ISnapshotTree from a storage adapter based on the specified version.\n *\n * @param mc - The monitoring context.\n * @param storageAdapter - The storage adapter providing methods to retrieve the ISnapshotTree and version.\n * @param specifiedVersion - An optional version string specifying the version of the snapshot tree to fetch.\n * @returns The fetched snapshot tree and its version.\n */\nexport async function fetchISnapshotTree(\n\tmc: MonitoringContext,\n\tstorageAdapter: Pick<IDocumentStorageService, \"getSnapshotTree\" | \"getVersions\">,\n\tspecifiedVersion: string | undefined,\n): Promise<{ snapshot?: ISnapshotTree; version?: IVersion | undefined }> {\n\t// API uses null\n\t// eslint-disable-next-line unicorn/no-null\n\tconst versions = await storageAdapter.getVersions(specifiedVersion ?? null, 1);\n\tconst version = versions[0];\n\n\tif (version === undefined && specifiedVersion !== undefined) {\n\t\t// We should have a defined version to load from if specified version requested\n\t\tmc.logger.sendErrorEvent({\n\t\t\teventName: \"NoVersionFoundWhenSpecified\",\n\t\t\tid: specifiedVersion,\n\t\t});\n\t}\n\tconst snapshot = (await storageAdapter.getSnapshotTree(version)) ?? undefined;\n\n\tif (snapshot === undefined && version !== undefined) {\n\t\tmc.logger.sendErrorEvent({ eventName: \"getSnapshotTreeFailed\", id: version.id });\n\t} else if (snapshot !== undefined && version?.id === undefined) {\n\t\tmc.logger.sendErrorEvent({\n\t\t\teventName: \"getSnapshotFetchedTreeWithoutVersionId\",\n\t\t\thasVersion: version !== undefined, // if hasVersion is true, this means that the contract with the service was broken.\n\t\t});\n\t}\n\treturn { snapshot, version };\n}\n"]}
1
+ {"version":3,"file":"serializedStateManager.js","sourceRoot":"","sources":["../src/serializedStateManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAQ9D,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EACN,WAAW,GAQX,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC/F,OAAO,EAEN,gBAAgB,EAChB,UAAU,EACV,4BAA4B,GAC5B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,uBAAuB,GAIvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EACN,mCAAmC,EACnC,6BAA6B,EAC7B,qBAAqB,GACrB,MAAM,YAAY,CAAC;AAwHpB;;;;;;GAMG;AACH,MAAM,OAAO,sBAAsB;IASlC;;;;;;OAMG;IACH,YACC,SAA+B,EACd,cAA6D,EAC7D,kBAA2B,EAC5C,cAAgD,EAC/B,cAA6B,EAC7B,qBAAoC,EACrD,wBAAiC;QALhB,mBAAc,GAAd,cAAc,CAA+C;QAC7D,uBAAkB,GAAlB,kBAAkB,CAAS;QAE3B,mBAAc,GAAd,cAAc,CAAe;QAC7B,0BAAqB,GAArB,qBAAqB,CAAe;QArBrC,iBAAY,GAAgC,EAAE,CAAC;QAIxD,8BAAyB,GAAW,CAAC,CAAC;QAE9C,2CAAqB,KAAK,EAAC;QAkB1B,IAAI,CAAC,EAAE,GAAG,4BAA4B,CAAC;YACtC,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,wBAAwB;SACnC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,kBAAkB;YAC/C,CAAC,CAAC,IAAI,iBAAiB,CACrB,SAAS,EACT,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,qBAAqB,EAC1B,CAAC,QAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,EACnE,wBAAwB,CACxB;YACF,CAAC,CAAC,SAAS,CAAC;QAEb,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC,CAAC;IAC7E,CAAC;IACD,IAAW,QAAQ;QAClB,OAAO,uBAAA,IAAI,wCAAU,CAAC;IACvB,CAAC;IACD,OAAO;QACN,uBAAA,IAAI,oCAAa,IAAI,MAAA,CAAC;QACtB,IAAI,CAAC,iBAAiB,EAAE,OAAO,EAAE,CAAC;IACnC,CAAC;IAEO,iBAAiB;QACxB,IAAI,uBAAA,IAAI,wCAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAC/D,CAAC;IACF,CAAC;IAED;;;;OAIG;IACH,IAAW,gBAAgB;QAC1B,OAAO,IAAI,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,OAAkC;QACvD,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,CAAC,kCAAkC,EAAE,CAAC;QAC3C,CAAC;IACF,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,aAAa,CACzB,gBAAoC,EACpC,iBAAqD;QAMrD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,WAAW,CAC9C,IAAI,CAAC,EAAE,EACP,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,qBAAqB,EAAE,EAC5B,gBAAgB,CAChB,CAAC;YACF,MAAM,gBAAgB,GAA8B,eAAe,CAAC,QAAQ,CAAC,CAAC;YAC9E,MAAM,UAAU,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;YACtF,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC7B,IAAI,CAAC,iBAAiB,EAAE,UAAU,EAAE,CAAC;gBACrC,IAAI,CAAC,YAAY,GAAG;oBACnB,QAAQ;oBACR,sBAAsB,EAAE,UAAU,CAAC,cAAc;iBACjD,CAAC;YACH,CAAC;YACD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;QAC1C,CAAC;aAAM,CAAC;YACP,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,sBAAsB,EAAE,QAAQ,EAAE,GACtE,iBAAiB,CAAC;YACnB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAuB,CAAC;YACpD,8EAA8E;YAC9E,uEAAuE;YACvE,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBACzD,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;YACrD,CAAC;YACD,mEAAmE;YACnE,qEAAqE;YACrE,gEAAgE;YAChE,IAAI,sBAAsB,KAAK,SAAS,EAAE,CAAC;gBAC1C,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,CAAC;oBAClE,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;gBACvD,CAAC;YACF,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;YACrD,MAAM,UAAU,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAElF,MAAM,QAAQ,GAAc;gBAC3B,cAAc,EAAE,UAAU,CAAC,cAAc;gBACzC,YAAY,EAAE,YAAY;gBAC1B,YAAY;gBACZ,oBAAoB,EAAE,SAAS;gBAC/B,GAAG,EAAE,EAAE;gBACP,eAAe,EAAE,CAAC;aAClB,CAAC;YAEF,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC7B,oEAAoE;gBACpE,sEAAsE;gBACtE,+DAA+D;gBAC/D,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzB,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC;oBACrC,IAAI,CAAC,yBAAyB,GAAG,QAAQ,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC;gBAC5E,CAAC;gBAED,IAAI,CAAC,YAAY,GAAG;oBACnB,QAAQ;oBACR,sBAAsB,EAAE,UAAU,CAAC,cAAc;iBACjD,CAAC;gBACF,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;YAC9C,CAAC;YACD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;QACrD,CAAC;IACF,CAAC;IAED;;;;OAIG;IACK,uBAAuB,CAAC,cAA6B;QAC5D,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,OAAO,IAAI,CAAC,kCAAkC,EAAE,CAAC;IAClD,CAAC;IAED;;OAEG;IACK,kCAAkC;QACzC,MAAM,sBAAsB,GAAG,IAAI,CAAC,cAAc,EAAE,sBAAsB,CAAC;QAC3E,IACC,uBAAA,IAAI,wCAAU;YACd,sBAAsB,KAAK,SAAS;YACpC,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC;YAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc;gBAC7D,IAAI,CAAC,yBAAyB;YAC/B,IAAI,CAAC,cAAc,EAAE,EACpB,CAAC;YACF,0EAA0E;YAC1E,qDAAqD;YACrD,OAAO,CAAC,CAAC,CAAC;QACX,CAAC;QACD,MAAM,8BAA8B,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;QAC3E,MAAM,6BAA6B,GAClC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC;QAEhE,IAAI,sBAAsB,GAAG,8BAA8B,EAAE,CAAC;YAC7D,4FAA4F;YAC5F,qGAAqG;YACrG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBACjC,SAAS,EAAE,iCAAiC;gBAC5C,sBAAsB;gBACtB,8BAA8B;gBAC9B,6BAA6B;gBAC7B,6BAA6B,EAAE,IAAI,CAAC,YAAY,EAAE,sBAAsB;aACxE,CAAC,CAAC;YACH,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;YAC9C,IAAI,CAAC,iBAAiB,EAAE,YAAY,EAAE,CAAC;QACxC,CAAC;aAAM,IAAI,sBAAsB,IAAI,6BAA6B,EAAE,CAAC;YACpE,+DAA+D;YAC/D,uDAAuD;YACvD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,sBAAsB,GAAG,8BAA8B,GAAG,CAAC,CAAC,CAAC;YACzF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;YAC9C,IAAI,CAAC,iBAAiB,EAAE,YAAY,EAAE,CAAC;YACvC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBACjC,SAAS,EAAE,mBAAmB;gBAC9B,sBAAsB;gBACtB,8BAA8B;gBAC9B,iCAAiC,EAChC,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc;aACjF,CAAC,CAAC;QACJ,CAAC;QACD,OAAO,sBAAsB,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,QAAmB;QAC5C,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,IAAI,CAAC,YAAY,GAAG;gBACnB,QAAQ;gBACR,sBAAsB,EAAE,QAAQ,CAAC,cAAc,IAAI,CAAC;gBACpD,mBAAmB,EAAE,IAAI,CAAC,GAAG,EAAE;aAC/B,CAAC;YACF,IAAI,CAAC,iBAAiB,EAAE,UAAU,EAAE,CAAC;QACtC,CAAC;IACF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAChC,QAA4B,EAC5B,OAA+C,EAC/C,WAAyB;QAEzB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9B,MAAM,IAAI,UAAU,CAAC,8DAA8D,CAAC,CAAC;QACtF,CAAC;QAED,OAAO,gBAAgB,CAAC,cAAc,CACrC,IAAI,CAAC,EAAE,CAAC,MAAM,EACd;YACC,SAAS,EAAE,sBAAsB;YACjC,OAAO,EAAE;gBACR,qBAAqB,EAAE,KAAK;gBAC5B,yBAAyB,EAAE,SAAS;gBACpC,sBAAsB,EAAE,SAAS;gBACjC,gBAAgB,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM;aAC1C;YACD,QAAQ;SACR,EACD,KAAK,IAAI,EAAE;YACV,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAClE,MAAM,mBAAmB,GAAG,MAAM,OAAO,CAAC,oBAAoB,CAAC;gBAC9D,qBAAqB,EAAE,KAAK;gBAC5B,sBAAsB,EAAE,IAAI,CAAC,YAAY,CAAC,sBAAsB;gBAChE,yBAAyB,EAAE,IAAI,CAAC,YAAY,CAAC,mBAAmB;aAChE,CAAC,CAAC;YACH,qFAAqF;YACrF,MAAM,sBAAsB,GAA2C,EAAE,CAAC;YAC1E,IAAI,mBAAmB,GAAG,KAAK,CAAC;YAChC,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;YACpF,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACjC,KAAK,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,gBAAgB,EAAE,CAAC;oBACpD,mBAAmB,GAAG,IAAI,CAAC;oBAC3B,sBAAsB,CAAC,OAAO,CAAC,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAAC;gBAC3E,CAAC;YACF,CAAC;YAED,MAAM,iBAAiB,GAAsB,qBAAqB,CACjE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAC1B;gBACA,CAAC,CAAC,mCAAmC,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;gBACjE,CAAC,CAAC,MAAM,sCAAsC,CAC5C,IAAI,CAAC,YAAY,CAAC,QAAQ,EAC1B,IAAI,CAAC,cAAc,CACnB,CAAC;YAEJ,MAAM,YAAY,GAA2B;gBAC5C,QAAQ,EAAE,IAAI;gBACd,mBAAmB;gBACnB,GAAG,iBAAiB;gBACpB,sBAAsB,EAAE,mBAAmB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS;gBAChF,QAAQ,EAAE,IAAI,CAAC,YAAY;gBAC3B,GAAG,EAAE,WAAW,CAAC,GAAG;gBACpB,QAAQ;aACR,CAAC;YAEF,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACrC,CAAC,CACD,CAAC;IACH,CAAC;CACD;;AAED,KAAK,UAAU,sCAAsC,CACpD,QAAuB,EACvB,cAA6D;IAE7D,MAAM,aAAa,GAAG,MAAM,uBAAuB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IAC9E,OAAO;QACN,YAAY,EAAE,QAAQ;QACtB,aAAa;KACb,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAC1C,EAAqB,EACrB,cAA6D,EAC7D,qBAA8B;IAE9B,OAAO,gBAAgB,CAAC,cAAc,CACrC,EAAE,CAAC,MAAM,EACT,EAAE,SAAS,EAAE,uBAAuB,EAAE,EACtC,KAAK,EAAE,KAAK,EAAE,EAAE;QACf,IAAI,CAAC;YACJ,6CAA6C;YAC7C,MAAM,gBAAgB,GAAe,MAAM,cAAc,CAAC,WAAW;YACpE,2CAA2C;YAC3C,IAAI,EACJ,CAAC,EACD,uBAAuB,EACvB,WAAW,CAAC,OAAO,CACnB,CAAC;YACF,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,MAAM,WAAW,CACnD,EAAE,EACF,cAAc,EACd,qBAAqB,EACrB,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAAE,CACvB,CAAC;YAEF,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,qBAAqB,CAAC,YAAY,CAAC;gBAC3E,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC;YAE7D,MAAM,sBAAsB,GAC3B,cAAc;gBACd,CAAC,MAAM,qBAAqB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,IAAI,CAC9D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CACvB,CAAC,CAAC;YACJ,OAAO;gBACN,QAAQ,EAAE,YAAY;gBACtB,sBAAsB;gBACtB,mBAAmB,EAAE,IAAI,CAAC,GAAG,EAAE;aAC/B,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,SAAS,CAAC;IAClB,CAAC,CACD,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,UAAU,WAAW,CACzB,EAAqB,EACrB,cAGC,EACD,qBAA8B,EAC9B,gBAAoC;IAEpC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,qBAAqB;QAClD,CAAC,CAAC,MAAM,cAAc,CAAC,EAAE,EAAE,cAAc,EAAE,gBAAgB,CAAC;QAC5D,CAAC,CAAC,MAAM,kBAAkB,CAAC,EAAE,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC;IAClE,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAClE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CACnC,EAAqB,EACrB,cAA4D,EAC5D,gBAAoC;IAEpC,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,WAAW,EAAE,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACrF,MAAM,OAAO,GACZ,QAAQ,EAAE,YAAY,CAAC,EAAE,KAAK,SAAS;QACtC,CAAC,CAAC,SAAS;QACX,CAAC,CAAC;YACA,EAAE,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE;YAC5B,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE;SAChC,CAAC;IAEL,IAAI,QAAQ,KAAK,SAAS,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAC9D,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;YACxB,SAAS,EAAE,uBAAuB;YAClC,EAAE,EAAE,gBAAgB;SACpB,CAAC,CAAC;IACJ,CAAC;SAAM,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,EAAE,EAAE,KAAK,SAAS,EAAE,CAAC;QAChE,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;YACxB,SAAS,EAAE,wCAAwC;YACnD,UAAU,EAAE,OAAO,KAAK,SAAS,EAAE,mFAAmF;SACtH,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACvC,EAAqB,EACrB,cAAgF,EAChF,gBAAoC;IAEpC,gBAAgB;IAChB,2CAA2C;IAC3C,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,gBAAgB,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;IAC/E,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE5B,IAAI,OAAO,KAAK,SAAS,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAC7D,+EAA+E;QAC/E,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;YACxB,SAAS,EAAE,6BAA6B;YACxC,EAAE,EAAE,gBAAgB;SACpB,CAAC,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,CAAC,MAAM,cAAc,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,IAAI,SAAS,CAAC;IAE9E,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACrD,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;SAAM,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,EAAE,EAAE,KAAK,SAAS,EAAE,CAAC;QAChE,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;YACxB,SAAS,EAAE,wCAAwC;YACnD,UAAU,EAAE,OAAO,KAAK,SAAS,EAAE,mFAAmF;SACtH,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { stringToBuffer } from \"@fluid-internal/client-utils\";\nimport type { IRuntime } from \"@fluidframework/container-definitions/internal\";\nimport type {\n\tIEventProvider,\n\tIEvent,\n\tITelemetryBaseLogger,\n} from \"@fluidframework/core-interfaces\";\nimport type { IDisposable } from \"@fluidframework/core-interfaces/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\tFetchSource,\n\ttype IDocumentStorageService,\n\ttype IResolvedUrl,\n\ttype ISnapshot,\n\ttype IDocumentAttributes,\n\ttype ISnapshotTree,\n\ttype IVersion,\n\ttype ISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\nimport { getSnapshotTree, isInstanceOfISnapshot } from \"@fluidframework/driver-utils/internal\";\nimport {\n\ttype MonitoringContext,\n\tPerformanceEvent,\n\tUsageError,\n\tcreateChildMonitoringContext,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\tgetBlobContentsFromTree,\n\ttype ContainerStorageAdapter,\n\ttype IBase64BlobContents,\n\ttype ISerializableBlobContents,\n} from \"./containerStorageAdapter.js\";\nimport { SnapshotRefresher } from \"./snapshotRefresher.js\";\nimport {\n\tconvertISnapshotToSnapshotWithBlobs,\n\tconvertSnapshotToSnapshotInfo,\n\tgetDocumentAttributes,\n} from \"./utils.js\";\n\n/**\n * This is very similar to {@link @fluidframework/protocol-definitions/internal#ISnapshot}, but the difference is\n * that the blobs of ISnapshot are of type ArrayBufferLike, while the blobs of this interface are serializable because\n * they are already converted to string.\n */\nexport interface SnapshotWithBlobs {\n\t/**\n\t * Snapshot from which container initially loaded.\n\t */\n\tbaseSnapshot: ISnapshotTree;\n\t/**\n\t * Serializable blobs from the base snapshot. Used to load offline since\n\t * storage is not available.\n\t */\n\tsnapshotBlobs: ISerializableBlobContents;\n}\n\n/**\n * State saved by a container at close time, to be used to load a new instance\n * of the container to the same state\n *\n * This is very similar to {@link @fluidframework/protocol-definitions/internal#ISnapshot}, but the difference is\n * that the blobs of ISnapshot are of type ArrayBufferLike, while the blobs of this interface are serializable because\n * they are already converted to string.\n *\n * @internal\n */\nexport interface IPendingContainerState extends SnapshotWithBlobs {\n\t/**\n\t * This container was attached (as opposed to IPendingDetachedContainerState.attached which is false)\n\t */\n\tattached: true;\n\t/**\n\t * Runtime-specific state that will be needed to properly rehydrate\n\t * (it's included in ContainerContext passed to instantiateRuntime)\n\t */\n\tpendingRuntimeState: unknown;\n\t/**\n\t * Any group snapshots (aka delay-loaded) we've downloaded from the service for this container\n\t */\n\tloadedGroupIdSnapshots?: Record<string, SerializedSnapshotInfo>;\n\t/**\n\t * Attachment blob contents inlined by storage id, encoded as base64.\n\t *\n\t * Carried separately from {@link SnapshotWithBlobs.snapshotBlobs} because\n\t * attachment blobs may contain arbitrary binary payloads, and the\n\t * UTF-8 encoding used for `snapshotBlobs` (which holds JSON/text the\n\t * runtime authors) would corrupt non-UTF-8 byte sequences with\n\t * replacement characters. Populated by `captureFullContainerState`; the\n\t * live container's pending-state path leaves this `undefined` because\n\t * it does not inline attachment blob contents.\n\t *\n\t * On load, entries are decoded from base64 and merged into the same\n\t * blob cache that `snapshotBlobs` populates.\n\t */\n\tattachmentBlobContents?: IBase64BlobContents;\n\t/**\n\t * All ops since base snapshot sequence number up to the latest op\n\t * seen when the container was closed. Used to apply stashed (saved pending)\n\t * ops at the same sequence number at which they were made.\n\t */\n\tsavedOps: ISequencedDocumentMessage[];\n\t/**\n\t * The Container's URL in the service, needed to hook up the driver during rehydration\n\t */\n\turl: string;\n\t/**\n\t * If the Container was connected when serialized, its clientId. Used as the initial clientId upon rehydration, until reconnected.\n\t */\n\tclientId?: string;\n}\n\n/**\n * State saved by a container in detached state, to be used to load a new instance\n * of the container to the same state (rehydrate)\n * @internal\n */\nexport interface IPendingDetachedContainerState extends SnapshotWithBlobs {\n\t/**\n\t * This container was not attached (as opposed to IPendingContainerState.attached which is true)\n\t */\n\tattached: false;\n\t/**\n\t * Indicates whether we expect the rehydrated container to have non-empty Detached Blob Storage\n\t */\n\thasAttachmentBlobs: boolean;\n\t/**\n\t * Used by the memory blob storage to persisted attachment blobs\n\t */\n\tattachmentBlobs?: string;\n\t/**\n\t * Runtime-specific state that will be needed to properly rehydrate\n\t * (it's included in ContainerContext passed to instantiateRuntime)\n\t */\n\tpendingRuntimeState?: unknown;\n}\n\nexport interface SerializedSnapshotInfo extends SnapshotWithBlobs {\n\tsnapshotSequenceNumber: number;\n}\n\nexport interface ISnapshotInfo {\n\tsnapshotSequenceNumber: number;\n\tsnapshotFetchedTime?: number | undefined;\n\tsnapshot: ISnapshot | ISnapshotTree;\n}\n\nexport type ISerializedStateManagerDocumentStorageService = Pick<\n\tContainerStorageAdapter,\n\t\"getSnapshot\" | \"getSnapshotTree\" | \"getVersions\" | \"readBlob\" | \"cacheSnapshotBlobs\"\n> & {\n\tloadedGroupIdSnapshots: Record<string, ISnapshot>;\n};\n\ninterface ISerializerEvent extends IEvent {\n\t(event: \"saved\", listener: (dirty: boolean) => void): void;\n}\n\n/**\n * Helper class to manage the state of the container needed for proper serialization.\n *\n * It holds the pendingLocalState the container was rehydrated from (if any),\n * as well as the snapshot to be used for serialization.\n * It also keeps track of container dirty state and which local ops have been processed\n */\nexport class SerializedStateManager implements IDisposable {\n\tprivate readonly processedOps: ISequencedDocumentMessage[] = [];\n\tprivate readonly mc: MonitoringContext;\n\tprivate snapshotInfo: ISnapshotInfo | undefined;\n\tprivate latestSnapshot: ISnapshotInfo | undefined;\n\tprivate lastSavedOpSequenceNumber: number = 0;\n\tprivate readonly snapshotRefresher: SnapshotRefresher | undefined;\n\t#disposed: boolean = false;\n\n\t/**\n\t * @param subLogger - Container's logger to use as parent for our logger\n\t * @param storageAdapter - Storage adapter for fetching snapshots\n\t * @param offlineLoadEnabled - Is serializing/rehydrating containers allowed?\n\t * @param containerEvent - Source of the \"saved\" event when the container has all its pending state uploaded\n\t * @param containerDirty - Is the container \"dirty\"? That's the opposite of \"saved\" - there is pending state that may not have been received yet by the service.\n\t */\n\tconstructor(\n\t\tsubLogger: ITelemetryBaseLogger,\n\t\tprivate readonly storageAdapter: ISerializedStateManagerDocumentStorageService,\n\t\tprivate readonly offlineLoadEnabled: boolean,\n\t\tcontainerEvent: IEventProvider<ISerializerEvent>,\n\t\tprivate readonly containerDirty: () => boolean,\n\t\tprivate readonly supportGetSnapshotApi: () => boolean,\n\t\tsnapshotRefreshTimeoutMs?: number,\n\t) {\n\t\tthis.mc = createChildMonitoringContext({\n\t\t\tlogger: subLogger,\n\t\t\tnamespace: \"serializedStateManager\",\n\t\t});\n\n\t\tthis.snapshotRefresher = this.offlineLoadEnabled\n\t\t\t? new SnapshotRefresher(\n\t\t\t\t\tsubLogger,\n\t\t\t\t\tthis.storageAdapter,\n\t\t\t\t\tthis.offlineLoadEnabled,\n\t\t\t\t\tthis.supportGetSnapshotApi,\n\t\t\t\t\t(snapshot: ISnapshotInfo) => this.handleSnapshotRefreshed(snapshot),\n\t\t\t\t\tsnapshotRefreshTimeoutMs,\n\t\t\t\t)\n\t\t\t: undefined;\n\n\t\tcontainerEvent.on(\"saved\", () => this.updateSnapshotAndProcessedOpsMaybe());\n\t}\n\tpublic get disposed(): boolean {\n\t\treturn this.#disposed;\n\t}\n\tdispose(): void {\n\t\tthis.#disposed = true;\n\t\tthis.snapshotRefresher?.dispose();\n\t}\n\n\tprivate verifyNotDisposed(): void {\n\t\tif (this.#disposed) {\n\t\t\tthrow new Error(\"SerializedStateManager used after dispose.\");\n\t\t}\n\t}\n\n\t/**\n\t * Promise that will resolve (or reject) once we've tried to download the latest snapshot(s) from storage\n\t * only intended to be used for testing purposes.\n\t * @returns The snapshot sequence number associated with the latest fetched snapshot\n\t */\n\tpublic get refreshSnapshotP(): Promise<number> | undefined {\n\t\treturn this.snapshotRefresher?.refreshSnapshotP;\n\t}\n\n\t/**\n\t * Called whenever an incoming op is processed by the Container\n\t */\n\tpublic addProcessedOp(message: ISequencedDocumentMessage): void {\n\t\tif (this.offlineLoadEnabled) {\n\t\t\tthis.processedOps.push(message);\n\t\t\tthis.updateSnapshotAndProcessedOpsMaybe();\n\t\t}\n\t}\n\n\t/**\n\t * This wraps the basic functionality of fetching the snapshot for this container during Container load.\n\t *\n\t * If we have pendingLocalState, we get the snapshot from there.\n\t * Otherwise, fetch it from storage (according to specifiedVersion if provided).\n\t *\n\t * @param specifiedVersion - If a version is specified and we don't have pendingLocalState, fetch this version from storage.\n\t * @param pendingLocalState - The pendingLocalState being rehydrated, if any (undefined when loading directly from storage)\n\t * @returns The snapshot to boot the container from\n\t */\n\tpublic async fetchSnapshot(\n\t\tspecifiedVersion: string | undefined,\n\t\tpendingLocalState: IPendingContainerState | undefined,\n\t): Promise<{\n\t\tsnapshot: ISnapshot | ISnapshotTree;\n\t\tversion: IVersion | undefined;\n\t\tattributes: IDocumentAttributes;\n\t}> {\n\t\tthis.verifyNotDisposed();\n\t\tif (pendingLocalState === undefined) {\n\t\t\tconst { snapshot, version } = await getSnapshot(\n\t\t\t\tthis.mc,\n\t\t\t\tthis.storageAdapter,\n\t\t\t\tthis.supportGetSnapshotApi(),\n\t\t\t\tspecifiedVersion,\n\t\t\t);\n\t\t\tconst baseSnapshotTree: ISnapshotTree | undefined = getSnapshotTree(snapshot);\n\t\t\tconst attributes = await getDocumentAttributes(this.storageAdapter, baseSnapshotTree);\n\t\t\tif (this.offlineLoadEnabled) {\n\t\t\t\tthis.snapshotRefresher?.startTimer();\n\t\t\t\tthis.snapshotInfo = {\n\t\t\t\t\tsnapshot,\n\t\t\t\t\tsnapshotSequenceNumber: attributes.sequenceNumber,\n\t\t\t\t};\n\t\t\t}\n\t\t\treturn { snapshot, version, attributes };\n\t\t} else {\n\t\t\tconst { baseSnapshot, snapshotBlobs, attachmentBlobContents, savedOps } =\n\t\t\t\tpendingLocalState;\n\t\t\tconst blobContents = new Map<string, ArrayBuffer>();\n\t\t\t// Structural snapshot blobs (snapshot trees, `.attributes`, `.redirectTable`)\n\t\t\t// are JSON/text the runtime authored, so UTF-8 round-trip is lossless.\n\t\t\tfor (const [id, value] of Object.entries(snapshotBlobs)) {\n\t\t\t\tblobContents.set(id, stringToBuffer(value, \"utf8\"));\n\t\t\t}\n\t\t\t// Attachment blobs are base64-encoded — see IPendingContainerState\n\t\t\t// docs. Decoded after structural blobs because storage-id collisions\n\t\t\t// between the two namespaces should resolve to the binary form.\n\t\t\tif (attachmentBlobContents !== undefined) {\n\t\t\t\tfor (const [id, value] of Object.entries(attachmentBlobContents)) {\n\t\t\t\t\tblobContents.set(id, stringToBuffer(value, \"base64\"));\n\t\t\t\t}\n\t\t\t}\n\t\t\tthis.storageAdapter.cacheSnapshotBlobs(blobContents);\n\t\t\tconst attributes = await getDocumentAttributes(this.storageAdapter, baseSnapshot);\n\n\t\t\tconst snapshot: ISnapshot = {\n\t\t\t\tsequenceNumber: attributes.sequenceNumber,\n\t\t\t\tsnapshotTree: baseSnapshot,\n\t\t\t\tblobContents,\n\t\t\t\tlatestSequenceNumber: undefined,\n\t\t\t\tops: [],\n\t\t\t\tsnapshotFormatV: 1,\n\t\t\t};\n\n\t\t\tif (this.offlineLoadEnabled) {\n\t\t\t\t// special case handle. Obtaining the last saved op seq num to avoid\n\t\t\t\t// refreshing the snapshot before we have processed it. It could cause\n\t\t\t\t// a subsequent stashing to have a newer snapshot than allowed.\n\t\t\t\tif (savedOps.length > 0) {\n\t\t\t\t\tconst savedOpsSize = savedOps.length;\n\t\t\t\t\tthis.lastSavedOpSequenceNumber = savedOps[savedOpsSize - 1].sequenceNumber;\n\t\t\t\t}\n\n\t\t\t\tthis.snapshotInfo = {\n\t\t\t\t\tsnapshot,\n\t\t\t\t\tsnapshotSequenceNumber: attributes.sequenceNumber,\n\t\t\t\t};\n\t\t\t\tthis.snapshotRefresher?.tryRefreshSnapshot();\n\t\t\t}\n\t\t\treturn { snapshot, version: undefined, attributes };\n\t\t}\n\t}\n\n\t/**\n\t * Handles the snapshotRefreshed event from SnapshotRefresher.\n\t * Decides whether to accept the new snapshot based on processed ops.\n\t * @returns The snapshot sequence number if updated, -1 otherwise\n\t */\n\tprivate handleSnapshotRefreshed(latestSnapshot: ISnapshotInfo): number {\n\t\tthis.latestSnapshot = latestSnapshot;\n\t\treturn this.updateSnapshotAndProcessedOpsMaybe();\n\t}\n\n\t/**\n\t * Updates class snapshot and processedOps if we have a new snapshot and it's among processedOps range.\n\t */\n\tprivate updateSnapshotAndProcessedOpsMaybe(): number {\n\t\tconst snapshotSequenceNumber = this.latestSnapshot?.snapshotSequenceNumber;\n\t\tif (\n\t\t\tthis.#disposed ||\n\t\t\tsnapshotSequenceNumber === undefined ||\n\t\t\tthis.processedOps.length === 0 ||\n\t\t\tthis.processedOps[this.processedOps.length - 1].sequenceNumber <\n\t\t\t\tthis.lastSavedOpSequenceNumber ||\n\t\t\tthis.containerDirty()\n\t\t) {\n\t\t\t// can't refresh latest snapshot until we have processed the ops up to it.\n\t\t\t// Pending state would be behind the latest snapshot.\n\t\t\treturn -1;\n\t\t}\n\t\tconst firstProcessedOpSequenceNumber = this.processedOps[0].sequenceNumber;\n\t\tconst lastProcessedOpSequenceNumber =\n\t\t\tthis.processedOps[this.processedOps.length - 1].sequenceNumber;\n\n\t\tif (snapshotSequenceNumber < firstProcessedOpSequenceNumber) {\n\t\t\t// Snapshot seq number is older than our first processed op, which could mean we're fetching\n\t\t\t// the same snapshot that we already have or snapshot is too old, implicating an unexpected behavior.\n\t\t\tthis.mc.logger.sendTelemetryEvent({\n\t\t\t\teventName: \"OldSnapshotFetchWhileRefreshing\",\n\t\t\t\tsnapshotSequenceNumber,\n\t\t\t\tfirstProcessedOpSequenceNumber,\n\t\t\t\tlastProcessedOpSequenceNumber,\n\t\t\t\tstashedSnapshotSequenceNumber: this.snapshotInfo?.snapshotSequenceNumber,\n\t\t\t});\n\t\t\tthis.latestSnapshot = undefined;\n\t\t\tthis.snapshotRefresher?.clearLatestSnapshot();\n\t\t\tthis.snapshotRefresher?.restartTimer();\n\t\t} else if (snapshotSequenceNumber <= lastProcessedOpSequenceNumber) {\n\t\t\t// Snapshot seq num is between the first and last processed op.\n\t\t\t// Remove the ops that are already part of the snapshot\n\t\t\tthis.processedOps.splice(0, snapshotSequenceNumber - firstProcessedOpSequenceNumber + 1);\n\t\t\tthis.snapshotInfo = this.latestSnapshot;\n\t\t\tthis.latestSnapshot = undefined;\n\t\t\tthis.snapshotRefresher?.clearLatestSnapshot();\n\t\t\tthis.snapshotRefresher?.restartTimer();\n\t\t\tthis.mc.logger.sendTelemetryEvent({\n\t\t\t\teventName: \"SnapshotRefreshed\",\n\t\t\t\tsnapshotSequenceNumber,\n\t\t\t\tfirstProcessedOpSequenceNumber,\n\t\t\t\tnewFirstProcessedOpSequenceNumber:\n\t\t\t\t\tthis.processedOps.length === 0 ? undefined : this.processedOps[0].sequenceNumber,\n\t\t\t});\n\t\t}\n\t\treturn snapshotSequenceNumber;\n\t}\n\n\t/**\n\t * When the Container attaches, we need to stash the initial snapshot (a form of the attach summary).\n\t * This method is only meant to be used by Container.attach() to set the initial\n\t * base snapshot when attaching.\n\t * @param snapshot - snapshot and blobs collected while attaching (a form of the attach summary)\n\t */\n\tpublic setInitialSnapshot(snapshot: ISnapshot): void {\n\t\tthis.verifyNotDisposed();\n\t\tif (this.offlineLoadEnabled) {\n\t\t\tthis.snapshotInfo = {\n\t\t\t\tsnapshot,\n\t\t\t\tsnapshotSequenceNumber: snapshot.sequenceNumber ?? 0,\n\t\t\t\tsnapshotFetchedTime: Date.now(),\n\t\t\t};\n\t\t\tthis.snapshotRefresher?.startTimer();\n\t\t}\n\t}\n\n\t/**\n\t * Assembles and serializes the {@link IPendingContainerState} for the container,\n\t * to be stored and used to rehydrate the container at a later time.\n\t */\n\tpublic async getPendingLocalState(\n\t\tclientId: string | undefined,\n\t\truntime: Pick<IRuntime, \"getPendingLocalState\">,\n\t\tresolvedUrl: IResolvedUrl,\n\t): Promise<string> {\n\t\tthis.verifyNotDisposed();\n\t\tif (!this.offlineLoadEnabled) {\n\t\t\tthrow new UsageError(\"Can't get pending local state unless offline load is enabled\");\n\t\t}\n\n\t\treturn PerformanceEvent.timedExecAsync(\n\t\t\tthis.mc.logger,\n\t\t\t{\n\t\t\t\teventName: \"getPendingLocalState\",\n\t\t\t\tdetails: {\n\t\t\t\t\tnotifyImminentClosure: false,\n\t\t\t\t\tsessionExpiryTimerStarted: undefined,\n\t\t\t\t\tsnapshotSequenceNumber: undefined,\n\t\t\t\t\tprocessedOpsSize: this.processedOps.length,\n\t\t\t\t},\n\t\t\t\tclientId,\n\t\t\t},\n\t\t\tasync () => {\n\t\t\t\tassert(this.snapshotInfo !== undefined, 0x8e5 /* no base data */);\n\t\t\t\tconst pendingRuntimeState = await runtime.getPendingLocalState({\n\t\t\t\t\tnotifyImminentClosure: false,\n\t\t\t\t\tsnapshotSequenceNumber: this.snapshotInfo.snapshotSequenceNumber,\n\t\t\t\t\tsessionExpiryTimerStarted: this.snapshotInfo.snapshotFetchedTime,\n\t\t\t\t});\n\t\t\t\t// This conversion is required because ArrayBufferLike doesn't survive JSON.stringify\n\t\t\t\tconst loadedGroupIdSnapshots: Record<string, SerializedSnapshotInfo> = {};\n\t\t\t\tlet hasGroupIdSnapshots = false;\n\t\t\t\tconst groupIdSnapshots = Object.entries(this.storageAdapter.loadedGroupIdSnapshots);\n\t\t\t\tif (groupIdSnapshots.length > 0) {\n\t\t\t\t\tfor (const [groupId, snapshot] of groupIdSnapshots) {\n\t\t\t\t\t\thasGroupIdSnapshots = true;\n\t\t\t\t\t\tloadedGroupIdSnapshots[groupId] = convertSnapshotToSnapshotInfo(snapshot);\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tconst snapshotWithBlobs: SnapshotWithBlobs = isInstanceOfISnapshot(\n\t\t\t\t\tthis.snapshotInfo.snapshot,\n\t\t\t\t)\n\t\t\t\t\t? convertISnapshotToSnapshotWithBlobs(this.snapshotInfo.snapshot)\n\t\t\t\t\t: await convertSnapshotTreeToSnapshotWithBlobs(\n\t\t\t\t\t\t\tthis.snapshotInfo.snapshot,\n\t\t\t\t\t\t\tthis.storageAdapter,\n\t\t\t\t\t\t);\n\n\t\t\t\tconst pendingState: IPendingContainerState = {\n\t\t\t\t\tattached: true,\n\t\t\t\t\tpendingRuntimeState,\n\t\t\t\t\t...snapshotWithBlobs,\n\t\t\t\t\tloadedGroupIdSnapshots: hasGroupIdSnapshots ? loadedGroupIdSnapshots : undefined,\n\t\t\t\t\tsavedOps: this.processedOps,\n\t\t\t\t\turl: resolvedUrl.url,\n\t\t\t\t\tclientId,\n\t\t\t\t};\n\n\t\t\t\treturn JSON.stringify(pendingState);\n\t\t\t},\n\t\t);\n\t}\n}\n\nasync function convertSnapshotTreeToSnapshotWithBlobs(\n\tsnapshot: ISnapshotTree,\n\tstorageAdapter: ISerializedStateManagerDocumentStorageService,\n): Promise<SnapshotWithBlobs> {\n\tconst snapshotBlobs = await getBlobContentsFromTree(snapshot, storageAdapter);\n\treturn {\n\t\tbaseSnapshot: snapshot,\n\t\tsnapshotBlobs,\n\t};\n}\n\n/**\n * Retrieves the most recent snapshot and returns its info.\n *\n * @param mc - The monitoring context.\n * @param storageAdapter - The storage adapter providing methods to retrieve the snapshot.\n * @param supportGetSnapshotApi - a boolean indicating whether to use the fetchISnapshot or fetchISnapshotTree.\n * @returns a SnapshotInfo object containing the snapshot tree, snapshot blobs and its sequence number.\n */\nexport async function getLatestSnapshotInfo(\n\tmc: MonitoringContext,\n\tstorageAdapter: ISerializedStateManagerDocumentStorageService,\n\tsupportGetSnapshotApi: boolean,\n): Promise<ISnapshotInfo | undefined> {\n\treturn PerformanceEvent.timedExecAsync<ISnapshotInfo | undefined>(\n\t\tmc.logger,\n\t\t{ eventName: \"GetLatestSnapshotInfo\" },\n\t\tasync (event) => {\n\t\t\ttry {\n\t\t\t\t// get the latest non cached snapshot version\n\t\t\t\tconst specifiedVersion: IVersion[] = await storageAdapter.getVersions(\n\t\t\t\t\t// eslint-disable-next-line unicorn/no-null\n\t\t\t\t\tnull,\n\t\t\t\t\t1,\n\t\t\t\t\t\"getLatestSnapshotInfo\",\n\t\t\t\t\tFetchSource.noCache,\n\t\t\t\t);\n\t\t\t\tconst { snapshot: baseSnapshot } = await getSnapshot(\n\t\t\t\t\tmc,\n\t\t\t\t\tstorageAdapter,\n\t\t\t\t\tsupportGetSnapshotApi,\n\t\t\t\t\tspecifiedVersion[0]?.id,\n\t\t\t\t);\n\n\t\t\t\tconst { sequenceNumber, snapshotTree } = isInstanceOfISnapshot(baseSnapshot)\n\t\t\t\t\t? baseSnapshot\n\t\t\t\t\t: { snapshotTree: baseSnapshot, sequenceNumber: undefined };\n\n\t\t\t\tconst snapshotSequenceNumber: number =\n\t\t\t\t\tsequenceNumber ??\n\t\t\t\t\t(await getDocumentAttributes(storageAdapter, snapshotTree).then(\n\t\t\t\t\t\t(a) => a.sequenceNumber,\n\t\t\t\t\t));\n\t\t\t\treturn {\n\t\t\t\t\tsnapshot: baseSnapshot,\n\t\t\t\t\tsnapshotSequenceNumber,\n\t\t\t\t\tsnapshotFetchedTime: Date.now(),\n\t\t\t\t};\n\t\t\t} catch (error) {\n\t\t\t\tevent.cancel(undefined, error);\n\t\t\t}\n\t\t\treturn undefined;\n\t\t},\n\t);\n}\n\n/**\n * Retrieves a snapshot from the storage adapter and transforms it into an ISnapshotTree object.\n *\n * @param mc - The monitoring context.\n * @param storageAdapter - The storage adapter providing methods to retrieve the snapshot.\n * @param supportGetSnapshotApi - a boolean indicating whether to use the fetchISnapshot or fetchISnapshotTree.\n * @param specifiedVersion - An optional version string specifying the version of the snapshot tree to fetch.\n * @returns An ISnapshotTree and its version.\n */\nasync function getSnapshot(\n\tmc: MonitoringContext,\n\tstorageAdapter: Pick<\n\t\tIDocumentStorageService,\n\t\t\"getSnapshot\" | \"getSnapshotTree\" | \"getVersions\"\n\t>,\n\tsupportGetSnapshotApi: boolean,\n\tspecifiedVersion: string | undefined,\n): Promise<{ snapshot: ISnapshot | ISnapshotTree; version?: IVersion }> {\n\tconst { snapshot, version } = supportGetSnapshotApi\n\t\t? await fetchISnapshot(mc, storageAdapter, specifiedVersion)\n\t\t: await fetchISnapshotTree(mc, storageAdapter, specifiedVersion);\n\tassert(snapshot !== undefined, 0x8e4 /* Snapshot should exist */);\n\treturn { snapshot, version };\n}\n\n/**\n * Fetches an ISnapshot from a storage adapter based on the specified version.\n *\n * @param mc - The monitoring context.\n * @param storageAdapter - The storage adapter providing a getSnapshot method to retrieve the ISnapshot and version.\n * @param specifiedVersion - An optional version string specifying the version of the snapshot tree to fetch.\n * @returns The fetched snapshot tree and its version.\n */\nexport async function fetchISnapshot(\n\tmc: MonitoringContext,\n\tstorageAdapter: Pick<IDocumentStorageService, \"getSnapshot\">,\n\tspecifiedVersion: string | undefined,\n): Promise<{ snapshot?: ISnapshot; version?: IVersion }> {\n\tconst snapshot = await storageAdapter.getSnapshot?.({ versionId: specifiedVersion });\n\tconst version: IVersion | undefined =\n\t\tsnapshot?.snapshotTree.id === undefined\n\t\t\t? undefined\n\t\t\t: {\n\t\t\t\t\tid: snapshot.snapshotTree.id,\n\t\t\t\t\ttreeId: snapshot.snapshotTree.id,\n\t\t\t\t};\n\n\tif (snapshot === undefined && specifiedVersion !== undefined) {\n\t\tmc.logger.sendErrorEvent({\n\t\t\teventName: \"getSnapshotTreeFailed\",\n\t\t\tid: specifiedVersion,\n\t\t});\n\t} else if (snapshot !== undefined && version?.id === undefined) {\n\t\tmc.logger.sendErrorEvent({\n\t\t\teventName: \"getSnapshotFetchedTreeWithoutVersionId\",\n\t\t\thasVersion: version !== undefined, // if hasVersion is true, this means that the contract with the service was broken.\n\t\t});\n\t}\n\treturn { snapshot, version };\n}\n\n/**\n * Fetches an ISnapshotTree from a storage adapter based on the specified version.\n *\n * @param mc - The monitoring context.\n * @param storageAdapter - The storage adapter providing methods to retrieve the ISnapshotTree and version.\n * @param specifiedVersion - An optional version string specifying the version of the snapshot tree to fetch.\n * @returns The fetched snapshot tree and its version.\n */\nexport async function fetchISnapshotTree(\n\tmc: MonitoringContext,\n\tstorageAdapter: Pick<IDocumentStorageService, \"getSnapshotTree\" | \"getVersions\">,\n\tspecifiedVersion: string | undefined,\n): Promise<{ snapshot?: ISnapshotTree; version?: IVersion | undefined }> {\n\t// API uses null\n\t// eslint-disable-next-line unicorn/no-null\n\tconst versions = await storageAdapter.getVersions(specifiedVersion ?? null, 1);\n\tconst version = versions[0];\n\n\tif (version === undefined && specifiedVersion !== undefined) {\n\t\t// We should have a defined version to load from if specified version requested\n\t\tmc.logger.sendErrorEvent({\n\t\t\teventName: \"NoVersionFoundWhenSpecified\",\n\t\t\tid: specifiedVersion,\n\t\t});\n\t}\n\tconst snapshot = (await storageAdapter.getSnapshotTree(version)) ?? undefined;\n\n\tif (snapshot === undefined && version !== undefined) {\n\t\tmc.logger.sendErrorEvent({ eventName: \"getSnapshotTreeFailed\", id: version.id });\n\t} else if (snapshot !== undefined && version?.id === undefined) {\n\t\tmc.logger.sendErrorEvent({\n\t\t\teventName: \"getSnapshotFetchedTreeWithoutVersionId\",\n\t\t\thasVersion: version !== undefined, // if hasVersion is true, this means that the contract with the service was broken.\n\t\t});\n\t}\n\treturn { snapshot, version };\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/container-loader",
3
- "version": "2.93.0",
3
+ "version": "2.101.0",
4
4
  "description": "Fluid container loader",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -129,13 +129,13 @@
129
129
  "temp-directory": "nyc/.nyc_output"
130
130
  },
131
131
  "dependencies": {
132
- "@fluid-internal/client-utils": "~2.93.0",
133
- "@fluidframework/container-definitions": "~2.93.0",
134
- "@fluidframework/core-interfaces": "~2.93.0",
135
- "@fluidframework/core-utils": "~2.93.0",
136
- "@fluidframework/driver-definitions": "~2.93.0",
137
- "@fluidframework/driver-utils": "~2.93.0",
138
- "@fluidframework/telemetry-utils": "~2.93.0",
132
+ "@fluid-internal/client-utils": "~2.101.0",
133
+ "@fluidframework/container-definitions": "~2.101.0",
134
+ "@fluidframework/core-interfaces": "~2.101.0",
135
+ "@fluidframework/core-utils": "~2.101.0",
136
+ "@fluidframework/driver-definitions": "~2.101.0",
137
+ "@fluidframework/driver-utils": "~2.101.0",
138
+ "@fluidframework/telemetry-utils": "~2.101.0",
139
139
  "debug": "^4.3.4",
140
140
  "double-ended-queue": "^2.1.0-0",
141
141
  "events_pkg": "npm:events@^3.1.0",
@@ -144,12 +144,12 @@
144
144
  "devDependencies": {
145
145
  "@arethetypeswrong/cli": "^0.18.2",
146
146
  "@biomejs/biome": "~2.4.5",
147
- "@fluid-internal/client-utils": "~2.93.0",
148
- "@fluid-internal/mocha-test-setup": "~2.93.0",
149
- "@fluid-private/test-loader-utils": "~2.93.0",
150
- "@fluid-tools/build-cli": "^0.64.0",
147
+ "@fluid-internal/client-utils": "~2.101.0",
148
+ "@fluid-internal/mocha-test-setup": "~2.101.0",
149
+ "@fluid-private/test-loader-utils": "~2.101.0",
150
+ "@fluid-tools/build-cli": "^0.65.0",
151
151
  "@fluidframework/build-common": "^2.0.3",
152
- "@fluidframework/build-tools": "^0.64.0",
152
+ "@fluidframework/build-tools": "^0.65.0",
153
153
  "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.92.0",
154
154
  "@fluidframework/eslint-config-fluid": "^9.0.0",
155
155
  "@microsoft/api-extractor": "7.58.1",
@@ -0,0 +1,446 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ import { bufferToString } from "@fluid-internal/client-utils";
7
+ import type {
8
+ IDocumentStorageService,
9
+ ISequencedDocumentMessage,
10
+ ISnapshot,
11
+ ISnapshotTree,
12
+ } from "@fluidframework/driver-definitions/internal";
13
+ import { readAndParse } from "@fluidframework/driver-utils/internal";
14
+
15
+ import type {
16
+ IBase64BlobContents,
17
+ ISerializableBlobContents,
18
+ } from "./containerStorageAdapter.js";
19
+
20
+ /**
21
+ * Wire-format constants this module needs to walk and filter snapshots.
22
+ * Authoritative definitions live in `container-runtime` and
23
+ * `runtime-definitions`; the values are duplicated here to avoid a
24
+ * loader → runtime layering dependency. A contract test in
25
+ * `packages/test/local-server-tests` asserts these match the authoritative
26
+ * values; do not change them in isolation.
27
+ *
28
+ * Authoritative sources:
29
+ * - `blobsTreeName`, `redirectTableBlobName`: `packages/runtime/container-runtime/src/blobManager/blobManagerSnapSum.ts`
30
+ * - `blobManagerBasePath`: `packages/runtime/container-runtime/src/blobManager/blobManager.ts`
31
+ * - `gcTreeKey`, `gcBlobPrefix`, `gcTombstoneBlobKey`, `gcDeletedBlobKey`: `packages/runtime/runtime-definitions/src/garbageCollectionDefinitions.ts`
32
+ *
33
+ * @internal
34
+ */
35
+ export const wireFormatConstants = {
36
+ blobsTreeName: ".blobs",
37
+ redirectTableBlobName: ".redirectTable",
38
+ blobManagerBasePath: "_blobs",
39
+ gcTreeKey: "gc",
40
+ gcBlobPrefix: "__gc",
41
+ gcTombstoneBlobKey: "__tombstones",
42
+ gcDeletedBlobKey: "__deletedNodes",
43
+ } as const;
44
+
45
+ const {
46
+ blobsTreeName,
47
+ redirectTableBlobName,
48
+ blobManagerBasePath,
49
+ gcTreeKey,
50
+ gcBlobPrefix,
51
+ gcTombstoneBlobKey,
52
+ gcDeletedBlobKey,
53
+ } = wireFormatConstants;
54
+
55
+ interface IGcNodeData {
56
+ outboundRoutes: string[];
57
+ unreferencedTimestampMs?: number;
58
+ }
59
+
60
+ interface IGcState {
61
+ gcNodes: { [id: string]: IGcNodeData };
62
+ }
63
+
64
+ /**
65
+ * The parsed subset of the `gc` subtree that drives reachability decisions.
66
+ */
67
+ export interface IGcSnapshotData {
68
+ gcState: IGcState | undefined;
69
+ tombstones: string[] | undefined;
70
+ deletedNodes: string[] | undefined;
71
+ }
72
+
73
+ /** Reader that returns a blob's contents for a given storage id. */
74
+ type BlobReader = (id: string) => Promise<ArrayBufferLike>;
75
+
76
+ /**
77
+ * Upper bound on concurrent `readBlob` calls. Driver/service back-pressure is
78
+ * real for large documents, and unbounded `Promise.all` can trigger throttling
79
+ * or spike memory. The value is a pragmatic middle ground — high enough to
80
+ * keep a typical driver's request pipeline full, low enough to avoid storms.
81
+ */
82
+ const maxReadConcurrency = 32;
83
+
84
+ /**
85
+ * Runs `fn` over `items` with at most `limit` promises in flight. Preserves
86
+ * input order on output (not that any caller depends on it today).
87
+ *
88
+ * Exported for unit tests; not part of the package public API.
89
+ *
90
+ * @internal
91
+ */
92
+ export async function mapWithConcurrency<T, R>(
93
+ items: readonly T[],
94
+ limit: number,
95
+ fn: (item: T) => Promise<R>,
96
+ ): Promise<R[]> {
97
+ const results: R[] = Array.from({ length: items.length });
98
+ let cursor = 0;
99
+ const workerCount = Math.min(limit, items.length);
100
+ const workers = Array.from({ length: workerCount }, async () => {
101
+ while (cursor < items.length) {
102
+ const index = cursor++;
103
+ const item = items[index];
104
+ if (item !== undefined) {
105
+ results[index] = await fn(item);
106
+ }
107
+ }
108
+ });
109
+ await Promise.all(workers);
110
+ return results;
111
+ }
112
+
113
+ /**
114
+ * Parses the `gc` subtree of a base snapshot. Returns `undefined` if the
115
+ * snapshot has no GC tree (GC disabled or pre-GC document).
116
+ */
117
+ export async function parseGcSnapshotData(
118
+ baseSnapshot: ISnapshotTree,
119
+ storage: Pick<IDocumentStorageService, "readBlob">,
120
+ ): Promise<IGcSnapshotData | undefined> {
121
+ const gcSnapshotTree: ISnapshotTree | undefined = baseSnapshot.trees[gcTreeKey];
122
+ if (gcSnapshotTree === undefined) {
123
+ return undefined;
124
+ }
125
+ let gcState: IGcState | undefined;
126
+ let tombstones: string[] | undefined;
127
+ let deletedNodes: string[] | undefined;
128
+ for (const [key, blobId] of Object.entries(gcSnapshotTree.blobs)) {
129
+ if (key === gcDeletedBlobKey) {
130
+ deletedNodes = await readAndParse<string[]>(storage, blobId);
131
+ } else if (key === gcTombstoneBlobKey) {
132
+ tombstones = await readAndParse<string[]>(storage, blobId);
133
+ } else if (key.startsWith(gcBlobPrefix)) {
134
+ const partial = await readAndParse<IGcState>(storage, blobId);
135
+ if (gcState === undefined) {
136
+ gcState = { gcNodes: { ...partial.gcNodes } };
137
+ } else {
138
+ for (const [nodeId, nodeData] of Object.entries(partial.gcNodes)) {
139
+ gcState.gcNodes[nodeId] ??= nodeData;
140
+ }
141
+ }
142
+ }
143
+ }
144
+ return { gcState, tombstones, deletedNodes };
145
+ }
146
+
147
+ /**
148
+ * Walks a snapshot and inlines the contents of every blob reachable without
149
+ * crossing an `unreferenced` subtree boundary. Subtrees flagged
150
+ * `unreferenced: true` are skipped entirely — the summarizer sets that flag
151
+ * from GC state, so honouring it filters out dead subtrees without a
152
+ * separate GC-path traversal.
153
+ *
154
+ * The root-level `.blobs` subtree is special-cased: only its `.redirectTable`
155
+ * blob is read, because attachment blob contents are captured separately via
156
+ * {@link captureReferencedAttachmentBlobs}.
157
+ */
158
+ export async function readReferencedSnapshotBlobs(
159
+ snapshot: ISnapshot | ISnapshotTree,
160
+ storage: Pick<IDocumentStorageService, "readBlob">,
161
+ ): Promise<ISerializableBlobContents> {
162
+ const { tree, read } = toTreeAndReader(snapshot, storage);
163
+ const ids = new Set<string>();
164
+ collectReferencedBlobIds(tree, true, ids);
165
+ const blobs: ISerializableBlobContents = {};
166
+ await mapWithConcurrency([...ids], maxReadConcurrency, async (id) => {
167
+ const data = await read(id);
168
+ blobs[id] = bufferToString(data, "utf8");
169
+ });
170
+ return blobs;
171
+ }
172
+
173
+ /**
174
+ * Synchronously walks the snapshot tree and gathers the set of blob ids that
175
+ * should be inlined. Subtrees flagged `unreferenced: true` are skipped
176
+ * entirely. The root-level `.blobs` subtree is special-cased: only its
177
+ * `.redirectTable` id is collected, because attachment blob contents are
178
+ * captured separately via {@link captureReferencedAttachmentBlobs}.
179
+ */
180
+ function collectReferencedBlobIds(
181
+ tree: ISnapshotTree,
182
+ isRoot: boolean,
183
+ ids: Set<string>,
184
+ ): void {
185
+ if (tree.unreferenced === true) {
186
+ return;
187
+ }
188
+ for (const blobId of Object.values(tree.blobs)) {
189
+ ids.add(blobId);
190
+ }
191
+ for (const [key, subTree] of Object.entries(tree.trees)) {
192
+ if (isRoot && key === blobsTreeName) {
193
+ const tableBlobId = subTree.blobs[redirectTableBlobName];
194
+ if (tableBlobId !== undefined) {
195
+ ids.add(tableBlobId);
196
+ }
197
+ } else {
198
+ collectReferencedBlobIds(subTree, false, ids);
199
+ }
200
+ }
201
+ }
202
+
203
+ function toTreeAndReader(
204
+ snapshot: ISnapshot | ISnapshotTree,
205
+ storage: Pick<IDocumentStorageService, "readBlob">,
206
+ ): { tree: ISnapshotTree; read: BlobReader } {
207
+ if ("snapshotTree" in snapshot) {
208
+ const blobContents = snapshot.blobContents;
209
+ return {
210
+ tree: snapshot.snapshotTree,
211
+ read: async (id) => blobContents.get(id) ?? storage.readBlob(id),
212
+ };
213
+ }
214
+ return { tree: snapshot, read: async (id) => storage.readBlob(id) };
215
+ }
216
+
217
+ /**
218
+ * Fetches attachment blob contents from a snapshot, filtered by GC
219
+ * reachability. Blobs GC has explicitly marked unreferenced, tombstoned, or
220
+ * deleted are skipped. Blobs absent from the GC graph are kept — GC state
221
+ * lags behind recent attachments and dropping them would lose live data.
222
+ * If `gcData` is `undefined`, every attachment blob is returned.
223
+ *
224
+ * The returned map is keyed by attachment blob storage id. Values are the
225
+ * raw bytes encoded as **base64** strings — attachment blobs may carry
226
+ * arbitrary binary payloads (images, encrypted data, etc.) and a
227
+ * UTF-8 round-trip would silently corrupt non-UTF-8 byte sequences with
228
+ * replacement characters. The runtime's own pending-blob serializer uses
229
+ * base64 for the same reason. This diverges from the structural-blob path
230
+ * in {@link readReferencedSnapshotBlobs}, which encodes UTF-8 because those
231
+ * blobs are JSON or other text the runtime authored. Callers must keep the
232
+ * two encodings on separate fields of the pending state so the load side
233
+ * can decode each correctly.
234
+ */
235
+ export async function captureReferencedAttachmentBlobs(
236
+ baseSnapshot: ISnapshotTree,
237
+ storage: Pick<IDocumentStorageService, "readBlob">,
238
+ gcData: IGcSnapshotData | undefined,
239
+ ): Promise<IBase64BlobContents> {
240
+ const blobsTree: ISnapshotTree | undefined = baseSnapshot.trees[blobsTreeName];
241
+ if (blobsTree === undefined) {
242
+ return {};
243
+ }
244
+ const localIdToStorageId = await readRedirectTable(blobsTree, storage);
245
+ if (localIdToStorageId.size === 0) {
246
+ return {};
247
+ }
248
+
249
+ const unreferencedLocalIds =
250
+ gcData === undefined ? undefined : collectUnreferencedBlobLocalIds(gcData);
251
+
252
+ const storageIdsToFetch = new Set<string>();
253
+ for (const [localId, storageId] of localIdToStorageId) {
254
+ if (unreferencedLocalIds?.has(localId) !== true) {
255
+ storageIdsToFetch.add(storageId);
256
+ }
257
+ }
258
+
259
+ const contents: IBase64BlobContents = {};
260
+ await mapWithConcurrency([...storageIdsToFetch], maxReadConcurrency, async (storageId) => {
261
+ const buffer = await storage.readBlob(storageId);
262
+ contents[storageId] = bufferToString(buffer, "base64");
263
+ });
264
+ return contents;
265
+ }
266
+
267
+ /**
268
+ * Reconstructs the BlobManager's redirect table from a `.blobs` subtree.
269
+ * Mirrors `toRedirectTable` in blobManagerSnapSum.ts.
270
+ */
271
+ async function readRedirectTable(
272
+ blobsTree: ISnapshotTree,
273
+ storage: Pick<IDocumentStorageService, "readBlob">,
274
+ ): Promise<Map<string, string>> {
275
+ const redirectTable = new Map<string, string>();
276
+ const tableBlobId: string | undefined = blobsTree.blobs[redirectTableBlobName];
277
+ if (tableBlobId !== undefined) {
278
+ const entries = await readAndParse<[string, string][]>(storage, tableBlobId);
279
+ for (const [localId, storageId] of entries) {
280
+ redirectTable.set(localId, storageId);
281
+ }
282
+ }
283
+ for (const [key, storageId] of Object.entries(blobsTree.blobs)) {
284
+ if (key !== redirectTableBlobName) {
285
+ // Identity mapping: storage ids referenced directly in handles (legacy).
286
+ redirectTable.set(storageId, storageId);
287
+ }
288
+ }
289
+ return redirectTable;
290
+ }
291
+
292
+ /**
293
+ * Collects the set of blob localIds that GC has explicitly marked as
294
+ * unreferenced (via `unreferencedTimestampMs` on a gc node), tombstoned, or
295
+ * deleted. Tombstones and deletedNodes are applied regardless of whether
296
+ * `gcState` is present — they are authoritative on their own and must not
297
+ * be silently dropped when gc state is absent but tombstone/deleted lists
298
+ * exist.
299
+ */
300
+ function collectUnreferencedBlobLocalIds(gcData: IGcSnapshotData): Set<string> {
301
+ const blobPathPrefix = `/${blobManagerBasePath}/`;
302
+ const unreferenced = new Set<string>();
303
+ if (gcData.gcState !== undefined) {
304
+ for (const [nodePath, nodeData] of Object.entries(gcData.gcState.gcNodes)) {
305
+ if (
306
+ nodePath.startsWith(blobPathPrefix) &&
307
+ nodeData.unreferencedTimestampMs !== undefined
308
+ ) {
309
+ unreferenced.add(nodePath.slice(blobPathPrefix.length));
310
+ }
311
+ }
312
+ }
313
+ for (const nodePath of [...(gcData.tombstones ?? []), ...(gcData.deletedNodes ?? [])]) {
314
+ if (nodePath.startsWith(blobPathPrefix)) {
315
+ unreferenced.add(nodePath.slice(blobPathPrefix.length));
316
+ }
317
+ }
318
+ return unreferenced;
319
+ }
320
+
321
+ /**
322
+ * A blob reference extracted from a `BlobAttach` op. `localId` is the
323
+ * `BlobManager` GC identity for the blob; `storageId` is the id used for
324
+ * `IDocumentStorageService.readBlob`.
325
+ *
326
+ * @internal
327
+ */
328
+ export interface IBlobAttachReference {
329
+ readonly localId: string;
330
+ readonly storageId: string;
331
+ }
332
+
333
+ interface IBlobAttachLikeMetadata {
334
+ readonly localId: string;
335
+ readonly blobId: string;
336
+ }
337
+
338
+ function isBlobAttachLikeMetadata(metadata: unknown): metadata is IBlobAttachLikeMetadata {
339
+ if (typeof metadata !== "object" || metadata === null) {
340
+ return false;
341
+ }
342
+ const candidate = metadata as { localId?: unknown; blobId?: unknown };
343
+ return typeof candidate.localId === "string" && typeof candidate.blobId === "string";
344
+ }
345
+
346
+ /**
347
+ * Extracts every `BlobAttach` reference an op carries. Returns an empty array
348
+ * for non-blobAttach ops.
349
+ *
350
+ * This is the single place in the loader that interprets the BlobAttach
351
+ * wire format. Capture and load-side reasoning about ops should call into
352
+ * this function rather than reading `op.metadata` directly, so a future
353
+ * protocol change touches one site.
354
+ *
355
+ * BlobAttach ops carry `(localId, storageId)` directly on
356
+ * `ISequencedDocumentMessage.metadata` and are not grouped — the container
357
+ * runtime routes them through a separate `outbox.submitBlobAttach` lane,
358
+ * and `OpGroupingManager.groupBatch` asserts (0x5dd) that no op carrying
359
+ * non-batch metadata enters a grouped batch. If either guarantee changes,
360
+ * extend this function rather than each call site.
361
+ *
362
+ * @internal
363
+ */
364
+ export function extractBlobAttachReferences(
365
+ op: Pick<ISequencedDocumentMessage, "metadata">,
366
+ ): IBlobAttachReference[] {
367
+ if (!isBlobAttachLikeMetadata(op.metadata)) {
368
+ return [];
369
+ }
370
+ return [{ localId: op.metadata.localId, storageId: op.metadata.blobId }];
371
+ }
372
+
373
+ /**
374
+ * Set of attachment-blob localIds that GC has marked unreferenced,
375
+ * tombstoned, or deleted in the base snapshot. `undefined` if `gcData`
376
+ * is `undefined` (GC disabled / pre-GC document).
377
+ *
378
+ * @internal
379
+ */
380
+ export function unreferencedAttachmentBlobLocalIds(
381
+ gcData: IGcSnapshotData | undefined,
382
+ ): Set<string> | undefined {
383
+ return gcData === undefined ? undefined : collectUnreferencedBlobLocalIds(gcData);
384
+ }
385
+
386
+ /**
387
+ * Inline attachment blob contents for the given `(localId, storageId)`
388
+ * references. Skips entries already present in `existing` (de-dupe with
389
+ * the snapshot path) and entries whose `localId` is in
390
+ * `unreferencedLocalIds`. Returns only the freshly-read entries; the
391
+ * caller merges them into the existing map.
392
+ *
393
+ * @internal
394
+ */
395
+ export async function inlineAttachmentBlobsByReference(
396
+ references: readonly IBlobAttachReference[],
397
+ storage: Pick<IDocumentStorageService, "readBlob">,
398
+ unreferencedLocalIds: ReadonlySet<string> | undefined,
399
+ existing: Readonly<IBase64BlobContents>,
400
+ ): Promise<IBase64BlobContents> {
401
+ const storageIdsToFetch = new Set<string>();
402
+ for (const { localId, storageId } of references) {
403
+ if (unreferencedLocalIds?.has(localId) === true) {
404
+ continue;
405
+ }
406
+ if (existing[storageId] !== undefined) {
407
+ continue;
408
+ }
409
+ storageIdsToFetch.add(storageId);
410
+ }
411
+ const added: IBase64BlobContents = {};
412
+ if (storageIdsToFetch.size === 0) {
413
+ return added;
414
+ }
415
+ await mapWithConcurrency([...storageIdsToFetch], maxReadConcurrency, async (storageId) => {
416
+ const buffer = await storage.readBlob(storageId);
417
+ added[storageId] = bufferToString(buffer, "base64");
418
+ });
419
+ return added;
420
+ }
421
+
422
+ /**
423
+ * Returns true if any referenced subtree of `baseSnapshot` declares a
424
+ * `groupId` — the snapshot-tree wire field that carries the runtime's
425
+ * loading-group identifier. Subtrees flagged `unreferenced` are skipped —
426
+ * a dead subtree's `groupId` would not be loaded by the runtime either.
427
+ *
428
+ * `captureFullContainerState` does not yet support loading groups: prefetching
429
+ * per-group snapshots adds a code path that has no end-to-end coverage and no
430
+ * known production consumer. Callers use this to fail fast with a `UsageError`
431
+ * rather than silently producing a pending state that omits group data.
432
+ */
433
+ export function snapshotHasLoadingGroups(baseSnapshot: ISnapshotTree): boolean {
434
+ if (baseSnapshot.unreferenced === true) {
435
+ return false;
436
+ }
437
+ if (baseSnapshot.groupId !== undefined) {
438
+ return true;
439
+ }
440
+ for (const child of Object.values(baseSnapshot.trees)) {
441
+ if (snapshotHasLoadingGroups(child)) {
442
+ return true;
443
+ }
444
+ }
445
+ return false;
446
+ }