Merge pull request #125 from doughsay/fix-text-search

Fix exceptions when unknown search results come from server.

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.2.1] - 2017-06-30
+### Fixed
+- Don't blow up when unknown search result types come from the server ([#123](https://github.com/doughsay/room.js-client/issues/123))
+
 ## [2.2.0] - 2017-06-30
 ### Added
 - Right prompt (requires server version >= 4.0.0)
@@ -15,6 +19,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Release tracking via an initial [github release](https://github.com/doughsay/room.js-client/releases/tag/2.1.0) and a tag.
 
-[Unreleased]: https://github.com/doughsay/room.js-client/compare/2.2.0...HEAD
+[Unreleased]: https://github.com/doughsay/room.js-client/compare/2.2.1...HEAD
+[2.2.1]: https://github.com/doughsay/room.js-client/compare/2.2.0...2.2.1
 [2.2.0]: https://github.com/doughsay/room.js-client/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/doughsay/room.js-client/releases/tag/2.1.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "room.js-client",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Room.js client.",
   "scripts": {
     "build": "./bin/build",

src/lib/ko-codemirror.js

@@ -6,7 +6,7 @@ function register () {
   function init (element, valueAccessor, allBindings) {
     const options = allBindings.get('codemirrorOptions') || {}
     options.value = ko.unwrap(valueAccessor())
-    const editor = CodeMirror(element, options) // eslint-disable-line new-cap
+    const editor = CodeMirror(element, options)
 
     editor.on('change', cm => {
       const value = valueAccessor()

src/lib/search-result.js

@@ -0,0 +1,54 @@
+import ko from 'knockout'
+
+export default class SearchResult {
+  constructor (data) {
+    this.data = data
+    this.objectId = data.objectId
+    this.active = ko.observable(false)
+    this.name = ko.computed(this.computeName.bind(this))
+  }
+
+  static newFromResult (result) {
+    if (result.function) {
+      return new FunctionSearchResult(result)
+    } else if (result.verb) {
+      return new VerbSearchResult(result)
+    }
+
+    return null
+  }
+
+  computeName () {
+    throw new Error('Must be subclassed.')
+  }
+
+  openEditor () {
+    throw new Error('Must be subclassed.')
+  }
+}
+
+class FunctionSearchResult extends SearchResult {
+  computeName () {
+    return `${this.objectId}.${this.data.function}`
+  }
+
+  openEditor (socket, tabsViewModel) {
+    const params = { objectId: this.objectId, name: this.data.function }
+    socket.emit('get-function', params, data => {
+      tabsViewModel.newEditFunctionTab(socket, data)
+    })
+  }
+}
+
+class VerbSearchResult extends SearchResult {
+  computeName () {
+    return `${this.objectId}.${this.data.verb}`
+  }
+
+  openEditor (socket, tabsViewModel) {
+    const params = { objectId: this.objectId, name: this.data.verb }
+    socket.emit('get-verb', params, data => {
+      tabsViewModel.newEditVerbTab(socket, data)
+    })
+  }
+}

src/view-models/function-editor-view-model.js

@@ -44,7 +44,6 @@ export default class FunctionEditorViewModel {
     }
 
     if (!this.socket.connected) {
-      // eslint-disable-next-line no-alert
       this.window.alert([
         'The client tab that this editor was opened from has been',
         'closed.  You must keep that open for saving to work.'
@@ -56,7 +55,6 @@ export default class FunctionEditorViewModel {
       if (response === 'saved') {
         this._code(this.code())
       } else {
-        // eslint-disable-next-line no-alert
         this.window.alert(response)
       }
     })
@@ -69,7 +67,6 @@ export default class FunctionEditorViewModel {
     ].join(' ')
 
     return this.dirty()
-      // eslint-disable-next-line no-alert
       ? this.window.confirm(msg)
       : true
   }

src/view-models/search-view-model.js

@@ -1,4 +1,5 @@
 import ko from 'knockout'
+import SearchResult from '../lib/search-result'
 
 function isElementVisibleIn (el, container) {
   const elRect = el.getBoundingClientRect()
@@ -12,60 +13,6 @@ function isElementVisibleIn (el, container) {
   )
 }
 
-class SearchResult {
-  constructor (data) {
-    this.data = data
-    this.objectId = data.objectId
-    this.active = ko.observable(false)
-    this.name = ko.computed(this.computeName.bind(this))
-  }
-
-  static newFromResult (result) {
-    if (result.function) {
-      // eslint-disable-next-line no-use-before-define
-      return new FunctionSearchResult(result)
-    } else if (result.verb) {
-      // eslint-disable-next-line no-use-before-define
-      return new VerbSearchResult(result)
-    }
-    throw new Error('Invalid result type.')
-  }
-
-  computeName () {
-    throw new Error('Must be subclassed.')
-  }
-
-  openEditor () {
-    throw new Error('Must be subclassed.')
-  }
-}
-
-class FunctionSearchResult extends SearchResult {
-  computeName () {
-    return `${this.objectId}.${this.data.function}`
-  }
-
-  openEditor (socket, tabsViewModel) {
-    const params = { objectId: this.objectId, name: this.data.function }
-    socket.emit('get-function', params, data => {
-      tabsViewModel.newEditFunctionTab(socket, data)
-    })
-  }
-}
-
-class VerbSearchResult extends SearchResult {
-  computeName () {
-    return `${this.objectId}.${this.data.verb}`
-  }
-
-  openEditor (socket, tabsViewModel) {
-    const params = { objectId: this.objectId, name: this.data.verb }
-    socket.emit('get-verb', params, data => {
-      tabsViewModel.newEditVerbTab(socket, data)
-    })
-  }
-}
-
 // TODO: socket permissions
 export default class SearchViewModel {
   constructor ({ doc }, parentViewModel, socket) {
@@ -118,7 +65,7 @@ export default class SearchViewModel {
   onSearch (str) {
     this.socket.emit('search', str, results => {
       this.selectedIndex(0)
-      this.results(results.map(result => SearchResult.newFromResult(result)))
+      this.results(results.map(result => SearchResult.newFromResult(result)).filter(r => r))
     })
   }
 

src/view-models/verb-editor-view-model.js

@@ -68,7 +68,6 @@ export default class VerbEditorViewModel {
     }
 
     if (!this.socket.connected) {
-      // eslint-disable-next-line no-alert
       this.window.alert([
         'The client tab that this editor was opened from has been',
         'closed.  You must keep that open for saving to work.'
@@ -84,7 +83,6 @@ export default class VerbEditorViewModel {
         this._iobjarg(this.iobjarg())
         this._code(this.code())
       } else {
-        // eslint-disable-next-line no-alert
         this.window.alert(response)
       }
     })
@@ -97,7 +95,6 @@ export default class VerbEditorViewModel {
     ].join(' ')
 
     return this.dirty()
-      // eslint-disable-next-line no-alert
       ? this.window.confirm(msg)
       : true
   }

test/lib/search-result-test.js

@@ -0,0 +1,23 @@
+import test from 'ava'
+import SearchResult from '../../src/lib/search-result'
+
+test('SearchResult: newFromResult works for function result', t => {
+  const result = { objectId: 'foo', function: 'bar' }
+  const searchResult = SearchResult.newFromResult(result)
+
+  t.truthy(searchResult)
+})
+
+test('SearchResult: newFromResult works for verb result', t => {
+  const result = { objectId: 'foo', verb: 'bar' }
+  const searchResult = SearchResult.newFromResult(result)
+
+  t.truthy(searchResult)
+})
+
+test('SearchResult: newFromResult doesn\'t work for text result', t => {
+  const result = { objectId: 'foo', text: 'bar' }
+  const searchResult = SearchResult.newFromResult(result)
+
+  t.falsy(searchResult)
+})