feat(core): Pass RequestContext to OrderMergeStrategy functions

BREAKING CHANGE: The OrderMergeStrategy `merge()` function signature has changed: the first argument is now the RequestContext of the current request.
vendure-ecommerce · Oct 27, 2020 · eae71f0 · eae71f0
1 parent a4d4311
commit eae71f0
Show file tree

Hide file tree

Showing 12 changed files with 55 additions and 39 deletions.
diff --git a/packages/core/src/config/order/merge-orders-strategy.spec.ts b/packages/core/src/config/order/merge-orders-strategy.spec.ts
@@ -1,16 +1,18 @@
+import { RequestContext } from '../../api/common/request-context';
 import { Order } from '../../entity/order/order.entity';
 import { createOrderFromLines, parseLines } from '../../testing/order-test-utils';
 
 import { MergeOrdersStrategy } from './merge-orders-strategy';
 
 describe('MergeOrdersStrategy', () => {
     const strategy = new MergeOrdersStrategy();
+    const ctx = RequestContext.empty();
 
     it('both orders empty', () => {
         const guestOrder = new Order({ lines: [] });
         const existingOrder = new Order({ lines: [] });
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(result).toEqual([]);
     });
@@ -20,7 +22,7 @@ describe('MergeOrdersStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = new Order({ lines: [] });
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(guestLines);
     });
@@ -30,7 +32,7 @@ describe('MergeOrdersStrategy', () => {
         const guestOrder = new Order({ lines: [] });
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(existingLines);
     });
@@ -48,7 +50,7 @@ describe('MergeOrdersStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual([
             { lineId: 21, quantity: 2, productVariantId: 201 },
@@ -72,7 +74,7 @@ describe('MergeOrdersStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual([
             { lineId: 22, quantity: 1, productVariantId: 202 },
@@ -88,7 +90,7 @@ describe('MergeOrdersStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(result).not.toBe(guestOrder.lines);
         expect(result).not.toBe(existingOrder.lines);

diff --git a/packages/core/src/config/order/merge-orders-strategy.ts b/packages/core/src/config/order/merge-orders-strategy.ts
@@ -1,3 +1,4 @@
+import { RequestContext } from '../../api/common/request-context';
 import { OrderLine } from '../../entity/order-line/order-line.entity';
 import { Order } from '../../entity/order/order.entity';
 
@@ -12,7 +13,7 @@ import { OrderMergeStrategy } from './order-merge-strategy';
  * @docsPage Merge Strategies
  */
 export class MergeOrdersStrategy implements OrderMergeStrategy {
-    merge(guestOrder: Order, existingOrder: Order): OrderLine[] {
+    merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order): OrderLine[] {
         const mergedLines = existingOrder.lines.slice();
         const guestLines = guestOrder.lines.slice();
         for (const guestLine of guestLines.reverse()) {
@@ -25,6 +26,6 @@ export class MergeOrdersStrategy implements OrderMergeStrategy {
     }
 
     private findCorrespondingLine(existingOrder: Order, guestLine: OrderLine): OrderLine | undefined {
-        return existingOrder.lines.find((line) => line.productVariant.id === guestLine.productVariant.id);
+        return existingOrder.lines.find(line => line.productVariant.id === guestLine.productVariant.id);
     }
 }
diff --git a/packages/core/src/config/order/order-merge-strategy.ts b/packages/core/src/config/order/order-merge-strategy.ts
@@ -1,3 +1,4 @@
+import { RequestContext } from '../../api/common/request-context';
 import { InjectableStrategy } from '../../common/types/injectable-strategy';
 import { OrderLine } from '../../entity/order-line/order-line.entity';
 import { Order } from '../../entity/order/order.entity';
@@ -18,5 +19,5 @@ export interface OrderMergeStrategy extends InjectableStrategy {
      * Merges the lines of the guest Order with those of the existing Order which is associated
      * with the active customer.
      */
-    merge(guestOrder: Order, existingOrder: Order): OrderLine[];
+    merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order): OrderLine[];
 }
diff --git a/packages/core/src/config/order/use-existing-strategy.spec.ts b/packages/core/src/config/order/use-existing-strategy.spec.ts
@@ -1,16 +1,18 @@
+import { RequestContext } from '../../api/common/request-context';
 import { Order } from '../../entity/order/order.entity';
 import { createOrderFromLines, parseLines } from '../../testing/order-test-utils';
 
 import { UseExistingStrategy } from './use-existing-strategy';
 
 describe('UseExistingStrategy', () => {
     const strategy = new UseExistingStrategy();
+    const ctx = RequestContext.empty();
 
     it('both orders empty', () => {
         const guestOrder = new Order({ lines: [] });
         const existingOrder = new Order({ lines: [] });
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(result).toEqual([]);
     });
@@ -20,7 +22,7 @@ describe('UseExistingStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = new Order({ lines: [] });
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual([]);
     });
@@ -30,7 +32,7 @@ describe('UseExistingStrategy', () => {
         const guestOrder = new Order({ lines: [] });
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(existingLines);
     });
@@ -48,7 +50,7 @@ describe('UseExistingStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(existingLines);
     });
@@ -66,7 +68,7 @@ describe('UseExistingStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(existingLines);
     });
@@ -77,7 +79,7 @@ describe('UseExistingStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(result).not.toBe(guestOrder.lines);
         expect(result).not.toBe(existingOrder.lines);

diff --git a/packages/core/src/config/order/use-existing-strategy.ts b/packages/core/src/config/order/use-existing-strategy.ts
@@ -1,3 +1,4 @@
+import { RequestContext } from '../../api/common/request-context';
 import { OrderLine } from '../../entity/order-line/order-line.entity';
 import { Order } from '../../entity/order/order.entity';
 
@@ -11,7 +12,7 @@ import { OrderMergeStrategy } from './order-merge-strategy';
  * @docsPage Merge Strategies
  */
 export class UseExistingStrategy implements OrderMergeStrategy {
-    merge(guestOrder: Order, existingOrder: Order): OrderLine[] {
+    merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order): OrderLine[] {
         return existingOrder.lines.slice();
     }
 }
diff --git a/packages/core/src/config/order/use-guest-if-existing-empty-strategy.spec.ts b/packages/core/src/config/order/use-guest-if-existing-empty-strategy.spec.ts
@@ -1,16 +1,18 @@
+import { RequestContext } from '../../api/common/request-context';
 import { Order } from '../../entity/order/order.entity';
 import { createOrderFromLines, parseLines } from '../../testing/order-test-utils';
 
 import { UseGuestIfExistingEmptyStrategy } from './use-guest-if-existing-empty-strategy';
 
 describe('UseGuestIfExistingEmptyStrategy', () => {
     const strategy = new UseGuestIfExistingEmptyStrategy();
+    const ctx = RequestContext.empty();
 
     it('both orders empty', () => {
         const guestOrder = new Order({ lines: [] });
         const existingOrder = new Order({ lines: [] });
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(result).toEqual([]);
     });
@@ -20,7 +22,7 @@ describe('UseGuestIfExistingEmptyStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = new Order({ lines: [] });
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(guestLines);
     });
@@ -30,7 +32,7 @@ describe('UseGuestIfExistingEmptyStrategy', () => {
         const guestOrder = new Order({ lines: [] });
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(existingLines);
     });
@@ -48,7 +50,7 @@ describe('UseGuestIfExistingEmptyStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(existingLines);
     });
@@ -66,7 +68,7 @@ describe('UseGuestIfExistingEmptyStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(existingLines);
     });
@@ -77,7 +79,7 @@ describe('UseGuestIfExistingEmptyStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(result).not.toBe(guestOrder.lines);
         expect(result).not.toBe(existingOrder.lines);

diff --git a/packages/core/src/config/order/use-guest-if-existing-empty-strategy.ts b/packages/core/src/config/order/use-guest-if-existing-empty-strategy.ts
@@ -1,3 +1,4 @@
+import { RequestContext } from '../../api/common/request-context';
 import { OrderLine } from '../../entity/order-line/order-line.entity';
 import { Order } from '../../entity/order/order.entity';
 
@@ -11,7 +12,7 @@ import { OrderMergeStrategy } from './order-merge-strategy';
  * @docsPage Merge Strategies
  */
 export class UseGuestIfExistingEmptyStrategy implements OrderMergeStrategy {
-    merge(guestOrder: Order, existingOrder: Order): OrderLine[] {
+    merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order): OrderLine[] {
         return existingOrder.lines.length ? existingOrder.lines.slice() : guestOrder.lines.slice();
     }
 }
diff --git a/packages/core/src/config/order/use-guest-strategy.spec.ts b/packages/core/src/config/order/use-guest-strategy.spec.ts
@@ -1,16 +1,18 @@
+import { RequestContext } from '../../api/common/request-context';
 import { Order } from '../../entity/order/order.entity';
 import { createOrderFromLines, parseLines } from '../../testing/order-test-utils';
 
 import { UseGuestStrategy } from './use-guest-strategy';
 
 describe('UseGuestStrategy', () => {
     const strategy = new UseGuestStrategy();
+    const ctx = RequestContext.empty();
 
     it('both orders empty', () => {
         const guestOrder = new Order({ lines: [] });
         const existingOrder = new Order({ lines: [] });
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(result).toEqual([]);
     });
@@ -20,7 +22,7 @@ describe('UseGuestStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = new Order({ lines: [] });
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(guestLines);
     });
@@ -30,7 +32,7 @@ describe('UseGuestStrategy', () => {
         const guestOrder = new Order({ lines: [] });
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual([]);
     });
@@ -48,7 +50,7 @@ describe('UseGuestStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(guestLines);
     });
@@ -66,7 +68,7 @@ describe('UseGuestStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(parseLines(result)).toEqual(guestLines);
     });
@@ -77,7 +79,7 @@ describe('UseGuestStrategy', () => {
         const guestOrder = createOrderFromLines(guestLines);
         const existingOrder = createOrderFromLines(existingLines);
 
-        const result = strategy.merge(guestOrder, existingOrder);
+        const result = strategy.merge(ctx, guestOrder, existingOrder);
 
         expect(result).not.toBe(guestOrder.lines);
         expect(result).not.toBe(existingOrder.lines);

diff --git a/packages/core/src/config/order/use-guest-strategy.ts b/packages/core/src/config/order/use-guest-strategy.ts
@@ -1,3 +1,4 @@
+import { RequestContext } from '../../api/common/request-context';
 import { OrderLine } from '../../entity/order-line/order-line.entity';
 import { Order } from '../../entity/order/order.entity';
 
@@ -11,7 +12,7 @@ import { OrderMergeStrategy } from './order-merge-strategy';
  * @docsPage Merge Strategies
  */
 export class UseGuestStrategy implements OrderMergeStrategy {
-    merge(guestOrder: Order, existingOrder: Order): OrderLine[] {
+    merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order): OrderLine[] {
         return guestOrder.lines.slice();
     }
 }