feat: introduce price update strategies (#1089)

src/app/core/configurations/injection-keys.ts

@@ -1,6 +1,7 @@
 import { InjectionToken } from '@angular/core';
 
 import { CookieConsentOptions } from 'ish-core/models/cookies/cookies.model';
+import { PriceUpdateType } from 'ish-core/models/price/price.model';
 import { ViewType } from 'ish-core/models/viewtype/viewtype.types';
 import { DataRetentionPolicy } from 'ish-core/utils/meta-reducers';
 
@@ -58,6 +59,13 @@ export const DATA_RETENTION_POLICY = new InjectionToken<DataRetentionPolicy>('da
   factory: () => environment.dataRetention,
 });
 
+/**
+ * the configured price update policy for the application
+ */
+export const PRICE_UPDATE = new InjectionToken<PriceUpdateType>('priceUpdate', {
+  factory: () => environment.priceUpdate,
+});
+
 /**
  * the configured theme color
  */

src/app/core/facades/product-context.facade.ts

@@ -402,9 +402,20 @@ export class ProductContextFacade extends RxState<ProductContext> implements OnD
       case 'prices':
         wrap(
           'prices',
-          combineLatest([this.select('displayProperties', 'price'), this.select('product', 'sku')]).pipe(
+          combineLatest([
+            this.select('displayProperties', 'price'),
+            this.select('product').pipe(
+              filter(p => !!p && !p.failed),
+              mapToProperty('sku'),
+              distinctUntilChanged()
+            ),
+            this.select('requiredCompletenessLevel').pipe(
+              map(completeness => completeness === true),
+              distinctUntilChanged()
+            ),
+          ]).pipe(
             filter(([visible]) => !!visible),
-            switchMap(([, ids]) => this.shoppingFacade.productPrices$(ids))
+            switchMap(([, sku, fresh]) => this.shoppingFacade.productPrices$(sku, fresh))
           )
         );
         break;

src/app/core/facades/shopping.facade.ts

@@ -1,9 +1,11 @@
-import { Injectable } from '@angular/core';
+import { Inject, Injectable } from '@angular/core';
 import { Store, select } from '@ngrx/store';
-import { Observable, combineLatest } from 'rxjs';
+import { Observable, combineLatest, identity } from 'rxjs';
 import { debounce, filter, map, pairwise, startWith, switchMap, tap } from 'rxjs/operators';
 
+import { PRICE_UPDATE } from 'ish-core/configurations/injection-keys';
 import { PriceItemHelper } from 'ish-core/models/price-item/price-item.helper';
+import { PriceUpdateType } from 'ish-core/models/price/price.model';
 import { ProductListingID } from 'ish-core/models/product-listing/product-listing.model';
 import { ProductCompletenessLevel, ProductHelper } from 'ish-core/models/product/product.model';
 import { selectRouteParam } from 'ish-core/store/core/router';
@@ -24,6 +26,7 @@ import {
   getProductListingViewType,
   loadMoreProducts,
 } from 'ish-core/store/shopping/product-listing';
+import { loadProductPrices } from 'ish-core/store/shopping/product-prices';
 import { getProductPrice } from 'ish-core/store/shopping/product-prices/product-prices.selectors';
 import {
   getProduct,
@@ -43,7 +46,7 @@ import { whenFalsy, whenTruthy } from 'ish-core/utils/operators';
 /* eslint-disable @typescript-eslint/member-ordering */
 @Injectable({ providedIn: 'root' })
 export class ShoppingFacade {
-  constructor(private store: Store) {}
+  constructor(private store: Store, @Inject(PRICE_UPDATE) private priceUpdate: PriceUpdateType) {}
 
   // CATEGORY
 
@@ -105,11 +108,22 @@ export class ShoppingFacade {
     );
   }
 
-  productPrices$(sku: string | Observable<string>) {
+  productPrices$(sku: string | Observable<string>, fresh = false) {
     return toObservable(sku).pipe(
+      whenTruthy(),
       switchMap(plainSKU =>
         combineLatest([
-          this.store.pipe(select(getProductPrice(plainSKU))),
+          this.store.pipe(
+            select(getProductPrice(plainSKU)),
+            // reset state when updates are forced
+            this.priceUpdate === 'always' || fresh ? startWith(undefined) : identity,
+            tap(prices => {
+              if (!prices) {
+                this.store.dispatch(loadProductPrices({ skus: [plainSKU] }));
+              }
+            }),
+            whenTruthy()
+          ),
           this.store.pipe(select(getPriceDisplayType)),
         ]).pipe(map(args => PriceItemHelper.selectPricing(...args)))
       )

src/app/core/models/price/price.model.ts

@@ -1,3 +1,5 @@
+export type PriceUpdateType = 'stable' | 'always';
+
 export interface Price {
   type: 'Money';
   value: number;

src/app/core/store/shopping/products/products.effects.spec.ts

@@ -17,7 +17,6 @@ import { loadCategory } from 'ish-core/store/shopping/categories';
 import { loadProductsForFilter } from 'ish-core/store/shopping/filter';
 import { setProductListingPageSize } from 'ish-core/store/shopping/product-listing';
 import { loadProductPricesSuccess } from 'ish-core/store/shopping/product-prices';
-import { loadProductPrices } from 'ish-core/store/shopping/product-prices/product-prices.actions';
 import { ShoppingStoreModule } from 'ish-core/store/shopping/shopping-store.module';
 import { makeHttpError } from 'ish-core/utils/dev/api-service-utils';
 import { HttpStatusCodeService } from 'ish-core/utils/http-status-code/http-status-code.service';
@@ -199,18 +198,6 @@ describe('Products Effects', () => {
     }));
   });
 
-  describe('loadProductPricesAfterProductSuccess$', () => {
-    it('should trigger action to load product prices after successful load product action', () => {
-      const sku = 'sku123';
-      const action = loadProductSuccess({ product: { sku } as Product });
-      const completion = loadProductPrices({ skus: [sku] });
-      actions$ = hot('-a-a-a', { a: action });
-      const expected$ = cold('-c-c-c', { c: completion });
-
-      expect(effects.loadProductPricesAfterProductSuccess$).toBeObservable(expected$);
-    });
-  });
-
   describe('loadProductsForCategory$', () => {
     it('should call service for SKU list', done => {
       actions$ = of(loadProductsForCategory({ categoryId: '123', sorting: 'name-asc' }));

src/app/core/store/shopping/products/products.effects.ts

@@ -30,7 +30,6 @@ import { personalizationStatusDetermined } from 'ish-core/store/customer/user';
 import { loadCategory } from 'ish-core/store/shopping/categories';
 import { loadProductsForFilter } from 'ish-core/store/shopping/filter';
 import { getProductListingItemsPerPage, setProductListingPages } from 'ish-core/store/shopping/product-listing';
-import { loadProductPrices } from 'ish-core/store/shopping/product-prices';
 import { HttpStatusCodeService } from 'ish-core/utils/http-status-code/http-status-code.service';
 import {
   delayUntil,
@@ -110,16 +109,6 @@ export class ProductsEffects {
     )
   );
 
-  loadProductPricesAfterProductSuccess$ = createEffect(() =>
-    this.actions$.pipe(
-      ofType(loadProductSuccess),
-      mapToPayloadProperty('product'),
-      mapToProperty('sku'),
-      whenTruthy(),
-      map(sku => loadProductPrices({ skus: [sku] }))
-    )
-  );
-
   /**
    * retrieve products for category incremental respecting paging
    */

src/app/core/store/shopping/shopping-store.spec.ts

@@ -316,10 +316,6 @@ describe('Shopping Store', () => {
             sortableAttributes: []
           [Filter API] Load Filter Success:
             filterNavigation: {}
-          [Product Price Internal] Load Product Prices:
-            skus: ["P2"]
-          [Products API] Load Product Prices Success:
-            prices: []
         `);
       }));
 
@@ -338,11 +334,7 @@ describe('Shopping Store', () => {
               sku: "P2"
             [Products API] Load Product Success:
               product: {"sku":"P2","name":"nP2"}
-            [Product Price Internal] Load Product Prices:
-              skus: ["P2"]
             @ngrx/router-store/navigated: /product/P2
-            [Products API] Load Product Prices Success:
-              prices: []
           `);
         }));
       });
@@ -467,12 +459,6 @@ describe('Shopping Store', () => {
           sortableAttributes: []
         [Filter API] Load Filter Success:
           filterNavigation: {}
-        [Product Price Internal] Load Product Prices:
-          skus: ["P1"]
-        [Product Price Internal] Load Product Prices:
-          skus: ["P2"]
-        [Products API] Load Product Prices Success:
-          prices: []
       `);
     }));
 
@@ -491,11 +477,7 @@ describe('Shopping Store', () => {
             sku: "P1"
           [Products API] Load Product Success:
             product: {"sku":"P1","name":"nP1"}
-          [Product Price Internal] Load Product Prices:
-            skus: ["P1"]
           @ngrx/router-store/navigated: /category/A.123.456/product/P1
-          [Products API] Load Product Prices Success:
-            prices: []
         `);
       }));
 
@@ -562,10 +544,6 @@ describe('Shopping Store', () => {
             sortableAttributes: []
           [Filter API] Load Filter Success:
             filterNavigation: {}
-          [Product Price Internal] Load Product Prices:
-            skus: ["P2"]
-          [Products API] Load Product Prices Success:
-            prices: []
         `);
       }));
 
@@ -606,17 +584,11 @@ describe('Shopping Store', () => {
               sortableAttributes: []
             [Filter API] Load Filter Success:
               filterNavigation: {}
-            [Product Price Internal] Load Product Prices:
-              skus: ["P1"]
-            [Product Price Internal] Load Product Prices:
-              skus: ["P2"]
             @ngrx/router-store/navigated: /category/A.123.456
             [Product Listing] Load More Products:
               id: {"type":"category","value":"A.123.456"}
             [Viewconf Internal] Set Breadcrumb Data:
               breadcrumbData: [{"text":"nA","link":"/nA-catA"},{"text":"nA123","link":"/nA...
-            [Products API] Load Product Prices Success:
-              prices: []
           `);
         }));
       });
