@azure/cosmos 3.14.2-alpha.20211111.1 → 3.15.0

package/dist-esm/test/public/integration/query.spec.js

@@ -0,0 +1,78 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import assert from "assert";
+import { getTestContainer, getTestDatabase, removeAllDatabases } from "../common/TestHelpers";
+const doc = { id: "myId", pk: "pk" };
+describe("ResourceLink Trimming of leading and trailing slashes", function () {
+    this.timeout(process.env.MOCHA_TIMEOUT || 10000);
+    const containerId = "testcontainer";
+    beforeEach(async function () {
+        await removeAllDatabases();
+    });
+    it("validate correct execution of query using named container link with leading and trailing slashes", async function () {
+        const containerDefinition = {
+            id: containerId,
+            partitionKey: {
+                paths: ["/pk"]
+            }
+        };
+        const containerOptions = { offerThroughput: 10100 };
+        const container = await getTestContainer("validate correct execution of query", undefined, containerDefinition, containerOptions);
+        await container.items.create(doc);
+        const query = "SELECT * from " + containerId;
+        const queryIterator = container.items.query(query);
+        const { resources } = await queryIterator.fetchAll();
+        assert.equal(resources[0]["id"], "myId");
+    });
+});
+describe("Test Query Metrics", function () {
+    this.timeout(process.env.MOCHA_TIMEOUT || 20000);
+    const collectionId = "testCollection2";
+    beforeEach(async function () {
+        await removeAllDatabases();
+    });
+    it("validate that query metrics are correct for a single partition query", async function () {
+        const database = await getTestDatabase("query metrics test db");
+        const collectionDefinition = { id: collectionId };
+        const collectionOptions = { offerThroughput: 4000 };
+        const { resource: createdCollectionDef } = await database.containers.create(collectionDefinition, collectionOptions);
+        const createdContainer = database.container(createdCollectionDef.id);
+        await createdContainer.items.create(doc);
+        const query = "SELECT * from " + collectionId;
+        const queryOptions = { populateQueryMetrics: true };
+        const queryIterator = createdContainer.items.query(query, queryOptions);
+        while (queryIterator.hasMoreResults()) {
+            const { resources: results, queryMetrics, activityId, requestCharge } = await queryIterator.fetchNext();
+            assert(activityId, "activityId must exist");
+            assert(requestCharge, "requestCharge must exist");
+            if (results === undefined) {
+                // no more results
+                break;
+            }
+            assert.notEqual(queryMetrics, null);
+        }
+    });
+});
+describe("Partition key in FeedOptions", function () {
+    this.timeout(process.env.MOCHA_TIMEOUT || 10000);
+    beforeEach(async function () {
+        await removeAllDatabases();
+    });
+    it("passing partition key in FeedOptions", async function () {
+        const containerDefinition = {
+            id: "testcontainer",
+            partitionKey: {
+                paths: ["/id"]
+            }
+        };
+        const container = await getTestContainer("validate correct execution of query", undefined, containerDefinition);
+        await container.items.create({ id: "foo" });
+        await container.items.create({ id: "bar" });
+        const query = "SELECT * from C";
+        const queryIterator = container.items.query(query, { partitionKey: "foo" });
+        const { resources } = await queryIterator.fetchAll();
+        assert.equal(resources.length, 1);
+        assert.equal(resources[0].id, "foo");
+    });
+});
+//# sourceMappingURL=query.spec.js.map

package/dist-esm/test/public/integration/query.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.spec.js","sourceRoot":"","sources":["../../../../test/public/integration/query.spec.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE9F,MAAM,GAAG,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;AAErC,QAAQ,CAAC,uDAAuD,EAAE;IAChE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,KAAK,CAAC,CAAC;IACjD,MAAM,WAAW,GAAG,eAAe,CAAC;IAEpC,UAAU,CAAC,KAAK;QACd,MAAM,kBAAkB,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kGAAkG,EAAE,KAAK;QAC1G,MAAM,mBAAmB,GAAG;YAC1B,EAAE,EAAE,WAAW;YACf,YAAY,EAAE;gBACZ,KAAK,EAAE,CAAC,KAAK,CAAC;aACf;SACF,CAAC;QACF,MAAM,gBAAgB,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC;QAEpD,MAAM,SAAS,GAAG,MAAM,gBAAgB,CACtC,qCAAqC,EACrC,SAAS,EACT,mBAAmB,EACnB,gBAAgB,CACjB,CAAC;QAEF,MAAM,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,KAAK,GAAG,gBAAgB,GAAG,WAAW,CAAC;QAC7C,MAAM,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEnD,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,aAAa,CAAC,QAAQ,EAAE,CAAC;QACrD,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE;IAC7B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,KAAK,CAAC,CAAC;IACjD,MAAM,YAAY,GAAG,iBAAiB,CAAC;IAEvC,UAAU,CAAC,KAAK;QACd,MAAM,kBAAkB,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK;QAC9E,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,uBAAuB,CAAC,CAAC;QAEhE,MAAM,oBAAoB,GAAG,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC;QAClD,MAAM,iBAAiB,GAAG,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;QAEpD,MAAM,EAAE,QAAQ,EAAE,oBAAoB,EAAE,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,MAAM,CACzE,oBAAoB,EACpB,iBAAiB,CAClB,CAAC;QACF,MAAM,gBAAgB,GAAG,QAAQ,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAErE,MAAM,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,gBAAgB,GAAG,YAAY,CAAC;QAC9C,MAAM,YAAY,GAAgB,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;QACjE,MAAM,aAAa,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAExE,OAAO,aAAa,CAAC,cAAc,EAAE,EAAE;YACrC,MAAM,EACJ,SAAS,EAAE,OAAO,EAClB,YAAY,EACZ,UAAU,EACV,aAAa,EACd,GAAG,MAAM,aAAa,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,CAAC,UAAU,EAAE,uBAAuB,CAAC,CAAC;YAC5C,MAAM,CAAC,aAAa,EAAE,0BAA0B,CAAC,CAAC;YAElD,IAAI,OAAO,KAAK,SAAS,EAAE;gBACzB,kBAAkB;gBAClB,MAAM;aACP;YAED,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;SACrC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,8BAA8B,EAAE;IACvC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,KAAK,CAAC,CAAC;IAEjD,UAAU,CAAC,KAAK;QACd,MAAM,kBAAkB,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK;QAC9C,MAAM,mBAAmB,GAAG;YAC1B,EAAE,EAAE,eAAe;YACnB,YAAY,EAAE;gBACZ,KAAK,EAAE,CAAC,KAAK,CAAC;aACf;SACF,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,gBAAgB,CACtC,qCAAqC,EACrC,SAAS,EACT,mBAAmB,CACpB,CAAC;QAEF,MAAM,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5C,MAAM,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAG,iBAAiB,CAAC;QAChC,MAAM,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QAE5E,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,aAAa,CAAC,QAAQ,EAAE,CAAC;QACrD,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\nimport assert from \"assert\";\nimport { Suite } from \"mocha\";\nimport { FeedOptions } from \"../../../src\";\nimport { getTestContainer, getTestDatabase, removeAllDatabases } from \"../common/TestHelpers\";\n\nconst doc = { id: \"myId\", pk: \"pk\" };\n\ndescribe(\"ResourceLink Trimming of leading and trailing slashes\", function(this: Suite) {\n  this.timeout(process.env.MOCHA_TIMEOUT || 10000);\n  const containerId = \"testcontainer\";\n\n  beforeEach(async function() {\n    await removeAllDatabases();\n  });\n\n  it(\"validate correct execution of query using named container link with leading and trailing slashes\", async function() {\n    const containerDefinition = {\n      id: containerId,\n      partitionKey: {\n        paths: [\"/pk\"]\n      }\n    };\n    const containerOptions = { offerThroughput: 10100 };\n\n    const container = await getTestContainer(\n      \"validate correct execution of query\",\n      undefined,\n      containerDefinition,\n      containerOptions\n    );\n\n    await container.items.create(doc);\n    const query = \"SELECT * from \" + containerId;\n    const queryIterator = container.items.query(query);\n\n    const { resources } = await queryIterator.fetchAll();\n    assert.equal(resources[0][\"id\"], \"myId\");\n  });\n});\n\ndescribe(\"Test Query Metrics\", function(this: Suite) {\n  this.timeout(process.env.MOCHA_TIMEOUT || 20000);\n  const collectionId = \"testCollection2\";\n\n  beforeEach(async function() {\n    await removeAllDatabases();\n  });\n\n  it(\"validate that query metrics are correct for a single partition query\", async function() {\n    const database = await getTestDatabase(\"query metrics test db\");\n\n    const collectionDefinition = { id: collectionId };\n    const collectionOptions = { offerThroughput: 4000 };\n\n    const { resource: createdCollectionDef } = await database.containers.create(\n      collectionDefinition,\n      collectionOptions\n    );\n    const createdContainer = database.container(createdCollectionDef.id);\n\n    await createdContainer.items.create(doc);\n    const query = \"SELECT * from \" + collectionId;\n    const queryOptions: FeedOptions = { populateQueryMetrics: true };\n    const queryIterator = createdContainer.items.query(query, queryOptions);\n\n    while (queryIterator.hasMoreResults()) {\n      const {\n        resources: results,\n        queryMetrics,\n        activityId,\n        requestCharge\n      } = await queryIterator.fetchNext();\n      assert(activityId, \"activityId must exist\");\n      assert(requestCharge, \"requestCharge must exist\");\n\n      if (results === undefined) {\n        // no more results\n        break;\n      }\n\n      assert.notEqual(queryMetrics, null);\n    }\n  });\n});\n\ndescribe(\"Partition key in FeedOptions\", function(this: Suite) {\n  this.timeout(process.env.MOCHA_TIMEOUT || 10000);\n\n  beforeEach(async function() {\n    await removeAllDatabases();\n  });\n\n  it(\"passing partition key in FeedOptions\", async function() {\n    const containerDefinition = {\n      id: \"testcontainer\",\n      partitionKey: {\n        paths: [\"/id\"]\n      }\n    };\n\n    const container = await getTestContainer(\n      \"validate correct execution of query\",\n      undefined,\n      containerDefinition\n    );\n\n    await container.items.create({ id: \"foo\" });\n    await container.items.create({ id: \"bar\" });\n    const query = \"SELECT * from C\";\n    const queryIterator = container.items.query(query, { partitionKey: \"foo\" });\n\n    const { resources } = await queryIterator.fetchAll();\n    assert.equal(resources.length, 1);\n    assert.equal(resources[0].id, \"foo\");\n  });\n});\n"]}

