Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-04-01 02:41:39 -05:00
Code Issues Activity

Merge pull request #2665 from halfdan/2637-persistent-notifications

Browse source 
Proper endpoints for persistent notifications
This commit is contained in:
Hannah Wolfe 2014-05-06 00:35:11 +01:00
commit fc1cbac7b8
12 changed files with 150 additions and 96 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
core/server/api/index.js
View file

@ -101,8 +101,8 @@ function locationHeader(req, result) {
post = result.posts[0];
location = apiRoot + '/posts/' + post.id + '/?status=' + post.status;
} else if (endpoint === 'notifications') {
notification = result;
location = apiRoot + '/notifications/' + notification.id;
notification = result.notifications;
location = apiRoot + '/notifications/' + notification[0].id;
}
}

47
core/server/api/notifications.js
View file

@ -2,28 +2,43 @@ var when = require('when'),
_ = require('lodash'),
// Holds the persistent notifications
notificationsStore = [],
// Holds the last used id
notificationCounter = 0,
notifications;
// ## Notifications
notifications = {
browse: function browse() {
return when(notificationsStore);
return when({ 'notifications': notificationsStore });
},
// #### Destroy
// **takes:** an identifier object ({id: id})
destroy: function destroy(i) {
notificationsStore = _.reject(notificationsStore, function (element) {
return element.id === i.id;
var notification = _.find(notificationsStore, function (element) {
return element.id === parseInt(i.id, 10);
});
// **returns:** a promise for remaining notifications as a json object
return when(notificationsStore);
if (notification && !notification.dismissable) {
return when.reject({type: 'NoPermission', message: 'You do not have permission to dismiss this notification.'});
}
if (!notification) {
return when.reject({type: 'NoPermission', message: 'Notification does not exist.'});
}
notificationsStore = _.reject(notificationsStore, function (element) {
return element.id === parseInt(i.id, 10);
});
// **returns:** a promise for the deleted object
return when({notifications: [notification]});
},
destroyAll: function destroyAll() {
notificationsStore = [];
notificationCounter = 0;
return when(notificationsStore);
},
@ -34,14 +49,28 @@ notifications = {
// msg = {
// type: 'error', // this can be 'error', 'success', 'warn' and 'info'
// message: 'This is an error', // A string. Should fit in one line.
// status: 'persistent', // or 'passive'
// id: 'auniqueid' // A unique ID
// location: 'bottom', // A string where this notification should appear. can be 'bottom' or 'top'
// dismissable: true // A Boolean. Whether the notification is dismissable or not.
// };
// ```
add: function add(notification) {
// **returns:** a promise for all notifications as a json object
var defaults = {
dismissable: true,
location: 'bottom',
status: 'persistent'
};
notificationCounter = notificationCounter + 1;
notification = _.assign(defaults, notification, {
id: notificationCounter
//status: 'persistent'
});
notificationsStore.push(notification);
return when(notification);
// **returns:** a promise of the new notification object
return when({ notifications: [notification]});
}
};

17
core/server/controllers/admin.js
View file

@ -134,9 +134,7 @@ adminControllers = {
}).otherwise(function (err) {
var notification = {
type: 'error',
message: 'Your export file could not be generated. Error: ' + err.message,
status: 'persistent',
id: 'errorexport'
message: 'Your export file could not be generated. Error: ' + err.message
};
errors.logError(err, 'admin.js', "Your export file could not be generated.");
@ -179,8 +177,7 @@ adminControllers = {
var notification = {
type: 'success',
message: 'You were successfully signed out',
status: 'passive',
id: 'successlogout'
status: 'passive'
};
return api.notifications.add(notification).then(function () {
@ -333,8 +330,7 @@ adminControllers = {
var notification = {
type: 'success',
message: 'Check your email for further instructions',
status: 'passive',
id: 'successresetpw'
status: 'passive'
};
return api.notifications.add(notification).then(function () {
@ -368,9 +364,7 @@ adminControllers = {
// Redirect to forgotten if invalid token
var notification = {
type: 'error',
message: 'Invalid or expired token',
status: 'persistent',
id: 'errorinvalidtoken'
message: 'Invalid or expired token'
};
errors.logError(err, 'admin.js', "Please check the provided token for validity and expiration.");
@ -392,8 +386,7 @@ adminControllers = {
var notification = {
type: 'success',
message: 'Password changed successfully.',
status: 'passive',
id: 'successresetpw'
status: 'passive'
};
return api.notifications.add(notification).then(function () {

4
core/server/index.js
View file

@ -46,9 +46,7 @@ function doFirstRun() {
return api.notifications.add({
type: 'info',
message: firstRunMessage.join(' '),
status: 'persistent',
id: 'ghost-first-run'
message: firstRunMessage.join(' ')
});
}

8
core/server/mail.js
View file

@ -62,9 +62,7 @@ GhostMailer.prototype.usingSendmail = function () {
"Ghost is attempting to use your server's <b>sendmail</b> to send e-mail.",
"It is recommended that you explicitly configure an e-mail service,",
"See <a href=\"http://docs.ghost.org/mail\">http://docs.ghost.org/mail</a> for instructions"
].join(' '),
status: 'persistent',
id: 'ghost-mail-fallback'
].join(' ')
});
};
@ -74,9 +72,7 @@ GhostMailer.prototype.emailDisabled = function () {
message: [
"Ghost is currently unable to send e-mail.",
"See <a href=\"http://docs.ghost.org/mail\">http://docs.ghost.org/mail</a> for instructions"
].join(' '),
status: 'persistent',
id: 'ghost-mail-disabled'
].join(' ')
});
this.transport = null;
};

9
core/server/middleware/index.js
View file

@ -43,7 +43,7 @@ function ghostLocals(req, res, next) {
api.notifications.browse()
]).then(function (values) {
var currentUser = values[0].users[0],
notifications = values[1];
notifications = values[1].notifications;
_.extend(res.locals, {
currentUser: {
@ -56,9 +56,10 @@ function ghostLocals(req, res, next) {
next();
}).otherwise(function () {
// Only show passive notifications
// ToDo: Remove once ember handles passive notifications.
api.notifications.browse().then(function (notifications) {
_.extend(res.locals, {
messages: _.reject(notifications, function (notification) {
messages: _.reject(notifications.notifications, function (notification) {
return notification.status !== 'passive';
})
});
@ -341,6 +342,7 @@ module.exports = function (server, dbHash) {
expressServer.use(subdir + '/api/', middleware.cacheControl('private'));
expressServer.use(subdir + '/ghost/', middleware.cacheControl('private'));
// enable authentication; has to be done before CSRF handling
expressServer.use(middleware.authenticate);
@ -349,8 +351,11 @@ module.exports = function (server, dbHash) {
// local data
expressServer.use(ghostLocals);
// So on every request we actually clean out redundant passive notifications from the server side
// ToDo: Remove when ember handles passive notifications.
expressServer.use(middleware.cleanNotifications);
// Initialise the views
expressServer.use(initViews);

6
core/server/middleware/middleware.js
View file

@ -70,8 +70,7 @@ var middleware = {
msg = {
type: 'error',
message: 'Please Sign In',
status: 'passive',
id: 'failedauth'
status: 'passive'
};
// let's only add the notification once
if (!_.contains(_.pluck(notifications, 'id'), 'failedauth')) {
@ -110,10 +109,11 @@ var middleware = {
// That being ghost.notifications, and let's remove the passives from there
// plus the local messages, as they have already been added at this point
// otherwise they'd appear one too many times
// ToDo: Remove once ember handles passive notifications.
cleanNotifications: function (req, res, next) {
/*jslint unparam:true*/
api.notifications.browse().then(function (notifications) {
_.each(notifications, function (notification) {
_.each(notifications.notifications, function (notification) {
if (notification.status === 'passive') {
api.notifications.destroy(notification);
}

1
core/server/routes/api.js
View file

@ -23,6 +23,7 @@ module.exports = function (server) {
// #### Notifications
server.del('/ghost/api/v0.1/notifications/:id', api.requestHandler(api.notifications.destroy));
server.post('/ghost/api/v0.1/notifications/', api.requestHandler(api.notifications.add));
server.get('/ghost/api/v0.1/notifications/', api.requestHandler(api.notifications.browse));
// #### Import/Export
server.get('/ghost/api/v0.1/db/', api.requestHandler(api.db.exportContent));
server.post('/ghost/api/v0.1/db/', middleware.busboy, api.requestHandler(api.db.importContent));

51
core/test/functional/routes/api/notifications_test.js
View file

@ -79,9 +79,7 @@ describe('Notifications API', function () {
describe('Add', function () {
var newNotification = {
type: 'info',
message: 'test notification',
status: 'persistent',
id: 'add-test-1'
message: 'test notification'
};
it('creates a new notification', function (done) {
@ -93,17 +91,16 @@ describe('Notifications API', function () {
if (err) {
return done(err);
}
res.headers['location'].should.equal('/ghost/api/v0.1/notifications/' + newNotification.id);
var jsonResponse = res.body;
testUtils.API.checkResponse(jsonResponse, 'notification');
jsonResponse.notifications.should.exist;
jsonResponse.type.should.equal(newNotification.type);
jsonResponse.message.should.equal(newNotification.message);
jsonResponse.status.should.equal(newNotification.status);
jsonResponse.id.should.equal(newNotification.id);
testUtils.API.checkResponse(jsonResponse.notifications[0], 'notification');
jsonResponse.notifications[0].type.should.equal(newNotification.type);
jsonResponse.notifications[0].message.should.equal(newNotification.message);
jsonResponse.notifications[0].status.should.equal('persistent');
done();
});
@ -114,8 +111,7 @@ describe('Notifications API', function () {
var newNotification = {
type: 'info',
message: 'test notification',
status: 'persistent',
id: 'delete-test-1'
status: 'persistent'
};
it('deletes a notification', function (done) {
@ -130,17 +126,16 @@ describe('Notifications API', function () {
}
var location = res.headers['location'];
location.should.equal('/ghost/api/v0.1/notifications/' + newNotification.id);
var jsonResponse = res.body;
testUtils.API.checkResponse(jsonResponse, 'notification');
jsonResponse.type.should.equal(newNotification.type);
jsonResponse.message.should.equal(newNotification.message);
jsonResponse.status.should.equal(newNotification.status);
jsonResponse.id.should.equal(newNotification.id);
jsonResponse.notifications.should.exist;
testUtils.API.checkResponse(jsonResponse.notifications[0], 'notification');
jsonResponse.notifications[0].type.should.equal(newNotification.type);
jsonResponse.notifications[0].message.should.equal(newNotification.message);
jsonResponse.notifications[0].status.should.equal(newNotification.status);
// begin delete test
request.del(location)
.set('X-CSRF-Token', csrfToken)
@ -150,17 +145,13 @@ describe('Notifications API', function () {
return done(err);
}
// a delete returns a JSON object containing all notifications
// so we can make sure the notification we just deleted isn't
// included
var notifications = res.body;
var success;
notifications.forEach(function (n) {
success = n.id !== newNotification.id;
});
success.should.be.true;
// a delete returns a JSON object containing the notification
// we just deleted.
var deleteResponse = res.body;
deleteResponse.notifications.should.exist;
deleteResponse.notifications[0].type.should.equal(newNotification.type);
deleteResponse.notifications[0].message.should.equal(newNotification.message);
deleteResponse.notifications[0].status.should.equal(newNotification.status);
done();
});

72
core/test/integration/api/api_notifications_spec.js
View file

@ -34,14 +34,76 @@ describe('Notifications API', function () {
var msg = {
type: 'error', // this can be 'error', 'success', 'warn' and 'info'
message: 'This is an error', // A string. Should fit in one line.
status: 'persistent', // or 'passive'
id: 'auniqueid' // A unique ID
};
NotificationsAPI.add(msg).then(function (notification){
NotificationsAPI.add(msg).then(function (notification) {
NotificationsAPI.browse().then(function (results) {
should.exist(results);
results.length.should.be.above(0);
testUtils.API.checkResponse(results[0], 'notification');
should.exist(results.notifications);
results.notifications.length.should.be.above(0);
testUtils.API.checkResponse(results.notifications[0], 'notification');
done();
});
});
});
it('can add, adds defaults', function (done) {
var msg = {
type: 'info',
message: 'Hello, this is dog'
};
NotificationsAPI.add(msg).then(function (result) {
var notification;
should.exist(result);
should.exist(result.notifications);
notification = result.notifications[0];
notification.dismissable.should.be.true;
should.exist(notification.location);
notification.location.should.equal('bottom');
done();
});
});
it('can add, adds id and status', function (done) {
var msg = {
type: 'info',
message: 'Hello, this is dog',
id: 99
};
NotificationsAPI.add(msg).then(function (result) {
var notification;
should.exist(result);
should.exist(result.notifications);
notification = result.notifications[0];
notification.id.should.be.a.Number;
notification.id.should.not.equal(99);
should.exist(notification.status);
notification.status.should.equal('persistent')
done();
});
});
it('can destroy', function (done) {
var msg = {
type: 'error',
message: 'Goodbye, cruel world!'
};
NotificationsAPI.add(msg).then(function (result) {
var notification = result.notifications[0];
NotificationsAPI.destroy({ id: notification.id }).then(function (result) {
should.exist(result);
should.exist(result.notifications);
result.notifications[0].id.should.equal(notification.id);
done();
}).catch(done);
});

25
core/test/unit/middleware_spec.js
View file

@ -48,27 +48,6 @@ describe('Middleware', function () {
}).catch(done);
});
it('should only add one message to the notification array', function (done) {
var path = 'test/path/party';
req.path = '/ghost/' + path;
middleware.auth(req, res, null).then(function () {
assert(res.redirect.calledWithMatch('/ghost/signin/?r=' + encodeURIComponent(path)));
return api.notifications.browse().then(function (notifications) {
assert.equal(notifications.length, 1);
return;
}).catch(done);
}).then(function () {
return middleware.auth(req, res, null);
}).then(function () {
assert(res.redirect.calledWithMatch('/ghost/signin/?r=' + encodeURIComponent(path)));
return api.notifications.browse().then(function (notifications) {
assert.equal(notifications.length, 1);
done();
}).catch(done);
});
});
it('should call next if session user exists', function (done) {
req.session.user = {};
@ -168,8 +147,8 @@ describe('Middleware', function () {
it('should clean all passive messages', function (done) {
middleware.cleanNotifications(null, null, function () {
api.notifications.browse().then(function (notifications) {
should(notifications.length).eql(1);
var passiveMsgs = _.filter(notifications, function (notification) {
should(notifications.notifications.length).eql(1);
var passiveMsgs = _.filter(notifications.notifications, function (notification) {
return notification.status === 'passive';
});
assert.equal(passiveMsgs.length, 0);

2
core/test/utils/api.js
View file

@ -17,7 +17,7 @@ var url = require('url'),
user: ['id', 'uuid', 'name', 'slug', 'email', 'image', 'cover', 'bio', 'website',
'location', 'accessibility', 'status', 'language', 'meta_title', 'meta_description', 'last_login',
'created_at', 'created_by', 'updated_at', 'updated_by'],
notification: ['type', 'message', 'status', 'id']
notification: ['type', 'message', 'status', 'id', 'dismissable', 'location']
};
function getApiQuery(route) {