Add support for comment trees (#14)

Author: nramadas

migrations/1663081197272-RealmFeedItemComment.ts

@@ -0,0 +1,60 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class RealmFeedItemComment1663081197272 implements MigrationInterface {
+    name = 'RealmFeedItemComment1663081197272'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            CREATE TABLE "realm_feed_item_comment" (
+                "id" SERIAL NOT NULL,
+                "authorId" uuid NOT NULL,
+                "data" jsonb NOT NULL,
+                "feedItemId" integer NOT NULL,
+                "environment" character varying NOT NULL,
+                "metadata" jsonb NOT NULL,
+                "parentCommentId" integer,
+                "realmPublicKeyStr" character varying NOT NULL,
+                "created" TIMESTAMP NOT NULL DEFAULT now(),
+                "deleted" TIMESTAMP,
+                "updated" TIMESTAMP NOT NULL DEFAULT now(),
+                CONSTRAINT "PK_241ee9ad70d478bea24f5cad849" PRIMARY KEY ("id")
+            )
+        `);
+        await queryRunner.query(`
+            CREATE TABLE "realm_feed_item_comment_vote" (
+                "commentId" integer NOT NULL,
+                "userId" uuid NOT NULL,
+                "realmPublicKeyStr" character varying NOT NULL,
+                "data" jsonb NOT NULL,
+                "created" TIMESTAMP NOT NULL DEFAULT now(),
+                "deleted" TIMESTAMP,
+                "updated" TIMESTAMP NOT NULL DEFAULT now(),
+                CONSTRAINT "PK_e163f06bd5b24e570a1e3502598" PRIMARY KEY ("commentId", "userId", "realmPublicKeyStr")
+            )
+        `);
+        await queryRunner.query(`
+            ALTER TABLE "realm_feed_item_comment"
+            ADD CONSTRAINT "FK_d9738a44f8f8e8436c9bbdcf0d6" FOREIGN KEY ("authorId") REFERENCES "user"("id") ON DELETE NO ACTION ON UPDATE NO ACTION
+        `);
+        await queryRunner.query(`
+            ALTER TABLE "realm_feed_item_comment"
+            ADD CONSTRAINT "FK_8f105becc4961c4627e11ec0ed9" FOREIGN KEY ("feedItemId") REFERENCES "realm_feed_item"("id") ON DELETE NO ACTION ON UPDATE NO ACTION
+        `);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            ALTER TABLE "realm_feed_item_comment" DROP CONSTRAINT "FK_8f105becc4961c4627e11ec0ed9"
+        `);
+        await queryRunner.query(`
+            ALTER TABLE "realm_feed_item_comment" DROP CONSTRAINT "FK_d9738a44f8f8e8436c9bbdcf0d6"
+        `);
+        await queryRunner.query(`
+            DROP TABLE "realm_feed_item_comment_vote"
+        `);
+        await queryRunner.query(`
+            DROP TABLE "realm_feed_item_comment"
+        `);
+    }
+
+}

src/app.module.ts

@@ -19,6 +19,7 @@ import { ConfigModule } from '@src/config/config.module';
 import { ConfigService } from '@src/config/config.service';
 import { HolaplexModule } from '@src/holaplex/holaplex.module';
 import { OnChainModule } from '@src/on-chain/on-chain.module';
+import { RealmFeedItemCommentModule } from '@src/realm-feed-item-comment/realm-feed-item-comment.module';
 import { RealmFeedItemModule } from '@src/realm-feed-item/realm-feed-item.module';
 import { RealmFeedModule } from '@src/realm-feed/realm-feed.module';
 import { RealmGovernanceModule } from '@src/realm-governance/realm-governance.module';
@@ -78,6 +79,7 @@ import { UserModule } from '@src/user/user.module';
     OnChainModule,
     RealmGovernanceModule,
     TaskDedupeModule,