package/dist-esm/test/public/integration/queryMetrics.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=queryMetrics.spec.d.ts.map

package/dist-esm/test/public/integration/queryMetrics.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryMetrics.spec.d.ts","sourceRoot":"","sources":["../../../../test/public/integration/queryMetrics.spec.ts"],"names":[],"mappings":""}

package/dist-esm/test/public/integration/queryMetrics.spec.js

@@ -0,0 +1,91 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import assert from "assert";
+import { ClientSideMetrics, QueryMetrics, QueryPreparationTimes, RuntimeExecutionTimes, TimeSpan } from "../../../src";
+describe("QueryMetrics", function () {
+    // Properties
+    const totalQueryExecutionTime = TimeSpan.fromMilliseconds(33.67);
+    const queryCompilationTime = TimeSpan.fromMilliseconds(0.06);
+    const logicalPlanBuildTime = TimeSpan.fromMilliseconds(0.02);
+    const physicalPlanBuildTime = TimeSpan.fromMilliseconds(0.1);
+    const queryOptimizationTime = TimeSpan.fromMilliseconds(0.01);
+    const vmExecutionTime = TimeSpan.fromMilliseconds(32.56);
+    const indexLookupTime = TimeSpan.fromMilliseconds(0.36);
+    const documentLoadTime = TimeSpan.fromMilliseconds(9.58);
+    const systemFunctionExecutionTime = TimeSpan.fromMilliseconds(0.05);
+    const userDefinedFunctionExecutionTime = TimeSpan.fromMilliseconds(0.07);
+    const documentWriteTime = TimeSpan.fromMilliseconds(18.1);
+    const retrievedDocumentCount = 2000;
+    const retrievedDocumentSize = 1125600;
+    const outputDocumentCount = 2000;
+    const outputDocumentSize = 1125600;
+    const indexUtilizationRatio = 1.0;
+    const requestCharge = 42;
+    const delimitedString = "totalExecutionTimeInMs=33.67;queryCompileTimeInMs=0.06;queryLogicalPlanBuildTimeInMs=0.02;queryPhysicalPlanBuildTimeInMs=0.10;queryOptimizationTimeInMs=0.01;VMExecutionTimeInMs=32.56;indexLookupTimeInMs=0.36;documentLoadTimeInMs=9.58;systemFunctionExecuteTimeInMs=0.05;userFunctionExecuteTimeInMs=0.07;retrievedDocumentCount=2000;retrievedDocumentSize=1125600;outputDocumentCount=2000;outputDocumentSize=1125600;writeOutputTimeInMs=18.10;indexUtilizationRatio=1.00";
+    const queryEngineExecutionTime = TimeSpan.zero
+        .add(vmExecutionTime)
+        .subtract(indexLookupTime)
+        .subtract(documentLoadTime)
+        .subtract(documentWriteTime);
+    // Base line query metrics
+    const queryMetrics = new QueryMetrics(retrievedDocumentCount, retrievedDocumentSize, outputDocumentCount, outputDocumentSize, indexUtilizationRatio * retrievedDocumentCount, totalQueryExecutionTime, new QueryPreparationTimes(queryCompilationTime, logicalPlanBuildTime, physicalPlanBuildTime, queryOptimizationTime), indexLookupTime, documentLoadTime, vmExecutionTime, new RuntimeExecutionTimes(queryEngineExecutionTime, systemFunctionExecutionTime, userDefinedFunctionExecutionTime), documentWriteTime, new ClientSideMetrics(requestCharge));
+    const assertQueryMetricsEquality = function (queryMetrics1, queryMetrics2) {
+        assert.deepEqual(queryMetrics1.indexHitRatio, queryMetrics2.indexHitRatio);
+        assert.deepEqual(queryMetrics1.outputDocumentCount, queryMetrics2.outputDocumentCount);
+        assert.deepEqual(queryMetrics1.outputDocumentSize, queryMetrics2.outputDocumentSize);
+        assert.deepEqual(queryMetrics1.retrievedDocumentCount, queryMetrics2.retrievedDocumentCount);
+        assert.deepEqual(queryMetrics1.retrievedDocumentSize, queryMetrics2.retrievedDocumentSize);
+        assert.deepEqual(queryMetrics1.totalQueryExecutionTime, queryMetrics2.totalQueryExecutionTime);
+        assert.deepEqual(queryMetrics1.documentLoadTime, queryMetrics2.documentLoadTime);
+        assert.deepEqual(queryMetrics1.documentWriteTime, queryMetrics2.documentWriteTime);
+        assert.deepEqual(queryMetrics1.indexLookupTime, queryMetrics2.indexLookupTime);
+        assert.deepEqual(queryMetrics1.vmExecutionTime, queryMetrics2.vmExecutionTime);
+        assert.deepEqual(queryMetrics1.queryPreparationTimes.logicalPlanBuildTime, queryMetrics2.queryPreparationTimes.logicalPlanBuildTime);
+        assert.deepEqual(queryMetrics1.queryPreparationTimes.physicalPlanBuildTime, queryMetrics2.queryPreparationTimes.physicalPlanBuildTime);
+        assert.deepEqual(queryMetrics1.queryPreparationTimes.queryCompilationTime, queryMetrics2.queryPreparationTimes.queryCompilationTime);
+        assert.deepEqual(queryMetrics1.queryPreparationTimes.queryOptimizationTime, queryMetrics2.queryPreparationTimes.queryOptimizationTime);
+        assert.deepEqual(queryMetrics1.runtimeExecutionTimes.queryEngineExecutionTime, queryMetrics2.runtimeExecutionTimes.queryEngineExecutionTime);
+        assert.deepEqual(queryMetrics1.runtimeExecutionTimes.systemFunctionExecutionTime, queryMetrics2.runtimeExecutionTimes.systemFunctionExecutionTime);
+        assert.deepEqual(queryMetrics1.runtimeExecutionTimes.userDefinedFunctionExecutionTime, queryMetrics2.runtimeExecutionTimes.userDefinedFunctionExecutionTime);
+        assert.deepEqual(queryMetrics1.clientSideMetrics.requestCharge, queryMetrics2.clientSideMetrics.requestCharge);
+    };
+    it("Can Be Cloned", function () {
+        const queryMetrics2 = new QueryMetrics(queryMetrics.retrievedDocumentCount, queryMetrics.retrievedDocumentSize, queryMetrics.outputDocumentCount, queryMetrics.outputDocumentSize, queryMetrics.indexHitDocumentCount, queryMetrics.totalQueryExecutionTime, queryMetrics.queryPreparationTimes, queryMetrics.indexLookupTime, queryMetrics.documentLoadTime, queryMetrics.vmExecutionTime, queryMetrics.runtimeExecutionTimes, queryMetrics.documentWriteTime, queryMetrics.clientSideMetrics);
+        assertQueryMetricsEquality(queryMetrics, queryMetrics2);
+    });
+    it("Should Add Two Query Metrics", function () {
+        const doubleQueryMetrics = queryMetrics.add([queryMetrics]);
+        const doubleRetrievedDocumentCount = retrievedDocumentCount * 2;
+        const doubleRetrievedDocumentSize = retrievedDocumentSize * 2;
+        const doubleOutputDocumentCount = outputDocumentCount * 2;
+        const doubleOutputDocumentSize = outputDocumentSize * 2;
+        const doubleIndexHitCount = indexUtilizationRatio * retrievedDocumentCount * 2;
+        const doubleTotalQueryExecutionTime = TimeSpan.fromMilliseconds(totalQueryExecutionTime.totalMilliseconds() * 2);
+        const doubleQueryCompilationTime = TimeSpan.fromMilliseconds(queryCompilationTime.totalMilliseconds() * 2);
+        const doubleLogicalPlanBuildTime = TimeSpan.fromMilliseconds(logicalPlanBuildTime.totalMilliseconds() * 2);
+        const doublePhysicalPlanBuildTime = TimeSpan.fromMilliseconds(physicalPlanBuildTime.totalMilliseconds() * 2);
+        const doubleIndexLookupTime = TimeSpan.fromMilliseconds(indexLookupTime.totalMilliseconds() * 2);
+        const doubleDocumentLoadTime = TimeSpan.fromMilliseconds(documentLoadTime.totalMilliseconds() * 2);
+        const doubleVMExecutionTime = TimeSpan.fromMilliseconds(vmExecutionTime.totalMilliseconds() * 2);
+        const doubleQueryOptimizationTime = TimeSpan.fromMilliseconds(queryOptimizationTime.totalMilliseconds() * 2);
+        const doubleQueryEngineExecutionTime = TimeSpan.fromMilliseconds(queryEngineExecutionTime.totalMilliseconds() * 2);
+        const doubleSystemFunctionExecutionTime = TimeSpan.fromMilliseconds(systemFunctionExecutionTime.totalMilliseconds() * 2);
+        const doubleUserDefinedFunctionExecutionTime = TimeSpan.fromMilliseconds(userDefinedFunctionExecutionTime.totalMilliseconds() * 2);
+        const doubleDocumentWriteTime = TimeSpan.fromMilliseconds(documentWriteTime.totalMilliseconds() * 2);
+        const doubleRequestCharge = requestCharge * 2;
+        const expectedQueryMetrics = new QueryMetrics(doubleRetrievedDocumentCount, doubleRetrievedDocumentSize, doubleOutputDocumentCount, doubleOutputDocumentSize, doubleIndexHitCount, doubleTotalQueryExecutionTime, new QueryPreparationTimes(doubleQueryCompilationTime, doubleLogicalPlanBuildTime, doublePhysicalPlanBuildTime, doubleQueryOptimizationTime), doubleIndexLookupTime, doubleDocumentLoadTime, doubleVMExecutionTime, new RuntimeExecutionTimes(doubleQueryEngineExecutionTime, doubleSystemFunctionExecutionTime, doubleUserDefinedFunctionExecutionTime), doubleDocumentWriteTime, new ClientSideMetrics(doubleRequestCharge));
+        assertQueryMetricsEquality(doubleQueryMetrics, expectedQueryMetrics);
+        const queryMetricsFromCreateArray = QueryMetrics.createFromArray([queryMetrics, queryMetrics]);
+        assertQueryMetricsEquality(queryMetricsFromCreateArray, expectedQueryMetrics);
+    });
+    it("Can Be Create From Delimited String", function () {
+        const queryMetricsFromDelimitedString = QueryMetrics.createFromDelimitedString(delimitedString, new ClientSideMetrics(requestCharge));
+        assertQueryMetricsEquality(queryMetricsFromDelimitedString, queryMetrics);
+    });
+    it("Can Be Converted To A Delimited String", function () {
+        const delimitedStringFromMetrics = queryMetrics.toDelimitedString();
+        const queryMetricsFromDelimitedString = QueryMetrics.createFromDelimitedString(delimitedStringFromMetrics, new ClientSideMetrics(requestCharge));
+        assertQueryMetricsEquality(queryMetrics, queryMetricsFromDelimitedString);
+    });
+});
+//# sourceMappingURL=queryMetrics.spec.js.map

