[discover] query editor and language selector state fixes by kavilla · Pull Request #8712 · opensearch-project/OpenSearch-Dashboards

kavilla · 2024-10-26T23:30:59Z

Description

Makes the query editor a React functional component which helps with state
Update language selector to not rely on a props.query to force re-render relying on observers
Update dataset selector to update the language and dataset instead of just updating the dataset and then the dataset eventually triggering the now removed props.query for the language selector to update intime.
update recent dataset on query update

Issues Resolved

n/a

Screenshot

Testing the changes

Changelog

refactor: [discover] query editor and language selector state fixes

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

github-actions · 2024-10-26T23:31:32Z

❌ Empty Changelog Section

The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.

codecov · 2024-10-26T23:45:17Z

Codecov Report

Attention: Patch coverage is 69.49153% with 18 lines in your changes missing coverage. Please review.

Project coverage is 60.75%. Comparing base (463a6c0) to head (1a59213).
Report is 11 commits behind head on main.

Files with missing lines	Patch %	Lines
.../data/public/ui/query_editor/language_selector.tsx	59.25%	5 Missing and 6 partials ⚠️
...ta/public/ui/dataset_selector/dataset_selector.tsx	0.00%	4 Missing ⚠️
.../public/query/query_string/query_string_manager.ts	90.90%	1 Missing and 1 partial ⚠️
...s/data/public/ui/dataset_selector/configurator.tsx	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8712      +/-   ##
==========================================
- Coverage   60.75%   60.75%   -0.01%     
==========================================
  Files        3798     3798              
  Lines       90650    90677      +27     
  Branches    14254    14269      +15     
==========================================
+ Hits        55076    55089      +13     
- Misses      32079    32091      +12     
- Partials     3495     3497       +2

