@azure/cosmos 3.16.3 → 3.16.4

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History
 
+## 3.16.4 (2022-08-05)
+
+### Bugs Fixed
+- Reverts changes of [PR 22548](https://github.com/Azure/azure-sdk-for-js/pull/22548) to avoid possible regression when customers use id with special characters and their account is on ComputeGateway already. - See [PR 22818](https://github.com/Azure/azure-sdk-for-js/pull/22818)
+
 ## 3.16.3 (2022-07-13)
 
 ### Bugs Fixed

package/dist/index.js

@@ -179,7 +179,7 @@ const Constants = {
     AzureNamespace: "Azure.Cosmos",
     AzurePackageName: "@azure/cosmos",
     SDKName: "azure-cosmos-js",
-    SDKVersion: "3.16.3",
+    SDKVersion: "3.16.4",
     Quota: {
         CollectionSize: "collectionSize",
     },
@@ -412,6 +412,7 @@ exports.SasTokenPermissionKind = void 0;
 const trimLeftSlashes = new RegExp("^[/]+");
 const trimRightSlashes = new RegExp("[/]+$");
 const illegalResourceIdCharacters = new RegExp("[/\\\\?#]");
+const illegalItemResourceIdCharacters = new RegExp("[/\\\\#]");
 /** @hidden */
 function jsonStringifyAndEscapeNonASCII(arg) {
     // TODO: better way for this? Not sure.
@@ -564,7 +565,33 @@ function isResourceValid(resource, err) {
             err.message = "Id must be a string.";
             return false;
         }
-        if (resource.id.indexOf("/") !== -1 || resource.id.indexOf("\\") !== -1) {
+        if (resource.id.indexOf("/") !== -1 ||
+            resource.id.indexOf("\\") !== -1 ||
+            resource.id.indexOf("?") !== -1 ||
+            resource.id.indexOf("#") !== -1) {
+            err.message = "Id contains illegal chars.";
+            return false;
+        }
+        if (resource.id[resource.id.length - 1] === " ") {
+            err.message = "Id ends with a space.";
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * @hidden
+ */
+function isItemResourceValid(resource, err) {
+    // TODO: fix strictness issues so that caller contexts respects the types of the functions
+    if (resource.id) {
+        if (typeof resource.id !== "string") {
+            err.message = "Id must be a string.";
+            return false;
+        }
+        if (resource.id.indexOf("/") !== -1 ||
+            resource.id.indexOf("\\") !== -1 ||
+            resource.id.indexOf("#") !== -1) {
             err.message = "Id contains illegal chars.";
             return false;
         }
@@ -608,11 +635,25 @@ function trimSlashFromLeftAndRight(inputString) {
 function validateResourceId(resourceId) {
     // if resourceId is not a string or is empty throw an error
     if (typeof resourceId !== "string" || isStringNullOrEmpty(resourceId)) {
-        throw new Error("Resource Id must be a string and cannot be undefined, null or empty");
+        throw new Error("Resource ID must be a string and cannot be undefined, null or empty");
     }
     // if resource id contains illegal characters throw an error
     if (illegalResourceIdCharacters.test(resourceId)) {
-        throw new Error("Illegal characters ['/', '\\'] cannot be used in resourceId");
+        throw new Error("Illegal characters ['/', '\\', '#', '?'] cannot be used in Resource ID");
+    }
+    return true;
+}
+/**
+ * @hidden
+ */
+function validateItemResourceId(resourceId) {
+    // if resourceId is not a string or is empty throw an error
+    if (typeof resourceId !== "string" || isStringNullOrEmpty(resourceId)) {
+        throw new Error("Resource ID must be a string and cannot be undefined, null or empty");
+    }
+    // if resource id contains illegal characters throw an error
+    if (illegalItemResourceIdCharacters.test(resourceId)) {
+        throw new Error("Illegal characters ['/', '\\', '#'] cannot be used in Resource ID");
     }
     return true;
 }
@@ -760,7 +801,7 @@ function createUserUri(databaseId, userId) {
  */
 function createDocumentUri(databaseId, collectionId, documentId) {
     documentId = trimSlashFromLeftAndRight(documentId);
-    validateResourceId(documentId);
+    validateItemResourceId(documentId);
     return (createDocumentCollectionUri(databaseId, collectionId) +
         "/" +
         Constants.Path.DocumentsPathSegment +
@@ -908,17 +949,6 @@ async function generateHeaders(masterKey, method, resourceType = exports.Resourc
         [Constants.HttpHeaders.XDate]: date.toUTCString(),
     };
 }
-function getEffectiveResourceIdForSignature(resourceId) {
-    const lastSlashPosition = resourceId.lastIndexOf("/");
-    if (lastSlashPosition <= 0) {
-        return resourceId;
-    }
-    const prefix = resourceId.substring(0, lastSlashPosition);
-    if (!prefix.endsWith("/docs")) {
-        return resourceId;
-    }
-    return prefix + "/" + decodeURIComponent(resourceId.substring(lastSlashPosition + 1));
-}
 async function signature(masterKey, method, resourceType, resourceId = "", date = new Date()) {
     const type = "master";
     const version = "1.0";
@@ -926,7 +956,7 @@ async function signature(masterKey, method, resourceType, resourceId = "", date
         "\n" +
         resourceType.toLowerCase() +
         "\n" +
-        getEffectiveResourceIdForSignature(resourceId) +
+        resourceId +
         "\n" +
         date.toUTCString().toLowerCase() +
         "\n" +
@@ -4372,7 +4402,7 @@ class Item {
      * Returns a reference URL to the resource. Used for linking in Permissions.
      */
     get url() {
-        return createDocumentUri(this.container.database.id, this.container.id, encodeURIComponent(this.id));
+        return createDocumentUri(this.container.database.id, this.container.id, this.id);
     }
     /**
      * Read the item's definition.
@@ -4403,9 +4433,8 @@ class Item {
             const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
             this.partitionKey = undefinedPartitionKey(partitionKeyDefinition);
         }
-        const resourceUri = this.url;
-        const path = getPathFromLink(resourceUri);
-        const id = getIdFromLink(resourceUri);
+        const path = getPathFromLink(this.url);
+        const id = getIdFromLink(this.url);
         let response;
         try {
             response = await this.clientContext.read({
@@ -4430,12 +4459,11 @@ class Item {
             this.partitionKey = extractPartitionKey(body, partitionKeyDefinition);
         }
         const err = {};
-        if (!isResourceValid(body, err)) {
+        if (!isItemResourceValid(body, err)) {
             throw err;
         }
-        const resourceUri = this.url;
-        const path = getPathFromLink(resourceUri);
-        const id = getIdFromLink(resourceUri);
+        const path = getPathFromLink(this.url);
+        const id = getIdFromLink(this.url);
         const response = await this.clientContext.replace({
             body,
             path,
@@ -4459,9 +4487,8 @@ class Item {
             const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
             this.partitionKey = undefinedPartitionKey(partitionKeyDefinition);
         }
-        const resourceUri = this.url;
-        const path = getPathFromLink(resourceUri);
-        const id = getIdFromLink(resourceUri);
+        const path = getPathFromLink(this.url);
+        const id = getIdFromLink(this.url);
         const response = await this.clientContext.delete({
             path,
             resourceType: exports.ResourceType.item,
@@ -4484,9 +4511,8 @@ class Item {
             const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
             this.partitionKey = extractPartitionKey(body, partitionKeyDefinition);
         }
-        const resourceUri = this.url;
-        const path = getPathFromLink(resourceUri);
-        const id = getIdFromLink(resourceUri);
+        const path = getPathFromLink(this.url);
+        const id = getIdFromLink(this.url);
         const response = await this.clientContext.patch({
             body,
             path,
@@ -5416,7 +5442,7 @@ class Items {
         const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
         const partitionKey = extractPartitionKey(body, partitionKeyDefinition);
         const err = {};
-        if (!isResourceValid(body, err)) {
+        if (!isItemResourceValid(body, err)) {
             throw err;
         }
         const path = getPathFromLink(this.container.url, exports.ResourceType.item);
@@ -5441,7 +5467,7 @@ class Items {
             body.id = uuid$1();
         }
         const err = {};
-        if (!isResourceValid(body, err)) {
+        if (!isItemResourceValid(body, err)) {
             throw err;
         }
         const path = getPathFromLink(this.container.url, exports.ResourceType.item);