SendIfDue + tests

x-pack/plugins/security_solution/server/lib/telemetry/sender.test.ts

@@ -5,10 +5,11 @@
  */
 
 import { TelemetryEventsSender } from './sender.ts';
+import { loggingSystemMock } from 'src/core/server/mocks';
 
 describe('TelemetryEventsSender', () => {
   describe('processEvents', () => {
-    it('returns empty array when empty array is passed', async () => {
+    it('returns empty array when empty array is passed', () => {
       const sender = new TelemetryEventsSender();
       const result = sender.processEvents([]);
       expect(result).toStrictEqual([]);
@@ -71,4 +72,40 @@ describe('TelemetryEventsSender', () => {
       ]);
     });
   });
+
+  describe('queueTelemetryEvents', () => {
+    it('queues two events', () => {
+      const sender = new TelemetryEventsSender();
+      sender.queueTelemetryEvents([{ 'event.kind': '1' }, { 'event.kind': '2' }]);
+      expect(sender.queue.length).toBe(2);
+    });
+
+    it('queues more than maxQueueSize events', () => {
+      const sender = new TelemetryEventsSender();
+      sender.maxQueueSize = 5;
+      sender.queueTelemetryEvents([{ 'event.kind': '1' }, { 'event.kind': '2' }]);
+      sender.queueTelemetryEvents([{ 'event.kind': '3' }, { 'event.kind': '4' }]);
+      sender.queueTelemetryEvents([{ 'event.kind': '5' }, { 'event.kind': '6' }]);
+      sender.queueTelemetryEvents([{ 'event.kind': '7' }, { 'event.kind': '8' }]);
+      expect(sender.queue.length).toBe(5);
+    });
+
+    it('empties the queue when sending', async () => {
+      const sender = new TelemetryEventsSender();
+      sender.logger = loggingSystemMock.create().get();
+      sender.sendEvents = jest.fn();
+
+      sender.queueTelemetryEvents([{ 'event.kind': '1' }, { 'event.kind': '2' }]);
+      expect(sender.queue.length).toBe(2);
+      await sender.sendIfDue();
+      expect(sender.queue.length).toBe(0);
+      expect(sender.sendEvents).toBeCalledTimes(1);
+      sender.queueTelemetryEvents([{ 'event.kind': '3' }, { 'event.kind': '4' }]);
+      sender.queueTelemetryEvents([{ 'event.kind': '5' }, { 'event.kind': '6' }]);
+      expect(sender.queue.length).toBe(4);
+      await sender.sendIfDue();
+      expect(sender.queue.length).toBe(0);
+      expect(sender.sendEvents).toBeCalledTimes(2);
+    });
+  });
 });

x-pack/plugins/security_solution/server/lib/telemetry/sender.ts

@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { pick } from 'lodash';
+import { pick, cloneDeep } from 'lodash';
 
 import { PluginInitializerContext, Logger } from '../../../../../../core/server';
 
@@ -50,34 +50,20 @@ export class TelemetryEventsSender {
     }
   }
 
-  private async sendIfDue() {
-    if (this.isSending) {
-      return;
-    }
-
-    try {
-      this.isSending = true;
-      this.logger.debug(`Sending...`);
-    } catch (err) {
-      this.logger.warn(`Error sending telemetry events data: ${err}`);
-    }
-    this.isSending = false;
-  }
-
   public queueTelemetryEvents(events: object[]) {
     const qlength = this.queue.length;
 
-    if (qlength > this.maxQueueSize) {
+    if (qlength >= this.maxQueueSize) {
       // we're full already
       return;
     }
 
     // TODO check that telemetry is opted-in
 
     if (events.length > this.maxQueueSize - qlength) {
-      this.queue.push(this.processEvents(events.slice(0, this.maxQueueSize - qlength)));
+      this.queue.push(...this.processEvents(events.slice(0, this.maxQueueSize - qlength)));
     } else {
-      this.queue.push(this.processEvents(events));
+      this.queue.push(...this.processEvents(events));
     }
   }
 
@@ -100,4 +86,24 @@ export class TelemetryEventsSender {
       return newObj;
     });
   }
+
+  private async sendIfDue() {
+    if (this.isSending) {
+      return;
+    }
+
+    try {
+      this.isSending = true;
+      const toSend: object[] = cloneDeep(this.queue);
+      this.queue = [];
+      this.sendEvents(toSend);
+    } catch (err) {
+      this.logger.warn(`Error sending telemetry events data: ${err}`);
+    }
+    this.isSending = false;
+  }
+
+  private async sendEvents(events: object[]) {
+    // TODO
+  }
 }