superset icon indicating copy to clipboard operation
superset copied to clipboard

chore: Adding missing flags to `FEATURE_FLAGS.md`, and a new/temp `TODO` category

Open rusackas opened this issue 3 years ago • 4 comments
trafficstars

SUMMARY

It was mentioned that the DRILL_TO_DETAIL flag was not categorized in the FEATURE_FLAGS.md file. I went to add it, and noticed several others were missing, too!

Some of these, I'm not personally sure of how to categorize. I've placed the handle of either the author or someone knowledgeable in this area next to each one, below. With these mentions, I hope y'all can make comments/suggestions on this PR and help get them in the right category.

These are the ones in need of categorization at the moment. Please help!

  • DRUID_JOINS (@betodealmeida)
  • DISABLE_LEGACY_DATASOURCE_EDITOR (@AAfghahi)
  • DASHBOARD_FILTERS_EXPERIMENTAL (@kgabryje)
  • EMBEDDED_SUPERSET (@suddjian / @lilykuang)
  • ENABLE_ADVANCED_DATA_TYPES (@cccs-RyanS)
  • ALERTS_ATTACH_REPORTS (@lilykuang)
  • ENFORCE_DB_ENCRYPTION_UI (@AAfghahi)
  • ALLOW_FULL_CSV_EXPORT (@m-ajay)
  • ALLOW_ADHOC_SUBQUERY (@lilykuang)
  • RLS_IN_SQLLAB (@betodealmeida)
  • CACHE_IMPERSONATION (@Samira-El)
  • EMBEDDABLE_CHARTS (@geido)

TESTING INSTRUCTIONS

N/A - it's just markdown :) Check my spelling/formatting, though!

ADDITIONAL INFORMATION

  • [x] Has associated issue: Fixes #21467
  • [ ] 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

rusackas avatar Sep 15 '22 02:09 rusackas

Codecov Report

Merging #21474 (8037e69) into master (2285ebe) will decrease coverage by 11.27%. The diff coverage is n/a.

@@             Coverage Diff             @@
##           master   #21474       +/-   ##
===========================================
- Coverage   66.65%   55.37%   -11.28%     
===========================================
  Files        1791     1791               
  Lines       68476    68476               
  Branches     7286     7286               
===========================================
- Hits        45643    37919     -7724     
- Misses      20963    28687     +7724     
  Partials     1870     1870               
Flag Coverage Δ
hive 53.06% <ø> (ø)
javascript 52.85% <ø> (ø)
mysql ?
postgres ?
presto 52.96% <ø> (ø)
python 58.06% <ø> (-23.32%) :arrow_down:
sqlite ?
unit 51.07% <ø> (ø)

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

Impacted Files Coverage Δ
superset/utils/dashboard_import_export.py 0.00% <0.00%> (-100.00%) :arrow_down:
superset/key_value/commands/update.py 0.00% <0.00%> (-88.89%) :arrow_down:
superset/key_value/commands/delete.py 0.00% <0.00%> (-85.30%) :arrow_down:
superset/key_value/commands/delete_expired.py 0.00% <0.00%> (-80.77%) :arrow_down:
superset/dashboards/commands/importers/v0.py 15.62% <0.00%> (-76.25%) :arrow_down:
superset/datasets/commands/update.py 25.00% <0.00%> (-69.05%) :arrow_down:
superset/datasets/commands/create.py 31.25% <0.00%> (-68.75%) :arrow_down:
superset/datasets/commands/importers/v0.py 24.03% <0.00%> (-67.45%) :arrow_down:
superset/reports/commands/execute.py 24.64% <0.00%> (-66.91%) :arrow_down:
superset/views/datasource/utils.py 26.66% <0.00%> (-66.67%) :arrow_down:
... and 280 more

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

codecov[bot] avatar Sep 15 '22 02:09 codecov[bot]

@rusackas Following feature flags are also missing. Can you please add them in this PR.

DASHBOARD_EDIT_CHART_IN_NEW_TAB (@kgabryje) ENABLE_DND_WITH_CLICK_UX (@kgabryje) ENABLE_EXPLORE_DRAG_AND_DROP (@kgabryje) ENABLE_FILTER_BOX_MIGRATION (@graceguo-supercat) ESTIMATE_QUERY_COST (@betodealmeida) FORCE_DATABASE_CONNECTIONS_SSL (@AAfghahi) USE_ANALAGOUS_COLORS (@stephenLYZ) UX_BETA (@kgabryje)

I also suggest we should add one liner description in front of each feature flag to indicate what feature is hidden behind them. I can collect those descriptions from their original PR's and submit it as separate PR. What are your thoughts about this?

mdeshmu avatar Sep 15 '22 18:09 mdeshmu

@rusackas Following feature flags are also missing. Can you please add them in this PR.

DASHBOARD_EDIT_CHART_IN_NEW_TAB (@kgabryje)

It's in the "In Testing" section

ENABLE_DND_WITH_CLICK_UX (@kgabryje) ENABLE_EXPLORE_DRAG_AND_DROP (@kgabryje)

These are in the "Stable" section

ENABLE_FILTER_BOX_MIGRATION (@graceguo-supercat)

It's in the "In Testing" section

ESTIMATE_QUERY_COST (@betodealmeida)

Unless I'm mistaken this is not a feature flag... but perhaps it should be, @betodealmeida ?

FORCE_DATABASE_CONNECTIONS_SSL (@AAfghahi)

It's in the "Deprecated" section

USE_ANALAGOUS_COLORS (@stephenLYZ) UX_BETA (@kgabryje)

These are both in the "In Testing" section

I also suggest we should add one liner description in front of each feature flag to indicate what feature is hidden behind them. I can collect those descriptions from their original PR's and submit it as separate PR. What are your thoughts about this?

I'd welcome that PR with open arms :) Ping me (or any of us on the thread) when it's ready for review!

rusackas avatar Sep 16 '22 01:09 rusackas

@rusackas Thank you so much for the detailed reply. I must have seen the latest commit instead of all changes in the PR and hence didn't notice that most of them you have already added.

mdeshmu avatar Sep 17 '22 04:09 mdeshmu

Still in need of a few more clarifications, if any of ya can help categorize:

  • ~~DISABLE_LEGACY_DATASOURCE_EDITOR (@AAfghahi )~~ ✅
  • ~~EMBEDDED_SUPERSET (@lilykuang)~~ ✅
  • ~~ENABLE_ADVANCED_DATA_TYPES (@cccs-RyanS)~~ ✅
  • ~~ALERTS_ATTACH_REPORTS (@lilykuang)~~ ✅
  • ~~ENFORCE_DB_ENCRYPTION_UI (@AAfghahi)~~ ✅
  • ~~ALLOW_FULL_CSV_EXPORT~~ (@m-ajay) ✅
  • ~~ALLOW_ADHOC_SUBQUERY (@lilykuang)~~ ✅

rusackas avatar Sep 28 '22 00:09 rusackas

I just went through the list on our deployment as well. The default config has a few more descriptions than the docs:

https://github.com/apache/superset/blob/master/superset/config.py#L375

cbdabner avatar Sep 29 '22 01:09 cbdabner

I just went through the list on our deployment as well. The default config has a few more descriptions than the docs:

https://github.com/apache/superset/blob/master/superset/config.py#L375

Fair, but I guess I'm just trying to address the initial complaint that not all the flags were categorized. Documenting their perils and pitfalls might be a separate effort - copy/pasting comments is one option, but things might need another layer of color (risks, timelines, etc).

rusackas avatar Sep 29 '22 13:09 rusackas