mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-04-01 02:41:39 -05:00
Added endpoint for comments/post/:post_id
refs https://linear.app/tryghost/issue/ENG-676/ This is pretty simple as we can reuse the existing browse method on the CommentsController, but we need to add support for the post_id option to the endpoint, for it to be added to the frame. We also need to update the browse method to enforce the post_id on the NQL filter. I initially tried this with string concatenation, but ran into way too many bugs, so we're using a mongo transformer instead.
This commit is contained in:
Fabien O'Carroll
Fabien 'egg' O'Carroll
parent
f032f11d8a
commit
2c6321472c
5 changed files with 200 additions and 2 deletions
|
|
@ -10,6 +10,7 @@ module.exports = {
|
|||
cacheInvalidate: false
|
||||
},
|
||||
options: [
|
||||
'post_id',
|
||||
'include',
|
||||
'page',
|
||||
'limit',
|
||||
|
|
|
|||
|
|
@ -35,6 +35,22 @@ module.exports = class CommentsController {
|
|||
* @param {Frame} frame
|
||||
*/
|
||||
async browse(frame) {
|
||||
if (frame.options.post_id) {
|
||||
if (frame.options.filter) {
|
||||
frame.options.mongoTransformer = function (query) {
|
||||
return {
|
||||
$and: [
|
||||
{
|
||||
post_id: frame.options.post_id
|
||||
},
|
||||
query
|
||||
]
|
||||
};
|
||||
};
|
||||
} else {
|
||||
frame.options.filter = `post_id:${frame.options.post_id}`;
|
||||
}
|
||||
}
|
||||
return this.service.getComments(frame.options);
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -21,6 +21,7 @@ module.exports = function apiRoutes() {
|
|||
router.use(membersService.middleware.loadMemberSession);
|
||||
|
||||
router.get('/', http(api.commentsMembers.browse));
|
||||
router.get('/post/:post_id', http(api.commentsMembers.browse));
|
||||
router.get('/:id', http(api.commentsMembers.read));
|
||||
router.post('/', http(api.commentsMembers.add));
|
||||
router.put('/:id', http(api.commentsMembers.edit));
|
||||
|
|
|
|||
|
|
@ -1666,6 +1666,94 @@ Object {
|
|||
}
|
||||
`;
|
||||
|
||||
exports[`Comments API when commenting enabled for all when authenticated Can browse all comments of a post (legacy) 1: [body] 1`] = `
|
||||
Object {
|
||||
"comments": Array [
|
||||
Object {
|
||||
"count": Object {
|
||||
"likes": Any<Number>,
|
||||
"replies": Any<Number>,
|
||||
},
|
||||
"created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
|
||||
"edited_at": null,
|
||||
"html": "<p>First.</p>",
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"liked": Any<Boolean>,
|
||||
"member": Object {
|
||||
"avatar_image": null,
|
||||
"expertise": null,
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"name": "Mr Egg",
|
||||
"uuid": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
},
|
||||
"replies": Array [
|
||||
Object {
|
||||
"count": Object {
|
||||
"likes": Any<Number>,
|
||||
},
|
||||
"created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
|
||||
"edited_at": null,
|
||||
"html": "<p>Really original</p>",
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"liked": Any<Boolean>,
|
||||
"member": Object {
|
||||
"avatar_image": null,
|
||||
"expertise": null,
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"name": null,
|
||||
"uuid": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
},
|
||||
"status": "published",
|
||||
},
|
||||
],
|
||||
"status": "published",
|
||||
},
|
||||
Object {
|
||||
"count": Object {
|
||||
"likes": Any<Number>,
|
||||
"replies": 0,
|
||||
},
|
||||
"created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
|
||||
"edited_at": null,
|
||||
"html": "<p>This is a message</p><p></p><p>New line</p>",
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"liked": Any<Boolean>,
|
||||
"member": Object {
|
||||
"avatar_image": null,
|
||||
"expertise": null,
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"name": null,
|
||||
"uuid": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
},
|
||||
"replies": Array [],
|
||||
"status": "published",
|
||||
},
|
||||
],
|
||||
"meta": Object {
|
||||
"pagination": Object {
|
||||
"limit": 15,
|
||||
"next": null,
|
||||
"page": 1,
|
||||
"pages": 1,
|
||||
"prev": null,
|
||||
"total": 2,
|
||||
},
|
||||
},
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`Comments API when commenting enabled for all when authenticated Can browse all comments of a post (legacy) 2: [headers] 1`] = `
|
||||
Object {
|
||||
"access-control-allow-origin": "*",
|
||||
"cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
|
||||
"content-length": "1118",
|
||||
"content-type": "application/json; charset=utf-8",
|
||||
"etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,
|
||||
"vary": "Accept-Encoding",
|
||||
"x-powered-by": "Express",
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`Comments API when commenting enabled for all when authenticated Can browse all comments of a post 1: [body] 1`] = `
|
||||
Object {
|
||||
"comments": Array [
|
||||
|
|
@ -3025,6 +3113,74 @@ Object {
|
|||
}
|
||||
`;
|
||||
|
||||
exports[`Comments API when commenting enabled for all when not authenticated Can browse all comments of a post (legacy) 1: [body] 1`] = `
|
||||
Object {
|
||||
"comments": Array [
|
||||
Object {
|
||||
"count": Object {
|
||||
"likes": Any<Number>,
|
||||
"replies": Any<Number>,
|
||||
},
|
||||
"created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
|
||||
"edited_at": null,
|
||||
"html": "<p>First.</p>",
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"liked": Any<Boolean>,
|
||||
"member": Object {
|
||||
"avatar_image": null,
|
||||
"expertise": null,
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"name": "Mr Egg",
|
||||
"uuid": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
},
|
||||
"replies": Array [
|
||||
Object {
|
||||
"count": Object {
|
||||
"likes": Any<Number>,
|
||||
},
|
||||
"created_at": StringMatching /\\\\d\\{4\\}-\\\\d\\{2\\}-\\\\d\\{2\\}T\\\\d\\{2\\}:\\\\d\\{2\\}:\\\\d\\{2\\}\\\\\\.000Z/,
|
||||
"edited_at": null,
|
||||
"html": "<p>Really original</p>",
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"liked": Any<Boolean>,
|
||||
"member": Object {
|
||||
"avatar_image": null,
|
||||
"expertise": null,
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{24\\}/,
|
||||
"name": null,
|
||||
"uuid": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
},
|
||||
"status": "published",
|
||||
},
|
||||
],
|
||||
"status": "published",
|
||||
},
|
||||
],
|
||||
"meta": Object {
|
||||
"pagination": Object {
|
||||
"limit": 15,
|
||||
"next": null,
|
||||
"page": 1,
|
||||
"pages": 1,
|
||||
"prev": null,
|
||||
"total": 1,
|
||||
},
|
||||
},
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`Comments API when commenting enabled for all when not authenticated Can browse all comments of a post (legacy) 2: [headers] 1`] = `
|
||||
Object {
|
||||
"access-control-allow-origin": "*",
|
||||
"cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
|
||||
"content-length": "753",
|
||||
"content-type": "application/json; charset=utf-8",
|
||||
"etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,
|
||||
"vary": "Accept-Encoding",
|
||||
"x-powered-by": "Express",
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`Comments API when commenting enabled for all when not authenticated Can browse all comments of a post 1: [body] 1`] = `
|
||||
Object {
|
||||
"comments": Array [
|
||||
|
|
|
|||
|
|
@ -211,7 +211,7 @@ describe('Comments API', function () {
|
|||
sinon.restore();
|
||||
});
|
||||
|
||||
it('Can browse all comments of a post', async function () {
|
||||
it('Can browse all comments of a post (legacy)', async function () {
|
||||
await membersAgent
|
||||
.get(`/api/comments/?filter=post_id:'${postId}'`)
|
||||
.expectStatus(200)
|
||||
|
|
@ -223,6 +223,18 @@ describe('Comments API', function () {
|
|||
});
|
||||
});
|
||||
|
||||
it('Can browse all comments of a post', async function () {
|
||||
await membersAgent
|
||||
.get(`/api/comments/post/${postId}/`)
|
||||
.expectStatus(200)
|
||||
.matchHeaderSnapshot({
|
||||
etag: anyEtag
|
||||
})
|
||||
.matchBodySnapshot({
|
||||
comments: [commentMatcherWithReplies({replies: 1})]
|
||||
});
|
||||
});
|
||||
|
||||
it('cannot comment on a post', async function () {
|
||||
await testCannotCommentOnPost(401);
|
||||
});
|
||||
|
|
@ -306,7 +318,7 @@ describe('Comments API', function () {
|
|||
await testCanCommentOnPost(member);
|
||||
});
|
||||
|
||||
it('Can browse all comments of a post', async function () {
|
||||
it('Can browse all comments of a post (legacy)', async function () {
|
||||
await membersAgent
|
||||
.get(`/api/comments/?filter=post_id:'${postId}'`)
|
||||
.expectStatus(200)
|
||||
|
|
@ -318,6 +330,18 @@ describe('Comments API', function () {
|
|||
});
|
||||
});
|
||||
|
||||
it('Can browse all comments of a post', async function () {
|
||||
await membersAgent
|
||||
.get(`/api/comments/post/${postId}/`)
|
||||
.expectStatus(200)
|
||||
.matchHeaderSnapshot({
|
||||
etag: anyEtag
|
||||
})
|
||||
.matchBodySnapshot({
|
||||
comments: [commentMatcherWithReplies({replies: 1}), commentMatcher]
|
||||
});
|
||||
});
|
||||
|
||||
it('Can reply to your own comment', async function () {
|
||||
// Should not update last_seen_at or last_commented_at when both are already set to a value on the same day
|
||||
const timezone = settingsCache.get('timezone');
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue