import EmberObject from '@ember/object'; import sinon from 'sinon'; import {AjaxError, InvalidError} from 'ember-ajax/errors'; import {ServerUnreachableError} from 'ghost-admin/services/ajax'; import {describe, it} from 'mocha'; import {A as emberA} from '@ember/array'; import {expect} from 'chai'; import {get} from '@ember/object'; import {run} from '@ember/runloop'; import {setupTest} from 'ember-mocha'; describe('Unit: Service: notifications', function () { setupTest('service:notifications', { needs: ['service:upgradeStatus'] }); beforeEach(function () { this.subject().set('content', emberA()); this.subject().set('delayedNotifications', emberA()); }); it('filters alerts/notifications', function () { let 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 () { let notifications = this.subject(); let notification = EmberObject.create({message: '

Test

', 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 () { let 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 () { let 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 () { let 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 using keys', function () { let 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('#showAlert clears duplicates using message text', function () { let notifications = this.subject(); notifications.showAlert('Not duplicate'); notifications.showAlert('Duplicate', {key: 'duplicate'}); notifications.showAlert('Duplicate'); expect(notifications.get('alerts.length')).to.equal(2); expect(notifications.get('alerts.lastObject.key')).to.not.exist; }); it('#showNotification adds POJO notifications', function () { let 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 () { let 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 () { let 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 () { let notifications = this.subject(); run(() => { notifications.showNotification('First'); notifications.showNotification('Second', {doNotCloseNotifications: true}); }); expect(notifications.get('notifications.length')).to.equal(2); }); it('#showAPIError handles single json response error', function () { let notifications = this.subject(); let error = new AjaxError({errors: [{message: 'Single error'}]}); run(() => { notifications.showAPIError(error); }); let alert = notifications.get('alerts.firstObject'); expect(get(alert, 'message')).to.equal('Single error'); expect(get(alert, 'status')).to.equal('alert'); expect(get(alert, 'type')).to.equal('error'); expect(get(alert, 'key')).to.equal('api-error'); }); it('#showAPIError handles multiple json response errors', function () { let notifications = this.subject(); let error = new AjaxError({errors: [ {title: 'First error', message: 'First error message'}, {title: 'Second error', message: 'Second error message'} ]}); run(() => { notifications.showAPIError(error); }); expect(notifications.get('alerts.length')).to.equal(2); let [alert1, alert2] = notifications.get('alerts'); expect(alert1).to.deep.equal({message: 'First error message', status: 'alert', type: 'error', key: 'api-error.first-error'}); expect(alert2).to.deep.equal({message: 'Second error message', status: 'alert', type: 'error', key: 'api-error.second-error'}); }); it('#showAPIError displays default error text if response has no error/message', function () { let notifications = this.subject(); let resp = false; run(() => { notifications.showAPIError(resp); }); expect(notifications.get('content').toArray()).to.deep.equal([ {message: 'There was a problem on the server, please try again.', status: 'alert', type: 'error', key: 'api-error'} ]); notifications.set('content', emberA()); run(() => { notifications.showAPIError(resp, {defaultErrorText: 'Overridden default'}); }); expect(notifications.get('content').toArray()).to.deep.equal([ {message: 'Overridden default', status: 'alert', type: 'error', key: 'api-error'} ]); }); it('#showAPIError sets correct key when passed a base key', function () { let notifications = this.subject(); run(() => { notifications.showAPIError('Test', {key: 'test.alert'}); }); expect(notifications.get('alerts.firstObject.key')).to.equal('api-error.test.alert'); }); it('#showAPIError sets correct key when not passed a key', function () { let notifications = this.subject(); run(() => { notifications.showAPIError('Test'); }); expect(notifications.get('alerts.firstObject.key')).to.equal('api-error'); }); it('#showAPIError parses default ember-ajax errors correctly', function () { let notifications = this.subject(); let error = new InvalidError(); run(() => { notifications.showAPIError(error); }); let notification = notifications.get('alerts.firstObject'); expect(get(notification, 'message')).to.equal('Request was rejected because it was invalid'); expect(get(notification, 'status')).to.equal('alert'); expect(get(notification, 'type')).to.equal('error'); expect(get(notification, 'key')).to.equal('api-error'); }); it('#showAPIError parses custom ember-ajax errors correctly', function () { let notifications = this.subject(); let error = new ServerUnreachableError(); run(() => { notifications.showAPIError(error); }); let notification = notifications.get('alerts.firstObject'); expect(get(notification, 'message')).to.equal('Server was unreachable'); expect(get(notification, 'status')).to.equal('alert'); expect(get(notification, 'type')).to.equal('error'); expect(get(notification, 'key')).to.equal('api-error'); }); it('#showAPIError adds error context to message if available', function () { let notifications = this.subject(); let error = new AjaxError({errors: [{ message: 'Authorization Error.', context: 'Please sign in.' }]}); run(() => { notifications.showAPIError(error); }); let alert = notifications.get('alerts.firstObject'); expect(get(alert, 'message')).to.equal('Authorization Error. Please sign in.'); expect(get(alert, 'status')).to.equal('alert'); expect(get(alert, 'type')).to.equal('error'); expect(get(alert, 'key')).to.equal('api-error'); }); it('#displayDelayed moves delayed notifications into content', function () { let 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 () { let notification = {message: 'Close test', status: 'notification'}; let 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 () { let notification = EmberObject.create({message: 'Close test', status: 'alert'}); let notifications = this.subject(); notification.toJSON = function () {}; notification.deleteRecord = function () {}; sinon.spy(notification, 'deleteRecord'); notification.save = function () { return { finally(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 () { let 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 () { let 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 () { let notifications = this.subject(); let notificationModel = EmberObject.create({message: 'model'}); notificationModel.toJSON = function () {}; notificationModel.deleteRecord = function () {}; sinon.spy(notificationModel, 'deleteRecord'); notificationModel.save = function () { return { finally(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 () { let 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 () { let 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); }); });