warmupfix

[skerbis]

Summary by CodeRabbit

• New Features

  • Enhanced handling of cache-warming requests with a secure token mechanism and dynamic viewport retrieval.
  • Improved progress tracking and status messaging during the cache warming process.

• Refactor

  • Streamlined viewport detection and cache warming processes, removing unnecessary functions for improved performance and maintainability.
  • Introduced a session variable for forced viewport handling, enhancing viewport detection logic.

[coderabbitai[bot]]

Walkthrough

The changes enhance boot.php by introducing a cache warming feature. A new conditional block checks if a request is for cache warming and if the frontend is accessed. When a valid token is received, a viewport is forced via a session variable and later reset to avoid reuse. The code now also falls back to detecting the viewport using an external helper if no forced value is set. Additionally, several functions for viewport detection, cache file handling, inline CSS processing, and critical JS generation were removed to streamline the codebase. The pages/cache.php file was updated to improve cache warming by incorporating a token generation mechanism and a structured approach for handling multiple viewports.

Changes

File	Change Summary
boot.php	- Added cache warming logic: checks cache_warm flag, validates token, sets a session variable forced_viewport, and logs the action if debugging is enabled. - Modified viewport detection: uses forced_viewport if set, otherwise calls CriticalCssHelper::detectViewport(), then resets the session value. - Removed functions: detectViewport(), getCacheFile(), processWithInlineCss(), getAsyncCssCode(), processWithCriticalJs(), generateToken(), and getCriticalJsCode().
pages/cache.php	- Enhanced cache warming process: implemented token generation and improved handling of multiple viewports. - Updated method signature for warmViewport(viewport) to warmViewport(index). - Increased viewport processing time from 5 to 8 seconds and refined progress tracking.
lib/CriticalCssHelper.php	- Modified detectViewport method to prioritize forced_viewport session variable over default detection logic.

Poem

I'm a rabbit in the code, hopping with delight,
Cache warmed and tokens checked, everything's just right.
Forced viewports dance in session, then vanish like a dream,
Old functions make way for new flows, smooth as a gleam.
🐇✨ Through clean code fields I bounce, keeping things light.
Cheers to fresh changes, may our code always take flight!

[!WARNING]

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7637ae5cda9e11d086c39bedd8efb44edbde4931 and e87f66ac0e33f3fad293c5ac4ff6a85d0aec60c0.

📒 Files selected for processing (1)

• pages/cache.php (8 hunks)

🔇 Additional comments (9)

pages/cache.php (9)

43-53: Token-based security enhancement for cache warming

The implementation of a secure random token for cache warming is a good security practice. Using random_bytes(16) with bin2hex() provides a cryptographically secure token with sufficient entropy. The token is properly stored in the addon's configuration and included in the frontend URL.

---

55-62: Good approach for viewport configuration

The code now retrieves viewport sizes from the addon's configuration with sensible defaults. This makes the cache warming system more flexible and configurable.

---

71-74: Improved JavaScript setup for viewport handling

Converting the viewport configuration to JSON and passing it to JavaScript is well done. Separating keys and values into distinct variables (viewports and viewportSizes) creates a cleaner structure.

---

79-92: Enhanced warmViewport function with better viewport handling

The function now takes an index parameter instead of a viewport name, which provides better control over the iteration process. The status message now includes both the viewport name and its width in pixels, improving user feedback.

---

94-105: Improved iframe setup for viewport simulation

The iframe styling now properly uses the actual viewport width from configuration. The debug styling with blue border and slight opacity is helpful for developers. The URL construction with viewport parameter is clear and well-implemented.

---

106-117: Better progress tracking calculation

The progress calculation is now based on the viewport index relative to the total number of viewports, which provides a more accurate representation of completion status. The timeout between viewports has been reduced to 3 seconds, which should improve overall cache warming speed.

---

119-134: Robust error handling with retry mechanism

The addition of error handling with a retry mechanism is excellent. The code will attempt to retry warming the same viewport up to three times before moving on, which improves resilience. The escalating status messages provide good feedback to the user about what's happening during errors.

---

228-229: Improved article and language display in cache file list

Adding the ID values in square brackets next to the names provides better reference information when managing cache files. This makes it easier to identify specific cache entries, especially when dealing with similarly named articles.

---

233-235: Consistent styling for delete button

The delete button now uses consistent CSS classes (btn btn-delete btn-xs), which aligns with REDAXO's UI styling conventions. The confirmation dialog is properly implemented using the data-confirm attribute.

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

🪧 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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.