@@ -685,11 +657,7 @@ describe('Shopping Store', () => {
           sku: "P1"
         [Products API] Load Product Success:
           product: {"sku":"P1","name":"nP1"}
-        [Product Price Internal] Load Product Prices:
-          skus: ["P1"]
         @ngrx/router-store/navigated: /category/A.123.456/product/P1
-        [Products API] Load Product Prices Success:
-          prices: []
       `);
     }));
 
@@ -741,17 +709,11 @@ describe('Shopping Store', () => {
             sortableAttributes: []
           [Filter API] Load Filter Success:
             filterNavigation: {}
-          [Product Price Internal] Load Product Prices:
-            skus: ["P1"]
-          [Product Price Internal] Load Product Prices:
-            skus: ["P2"]
           @ngrx/router-store/navigated: /category/A.123.456
           [Product Listing] Load More Products:
             id: {"type":"category","value":"A.123.456"}
           [Viewconf Internal] Set Breadcrumb Data:
             breadcrumbData: [{"text":"nA","link":"/nA-catA"},{"text":"nA123","link":"/nA...
-          [Products API] Load Product Prices Success:
-            prices: []
         `);
       }));
     });
@@ -809,11 +771,7 @@ describe('Shopping Store', () => {
           sku: "P1"
         [Products API] Load Product Success:
           product: {"sku":"P1","name":"nP1"}
-        [Product Price Internal] Load Product Prices:
-          skus: ["P1"]
         @ngrx/router-store/navigated: /product/P1
-        [Products API] Load Product Prices Success:
-          prices: []
       `);
     }));
 
@@ -961,10 +919,6 @@ describe('Shopping Store', () => {
           sortableAttributes: []
         [Filter API] Load Filter Success:
           filterNavigation: {}
-        [Product Price Internal] Load Product Prices:
-          skus: ["P2"]
-        [Products API] Load Product Prices Success:
-          prices: []
       `);
     }));
   });

