chore: Upgrade to Angular 18 - Handle new return type of guards

- replaced `Observable<boolean | UrlTree> with combined `Observable<GuardResult>` from @angular/router for more, see: angular/angular#45023
SAP · Oct 10, 2024 · c6b88bc · c6b88bc
1 parent 6518611
commit c6b88bc
Show file tree

Hide file tree

Showing 31 changed files with 101 additions and 99 deletions.
diff --git a/feature-libs/cart/base/core/guards/cart-validation.guard.ts b/feature-libs/cart/base/core/guards/cart-validation.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { Router, UrlTree } from '@angular/router';
+import { GuardResult, Router } from '@angular/router';
 import {
   ActiveCartFacade,
   CartValidationFacade,
@@ -37,7 +37,7 @@ export class CartValidationGuard {
 
   protected GLOBAL_MESSAGE_TIMEOUT = 10000;
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return !this.cartConfigService.isCartValidationEnabled()
       ? of(true)
       : this.cartValidationService.validateCart().pipe(

diff --git a/feature-libs/checkout/b2b/components/guards/checkout-b2b-auth.guard.ts b/feature-libs/checkout/b2b/components/guards/checkout-b2b-auth.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { Router, UrlTree } from '@angular/router';
+import { GuardResult, Router, UrlTree } from '@angular/router';
 import { ActiveCartFacade } from '@spartacus/cart/base/root';
 import {
   CheckoutAuthGuard,
@@ -48,7 +48,7 @@ export class CheckoutB2BAuthGuard extends CheckoutAuthGuard {
     );
   }
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return combineLatest([
       this.authService.isUserLoggedIn(),
       this.activeCartFacade.isGuestCart(),

diff --git a/feature-libs/checkout/b2b/components/guards/checkout-b2b-steps-set.guard.ts b/feature-libs/checkout/b2b/components/guards/checkout-b2b-steps-set.guard.ts
@@ -4,8 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Injectable, inject, isDevMode } from '@angular/core';
-import { ActivatedRouteSnapshot, Router, UrlTree } from '@angular/router';
+import { inject, Injectable, isDevMode } from '@angular/core';
+import { ActivatedRouteSnapshot, GuardResult, Router } from '@angular/router';
 import { ActiveCartFacade } from '@spartacus/cart/base/root';
 import {
   CheckoutCostCenterFacade,
@@ -23,7 +23,7 @@ import {
   CheckoutStepType,
 } from '@spartacus/checkout/base/root';
 import { LoggerService, RoutingConfigService } from '@spartacus/core';
-import { Observable, combineLatest, of } from 'rxjs';
+import { combineLatest, Observable, of } from 'rxjs';
 import { filter, map, switchMap, take, tap } from 'rxjs/operators';
 
 @Injectable({
@@ -54,7 +54,7 @@ export class CheckoutB2BStepsSetGuard extends CheckoutStepsSetGuard {
     );
   }
 
-  canActivate(route: ActivatedRouteSnapshot): Observable<boolean | UrlTree> {
+  canActivate(route: ActivatedRouteSnapshot): Observable<GuardResult> {
     let currentIndex = -1;
     const currentRouteUrl = '/' + route.url.join('/');
 
@@ -99,7 +99,7 @@ export class CheckoutB2BStepsSetGuard extends CheckoutStepsSetGuard {
   protected isB2BStepSet(
     step: CheckoutStep,
     isAccountPayment: boolean
-  ): Observable<boolean | UrlTree> {
+  ): Observable<GuardResult> {
     if (step && !step.disabled) {
       switch (step.type[0]) {
         case CheckoutStepType.PAYMENT_TYPE: {
@@ -122,9 +122,7 @@ export class CheckoutB2BStepsSetGuard extends CheckoutStepsSetGuard {
     return of(true);
   }
 
-  protected isPaymentTypeSet(
-    step: CheckoutStep
-  ): Observable<boolean | UrlTree> {
+  protected isPaymentTypeSet(step: CheckoutStep): Observable<GuardResult> {
     return this.checkoutPaymentTypeFacade.getSelectedPaymentTypeState().pipe(
       filter((state) => !state.loading),
       map((state) => state.data),
@@ -141,7 +139,7 @@ export class CheckoutB2BStepsSetGuard extends CheckoutStepsSetGuard {
   protected isDeliveryAddressAndCostCenterSet(
     step: CheckoutStep,
     isAccountPayment: boolean
-  ): Observable<boolean | UrlTree> {
+  ): Observable<GuardResult> {
     return combineLatest([
       this.checkoutDeliveryAddressFacade.getDeliveryAddressState().pipe(
         filter((state) => !state.loading),

diff --git a/feature-libs/checkout/base/components/guards/cart-not-empty.guard.ts b/feature-libs/checkout/base/components/guards/cart-not-empty.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { Router, UrlTree } from '@angular/router';
+import { GuardResult, Router } from '@angular/router';
 import { ActiveCartFacade, Cart } from '@spartacus/cart/base/root';
 import { SemanticPathService } from '@spartacus/core';
 import { Observable } from 'rxjs';
@@ -21,7 +21,7 @@ export class CartNotEmptyGuard {
     protected router: Router
   ) {}
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return this.activeCartFacade.takeActive().pipe(
       map((cart) => {
         if (this.isEmpty(cart)) {

diff --git a/feature-libs/checkout/base/components/guards/checkout-auth.guard.ts b/feature-libs/checkout/base/components/guards/checkout-auth.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { Router, UrlTree } from '@angular/router';
+import { GuardResult, Router, UrlTree } from '@angular/router';
 import { ActiveCartFacade } from '@spartacus/cart/base/root';
 import {
   AuthRedirectService,
@@ -29,7 +29,7 @@ export class CheckoutAuthGuard {
     protected router: Router
   ) {}
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return combineLatest([
       this.authService.isUserLoggedIn(),
       this.activeCartFacade.isGuestCart(),

diff --git a/feature-libs/checkout/base/components/guards/checkout-steps-set.guard.ts b/feature-libs/checkout/base/components/guards/checkout-steps-set.guard.ts
@@ -5,7 +5,12 @@
  */
 
 import { inject, Injectable, isDevMode, OnDestroy } from '@angular/core';
-import { ActivatedRouteSnapshot, Router, UrlTree } from '@angular/router';
+import {
+  ActivatedRouteSnapshot,
+  GuardResult,
+  Router,
+  UrlTree,
+} from '@angular/router';
 import { ActiveCartFacade } from '@spartacus/cart/base/root';
 import {
   CheckoutDeliveryAddressFacade,
@@ -65,7 +70,7 @@ export class CheckoutStepsSetGuard implements OnDestroy {
       });
   }
 
-  canActivate(route: ActivatedRouteSnapshot): Observable<boolean | UrlTree> {
+  canActivate(route: ActivatedRouteSnapshot): Observable<GuardResult> {
     let currentIndex = -1;
     const currentRouteUrl = '/' + route.url.join('/');
 
@@ -98,7 +103,7 @@ export class CheckoutStepsSetGuard implements OnDestroy {
     );
   }
 
-  protected isStepSet(step: CheckoutStep): Observable<boolean | UrlTree> {
+  protected isStepSet(step: CheckoutStep): Observable<GuardResult> {
     if (step && !step.disabled) {
       switch (step.type[0]) {
         case CheckoutStepType.DELIVERY_ADDRESS: {
@@ -126,9 +131,7 @@ export class CheckoutStepsSetGuard implements OnDestroy {
     return of(true);
   }
 
-  protected isDeliveryAddress(
-    step: CheckoutStep
-  ): Observable<boolean | UrlTree> {
+  protected isDeliveryAddress(step: CheckoutStep): Observable<GuardResult> {
     return this.checkoutDeliveryAddressFacade.getDeliveryAddressState().pipe(
       filter((state) => !state.loading),
       map((state) => state.data),
@@ -142,19 +145,15 @@ export class CheckoutStepsSetGuard implements OnDestroy {
     );
   }
 
-  protected isDeliveryModeSet(
-    step: CheckoutStep
-  ): Observable<boolean | UrlTree> {
+  protected isDeliveryModeSet(step: CheckoutStep): Observable<GuardResult> {
     return this.checkoutDeliveryModesFacade.getSelectedDeliveryModeState().pipe(
       filter((state) => !state.loading),
       map((state) => state.data),
       map((mode) => (mode ? true : this.getUrl(step.routeName)))
     );
   }
 
-  protected isPaymentDetailsSet(
-    step: CheckoutStep
-  ): Observable<boolean | UrlTree> {
+  protected isPaymentDetailsSet(step: CheckoutStep): Observable<GuardResult> {
     return this.checkoutPaymentFacade.getPaymentDetailsState().pipe(
       filter((state) => !state.loading),
       map((state) => state.data),

diff --git a/feature-libs/checkout/base/components/guards/checkout.guard.ts b/feature-libs/checkout/base/components/guards/checkout.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { Router, UrlTree } from '@angular/router';
+import { GuardResult, Router, UrlTree } from '@angular/router';
 import { ActiveCartFacade } from '@spartacus/cart/base/root';
 import { CheckoutStepType } from '@spartacus/checkout/base/root';
 import { RoutingConfigService } from '@spartacus/core';
@@ -38,7 +38,7 @@ export class CheckoutGuard {
     protected checkoutStepService: CheckoutStepService
   ) {}
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     const expressCheckout$ = this.expressCheckoutService
       .trySetDefaultCheckoutDetails()
       .pipe(

diff --git a/feature-libs/checkout/base/components/guards/not-checkout-auth.guard.ts b/feature-libs/checkout/base/components/guards/not-checkout-auth.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { Router, UrlTree } from '@angular/router';
+import { GuardResult, Router } from '@angular/router';
 import { ActiveCartFacade } from '@spartacus/cart/base/root';
 import {
   AuthService,
@@ -26,7 +26,7 @@ export class NotCheckoutAuthGuard {
     protected router: Router
   ) {}
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return this.authService.isUserLoggedIn().pipe(
       map((isLoggedIn) => {
         if (isLoggedIn) {

diff --git a/feature-libs/order/components/amend-order/cancellations/order-cancellation.guard.ts b/feature-libs/order/components/amend-order/cancellations/order-cancellation.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { Router, UrlTree } from '@angular/router';
+import { GuardResult, Router } from '@angular/router';
 import { SemanticPathService } from '@spartacus/core';
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
@@ -21,7 +21,7 @@ export class OrderCancellationGuard {
     protected router: Router
   ) {}
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return this.orderAmendService.getForm().pipe(
       map((form) => {
         if (!form.valid) {

diff --git a/feature-libs/order/components/amend-order/returns/order-return.guard.ts b/feature-libs/order/components/amend-order/returns/order-return.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { Router, UrlTree } from '@angular/router';
+import { GuardResult, Router } from '@angular/router';
 import { SemanticPathService } from '@spartacus/core';
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
@@ -21,7 +21,7 @@ export class OrderReturnGuard {
     protected router: Router
   ) {}
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return this.orderAmendService.getForm().pipe(
       map((form) => {
         if (!form.valid) {

diff --git a/feature-libs/order/components/guards/order-confirmation.guard.ts b/feature-libs/order/components/guards/order-confirmation.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { Router, UrlTree } from '@angular/router';
+import { GuardResult, Router } from '@angular/router';
 import { SemanticPathService } from '@spartacus/core';
 import { OrderFacade } from '@spartacus/order/root';
 import { Observable } from 'rxjs';
@@ -21,7 +21,7 @@ export class OrderConfirmationGuard {
     protected semanticPathService: SemanticPathService
   ) {}
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return this.orderFacade.getOrderDetails().pipe(
       map((orderDetails) => {
         if (orderDetails && Object.keys(orderDetails).length !== 0) {

diff --git a/...-multi-dimensional/selector/components/guards/product-multi-dimensional-selector.guard.ts b/...-multi-dimensional/selector/components/guards/product-multi-dimensional-selector.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { inject, Injectable } from '@angular/core';
-import { ActivatedRouteSnapshot, Router, UrlTree } from '@angular/router';
+import { ActivatedRouteSnapshot, GuardResult, Router } from '@angular/router';
 import {
   isNotUndefined,
   Product,
@@ -36,9 +36,7 @@ export class ProductMultiDimensionalSelectorGuard {
     inject(SemanticPathService);
   protected router: Router = inject(Router);
 
-  canActivate(
-    activatedRoute: ActivatedRouteSnapshot
-  ): Observable<boolean | UrlTree> {
+  canActivate(activatedRoute: ActivatedRouteSnapshot): Observable<GuardResult> {
     const productCode = activatedRoute.params?.productCode;
     if (!productCode) {
       return of(false);
@@ -64,7 +62,7 @@ export class ProductMultiDimensionalSelectorGuard {
    * Finds a valid product code from variant options and returns a URL tree for redirection.
    *
    * @param {Product} product - The product with variant options.
-   * @returns {Observable<boolean | UrlTree>} - An observable that resolves to a `UrlTree` for
+   * @returns {Observable<GuardResult>} - An observable that resolves to a `UrlTree` for
    * redirection if a valid product code is found, or `false` if no valid code is available.
    *
    * @description
@@ -74,7 +72,7 @@ export class ProductMultiDimensionalSelectorGuard {
    */
   protected findValidProductCodeAndReturnUrlTree(
     product: Product
-  ): Observable<boolean | UrlTree> {
+  ): Observable<GuardResult> {
     const validVariantCode = this.getValidVariantCode(product);
     const fallbackProductCode = this.getFallbackProductCode(product);
 

diff --git a/feature-libs/product/variants/components/guards/product-variants.guard.ts b/feature-libs/product/variants/components/guards/product-variants.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable } from '@angular/core';
-import { ActivatedRouteSnapshot, Router, UrlTree } from '@angular/router';
+import { ActivatedRouteSnapshot, GuardResult, Router } from '@angular/router';
 import {
   isNotUndefined,
   Product,
@@ -29,9 +29,7 @@ export class ProductVariantsGuard {
     protected semanticPathService: SemanticPathService,
     protected router: Router
   ) {}
-  canActivate(
-    activatedRoute: ActivatedRouteSnapshot
-  ): Observable<boolean | UrlTree> {
+  canActivate(activatedRoute: ActivatedRouteSnapshot): Observable<GuardResult> {
     const productCode = activatedRoute.params?.productCode;
     if (!productCode) {
       return of(true);

diff --git a/feature-libs/quote/components/cart-guard/quote-cart.guard.ts b/feature-libs/quote/components/cart-guard/quote-cart.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { inject, Injectable } from '@angular/core';
-import { CanActivate, Router, UrlTree } from '@angular/router';
+import { CanActivate, GuardResult, Router } from '@angular/router';
 
 import {
   RouterState,
@@ -31,7 +31,7 @@ export class QuoteCartGuard implements CanActivate {
   protected router = inject(Router);
   protected semanticPathService = inject(SemanticPathService);
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return combineLatest([
       this.quoteCartService.isQuoteCartActive(),
       this.quoteCartService.getQuoteId(),

diff --git a/integration-libs/cdc/components/gigya-raas/gigya-raas.guard.ts b/integration-libs/cdc/components/gigya-raas/gigya-raas.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable, inject } from '@angular/core';
-import { CanActivate, UrlTree } from '@angular/router';
+import { CanActivate, GuardResult } from '@angular/router';
 import { GigyaRaasComponentData } from '@spartacus/cdc/core';
 import {
   AuthGuard,
@@ -26,7 +26,7 @@ export class GigyaRaasGuard implements CanActivate {
   protected authGuard = inject(AuthGuard);
   protected notAuthGuard = inject(NotAuthGuard);
 
-  canActivate(): Observable<boolean | UrlTree> {
+  canActivate(): Observable<GuardResult> {
     return this.getComponentData().pipe(
       switchMap((componentData) => {
         if (Object.keys(componentData).length === 0) {

diff --git a/integration-libs/opps/root/login-required/opps-login-required.guard.ts b/integration-libs/opps/root/login-required/opps-login-required.guard.ts
@@ -5,7 +5,7 @@
  */
 
 import { Injectable, inject, isDevMode } from '@angular/core';
-import { RouterStateSnapshot, UrlTree, Router } from '@angular/router';
+import { GuardResult, Router, RouterStateSnapshot } from '@angular/router';
 import {
   AuthRedirectService,
   AuthService,
@@ -29,7 +29,7 @@ export class OppsLoginRequiredGuard {
   canActivate(
     route: CmsActivatedRouteSnapshot,
     _state: RouterStateSnapshot
-  ): Observable<boolean | UrlTree> {
+  ): Observable<GuardResult> {
     const navigation = this.router.getCurrentNavigation();
     return this.authService.isUserLoggedIn().pipe(
       take(1),