Merge pull request #1078 from atom/add-metrics

Add metrics logging for time to search in project

Author: rafeca

docs/events.md

@@ -0,0 +1,23 @@
+# Events specification
+
+This document specifies all the data (along with the format) which gets sent from the Find and Replace package to the GitHub analytics pipeline. This document follows the same format and nomenclature as the [Atom Core Events spec](https://github.com/atom/metrics/blob/master/docs/events.md).
+
+## Counters
+
+Currently Find and Replace does not log any counter events.
+
+## Timing events
+
+#### Time to search on a project
+
+* **eventType**: `find-and-replace-v1`
+* **metadata**
+
+  | field | value |
+  |-------|-------|
+  | `ec` | `time-to-search`
+  | `ev` | Number of found results
+
+## Standard events
+
+Currently Find and Replace does not log any standard events.

lib/find.coffee

@@ -9,6 +9,9 @@ FindView = require './find-view'
 ProjectFindView = require './project-find-view'
 ResultsModel = require './project/results-model'
 ResultsPaneView = require './project/results-pane'
+ReporterProxy = require './reporter-proxy'
+
+metricsReporter = new ReporterProxy()
 
 module.exports =
   activate: ({findOptions, findHistory, replaceHistory, pathsHistory}={}) ->
@@ -28,7 +31,7 @@ module.exports =
 
     @findOptions = new FindOptions(findOptions)
     @findModel = new BufferSearch(@findOptions)
-    @resultsModel = new ResultsModel(@findOptions)
+    @resultsModel = new ResultsModel(@findOptions, metricsReporter)
 
     @subscriptions.add atom.workspace.getCenter().observeActivePaneItem (paneItem) =>
       @subscriptions.delete @currentItemSub
@@ -132,6 +135,11 @@ module.exports =
       'find-and-replace:select-skip': (event) ->
         selectNextObjectForEditorElement(this).skipCurrentSelection()
 
+  consumeMetricsReporter: (service) ->
+    metricsReporter.setReporter(service)
+    new Disposable ->
+      metricsReporter.unsetReporter()
+
   consumeElementIcons: (service) ->
     getIconServices().setElementIcons service
     new Disposable ->

lib/project/results-model.js

@@ -27,7 +27,8 @@ class Result {
 }
 
 module.exports = class ResultsModel {
-  constructor (findOptions) {
+  constructor (findOptions, metricsReporter) {
+    this.metricsReporter = metricsReporter
     this.onContentsModified = this.onContentsModified.bind(this)
     this.findOptions = findOptions
     this.emitter = new Emitter()
@@ -172,6 +173,9 @@ module.exports = class ResultsModel {
 
     const leadingContextLineCount = atom.config.get('find-and-replace.searchContextLineCountBefore')
     const trailingContextLineCount = atom.config.get('find-and-replace.searchContextLineCountAfter')
+
+    const startTime = Date.now()
+
     this.inProgressSearchPromise = atom.workspace.scan(
       this.regex,
       {
@@ -195,8 +199,11 @@ module.exports = class ResultsModel {
       if (message === 'cancelled') {
         this.emitter.emit('did-cancel-searching')
       } else {
+        const resultsSummary = this.getResultsSummary()
+
+        this.metricsReporter.sendSearchEvent(Date.now() - startTime, resultsSummary.matchCount)
         this.inProgressSearchPromise = null
-        this.emitter.emit('did-finish-searching', this.getResultsSummary())
+        this.emitter.emit('did-finish-searching', resultsSummary)
       }
     })
   }

lib/reporter-proxy.js

@@ -0,0 +1,38 @@
+module.exports = class ReporterProxy {
+  constructor () {
+    this.reporter = null
+    this.timingsQueue = []
+
+     this.eventType = 'find-and-replace-v1'
+  }
+
+   setReporter (reporter) {
+    this.reporter = reporter
+    let timingsEvent
+
+     while ((timingsEvent = this.timingsQueue.shift())) {
+      this.reporter.addTiming(this.eventType, timingsEvent.duration, timingsEvent.metadata)
+    }
+  }
+
+   unsetReporter () {
+    delete this.reporter
+  }
+
+   sendSearchEvent (duration, numResults) {
+    const metadata = {
+      ec: 'time-to-search',
+      ev: numResults
+    }
+
+     this._addTiming(duration, metadata)
+  }
+
+   _addTiming (duration, metadata) {
+    if (this.reporter) {
+      this.reporter.addTiming(this.eventType, duration, metadata)
+    } else {
+      this.timingsQueue.push({duration, metadata})
+    }
+  }
+}

package.json

@@ -57,6 +57,11 @@
       "versions": {
         "1.0.0": "consumeElementIcons"
       }
+    },
+    "metrics-reporter": {
+      "versions": {
+        "^1.1.0": "consumeMetricsReporter"
+      }
     }
   },
   "providedServices": {

spec/results-model-spec.js

@@ -6,7 +6,7 @@ const FindOptions = require("../lib/find-options");
 const {beforeEach, it, fit, ffit, fffit} = require('./async-spec-helpers')
 
 describe("ResultsModel", () => {
-  let editor, resultsModel;
+  let editor, resultsModel, reporterSpy;
 
   beforeEach(async () => {
     atom.config.set("core.excludeVcsIgnoredPaths", false);
@@ -15,7 +15,10 @@ describe("ResultsModel", () => {
     atom.project.setPaths([path.join(__dirname, "fixtures/project")]);
 
     editor = await atom.workspace.open("sample.js");
-    resultsModel = new ResultsModel(new FindOptions());
+    reporterSpy = {
+      sendSearchEvent: jasmine.createSpy()
+    }
+    resultsModel = new ResultsModel(new FindOptions(), reporterSpy);
   });
 
   describe("searching for a pattern", () => {
@@ -128,4 +131,17 @@ describe("ResultsModel", () => {
       expect(resultsModel.getMatchCount()).toBe(5);
     });
   });
+
+  describe("logging metrics", () => {
+    it("logs the elapsed time and the number of results", async () => {
+      await resultsModel.search('items', '*.js', '');
+
+      advanceClock(editor.buffer.stoppedChangingDelay)
+      editor.getBuffer().destroy()
+      result = resultsModel.getResult(editor.getPath())
+
+      expect(Number.isInteger(reporterSpy.sendSearchEvent.calls[0].args[0])).toBeTruthy()
+      expect(reporterSpy.sendSearchEvent.calls[0].args[1]).toBe(6)
+    });
+  });
 });