Moving Query Workbench to Dev Tools #349

TackAdam · 2024-07-12T01:17:18Z

Description

This change migrates query workbench to dev tools for the navigation changes planned for 2.16. The way the selectedMDSDataConnectionId was passed needed to be updated to allow dev tools to correctly find data sources.

Working with MDS:

Screen.Recording.2024-07-11.at.6.15.05.PM.mov

Working with Flint:
FlintTest.mov.zip

There is an existing issue I outlined in #348. But testing with Flint(using dashboards-observability prior to the opensearch-project/dashboards-observability@19d68b2 commit) seems to keep all functionality working correctly.

Issues Resolved

Check List

New functionality includes testing.
- All tests pass, including unit test, integration test and doctest
New functionality has been documented.
- New functionality has javadoc added
- New functionality has user manual doc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Adam Tackett <tackadam@amazon.com>

sumukhswamy · 2024-07-17T04:21:40Z

nit. could you rename all the dataSourceId to dataSourceMDSId, will be easier to distinguish

Signed-off-by: Adam Tackett <tackadam@amazon.com>

public/application.tsx

ps48

Can we please add the legacy UR support for workbench: https://github.com/opensearch-project/dashboards-observability/blob/7566cff5e9a245cc619732741e05886617134e8e/public/plugin.tsx#L187-L190

So If user types https://playground.opensearch.org/app/opensearch-query-workbench they’ll be redirected to https://playground.opensearch.org/app/dev_tools#/opensearch-query-workbench
Let's fix the linter errors here.
Thanks!

Signed-off-by: Adam Tackett <tackadam@amazon.com>

Signed-off-by: Shenoy Pratik <sgguruda@amazon.com>

ps48 · 2024-07-19T19:24:59Z

public/application.tsx

@@ -14,7 +13,7 @@ import { AppPluginStartDependencies } from './types';
 export const renderApp = (
  { notifications, http, chrome, savedObjects }: CoreStart,
  { navigation, dataSource }: AppPluginStartDependencies,
-  { appBasePath, element, setHeaderActionMenu }: AppMountParameters,
+  { appBasePath, element, setHeaderActionMenu, dataSourceId }: AppMountParameters,


@TackAdam Did we test this with and without new nav? cc: @sumukhswamy

Thanks! Sumukh for validating offline that workbench works with MDS with and without new nav.

opensearch-trigger-bot · 2024-07-19T20:42:52Z

The backport to 2.x 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/dashboards-query-workbench/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/dashboards-query-workbench/backport-2.x
# Create a new branch
git switch --create backport/backport-349-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 7aba1fd8b4ba174820ca09370012c3eeae3d67ec
# Push it to GitHub
git push --set-upstream origin backport/backport-349-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/dashboards-query-workbench/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-349-to-2.x.

* Migrate to devTools Signed-off-by: Adam Tackett <tackadam@amazon.com> * MDS working changed how ID passed Signed-off-by: Adam Tackett <tackadam@amazon.com> * Chagned name to dataSourceMDSId Signed-off-by: Adam Tackett <tackadam@amazon.com> * remove console log Signed-off-by: Adam Tackett <tackadam@amazon.com> * add support for backward URLs Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * update nav coditionally and set breadcrumbs Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * fix lint error Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * update breadcrumb only when nav is enabled Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * fix URL for new nav is disabled Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> --------- Signed-off-by: Adam Tackett <tackadam@amazon.com> Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> Co-authored-by: Adam Tackett <tackadam@amazon.com> Co-authored-by: Shenoy Pratik <sgguruda@amazon.com> (cherry picked from commit 7aba1fd)

* Migrate to devTools Signed-off-by: Adam Tackett <tackadam@amazon.com> * MDS working changed how ID passed Signed-off-by: Adam Tackett <tackadam@amazon.com> * Chagned name to dataSourceMDSId Signed-off-by: Adam Tackett <tackadam@amazon.com> * remove console log Signed-off-by: Adam Tackett <tackadam@amazon.com> * add support for backward URLs Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * update nav coditionally and set breadcrumbs Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * fix lint error Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * update breadcrumb only when nav is enabled Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> * fix URL for new nav is disabled Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> --------- Signed-off-by: Adam Tackett <tackadam@amazon.com> Signed-off-by: Shenoy Pratik <sgguruda@amazon.com> Co-authored-by: Adam Tackett <tackadam@amazon.com> Co-authored-by: Shenoy Pratik <sgguruda@amazon.com> (cherry picked from commit 7aba1fd) Co-authored-by: Adam Tackett <105462877+TackAdam@users.noreply.github.com>

Adam Tackett added 2 commits July 3, 2024 17:29

Migrate to devTools

0971f57

Signed-off-by: Adam Tackett <tackadam@amazon.com>

MDS working changed how ID passed

6f77d47

Signed-off-by: Adam Tackett <tackadam@amazon.com>

TackAdam requested review from ps48, kavithacm, derek-ho, joshuali925, dai-chen, YANG-DB, rupal-bq, mengweieric, vamsi-amazon, Swiddis, penghuo, seankao-az, Yury-Fridlyand, anirudha, paulstn and sumukhswamy as code owners July 12, 2024 01:17

SuZhou-Joe approved these changes Jul 16, 2024

View reviewed changes

Chagned name to dataSourceMDSId

4240806

Signed-off-by: Adam Tackett <tackadam@amazon.com>

TackAdam force-pushed the moveToDevTools branch from bb58dc4 to 4240806 Compare July 17, 2024 17:34

ps48 reviewed Jul 17, 2024

View reviewed changes

public/application.tsx Outdated Show resolved Hide resolved

ps48 reviewed Jul 17, 2024

View reviewed changes

Adam Tackett and others added 6 commits July 17, 2024 12:52

remove console log

869850a

Signed-off-by: Adam Tackett <tackadam@amazon.com>

add support for backward URLs

6d45721

Signed-off-by: Shenoy Pratik <sgguruda@amazon.com>

Merge branch 'main' into moveToDevTools

ebd8a3b

Signed-off-by: Shenoy Pratik <sgguruda@amazon.com>

update nav coditionally and set breadcrumbs

b3d94ac

Signed-off-by: Shenoy Pratik <sgguruda@amazon.com>

fix lint error

0e9378a

Signed-off-by: Shenoy Pratik <sgguruda@amazon.com>

update breadcrumb only when nav is enabled

4b26775

Signed-off-by: Shenoy Pratik <sgguruda@amazon.com>

ps48 approved these changes Jul 19, 2024

View reviewed changes

fix URL for new nav is disabled

3933cb1

Signed-off-by: Shenoy Pratik <sgguruda@amazon.com>

mengweieric approved these changes Jul 19, 2024

View reviewed changes

ps48 reviewed Jul 19, 2024

View reviewed changes

ps48 merged commit 7aba1fd into opensearch-project:main Jul 19, 2024
9 of 11 checks passed

ps48 added the backport 2.x label Jul 19, 2024

opensearch-trigger-bot bot added the backport-failed label Jul 19, 2024

ps48 removed the backport-failed label Jul 19, 2024

ps48 mentioned this pull request Jul 19, 2024

[Navigation] Update dev tools tab css for new left navigation opensearch-project/OpenSearch-Dashboards#7328

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Moving Query Workbench to Dev Tools #349

Moving Query Workbench to Dev Tools #349

TackAdam commented Jul 12, 2024

sumukhswamy commented Jul 17, 2024

ps48 left a comment •

edited

Loading

ps48 Jul 19, 2024

ps48 Jul 19, 2024

opensearch-trigger-bot bot commented Jul 19, 2024

Moving Query Workbench to Dev Tools #349

Moving Query Workbench to Dev Tools #349

Conversation

TackAdam commented Jul 12, 2024

Description

Issues Resolved

Check List

sumukhswamy commented Jul 17, 2024

ps48 left a comment • edited Loading

Choose a reason for hiding this comment

ps48 Jul 19, 2024

Choose a reason for hiding this comment

ps48 Jul 19, 2024

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Jul 19, 2024

ps48 left a comment •

edited

Loading