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(embed): prevent random crash for filters bar in embedded dashboard #32294

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

Conversation

hainenber
Copy link
Contributor

Text containing single quote might not be JSON-parseable. If consumed as bootstrap data, it'll crash over.

fix(embed): prevent random crash for filters bar in embedded dashboard

SUMMARY

Fixes #32282

Rephrase the term for disabling refresh interval to eliminate single quote usage, which might not play nice with JSON.parse/load.

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

Text containing single quote might not be JSON-parseable. If consumed as bootstrap data, it'll crash over.

Signed-off-by: hainenber <[email protected]>
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/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
Documentation
Logging
Error Handling
Readability
Design
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 Feb 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.45%. Comparing base (76d897e) to head (cd8bc60).
Report is 1471 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master   #32294       +/-   ##
===========================================
+ Coverage   60.48%   83.45%   +22.96%     
===========================================
  Files        1931      546     -1385     
  Lines       76236    39098    -37138     
  Branches     8568        0     -8568     
===========================================
- Hits        46114    32630    -13484     
+ Misses      28017     6468    -21549     
+ Partials     2105        0     -2105     
Flag Coverage Δ
hive 48.50% <ø> (-0.67%) ⬇️
javascript ?
mysql 75.85% <ø> (?)
postgres 75.92% <ø> (?)
presto 53.03% <ø> (-0.78%) ⬇️
python 83.45% <ø> (+19.96%) ⬆️
sqlite 75.43% <ø> (?)
unit 61.06% <ø> (+3.44%) ⬆️

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.

@@ -567,7 +567,7 @@ test('Columnar, does not render the rows', () => {
});

test('database and schema are correctly populated', async () => {
jest.setTimeout(10000);
jest.setTimeout(20000);
Copy link
Member

Choose a reason for hiding this comment

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

wondering why we are bumping the timeout here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We did observed that this test suite is failing more often than previously (1, 2, 3).

I'm picking up my own failed CI checks as examples as it's easier to find them in the personal mailbox.

@rusackas
Copy link
Member

I have no problem with the timeouts (we might need more of them, honestly!) but I'm wondering if the jsonrepair addition might have any unintended side effects. Does that library properly escape the single quote and solve the problem without changing the text? I'm worried there may be any number of strings throughout the codebase with apostrophes, and hope we can handle them properly rather than work around them.

@hainenber
Copy link
Contributor Author

Does that library properly escape the single quote and solve the problem without changing the text?

The library fixes the input string in best effort approach and at least returns JSON-compliant object.

image

I'm worried there may be any number of strings throughout the codebase with apostrophes, and hope we can handle them properly rather than work around them.

This is going to be tedious so that's why I added a failsafe with jsonrepair. What do you think of initially parse input data with native JSON.parse and if failed, fixes the input string and reparse again?

export default function getBootstrapData(): BootstrapData {
  const appContainer = document.getElementById('app');
  const dataBootstrapString = appContainer?.getAttribute('data-bootstrap');
  if (!dataBootstrapString) {
    return DEFAULT_BOOTSTRAP_DATA
  }

  try {
    return JSON.parse(dataBootstrapString) 
  } catch (error) {
    return JSON.parse(jsonrepair(dataBootstrapString))
  }
}

@rusackas
Copy link
Member

What do you think of initially parse input data with native JSON.parse and if failed, fixes the input string and reparse again?

I think that's a good idea... it seems like it would de-risk jsonrepair doing anything unexpected/unintended.

Optionally, you could go the extra mile and try the jsonrepair and throw an error about malformed json if both methods fail.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The filters bar crashes randomly in an embedded dashboard
3 participants