@adobe/helix-config 4.5.2 → 4.5.3

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [4.5.3](https://github.com/adobe/helix-config/compare/v4.5.2...v4.5.3) (2024-09-19)
+
+
+### Bug Fixes
+
+* dedupe sidekick plugins when merging site with profile ([#189](https://github.com/adobe/helix-config/issues/189)) ([69d32da](https://github.com/adobe/helix-config/commit/69d32da8c771f37b77cbc9047b45160d547e3b6d)), closes [#188](https://github.com/adobe/helix-config/issues/188)
+
 ## [4.5.2](https://github.com/adobe/helix-config/compare/v4.5.1...v4.5.2) (2024-09-13)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "4.5.2",
+  "version": "4.5.3",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -41,14 +41,14 @@
     "@semantic-release/npm": "12.0.1",
     "c8": "10.1.2",
     "eslint": "8.57.0",
-    "husky": "9.1.5",
+    "husky": "9.1.6",
     "junit-report-builder": "5.0.0",
     "lint-staged": "15.2.10",
     "mocha": "10.7.3",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",
     "nock": "13.5.5",
-    "semantic-release": "24.1.0"
+    "semantic-release": "24.1.1"
   },
   "lint-staged": {
     "*.js": "eslint",

package/src/config-merge.js

@@ -38,6 +38,9 @@ const ROOT_PROPERTIES = {
 
 const FORCED_TYPES = {
   '.cdn.prod.route': 'array',
+  '.sidekick.plugins': 'id-array',
+  '.headers': 'modifier',
+  '.metadata': 'modifier',
 };
 
 /**
@@ -48,10 +51,9 @@ const FORCED_TYPES = {
  * - some well known paths are forced to be arrays
  * @param {object} dst
  * @param {object} src
- * @param {boolean} isModifier specifies that the objects are modifiers sheets and need special
- *                             merging
+ * @param {string} [path]
  */
-function merge(dst, src, path, isModifier) {
+function merge(dst, src, path) {
   for (const [key, value] of Object.entries(src)) {
     const itemPath = `${path}.${key}`;
     if (value === '') {
@@ -88,7 +90,7 @@ function merge(dst, src, path, isModifier) {
         if (typeof item === 'object') {
           // todo: handle arrays in arrays eventually
           // special case for modifier sheets
-          if (isModifier && item.key) {
+          if (FORCED_TYPES[path] === 'modifier' && item.key) {
             const idx = dstArray.findIndex((i) => i.key === item.key);
             if (idx >= 0) {
               dstArray.splice(idx, 1);
@@ -98,9 +100,16 @@ function merge(dst, src, path, isModifier) {
               continue;
             }
           }
+          if (FORCED_TYPES[itemPath] === 'id-array' && item.id !== undefined) {
+            // special case for id arrays
+            const idx = dstArray.findIndex((i) => i.id === item.id);
+            if (idx >= 0) {
+              dstArray.splice(idx, 1);
+            }
+          }
           const dstObj = Object.create(null);
           dstArray.push(dstObj);
-          merge(dstObj, item, itemPath, isModifier);
+          merge(dstObj, item, itemPath);
         } else if (!dstArray.includes(item)) {
           dstArray.push(item);
         }
@@ -108,26 +117,26 @@ function merge(dst, src, path, isModifier) {
     } else {
       // handle plain object
       // eslint-disable-next-line no-use-before-define
-      mergeObject(dst, key, value, `${path}.${key}`, isModifier);
+      mergeObject(dst, key, value, `${path}.${key}`);
     }
   }
 }
 
-function mergeObject(dst, key, value, path, isModifier) {
+function mergeObject(dst, key, value, path) {
   const dstObj = dst[key] ?? Object.create(null);
   if (!dst[key]) {
     dst[key] = dstObj;
   }
-  merge(dstObj, value, path, isModifier);
+  merge(dstObj, value, path);
 }
 
 function mergeConfig(dst, src) {
-  Object.entries(ROOT_PROPERTIES).forEach(([key, { atomic, isModifier }]) => {
+  Object.entries(ROOT_PROPERTIES).forEach(([key, { atomic }]) => {
     if (src[key]) {
       if (atomic) {
         dst[key] = src[key];
       } else {
-        mergeObject(dst, key, src[key], `.${key}`, isModifier);
+        mergeObject(dst, key, src[key], `.${key}`);
       }
     }
   });