@adobe/spacecat-shared-tokowaka-client 1.1.1 → 1.2.0

package/test/utils/patch-utils.test.js

@@ -0,0 +1,409 @@
+/*
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/* eslint-env mocha */
+
+import { expect } from 'chai';
+import { mergePatches, removePatchesBySuggestionIds } from '../../src/utils/patch-utils.js';
+
+describe('Patch Utils', () => {
+  describe('mergePatches', () => {
+    it('should merge individual patches with same key', () => {
+      const existingPatches = [
+        {
+          opportunityId: 'opp-1',
+          suggestionId: 'sugg-1',
+          op: 'replace',
+          value: 'old-value',
+        },
+      ];
+
+      const newPatches = [
+        {
+          opportunityId: 'opp-1',
+          suggestionId: 'sugg-1',
+          op: 'replace',
+          value: 'new-value',
+        },
+      ];
+
+      const result = mergePatches(existingPatches, newPatches);
+
+      expect(result.patches).to.have.lengthOf(1);
+      expect(result.patches[0].value).to.equal('new-value');
+      expect(result.updateCount).to.equal(1);
+      expect(result.addCount).to.equal(0);
+    });
+
+    it('should keep individual patches with different keys', () => {
+      const existingPatches = [
+        {
+          opportunityId: 'opp-1',
+          suggestionId: 'sugg-1',
+          op: 'replace',
+          value: 'value-1',
+        },
+      ];
+
+      const newPatches = [
+        {
+          opportunityId: 'opp-1',
+          suggestionId: 'sugg-2',
+          op: 'replace',
+          value: 'value-2',
+        },
+      ];
+
+      const result = mergePatches(existingPatches, newPatches);
+
+      expect(result.patches).to.have.lengthOf(2);
+      expect(result.updateCount).to.equal(0);
+      expect(result.addCount).to.equal(1);
+    });
+
+    it('should handle empty existing patches', () => {
+      const existingPatches = [];
+      const newPatches = [
+        {
+          opportunityId: 'opp-1',
+          suggestionId: 'sugg-1',
+          op: 'replace',
+          value: 'value-1',
+        },
+      ];
+
+      const result = mergePatches(existingPatches, newPatches);
+
+      expect(result.patches).to.have.lengthOf(1);
+      expect(result.updateCount).to.equal(0);
+      expect(result.addCount).to.equal(1);
+    });
+
+    it('should handle empty new patches', () => {
+      const existingPatches = [
+        {
+          opportunityId: 'opp-1',
+          suggestionId: 'sugg-1',
+          op: 'replace',
+          value: 'value-1',
+        },
+      ];
+      const newPatches = [];
+
+      const result = mergePatches(existingPatches, newPatches);
+
+      expect(result.patches).to.have.lengthOf(1);
+      expect(result.updateCount).to.equal(0);
+      expect(result.addCount).to.equal(0);
+    });
+
+    it('should handle patch without suggestionId (heading patch)', () => {
+      const existingPatches = [
+        {
+          opportunityId: 'opp-faq',
+          op: 'appendChild',
+          value: 'Old Heading',
+        },
+      ];
+
+      const newPatches = [
+        {
+          opportunityId: 'opp-faq',
+          op: 'appendChild',
+          value: 'New Heading',
+        },
+      ];
+
+      const result = mergePatches(existingPatches, newPatches);
+
+      expect(result.patches).to.have.lengthOf(1);
+      expect(result.patches[0].value).to.equal('New Heading');
+      expect(result.updateCount).to.equal(1);
+      expect(result.addCount).to.equal(0);
+    });
+
+    it('should merge heading patches with same opportunityId', () => {
+      const existingPatches = [
+        {
+          opportunityId: 'opp-faq',
+          op: 'appendChild',
+          value: 'Heading',
+        },
+        {
+          opportunityId: 'opp-faq',
+          suggestionId: 'sugg-1',
+          op: 'appendChild',
+          value: 'FAQ 1',
+        },
+      ];
+
+      const newPatches = [
+        {
+          opportunityId: 'opp-faq',
+          op: 'appendChild',
+          value: 'Updated Heading',
+        },
+        {
+          opportunityId: 'opp-faq',
+          suggestionId: 'sugg-2',
+          op: 'appendChild',
+          value: 'FAQ 2',
+        },
+      ];
+
+      const result = mergePatches(existingPatches, newPatches);
+
+      expect(result.patches).to.have.lengthOf(3);
+      expect(result.patches[0].value).to.equal('Updated Heading');
+      expect(result.updateCount).to.equal(1);
+      expect(result.addCount).to.equal(1);
+    });
+  });
+
+  describe('removePatchesBySuggestionIds', () => {
+    it('should remove patches with matching suggestion IDs', () => {
+      const config = {
+        url: 'https://example.com/page1',
+        version: '1.0',
+        forceFail: false,
+        prerender: true,
+        patches: [
+          {
+            opportunityId: 'opp-1',
+            suggestionId: 'sugg-1',
+            op: 'replace',
+            value: 'value-1',
+          },
+          {
+            opportunityId: 'opp-1',
+            suggestionId: 'sugg-2',
+            op: 'replace',
+            value: 'value-2',
+          },
+        ],
+      };
+
+      const result = removePatchesBySuggestionIds(config, ['sugg-1']);
+
+      expect(result.patches).to.have.lengthOf(1);
+      expect(result.patches[0].suggestionId).to.equal('sugg-2');
+      expect(result.removedCount).to.equal(1);
+    });
+
+    it('should remove URL paths with no remaining patches', () => {
+      const config = {
+        url: 'https://example.com/page1',
+        version: '1.0',
+        forceFail: false,
+        prerender: true,
+        patches: [
+          {
+            opportunityId: 'opp-1',
+            suggestionId: 'sugg-1',
+            op: 'replace',
+            value: 'value-1',
+          },
+        ],
+      };
+
+      const result = removePatchesBySuggestionIds(config, ['sugg-1']);
+
+      expect(result.patches).to.have.lengthOf(0);
+      expect(result.removedCount).to.equal(1);
+    });
+
+    it('should handle empty suggestion IDs array', () => {
+      const config = {
+        url: 'https://example.com/page1',
+        version: '1.0',
+        forceFail: false,
+        prerender: true,
+        patches: [
+          {
+            opportunityId: 'opp-1',
+            suggestionId: 'sugg-1',
+            op: 'replace',
+            value: 'value-1',
+          },
+        ],
+      };
+
+      const result = removePatchesBySuggestionIds(config, []);
+
+      expect(result.patches).to.have.lengthOf(1);
+      expect(result.removedCount).to.equal(0);
+    });
+
+    it('should handle non-matching suggestion IDs', () => {
+      const config = {
+        url: 'https://example.com/page1',
+        version: '1.0',
+        forceFail: false,
+        prerender: true,
+        patches: [
+          {
+            opportunityId: 'opp-1',
+            suggestionId: 'sugg-1',
+            op: 'replace',
+            value: 'value-1',
+          },
+        ],
+      };
+
+      const result = removePatchesBySuggestionIds(config, ['sugg-999']);
+
+      expect(result.patches).to.have.lengthOf(1);
+      expect(result.removedCount).to.equal(0);
+    });
+
+    it('should handle null/undefined config gracefully', () => {
+      const result1 = removePatchesBySuggestionIds(null, ['sugg-1']);
+      const result2 = removePatchesBySuggestionIds(undefined, ['sugg-1']);
+
+      expect(result1).to.be.null;
+      expect(result2).to.be.undefined;
+    });
+
+    it('should preserve patches without suggestionId (heading patches)', () => {
+      const config = {
+        url: 'https://example.com/page1',
+        version: '1.0',
+        forceFail: false,
+        prerender: true,
+        patches: [
+          {
+            opportunityId: 'opp-faq',
+            op: 'appendChild',
+            value: 'FAQs',
+          },
+          {
+            opportunityId: 'opp-faq',
+            suggestionId: 'sugg-1',
+            op: 'appendChild',
+            value: 'FAQ item 1',
+          },
+        ],
+      };
+
+      const result = removePatchesBySuggestionIds(config, ['sugg-1']);
+
+      expect(result.patches).to.have.lengthOf(1);
+      expect(result.patches[0].value).to.equal('FAQs');
+      expect(result.removedCount).to.equal(1);
+    });
+
+    it('should remove patches by additional patch keys', () => {
+      const config = {
+        url: 'https://example.com/page1',
+        version: '1.0',
+        forceFail: false,
+        prerender: true,
+        patches: [
+          {
+            opportunityId: 'opp-faq',
+            op: 'appendChild',
+            value: 'FAQs',
+          },
+          {
+            opportunityId: 'opp-faq',
+            suggestionId: 'sugg-1',
+            op: 'appendChild',
+            value: 'FAQ item 1',
+          },
+          {
+            opportunityId: 'opp-faq',
+            suggestionId: 'sugg-2',
+            op: 'appendChild',
+            value: 'FAQ item 2',
+          },
+        ],
+      };
+
+      // Remove all FAQs by passing heading patch key and suggestion IDs
+      const result = removePatchesBySuggestionIds(config, ['sugg-1', 'sugg-2'], ['opp-faq']);
+
+      expect(result.patches).to.have.lengthOf(0);
+      expect(result.removedCount).to.equal(3);
+    });
+
+    it('should remove patches by additional patch keys while keeping other suggestions', () => {
+      const config = {
+        url: 'https://example.com/page1',
+        version: '1.0',
+        forceFail: false,
+        prerender: true,
+        patches: [
+          {
+            opportunityId: 'opp-faq',
+            op: 'appendChild',
+            value: 'FAQs',
+          },
+          {
+            opportunityId: 'opp-faq',
+            suggestionId: 'sugg-1',
+            op: 'appendChild',
+            value: 'FAQ item 1',
+          },
+          {
+            opportunityId: 'opp-faq',
+            suggestionId: 'sugg-2',
+            op: 'appendChild',
+            value: 'FAQ item 2',
+          },
+        ],
+      };
+
+      // Remove only sugg-1, heading patch should remain
+      const result = removePatchesBySuggestionIds(config, ['sugg-1']);
+
+      expect(result.patches).to.have.lengthOf(2);
+      expect(result.patches[0].value).to.equal('FAQs');
+      expect(result.patches[1].suggestionId).to.equal('sugg-2');
+      expect(result.removedCount).to.equal(1);
+    });
+
+    it('should handle both suggestionIds and additional patch keys together', () => {
+      const config = {
+        url: 'https://example.com/page1',
+        version: '1.0',
+        forceFail: false,
+        prerender: true,
+        patches: [
+          {
+            opportunityId: 'opp-faq',
+            op: 'appendChild',
+            value: 'FAQs',
+          },
+          {
+            opportunityId: 'opp-faq',
+            suggestionId: 'sugg-1',
+            op: 'appendChild',
+            value: 'FAQ item 1',
+          },
+          {
+            opportunityId: 'opp-other',
+            suggestionId: 'sugg-2',
+            op: 'replace',
+            value: 'Other suggestion',
+          },
+        ],
+      };
+
+      // Remove sugg-1 and the heading patch
+      const result = removePatchesBySuggestionIds(config, ['sugg-1'], ['opp-faq']);
+
+      expect(result.patches).to.have.lengthOf(1);
+      expect(result.patches[0].suggestionId).to.equal('sugg-2');
+      expect(result.removedCount).to.equal(2);
+    });
+  });
+});

