TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-23 22:11:09 +03:00
Code Issues Projects Releases Wiki Activity

Used job queue for processing incoming Webmentions

Browse Source 
refs https://github.com/TryGhost/Team/issues/2419

We use a job queue to ensure that webmentions can be processed outside of
the request/response cycle, but still finish executing if the processed is closed.

With this we're able to update the e2e tests to await the processing of the mention
rather than sleepign for arbitrary lengths of time, and we've reintroduced the tests
removed previously

- aa14207b69
- 48e9393159
This commit is contained in:
Fabien 'egg' O'Carroll 2023-01-30 18:11:30 +07:00 committed by GitHub
parent 478eb6ead6
commit 73bddef7c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 124 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
ghost/core/core/server/services/mentions/MentionController.js
View File

@ -10,12 +10,26 @@ const logging = require('@tryghost/logging');
* @typedef {import('@tryghost/webmentions/lib/MentionsAPI').Page} Page<Model>
*/
/**
* @typedef {object} IJobService
* @prop {(name: string, fn: Function) => void} addJob
*/
module.exports = class MentionController {
/** @type {import('@tryghost/webmentions/lib/MentionsAPI')} */
#api;
/** @type {IJobService} */
#jobService;
/**
* @param {object} deps
* @param {import('@tryghost/webmentions/lib/MentionsAPI')} deps.api
* @param {IJobService} deps.jobService
*/
async init(deps) {
this.#api = deps.api;
this.#jobService = deps.jobService;
}
/**
@ -52,15 +66,17 @@ module.exports = class MentionController {
*/
async receive(frame) {
logging.info('[Webmention] ' + JSON.stringify(frame.data));
const {source, target, ...payload} = frame.data;
const result = this.#api.processWebmention({
source: new URL(source),
target: new URL(target),
payload
});
result.catch(function rejected(err) {
logging.error(err);
this.#jobService.addJob('processWebmention', async () => {
const {source, target, ...payload} = frame.data;
try {
await this.#api.processWebmention({
source: new URL(source),
target: new URL(target),
payload
});
} catch (err) {
logging.error(err);
}
});
}
};

14
ghost/core/core/server/services/mentions/service.js
View File

