fix: support the character sequence 'sku' in product SKUs (#963)

* add integration test for routing
* allow sku in sku
* allow sku in category
* assure no -cat in slugs

src/app/core/routing/category/category.route.ts

@@ -8,7 +8,13 @@ import { selectRouteParam, selectRouteParamAorB } from 'ish-core/store/core/rout
 import { reservedCharactersRegEx } from 'ish-core/utils/routing';
 
 export function generateLocalizedCategorySlug(category: Category) {
-  return category?.name?.replace(reservedCharactersRegEx, '-').replace(/-+/g, '-').replace(/-+$/, '') || '';
+  return (
+    category?.name
+      ?.replace(reservedCharactersRegEx, '-')
+      .replace(/-+/g, '-')
+      .replace(/-+$/, '')
+      .replace('-cat', '-Cat') || ''
+  );
 }
 
 const categoryRouteFormat = /^\/(?!category|categoryref\/.*$)(.*-)?cat(.*)$/;

src/app/core/routing/product/product.route.ts

@@ -27,10 +27,10 @@ function generateProductSlug(product: ProductView) {
       .replace(/-+/g, '-');
   }
 
-  return slug;
+  return slug.replace('-cat', '-Cat');
 }
 
-const productRouteFormat = new RegExp('^/(.*)?sku(.*?)(-cat(.*))?$');
+const productRouteFormat = new RegExp('/(?!cat)((?!.*-cat.*-sku).*-)?sku(.*?)(-cat(.*))?$');
 
 export function matchProductRoute(segments: UrlSegment[]): UrlMatchResult {
   // compatibility to old routes

src/app/core/routing/routing.integration.spec.ts

@@ -0,0 +1,181 @@
+import { Location } from '@angular/common';
+import { TestBed } from '@angular/core/testing';
+import { Router } from '@angular/router';
+import { RouterTestingModule } from '@angular/router/testing';
+
+import { CoreStoreModule } from 'ish-core/store/core/core-store.module';
+import { selectRouteData, selectRouteParam } from 'ish-core/store/core/router';
+import { StoreWithSnapshots, provideStoreSnapshots } from 'ish-core/utils/dev/ngrx-testing';
+
+import { matchCategoryRoute } from './category/category.route';
+import { matchProductRoute } from './product/product.route';
+
+describe('Routing Integration', () => {
+  let router: Router;
+  let location: Location;
+  let store: StoreWithSnapshots;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      imports: [
+        CoreStoreModule.forTesting(['router']),
+        RouterTestingModule.withRoutes([
+          { matcher: matchProductRoute, data: { page: 'product' }, children: [{ path: '**', children: [] }] },
+          { matcher: matchCategoryRoute, data: { page: 'category' }, children: [{ path: '**', children: [] }] },
+          { path: '**', children: [], data: { page: 'error' } },
+        ]),
+      ],
+      providers: [provideStoreSnapshots()],
+    });
+
+    router = TestBed.inject(Router);
+    location = TestBed.inject(Location);
+    store = TestBed.inject(StoreWithSnapshots);
+  });
+
+  describe('navigating to an unknown page', () => {
+    it('should land at the error page', async () => {
+      await router.navigateByUrl('/some');
+
+      expect(location.path()).toEqual('/some');
+
+      expect(selectRouteData('page')(store.state)).toEqual('error');
+    });
+  });
+
+  describe('navigating to a product page', () => {
+    it('should land at the product page for simple syntax with sku only', async () => {
+      await router.navigateByUrl('/sku12345');
+
+      expect(location.path()).toEqual('/sku12345');
+
+      expect(selectRouteData('page')(store.state)).toEqual('product');
+      expect(selectRouteParam('sku')(store.state)).toEqual('12345');
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toBeUndefined();
+    });
+
+    it('should land at the product page for syntax with sku and slug', async () => {
+      await router.navigateByUrl('/my-fancy-product-sku12345');
+
+      expect(location.path()).toEqual('/my-fancy-product-sku12345');
+
+      expect(selectRouteData('page')(store.state)).toEqual('product');
+      expect(selectRouteParam('sku')(store.state)).toEqual('12345');
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toBeUndefined();
+    });
+
+    it('should land at the product page for simple syntax with sku and categoryUniqueId only', async () => {
+      await router.navigateByUrl('/sku12345-catCAT');
+
+      expect(location.path()).toEqual('/sku12345-catCAT');
+
+      expect(selectRouteData('page')(store.state)).toEqual('product');
+      expect(selectRouteParam('sku')(store.state)).toEqual('12345');
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('CAT');
+    });
+
+    it('should land at the product page for syntax with slug, sku and categoryUniqueId', async () => {
+      await router.navigateByUrl('/fancy-category/fancy-product-sku12345-catCAT');
+
+      expect(location.path()).toEqual('/fancy-category/fancy-product-sku12345-catCAT');
+
+      expect(selectRouteData('page')(store.state)).toEqual('product');
+      expect(selectRouteParam('sku')(store.state)).toEqual('12345');
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('CAT');
+    });
+  });
+
+  describe('navigating to a category page', () => {
+    it('should land at the category page for simple syntax with categoryUniqueId only', async () => {
+      await router.navigateByUrl('/catCAT');
+
+      expect(location.path()).toEqual('/catCAT');
+
+      expect(selectRouteData('page')(store.state)).toEqual('category');
+      expect(selectRouteParam('sku')(store.state)).toBeUndefined();
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('CAT');
+    });
+
+    it('should land at the category page for syntax with slug and categoryUniqueId', async () => {
+      await router.navigateByUrl('/fancy-category-catCAT');
+
+      expect(location.path()).toEqual('/fancy-category-catCAT');
+
+      expect(selectRouteData('page')(store.state)).toEqual('category');
+      expect(selectRouteParam('sku')(store.state)).toBeUndefined();
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('CAT');
+    });
+  });
+
+  describe('special case with tokens in URL', () => {
+    it('should navigate to the correct product page when sku contains "sku"', async () => {
+      await router.navigateByUrl('/Acer/Glaskugel-skuglaskugel_1-catHome');
+
+      expect(location.path()).toEqual('/Acer/Glaskugel-skuglaskugel_1-catHome');
+
+      expect(selectRouteData('page')(store.state)).toEqual('product');
+      expect(selectRouteParam('sku')(store.state)).toEqual('glaskugel_1');
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('Home');
+    });
+
+    it('should navigate to the correct product page when category contains "cat"', async () => {
+      await router.navigateByUrl('/Furniture/Cat-Tree-skutree_1-catTrees-for-cats');
+
+      expect(location.path()).toEqual('/Furniture/Cat-Tree-skutree_1-catTrees-for-cats');
+
+      expect(selectRouteData('page')(store.state)).toEqual('product');
+      expect(selectRouteParam('sku')(store.state)).toEqual('tree_1');
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('Trees-for-cats');
+    });
+
+    it('should navigate to the correct product page when sku contains "cat"', async () => {
+      await router.navigateByUrl('/Furniture/Cat-Tree-skucat-tree_1-catTrees-for-cats');
+
+      expect(location.path()).toEqual('/Furniture/Cat-Tree-skucat-tree_1-catTrees-for-cats');
+
+      expect(selectRouteData('page')(store.state)).toEqual('product');
+      expect(selectRouteParam('sku')(store.state)).toEqual('cat-tree_1');
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('Trees-for-cats');
+    });
+
+    it('should navigate to the correct product page when sku contains "cat" with simple route', async () => {
+      await router.navigateByUrl('/skucat-tree_1-catTrees-for-cats');
+
+      expect(location.path()).toEqual('/skucat-tree_1-catTrees-for-cats');
+
+      expect(selectRouteData('page')(store.state)).toEqual('product');
+      expect(selectRouteParam('sku')(store.state)).toEqual('cat-tree_1');
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('Trees-for-cats');
+    });
+
+    it('should navigate to the correct product page when sku contains "cat" with simple route by sku only', async () => {
+      await router.navigateByUrl('/skucat-tree_1');
+
+      expect(location.path()).toEqual('/skucat-tree_1');
+
+      expect(selectRouteData('page')(store.state)).toEqual('product');
+      expect(selectRouteParam('sku')(store.state)).toEqual('cat-tree_1');
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toBeUndefined();
+    });
+
+    it('should navigate to the correct category page when uniqueId contains "-sku"', async () => {
+      await router.navigateByUrl('/Cult-Equipment-catCrosses-and-skulls');
+
+      expect(location.path()).toEqual('/Cult-Equipment-catCrosses-and-skulls');
+
+      expect(selectRouteData('page')(store.state)).toEqual('category');
+      expect(selectRouteParam('sku')(store.state)).toBeUndefined();
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('Crosses-and-skulls');
+    });
+
+    it('should navigate to the correct category page when uniqueId contains "-sku" with simple route', async () => {
+      await router.navigateByUrl('/catCrosses-and-skulls');
+
+      expect(location.path()).toEqual('/catCrosses-and-skulls');
+
+      expect(selectRouteData('page')(store.state)).toEqual('category');
+      expect(selectRouteParam('sku')(store.state)).toBeUndefined();
+      expect(selectRouteParam('categoryUniqueId')(store.state)).toEqual('Crosses-and-skulls');
+    });
+  });
+});