Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve search dropdowns #84

Merged
merged 2 commits into from
Sep 29, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/components/SearchTracePage/SearchDropdownInput.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit: Although this is pretty local in scope, name this to rgx or something else.
rx is common used with RxJS

return items.filter(v => rx.test(v.text)).slice(0, maxResults);
}
render() {
const { input: { value, onChange } } = this.props;
Expand All @@ -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
Expand Down
7 changes: 7 additions & 0 deletions src/reducers/services.js
Original file line number Diff line number Diff line change
Expand Up @@ -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: [],
Expand All @@ -35,6 +36,9 @@ function fetchStarted(state) {

function fetchServicesDone(state, { payload }) {
const services = payload.data;
if (Array.isArray(services)) {
services.sort(baseStringComparator);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion, I think we should use lodash as much as we can on util stuff.

It's well tested, easier to read and immutable.

const sortedServices = _.sortBy(services, s => s)
// or if it was an obj { "name": "svc1" }
const sortedServices = _.sortBy(services, 'name')

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@saminzadeh I would generally go with arr.sort() instead of _.sortBy(arr, value => value). You prefer the lodash util in this case?

The sort util function is using string#localCompare(...) with the option sensitivity. It's ignores accents, case, etc.

I don't think lodash gets us anywhere, here, because it takes a transform function instead of a comparator.

Can you elaborate?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than keeping things immutable (redux approach), I think its just about keeping it consistent. Both work, just my 2 cents.

}
return { ...state, services, error: null, loading: false };
}

Expand All @@ -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 };
}
Expand Down
23 changes: 23 additions & 0 deletions src/utils/regexp-escape.js
Original file line number Diff line number Diff line change
@@ -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, '\\$&');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a small comment with the use cases this escapes

}
33 changes: 33 additions & 0 deletions src/utils/regexp-escape.test.js
Original file line number Diff line number Diff line change
@@ -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);
});
});
});
4 changes: 4 additions & 0 deletions src/utils/sort.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down
6 changes: 6 additions & 0 deletions src/utils/sort.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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'];

Expand Down