Layered Phase 2 - Comments (#169)

### Description

<!-- Provide a comprehensive description here about what your PR aims to
solve. -->

<!-- You may also add additional context -->

- Refactor Comments into our Layered architecture by creating dedicated
mappers, dto, interface, and controller just like article
- separate mappers into atomic files

---

### PR Checklist

<!-- Please do not remove this section -->

<!-- Mark each item with an "x" ([ ] becomes [x]) -->

- [x] Read the Developer's Guide in
[CONTRIBUTING.md](https://github.com/agnyz/bedstack/blob/main/CONTRIBUTING.md)
- [x] Use a concise title to represent the changes introduced in this PR
- [x] Provide a detailed description of the changes introduced in this
PR, and, if necessary, some screenshots
- [x] Reference an issue or discussion where the feature or changes have
been previously discussed
- [x] Add a failing test that passes with the changes introduced in this
PR, or explain why it's not feasible
- [x] Add documentation for the feature or changes introduced in this PR
to the docs; you can run them with `bun docs`


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced a dedicated comments API with endpoints to create,
retrieve, and delete comments on articles.
  - Added structured response formats for single and multiple comments.

- **Refactor**
- Separated comment-related routes from the articles API to a standalone
comments controller.
- Improved data mapping for articles and comments using dedicated mapper
functions and centralized exports.

- **Bug Fixes**
  - Corrected import paths for comments schema to ensure consistency.

- **Chores**
- Enhanced type safety and maintainability with new and updated
interfaces for comments.
  - Updated documentation and response schemas for improved API clarity.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: yamcodes

src/app.module.ts

@@ -11,6 +11,7 @@ import { tagsPlugin } from '@tags/tags.plugin';
 import { usersPlugin } from '@users/users.plugin';
 import { Elysia } from 'elysia';
 import { description, title, version } from '../package.json';
+import { commentsController } from './comments/comments.controller';
 
 // the file name is in the spirit of NestJS, where app module is the device in charge of putting together all the pieces of the app
 // see: https://docs.nestjs.com/modules
@@ -60,6 +61,7 @@ export const setupApp = () => {
         .use(usersPlugin)
         .use(profilesPlugin)
         .use(articlesController)
+        .use(commentsController)
         .use(tagsPlugin),
     );
 };

src/articles/articles.controller.ts

@@ -1,6 +1,5 @@
 import { setupArticles } from '@articles/articles.module';
-import { CommentResponseDto, CreateCommentDto } from '@comments/dto';
-import { Elysia, t } from 'elysia';
+import { Elysia } from 'elysia';
 import {
   ArticleFeedQueryDto,
   ArticleResponseDto,
@@ -9,12 +8,7 @@ import {
   ListArticlesQueryDto,
   UpdateArticleDto,
 } from './dto';
-import {
-  toCommentResponse,
-  toCreateArticleInput,
-  toFeedResponse,
-  toResponse,
-} from './mappers/articles.mapper';
+import { toCreateArticleInput, toFeedResponse, toResponse } from './mappers';
 
 export const articlesController = new Elysia().use(setupArticles).group(
   '/articles',
@@ -177,66 +171,6 @@ export const articlesController = new Elysia().use(setupArticles).group(
           },
         },
       )
-      .post(
-        '/:slug/comments',
-        async ({ body, params, store, request }) => {
-          const comment = await store.commentsService.createComment(
-            params.slug,
-            body.comment,
-            await store.authService.getUserIdFromHeader(request.headers),
-          );
-          return toCommentResponse(comment);
-        },
-        {
-          beforeHandle: app.store.authService.requireLogin,
-          body: CreateCommentDto,
-          response: CommentResponseDto,
-          detail: {
-            summary: 'Add Comments to an Article',
-          },
-        },
-      )
-      .get(
-        '/:slug/comments',
-        async ({ params, store, request }) => {
-          const userId = await store.authService.getOptionalUserIdFromHeader(
-            request.headers,
-          );
-          const comments = await store.commentsService.getComments(
-            params.slug,
-            userId === null ? undefined : userId,
-          );
-          return { comments: comments.map(toCommentResponse) };
-        },
-        {
-          response: t.Object({
-            comments: t.Array(CommentResponseDto),
-          }),
-          detail: {
-            summary: 'Get Comments from an Article',
-          },
-        },
-      )
-      .delete(
-        '/:slug/comments/:id',
-        async ({ params, store, request }) => {
-          await store.commentsService.deleteComment(
-            params.slug,
-            Number.parseInt(params.id, 10),
-            await store.authService.getUserIdFromHeader(request.headers),
-          );
-        },
-        {
-          beforeHandle: app.store.authService.requireLogin,
-          params: t.Object({
-            slug: t.String(),
-            id: t.String(),
-          }),
-          detail: {
-            summary: 'Delete Comment',
-          },
-        },
-      )
       .post(
         '/:slug/favorite',
         async ({ params, store, request }) => {

src/articles/articles.module.ts

@@ -2,8 +2,6 @@ import { db } from '@/database.providers';
 import { ArticlesRepository } from '@articles/articles.repository';
 import { ArticlesService } from '@articles/articles.service';
 import { AuthService } from '@auth/auth.service';
-import { CommentsRepository } from '@comments/comments.repository';
-import { CommentsService } from '@comments/comments.service';
 import { ProfilesRepository } from '@profiles/profiles.repository';
 import { ProfilesService } from '@profiles/profiles.service';
 import { TagsRepository } from '@tags/tags.repository';
@@ -12,7 +10,6 @@ import { Elysia } from 'elysia';
 
 export const setupArticles = () => {
   const articlesRepository = new ArticlesRepository(db);
-  const commentsRepository = new CommentsRepository(db);
   const profilesRepository = new ProfilesRepository(db);
   const tagsRepositry = new TagsRepository(db);
   const profilesService = new ProfilesService(profilesRepository);
@@ -22,14 +19,9 @@ export const setupArticles = () => {
     profilesService,
     tagsService,
   );
-  const commentsService = new CommentsService(
-    commentsRepository,
-    profilesService,
-  );
   const authService = new AuthService();
   return new Elysia().state(() => ({
     articlesService,
     authService,
-    commentsService,
   }));
 };

src/articles/articles.schema.ts

@@ -1,6 +1,6 @@
-import { users } from '@/users/users.model';
-import { comments } from '@comments/schema';
+import { comments } from '@comments/comments.schema';
 import { articleTags } from '@tags/tags.model';
+import { users } from '@users/users.model';
 import { relations } from 'drizzle-orm';
 import {
   integer,

src/articles/articles.service.ts

@@ -1,20 +1,16 @@
-import { AuthorizationError, BadRequestError, ConflictError } from '@/errors';
-import type { ProfilesService } from '@/profiles/profiles.service';
-import { slugify } from '@/utils/slugify';
 import type { ArticlesRepository } from '@articles/articles.repository';
+import { AuthorizationError, BadRequestError, ConflictError } from '@errors';
+import type { ProfilesService } from '@profiles/profiles.service';
 import type { TagsService } from '@tags/tags.service';
+import { slugify } from '@utils/slugify';
 import { NotFoundError } from 'elysia';
 import type {
   CreateArticleInput,
   IArticle,
   IArticleFeed,
   UpdateArticleInput,
 } from './interfaces';
-import {
-  toDomain,
-  toFeedDomain,
-  toNewArticleRow,
-} from './mappers/articles.mapper';
+import { toDomain, toFeedDomain, toNewArticleRow } from './mappers';
 
 type FindFilters = {
   tag?: string;

src/articles/interfaces/article-row.interface.ts

@@ -1,5 +1,5 @@
-import type { Profile } from '@/profiles/profiles.schema';
 import type { ArticleTag } from '@/tags/tags.schema';
+import type { Profile } from '@profiles/profiles.schema';
 import type { InferSelectModel } from 'drizzle-orm';
 import type { articles, favoriteArticles } from '../articles.schema';
 

src/articles/mappers/articles.mapper.ts

@@ -0,0 +1,6 @@
+export * from './to-domain.mapper';
+export * from './to-response.mapper';
+export * from './to-create-article-input.mapper';
+export * from './to-new-article-row.mapper';
+export * from './to-feed-domain.mapper';
+export * from './to-feed-response.mapper';

src/articles/mappers/index.ts

@@ -0,0 +1,13 @@
+import type { CreateArticleDto } from '../dto';
+import type { CreateArticleInput } from '../interfaces';
+
+export function toCreateArticleInput({
+  article,
+}: CreateArticleDto): CreateArticleInput {
+  return {
+    title: article.title,
+    description: article.description,
+    body: article.body,
+    tagList: article.tagList ?? [],
+  };
+}

src/articles/mappers/to-create-article-input.mapper.ts

@@ -0,0 +1,34 @@
+import type { ArticleRow, IArticle } from '../interfaces';
+
+type ToDomainOptions = {
+  tagList?: string[];
+  currentUserId?: number;
+};
+
+export function toDomain(
+  article: ArticleRow,
+  { tagList, currentUserId }: ToDomainOptions,
+): IArticle {
+  return {
+    id: article.id,
+    slug: article.slug,
+    title: article.title,
+    description: article.description,
+    tagList: tagList ?? article.tags.map((t) => t.tagName),
+    createdAt: article.createdAt,
+    updatedAt: article.updatedAt,
+    favorited: article.favoritedBy.some(
+      (user) => user.userId === currentUserId,
+    ),
+    favoritesCount: article.favoritedBy.length,
+    body: article.body,
+    author: {
+      username: article.author.username,
+      bio: article.author.bio,
+      image: article.author.image,
+      following: article.author.followers.some(
+        (follower) => follower.followerId === currentUserId,
+      ),
+    },
+  };
+}