@fluidframework/driver-utils 2.0.0-rc.1.0.4 → 2.0.0-rc.2.0.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.
- package/{.eslintrc.js → .eslintrc.cjs} +5 -2
- package/{.mocharc.js → .mocharc.cjs} +1 -1
- package/CHANGELOG.md +32 -0
- package/{api-extractor-esm.json → api-extractor-cjs.json} +5 -1
- package/api-extractor-lint.json +1 -1
- package/api-extractor.json +1 -1
- package/api-report/driver-utils.api.md +22 -18
- package/dist/adapters/compression/documentServiceCompressionAdapter.d.ts +2 -2
- package/dist/adapters/compression/documentServiceCompressionAdapter.d.ts.map +1 -1
- package/dist/adapters/compression/documentServiceCompressionAdapter.js +8 -4
- package/dist/adapters/compression/documentServiceCompressionAdapter.js.map +1 -1
- package/dist/adapters/compression/documentServiceFactoryCompressionAdapter.d.ts +2 -2
- package/dist/adapters/compression/documentServiceFactoryCompressionAdapter.d.ts.map +1 -1
- package/dist/adapters/compression/documentServiceFactoryCompressionAdapter.js +7 -7
- package/dist/adapters/compression/documentServiceFactoryCompressionAdapter.js.map +1 -1
- package/dist/adapters/compression/index.d.ts +3 -3
- package/dist/adapters/compression/index.d.ts.map +1 -1
- package/dist/adapters/compression/index.js +7 -7
- package/dist/adapters/compression/index.js.map +1 -1
- package/dist/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.d.ts +2 -2
- package/dist/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.d.ts.map +1 -1
- package/dist/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.js +11 -11
- package/dist/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.js.map +1 -1
- package/dist/adapters/compression/summaryblob/index.d.ts +1 -1
- package/dist/adapters/compression/summaryblob/index.d.ts.map +1 -1
- package/dist/adapters/compression/summaryblob/index.js +3 -3
- package/dist/adapters/compression/summaryblob/index.js.map +1 -1
- package/dist/adapters/index.d.ts +2 -2
- package/dist/adapters/index.d.ts.map +1 -1
- package/dist/adapters/index.js +6 -6
- package/dist/adapters/index.js.map +1 -1
- package/dist/adapters/predefinedAdapters.d.ts +1 -1
- package/dist/adapters/predefinedAdapters.d.ts.map +1 -1
- package/dist/adapters/predefinedAdapters.js +4 -4
- package/dist/adapters/predefinedAdapters.js.map +1 -1
- package/dist/documentServiceProxy.d.ts +3 -2
- package/dist/documentServiceProxy.d.ts.map +1 -1
- package/dist/documentServiceProxy.js +3 -1
- package/dist/documentServiceProxy.js.map +1 -1
- package/dist/documentStorageServiceProxy.d.ts +2 -2
- package/dist/documentStorageServiceProxy.d.ts.map +1 -1
- package/dist/documentStorageServiceProxy.js +7 -3
- package/dist/documentStorageServiceProxy.js.map +1 -1
- package/dist/driver-utils-alpha.d.ts +6 -2
- package/dist/driver-utils-beta.d.ts +10 -2
- package/dist/driver-utils-public.d.ts +10 -2
- package/dist/driver-utils-untrimmed.d.ts +30 -17
- package/dist/error.d.ts +2 -2
- package/dist/error.d.ts.map +1 -1
- package/dist/error.js +1 -3
- package/dist/error.js.map +1 -1
- package/dist/index.d.ts +17 -16
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +64 -62
- package/dist/index.js.map +1 -1
- package/dist/insecureUrlResolver.d.ts +3 -2
- package/dist/insecureUrlResolver.d.ts.map +1 -1
- package/dist/insecureUrlResolver.js +9 -7
- package/dist/insecureUrlResolver.js.map +1 -1
- package/dist/network.d.ts +13 -10
- package/dist/network.d.ts.map +1 -1
- package/dist/network.js +9 -12
- package/dist/network.js.map +1 -1
- package/dist/networkUtils.d.ts +2 -3
- package/dist/networkUtils.d.ts.map +1 -1
- package/dist/networkUtils.js +3 -3
- package/dist/networkUtils.js.map +1 -1
- package/dist/package.json +3 -0
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/dist/parallelRequests.d.ts +3 -3
- package/dist/parallelRequests.d.ts.map +1 -1
- package/dist/parallelRequests.js +10 -10
- package/dist/parallelRequests.js.map +1 -1
- package/dist/prefetchDocumentStorageService.d.ts +1 -1
- package/dist/prefetchDocumentStorageService.d.ts.map +1 -1
- package/dist/prefetchDocumentStorageService.js +4 -4
- package/dist/prefetchDocumentStorageService.js.map +1 -1
- package/dist/runWithRetry.js +6 -6
- package/dist/runWithRetry.js.map +1 -1
- package/dist/storageUtils.d.ts +13 -0
- package/dist/storageUtils.d.ts.map +1 -0
- package/dist/storageUtils.js +17 -0
- package/dist/storageUtils.js.map +1 -0
- package/dist/treeConversions.d.ts.map +1 -1
- package/dist/treeConversions.js +7 -6
- package/dist/treeConversions.js.map +1 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/adapters/compression/{compressionTypes.d.mts → compressionTypes.d.ts} +1 -1
- package/lib/adapters/compression/compressionTypes.d.ts.map +1 -0
- package/lib/adapters/compression/{compressionTypes.mjs → compressionTypes.js} +1 -1
- package/lib/adapters/compression/compressionTypes.js.map +1 -0
- package/lib/adapters/compression/{documentServiceCompressionAdapter.d.mts → documentServiceCompressionAdapter.d.ts} +3 -3
- package/lib/adapters/compression/documentServiceCompressionAdapter.d.ts.map +1 -0
- package/lib/adapters/compression/{documentServiceCompressionAdapter.mjs → documentServiceCompressionAdapter.js} +7 -3
- package/lib/adapters/compression/documentServiceCompressionAdapter.js.map +1 -0
- package/lib/adapters/compression/{documentServiceFactoryCompressionAdapter.d.mts → documentServiceFactoryCompressionAdapter.d.ts} +3 -3
- package/lib/adapters/compression/documentServiceFactoryCompressionAdapter.d.ts.map +1 -0
- package/lib/adapters/compression/{documentServiceFactoryCompressionAdapter.mjs → documentServiceFactoryCompressionAdapter.js} +4 -4
- package/lib/adapters/compression/documentServiceFactoryCompressionAdapter.js.map +1 -0
- package/lib/adapters/compression/{index.d.mts → index.d.ts} +4 -4
- package/lib/adapters/compression/index.d.ts.map +1 -0
- package/lib/adapters/compression/{index.mjs → index.js} +4 -4
- package/lib/adapters/compression/index.js.map +1 -0
- package/lib/adapters/compression/summaryblob/{documentStorageServiceSummaryBlobCompressionAdapter.d.mts → documentStorageServiceSummaryBlobCompressionAdapter.d.ts} +3 -3
- package/lib/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.d.ts.map +1 -0
- package/lib/adapters/compression/summaryblob/{documentStorageServiceSummaryBlobCompressionAdapter.mjs → documentStorageServiceSummaryBlobCompressionAdapter.js} +3 -3
- package/lib/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.js.map +1 -0
- package/lib/adapters/compression/summaryblob/{index.mjs → index.d.ts} +2 -2
- package/lib/adapters/compression/summaryblob/index.d.ts.map +1 -0
- package/lib/adapters/compression/summaryblob/{index.d.mts → index.js} +2 -2
- package/lib/adapters/compression/summaryblob/index.js.map +1 -0
- package/lib/adapters/{index.d.mts → index.d.ts} +3 -3
- package/lib/adapters/index.d.ts.map +1 -0
- package/lib/adapters/{index.mjs → index.js} +3 -3
- package/lib/adapters/index.js.map +1 -0
- package/lib/adapters/{predefinedAdapters.d.mts → predefinedAdapters.d.ts} +2 -2
- package/lib/adapters/predefinedAdapters.d.ts.map +1 -0
- package/lib/adapters/{predefinedAdapters.mjs → predefinedAdapters.js} +2 -2
- package/lib/adapters/predefinedAdapters.js.map +1 -0
- package/lib/{blob.d.mts → blob.d.ts} +1 -1
- package/lib/blob.d.ts.map +1 -0
- package/lib/{blob.mjs → blob.js} +1 -1
- package/lib/blob.js.map +1 -0
- package/lib/{buildSnapshotTree.d.mts → buildSnapshotTree.d.ts} +1 -1
- package/lib/buildSnapshotTree.d.ts.map +1 -0
- package/lib/{buildSnapshotTree.mjs → buildSnapshotTree.js} +1 -1
- package/lib/buildSnapshotTree.js.map +1 -0
- package/lib/{documentServiceFactoryProxy.d.mts → documentServiceFactoryProxy.d.ts} +1 -1
- package/lib/documentServiceFactoryProxy.d.ts.map +1 -0
- package/lib/{documentServiceFactoryProxy.mjs → documentServiceFactoryProxy.js} +1 -1
- package/lib/documentServiceFactoryProxy.js.map +1 -0
- package/lib/{documentServiceProxy.d.mts → documentServiceProxy.d.ts} +4 -3
- package/lib/documentServiceProxy.d.ts.map +1 -0
- package/lib/{documentServiceProxy.mjs → documentServiceProxy.js} +4 -2
- package/lib/documentServiceProxy.js.map +1 -0
- package/lib/{documentStorageServiceProxy.d.mts → documentStorageServiceProxy.d.ts} +3 -3
- package/lib/documentStorageServiceProxy.d.ts.map +1 -0
- package/lib/{documentStorageServiceProxy.mjs → documentStorageServiceProxy.js} +8 -4
- package/lib/documentStorageServiceProxy.js.map +1 -0
- package/lib/{driver-utils-alpha.d.mts → driver-utils-alpha.d.ts} +6 -2
- package/lib/{driver-utils-public.d.mts → driver-utils-beta.d.ts} +10 -2
- package/lib/{driver-utils-beta.d.mts → driver-utils-public.d.ts} +10 -2
- package/lib/{driver-utils-untrimmed.d.mts → driver-utils-untrimmed.d.ts} +30 -17
- package/lib/{error.d.mts → error.d.ts} +3 -3
- package/lib/error.d.ts.map +1 -0
- package/lib/{error.mjs → error.js} +3 -4
- package/lib/error.js.map +1 -0
- package/lib/{index.d.mts → index.d.ts} +18 -17
- package/lib/index.d.ts.map +1 -0
- package/lib/{index.mjs → index.js} +18 -17
- package/lib/index.js.map +1 -0
- package/lib/{insecureUrlResolver.d.mts → insecureUrlResolver.d.ts} +4 -3
- package/lib/insecureUrlResolver.d.ts.map +1 -0
- package/lib/{insecureUrlResolver.mjs → insecureUrlResolver.js} +10 -8
- package/lib/insecureUrlResolver.js.map +1 -0
- package/lib/{messageRecognition.d.mts → messageRecognition.d.ts} +5 -1
- package/lib/messageRecognition.d.ts.map +1 -0
- package/lib/{messageRecognition.mjs → messageRecognition.js} +5 -1
- package/lib/messageRecognition.js.map +1 -0
- package/lib/{network.d.mts → network.d.ts} +14 -11
- package/lib/network.d.ts.map +1 -0
- package/lib/{network.mjs → network.js} +11 -16
- package/lib/network.js.map +1 -0
- package/lib/networkUtils.d.ts +10 -0
- package/lib/networkUtils.d.ts.map +1 -0
- package/lib/{networkUtils.mjs → networkUtils.js} +2 -2
- package/lib/networkUtils.js.map +1 -0
- package/lib/{packageVersion.d.mts → packageVersion.d.ts} +2 -2
- package/lib/packageVersion.d.ts.map +1 -0
- package/lib/{packageVersion.mjs → packageVersion.js} +2 -2
- package/lib/packageVersion.js.map +1 -0
- package/lib/{parallelRequests.d.mts → parallelRequests.d.ts} +4 -4
- package/lib/parallelRequests.d.ts.map +1 -0
- package/lib/{parallelRequests.mjs → parallelRequests.js} +10 -5
- package/lib/parallelRequests.js.map +1 -0
- package/lib/{prefetchDocumentStorageService.d.mts → prefetchDocumentStorageService.d.ts} +6 -2
- package/lib/prefetchDocumentStorageService.d.ts.map +1 -0
- package/lib/{prefetchDocumentStorageService.mjs → prefetchDocumentStorageService.js} +7 -3
- package/lib/prefetchDocumentStorageService.js.map +1 -0
- package/lib/{rateLimiter.d.mts → rateLimiter.d.ts} +1 -1
- package/lib/rateLimiter.d.ts.map +1 -0
- package/lib/{rateLimiter.mjs → rateLimiter.js} +1 -1
- package/lib/rateLimiter.js.map +1 -0
- package/lib/{readAndParse.d.mts → readAndParse.d.ts} +1 -1
- package/lib/readAndParse.d.ts.map +1 -0
- package/lib/{readAndParse.mjs → readAndParse.js} +1 -1
- package/lib/readAndParse.js.map +1 -0
- package/lib/{runWithRetry.d.mts → runWithRetry.d.ts} +1 -1
- package/lib/runWithRetry.d.ts.map +1 -0
- package/lib/{runWithRetry.mjs → runWithRetry.js} +3 -3
- package/lib/runWithRetry.js.map +1 -0
- package/lib/storageUtils.d.ts +13 -0
- package/lib/storageUtils.d.ts.map +1 -0
- package/lib/storageUtils.js +13 -0
- package/lib/storageUtils.js.map +1 -0
- package/lib/{summaryForCreateNew.d.mts → summaryForCreateNew.d.ts} +1 -1
- package/lib/summaryForCreateNew.d.ts.map +1 -0
- package/lib/{summaryForCreateNew.mjs → summaryForCreateNew.js} +1 -1
- package/lib/summaryForCreateNew.js.map +1 -0
- package/lib/test/insecureUrlResolverTest.spec.js +101 -0
- package/lib/test/insecureUrlResolverTest.spec.js.map +1 -0
- package/lib/test/parallelRequests.spec.js +186 -0
- package/lib/test/parallelRequests.spec.js.map +1 -0
- package/lib/test/rateLimiter.spec.js +85 -0
- package/lib/test/rateLimiter.spec.js.map +1 -0
- package/lib/test/runWithRetry.spec.js +180 -0
- package/lib/test/runWithRetry.spec.js.map +1 -0
- package/lib/test/summaryCompressionData.js +170 -0
- package/lib/test/summaryCompressionData.js.map +1 -0
- package/lib/test/summaryCompresssionTester.spec.js +429 -0
- package/lib/test/summaryCompresssionTester.spec.js.map +1 -0
- package/lib/test/types/validateDriverUtilsPrevious.generated.js +108 -0
- package/lib/test/types/validateDriverUtilsPrevious.generated.js.map +1 -0
- package/lib/{treeConversions.d.mts → treeConversions.d.ts} +1 -1
- package/lib/treeConversions.d.ts.map +1 -0
- package/lib/{treeConversions.mjs → treeConversions.js} +4 -3
- package/lib/treeConversions.js.map +1 -0
- package/package.json +82 -28
- package/src/adapters/compression/documentServiceCompressionAdapter.ts +9 -3
- package/src/adapters/compression/documentServiceFactoryCompressionAdapter.ts +4 -4
- package/src/adapters/compression/index.ts +3 -3
- package/src/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.ts +2 -2
- package/src/adapters/compression/summaryblob/index.ts +1 -1
- package/src/adapters/index.ts +2 -2
- package/src/adapters/predefinedAdapters.ts +1 -1
- package/src/documentServiceProxy.ts +9 -2
- package/src/documentStorageServiceProxy.ts +12 -4
- package/src/error.ts +2 -4
- package/src/index.ts +17 -16
- package/src/insecureUrlResolver.ts +8 -6
- package/src/network.ts +11 -16
- package/src/networkUtils.ts +3 -4
- package/src/packageVersion.ts +1 -1
- package/src/parallelRequests.ts +11 -11
- package/src/prefetchDocumentStorageService.ts +2 -2
- package/src/runWithRetry.ts +2 -2
- package/src/storageUtils.ts +18 -0
- package/src/treeConversions.ts +3 -2
- package/tsconfig.cjs.json +7 -0
- package/tsconfig.json +2 -5
- package/lib/adapters/compression/compressionTypes.d.mts.map +0 -1
- package/lib/adapters/compression/compressionTypes.mjs.map +0 -1
- package/lib/adapters/compression/documentServiceCompressionAdapter.d.mts.map +0 -1
- package/lib/adapters/compression/documentServiceCompressionAdapter.mjs.map +0 -1
- package/lib/adapters/compression/documentServiceFactoryCompressionAdapter.d.mts.map +0 -1
- package/lib/adapters/compression/documentServiceFactoryCompressionAdapter.mjs.map +0 -1
- package/lib/adapters/compression/index.d.mts.map +0 -1
- package/lib/adapters/compression/index.mjs.map +0 -1
- package/lib/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.d.mts.map +0 -1
- package/lib/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.mjs.map +0 -1
- package/lib/adapters/compression/summaryblob/index.d.mts.map +0 -1
- package/lib/adapters/compression/summaryblob/index.mjs.map +0 -1
- package/lib/adapters/index.d.mts.map +0 -1
- package/lib/adapters/index.mjs.map +0 -1
- package/lib/adapters/predefinedAdapters.d.mts.map +0 -1
- package/lib/adapters/predefinedAdapters.mjs.map +0 -1
- package/lib/blob.d.mts.map +0 -1
- package/lib/blob.mjs.map +0 -1
- package/lib/buildSnapshotTree.d.mts.map +0 -1
- package/lib/buildSnapshotTree.mjs.map +0 -1
- package/lib/documentServiceFactoryProxy.d.mts.map +0 -1
- package/lib/documentServiceFactoryProxy.mjs.map +0 -1
- package/lib/documentServiceProxy.d.mts.map +0 -1
- package/lib/documentServiceProxy.mjs.map +0 -1
- package/lib/documentStorageServiceProxy.d.mts.map +0 -1
- package/lib/documentStorageServiceProxy.mjs.map +0 -1
- package/lib/error.d.mts.map +0 -1
- package/lib/error.mjs.map +0 -1
- package/lib/index.d.mts.map +0 -1
- package/lib/index.mjs.map +0 -1
- package/lib/insecureUrlResolver.d.mts.map +0 -1
- package/lib/insecureUrlResolver.mjs.map +0 -1
- package/lib/messageRecognition.d.mts.map +0 -1
- package/lib/messageRecognition.mjs.map +0 -1
- package/lib/network.d.mts.map +0 -1
- package/lib/network.mjs.map +0 -1
- package/lib/networkUtils.d.mts +0 -11
- package/lib/networkUtils.d.mts.map +0 -1
- package/lib/networkUtils.mjs.map +0 -1
- package/lib/packageVersion.d.mts.map +0 -1
- package/lib/packageVersion.mjs.map +0 -1
- package/lib/parallelRequests.d.mts.map +0 -1
- package/lib/parallelRequests.mjs.map +0 -1
- package/lib/prefetchDocumentStorageService.d.mts.map +0 -1
- package/lib/prefetchDocumentStorageService.mjs.map +0 -1
- package/lib/rateLimiter.d.mts.map +0 -1
- package/lib/rateLimiter.mjs.map +0 -1
- package/lib/readAndParse.d.mts.map +0 -1
- package/lib/readAndParse.mjs.map +0 -1
- package/lib/runWithRetry.d.mts.map +0 -1
- package/lib/runWithRetry.mjs.map +0 -1
- package/lib/summaryForCreateNew.d.mts.map +0 -1
- package/lib/summaryForCreateNew.mjs.map +0 -1
- package/lib/treeConversions.d.mts.map +0 -1
- package/lib/treeConversions.mjs.map +0 -1
|
@@ -4,12 +4,15 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
module.exports = {
|
|
7
|
-
extends: [
|
|
7
|
+
extends: [
|
|
8
|
+
require.resolve("@fluidframework/eslint-config-fluid/minimal-deprecated"),
|
|
9
|
+
"prettier",
|
|
10
|
+
],
|
|
8
11
|
parserOptions: {
|
|
9
12
|
project: ["./tsconfig.json", "./src/test/tsconfig.json"],
|
|
10
13
|
},
|
|
11
14
|
rules: {
|
|
12
|
-
"import/no-nodejs-modules": ["error"
|
|
15
|
+
"import/no-nodejs-modules": ["error"],
|
|
13
16
|
},
|
|
14
17
|
overrides: [
|
|
15
18
|
{
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
"use strict";
|
|
7
7
|
|
|
8
|
-
const getFluidTestMochaConfig = require("@
|
|
8
|
+
const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
|
|
9
9
|
|
|
10
10
|
const packageDir = __dirname;
|
|
11
11
|
const config = getFluidTestMochaConfig(packageDir);
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# @fluidframework/driver-utils
|
|
2
2
|
|
|
3
|
+
## 2.0.0-rc.2.0.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- Resolved URLs no longer use non-standard protocols ([#19840](https://github.com/microsoft/FluidFramework/issues/19840)) [9d3d185183](https://github.com/microsoft/FluidFramework/commits/9d3d1851830d953792a6dfad60dde6f1c59480de)
|
|
8
|
+
|
|
9
|
+
Previously, `IResolvedUrl.url` could use a non-standard protocol like `fluid://`, `fluid-odsp://`, or `fluid-test://`. These have been replaced with `https://` to permit standards-compliant URL parsing.
|
|
10
|
+
|
|
11
|
+
- driver-definitions: Deprecate `ISnapshotContents` ([#19314](https://github.com/microsoft/FluidFramework/issues/19314)) [fc731b69de](https://github.com/microsoft/FluidFramework/commits/fc731b69deed4a2987e9b97d8918492d689bafbc)
|
|
12
|
+
|
|
13
|
+
`ISnapshotContents` is deprecated. It has been replaced with `ISnapshot`.
|
|
14
|
+
|
|
15
|
+
- driver-definitions: repositoryUrl removed from IDocumentStorageService ([#19522](https://github.com/microsoft/FluidFramework/issues/19522)) [90eb3c9d33](https://github.com/microsoft/FluidFramework/commits/90eb3c9d33d80e24caa1393a50f414c5602f6aa3)
|
|
16
|
+
|
|
17
|
+
The `repositoryUrl` member of `IDocumentStorageService` was unused and always equal to the empty string. It has been removed.
|
|
18
|
+
|
|
19
|
+
- Deprecated error-related enums have been removed ([#19067](https://github.com/microsoft/FluidFramework/issues/19067)) [59793302e5](https://github.com/microsoft/FluidFramework/commits/59793302e56784cfb6ace0e6469345f3565b3312)
|
|
20
|
+
|
|
21
|
+
Error-related enums `ContainerErrorType`, `DriverErrorType`, `OdspErrorType` and `RouterliciousErrorType` were previously
|
|
22
|
+
deprecated and are now removed. There are replacement object-based enumerations of `ContainerErrorTypes`,
|
|
23
|
+
`DriverErrorTypes`, `OdspErrorTypes` and `RouterliciousErrorTypes`. Refer to the release notes of [Fluid Framework version
|
|
24
|
+
2.0.0-internal.7.0.0](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.0.0-internal.7.0.0) for details
|
|
25
|
+
on the replacements.
|
|
26
|
+
|
|
27
|
+
- container-definitions: Added containerMetadata prop on IContainer interface ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
|
|
28
|
+
|
|
29
|
+
Added `containerMetadata` prop on IContainer interface.
|
|
30
|
+
|
|
31
|
+
- runtime-definitions: Moved ISignalEnvelope interface to core-interfaces ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
|
|
32
|
+
|
|
33
|
+
The `ISignalEnvelope` interface has been moved to the @fluidframework/core-interfaces package.
|
|
34
|
+
|
|
3
35
|
## 2.0.0-rc.1.0.0
|
|
4
36
|
|
|
5
37
|
### Minor Changes
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
-
"extends": "../../../common/build/build-common/api-extractor-base
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
|
|
4
|
+
// CJS is actually secondary; so, no report.
|
|
5
|
+
"apiReport": {
|
|
6
|
+
"enabled": false
|
|
7
|
+
}
|
|
4
8
|
}
|
package/api-extractor-lint.json
CHANGED
package/api-extractor.json
CHANGED
|
@@ -22,15 +22,17 @@ import { ILocationRedirectionError } from '@fluidframework/driver-definitions';
|
|
|
22
22
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
23
23
|
import { IResolvedUrl } from '@fluidframework/driver-definitions';
|
|
24
24
|
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
25
|
+
import { ISnapshot } from '@fluidframework/driver-definitions';
|
|
26
|
+
import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions';
|
|
25
27
|
import { ISnapshotTree } from '@fluidframework/protocol-definitions';
|
|
26
28
|
import { IStream } from '@fluidframework/driver-definitions';
|
|
27
29
|
import { IStreamResult } from '@fluidframework/driver-definitions';
|
|
28
30
|
import { ISummaryContext } from '@fluidframework/driver-definitions';
|
|
29
31
|
import { ISummaryHandle } from '@fluidframework/protocol-definitions';
|
|
30
32
|
import { ISummaryTree } from '@fluidframework/protocol-definitions';
|
|
31
|
-
import {
|
|
33
|
+
import { ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
|
|
34
|
+
import { ITelemetryErrorEventExt } from '@fluidframework/telemetry-utils';
|
|
32
35
|
import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
|
|
33
|
-
import { ITelemetryProperties } from '@fluidframework/core-interfaces';
|
|
34
36
|
import { IThrottlingWarning } from '@fluidframework/driver-definitions';
|
|
35
37
|
import { ITree } from '@fluidframework/protocol-definitions';
|
|
36
38
|
import { ITreeEntry } from '@fluidframework/protocol-definitions';
|
|
@@ -65,7 +67,7 @@ export class AuthorizationError extends LoggingError implements IAuthorizationEr
|
|
|
65
67
|
// (undocumented)
|
|
66
68
|
readonly claims: string | undefined;
|
|
67
69
|
// (undocumented)
|
|
68
|
-
readonly errorType
|
|
70
|
+
readonly errorType: "authorizationError";
|
|
69
71
|
// (undocumented)
|
|
70
72
|
readonly tenantId: string | undefined;
|
|
71
73
|
}
|
|
@@ -125,9 +127,9 @@ export class DeltaStreamConnectionForbiddenError extends LoggingError implements
|
|
|
125
127
|
// (undocumented)
|
|
126
128
|
readonly canRetry = false;
|
|
127
129
|
// (undocumented)
|
|
128
|
-
static readonly errorType
|
|
130
|
+
static readonly errorType: "deltaStreamConnectionForbidden";
|
|
129
131
|
// (undocumented)
|
|
130
|
-
readonly errorType
|
|
132
|
+
readonly errorType: "deltaStreamConnectionForbidden";
|
|
131
133
|
// (undocumented)
|
|
132
134
|
readonly storageOnlyReason: string | undefined;
|
|
133
135
|
}
|
|
@@ -140,6 +142,8 @@ export class DocumentStorageServiceProxy implements IDocumentStorageService {
|
|
|
140
142
|
// (undocumented)
|
|
141
143
|
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
142
144
|
// (undocumented)
|
|
145
|
+
getSnapshot(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
146
|
+
// (undocumented)
|
|
143
147
|
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
144
148
|
// (undocumented)
|
|
145
149
|
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
@@ -151,13 +155,11 @@ export class DocumentStorageServiceProxy implements IDocumentStorageService {
|
|
|
151
155
|
// (undocumented)
|
|
152
156
|
readBlob(blobId: string): Promise<ArrayBufferLike>;
|
|
153
157
|
// (undocumented)
|
|
154
|
-
get repositoryUrl(): string;
|
|
155
|
-
// (undocumented)
|
|
156
158
|
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
157
159
|
}
|
|
158
160
|
|
|
159
161
|
// @internal
|
|
160
|
-
export type DriverErrorTelemetryProps =
|
|
162
|
+
export type DriverErrorTelemetryProps = ITelemetryBaseProperties & {
|
|
161
163
|
driverVersion: string | undefined;
|
|
162
164
|
};
|
|
163
165
|
|
|
@@ -170,7 +172,7 @@ export class FluidInvalidSchemaError extends LoggingError implements IDriverErro
|
|
|
170
172
|
// (undocumented)
|
|
171
173
|
readonly canRetry = false;
|
|
172
174
|
// (undocumented)
|
|
173
|
-
readonly errorType
|
|
175
|
+
readonly errorType: "fluidInvalidSchema";
|
|
174
176
|
}
|
|
175
177
|
|
|
176
178
|
// @internal
|
|
@@ -178,8 +180,7 @@ export class GenericNetworkError extends LoggingError implements IDriverErrorBas
|
|
|
178
180
|
constructor(message: string, canRetry: boolean, props: DriverErrorTelemetryProps);
|
|
179
181
|
// (undocumented)
|
|
180
182
|
readonly canRetry: boolean;
|
|
181
|
-
|
|
182
|
-
readonly errorType = DriverErrorType.genericNetworkError;
|
|
183
|
+
readonly errorType: "genericNetworkError";
|
|
183
184
|
}
|
|
184
185
|
|
|
185
186
|
// @internal
|
|
@@ -204,7 +205,7 @@ export interface ICompressionStorageConfig {
|
|
|
204
205
|
|
|
205
206
|
// @internal
|
|
206
207
|
export class InsecureUrlResolver implements IUrlResolver {
|
|
207
|
-
constructor(hostUrl: string, ordererUrl: string, storageUrl: string, tenantId: string, bearer: string, isForNodeTest?: boolean);
|
|
208
|
+
constructor(hostUrl: string, ordererUrl: string, storageUrl: string, deltaStreamUrl: string, tenantId: string, bearer: string, isForNodeTest?: boolean);
|
|
208
209
|
// (undocumented)
|
|
209
210
|
createCreateNewRequest(fileName?: string): IRequest;
|
|
210
211
|
// (undocumented)
|
|
@@ -222,6 +223,9 @@ export interface IProgress {
|
|
|
222
223
|
// @internal
|
|
223
224
|
export function isCombinedAppAndProtocolSummary(summary: ISummaryTree | undefined, ...optionalRootTrees: string[]): summary is CombinedAppAndProtocolSummary;
|
|
224
225
|
|
|
226
|
+
// @internal
|
|
227
|
+
export function isInstanceOfISnapshot(obj: ISnapshotTree | ISnapshot | undefined): obj is ISnapshot;
|
|
228
|
+
|
|
225
229
|
// @internal
|
|
226
230
|
export function isOnline(): OnlineStatus;
|
|
227
231
|
|
|
@@ -236,13 +240,13 @@ export class LocationRedirectionError extends LoggingError implements ILocationR
|
|
|
236
240
|
// (undocumented)
|
|
237
241
|
readonly canRetry = false;
|
|
238
242
|
// (undocumented)
|
|
239
|
-
readonly errorType
|
|
243
|
+
readonly errorType: "locationRedirection";
|
|
240
244
|
// (undocumented)
|
|
241
245
|
readonly redirectUrl: IResolvedUrl;
|
|
242
246
|
}
|
|
243
247
|
|
|
244
248
|
// @internal (undocumented)
|
|
245
|
-
export function logNetworkFailure(logger: ITelemetryLoggerExt, event:
|
|
249
|
+
export function logNetworkFailure(logger: ITelemetryLoggerExt, event: ITelemetryErrorEventExt, error?: any): void;
|
|
246
250
|
|
|
247
251
|
// @internal (undocumented)
|
|
248
252
|
export enum MessageType2 {
|
|
@@ -278,7 +282,7 @@ export enum OnlineStatus {
|
|
|
278
282
|
|
|
279
283
|
// @internal
|
|
280
284
|
export class ParallelRequests<T> {
|
|
281
|
-
constructor(from: number, to: number | undefined, payloadSize: number, logger: ITelemetryLoggerExt, requestCallback: (request: number, from: number, to: number, strongTo: boolean, props:
|
|
285
|
+
constructor(from: number, to: number | undefined, payloadSize: number, logger: ITelemetryLoggerExt, requestCallback: (request: number, from: number, to: number, strongTo: boolean, props: ITelemetryBaseProperties) => Promise<{
|
|
282
286
|
partial: boolean;
|
|
283
287
|
cancel: boolean;
|
|
284
288
|
payload: T[];
|
|
@@ -337,7 +341,7 @@ export class RateLimiter {
|
|
|
337
341
|
export function readAndParse<T>(storage: Pick<IDocumentStorageService, "readBlob">, id: string): Promise<T>;
|
|
338
342
|
|
|
339
343
|
// @internal
|
|
340
|
-
export function requestOps(get: (from: number, to: number, telemetryProps:
|
|
344
|
+
export function requestOps(get: (from: number, to: number, telemetryProps: ITelemetryBaseProperties) => Promise<IDeltasFetchResult>, concurrency: number, fromTotal: number, toTotal: number | undefined, payloadSize: number, logger: ITelemetryLoggerExt, signal?: AbortSignal, scenarioName?: string): IStream<ISequencedDocumentMessage[]>;
|
|
341
345
|
|
|
342
346
|
// @internal (undocumented)
|
|
343
347
|
export class RetryableError<T extends string> extends NetworkErrorBasic<T> {
|
|
@@ -369,7 +373,7 @@ export class ThrottlingError extends LoggingError implements IThrottlingWarning,
|
|
|
369
373
|
// (undocumented)
|
|
370
374
|
readonly canRetry = true;
|
|
371
375
|
// (undocumented)
|
|
372
|
-
readonly errorType
|
|
376
|
+
readonly errorType: "throttlingError";
|
|
373
377
|
// (undocumented)
|
|
374
378
|
readonly retryAfterSeconds: number;
|
|
375
379
|
}
|
|
@@ -393,7 +397,7 @@ export class UsageError extends LoggingError implements IDriverErrorBase, IFluid
|
|
|
393
397
|
// (undocumented)
|
|
394
398
|
readonly canRetry = false;
|
|
395
399
|
// (undocumented)
|
|
396
|
-
readonly errorType
|
|
400
|
+
readonly errorType: "usageError";
|
|
397
401
|
}
|
|
398
402
|
|
|
399
403
|
// (No @packageDocumentation comment for this package)
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import { IDocumentService, IDocumentStorageService } from "@fluidframework/driver-definitions";
|
|
6
|
-
import { DocumentServiceProxy } from "../../documentServiceProxy";
|
|
7
|
-
import { ICompressionStorageConfig } from "./compressionTypes";
|
|
6
|
+
import { DocumentServiceProxy } from "../../documentServiceProxy.js";
|
|
7
|
+
import { ICompressionStorageConfig } from "./compressionTypes.js";
|
|
8
8
|
export declare class DocumentServiceCompressionAdapter extends DocumentServiceProxy {
|
|
9
9
|
private readonly _config;
|
|
10
10
|
constructor(service: IDocumentService, _config: ICompressionStorageConfig);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documentServiceCompressionAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceCompressionAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC/F,OAAO,EAAE,oBAAoB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"documentServiceCompressionAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceCompressionAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC/F,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAErE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAElE,qBAAa,iCAAkC,SAAQ,oBAAoB;IAGzE,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADxB,OAAO,EAAE,gBAAgB,EACR,OAAO,EAAE,yBAAyB;IAWvC,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;CASjE"}
|
|
@@ -5,16 +5,20 @@
|
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
7
|
exports.DocumentServiceCompressionAdapter = void 0;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
-
class DocumentServiceCompressionAdapter extends
|
|
8
|
+
const documentServiceProxy_js_1 = require("../../documentServiceProxy.js");
|
|
9
|
+
const index_js_1 = require("./summaryblob/index.js");
|
|
10
|
+
class DocumentServiceCompressionAdapter extends documentServiceProxy_js_1.DocumentServiceProxy {
|
|
11
11
|
constructor(service, _config) {
|
|
12
12
|
super(service);
|
|
13
13
|
this._config = _config;
|
|
14
|
+
// Back-compat Old driver
|
|
15
|
+
if (service.on !== undefined) {
|
|
16
|
+
service.on("metadataUpdate", (metadata) => this.emit("metadataUpdate", metadata));
|
|
17
|
+
}
|
|
14
18
|
}
|
|
15
19
|
async connectToStorage() {
|
|
16
20
|
const storage = await super.connectToStorage();
|
|
17
|
-
const wrapped = new
|
|
21
|
+
const wrapped = new index_js_1.DocumentStorageServiceCompressionAdapter(storage, this._config);
|
|
18
22
|
await wrapped.getSnapshotTree();
|
|
19
23
|
return wrapped;
|
|
20
24
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documentServiceCompressionAdapter.js","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceCompressionAdapter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,
|
|
1
|
+
{"version":3,"file":"documentServiceCompressionAdapter.js","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceCompressionAdapter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2EAAqE;AACrE,qDAAyI;AAGzI,MAAa,iCAAkC,SAAQ,8CAAoB;IAC1E,YACC,OAAyB,EACR,OAAkC;QAEnD,KAAK,CAAC,OAAO,CAAC,CAAC;QAFE,YAAO,GAAP,OAAO,CAA2B;QAGnD,yBAAyB;QACzB,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE;YAC7B,OAAO,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,QAAgC,EAAE,EAAE,CACjE,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CACrC,CAAC;SACF;IACF,CAAC;IAEM,KAAK,CAAC,gBAAgB;QAC5B,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,gBAAgB,EAAE,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAI,mDAAmD,CACtE,OAAO,EACP,IAAI,CAAC,OAAO,CACZ,CAAC;QACF,MAAM,OAAO,CAAC,eAAe,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IAChB,CAAC;CACD;AAvBD,8EAuBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentService, IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { DocumentServiceProxy } from \"../../documentServiceProxy.js\";\nimport { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSummaryBlobCompressionAdapter } from \"./summaryblob/index.js\";\nimport { ICompressionStorageConfig } from \"./compressionTypes.js\";\n\nexport class DocumentServiceCompressionAdapter extends DocumentServiceProxy {\n\tconstructor(\n\t\tservice: IDocumentService,\n\t\tprivate readonly _config: ICompressionStorageConfig,\n\t) {\n\t\tsuper(service);\n\t\t// Back-compat Old driver\n\t\tif (service.on !== undefined) {\n\t\t\tservice.on(\"metadataUpdate\", (metadata: Record<string, string>) =>\n\t\t\t\tthis.emit(\"metadataUpdate\", metadata),\n\t\t\t);\n\t\t}\n\t}\n\n\tpublic async connectToStorage(): Promise<IDocumentStorageService> {\n\t\tconst storage = await super.connectToStorage();\n\t\tconst wrapped = new DocumentStorageServiceSummaryBlobCompressionAdapter(\n\t\t\tstorage,\n\t\t\tthis._config,\n\t\t);\n\t\tawait wrapped.getSnapshotTree();\n\t\treturn wrapped;\n\t}\n}\n"]}
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
|
|
6
6
|
import { IDocumentService, IDocumentServiceFactory, IResolvedUrl } from "@fluidframework/driver-definitions";
|
|
7
7
|
import { ISummaryTree } from "@fluidframework/protocol-definitions";
|
|
8
|
-
import { DocumentServiceFactoryProxy } from "../../documentServiceFactoryProxy";
|
|
9
|
-
import { ICompressionStorageConfig } from "./compressionTypes";
|
|
8
|
+
import { DocumentServiceFactoryProxy } from "../../documentServiceFactoryProxy.js";
|
|
9
|
+
import { ICompressionStorageConfig } from "./compressionTypes.js";
|
|
10
10
|
export declare class DocumentServiceFactoryCompressionAdapter extends DocumentServiceFactoryProxy {
|
|
11
11
|
private readonly _config;
|
|
12
12
|
constructor(serviceFactory: IDocumentServiceFactory, _config: ICompressionStorageConfig);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documentServiceFactoryCompressionAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceFactoryCompressionAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EACN,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,2BAA2B,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"documentServiceFactoryCompressionAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceFactoryCompressionAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EACN,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAIlE,qBAAa,wCAAyC,SAAQ,2BAA2B;IAGvF,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADxB,cAAc,EAAE,uBAAuB,EACtB,OAAO,EAAE,yBAAyB;IAKvC,eAAe,CAC3B,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IAmBf,qBAAqB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAIxF"}
|
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
7
|
exports.DocumentServiceFactoryCompressionAdapter = void 0;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
-
const
|
|
11
|
-
class DocumentServiceFactoryCompressionAdapter extends
|
|
8
|
+
const documentServiceFactoryProxy_js_1 = require("../../documentServiceFactoryProxy.js");
|
|
9
|
+
const index_js_1 = require("./summaryblob/index.js");
|
|
10
|
+
const documentServiceCompressionAdapter_js_1 = require("./documentServiceCompressionAdapter.js");
|
|
11
|
+
class DocumentServiceFactoryCompressionAdapter extends documentServiceFactoryProxy_js_1.DocumentServiceFactoryProxy {
|
|
12
12
|
constructor(serviceFactory, _config) {
|
|
13
13
|
super(serviceFactory);
|
|
14
14
|
this._config = _config;
|
|
@@ -16,15 +16,15 @@ class DocumentServiceFactoryCompressionAdapter extends documentServiceFactoryPro
|
|
|
16
16
|
async createContainer(createNewSummary, createNewResolvedUrl, logger, clientIsSummarizer) {
|
|
17
17
|
if (createNewSummary !== undefined) {
|
|
18
18
|
const configForInitial = this._config;
|
|
19
|
-
const newAppSumary =
|
|
19
|
+
const newAppSumary = index_js_1.DocumentStorageServiceCompressionAdapter.compressSummary(createNewSummary.tree[".app"], configForInitial);
|
|
20
20
|
createNewSummary.tree[".app"] = newAppSumary;
|
|
21
21
|
}
|
|
22
22
|
const service = await this.serviceFactory.createContainer(createNewSummary, createNewResolvedUrl, logger, clientIsSummarizer);
|
|
23
|
-
return new
|
|
23
|
+
return new documentServiceCompressionAdapter_js_1.DocumentServiceCompressionAdapter(service, this._config);
|
|
24
24
|
}
|
|
25
25
|
async createDocumentService(resolvedUrl) {
|
|
26
26
|
const service = await this.serviceFactory.createDocumentService(resolvedUrl);
|
|
27
|
-
return new
|
|
27
|
+
return new documentServiceCompressionAdapter_js_1.DocumentServiceCompressionAdapter(service, this._config);
|
|
28
28
|
}
|
|
29
29
|
}
|
|
30
30
|
exports.DocumentServiceFactoryCompressionAdapter = DocumentServiceFactoryCompressionAdapter;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documentServiceFactoryCompressionAdapter.js","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceFactoryCompressionAdapter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,
|
|
1
|
+
{"version":3,"file":"documentServiceFactoryCompressionAdapter.js","sourceRoot":"","sources":["../../../src/adapters/compression/documentServiceFactoryCompressionAdapter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,yFAAmF;AAEnF,qDAAyI;AACzI,iGAA2F;AAE3F,MAAa,wCAAyC,SAAQ,4DAA2B;IACxF,YACC,cAAuC,EACtB,OAAkC;QAEnD,KAAK,CAAC,cAAc,CAAC,CAAC;QAFL,YAAO,GAAP,OAAO,CAA2B;IAGpD,CAAC;IAEM,KAAK,CAAC,eAAe,CAC3B,gBAA0C,EAC1C,oBAAkC,EAClC,MAA6B,EAC7B,kBAA4B;QAE5B,IAAI,gBAAgB,KAAK,SAAS,EAAE;YACnC,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC;YACtC,MAAM,YAAY,GACjB,mDAAmD,CAAC,eAAe,CAClE,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAiB,EAC7C,gBAAgB,CAChB,CAAC;YACH,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC;SAC7C;QACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,CACxD,gBAAgB,EAChB,oBAAoB,EACpB,MAAM,EACN,kBAAkB,CAClB,CAAC;QACF,OAAO,IAAI,wEAAiC,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,WAAyB;QAC3D,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAC7E,OAAO,IAAI,wEAAiC,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;CACD;AApCD,4FAoCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport {\n\tIDocumentService,\n\tIDocumentServiceFactory,\n\tIResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport { DocumentServiceFactoryProxy } from \"../../documentServiceFactoryProxy.js\";\nimport { ICompressionStorageConfig } from \"./compressionTypes.js\";\nimport { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSummaryBlobCompressionAdapter } from \"./summaryblob/index.js\";\nimport { DocumentServiceCompressionAdapter } from \"./documentServiceCompressionAdapter.js\";\n\nexport class DocumentServiceFactoryCompressionAdapter extends DocumentServiceFactoryProxy {\n\tconstructor(\n\t\tserviceFactory: IDocumentServiceFactory,\n\t\tprivate readonly _config: ICompressionStorageConfig,\n\t) {\n\t\tsuper(serviceFactory);\n\t}\n\n\tpublic async createContainer(\n\t\tcreateNewSummary: ISummaryTree | undefined,\n\t\tcreateNewResolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService> {\n\t\tif (createNewSummary !== undefined) {\n\t\t\tconst configForInitial = this._config;\n\t\t\tconst newAppSumary =\n\t\t\t\tDocumentStorageServiceSummaryBlobCompressionAdapter.compressSummary(\n\t\t\t\t\tcreateNewSummary.tree[\".app\"] as ISummaryTree,\n\t\t\t\t\tconfigForInitial,\n\t\t\t\t);\n\t\t\tcreateNewSummary.tree[\".app\"] = newAppSumary;\n\t\t}\n\t\tconst service = await this.serviceFactory.createContainer(\n\t\t\tcreateNewSummary,\n\t\t\tcreateNewResolvedUrl,\n\t\t\tlogger,\n\t\t\tclientIsSummarizer,\n\t\t);\n\t\treturn new DocumentServiceCompressionAdapter(service, this._config);\n\t}\n\n\tpublic async createDocumentService(resolvedUrl: IResolvedUrl): Promise<IDocumentService> {\n\t\tconst service = await this.serviceFactory.createDocumentService(resolvedUrl);\n\t\treturn new DocumentServiceCompressionAdapter(service, this._config);\n\t}\n}\n"]}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
export { SummaryCompressionAlgorithm, ICompressionStorageConfig, DefaultCompressionStorageConfig, } from "./compressionTypes";
|
|
6
|
-
export { DocumentServiceFactoryCompressionAdapter } from "./documentServiceFactoryCompressionAdapter";
|
|
7
|
-
export { blobHeadersBlobName } from "./summaryblob";
|
|
5
|
+
export { SummaryCompressionAlgorithm, ICompressionStorageConfig, DefaultCompressionStorageConfig, } from "./compressionTypes.js";
|
|
6
|
+
export { DocumentServiceFactoryCompressionAdapter } from "./documentServiceFactoryCompressionAdapter.js";
|
|
7
|
+
export { blobHeadersBlobName } from "./summaryblob/index.js";
|
|
8
8
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/adapters/compression/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,2BAA2B,EAC3B,yBAAyB,EACzB,+BAA+B,GAC/B,MAAM,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/adapters/compression/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,2BAA2B,EAC3B,yBAAyB,EACzB,+BAA+B,GAC/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,wCAAwC,EAAE,MAAM,+CAA+C,CAAC;AACzG,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC"}
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
7
|
exports.blobHeadersBlobName = exports.DocumentServiceFactoryCompressionAdapter = exports.DefaultCompressionStorageConfig = exports.SummaryCompressionAlgorithm = void 0;
|
|
8
|
-
var
|
|
9
|
-
Object.defineProperty(exports, "SummaryCompressionAlgorithm", { enumerable: true, get: function () { return
|
|
10
|
-
Object.defineProperty(exports, "DefaultCompressionStorageConfig", { enumerable: true, get: function () { return
|
|
11
|
-
var
|
|
12
|
-
Object.defineProperty(exports, "DocumentServiceFactoryCompressionAdapter", { enumerable: true, get: function () { return
|
|
13
|
-
var
|
|
14
|
-
Object.defineProperty(exports, "blobHeadersBlobName", { enumerable: true, get: function () { return
|
|
8
|
+
var compressionTypes_js_1 = require("./compressionTypes.js");
|
|
9
|
+
Object.defineProperty(exports, "SummaryCompressionAlgorithm", { enumerable: true, get: function () { return compressionTypes_js_1.SummaryCompressionAlgorithm; } });
|
|
10
|
+
Object.defineProperty(exports, "DefaultCompressionStorageConfig", { enumerable: true, get: function () { return compressionTypes_js_1.DefaultCompressionStorageConfig; } });
|
|
11
|
+
var documentServiceFactoryCompressionAdapter_js_1 = require("./documentServiceFactoryCompressionAdapter.js");
|
|
12
|
+
Object.defineProperty(exports, "DocumentServiceFactoryCompressionAdapter", { enumerable: true, get: function () { return documentServiceFactoryCompressionAdapter_js_1.DocumentServiceFactoryCompressionAdapter; } });
|
|
13
|
+
var index_js_1 = require("./summaryblob/index.js");
|
|
14
|
+
Object.defineProperty(exports, "blobHeadersBlobName", { enumerable: true, get: function () { return index_js_1.blobHeadersBlobName; } });
|
|
15
15
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapters/compression/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapters/compression/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6DAI+B;AAH9B,kIAAA,2BAA2B,OAAA;AAE3B,sIAAA,+BAA+B,OAAA;AAEhC,6GAAyG;AAAhG,uKAAA,wCAAwC,OAAA;AACjD,mDAA6D;AAApD,+GAAA,mBAAmB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tSummaryCompressionAlgorithm,\n\tICompressionStorageConfig,\n\tDefaultCompressionStorageConfig,\n} from \"./compressionTypes.js\";\nexport { DocumentServiceFactoryCompressionAdapter } from \"./documentServiceFactoryCompressionAdapter.js\";\nexport { blobHeadersBlobName } from \"./summaryblob/index.js\";\n"]}
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import { IDocumentStorageService, ISummaryContext } from "@fluidframework/driver-definitions";
|
|
6
6
|
import { ISnapshotTree, ISummaryHandle, ISummaryTree, IVersion } from "@fluidframework/protocol-definitions";
|
|
7
|
-
import { DocumentStorageServiceProxy } from "../../../documentStorageServiceProxy";
|
|
8
|
-
import { ICompressionStorageConfig } from "
|
|
7
|
+
import { DocumentStorageServiceProxy } from "../../../documentStorageServiceProxy.js";
|
|
8
|
+
import { ICompressionStorageConfig } from "..//index.js";
|
|
9
9
|
/**
|
|
10
10
|
* @internal
|
|
11
11
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documentStorageServiceSummaryBlobCompressionAdapter.d.ts","sourceRoot":"","sources":["../../../../src/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAC9F,OAAO,EACN,aAAa,EAEb,cAAc,EACd,YAAY,EACZ,QAAQ,EAGR,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,2BAA2B,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"documentStorageServiceSummaryBlobCompressionAdapter.d.ts","sourceRoot":"","sources":["../../../../src/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAC9F,OAAO,EACN,aAAa,EAEb,cAAc,EACd,YAAY,EACZ,QAAQ,EAGR,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,yBAAyB,EAA+B,MAAM,cAAc,CAAC;AAEtF;;GAEG;AACH,eAAO,MAAM,mBAAmB,0BAA0B,CAAC;AAG3D;;;;;;;;;;;GAWG;AACH,qBAAa,wCAAyC,SAAQ,2BAA2B;IAKvF,OAAO,CAAC,QAAQ,CAAC,OAAO;IAJzB,OAAO,CAAC,qBAAqB,CAAkB;gBAG9C,OAAO,EAAE,uBAAuB,EACf,OAAO,EAAE,yBAAyB;IAKpD,IAAW,OAAO,IAAI,uBAAuB,CAE5C;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,SAAS;IAMxB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAOpC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAmBnC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,6BAA6B;IAK5C;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAI5B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAoBjC;IAEF;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAgBjC;IAEF;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAwBzB;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAqBzB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAoCjC;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAkBxC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAOpC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IASnC;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAsBnC;;;;;OAKG;WACW,eAAe,CAC5B,OAAO,EAAE,YAAY,EACrB,MAAM,EAAE,yBAAyB,GAC/B,YAAY;IAaf;;;;OAIG;IACmB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAYpE;;;;;;;OAOG;IACmB,eAAe,CACpC,OAAO,CAAC,EAAE,QAAQ,GAAG,SAAS,EAC9B,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,GAE/B,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAShC;;;;;OAKG;IACmB,wBAAwB,CAC7C,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,eAAe,GACtB,OAAO,CAAC,MAAM,CAAC;IAQlB;;;;OAIG;IACmB,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;CAYhF"}
|
package/dist/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.js
CHANGED
|
@@ -9,8 +9,8 @@ const client_utils_1 = require("@fluid-internal/client-utils");
|
|
|
9
9
|
const core_utils_1 = require("@fluidframework/core-utils");
|
|
10
10
|
const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
|
|
11
11
|
const lz4js_1 = require("lz4js");
|
|
12
|
-
const
|
|
13
|
-
const
|
|
12
|
+
const documentStorageServiceProxy_js_1 = require("../../../documentStorageServiceProxy.js");
|
|
13
|
+
const index_js_1 = require("..//index.js");
|
|
14
14
|
/**
|
|
15
15
|
* @internal
|
|
16
16
|
*/
|
|
@@ -28,7 +28,7 @@ const metadataBlobName = ".metadata";
|
|
|
28
28
|
* that the compression is not enabled and no first prefix byte is present in the blobs.
|
|
29
29
|
* @public
|
|
30
30
|
*/
|
|
31
|
-
class DocumentStorageServiceCompressionAdapter extends
|
|
31
|
+
class DocumentStorageServiceCompressionAdapter extends documentStorageServiceProxy_js_1.DocumentStorageServiceProxy {
|
|
32
32
|
constructor(service, _config) {
|
|
33
33
|
super(service);
|
|
34
34
|
this._config = _config;
|
|
@@ -53,7 +53,7 @@ class DocumentStorageServiceCompressionAdapter extends documentStorageServicePro
|
|
|
53
53
|
*/
|
|
54
54
|
static readAlgorithmFromBlob(blob) {
|
|
55
55
|
return !this.hasPrefix(blob)
|
|
56
|
-
?
|
|
56
|
+
? index_js_1.SummaryCompressionAlgorithm.None
|
|
57
57
|
: // eslint-disable-next-line no-bitwise
|
|
58
58
|
client_utils_1.IsoBuffer.from(blob)[0] & 0x0f;
|
|
59
59
|
}
|
|
@@ -64,7 +64,7 @@ class DocumentStorageServiceCompressionAdapter extends documentStorageServicePro
|
|
|
64
64
|
* @returns The blob with the algorithm as the first byte.
|
|
65
65
|
*/
|
|
66
66
|
static writeAlgorithmToBlob(blob, algorithm) {
|
|
67
|
-
if (algorithm ===
|
|
67
|
+
if (algorithm === index_js_1.SummaryCompressionAlgorithm.None) {
|
|
68
68
|
const firstByte = client_utils_1.IsoBuffer.from(blob)[0];
|
|
69
69
|
// eslint-disable-next-line no-bitwise
|
|
70
70
|
if ((firstByte & 0xf0) !== 0xb0) {
|
|
@@ -111,12 +111,12 @@ class DocumentStorageServiceCompressionAdapter extends documentStorageServicePro
|
|
|
111
111
|
let algorithm = config.algorithm;
|
|
112
112
|
if (new Uint8Array(file).length < config.minSizeToCompress) {
|
|
113
113
|
maybeCompressed = file;
|
|
114
|
-
algorithm =
|
|
114
|
+
algorithm = index_js_1.SummaryCompressionAlgorithm.None;
|
|
115
115
|
}
|
|
116
|
-
else if (algorithm ===
|
|
116
|
+
else if (algorithm === index_js_1.SummaryCompressionAlgorithm.None) {
|
|
117
117
|
maybeCompressed = file;
|
|
118
118
|
}
|
|
119
|
-
else if (algorithm ===
|
|
119
|
+
else if (algorithm === index_js_1.SummaryCompressionAlgorithm.LZ4) {
|
|
120
120
|
const compressed = (0, lz4js_1.compress)(file);
|
|
121
121
|
maybeCompressed = compressed;
|
|
122
122
|
}
|
|
@@ -140,13 +140,13 @@ class DocumentStorageServiceCompressionAdapter extends documentStorageServicePro
|
|
|
140
140
|
originalBlob = this.removePrefixFromBlobIfPresent(file);
|
|
141
141
|
}
|
|
142
142
|
else {
|
|
143
|
-
algorithm =
|
|
143
|
+
algorithm = index_js_1.SummaryCompressionAlgorithm.None;
|
|
144
144
|
originalBlob = file;
|
|
145
145
|
}
|
|
146
|
-
if (algorithm ===
|
|
146
|
+
if (algorithm === index_js_1.SummaryCompressionAlgorithm.None) {
|
|
147
147
|
decompressed = originalBlob;
|
|
148
148
|
}
|
|
149
|
-
else if (algorithm ===
|
|
149
|
+
else if (algorithm === index_js_1.SummaryCompressionAlgorithm.LZ4) {
|
|
150
150
|
decompressed = (0, lz4js_1.decompress)(originalBlob);
|
|
151
151
|
}
|
|
152
152
|
else {
|