Merge pull request #42 from josemarluedke/feat/notifications-testing

Allow notifications to skipTimer and clear timer on removal

packages/notifications/addon/-private/get-config.ts

@@ -0,0 +1,14 @@
+import config from 'ember-get-config';
+import { DefaultConfig } from './types';
+import { getWithDefault } from '@ember/object';
+
+export function getConfigOption<T extends keyof DefaultConfig>(
+  key: T,
+  defaultValue: NonNullable<DefaultConfig[T]> | undefined
+): NonNullable<DefaultConfig[T]> {
+  return getWithDefault(
+    config['@frontile/notifications'] || ({} as never),
+    key as never,
+    defaultValue as never
+  );
+}

packages/notifications/addon/-private/manager.ts

@@ -1,8 +1,9 @@
 import Notification from './notification';
 import Timer from './timer';
+import { NotificationOptions } from './types';
+import { getConfigOption } from './get-config';
 import { tracked } from '@glimmer/tracking';
 import { later } from '@ember/runloop';
-import { NotificationOptions } from './types';
 
 export default class NotificationsManager {
   @tracked notifications: Notification[] = [];
@@ -11,7 +12,18 @@ export default class NotificationsManager {
     const notification = new Notification(message, options);
     this.notifications = [...this.notifications, notification];
 
-    if (options.preserve !== true) {
+    let preserve =
+      typeof options.preserve === 'undefined'
+        ? getConfigOption('preserve', false)
+        : options.preserve;
+
+    // if default config has set skipTimer to true, we will preserve the
+    // notification, therefore skiping the timer
+    if (getConfigOption('skipTimer', false) === true) {
+      preserve = true;
+    }
+
+    if (preserve === false) {
       this.setupAutoRemoval(notification, notification.duration);
     }
     return notification;
@@ -22,7 +34,7 @@ export default class NotificationsManager {
       return;
     }
 
-    notification.isRemoving = true;
+    notification.remove();
 
     later(
       this,

packages/notifications/addon/-private/notification.ts

@@ -1,19 +1,7 @@
 import { tracked } from '@glimmer/tracking';
 import Timer from './timer';
 import { NotificationOptions, CustomAction } from './types';
-import config from 'ember-get-config';
-import { getWithDefault } from '@ember/object';
-
-function getConfigOption<T extends keyof NotificationOptions>(
-  key: T,
-  defaultValue: NonNullable<NotificationOptions[T]>
-): NonNullable<NotificationOptions[T]> {
-  return getWithDefault(
-    config['@frontile/notifications'] || ({} as never),
-    key as never,
-    defaultValue as never
-  );
-}
+import { getConfigOption } from './get-config';
 
 export default class Notification {
   readonly message: string;
@@ -43,4 +31,12 @@ export default class Notification {
       this.allowClosing = true;
     }
   }
+
+  remove(): void {
+    this.isRemoving = true;
+
+    if (this.timer) {
+      this.timer.clear();
+    }
+  }
 }

packages/notifications/addon/-private/types.ts

@@ -36,3 +36,14 @@ export interface NotificationOptions {
    */
   customActions?: CustomAction[];
 }
+
+export interface DefaultConfig extends NotificationOptions {
+  /*
+   * If set to true, we will preserve the notification, therefore skiping the timer.
+   * This is useful in tests because Ember will wait for any runloop to
+   * finish before proceeding.
+   *
+   * @defaultValue false
+   */
+  skipTimer?: boolean;
+}

packages/notifications/addon/index.ts

@@ -1,12 +1,17 @@
 import Notification from './-private/notification';
 import Timer from './-private/timer';
 import NotificationsService from './services/notifications';
-import { NotificationOptions, CustomAction } from './-private/types';
+import {
+  DefaultConfig,
+  NotificationOptions,
+  CustomAction
+} from './-private/types';
 
 export {
   Notification,
   Timer,
   NotificationsService,
   NotificationOptions,
+  DefaultConfig,
   CustomAction
 };

packages/notifications/addon/services/notifications.ts

@@ -21,6 +21,11 @@ export default class NotificationsService extends Service {
   removeAll(): void {
     this.manager.removeAll();
   }
+
+  willDestroy(): void {
+    this.removeAll();
+    super.willDestroy();
+  }
 }
 
 // DO NOT DELETE: this is how TypeScript knows how to look up your services.

packages/notifications/tests/dummy/app/config/environment.d.ts

@@ -1,4 +1,5 @@
-import { NotificationOptions } from '@frontile/notifications';
+import { DefaultConfig } from '@frontile/notifications';
+
 /**
  * Type declarations for
  *    import config from './config/environment'
@@ -12,7 +13,7 @@ declare const config: {
   podModulePrefix: string;
   locationType: string;
   rootURL: string;
-  '@frontile/notifications'?: NotificationOptions;
+  '@frontile/notifications'?: DefaultConfig;
 };
 
 export default config;