fix: feature flags typing #15254

dpgaspar · 2021-06-18T10:25:04Z

SUMMARY

Adds type annotations to feature flags, clearly stating that all feature flags are booleans. Because of that QUERY_COST_FORMATTERS_BY_ENGINE, SCHEDULED_QUERIES and SQL_VALIDATORS_BY_ENGINE are no longer feature flags but config keys. Note that currently on master, SQL_VALIDATORS_BY_ENGINE is defined as a top level key on config.py, but is erroneously being read from the feature flag object on the frontend. This fixes the issue and adds a note to UPDATING.md.

Testing instructions

Go to SQL Lab and open a Postgres database
Write a query that's incorrect and verify that the error shows up in the gutter (see below)

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

codecov · 2021-11-17T07:51:02Z

Codecov Report

Merging #15254 (345d01b) into master (c829614) will decrease coverage by 0.20%.
The diff coverage is 55.00%.

@@            Coverage Diff             @@
##           master   #15254      +/-   ##
==========================================
- Coverage   76.94%   76.74%   -0.21%     
==========================================
  Files        1042     1043       +1     
  Lines       56254    56371     +117     
  Branches     7785     7794       +9     
==========================================
- Hits        43286    43260      -26     
- Misses      12710    12855     +145     
+ Partials      258      256       -2

Flag	Coverage Δ
hive	`?`
mysql	`81.96% <83.33%> (+<0.01%)`	⬆️
postgres	`81.96% <83.33%> (-0.01%)`	⬇️
presto	`?`
python	`82.04% <83.33%> (-0.43%)`	⬇️
sqlite	`81.64% <83.33%> (+<0.01%)`	⬆️

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

Impacted Files	Coverage Δ
superset-frontend/src/showSavedQuery/index.jsx	`0.00% <0.00%> (ø)`
superset/views/base.py	`74.91% <ø> (ø)`
...rc/SqlLab/components/ScheduleQueryButton/index.tsx	`28.12% <12.50%> (ø)`
superset/views/core.py	`76.97% <50.00%> (ø)`
...frontend/src/SqlLab/components/SqlEditor/index.jsx	`54.97% <100.00%> (+0.82%)`	⬆️
...et-frontend/src/dashboard/components/Dashboard.jsx	`78.09% <100.00%> (ø)`
superset/config.py	`91.53% <100.00%> (+0.02%)`	⬆️
superset/utils/feature_flag_manager.py	`96.29% <100.00%> (ø)`
superset/db_engines/hive.py	`0.00% <0.00%> (-85.19%)`	⬇️
superset/db_engine_specs/hive.py	`69.49% <0.00%> (-16.99%)`	⬇️
... and 109 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 c829614...345d01b. Read the comment docs.

villebro

LGTM. I contributed some code to this PR, so leaving this to be stamped by @betodealmeida

villebro · 2021-11-18T14:51:53Z

superset/views/core.py

@@ -2414,7 +2413,7 @@ def validate_sql_json(
            )

        spec = mydb.db_engine_spec
-        validators_by_engine = get_feature_flags().get("SQL_VALIDATORS_BY_ENGINE")
+        validators_by_engine = app.config["SQL_VALIDATORS_BY_ENGINE"]


It appears that SQL validation has never worked based on the SQL_VALIDATORS_BY_ENGINE top level config parameter, as this was referencing the feature flag map.

villebro · 2021-11-18T14:54:17Z

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

