Show prompt to enable "fast mode" on large projects

docs/events.md

@@ -4,7 +4,16 @@ This document specifies all the data (along with the format) which gets sent fro
 
 ## Counters
 
-Currently the Fuzzy finder does not log any counter events.
+| counter name | description |
+|-------|-------|
+| `show-enable-prompt` | Number of times the prompt to enable fast mode is shown |
+| `click-enable-prompt` | Number of clicks on the "enable fast mode" prompt |
+| `confirm-enable-prompt` | Number of confirmations on the "enable fast mode" notification |
+| `cancel-enable-prompt` | Number of cancels on the "enable fast mode" notification |
+| `show-disable-prompt` | Number of times the prompt to disable fast mode is shown |
+| `click-disable-prompt` | Number of clicks on the "disable fast mode" prompt |
+| `confirm-disable-prompt` | Number of confirmations on the "disable fast mode" notification |
+| `cancel-disable-prompt` | Number of cancels on the "disable fast mode" notification |
 
 ## Timing events
 

lib/experiment-prompt.js

@@ -0,0 +1,150 @@
+const etch = require('etch')
+const $ = etch.dom
+const SCORING_SYSTEMS = require('./scoring-systems')
+
+/**
+ * Minimum number of files in the project needed to show the fast mode prompt.
+ */
+const ThresholdForShowingPrompt = 10000
+
+/**
+ * For how long to show the "NEW" badge in the prompt since the first time
+ * it was seen (24h).
+ */
+const TimeToShowNewBadgeInMilliseconds = 24 * 60 * 60 * 1000
+const FirstTimeShownKey = 'fuzzy-finder:prompt-first-time-shown'
+
+function shouldShowPrompt (numItems) {
+  // The nucleus-dark-ui does not display the prompt correctly.
+  if (atom.themes.getActiveThemeNames().includes('nucleus-dark-ui')) {
+    return false
+  }
+
+  return isFastModeEnabled() || numItems > ThresholdForShowingPrompt
+}
+
+function shouldShowBadge () {
+  const firstTimeShown = localStorage.getItem(FirstTimeShownKey)
+  const now = new Date().getTime()
+
+  if (!firstTimeShown) {
+    localStorage.setItem(FirstTimeShownKey, now)
+
+    return true
+  }
+
+  return now - firstTimeShown <= TimeToShowNewBadgeInMilliseconds
+}
+
+function showNotification (message, {description, confirmBtn, cancelBtn, confirmFn, cancelFn}) {
+  const notification = atom.notifications.addInfo(
+    message,
+    {
+      description,
+      dismissable: true,
+      buttons: [
+        {
+          text: confirmBtn,
+          onDidClick: () => {
+            confirmFn && confirmFn()
+            notification.dismiss()
+          },
+          className: 'btn btn-info btn-primary'
+        },
+        {
+          text: cancelBtn,
+          onDidClick: () => {
+            cancelFn && cancelFn()
+            notification.dismiss()
+          }
+        }
+      ],
+      icon: 'rocket'
+    }
+  )
+}
+
+function enableExperimentalFuzzyFinder (metricsReporter) {
+  metricsReporter.incrementCounter('click-enable-prompt')
+
+  showNotification(
+    'Introducing experimental fast mode',
+    {
+      description: "The fuzzy finder has a new experimental _fast mode_. It dramatically speeds up the experience of finding files, especially in large projects. Would you like to try it?\n\n(You can always switch back to the fuzzy finder's _normal mode_ later.)",
+      confirmBtn: 'Enable fast mode',
+      confirmFn: () => {
+        metricsReporter.incrementCounter('confirm-enable-prompt')
+
+        atom.config.set('fuzzy-finder.useRipGrep', true)
+        atom.config.set('fuzzy-finder.scoringSystem', SCORING_SYSTEMS.FAST)
+        atom.notifications.addSuccess('Fasten your seatbelt! Here comes a faster fuzzy finder.', {icon: 'rocket'})
+      },
+      cancelBtn: 'Not right now',
+      cancelFn: () => {
+        metricsReporter.incrementCounter('cancel-enable-prompt')
+      }
+    }
+  )
+}
+
+function disableExperimentalFuzzyFinder (metricsReporter) {
+  metricsReporter.incrementCounter('click-disable-prompt')
+
+  showNotification(
+    'Do you want to disable the new experimental fast mode for the fuzzy finder?',
+    {
+      description: 'If the experimental fast mode is negatively impacting your experience, please leave a comment to [**let us know**](https://github.com/atom/fuzzy-finder/issues/379).\n\n(You can reenable fast mode later from the fuzzy finder.)',
+      confirmBtn: 'Disable experimental fast mode',
+      confirmFn: () => {
+        metricsReporter.incrementCounter('confirm-disable-prompt')
+
+        atom.config.set('fuzzy-finder.useRipGrep', false)
+        atom.config.set('fuzzy-finder.scoringSystem', SCORING_SYSTEMS.ALTERNATE)
+        atom.notifications.addSuccess('OK. Experimental fast mode is disabled.')
+      },
+      cancelBtn: 'No, thanks',
+      cancelFn: () => {
+        metricsReporter.incrementCounter('cancel-disable-prompt')
+      }
+    }
+  )
+}
+
+function isFastModeEnabled () {
+  return (
+    atom.config.get('fuzzy-finder.scoringSystem') === SCORING_SYSTEMS.FAST &&
+    atom.config.get('fuzzy-finder.useRipGrep') === true
+  )
+}
+
+function renderExperimentPrompt (metricsReporter) {
+  if (isFastModeEnabled()) {
+    metricsReporter.incrementCounter('show-disable-prompt')
+
+    return (
+      $.span({className: 'experiment-prompt'}, [
+        $.a({onmousedown: disableExperimentalFuzzyFinder.bind(null, metricsReporter)}, [
+          $.span({className: 'icon icon-rocket'}, ''),
+          $.span({className: ''}, 'Using experimental fast mode. Opt out?')
+        ])
+      ])
+    )
+  }
+
+  metricsReporter.incrementCounter('show-enable-prompt')
+
+  return (
+    $.span({className: 'experiment-prompt'}, [
+      $.a({onmousedown: enableExperimentalFuzzyFinder.bind(null, metricsReporter)}, [
+        shouldShowBadge() ? $.span({className: 'badge badge-info'}, 'NEW') : null,
+        $.span({className: 'icon icon-beaker'}, ''),
+        $.span({className: ''}, 'Try experimental fast mode?')
+      ])
+    ])
+  )
+}
+
+module.exports = {
+  renderExperimentPrompt,
+  shouldShowPrompt
+}

