@adobe/spacecat-shared-tokowaka-client 1.5.7 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-tokowaka-client-v1.6.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.8...@adobe/spacecat-shared-tokowaka-client-v1.6.0) (2026-01-29)
+
+
+### Features
+
+* new flag opted added in edgeoptimizeconfig ([#1294](https://github.com/adobe/spacecat-shared/issues/1294)) ([8386e38](https://github.com/adobe/spacecat-shared/commit/8386e3805e9e67c18e4569428bef7ac5723eb991))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.5.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.7...@adobe/spacecat-shared-tokowaka-client-v1.5.8) (2026-01-27)
+
+
+### Bug Fixes
+
+* rename x-edge-optimize to x-edgeoptimize ([#1284](https://github.com/adobe/spacecat-shared/issues/1284)) ([63ba2ac](https://github.com/adobe/spacecat-shared/commit/63ba2ac9141612a5f581b0162cb1b30343c5980c))
+
 # [@adobe/spacecat-shared-tokowaka-client-v1.5.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.6...@adobe/spacecat-shared-tokowaka-client-v1.5.7) (2026-01-22)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tokowaka-client",
-  "version": "1.5.7",
+  "version": "1.6.0",
   "description": "Tokowaka Client for SpaceCat - Edge optimization config management",
   "type": "module",
   "engines": {

package/src/index.js

@@ -290,7 +290,7 @@ class TokowakaClient {
    * @param {boolean} options.enhancements - Whether to enable enhancements (default: true)
    * @returns {Promise<Object>} - Object with s3Path and metaconfig
    */
-  async createMetaconfig(url, siteId, options = {}) {
+  async createMetaconfig(url, siteId, options = {}, metadata = {}) {
     if (!hasText(url)) {
       throw this.#createError('URL is required', HTTP_BAD_REQUEST);
     }
@@ -316,8 +316,7 @@ class TokowakaClient {
       patches: {},
     };
 
-    const s3Path = await this.uploadMetaconfig(url, metaconfig);
-
+    const s3Path = await this.uploadMetaconfig(url, metaconfig, metadata);
     this.log.info(`Created new Tokowaka metaconfig for ${normalizedHostName} at ${s3Path}`);
 
     return metaconfig;
@@ -331,7 +330,7 @@ class TokowakaClient {
    * @param {Object} options - Optional configuration
    * @returns {Promise<Object>} - Object with s3Path and metaconfig
    */
-  async updateMetaconfig(url, siteId, options = {}) {
+  async updateMetaconfig(url, siteId, options = {}, metadata = {}) {
     if (!hasText(url)) {
       throw this.#createError('URL is required', HTTP_BAD_REQUEST);
     }
@@ -371,8 +370,7 @@ class TokowakaClient {
       ...(hasPrerender && { prerender }),
     };
 
-    const s3Path = await this.uploadMetaconfig(url, metaconfig);
-
+    const s3Path = await this.uploadMetaconfig(url, metaconfig, metadata);
     this.log.info(`Updated Tokowaka metaconfig for ${normalizedHostName} at ${s3Path}`);
 
     return metaconfig;
@@ -382,9 +380,10 @@ class TokowakaClient {
    * Uploads domain-level metaconfig to S3
    * @param {string} url - Full URL (used to extract domain)
    * @param {Object} metaconfig - Metaconfig object (siteId, apiKeys, prerender)
+   * @param {Object} metadata - Optional S3 user-defined metadata (key-value pairs)
    * @returns {Promise<string>} - S3 key of uploaded metaconfig
-   */
-  async uploadMetaconfig(url, metaconfig) {
+  */
+  async uploadMetaconfig(url, metaconfig, metadata = {}) {
     if (!hasText(url)) {
       throw this.#createError('URL is required', HTTP_BAD_REQUEST);
     }
@@ -397,12 +396,19 @@ class TokowakaClient {
     const bucketName = this.deployBucketName;
 
     try {
-      const command = new PutObjectCommand({
+      const putObjectParams = {
         Bucket: bucketName,
         Key: s3Path,
         Body: JSON.stringify(metaconfig, null, 2),
         ContentType: 'application/json',
-      });
+      };
+
+      // Add user-defined metadata if provided
+      if (isNonEmptyObject(metadata)) {
+        putObjectParams.Metadata = metadata;
+      }
+
+      const command = new PutObjectCommand(putObjectParams);
 
       await this.s3Client.send(command);
       this.log.info(`Successfully uploaded metaconfig to s3://${bucketName}/${s3Path}`);

package/src/utils/custom-html-utils.js

@@ -52,14 +52,14 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
       }
 
       // Check for edge optimize headers
-      const cacheHeader = response.headers.get('x-edge-optimize-cache');
-      const proxyHeader = response.headers.get('x-edge-optimize-proxy');
+      const cacheHeader = response.headers.get('x-edgeoptimize-cache');
+      const proxyHeader = response.headers.get('x-edgeoptimize-proxy');
 
       log.debug(`Headers - cache: ${cacheHeader || 'none'}, proxy: ${proxyHeader || 'none'}`);
 
       // Case 1: Cache header present (regardless of proxy) -> Success
       if (cacheHeader) {
-        log.debug(`Cache header found (x-edge-optimize-cache: ${cacheHeader}), stopping retry logic`);
+        log.debug(`Cache header found (x-edgeoptimize-cache: ${cacheHeader}), stopping retry logic`);
         return response;
       }
 
@@ -80,7 +80,7 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
       } else {
         // Last attempt - throw error
         log.error(`Max retries (${maxRetries}) exhausted. Proxy header present but cache header not found`);
-        throw new Error(`Cache header (x-edge-optimize-cache) not found after ${maxRetries} retries`);
+        throw new Error(`Cache header (x-edgeoptimize-cache) not found after ${maxRetries} retries`);
       }
     } catch (error) {
       log.warn(`Attempt ${attempt} failed for ${fetchType} HTML, error: ${error.message}`);
@@ -158,15 +158,15 @@ export async function fetchHtmlWithWarmup(
 
   const headers = {
     'x-forwarded-host': forwardedHost,
-    'x-edge-optimize-api-key': apiKey,
-    'x-edge-optimize-url': urlPath,
+    'x-edgeoptimize-api-key': apiKey,
+    'x-edgeoptimize-url': urlPath,
     'Accept-Encoding': 'identity', // Disable compression to avoid content-length: 0 issue
   };
 
   if (isOptimized) {
     // Add tokowakaPreview param for optimized HTML
     fullUrl = `${fullUrl}?tokowakaPreview=true`;
-    headers['x-edge-optimize-url'] = `${urlPath}?tokowakaPreview=true`;
+    headers['x-edgeoptimize-url'] = `${urlPath}?tokowakaPreview=true`;
   }
 
   const fetchOptions = {

package/test/index.test.js

@@ -454,6 +454,43 @@ describe('TokowakaClient', () => {
         expect(error.status).to.equal(500);
       }
     });
+
+    it('should upload metaconfig with user-defined metadata when provided', async () => {
+      const metaconfig = {
+        siteId: 'site-123',
+        prerender: true,
+      };
+      const metadata = {
+        'last-modified-by': 'john@example.com',
+        'created-by': 'admin',
+      };
+
+      const s3Path = await client.uploadMetaconfig('https://example.com/page1', metaconfig, metadata);
+
+      expect(s3Path).to.equal('opportunities/example.com/config');
+
+      const command = s3Client.send.firstCall.args[0];
+      expect(command.input.Bucket).to.equal('test-bucket');
+      expect(command.input.Key).to.equal('opportunities/example.com/config');
+      expect(command.input.ContentType).to.equal('application/json');
+      expect(JSON.parse(command.input.Body)).to.deep.equal(metaconfig);
+      expect(command.input.Metadata).to.deep.equal(metadata);
+    });
+
+    it('should upload metaconfig without Metadata field when metadata is empty object', async () => {
+      const metaconfig = {
+        siteId: 'site-123',
+        prerender: true,
+      };
+
+      const s3Path = await client.uploadMetaconfig('https://example.com/page1', metaconfig, {});
+
+      expect(s3Path).to.equal('opportunities/example.com/config');
+
+      const command = s3Client.send.firstCall.args[0];
+      expect(command.input.Bucket).to.equal('test-bucket');
+      expect(command.input.Metadata).to.be.undefined;
+    });
   });
 
   describe('createMetaconfig', () => {
@@ -567,6 +604,50 @@ describe('TokowakaClient', () => {
       const command = s3Client.send.firstCall.args[0];
       expect(command.input.Key).to.equal('opportunities/example.com/config');
     });
+
+    it('should include user-defined metadata when metadata is provided', async () => {
+      const siteId = 'site-123';
+      const url = 'https://www.example.com/page1';
+      const noSuchKeyError = new Error('NoSuchKey');
+      noSuchKeyError.name = 'NoSuchKey';
+      s3Client.send.onFirstCall().rejects(noSuchKeyError);
+
+      await client.createMetaconfig(url, siteId, {}, { 'last-modified-by': 'john@example.com' });
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.deep.equal({
+        'last-modified-by': 'john@example.com',
+      });
+    });
+
+    it('should not include metadata when metadata is empty object', async () => {
+      const siteId = 'site-123';
+      const url = 'https://www.example.com/page1';
+      const noSuchKeyError = new Error('NoSuchKey');
+      noSuchKeyError.name = 'NoSuchKey';
+      s3Client.send.onFirstCall().rejects(noSuchKeyError);
+
+      await client.createMetaconfig(url, siteId, {}, {});
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.be.undefined;
+    });
+
+    it('should not include metadata when metadata is not provided', async () => {
+      const siteId = 'site-123';
+      const url = 'https://www.example.com/page1';
+      const noSuchKeyError = new Error('NoSuchKey');
+      noSuchKeyError.name = 'NoSuchKey';
+      s3Client.send.onFirstCall().rejects(noSuchKeyError);
+
+      await client.createMetaconfig(url, siteId);
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.be.undefined;
+    });
   });
 
   describe('updateMetaconfig', () => {
@@ -1308,6 +1389,47 @@ describe('TokowakaClient', () => {
       expect(result).to.have.property('prerender');
       expect(result.prerender).to.deep.equal(prerenderConfig);
     });
+
+    it('should include user-defined metadata when metadata is provided', async () => {
+      const siteId = 'site-456';
+      const url = 'https://www.example.com';
+
+      await client.updateMetaconfig(url, siteId, {
+        tokowakaEnabled: true,
+      }, { 'last-modified-by': 'jane@example.com' });
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.deep.equal({
+        'last-modified-by': 'jane@example.com',
+      });
+    });
+
+    it('should not include metadata when metadata is empty object', async () => {
+      const siteId = 'site-456';
+      const url = 'https://www.example.com';
+
+      await client.updateMetaconfig(url, siteId, {
+        tokowakaEnabled: true,
+      }, {});
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.be.undefined;
+    });
+
+    it('should not include metadata when metadata is not provided', async () => {
+      const siteId = 'site-456';
+      const url = 'https://www.example.com';
+
+      await client.updateMetaconfig(url, siteId, {
+        tokowakaEnabled: true,
+      });
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.be.undefined;
+    });
   });
 
   describe('uploadConfig', () => {
@@ -2692,7 +2814,7 @@ describe('TokowakaClient', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html><body>Test HTML</body></html>',
       });

package/test/utils/html-utils.test.js

@@ -104,7 +104,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Test HTML</html>',
       });
@@ -129,7 +129,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Optimized HTML</html>',
       });
@@ -208,7 +208,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 1</html>',
       });
@@ -217,7 +217,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 2</html>',
       });
@@ -226,7 +226,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 3</html>',
       });
@@ -244,7 +244,7 @@ describe('HTML Utils', () => {
         expect.fail('Should have thrown error');
       } catch (error) {
         expect(error.message).to.include('Failed to fetch optimized HTML');
-        expect(error.message).to.include('Cache header (x-edge-optimize-cache) not found after 2 retries');
+        expect(error.message).to.include('Cache header (x-edgeoptimize-cache) not found after 2 retries');
       }
 
       // Should have tried 3 times (initial + 2 retries) plus warmup
@@ -268,7 +268,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only</html>',
       });
@@ -278,7 +278,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Cached HTML</html>',
       });
@@ -483,7 +483,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only</html>',
       });
