Retains support for Infinity and adds a dev note on what using the va…

…lue does
elastic · Apr 19, 2021 · 3e614a7 · 3e614a7
1 parent 5aa86e3
commit 3e614a7
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 40 deletions.
diff --git a/src/core/server/ui_settings/settings/notifications.test.ts b/src/core/server/ui_settings/settings/notifications.test.ts
@@ -34,15 +34,17 @@ describe('notifications settings', () => {
 
     it('should only accept positive numeric values or `Infinity`', () => {
       expect(() => validate(42)).not.toThrow();
-      expect(() => validate('Infinity')).toThrowErrorMatchingInlineSnapshot(
-        `"expected value of type [number] but got [string]"`
-      );
-      expect(() => validate(-12)).toThrowErrorMatchingInlineSnapshot(
-        `"Value must be equal to or greater than [0]."`
-      );
-      expect(() => validate('foo')).toThrowErrorMatchingInlineSnapshot(
-        `"expected value of type [number] but got [string]"`
-      );
+      expect(() => validate('Infinity')).not.toThrow();
+      expect(() => validate(-12)).toThrowErrorMatchingInlineSnapshot(`
+        "types that failed validation:
+        - [0]: Value must be equal to or greater than [0].
+        - [1]: expected value to equal [Infinity]"
+      `);
+      expect(() => validate('foo')).toThrowErrorMatchingInlineSnapshot(`
+        "types that failed validation:
+        - [0]: expected value of type [number] but got [string]
+        - [1]: expected value to equal [Infinity]"
+      `);
     });
   });
 
@@ -51,15 +53,17 @@ describe('notifications settings', () => {
 
     it('should only accept positive numeric values or `Infinity`', () => {
       expect(() => validate(42)).not.toThrow();
-      expect(() => validate('Infinity')).toThrowErrorMatchingInlineSnapshot(
-        `"expected value of type [number] but got [string]"`
-      );
-      expect(() => validate(-12)).toThrowErrorMatchingInlineSnapshot(
-        `"Value must be equal to or greater than [0]."`
-      );
-      expect(() => validate('foo')).toThrowErrorMatchingInlineSnapshot(
-        `"expected value of type [number] but got [string]"`
-      );
+      expect(() => validate('Infinity')).not.toThrow();
+      expect(() => validate(-12)).toThrowErrorMatchingInlineSnapshot(`
+        "types that failed validation:
+        - [0]: Value must be equal to or greater than [0].
+        - [1]: expected value to equal [Infinity]"
+      `);
+      expect(() => validate('foo')).toThrowErrorMatchingInlineSnapshot(`
+        "types that failed validation:
+        - [0]: expected value of type [number] but got [string]
+        - [1]: expected value to equal [Infinity]"
+      `);
     });
   });
 
@@ -68,15 +72,17 @@ describe('notifications settings', () => {
 
     it('should only accept positive numeric values or `Infinity`', () => {
       expect(() => validate(42)).not.toThrow();
-      expect(() => validate('Infinity')).toThrowErrorMatchingInlineSnapshot(
-        `"expected value of type [number] but got [string]"`
-      );
-      expect(() => validate(-12)).toThrowErrorMatchingInlineSnapshot(
-        `"Value must be equal to or greater than [0]."`
-      );
-      expect(() => validate('foo')).toThrowErrorMatchingInlineSnapshot(
-        `"expected value of type [number] but got [string]"`
-      );
+      expect(() => validate('Infinity')).not.toThrow();
+      expect(() => validate(-12)).toThrowErrorMatchingInlineSnapshot(`
+        "types that failed validation:
+        - [0]: Value must be equal to or greater than [0].
+        - [1]: expected value to equal [Infinity]"
+      `);
+      expect(() => validate('foo')).toThrowErrorMatchingInlineSnapshot(`
+        "types that failed validation:
+        - [0]: expected value of type [number] but got [string]
+        - [1]: expected value to equal [Infinity]"
+      `);
     });
   });
 
@@ -85,15 +91,17 @@ describe('notifications settings', () => {
 
     it('should only accept positive numeric values or `Infinity`', () => {
       expect(() => validate(42)).not.toThrow();
-      expect(() => validate('Infinity')).toThrowErrorMatchingInlineSnapshot(
-        `"expected value of type [number] but got [string]"`
-      );
-      expect(() => validate(-12)).toThrowErrorMatchingInlineSnapshot(
-        `"Value must be equal to or greater than [0]."`
-      );
-      expect(() => validate('foo')).toThrowErrorMatchingInlineSnapshot(
-        `"expected value of type [number] but got [string]"`
-      );
+      expect(() => validate('Infinity')).not.toThrow();
+      expect(() => validate(-12)).toThrowErrorMatchingInlineSnapshot(`
+        "types that failed validation:
+        - [0]: Value must be equal to or greater than [0].
+        - [1]: expected value to equal [Infinity]"
+      `);
+      expect(() => validate('foo')).toThrowErrorMatchingInlineSnapshot(`
+        "types that failed validation:
+        - [0]: expected value of type [number] but got [string]
+        - [1]: expected value to equal [Infinity]"
+      `);
     });
   });
 });
diff --git a/src/core/server/ui_settings/settings/notifications.ts b/src/core/server/ui_settings/settings/notifications.ts
@@ -49,7 +49,7 @@ export const getNotificationsSettings = (): Record<string, UiSettingsParams> =>
       }),
       type: 'number',
       category: ['notifications'],
-      schema: schema.number({ min: 0 }),
+      schema: schema.oneOf([schema.number({ min: 0 }), schema.literal('Infinity')]), // Setting to 'Infinity' will disable the countdown.
     },
     'notifications:lifetime:error': {
       name: i18n.translate('core.ui_settings.params.notifications.errorLifetimeTitle', {
@@ -62,7 +62,7 @@ export const getNotificationsSettings = (): Record<string, UiSettingsParams> =>
       }),
       type: 'number',
       category: ['notifications'],
-      schema: schema.number({ min: 0 }),
+      schema: schema.oneOf([schema.number({ min: 0 }), schema.literal('Infinity')]), // Setting to 'Infinity' will disable
     },
     'notifications:lifetime:warning': {
       name: i18n.translate('core.ui_settings.params.notifications.warningLifetimeTitle', {
@@ -75,7 +75,7 @@ export const getNotificationsSettings = (): Record<string, UiSettingsParams> =>
       }),
       type: 'number',
       category: ['notifications'],
-      schema: schema.number({ min: 0 }),
+      schema: schema.oneOf([schema.number({ min: 0 }), schema.literal('Infinity')]), // Setting to 'Infinity' will disable
     },
     'notifications:lifetime:info': {
       name: i18n.translate('core.ui_settings.params.notifications.infoLifetimeTitle', {
@@ -88,7 +88,7 @@ export const getNotificationsSettings = (): Record<string, UiSettingsParams> =>
       }),
       type: 'number',
       category: ['notifications'],
-      schema: schema.number({ min: 0 }),
+      schema: schema.oneOf([schema.number({ min: 0 }), schema.literal('Infinity')]), // Setting to 'Infinity' will disable
     },
   };
 };