feat(application-config): Enforce uniqueness for uriPath of the submenu links.

.changeset/bright-hornets-enjoy.md

@@ -0,0 +1,6 @@
+---
+'@commercetools-frontend/application-config': minor
+---
+
+SubmenuLinks are meant to be "unique" based on the `uriPath`
+An error is thrown if there are duplicate uriPath in the submenuLinks.

packages/application-config/src/transformers.ts

@@ -1,6 +1,7 @@
 import type { JSONSchemaForCustomApplicationConfigurationFiles } from './schema';
 import type { CustomApplicationData } from './types';
 import { entryPointUriPathToResourceAccesses } from './formatters';
+import { validateSubmenuLinks } from './validate-config';
 
 // The `uriPath` of each submenu link is supposed to be defined relative
 // to the `entryPointUriPath`. Computing the full path is done internally to keep
@@ -24,6 +25,8 @@ function transformCustomApplicationConfigToData(
     appConfig.entryPointUriPath
   );
 
+  validateSubmenuLinks(appConfig.submenuLinks);
+
   return {
     id: appConfig.env.production.applicationId,
     name: appConfig.name,

packages/application-config/src/validate-config.ts

@@ -1,6 +1,7 @@
 import type { JSONSchemaForCustomApplicationConfigurationFiles } from './schema';
 import Ajv, { type ErrorObject } from 'ajv';
 import schemaJson from '../schema.json';
+import type { CustomApplicationData } from './types';
 
 type ErrorAdditionalProperty = ErrorObject<
   'additionalProperty',
@@ -9,6 +10,7 @@ type ErrorAdditionalProperty = ErrorObject<
 type ErrorEnum = ErrorObject<'enum', { allowedValues: string[] }>;
 
 const ajv = new Ajv({ strict: true, useDefaults: true });
+
 const validate =
   ajv.compile<JSONSchemaForCustomApplicationConfigurationFiles>(schemaJson);
 
@@ -46,3 +48,17 @@ const validateConfig = (
 };
 
 export default validateConfig;
+
+export const validateSubmenuLinks = (
+  submenuLinks: CustomApplicationData['submenuLinks']
+) => {
+  const uriPathSet = new Set();
+  submenuLinks.forEach(({ uriPath }) => {
+    if (uriPathSet.has(uriPath)) {
+      throw new Error(
+        'Duplicate URI path. Every submenu link must have a unique URI path value'
+      );
+    }
+    uriPathSet.add(uriPath);
+  });
+};

packages/application-config/test/json-schema.spec.js

@@ -1,4 +1,4 @@
-import validateConfig from '../src/validate-config';
+import validateConfig, { validateSubmenuLinks } from '../src/validate-config';
 import fixtureConfigSimple from './fixtures/config-simple.json';
 import fixtureConfigFull from './fixtures/config-full.json';
 import fixtureConfigOidc from './fixtures/config-oidc.json';
@@ -173,4 +173,25 @@ describe('invalid configurations', () => {
       `" must have required property 'mainMenuLink'"`
     );
   });
+  it('should validate that "uriPath" for "submenuLinks" is unique', () => {
+    expect(() =>
+      validateSubmenuLinks([
+        {
+          uriPath: 'custom-app/avengers',
+          defaultLabel: 'avengers',
+          permissions: [],
+          labelAllLocales: [],
+        },
+
+        {
+          uriPath: 'custom-app/avengers',
+          defaultLabel: 'justice-league',
+          permissions: [],
+          labelAllLocales: [],
+        },
+      ])
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Duplicate URI path. Every submenu link must have a unique URI path value"`
+    );
+  });
 });