package/dist-esm/test/public/integration/queryMetrics.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryMetrics.spec.js","sourceRoot":"","sources":["../../../../test/public/integration/queryMetrics.spec.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,qBAAqB,EACrB,qBAAqB,EACrB,QAAQ,EACT,MAAM,cAAc,CAAC;AAEtB,QAAQ,CAAC,cAAc,EAAE;IACvB,aAAa;IACb,MAAM,uBAAuB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACjE,MAAM,oBAAoB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7D,MAAM,oBAAoB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7D,MAAM,qBAAqB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAC7D,MAAM,qBAAqB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC9D,MAAM,eAAe,GAAG,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACxD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACzD,MAAM,2BAA2B,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpE,MAAM,gCAAgC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACzE,MAAM,iBAAiB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1D,MAAM,sBAAsB,GAAG,IAAI,CAAC;IACpC,MAAM,qBAAqB,GAAG,OAAO,CAAC;IACtC,MAAM,mBAAmB,GAAG,IAAI,CAAC;IACjC,MAAM,kBAAkB,GAAG,OAAO,CAAC;IACnC,MAAM,qBAAqB,GAAG,GAAG,CAAC;IAClC,MAAM,aAAa,GAAG,EAAE,CAAC;IAEzB,MAAM,eAAe,GACnB,kdAAkd,CAAC;IAErd,MAAM,wBAAwB,GAAG,QAAQ,CAAC,IAAI;SAC3C,GAAG,CAAC,eAAe,CAAC;SACpB,QAAQ,CAAC,eAAe,CAAC;SACzB,QAAQ,CAAC,gBAAgB,CAAC;SAC1B,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IAE/B,0BAA0B;IAC1B,MAAM,YAAY,GAAG,IAAI,YAAY,CACnC,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,GAAG,sBAAsB,EAC9C,uBAAuB,EACvB,IAAI,qBAAqB,CACvB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,CACtB,EACD,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,IAAI,qBAAqB,CACvB,wBAAwB,EACxB,2BAA2B,EAC3B,gCAAgC,CACjC,EACD,iBAAiB,EACjB,IAAI,iBAAiB,CAAC,aAAa,CAAC,CACrC,CAAC;IAEF,MAAM,0BAA0B,GAAG,UACjC,aAA2B,EAC3B,aAA2B;QAE3B,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;QAC3E,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,mBAAmB,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;QACvF,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,kBAAkB,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;QACrF,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,sBAAsB,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;QAC7F,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,qBAAqB,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAC3F,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,uBAAuB,EAAE,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAE/F,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,gBAAgB,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;QACjF,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,iBAAiB,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;QACnF,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;QAC/E,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;QAE/E,MAAM,CAAC,SAAS,CACd,aAAa,CAAC,qBAAqB,CAAC,oBAAoB,EACxD,aAAa,CAAC,qBAAqB,CAAC,oBAAoB,CACzD,CAAC;QACF,MAAM,CAAC,SAAS,CACd,aAAa,CAAC,qBAAqB,CAAC,qBAAqB,EACzD,aAAa,CAAC,qBAAqB,CAAC,qBAAqB,CAC1D,CAAC;QACF,MAAM,CAAC,SAAS,CACd,aAAa,CAAC,qBAAqB,CAAC,oBAAoB,EACxD,aAAa,CAAC,qBAAqB,CAAC,oBAAoB,CACzD,CAAC;QACF,MAAM,CAAC,SAAS,CACd,aAAa,CAAC,qBAAqB,CAAC,qBAAqB,EACzD,aAAa,CAAC,qBAAqB,CAAC,qBAAqB,CAC1D,CAAC;QAEF,MAAM,CAAC,SAAS,CACd,aAAa,CAAC,qBAAqB,CAAC,wBAAwB,EAC5D,aAAa,CAAC,qBAAqB,CAAC,wBAAwB,CAC7D,CAAC;QACF,MAAM,CAAC,SAAS,CACd,aAAa,CAAC,qBAAqB,CAAC,2BAA2B,EAC/D,aAAa,CAAC,qBAAqB,CAAC,2BAA2B,CAChE,CAAC;QACF,MAAM,CAAC,SAAS,CACd,aAAa,CAAC,qBAAqB,CAAC,gCAAgC,EACpE,aAAa,CAAC,qBAAqB,CAAC,gCAAgC,CACrE,CAAC;QAEF,MAAM,CAAC,SAAS,CACd,aAAa,CAAC,iBAAiB,CAAC,aAAa,EAC7C,aAAa,CAAC,iBAAiB,CAAC,aAAa,CAC9C,CAAC;IACJ,CAAC,CAAC;IAEF,EAAE,CAAC,eAAe,EAAE;QAClB,MAAM,aAAa,GAAG,IAAI,YAAY,CACpC,YAAY,CAAC,sBAAsB,EACnC,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,mBAAmB,EAChC,YAAY,CAAC,kBAAkB,EAC/B,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,uBAAuB,EACpC,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,gBAAgB,EAC7B,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,qBAAqB,EAClC,YAAY,CAAC,iBAAiB,EAC9B,YAAY,CAAC,iBAAiB,CAC/B,CAAC;QAEF,0BAA0B,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE;QACjC,MAAM,kBAAkB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;QAE5D,MAAM,4BAA4B,GAAG,sBAAsB,GAAG,CAAC,CAAC;QAChE,MAAM,2BAA2B,GAAG,qBAAqB,GAAG,CAAC,CAAC;QAC9D,MAAM,yBAAyB,GAAG,mBAAmB,GAAG,CAAC,CAAC;QAC1D,MAAM,wBAAwB,GAAG,kBAAkB,GAAG,CAAC,CAAC;QACxD,MAAM,mBAAmB,GAAG,qBAAqB,GAAG,sBAAsB,GAAG,CAAC,CAAC;QAC/E,MAAM,6BAA6B,GAAG,QAAQ,CAAC,gBAAgB,CAC7D,uBAAuB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAChD,CAAC;QACF,MAAM,0BAA0B,GAAG,QAAQ,CAAC,gBAAgB,CAC1D,oBAAoB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAC7C,CAAC;QACF,MAAM,0BAA0B,GAAG,QAAQ,CAAC,gBAAgB,CAC1D,oBAAoB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAC7C,CAAC;QACF,MAAM,2BAA2B,GAAG,QAAQ,CAAC,gBAAgB,CAC3D,qBAAqB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAC9C,CAAC;QACF,MAAM,qBAAqB,GAAG,QAAQ,CAAC,gBAAgB,CACrD,eAAe,CAAC,iBAAiB,EAAE,GAAG,CAAC,CACxC,CAAC;QACF,MAAM,sBAAsB,GAAG,QAAQ,CAAC,gBAAgB,CACtD,gBAAgB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CACzC,CAAC;QACF,MAAM,qBAAqB,GAAG,QAAQ,CAAC,gBAAgB,CACrD,eAAe,CAAC,iBAAiB,EAAE,GAAG,CAAC,CACxC,CAAC;QACF,MAAM,2BAA2B,GAAG,QAAQ,CAAC,gBAAgB,CAC3D,qBAAqB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAC9C,CAAC;QACF,MAAM,8BAA8B,GAAG,QAAQ,CAAC,gBAAgB,CAC9D,wBAAwB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CACjD,CAAC;QACF,MAAM,iCAAiC,GAAG,QAAQ,CAAC,gBAAgB,CACjE,2BAA2B,CAAC,iBAAiB,EAAE,GAAG,CAAC,CACpD,CAAC;QACF,MAAM,sCAAsC,GAAG,QAAQ,CAAC,gBAAgB,CACtE,gCAAgC,CAAC,iBAAiB,EAAE,GAAG,CAAC,CACzD,CAAC;QACF,MAAM,uBAAuB,GAAG,QAAQ,CAAC,gBAAgB,CACvD,iBAAiB,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAC1C,CAAC;QACF,MAAM,mBAAmB,GAAG,aAAa,GAAG,CAAC,CAAC;QAE9C,MAAM,oBAAoB,GAAG,IAAI,YAAY,CAC3C,4BAA4B,EAC5B,2BAA2B,EAC3B,yBAAyB,EACzB,wBAAwB,EACxB,mBAAmB,EACnB,6BAA6B,EAC7B,IAAI,qBAAqB,CACvB,0BAA0B,EAC1B,0BAA0B,EAC1B,2BAA2B,EAC3B,2BAA2B,CAC5B,EACD,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,IAAI,qBAAqB,CACvB,8BAA8B,EAC9B,iCAAiC,EACjC,sCAAsC,CACvC,EACD,uBAAuB,EACvB,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,CAC3C,CAAC;QAEF,0BAA0B,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;QAErE,MAAM,2BAA2B,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;QAE/F,0BAA0B,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE;QACxC,MAAM,+BAA+B,GAAG,YAAY,CAAC,yBAAyB,CAC5E,eAAe,EACf,IAAI,iBAAiB,CAAC,aAAa,CAAC,CACrC,CAAC;QAEF,0BAA0B,CAAC,+BAA+B,EAAE,YAAY,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE;QAC3C,MAAM,0BAA0B,GAAG,YAAY,CAAC,iBAAiB,EAAE,CAAC;QACpE,MAAM,+BAA+B,GAAG,YAAY,CAAC,yBAAyB,CAC5E,0BAA0B,EAC1B,IAAI,iBAAiB,CAAC,aAAa,CAAC,CACrC,CAAC;QAEF,0BAA0B,CAAC,YAAY,EAAE,+BAA+B,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\nimport assert from \"assert\";\nimport {\n  ClientSideMetrics,\n  QueryMetrics,\n  QueryPreparationTimes,\n  RuntimeExecutionTimes,\n  TimeSpan\n} from \"../../../src\";\n\ndescribe(\"QueryMetrics\", function() {\n  // Properties\n  const totalQueryExecutionTime = TimeSpan.fromMilliseconds(33.67);\n  const queryCompilationTime = TimeSpan.fromMilliseconds(0.06);\n  const logicalPlanBuildTime = TimeSpan.fromMilliseconds(0.02);\n  const physicalPlanBuildTime = TimeSpan.fromMilliseconds(0.1);\n  const queryOptimizationTime = TimeSpan.fromMilliseconds(0.01);\n  const vmExecutionTime = TimeSpan.fromMilliseconds(32.56);\n  const indexLookupTime = TimeSpan.fromMilliseconds(0.36);\n  const documentLoadTime = TimeSpan.fromMilliseconds(9.58);\n  const systemFunctionExecutionTime = TimeSpan.fromMilliseconds(0.05);\n  const userDefinedFunctionExecutionTime = TimeSpan.fromMilliseconds(0.07);\n  const documentWriteTime = TimeSpan.fromMilliseconds(18.1);\n  const retrievedDocumentCount = 2000;\n  const retrievedDocumentSize = 1125600;\n  const outputDocumentCount = 2000;\n  const outputDocumentSize = 1125600;\n  const indexUtilizationRatio = 1.0;\n  const requestCharge = 42;\n\n  const delimitedString =\n    \"totalExecutionTimeInMs=33.67;queryCompileTimeInMs=0.06;queryLogicalPlanBuildTimeInMs=0.02;queryPhysicalPlanBuildTimeInMs=0.10;queryOptimizationTimeInMs=0.01;VMExecutionTimeInMs=32.56;indexLookupTimeInMs=0.36;documentLoadTimeInMs=9.58;systemFunctionExecuteTimeInMs=0.05;userFunctionExecuteTimeInMs=0.07;retrievedDocumentCount=2000;retrievedDocumentSize=1125600;outputDocumentCount=2000;outputDocumentSize=1125600;writeOutputTimeInMs=18.10;indexUtilizationRatio=1.00\";\n\n  const queryEngineExecutionTime = TimeSpan.zero\n    .add(vmExecutionTime)\n    .subtract(indexLookupTime)\n    .subtract(documentLoadTime)\n    .subtract(documentWriteTime);\n\n  // Base line query metrics\n  const queryMetrics = new QueryMetrics(\n    retrievedDocumentCount,\n    retrievedDocumentSize,\n    outputDocumentCount,\n    outputDocumentSize,\n    indexUtilizationRatio * retrievedDocumentCount,\n    totalQueryExecutionTime,\n    new QueryPreparationTimes(\n      queryCompilationTime,\n      logicalPlanBuildTime,\n      physicalPlanBuildTime,\n      queryOptimizationTime\n    ),\n    indexLookupTime,\n    documentLoadTime,\n    vmExecutionTime,\n    new RuntimeExecutionTimes(\n      queryEngineExecutionTime,\n      systemFunctionExecutionTime,\n      userDefinedFunctionExecutionTime\n    ),\n    documentWriteTime,\n    new ClientSideMetrics(requestCharge)\n  );\n\n  const assertQueryMetricsEquality = function(\n    queryMetrics1: QueryMetrics,\n    queryMetrics2: QueryMetrics\n  ): void {\n    assert.deepEqual(queryMetrics1.indexHitRatio, queryMetrics2.indexHitRatio);\n    assert.deepEqual(queryMetrics1.outputDocumentCount, queryMetrics2.outputDocumentCount);\n    assert.deepEqual(queryMetrics1.outputDocumentSize, queryMetrics2.outputDocumentSize);\n    assert.deepEqual(queryMetrics1.retrievedDocumentCount, queryMetrics2.retrievedDocumentCount);\n    assert.deepEqual(queryMetrics1.retrievedDocumentSize, queryMetrics2.retrievedDocumentSize);\n    assert.deepEqual(queryMetrics1.totalQueryExecutionTime, queryMetrics2.totalQueryExecutionTime);\n\n    assert.deepEqual(queryMetrics1.documentLoadTime, queryMetrics2.documentLoadTime);\n    assert.deepEqual(queryMetrics1.documentWriteTime, queryMetrics2.documentWriteTime);\n    assert.deepEqual(queryMetrics1.indexLookupTime, queryMetrics2.indexLookupTime);\n    assert.deepEqual(queryMetrics1.vmExecutionTime, queryMetrics2.vmExecutionTime);\n\n    assert.deepEqual(\n      queryMetrics1.queryPreparationTimes.logicalPlanBuildTime,\n      queryMetrics2.queryPreparationTimes.logicalPlanBuildTime\n    );\n    assert.deepEqual(\n      queryMetrics1.queryPreparationTimes.physicalPlanBuildTime,\n      queryMetrics2.queryPreparationTimes.physicalPlanBuildTime\n    );\n    assert.deepEqual(\n      queryMetrics1.queryPreparationTimes.queryCompilationTime,\n      queryMetrics2.queryPreparationTimes.queryCompilationTime\n    );\n    assert.deepEqual(\n      queryMetrics1.queryPreparationTimes.queryOptimizationTime,\n      queryMetrics2.queryPreparationTimes.queryOptimizationTime\n    );\n\n    assert.deepEqual(\n      queryMetrics1.runtimeExecutionTimes.queryEngineExecutionTime,\n      queryMetrics2.runtimeExecutionTimes.queryEngineExecutionTime\n    );\n    assert.deepEqual(\n      queryMetrics1.runtimeExecutionTimes.systemFunctionExecutionTime,\n      queryMetrics2.runtimeExecutionTimes.systemFunctionExecutionTime\n    );\n    assert.deepEqual(\n      queryMetrics1.runtimeExecutionTimes.userDefinedFunctionExecutionTime,\n      queryMetrics2.runtimeExecutionTimes.userDefinedFunctionExecutionTime\n    );\n\n    assert.deepEqual(\n      queryMetrics1.clientSideMetrics.requestCharge,\n      queryMetrics2.clientSideMetrics.requestCharge\n    );\n  };\n\n  it(\"Can Be Cloned\", function() {\n    const queryMetrics2 = new QueryMetrics(\n      queryMetrics.retrievedDocumentCount,\n      queryMetrics.retrievedDocumentSize,\n      queryMetrics.outputDocumentCount,\n      queryMetrics.outputDocumentSize,\n      queryMetrics.indexHitDocumentCount,\n      queryMetrics.totalQueryExecutionTime,\n      queryMetrics.queryPreparationTimes,\n      queryMetrics.indexLookupTime,\n      queryMetrics.documentLoadTime,\n      queryMetrics.vmExecutionTime,\n      queryMetrics.runtimeExecutionTimes,\n      queryMetrics.documentWriteTime,\n      queryMetrics.clientSideMetrics\n    );\n\n    assertQueryMetricsEquality(queryMetrics, queryMetrics2);\n  });\n\n  it(\"Should Add Two Query Metrics\", function() {\n    const doubleQueryMetrics = queryMetrics.add([queryMetrics]);\n\n    const doubleRetrievedDocumentCount = retrievedDocumentCount * 2;\n    const doubleRetrievedDocumentSize = retrievedDocumentSize * 2;\n    const doubleOutputDocumentCount = outputDocumentCount * 2;\n    const doubleOutputDocumentSize = outputDocumentSize * 2;\n    const doubleIndexHitCount = indexUtilizationRatio * retrievedDocumentCount * 2;\n    const doubleTotalQueryExecutionTime = TimeSpan.fromMilliseconds(\n      totalQueryExecutionTime.totalMilliseconds() * 2\n    );\n    const doubleQueryCompilationTime = TimeSpan.fromMilliseconds(\n      queryCompilationTime.totalMilliseconds() * 2\n    );\n    const doubleLogicalPlanBuildTime = TimeSpan.fromMilliseconds(\n      logicalPlanBuildTime.totalMilliseconds() * 2\n    );\n    const doublePhysicalPlanBuildTime = TimeSpan.fromMilliseconds(\n      physicalPlanBuildTime.totalMilliseconds() * 2\n    );\n    const doubleIndexLookupTime = TimeSpan.fromMilliseconds(\n      indexLookupTime.totalMilliseconds() * 2\n    );\n    const doubleDocumentLoadTime = TimeSpan.fromMilliseconds(\n      documentLoadTime.totalMilliseconds() * 2\n    );\n    const doubleVMExecutionTime = TimeSpan.fromMilliseconds(\n      vmExecutionTime.totalMilliseconds() * 2\n    );\n    const doubleQueryOptimizationTime = TimeSpan.fromMilliseconds(\n      queryOptimizationTime.totalMilliseconds() * 2\n    );\n    const doubleQueryEngineExecutionTime = TimeSpan.fromMilliseconds(\n      queryEngineExecutionTime.totalMilliseconds() * 2\n    );\n    const doubleSystemFunctionExecutionTime = TimeSpan.fromMilliseconds(\n      systemFunctionExecutionTime.totalMilliseconds() * 2\n    );\n    const doubleUserDefinedFunctionExecutionTime = TimeSpan.fromMilliseconds(\n      userDefinedFunctionExecutionTime.totalMilliseconds() * 2\n    );\n    const doubleDocumentWriteTime = TimeSpan.fromMilliseconds(\n      documentWriteTime.totalMilliseconds() * 2\n    );\n    const doubleRequestCharge = requestCharge * 2;\n\n    const expectedQueryMetrics = new QueryMetrics(\n      doubleRetrievedDocumentCount,\n      doubleRetrievedDocumentSize,\n      doubleOutputDocumentCount,\n      doubleOutputDocumentSize,\n      doubleIndexHitCount,\n      doubleTotalQueryExecutionTime,\n      new QueryPreparationTimes(\n        doubleQueryCompilationTime,\n        doubleLogicalPlanBuildTime,\n        doublePhysicalPlanBuildTime,\n        doubleQueryOptimizationTime\n      ),\n      doubleIndexLookupTime,\n      doubleDocumentLoadTime,\n      doubleVMExecutionTime,\n      new RuntimeExecutionTimes(\n        doubleQueryEngineExecutionTime,\n        doubleSystemFunctionExecutionTime,\n        doubleUserDefinedFunctionExecutionTime\n      ),\n      doubleDocumentWriteTime,\n      new ClientSideMetrics(doubleRequestCharge)\n    );\n\n    assertQueryMetricsEquality(doubleQueryMetrics, expectedQueryMetrics);\n\n    const queryMetricsFromCreateArray = QueryMetrics.createFromArray([queryMetrics, queryMetrics]);\n\n    assertQueryMetricsEquality(queryMetricsFromCreateArray, expectedQueryMetrics);\n  });\n\n  it(\"Can Be Create From Delimited String\", function() {\n    const queryMetricsFromDelimitedString = QueryMetrics.createFromDelimitedString(\n      delimitedString,\n      new ClientSideMetrics(requestCharge)\n    );\n\n    assertQueryMetricsEquality(queryMetricsFromDelimitedString, queryMetrics);\n  });\n\n  it(\"Can Be Converted To A Delimited String\", function() {\n    const delimitedStringFromMetrics = queryMetrics.toDelimitedString();\n    const queryMetricsFromDelimitedString = QueryMetrics.createFromDelimitedString(\n      delimitedStringFromMetrics,\n      new ClientSideMetrics(requestCharge)\n    );\n\n    assertQueryMetricsEquality(queryMetrics, queryMetricsFromDelimitedString);\n  });\n});\n"]}