Flag	Coverage Δ
Linux_1	`29.06% <0.00%> (-0.01%)`	⬇️
Linux_2	`56.39% <ø> (-0.01%)`	⬇️
Linux_3	`37.60% <69.49%> (+0.02%)`	⬆️
Linux_4	`29.82% <0.00%> (-0.01%)`	⬇️
Windows_1	`29.07% <0.00%> (-0.03%)`	⬇️
Windows_2	`56.34% <ø> (-0.01%)`	⬇️
Windows_3	`37.60% <69.49%> (+0.02%)`	⬆️
Windows_4	`29.82% <0.00%> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

github-actions · 2024-10-28T11:34:54Z

❌ Empty Changelog Section

The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.

github-actions · 2024-10-28T11:37:01Z

❌ Empty Changelog Section

The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

ananzh · 2024-10-28T18:00:29Z

test it with new cypress tests. It can pass the two tests I created.

virajsanghvi

How have we tested this? Is there an endpoint I can try this out on?

virajsanghvi · 2024-10-28T21:43:02Z

  }

-  public getDefaultLanguage(): LanguageConfig {
+  public getDefaultLanguage(): LanguageConfig | undefined {


Was this response type just incorrect before or did it change?

response type was incorrect. in current state there should never not be a default language. but since it's stored as a map, the linter is saying DQL technically can't exist.

probaby need to bucket in having a more thorough default language usage and what that default language is. or did we want to lean in on perhaps there is no language state.

virajsanghvi · 2024-10-28T21:49:03Z

+   * If only language is provided, uses current dataset
+   * If only dataset is provided, uses current or dataset's preferred language
+   */
+  public getInitialQuery = (partialQuery?: Partial<Query>) => {


do we have a plan to address test coverage of this method?

virajsanghvi · 2024-10-28T21:55:40Z

+   */
+  public getInitialQuery = (partialQuery?: Partial<Query>) => {
+    if (!partialQuery) {
+      return this.getInitialQueryByLanguage(this.query$.getValue().language);


Is this.query$.getValue().language always defined?

virajsanghvi · 2024-10-28T21:57:09Z

+      language: languageId,
+    };
+    const queryString = language?.getQueryString(newQuery) || '';
+    this.languageService.setUserQueryString(queryString);


q: this updates the query in the query box?

abbyhu2000 · 2024-10-28T22:53:36Z

passed the two cypress tests i wrote for discover 2.0

ananzh

I pull it down and verified using new tests. Changes look good to me. Approve for unblocking. I am also curious about @virajsanghvi 's questions. It would be better if you can add more tests.

virajsanghvi

Approving to unblock

ashwin-pc

Thanks for the added comments in the flow. IT helped the review. No real blockers for the PR, had some questions before approving though

ashwin-pc · 2024-10-28T23:25:11Z

+   * If only language is provided, uses current dataset
+   * If only dataset is provided, uses current or dataset's preferred language
+   */
+  public getInitialQuery = (partialQuery?: Partial<Query>) => {


ashwin-pc · 2024-10-29T00:10:03Z

-    return datasetType?.supportedLanguages(dataset);
-  }, [props.query.dataset, queryString]);
+  const [isPopoverOpen, setPopover] = useState(false);
+  const [currentLanguage, setCurrentLanguage] = useState<string>(


This works for now, but i dont like keeping track of another state here. This component should simply use the current state of the query service. Two issues can arise from this:

If the query state does not update, but the setCurrentLanguage does. They ar no out of sync again

If someone in fututre accidentally updates the query state based on the currentLanguage, we have a race condition again

Not a blocker, but we need to be figure out a nicer pattern for components that want to simply reflect the current state of the query and update it without causing update loops

yeah i think we discussed offline, but ui actions would help. originally i wanted to just rely on the query manager solely but then when modifying the code it was historically split because they wanted different states and actions for when the user selected the language vs like saved queries/saved searches modifying the language.

for example they will count an opt in/opt out of DQL based on the user selecting the language. but they would not increment an opt out count of DQL if the user selected a saved query that had a language of Lucene.

but we should revisit this and rely on modern services in OSD instead of handling the logic too specifically in a single component and passing around that prop.

ashwin-pc · 2024-10-29T00:11:13Z

we need to update the tests here. These snapshots are not useful

ashwin-pc · 2024-10-29T00:11:55Z

      {...datasetSelectorProps}
      selectedDataset={selectedDataset}
-      setSelectedDataset={handleDatasetChange}
+      onSelect={onSelect}


Nit:

Suggested change

onSelect={onSelect}

onChance={handleChange}

This is a more common pattern

can make it a fast follow?

ashwin-pc · 2024-10-29T00:13:15Z

+      setSelectedDataset(query.dataset);
+      queryString.setQuery(query);


This is not a good pattern. We are effectively trying to keep two separate states in sync. That means we have 2 sources of truth, which is risky

ashwin-pc · 2024-10-29T00:15:20Z

 }

-interface State {
-  isSuggestionsVisible: boolean;


Dont we need this anymore?

I dont see it being used. autocomplete appear to be working

ashwin-pc · 2024-10-29T00:15:50Z

+    services.http.post('/api/opensearch-dashboards/dql_opt_in_stats', {
      body: JSON.stringify({ opt_in: languageId === 'kuery' }),
    });


We should remove this as a whole

ashwin-pc · 2024-10-29T00:16:44Z

          !languageEditor.TopBar.Expanded && 'emptyExpanded'
        )}
      >
-        <div


Why did we move the location of the banner?

whoops seems to have duplicated

ashwin-pc · 2024-10-29T00:23:57Z

+          language: query.language,
+          dataset: query.dataset,
+        },
+        dateRange


We were missing this? How did it work before?

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

* Query editor functional component and cleanup language selector Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * pass language and dataset when the configurator sets it Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * clean up some dup and update language selector tests Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * fix tests Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Changeset file for PR #8712 created/updated * update recent dataset on query update Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * add tests and remove extra div wrapper Signed-off-by: Kawika Avilla <kavilla414@gmail.com> --------- Signed-off-by: Kawika Avilla <kavilla414@gmail.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit 56eeab2) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…-project#8712) * Query editor functional component and cleanup language selector Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * pass language and dataset when the configurator sets it Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * clean up some dup and update language selector tests Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * fix tests Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Changeset file for PR opensearch-project#8712 created/updated * update recent dataset on query update Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * add tests and remove extra div wrapper Signed-off-by: Kawika Avilla <kavilla414@gmail.com> --------- Signed-off-by: Kawika Avilla <kavilla414@gmail.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

) * Query editor functional component and cleanup language selector * pass language and dataset when the configurator sets it * clean up some dup and update language selector tests * fix tests * Changeset file for PR #8712 created/updated * update recent dataset on query update * add tests and remove extra div wrapper --------- (cherry picked from commit 56eeab2) Signed-off-by: Kawika Avilla <kavilla414@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

…-project#8712) (opensearch-project#8736) * Query editor functional component and cleanup language selector * pass language and dataset when the configurator sets it * clean up some dup and update language selector tests * fix tests * Changeset file for PR opensearch-project#8712 created/updated * update recent dataset on query update * add tests and remove extra div wrapper --------- (cherry picked from commit 56eeab2) Signed-off-by: Kawika Avilla <kavilla414@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Signed-off-by: Ruchi Sharma <ruchi492@gmail.com>

github-actions bot added the distinguished-contributor label Oct 26, 2024

github-actions bot added the failed changeset label Oct 26, 2024

Query editor functional component and cleanup language selector

126f51b

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

kavilla force-pushed the kavilla/queryeditoropts branch from 156b1d5 to 126f51b Compare October 28, 2024 02:16

kavilla added 3 commits October 28, 2024 08:54

pass language and dataset when the configurator sets it

ec97f83

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

clean up some dup and update language selector tests

b3dd801

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

fix tests

cc17524

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

kavilla changed the title ~~[DO NOT MERGE][WIP] react functional component~~ [discover] query editor and language selector state fixes Oct 28, 2024

kavilla marked this pull request as ready for review October 28, 2024 11:37

kavilla requested review from AMoo-Miki, BionIT, Flyingliuhub, SuZhou-Joe, ZilongX, abbyhu2000, ananzh, ashwin-pc, bandinib-amzn, curq, joshuarrrr, manasvinibs, ruanyl, xinruiba, zengyan-amazon, zhongnansu and zhyuanqi as code owners October 28, 2024 11:37

kavilla requested review from huyaboo, joshuali925, sejli and virajsanghvi as code owners October 28, 2024 11:37

kavilla added backport 2.x v2.18.0 labels Oct 28, 2024

Changeset file for PR opensearch-project#8712 created/updated

b83a580

github-actions bot removed the failed changeset label Oct 28, 2024

kavilla added discover for discover reinvent failed changeset discover-next labels Oct 28, 2024

github-actions bot removed the failed changeset label Oct 28, 2024

update recent dataset on query update

8d6247b

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

virajsanghvi reviewed Oct 28, 2024

View reviewed changes

ananzh previously approved these changes Oct 28, 2024

View reviewed changes

virajsanghvi previously approved these changes Oct 29, 2024

View reviewed changes

ashwin-pc reviewed Oct 29, 2024

View reviewed changes

add tests and remove extra div wrapper

1a59213

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

kavilla dismissed stale reviews from virajsanghvi and ananzh via 1a59213 October 29, 2024 01:15

ashwin-pc approved these changes Oct 29, 2024

View reviewed changes

ananzh approved these changes Oct 29, 2024

View reviewed changes

ashwin-pc merged commit 56eeab2 into opensearch-project:main Oct 29, 2024

opensearch-trigger-bot bot mentioned this pull request Oct 29, 2024

[Backport 2.x] [discover] query editor and language selector state fixes #8736

Merged

		setSelectedDataset(query.dataset);
		queryString.setQuery(query);

Conversation

kavilla commented Oct 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

Uh oh!

github-actions bot commented Oct 26, 2024

❌ Empty Changelog Section

Uh oh!

codecov bot commented Oct 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Oct 28, 2024

❌ Empty Changelog Section

Uh oh!

github-actions bot commented Oct 28, 2024

❌ Empty Changelog Section

Uh oh!

ananzh commented Oct 28, 2024

Uh oh!

virajsanghvi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kavilla Oct 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abbyhu2000 commented Oct 28, 2024

Uh oh!

ananzh left a comment

Choose a reason for hiding this comment

Uh oh!

virajsanghvi left a comment

Choose a reason for hiding this comment

Uh oh!

ashwin-pc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

kavilla commented Oct 26, 2024 •

edited

Loading

codecov bot commented Oct 26, 2024 •

edited

Loading

kavilla Oct 29, 2024 •

edited

Loading