feat: incorporate submenu items ordering in config:sync command (#3689)

* feat: add check for submenu item order change * feat: incorporate submenu items ordering in config:sync command * chore: imporve variable name * chore: update tests for submenu items order change * chore: add a changeset for updating submenu item order from the configuration file * chore: correct changeset file
commercetools · Jan 22, 2025 · f6827aa · f6827aa
1 parent 6ece19a
commit f6827aa
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 0 deletions.
diff --git a/.changeset/grumpy-gorillas-nail.md b/.changeset/grumpy-gorillas-nail.md
@@ -0,0 +1,5 @@
+---
+'@commercetools-frontend/mc-scripts': minor
+---
+
+Update the `mc-scripts config:sync` command to synchronize submenu item order from the configuration file to the database.
diff --git a/packages/mc-scripts/src/utils/get-config-diff.spec.ts b/packages/mc-scripts/src/utils/get-config-diff.spec.ts
@@ -317,6 +317,9 @@ describe('Custom Application Config Diff', () => {
         expect(getCustomApplicationConfigDiff(oldConfig, newConfig))
           .toMatchInlineSnapshot(`
           "submenuLink changed
+            submenu order changed
+              previous order: []
+              new order: [my-test-app/new]
             menu link added: <color-green>my-test-app/new</color-green>"
         `);
       });
@@ -344,6 +347,9 @@ describe('Custom Application Config Diff', () => {
         expect(getCustomApplicationConfigDiff(oldConfig, newConfig))
           .toMatchInlineSnapshot(`
           "submenuLink changed
+            submenu order changed
+              previous order: [my-test-app/new]
+              new order: []
             menu link removed: <color-red>my-test-app/new</color-red>"
         `);
       });
@@ -401,6 +407,70 @@ describe('Custom Application Config Diff', () => {
                 locale removed: <color-red>en</color-red>"
         `);
       });
+
+      it('should display diff when submenu items are reordered', () => {
+        const oldConfig = createTestCustomApplicationConfig({
+          submenuLinks: [
+            {
+              uriPath: 'my-test-app/first',
+              defaultLabel: 'First Item',
+              permissions: ['ManageMyTestApp'],
+              labelAllLocales: [
+                {
+                  locale: 'de',
+                  value: 'Erstes Element',
+                },
+              ],
+            },
+            {
+              uriPath: 'my-test-app/second',
+              defaultLabel: 'Second Item',
+              permissions: ['ManageMyTestApp'],
+              labelAllLocales: [
+                {
+                  locale: 'de',
+                  value: 'Zweites Element',
+                },
+              ],
+            },
+          ],
+        });
+
+        const newConfig = createTestCustomApplicationConfig({
+          submenuLinks: [
+            {
+              uriPath: 'my-test-app/second',
+              defaultLabel: 'Second Item',
+              permissions: ['ManageMyTestApp'],
+              labelAllLocales: [
+                {
+                  locale: 'de',
+                  value: 'Zweites Element',
+                },
+              ],
+            },
+            {
+              uriPath: 'my-test-app/first',
+              defaultLabel: 'First Item',
+              permissions: ['ManageMyTestApp'],
+              labelAllLocales: [
+                {
+                  locale: 'de',
+                  value: 'Erstes Element',
+                },
+              ],
+            },
+          ],
+        });
+
+        expect(getCustomApplicationConfigDiff(oldConfig, newConfig))
+          .toMatchInlineSnapshot(`
+          "submenuLink changed
+            submenu order changed
+              previous order: [my-test-app/first, my-test-app/second]
+              new order: [my-test-app/second, my-test-app/first]"
+        `);
+      });
     });
   });
 });

diff --git a/packages/mc-scripts/src/utils/get-config-diff.ts b/packages/mc-scripts/src/utils/get-config-diff.ts
@@ -332,6 +332,18 @@ const getSubmenuLinksDiff = ({
     {}
   );
 
+  const getOrder = (value: { uriPath: string }[]): string =>
+    value.map((link) => link.uriPath).join(', ');
+
+  const previousOrder = getOrder(previousValue);
+  const newOrder = getOrder(nextValue);
+
+  if (previousOrder !== newOrder) {
+    submenuLinksDiff.push(`${indent(1)}submenu order changed`);
+    submenuLinksDiff.push(`${indent(2)}previous order: [${previousOrder}]`);
+    submenuLinksDiff.push(`${indent(2)}new order: [${newOrder}]`);
+  }
+
   nextValue.forEach((newSubmenuLink) => {
     const oldSubMenuLink = mappedSubmenuLinks[newSubmenuLink.uriPath];
     if (newSubmenuLink.uriPath in mappedSubmenuLinks) {