mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-04-01 02:41:39 -05:00
Added in-reply-to support to comments API
ref https://linear.app/tryghost/issue/PLG-230 - adds `in_reply_to_id` to API output - adds `in_reply_to_snippet` to API output - dynamically generated from the HTML of the replied-to comment - excluded if the replied-to comment has been deleted or hidden - adds `commentSnippet` to `@tryghost/html-to-plaintext` - skips anchor tag URLs as they won't be useful for snippet purposes - skips blockquotes so the snippet is more likely to contain the unique content of the replied-to comment when it's quoting a previous comment - returns a single line (no newline chars) - allows setting `in_reply_to_id` when creating comments - id must reference a reply with the same parent - id must reference a published comment - adds email notification for the original reply author when their comment is replied to
This commit is contained in:
Kevin Ansfield
parent
f9b0280553
commit
79f41dc679
12 changed files with 649 additions and 2156 deletions
|
|
@ -109,7 +109,6 @@ const controller = {
|
|||
},
|
||||
options: [
|
||||
'include'
|
||||
|
||||
],
|
||||
validation: {
|
||||
options: {
|
||||
|
|
|
|||
|
|
@ -1,9 +1,12 @@
|
|||
const _ = require('lodash');
|
||||
const utils = require('../../..');
|
||||
const url = require('../utils/url');
|
||||
const htmlToPlaintext = require('@tryghost/html-to-plaintext');
|
||||
|
||||
const commentFields = [
|
||||
'id',
|
||||
'in_reply_to_id',
|
||||
'in_reply_to_snippet',
|
||||
'status',
|
||||
'html',
|
||||
'created_at',
|
||||
|
|
@ -42,6 +45,10 @@ const countFields = [
|
|||
const commentMapper = (model, frame) => {
|
||||
const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
|
||||
|
||||
if (jsonModel.inReplyTo && jsonModel.inReplyTo.status === 'published') {
|
||||
jsonModel.in_reply_to_snippet = htmlToPlaintext.commentSnippet(jsonModel.inReplyTo.html);
|
||||
}
|
||||
|
||||
const response = _.pick(jsonModel, commentFields);
|
||||
|
||||
if (jsonModel.member) {
|
||||
|
|
@ -59,7 +66,7 @@ const commentMapper = (model, frame) => {
|
|||
}
|
||||
|
||||
if (jsonModel.post) {
|
||||
// We could use the post mapper here, but we need less field + don't need al the async behavior support
|
||||
// We could use the post mapper here, but we need less field + don't need all the async behavior support
|
||||
url.forPost(jsonModel.post.id, jsonModel.post, frame);
|
||||
response.post = _.pick(jsonModel.post, postFields);
|
||||
}
|
||||
|
|
@ -77,7 +84,7 @@ const commentMapper = (model, frame) => {
|
|||
response.html = null;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
return response;
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,10 @@ const Comment = ghostBookshelf.Model.extend({
|
|||
return this.belongsTo('Comment', 'parent_id');
|
||||
},
|
||||
|
||||
inReplyTo() {
|
||||
return this.belongsTo('Comment', 'in_reply_to_id');
|
||||
},
|
||||
|
||||
likes() {
|
||||
return this.hasMany('CommentLike', 'comment_id');
|
||||
},
|
||||
|
|
@ -181,25 +185,26 @@ const Comment = ghostBookshelf.Model.extend({
|
|||
/**
|
||||
* We have to ensure consistency. If you listen on model events (e.g. `member.added`), you can expect that you always
|
||||
* receive all fields including relations. Otherwise you can't rely on a consistent flow. And we want to avoid
|
||||
* that event listeners have to re-fetch a resource. This function is used in the context of inserting
|
||||
* and updating resources. We won't return the relations by default for now.
|
||||
* that event listeners have to re-fetch a resource.
|
||||
*/
|
||||
defaultRelations: function defaultRelations(methodName, options) {
|
||||
// @todo: the default relations are not working for 'add' when we add it below
|
||||
// @TODO: the default relations are not working for 'add' when we add it below
|
||||
// this is because bookshelf does not automatically call `fetch` after adding so
|
||||
// our bookshelf eager-load plugin doesn't use the `withRelated` options
|
||||
if (['findAll', 'findPage', 'edit', 'findOne', 'destroy'].indexOf(methodName) !== -1) {
|
||||
if (!options.withRelated || options.withRelated.length === 0) {
|
||||
if (options.parentId) {
|
||||
// Do not include replies for replies
|
||||
options.withRelated = [
|
||||
// Relations
|
||||
'member', 'count.likes', 'count.liked'
|
||||
'inReplyTo', 'member', 'count.likes', 'count.liked'
|
||||
];
|
||||
} else {
|
||||
options.withRelated = [
|
||||
// Relations
|
||||
'member', 'count.replies', 'count.likes', 'count.liked',
|
||||
'member', 'inReplyTo', 'count.replies', 'count.likes', 'count.liked',
|
||||
// Replies (limited to 3)
|
||||
'replies', 'replies.member' , 'replies.count.likes', 'replies.count.liked'
|
||||
'replies', 'replies.member', 'replies.inReplyTo', 'replies.count.likes', 'replies.count.liked'
|
||||
];
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -115,6 +115,7 @@ module.exports = class CommentsController {
|
|||
if (data.parent_id) {
|
||||
result = await this.service.replyToComment(
|
||||
data.parent_id,
|
||||
data.in_reply_to_id,
|
||||
frame.options.context.member.id,
|
||||
data.html,
|
||||
frame.options
|
||||
|
|
|
|||
|
|
@ -83,7 +83,10 @@ class CommentsService {
|
|||
await this.emails.notifyPostAuthors(comment);
|
||||
|
||||
if (comment.get('parent_id')) {
|
||||
await this.emails.notifyParentCommentAuthor(comment);
|
||||
await this.emails.notifyParentCommentAuthor(comment, {type: 'parent'});
|
||||
}
|
||||
if (comment.get('in_reply_to_id')) {
|
||||
await this.emails.notifyParentCommentAuthor(comment, {type: 'in_reply_to'});
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -253,11 +256,12 @@ class CommentsService {
|
|||
|
||||
/**
|
||||
* @param {string} parent - The ID of the Comment to reply to
|
||||
* @param {string} inReplyTo - The ID of the Reply to reply to
|
||||
* @param {string} member - The ID of the Member to comment as
|
||||
* @param {string} comment - The HTML content of the Comment
|
||||
* @param {any} options
|
||||
*/
|
||||
async replyToComment(parent, member, comment, options) {
|
||||
async replyToComment(parent, inReplyTo, member, comment, options) {
|
||||
this.checkEnabled();
|
||||
const memberModel = await this.models.Member.findOne({
|
||||
id: member
|
||||
|
|
@ -281,6 +285,7 @@ class CommentsService {
|
|||
message: tpl(messages.replyToReply)
|
||||
});
|
||||
}
|
||||
|
||||
const postModel = await this.models.Post.findOne({
|
||||
id: parentComment.get('post_id')
|
||||
}, {
|
||||
|
|
@ -291,10 +296,27 @@ class CommentsService {
|
|||
|
||||
this.checkPostAccess(postModel, memberModel);
|
||||
|
||||
let inReplyToComment;
|
||||
if (parent && inReplyTo) {
|
||||
inReplyToComment = await this.getCommentByID(inReplyTo, options);
|
||||
|
||||
// we only allow references to published comments to avoid leaking
|
||||
// hidden data via the snippet included in API responses
|
||||
if (inReplyToComment && inReplyToComment.get('status') !== 'published') {
|
||||
inReplyToComment = null;
|
||||
}
|
||||
|
||||
// we don't allow in_reply_to references across different parents
|
||||
if (inReplyToComment && inReplyToComment.get('parent_id') !== parent) {
|
||||
inReplyToComment = null;
|
||||
}
|
||||
}
|
||||
|
||||
const model = await this.models.Comment.add({
|
||||
post_id: parentComment.get('post_id'),
|
||||
member_id: member,
|
||||
parent_id: parentComment.id,
|
||||
in_reply_to_id: inReplyToComment && inReplyToComment.get('id'),
|
||||
html: comment,
|
||||
status: 'published'
|
||||
}, options);
|
||||
|
|
|
|||
|
|
@ -60,8 +60,13 @@ class CommentsServiceEmails {
|
|||
}
|
||||
}
|
||||
|
||||
async notifyParentCommentAuthor(reply) {
|
||||
const parent = await this.models.Comment.findOne({id: reply.get('parent_id')});
|
||||
async notifyParentCommentAuthor(reply, {type = 'parent'} = {}) {
|
||||
let parent;
|
||||
if (type === 'in_reply_to') {
|
||||
parent = await this.models.Comment.findOne({id: reply.get('in_reply_to_id')});
|
||||
} else {
|
||||
parent = await this.models.Comment.findOne({id: reply.get('parent_id')});
|
||||
}
|
||||
const parentMember = parent.related('member');
|
||||
|
||||
if (parent?.get('status') !== 'published' || !parentMember.get('enable_comment_notifications')) {
|
||||
|
|
|
|||
|
|
@ -22699,7 +22699,7 @@ exports[`Activity Feed API Can filter events by post id 2: [headers] 1`] = `
|
|||
Object {
|
||||
"access-control-allow-origin": "http://127.0.0.1:2369",
|
||||
"cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
|
||||
"content-length": "17559",
|
||||
"content-length": "17625",
|
||||
"content-type": "application/json; charset=utf-8",
|
||||
"content-version": StringMatching /v\\\\d\\+\\\\\\.\\\\d\\+/,
|
||||
"etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,
|
||||
|
|
@ -22867,7 +22867,7 @@ exports[`Activity Feed API Filter splitting Can use NQL OR for type only 2: [hea
|
|||
Object {
|
||||
"access-control-allow-origin": "http://127.0.0.1:2369",
|
||||
"cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
|
||||
"content-length": "5114",
|
||||
"content-length": "5180",
|
||||
"content-type": "application/json; charset=utf-8",
|
||||
"content-version": StringMatching /v\\\\d\\+\\\\\\.\\\\d\\+/,
|
||||
"etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,
|
||||
|
|
@ -23914,7 +23914,7 @@ exports[`Activity Feed API Returns comments in activity feed 2: [headers] 1`] =
|
|||
Object {
|
||||
"access-control-allow-origin": "http://127.0.0.1:2369",
|
||||
"cache-control": "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0",
|
||||
"content-length": "1238",
|
||||
"content-length": "1304",
|
||||
"content-type": "application/json; charset=utf-8",
|
||||
"content-version": StringMatching /v\\\\d\\+\\\\\\.\\\\d\\+/,
|
||||
"etag": StringMatching /\\(\\?:W\\\\/\\)\\?"\\(\\?:\\[ !#-\\\\x7E\\\\x80-\\\\xFF\\]\\*\\|\\\\r\\\\n\\[\\\\t \\]\\|\\\\\\\\\\.\\)\\*"/,
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -1,6 +1,6 @@
|
|||
const assert = require('assert/strict');
|
||||
const {agentProvider, mockManager, fixtureManager, matchers, configUtils, dbUtils} = require('../../utils/e2e-framework');
|
||||
const {anyEtag, anyObjectId, anyLocationFor, anyISODateTime, anyErrorId, anyUuid, anyNumber, anyBoolean} = matchers;
|
||||
const {nullable, anyEtag, anyObjectId, anyLocationFor, anyISODateTime, anyErrorId, anyUuid, anyNumber, anyBoolean} = matchers;
|
||||
const should = require('should');
|
||||
const models = require('../../../core/server/models');
|
||||
const moment = require('moment-timezone');
|
||||
|
|
@ -20,13 +20,17 @@ const dbFns = {
|
|||
* @property {string} [post_id=postId]
|
||||
* @property {string} member_id
|
||||
* @property {string} [parent_id]
|
||||
* @property {string} [in_reply_to_id]
|
||||
* @property {string} [html='This is a comment']
|
||||
* @property {string} [status]
|
||||
* @property {Date} [created_at]
|
||||
*/
|
||||
/**
|
||||
* @typedef {Object} AddCommentReplyData
|
||||
* @property {string} member_id
|
||||
* @property {string} [html='This is a reply']
|
||||
* @property {date} [created_at]
|
||||
* @property {Date} [created_at]
|
||||
* @property {string} [status]
|
||||
*/
|
||||
/**
|
||||
* @typedef {AddCommentData & {replies: AddCommentReplyData[]}} AddCommentWithRepliesData
|
||||
|
|
@ -42,7 +46,9 @@ const dbFns = {
|
|||
member_id: data.member_id,
|
||||
parent_id: data.parent_id,
|
||||
html: data.html || '<p>This is a comment</p>',
|
||||
created_at: data.created_at
|
||||
created_at: data.created_at,
|
||||
in_reply_to_id: data.in_reply_to_id,
|
||||
status: data.status || 'published'
|
||||
});
|
||||
},
|
||||
/**
|
||||
|
|
@ -60,7 +66,8 @@ const dbFns = {
|
|||
post_id: parent.get('post_id'),
|
||||
member_id: reply.member_id,
|
||||
parent_id: parent.get('id'),
|
||||
html: reply.html || '<p>This is a reply</p>'
|
||||
html: reply.html || '<p>This is a reply</p>',
|
||||
status: reply.status
|
||||
});
|
||||
createdReplies.push(createdReply);
|
||||
}
|
||||
|
|
@ -95,6 +102,7 @@ const dbFns = {
|
|||
|
||||
const commentMatcher = {
|
||||
id: anyObjectId,
|
||||
in_reply_to_id: nullable(anyObjectId),
|
||||
created_at: anyISODateTime,
|
||||
member: {
|
||||
id: anyObjectId,
|
||||
|
|
@ -184,24 +192,32 @@ function testGetComments(url, commentsMatcher) {
|
|||
* @param {string} data.post_id
|
||||
* @param {string} data.html
|
||||
* @param {string} [data.parent_id]
|
||||
* @param {string} [data.in_reply_to_id]
|
||||
* @param {Object} [options]
|
||||
* @param {number} [options.status = 201]
|
||||
* @param {Object} [options.matchHeaderSnapshot]
|
||||
* @param {Object} [options.matchBodySnapshot]
|
||||
* @returns {any} ExpectRequest
|
||||
*/
|
||||
function testPostComment({post_id, html, parent_id}, {status = 201, matchHeaderSnapshot = {}, matchBodySnapshot} = {}) {
|
||||
function testPostComment({post_id, html, parent_id, in_reply_to_id}, {status = 201, matchHeaderSnapshot = {}, matchBodySnapshot} = {}) {
|
||||
return membersAgent
|
||||
.post(`/api/comments/`)
|
||||
.body({comments: [{
|
||||
post_id,
|
||||
parent_id,
|
||||
in_reply_to_id,
|
||||
html
|
||||
}]})
|
||||
.expectStatus(status)
|
||||
.matchHeaderSnapshot({
|
||||
etag: anyEtag,
|
||||
location: anyLocationFor('comments'),
|
||||
'x-cache-invalidate': matchers.stringMatching(
|
||||
parent_id
|
||||
? new RegExp('/api/members/comments/post/[0-9a-f]{24}/, /api/members/comments/[0-9a-f]{24}/replies/')
|
||||
: new RegExp('/api/members/comments/post/[0-9a-f]{24}/')
|
||||
|
||||
),
|
||||
...matchHeaderSnapshot
|
||||
})
|
||||
.matchBodySnapshot({
|
||||
|
|
@ -256,12 +272,6 @@ async function testCanReply(member, emailMatchers = {}) {
|
|||
post_id: postId,
|
||||
parent_id: parentComment.get('id'),
|
||||
html: 'This is a reply'
|
||||
}, {
|
||||
matchHeaderSnapshot: {
|
||||
'x-cache-invalidate': matchers.stringMatching(
|
||||
new RegExp('/api/members/comments/post/[0-9a-f]{24}/, /api/members/comments/[0-9a-f]{24}/replies/')
|
||||
)
|
||||
}
|
||||
});
|
||||
|
||||
mockManager.assert.sentEmailCount(2);
|
||||
|
|
@ -587,12 +597,6 @@ describe('Comments API', function () {
|
|||
post_id: postId,
|
||||
parent_id: parentComment.id,
|
||||
html: 'This is a reply'
|
||||
}, {
|
||||
matchHeaderSnapshot: {
|
||||
'x-cache-invalidate': matchers.stringMatching(
|
||||
new RegExp('/api/members/comments/post/[0-9a-f]{24}/, /api/members/comments/[0-9a-f]{24}/replies/')
|
||||
)
|
||||
}
|
||||
});
|
||||
|
||||
// Check only the author got an email (because we are the author of this parent comment)
|
||||
|
|
@ -1020,6 +1024,160 @@ describe('Comments API', function () {
|
|||
|
||||
assert(!deletedComment.html);
|
||||
});
|
||||
|
||||
describe('replies to replies', function () {
|
||||
it('can set in_reply_to_id when creating a reply', async function () {
|
||||
const {replies: [reply]} = await dbFns.addCommentWithReplies({
|
||||
member_id: fixtureManager.get('members', 1).id,
|
||||
replies: [{
|
||||
member_id: fixtureManager.get('members', 2).id
|
||||
}]
|
||||
});
|
||||
|
||||
const {body: {comments: [newComment]}} = await testPostComment({
|
||||
post_id: postId,
|
||||
parent_id: reply.get('parent_id'),
|
||||
in_reply_to_id: reply.get('id'),
|
||||
html: '<p>This is a reply to a reply</p>'
|
||||
});
|
||||
|
||||
// in_reply_to is set
|
||||
newComment.in_reply_to_id.should.eql(reply.get('id'));
|
||||
newComment.in_reply_to_snippet.should.eql('This is a reply');
|
||||
|
||||
// replied-to comment author is notified
|
||||
// parent comment author is notified
|
||||
mockManager.assert.sentEmailCount(3);
|
||||
assertAuthorEmailSent(postAuthorEmail, postTitle);
|
||||
mockManager.assert.sentEmail({
|
||||
subject: '↪️ New reply to your comment on Ghost',
|
||||
to: fixtureManager.get('members', 1).email
|
||||
});
|
||||
mockManager.assert.sentEmail({
|
||||
subject: '↪️ New reply to your comment on Ghost',
|
||||
to: fixtureManager.get('members', 2).email
|
||||
});
|
||||
});
|
||||
|
||||
['deleted', 'hidden'].forEach((status) => {
|
||||
it(`cannot set in_reply_to_id to a ${status} comment`, async function () {
|
||||
const {replies: [reply]} = await dbFns.addCommentWithReplies({
|
||||
member_id: fixtureManager.get('members', 1).id,
|
||||
replies: [{
|
||||
member_id: fixtureManager.get('members', 2).id,
|
||||
status
|
||||
}]
|
||||
});
|
||||
|
||||
const {body: {comments: [newComment]}} = await testPostComment({
|
||||
post_id: postId,
|
||||
parent_id: reply.get('parent_id'),
|
||||
in_reply_to_id: reply.get('id'),
|
||||
html: '<p>This is a reply to a reply</p>'
|
||||
});
|
||||
|
||||
// in_reply_to is not set
|
||||
should.not.exist(newComment.in_reply_to_id);
|
||||
should.not.exist(newComment.in_reply_to_snippet);
|
||||
|
||||
// only author and parent email sent
|
||||
mockManager.assert.sentEmailCount(2);
|
||||
});
|
||||
});
|
||||
|
||||
it('in_reply_to_id is ignored when no parent specified', async function () {
|
||||
const {replies: [reply]} = await dbFns.addCommentWithReplies({
|
||||
member_id: fixtureManager.get('members', 1).id,
|
||||
replies: [{
|
||||
member_id: fixtureManager.get('members', 2).id
|
||||
}]
|
||||
});
|
||||
|
||||
const {body: {comments: [newComment]}} = await testPostComment({
|
||||
post_id: postId,
|
||||
in_reply_to_id: reply.get('id'),
|
||||
html: '<p>This is a reply to a reply</p>'
|
||||
});
|
||||
|
||||
// in_reply_to is not set
|
||||
should.not.exist(newComment.in_reply_to_id);
|
||||
should.not.exist(newComment.in_reply_to_snippet);
|
||||
|
||||
should.not.exist(newComment.parent_id);
|
||||
|
||||
// only author email sent
|
||||
mockManager.assert.sentEmailCount(1);
|
||||
});
|
||||
|
||||
it('in_reply_to_id is ignored id in_reply_to_id has a different parent', async function () {
|
||||
const {replies: [reply]} = await dbFns.addCommentWithReplies({
|
||||
member_id: fixtureManager.get('members', 1).id,
|
||||
replies: [{
|
||||
member_id: fixtureManager.get('members', 2).id
|
||||
}]
|
||||
});
|
||||
|
||||
const diffParentComment = await dbFns.addComment({
|
||||
member_id: fixtureManager.get('members', 1).id
|
||||
});
|
||||
|
||||
const {body: {comments: [newComment]}} = await testPostComment({
|
||||
post_id: postId,
|
||||
parent_id: diffParentComment.get('id'),
|
||||
in_reply_to_id: reply.get('id'),
|
||||
html: '<p>This is a reply to a reply</p>'
|
||||
});
|
||||
|
||||
// in_reply_to is not set
|
||||
should.not.exist(newComment.in_reply_to_id);
|
||||
should.not.exist(newComment.in_reply_to_snippet);
|
||||
});
|
||||
|
||||
it('includes in_reply_to_snippet in response', async function () {
|
||||
const {replies: [reply]} = await dbFns.addCommentWithReplies({
|
||||
member_id: fixtureManager.get('members', 1).id,
|
||||
replies: [{
|
||||
member_id: fixtureManager.get('members', 2).id,
|
||||
html: '<p><b>This is what was replied to</b></p>'
|
||||
}]
|
||||
});
|
||||
|
||||
const {body: {comments: [newComment]}} = await testPostComment({
|
||||
post_id: postId,
|
||||
parent_id: reply.get('parent_id'),
|
||||
in_reply_to_id: reply.get('id'),
|
||||
html: '<p>This is a reply to a reply</p>'
|
||||
});
|
||||
|
||||
const {body: {comments: [comment]}} = await testGetComments(`/api/comments/${newComment.id}`, [commentMatcher]);
|
||||
|
||||
// in_reply_to_snippet is included
|
||||
comment.in_reply_to_snippet.should.eql('This is what was replied to');
|
||||
});
|
||||
|
||||
['deleted', 'hidden'].forEach((status) => {
|
||||
it(`does not include in_reply_to_snippet for ${status} comments`, async function () {
|
||||
const {replies: [reply]} = await dbFns.addCommentWithReplies({
|
||||
member_id: fixtureManager.get('members', 1).id,
|
||||
replies: [{
|
||||
member_id: fixtureManager.get('members', 2).id,
|
||||
html: `<p>This is a ${status} reply</p>`,
|
||||
status
|
||||
}]
|
||||
});
|
||||
|
||||
const newComment = await dbFns.addComment({
|
||||
member_id: loggedInMember.id,
|
||||
parent_id: reply.get('parent_id'),
|
||||
in_reply_to_id: reply.get('id')
|
||||
});
|
||||
|
||||
const {body: {comments: [comment]}} = await testGetComments(`/api/comments/${newComment.id}`, [commentMatcher]);
|
||||
|
||||
should.not.exist(comment.in_reply_to_snippet);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ const cleanUtil = require('../../../../../../../core/server/api/endpoints/utils/
|
|||
const extraAttrsUtils = require('../../../../../../../core/server/api/endpoints/utils/serializers/output/utils/extra-attrs');
|
||||
const mappers = require('../../../../../../../core/server/api/endpoints/utils/serializers/output/mappers');
|
||||
const memberAttribution = require('../../../../../../../core/server/services/member-attribution');
|
||||
const htmlToPlaintext = require('@tryghost/html-to-plaintext');
|
||||
|
||||
function createJsonModel(data) {
|
||||
return Object.assign(data, {toJSON: sinon.stub().returns(data)});
|
||||
|
|
@ -609,4 +610,80 @@ describe('Unit: utils/serializers/output/mappers', function () {
|
|||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('Comment mapper', function () {
|
||||
it('includes in_reply_to_snippet for published replies-to-replies', function () {
|
||||
const frame = {};
|
||||
|
||||
const model = {
|
||||
id: 'comment3',
|
||||
html: '<p>comment 3</p>',
|
||||
member: {id: 'member1'},
|
||||
parent: {
|
||||
id: 'comment1',
|
||||
html: '<p>comment 1</p>',
|
||||
member: {id: 'member1'}
|
||||
},
|
||||
in_reply_to_id: 'comment2',
|
||||
inReplyTo: {
|
||||
id: 'comment2',
|
||||
parent_id: 'comment1',
|
||||
html: '<p>comment 2</p>',
|
||||
status: 'published',
|
||||
member: {id: 'member2'}
|
||||
}
|
||||
};
|
||||
|
||||
const mapped = mappers.comments(model, frame);
|
||||
|
||||
mapped.should.eql({
|
||||
id: 'comment3',
|
||||
html: '<p>comment 3</p>',
|
||||
member: {id: 'member1'},
|
||||
parent: {id: 'comment1', html: '<p>comment 1</p>', member: {id: 'member1'}},
|
||||
in_reply_to_id: 'comment2',
|
||||
in_reply_to_snippet: 'comment 2'
|
||||
});
|
||||
});
|
||||
|
||||
it('calls correct html-to-plaintext converter for in_reply_to_snippet', function () {
|
||||
const converterSpy = sinon.spy(htmlToPlaintext, 'commentSnippet');
|
||||
|
||||
const frame = {};
|
||||
|
||||
const model = {
|
||||
inReplyTo: {
|
||||
html: '<p>First paragraph <a href="https://example.com">with link</a>,<br> and new line.</p><p>Second paragraph</p>',
|
||||
status: 'published'
|
||||
}
|
||||
};
|
||||
|
||||
const mapped = mappers.comments(model, frame);
|
||||
|
||||
converterSpy.calledOnce.should.eql(true, 'htmlToPlaintext.commentSnippet was not called');
|
||||
|
||||
mapped.should.eql({
|
||||
in_reply_to_snippet: 'First paragraph with link, and new line. Second paragraph',
|
||||
member: null
|
||||
});
|
||||
});
|
||||
|
||||
it('does not include in_reply_to_snippet for top-level comments', function () {
|
||||
const frame = {};
|
||||
|
||||
const model = {
|
||||
id: 'comment1',
|
||||
html: '<p>comment 1</p>',
|
||||
inReplyTo: undefined
|
||||
};
|
||||
|
||||
const mapped = mappers.comments(model, frame);
|
||||
|
||||
mapped.should.eql({
|
||||
id: 'comment1',
|
||||
html: '<p>comment 1</p>',
|
||||
member: null
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ const baseSettings = {
|
|||
let excerptConverter;
|
||||
let emailConverter;
|
||||
let commentConverter;
|
||||
let commentSnippetConverter;
|
||||
|
||||
const loadConverters = () => {
|
||||
if (excerptConverter && emailConverter) {
|
||||
|
|
@ -78,9 +79,18 @@ const loadConverters = () => {
|
|||
]
|
||||
});
|
||||
|
||||
const commentSnippetSettings = mergeSettings({
|
||||
preserveNewlines: false,
|
||||
ignoreHref: true,
|
||||
selectors: [
|
||||
{selector: 'blockquote', format: 'skip'}
|
||||
]
|
||||
});
|
||||
|
||||
excerptConverter = compile(excerptSettings);
|
||||
emailConverter = compile(emailSettings);
|
||||
commentConverter = compile(commentSettings);
|
||||
commentSnippetConverter = compile(commentSnippetSettings);
|
||||
};
|
||||
|
||||
module.exports.excerpt = (html) => {
|
||||
|
|
@ -100,3 +110,11 @@ module.exports.comment = (html) => {
|
|||
|
||||
return commentConverter(html);
|
||||
};
|
||||
|
||||
module.exports.commentSnippet = (html) => {
|
||||
loadConverters();
|
||||
|
||||
return commentSnippetConverter(html)
|
||||
.replace(/\n/g, ' ')
|
||||
.replace(/\s+/g, ' ');
|
||||
};
|
||||
|
|
|
|||
|
|
@ -87,4 +87,28 @@ describe('Html to Plaintext', function () {
|
|||
assert.equal(excerpt, expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('commentSnippet converter', function () {
|
||||
function testConverter({input, expected}) {
|
||||
return () => {
|
||||
const output = htmlToPlaintext.commentSnippet(input);
|
||||
assert.equal(output, expected);
|
||||
};
|
||||
}
|
||||
|
||||
it('skips href urls', testConverter({
|
||||
input: '<a href="https://mysite.com">A snippet from a post template</a>',
|
||||
expected: 'A snippet from a post template'
|
||||
}));
|
||||
|
||||
it('skips blockquotes', testConverter({
|
||||
input: '<blockquote>Previous comment quote</blockquote><p>And the new comment text</p>',
|
||||
expected: 'And the new comment text'
|
||||
}));
|
||||
|
||||
it('returns a single line', testConverter({
|
||||
input: '<p>First paragraph.</p><p>Second paragraph.</p>',
|
||||
expected: 'First paragraph. Second paragraph.'
|
||||
}));
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue