[Data] Query Input String manager #72093

lizozom · 2020-07-16T16:03:58Z

Summary

Allow gracefully extracting the query string state, to be consumed by other services. One can now use the data.query.state$ observable and receive all state updates in one place.
Add the data.query.queryString service, allowing to set the query string programmatically.
Use the data.query.queryString.getDefaultQuery() anywhere that previously constructed the default query from scratch.

Dev Docs

This PR allows gracefully extracting the query string state, to be consumed by other services.
One can now use the data.query.state$ observable and receive all state updates in one place.

data.query.state$.subscribe((queryState: QueryState) => {...})

This PR also adds the data.query.queryString service, allowing to set the query string programmatically.

data.query.queryString.setQuery({query: 'abc', language: 'kuery'});

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

…ut-manager

Dosant · 2020-07-20T10:29:50Z

ACK will play with it

…ut-manager

elasticmachine · 2020-07-22T07:14:12Z

Pinging @elastic/kibana-app-arch (Team:AppArch)

flash1293 · 2020-07-22T07:23:05Z

@lizozom Can you expand a little on the context of this PR and why things are changed?

…nto data/queryinput-manager

lizozom · 2020-07-23T17:13:57Z

@elasticmachine merge upstream

…nto data/queryinput-manager

…ut-manager

lizozom · 2020-07-27T11:03:36Z

x-pack/plugins/maps/public/routing/routes/maps_app/maps_app_view.js

@@ -292,6 +291,8 @@ export class MapsAppView extends React.Component {
        globalState,
      }),
    };
+
+    if (newState.query) queryString.setQuery(newState.query);


@nreese I had to add this line, setting the query to the manager in order to stabilize functional tests.
Is this addition correct and in the proper location in your opinion?

This component needs some refactoring. This is a good place to put this until that refactoring occurs.

…ut-manager

kibanamachine · 2020-07-28T12:31:25Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 5c12dc2

Build metrics

async chunks size

id	value	diff	baseline
discover	430.9KB	-280.0B	431.2KB
indexPatternManagement	697.5KB	-45.0B	697.6KB
lens	24.7KB	-204.0B	24.9KB
maps	3.8MB	-150.0B	3.8MB
visualize	676.9KB	-372.0B	677.3KB
total	-	-1.0KB	-

page load bundle size

id	value	diff	baseline
charts	873.6KB	-40.0B	873.7KB
dashboard	679.3KB	-334.0B	679.6KB
data	1.4MB	+3.2KB	1.4MB
regionMap	832.2KB	-40.0B	832.3KB
tileMap	843.8KB	-40.0B	843.9KB
visTypeMarkdown	552.8KB	-40.0B	552.8KB
visTypeMetric	575.8KB	-40.0B	575.9KB
visTypeTable	604.6KB	-40.0B	604.6KB
visTypeTagcloud	837.1KB	-40.0B	837.1KB
visTypeTimelion	712.5KB	-40.0B	712.6KB
visTypeVega	660.6KB	-40.0B	660.6KB
visTypeVislib	1.3MB	-40.0B	1.3MB
total	-	+2.5KB	-

History

💚 Build #64288 succeeded e13545b
💔 Build #64277 failed 08246fa
💔 Build #64213 failed 5f04c15
💔 Build #64041 failed 723b8fc
💔 Build #63994 failed 3dc3bee

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Dosant

I tested dashboard, discover and state management demo plugin in chrome and safari and didn't find regressions.

Probably also worth requesting re-review from @elastic/kibana-app, since there were significant changes

Dosant · 2020-07-28T13:07:36Z

src/plugins/data/public/ui/search_bar/lib/use_query_string_manager.ts

+
+export const useQueryStringManager = (props: UseQueryStringProps) => {
+  // Filters should be either what's passed in the initial state or the current state of the filter manager
+  const [query, setQuery] = useState<Query>(props.query || props.queryStringManager.getQuery());


As I understood props.query are only used on initial rendering for initial state? If this is the case, let's rename it into props.initialQuery for clarity?

I'd want any change to all attributes (query, filters, time, etc)
So lets take this separately :)

ThomThomson

Tested in chrome & firefox, lots of changes, but no regressions I could find. Also looked into the new data.query.state$, and programatically setting the query string which both work great!

