[Auto Suggest] DQL autosuggest with ANTLR by paulstn · Pull Request #7391 · opensearch-project/OpenSearch-Dashboards

paulstn · 2024-07-23T03:23:29Z

Description

Implements ANTLR based autocomplete for DQL queries, currently within Discover.

Ignore files located in .generated and grammar/.antlr

Previously reviewed/approved in #7467 to be merged into the feature/discover-2.0-1 branch. Was then reverted to isolate test failures, and then moved to this pr to get merged into main directly.

Screenshot

Testing the changes

Changelog

feat: DQL Autocomplete

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

codecov · 2024-07-23T03:39:50Z

Codecov Report

Attention: Patch coverage is 58.68794% with 233 lines in your changes missing coverage. Please review.

Project coverage is 63.64%. Comparing base (7a9e9ed) to head (d3db8da).
Report is 229 commits behind head on main.

Files with missing lines	Patch %	Lines
...gins/data/public/antlr/dql/.generated/DQLParser.ts	55.76%	174 Missing and 18 partials ⚠️
...c/plugins/data/public/antlr/dql/code_completion.ts	70.12%	9 Missing and 14 partials ⚠️
...ugins/data/public/antlr/dql/.generated/DQLLexer.ts	76.47%	8 Missing ⚠️
...ashboards_react/public/code_editor/code_editor.tsx	36.36%	3 Missing and 4 partials ⚠️
...s/data/public/autocomplete/autocomplete_service.ts	0.00%	2 Missing ⚠️
src/plugins/data/public/plugin.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7391      +/-   ##
==========================================
- Coverage   63.67%   63.64%   -0.04%     
==========================================
  Files        3630     3634       +4     
  Lines       79545    80099     +554     
  Branches    12609    12682      +73     
==========================================
+ Hits        50652    50977     +325     
- Misses      25819    26015     +196     
- Partials     3074     3107      +33

Flag	Coverage Δ
Linux_1	`30.56% <11.31%> (-0.19%)`	⬇️
Linux_2	`55.58% <ø> (ø)`
Linux_3	`40.58% <59.13%> (+0.20%)`	⬆️
Linux_4	`31.32% <11.80%> (-0.24%)`	⬇️
Windows_1	`30.58% <11.31%> (-0.19%)`	⬇️
Windows_2	`55.53% <ø> (ø)`
Windows_3	`40.58% <59.13%> (+0.21%)`	⬆️
Windows_4	`31.32% <11.80%> (-0.24%)`	⬇️

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.

sejli

Looks good, have some nits and one thing regarding http.

src/plugins/data/public/antlr/dql/code_completion.ts

src/plugins/data/public/antlr/dql/code_completion.test.ts

src/plugins/data/public/plugin.ts

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

…and utilize selectionEnd if no position Signed-off-by: Paul Sebastian <paulstn@amazon.com>

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

* update code completion to not return for visualize Signed-off-by: Paul Sebastian <paulstn@amazon.com> * update types to match completionitemkind Signed-off-by: Paul Sebastian <paulstn@amazon.com> --------- Signed-off-by: Paul Sebastian <paulstn@amazon.com>

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

kavilla

qq in the PR

kavilla · 2024-07-30T20:31:41Z

src/plugins/opensearch_dashboards_react/public/code_editor/code_editor.tsx

      this.props.editorWillMount();
    }

-    monaco.languages.onLanguage(this.props.languageId, () => {


have we verify no performance issues? that means anytime this is re-rendered its going to re register

kavilla · 2024-07-30T20:37:24Z

src/plugins/opensearch_dashboards_react/public/code_editor/code_editor.tsx

+   * The language ID, meant to restrict the specified configuration for only this language. When
+   * not provided, will apply the language configuration for every language.
+   */
+  language?: string;


little bit confused, but you have more context than me. it seems like the only time this is set is in the loop where we check the language. and if we have to register the languages so we would still have to pass this prop. so as long as im registering the language then i can register the language configuration?

kavilla · 2024-07-30T20:51:50Z

src/plugins/data/public/ui/query_editor/query_editor.tsx

    }
  };

