ui: Async Search (#4859)
This does several things to make improving the search experience easier
moving forwards:
1. Separate searching off from filtering. 'Searching' can be thought of
as specifically 'text searching' whilst filtering is more of a
boolean/flag search.
2. Decouple the actual searching functionality to almost pure,
isolated / unit testable units and unit test. (I still import embers get
which, once I upgrade to 3.5, I shouldn't need)
3. Searching rules are now configurable from the outside, i.e. not
wrapped in Controllers or Components.
4. General searching itself now can use an asynchronous approach based on
events. This prepares for future possibilities of handing off the
searching to a web worker or elsewhere, which should aid in large scale
searching and prepares the way for other searching methods.
5. Adds the possibility of have multiple searches in one
template/route/page.
Additionally, this adds a WithSearching mixin to aid linking the
searching to ember in an ember-like way in a single place. Plus a
WithListeners mixin to aid with cleaning up of event listeners on
Controller/Component destruction.
Post-initial work I slightly changed the API of create listeners:
Returning the handler from a `remover` means you can re-add it again if you
want to, this avoids having to save a reference to the handler elsewhere
to do the same.
The `remove` method itself now returns an array of handlers, again you
might want to use these again or something, and its also more useful
then just returning an empty array.
The more I look at this the more I doubt that you'll ever use `remove`
to remove individual handlers, you may aswell just use the `remover`
returned from add. I've added some comments to reflect this, but they'll
likely be removed once I'm absolutely sure of this.
I also added some comments for WithSearching to explain possible further
work re: moving `searchParams` so it can be `hung` off the
controller object
2018-11-06 09:10:20 +00:00
|
|
|
import Service from '@ember/service';
|
2020-12-18 10:38:15 +00:00
|
|
|
|
|
|
|
|
import ExactSearch from 'consul-ui/utils/search/exact';
|
2020-10-26 09:30:07 +00:00
|
|
|
|
|
|
|
|
import intention from 'consul-ui/search/predicates/intention';
|
2020-11-12 18:45:11 +00:00
|
|
|
import upstreamInstance from 'consul-ui/search/predicates/upstream-instance';
|
2020-12-01 15:45:09 +00:00
|
|
|
import serviceInstance from 'consul-ui/search/predicates/service-instance';
|
2020-12-07 09:14:30 +00:00
|
|
|
import healthCheck from 'consul-ui/search/predicates/health-check';
|
2020-12-01 15:45:09 +00:00
|
|
|
import acl from 'consul-ui/search/predicates/acl';
|
|
|
|
|
import service from 'consul-ui/search/predicates/service';
|
|
|
|
|
import node from 'consul-ui/search/predicates/node';
|
|
|
|
|
import kv from 'consul-ui/search/predicates/kv';
|
|
|
|
|
import token from 'consul-ui/search/predicates/token';
|
|
|
|
|
import role from 'consul-ui/search/predicates/role';
|
|
|
|
|
import policy from 'consul-ui/search/predicates/policy';
|
2021-02-17 18:56:56 +00:00
|
|
|
import authMethod from 'consul-ui/search/predicates/auth-method';
|
2020-12-01 15:45:09 +00:00
|
|
|
import nspace from 'consul-ui/search/predicates/nspace';
|
2022-07-04 10:31:58 +00:00
|
|
|
import peer from 'consul-ui/search/predicates/peer';
|
2020-11-12 18:45:11 +00:00
|
|
|
|
2020-10-26 09:30:07 +00:00
|
|
|
const predicates = {
|
2020-12-18 10:38:15 +00:00
|
|
|
intention: intention,
|
|
|
|
|
service: service,
|
|
|
|
|
['service-instance']: serviceInstance,
|
|
|
|
|
['upstream-instance']: upstreamInstance,
|
|
|
|
|
['health-check']: healthCheck,
|
2021-02-17 18:56:56 +00:00
|
|
|
['auth-method']: authMethod,
|
2020-12-18 10:38:15 +00:00
|
|
|
node: node,
|
|
|
|
|
kv: kv,
|
|
|
|
|
acl: acl,
|
|
|
|
|
token: token,
|
|
|
|
|
role: role,
|
|
|
|
|
policy: policy,
|
|
|
|
|
nspace: nspace,
|
2022-07-04 10:31:58 +00:00
|
|
|
peer: peer,
|
2020-10-26 09:30:07 +00:00
|
|
|
};
|
2020-12-18 10:38:15 +00:00
|
|
|
|
2020-10-26 09:30:07 +00:00
|
|
|
export default class SearchService extends Service {
|
2020-12-18 10:38:15 +00:00
|
|
|
searchables = {
|
|
|
|
|
exact: ExactSearch,
|
|
|
|
|
// regex: RegExpSearch,
|
|
|
|
|
// fuzzy: FuzzySearch,
|
|
|
|
|
};
|
2020-10-26 09:30:07 +00:00
|
|
|
predicate(name) {
|
|
|
|
|
return predicates[name];
|
|
|
|
|
}
|
|
|
|
|
}
|