mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-18 16:01:40 +03:00
c5a8a0c860
closes #5903, refs #5409 - switch alert/notification component tests from unit to integration where appropriate - rename `notifications.closeAll` to `notifications.clearAll` to better represent it's behaviour - add concept of a "key" to alerts/notifications and ability to close only specified keys through notifications service - close duplicate alerts/notifications before showing a new one - specify a key for all existing alerts - close failure alerts on successful retries - clear all currently displayed alerts on successful sign-in
413 lines
16 KiB
JavaScript
413 lines
16 KiB
JavaScript
/* jshint expr:true */
|
|
import Ember from 'ember';
|
|
import sinon from 'sinon';
|
|
import { expect } from 'chai';
|
|
import {
|
|
describeModule,
|
|
it
|
|
} from 'ember-mocha';
|
|
|
|
const {run, get} = Ember;
|
|
|
|
describeModule(
|
|
'service:notifications',
|
|
'Unit: Service: notifications',
|
|
{
|
|
// Specify the other units that are required for this test.
|
|
// needs: ['model:notification']
|
|
},
|
|
function () {
|
|
beforeEach(function () {
|
|
this.subject().set('content', Ember.A());
|
|
this.subject().set('delayedNotifications', Ember.A());
|
|
});
|
|
|
|
it('filters alerts/notifications', function () {
|
|
var notifications = this.subject();
|
|
|
|
// wrapped in run-loop to enure alerts/notifications CPs are updated
|
|
run(() => {
|
|
notifications.showAlert('Alert');
|
|
notifications.showNotification('Notification');
|
|
});
|
|
|
|
expect(notifications.get('alerts.length')).to.equal(1);
|
|
expect(notifications.get('alerts.firstObject.message')).to.equal('Alert');
|
|
|
|
expect(notifications.get('notifications.length')).to.equal(1);
|
|
expect(notifications.get('notifications.firstObject.message')).to.equal('Notification');
|
|
});
|
|
|
|
it('#handleNotification deals with DS.Notification notifications', function () {
|
|
var notifications = this.subject(),
|
|
notification = Ember.Object.create({message: '<h1>Test</h1>', status: 'alert'});
|
|
|
|
notification.toJSON = function () {};
|
|
|
|
notifications.handleNotification(notification);
|
|
|
|
notification = notifications.get('alerts')[0];
|
|
|
|
// alerts received from the server should be marked html safe
|
|
expect(notification.get('message')).to.have.property('toHTML');
|
|
});
|
|
|
|
it('#handleNotification defaults to notification if no status supplied', function () {
|
|
var notifications = this.subject();
|
|
|
|
notifications.handleNotification({message: 'Test'}, false);
|
|
|
|
expect(notifications.get('content'))
|
|
.to.deep.include({message: 'Test', status: 'notification'});
|
|
});
|
|
|
|
it('#showAlert adds POJO alerts', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showAlert('Test Alert', {type: 'error'});
|
|
});
|
|
|
|
expect(notifications.get('alerts'))
|
|
.to.deep.include({message: 'Test Alert', status: 'alert', type: 'error', key: undefined});
|
|
});
|
|
|
|
it('#showAlert adds delayed notifications', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showNotification('Test Alert', {type: 'error', delayed: true});
|
|
});
|
|
|
|
expect(notifications.get('delayedNotifications'))
|
|
.to.deep.include({message: 'Test Alert', status: 'notification', type: 'error', key: undefined});
|
|
});
|
|
|
|
// in order to cater for complex keys that are suitable for i18n
|
|
// we split on the second period and treat the resulting base as
|
|
// the key for duplicate checking
|
|
it('#showAlert clears duplicates', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showAlert('Kept');
|
|
notifications.showAlert('Duplicate', {key: 'duplicate.key.fail'});
|
|
});
|
|
|
|
expect(notifications.get('alerts.length')).to.equal(2);
|
|
|
|
run(() => {
|
|
notifications.showAlert('Duplicate with new message', {key: 'duplicate.key.success'});
|
|
});
|
|
|
|
expect(notifications.get('alerts.length')).to.equal(2);
|
|
expect(notifications.get('alerts.lastObject.message')).to.equal('Duplicate with new message');
|
|
});
|
|
|
|
it('#showNotification adds POJO notifications', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showNotification('Test Notification', {type: 'success'});
|
|
});
|
|
|
|
expect(notifications.get('notifications'))
|
|
.to.deep.include({message: 'Test Notification', status: 'notification', type: 'success', key: undefined});
|
|
});
|
|
|
|
it('#showNotification adds delayed notifications', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showNotification('Test Notification', {delayed: true});
|
|
});
|
|
|
|
expect(notifications.get('delayedNotifications'))
|
|
.to.deep.include({message: 'Test Notification', status: 'notification', type: undefined, key: undefined});
|
|
});
|
|
|
|
it('#showNotification clears existing notifications', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showNotification('First');
|
|
notifications.showNotification('Second');
|
|
});
|
|
|
|
expect(notifications.get('notifications.length')).to.equal(1);
|
|
expect(notifications.get('notifications'))
|
|
.to.deep.equal([{message: 'Second', status: 'notification', type: undefined, key: undefined}]);
|
|
});
|
|
|
|
it('#showNotification keeps existing notifications if doNotCloseNotifications option passed', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showNotification('First');
|
|
notifications.showNotification('Second', {doNotCloseNotifications: true});
|
|
});
|
|
|
|
expect(notifications.get('notifications.length')).to.equal(2);
|
|
});
|
|
|
|
// TODO: review whether this can be removed once it's no longer used by validations
|
|
it('#showErrors adds multiple notifications', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showErrors([
|
|
{message: 'First'},
|
|
{message: 'Second'}
|
|
]);
|
|
});
|
|
|
|
expect(notifications.get('notifications')).to.deep.equal([
|
|
{message: 'First', status: 'notification', type: 'error', key: undefined},
|
|
{message: 'Second', status: 'notification', type: 'error', key: undefined}
|
|
]);
|
|
});
|
|
|
|
it('#showAPIError adds single json response error', function () {
|
|
var notifications = this.subject(),
|
|
resp = {jqXHR: {responseJSON: {error: 'Single error'}}};
|
|
|
|
run(() => {
|
|
notifications.showAPIError(resp);
|
|
});
|
|
|
|
let notification = notifications.get('alerts.firstObject');
|
|
expect(get(notification, 'message')).to.equal('Single error');
|
|
expect(get(notification, 'status')).to.equal('alert');
|
|
expect(get(notification, 'type')).to.equal('error');
|
|
expect(get(notification, 'key')).to.equal('api-error');
|
|
});
|
|
|
|
// used to display validation errors returned from the server
|
|
it('#showAPIError adds multiple json response errors', function () {
|
|
var notifications = this.subject(),
|
|
resp = {jqXHR: {responseJSON: {errors: ['First error', 'Second error']}}};
|
|
|
|
run(() => {
|
|
notifications.showAPIError(resp);
|
|
});
|
|
|
|
expect(notifications.get('notifications')).to.deep.equal([
|
|
{message: 'First error', status: 'notification', type: 'error', key: undefined},
|
|
{message: 'Second error', status: 'notification', type: 'error', key: undefined}
|
|
]);
|
|
});
|
|
|
|
it('#showAPIError adds single json response message', function () {
|
|
var notifications = this.subject(),
|
|
resp = {jqXHR: {responseJSON: {message: 'Single message'}}};
|
|
|
|
run(() => {
|
|
notifications.showAPIError(resp);
|
|
});
|
|
|
|
let notification = notifications.get('alerts.firstObject');
|
|
expect(get(notification, 'message')).to.equal('Single message');
|
|
expect(get(notification, 'status')).to.equal('alert');
|
|
expect(get(notification, 'type')).to.equal('error');
|
|
expect(get(notification, 'key')).to.equal('api-error');
|
|
});
|
|
|
|
it('#showAPIError displays default error text if response has no error/message', function () {
|
|
var notifications = this.subject(),
|
|
resp = {};
|
|
|
|
run(() => { notifications.showAPIError(resp); });
|
|
expect(notifications.get('content')).to.deep.equal([
|
|
{message: 'There was a problem on the server, please try again.', status: 'alert', type: 'error', key: 'api-error'}
|
|
]);
|
|
|
|
notifications.set('content', Ember.A());
|
|
|
|
run(() => {
|
|
notifications.showAPIError(resp, {defaultErrorText: 'Overridden default'});
|
|
});
|
|
expect(notifications.get('content')).to.deep.equal([
|
|
{message: 'Overridden default', status: 'alert', type: 'error', key: 'api-error'}
|
|
]);
|
|
});
|
|
|
|
it('#showAPIError sets correct key when passed a base key', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showAPIError('Test', {key: 'test.alert'});
|
|
});
|
|
|
|
expect(notifications.get('alerts.firstObject.key')).to.equal('test.alert.api-error');
|
|
});
|
|
|
|
it('#showAPIError sets correct key when not passed a key', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showAPIError('Test');
|
|
});
|
|
|
|
expect(notifications.get('alerts.firstObject.key')).to.equal('api-error');
|
|
});
|
|
|
|
it('#displayDelayed moves delayed notifications into content', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showNotification('First', {delayed: true});
|
|
notifications.showNotification('Second', {delayed: true});
|
|
notifications.showNotification('Third', {delayed: false});
|
|
notifications.displayDelayed();
|
|
});
|
|
|
|
expect(notifications.get('notifications')).to.deep.equal([
|
|
{message: 'Third', status: 'notification', type: undefined, key: undefined},
|
|
{message: 'First', status: 'notification', type: undefined, key: undefined},
|
|
{message: 'Second', status: 'notification', type: undefined, key: undefined}
|
|
]);
|
|
});
|
|
|
|
it('#closeNotification removes POJO notifications', function () {
|
|
var notification = {message: 'Close test', status: 'notification'},
|
|
notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.handleNotification(notification);
|
|
});
|
|
|
|
expect(notifications.get('notifications'))
|
|
.to.include(notification);
|
|
|
|
run(() => {
|
|
notifications.closeNotification(notification);
|
|
});
|
|
|
|
expect(notifications.get('notifications'))
|
|
.to.not.include(notification);
|
|
});
|
|
|
|
it('#closeNotification removes and deletes DS.Notification records', function () {
|
|
var notification = Ember.Object.create({message: 'Close test', status: 'alert'}),
|
|
notifications = this.subject();
|
|
|
|
notification.toJSON = function () {};
|
|
notification.deleteRecord = function () {};
|
|
sinon.spy(notification, 'deleteRecord');
|
|
notification.save = function () {
|
|
return {
|
|
finally: function (callback) { return callback(notification); }
|
|
};
|
|
};
|
|
sinon.spy(notification, 'save');
|
|
|
|
run(() => { notifications.handleNotification(notification); });
|
|
|
|
expect(notifications.get('alerts')).to.include(notification);
|
|
|
|
run(() => { notifications.closeNotification(notification); });
|
|
|
|
expect(notification.deleteRecord.calledOnce).to.be.true;
|
|
expect(notification.save.calledOnce).to.be.true;
|
|
|
|
expect(notifications.get('alerts')).to.not.include(notification);
|
|
});
|
|
|
|
it('#closeNotifications only removes notifications', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showAlert('First alert');
|
|
notifications.showNotification('First notification');
|
|
notifications.showNotification('Second notification', {doNotCloseNotifications: true});
|
|
});
|
|
|
|
expect(notifications.get('alerts.length'), 'alerts count').to.equal(1);
|
|
expect(notifications.get('notifications.length'), 'notifications count').to.equal(2);
|
|
|
|
run(() => { notifications.closeNotifications(); });
|
|
|
|
expect(notifications.get('alerts.length'), 'alerts count').to.equal(1);
|
|
expect(notifications.get('notifications.length'), 'notifications count').to.equal(0);
|
|
});
|
|
|
|
it('#closeNotifications only closes notifications with specified key', function () {
|
|
var notifications = this.subject();
|
|
|
|
run(() => {
|
|
notifications.showAlert('First alert');
|
|
// using handleNotification as showNotification will auto-prune
|
|
// duplicates and keys will be removed if doNotCloseNotifications
|
|
// is true
|
|
notifications.handleNotification({message: 'First notification', key: 'test.close', status: 'notification'});
|
|
notifications.handleNotification({message: 'Second notification', key: 'test.keep', status: 'notification'});
|
|
notifications.handleNotification({message: 'Third notification', key: 'test.close', status: 'notification'});
|
|
});
|
|
|
|
run(() => {
|
|
notifications.closeNotifications('test.close');
|
|
});
|
|
|
|
expect(notifications.get('notifications.length'), 'notifications count').to.equal(1);
|
|
expect(notifications.get('notifications.firstObject.message'), 'notification message').to.equal('Second notification');
|
|
expect(notifications.get('alerts.length'), 'alerts count').to.equal(1);
|
|
});
|
|
|
|
it('#clearAll removes everything without deletion', function () {
|
|
var notifications = this.subject(),
|
|
notificationModel = Ember.Object.create({message: 'model'});
|
|
|
|
notificationModel.toJSON = function () {};
|
|
notificationModel.deleteRecord = function () {};
|
|
sinon.spy(notificationModel, 'deleteRecord');
|
|
notificationModel.save = function () {
|
|
return {
|
|
finally: function (callback) { return callback(notificationModel); }
|
|
};
|
|
};
|
|
sinon.spy(notificationModel, 'save');
|
|
|
|
notifications.handleNotification(notificationModel);
|
|
notifications.handleNotification({message: 'pojo'});
|
|
|
|
notifications.clearAll();
|
|
|
|
expect(notifications.get('content')).to.be.empty;
|
|
expect(notificationModel.deleteRecord.called).to.be.false;
|
|
expect(notificationModel.save.called).to.be.false;
|
|
});
|
|
|
|
it('#closeAlerts only removes alerts', function () {
|
|
var notifications = this.subject();
|
|
|
|
notifications.showNotification('First notification');
|
|
notifications.showAlert('First alert');
|
|
notifications.showAlert('Second alert');
|
|
|
|
run(() => {
|
|
notifications.closeAlerts();
|
|
});
|
|
|
|
expect(notifications.get('alerts.length')).to.equal(0);
|
|
expect(notifications.get('notifications.length')).to.equal(1);
|
|
});
|
|
|
|
it('#closeAlerts closes only alerts with specified key', function () {
|
|
var notifications = this.subject();
|
|
|
|
notifications.showNotification('First notification');
|
|
notifications.showAlert('First alert', {key: 'test.close'});
|
|
notifications.showAlert('Second alert', {key: 'test.keep'});
|
|
notifications.showAlert('Third alert', {key: 'test.close'});
|
|
|
|
run(() => {
|
|
notifications.closeAlerts('test.close');
|
|
});
|
|
|
|
expect(notifications.get('alerts.length')).to.equal(1);
|
|
expect(notifications.get('alerts.firstObject.message')).to.equal('Second alert');
|
|
expect(notifications.get('notifications.length')).to.equal(1);
|
|
});
|
|
}
|
|
);
|