+  private fetchIndexPatterns = debounce(


yeah i believe index patterns service might be easier. it's ok can be fast follow

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

opensearch-trigger-bot · 2024-07-30T23:11:13Z

The backport to 2.16 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.16 2.16
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.16
# Create a new branch
git switch --create backport/backport-7391-to-2.16
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 2b1d01f4aa87a91b0fe1ec2cfd0ee9653adb02c5
# Push it to GitHub
git push --set-upstream origin backport/backport-7391-to-2.16
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.16

Then, create a pull request where the base branch is 2.16 and the compare/head branch is backport/backport-7391-to-2.16.

github-actions bot added the repeat-contributor label Jul 23, 2024

opensearch-changeset-bot bot added a commit to paulstn/OpenSearch-Dashboards that referenced this pull request Jul 23, 2024

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

b7471dd

paulstn marked this pull request as ready for review July 23, 2024 13:54

paulstn requested review from AMoo-Miki, BionIT, Flyingliuhub, LDrago27, SuZhou-Joe, ZilongX, abbyhu2000, ananzh, ashwin-pc, bandinib-amzn, curq, joshuarrrr, kavilla, manasvinibs, mengweieric, ruanyl, virajsanghvi, xinruiba, zengyan-amazon, zhongnansu and zhyuanqi as code owners July 23, 2024 13:54

paulstn pushed a commit to paulstn/OpenSearch-Dashboards that referenced this pull request Jul 23, 2024

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

677286f

paulstn force-pushed the antlr-autocomplete branch from c9206b8 to 85ee824 Compare July 23, 2024 17:17

sejli previously approved these changes Jul 23, 2024

View reviewed changes

paulstn pushed a commit to paulstn/OpenSearch-Dashboards that referenced this pull request Jul 23, 2024

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

3d3deb0

paulstn force-pushed the antlr-autocomplete branch from 85ee824 to d3bd0ce Compare July 23, 2024 21:36

paulstn added 16 commits July 30, 2024 11:23

move dql test constants to separate file

8f36279

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

pass core setup from autocomplete constructor to query sugg provider …

9787c6e

…and utilize selectionEnd if no position Signed-off-by: Paul Sebastian <paulstn@amazon.com>

update an import

99ee35a

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

use updated dataset for index pattern

d6519a3

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

remove console log

443bf72

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

update saved object test flyout snap

7a8ef87

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

update tests to match changes

00fe412

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

updated editor

3be2116

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

insert colon and space after selecting suggested field

c799ae5

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

fix suggestions after colon without space

e65080a

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

update test

c14afd2

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

typing update

dfe3ffd

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

updated dataset name

da49684

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

remove connection service based lines and rely on service

d5184f6

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

add debouncer for index pattern calls

1cd99fd

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

kavilla reviewed Jul 30, 2024

View reviewed changes

ashwin-pc previously approved these changes Jul 30, 2024

View reviewed changes

prudhvigodithi mentioned this pull request Jul 30, 2024

[RELEASE] Release version 2.16.0 opensearch-project/opensearch-build#4771

Closed

74 tasks

use index pattern service rather than debounce

b1b4095

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

kavilla previously approved these changes Jul 30, 2024

View reviewed changes

ashwin-pc previously approved these changes Jul 30, 2024

View reviewed changes

paulstn added 2 commits July 30, 2024 15:15

update mock index for test

b182ce8

Signed-off-by: Paul Sebastian <paulstn@amazon.com>

Merge branch 'main' into antlr-autocomplete

d3db8da

ananzh approved these changes Jul 30, 2024

View reviewed changes

kavilla approved these changes Jul 30, 2024

View reviewed changes

opensearch-trigger-bot bot mentioned this pull request Jul 30, 2024

[Backport 2.x] [Auto Suggest] DQL autosuggest with ANTLR #7590

Merged

paulstn mentioned this pull request Jul 31, 2024

[Auto Suggest] DQL Updates #7593

Merged

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Auto Suggest] DQL autosuggest with ANTLR#7391

[Auto Suggest] DQL autosuggest with ANTLR#7391
kavilla merged 47 commits intoopensearch-project:mainfrom
paulstn:antlr-autocomplete

paulstn commented Jul 23, 2024 •

edited

Loading

Uh oh!

codecov bot commented Jul 23, 2024 •

edited

Loading

Uh oh!

sejli left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kavilla left a comment

Uh oh!

kavilla Jul 30, 2024

Uh oh!

kavilla Jul 30, 2024

Uh oh!

kavilla Jul 30, 2024

Uh oh!

opensearch-trigger-bot bot commented Jul 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Conversation

paulstn commented Jul 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Screenshot

Testing the changes

Changelog

Check List

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

sejli left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kavilla left a comment

Choose a reason for hiding this comment

Uh oh!

kavilla Jul 30, 2024

Choose a reason for hiding this comment

Uh oh!

kavilla Jul 30, 2024

Choose a reason for hiding this comment

Uh oh!

kavilla Jul 30, 2024

Choose a reason for hiding this comment

Uh oh!

opensearch-trigger-bot bot commented Jul 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

paulstn commented Jul 23, 2024 •

edited

Loading

codecov bot commented Jul 23, 2024 •

edited

Loading