Improve search dropdowns

- Sort services and operations operations (case insensitive)
- Filter options based on contains instead of starts with

Author: tiffon

src/components/SearchTracePage/SearchDropdownInput.js

@@ -22,6 +22,8 @@ import PropTypes from 'prop-types';
 import React, { Component } from 'react';
 import { Dropdown } from 'semantic-ui-react';
 
+import regexpEscape from '../../utils/regexp-escape';
+
 /**
  * We have to wrap the semantic ui component becuase it doesn't perform well
  * when there are 200+ suggestions.
@@ -33,21 +35,22 @@ export default class SearchDropdownInput extends Component {
   constructor(props) {
     super(props);
     this.state = {
-      items: props.items,
       currentItems: props.items.slice(0, props.maxResults),
     };
+    this.onSearch = this.onSearch.bind(this);
   }
   componentWillReceiveProps(nextProps) {
     if (this.props.items.map(i => i.text).join(',') !== nextProps.items.map(i => i.text).join(',')) {
       this.setState({
-        items: nextProps.items,
         currentItems: nextProps.items.slice(0, nextProps.maxResults),
       });
     }
   }
-  onSearch(items, v) {
-    const { maxResults } = this.props;
-    return this.state.items.filter(i => i.text.startsWith(v)).slice(0, maxResults);
+  onSearch(_, searchText) {
+    const { items, maxResults } = this.props;
+    const rxStr = regexpEscape(searchText);
+    const rx = new RegExp(rxStr, 'i');
+    return items.filter(v => rx.test(v.text)).slice(0, maxResults);
   }
   render() {
     const { input: { value, onChange } } = this.props;
@@ -56,7 +59,7 @@ export default class SearchDropdownInput extends Component {
       <Dropdown
         value={value}
         text={value}
-        search={(items, v) => this.onSearch(items, v)}
+        search={this.onSearch}
         onChange={(e, { value: newValue }) => onChange(newValue)}
         options={currentItems}
         selection

src/reducers/services.js

@@ -21,6 +21,7 @@
 import { handleActions } from 'redux-actions';
 
 import { fetchServices, fetchServiceOperations as fetchOps } from '../actions/jaeger-api';
+import { baseStringComparator } from '../utils/sort';
 
 const initialState = {
   services: [],
@@ -35,6 +36,9 @@ function fetchStarted(state) {
 
 function fetchServicesDone(state, { payload }) {
   const services = payload.data;
+  if (Array.isArray(services)) {
+    services.sort(baseStringComparator);
+  }
   return { ...state, services, error: null, loading: false };
 }
 
@@ -49,6 +53,9 @@ function fetchOpsStarted(state, { meta: { serviceName } }) {
 
 function fetchOpsDone(state, { meta, payload }) {
   const { data: operations } = payload;
+  if (Array.isArray(operations)) {
+    operations.sort(baseStringComparator);
+  }
   const operationsForService = { ...state.operationsForService, [meta.serviceName]: operations };
   return { ...state, operationsForService };
 }

src/utils/regexp-escape.js

@@ -0,0 +1,23 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+export default function regexpEscape(s) {
+  return s.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&');
+}

src/utils/regexp-escape.test.js

@@ -0,0 +1,33 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+import regexpEscape from './regexp-escape';
+
+describe('regexp-escape', () => {
+  const chars = '-/\\^$*+?.()|[]{}'.split('');
+  chars.forEach(c => {
+    it(`escapes "${c}" correctly`, () => {
+      const result = regexpEscape(c);
+      expect(result.length).toBe(2);
+      expect(result[0]).toBe('\\');
+      expect(result[1]).toBe(c);
+    });
+  });
+});

src/utils/sort.js

@@ -18,6 +18,10 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
+export function baseStringComparator(itemA, itemB) {
+  return itemA.localeCompare(itemB, 'en', { sensitivity: 'base' });
+}
+
 export function stringSortComparator(itemA, itemB) {
   return itemA.localeCompare(itemB);
 }

src/utils/sort.test.js

@@ -22,6 +22,12 @@ import sinon from 'sinon';
 
 import * as sortUtils from './sort';
 
+it('baseStringComparator() provides a case-insensitive sort', () => {
+  const arr = ['Z', 'ab', 'AC'];
+  expect(arr.slice().sort()).toEqual(['AC', 'Z', 'ab']);
+  expect(arr.slice().sort(sortUtils.baseStringComparator)).toEqual(['ab', 'AC', 'Z']);
+});
+
 it('stringSortComparator() should properly sort a list of strings', () => {
   const arr = ['allen', 'Gustav', 'paul', 'Tim', 'abernathy', 'tucker', 'Steve', 'mike', 'John', 'Paul'];