fix: Select a query from History and Run #15891

graceguo-supercat · 2021-07-25T23:52:40Z

SUMMARY

Fix an issue that SQL Lab didn't run correct sql after user pick a query from History. The root cause is that after update selected sql in redux store, component state is out of sync from props.

The proposed solution for this PR is to remove sql from component local state, and always use props which sync from redux store.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Step to reproduce:

open sql lab
run a sql statement
pick a query from History tab
you will see SQL Editor updated with the picked query
Click Run button
The query result is not correct: query result is actually from the previous sql statement.

TESTING INSTRUCTIONS

CI and manual test.

@jinghua-qa It's a little troublesome to add unit test for this bug. Could you add a test case for this flow?

ADDITIONAL INFORMATION

Has associated issue:
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

cc @etr2460 @ktmud

codecov · 2021-07-26T00:20:52Z

Codecov Report

Merging #15891 (4aec771) into master (9c81599) will increase coverage by 0.02%.
The diff coverage is 84.37%.

❗ Current head 4aec771 differs from pull request most recent head 349216b. Consider uploading reports for the commit 349216b to get more accurate results

@@            Coverage Diff             @@
##           master   #15891      +/-   ##
==========================================
+ Coverage   77.08%   77.11%   +0.02%     
==========================================
  Files         984      985       +1     
  Lines       51788    51849      +61     
  Branches     7037     7068      +31     
==========================================
+ Hits        39923    39983      +60     
- Misses      11640    11641       +1     
  Partials      225      225

Flag	Coverage Δ
javascript	`71.79% <89.79%> (+0.05%)`	⬆️

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

Impacted Files	Coverage Δ
...erset-frontend/src/SqlLab/components/SqlEditor.jsx	`53.98% <0.00%> (+0.23%)`	⬆️
superset/sql_lab.py	`80.70% <40.00%> (+0.78%)`	⬆️
superset/db_engine_specs/base.py	`88.37% <50.00%> (-0.30%)`	⬇️
...frontend/src/components/TimezoneSelector/index.tsx	`97.77% <97.77%> (ø)`
superset/db_engine_specs/hive.py	`86.66% <100.00%> (+0.15%)`	⬆️
superset/db_engine_specs/presto.py	`90.37% <100.00%> (+0.06%)`	⬆️
...d/src/explore/components/PropertiesModal/index.tsx	`81.94% <0.00%> (-2.35%)`	⬇️
superset-frontend/src/dataMask/reducer.ts	`65.38% <0.00%> (-1.93%)`	⬇️
...src/dashboard/components/FiltersBadge/selectors.ts	`75.22% <0.00%> (-0.48%)`	⬇️
...ontrols/DndColumnSelectControl/DndMetricSelect.tsx	`41.04% <0.00%> (-0.44%)`	⬇️
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9c81599...349216b. Read the comment docs.

etr2460 · 2021-07-26T15:17:27Z

superset-frontend/src/SqlLab/components/SqlEditor.jsx

+  static getDerivedStateFromProps(props, state) {
+    if (props.queryEditor.sql !== state.sql) {
+      return {
+        sql: props.queryEditor.sql,
+      };
+    }
+    return null;
+  }


needing to use this function seems a bit concerning... i'm referencing here: https://reactjs.org/docs/react-component.html#static-getderivedstatefromprops:

If you want to “reset” some state when a prop changes, consider either making a component fully controlled or fully uncontrolled with a key instead.

I wonder if we can just use the sql from the queryEditor for everything here instead of using the state.sql string?

i think this is a good idea: I removed all the usage for state.sql and always use props.queryEditor.sql.

etr2460 · 2021-07-26T20:27:57Z

/testenv up

github-actions · 2021-07-26T20:30:16Z

@etr2460 Ephemeral environment spinning up at http://34.220.228.128:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

etr2460

