feat(sqllab): add shortcut for run current sql

[justinpark]

SUMMARY

The manual selection of the current query is time-consuming. (Longer the query more time it takes to select manually)
This commit creates a new shortcut(ctrl + shift + enter) which automatically detects and selects the range of the current query and then run the selection in order to reduce the manual selection work.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

After:

current.query.mov

Before:

before--current-sql.mov

TESTING INSTRUCTIONS

Hit "Ctrl+Shift+Enter" on sql editor

ADDITIONAL INFORMATION

• Has associated issue:
• Required feature flags:
• Changes UI
• Includes DB Migration (follow approval process in SIP-59)
  • Migration is atomic, supports rollback & is backwards-compatible
  • Confirm DB migration upgrade and downgrade tested
  • Runtime estimates and downtime expectations provided
• Introduces new feature or API
• Removes existing feature or API

[michael-s-molina]

This is awesome! I'll review it tomorrow.

[michael-s-molina]

/testenv up

[github-actions]

@michael-s-molina Container image not yet published for this PR. Please try again when build is complete.

[github-actions]

@michael-s-molina Ephemeral environment creation failed. Please check the Actions logs for details.

[codecov]

Codecov Report

Merging #24329 (9cce503) into master (d041648) will decrease coverage by 0.15%.
The diff coverage is 25.24%.

❗ Current head 9cce503 differs from pull request most recent head ea9beb7. Consider uploading reports for the commit ea9beb7 to get more accurate results

@@            Coverage Diff             @@
##           master   #24329      +/-   ##
==========================================
- Coverage   69.09%   68.95%   -0.15%     
==========================================
  Files        1906     1907       +1     
  Lines       74108    74177      +69     
  Branches     8165     8190      +25     
==========================================
- Hits        51207    51148      -59     
- Misses      20778    20906     +128     
  Partials     2123     2123              

Flag	Coverage Δ
hive	?
javascript	55.72% <15.90%> (-0.07%)	⬇️
mysql	?

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

Impacted Files	Coverage Δ
...plugins/legacy-plugin-chart-heatmap/src/Heatmap.js	0.00% <ø> (ø)
.../legacy-plugin-chart-heatmap/src/transformProps.js	0.00% <0.00%> (ø)
...gins/legacy-plugin-chart-world-map/src/WorldMap.js	0.00% <ø> (ø)
...egacy-plugin-chart-world-map/src/transformProps.js	0.00% <0.00%> (ø)
...rts/src/BigNumber/BigNumberTotal/transformProps.ts	0.00% <ø> (ø)
...BigNumber/BigNumberWithTrendline/transformProps.ts	48.57% <ø> (ø)
.../plugin-chart-echarts/src/Funnel/transformProps.ts	73.46% <ø> (ø)
...s/plugin-chart-echarts/src/Gauge/transformProps.ts	78.57% <ø> (ø)
...ins/plugin-chart-echarts/src/Pie/transformProps.ts	56.33% <ø> (ø)
...lugin-chart-echarts/src/Sunburst/transformProps.ts	0.00% <0.00%> (ø)
... and 20 more

... and 7 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[michael-s-molina]

/testenv up

[github-actions]

@michael-s-molina Container image not yet published for this PR. Please try again when build is complete.

[github-actions]

@michael-s-molina Ephemeral environment creation failed. Please check the Actions logs for details.

[michael-s-molina]

@justinpark Ephemeral environments are not working anymore.

[michael-s-molina]

If the cursor is at the end of the line, it will jump to the next statement.

Screen.Recording.2023-06-09.at.14.44.03.mov

[michael-s-molina]

Should we ignore comments?

Screen.Recording.2023-06-09.at.14.47.42.mov

[cploonker]

To me it should be any query delimited by semi-colon OR (start/end of file) around the cursor should be picked.

If the cursor is just after the semicolon, next query should be picked.

If I am editing a specific query my cursor is likely going to be inside that query,

[justinpark]

If the cursor is at the end of the line, it will jump to the next statement.

Screen.Recording.2023-06-09.at.14.44.03.mov

As Chandraprakash mentioned, this is intended. If the cursor is the next to the semi column, it will jump to the next statement.

[justinpark]

Should we ignore comments?

Screen.Recording.2023-06-09.at.14.47.42.mov

As we faced the regression of handling comments in FE, ignoring comments makes more complex and can be an issue in some edge cases. I'd rather make simple (including comments) to make features functional.

[cploonker]

Is it possible to send the delimited query for execution without actually selecting the query in the UI?
Can we NOT skip this step off selecting it in the UI?
I don't have a demo to play with, but I was thinking that the selection will actually move my cursor and if I need to further edit then I still need to use the mouse to go back to the location of edit.

If not i guess this can be a stepping stone to end goal some day.

[michael-s-molina]

Is it possible to send the delimited query for execution without actually selecting the query in the UI?

I think this is a great suggestion from an usability perspective. It's quite common to edit the statement after a failed query. That's actually the default behavior of many database tools. Here's an example of DBeaver:

Screen.Recording.2023-06-14.at.08.44.56.mov

[cploonker]

We can try to pass an additional parameter into runQueryFromSqlEditor e.g. currentQuery=true with default value as false. And then move the calc to find the query inside that function.

https://github.com/apache/superset/blob/c1d882e9153624046a450257a6e19e36a1f96e9d/superset-frontend/src/SqlLab/actions/sqlLab.js#L390

[cploonker]

Can we please merge this change.
We can always iterate on how ctrl + shift + enter works.
For the most part the end user experience will remain the same

[michael-s-molina]

Can we please merge this change.
We can always iterate on how ctrl + shift + enter works.
For the most part the end user experience will remain the same

The iterative approach makes sense given that the current behavior already offers a valuable feature.

[michael-s-molina]

LGTM

[EugeneTorap]

@justinpark Thanks for this nice PR!
@michael-s-molina Can you rerun the cancelled CI test and merge the PR?

[justinpark]

cc: @cploonker @michael-s-molina @EugeneTorap

As suggested, I updated the selection back to the current cursor position.

without.selection.mov

[cploonker]

cc: @cploonker @michael-s-molina @EugeneTorap

As suggested, I updated the selection back to the current cursor position.

without.selection.mov

ooohhh nice

[EugeneTorap]

@justinpark Merge it?

[villebro]

This is awesome! I'll review it tomorrow.

Agreed, this has been long overdue, thanks for this work @justinpark ! ❤️