Adding controller for Rental from scratch.

Author: afronski

examples/01-from-crud-to-cqrs/step-00-crud/src/controllers/rental.ts

@@ -0,0 +1,78 @@
+import Router from 'express-promise-router';
+import KSUID from 'ksuid';
+import { Request, Response } from 'express';
+import { DI } from '../server';
+import { Rental } from '../model/Rental';
+import { RentalMapping } from '../mapping/RentalMapping';
+
+const router = Router();
+
+// Create.
+
+router.post('/for-user/:id/:bookId', async (req: Request<{ id: string, bookId: string }>, res: Response) => {
+ const id = req.params.id;
+ const bookId = req.params.bookId;
+ const payload = req.body;
+
+ RentalMapping.validateIdentifiers(id, bookId);
+ const mapping = RentalMapping.validateAndConstructFromPayload(payload);
+
+ const entity = Rental.fromMapping(KSUID.parse(id), KSUID.parse(bookId), mapping);
+
+ await DI.database.rentals.put(entity);
+
+ res.json(entity.toMapping());
+});
+
+// Read (All).
+
+router.get('/', async (req: Request, res: Response) => {
+ // TODO: Pagination.
+ const collection = await DI.database.rentals.query()
+ .partitionKey('type')
+ .eq(Rental.name)
+ .run();
+
+ res.json(collection.items.map((entity: Rental) => entity.toMapping()));
+});
+
+// Read (One).
+
+router.get('/for-user/:id/:bookId', async (req: Request<{ id: string, bookId: string }>, res: Response) => {
+ const id = req.params.id;
+ const bookId = req.params.bookId;
+ RentalMapping.validateIdentifiers(id, bookId);
+
+ const entity = await DI.database.rentals.get(Rental.getPrimaryKey(id, bookId));
+
+ res.json(entity.toMapping());
+});
+
+// Update.
+
+router.put('/for-user/:id/:bookId', async (req: Request<{ id: string, bookId: string }>, res: Response) => {
+ const userId = req.params.id;
+ const bookId = req.params.bookId;
+ const payload = req.body;
+ const mapping = RentalMapping.validateAndConstructFromPayload({ userId, bookId, ...payload });
+
+ const entity = Rental.fromCompleteMapping(mapping);
+ const primaryKey = Rental.getPrimaryKey(mapping.userId!, mapping.bookId!);
+ const updatedEntity = await DI.database.rentals.update(primaryKey, entity.toUpdateStructure());
+
+ res.json(updatedEntity.toMapping());
+});
+
+// Delete.
+
+router.delete('/for-user/:id/:bookId', async (req: Request<{ id: string, bookId: string }>, res: Response) => {
+ const id = req.params.id;
+ const bookId = req.params.bookId;
+ RentalMapping.validateIdentifiers(id, bookId);
+
+ await DI.database.rentals.delete(Rental.getPrimaryKey(id, bookId));
+
+ res.json(RentalMapping.emptyMapping(id, bookId));
+});
+
+export const RentalController = router;

examples/01-from-crud-to-cqrs/step-00-crud/src/mapping/RentalMapping.ts

@@ -0,0 +1,68 @@
+import { BaseMapping } from './base/BaseMapping';
+import { MappingValidationError } from './exceptions/MappingValidationError';
+import { Rental } from '../model/Rental';
+
+type RentalMappingAllowedFields = {
+ userId?: string;
+ bookId?: string;
+ name: string;
+ email: string;
+ status?: string;
+ comment?: string;
+}
+
+export class RentalMapping extends BaseMapping {
+ public readonly userId?: string;
+ public readonly bookId?: string;
+ public readonly name: string;
+ public readonly email: string;
+ public readonly status?: string;
+ public readonly comment?: string;
+
+ protected constructor(payload: RentalMappingAllowedFields) {
+ super();
+
+ this.userId = payload.userId;
+ this.bookId = payload.bookId;
+ this.name = payload.name;
+ this.email = payload.email;
+ this.status = payload.status;
+ this.comment = payload.comment;
+ }
+
+ static fromEntity(entity: Rental): RentalMapping {
+ return new RentalMapping({
+ userId: entity.resourceId,
+ bookId: entity.subResourceId,
+ name: entity.name,
+ email: entity.email,
+ status: entity.status,
+ comment: entity.comment
+ });
+ }
+
+ static fromPayload(payload: RentalMappingAllowedFields) {
+ return new RentalMapping(payload);
+ }
+
+ static validateAndConstructFromPayload(payload: RentalMappingAllowedFields) {
+ RentalMapping.validatePayload(payload);
+ return RentalMapping.fromPayload(payload);
+ }
+
+ static validatePayload(payload: RentalMappingAllowedFields) {
+ BaseMapping.validateIdentifiers(payload.userId, payload.bookId);
+
+ if (!payload.name) {
+ throw new MappingValidationError('For Rental, name is a required field that is a non-empty string');
+ }
+
+ if (!payload.email) {
+ throw new MappingValidationError('For Rental, email is a required field that is a non-empty string');
+ }
+ }
+
+ static emptyMapping(userId: string, bookId: string) {
+ return { userId, bookId };
+ }
+}