+    RealmFeedItemCommentModule,
   ],
   controllers: [AppController],
   providers: [

src/lib/scalars/RealmFeedItemCommentID.ts

@@ -0,0 +1,21 @@
+import { Kind, ValueNode, GraphQLScalarType } from 'graphql';
+
+const RADIX = 36;
+
+export const RealmFeedItemCommentIDScalar = new GraphQLScalarType({
+  name: "RealmFeedItemCommentID",
+  description: 'An opaque id used to identify `RealmFeedItemComment`s',
+  // @ts-ignore
+  parseLiteral: (ast: ValueNode): string => {
+    // @ts-ignore
+    return ast.kind === Kind.STRING ? parseInt(ast.value, RADIX) : null;
+  },
+  // @ts-ignore
+  parseValue: (value: string): number => {
+    return parseInt(value, RADIX);
+  },
+  // @ts-ignore
+  serialize: (value: number): string => {
+    return value.toString(RADIX);
+  },
+})

src/realm-feed-item-comment/dto/RealmFeedItemComment.ts

@@ -0,0 +1,73 @@
+import { Field, ObjectType } from '@nestjs/graphql';
+
+import { RichTextDocumentScalar } from '@lib/scalars/RichTextDocument';
+import { RichTextDocument } from '@lib/types/RichTextDocument';
+import { RealmFeedItemCommentIDScalar } from '@src/lib/scalars/RealmFeedItemCommentID';
+import { RealmFeedItemIDScalar } from '@src/lib/scalars/RealmFeedItemID';
+import { RealmMember } from '@src/realm-member/dto/RealmMember';
+
+import { RealmFeedItemCommentVoteType } from './RealmFeedItemCommentVoteType';
+
+@ObjectType({
+  description: 'A comment on a feed item',
+})
+export class RealmFeedItemComment {
+  @Field(() => RealmMember, {
+    description: 'The creator of the comment',
+    nullable: true,
+  })
+  author?: RealmMember;
+
+  @Field(() => Date, {
+    description: 'When the comment was created',
+  })
+  created: Date;
+
+  @Field(() => RichTextDocumentScalar, {
+    description: 'Comment body text',
+  })
+  document: RichTextDocument;
+
+  @Field(() => RealmFeedItemIDScalar, {
+    description: 'ID of the feed item the comment is in',
+  })
+  feedItemId: number;
+
+  @Field(() => RealmFeedItemCommentIDScalar, {
+    description: 'ID of the comment',
+  })
+  id: number;
+
+  @Field(() => RealmFeedItemCommentVoteType, {
+    description: "The requesting user's vote on the comment",
+    nullable: true,
+  })
+  myVote?: RealmFeedItemCommentVoteType;
+
+  @Field(() => RealmFeedItemCommentIDScalar, {
+    description: 'ID of the parent comment',
+    nullable: true,
+  })
+  parentCommentId?: number | null;
+
+  @Field(() => [RealmFeedItemComment], {
+    description: 'Replies to the comment',
+    nullable: true,
+  })
+  replies?: RealmFeedItemComment[] | null;
+
+  @Field(() => Number, {
+    description: 'The number of immediate replies to this comment',
+  })
+  repliesCount: number;
+
+  @Field(() => Number, {
+    description: 'The total raw score for the comment',
+  })
+  score: number;
+
+  @Field(() => Date, {
+    description: 'When the comment was last updated',
+  })
+  updated: Date;
+}

src/realm-feed-item-comment/dto/RealmFeedItemCommentVoteType.ts

@@ -0,0 +1,22 @@
+import { registerEnumType } from '@nestjs/graphql';
+
+/**
+ * A vote for a comment, affecting the comment's score
+ */
+export enum RealmFeedItemCommentVoteType {
+  Approve = 'Approve',
+  Disapprove = 'Disapprove',
+}
+
+registerEnumType(RealmFeedItemCommentVoteType, {
+  name: 'RealmFeedItemCommentVoteType',
+  description: 'A vote on a comment',
+  valuesMap: {
+    [RealmFeedItemCommentVoteType.Approve]: {
+      description: 'The comment was approved',
+    },
+    [RealmFeedItemCommentVoteType.Disapprove]: {
+      description: 'The comment was disapproved',
+    },
+  },
+});

src/realm-feed-item-comment/dto/pagination.ts

@@ -0,0 +1,28 @@
+import { ObjectType, registerEnumType } from '@nestjs/graphql';
+
+import { EdgeType, ConnectionType } from '@lib/gqlTypes/Connection';
+
+import { RealmFeedItemComment } from './RealmFeedItemComment';
+
+@ObjectType()
+export class RealmFeedItemCommentEdge extends EdgeType(
+  'RealmFeedItemComment',
+  RealmFeedItemComment as any,
+) {}
+
+@ObjectType()
+export class RealmFeedItemCommentConnection extends ConnectionType<RealmFeedItemCommentEdge>(
+  'RealmFeedItemComment',
+  RealmFeedItemCommentEdge,
+) {}
+
+export enum RealmFeedItemCommentSort {
+  New = 'New',
+  Relevance = 'Relevance',
+  TopAllTime = 'TopAllTime',
+}
+
+registerEnumType(RealmFeedItemCommentSort, {
+  name: 'RealmFeedItemCommentSort',
+  description: 'Sort order for a list of comments',
+});

src/realm-feed-item-comment/entities/RealmFeedItemComment.entity.ts

@@ -0,0 +1,67 @@
+import {
+  Column,
+  CreateDateColumn,
+  DeleteDateColumn,
+  Entity,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+  ManyToOne,
+} from 'typeorm';
+
+import { Environment } from '@lib/types/Environment';
+import { RichTextDocument } from '@lib/types/RichTextDocument';
+import { RealmFeedItem } from '@src/realm-feed-item/entities/RealmFeedItem.entity';
+import { User } from '@src/user/entities/User.entity';
+
+export interface Data {
+  authorPublicKeyStr?: string;
+  document: RichTextDocument;
+}
+
+export interface Metadata {
+  relevanceScore: number;
+  topAllTimeScore: number;
+  rawScore: number;
+}
+
+@Entity()
+export class RealmFeedItemComment {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @Column()
+  authorId: string;
+
+  @Column('jsonb')
+  data: Data;
+
+  @Column()
+  feedItemId: number;
+
+  @Column('varchar')
+  environment: Environment;
+
+  @Column('jsonb')
+  metadata: Metadata;
+
+  @Column({ nullable: true })
+  parentCommentId?: number;
+
+  @Column()
+  realmPublicKeyStr: string;
+
+  @ManyToOne('User', 'posts')
+  author: User;
+
+  @ManyToOne('RealmFeedItem', 'comments')
+  feedItem: RealmFeedItem;
+
+  @CreateDateColumn()
+  created: Date;
+
+  @DeleteDateColumn()
+  deleted: Date;
+
+  @UpdateDateColumn()
+  updated: Date;
+}

src/realm-feed-item-comment/entities/RealmFeedItemCommentVote.entity.ts

@@ -0,0 +1,39 @@
+import {
+  Column,
+  CreateDateColumn,
+  DeleteDateColumn,
+  Entity,
+  PrimaryColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+
+import { RealmFeedItemCommentVoteType } from '../dto/RealmFeedItemCommentVoteType';
+
+export interface Data {
+  type: RealmFeedItemCommentVoteType;
+  relevanceWeight: number;
+}
+
+@Entity()
+export class RealmFeedItemCommentVote {
+  @PrimaryColumn()
+  commentId: number;
+
+  @PrimaryColumn('uuid')
+  userId: string;
+
+  @PrimaryColumn()
+  realmPublicKeyStr: string;
+
+  @Column('jsonb')
+  data: Data;
+
+  @CreateDateColumn()
+  created: Date;
+
+  @DeleteDateColumn()
+  deleted: Date;
+
+  @UpdateDateColumn()
+  updated: Date;
+}

src/realm-feed-item-comment/realm-feed-item-comment.module.ts

@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+
+import { RealmFeedItemComment } from './entities/RealmFeedItemComment.entity';
+import { RealmFeedItemCommentVote } from './entities/RealmFeedItemCommentVote.entity';
+import { RealmFeedItemCommentResolver } from './realm-feed-item-comment.resolver';
+import { RealmFeedItemCommentService } from './realm-feed-item-comment.service';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([RealmFeedItemComment, RealmFeedItemCommentVote])],
+  providers: [RealmFeedItemCommentService, RealmFeedItemCommentResolver],
+  exports: [RealmFeedItemCommentService],
+})
+export class RealmFeedItemCommentModule {}

src/realm-feed-item-comment/realm-feed-item-comment.resolver.spec.ts

@@ -0,0 +1,19 @@
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { RealmFeedItemCommentResolver } from './realm-feed-item-comment.resolver';
+
+describe('RealmFeedItemCommentResolver', () => {
+  let resolver: RealmFeedItemCommentResolver;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [RealmFeedItemCommentResolver],
+    }).compile();
+
+    resolver = module.get<RealmFeedItemCommentResolver>(RealmFeedItemCommentResolver);
+  });
+
+  it('should be defined', () => {
+    expect(resolver).toBeDefined();
+  });
+});