feat: add cache warmup #2
Conversation
WalkthroughA new cache warmup deployment task for TYPO3 was added and integrated into the autoloader. The task executes a CLI command to warm up the TYPO3 cache and is set to run before the feature initialization step. Documentation was updated to clarify how cache warming works and its reliance on a specific TYPO3 extension. The composer-require-checker configuration was extended with an additional whitelisted symbol. Changes
Sequence Diagram(s)sequenceDiagram
participant Deployer
participant TYPO3 Host
Deployer->>TYPO3 Host: Run "dep cache:warmup"
TYPO3 Host->>TYPO3 Host: Determine site config (default: main)
TYPO3 Host->>TYPO3 Host: Select active directory (release or current)
TYPO3 Host->>TYPO3 Host: Execute "php typo3cms warming:cachewarmup"
TYPO3 Host->>Deployer: Return result
Estimated code review effort2 (~10–30 minutes) Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
deployer/typo3/autoload.php(1 hunks)deployer/typo3/task/cache_warmup.php(1 hunks)docs/TYPO3.md(1 hunks)
🧬 Code Graph Analysis (1)
deployer/typo3/task/cache_warmup.php (1)
deployer/functions.php (1)
runExtended(95-107)
🧰 Additional context used
🧬 Code Graph Analysis (1)
deployer/typo3/task/cache_warmup.php (1)
deployer/functions.php (1)
runExtended(95-107)
🔇 Additional comments (2)
deployer/typo3/autoload.php (1)
21-21: LGTM! Correctly integrates the new cache warmup task.The require_once statement follows the established pattern and is properly placed in alphabetical order with other task files.
deployer/typo3/task/cache_warmup.php (1)
8-10: Consistent implementation with other TYPO3 tasks.The active directory detection logic correctly follows the same pattern used in other TYPO3 deployment tasks, ensuring consistency across the codebase.
|
|
||
| // cache warmup | ||
| task('cache:warmup', function () { | ||
| $siteConfig = has('site_config') ? get('site_config') : 'main'; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider validating site_config parameter.
The site config parameter should be validated or escaped to prevent potential command injection issues.
- $siteConfig = has('site_config') ? get('site_config') : 'main';
+ $siteConfig = has('site_config') ? escapeshellarg(get('site_config')) : 'main';🤖 Prompt for AI Agents
In deployer/typo3/task/cache_warmup.php at line 7, the site_config parameter is
assigned without validation, which risks command injection. Add validation or
sanitization to ensure the site_config value only contains expected safe
characters or matches allowed values before using it. This prevents malicious
input from being executed in commands.
| $activeDir = test('[ -e {{deploy_path}}/release ]') ? | ||
| get('deploy_path') . '/release' : | ||
| get('deploy_path') . '/current'; | ||
| runExtended('cd ' . $activeDir . ' && {{bin/php}} {{bin/typo3cms}} warming:cachewarmup -s ' . $siteConfig); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add validation for the typo3-warming extension dependency.
The task uses the warming:cachewarmup command which requires the EXT:typo3-warming extension. Consider adding a check to ensure this extension is available before attempting to run the command.
- runExtended('cd ' . $activeDir . ' && {{bin/php}} {{bin/typo3cms}} warming:cachewarmup -s ' . $siteConfig);
+ // Check if typo3-warming extension is available
+ $extensionCheck = runExtended('cd ' . $activeDir . ' && {{bin/php}} {{bin/typo3cms}} extension:list --raw | grep -q "^warming"', ['no_throw' => true]);
+ if ($extensionCheck === '') {
+ throw new \Exception('EXT:typo3-warming extension is required for cache warmup but not found.');
+ }
+ runExtended('cd ' . $activeDir . ' && {{bin/php}} {{bin/typo3cms}} warming:cachewarmup -s ' . $siteConfig);📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| runExtended('cd ' . $activeDir . ' && {{bin/php}} {{bin/typo3cms}} warming:cachewarmup -s ' . $siteConfig); | |
| // Check if typo3-warming extension is available | |
| $extensionCheck = runExtended( | |
| 'cd ' . $activeDir . ' && {{bin/php}} {{bin/typo3cms}} extension:list --raw | grep -q "^warming"', | |
| ['no_throw' => true] | |
| ); | |
| if ($extensionCheck === '') { | |
| throw new \Exception( | |
| 'EXT:typo3-warming extension is required for cache warmup but not found.' | |
| ); | |
| } | |
| runExtended( | |
| 'cd ' . $activeDir . ' && {{bin/php}} {{bin/typo3cms}} warming:cachewarmup -s ' . $siteConfig | |
| ); |
🤖 Prompt for AI Agents
In deployer/typo3/task/cache_warmup.php at line 11, add a validation step before
running the warming:cachewarmup command to check if the EXT:typo3-warming
extension is installed and active. Implement a conditional check that verifies
the presence of this extension and only proceeds with the command execution if
the extension is available; otherwise, log an appropriate warning or error
message and skip the command to prevent failures.
| get('deploy_path') . '/current'; | ||
| runExtended('cd ' . $activeDir . ' && {{bin/php}} {{bin/typo3cms}} warming:cachewarmup -s ' . $siteConfig); | ||
| }); | ||
| before('cache:warmup', 'feature:init'); |
There was a problem hiding this comment.
Fix the hook direction - this runs feature:init before cache:warmup, not after.
The current hook before('cache:warmup', 'feature:init') means "run feature:init before cache:warmup", but according to the AI summary, cache:warmup should run before feature:init.
-before('cache:warmup', 'feature:init');
+before('feature:init', 'cache:warmup');🤖 Prompt for AI Agents
In deployer/typo3/task/cache_warmup.php at line 13, the hook direction is
reversed; currently, feature:init runs before cache:warmup, but cache:warmup
should run before feature:init. Replace the before() call with
after('feature:init', 'cache:warmup') or adjust the hook so that cache:warmup
executes prior to feature:init as intended.
| > [!NOTE] | ||
| > This is just a simple curl request for the public URL configuration of the deployer host. | ||
| ```bash | ||
| dep cache:warmup | ||
| ``` | ||
|
|
||
| > [!NOTE] | ||
| > This is using the [EXT:typo3-warming](https://github.com/eliashaeussler/typo3-warming) extension to warm up the cache. | ||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify the distinction between cache warmup commands.
The documentation appears to have an inconsistency. The first note mentions "deploy:cache:warmup" but shows the command "dep cache:warmup". Based on the relevant code snippets from deployer/typo3/task/deploy_cache.php, there are two different approaches:
deploy:cache:warmup- performs curl requests to public URLscache:warmup- uses the TYPO3 CLI command with the warming extension
Please ensure the documentation clearly distinguishes between these two commands and their respective functionality.
> [!NOTE]
-> This is just a simple curl request for the public URL configuration of the deployer host.
+> The `deploy:cache:warmup` command performs simple curl requests to the public URL configuration of the deployer host.
```bash
-dep cache:warmup
+dep deploy:cache:warmupNote
-> This is using the EXT:typo3-warming extension to warm up the cache.
+> The cache:warmup command uses the EXT:typo3-warming extension to warm up the cache via CLI.
+bash +dep cache:warmup +
<details>
<summary>🤖 Prompt for AI Agents</summary>
In docs/TYPO3.md around lines 50 to 59, the documentation mixes up two different
cache warmup commands. Update the first note to correctly reference the "dep
deploy:cache:warmup" command that performs curl requests to public URLs, and
then clearly separate the second note to explain that the "dep cache:warmup"
command uses the TYPO3 CLI with the EXT:typo3-warming extension. Add the
appropriate command snippets under each note to reflect their distinct
functionality.
</details>
<!-- fingerprinting:phantom:poseidon:panther -->
<!-- This is an auto-generated comment by CodeRabbit -->
Summary by CodeRabbit
New Features
Documentation