package/test/utils/s3-utils.test.js

@@ -0,0 +1,140 @@
+/*
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/* eslint-env mocha */
+
+import { expect } from 'chai';
+import {
+  normalizePath,
+  getHostName,
+  base64UrlEncode,
+  getTokowakaConfigS3Path,
+  getTokowakaMetaconfigS3Path,
+} from '../../src/utils/s3-utils.js';
+
+describe('S3 Utils', () => {
+  describe('normalizePath', () => {
+    it('should add leading slash if missing', () => {
+      const result = normalizePath('page1');
+      expect(result).to.equal('/page1');
+    });
+
+    it('should keep single slash', () => {
+      const result = normalizePath('/');
+      expect(result).to.equal('/');
+    });
+
+    it('should remove trailing slash except for root', () => {
+      const result = normalizePath('/page1/');
+      expect(result).to.equal('/page1');
+    });
+
+    it('should handle path with leading slash', () => {
+      const result = normalizePath('/page1');
+      expect(result).to.equal('/page1');
+    });
+  });
+
+  describe('getHostName', () => {
+    it('should extract hostname and remove www', () => {
+      const url = new URL('https://www.example.com/page');
+      const logger = { error: () => {} };
+      const result = getHostName(url, logger);
+      expect(result).to.equal('example.com');
+    });
+
+    it('should handle hostname without www', () => {
+      const url = new URL('https://example.com/page');
+      const logger = { error: () => {} };
+      const result = getHostName(url, logger);
+      expect(result).to.equal('example.com');
+    });
+
+    it('should throw error on invalid URL', () => {
+      const logger = { error: () => {} };
+      const invalidUrl = { hostname: null };
+
+      try {
+        getHostName(invalidUrl, logger);
+        expect.fail('Should have thrown error');
+      } catch (error) {
+        expect(error.message).to.include('Error extracting host name');
+      }
+    });
+  });
+
+  describe('getTokowakaConfigS3Path', () => {
+    const logger = { error: () => {} };
+
+    it('should generate correct S3 path for deploy', () => {
+      const url = 'https://example.com/page1';
+      const result = getTokowakaConfigS3Path(url, logger, false);
+      expect(result).to.equal('opportunities/example.com/L3BhZ2Ux');
+    });
+
+    it('should generate correct S3 path for preview', () => {
+      const url = 'https://example.com/page1';
+      const result = getTokowakaConfigS3Path(url, logger, true);
+      expect(result).to.equal('preview/opportunities/example.com/L3BhZ2Ux');
+    });
+
+    it('should throw error on invalid URL', () => {
+      try {
+        getTokowakaConfigS3Path('not-a-valid-url', logger, false);
+        expect.fail('Should have thrown error');
+      } catch (error) {
+        expect(error.message).to.include('Failed to generate S3 path');
+      }
+    });
+  });
+
+  describe('getTokowakaMetaconfigS3Path', () => {
+    it('should generate correct metaconfig S3 path for deploy', () => {
+      const url = 'https://example.com/page1';
+      const logger = { error: () => {} };
+      const result = getTokowakaMetaconfigS3Path(url, logger, false);
+      expect(result).to.equal('opportunities/example.com/config');
+    });
+
+    it('should generate correct metaconfig S3 path for preview', () => {
+      const url = 'https://example.com/page1';
+      const logger = { error: () => {} };
+      const result = getTokowakaMetaconfigS3Path(url, logger, true);
+      expect(result).to.equal('preview/opportunities/example.com/config');
+    });
+
+    it('should throw error on invalid URL', () => {
+      const logger = { error: () => {} };
+
+      try {
+        getTokowakaMetaconfigS3Path('not-a-valid-url', logger, false);
+        expect.fail('Should have thrown error');
+      } catch (error) {
+        expect(error.message).to.include('Failed to generate metaconfig S3 path');
+      }
+    });
+  });
+
+  describe('base64UrlEncode', () => {
+    it('should encode string to base64url', () => {
+      const result = base64UrlEncode('/page1');
+      expect(result).to.equal('L3BhZ2Ux');
+    });
+
+    it('should handle special characters', () => {
+      const result = base64UrlEncode('/page?query=1');
+      // Should replace + with - and / with _
+      expect(result).to.not.include('+');
+      expect(result).to.not.include('=');
+    });
+  });
+});