package/dist-esm/test/public/integration/retry.spec.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=retry.spec.d.ts.map

package/dist-esm/test/public/integration/retry.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry.spec.d.ts","sourceRoot":"","sources":["../../../../test/public/integration/retry.spec.ts"],"names":[],"mappings":""}

package/dist-esm/test/public/integration/retry.spec.js

@@ -0,0 +1,133 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// import assert from "assert";
+// import { ConnectionPolicy, Constants, CosmosClient, RetryOptions } from "../../src";
+// import * as request from "../../src/request";
+describe("retry policy tests", function () {
+    // this.timeout(300000);
+    // const collectionDefinition = {
+    //   id: "sample collection"
+    // };
+    // const documentDefinition = {
+    //   id: "doc",
+    //   name: "sample document",
+    //   key: "value"
+    // };
+    // mocked database account to return the WritableLocations and ReadableLocations
+    // set with the default endpoint
+    // const mockGetDatabaseAccount = function (options, callback) {
+    //     const databaseAccount = new AzureDocuments.DatabaseAccount();
+    //     callback(undefined, databaseAccount);
+    // };
+    // const retryAfterInMilliseconds = 1000;
+    // // mocked request object stub that calls the callback with 429 throttling error
+    // const mockCreateRequestObjectStub = function (connectionPolicy, requestOptions, callback) {
+    //     callback({ code: 429, body: "Request rate is too large",
+    //                retryAfterInMilliseconds: retryAfterInMilliseconds });
+    // };
+    // var mockCreateRequestObjectForDefaultRetryStub = function (connectionPolicy, requestOptions, callback) {
+    //     global.counter++;
+    //     if (global.counter % 5 == 0)
+    //         return global.originalFunc(connectionPolicy, requestOptions, callback)
+    //     else
+    //         return callback({ code: "ECONNRESET", body: "Connection was reset" })
+    // }
+    // TODO: need to fix this, the stubbing doesn't work with the new way we work
+    xit("throttle retry policy test default retryAfter", async function () {
+        // connectionPolicy.RetryOptions = new RetryOptions(5);
+        // const client = new CosmosClient({endpoint, key: masterKey, connectionPolicy});
+        // const { result: db } = await client.createDatabase({ id: "sample database" });
+        // const { result: collection } = await client.createCollection(db._self, collectionDefinition);
+        // const originalGetDatabaseAccount = client.getDatabaseAccount;
+        // client.getDatabaseAccount = mockGetDatabaseAccount;
+        // const originalCreateRequestObjectStub = request._createRequestObjectStub;
+        // request._createRequestObjectStub = mockCreateRequestObjectStub;
+        // try {
+        //     const { result: createdDocument } =
+        //         await client.createDocument(collection._self, documentDefinition);
+        // } catch (err) {
+        //     const responseHeaders = (err as request.ErrorResponse).headers;
+        //     assert.equal(err.code, 429, "invalid error code");
+        //     assert.equal(responseHeaders[Constants.ThrottleRetryCount],
+        //         connectionPolicy.RetryOptions.MaxRetryAttemptCount, "Current retry attempts not maxed out");
+        //     assert.ok(responseHeaders[Constants.ThrottleRetryWaitTimeInMs]
+        //         >= connectionPolicy.RetryOptions.MaxRetryAttemptCount * retryAfterInMilliseconds);
+        // }
+        // request._createRequestObjectStub = originalCreateRequestObjectStub;
+        // client.getDatabaseAccount = originalGetDatabaseAccount;
+    });
+    xit("throttle retry policy test fixed retryAfter", async function () {
+        // connectionPolicy.RetryOptions = new RetryOptions(5, 2000);
+        // const client = new CosmosClient(endpoint, { masterKey }, connectionPolicy);
+        // const { result: db } = await client.createDatabase({ id: "sample database" });
+        // const { result: collection } = await client.createCollection(db._self, collectionDefinition);
+        // const originalGetDatabaseAccount = client.getDatabaseAccount;
+        // client.getDatabaseAccount = mockGetDatabaseAccount;
+        // const originalCreateRequestObjectStub = request._createRequestObjectStub;
+        // request._createRequestObjectStub = mockCreateRequestObjectStub;
+        // try {
+        //     await client.createDocument(collection._self, documentDefinition);
+        //     assert.fail("Must throw");
+        // } catch (err) {
+        //     const responseHeaders = (err as request.ErrorResponse).headers;
+        //     assert.equal(err.code, 429, "invalid error code");
+        //     assert.equal(responseHeaders[Constants.ThrottleRetryCount],
+        //         connectionPolicy.RetryOptions.MaxRetryAttemptCount, "Current retry attempts not maxed out");
+        //     assert.ok(responseHeaders[Constants.ThrottleRetryWaitTimeInMs]
+        //         >= connectionPolicy.RetryOptions.MaxRetryAttemptCount
+        //         * connectionPolicy.RetryOptions.FixedRetryIntervalInMilliseconds);
+        // }
+        // request._createRequestObjectStub = originalCreateRequestObjectStub;
+        // client.getDatabaseAccount = originalGetDatabaseAccount;
+    });
+    xit("throttle retry policy test max wait time", async function () {
+        // connectionPolicy.RetryOptions = new RetryOptions(5, 2000, 3);
+        // const client = new CosmosClient(endpoint, { masterKey }, connectionPolicy);
+        // const { result: db } = await client.createDatabase({ id: "sample database" });
+        // const { result: collection } = await client.createCollection(db._self, collectionDefinition);
+        // const originalGetDatabaseAccount = client.getDatabaseAccount;
+        // client.getDatabaseAccount = mockGetDatabaseAccount;
+        // const originalCreateRequestObjectStub = request._createRequestObjectStub;
+        // request._createRequestObjectStub = mockCreateRequestObjectStub;
+        // try {
+        //     await client.createDocument(collection._self, documentDefinition);
+        // } catch (err) {
+        //     const responseHeaders = (err as request.ErrorResponse).headers;
+        //     assert.equal(err.code, 429, "invalid error code");
+        //     assert.ok(responseHeaders[Constants.ThrottleRetryWaitTimeInMs]
+        //         >= connectionPolicy.RetryOptions.MaxWaitTimeInSeconds * 1000);
+        // }
+        // request._createRequestObjectStub = originalCreateRequestObjectStub;
+        // client.getDatabaseAccount = originalGetDatabaseAccount;
+    });
+    xit("default retry policy validate create failure", async function () {
+        // const client = new CosmosClient(endpoint, { masterKey }, connectionPolicy);
+        // const { result: db } = await client.createDatabase({ id: "sample database" });
+        // const { result: collection } = await client.createCollection(db._self, collectionDefinition);
+        // global.originalFunc = request._createRequestObjectStub;
+        // global.counter = 0;
+        // request._createRequestObjectStub = mockCreateRequestObjectForDefaultRetryStub;
+        // try {
+        //     await client.createDocument(collection._self, documentDefinition);
+        // } catch (err) {
+        //     assert.equal(err.code, "ECONNRESET", "invalid error code");
+        //     // assert.equal(global.counter, 6, "invalid number of retries");
+        // }
+        // request._createRequestObjectStub = global.originalFunc;
+    });
+    xit("default retry policy validate read success", async function () {
+        // const client = new CosmosClient(endpoint, { masterKey }, connectionPolicy);
+        // const { result: db } = await client.createDatabase({ id: "sample database" });
+        // const { result: collection } = await client.createCollection(db._self, collectionDefinition);
+        // const { result: createdDocument } = await client.createDocument(collection._self, documentDefinition);
+        // global.originalFunc = request._createRequestObjectStub;
+        // global.counter = 0;
+        // request._createRequestObjectStub = mockCreateRequestObjectForDefaultRetryStub;
+        // const { result: readDocument } = await client.readDocument(createdDocument._self);
+        // assert.equal(readDocument.id, documentDefinition.id, "invalid document id");
+        // assert.equal(global.counter, 5, "invalid number of retries");
+        // request._createRequestObjectStub = global.originalFunc;
+    });
+});
+//# sourceMappingURL=retry.spec.js.map

