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

fix: enforce ALERT_REPORTS_MAX_CUSTOM_SCREENSHOT_WIDTH #32053

Merged
merged 2 commits into from
Jan 31, 2025

Conversation

betodealmeida
Copy link
Member

SUMMARY

We only enforce ALERT_REPORTS_MAX_CUSTOM_SCREENSHOT_WIDTH when an alert/report is created. This means that if the feature flag is later changed to a smaller value it might not have any effect on pre-existing alerts/reports.

This PR adds a check during screenshot generation.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

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

Copy link

korbit-ai bot commented Jan 30, 2025

Based on your review schedule, I'll hold off on reviewing this PR until it's marked as ready for review. If you'd like me to take a look now, comment /korbit-review.

Your admin can change your review schedule in the Korbit Console

@betodealmeida betodealmeida marked this pull request as ready for review January 31, 2025 16:17
@dosubot dosubot bot added the alert-reports Namespace | Anything related to the Alert & Reports feature label Jan 31, 2025
@betodealmeida betodealmeida force-pushed the enforce-max-screenshot-width branch from 32fd9cf to 0ea2597 Compare January 31, 2025 16:18
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.

Files scanned
File Path Reviewed
superset/commands/report/execute.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

@betodealmeida betodealmeida force-pushed the enforce-max-screenshot-width branch from 0ea2597 to 90e9328 Compare January 31, 2025 17:36
@@ -300,13 +300,16 @@ def _get_screenshots(self) -> list[bytes]:
)
user = security_manager.find_user(username)

max_width = app.config["ALERT_REPORTS_MAX_CUSTOM_SCREENSHOT_WIDTH"]
Copy link
Member

Choose a reason for hiding this comment

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

@betodealmeida Maybe we should deprecate the ALERT_REPORTS_MAX_CUSTOM_SCREENSHOT_WIDTH feature flag to remove it in a major version. It seems that this feature should always be enabled in case alerts and reports are too.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, it's not a feature, just a configuration value.

("equals_max", 1600, 1600, 800, 1600),
],
)
def test_screenshot_width_calculation(
Copy link
Member

Choose a reason for hiding this comment

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

Nice!

Copy link
Member

@michael-s-molina michael-s-molina left a comment

Choose a reason for hiding this comment

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

Thank you for the improvement!

@betodealmeida betodealmeida merged commit 1064ad5 into master Jan 31, 2025
40 checks passed
@betodealmeida betodealmeida deleted the enforce-max-screenshot-width branch January 31, 2025 19:56
tmsjordan pushed a commit to tmsdevelopment/superset that referenced this pull request Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alert-reports Namespace | Anything related to the Alert & Reports feature size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants