feat(core): Pass RequestContext to PriceCalculationStrategy

Closes #487 BREAKING CHANGE: The `PriceCalculationStrategy.calculateUnitPrice()` function signature has changed: the first argument is now the RequestContext of the current request.
vendure-ecommerce · Oct 27, 2020 · 8a58325 · 8a58325
1 parent 9c2257d
commit 8a58325
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/packages/core/e2e/fixtures/test-price-calculation-strategy.ts b/packages/core/e2e/fixtures/test-price-calculation-strategy.ts
@@ -1,10 +1,11 @@
-import { CalculatedPrice, PriceCalculationStrategy, ProductVariant } from '@vendure/core';
+import { CalculatedPrice, PriceCalculationStrategy, ProductVariant, RequestContext } from '@vendure/core';
 
 /**
  * Adds $5 for items with gift wrapping.
  */
 export class TestPriceCalculationStrategy implements PriceCalculationStrategy {
     calculateUnitPrice(
+        ctx: RequestContext,
         productVariant: ProductVariant,
         orderLineCustomFields: { [p: string]: any },
     ): CalculatedPrice | Promise<CalculatedPrice> {

diff --git a/packages/core/src/config/order/default-price-calculation-strategy.ts b/packages/core/src/config/order/default-price-calculation-strategy.ts
@@ -1,3 +1,4 @@
+import { RequestContext } from '../../api/common/request-context';
 import { ProductVariant } from '../../entity/product-variant/product-variant.entity';
 
 import { CalculatedPrice, PriceCalculationStrategy } from './price-calculation-strategy';
@@ -10,7 +11,10 @@ import { CalculatedPrice, PriceCalculationStrategy } from './price-calculation-s
  * @docsCategory orders
  */
 export class DefaultPriceCalculationStrategy implements PriceCalculationStrategy {
-    calculateUnitPrice(productVariant: ProductVariant): CalculatedPrice | Promise<CalculatedPrice> {
+    calculateUnitPrice(
+        ctx: RequestContext,
+        productVariant: ProductVariant,
+    ): CalculatedPrice | Promise<CalculatedPrice> {
         return productVariant;
     }
 }
diff --git a/packages/core/src/config/order/price-calculation-strategy.ts b/packages/core/src/config/order/price-calculation-strategy.ts
@@ -1,3 +1,4 @@
+import { RequestContext } from '../../api/common/request-context';
 import { InjectableStrategy } from '../../common/types/injectable-strategy';
 import { ProductVariant } from '../../entity/product-variant/product-variant.entity';
 
@@ -54,6 +55,7 @@ export interface PriceCalculationStrategy extends InjectableStrategy {
      * the price for a single unit.
      */
     calculateUnitPrice(
+        ctx: RequestContext,
         productVariant: ProductVariant,
         orderLineCustomFields: { [key: string]: any },
     ): CalculatedPrice | Promise<CalculatedPrice>;

diff --git a/packages/core/src/service/services/order.service.ts b/packages/core/src/service/services/order.service.ts
@@ -378,6 +378,7 @@ export class OrderService {
                 }
                 const productVariant = orderLine.productVariant;
                 const calculatedPrice = await priceCalculationStrategy.calculateUnitPrice(
+                    ctx,
                     productVariant,
                     orderLine.customFields || {},
                 );