src/environments/environment.model.ts

@@ -1,5 +1,6 @@
 import { Auth0Config } from 'ish-core/identity-provider/auth0.identity-provider';
 import { CookieConsentOptions } from 'ish-core/models/cookies/cookies.model';
+import { PriceUpdateType } from 'ish-core/models/price/price.model';
 import { DeviceType, ViewType } from 'ish-core/models/viewtype/viewtype.types';
 import { DataRetentionPolicy } from 'ish-core/utils/meta-reducers';
 import { MultiSiteLocaleMap } from 'ish-core/utils/multi-site/multi-site.service';
@@ -113,6 +114,12 @@ export interface Environment {
 
   // enable and configure data persistence for specific stores (compare, recently, tacton)
   dataRetention: DataRetentionPolicy;
+
+  /** Price update mechanism:
+   * - 'always': fetch fresh price information all the time
+   * - 'stable': only fetch prices once per application lifetime
+   */
+  priceUpdate: PriceUpdateType;
 }
 
 export const ENVIRONMENT_DEFAULTS: Omit<Environment, 'icmChannel'> = {
@@ -171,4 +178,5 @@ export const ENVIRONMENT_DEFAULTS: Omit<Environment, 'icmChannel'> = {
     recently: 60 * 24 * 7, // 1 week
     tacton: 'forever',
   },
+  priceUpdate: 'always',
 };