feat: add filtering log events with type (related to #365) (#368)

* add filtering with type

* use reduce, add converting to array

* make anonymous

Author: KazuCocoa

lib/basedriver/commands/event.js

@@ -1,3 +1,5 @@
+import _ from 'lodash';
+
 const commands = {};
 
 /**
@@ -14,13 +16,25 @@ commands.logCustomEvent = function (vendor, event) {
 /**
  * Get the event log
  *
- * @param {string} type - currently unused but a placeholder for a future
- * feature where filtering of log events is allowed
+ * @param {?string|Array<string>} type - the event type to filter with.
+ * It returns all events if the type is not provided or empty string/array.
  * @returns {object} - the event history log object
  */
-commands.getLogEvents = function (/*type*/) {
-  // type is currently unused but may be implemented for filtering later on
-  return this._eventHistory;
+commands.getLogEvents = function (type = null) {
+  if (_.isEmpty(type)) {
+    return this._eventHistory;
+  }
+
+  if (!_.isArray(type)) {
+    type = [type];
+  }
+
+  return _.reduce(this._eventHistory, (acc, eventTimes, eventType) => {
+    if (type.includes(eventType)) {
+      acc[eventType] = eventTimes;
+    }
+    return acc;
+  }, {});
 };
 
 export default commands;

test/basedriver/commands/event-specs.js

@@ -22,3 +22,56 @@ describe('logging custom events', function () {
     _.keys(events).should.eql(['commands', 'appiumEvent', 'myorg:myevent']);
   });
 });
+
+describe('#getLogEvents', function () {
+  it('should allow to get all events', async function () {
+    const d = new BaseDriver();
+    d._eventHistory.should.eql({commands: []});
+    d._eventHistory.testCommand = ['1', '2', '3'];
+    await d.getLogEvents().should.eql({
+      commands: [], testCommand: ['1', '2', '3']
+    });
+  });
+
+  it('should filter with testCommand', async function () {
+    const d = new BaseDriver();
+    d._eventHistory.should.eql({commands: []});
+    d._eventHistory.testCommand = ['1', '2', '3'];
+    await d.getLogEvents('testCommand').should.eql({
+      testCommand: ['1', '2', '3']
+    });
+  });
+
+  it('should not filter with wrong but can be a part of the event name', async function () {
+    const d = new BaseDriver();
+    d._eventHistory.should.eql({commands: []});
+    d._eventHistory.testCommand = ['1', '2', '3'];
+    await d.getLogEvents('testCommandDummy').should.eql({});
+  });
+
+  it('should filter with multiple event keys', async function () {
+    const d = new BaseDriver();
+    d._eventHistory.should.eql({commands: []});
+    d._eventHistory.testCommand = ['1', '2', '3'];
+    d._eventHistory.testCommand2 = ['4', '5'];
+    await d.getLogEvents(['testCommand', 'testCommand2']).should.eql({
+      testCommand: ['1', '2', '3'], testCommand2: ['4', '5']
+    });
+  });
+
+  it('should filter with custom events', async function () {
+    const d = new BaseDriver();
+    d._eventHistory.should.eql({commands: []});
+    d._eventHistory['custom:appiumEvent'] = ['1', '2', '3'];
+    await d.getLogEvents(['custom:appiumEvent']).should.eql({
+      'custom:appiumEvent': ['1', '2', '3']
+    });
+  });
+
+  it('should not filter with no existed event name', async function () {
+    const d = new BaseDriver();
+    d._eventHistory.should.eql({commands: []});
+    d._eventHistory.testCommand = ['1', '2', '3'];
+    await d.getLogEvents(['noEventName']).should.eql({});
+  });
+});