@@ -494,8 +494,8 @@ describe('HTML Utils', () => {
         statusText: 'OK',
         headers: {
           get: (name) => {
-            if (name === 'x-edge-optimize-cache') return 'HIT';
-            if (name === 'x-edge-optimize-proxy') return 'true';
+            if (name === 'x-edgeoptimize-cache') return 'HIT';
+            if (name === 'x-edgeoptimize-proxy') return 'true';
             return null;
           },
         },
@@ -534,7 +534,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 1</html>',
       });
@@ -543,7 +543,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 2</html>',
       });
@@ -552,7 +552,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 3</html>',
       });
@@ -570,7 +570,7 @@ describe('HTML Utils', () => {
         expect.fail('Should have thrown error');
       } catch (error) {
         expect(error.message).to.include('Failed to fetch original HTML');
-        expect(error.message).to.include('Cache header (x-edge-optimize-cache) not found after 2 retries');
+        expect(error.message).to.include('Cache header (x-edgeoptimize-cache) not found after 2 retries');
       }
 
       // Should have tried 3 times (initial + 2 retries) plus warmup
@@ -594,7 +594,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Cached HTML</html>',
       });
@@ -632,8 +632,8 @@ describe('HTML Utils', () => {
         statusText: 'OK',
         headers: {
           get: (name) => {
-            if (name === 'x-edge-optimize-cache') return 'HIT';
-            if (name === 'x-edge-optimize-proxy') return 'true';
+            if (name === 'x-edgeoptimize-cache') return 'HIT';
+            if (name === 'x-edgeoptimize-proxy') return 'true';
             return null;
           },
         },
@@ -672,7 +672,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Cache only HTML</html>',
       });