Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf(dashboard): dashboard list endpoint returning large and unnecessary data #29121

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Always-prog
Copy link
Contributor

@Always-prog Always-prog commented Jun 9, 2024

SUMMARY

The endpoint of the response list returns unnecessary data - css, position_json, and json_metadata. This fields data is large, and loads the network, but it is not used at the frontend, because they are not needed to display the dashboards list.

In my company, there was a problem with this, because our dashboards are large, and getting list of dashboards was taking 2-3 seconds. As soon as we deleted the return of these fields, it began to load instantly.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before

image

After

image

Look at the Content Length

TESTING INSTRUCTIONS

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

…rge columns - css, position_json and json_metadata
@github-actions github-actions bot added the api Related to the REST API label Jun 9, 2024
@dosubot dosubot bot added the dashboard:performance Related to Dashboard performance label Jun 9, 2024
Copy link

codecov bot commented Jun 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.67%. Comparing base (76d897e) to head (3602f11).
Report is 298 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master   #29121       +/-   ##
===========================================
+ Coverage   60.48%   83.67%   +23.18%     
===========================================
  Files        1931      518     -1413     
  Lines       76236    37492    -38744     
  Branches     8568        0     -8568     
===========================================
- Hits        46114    31371    -14743     
+ Misses      28017     6121    -21896     
+ Partials     2105        0     -2105     
Flag Coverage Δ
hive 48.92% <ø> (-0.24%) ⬇️
javascript ?
mysql 77.21% <ø> (?)
postgres 77.32% <ø> (?)
presto 53.53% <ø> (-0.27%) ⬇️
python 83.67% <ø> (+20.18%) ⬆️
sqlite 76.77% <ø> (?)
unit 59.04% <ø> (+1.42%) ⬆️

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.

@Always-prog
Copy link
Contributor Author

@supersetbot org-label

@Always-prog
Copy link
Contributor Author

@supersetbot orglabel

@mistercrunch
Copy link
Member

This looks similar to #28609 (?) @dpgaspar

@rusackas rusackas requested a review from dpgaspar June 10, 2024 18:03
@john-bodley
Copy link
Member

john-bodley commented Jun 11, 2024

The challenge with this is it's unclear where and how both Superset* and third party applications are using the payload. At the very least this is a breaking change.

* Ideally the Superset frontend would explicitly define which fields it requires so it is evident which fields are actually used by the application. So the non-breaking fix here would be to leave list_columns as is and update the frontend code.

@john-bodley john-bodley added risk:breaking-change Issues or PRs that will introduce breaking changes hold! On hold labels Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Related to the REST API dashboard:performance Related to Dashboard performance hold! On hold risk:breaking-change Issues or PRs that will introduce breaking changes size/XS TechAudit-BI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants