Throw an error if Search is instantiated without the required uidFieldName constructor parameter.

Brian Vaughn · Brian Vaughn · commit 9475ea545555 · 2017-04-24T21:54:53.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.4.1
+Throw an error if `Search` is instantiated without the required `uidFieldName` constructor parameter.
+
 ## 1.4.0
 Search uid field can now be an array (for nested/deep keys).
 
diff --git a/benchmarks/index.html b/benchmarks/index.html
@@ -0,0 +1,28 @@
+<html>
+<head>
+  <script src="../dist/umd/js-search.js"></script>
+  <script>
+    var books;
+
+    fetch('./books.json', {
+      method: 'get'
+    }).then(async response => {
+      var data = await response.json();
+      books = data.books;
+
+      var search = new JsSearch.Search('isbn');
+      search.addIndex('title');
+      search.addIndex('author');
+
+      for (var i = 0; i < 10000; i++) {
+        search.addDocuments(books);
+
+        search.search('the');
+        search.search('an');
+        search.search('of');
+      }
+    });
+  </script>
+</head>
+<body></body>
+</html>
diff --git a/benchmarks/test.js b/benchmarks/test.js
@@ -0,0 +1,53 @@
+const Benchmark = require('benchmark');
+const bb = require('beautify-benchmark');
+
+function doThing({
+  foo,
+  bar,
+  baz,
+  qux
+}) {
+  return foo + bar + baz + qux;
+}
+function doThingAlt(foo, bar, baz, qux) {
+  return foo + bar + baz + qux;
+}
+
+new Benchmark.Suite()
+  .on('cycle', (event) => {
+    bb.add(event.target);
+  })
+  .on('complete', () => {
+    bb.log();
+  })
+  .add('recreate', () => {
+    for (var i = 1000; i--;) {
+      doThing({
+//        foo: Math.random(),
+//        bar: Math.random(),
+//        baz: Math.random(),
+        qux: Math.random()
+      });
+    }
+  })
+  .add('recycle', () => {
+    var doThingParams = {
+      foo: null,
+      bar: null,
+      baz: null,
+      qux: null
+    }
+    for (var i = 1000; i--;) {
+      doThingParams.foo = Math.random()
+      doThingParams.bar = Math.random()
+      doThingParams.baz = Math.random()
+      doThingParams.qux = Math.random()
+      doThing(doThingParams);
+    }
+  })
+  .add('unnamed', () => {
+    for (var i = 1000; i--;) {
+      doThingAlt(Math.random(), Math.random(), Math.random(), Math.random());
+    }
+  })
+  .run({ 'async': true });  
diff --git a/benchmarks/trace.js b/benchmarks/trace.js
@@ -0,0 +1,22 @@
+var { Search, AllSubstringsIndexStrategy, ExactWordIndexStrategy } = require('../dist/umd/js-search');
+
+function identity(text) {
+  return text;
+}
+
+var search = new Search('id');
+search.indexStrategy = new AllSubstringsIndexStrategy();
+search.addIndex('text');
+
+
+for (var i = 0; i < 10000; i++) {
+  search.addDocuments([
+    { id: 1, text: 'foo bar' },
+    { id: 2, text: 'bar baz' },
+    { id: 3, text: 'baz foo' }
+  ]);
+
+  search.search('foo');
+  search.search('bar');
+  search.search('baz');
+}
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "js-search",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "JS Search is an efficient, client-side search library for JavaScript and JSON objects",
   "main": "dist/commonjs/index.js",
   "directories": {
diff --git a/source/Search.js b/source/Search.js
@@ -38,6 +38,10 @@ export class Search {
    *                     to ensure that a search result set does not contain duplicate objects.
    */
   constructor(uidFieldName : string | Array<string>) {
+    if (!uidFieldName) {
+      throw Error('js-search requires a uid field name constructor parameter');
+    }
+
     this._uidFieldName = uidFieldName;
 
     // Set default/recommended strategies
diff --git a/source/Search.test.js b/source/Search.test.js
@@ -44,6 +44,12 @@ describe('Search', function() {
     }
   });
 
+  it('should throw an error if instantiated without the :uidFieldName parameter', function() {
+    expect(function() {
+      new Search();
+    }).toThrow();
+  });
+
   it('should index a new document on all searchable fields', function() {
     search.addIndex('title');
     spyOn(search._indexStrategy, 'expandToken').and.returnValue([]);

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "js-search",`
`3`		`- "version": "1.4.0",`
	`3`	`+ "version": "1.4.1",`
`4`	`4`	`"description": "JS Search is an efficient, client-side search library for JavaScript and JSON objects",`
`5`	`5`	`"main": "dist/commonjs/index.js",`
`6`	`6`	`"directories": {`