Refactor version history (PART 1/2)

libs/model/src/models/associations.ts

@@ -101,11 +101,12 @@ export const buildAssociations = (db: DB) => {
       asMany: 'reactions',
     })
     .withMany(db.Comment)
-    .withMany(db.Notification);
+    .withMany(db.Notification)
+    .withMany(db.ThreadVersionHistory);
 
   db.Comment.withMany(db.Reaction, {
     asMany: 'reactions',
-  });
+  }).withMany(db.CommentVersionHistory);
 
   db.ContestManager.withMany(db.Contest, {
     foreignKey: 'contest_address',

libs/model/src/models/comment.ts

@@ -33,6 +33,7 @@ export type CommentAttributes = {
   deleted_at?: Date;
   marked_as_spam_at?: Date;
   discord_meta?: IDiscordMeta;
+  version_history_updated?: boolean;
 
   // associations
   Community?: CommunityAttributes;
@@ -97,6 +98,11 @@ export default (
         allowNull: false,
         defaultValue: 0,
       },
+      version_history_updated: {
+        type: Sequelize.BOOLEAN,
+        allowNull: false,
+        defaultValue: false,
+      },
     },
     {
       hooks: {

libs/model/src/models/comment_version_history.ts

@@ -0,0 +1,33 @@
+import { CommentVersionHistory } from '@hicommonwealth/schemas';
+import Sequelize from 'sequelize';
+import { z } from 'zod';
+import { CommentAttributes } from './comment';
+import type { ModelInstance } from './types';
+
+export type CommentVersionHistoryAttributes = z.infer<
+  typeof CommentVersionHistory
+> & {
+  // associations
+  Comment?: CommentAttributes;
+};
+
+export type CommentVersionHistoryInstance =
+  ModelInstance<CommentVersionHistoryAttributes>;
+
+export default (
+  sequelize: Sequelize.Sequelize,
+): Sequelize.ModelStatic<CommentVersionHistoryInstance> =>
+  sequelize.define<CommentVersionHistoryInstance>(
+    'CommentVersionHistory',
+    {
+      id: { type: Sequelize.INTEGER, autoIncrement: true, primaryKey: true },
+      comment_id: { type: Sequelize.INTEGER, allowNull: false },
+      text: { type: Sequelize.TEXT, allowNull: false },
+      timestamp: { type: Sequelize.DATE, allowNull: false },
+    },
+    {
+      tableName: 'CommentVersionHistories',
+      timestamps: false,
+      indexes: [{ fields: ['comment_id'] }],
+    },
+  );

libs/model/src/models/factories.ts

@@ -7,6 +7,7 @@ import ChainNode from './chain_node';
 import Collaboration from './collaboration';
 import Comment from './comment';
 import CommentSubscription from './comment_subscriptions';
+import CommentVersionHistory from './comment_version_history';
 import Community from './community';
 import CommunityAlert from './community_alerts';
 import CommunityBanner from './community_banner';
@@ -42,6 +43,7 @@ import SubscriptionPreference from './subscription_preference';
 import Tags from './tags';
 import Thread from './thread';
 import ThreadSubscription from './thread_subscriptions';
+import ThreadVersionHistory from './thread_version_history';
 import Topic from './topic';
 import User from './user';
 import Vote from './vote';
@@ -53,6 +55,7 @@ export const Factories = {
   ChainNode,
   Collaboration,
   Comment,
+  CommentVersionHistory,
   CommentSubscription,
   Community,
   CommunityAlert,
@@ -88,6 +91,7 @@ export const Factories = {
   Tags,
   SubscriptionPreference,
   Thread,
+  ThreadVersionHistory,
   ThreadSubscription,
   Topic,
   User,

libs/model/src/models/index.ts

@@ -46,6 +46,7 @@ export * from './ban';
 export * from './chain_node';
 export * from './collaboration';
 export * from './comment';
+export * from './comment_version_history';
 export * from './community';
 export * from './community_banner';
 export * from './community_contract';
@@ -76,6 +77,7 @@ export * from './starred_community';
 export * from './subscription';
 export * from './tags';
 export * from './thread';
+export * from './thread_version_history';
 export * from './topic';
 export * from './types';
 export * from './user';

libs/model/src/models/thread.ts

@@ -13,6 +13,7 @@ import type { ModelInstance } from './types';
 
 export type ThreadAttributes = z.infer<typeof Thread> & {
   // associations
+  version_history_updated?: boolean;
   Community?: CommunityAttributes;
   collaborators?: AddressAttributes[];
   topic?: TopicAttributes;
@@ -109,6 +110,12 @@ export default (
         allowNull: false,
         defaultValue: 0,
       },
+
+      version_history_updated: {
+        type: Sequelize.BOOLEAN,
+        allowNull: false,
+        defaultValue: false,
+      },
     },
     {
       timestamps: true,

libs/model/src/models/thread_version_history.ts

@@ -0,0 +1,34 @@
+import { ThreadVersionHistory } from '@hicommonwealth/schemas';
+import Sequelize from 'sequelize';
+import { z } from 'zod';
+import { ThreadAttributes } from './thread';
+import type { ModelInstance } from './types';
+
+export type ThreadVersionHistoryAttributes = z.infer<
+  typeof ThreadVersionHistory
+> & {
+  // associations
+  Thread?: ThreadAttributes;
+};
+
+export type ThreadVersionHistoryInstance =
+  ModelInstance<ThreadVersionHistoryAttributes>;
+
+export default (
+  sequelize: Sequelize.Sequelize,
+): Sequelize.ModelStatic<ThreadVersionHistoryInstance> =>
+  sequelize.define<ThreadVersionHistoryInstance>(
+    'ThreadVersionHistory',
+    {
+      id: { type: Sequelize.INTEGER, autoIncrement: true, primaryKey: true },
+      thread_id: { type: Sequelize.INTEGER, allowNull: false },
+      address: { type: Sequelize.STRING, allowNull: false },
+      body: { type: Sequelize.TEXT, allowNull: false },
+      timestamp: { type: Sequelize.DATE, allowNull: false },
+    },
+    {
+      tableName: 'ThreadVersionHistories',
+      timestamps: false,
+      indexes: [{ fields: ['thread_id'] }],
+    },
+  );

libs/schemas/src/entities/comment.schemas.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { PG_INT } from '../utils';
+
+export const CommentVersionHistory = z.object({
+  id: PG_INT.optional(),
+  comment_id: PG_INT,
+  text: z.string(),
+  timestamp: z.date().optional(),
+});

libs/schemas/src/entities/index.ts

@@ -1,4 +1,5 @@
 export * from './chain.schemas';
+export * from './comment.schemas';
 export * from './community.schemas';
 export * from './contest-manager.schemas';
 export * from './contract.schemas';

libs/schemas/src/entities/thread.schemas.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { PG_INT, discordMetaSchema, linksSchema, zDate } from '../utils';
+import { discordMetaSchema, linksSchema, PG_INT, zDate } from '../utils';
 import { Address } from './user.schemas';
 
 export const Thread = z.object({
@@ -81,3 +81,13 @@ export const Comment = z.object({
 
   Address: Address.optional(),
 });
+
+export const ThreadVersionHistory = z.object({
+  id: PG_INT.optional(),
+  thread_id: PG_INT,
+  address: z
+    .string()
+    .describe('Address of the creator of the post or the collaborator'),
+  body: z.string(),
+  timestamp: z.date().optional(),
+});

libs/schemas/src/index.ts

@@ -5,10 +5,12 @@ export type Aggregates = Extract<
   Entities,
   | 'ChainNode'
   | 'Comment'
+  | 'CommentVersionHistory'
   | 'Community'
   | 'NotificationCategory'
   | 'Subscription'
   | 'Thread'
+  | 'ThreadVersionHistory'
   | 'Reaction'
   | 'User'
   | 'StakeTransaction'

packages/canvas-node/package.json

@@ -15,8 +15,8 @@
     "url": "git+https://github.com/hicommonwealth/canvas-node.git"
   },
   "dependencies": {
-    "@canvas-js/core": "0.10.0-beta.2",
-    "@canvas-js/cli": "0.10.0-beta.2",
+    "@canvas-js/core": "0.10.0-beta.3",
+    "@canvas-js/cli": "0.10.0-beta.3",
     "chalk": "^5.2.0",
     "cors": "^2.8.5",
     "express": "^4.18.2",

packages/commonwealth/package.json

@@ -9,6 +9,8 @@
   },
   "type": "module",
   "scripts": {
+    "async-migrate-comment-version-history": "tsx ./scripts/async-migrate-comment-version-history.ts",
+    "async-migrate-thread-version-history": "tsx ./scripts/async-migrate-thread-version-history.ts",
     "add-component-showcase": "tsx ./scripts/add-component-showcase.ts",
     "archive-outbox": "node --import=extensionless/register --max-old-space-size=$(../../scripts/get-max-old-space-size.sh) build/scripts/archive-outbox.js",
     "async-migrate-community-counts": "tsx ./scripts/async-migrate-community-count.ts",

packages/commonwealth/scripts/async-migrate-comment-version-history.ts

@@ -0,0 +1,90 @@
+//TODO: This should be deleted after comment version histories are fixed
+import { dispose } from '@hicommonwealth/core';
+import { CommentVersionHistoryInstance, models } from '@hicommonwealth/model';
+import { QueryTypes } from 'sequelize';
+
+async function run() {
+  const commentCount = (
+    await models.sequelize.query(
+      `SELECT COUNT(*) FROM "Comments" WHERE version_history_updated = false`,
+      {
+        raw: true,
+        type: QueryTypes.SELECT,
+      },
+    )
+  )[0];
+
+  const count = parseInt(commentCount['count']);
+  let i = 0;
+  while (i < count) {
+    try {
+      await models.sequelize.transaction(async (transaction) => {
+        const commentVersionHistory: {
+          id: number;
+          versionHistories: { timestamp: string; body: string }[];
+        }[] = (
+          await models.sequelize.query(
+            `SELECT id, version_history FROM "Comments" where version_history_updated = false
+             FOR UPDATE SKIP LOCKED LIMIT 1`,
+            {
+              raw: true,
+              type: QueryTypes.SELECT,
+              transaction,
+            },
+          )
+        ).map((c) => ({
+          id: parseInt(c['id']),
+          versionHistories: c['version_history'].map((v) => JSON.parse(v)),
+        }));
+
+        if (commentVersionHistory.length === 0) {
+          return;
+        }
+
+        for (const versionHistory of commentVersionHistory) {
+          console.log(
+            `${i}/${count} Updating comment version_histories for id ${versionHistory.id}`,
+          );
+
+          const formattedValues = versionHistory.versionHistories.map((v) => {
+            const { body, ...rest } = v;
+            return {
+              comment_id: versionHistory.id,
+              ...rest,
+              text: body,
+            };
+          }) as unknown as CommentVersionHistoryInstance[];
+
+          await models.sequelize.query(
+            `UPDATE "Comments" SET version_history_updated = true WHERE id = $id`,
+            {
+              bind: { id: versionHistory.id },
+              transaction,
+            },
+          );
+          return await models.CommentVersionHistory.bulkCreate(
+            formattedValues,
+            {
+              transaction,
+            },
+          );
+        }
+      });
+    } catch (error) {
+      console.error('Error:', error.message);
+      throw error;
+    }
+
+    i += 1;
+  }
+
+  console.log('Finished migration');
+}
+
+run()
+  .then(() => {
+    void dispose()('EXIT', true);
+  })
+  .catch((error) => {
+    console.error('Failed to migrate community counts:', error);
+  });