chore: Refactor of routerService.go 8169 (#12638)

* Refactor of routerService.go

Co-authored-by: Krzysztof Platis <[email protected]>

docs/migration/4_0.md

@@ -792,6 +792,10 @@ The following properties where removed in 4.0:
 
 `AuthRedirectService` is a new, required constructor dependency.
 
+### RoutingService
+`RoutingService.go` - Removed 2nd argument `query`. Use `extras.queryParams` instead.
+`RoutingService.navigate` - Removed 2nd argument `query`. Use `extras.queryParams` instead.
+
 ### AuthRedirectService
 
 - `#reportNotAuthGuard` - method not needed anymore. Every visited URL is now remembered automatically as redirect URL on `NavigationEnd` event.

feature-libs/product-configurator/rulebased/components/add-to-cart-button/configurator-add-to-cart-button.component.spec.ts

@@ -31,7 +31,6 @@ const navParamsOverview: any = {
   params: { ownerType: 'cartEntry', entityKey: CART_ENTRY_KEY },
 };
 
-const attributes = {};
 const mockOwner = mockProductConfiguration.owner;
 
 const mockRouterData: ConfiguratorRouter.Data = {
@@ -249,10 +248,7 @@ describe('ConfigAddToCartButtonComponent', () => {
     it('should navigate to OV in case configuration is cart bound and we are on product config page', () => {
       mockRouterData.pageType = ConfiguratorRouter.PageType.CONFIGURATION;
       performUpdateCart();
-      expect(routingService.go).toHaveBeenCalledWith(
-        navParamsOverview,
-        attributes
-      );
+      expect(routingService.go).toHaveBeenCalledWith(navParamsOverview);
 
       expect(
         configuratorGroupsService.setGroupStatusVisited
@@ -298,10 +294,7 @@ describe('ConfigAddToCartButtonComponent', () => {
     it('should navigate to overview in case configuration has not been added yet and we are on configuration page', () => {
       ensureProductBound();
       component.onAddToCart(mockProductConfiguration, mockRouterData);
-      expect(routingService.go).toHaveBeenCalledWith(
-        navParamsOverview,
-        attributes
-      );
+      expect(routingService.go).toHaveBeenCalledWith(navParamsOverview);
     });
 
     it('should remove one configuration (cart bound) in case configuration has not yet been added and we are on configuration page', () => {

feature-libs/product-configurator/rulebased/components/add-to-cart-button/configurator-add-to-cart-button.component.ts

@@ -65,13 +65,10 @@ export class ConfiguratorAddToCartButtonComponent {
     configuratorType: string,
     owner: CommonConfigurator.Owner
   ): void {
-    this.routingService.go(
-      {
-        cxRoute: 'configureOverview' + configuratorType,
-        params: { ownerType: 'cartEntry', entityKey: owner.id },
-      },
-      {}
-    );
+    this.routingService.go({
+      cxRoute: 'configureOverview' + configuratorType,
+      params: { ownerType: 'cartEntry', entityKey: owner.id },
+    });
   }
 
   protected displayConfirmationMessage(key: string): void {

feature-libs/storefinder/components/store-finder-search/store-finder-search.component.spec.ts

@@ -7,7 +7,11 @@ import { I18nTestingModule, RoutingService } from '@spartacus/core';
 import { StoreFinderSearchComponent } from './store-finder-search.component';
 import { ICON_TYPE } from '@spartacus/storefront';
 
-const query = 'address';
+const query = {
+  queryParams: {
+    query: 'address',
+  },
+};
 
 const keyEvent = {
   key: 'Enter',
@@ -77,19 +81,21 @@ describe('StoreFinderSearchComponent', () => {
   });
 
   it('should dispatch new query', () => {
-    component.searchBox.setValue(query);
+    component.searchBox.setValue(query.queryParams.query);
     component.findStores(component.searchBox.value);
-    expect(routingService.go).toHaveBeenCalledWith(['store-finder/find'], {
-      query,
-    });
+    expect(routingService.go).toHaveBeenCalledWith(
+      ['store-finder/find'],
+      query
+    );
   });
 
   it('should call onKey and dispatch query', () => {
-    component.searchBox.setValue(query);
+    component.searchBox.setValue(query.queryParams.query);
     component.onKey(keyEvent);
-    expect(routingService.go).toHaveBeenCalledWith(['store-finder/find'], {
-      query,
-    });
+    expect(routingService.go).toHaveBeenCalledWith(
+      ['store-finder/find'],
+      query
+    );
   });
 
   it('should only call onKey', () => {
@@ -100,14 +106,16 @@ describe('StoreFinderSearchComponent', () => {
   it('should view stores near by my location', () => {
     component.viewStoresWithMyLoc();
     expect(routingService.go).toHaveBeenCalledWith(['store-finder/find'], {
-      useMyLocation: true,
+      queryParams: {
+        useMyLocation: true,
+      },
     });
   });
 
   it('should call findStores if search value provided and Enter is an event', () => {
     spyOn(component, 'findStores');
-    component.searchBox.setValue(query);
+    component.searchBox.setValue(query.queryParams.query);
     component.onKey(keyEvent);
-    expect(component.findStores).toHaveBeenCalledWith(query);
+    expect(component.findStores).toHaveBeenCalledWith(query.queryParams.query);
   });
 });

feature-libs/storefinder/components/store-finder-search/store-finder-search.component.ts

@@ -14,11 +14,19 @@ export class StoreFinderSearchComponent {
   constructor(private routingService: RoutingService) {}
 
   findStores(address: string) {
-    this.routingService.go(['store-finder/find'], { query: address });
+    this.routingService.go(['store-finder/find'], {
+      queryParams: {
+        query: address,
+      },
+    });
   }
 
   viewStoresWithMyLoc() {
-    this.routingService.go(['store-finder/find'], { useMyLocation: true });
+    this.routingService.go(['store-finder/find'], {
+      queryParams: {
+        useMyLocation: true,
+      },
+    });
   }
 
   onKey(event: any) {

feature-libs/user/profile/components/update-email/update-email-component.service.spec.ts

@@ -132,7 +132,6 @@ describe('UpdateEmailComponentService', () => {
         authService.coreLogout().then(() => {
           expect(routingService.go).toHaveBeenCalledWith(
             { cxRoute: 'login' },
-            undefined,
             {
               state: {
                 newUid: '[email protected]',

feature-libs/user/profile/components/update-email/update-email-component.service.ts

@@ -72,11 +72,14 @@ export class UpdateEmailComponentService {
     this.form.reset();
     // TODO(#9638): Use logout route when it will support passing redirect url
     this.authService.coreLogout().then(() => {
-      this.routingService.go({ cxRoute: 'login' }, undefined, {
-        state: {
-          newUid,
-        },
-      });
+      this.routingService.go(
+        { cxRoute: 'login' },
+        {
+          state: {
+            newUid,
+          },
+        }
+      );
     });
   }
 

projects/core/src/routing/facade/routing.service.spec.ts

@@ -66,7 +66,6 @@ describe('RoutingService', () => {
       expect(store.dispatch).toHaveBeenCalledWith(
         new RoutingActions.RouteGoAction({
           path: ['generated', 'path'],
-          query: undefined,
           extras: undefined,
         })
       );
@@ -142,7 +141,6 @@ describe('RoutingService', () => {
       expect(store.dispatch).toHaveBeenCalledWith(
         new RoutingActions.RouteGoAction({
           path: ['/'],
-          query: undefined,
           extras: undefined,
         })
       );

projects/core/src/routing/facade/routing.service.ts

@@ -74,10 +74,9 @@ export class RoutingService {
    * @param query
    * @param extras: Represents the extra options used during navigation.
    */
-  go(commands: UrlCommands, query?: object, extras?: NavigationExtras): void {
+  go(commands: UrlCommands, extras?: NavigationExtras): void {
     const path = this.semanticPathService.transform(commands);
-
-    return this.navigate(path, query, extras);
+    return this.navigate(path, extras);
   }
 
   /**
@@ -146,15 +145,10 @@ export class RoutingService {
    * @param query
    * @param extras: Represents the extra options used during navigation.
    */
-  protected navigate(
-    path: any[],
-    query?: object,
-    extras?: NavigationExtras
-  ): void {
+  protected navigate(path: any[], extras?: NavigationExtras): void {
     this.store.dispatch(
       new RoutingActions.RouteGoAction({
         path,
-        query,
         extras,
       })
     );

projects/core/src/routing/store/actions/router.action.ts

@@ -13,7 +13,6 @@ export class RouteGoAction implements Action {
   constructor(
     public payload: {
       path: string[];
-      query?: object;
       extras?: NavigationExtras;
     }
   ) {}

projects/core/src/routing/store/effects/router.effect.spec.ts

@@ -46,9 +46,7 @@ describe('Router Effects', () => {
       spyOn(router, 'navigate');
       spyOn(router, 'navigateByUrl');
       effects.navigate$.subscribe(() => {
-        expect(router.navigate).toHaveBeenCalledWith(['/test'], {
-          queryParams: undefined,
-        });
+        expect(router.navigate).toHaveBeenCalledWith(['/test'], {});
       });
     });
   });

projects/core/src/routing/store/effects/router.effect.ts

@@ -16,8 +16,8 @@ export class RouterEffects {
   navigate$: Observable<any> = this.actions$.pipe(
     ofType(RoutingActions.ROUTER_GO),
     map((action: RoutingActions.RouteGoAction) => action.payload),
-    tap(({ path, query: queryParams, extras }) => {
-      this.router.navigate(path, { queryParams, ...extras });
+    tap(({ path, extras }) => {
+      this.router.navigate(path, { ...extras });
     })
   );
 

projects/schematics/src/migrations/4_0/methods-and-properties-deprecations/data/routing.service.ts.migration.ts

@@ -0,0 +1,17 @@
+import {
+  TODO_SPARTACUS,
+  SPARTACUS_CORE,
+  ROUTING_SERVICE,
+  GO,
+} from '../../../../shared/constants';
+import { MethodPropertyDeprecation } from '../../../../shared/utils/file-utils';
+
+// projects/core/src/routing/facade/routing.service.ts
+export const ROUTING_SERVICE_MIGRATION: MethodPropertyDeprecation[] = [
+  {
+    class: ROUTING_SERVICE,
+    importPath: SPARTACUS_CORE,
+    deprecatedNode: GO,
+    comment: `// ${TODO_SPARTACUS} The second argument of the method ${GO} has been removed. Use extras.queryParams instead.`,
+  },
+];

projects/schematics/src/migrations/4_0/methods-and-properties-deprecations/methods-and-properties-deprecations.ts

@@ -5,8 +5,8 @@ import { ADDED_TO_CART_DIALOG_COMPONENT_MIGRATION } from './data/added-to-cart-d
 import { CONFIGURATOR_ATTRIBUTE_DROP_DOWN_COMPONENT_MIGRATION } from './data/configurator-attribute-drop-down.component.migration';
 import { CONFIGURATOR_ATTRIBUTE_NUMERIC_INPUT_FIELD_COMPONENT_MIGRATION } from './data/configurator-attribute-numeric-input-field.component.migration';
 import { CONFIGURATOR_ATTRIBUTE_RADIO_BUTTON_COMPONENT_MIGRATION } from './data/configurator-attribute-radio-button.component.migration';
-import { CONFIGURATOR_PRODUCT_TITLE_COMPONENT_MIGRATION } from './data/configurator-product-title.component.migration';
 import { CONFIGURATOR_GROUP_MENU_COMPONENT_MIGRATION } from './data/configurator-group-menu.component.migration';
+import { CONFIGURATOR_PRODUCT_TITLE_COMPONENT_MIGRATION } from './data/configurator-product-title.component.migration';
 import {
   CONTENT_PAGE_META_RESOLVER_MIGRATION,
   PAGE_META_SERVICE_MIGRATION,
@@ -19,6 +19,7 @@ import {
   OCC_ENDPOINTS_SERVICE_MIGRATION,
 } from './data/occ-endpoints.service.migration';
 import { PAGE_EVENT_BUILDER_MIGRATION } from './data/page-event.builder.ts.migration';
+import { ROUTING_SERVICE_MIGRATION } from './data/routing.service.ts.migration';
 import { SELECTIVE_CART_SERVICE_MIGRATION } from './data/selective-cart.service.migration';
 
 export const METHOD_PROPERTY_DATA: MethodPropertyDeprecation[] = [
@@ -36,6 +37,7 @@ export const METHOD_PROPERTY_DATA: MethodPropertyDeprecation[] = [
   ...CONFIGURATOR_ATTRIBUTE_NUMERIC_INPUT_FIELD_COMPONENT_MIGRATION,
   ...CONFIGURATOR_ATTRIBUTE_RADIO_BUTTON_COMPONENT_MIGRATION,
   ...CONFIGURATOR_PRODUCT_TITLE_COMPONENT_MIGRATION,
+  ...ROUTING_SERVICE_MIGRATION,
   ...CONFIGURATOR_GROUP_MENU_COMPONENT_MIGRATION,
 ];
 

projects/schematics/src/shared/constants.ts

@@ -861,6 +861,7 @@ export const GET_LOADED = 'getLoaded';
 export const IS_STABLE = 'isStable';
 
 export const STOREFINDER_MODULE = 'StoreFinderModule';
+export const GO = 'go';
 
 export const CREATE_EVENT_FROM_INPUT = 'createEventFromInput';
 export const ON_SELECT = 'onSelect';

projects/storefrontlib/src/cms-components/myaccount/my-coupons/my-coupons.component.service.spec.ts

@@ -51,7 +51,11 @@ describe('MyCouponsComponentService', () => {
         cxRoute: 'search',
         params: { query: RELEVANCE },
       },
-      { couponcode: 'CouponForAllProduct' }
+      {
+        queryParams: {
+          couponcode: 'CouponForAllProduct',
+        },
+      }
     );
   });
 
@@ -64,7 +68,11 @@ describe('MyCouponsComponentService', () => {
           query: RELEVANCE + CUSTOMER_COUPON_CODE + 'CouponForPartProduct',
         },
       },
-      { couponcode: 'CouponForPartProduct' }
+      {
+        queryParams: {
+          couponcode: 'CouponForPartProduct',
+        },
+      }
     );
   });
 

projects/storefrontlib/src/cms-components/myaccount/my-coupons/my-coupons.component.service.ts

@@ -32,7 +32,11 @@ export class MyCouponsComponentService {
         cxRoute: 'search',
         params: { query: this.buildSearchParam(coupon) },
       },
-      { couponcode: coupon.couponId }
+      {
+        queryParams: {
+          couponcode: coupon.couponId,
+        },
+      }
     );
   }
 

projects/storefrontlib/src/cms-components/myaccount/order/return-request-detail/return-request.service.spec.ts

@@ -146,7 +146,6 @@ describe('ReturnRequestService', () => {
     service.backToList();
     expect(routingService.go).toHaveBeenCalledWith(
       { cxRoute: 'orders' },
-      null,
       {
         state: {
           activeTab: 1,

projects/storefrontlib/src/cms-components/myaccount/order/return-request-detail/return-request.service.ts

@@ -78,10 +78,13 @@ export class ReturnRequestService {
   }
 
   backToList(): void {
-    this.routingService.go({ cxRoute: 'orders' }, null, {
-      state: {
-        activeTab: 1,
-      },
-    });
+    this.routingService.go(
+      { cxRoute: 'orders' },
+      {
+        state: {
+          activeTab: 1,
+        },
+      }
+    );
   }
 }