lib/fuzzy-finder-view.js

@@ -1,25 +1,17 @@
 const {Point, CompositeDisposable} = require('atom')
+const {renderExperimentPrompt, shouldShowPrompt} = require('./experiment-prompt')
 const fs = require('fs-plus')
 const fuzzaldrin = require('fuzzaldrin')
 const fuzzaldrinPlus = require('fuzzaldrin-plus')
 const NativeFuzzy = require('@atom/fuzzy-native')
+const SCORING_SYSTEMS = require('./scoring-systems')
 
 const path = require('path')
 const SelectListView = require('atom-select-list')
 
 const {repositoryForPath} = require('./helpers')
 const getIconServices = require('./get-icon-services')
 
-/**
- * These scoring systems should be synchronized with the enum values
- * on the scoringSystem config option defined in package.json
-**/
-const SCORING_SYSTEMS = {
-  STANDARD: 'standard',
-  ALTERNATE: 'alternate',
-  FAST: 'fast'
-}
-
 const MAX_RESULTS = 10
 
 module.exports = class FuzzyFinderView {
@@ -87,6 +79,8 @@ module.exports = class FuzzyFinderView {
             errorMessage: null
           })
         }
+
+        return this.updateExperimentPrompt()
       },
       elementForItem: ({filePath, label, ownerGitHubUsername}) => {
         const filterQuery = this.selectListView.getFilterQuery()
@@ -170,6 +164,8 @@ module.exports = class FuzzyFinderView {
         } else {
           this.selectListView.update({ filter: this.filterFn })
         }
+
+        this.updateExperimentPrompt()
       })
     )
   }
