refactor(sqllab): migrate share queries via kv by permalink

[justinpark]

SUMMARY

This PR changes the existing SHARE_QUERIES_VIA_KV_STORE feature to store data using the permalink API instead of the KV store. This is one of the prerequisites of Remove old KV store endpoint and its associated asset.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

after--permalink.mov

TESTING INSTRUCTIONS

Go to SQL Lab and then click "Copy Link"

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

[codecov]

Codecov Report

Attention: Patch coverage is 91.94631% with 12 lines in your changes missing coverage. Please review.

Project coverage is 70.47%. Comparing base (76d897e) to head (26036ce).
Report is 295 commits behind head on master.

Files	Patch %	Lines
superset/sqllab/permalink/api.py	90.19%	5 Missing ⚠️
superset/commands/sql_lab/permalink/create.py	86.95%	3 Missing ⚠️
superset/commands/sql_lab/permalink/get.py	87.50%	3 Missing ⚠️
superset-frontend/src/SqlLab/actions/sqlLab.js	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #29163      +/-   ##
==========================================
+ Coverage   60.48%   70.47%   +9.98%     
==========================================
  Files        1931     1960      +29     
  Lines       76236    77838    +1602     
  Branches     8568     8765     +197     
==========================================
+ Hits        46114    54855    +8741     
+ Misses      28017    20823    -7194     
- Partials     2105     2160      +55     

Flag	Coverage Δ
hive	49.02% <70.80%> (-0.14%)	⬇️
javascript	58.02% <91.66%> (+0.30%)	⬆️
mysql	77.28% <91.97%> (?)
postgres	77.39% <91.97%> (?)
presto	53.63% <70.80%> (-0.18%)	⬇️
python	83.75% <91.97%> (+20.26%)	⬆️
sqlite	76.84% <91.97%> (?)
unit	59.25% <70.80%> (+1.62%)	⬆️

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.

[villebro]

/testenv up

[github-actions]

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

[villebro]

/testenv up FEATURE_SHARE_QUERIES_VIA_KV_STORE=true

[github-actions]

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

[villebro]

Great improvement, this is long overdue! I suggest removing the SHARE_QUERIES_VIA_KV_STORE feature flag, and making the permalink only store the selected portion of the editor. Other than that this looks great!

[villebro]

Shouldn't this feature be enabled by default? Now the permalink feature is only available if the SHARE_QUERIES_VIA_KV_STORE feature flag is enabled:

I feel we could now remove the feature flag, and make this the default behavior.

In addition, I think it would be a good idea to create the permalink based on the same query snippet that gets executed when running the query - Currently the entire editor gets persisted into the permalink, even if only a specific portion of the editor is selected.

[michael-s-molina]

I suggest removing the SHARE_QUERIES_VIA_KV_STORE feature flag, and making the permalink only store the selected portion of the editor.

@villebro There's a proposal in 5.0 to remove this feature flag.