[OGUI-914] Filter change is now observed, default level setting is moved to within resetCriteria, contextMenu resets to OPS level

Attach Log to LogFilter as an observer and make filter updates drive behaviour instead of manual notifications.

Adjust tests to take into account new default filter state.

Author: isaachilly

InfoLogger/public/log/Log.js

@@ -32,8 +32,8 @@ export default class Log extends Observable {
     this.model = model;
 
     this.filter = new LogFilter(model);
-    this.filter.setCriteria('level', 'max', 1);
     this.filter.bubbleTo(this);
+    this.filter.observe(this.onFilterChange.bind(this));
 
     this.focus = { // show date picker on focus
       timestampSince: false,
@@ -401,23 +401,13 @@ export default class Log extends Observable {
       }
       value = copy.join(' ');
     }
-    if (this.filter.setCriteria(field, operator, value)) {
-      this.notifyFilterChanged();
-    }
-  }
-
-  /**
-   * Reset all filter criteria and notify active mode of the change.
-   */
-  resetFilters() {
-    this.filter.resetCriteria();
-    this.notifyFilterChanged();
+    this.filter.setCriteria(field, operator, value);
   }
 
   /**
    * Notify the active mode (live or query) that filters have changed.
    */
-  notifyFilterChanged() {
+  onFilterChange() {
     if (this.isLiveModeRunning()) {
       this.model.ws.setFilter(this.filter.toStringifyFunction());
       this.model.notification.show(

InfoLogger/public/log/cellContextMenu.js

@@ -125,10 +125,10 @@ export const cellContextMenu = (model) => {
             hideMenu();
           },
         ),
-        createMenuItem(iconTrash(), 'danger', 'Clear Level Filter', () => {
-          model.log.setCriteria('level', 'max', null);
+        createMenuItem(iconTrash(), 'danger', 'Reset Level Filter', () => {
+          model.log.setCriteria('level', 'max', 1);
           hideMenu();
-        }, model.log.filter.criterias.level.max === null),
+        }, model.log.filter.criterias.level.max === 1),
       ];
     }
     return [

InfoLogger/public/logFilter/LogFilter.js

@@ -429,8 +429,8 @@ export default class LogFilter extends Observable {
         $in: ['I', 'W', 'E', 'F'],
       },
       level: {
-        max: null, // 0, 1, 6, 11, 21
-        $max: null, // 0, 1, 6, 11, 21
+        max: 1,
+        $max: 1,
       },
     };
     this.notify();

InfoLogger/public/logFilter/commandFilters.js

@@ -104,6 +104,6 @@ const buttonLogLimit = (model, label, limit) => h('button.btn', {
  * @returns {vnode} - component representing the creation of a button to reset filters
  */
 const buttonReset = (model) => h('button.btn', {
-  onclick: () => model.log.resetFilters(),
+  onclick: () => model.log.filter.resetCriteria(),
   title: 'Reset date, time, matches, excludes, log levels',
 }, 'Reset filters');

InfoLogger/test/public/log-context-menu-mocha.js

@@ -276,7 +276,7 @@ describe('Cell Context Menu', async () => {
       it('should show correct actions for level field', async () => {
         await openContextMenu(page, 'level', '3', 100, 120);
         const labels = await getMenuActionLabels(page);
-        assert.deepStrictEqual(labels, ['Set Level To Support', 'Set Level To Ops', 'Clear Level Filter', 'Copy', 'Open Inspector']);
+        assert.deepStrictEqual(labels, ['Set Level To Support', 'Set Level To Ops', 'Reset Level Filter', 'Copy', 'Open Inspector']);
       });
     });
 
@@ -561,7 +561,7 @@ describe('Cell Context Menu', async () => {
         });
       });
 
-      describe('Set/Clear level filter for level field', async () => {
+      describe('Set/Reset Level Filter for level field', async () => {
         it('should set level to nearest threshold above via include', async () => {
           await openContextMenu(page, 'level', '3', 100, 120);
 
@@ -586,34 +586,38 @@ describe('Cell Context Menu', async () => {
           assert.strictEqual(level.$max, 1);
         });
 
-        it('should disable "Clear Level Filter" when no level filter is set', async () => {
+        it('should disable "Reset Level Filter" when level is already cleared', async () => {
+          await page.evaluate(() => {
+            window.model.log.filter.setCriteria('level', 'max', 1);
+          });
+
           await openContextMenu(page, 'level', '3', 100, 120);
 
-          assert.strictEqual(await isMenuItemDisabled(page, 'Clear Level Filter'), true);
+          assert.strictEqual(await isMenuItemDisabled(page, 'Reset Level Filter'), true);
         });
 
-        it('should enable "Clear Level Filter" when a level filter is active', async () => {
+        it('should enable "Reset Level Filter" when a level filter is active', async () => {
           await page.evaluate(() => {
             window.model.log.filter.setCriteria('level', 'max', 6);
           });
 
           await openContextMenu(page, 'level', '3', 100, 120);
 
-          assert.strictEqual(await isMenuItemDisabled(page, 'Clear Level Filter'), false);
+          assert.strictEqual(await isMenuItemDisabled(page, 'Reset Level Filter'), false);
         });
 
-        it('should clear level filter back to null', async () => {
+        it('should reset level filter back to default', async () => {
           await page.evaluate(() => {
             window.model.log.filter.setCriteria('level', 'max', 6);
           });
 
           await openContextMenu(page, 'level', '3', 100, 120);
 
-          await clickMenuItemByLabel(page, 'Clear Level Filter');
+          await clickMenuItemByLabel(page, 'Reset Level Filter');
 
           const level = await page.evaluate(() => window.model.log.filter.criterias.level);
-          assert.strictEqual(level.max, null);
-          assert.strictEqual(level.$max, null);
+          assert.strictEqual(level.max, 1);
+          assert.strictEqual(level.$max, 1);
         });
       });
 

InfoLogger/test/public/log-filter-actions-mocha.js

@@ -95,7 +95,7 @@ describe('Filter actions test-suite', async () => {
   });
 
   it('should redirect to default filters and show JSON parse error on malformed q in URI', async () => {
-    const expectedDefaultParams = '?q={"severity":{"in":"I W E F"}}';
+    const expectedDefaultParams = '?q={"severity":{"in":"I W E F"},"level":{"max":1}}';
 
     const locationAndNotification = await page.evaluate(() => {
       const params = { q: '{"severity":{"in":"W I E F"' };
@@ -116,8 +116,8 @@ describe('Filter actions test-suite', async () => {
 
   it('should update URI with new encoded "match" criteria', async () => {
     /* eslint-disable max-len */
-    const decodedParams = '?q={"hostname":{"match":"\\"%ald_qdip01%"},"severity":{"in":"I W E F"}}';
-    const expectedParams = '?q={%22hostname%22:{%22match%22:%22%5C%22%25ald_qdip01%25%22},%22severity%22:{%22in%22:%22I%20W%20E%20F%22}}';
+    const decodedParams = '?q={"hostname":{"match":"\\"%ald_qdip01%"},"severity":{"in":"I W E F"},"level":{"max":1}}';
+    const expectedParams = '?q={%22hostname%22:{%22match%22:%22%5C%22%25ald_qdip01%25%22},%22severity%22:{%22in%22:%22I%20W%20E%20F%22},%22level%22:{%22max%22:1}}';
     const searchParams = await page.evaluate(() => {
       window.model.log.filter.setCriteria('hostname', 'match', '"%ald_qdip01%');
       window.model.updateRouteOnModelChange();
@@ -130,8 +130,8 @@ describe('Filter actions test-suite', async () => {
 
   it('should update URI with new encoded "exclude" criteria', async () => {
     /* eslint-disable max-len */
-    const decodedParams = '?q={"hostname":{"exclude":"\\"%ald_qdip01%"},"severity":{"in":"I W E F"}}';
-    const expectedParams = '?q={%22hostname%22:{%22exclude%22:%22%5C%22%25ald_qdip01%25%22},%22severity%22:{%22in%22:%22I%20W%20E%20F%22}}';
+    const decodedParams = '?q={"hostname":{"exclude":"\\"%ald_qdip01%"},"severity":{"in":"I W E F"},"level":{"max":1}}';
+    const expectedParams = '?q={%22hostname%22:{%22exclude%22:%22%5C%22%25ald_qdip01%25%22},%22severity%22:{%22in%22:%22I%20W%20E%20F%22},%22level%22:{%22max%22:1}}';
     const searchParams = await page.evaluate(() => {
       window.model.log.filter.resetCriteria();
       window.model.log.filter.setCriteria('hostname', 'exclude', '"%ald_qdip01%');
@@ -286,20 +286,6 @@ describe('Filter actions test-suite', async () => {
       assert.ok(!severity.in.includes('D'));
     });
 
-    it('should re-enable DEBUG after reset', async () => {
-      const result = await page.evaluate(() => {
-        window.model.log.filter.setCriteria('level', 'max', 1);
-        window.model.log.resetFilters();
-        return {
-          disabled: window.model.log.filter.isSeverityDisabled('D'),
-          level: window.model.log.filter.criterias.level.max,
-        };
-      });
-
-      assert.strictEqual(result.disabled, false);
-      assert.strictEqual(result.level, null);
-    });
-
     it('should disable DEBUG button at OPS level', async () => {
       await page.evaluate(() => {
         window.model.log.filter.setCriteria('level', 'max', 1);