@ -16,6 +16,7 @@ const outputSerializerUrlUtil = require('../../../server/api/endpoints/utils/ser
const labs = require('../../../shared/labs');
const urlService = require('../url');
const DomainEvents = require('@tryghost/domain-events');
const jobsService = require('../jobs');
function getPostUrl(post) {
const jsonModel = {};
@ -50,7 +51,18 @@ module.exports = {
routingService
});
this.controller.init({api});
this.controller.init({
api,
jobService: {
async addJob(name, fn) {
jobsService.addJob({
name,
job: fn,
offloaded: false
});
}
}
});
const sendingService = new MentionSendingService({
discoveryService,

117
ghost/core/test/e2e-api/webmentions/webmentions.test.js
View File

@ -3,6 +3,7 @@ const models = require('../../../core/server/models');
const assert = require('assert');
const urlUtils = require('../../../core/shared/url-utils');
const nock = require('nock');
const jobsService = require('../../../core/server/services/jobs');
describe('Webmentions (receiving)', function () {
let agent;
@ -18,7 +19,7 @@ describe('Webmentions (receiving)', function () {
nock.cleanAll();
nock.enableNetConnect();
});
beforeEach(function () {
emailMockReceiver = mockManager.mockMail();
});
@ -28,24 +29,29 @@ describe('Webmentions (receiving)', function () {
});
it('can receive a webmention', async function () {
const url = new URL('http://testpage.com/external-article/');
const processWebmentionJob = jobsService.awaitCompletion('processWebmention');
const targetUrl = new URL('integrations/', urlUtils.getSiteUrl());
const sourceUrl = new URL('http://testpage.com/external-article/');
const html = `
<html><head><title>Test Page</title><meta name="description" content="Test description"><meta name="author" content="John Doe"></head><body></body></html>
`;
nock(url.href)
.get('/')
.reply(200, html, {'content-type': 'text/html'});
nock(targetUrl.origin)
.head(targetUrl.pathname)
.reply(200);
nock(sourceUrl.origin)
.get(sourceUrl.pathname)
.reply(200, html, {'Content-Type': 'text/html'});
await agent.post('/receive')
.body({
source: 'http://testpage.com/external-article/',
target: urlUtils.getSiteUrl() + 'integrations/',
source: sourceUrl.href,
target: targetUrl.href,
withExtension: true // test payload recorded
})
.expectStatus(202);
// todo: remove sleep in future
await sleep(2000);
await processWebmentionJob;
const mention = await models.Mention.findOne({source: 'http://testpage.com/external-article/'});
assert(mention);
@ -60,54 +66,103 @@ describe('Webmentions (receiving)', function () {
}));
});
it('can send an email notification for a new webmention', async function () {
const url = new URL('http://testpage.com/external-article-123-email-test/');
it('can receive a webmention to homepage', async function () {
const processWebmentionJob = jobsService.awaitCompletion('processWebmention');
const targetUrl = new URL(urlUtils.getSiteUrl());
const sourceUrl = new URL('http://testpage.com/external-article-2/');
const html = `
<html><head><title>Test Page</title><meta name="description" content="Test description"><meta name="author" content="John Doe"></head><body></body></html>
`;
nock(url.href)
.get('/')
.reply(200, html, {'content-type': 'text/html'});
nock(targetUrl.origin)
.head(targetUrl.pathname)
.reply(200);
nock(sourceUrl.origin)
.get(sourceUrl.pathname)
.reply(200, html, {'Content-Type': 'text/html'});
await agent.post('/receive')
.body({
source: sourceUrl.href,
target: targetUrl.href
})
.expectStatus(202);
await processWebmentionJob;
const mention = await models.Mention.findOne({source: 'http://testpage.com/external-article-2/'});
assert(mention);
assert.equal(mention.get('target'), urlUtils.getSiteUrl());
assert.ok(!mention.get('resource_id'));
assert.equal(mention.get('resource_type'), null);
assert.equal(mention.get('source_title'), 'Test Page');
assert.equal(mention.get('source_excerpt'), 'Test description');
assert.equal(mention.get('source_author'), 'John Doe');
assert.equal(mention.get('payload'), JSON.stringify({}));
});
it('can send an email notification for a new webmention', async function () {
const processWebmentionJob = jobsService.awaitCompletion('processWebmention');
const targetUrl = new URL('integrations/', urlUtils.getSiteUrl());
const sourceUrl = new URL('http://testpage.com/external-article-123-email-test/');
const html = `
<html><head><title>Test Page</title><meta name="description" content="Test description"><meta name="author" content="John Doe"></head><body></body></html>
`;
nock(targetUrl.origin)
.head(targetUrl.pathname)
.reply(200);
nock(sourceUrl.origin)
.get(sourceUrl.pathname)
.reply(200, html, {'Content-Type': 'text/html'});
await agent.post('/receive/')
.body({
source: 'http://testpage.com/external-article-123-email-test/',
target: urlUtils.getSiteUrl() + 'integrations/',
withExtension: true // test payload recorded
source: sourceUrl.href,
target: targetUrl.href
})
.expectStatus(202);
await sleep(2000);
await processWebmentionJob;
const users = await models.User.findAll();
users.forEach(async (user) => {
await mockManager.assert.sentEmail({
subject: 'You\'ve been mentioned!',
to: user.toJSON().email
});
});
});
emailMockReceiver.sentEmailCount(users.length);
});
it('does not send notification with flag disabled', async function () {
mockManager.mockLabsDisabled('webmentionEmail');
const url = new URL('http://testpage.com/external-article-123-email-test/');
const processWebmentionJob = jobsService.awaitCompletion('processWebmention');
const targetUrl = new URL('integrations/', urlUtils.getSiteUrl());
const sourceUrl = new URL('http://testpage.com/external-article-123-email-test/');
const html = `
<html><head><title>Test Page</title><meta name="description" content="Test description"><meta name="author" content="John Doe"></head><body></body></html>
`;
nock(url.href)
.get('/')
.reply(200, html, {'content-type': 'text/html'});
<html><head><title>Test Page</title><meta name="description" content="Test description"><meta name="author" content="John Doe"></head><body></body></html>
`;
nock(targetUrl.origin)
.head(targetUrl.pathname)
.reply(200);
nock(sourceUrl.origin)
.get(sourceUrl.pathname)
.reply(200, html, {'Content-Type': 'text/html'});
await agent.post('/receive/')
.body({
source: 'http://testpage.com/external-article-123-email-test/',
target: urlUtils.getSiteUrl() + 'integrations/',
withExtension: true // test payload recorded
source: sourceUrl.href,
target: targetUrl.href
})
.expectStatus(202);
await sleep(2000);
await processWebmentionJob;
emailMockReceiver.sentEmailCount(0);
});
});