Merge pull request #132 from jbrunton/refactor-message-types

refactor: message types

services/api/src/app/dispatcher/dispatcher.module.ts

@@ -1,4 +1,4 @@
-import { Dispatcher } from '@entities/message.entity';
+import { Dispatcher } from '@entities/messages';
 import { Module } from '@nestjs/common';
 import { EventEmitter } from 'stream';
 import { DispatcherService } from './dispatcher.service';

services/api/src/app/dispatcher/dispatcher.service.spec.ts

@@ -2,7 +2,7 @@ import { TestRoomsRepository } from '@fixtures/data/test.rooms.repository';
 import { DispatcherService } from './dispatcher.service';
 import { TestMessagesRepository } from '@fixtures/data/test.messages.repository';
 import { TestAuthService } from '@fixtures/auth/test-auth-service';
-import { DraftMessage, Message } from '@entities/message.entity';
+import { DraftMessage, SentMessage } from '@entities/messages';
 import { RoomFactory } from '@fixtures/messages/room.factory';
 import { UserFactory } from '@fixtures/messages/user.factory';
 import { MockProxy, mock } from 'jest-mock-extended';
@@ -53,7 +53,7 @@ describe('DispatcherService', () => {
 
       await dispatcher.send(draft);
 
-      const expectedMessage: Message = {
+      const expectedMessage: SentMessage = {
         id: `message:${now.getTime()}`,
         time: now.getTime(),
         ...draft,
@@ -74,7 +74,7 @@ describe('DispatcherService', () => {
 
       await dispatcher.send(draft);
 
-      const expectedMessage: Message = {
+      const expectedMessage: SentMessage = {
         id: `message:${now.getTime()}`,
         time: now.getTime(),
         ...draft,

services/api/src/app/dispatcher/dispatcher.service.ts

@@ -1,5 +1,5 @@
-import { Dispatcher, DraftMessage, isPrivate } from '@entities/message.entity';
-import { MessagesRepository } from '@entities/messages.repository';
+import { Dispatcher, DraftMessage, isPrivate } from '@entities/messages';
+import { MessagesRepository } from '@entities/messages';
 import { RoomsRepository } from '@entities/rooms.repository';
 import { User } from '@entities/user.entity';
 import { ConsoleLogger, Injectable } from '@nestjs/common';

services/api/src/app/messages/command.service.ts

@@ -4,7 +4,7 @@ import { Injectable } from '@nestjs/common';
 import { HelpCommandUseCase } from '@usecases/commands/help';
 import { RenameRoomUseCase } from '@usecases/rooms/rename';
 import { RenameUserUseCase } from '@usecases/users/rename';
-import { Dispatcher } from '@entities/message.entity';
+import { Dispatcher } from '@entities/messages';
 import { LoremCommandUseCase } from '@usecases/commands/lorem';
 import { ParseCommandUseCase } from '@usecases/commands/parse';
 

services/api/src/app/messages/messages.controller.spec.ts

@@ -10,7 +10,7 @@ import {
 } from '@fixtures/auth/FakeAuth';
 import { MessageFactory } from '@fixtures/messages/message.factory';
 import { UsersRepository } from '@entities/users.repository';
-import { MessagesRepository } from '@entities/messages.repository';
+import { MessagesRepository } from '@entities/messages';
 import { TestDataModule } from '@fixtures/data/test.data.module';
 import { TestUsersRepository } from '@fixtures/data/test.users.repository';
 import { TestMessagesRepository } from '@fixtures/data/test.messages.repository';

services/api/src/app/messages/messages.controller.ts

@@ -4,7 +4,7 @@ import { CreateMessageDto } from './dto/create-message.dto';
 import { Auth } from '@app/auth/auth.decorator';
 import { Identify } from '@app/auth/auth0/identify.decorator';
 import { User } from '@entities/user.entity';
-import { Dispatcher } from '@entities/message.entity';
+import { Dispatcher } from '@entities/messages';
 import { GetMessagesUseCase } from '@usecases/messages/get-messages';
 
 @Auth()

services/api/src/data/data.module.ts

@@ -1,6 +1,6 @@
 import { Global, Module } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
-import { MessagesRepository } from '@entities/messages.repository';
+import { MessagesRepository } from '@entities/messages';
 import databaseConfig from '@config/database.config';
 import { DynamoDBMessagesRepository } from './repositories/dynamodb.messages.repository';
 import { RoomsRepository } from '@entities/rooms.repository';

services/api/src/data/repositories/dynamodb.messages.repository.e2e-spec.ts

@@ -1,5 +1,5 @@
 import { DynamoDBMessagesRepository } from '@data/repositories/dynamodb.messages.repository';
-import { DraftMessage } from '@entities/message.entity';
+import { DraftMessage } from '@entities/messages';
 import { TestMessagesRepository } from '@fixtures/data/test.messages.repository';
 import { RoomFactory } from '@fixtures/messages/room.factory';
 import { UserFactory } from '@fixtures/messages/user.factory';

services/api/src/data/repositories/dynamodb.messages.repository.ts

@@ -1,5 +1,5 @@
-import { DraftMessage, Message } from '@entities/message.entity';
-import { MessagesRepository } from '@entities/messages.repository';
+import { DraftMessage, SentMessage } from '@entities/messages';
+import { MessagesRepository } from '@entities/messages';
 import { Injectable } from '@nestjs/common';
 import { pick } from 'rambda';
 import { DynamoDBAdapter } from '../adapters/dynamodb.adapter';
@@ -11,7 +11,7 @@ export class DynamoDBMessagesRepository extends MessagesRepository {
     super();
   }
 
-  override async saveMessage(params: DraftMessage): Promise<Message> {
+  override async saveMessage(params: DraftMessage): Promise<SentMessage> {
     const message = await this.adapter.Message.create(
       {
         ...params,
@@ -22,15 +22,15 @@ export class DynamoDBMessagesRepository extends MessagesRepository {
     return messageFromRecord(message);
   }
 
-  override async getMessagesForRoom(roomId: string): Promise<Message[]> {
+  override async getMessagesForRoom(roomId: string): Promise<SentMessage[]> {
     const messages = await this.adapter.Message.find(
       { Id: roomId },
       { hidden: true },
     );
     return messages.map(messageFromRecord);
   }
 
-  override async getAuthorHistory(authorId: string): Promise<Message[]> {
+  override async getAuthorHistory(authorId: string): Promise<SentMessage[]> {
     const messages = await this.adapter.Message.scan(
       {},
       {
@@ -45,7 +45,7 @@ export class DynamoDBMessagesRepository extends MessagesRepository {
   }
 }
 
-const messageFromRecord = (record: DbMessage): Message => ({
+const messageFromRecord = (record: DbMessage): SentMessage => ({
   id: record.Sort,
   ...pick(
     ['roomId', 'content', 'authorId', 'recipientId', 'time', 'updatedEntities'],

services/api/src/domain/entities/command.entity.ts

@@ -3,12 +3,3 @@ export class Command {
   roomId: string;
   canonicalInput: string;
 }
-
-export type ParsedCommand =
-  | { tag: 'help'; params: null }
-  | { tag: 'renameRoom'; params: { newName: string } }
-  | { tag: 'renameUser'; params: { newName: string } }
-  | {
-      tag: 'lorem';
-      params: { count: number; typeToken: 'words' | 'paragraphs' };
-    };

services/api/src/domain/entities/messages/index.ts

@@ -0,0 +1,3 @@
+export * from './message';
+export * from './system';
+export * from './messages.repository';

services/api/src/domain/entities/message.entity.ts → services/api/src/domain/entities/messages/message.ts

@@ -1,7 +1,7 @@
 import { Observable } from 'rxjs';
-import { User } from './user.entity';
+import { User } from '../user.entity';
 
-export type Message = {
+export type SentMessage = {
   id: string;
   time: number;
   content: string;
@@ -11,15 +11,15 @@ export type Message = {
   updatedEntities?: string[];
 };
 
-export type PrivateMessage = Message & {
+export type PrivateMessage = SentMessage & {
   recipientId: string;
 };
 
-export const isPrivate = (message: Message): message is PrivateMessage => {
+export const isPrivate = (message: SentMessage): message is PrivateMessage => {
   return (message as PrivateMessage).recipientId !== undefined;
 };
 
-export type DraftMessage = Omit<Message, 'id' | 'time'>;
+export type DraftMessage = Omit<SentMessage, 'id' | 'time'>;
 
 export abstract class Dispatcher {
   abstract subscribe(roomId: string, user: User): Promise<Observable<unknown>>;

services/api/src/domain/entities/messages/messages.repository.ts

@@ -0,0 +1,7 @@
+import { DraftMessage, SentMessage } from './message';
+
+export abstract class MessagesRepository {
+  abstract saveMessage(params: DraftMessage): Promise<SentMessage>;
+  abstract getMessagesForRoom(roomId: string): Promise<SentMessage[]>;
+  abstract getAuthorHistory(authorId: string): Promise<SentMessage[]>;
+}

services/api/src/domain/entities/messages/system.ts

@@ -0,0 +1,18 @@
+import { SentMessage, DraftMessage } from './message';
+
+export const systemUser = 'system';
+
+export const isSystemMessage = (message: SentMessage): boolean => {
+  return message.authorId === systemUser;
+};
+
+export const buildSystemMessage = ({
+  content,
+  roomId,
+}: Omit<DraftMessage, 'authorId'>) => {
+  return {
+    content,
+    roomId,
+    authorId: systemUser,
+  };
+};

services/api/src/domain/usecases/commands/help.spec.ts

@@ -1,6 +1,6 @@
 import { HelpCommandUseCase } from './help';
 import { MockProxy, mock } from 'jest-mock-extended';
-import { Dispatcher } from '@entities/message.entity';
+import { Dispatcher } from '@entities/messages';
 import { User } from '@entities/user.entity';
 import { UserFactory } from '@fixtures/messages/user.factory';
 import { RoomFactory } from '@fixtures/messages/room.factory';

services/api/src/domain/usecases/commands/help.ts

@@ -1,4 +1,4 @@
-import { Dispatcher } from '@entities/message.entity';
+import { Dispatcher } from '@entities/messages';
 import { User } from '@entities/user.entity';
 import { Injectable } from '@nestjs/common';
 import { parsers } from './parse/parsers';

services/api/src/domain/usecases/commands/lorem.spec.ts

@@ -1,6 +1,6 @@
 import { LoremCommandUseCase, LoremGenerator, LoremParams } from './lorem';
 import { MockProxy, mock } from 'jest-mock-extended';
-import { Dispatcher } from '@entities/message.entity';
+import { Dispatcher } from '@entities/messages';
 import { User } from '@entities/user.entity';
 import { RoomFactory } from '@fixtures/messages/room.factory';
 import { UserFactory } from '@fixtures/messages/user.factory';

services/api/src/domain/usecases/commands/lorem.ts

@@ -1,4 +1,4 @@
-import { Dispatcher, DraftMessage } from '@entities/message.entity';
+import { Dispatcher, DraftMessage } from '@entities/messages';
 import { User } from '@entities/user.entity';
 import { Injectable } from '@nestjs/common';
 

services/api/src/domain/usecases/commands/parse/command.parser.ts

@@ -1,8 +1,17 @@
-import { Command, ParsedCommand } from '@entities/command.entity';
+import { Command } from '@entities/command.entity';
 import { BadRequestException } from '@nestjs/common';
 import { equals } from 'rambda';
 import { z, ZodIssue, ZodType } from 'zod';
 
+export type ParsedCommand =
+  | { tag: 'help'; params: null }
+  | { tag: 'renameRoom'; params: { newName: string } }
+  | { tag: 'renameUser'; params: { newName: string } }
+  | {
+      tag: 'lorem';
+      params: { count: number; typeToken: 'words' | 'paragraphs' };
+    };
+
 export type ParseResult =
   | {
       match: true;

services/api/src/domain/usecases/commands/parse/index.ts

@@ -1,6 +1,7 @@
-import { Command, ParsedCommand } from '@entities/command.entity';
+import { Command } from '@entities/command.entity';
 import { BadRequestException, Injectable } from '@nestjs/common';
 import { parsers } from './parsers';
+import { ParsedCommand } from './command.parser';
 
 @Injectable()
 export class ParseCommandUseCase {

services/api/src/domain/usecases/commands/parse.spec.ts → services/api/src/domain/usecases/commands/parse/parse.spec.ts

@@ -1,6 +1,7 @@
-import { Command, ParsedCommand } from '@entities/command.entity';
+import { Command } from '@entities/command.entity';
 import { BadRequestException } from '@nestjs/common';
-import { ParseCommandUseCase } from './parse';
+import { ParseCommandUseCase } from '.';
+import { ParsedCommand } from './command.parser';
 
 describe('ParseCommandUseCase', () => {
   let parse: ParseCommandUseCase;
@@ -9,7 +10,7 @@ describe('ParseCommandUseCase', () => {
     parse = new ParseCommandUseCase();
   });
 
-  const expectCommand = (command: string) => {
+  const withMessage = (command: string) => {
     const tokens = command.slice(1).split(' ');
     const parsedCommand: Command = {
       roomId: 'my-room',
@@ -18,12 +19,12 @@ describe('ParseCommandUseCase', () => {
     };
     const parse = new ParseCommandUseCase();
     return {
-      toReturn: (expected: ParsedCommand) => {
+      expectCommand: (expected: ParsedCommand) => {
         const result = parse.exec(parsedCommand);
         expect(result).toEqual(expected);
       },
 
-      toErrorWith: (...expectedMessage: string[]) => {
+      expectError: (...expectedMessage: string[]) => {
         expect(() => parse.exec(parsedCommand)).toThrow(
           new BadRequestException(expectedMessage.join('\n')),
         );
@@ -33,14 +34,14 @@ describe('ParseCommandUseCase', () => {
 
   describe('/help', () => {
     it('parses the command', () => {
-      expectCommand('/help').toReturn({
+      withMessage('/help').expectCommand({
         tag: 'help',
         params: null,
       });
     });
 
     it('validates the number of arguments', () => {
-      expectCommand('/help me').toErrorWith(
+      withMessage('/help me').expectError(
         'Error in command `/help me`:',
         '* Received too many arguments. Expected: `/help`',
       );
@@ -49,7 +50,7 @@ describe('ParseCommandUseCase', () => {
 
   describe('/lorem', () => {
     it('parses valid commands', () => {
-      expectCommand('/lorem 3 words').toReturn({
+      withMessage('/lorem 3 words').expectCommand({
         tag: 'lorem',
         params: {
           count: 3,
@@ -59,22 +60,22 @@ describe('ParseCommandUseCase', () => {
     });
 
     it('validates the number of arguments', () => {
-      expectCommand('/lorem').toErrorWith(
+      withMessage('/lorem').expectError(
         'Error in command `/lorem`:',
         `* Received too few arguments. Expected: \`/lorem {count} {'words' | 'paragraphs'}\``,
       );
-      expectCommand('/lorem 3 words paragraphs').toErrorWith(
+      withMessage('/lorem 3 words paragraphs').expectError(
         'Error in command `/lorem 3 words paragraphs`:',
         `* Received too many arguments. Expected: \`/lorem {count} {'words' | 'paragraphs'}\``,
       );
     });
 
     it('validates the arguments', () => {
-      expectCommand('/lorem three words').toErrorWith(
+      withMessage('/lorem three words').expectError(
         'Error in command `/lorem three words`:',
         '* Argument 1 (`three`): Expected number, received nan',
       );
-      expectCommand('/lorem 3 chars').toErrorWith(
+      withMessage('/lorem 3 chars').expectError(
         'Error in command `/lorem 3 chars`:',
         `* Argument 2 (\`chars\`): Invalid enum value. Expected 'words' | 'paragraphs', received 'chars'`,
       );
@@ -83,7 +84,7 @@ describe('ParseCommandUseCase', () => {
 
   describe('/rename room', () => {
     it('parses valid commands', () => {
-      expectCommand('/rename room My Room').toReturn({
+      withMessage('/rename room My Room').expectCommand({
         tag: 'renameRoom',
         params: {
           newName: 'My Room',
@@ -92,7 +93,7 @@ describe('ParseCommandUseCase', () => {
     });
 
     it('validates the number of arguments', () => {
-      expectCommand('/rename room').toErrorWith(
+      withMessage('/rename room').expectError(
         'Error in command `/rename room`:',
         `* Received too few arguments. Expected: \`/rename room {name}\``,
       );
@@ -101,7 +102,7 @@ describe('ParseCommandUseCase', () => {
 
   describe('/rename user', () => {
     it('parses valid commands', () => {
-      expectCommand('/rename user My User').toReturn({
+      withMessage('/rename user My User').expectCommand({
         tag: 'renameUser',
         params: {
           newName: 'My User',
@@ -110,7 +111,7 @@ describe('ParseCommandUseCase', () => {
     });
 
     it('validates the number of arguments', () => {
-      expectCommand('/rename user').toErrorWith(
+      withMessage('/rename user').expectError(
         'Error in command `/rename user`:',
         `* Received too few arguments. Expected: \`/rename user {name}\``,
       );

services/api/src/domain/usecases/commands/parse/parsers/help.parser.ts

@@ -1,6 +1,5 @@
-import { ParsedCommand } from '@entities/command.entity';
 import { z } from 'zod';
-import { CommandParser } from '../command.parser';
+import { CommandParser, ParsedCommand } from '../command.parser';
 
 const schema = z.tuple([z.literal('help')]).transform<ParsedCommand>(() => ({
   tag: 'help',