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

feat(config): add LOADERS variable in config files to enable custom loader gif #31565

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

ERGO1995
Copy link

SUMMARY

Added a LOADERS variable in the configuration files config.py and superset_config.py:

  • config.py default value → LOADERS = [{"src": "/static/assets/images/loading.gif"}]
  • superset_config.py → LOADERS = [{"src": "/static/assets/images/YOUR_GIF.gif"}] (for exemple)

Managed the loader in Superset's base HTML skeleton:

  • superset/superset/templates/superset/basic.html

Retrieved the custom loader in Superset API endpoints:

  • superset/superset/views/core.py → Added an endpoint to retrieve the loader from the configuration file.

Managed the loader in Superset's React.js elements:

  • superset/superset-frontend/src/components/Loading/index.tsx → Fetches the custom loader via the new endpoint.

I'm very new to Superset and the open-source world, and this is my first attempt. I'm open to any advice on how to make this cleaner if needed :)

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

Don't setup the LOADERS in superset_config.py file to see the default loader. Then add tyour custom gif to see the difference.

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

@github-actions github-actions bot added the api Related to the REST API label Dec 19, 2024
@dosubot dosubot bot added the change:frontend Requires changing the frontend label Dec 19, 2024
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've completed my review and didn't find any issues... but I did find this kitten.

    |\__/,|   (`\
  _.|o o  |_   ) )
-(((---(((--------
Files scanned
File Path Reviewed
superset-frontend/src/components/Loading/index.tsx
superset/views/core.py
superset/config.py

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

  • You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
  • You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
  • Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
  • Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
  • Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

  • Check out our docs on how you can make Korbit work best for you and your team.
  • Customize Korbit for your organization through the Korbit Console.

Current Korbit Configuration

General Settings
Setting Value
Review Schedule Automatic excluding drafts
Max Issue Count 10
Automatic PR Descriptions
Issue Categories
Category Enabled
Naming
Database Operations
Documentation
Logging
Error Handling
Systems and Environment
Objects and Data Structures
Readability and Maintainability
Asynchronous Processing
Design Patterns
Third-Party Libraries
Performance
Security
Functionality

Feedback and Support

Note

Korbit Pro is free for open source projects 🎉

Looking to add Korbit to your team? Get started with a free 2 week trial here

Copy link

codecov bot commented Dec 19, 2024

Codecov Report

Attention: Patch coverage is 66.66667% with 2 lines in your changes missing coverage. Please review.

Project coverage is 65.33%. Comparing base (76d897e) to head (b3243ca).
Report is 1226 commits behind head on master.

Files with missing lines Patch % Lines
superset/views/core.py 60.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master   #31565      +/-   ##
==========================================
+ Coverage   60.48%   65.33%   +4.84%     
==========================================
  Files        1931      538    -1393     
  Lines       76236    39134   -37102     
  Branches     8568        0    -8568     
==========================================
- Hits        46114    25569   -20545     
+ Misses      28017    13565   -14452     
+ Partials     2105        0    -2105     
Flag Coverage Δ
hive 48.76% <66.66%> (-0.41%) ⬇️
javascript ?
presto 53.27% <66.66%> (-0.54%) ⬇️
python 65.33% <66.66%> (+1.84%) ⬆️
unit 60.88% <66.66%> (+3.25%) ⬆️

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.

@rusackas rusackas changed the title feat(Loader) add LOADERS variable in config files to enable custom loader gif feat(config): add LOADERS variable in config files to enable custom loader gif Dec 19, 2024
@sadpandajoe sadpandajoe added review:checkpoint Last PR reviewed during the daily review standup review:draft and removed review:draft labels Dec 19, 2024
@michael-s-molina michael-s-molina removed the review:checkpoint Last PR reviewed during the daily review standup label Dec 20, 2024
@@ -109,6 +109,7 @@
# },
FAVICONS = [{"href": "/static/assets/images/favicon.png"}]

LOADERS = [{"src": "/static/assets/images/loading.gif"}]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this is a bit of a side mission for another PR, or it could be part of this, but I notice we have the FAVICON and LOADERS up here. APP_ICON is waaaaay down below, but maybe they should live together in the config?

LOADERS could also probably use a comment explaining what it is, for anyone learning what they can config.

Is there a reason it's an array? Can you use more than one? If it's just a single GIF, it should probably be more singular like APP_ICON. And to be crazy pedantic, maybe it should just be "LOADER" rather than "LOADERS"

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 change:frontend Requires changing the frontend size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants