@adobe/spacecat-shared-tokowaka-client 1.5.2 → 1.5.3

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-tokowaka-client-v1.5.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.2...@adobe/spacecat-shared-tokowaka-client-v1.5.3) (2026-01-21)
+
+
+### Bug Fixes
+
+* update tokowaka config ([#1275](https://github.com/adobe/spacecat-shared/issues/1275)) ([06cedcd](https://github.com/adobe/spacecat-shared/commit/06cedcd3d6f5956d895f7dedb7579d2eefffe58e))
+
 # [@adobe/spacecat-shared-tokowaka-client-v1.5.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.1...@adobe/spacecat-shared-tokowaka-client-v1.5.2) (2026-01-21)
 
 

package/package.json

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

package/src/index.js

@@ -349,15 +349,21 @@ class TokowakaClient {
 
     // dont override api keys
     // if patches exist, they cannot reset to empty object
+    const hasForceFail = options.forceFail !== undefined
+      || existingMetaconfig.forceFail !== undefined;
+    const forceFail = options.forceFail
+      ?? existingMetaconfig.forceFail
+      ?? false;
+
     const metaconfig = {
       siteId,
       apiKeys: existingMetaconfig.apiKeys,
-      tokowakaEnabled: options.tokowakaEnabled ?? true,
-      enhancements: options.enhancements ?? true,
+      tokowakaEnabled: options.tokowakaEnabled ?? existingMetaconfig.tokowakaEnabled ?? true,
+      enhancements: options.enhancements ?? existingMetaconfig.enhancements ?? true,
       patches: isNonEmptyObject(options.patches)
         ? options.patches
         : (existingMetaconfig.patches ?? {}),
-      ...(options.forceFail && { forceFail: true }),
+      ...(hasForceFail && { forceFail }),
     };
 
     const s3Path = await this.uploadMetaconfig(url, metaconfig);

package/test/index.test.js

@@ -598,8 +598,9 @@ describe('TokowakaClient', () => {
       expect(result).to.have.property('siteId', siteId);
       expect(result).to.have.property('apiKeys');
       expect(result.apiKeys).to.deep.equal(['existing-api-key-123']);
-      expect(result).to.have.property('tokowakaEnabled', true);
-      expect(result).to.have.property('enhancements', true);
+      // Should preserve existing metaconfig values when options not provided
+      expect(result).to.have.property('tokowakaEnabled', false);
+      expect(result).to.have.property('enhancements', false);
       expect(result.patches).to.deep.equal({ 'existing-patch': 'value' });
       expect(result).to.not.have.property('forceFail');
     });
@@ -611,7 +612,7 @@ describe('TokowakaClient', () => {
       const result = await client.updateMetaconfig(url, siteId, { tokowakaEnabled: false });
 
       expect(result).to.have.property('tokowakaEnabled', false);
-      expect(result).to.have.property('enhancements', true);
+      expect(result).to.have.property('enhancements', false);
       expect(result.patches).to.deep.equal({ 'existing-patch': 'value' });
       expect(result).to.not.have.property('forceFail');
     });
@@ -623,8 +624,9 @@ describe('TokowakaClient', () => {
       const result = await client.updateMetaconfig(url, siteId, { tokowakaEnabled: true });
 
       expect(result).to.have.property('tokowakaEnabled', true);
-      expect(result).to.have.property('enhancements', true);
+      expect(result).to.have.property('enhancements', false);
       expect(result.patches).to.deep.equal({ 'existing-patch': 'value' });
+      expect(result).to.not.have.property('forceFail');
     });
 
     it('should update metaconfig with enhancements set to false', async () => {
@@ -633,9 +635,10 @@ describe('TokowakaClient', () => {
 
       const result = await client.updateMetaconfig(url, siteId, { enhancements: false });
 
-      expect(result).to.have.property('tokowakaEnabled', true);
+      expect(result).to.have.property('tokowakaEnabled', false);
       expect(result).to.have.property('enhancements', false);
       expect(result.patches).to.deep.equal({ 'existing-patch': 'value' });
+      expect(result).to.not.have.property('forceFail');
     });
 
     it('should update metaconfig with enhancements set to true explicitly', async () => {
@@ -644,9 +647,10 @@ describe('TokowakaClient', () => {
 
       const result = await client.updateMetaconfig(url, siteId, { enhancements: true });
 
-      expect(result).to.have.property('tokowakaEnabled', true);
+      expect(result).to.have.property('tokowakaEnabled', false);
       expect(result).to.have.property('enhancements', true);
       expect(result.patches).to.deep.equal({ 'existing-patch': 'value' });
+      expect(result).to.not.have.property('forceFail');
     });
 
     it('should override patches when non-empty patches object is provided', async () => {
@@ -708,13 +712,13 @@ describe('TokowakaClient', () => {
       expect(result).to.have.property('forceFail', true);
     });
 
-    it('should not include forceFail when set to false', async () => {
+    it('should include forceFail when set to false', async () => {
       const siteId = 'site-789';
       const url = 'https://example.com';
 
       const result = await client.updateMetaconfig(url, siteId, { forceFail: false });
 
-      expect(result).to.not.have.property('forceFail');
+      expect(result).to.have.property('forceFail', false);
     });
 
     it('should not include forceFail when undefined', async () => {
@@ -726,6 +730,38 @@ describe('TokowakaClient', () => {
       expect(result).to.not.have.property('forceFail');
     });
 
+    it('should use forceFail as false when options.forceFail is null and existingMetaconfig has no forceFail', async () => {
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId, { forceFail: null });
+
+      expect(result).to.have.property('forceFail', false);
+    });
+
+    it('should preserve existingMetaconfig forceFail when options.forceFail is null', async () => {
+      const configWithForceFail = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: true,
+        enhancements: true,
+        patches: {},
+        forceFail: true,
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithForceFail)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId, { forceFail: null });
+
+      expect(result).to.have.property('forceFail', true);
+    });
+
     it('should update metaconfig with multiple options', async () => {
       const siteId = 'site-789';
       const url = 'https://example.com';
@@ -855,6 +891,259 @@ describe('TokowakaClient', () => {
 
       expect(result.patches).to.deep.equal(singlePatch);
     });
+
+    it('should preserve existing patches when options.patches is null', async () => {
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId, { patches: null });
+
+      expect(result.patches).to.deep.equal({ 'existing-patch': 'value' });
+    });
+
+    it('should preserve tokowakaEnabled=true from existingMetaconfig when options not provided', async () => {
+      const configWithTokowakaEnabled = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: true,
+        enhancements: false,
+        patches: {},
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithTokowakaEnabled)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId);
+
+      expect(result).to.have.property('tokowakaEnabled', true);
+    });
+
+    it('should preserve enhancements=true from existingMetaconfig when options not provided', async () => {
+      const configWithEnhancements = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: false,
+        enhancements: true,
+        patches: {},
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithEnhancements)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId);
+
+      expect(result).to.have.property('enhancements', true);
+    });
+
+    it('should default tokowakaEnabled to true when not in existingMetaconfig or options', async () => {
+      const configWithoutTokowakaEnabled = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        enhancements: false,
+        patches: {},
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithoutTokowakaEnabled)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId);
+
+      expect(result).to.have.property('tokowakaEnabled', true);
+    });
+
+    it('should default enhancements to true when not in existingMetaconfig or options', async () => {
+      const configWithoutEnhancements = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: false,
+        patches: {},
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithoutEnhancements)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId);
+
+      expect(result).to.have.property('enhancements', true);
+    });
+
+    it('should preserve forceFail=true from existingMetaconfig when options not provided', async () => {
+      const configWithForceFail = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: true,
+        enhancements: true,
+        patches: {},
+        forceFail: true,
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithForceFail)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId);
+
+      expect(result).to.have.property('forceFail', true);
+    });
+
+    it('should override existingMetaconfig forceFail when explicitly set to false in options', async () => {
+      const configWithForceFail = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: true,
+        enhancements: true,
+        patches: {},
+        forceFail: true,
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithForceFail)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId, { forceFail: false });
+
+      expect(result).to.have.property('forceFail', false);
+    });
+
+    it('should override existingMetaconfig forceFail when explicitly set to true in options', async () => {
+      const configWithoutForceFail = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: true,
+        enhancements: true,
+        patches: {},
+        forceFail: false,
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithoutForceFail)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId, { forceFail: true });
+
+      expect(result).to.have.property('forceFail', true);
+    });
+
+    it('should preserve forceFail=false from existingMetaconfig when options not provided', async () => {
+      const configWithForceFail = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: true,
+        enhancements: true,
+        patches: {},
+        forceFail: false,
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithForceFail)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId);
+
+      expect(result).to.have.property('forceFail', false);
+    });
+
+    it('should override existingMetaconfig tokowakaEnabled=false when explicitly set to true', async () => {
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+      // existingMetaconfig has tokowakaEnabled: false
+
+      const result = await client.updateMetaconfig(url, siteId, { tokowakaEnabled: true });
+
+      expect(result).to.have.property('tokowakaEnabled', true);
+    });
+
+    it('should override existingMetaconfig enhancements=false when explicitly set to true', async () => {
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+      // existingMetaconfig has enhancements: false
+
+      const result = await client.updateMetaconfig(url, siteId, { enhancements: true });
+
+      expect(result).to.have.property('enhancements', true);
+    });
+
+    it('should handle case where options.forceFail and existingMetaconfig.forceFail are both true', async () => {
+      const configWithForceFail = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: true,
+        enhancements: true,
+        patches: {},
+        forceFail: true,
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithForceFail)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId, { forceFail: true });
+
+      expect(result).to.have.property('forceFail', true);
+    });
+
+    it('should handle case where options.forceFail and existingMetaconfig.forceFail are both false', async () => {
+      const configWithForceFail = {
+        siteId: 'site-456',
+        apiKeys: ['existing-api-key-123'],
+        tokowakaEnabled: true,
+        enhancements: true,
+        patches: {},
+        forceFail: false,
+      };
+      s3Client.send.onFirstCall().resolves({
+        Body: {
+          transformToString: sinon.stub().resolves(JSON.stringify(configWithForceFail)),
+        },
+      });
+
+      const siteId = 'site-789';
+      const url = 'https://example.com';
+
+      const result = await client.updateMetaconfig(url, siteId);
+
+      expect(result).to.have.property('forceFail', false);
+    });
   });
 
   describe('uploadConfig', () => {