Merge pull request #146 from codex-team/feat/note-settings-invitation…

…-hash

Feat: invitation hash

migrations/tenant/0012-note-settings@add-invitation-hash.sql

@@ -0,0 +1,24 @@
+-- Create "invitation hash" column in note_settings table
+DO $$
+BEGIN
+  IF NOT EXISTS(SELECT *
+    FROM information_schema.columns
+    WHERE table_name='note_settings' and column_name='invitation_hash')
+  THEN
+      ALTER TABLE "public"."note_settings" ADD COLUMN "invitation_hash" VARCHAR(255);
+  END IF;
+END $$;
+
+-- Generate invitation hash for records with NULL invitation_hash
+DO $$
+BEGIN
+  UPDATE "public"."note_settings"
+  SET "invitation_hash" = SUBSTRING(CAST(GEN_RANDOM_UUID() AS VARCHAR), 1, 10)
+  WHERE "invitation_hash" IS NULL;
+END $$;
+
+-- Makes the column 'invitation_hash' NOT NULL
+DO $$
+BEGIN
+  ALTER TABLE "public"."note_settings" ALTER COLUMN "invitation_hash" SET NOT NULL;
+END $$;

src/domain/entities/noteSettings.ts

@@ -1,3 +1,8 @@
+/**
+ * Invitation hash. It's used to invite users to team
+ */
+export type InvitationHash = string;
+
 /**
  * Notes settings entity
  */
@@ -21,6 +26,11 @@ export default interface NoteSettings {
    * Is note public for everyone or only for collaborators
    */
   isPublic: boolean;
+
+  /**
+   * Invitation hash
+   */
+  invitationHash: InvitationHash;
 }
 
 /**

src/domain/service/noteSettings.ts

@@ -4,6 +4,7 @@ import type NoteSettingsRepository from '@repository/noteSettings.repository.js'
 import type TeamRepository from '@repository/team.repository.js';
 import type { MemberRole, Team, TeamMember, TeamMemberCreationAttributes } from '@domain/entities/team.js';
 import type User from '@domain/entities/user.js';
+import { createInvitationHash } from '@infrastructure/utils/invitationHash.js';
 
 /**
  * Service responsible for Note Settings
@@ -47,6 +48,7 @@ export default class NoteSettingsService {
     return await this.noteSettingsRepository.addNoteSettings({
       noteId: noteId,
       isPublic: isPublic,
+      invitationHash: createInvitationHash(),
     });
   }
 

src/infrastructure/utils/invitationHash.ts

@@ -0,0 +1,11 @@
+import { nanoid } from 'nanoid';
+
+/**
+ * Create invitation hash
+ * Used to invite users to team
+ *
+ * @param length - length of invitation hash
+ */
+export function createInvitationHash(length: number = 10): string {
+  return nanoid(length);
+}

src/presentation/http/router/note.test.ts

@@ -21,6 +21,7 @@ describe('Note API', () => {
             'isPublic': true,
             'id': 1,
             'noteId': 1,
+            'invitationHash': 'Hzh2hy4igf',
           },
         },
         'accessRights': {

src/presentation/http/router/noteSettings.test.ts

@@ -14,6 +14,7 @@ describe('NoteSettings API', () => {
         'isPublic': true,
         'id': 2,
         'noteId': 2,
+        'invitationHash': 'E2zRXv3cp-',
       };
 
       const response = await global.api?.fakeRequest({
@@ -201,6 +202,7 @@ describe('NoteSettings API', () => {
         'noteId': 53,
         'customHostname': 'codex.so',
         'isPublic': false,
+        'invitationHash': 'FfAwyaR80C',
       };
 
       const response = await global.api?.fakeRequest({
@@ -279,4 +281,4 @@ describe('NoteSettings API', () => {
 
     test.todo('Return 403 when user authorized, but not member of the team');
   });
-});
+});

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

@@ -28,6 +28,11 @@ export class NoteSettingsModel extends Model<InferAttributes<NoteSettingsModel>,
    * Is note public
    */
   public declare isPublic: CreationOptional<NoteSettings['isPublic']>;
+
+  /**
+   * Invitation hash
+   */
+  public declare invitationHash: NoteSettings['invitationHash'];
 }
 
 /**
@@ -88,6 +93,10 @@ export default class NoteSettingsSequelizeStorage {
         allowNull: false,
         defaultValue: true,
       },
+      invitationHash: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
     }, {
       tableName: this.tableName,
       sequelize: this.database,
@@ -169,12 +178,14 @@ export default class NoteSettingsSequelizeStorage {
     noteId,
     customHostname,
     isPublic,
+    invitationHash,
   }: NoteSettingsCreationAttributes
   ): Promise<NoteSettings> {
     const settings = await this.model.create({
       noteId,
       customHostname,
       isPublic,
+      invitationHash,
     });
 
     return settings;

src/tests/test-data/notes-settings.json

@@ -3,27 +3,31 @@
     "id": 1,
     "note_id": 1,
     "custom_hostname": "codex.so",
-    "is_public": true
+    "is_public": true,
+    "invitation_hash": "Hzh2hy4igf"
   },
 
   {
     "id": 2,
     "note_id": 2,
     "custom_hostname": "codex.so",
-    "is_public": true
+    "is_public": true,
+    "invitation_hash": "E2zRXv3cp-"
   },
 
   {
     "id": 3,
     "note_id": 3,
     "custom_hostname": "codex.so",
-    "is_public": false
+    "is_public": false,
+    "invitation_hash": "Lw5kIwwo4_"
   },
 
   {
     "id": 53,
     "note_id": 53,
     "custom_hostname": "codex.so",
-    "is_public": true
+    "is_public": true,
+    "invitation_hash": "FfAwyaR80C"
   }
 ]

src/tests/utils/insert-data.ts

@@ -44,7 +44,7 @@ async function insertNotes(db: SequelizeOrm): Promise<void> {
  */
 async function insertNoteSettings(db: SequelizeOrm): Promise<void> {
   for (const noteSetting of noteSettings) {
-    await db.connection.query(`INSERT INTO public.note_settings (id, "note_id", "custom_hostname", "is_public") VALUES (${noteSetting.id}, '${noteSetting.note_id}', '${noteSetting.custom_hostname}', ${noteSetting.is_public})`);
+    await db.connection.query(`INSERT INTO public.note_settings (id, "note_id", "custom_hostname", "is_public", "invitation_hash") VALUES (${noteSetting.id}, '${noteSetting.note_id}', '${noteSetting.custom_hostname}', ${noteSetting.is_public}, '${noteSetting.invitation_hash}')`);
   }
 }