Skip to content

feat: add GraphQL query for top post comments #3402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
idoshamun merged 4 commits into from
Jan 6, 2026
Merged

feat: add GraphQL query for top post comments #3402

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
73d8eec
feat: add topComments GraphQL query
claude Jan 6, 2026
1eb60f8
feat: support post slug in topComments query
claude Jan 6, 2026
44400af
refactor: remove unnecessary user blocking filter from topComments query
github-actions[bot] Jan 6, 2026
8be4c60
fix: use auto-generated slug in topComments query test
idoshamun Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions __tests__/comments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,34 @@ describe('query userComments', () => {
});
});

describe('query topComments', () => {
const QUERY = `query TopComments($postId: ID!, $first: Int) {
topComments(postId: $postId, first: $first) {
id
numUpvotes
content
}
}`;

it('should return comments ordered by upvotes descending', async () => {
// Set different upvote counts for comments on p1
await con.getRepository(Comment).update({ id: 'c1' }, { upvotes: 5 });
await con.getRepository(Comment).update({ id: 'c3' }, { upvotes: 10 });
await con.getRepository(Comment).update({ id: 'c6' }, { upvotes: 3 });

const res = await client.query(QUERY, { variables: { postId: 'p1' } });
expect(res.errors).toBeFalsy();
expect(res.data.topComments).toHaveLength(3);
// Should be ordered by upvotes descending
expect(res.data.topComments[0].id).toEqual('c3');
expect(res.data.topComments[0].numUpvotes).toEqual(10);
expect(res.data.topComments[1].id).toEqual('c1');
expect(res.data.topComments[1].numUpvotes).toEqual(5);
expect(res.data.topComments[2].id).toEqual('c6');
expect(res.data.topComments[2].numUpvotes).toEqual(3);
});
});

describe('query commentFeed', () => {
const QUERY = `query CommentFeed($after: String, $first: Int) {
commentFeed(after: $after, first: $first) {
Expand Down
56 changes: 56 additions & 0 deletions src/schema/comments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,21 @@ export const typeDefs = /* GraphQL */ `
"""
id: ID!
): CommentBalance!

"""
Get top comments of a post ordered by upvotes
"""
topComments(
"""
Post id
"""
postId: ID!

"""
Number of comments to return (max 20)
"""
first: Int
): [Comment!]!
}

extend type Mutation {
Expand Down Expand Up @@ -521,6 +536,11 @@ export interface GQLUserCommentsArgs extends ConnectionArguments {
userId: string;
}

export interface GQLTopCommentsArgs {
postId: string;
first?: number;
}

export interface MentionedUser {
id: string;
username?: string;
Expand Down Expand Up @@ -986,6 +1006,42 @@ export const resolvers: IResolvers<unknown, BaseContext> = traceResolvers<

return result;
},
topComments: async (
_,
args: GQLTopCommentsArgs,
ctx: Context,
info,
): Promise<GQLComment[]> => {
const maxLimit = 20;
const limit = Math.min(args.first ?? maxLimit, maxLimit);

const post = await ctx.con.getRepository(Post).findOneOrFail({
select: ['sourceId'],
where: { id: args.postId },
});
await ensureSourcePermissions(ctx, post.sourceId);

return graphorm.query<GQLComment>(ctx, info, (builder) => {
builder.queryBuilder = builder.queryBuilder
.andWhere(`${builder.alias}.postId = :postId`, {
postId: args.postId,
})
.andWhere(`${builder.alias}.parentId is null`)
.andWhere(whereVordrFilter(builder.alias, ctx.userId))
.orderBy(`${builder.alias}.upvotes`, 'DESC')
.limit(limit);

if (ctx.userId) {
builder.queryBuilder.andWhere(
whereNotUserBlocked(builder.queryBuilder, {
Copy link
Contributor

@rebelchris rebelchris Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why SEO cares about it?

Copy link
Member Author

@idoshamun idoshamun Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need it, indeed

Copy link
Member Author

@idoshamun idoshamun Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@claude fix it. make sure lint pass

Copy link

@claude claude bot Jan 6, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude finished @idoshamun's task in 2m 5s —— View job

Completed

  • Read the changed files to understand the context
  • Identify what needs to be fixed based on review comments
  • Remove unnecessary user blocking filter
  • Commit and push changes

Summary

Removed the whereNotUserBlocked filter from the topComments query implementation (lines 1034-1040 in src/schema/comments.ts).

Rationale: For the SEO use case, crawlers are unauthenticated and won't have a ctx.userId, so this conditional filter wouldn't apply anyway. Removing it simplifies the code while maintaining the same behavior for SEO purposes.

The auto-lint hook should handle any formatting issues automatically.

Changes pushed

  • Commit: 44400af - refactor: remove unnecessary user blocking filter from topComments query
  • Branch: claude/add-top-comments-query-cxkqL

|

userId: ctx.userId,
}),
);
}

return builder;
});
},
},
Mutation: {
commentOnPost: async (
Expand Down
Loading