Simplified getAndUpdate and add methods handling

oskardudycz · oskardudycz · commit 52ac6c58179a · 2022-11-04T08:11:25.000+01:00
Removed `Current` from the shopping cart methods
diff --git a/samples/optimisticConcurrency/src/core/eventStore/appending/add.ts b/samples/optimisticConcurrency/src/core/eventStore/appending/add.ts
@@ -1,8 +1,9 @@
 import { Event } from '../../events';
-import { EventStoreDBClient, NO_STREAM } from '@eventstore/db-client';
+import { NO_STREAM } from '@eventstore/db-client';
 import { Result } from '../../primitives';
 import { FAILED_TO_APPEND_EVENT } from '.';
 import { AppendResult, appendToStream } from './appendToStream';
+import { getEventStore } from '..';
 
 export async function add<
   Command,
@@ -11,7 +12,6 @@ export async function add<
   STORE_ERROR = never
 >(
   handle: (command: Command) => Result<StreamEvent, HANDLE_ERROR>,
-  eventStore: EventStoreDBClient,
   streamName: string,
   command: Command
 ): Promise<
@@ -23,7 +23,7 @@ export async function add<
 
   const newEvent = handleResult.value;
 
-  return appendToStream(eventStore, streamName, [newEvent], {
+  return appendToStream(getEventStore(), streamName, [newEvent], {
     expectedRevision: NO_STREAM,
   });
 }
diff --git a/samples/optimisticConcurrency/src/core/eventStore/appending/getAndUpdate.ts b/samples/optimisticConcurrency/src/core/eventStore/appending/getAndUpdate.ts
@@ -1,10 +1,10 @@
-import { EventStoreDBClient } from '@eventstore/db-client';
 import { Event, StreamEvent } from '../../events';
 import { Command } from '../../commands';
 import { readFromStream, STREAM_NOT_FOUND } from '../reading';
 import { appendToStream } from '../appending';
 import { Result } from '../../primitives';
 import { AppendResult, FAILED_TO_APPEND_EVENT } from '.';
+import { getEventStore } from '..';
 
 export async function getAndUpdate<
   CommandType extends Command,
@@ -15,12 +15,13 @@ export async function getAndUpdate<
     currentEvents: StreamEvent<StreamEventType>[],
     command: CommandType
   ) => Result<StreamEventType, HANDLE_ERROR>,
