mirror of
https://github.com/nasa/openmct.git
synced 2024-12-23 23:12:23 +00:00
0442a31153
In the spec: NotificationService knows about concepts like "info", "alert" and "error" only, having a plain info notification model called successModel doesn't help much and may be confusing at times (makes you think it's something the service treats separately).
235 lines
12 KiB
JavaScript
235 lines
12 KiB
JavaScript
/*****************************************************************************
|
|
* Open MCT, Copyright (c) 2014-2016, United States Government
|
|
* as represented by the Administrator of the National Aeronautics and Space
|
|
* Administration. All rights reserved.
|
|
*
|
|
* Open MCT is licensed under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
* http://www.apache.org/licenses/LICENSE-2.0.
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
* Open MCT includes source code licensed under additional open source
|
|
* licenses. See the Open Source Licenses file (LICENSES.md) included with
|
|
* this source code distribution or the Licensing information page available
|
|
* at runtime from the About dialog for additional information.
|
|
*****************************************************************************/
|
|
/*global describe,it,expect,beforeEach,jasmine*/
|
|
|
|
define(
|
|
['../src/NotificationService'],
|
|
function (NotificationService) {
|
|
|
|
describe("The notification service ", function () {
|
|
var notificationService,
|
|
mockTimeout,
|
|
mockAutoDismiss,
|
|
mockMinimizeTimeout,
|
|
mockTopicFunction,
|
|
mockTopicObject,
|
|
infoModel,
|
|
errorModel;
|
|
|
|
beforeEach(function () {
|
|
mockTimeout = jasmine.createSpy("$timeout");
|
|
mockTopicFunction = jasmine.createSpy("topic");
|
|
mockTopicObject = jasmine.createSpyObj("topicObject", ["listen", "notify"]);
|
|
mockTopicFunction.andReturn(mockTopicObject);
|
|
|
|
mockAutoDismiss = mockMinimizeTimeout = 1000;
|
|
notificationService = new NotificationService(
|
|
mockTimeout, mockTopicFunction, mockAutoDismiss, mockMinimizeTimeout);
|
|
|
|
infoModel = {
|
|
title: "Mock Info Notification",
|
|
severity: "info"
|
|
};
|
|
|
|
errorModel = {
|
|
title: "Mock Error Notification",
|
|
severity: "error"
|
|
};
|
|
});
|
|
|
|
it("activates info notifications", function () {
|
|
var activeNotification;
|
|
notificationService.notify(infoModel);
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification.model).toBe(infoModel);
|
|
});
|
|
|
|
it("notifies listeners on dismissal of notification", function () {
|
|
var notification,
|
|
dismissListener = jasmine.createSpy("ondismiss");
|
|
notification = notificationService.notify(infoModel);
|
|
notification.onDismiss(dismissListener);
|
|
expect(mockTopicObject.listen).toHaveBeenCalled();
|
|
notification.dismiss();
|
|
expect(mockTopicObject.notify).toHaveBeenCalled();
|
|
mockTopicObject.listen.mostRecentCall.args[0]();
|
|
expect(dismissListener).toHaveBeenCalled();
|
|
|
|
});
|
|
|
|
it("activates an info notification built with just the title", function () {
|
|
var activeNotification,
|
|
notificationTitle = "Test info notification";
|
|
notificationService.info(notificationTitle);
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification.model.title).toBe(notificationTitle);
|
|
expect(activeNotification.model.severity).toBe("info");
|
|
});
|
|
|
|
it("gets a new info notification with numerical auto-dismiss specified. ", function () {
|
|
var activeNotification;
|
|
infoModel.autoDismiss = 1000;
|
|
notificationService.notify(infoModel);
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification.model).toBe(infoModel);
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
expect(mockTimeout.calls.length).toBe(2);
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification).toBeUndefined();
|
|
});
|
|
|
|
it("gets a new notification with boolean auto-dismiss specified. ", function () {
|
|
var activeNotification;
|
|
infoModel.autoDismiss = true;
|
|
notificationService.notify(infoModel);
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification.model).toBe(infoModel);
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
expect(mockTimeout.calls.length).toBe(2);
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification).toBeUndefined();
|
|
});
|
|
|
|
it("allows minimization of notifications", function () {
|
|
var notification,
|
|
activeNotification;
|
|
|
|
infoModel.autoDismiss = false;
|
|
notification = notificationService.notify(infoModel);
|
|
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification.model).toBe(infoModel);
|
|
notification.minimize();
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification).toBeUndefined();
|
|
expect(notificationService.notifications.length).toBe(1);
|
|
});
|
|
|
|
it("allows dismissal of notifications", function () {
|
|
var notification,
|
|
activeNotification;
|
|
|
|
infoModel.autoDismiss = false;
|
|
notification = notificationService.notify(infoModel);
|
|
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification.model).toBe(infoModel);
|
|
notification.dismiss();
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification).toBeUndefined();
|
|
expect(notificationService.notifications.length).toBe(0);
|
|
});
|
|
|
|
describe("when called with multiple notifications", function () {
|
|
it("auto-dismisses the previously active notification, making the new notification active", function () {
|
|
var activeNotification;
|
|
//First pre-load with a info message
|
|
notificationService.notify(infoModel);
|
|
activeNotification =
|
|
notificationService.getActiveNotification();
|
|
//Initially expect the active notification to be info
|
|
expect(activeNotification.model).toBe(infoModel);
|
|
//Then notify of an error
|
|
notificationService.notify(errorModel);
|
|
//But it should be auto-dismissed and replaced with the
|
|
// error notification
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
//Two timeouts, one is to force minimization after
|
|
// displaying the message for a minimum period, the
|
|
// second is to allow minimization animation to take place.
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
activeNotification = notificationService.getActiveNotification();
|
|
expect(activeNotification.model).toBe(errorModel);
|
|
});
|
|
|
|
it("auto-minimizes an active error notification", function () {
|
|
var activeNotification;
|
|
//First pre-load with an error message
|
|
notificationService.notify(errorModel);
|
|
//Then notify of info
|
|
notificationService.notify(infoModel);
|
|
expect(notificationService.notifications.length).toEqual(2);
|
|
//Mock the auto-minimize
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
//Two timeouts, one is to force minimization after
|
|
// displaying the message for a minimum period, the
|
|
// second is to allow minimization animation to take place.
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
//Previous error message should be minimized, not
|
|
// dismissed
|
|
expect(notificationService.notifications.length).toEqual(2);
|
|
activeNotification =
|
|
notificationService.getActiveNotification();
|
|
expect(activeNotification.model).toBe(infoModel);
|
|
expect(errorModel.minimized).toEqual(true);
|
|
});
|
|
|
|
it("auto-minimizes errors when a number of them arrive in short succession", function () {
|
|
var activeNotification,
|
|
error2 = {
|
|
title: "Second Mock Error Notification",
|
|
severity: "error"
|
|
},
|
|
error3 = {
|
|
title: "Third Mock Error Notification",
|
|
severity: "error"
|
|
};
|
|
|
|
//First pre-load with a info message
|
|
notificationService.notify(errorModel);
|
|
//Then notify of a third error
|
|
notificationService.notify(error2);
|
|
notificationService.notify(error3);
|
|
expect(notificationService.notifications.length).toEqual(3);
|
|
//Mock the auto-minimize
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
//Two timeouts, one is to force minimization after
|
|
// displaying the message for a minimum period, the
|
|
// second is to allow minimization animation to take place.
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
//Previous error message should be minimized, not
|
|
// dismissed
|
|
expect(notificationService.notifications.length).toEqual(3);
|
|
activeNotification =
|
|
notificationService.getActiveNotification();
|
|
expect(activeNotification.model).toBe(error2);
|
|
expect(errorModel.minimized).toEqual(true);
|
|
|
|
//Mock the second auto-minimize
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
//Two timeouts, one is to force minimization after
|
|
// displaying the message for a minimum period, the
|
|
// second is to allow minimization animation to take place.
|
|
mockTimeout.mostRecentCall.args[0]();
|
|
activeNotification =
|
|
notificationService.getActiveNotification();
|
|
expect(activeNotification.model).toBe(error3);
|
|
expect(error2.minimized).toEqual(true);
|
|
});
|
|
});
|
|
});
|
|
}
|
|
);
|