lgtm (and i couldn't break it in the test env). thanks for the fix and the iteration!

github-actions · 2021-07-27T20:25:14Z

Ephemeral environment shutdown and build artifacts deleted.

This reverts commit 8c7e09e.

This reverts commit 8c7e09e

…che#15992) This reverts commit 8c7e09e.

* fix: Run query picked from History * remove sql from component local state

…che#15992) This reverts commit 8c7e09e.

* fix: Run query picked from History * remove sql from component local state

…che#15992) This reverts commit 8c7e09e.

* fix: Run query picked from History * remove sql from component local state

…che#15992) This reverts commit 8c7e09e.

* fix: Run query picked from History * remove sql from component local state

…che#15992) This reverts commit 84da654.

fix: Run query picked from History

5baf2d6

pull-request-size bot added the size/XS label Jul 25, 2021

graceguo-supercat changed the title ~~fix: Run query picked from History~~ fix: Run sql picked from History Jul 26, 2021

etr2460 reviewed Jul 26, 2021

View reviewed changes

remove sql from component local state

349216b

pull-request-size bot added size/S and removed size/XS labels Jul 26, 2021

graceguo-supercat requested a review from etr2460 July 26, 2021 17:01

graceguo-supercat changed the title ~~fix: Run sql picked from History~~ fix: Select a query from History and Run Jul 26, 2021

etr2460 approved these changes Jul 27, 2021

View reviewed changes

graceguo-supercat merged commit 8c7e09e into apache:master Jul 27, 2021

serenajiang added a commit to serenajiang/incubator-superset that referenced this pull request Jul 30, 2021

Revert "fix: Select a query from History and Run (apache#15891)"

2d1f51f

This reverts commit 8c7e09e.

serenajiang mentioned this pull request Jul 30, 2021

fix(sqllab): revert #15891 to fix sqllab delay #15992

Merged

serenajiang added a commit that referenced this pull request Jul 30, 2021

Revert "fix: Select a query from History and Run (#15891)" (#15992)

c37c56c

This reverts commit 8c7e09e.

graceguo-supercat pushed a commit to airbnb/superset-fork that referenced this pull request Jul 31, 2021

Revert "fix: Select a query from History and Run (apache#15891)"

7957832

This reverts commit 8c7e09e

serenajiang added a commit to airbnb/superset-fork that referenced this pull request Jul 31, 2021

Revert "fix: Select a query from History and Run (apache#15891)" (apa…

bd034dd

…che#15992) This reverts commit 8c7e09e.

graceguo-supercat mentioned this pull request Jul 31, 2021

[wip]fix: Select a query from History and Run -- 2nd try #15995

Closed

8 tasks

opus-42 pushed a commit to opus-42/incubator-superset that referenced this pull request Nov 14, 2021

fix: Select a query from History and Run (apache#15891)

8fed44d

* fix: Run query picked from History * remove sql from component local state

opus-42 pushed a commit to opus-42/incubator-superset that referenced this pull request Nov 14, 2021

Revert "fix: Select a query from History and Run (apache#15891)" (apa…

fa2fc6b

…che#15992) This reverts commit 8c7e09e.

cccs-RyanS pushed a commit to CybercentreCanada/superset that referenced this pull request Dec 17, 2021

fix: Select a query from History and Run (apache#15891)

e409c23

* fix: Run query picked from History * remove sql from component local state

cccs-RyanS pushed a commit to CybercentreCanada/superset that referenced this pull request Dec 17, 2021

Revert "fix: Select a query from History and Run (apache#15891)" (apa…

01dd801

…che#15992) This reverts commit 8c7e09e.

QAlexBall pushed a commit to QAlexBall/superset that referenced this pull request Dec 29, 2021

fix: Select a query from History and Run (apache#15891)

0271108

* fix: Run query picked from History * remove sql from component local state

QAlexBall pushed a commit to QAlexBall/superset that referenced this pull request Dec 29, 2021

Revert "fix: Select a query from History and Run (apache#15891)" (apa…

7498b6c

…che#15992) This reverts commit 8c7e09e.

cccs-rc pushed a commit to CybercentreCanada/superset that referenced this pull request Mar 6, 2024

fix: Select a query from History and Run (apache#15891)

d0281f5

* fix: Run query picked from History * remove sql from component local state

cccs-rc pushed a commit to CybercentreCanada/superset that referenced this pull request Mar 6, 2024

Revert "fix: Select a query from History and Run (apache#15891)" (apa…

c7beb1c

…che#15992) This reverts commit 84da654.

mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.3.0 labels Mar 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Select a query from History and Run #15891

fix: Select a query from History and Run #15891

graceguo-supercat commented Jul 25, 2021 •

edited

Loading

codecov bot commented Jul 26, 2021 •

edited

Loading

etr2460 Jul 26, 2021

graceguo-supercat Jul 26, 2021

etr2460 commented Jul 26, 2021

github-actions bot commented Jul 26, 2021

etr2460 left a comment

github-actions bot commented Jul 27, 2021

fix: Select a query from History and Run #15891

fix: Select a query from History and Run #15891

Conversation

graceguo-supercat commented Jul 25, 2021 • edited Loading

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Jul 26, 2021 • edited Loading

Codecov Report

etr2460 Jul 26, 2021

Choose a reason for hiding this comment

graceguo-supercat Jul 26, 2021

Choose a reason for hiding this comment

etr2460 commented Jul 26, 2021

github-actions bot commented Jul 26, 2021

etr2460 left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 27, 2021

graceguo-supercat commented Jul 25, 2021 •

edited

Loading

codecov bot commented Jul 26, 2021 •

edited

Loading