uth-239: Comments database schema + API/routes

Author: svjson

migrations/20250523145209_create-comments-table.js

@@ -0,0 +1,37 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+  return knex.transaction(async (trx) => {
+
+  await trx.raw(`
+  CREATE TABLE comment (
+    id int NOT NULL PRIMARY KEY IDENTITY(1,1),
+    targetType nvarchar(30) NOT NULL,
+    targetId int NOT NULL,
+    authorId nvarchar(100) NOT NULL,
+    authorName nvarchar(50) NOT NULL,
+    type nvarchar(8) NOT NULL CHECK (type IN ('COMMENT', 'WARNING', 'STOP')),
+    comment nvarchar(max) NOT NULL,
+    createdAt datetimeoffset NOT NULL DEFAULT SYSDATETIMEOFFSET()
+  );
+
+  CREATE INDEX idx_thread_id
+  ON comment (targetType, targetId);
+`)
+  })
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+  return knex.transaction(async (trx) => {
+
+  await trx.raw(`
+    DROP TABLE comment;
+`)
+  })
+};

package-lock.json

@@ -74,7 +74,7 @@
     "koa-pino-logger": "^4.0.0",
     "koa2-swagger-ui": "^5.10.0",
     "mssql": "^11.0.1",
-    "onecore-types": "^3.7.1",
+    "onecore-types": "^3.11.0",
     "onecore-utilities": "^1.1.0",
     "personnummer": "^3.2.1",
     "pino": "^9.1.0",

package.json

@@ -0,0 +1,91 @@
+import { Comment, CommentThread, CommentThreadId } from 'onecore-types'
+import { DbComment } from './types'
+import { leasing } from 'onecore-types'
+import z from 'zod'
+
+import { db } from './db'
+
+const getCommentThreadById = async (
+  threadId: CommentThreadId,
+  dbConnection = db
+): Promise<CommentThread | undefined> => {
+  const comments = await dbConnection
+    .from('comment AS c')
+    .select<Array<DbComment>>(
+      'c.id AS Id',
+      'c.createdAt AS CreatedAt',
+      'c.type AS Type',
+      'c.authorId AS AuthorId',
+      'c.authorName AS AuthorName',
+      'c.comment AS Comment'
+    )
+    .where({
+      TargetType: threadId.targetType,
+      TargetId: threadId.targetId,
+    })
+    .orderBy('CreatedAt', 'desc')
+
+  return {
+    id: threadId,
+    comments: comments.map((c: DbComment) => {
+      return {
+        id: c.Id,
+        authorName: c.AuthorName,
+        authorId: c.AuthorId,
+        type: c.Type,
+        comment: c.Comment,
+        createdAt: c.CreatedAt,
+      }
+    }),
+  }
+}
+
+type AddCommentRequest = z.infer<
+  typeof leasing.v1.AddCommentRequestParamsSchema
+>
+
+const addComment = async (
+  threadId: CommentThreadId,
+  comment: AddCommentRequest,
+  dbConnection = db
+): Promise<Comment | undefined> => {
+  const [inserted] = await dbConnection
+    .table('comment')
+    .insert({
+      TargetType: threadId.targetType,
+      TargetId: threadId.targetId,
+      AuthorName: comment.authorName,
+      AuthorId: comment.authorId,
+      Type: comment.type,
+      Comment: comment.comment,
+    })
+    .returning('*')
+
+  return {
+    id: inserted.id,
+    authorName: inserted.authorName,
+    authorId: inserted.authorId,
+    type: inserted.type,
+    comment: inserted.comment,
+    createdAt: inserted.createdAt,
+  }
+}
+
+const removeComment = async (
+  threadId: CommentThreadId,
+  commentId: number,
+  dbConnection = db
+): Promise<void | undefined> => {
+  await dbConnection
+    .table('comment')
+    .where({
+      Id: commentId,
+      TargetType: threadId.targetType,
+      TargetId: threadId.targetId,
+    })
+    .delete()
+
+  return
+}
+
+export default { getCommentThreadById, addComment, removeComment }

src/services/lease-service/adapters/comment-adapter.ts

@@ -78,4 +78,15 @@ export type DbListing = {
   WaitingListType: string | null
 }
 
+export type DbComment = {
+  Id: number
+  TargetType: string
+  TargetId: number
+  AuthorName: string
+  AuthorId: string
+  CreatedAt: Date
+  Type: 'COMMENT' | 'WARNING' | 'STOP'
+  Comment: string
+}
+
 export type AdapterResult<T, E> = { ok: true; data: T } | { ok: false; err: E }

src/services/lease-service/adapters/types.ts

@@ -1,5 +1,6 @@
 import KoaRouter from '@koa/router'
 import { routes as offerRoutes } from './routes/offers'
+import { routes as commentRoutes } from './routes/comments'
 import { routes as contactRoutes } from './routes/contacts'
 import { routes as invoiceRoutes } from './routes/invoices'
 import { routes as leaseRoutes } from './routes/leases'
@@ -9,6 +10,7 @@ import { routes as applicantsRoutes } from './routes/applicants'
 export const routes = (router: KoaRouter) => {
   applicantsRoutes(router)
   offerRoutes(router)
+  commentRoutes(router)
   contactRoutes(router)
   invoiceRoutes(router)
   leaseRoutes(router)