package/dist-esm/test/public/integration/retry.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry.spec.js","sourceRoot":"","sources":["../../../../test/public/integration/retry.spec.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;AAClC,+BAA+B;AAC/B,uFAAuF;AACvF,gDAAgD;AAEhD,QAAQ,CAAC,oBAAoB,EAAE;IAC7B,wBAAwB;IACxB,iCAAiC;IACjC,4BAA4B;IAC5B,KAAK;IAEL,+BAA+B;IAC/B,eAAe;IACf,6BAA6B;IAC7B,iBAAiB;IACjB,KAAK;IAEL,gFAAgF;IAChF,gCAAgC;IAChC,gEAAgE;IAChE,oEAAoE;IACpE,4CAA4C;IAC5C,KAAK;IAEL,yCAAyC;IACzC,kFAAkF;IAClF,8FAA8F;IAC9F,+DAA+D;IAC/D,wEAAwE;IACxE,KAAK;IAEL,2GAA2G;IAC3G,wBAAwB;IACxB,mCAAmC;IACnC,iFAAiF;IACjF,WAAW;IACX,gFAAgF;IAChF,IAAI;IAEJ,6EAA6E;IAC7E,GAAG,CAAC,+CAA+C,EAAE,KAAK;QACxD,uDAAuD;QACvD,iFAAiF;QACjF,iFAAiF;QACjF,gGAAgG;QAChG,gEAAgE;QAChE,sDAAsD;QACtD,4EAA4E;QAC5E,kEAAkE;QAClE,QAAQ;QACR,0CAA0C;QAC1C,6EAA6E;QAC7E,kBAAkB;QAClB,sEAAsE;QACtE,yDAAyD;QACzD,kEAAkE;QAClE,uGAAuG;QACvG,qEAAqE;QACrE,6FAA6F;QAC7F,IAAI;QACJ,sEAAsE;QACtE,0DAA0D;IAC5D,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,6CAA6C,EAAE,KAAK;QACtD,6DAA6D;QAC7D,8EAA8E;QAC9E,iFAAiF;QACjF,gGAAgG;QAChG,gEAAgE;QAChE,sDAAsD;QACtD,4EAA4E;QAC5E,kEAAkE;QAClE,QAAQ;QACR,yEAAyE;QACzE,iCAAiC;QACjC,kBAAkB;QAClB,sEAAsE;QACtE,yDAAyD;QACzD,kEAAkE;QAClE,uGAAuG;QACvG,qEAAqE;QACrE,gEAAgE;QAChE,6EAA6E;QAC7E,IAAI;QACJ,sEAAsE;QACtE,0DAA0D;IAC5D,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,0CAA0C,EAAE,KAAK;QACnD,gEAAgE;QAChE,8EAA8E;QAC9E,iFAAiF;QACjF,gGAAgG;QAChG,gEAAgE;QAChE,sDAAsD;QACtD,4EAA4E;QAC5E,kEAAkE;QAClE,QAAQ;QACR,yEAAyE;QACzE,kBAAkB;QAClB,sEAAsE;QACtE,yDAAyD;QACzD,qEAAqE;QACrE,yEAAyE;QACzE,IAAI;QACJ,sEAAsE;QACtE,0DAA0D;IAC5D,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,8CAA8C,EAAE,KAAK;QACvD,8EAA8E;QAC9E,iFAAiF;QACjF,gGAAgG;QAChG,0DAA0D;QAC1D,sBAAsB;QACtB,iFAAiF;QACjF,QAAQ;QACR,yEAAyE;QACzE,kBAAkB;QAClB,kEAAkE;QAClE,uEAAuE;QACvE,IAAI;QACJ,0DAA0D;IAC5D,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,4CAA4C,EAAE,KAAK;QACrD,8EAA8E;QAC9E,iFAAiF;QACjF,gGAAgG;QAChG,yGAAyG;QACzG,0DAA0D;QAC1D,sBAAsB;QACtB,iFAAiF;QACjF,qFAAqF;QACrF,+EAA+E;QAC/E,gEAAgE;QAChE,0DAA0D;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n// import assert from \"assert\";\n// import { ConnectionPolicy, Constants, CosmosClient, RetryOptions } from \"../../src\";\n// import * as request from \"../../src/request\";\n\ndescribe(\"retry policy tests\", function() {\n  // this.timeout(300000);\n  // const collectionDefinition = {\n  //   id: \"sample collection\"\n  // };\n\n  // const documentDefinition = {\n  //   id: \"doc\",\n  //   name: \"sample document\",\n  //   key: \"value\"\n  // };\n\n  // mocked database account to return the WritableLocations and ReadableLocations\n  // set with the default endpoint\n  // const mockGetDatabaseAccount = function (options, callback) {\n  //     const databaseAccount = new AzureDocuments.DatabaseAccount();\n  //     callback(undefined, databaseAccount);\n  // };\n\n  // const retryAfterInMilliseconds = 1000;\n  // // mocked request object stub that calls the callback with 429 throttling error\n  // const mockCreateRequestObjectStub = function (connectionPolicy, requestOptions, callback) {\n  //     callback({ code: 429, body: \"Request rate is too large\",\n  //                retryAfterInMilliseconds: retryAfterInMilliseconds });\n  // };\n\n  // var mockCreateRequestObjectForDefaultRetryStub = function (connectionPolicy, requestOptions, callback) {\n  //     global.counter++;\n  //     if (global.counter % 5 == 0)\n  //         return global.originalFunc(connectionPolicy, requestOptions, callback)\n  //     else\n  //         return callback({ code: \"ECONNRESET\", body: \"Connection was reset\" })\n  // }\n\n  // TODO: need to fix this, the stubbing doesn't work with the new way we work\n  xit(\"throttle retry policy test default retryAfter\", async function() {\n    // connectionPolicy.RetryOptions = new RetryOptions(5);\n    // const client = new CosmosClient({endpoint, key: masterKey, connectionPolicy});\n    // const { result: db } = await client.createDatabase({ id: \"sample database\" });\n    // const { result: collection } = await client.createCollection(db._self, collectionDefinition);\n    // const originalGetDatabaseAccount = client.getDatabaseAccount;\n    // client.getDatabaseAccount = mockGetDatabaseAccount;\n    // const originalCreateRequestObjectStub = request._createRequestObjectStub;\n    // request._createRequestObjectStub = mockCreateRequestObjectStub;\n    // try {\n    //     const { result: createdDocument } =\n    //         await client.createDocument(collection._self, documentDefinition);\n    // } catch (err) {\n    //     const responseHeaders = (err as request.ErrorResponse).headers;\n    //     assert.equal(err.code, 429, \"invalid error code\");\n    //     assert.equal(responseHeaders[Constants.ThrottleRetryCount],\n    //         connectionPolicy.RetryOptions.MaxRetryAttemptCount, \"Current retry attempts not maxed out\");\n    //     assert.ok(responseHeaders[Constants.ThrottleRetryWaitTimeInMs]\n    //         >= connectionPolicy.RetryOptions.MaxRetryAttemptCount * retryAfterInMilliseconds);\n    // }\n    // request._createRequestObjectStub = originalCreateRequestObjectStub;\n    // client.getDatabaseAccount = originalGetDatabaseAccount;\n  });\n\n  xit(\"throttle retry policy test fixed retryAfter\", async function() {\n    // connectionPolicy.RetryOptions = new RetryOptions(5, 2000);\n    // const client = new CosmosClient(endpoint, { masterKey }, connectionPolicy);\n    // const { result: db } = await client.createDatabase({ id: \"sample database\" });\n    // const { result: collection } = await client.createCollection(db._self, collectionDefinition);\n    // const originalGetDatabaseAccount = client.getDatabaseAccount;\n    // client.getDatabaseAccount = mockGetDatabaseAccount;\n    // const originalCreateRequestObjectStub = request._createRequestObjectStub;\n    // request._createRequestObjectStub = mockCreateRequestObjectStub;\n    // try {\n    //     await client.createDocument(collection._self, documentDefinition);\n    //     assert.fail(\"Must throw\");\n    // } catch (err) {\n    //     const responseHeaders = (err as request.ErrorResponse).headers;\n    //     assert.equal(err.code, 429, \"invalid error code\");\n    //     assert.equal(responseHeaders[Constants.ThrottleRetryCount],\n    //         connectionPolicy.RetryOptions.MaxRetryAttemptCount, \"Current retry attempts not maxed out\");\n    //     assert.ok(responseHeaders[Constants.ThrottleRetryWaitTimeInMs]\n    //         >= connectionPolicy.RetryOptions.MaxRetryAttemptCount\n    //         * connectionPolicy.RetryOptions.FixedRetryIntervalInMilliseconds);\n    // }\n    // request._createRequestObjectStub = originalCreateRequestObjectStub;\n    // client.getDatabaseAccount = originalGetDatabaseAccount;\n  });\n\n  xit(\"throttle retry policy test max wait time\", async function() {\n    // connectionPolicy.RetryOptions = new RetryOptions(5, 2000, 3);\n    // const client = new CosmosClient(endpoint, { masterKey }, connectionPolicy);\n    // const { result: db } = await client.createDatabase({ id: \"sample database\" });\n    // const { result: collection } = await client.createCollection(db._self, collectionDefinition);\n    // const originalGetDatabaseAccount = client.getDatabaseAccount;\n    // client.getDatabaseAccount = mockGetDatabaseAccount;\n    // const originalCreateRequestObjectStub = request._createRequestObjectStub;\n    // request._createRequestObjectStub = mockCreateRequestObjectStub;\n    // try {\n    //     await client.createDocument(collection._self, documentDefinition);\n    // } catch (err) {\n    //     const responseHeaders = (err as request.ErrorResponse).headers;\n    //     assert.equal(err.code, 429, \"invalid error code\");\n    //     assert.ok(responseHeaders[Constants.ThrottleRetryWaitTimeInMs]\n    //         >= connectionPolicy.RetryOptions.MaxWaitTimeInSeconds * 1000);\n    // }\n    // request._createRequestObjectStub = originalCreateRequestObjectStub;\n    // client.getDatabaseAccount = originalGetDatabaseAccount;\n  });\n\n  xit(\"default retry policy validate create failure\", async function() {\n    // const client = new CosmosClient(endpoint, { masterKey }, connectionPolicy);\n    // const { result: db } = await client.createDatabase({ id: \"sample database\" });\n    // const { result: collection } = await client.createCollection(db._self, collectionDefinition);\n    // global.originalFunc = request._createRequestObjectStub;\n    // global.counter = 0;\n    // request._createRequestObjectStub = mockCreateRequestObjectForDefaultRetryStub;\n    // try {\n    //     await client.createDocument(collection._self, documentDefinition);\n    // } catch (err) {\n    //     assert.equal(err.code, \"ECONNRESET\", \"invalid error code\");\n    //     // assert.equal(global.counter, 6, \"invalid number of retries\");\n    // }\n    // request._createRequestObjectStub = global.originalFunc;\n  });\n\n  xit(\"default retry policy validate read success\", async function() {\n    // const client = new CosmosClient(endpoint, { masterKey }, connectionPolicy);\n    // const { result: db } = await client.createDatabase({ id: \"sample database\" });\n    // const { result: collection } = await client.createCollection(db._self, collectionDefinition);\n    // const { result: createdDocument } = await client.createDocument(collection._self, documentDefinition);\n    // global.originalFunc = request._createRequestObjectStub;\n    // global.counter = 0;\n    // request._createRequestObjectStub = mockCreateRequestObjectForDefaultRetryStub;\n    // const { result: readDocument } = await client.readDocument(createdDocument._self);\n    // assert.equal(readDocument.id, documentDefinition.id, \"invalid document id\");\n    // assert.equal(global.counter, 5, \"invalid number of retries\");\n    // request._createRequestObjectStub = global.originalFunc;\n  });\n});\n"]}

