Step 7: domain logic

src/application/reply-to-shout/reply-to-shout.test.ts

@@ -1,5 +1,6 @@
 import { beforeEach, describe, expect, it, vitest } from "vitest";
 
+import { MAX_NUM_SHOUTS_PER_DAY } from "@/domain/me";
 import { createMockFile } from "@/test/create-mock-file";
 
 import { ErrorMessages, replyToShout } from "./reply-to-shout";
@@ -50,7 +51,10 @@ describe("replyToShout", () => {
   });
 
   it("should return an error if the user has made too many shouts", async () => {
-    mockGetMe.mockResolvedValueOnce({ ...mockMe, numShoutsPastDay: 5 });
+    mockGetMe.mockResolvedValueOnce({
+      ...mockMe,
+      numShoutsPastDay: MAX_NUM_SHOUTS_PER_DAY,
+    });
 
     const result = await replyToShout(
       { recipientHandle, shoutId, message, files },

src/application/reply-to-shout/reply-to-shout.ts

@@ -1,5 +1,7 @@
 import { useCallback } from "react";
 
+import { hasExceededShoutLimit } from "@/domain/me";
+import { hasBlockedUser } from "@/domain/user";
 import MediaService from "@/infrastructure/media";
 import ShoutService from "@/infrastructure/shout";
 import UserService from "@/infrastructure/user";
@@ -33,15 +35,15 @@ export async function replyToShout(
   { getMe, getUser, saveImage, createReply, createShout }: typeof dependencies
 ) {
   const me = await getMe();
-  if (me.numShoutsPastDay >= 5) {
+  if (hasExceededShoutLimit(me)) {
     return { error: ErrorMessages.TooManyShouts };
   }
 
   const recipient = await getUser(recipientHandle);
   if (!recipient) {
     return { error: ErrorMessages.RecipientNotFound };
   }
-  if (recipient.blockedUserIds.includes(me.id)) {
+  if (hasBlockedUser(recipient, me.id)) {
     return { error: ErrorMessages.AuthorBlockedByRecipient };
   }
 

src/components/header/header.tsx

@@ -3,7 +3,7 @@ import { Link } from "react-router-dom";
 
 import { LoginDialog } from "@/components/login-dialog";
 import { Button } from "@/components/ui/button";
-import { Me } from "@/domain";
+import { Me } from "@/domain/me";
 import AuthService from "@/infrastructure/auth";
 import UserService from "@/infrastructure/user";
 

src/components/shout-list/shout-list.tsx

@@ -1,5 +1,7 @@
 import { Shout } from "@/components/shout";
-import { Image, Shout as IShout, User } from "@/domain";
+import { Image, getImageById } from "@/domain/media";
+import { Shout as IShout } from "@/domain/shout";
+import { User, getUserById } from "@/domain/user";
 
 interface ShoutListProps {
   shouts: IShout[];
@@ -10,17 +12,15 @@ interface ShoutListProps {
 export function ShoutList({ shouts, users, images }: ShoutListProps) {
   return (
     <ul className="flex flex-col gap-4 items-center">
-      {shouts.map((shout) => {
-        const author = users.find((u) => u.id === shout.authorId);
-        const image = shout.imageId
-          ? images.find((i) => i.id === shout.imageId)
-          : undefined;
-        return (
-          <li key={shout.id} className="max-w-sm w-full">
-            <Shout shout={shout} author={author} image={image} />
-          </li>
-        );
-      })}
+      {shouts.map((shout) => (
+        <li key={shout.id} className="max-w-sm w-full">
+          <Shout
+            shout={shout}
+            author={getUserById(users, shout.authorId)}
+            image={getImageById(images, shout.imageId)}
+          />
+        </li>
+      ))}
     </ul>
   );
 }

src/components/shout/reply-dialog.tsx

@@ -15,6 +15,7 @@ import {
 import { Input } from "@/components/ui/input";
 import { Label } from "@/components/ui/label";
 import { Textarea } from "@/components/ui/textarea";
+import { isAuthenticated as isUserAuthenticated } from "@/domain/me";
 import UserService from "@/infrastructure/user";
 
 interface ReplyFormElements extends HTMLFormControlsCollection {
@@ -46,7 +47,8 @@ export function ReplyDialog({
 
   useEffect(() => {
     UserService.getMe()
-      .then((me) => setIsAuthenticated(Boolean(me)))
+      .then(isUserAuthenticated)
+      .then(setIsAuthenticated)
       .catch(() => setHasError(true))
       .finally(() => setIsLoading(false));
   }, []);

src/components/shout/shout.tsx

@@ -10,7 +10,9 @@ import {
   CardFooter,
   CardHeader,
 } from "@/components/ui/card";
-import { Image, Shout as IShout, User } from "@/domain";
+import { Image } from "@/domain/media";
+import { Shout as IShout } from "@/domain/shout";
+import { User, fallbackAuthor } from "@/domain/user";
 
 import { ReplyDialog } from "./reply-dialog";
 
@@ -20,16 +22,7 @@ interface ShoutProps {
   image?: Image;
 }
 
-const defaultAuthor: User = {
-  id: "invalid",
-  handle: "Deleted",
-  avatar:
-    "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0Ij48cGF0aCBkPSJNMTIgMGMtNi42MjcgMC0xMiA1LjM3My0xMiAxMnM1LjM3MyAxMiAxMiAxMiAxMi01LjM3MyAxMi0xMi01LjM3My0xMi0xMi0xMnptOSAxMmMwIDEuOTQtLjYyNCAzLjczNS0xLjY3MiA1LjIwN2wtMTIuNTM1LTEyLjUzNWMxLjQ3Mi0xLjA0OCAzLjI2Ny0xLjY3MiA1LjIwNy0xLjY3MiA0Ljk2MiAwIDkgNC4wMzggOSA5em0tMTggMGMwLTEuOTQuNjI0LTMuNzM1IDEuNjcyLTUuMjA3bDEyLjUzNCAxMi41MzRjLTEuNDcxIDEuMDQ5LTMuMjY2IDEuNjczLTUuMjA2IDEuNjczLTQuOTYyIDAtOS00LjAzOC05LTl6Ii8+PC9zdmc+",
-  blockedUserIds: [],
-  followerIds: [],
-};
-
-export function Shout({ shout, author = defaultAuthor, image }: ShoutProps) {
+export function Shout({ shout, author = fallbackAuthor, image }: ShoutProps) {
   return (
     <Card key={shout.id} className="w-full">
       <Link to={`/user/${author.handle}`}>

src/domain/me/index.ts

@@ -0,0 +1 @@
+export * from "./me";

src/domain/me/me.test.ts

@@ -0,0 +1,40 @@
+import { describe, expect, it } from "vitest";
+
+import { isAuthenticated, hasExceededShoutLimit } from "./me";
+
+const mockMe = {
+  id: "1",
+  handle: "test",
+  avatar: "test",
+  numShoutsPastDay: 0,
+  blockedUserIds: [],
+  followerIds: [],
+};
+
+describe("Me domain", () => {
+  describe("isAuthenticated", () => {
+    it("should be true is me is defined", () => {
+      expect(isAuthenticated(mockMe)).toEqual(true);
+    });
+
+    it("should be false if me is not defined", () => {
+      expect(isAuthenticated(undefined)).toEqual(false);
+    });
+  });
+
+  describe("hasExceededShoutLimit", () => {
+    it("should be false if numShoutsPastDay is less than MAX_NUM_SHOUTS_PER_DAY", () => {
+      expect(hasExceededShoutLimit(mockMe)).toEqual(false);
+    });
+
+    it("should be true if numShoutsPastDay is equal to MAX_NUM_SHOUTS_PER_DAY", () => {
+      const me = { ...mockMe, numShoutsPastDay: 5 };
+      expect(hasExceededShoutLimit(me)).toEqual(true);
+    });
+
+    it("should be true if numShoutsPastDay is greater than MAX_NUM_SHOUTS_PER_DAY", () => {
+      const me = { ...mockMe, numShoutsPastDay: 6 };
+      expect(hasExceededShoutLimit(me)).toEqual(true);
+    });
+  });
+});

src/domain/me/me.ts

@@ -0,0 +1,15 @@
+import { User } from "@/domain/user";
+
+export const MAX_NUM_SHOUTS_PER_DAY = 5;
+
+export interface Me extends User {
+  numShoutsPastDay: number;
+}
+
+export function isAuthenticated(me?: Me) {
+  return Boolean(me);
+}
+
+export function hasExceededShoutLimit(me: Me) {
+  return me.numShoutsPastDay >= MAX_NUM_SHOUTS_PER_DAY;
+}

src/domain/media/index.ts

@@ -0,0 +1 @@
+export * from "./media";

src/domain/media/media.test.ts

@@ -0,0 +1,32 @@
+import { describe, expect, it } from "vitest";
+
+import { getImageById } from "./media";
+
+const mockImage = {
+  id: "1",
+  url: "test",
+};
+
+describe("Media domain", () => {
+  describe("getImageById", () => {
+    it("should be able to get image by id", () => {
+      const image = getImageById([mockImage], "1");
+      expect(image).toEqual(mockImage);
+    });
+
+    it("should return undefined if image is not found", () => {
+      const image = getImageById([{ ...mockImage, id: "2" }], "1");
+      expect(image).toEqual(undefined);
+    });
+
+    it("should return undefined if provided images are not defined", () => {
+      const image = getImageById(undefined, "1");
+      expect(image).toEqual(undefined);
+    });
+
+    it("should return undefined if provided image id is not defined", () => {
+      const image = getImageById([mockImage], undefined);
+      expect(image).toEqual(undefined);
+    });
+  });
+});

src/domain/media/media.ts

@@ -0,0 +1,9 @@
+export interface Image {
+  id: string;
+  url: string;
+}
+
+export function getImageById(images?: Image[], imageId?: string) {
+  if (!imageId || !images) return;
+  return images.find((i) => i.id === imageId);
+}

src/domain/shout/index.ts

@@ -0,0 +1 @@
+export * from "./shout";

src/domain/shout/shout.ts

@@ -0,0 +1,11 @@
+export interface Shout {
+  id: string;
+  createdAt: number;
+  authorId: string;
+  text: string;
+  likes: number;
+  reshouts: number;
+  imageId?: string;
+  replies: string[];
+  replyTo?: string;
+}

src/domain/user/index.ts

@@ -0,0 +1 @@
+export * from "./user";

src/domain/user/user.test.ts

@@ -0,0 +1,60 @@
+import { describe, expect, it } from "vitest";
+
+import { getUserById, hasBlockedUser } from "./user";
+
+const mockUser = {
+  id: "1",
+  handle: "test",
+  avatar: "test",
+  numShoutsPastDay: 0,
+  blockedUserIds: [],
+  followerIds: [],
+};
+
+describe("User domain", () => {
+  describe("getUserById", () => {
+    it("should be able to get user by id", () => {
+      const user = getUserById([mockUser], "1");
+      expect(user).toEqual(mockUser);
+    });
+
+    it("should return undefined if user is not found", () => {
+      const user = getUserById([{ ...mockUser, id: "2" }], "1");
+      expect(user).toEqual(undefined);
+    });
+
+    it("should return undefined if provided users are not defined", () => {
+      const user = getUserById(undefined, "1");
+      expect(user).toEqual(undefined);
+    });
+
+    it("should return undefined if provided user id is not defined", () => {
+      const user = getUserById([mockUser], undefined);
+      expect(user).toEqual(undefined);
+    });
+  });
+
+  describe("hasBlockedUser", () => {
+    it("should be false if user has not blocked the user", () => {
+      const user = { ...mockUser, blockedUserIds: ["2"] };
+      const hasBlocked = hasBlockedUser(user, "3");
+      expect(hasBlocked).toEqual(false);
+    });
+
+    it("should be true if user has blocked the user", () => {
+      const user = { ...mockUser, blockedUserIds: ["2"] };
+      const hasBlocked = hasBlockedUser(user, "2");
+      expect(hasBlocked).toEqual(true);
+    });
+
+    it("should be false if user is not defined", () => {
+      const hasBlocked = hasBlockedUser(undefined, "2");
+      expect(hasBlocked).toEqual(false);
+    });
+
+    it("should be false if user id is not defined", () => {
+      const hasBlocked = hasBlockedUser(mockUser, undefined);
+      expect(hasBlocked).toEqual(false);
+    });
+  });
+});

src/domain/user/user.ts

@@ -0,0 +1,27 @@
+export interface User {
+  id: string;
+  handle: string;
+  avatar: string;
+  info?: string;
+  blockedUserIds: string[];
+  followerIds: string[];
+}
+
+export const fallbackAuthor: User = {
+  id: "invalid",
+  handle: "Deleted",
+  avatar:
+    "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0Ij48cGF0aCBkPSJNMTIgMGMtNi42MjcgMC0xMiA1LjM3My0xMiAxMnM1LjM3MyAxMiAxMiAxMiAxMi01LjM3MyAxMi0xMi01LjM3My0xMi0xMi0xMnptOSAxMmMwIDEuOTQtLjYyNCAzLjczNS0xLjY3MiA1LjIwN2wtMTIuNTM1LTEyLjUzNWMxLjQ3Mi0xLjA0OCAzLjI2Ny0xLjY3MiA1LjIwNy0xLjY3MiA0Ljk2MiAwIDkgNC4wMzggOSA5em0tMTggMGMwLTEuOTQuNjI0LTMuNzM1IDEuNjcyLTUuMjA3bDEyLjUzNCAxMi41MzRjLTEuNDcxIDEuMDQ5LTMuMjY2IDEuNjczLTUuMjA2IDEuNjczLTQuOTYyIDAtOS00LjAzOC05LTl6Ii8+PC9zdmc+",
+  blockedUserIds: [],
+  followerIds: [],
+};
+
+export function getUserById(users?: User[], userId?: string) {
+  if (!userId || !users) return;
+  return users.find((u) => u.id === userId);
+}
+
+export function hasBlockedUser(user?: User, userId?: string) {
+  if (!user || !userId) return false;
+  return user.blockedUserIds.includes(userId);
+}

src/infrastructure/media/transform.ts

@@ -1,4 +1,4 @@
-import { Image } from "@/domain";
+import { Image } from "@/domain/media";
 
 import { ImageDto } from "./dto";
 

src/infrastructure/shout/transform.ts

@@ -1,4 +1,4 @@
-import { Shout } from "@/domain";
+import { Shout } from "@/domain/shout";
 
 import { ShoutDto } from "./dto";
 

src/infrastructure/user/transform.ts

@@ -1,4 +1,5 @@
-import { Me, User } from "@/domain";
+import { Me } from "@/domain/me";
+import { User } from "@/domain/user";
 
 import { MeDto, UserDto } from "./dto";