mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-11-28 14:03:48 +03:00
Removed update check service in favor of external package
refs https://github.com/TryGhost/Team/issues/728 - The code of update check has been extracted into it's own package as a part of TryGhost/Core monorepo. This commit is a cleanup of the leftover files
This commit is contained in:
Naz
parent
a7dec233ba
commit
7d05da6185
@ -1,360 +0,0 @@
|
||||
const _ = require('lodash');
|
||||
const url = require('url');
|
||||
const crypto = require('crypto');
|
||||
const moment = require('moment');
|
||||
const Promise = require('bluebird');
|
||||
const exec = require('child_process').exec;
|
||||
const errors = require('@tryghost/errors');
|
||||
const debug = require('ghost-ignition').debug('update-check');
|
||||
|
||||
const internal = {context: {internal: true}};
|
||||
|
||||
/**
|
||||
* Update Checker Class
|
||||
*
|
||||
* Makes a request to Ghost.org to request release & custom notifications.
|
||||
* The service is provided in return for users opting in to anonymous usage data collection.
|
||||
*
|
||||
* Blog owners can opt-out of update checks by setting `privacy: { useUpdateCheck: false }` in their config file.
|
||||
*/
|
||||
class UpdateCheckService {
|
||||
/**
|
||||
*
|
||||
* @param {Object} options
|
||||
* @param {Object} options.api - set of Ghost's API methods needed for update check to function
|
||||
* @param {Object} options.api.settings - Settings API methods
|
||||
* @param {Function} options.api.settings.read - method allowing to read Ghost's settings
|
||||
* @param {Function} options.api.settings.edit - method allowing to edit Ghost's settings
|
||||
* @param {Object} options.api.posts - Posts API methods
|
||||
* @param {Function} options.api.posts.browse - method allowing to read Ghost's posts
|
||||
* @param {Object} options.api.users - Users API methods
|
||||
* @param {Function} options.api.users.browse - method allowing to read Ghost's users
|
||||
* @param {Object} options.config
|
||||
* @param {Object} options.config.mail
|
||||
* @param {string} options.config.env
|
||||
* @param {string} options.config.databaseType
|
||||
* @param {string} options.config.checkEndpoint - update check service URL
|
||||
* @param {boolean} [options.config.isPrivacyDisabled]
|
||||
* @param {string[]} [options.config.notificationGroups] - example values ["migration", "something"]
|
||||
* @param {string} options.config.siteUrl - Ghost instance URL
|
||||
* @param {boolean} [options.config.forceUpdate]
|
||||
* @param {string} options.config.ghostVersion - Ghost instance version
|
||||
* @param {Function} options.request - a HTTP request proxy function
|
||||
* @param {Function} options.sendEmail - function handling sending an email
|
||||
*/
|
||||
constructor({api, config, i18n, logging, request, sendEmail}) {
|
||||
this.api = api;
|
||||
this.config = config;
|
||||
this.i18n = i18n;
|
||||
this.logging = logging;
|
||||
this.request = request;
|
||||
this.sendEmail = sendEmail;
|
||||
}
|
||||
|
||||
nextCheckTimestamp() {
|
||||
const now = Math.round(new Date().getTime() / 1000);
|
||||
return now + (24 * 3600);
|
||||
}
|
||||
|
||||
/**
|
||||
* @description Centralised error handler for the update check unit.
|
||||
*
|
||||
* CASES:
|
||||
* - the update check service returns an error
|
||||
* - error during collecting blog stats
|
||||
*
|
||||
* We still need to ensure that we set the "next_update_check" to a new value, otherwise no more
|
||||
* update checks will happen.
|
||||
*
|
||||
* @param err
|
||||
*/
|
||||
updateCheckError(err) {
|
||||
this.api.settings.edit({
|
||||
settings: [{
|
||||
key: 'next_update_check',
|
||||
value: this.nextCheckTimestamp()
|
||||
}]
|
||||
}, internal);
|
||||
|
||||
err.context = this.i18n.t('errors.updateCheck.checkingForUpdatesFailed.error');
|
||||
err.help = this.i18n.t('errors.updateCheck.checkingForUpdatesFailed.help', {url: 'https://ghost.org/docs/'});
|
||||
|
||||
this.logging.error(err);
|
||||
}
|
||||
|
||||
/**
|
||||
* @description Collect stats from your blog.
|
||||
* @returns {Promise}
|
||||
*/
|
||||
async updateCheckData() {
|
||||
let data = {};
|
||||
let mailConfig = this.config.mail;
|
||||
|
||||
data.ghost_version = this.config.ghostVersion;
|
||||
data.node_version = process.versions.node;
|
||||
data.env = this.config.env;
|
||||
data.database_type = this.config.databaseType;
|
||||
data.email_transport = mailConfig &&
|
||||
(mailConfig.options && mailConfig.options.service ?
|
||||
mailConfig.options.service :
|
||||
mailConfig.transport);
|
||||
|
||||
try {
|
||||
const hash = (await this.api.settings.read(_.extend({key: 'db_hash'}, internal))).settings[0];
|
||||
const theme = (await this.api.settings.read(_.extend({key: 'active_theme'}, internal))).settings[0];
|
||||
const posts = await this.api.posts.browse();
|
||||
const users = await this.api.users.browse(internal);
|
||||
const npm = await Promise.promisify(exec)('npm -v');
|
||||
|
||||
const blogUrl = this.config.siteUrl;
|
||||
const parsedBlogUrl = url.parse(blogUrl);
|
||||
const blogId = parsedBlogUrl.hostname + parsedBlogUrl.pathname.replace(/\//, '') + hash.value;
|
||||
|
||||
data.url = blogUrl;
|
||||
data.blog_id = crypto.createHash('md5').update(blogId).digest('hex');
|
||||
data.theme = theme ? theme.value : '';
|
||||
data.post_count = posts && posts.meta && posts.meta.pagination ? posts.meta.pagination.total : 0;
|
||||
data.user_count = users && users.users && users.users.length ? users.users.length : 0;
|
||||
data.blog_created_at = users && users.users && users.users[0] && users.users[0].created_at ? moment(users.users[0].created_at).unix() : '';
|
||||
data.npm_version = npm.trim();
|
||||
|
||||
return data;
|
||||
} catch (err) {
|
||||
this.updateCheckError(err);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @description Perform request to update check service.
|
||||
*
|
||||
* With the privacy setting `useUpdateCheck` you can control if you want to expose data/stats from your blog to the
|
||||
* service. Enabled or disabled, you will receive the latest notification available from the service.
|
||||
*
|
||||
* @see https://ghost.org/docs/concepts/config/#privacy
|
||||
* @returns {Promise}
|
||||
*/
|
||||
async updateCheckRequest() {
|
||||
const reqData = await this.updateCheckData();
|
||||
|
||||
let reqObj = {
|
||||
timeout: 1000,
|
||||
headers: {}
|
||||
};
|
||||
|
||||
let checkEndpoint = this.config.checkEndpoint;
|
||||
let checkMethod = this.config.isPrivacyDisabled ? 'GET' : 'POST';
|
||||
|
||||
// CASE: Expose stats and do a check-in
|
||||
if (checkMethod === 'POST') {
|
||||
reqObj.json = true;
|
||||
reqObj.body = reqData;
|
||||
reqObj.headers['Content-Length'] = Buffer.byteLength(JSON.stringify(reqData));
|
||||
reqObj.headers['Content-Type'] = 'application/json';
|
||||
} else {
|
||||
reqObj.json = true;
|
||||
reqObj.query = {
|
||||
ghost_version: reqData.ghost_version
|
||||
};
|
||||
}
|
||||
|
||||
debug('Request Update Check Service', checkEndpoint);
|
||||
|
||||
try {
|
||||
const response = await this.request(checkEndpoint, reqObj);
|
||||
return response.body;
|
||||
} catch (err) {
|
||||
// CASE: no notifications available, ignore
|
||||
if (err.statusCode === 404) {
|
||||
return {
|
||||
next_check: this.nextCheckTimestamp(),
|
||||
notifications: []
|
||||
};
|
||||
}
|
||||
|
||||
// CASE: service returns JSON error, deserialize into JS error
|
||||
if (err.response && err.response.body && typeof err.response.body === 'object') {
|
||||
throw errors.utils.deserialize(err.response.body);
|
||||
} else {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @description This function handles the response from the update check service.
|
||||
*
|
||||
* The helper does three things:
|
||||
*
|
||||
* 1. Updates the time in the settings table to know when we can execute the next update check request.
|
||||
* 2. Iterates over the received notifications and filters them out based on your notification groups.
|
||||
* 3. Calls a custom helper to generate a Ghost notification for the database.
|
||||
*
|
||||
* The structure of the response is:
|
||||
*
|
||||
* {
|
||||
* id: 20,
|
||||
* version: 'all4',
|
||||
* messages:
|
||||
* [{
|
||||
* id: 'f8ff6c80-aa61-11e7-a126-6119te37e2b8',
|
||||
* version: '^2',
|
||||
* content: 'Hallouuuu custom',
|
||||
* top: true,
|
||||
* dismissible: true,
|
||||
* type: 'info'
|
||||
* }],
|
||||
* created_at: '2021-10-06T07:00:00.000Z',
|
||||
* custom: 1,
|
||||
* next_check: 1555608722
|
||||
* }
|
||||
*
|
||||
*
|
||||
* Example for grouped custom notifications in config:
|
||||
*
|
||||
* "notificationGroups": ["migration", "something"]
|
||||
*
|
||||
* The group 'all' is a reserved name for general custom notifications, which every self hosted blog can receive.
|
||||
*
|
||||
* @param {Object} response
|
||||
* @return {Promise}
|
||||
*/
|
||||
async updateCheckResponse(response) {
|
||||
let notifications = [];
|
||||
let notificationGroups = (this.config.notificationGroups || []).concat(['all']);
|
||||
|
||||
debug('Notification Groups', notificationGroups);
|
||||
debug('Response Update Check Service', response);
|
||||
|
||||
await this.api.settings.edit({
|
||||
settings: [{
|
||||
key: 'next_update_check',
|
||||
value: response.next_check
|
||||
}]
|
||||
}, internal);
|
||||
|
||||
/**
|
||||
* @NOTE:
|
||||
*
|
||||
* When we refactored notifications in Ghost 1.20, the service did not support returning multiple messages.
|
||||
* But we wanted to already add the support for future functionality.
|
||||
* That's why this helper supports two ways: returning an array of messages or returning an object with
|
||||
* a "notifications" key. The second one is probably the best, because we need to support "next_check"
|
||||
* on the root level of the response.
|
||||
*/
|
||||
if (_.isArray(response)) {
|
||||
notifications = response;
|
||||
} else if ((Object.prototype.hasOwnProperty.call(response, 'notifications') && _.isArray(response.notifications))) {
|
||||
notifications = response.notifications;
|
||||
} else {
|
||||
// CASE: default right now
|
||||
notifications = [response];
|
||||
}
|
||||
|
||||
// CASE: Hook into received notifications and decide whether you are allowed to receive custom group messages.
|
||||
if (notificationGroups.length) {
|
||||
notifications = notifications.filter(function (notification) {
|
||||
// CASE: release notification, keep
|
||||
if (!notification.custom) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// CASE: filter out messages based on your groups
|
||||
return _.includes(notificationGroups.map(function (groupIdentifier) {
|
||||
if (notification && notification.version && notification.version.match(new RegExp(groupIdentifier))) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}), true) === true;
|
||||
});
|
||||
}
|
||||
|
||||
for (const notification of notifications) {
|
||||
await this.createCustomNotification(notification);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @description Create a Ghost notification and call the API controller.
|
||||
*
|
||||
* @param {Object} notification
|
||||
* @return {Promise}
|
||||
*/
|
||||
async createCustomNotification(notification) {
|
||||
if (!notification) {
|
||||
return;
|
||||
}
|
||||
|
||||
const {users} = await this.api.users.browse(Object.assign({
|
||||
limit: 'all',
|
||||
include: ['roles']
|
||||
}, internal));
|
||||
|
||||
const adminEmails = users
|
||||
.filter(user => ['Owner', 'Administrator'].includes(user.roles[0].name))
|
||||
.map(user => user.email);
|
||||
|
||||
const siteUrl = this.config.siteUrl;
|
||||
|
||||
for (const message of notification.messages) {
|
||||
const toAdd = {
|
||||
// @NOTE: the update check service returns "0" or "1" (https://github.com/TryGhost/UpdateCheck/issues/43)
|
||||
custom: !!notification.custom,
|
||||
createdAt: moment(notification.created_at).toDate(),
|
||||
status: message.status || 'alert',
|
||||
type: message.type || 'info',
|
||||
id: message.id,
|
||||
dismissible: Object.prototype.hasOwnProperty.call(message, 'dismissible') ? message.dismissible : true,
|
||||
top: !!message.top,
|
||||
message: message.content
|
||||
};
|
||||
|
||||
if (toAdd.type === 'alert') {
|
||||
for (const email of adminEmails) {
|
||||
try {
|
||||
this.sendEmail({
|
||||
to: email,
|
||||
subject: `Action required: Critical alert from Ghost instance ${siteUrl}`,
|
||||
html: toAdd.message,
|
||||
forceTextContent: true
|
||||
});
|
||||
} catch (err) {
|
||||
this.logging.err(err);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
debug('Add Custom Notification', toAdd);
|
||||
await this.api.notifications.add({notifications: [toAdd]}, {context: {internal: true}});
|
||||
}
|
||||
}
|
||||
/**
|
||||
* @description Entry point to trigger the update check unit.
|
||||
*
|
||||
* Based on a settings value, we check if `next_update_check` is less than now to decide whether
|
||||
* we should request the update check service (http://updates.ghost.org) or not.
|
||||
*
|
||||
* @returns {Promise}
|
||||
*/
|
||||
async check() {
|
||||
const result = await this.api.settings.read(_.extend({key: 'next_update_check'}, internal));
|
||||
|
||||
const nextUpdateCheck = result.settings[0];
|
||||
|
||||
// CASE: Next update check should happen now?
|
||||
// @NOTE: You can skip this check by adding a config value. This is helpful for developing.
|
||||
if (!this.config.forceUpdate && nextUpdateCheck && nextUpdateCheck.value && nextUpdateCheck.value > moment().unix()) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
const response = await this.updateCheckRequest();
|
||||
|
||||
return await this.updateCheckResponse(response);
|
||||
} catch (err) {
|
||||
this.updateCheckError(err);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = UpdateCheckService;
|
||||
@ -9,7 +9,7 @@ const i18n = require('../shared/i18n');
|
||||
const logging = require('../shared/logging');
|
||||
const request = require('./lib/request');
|
||||
const ghostVersion = require('./lib/ghost-version');
|
||||
const UpdateCheckService = require('./update-check-service');
|
||||
const UpdateCheckService = require('@tryghost/update-check-service');
|
||||
|
||||
const ghostMailer = new GhostMailer();
|
||||
let updateChecker;
|
||||
@ -34,6 +34,9 @@ module.exports = () => {
|
||||
},
|
||||
users: {
|
||||
browse: api.users.browse
|
||||
},
|
||||
notifications: {
|
||||
add: api.notifications.add
|
||||
}
|
||||
},
|
||||
config: {
|
||||
|
||||
@ -69,6 +69,7 @@
|
||||
"@tryghost/session-service": "0.1.22",
|
||||
"@tryghost/social-urls": "0.1.24",
|
||||
"@tryghost/string": "0.1.19",
|
||||
"@tryghost/update-check-service": "^0.1.0",
|
||||
"@tryghost/url-utils": "1.1.4",
|
||||
"@tryghost/vhost-middleware": "1.0.14",
|
||||
"@tryghost/zip": "1.1.13",
|
||||
|
||||
@ -1,329 +0,0 @@
|
||||
const should = require('should');
|
||||
const sinon = require('sinon');
|
||||
const moment = require('moment');
|
||||
const uuid = require('uuid');
|
||||
|
||||
const UpdateCheckService = require('../../../core/server/update-check-service');
|
||||
|
||||
describe('Update Check', function () {
|
||||
const internal = {context: {internal: true}};
|
||||
let settingsStub;
|
||||
let i18nStub;
|
||||
let loggingStub;
|
||||
let requestStub;
|
||||
|
||||
beforeEach(function () {
|
||||
settingsStub = sinon.stub().resolves({
|
||||
settings: []
|
||||
});
|
||||
settingsStub.withArgs(Object.assign({key: 'db_hash'}, internal)).resolves({
|
||||
settings: [{
|
||||
value: 'dummy_db_hash'
|
||||
}]
|
||||
});
|
||||
settingsStub.withArgs(Object.assign({key: 'active_theme'}, internal)).resolves({
|
||||
settings: [{
|
||||
value: 'casperito'
|
||||
}]
|
||||
});
|
||||
|
||||
i18nStub = {
|
||||
t: sinon.stub()
|
||||
};
|
||||
|
||||
loggingStub = {
|
||||
error: sinon.stub()
|
||||
};
|
||||
|
||||
requestStub = sinon.stub();
|
||||
});
|
||||
|
||||
afterEach(function () {
|
||||
sinon.restore();
|
||||
});
|
||||
|
||||
describe('UpdateCheck execution', function () {
|
||||
it('update check was executed', async function () {
|
||||
const updateCheckService = new UpdateCheckService({
|
||||
api: {
|
||||
settings: {
|
||||
read: settingsStub,
|
||||
edit: settingsStub
|
||||
},
|
||||
users: {
|
||||
browse: sinon.stub().resolves()
|
||||
},
|
||||
posts: {
|
||||
browse: sinon.stub().resolves()
|
||||
}
|
||||
},
|
||||
config: {
|
||||
checkEndpoint: 'https://updates.ghost.org',
|
||||
siteUrl: 'https://localhost:2368/test',
|
||||
isPrivacyDisabled: true,
|
||||
ghostVersion: '0.8.0'
|
||||
},
|
||||
i18n: i18nStub,
|
||||
logging: loggingStub,
|
||||
request: requestStub
|
||||
});
|
||||
|
||||
await updateCheckService.check();
|
||||
|
||||
requestStub.calledOnce.should.equal(true);
|
||||
|
||||
requestStub.args[0][0].should.equal('https://updates.ghost.org');
|
||||
requestStub.args[0][1].query.ghost_version.should.equal('0.8.0');
|
||||
});
|
||||
|
||||
it('update check won\'t happen if it\'s too early', async function () {
|
||||
const lateSettingStub = sinon.stub().resolves({
|
||||
settings: [{
|
||||
value: moment().add('10', 'minutes').unix()
|
||||
}]
|
||||
});
|
||||
|
||||
const updateCheckService = new UpdateCheckService({
|
||||
api: {
|
||||
settings: {
|
||||
read: lateSettingStub
|
||||
}
|
||||
},
|
||||
config: {},
|
||||
request: requestStub
|
||||
});
|
||||
|
||||
await updateCheckService.check();
|
||||
|
||||
requestStub.called.should.equal(false);
|
||||
});
|
||||
|
||||
it('update check will happen if it\'s time to check', async function () {
|
||||
const updateCheckDelayPassed = sinon.stub().resolves({
|
||||
settings: [{
|
||||
value: moment().subtract('10', 'minutes').unix()
|
||||
}]
|
||||
});
|
||||
|
||||
const updateCheckService = new UpdateCheckService({
|
||||
api: {
|
||||
settings: {
|
||||
read: updateCheckDelayPassed,
|
||||
edit: settingsStub
|
||||
},
|
||||
users: {
|
||||
browse: sinon.stub().resolves()
|
||||
},
|
||||
posts: {
|
||||
browse: sinon.stub().resolves()
|
||||
}
|
||||
},
|
||||
config: {
|
||||
checkEndpoint: 'https://updates.ghost.org',
|
||||
siteUrl: 'https://example.com',
|
||||
isPrivacyDisabled: true,
|
||||
ghostVersion: '5.3.4'
|
||||
},
|
||||
i18n: i18nStub,
|
||||
logging: loggingStub,
|
||||
request: requestStub
|
||||
});
|
||||
|
||||
await updateCheckService.check();
|
||||
|
||||
requestStub.calledOnce.should.equal(true);
|
||||
|
||||
requestStub.args[0][0].should.equal('https://updates.ghost.org');
|
||||
requestStub.args[0][1].query.ghost_version.should.equal('5.3.4');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Data sent with the POST request', function () {
|
||||
it('should report the correct data', async function () {
|
||||
const updateCheckService = new UpdateCheckService({
|
||||
api: {
|
||||
settings: {
|
||||
read: settingsStub,
|
||||
edit: settingsStub
|
||||
},
|
||||
users: {
|
||||
browse: sinon.stub().resolves({
|
||||
users: [{
|
||||
created_at: '1995-12-24T23:15:00Z'
|
||||
}, {}]
|
||||
})
|
||||
},
|
||||
posts: {
|
||||
browse: sinon.stub().resolves({
|
||||
meta: {
|
||||
pagination: {
|
||||
total: 13
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
},
|
||||
config: {
|
||||
checkEndpoint: 'https://updates.ghost.org',
|
||||
siteUrl: 'https://localhost:2368/test',
|
||||
isPrivacyDisabled: false,
|
||||
env: process.env.NODE_ENV,
|
||||
databaseType: 'mysql',
|
||||
ghostVersion: '4.0.0'
|
||||
},
|
||||
i18n: i18nStub,
|
||||
logging: loggingStub,
|
||||
request: requestStub,
|
||||
ghostMailer: {
|
||||
send: sinon.stub().resolves()
|
||||
}
|
||||
});
|
||||
|
||||
await updateCheckService.check();
|
||||
|
||||
requestStub.calledOnce.should.equal(true);
|
||||
|
||||
requestStub.args[0][0].should.equal('https://updates.ghost.org');
|
||||
|
||||
const data = requestStub.args[0][1].body;
|
||||
data.ghost_version.should.equal('4.0.0');
|
||||
data.node_version.should.equal(process.versions.node);
|
||||
data.env.should.equal(process.env.NODE_ENV);
|
||||
data.database_type.should.match(/sqlite3|mysql/);
|
||||
data.blog_id.should.be.a.String();
|
||||
data.blog_id.should.not.be.empty();
|
||||
data.theme.should.be.equal('casperito');
|
||||
data.blog_created_at.should.equal(819846900);
|
||||
data.user_count.should.be.equal(2);
|
||||
data.post_count.should.be.equal(13);
|
||||
data.npm_version.should.be.a.String();
|
||||
data.npm_version.should.not.be.empty();
|
||||
});
|
||||
});
|
||||
|
||||
describe('Notifications', function () {
|
||||
it('should create a release notification for target version', async function () {
|
||||
const notification = {
|
||||
id: 1,
|
||||
custom: 0,
|
||||
messages: [{
|
||||
id: uuid.v4(),
|
||||
version: '999.9.x',
|
||||
content: '<p>Hey there! This is for 999.9.0 version</p>',
|
||||
dismissible: true,
|
||||
top: true
|
||||
}]
|
||||
};
|
||||
|
||||
const notificationsAPIAddStub = sinon.stub().resolves();
|
||||
|
||||
const updateCheckService = new UpdateCheckService({
|
||||
api: {
|
||||
settings: {
|
||||
read: settingsStub,
|
||||
edit: settingsStub
|
||||
},
|
||||
users: {
|
||||
browse: sinon.stub().resolves({
|
||||
users: [{
|
||||
roles: [{
|
||||
name: 'Owner'
|
||||
}]
|
||||
}]
|
||||
})
|
||||
},
|
||||
posts: {
|
||||
browse: sinon.stub().resolves()
|
||||
},
|
||||
notifications: {
|
||||
add: notificationsAPIAddStub
|
||||
}
|
||||
},
|
||||
config: {
|
||||
siteUrl: 'https://localhost:2368/test'
|
||||
},
|
||||
i18n: i18nStub,
|
||||
logging: loggingStub,
|
||||
request: sinon.stub().resolves({
|
||||
body: {
|
||||
notifications: [notification]
|
||||
}
|
||||
})
|
||||
});
|
||||
|
||||
await updateCheckService.check();
|
||||
|
||||
notificationsAPIAddStub.calledOnce.should.equal(true);
|
||||
notificationsAPIAddStub.args[0][0].notifications.length.should.equal(1);
|
||||
|
||||
const targetNotification = notificationsAPIAddStub.args[0][0].notifications[0];
|
||||
targetNotification.dismissible.should.eql(notification.messages[0].dismissible);
|
||||
targetNotification.id.should.eql(notification.messages[0].id);
|
||||
targetNotification.top.should.eql(notification.messages[0].top);
|
||||
targetNotification.type.should.eql('info');
|
||||
targetNotification.message.should.eql(notification.messages[0].content);
|
||||
});
|
||||
|
||||
it('should send an email for critical notification', async function () {
|
||||
const notification = {
|
||||
id: 1,
|
||||
messages: [{
|
||||
id: uuid.v4(),
|
||||
version: 'custom1',
|
||||
content: '<p>Critical message. Upgrade your site!</p>',
|
||||
dismissible: false,
|
||||
top: true,
|
||||
type: 'alert'
|
||||
}]
|
||||
};
|
||||
|
||||
const notificationsAPIAddStub = sinon.stub().resolves();
|
||||
const sendEmailStub = sinon.stub().resolves();
|
||||
|
||||
const updateCheckService = new UpdateCheckService({
|
||||
api: {
|
||||
settings: {
|
||||
read: settingsStub,
|
||||
edit: settingsStub
|
||||
},
|
||||
users: {
|
||||
browse: sinon.stub().resolves({
|
||||
users: [{
|
||||
email: 'jbloggs@example.com',
|
||||
roles: [{
|
||||
name: 'Owner'
|
||||
}]
|
||||
}]
|
||||
})
|
||||
},
|
||||
posts: {
|
||||
browse: sinon.stub().resolves()
|
||||
},
|
||||
notifications: {
|
||||
add: notificationsAPIAddStub
|
||||
}
|
||||
},
|
||||
config: {
|
||||
siteUrl: 'http://127.0.0.1:2369'
|
||||
},
|
||||
i18n: i18nStub,
|
||||
logging: loggingStub,
|
||||
request: sinon.stub().resolves({
|
||||
body: [notification]
|
||||
}),
|
||||
sendEmail: sendEmailStub
|
||||
});
|
||||
|
||||
await updateCheckService.check();
|
||||
|
||||
sendEmailStub.called.should.be.true();
|
||||
sendEmailStub.args[0][0].to.should.equal('jbloggs@example.com');
|
||||
sendEmailStub.args[0][0].subject.should.equal('Action required: Critical alert from Ghost instance http://127.0.0.1:2369');
|
||||
sendEmailStub.args[0][0].html.should.equal('<p>Critical message. Upgrade your site!</p>');
|
||||
sendEmailStub.args[0][0].forceTextContent.should.equal(true);
|
||||
|
||||
notificationsAPIAddStub.calledOnce.should.equal(true);
|
||||
notificationsAPIAddStub.args[0][0].notifications.length.should.equal(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
10
yarn.lock
10
yarn.lock
@ -854,6 +854,16 @@
|
||||
dependencies:
|
||||
unidecode "^0.1.8"
|
||||
|
||||
"@tryghost/update-check-service@^0.1.0":
|
||||
version "0.1.0"
|
||||
resolved "https://registry.yarnpkg.com/@tryghost/update-check-service/-/update-check-service-0.1.0.tgz#ca1277989989968f2b2603a7d3b86e1124025be5"
|
||||
integrity sha512-i79AXxYlyR4sLOWBUgQ62DpNZ+12LE36kuYP39/R/qa2XiCQUd+2JYbm+Irf1m5f3x2U9B9Pmj4PkoeKhH4FHw==
|
||||
dependencies:
|
||||
"@tryghost/errors" "^0.2.11"
|
||||
bluebird "3.7.2"
|
||||
lodash "4.17.21"
|
||||
moment "2.24.0"
|
||||
|
||||
"@tryghost/url-utils@1.1.4", "@tryghost/url-utils@^1.1.2":
|
||||
version "1.1.4"
|
||||
resolved "https://registry.yarnpkg.com/@tryghost/url-utils/-/url-utils-1.1.4.tgz#9b7ffeafcc4331d9d2cc842e59d4a0ea37eb151e"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user