@@ -337,9 +333,36 @@ module.exports = class FuzzyFinderView {
     }
 
     if (this.isQueryALineJump()) {
-      return this.selectListView.update({items: [], loadingMessage: null, loadingBadge: null})
+      this.selectListView.update({
+        items: [],
+        infoMessage: null,
+        loadingMessage: null,
+        loadingBadge: null
+      })
     } else {
-      return this.selectListView.update({items: this.items, loadingMessage: null, loadingBadge: null})
+      this.selectListView.update({
+        items: this.items,
+        infoMessage: null,
+        loadingMessage: null,
+        loadingBadge: null
+      })
+    }
+
+    return this.updateExperimentPrompt()
+  }
+
+  updateExperimentPrompt () {
+    if (
+      this.selectListView.getQuery().length ||
+      !shouldShowPrompt(this.items.length)
+    ) {
+      return this.selectListView.update({
+        infoMessage: null
+      })
+    } else {
+      return this.selectListView.update({
+        infoMessage: renderExperimentPrompt(this.metricsReporter)
+      })
     }
   }
 

lib/project-view.js

@@ -108,14 +108,14 @@ class ProjectView extends FuzzyFinderView {
       }
 
       if (this.paths) {
-        await this.selectListView.update({loadingMessage: 'Reindexing project\u2026'})
+        await this.selectListView.update({loadingMessage: 'Reindexing project\u2026', infoMessage: null})
       } else {
-        await this.selectListView.update({loadingMessage: 'Indexing project\u2026', loadingBadge: '0'})
+        await this.selectListView.update({loadingMessage: 'Indexing project\u2026', infoMessage: null, loadingBadge: '0'})
         if (task) {
           let pathsFound = 0
           task.on('load-paths:paths-found', (paths) => {
             pathsFound += paths.length
-            this.selectListView.update({loadingMessage: 'Indexing project\u2026', loadingBadge: humanize.intComma(pathsFound)})
+            this.selectListView.update({loadingMessage: 'Indexing project\u2026', infoMessage: null, loadingBadge: humanize.intComma(pathsFound)})
           })
         }
       }

lib/reporter-proxy.js

@@ -4,6 +4,7 @@ module.exports = class ReporterProxy {
   constructor () {
     this.reporter = null
     this.timingsQueue = []
+    this.countersQueue = []
 
     this.eventType = 'fuzzy-finder-v1'
 
@@ -13,10 +14,15 @@ module.exports = class ReporterProxy {
   setReporter (reporter) {
     this.reporter = reporter
     let timingsEvent
+    let counterName
 
     while ((timingsEvent = this.timingsQueue.shift())) {
       this.reporter.addTiming(this.eventType, timingsEvent[0], timingsEvent[1])
     }
+
+    while ((counterName = this.countersQueue.shift())) {
+      this.reporter.incrementCounter(counterName)
+    }
   }
 
   unsetReporter () {
@@ -45,6 +51,14 @@ module.exports = class ReporterProxy {
     this._addTimingThrottled(duration, metadata)
   }
 
+  incrementCounter (counterName) {
+    if (this.reporter) {
+      this.reporter.incrementCounter(counterName)
+    } else {
+      this.countersQueue.push(counterName)
+    }
+  }
+
   _addTiming (duration, metadata) {
     if (this.reporter) {
       this.reporter.addTiming(this.eventType, duration, metadata)

lib/scoring-systems.js

@@ -0,0 +1,9 @@
+/**
+ * These scoring systems should be synchronized with the enum values
+ * on the scoringSystem config option defined in package.json
+**/
+module.exports = {
+  STANDARD: 'standard',
+  ALTERNATE: 'alternate',
+  FAST: 'fast'
+}

styles/fuzzy-finder.less

@@ -25,3 +25,12 @@
     right: @component-padding;
   }
 }
+
+.fuzzy-finder .experiment-prompt {
+  display: flex;
+  justify-content: flex-end;
+
+  .badge {
+    margin-right: (@component-padding / 2);
+  }
+}