examples/01-from-crud-to-cqrs/step-00-crud/src/mapping/base/BaseMapping.ts

@@ -4,8 +4,9 @@ import { MappingValidationError } from '../exceptions/MappingValidationError';
 export abstract class BaseMapping {
  public id?: string;
 
- static emptyMapping(identifier: string) {
- return { id: identifier };
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
+ static emptyMapping(primaryIdentifier: string, secondaryIdentifier?: string): any {
+ return { id: primaryIdentifier };
  }
 
  static validateIdentifiers(primaryIdentifier?: string, secondaryIdentifier?: string) {

examples/01-from-crud-to-cqrs/step-00-crud/src/model/Rental.ts

@@ -1,15 +1,21 @@
 import attribute from 'dynamode/decorators';
+import KSUID from "ksuid";
 import { LibraryTable, LibraryTablePrimaryKey, LibraryTableProps } from './base/LibraryTable';
 import { User } from "./User";
+import { RentalMapping } from "../mapping/RentalMapping";
+import { IMappable } from "../mapping/interfaces/IMappable";
+import { IUpdateable } from "../mapping/interfaces/IUpdateable";
 
-type RentalProps = LibraryTableProps & {
+type RentalFields = {
  name: string;
  email: string;
  status: RentalStatus;
  comment: string;
 };
 
-export class Rental extends LibraryTable {
+type RentalProps = LibraryTableProps & RentalFields;
+
+export class Rental extends LibraryTable implements IMappable, IUpdateable {
  @attribute.partitionKey.string({ prefix: User.name }) // `User#${userId}`
  resourceId!: string;
 
@@ -37,6 +43,35 @@ export class Rental extends LibraryTable {
  this.comment = props.comment;
  }
 
+ toMapping(): RentalMapping {
+ return RentalMapping.fromEntity(this);
+ }
+
+ toUpdateStructure(): { set: RentalFields } {
+ return {
+ set: {
+ name: this.name,
+ email: this.email,
+ status: this.status,
+ comment: this.comment
+ }
+ };
+ }
+
+ static fromMapping(userId: KSUID, bookId: KSUID, mapping: RentalMapping): Rental {
+ return new Rental({
+ ...Rental.getPrimaryKey(userId.string, bookId.string),
+ name: mapping.name,
+ email: mapping.email,
+ status: RentalStatus[(mapping.status ?? RentalStatus.BORROWED) as keyof typeof RentalStatus],
+ comment: mapping.comment ?? ""
+ })
+ }
+
+ static fromCompleteMapping(mapping: RentalMapping): Rental {
+ return Rental.fromMapping(KSUID.parse(mapping.userId!), KSUID.parse(mapping.bookId!), mapping);
+ }
+
  static getPrimaryKey(userId: string, bookId: string): LibraryTablePrimaryKey {
  return {
  resourceId: userId,

examples/01-from-crud-to-cqrs/step-00-crud/src/server.ts

@@ -7,6 +7,7 @@ import logger from 'morgan';
 import { AuthorController } from './controllers/author';
 import { BookController } from './controllers/book';
 import { UserController } from './controllers/user';
+import { RentalController } from './controllers/rental';
 import { DatabaseProvider } from "./providers/DatabaseProvider";
 
 import * as settings from '../package.json';
@@ -34,6 +35,7 @@ export const init = (async () => {
 
  app.use('/author', AuthorController);
  app.use('/book', BookController);
+ app.use('/rental', RentalController);
  app.use('/user', UserController);
 
  app.use((req, res) => {

examples/01-from-crud-to-cqrs/step-00-crud/test/controllers/rental.test.ts

@@ -0,0 +1,108 @@
+import { RentalStatus } from "../../src/model/Rental";
+import { getAgent, getFakeBookId, getFakeUserWithId, start, stop } from '../helpers/common';
+
+describe('CRUD Controller: /rental', () => {
+ beforeAll(start);
+ afterAll(stop);
+
+ const agent = getAgent();
+
+ const user = getFakeUserWithId();
+ const bookId = getFakeBookId();
+
+ it('Verifying validation during creation', async () => {
+ await agent
+ .post('/rental/for-user/' + user.id + '/' + bookId)
+ .set('Content-Type', 'application/json')
+ .send({})
+ .then(res => {
+ expect(res.status).toBe(400);
+ });
+ });
+
+ it('Create', async () => {
+ await agent
+ .post('/rental/for-user/' + user.id + '/' + bookId)
+ .set('Content-Type', 'application/json')
+ .send(user)
+ .then(res => {
+ expect(res.status).toBe(200);
+ expect(res.body.userId).toBe(user.id);
+ expect(res.body.bookId).toBe(bookId);
+ expect(res.body.name).toBe(user.name);
+ expect(res.body.email).toBe(user.email);
+ expect(res.body.status).toBe(RentalStatus.BORROWED);
+ expect(res.body.comment).toBe("");
+ });
+ });
+
+ it('Read all', async () => {
+ await agent
+ .get('/rental')
+ .then(res => {
+ expect(res.status).toBe(200);
+ expect(res.body).toHaveLength(1);
+ expect(res.body[0].userId).toBe(user.id);
+ expect(res.body[0].bookId).toBe(bookId);
+ expect(res.body[0].name).toBe(user.name);
+ expect(res.body[0].email).toBe(user.email);
+ expect(res.body[0].status).toBe(RentalStatus.BORROWED);
+ expect(res.body[0].comment).toBe("");
+ });
+ });
+
+ it('Read', async () => {
+ await agent
+ .get('/rental/for-user/' + user.id + '/' + bookId)
+ .then(res => {
+ expect(res.status).toBe(200);
+ expect(res.body.userId).toBe(user.id);
+ expect(res.body.bookId).toBe(bookId);
+ expect(res.body.name).toBe(user.name);
+ expect(res.body.email).toBe(user.email);
+ expect(res.body.status).toBe(RentalStatus.BORROWED);
+ expect(res.body.comment).toBe("");
+ });
+ });
+
+ it('Update', async () => {
+ const rentalUpdate = {
+ name: 'Jane Doe',
+ email: 'jane@example.com',
+ status: 'RETURNED',
+ comment: 'This is a comment'
+ };
+
+ await agent
+ .put('/rental/for-user/' + user.id + '/' + bookId)
+ .send(rentalUpdate)
+ .then(res => {
+ expect(res.status).toBe(200);
+ expect(res.body.userId).toBe(user.id);
+ expect(res.body.bookId).toBe(bookId);
+ expect(res.body.name).toBe(rentalUpdate.name);
+ expect(res.body.email).toBe(rentalUpdate.email);
+ expect(res.body.status).toBe(RentalStatus.RETURNED);
+ expect(res.body.comment).toBe(rentalUpdate.comment);
+ });
+ });
+
+ it('Delete', async () => {
+ await agent
+ .delete('/rental/for-user/' + user.id + '/' + bookId)
+ .then(res => {
+ expect(res.status).toBe(200);
+ expect(res.body.userId).toBe(user.id);
+ expect(res.body.bookId).toBe(bookId);
+ });
+ });
+
+ it('Read all, but this time empty collection', async () => {
+ await agent
+ .get('/rental')
+ .then(res => {
+ expect(res.status).toBe(200);
+ expect(res.body).toHaveLength(0);
+ });
+ });
+});

examples/01-from-crud-to-cqrs/step-00-crud/test/helpers/common.ts

@@ -13,6 +13,18 @@ export const stop = async () => {
  DI.server.close();
 };
 
+const getKSUID = () => {
+ return KSUID.randomSync().string;
+}
+
+export const getFakeAuthorId = () => {
+ return getKSUID();
+}
+
+export const getFakeBookId = () => {
+ return getKSUID();
+}
+
 export const getAgent = () => request(app);
 
 export const getFakeAuthor = () => {
@@ -29,8 +41,13 @@ export const getFakeUser = () => {
  }
 };
 
-export const getFakeAuthorId = () => {
- return KSUID.randomSync().string;
+export const getFakeUserWithId = () => {
+ const fakeUser = getFakeUser();
+
+ return {
+ id: getKSUID(),
+ ...fakeUser
+ }
 }
 
 export const getFakeBook = () => {