-  eventStore: EventStoreDBClient,
   streamName: string,
   command: CommandType
 ): Promise<
   Result<AppendResult, STREAM_NOT_FOUND | FAILED_TO_APPEND_EVENT | HANDLE_ERROR>
 > {
+  const eventStore = getEventStore();
+
   const result = await readFromStream<StreamEventType>(eventStore, streamName);
 
   if (result.isError) return result;
diff --git a/samples/optimisticConcurrency/src/core/http/requests/index.ts b/samples/optimisticConcurrency/src/core/http/requests/index.ts
@@ -1,10 +1,11 @@
 import { Request } from 'express';
 import { failure, Result, success } from '../../primitives';
 
-export type WeakETag = string;
+export type WeakETag = `W/${string}`;
 export type ETag = WeakETag | string;
 
 export const WeakETagRegex = /W\/"(\d+.*)"/;
+
 export type WRONG_WEAK_ETAG_FORMAT = 'WRONG_WEAK_ETAG_FORMAT';
 export type MISSING_IF_MATCH_HEADER = 'MISSING_IF_MATCH_HEADER';
 
@@ -24,7 +25,7 @@ export function toWeakETag(value: any): WeakETag {
 
 export function getETagFromIfMatch(
   request: Request
-): Result<WeakETag, MISSING_IF_MATCH_HEADER> {
+): Result<ETag, MISSING_IF_MATCH_HEADER> {
   const etag = request.headers['if-match'];
 
   if (etag === undefined) {
@@ -33,9 +34,9 @@ export function getETagFromIfMatch(
   return success(<ETag>etag);
 }
 
-export function getWeakETagFromIfMatch(
+export function getWeakETagValueFromIfMatch(
   request: Request
-): Result<WeakETag, WRONG_WEAK_ETAG_FORMAT | MISSING_IF_MATCH_HEADER> {
+): Result<string, WRONG_WEAK_ETAG_FORMAT | MISSING_IF_MATCH_HEADER> {
   const etag = getETagFromIfMatch(request);
 
   if (etag.isError) return etag;
diff --git a/samples/optimisticConcurrency/src/getSubscription.ts b/samples/optimisticConcurrency/src/getSubscription.ts
@@ -1,8 +1,8 @@
 import { getEventStore } from '#core/eventStore';
 import { getSubscriptionToAllWithESDBCheckpointing } from '#core/eventStore/subscribing';
-import { projectToCurrentShoppingCartDetails } from './shoppingCarts/gettingById/projection';
+import { projectToShoppingCartDetails } from './shoppingCarts/gettingById/projection';
 
 export const getSubscription = () =>
   getSubscriptionToAllWithESDBCheckpointing(getEventStore(), [
-    projectToCurrentShoppingCartDetails,
+    projectToShoppingCartDetails,
   ]);
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/addingProductItem/handler.ts b/samples/optimisticConcurrency/src/shoppingCarts/addingProductItem/handler.ts
@@ -20,7 +20,7 @@ export type AddProductItemToShoppingCart = Command<
   }
 >;
 
-export function handleAddingProductItemToShoppingCart(
+export function addProductItemToShoppingCart(
   events: StreamEvent<ShoppingCartEvent>[],
   command: AddProductItemToShoppingCart
 ): Result<ProductItemAddedToShoppingCart, SHOPPING_CARD_CLOSED> {
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/addingProductItem/route.ts b/samples/optimisticConcurrency/src/shoppingCarts/addingProductItem/route.ts
@@ -1,25 +1,24 @@
 import { NextFunction, Request, Response, Router } from 'express';
 import { isCommand } from '#core/commands';
-import { handleAddingProductItemToShoppingCart } from './handler';
+import { addProductItemToShoppingCart } from './handler';
 import { getShoppingCartStreamName } from '../shoppingCart';
 import {
   isNotEmptyString,
   isPositiveNumber,
   ValidationError,
 } from '#core/validation';
 import {
-  getWeakETagFromIfMatch,
+  getWeakETagValueFromIfMatch,
   toWeakETag,
   WRONG_ETAG,
 } from '#core/http/requests';
 import { AddProductItemToShoppingCart } from '.';
 import { getAndUpdate } from '#core/eventStore/appending';
-import { getEventStore } from '#core/eventStore';
 import { assertUnreachable } from '#core/primitives';
 
 export const route = (router: Router) =>
   router.post(
-    '/clients/:clientId/shopping-carts/:shoppingCartId',
+    '/clients/:clientId/shopping-carts/:shoppingCartId/product-items',
     async function (request: Request, response: Response, next: NextFunction) {
       try {
         const command = mapRequestToCommand(request);
@@ -33,8 +32,7 @@ export const route = (router: Router) =>
         );
 
         const result = await getAndUpdate(
-          handleAddingProductItemToShoppingCart,
-          getEventStore(),
+          addProductItemToShoppingCart,
           streamName,
           command
         );
@@ -75,7 +73,7 @@ function mapRequestToCommand(
     return 'INVALID_PRODUCT_ITEM_QUANTITY';
   }
 
-  const expectedRevision = getWeakETagFromIfMatch(request);
+  const expectedRevision = getWeakETagValueFromIfMatch(request);
 
   if (expectedRevision.isError) {
     return expectedRevision.error;
@@ -84,9 +82,9 @@ function mapRequestToCommand(
   return {
     type: 'add-product-item-to-shopping-cart',
     data: {
-      shoppingCartId: request.body.shoppingCartId,
+      shoppingCartId: request.params.shoppingCartId,
       productItem: {
-        productId: request.params.productId,
+        productId: request.body.productId,
         quantity: request.body.quantity,
       },
     },
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/confirming/handler.ts b/samples/optimisticConcurrency/src/shoppingCarts/confirming/handler.ts
@@ -18,7 +18,7 @@ export type ConfirmShoppingCart = Command<
   }
 >;
 
-export function handleConfirmShoppingCart(
+export function confirmShoppingCart(
   events: StreamEvent<ShoppingCartEvent>[],
   command: ConfirmShoppingCart
 ): Result<ShoppingCartConfirmed, SHOPPING_CARD_CLOSED> {
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/confirming/route.ts b/samples/optimisticConcurrency/src/shoppingCarts/confirming/route.ts
@@ -1,20 +1,19 @@
 import { NextFunction, Request, Response, Router } from 'express';
 import { isCommand } from '#core/commands';
-import { handleConfirmShoppingCart } from './handler';
+import { confirmShoppingCart } from './handler';
 import { getShoppingCartStreamName } from '../shoppingCart';
 import { isNotEmptyString, ValidationError } from '#core/validation';
 import {
-  getWeakETagFromIfMatch,
+  getWeakETagValueFromIfMatch,
   toWeakETag,
   WRONG_ETAG,
 } from '#core/http/requests';
 import { ConfirmShoppingCart } from '.';
 import { getAndUpdate } from '#core/eventStore/appending';
-import { getEventStore } from '#core/eventStore';
 import { assertUnreachable } from '#core/primitives';
 
 export const route = (router: Router) =>
-  router.post(
+  router.put(
     '/clients/:clientId/shopping-carts/:shoppingCartId',
     async function (request: Request, response: Response, next: NextFunction) {
       try {
@@ -29,8 +28,7 @@ export const route = (router: Router) =>
         );
 
         const result = await getAndUpdate(
-          handleConfirmShoppingCart,
-          getEventStore(),
+          confirmShoppingCart,
           streamName,
           command
         );
@@ -63,7 +61,7 @@ function mapRequestToCommand(
     return 'MISSING_SHOPPING_CARD_ID';
   }
 
-  const expectedRevision = getWeakETagFromIfMatch(request);
+  const expectedRevision = getWeakETagValueFromIfMatch(request);
 
   if (expectedRevision.isError) {
     return expectedRevision.error;
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/gettingById/index.ts b/samples/optimisticConcurrency/src/shoppingCarts/gettingById/index.ts
@@ -6,7 +6,7 @@ export type ProductItem = Readonly<{
   quantity: number;
 }>;
 
-export type CurrentShoppingCartDetails = Readonly<{
+export type ShoppingCartDetails = Readonly<{
   shoppingCartId: string;
   clientId: string;
   status: string;
@@ -16,4 +16,4 @@ export type CurrentShoppingCartDetails = Readonly<{
   revision: string;
 }>;
 
-export const CURRENT_SHOPPING_CART_DETAILS = 'currentShoppingCartDetails';
+export const SHOPPING_CART_DETAILS = 'shoppingCartDetails';
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/gettingById/projection.ts b/samples/optimisticConcurrency/src/shoppingCarts/gettingById/projection.ts
@@ -8,15 +8,15 @@ import {
   ShoppingCartOpened,
   ShoppingCartStatus,
 } from '..';
-import { CurrentShoppingCartDetails, CURRENT_SHOPPING_CART_DETAILS } from '.';
+import { ShoppingCartDetails, SHOPPING_CART_DETAILS } from '.';
 import { addProductItem, removeProductItem } from '../productItems';
 
 export async function projectShoppingCartOpened(
   event: ShoppingCartOpened,
   streamRevision: bigint
 ): Promise<Result<true>> {
-  await executeOnMongoDB<CurrentShoppingCartDetails>(
-    { collectionName: CURRENT_SHOPPING_CART_DETAILS },
+  await executeOnMongoDB<ShoppingCartDetails>(
+    { collectionName: SHOPPING_CART_DETAILS },
     async (collection) => {
       await collection.insertOne({
         shoppingCartId: event.data.shoppingCartId,
@@ -36,8 +36,8 @@ export async function projectProductItemAddedToShoppingCart(
   event: ProductItemAddedToShoppingCart,
   streamRevision: bigint
 ): Promise<Result<true>> {
-  await executeOnMongoDB<CurrentShoppingCartDetails>(
-    { collectionName: CURRENT_SHOPPING_CART_DETAILS },
+  await executeOnMongoDB<ShoppingCartDetails>(
+    { collectionName: SHOPPING_CART_DETAILS },
     async (collection) => {
       const { productItems } = (await collection.findOne(
         {
@@ -67,8 +67,8 @@ export async function projectProductItemRemovedFromShoppingCart(
   event: ProductItemRemovedFromShoppingCart,
   streamRevision: bigint
 ): Promise<Result<true>> {
-  await executeOnMongoDB<CurrentShoppingCartDetails>(
-    { collectionName: CURRENT_SHOPPING_CART_DETAILS },
+  await executeOnMongoDB<ShoppingCartDetails>(
+    { collectionName: SHOPPING_CART_DETAILS },
     async (collection) => {
       const { productItems } = (await collection.findOne(
         {
@@ -101,8 +101,8 @@ export async function projectShoppingCartConfirmed(
   event: ShoppingCartConfirmed,
   streamRevision: bigint
 ): Promise<Result<true>> {
-  await executeOnMongoDB<CurrentShoppingCartDetails>(
-    { collectionName: CURRENT_SHOPPING_CART_DETAILS },
+  await executeOnMongoDB<ShoppingCartDetails>(
+    { collectionName: SHOPPING_CART_DETAILS },
     async (collection) => {
       await collection.updateOne(
         {
@@ -122,16 +122,16 @@ export async function projectShoppingCartConfirmed(
   return success(true);
 }
 
-type CurrentShoppingCartDetailsEvent =
+type ShoppingCartDetailsEvent =
   | ShoppingCartOpened
   | ProductItemAddedToShoppingCart
   | ProductItemRemovedFromShoppingCart
   | ShoppingCartConfirmed;
 
 function isCashierShoppingCartDetailsEvent(
   event: Event
-): event is CurrentShoppingCartDetailsEvent {
-  const eventType = (event as CurrentShoppingCartDetailsEvent).type;
+): event is ShoppingCartDetailsEvent {
+  const eventType = (event as ShoppingCartDetailsEvent).type;
 
   return (
     eventType === 'shopping-cart-opened' ||
@@ -141,7 +141,7 @@ function isCashierShoppingCartDetailsEvent(
   );
 }
 
-export async function projectToCurrentShoppingCartDetails(
+export async function projectToShoppingCartDetails(
   streamEvent: StreamEvent
 ): Promise<Result<boolean>> {
   const { event, streamRevision } = streamEvent;
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/gettingById/queryHandler.ts b/samples/optimisticConcurrency/src/shoppingCarts/gettingById/queryHandler.ts
@@ -2,20 +2,20 @@ import { Query } from '#core/queries';
 import { failure, Result, success } from '#core/primitives';
 import { getSingleFromMongoDB } from '#core/mongoDB';
 import { SHIFT_DOES_NOT_EXIST } from '../shoppingCart';
-import { CurrentShoppingCartDetails, CURRENT_SHOPPING_CART_DETAILS } from '.';
+import { ShoppingCartDetails, SHOPPING_CART_DETAILS } from '.';
 
-export type GetCurrentShoppingCartDetails = Query<
-  'get-current-shopping-cart-details',
+export type GetShoppingCartDetails = Query<
+  'get-shopping-cart-details',
   {
     shoppingCartId: string;
   }
 >;
 
-export async function handleGetCurrentShoppingCartDetails(
-  query: GetCurrentShoppingCartDetails
-): Promise<Result<CurrentShoppingCartDetails, SHIFT_DOES_NOT_EXIST>> {
-  const result = await getSingleFromMongoDB<CurrentShoppingCartDetails>(
-    CURRENT_SHOPPING_CART_DETAILS,
+export async function getShoppingCartDetails(
+  query: GetShoppingCartDetails
+): Promise<Result<ShoppingCartDetails, SHIFT_DOES_NOT_EXIST>> {
+  const result = await getSingleFromMongoDB<ShoppingCartDetails>(
+    SHOPPING_CART_DETAILS,
     (collection) =>
       collection.findOne({
         shoppingCartId: query.data.shoppingCartId,
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/gettingById/route.ts b/samples/optimisticConcurrency/src/shoppingCarts/gettingById/route.ts
@@ -1,10 +1,7 @@
 import { NextFunction, Request, Response, Router } from 'express';
 import { isQuery } from '#core/queries';
 import { isNotEmptyString, ValidationError } from '#core/validation';
-import {
-  GetCurrentShoppingCartDetails,
-  handleGetCurrentShoppingCartDetails,
-} from './queryHandler';
+import { GetShoppingCartDetails, getShoppingCartDetails } from './queryHandler';
 import { toWeakETag } from '#core/http/requests';
 import { assertUnreachable } from '#core/primitives';
 
@@ -19,7 +16,7 @@ export const route = (router: Router) =>
           return next({ status: 400, message: query });
         }
 
-        const result = await handleGetCurrentShoppingCartDetails(query);
+        const result = await getShoppingCartDetails(query);
 
         if (result.isError) {
           switch (result.error) {
@@ -28,7 +25,6 @@ export const route = (router: Router) =>
             default:
               assertUnreachable(result.error);
           }
-          return;
         }
 
         response.set('ETag', toWeakETag(result.value.revision));
@@ -41,13 +37,13 @@ export const route = (router: Router) =>
 
 function mapRequestToQuery(
   request: Request
-): GetCurrentShoppingCartDetails | ValidationError {
-  if (!isNotEmptyString(request.params.cashRegisterId)) {
+): GetShoppingCartDetails | ValidationError {
+  if (!isNotEmptyString(request.params.shoppingCartId)) {
     return 'MISSING_SHOPPING_CARD_ID';
   }
 
   return {
-    type: 'get-current-shopping-cart-details',
+    type: 'get-shopping-cart-details',
     data: {
       shoppingCartId: request.params.shoppingCartId,
     },
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/opening/handler.ts b/samples/optimisticConcurrency/src/shoppingCarts/opening/handler.ts
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/opening/route.ts b/samples/optimisticConcurrency/src/shoppingCarts/opening/route.ts
diff --git a/samples/optimisticConcurrency/src/shoppingCarts/removingProductItem/route.ts b/samples/optimisticConcurrency/src/shoppingCarts/removingProductItem/route.ts

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ export type AddProductItemToShoppingCart = Command<`
`20`	`20`	`}`
`21`	`21`	`>;`
`22`	`22`
`23`		`-export function handleAddingProductItemToShoppingCart(`
	`23`	`+export function addProductItemToShoppingCart(`
`24`	`24`	`events: StreamEvent<ShoppingCartEvent>[],`
`25`	`25`	`command: AddProductItemToShoppingCart`
`26`	`26`	`): Result<ProductItemAddedToShoppingCart, SHOPPING_CARD_CLOSED> {`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ export type ConfirmShoppingCart = Command<`
`18`	`18`	`}`
`19`	`19`	`>;`
`20`	`20`
`21`		`-export function handleConfirmShoppingCart(`
	`21`	`+export function confirmShoppingCart(`
`22`	`22`	`events: StreamEvent<ShoppingCartEvent>[],`
`23`	`23`	`command: ConfirmShoppingCart`
`24`	`24`	`): Result<ShoppingCartConfirmed, SHOPPING_CARD_CLOSED> {`