package/dist-esm/test/public/integration/split.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=split.spec.d.ts.map

package/dist-esm/test/public/integration/split.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"split.spec.d.ts","sourceRoot":"","sources":["../../../../test/public/integration/split.spec.ts"],"names":[],"mappings":""}

package/dist-esm/test/public/integration/split.spec.js

@@ -0,0 +1,138 @@
+import { __asyncValues } from "tslib";
+import { bulkInsertItems, getTestContainer, removeAllDatabases } from "../common/TestHelpers";
+import { Constants, CosmosClient, PluginOn } from "../../../src";
+import { endpoint } from "../common/_testConfig";
+import { masterKey } from "../common/_fakeTestSecrets";
+import { SubStatusCodes } from "../../../src/common";
+import assert from "assert";
+const splitError = new Error("Fake Partition Split");
+splitError.code = 410;
+splitError.substatus = SubStatusCodes.PartitionKeyRangeGone;
+const generateDocuments = function (docSize) {
+    const docs = [];
+    for (let i = 0; i < docSize; i++) {
+        docs.push({ id: i.toString() });
+    }
+    return docs;
+};
+const documentDefinitions = generateDocuments(20);
+describe("Partition Splits", () => {
+    let container;
+    before(async function () {
+        await removeAllDatabases();
+        container = await getTestContainer("Partition Splits", undefined, {
+            id: "partitionSplits",
+            partitionKey: {
+                paths: ["/id"]
+            }
+        }, { offerThroughput: 25100 });
+        await bulkInsertItems(container, documentDefinitions);
+    });
+    it("handles one split part way through iteration", async () => {
+        let hasSplit = false;
+        const partitionKeyRanges = new Set();
+        const options = { endpoint, key: masterKey };
+        const plugins = [
+            {
+                on: PluginOn.request,
+                plugin: async (context, next) => {
+                    // This plugin throws a single 410 on the *second* time we see the same partition key range ID
+                    const partitionKeyRangeId = context === null || context === void 0 ? void 0 : context.headers[Constants.HttpHeaders.PartitionKeyRangeID];
+                    if (partitionKeyRanges.has(partitionKeyRangeId) && hasSplit === false) {
+                        hasSplit = true;
+                        const error = new Error("Fake Partition Split");
+                        error.code = 410;
+                        error.substatus = SubStatusCodes.PartitionKeyRangeGone;
+                        throw error;
+                    }
+                    if (partitionKeyRangeId) {
+                        partitionKeyRanges.add(partitionKeyRangeId);
+                    }
+                    return next(context);
+                }
+            }
+        ];
+        const client = new CosmosClient(Object.assign(Object.assign({}, options), { plugins, connectionPolicy: { enableBackgroundEndpointRefreshing: false } }));
+        const { resources } = await client
+            .database(container.database.id)
+            .container(container.id)
+            .items.query("SELECT * FROM root r", { maxItemCount: 2, maxDegreeOfParallelism: 1 })
+            .fetchAll();
+        // TODO. These should be equal but right now they are not
+        // I suspect injecting a random 410 with out actually splitting the documents
+        // results in duplicates by trying to read from two partitions
+        assert(resources.length >= documentDefinitions.length);
+    });
+    it("split errors surface as 503", async () => {
+        var e_1, _a;
+        const options = { endpoint, key: masterKey };
+        const plugins = [
+            {
+                on: PluginOn.request,
+                plugin: async (context, next) => {
+                    // This plugin throws a single 410 for partition key range ID 0 on every single request
+                    const partitionKeyRangeId = context === null || context === void 0 ? void 0 : context.headers[Constants.HttpHeaders.PartitionKeyRangeID];
+                    if (partitionKeyRangeId === "0") {
+                        const error = new Error("Fake Partition Split");
+                        error.code = 410;
+                        error.substatus = SubStatusCodes.PartitionKeyRangeGone;
+                        throw error;
+                    }
+                    return next(context);
+                }
+            }
+        ];
+        const client = new CosmosClient(Object.assign(Object.assign({}, options), { plugins, connectionPolicy: { enableBackgroundEndpointRefreshing: false } }));
+        // fetchAll()
+        try {
+            await client
+                .database(container.database.id)
+                .container(container.id)
+                .items.query("SELECT * FROM root r", { maxItemCount: 2, maxDegreeOfParallelism: 1 })
+                .fetchAll();
+            assert.fail("Expected query to fail");
+        }
+        catch (e) {
+            assert.strictEqual(e.code, 503);
+        }
+        // fetchNext()
+        try {
+            await client
+                .database(container.database.id)
+                .container(container.id)
+                .items.query("SELECT * FROM root r", { maxItemCount: 2, maxDegreeOfParallelism: 1 })
+                .fetchNext();
+            assert.fail("Expected query to fail");
+        }
+        catch (e) {
+            assert.strictEqual(e.code, 503);
+        }
+        // asyncIterator
+        try {
+            const iterator = client
+                .database(container.database.id)
+                .container(container.id)
+                .items.query("SELECT * FROM root r", { maxItemCount: 2, maxDegreeOfParallelism: 1 })
+                .getAsyncIterator();
+            const results = [];
+            try {
+                for (var iterator_1 = __asyncValues(iterator), iterator_1_1; iterator_1_1 = await iterator_1.next(), !iterator_1_1.done;) {
+                    const result = iterator_1_1.value;
+                    results.push(result);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (iterator_1_1 && !iterator_1_1.done && (_a = iterator_1.return)) await _a.call(iterator_1);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            assert.fail("Expected query to fail");
+        }
+        catch (e) {
+            assert.strictEqual(e.code, 503);
+        }
+    });
+});
+//# sourceMappingURL=split.spec.js.map

package/dist-esm/test/public/integration/split.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"split.spec.js","sourceRoot":"","sources":["../../../../test/public/integration/split.spec.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAqC,MAAM,cAAc,CAAC;AACpG,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,MAAM,UAAU,GAAG,IAAI,KAAK,CAAC,sBAAsB,CAAQ,CAAC;AAC5D,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC;AACtB,UAAU,CAAC,SAAS,GAAG,cAAc,CAAC,qBAAqB,CAAC;AAE5D,MAAM,iBAAiB,GAAG,UACxB,OAAe;IAIf,MAAM,IAAI,GAAG,EAAE,CAAC;IAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,EAAE,EAAE;QAChC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;KACjC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;AAElD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,SAAoB,CAAC;IAEzB,MAAM,CAAC,KAAK;QACV,MAAM,kBAAkB,EAAE,CAAC;QAC3B,SAAS,GAAG,MAAM,gBAAgB,CAChC,kBAAkB,EAClB,SAAS,EACT;YACE,EAAE,EAAE,iBAAiB;YACrB,YAAY,EAAE;gBACZ,KAAK,EAAE,CAAC,KAAK,CAAC;aACf;SACF,EACD,EAAE,eAAe,EAAE,KAAK,EAAE,CAC3B,CAAC;QACF,MAAM,eAAe,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAE,CAAC;QACrC,MAAM,OAAO,GAAwB,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;QAClE,MAAM,OAAO,GAAmB;YAC9B;gBACE,EAAE,EAAE,QAAQ,CAAC,OAAO;gBACpB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;oBAC9B,8FAA8F;oBAC9F,MAAM,mBAAmB,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;oBACxF,IAAI,kBAAkB,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,QAAQ,KAAK,KAAK,EAAE;wBACrE,QAAQ,GAAG,IAAI,CAAC;wBAChB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,sBAAsB,CAAQ,CAAC;wBACvD,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC;wBACjB,KAAK,CAAC,SAAS,GAAG,cAAc,CAAC,qBAAqB,CAAC;wBACvD,MAAM,KAAK,CAAC;qBACb;oBACD,IAAI,mBAAmB,EAAE;wBACvB,kBAAkB,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;qBAC7C;oBACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvB,CAAC;aACF;SACF,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,gCAC3B,OAAO,KACV,OAAO,EACP,gBAAgB,EAAE,EAAE,kCAAkC,EAAE,KAAK,EAAE,GACzD,CAAC,CAAC;QACV,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,MAAM;aAC/B,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;aAC/B,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;aACvB,KAAK,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,sBAAsB,EAAE,CAAC,EAAE,CAAC;aACnF,QAAQ,EAAE,CAAC;QAEd,yDAAyD;QACzD,6EAA6E;QAC7E,8DAA8D;QAC9D,MAAM,CAAC,SAAS,CAAC,MAAM,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;;QAC3C,MAAM,OAAO,GAAwB,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;QAClE,MAAM,OAAO,GAAmB;YAC9B;gBACE,EAAE,EAAE,QAAQ,CAAC,OAAO;gBACpB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;oBAC9B,uFAAuF;oBACvF,MAAM,mBAAmB,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;oBACxF,IAAI,mBAAmB,KAAK,GAAG,EAAE;wBAC/B,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,sBAAsB,CAAQ,CAAC;wBACvD,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC;wBACjB,KAAK,CAAC,SAAS,GAAG,cAAc,CAAC,qBAAqB,CAAC;wBACvD,MAAM,KAAK,CAAC;qBACb;oBACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvB,CAAC;aACF;SACF,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,gCAC3B,OAAO,KACV,OAAO,EACP,gBAAgB,EAAE,EAAE,kCAAkC,EAAE,KAAK,EAAE,GACzD,CAAC,CAAC;QAEV,aAAa;QACb,IAAI;YACF,MAAM,MAAM;iBACT,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;iBAC/B,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;iBACvB,KAAK,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,sBAAsB,EAAE,CAAC,EAAE,CAAC;iBACnF,QAAQ,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;SACvC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SACjC;QAED,cAAc;QACd,IAAI;YACF,MAAM,MAAM;iBACT,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;iBAC/B,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;iBACvB,KAAK,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,sBAAsB,EAAE,CAAC,EAAE,CAAC;iBACnF,SAAS,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;SACvC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SACjC;QAED,gBAAgB;QAChB,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM;iBACpB,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;iBAC/B,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;iBACvB,KAAK,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,sBAAsB,EAAE,CAAC,EAAE,CAAC;iBACnF,gBAAgB,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,EAAE,CAAC;;gBACnB,KAA2B,IAAA,aAAA,cAAA,QAAQ,CAAA,cAAA;oBAAxB,MAAM,MAAM,qBAAA,CAAA;oBACrB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;iBACtB;;;;;;;;;YACD,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;SACvC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SACjC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\nimport { Container } from \"../../../src\";\nimport { bulkInsertItems, getTestContainer, removeAllDatabases } from \"../common/TestHelpers\";\nimport { Constants, CosmosClient, PluginOn, CosmosClientOptions, PluginConfig } from \"../../../src\";\nimport { endpoint } from \"../common/_testConfig\";\nimport { masterKey } from \"../common/_fakeTestSecrets\";\nimport { SubStatusCodes } from \"../../../src/common\";\nimport assert from \"assert\";\n\nconst splitError = new Error(\"Fake Partition Split\") as any;\nsplitError.code = 410;\nsplitError.substatus = SubStatusCodes.PartitionKeyRangeGone;\n\nconst generateDocuments = function(\n  docSize: number\n): {\n  id: string;\n}[] {\n  const docs = [];\n  for (let i = 0; i < docSize; i++) {\n    docs.push({ id: i.toString() });\n  }\n  return docs;\n};\n\nconst documentDefinitions = generateDocuments(20);\n\ndescribe(\"Partition Splits\", () => {\n  let container: Container;\n\n  before(async function() {\n    await removeAllDatabases();\n    container = await getTestContainer(\n      \"Partition Splits\",\n      undefined,\n      {\n        id: \"partitionSplits\",\n        partitionKey: {\n          paths: [\"/id\"]\n        }\n      },\n      { offerThroughput: 25100 }\n    );\n    await bulkInsertItems(container, documentDefinitions);\n  });\n\n  it(\"handles one split part way through iteration\", async () => {\n    let hasSplit = false;\n    const partitionKeyRanges = new Set();\n    const options: CosmosClientOptions = { endpoint, key: masterKey };\n    const plugins: PluginConfig[] = [\n      {\n        on: PluginOn.request,\n        plugin: async (context, next) => {\n          // This plugin throws a single 410 on the *second* time we see the same partition key range ID\n          const partitionKeyRangeId = context?.headers[Constants.HttpHeaders.PartitionKeyRangeID];\n          if (partitionKeyRanges.has(partitionKeyRangeId) && hasSplit === false) {\n            hasSplit = true;\n            const error = new Error(\"Fake Partition Split\") as any;\n            error.code = 410;\n            error.substatus = SubStatusCodes.PartitionKeyRangeGone;\n            throw error;\n          }\n          if (partitionKeyRangeId) {\n            partitionKeyRanges.add(partitionKeyRangeId);\n          }\n          return next(context);\n        }\n      }\n    ];\n    const client = new CosmosClient({\n      ...options,\n      plugins,\n      connectionPolicy: { enableBackgroundEndpointRefreshing: false }\n    } as any);\n    const { resources } = await client\n      .database(container.database.id)\n      .container(container.id)\n      .items.query(\"SELECT * FROM root r\", { maxItemCount: 2, maxDegreeOfParallelism: 1 })\n      .fetchAll();\n\n    // TODO. These should be equal but right now they are not\n    // I suspect injecting a random 410 with out actually splitting the documents\n    // results in duplicates by trying to read from two partitions\n    assert(resources.length >= documentDefinitions.length);\n  });\n\n  it(\"split errors surface as 503\", async () => {\n    const options: CosmosClientOptions = { endpoint, key: masterKey };\n    const plugins: PluginConfig[] = [\n      {\n        on: PluginOn.request,\n        plugin: async (context, next) => {\n          // This plugin throws a single 410 for partition key range ID 0 on every single request\n          const partitionKeyRangeId = context?.headers[Constants.HttpHeaders.PartitionKeyRangeID];\n          if (partitionKeyRangeId === \"0\") {\n            const error = new Error(\"Fake Partition Split\") as any;\n            error.code = 410;\n            error.substatus = SubStatusCodes.PartitionKeyRangeGone;\n            throw error;\n          }\n          return next(context);\n        }\n      }\n    ];\n    const client = new CosmosClient({\n      ...options,\n      plugins,\n      connectionPolicy: { enableBackgroundEndpointRefreshing: false }\n    } as any);\n\n    // fetchAll()\n    try {\n      await client\n        .database(container.database.id)\n        .container(container.id)\n        .items.query(\"SELECT * FROM root r\", { maxItemCount: 2, maxDegreeOfParallelism: 1 })\n        .fetchAll();\n      assert.fail(\"Expected query to fail\");\n    } catch (e) {\n      assert.strictEqual(e.code, 503);\n    }\n\n    // fetchNext()\n    try {\n      await client\n        .database(container.database.id)\n        .container(container.id)\n        .items.query(\"SELECT * FROM root r\", { maxItemCount: 2, maxDegreeOfParallelism: 1 })\n        .fetchNext();\n      assert.fail(\"Expected query to fail\");\n    } catch (e) {\n      assert.strictEqual(e.code, 503);\n    }\n\n    // asyncIterator\n    try {\n      const iterator = client\n        .database(container.database.id)\n        .container(container.id)\n        .items.query(\"SELECT * FROM root r\", { maxItemCount: 2, maxDegreeOfParallelism: 1 })\n        .getAsyncIterator();\n      const results = [];\n      for await (const result of iterator) {\n        results.push(result);\n      }\n      assert.fail(\"Expected query to fail\");\n    } catch (e) {\n      assert.strictEqual(e.code, 503);\n    }\n  });\n});\n"]}

package/dist-esm/test/public/integration/sslVerification.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sslVerification.spec.d.ts.map

package/dist-esm/test/public/integration/sslVerification.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sslVerification.spec.d.ts","sourceRoot":"","sources":["../../../../test/public/integration/sslVerification.spec.ts"],"names":[],"mappings":""}

package/dist-esm/test/public/integration/sslVerification.spec.js

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import assert from "assert";
+import { CosmosClient } from "../../../src";
+import { getTestDatabase } from "../common/TestHelpers";
+import https from "https";
+const endpoint = "https://localhost:8081";
+const masterKey = "C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==";
+describe("Validate SSL verification check for emulator #nosignoff", function () {
+    it("should throw exception", async function () {
+        try {
+            const client = new CosmosClient({
+                endpoint,
+                key: masterKey,
+                connectionPolicy: { enableBackgroundEndpointRefreshing: false }
+            });
+            // create database
+            await getTestDatabase("ssl verification", client);
+        }
+        catch (err) {
+            // connecting to emulator should throw SSL verification error,
+            assert.equal(err.code, "DEPTH_ZERO_SELF_SIGNED_CERT", "client should throw exception");
+        }
+    });
+    it("disable ssl check via agent", async function () {
+        const client = new CosmosClient({
+            endpoint,
+            key: masterKey,
+            agent: new https.Agent({
+                rejectUnauthorized: false
+            }),
+            connectionPolicy: { enableBackgroundEndpointRefreshing: false }
+        });
+        // create database
+        await getTestDatabase("ssl verification", client);
+    });
+});
+//# sourceMappingURL=sslVerification.spec.js.map