package/test/utils/site-utils.test.js

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/* eslint-env mocha */
+
+import { expect } from 'chai';
+import { getEffectiveBaseURL } from '../../src/utils/site-utils.js';
+
+describe('Site Utils', () => {
+  describe('getEffectiveBaseURL', () => {
+    it('should return site baseURL when no override', () => {
+      const site = {
+        getBaseURL: () => 'https://example.com',
+        getConfig: () => ({
+          getFetchConfig: () => ({}),
+        }),
+      };
+
+      const result = getEffectiveBaseURL(site);
+      expect(result).to.equal('https://example.com');
+    });
+
+    it('should return override baseURL when valid', () => {
+      const site = {
+        getBaseURL: () => 'https://example.com',
+        getConfig: () => ({
+          getFetchConfig: () => ({
+            overrideBaseURL: 'https://override.com',
+          }),
+        }),
+      };
+
+      const result = getEffectiveBaseURL(site);
+      expect(result).to.equal('https://override.com');
+    });
+
+    it('should return site baseURL when override is invalid', () => {
+      const site = {
+        getBaseURL: () => 'https://example.com',
+        getConfig: () => ({
+          getFetchConfig: () => ({
+            overrideBaseURL: 'not-a-valid-url',
+          }),
+        }),
+      };
+
+      const result = getEffectiveBaseURL(site);
+      expect(result).to.equal('https://example.com');
+    });
+
+    it('should handle missing getFetchConfig', () => {
+      const site = {
+        getBaseURL: () => 'https://example.com',
+        getConfig: () => ({}),
+      };
+
+      const result = getEffectiveBaseURL(site);
+      expect(result).to.equal('https://example.com');
+    });
+
+    it('should handle missing config', () => {
+      const site = {
+        getBaseURL: () => 'https://example.com',
+        getConfig: () => null,
+      };
+
+      const result = getEffectiveBaseURL(site);
+      expect(result).to.equal('https://example.com');
+    });
+  });
+});