@@ -392,8 +397,7 @@ class SqlEditor extends React.PureComponent {
  canValidateQuery() {
    // Check whether or not we can validate the current query based on whether
    // or not the backend has a validator configured for it.
-    const validatorMap = window.featureFlags.SQL_VALIDATORS_BY_ENGINE;


Same here - instead of checking the featureFlags map, we should check bootstrap data.

betodealmeida

LGTM. We also have SCHEDULED_QUERIES which is non-boolean:

superset/superset-frontend/src/SqlLab/components/ScheduleQueryButton/index.tsx

Line 37 in 1ab36c9

const jsonSchema = window.featureFlags.SCHEDULED_QUERIES?.JSONSCHEMA;

superset/superset-frontend/src/SqlLab/components/ScheduleQueryButton/index.tsx

Line 55 in 1ab36c9

const getUISchema = () => window.featureFlags.SCHEDULED_QUERIES?.UISCHEMA;

villebro · 2021-11-19T07:06:09Z

LGTM. We also have SCHEDULED_QUERIES which is non-boolean:

superset/superset-frontend/src/SqlLab/components/ScheduleQueryButton/index.tsx

Line 37 in 1ab36c9

const jsonSchema = window.featureFlags.SCHEDULED_QUERIES?.JSONSCHEMA;

superset/superset-frontend/src/SqlLab/components/ScheduleQueryButton/index.tsx

Line 55 in 1ab36c9

const getUISchema = () => window.featureFlags.SCHEDULED_QUERIES?.UISCHEMA;

Thanks @betodealmeida , let's get that one fixed, too!

villebro · 2021-11-19T10:42:44Z

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

+const appContainer = document.getElementById('app');
+const bootstrapData = JSON.parse(
+  appContainer.getAttribute('data-bootstrap') || '{}',
+);


I'd like to move this boilerplate into a util, but I'd prefer to do that in a follow up

michellethomas · 2021-12-09T00:07:34Z

@dpgaspar Hi, can you clarify in UPDATING that this turns on SQL_VALIDATORS_BY_ENGINE for presto and postgres when it was not on previously. Do we want this feature to be on by default?

* fix: feature flags typing * fix tests * add note in UPDATING.md * fix frontend * also move SCHEDULED_QUERIES to top level * fix test Co-authored-by: Ville Brofeldt <ville.v.brofeldt@gmail.com>

fix: feature flags typing

3021d0f

superset-github-bot bot added the preset-io label Jun 18, 2021

pull-request-size bot added the size/S label Jun 18, 2021

Merge branch 'master' into fix/feature-flag-typing

4dd7f05

villebro marked this pull request as ready for review November 17, 2021 06:58

villebro added 3 commits November 18, 2021 13:13

fix tests

0fb4c7c

add note in UPDATING.md

622ad6f

fix frontend

7040045

pull-request-size bot added size/M and removed size/S labels Nov 18, 2021

dpgaspar requested review from villebro and betodealmeida November 18, 2021 14:10

villebro reviewed Nov 18, 2021

View reviewed changes

betodealmeida approved these changes Nov 18, 2021

View reviewed changes

villebro and others added 2 commits November 19, 2021 10:35

also move SCHEDULED_QUERIES to top level

f10f21c

fix test

345d01b

villebro reviewed Nov 19, 2021

View reviewed changes

villebro approved these changes Nov 19, 2021

View reviewed changes

dpgaspar merged commit 69f9ee8 into apache:master Nov 19, 2021

dpgaspar deleted the fix/feature-flag-typing branch November 19, 2021 15:56

cemremengu mentioned this pull request Dec 22, 2021

fix(ui): show SCHEDULED_QUERIES template in SqlLab #17854

Merged

9 tasks

villebro mentioned this pull request Jun 4, 2022

fix(schedule-query): getUISchema function called in SchemaForm component #20256

Merged

9 tasks

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: feature flags typing #15254

fix: feature flags typing #15254

dpgaspar commented Jun 18, 2021 •

edited by villebro

Loading

codecov bot commented Nov 17, 2021 •

edited

Loading

villebro left a comment

villebro Nov 18, 2021

villebro Nov 18, 2021

betodealmeida left a comment

villebro commented Nov 19, 2021

villebro Nov 19, 2021

michellethomas commented Dec 9, 2021

fix: feature flags typing #15254

fix: feature flags typing #15254

Conversation

dpgaspar commented Jun 18, 2021 • edited by villebro Loading

SUMMARY

Testing instructions

ADDITIONAL INFORMATION

codecov bot commented Nov 17, 2021 • edited Loading

Codecov Report

villebro left a comment

Choose a reason for hiding this comment

villebro Nov 18, 2021

Choose a reason for hiding this comment

villebro Nov 18, 2021

Choose a reason for hiding this comment

betodealmeida left a comment

Choose a reason for hiding this comment

villebro commented Nov 19, 2021

villebro Nov 19, 2021

Choose a reason for hiding this comment

michellethomas commented Dec 9, 2021

dpgaspar commented Jun 18, 2021 •

edited by villebro

Loading

codecov bot commented Nov 17, 2021 •

edited

Loading