* improve test stability * query string input manager (needed for search demo) * docs * dashboard * Fix jest * mock fix * Allow restoring a saved query * sync url * Luke's fix to test * cleanup * lens jest tests * docs * use queryStringManager.getDefaultQuery Don't sync query to global state * Update app.test.tsx lens mock * jest fix * jest * use new api in the example * Rename state param to query to match url state * Apply changes to discover * Update src/plugins/data/public/query/query_string/index.ts Co-authored-by: Anton Dosov <[email protected]> * Improve query string state manager * Cleanup dashboard code * Handle refresh button * Set initial dashboard state * visualize state * remove unused * docs * fix example * fix jest * fix filter app state in discover * fix maps test * jest Co-authored-by: Anton Dosov <[email protected]> Co-authored-by: Anton Dosov <[email protected]> Co-authored-by: Elastic Machine <[email protected]> # Conflicts: # src/plugins/data/public/public.api.md

* [Data] Query Input String manager (#72093) * improve test stability * query string input manager (needed for search demo) * docs * dashboard * Fix jest * mock fix * Allow restoring a saved query * sync url * Luke's fix to test * cleanup * lens jest tests * docs * use queryStringManager.getDefaultQuery Don't sync query to global state * Update app.test.tsx lens mock * jest fix * jest * use new api in the example * Rename state param to query to match url state * Apply changes to discover * Update src/plugins/data/public/query/query_string/index.ts Co-authored-by: Anton Dosov <[email protected]> * Improve query string state manager * Cleanup dashboard code * Handle refresh button * Set initial dashboard state * visualize state * remove unused * docs * fix example * fix jest * fix filter app state in discover * fix maps test * jest Co-authored-by: Anton Dosov <[email protected]> Co-authored-by: Anton Dosov <[email protected]> Co-authored-by: Elastic Machine <[email protected]> # Conflicts: # src/plugins/data/public/public.api.md * docs

* master: (126 commits) [ML] Disabling ML if license feature is disabled (elastic#73187) [ML] Fixing old _xpack style es endpoint paths (elastic#73667) [DOCS] [Lens] 7.9 docs refresh (elastic#72301) [ML] DF Analytics results: ensure `View` link is only enabled when job has successfully completed (elastic#73539) Set timeRange to default to trigger the error message (elastic#73629) [ML] Functional tests - stabilize DFA navigation and index pattern handling (elastic#73660) [ILM] Add links to "Snapshot and Restore" from ILM "wait for snapshot policy" (elastic#72473) [kbn-storybook] Update Storybook to 5.3.19 (elastic#73320) [Metrics UI] Fix hasData call to ensure it has data not just indices (elastic#72969) [Uptime] Use `service.name` to link from Uptime -> APM where available (elastic#73618) allow others to update `URL.revokeObjectURL` property if needed (elastic#73639) regen docs (elastic#73650) [Visualize] Fix inspector download filename issue when saving in-place (elastic#72605) [Data] Query Input String manager (elastic#72093) [Security Solutions] Add tooltips (elastic#73436) Do not render descriptionless actions within an EuiCard (elastic#73611) [Security Solution][Detections] Value Lists Modal supports multiple exports (elastic#73532) [Security Solution][Resolver] Handle disabled process collection (elastic#73592) [Security_Solution][Bug] Fix user name/domain to ECS structure (elastic#73530) [Security Solution][Exceptions] - Update rule.exceptions_list to include exception list list_id (elastic#73349) ...

…ibana into actions/webhook-remove-header * 'actions/webhook-remove-header' of github.com:gmmorris/kibana: (86 commits) [maps] rename GisMap to MapContainer and convert to TS (elastic#73690) [APM] docs: remove watcher documentation (elastic#73485) [Maps] fix fit to data for Point to Point layer (elastic#73563) [Metrics UI] Fix No Data in Inventory alerts/Snapshot API (elastic#72513) [ML] Disabling ML if license feature is disabled (elastic#73187) [ML] Fixing old _xpack style es endpoint paths (elastic#73667) [DOCS] [Lens] 7.9 docs refresh (elastic#72301) [ML] DF Analytics results: ensure `View` link is only enabled when job has successfully completed (elastic#73539) Set timeRange to default to trigger the error message (elastic#73629) [ML] Functional tests - stabilize DFA navigation and index pattern handling (elastic#73660) [ILM] Add links to "Snapshot and Restore" from ILM "wait for snapshot policy" (elastic#72473) [kbn-storybook] Update Storybook to 5.3.19 (elastic#73320) [Metrics UI] Fix hasData call to ensure it has data not just indices (elastic#72969) [Uptime] Use `service.name` to link from Uptime -> APM where available (elastic#73618) allow others to update `URL.revokeObjectURL` property if needed (elastic#73639) regen docs (elastic#73650) [Visualize] Fix inspector download filename issue when saving in-place (elastic#72605) [Data] Query Input String manager (elastic#72093) [Security Solutions] Add tooltips (elastic#73436) Do not render descriptionless actions within an EuiCard (elastic#73611) ...

Liza K added 7 commits July 9, 2020 17:13

improve test stability

6f46c7a

Merge branch 'master' of github.com:elastic/kibana

b824176

Merge branch 'master' of github.com:elastic/kibana

995da7d

Merge branch 'master' of github.com:elastic/kibana

7b2a45c

Merge branch 'master' of github.com:elastic/kibana

c3a3822

query string input manager (needed for search demo)

a558b34

docs

2aed579

lizozom added Feature:Query Bar Querying and query bar features v8.0.0 Team:AppArch v7.10.0 labels Jul 16, 2020

lizozom self-assigned this Jul 16, 2020

lizozom requested a review from Dosant July 16, 2020 16:06

lizozom mentioned this pull request Jul 16, 2020

[Search] Server strategy example #71679

Merged

7 tasks

Liza K added 6 commits July 19, 2020 11:35

Merge branch 'master' of github.com:elastic/kibana into data/queryinp…

4e3b824

…ut-manager

dashboard

f2ecb4b

Fix jest

dfdf2eb

mock fix

903b89b

Allow restoring a saved query

90f94b6

Merge branch 'master' of github.com:elastic/kibana into data/queryinp…

60e8758

…ut-manager

Liza K added 3 commits July 20, 2020 18:27

sync url

bfe2723

Merge branch 'master' of github.com:elastic/kibana into data/queryinp…

dd1413a

…ut-manager

Luke's fix to test

dac36cb

lizozom marked this pull request as ready for review July 22, 2020 07:14

lizozom requested a review from a team July 22, 2020 07:14

lizozom requested a review from a team as a code owner July 22, 2020 07:14

cleanup

1d93750

Liza K added 3 commits July 23, 2020 18:10

Cleanup dashboard code

41cc06b

Merge branch 'data/queryinput-manager' of github.com:lizozom/kibana i…

783ea70

…nto data/queryinput-manager

Handle refresh button

07721a6

elasticmachine and others added 13 commits July 23, 2020 11:14

Merge branch 'master' into data/queryinput-manager

acd4708

Merge branch 'data/queryinput-manager' of github.com:lizozom/kibana i…

3dc3bee

…nto data/queryinput-manager

Set initial dashboard state

9256ae7

visualize state

71d0541

remove unused

8b29596

docs

723b8fc

fix example

b0dc470

Merge branch 'master' of github.com:elastic/kibana into data/queryinp…

5f04c15

…ut-manager

fix jest

ae8d844

fix filter app state in discover

08246fa

Merge branch 'master' of github.com:elastic/kibana into data/queryinp…

921c5a5

…ut-manager

fix maps test

7b9211f

jest

e13545b

lizozom commented Jul 27, 2020

View reviewed changes

lizozom requested a review from Dosant July 27, 2020 13:29

Merge branch 'master' of github.com:elastic/kibana into data/queryinp…

5c12dc2

…ut-manager

Dosant approved these changes Jul 28, 2020

View reviewed changes

ThomThomson approved these changes Jul 28, 2020

View reviewed changes

lizozom merged commit 1414415 into elastic:master Jul 29, 2020

lizozom mentioned this pull request Jul 29, 2020

[7.x] [Data] Query Input String manager (#72093) #73634

Merged

sulemanof mentioned this pull request Dec 2, 2020

Browser back/forward does not update filtered data #84711

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Data] Query Input String manager #72093

[Data] Query Input String manager #72093

lizozom commented Jul 16, 2020 •

edited

Loading

Dosant commented Jul 20, 2020

elasticmachine commented Jul 22, 2020

flash1293 commented Jul 22, 2020

lizozom commented Jul 23, 2020

lizozom Jul 27, 2020

nreese Jul 27, 2020

kibanamachine commented Jul 28, 2020

Dosant left a comment

Dosant Jul 28, 2020

lizozom Jul 28, 2020

ThomThomson left a comment

[Data] Query Input String manager #72093

[Data] Query Input String manager #72093

Conversation

lizozom commented Jul 16, 2020 • edited Loading

Summary

Dev Docs

Checklist

For maintainers

Dosant commented Jul 20, 2020

elasticmachine commented Jul 22, 2020

flash1293 commented Jul 22, 2020

lizozom commented Jul 23, 2020

lizozom Jul 27, 2020

Choose a reason for hiding this comment

nreese Jul 27, 2020

Choose a reason for hiding this comment

kibanamachine commented Jul 28, 2020

💚 Build Succeeded

Build metrics

async chunks size

page load bundle size

History

Dosant left a comment

Choose a reason for hiding this comment

Dosant Jul 28, 2020

Choose a reason for hiding this comment

lizozom Jul 28, 2020

Choose a reason for hiding this comment

ThomThomson left a comment

Choose a reason for hiding this comment

lizozom commented Jul 16, 2020 •

edited

Loading