Skip to content

Conversation

AlexVelezLl
Copy link
Member

@AlexVelezLl AlexVelezLl commented May 7, 2025

Summary

The security error shown in #13339 was being raised because the bloom player was referencing missing files in a blob url. The first one is because the bloom player was trying to fetch a questions.json file just concatenating the file name to the url of the htm file, which is incorrect, since we haven't even built a blob url for this file. In Chrome it raises a 404 error, but in Firefox this raises this Security Error. The second security error shown in #13339 was because the bloom file was referencing a Basic Book.css file, but it was missing in the zip file, so there isn't much we can do there.

So this PR:

Before After
image image

References

Closes #13339.

Reviewer guidance

Replicate #13339

Summary by CodeRabbit

  • New Features

    • Added support for loading and displaying questions from a questions.json file within Bloom content packages.
  • Chores

    • Updated the Bloom player script to a new version.

Copy link
Contributor

coderabbitai bot commented May 7, 2025

Walkthrough

The changes update the Bloom player HTML to reference a new JavaScript build and modify the BloomRunner logic to load and pass a new questions.json resource from the Bloom package zip file to the player. The new resource URL is appended as a query parameter when initializing the Bloom player.

Changes

File(s) Change Summary
kolibri/core/content/static/bloom/bloomplayer.htm Updated the script source to reference a new minified Bloom player JavaScript file.
packages/hashi/src/Bloom/BloomRunner.js Added logic to extract questions.json from the zip, store its URL, and pass it as a query parameter.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BloomRunner
    participant ZipFile
    participant BloomPlayerIframe

    User->>BloomRunner: Initiate Bloom content loading
    BloomRunner->>ZipFile: Extract content, dist, meta, and questions.json
    ZipFile-->>BloomRunner: Return URLs for each resource
    BloomRunner->>BloomPlayerIframe: Construct iframe src with resource URLs as query params (including questionsJsonUrl)
    BloomPlayerIframe-->>User: Render Bloom content with questions
Loading

Assessment against linked issues

Objective Addressed Explanation
No CSP errors in the console for Bloom player books (#13339) The changes update the player script and resource loading, but do not directly address CSP.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b5f4997 and 29640b4.

⛔ Files ignored due to path filters (1)
  • kolibri/core/content/static/bloom/bloomPlayer-02a77592459cdf0b1bd7.min.js is excluded by !**/*.min.js
📒 Files selected for processing (2)
  • kolibri/core/content/static/bloom/bloomplayer.htm (1 hunks)
  • packages/hashi/src/Bloom/BloomRunner.js (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Frontend tests
  • GitHub Check: All file linting
  • GitHub Check: Build WHL file / Build WHL
🔇 Additional comments (2)
kolibri/core/content/static/bloom/bloomplayer.htm (1)

11-11: Appropriate update to use the newer Bloom player bundle.

The JavaScript bundle reference has been updated to a new version that supports the questionsJsonUrl parameter, which is essential for the fix described in the PR objectives.

packages/hashi/src/Bloom/BloomRunner.js (1)

168-170: Good implementation for loading the questions.json file.

The implementation correctly fetches the questions.json file from the ZIP archive and safely handles the case where it might not exist using the optional chaining operator.

@rtibbles rtibbles self-assigned this May 7, 2025
Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

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

All code changes here and in the associated PR on our bloom player fork make sense to me. Just need manual QA to verify the fix.

@pcenov pcenov self-requested a review May 12, 2025 11:36
Copy link
Member

@pcenov pcenov left a comment

Choose a reason for hiding this comment

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

Thanks @AlexVelezLl - I confirm that the questions.json error is not appearing anymore and I didn't observe any regressions caused by the fix.

@AlexVelezLl
Copy link
Member Author

Thanks @pcenov!

@AlexVelezLl AlexVelezLl merged commit db2d2d0 into learningequality:develop May 12, 2025
54 checks passed
@AlexVelezLl AlexVelezLl deleted the add-questions-url-blob branch May 12, 2025 21:42
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.

Content security policy issues for bloom player book(s)
3 participants