Merge pull request #273 from codex-team/delete-note-history-on-note-deletion

chore(note-history): Changed created_at field of the note_history table

Author: e11sy

migrations/tenant/0034-note-history@change-created-at-type-and-convert-data.sql

@@ -0,0 +1,20 @@
+DO $$
+BEGIN
+    -- Check if field created_at exists in public.note_history
+    IF EXISTS (
+        SELECT 1
+        FROM information_schema.columns
+        WHERE table_schema = 'public'
+          AND table_name = 'note_history'
+          AND column_name = 'created_at'
+    ) THEN
+        -- Changing field type to timestamp with time zone
+        ALTER TABLE public.note_history
+        ALTER COLUMN created_at TYPE timestamp with time zone
+        USING created_at AT TIME ZONE 'UTC';
+
+        -- Update current values of created_at field
+        UPDATE public.note_history
+        SET created_at = created_at AT TIME ZONE 'UTC' AT TIME ZONE 'Europe/Moscow'; -- Замените 'Europe/Moscow' на нужный вам часовой пояс
+    END IF;
+END $$;

src/domain/entities/noteHistory.ts

@@ -62,7 +62,12 @@ export type NoteHistoryMeta = Omit<NoteHistoryRecord, 'content' | 'noteId' | 'to
   user: UserMeta;
 };
 
+/**
+ * Entity that represents NoteHistoryRecord with user info
+ */
+export type NoteHistoryView = NoteHistoryRecord & { user: UserMeta };
+
 /**
  * Public note history record with note public id instead of note internal id
  */
-export type NoteHistoryPublic = Omit<NoteHistoryRecord, 'noteId'> & { noteId: NotePublicId };
+export type NoteHistoryPublic = Omit<NoteHistoryView, 'noteId'> & { noteId: NotePublicId };

src/domain/service/note.ts

@@ -416,7 +416,7 @@ export default class NoteService {
    * Get concrete history record of the note
    * Used for showing some of the note content versions
    * @param id - id of the note history record
-   * @returns full public note history record or raises domain error if record not found
+   * @returns full public note history record with user information or raises domain error if record not found
    */
   public async getHistoryRecordById(id: NoteHistoryRecord['id']): Promise<NoteHistoryPublic> {
     const noteHistoryRecord = await this.noteHistoryRepository.getHistoryRecordById(id);
@@ -436,6 +436,7 @@ export default class NoteService {
       content: noteHistoryRecord.content,
       tools: noteHistoryRecord.tools,
       createdAt: noteHistoryRecord.createdAt,
+      user: noteHistoryRecord.user,
     };
 
     return noteHistoryPublic;

src/repository/noteHistory.repository.ts

@@ -1,4 +1,4 @@
-import type { NoteHistoryCreationAttributes, NoteHistoryMeta, NoteHistoryRecord } from '@domain/entities/noteHistory.js';
+import type { NoteHistoryCreationAttributes, NoteHistoryMeta, NoteHistoryRecord, NoteHistoryView } from '@domain/entities/noteHistory.js';
 import type NoteHistoryStorage from '@repository/storage/noteHistory.storage.js';
 
 /**
@@ -36,9 +36,9 @@ export default class NoteHistoryRepository {
    * Get concrete history record by it's id
    * Used for presentation of certain version of note content saved in history
    * @param id - id of the history record
-   * @returns full history record or null if there is no record with such an id
+   * @returns full history record with user information or null if there is no record with such an id
    */
-  public async getHistoryRecordById(id: NoteHistoryRecord['id']): Promise<NoteHistoryRecord | null> {
+  public async getHistoryRecordById(id: NoteHistoryRecord['id']): Promise<NoteHistoryView | null> {
     return await this.storage.getHistoryRecordById(id);
   }
 

src/repository/storage/postgres/orm/sequelize/noteHistory.ts

@@ -3,7 +3,7 @@ import { DataTypes, literal, Model } from 'sequelize';
 import type Orm from '@repository/storage/postgres/orm/sequelize/index.js';
 import { NoteModel } from './note.js';
 import { UserModel } from './user.js';
-import type { NoteHistoryCreationAttributes, NoteHistoryRecord, NoteHistoryMeta } from '@domain/entities/noteHistory.js';
+import type { NoteHistoryCreationAttributes, NoteHistoryRecord, NoteHistoryMeta, NoteHistoryView } from '@domain/entities/noteHistory.js';
 
 /**
  * Note history model instance
@@ -147,6 +147,7 @@ export default class NoteHistorySequelizeStorage {
         as: 'user',
         attributes: ['name', 'photo'],
       },
+      order: [['createdAt', 'DESC']],
     });
 
     /**
@@ -160,10 +161,26 @@ export default class NoteHistorySequelizeStorage {
   /**
    * Get concrete history record by it's id
    * @param id - id of the history record
-   * @returns full history record or null if there is no record with such an id
+   * @returns full history record with user information or null if there is no record with such an id
    */
-  public async getHistoryRecordById(id: NoteHistoryRecord['id']): Promise<NoteHistoryRecord | null> {
-    return await this.model.findByPk(id);
+  public async getHistoryRecordById(id: NoteHistoryRecord['id']): Promise<NoteHistoryView | null> {
+    const historyView = await this.model.findOne({
+      where: {
+        id,
+      },
+      include: {
+        model: this.userModel,
+        as: 'user',
+        attributes: ['name', 'photo'],
+      },
+    });
+
+    /**
+     * We need this cast because of using sequelize model.include
+     * Since it returns NoteHistoryModel[], however we included userModel,
+     * without this cast NoteHistoryModel[] and NoteHistoryView are incompatible
+     */
+    return historyView as unknown as NoteHistoryView;
   }
 
   /**