Preliminary If-Match ETag support for User and Channel (#432)

Preliminary If-Match ETag support for User and Channel --------- Co-authored-by: Mohit Tejani <[email protected]>
pubnub · Jan 21, 2025 · f5f9670 · f5f9670
1 parent 875e44b
commit f5f9670
Show file tree

Hide file tree

Showing 14 changed files with 91 additions and 10 deletions.
diff --git a/.pubnub.yml b/.pubnub.yml
@@ -1,5 +1,10 @@
 ---
 changelog:
+  - date: 2025-01-21
+    version: v8.6.0
+    changes:
+      - type: feature
+        text: "A new optional parameter `ifMatchesEtag` is added to `setUUIDMetadata` and `setChannelMetadata`. When provided, the server compares the argument value with the ETag on the server and if they don't match a HTTP 412 error is returned."
   - date: 2025-01-15
     version: v8.5.0
     changes:
@@ -1106,7 +1111,7 @@ supported-platforms:
       - 'Ubuntu 14.04 and up'
       - 'Windows 7 and up'
     version: 'Pubnub Javascript for Node'
-version: '8.5.0'
+version: '8.6.0'
 sdks:
   - full-name: PubNub Javascript SDK
     short-name: Javascript
@@ -1122,7 +1127,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v8.5.0.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v8.6.0.zip
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'
@@ -1793,7 +1798,7 @@ sdks:
           - distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v8.5.0/pubnub.8.5.0.js
+            location: https://github.com/pubnub/javascript/releases/download/v8.6.0/pubnub.8.6.0.js
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## v8.6.0
+January 21 2025
+
+#### Added
+- A new optional parameter `ifMatchesEtag` is added to `setUUIDMetadata` and `setChannelMetadata`. When provided, the server compares the argument value with the ETag on the server and if they don't match a HTTP 412 error is returned.
+
 ## v8.5.0
 January 15 2025
 

diff --git a/README.md b/README.md
@@ -28,8 +28,8 @@ Watch [Getting Started with PubNub JS SDK](https://app.dashcam.io/replay/64ee0d2
      npm install pubnub
      ```
    * or download one of our builds from our CDN: 
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.5.0.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.5.0.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.6.0.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.6.0.min.js
 
 2. Configure your keys:
 

diff --git a/dist/web/pubnub.js b/dist/web/pubnub.js
@@ -3974,7 +3974,7 @@
 	            return base.PubNubFile;
 	        },
 	        get version() {
-	            return '8.5.0';
+	            return '8.6.0';
 	        },
 	        getVersion() {
 	            return this.version;
@@ -11553,6 +11553,14 @@
 	        if (!this.parameters.data)
 	            return 'Data cannot be empty';
 	    }
+	    get headers() {
+	        if (this.parameters.ifMatchesEtag) {
+	            return { 'If-Match': this.parameters.ifMatchesEtag };
+	        }
+	        else {
+	            return undefined;
+	        }
+	    }
 	    parse(response) {
 	        return __awaiter(this, void 0, void 0, function* () {
 	            const serviceResponse = this.deserializeResponse(response);
@@ -11972,6 +11980,14 @@
 	        if (!this.parameters.data)
 	            return 'Data cannot be empty';
 	    }
+	    get headers() {
+	        if (this.parameters.ifMatchesEtag) {
+	            return { 'If-Match': this.parameters.ifMatchesEtag };
+	        }
+	        else {
+	            return undefined;
+	        }
+	    }
 	    parse(response) {
 	        return __awaiter(this, void 0, void 0, function* () {
 	            const serviceResponse = this.deserializeResponse(response);

diff --git a/dist/web/pubnub.min.js b/dist/web/pubnub.min.js
diff --git a/lib/core/components/configuration.js b/lib/core/components/configuration.js
@@ -120,7 +120,7 @@ const makeConfiguration = (base, setupCryptoModule) => {
             return base.PubNubFile;
         },
         get version() {
-            return '8.5.0';
+            return '8.6.0';
         },
         getVersion() {
             return this.version;

diff --git a/lib/core/endpoints/objects/channel/set.js b/lib/core/endpoints/objects/channel/set.js
@@ -57,6 +57,14 @@ class SetChannelMetadataRequest extends request_1.AbstractRequest {
         if (!this.parameters.data)
             return 'Data cannot be empty';
     }
+    get headers() {
+        if (this.parameters.ifMatchesEtag) {
+            return { 'If-Match': this.parameters.ifMatchesEtag };
+        }
+        else {
+            return undefined;
+        }
+    }
     parse(response) {
         return __awaiter(this, void 0, void 0, function* () {
             const serviceResponse = this.deserializeResponse(response);

diff --git a/lib/core/endpoints/objects/uuid/set.js b/lib/core/endpoints/objects/uuid/set.js
@@ -60,6 +60,14 @@ class SetUUIDMetadataRequest extends request_1.AbstractRequest {
         if (!this.parameters.data)
             return 'Data cannot be empty';
     }
+    get headers() {
+        if (this.parameters.ifMatchesEtag) {
+            return { 'If-Match': this.parameters.ifMatchesEtag };
+        }
+        else {
+            return undefined;
+        }
+    }
     parse(response) {
         return __awaiter(this, void 0, void 0, function* () {
             const serviceResponse = this.deserializeResponse(response);

diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
@@ -5627,6 +5627,11 @@ declare namespace PubNub {
        * Fields which can be additionally included into response.
        */
       include?: Omit<IncludeOptions, 'totalCount'>;
+      /**
+       * Optional entity tag from a previously received `PNUUIDMetadata`. The request
+       * will fail if this parameter is specified and the ETag value on the server doesn't match.
+       */
+      ifMatchesEtag?: string;
     };
 
     /**
@@ -5752,6 +5757,11 @@ declare namespace PubNub {
        * Fields which can be additionally included into response.
        */
       include?: Omit<IncludeOptions, 'totalCount'>;
+      /**
+       * Optional entity tag from a previously received `PNUUIDMetadata`. The request
+       * will fail if this parameter is specified and the ETag value on the server doesn't match.
+       */
+      ifMatchesEtag?: string;
     };
 
     /**

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pubnub",
-  "version": "8.5.0",
+  "version": "8.6.0",
   "author": "PubNub <[email protected]>",
   "description": "Publish & Subscribe Real-time Messaging with PubNub",
   "scripts": {

diff --git a/src/core/components/configuration.ts b/src/core/components/configuration.ts
@@ -178,7 +178,7 @@ export const makeConfiguration = (
       return base.PubNubFile;
     },
     get version(): string {
-      return '8.5.0';
+      return '8.6.0';
     },
     getVersion(): string {
       return this.version;

diff --git a/src/core/endpoints/objects/channel/set.ts b/src/core/endpoints/objects/channel/set.ts
@@ -67,6 +67,14 @@ export class SetChannelMetadataRequest<
     if (!this.parameters.data) return 'Data cannot be empty';
   }
 
+  protected get headers(): Record<string, string> | undefined {
+    if (this.parameters.ifMatchesEtag) {
+      return { 'If-Match': this.parameters.ifMatchesEtag };
+    } else {
+      return undefined;
+    }
+  }
+
   async parse(response: TransportResponse): Promise<Response> {
     const serviceResponse = this.deserializeResponse<Response>(response);
 

diff --git a/src/core/endpoints/objects/uuid/set.ts b/src/core/endpoints/objects/uuid/set.ts
@@ -70,6 +70,14 @@ export class SetUUIDMetadataRequest<
     if (!this.parameters.data) return 'Data cannot be empty';
   }
 
+  protected get headers(): Record<string, string> | undefined {
+    if (this.parameters.ifMatchesEtag) {
+      return { 'If-Match': this.parameters.ifMatchesEtag };
+    } else {
+      return undefined;
+    }
+  }
+
   async parse(response: TransportResponse): Promise<Response> {
     const serviceResponse = this.deserializeResponse<Response>(response);
 

diff --git a/src/core/types/api/app-context.ts b/src/core/types/api/app-context.ts
@@ -689,6 +689,12 @@ export type SetUUIDMetadataParameters<Custom extends CustomData> = {
    * Fields which can be additionally included into response.
    */
   include?: Omit<IncludeOptions, 'totalCount'>;
+
+  /**
+   * Optional entity tag from a previously received `PNUUIDMetadata`. The request
+   * will fail if this parameter is specified and the ETag value on the server doesn't match.
+   */
+  ifMatchesEtag?: string;
 };
 
 /**
@@ -827,6 +833,12 @@ export type SetChannelMetadataParameters<Custom extends CustomData> = {
    * Fields which can be additionally included into response.
    */
   include?: Omit<IncludeOptions, 'totalCount'>;
+
+  /**
+   * Optional entity tag from a previously received `PNUUIDMetadata`. The request
+   * will fail if this parameter is specified and the ETag value on the server doesn't match.
+   */
+  ifMatchesEtag?: string;
 };
 
 /**