feat(report): allow capturing dashboard reports in specific state

[ktmud]

SUMMARY

Depends on: #20632 , please review after it is merged. (merged)

We want to allow users to specify which tabs are selected (and potentially which filters has been applied, too) when generating dashboard reports (see #19354 ). This PR is API changes requires for this to be possible.

Previous attempts (#17749) implemented this feature with only 1 tab being selectable (and highlighted), but will generate multiple screenshots in one report.

This isn't ideal---because there would be no way to compose a view where multiple specific tabs are selected (whether nested or not). We want to generate a screenshot where the whole dashboard state is preserved, hence this approach in this PR---the report_schedule.extra saves only one dashboard state at a time (including which tabs are selected, which filters are applied, etc), then we make only one screenshot for each report that corresponds to the specific dashboard state.

If users want reports for multiple dashboard tabs, they can create multiple reports---currently we don't allow multiple reports for each user on each report, which we would need to change. This PR only changes the report schedule schema and screenshot generation process. There will be more PRs to follow to fully enable the desired feature.

Future TODOs:

• Allow users to select tabs in the UI
• Allow each user to create multiple reports for a dashboard

#17749 isn't used by the frontend in any way, so it should be safe to just replace it.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A

TESTING INSTRUCTIONS

We rely on unit tests.

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

Merging #20552 (78bd489) into master (1b577d1) will decrease coverage by 0.13%.
The diff coverage is 96.34%.

❗ Current head 78bd489 differs from pull request most recent head 3047bdb. Consider uploading reports for the commit 3047bdb to get more accurate results

@@            Coverage Diff             @@
##           master   #20552      +/-   ##
==========================================
- Coverage   66.23%   66.09%   -0.14%     
==========================================
  Files        1757     1758       +1     
  Lines       66978    66987       +9     
  Branches     7117     7117              
==========================================
- Hits        44360    44273      -87     
- Misses      20801    20897      +96     
  Partials     1817     1817              

Flag	Coverage Δ
hive	?
mysql	81.07% <96.34%> (+<0.01%)	⬆️
postgres	81.14% <96.34%> (+<0.01%)	⬆️
presto	?
python	81.24% <96.34%> (-0.30%)	⬇️
sqlite	79.76% <96.34%> (?)
unit	?

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

Impacted Files	Coverage Δ
superset/dashboards/permalink/commands/create.py	92.85% <ø> (ø)
superset/reports/commands/base.py	92.30% <66.66%> (ø)
superset/models/dashboard.py	76.07% <75.00%> (-0.21%)	⬇️
superset/reports/commands/exceptions.py	97.97% <80.00%> (-0.98%)	⬇️
superset/models/helpers.py	40.78% <100.00%> (+0.52%)	⬆️
superset/reports/api.py	90.22% <100.00%> (ø)
superset/reports/commands/alert.py	96.59% <100.00%> (ø)
superset/reports/commands/bulk_delete.py	90.32% <100.00%> (ø)
superset/reports/commands/create.py	89.47% <100.00%> (+0.74%)	⬆️
superset/reports/commands/delete.py	90.32% <100.00%> (ø)
... and 28 more

Help us with your feedback. Take ten seconds to tell us how you rate us.

[john-bodley]

Thanks for adding the feature. I few comments, but otherwise LGTM.

[john-bodley]

You could inline this as two set comprehensions via { ... } | { ... }.

[ktmud]

I think | is actually union. What I needed is set(a) - set(b).