lib: add configurable timeout for all guru operations

Author: robbawebba

lib/highlight/highlight-provider.js

@@ -42,7 +42,10 @@ class HighlightProvider {
     if (!args) return null
 
     const options = {}
-    options.timeout = 30000
+    const t = atom.config.get('go-plus.guru.timeout')
+    const timeout = typeof t === 'number' ? t : 30000
+    options.timeout = timeout
+
     const archive = buildGuruArchive(editor)
     if (archive && archive.length) {
       options.input = archive

lib/implements/implements.js

@@ -56,7 +56,10 @@ class Implements implements PanelModel {
 
   async runGuru(args: Array<string>) {
     const options = {}
-    options.timeout = 20000
+    const t = atom.config.get('go-plus.guru.timeout')
+    const timeout = typeof t === 'number' ? t : 30000
+    options.timeout = timeout
+
     const archive = buildGuruArchive()
     if (archive && archive.length) {
       options.input = archive

lib/references/references-provider.js

@@ -76,8 +76,12 @@ class ReferencesProvider {
 
     const offset = utf8OffsetForBufferPosition(position, editor)
     const args = computeArgs('referrers', null, editor, offset) || []
+
     const options = {}
-    options.timeout = 30000
+    const t = atom.config.get('go-plus.guru.timeout')
+    const timeout = typeof t === 'number' ? t : 30000
+    options.timeout = timeout
+
     const archive = buildGuruArchive(editor)
     if (archive && archive.length) {
       options.input = archive

package.json

@@ -384,6 +384,13 @@
           "type": "boolean",
           "default": true,
           "order": 1
+        },
+        "timeout": {
+          "title": "Timeout",
+          "description": "Stop Guru commands from runnning after this number of milliseconds",
+          "type": "integer",
+          "default": 30000,
+          "order": 2
         }
       }
     },

spec/implements/implements-spec.js

@@ -72,4 +72,19 @@ describe('implements', () => {
     expect(args1.from[0].name).toBe('implements.Fooer')
     expect(args1.from[1].name).toBe('io.Reader')
   })
+
+  it('times out according to the configured guru timeout', async () => {
+    const testTimeout = 1
+    atom.config.set('go-plus.guru.timeout', testTimeout)
+    editor.setCursorBufferPosition([4, 9])
+    await impl.handleCommand()
+    expect(impl.view.update).toHaveBeenCalled()
+    expect(impl.view.update.calls.length).toBe(2)
+
+    const args0 = impl.view.update.calls[0].args[0]
+    const args1 = impl.view.update.calls[1].args[0]
+    expect(args0.startsWith('running guru')).toBe(true)
+    expect(args1.startsWith('guru failed')).toBe(true)
+    expect(args1.endsWith(testTimeout + ' ms')).toBe(true)
+  })
 })

spec/references/references-provider-spec.js

@@ -4,7 +4,8 @@
 import { lifecycle } from './../spec-helpers'
 import { ReferencesProvider } from './../../lib/references/references-provider'
 import path from 'path'
-import fs from 'fs'
+import fs from 'fs-extra'
+import { it, beforeEach } from '../async-spec-helpers' // eslint-disable-line
 
 describe('References Provider', () => {
   let references
@@ -60,4 +61,41 @@ describe('References Provider', () => {
       )
     })
   })
+
+  describe('findReferences', () => {
+    let editor
+    let gopath = null
+    let source = null
+    let target = null
+
+    beforeEach(async () => {
+      gopath = fs.realpathSync(lifecycle.temp.mkdirSync('gopath-'))
+      process.env.GOPATH = gopath
+
+      await lifecycle.activatePackage()
+      const { mainModule } = lifecycle
+      references = mainModule.provideReferences()
+
+      source = path.join(__dirname, '..', 'fixtures')
+      target = path.join(gopath, 'src', 'references')
+      fs.copySync(source, target)
+      editor = await atom.workspace.open(path.join(target || '.' , 'doc.go'))
+    })
+    afterEach(() => {
+      lifecycle.teardown()
+    })
+
+    it('times out according to the configured Guru timeout', async () => {
+      const testTimeout = 1
+      atom.config.set('go-plus.guru.timeout', testTimeout)
+      editor.setCursorBufferPosition([22, 2])
+      const refs = await references.findReferences(
+        editor,
+        editor.getCursorBufferPosition()
+      )
+      expect(typeof refs).toBe('object')
+      expect(refs.type).toBe('error')
+      expect(refs.message.endsWith(testTimeout + 'ms')).toBe(true)
+    })
+  })
 })