Sulu Media Extra Bundle Laravel Package

Technical Evaluation

Architecture Fit

• Sulu CMS Alignment: The bundle remains tightly coupled with Sulu CMS, now validated against Sulu 3.0 and 3.1. It continues to leverage Sulu’s media handling system (MediaCropModifiedEvent, me_format_options), preserving native integration with crops, formats, and storage workflows.
• Symfony Compatibility: Now supports Symfony 7.x and Symfony 8.1 (per release notes). This is a meaningful widening of the compatibility matrix — but note that Symfony 8.1 is ahead of the widely deployed 7.x line, suggesting the bundle is tracking upstream pre-releases or is being tested against forward branches. Verify against your locked Symfony version.
• Modular Design: Unchanged. Event subscribers, commands, and services remain decoupled, enabling selective adoption.

Integration Feasibility

• Low Friction: Zero-configuration setup persists. Composer install + bundle registration in bundles.php remains the only required step.
• Event-Driven: @2x crop sync still works via MediaCropModifiedEvent — no invasive changes.
• CLI Tools: Commands (generate, duplicate, rename) are unchanged and remain self-contained, suitable for post-deployment execution.
• New Consideration: Because the bundle now declares support across a wider framework range, Composer will resolve a version matched to your stack. Confirm your composer.lock pins the correct branch on first install/upgrade to avoid silently jumping across supported Symfony majors.

Technical Risk

• Sulu Version Lock (Softened): Previously flagged as a hard ~3.0 dependency. With 1.1.0, Sulu 3.1 is now explicitly supported, which reduces the risk of minor-version drift blocking upgrades within the 3.x line. Sulu 4.x remains untested/unsupported and continues to be a future breakpoint.
• Symfony 8.1 Baseline (New): Symfony 8.x requires a newer PHP floor than Symfony 7.x. If Symfony 8.1 compatibility means the bundle’s composer.json allows Symfony 8, your project’s PHP runtime, extensions, and transitive dependencies must satisfy that baseline. This is the main new integration risk and should be validated before merge.
• Storage Assumptions: Unchanged — rename command assumes filesystem storage; cloud adapters (S3, etc.) still require customization.
• XML/YAML Parsing: Unchanged — image-formats.xml generation still relies on strict schemas.
• Dry-Run Limitations: Unchanged — rename --dry-run remains read-only; locale edge cases still require manual verification.

Key Questions

1. Compatibility Matrix: Does 1.1.0 add Symfony 8.1 / Sulu 3.1 support (additive) or require it (breaking)? Confirm whether Symfony 7.x and Sulu 3.0 remain supported on this branch.
2. PHP Baseline: What PHP floor does the Symfony 8.1 path imply? Verify your runtime (PHP version, extensions, OPcache) meets it.
3. Upgrade Path: Are there any deprecations, config changes, or service signature changes introduced in 1.1.0? Review CHANGELOG and diff before upgrading.
4. Storage Backend: Is media stored locally or via a custom adapter? If custom, confirm rename behavior on the new baseline.
5. Format Management: Will this bundle replace or augment existing image-formats.xml and crop settings?
6. Performance: Any per-event overhead changes in 1.1.0? Benchmark crop-sync latency on a representative sample.
7. Backup Strategy: rename still mutates storage + database — confirm backups are in place for rollback.
8. Localization: Are filenames locale-sensitive? Confirm --locale behavior.
9. Testing Coverage: Does the 1.1.0 release include CI matrices for the new Symfony/Sulu versions, or is compatibility declared without regression coverage?

Integration Approach

Stack Fit

• PHP 8.2+ / Symfony 7.x–8.1 / Sulu 3.0–3.1: Widened fit — aligns with both current and forward-looking stacks. Confirm your environment satisfies the Symfony 8.1 baseline if you exercise that path; otherwise stay on Symfony 7.x.
• Event-Driven Extensions: Unchanged — @2x crop sync integrates via Symfony events.
• CLI-First Tools: Unchanged — commands remain idempotent and CI/CD-friendly.

Migration Path

1. Pre-Integration:
   • Diff composer.json and CHANGELOG between the previously assessed version and 1.1.0.
   • Confirm whether your project is on the Symfony 7.x or 8.x track; ensure your runtime meets the appropriate PHP floor.
   • Audit image-formats.xml and crop settings; back up media storage and the me_format_options table.
2. Upgrade (existing installs):
   • Bump the bundle in composer.json; run composer update alengo/media-bundle.
   • Re-run bin/console cache:clear and bin/console debug:container to confirm services register cleanly on the new framework version.
3. Installation (fresh):
   • Add to composer.json and register the bundle in bundles.php.
   • Stage against a media subset before production.
4. Data Migration:
   • Run alengo:media:image-format-options:duplicate to backfill existing @2x crops (unchanged).
   • Generate/update image-formats.xml via alengo:media:image-formats:generate.
5. Validation:
   • Verify @2x crop sync via the event subscriber on the new Symfony/Sulu combination.
   • Test rename command in staging; re-check locale behavior on the new baseline.

Compatibility

• Existing Media: No breaking change to stored data anticipated. Confirm no schema migration was introduced in 1.1.0.
• Custom Media Handlers: Still override bundle services (e.g., media.rename.handler) as needed.
• Third-Party Bundles: Re-test alongside sulu/media-bundle and any custom media extensions, particularly on Symfony 8.1 (transitive dependency friction is the most likely failure point).
• Cross-Version Support: If your fleet runs mixed Symfony versions, confirm the bundle supports resolving both Symfony 7.x and 8.x from the same major (or plan to pin per environment).

Sequencing

Operational Impact

Maintenance

• Low Overhead (unchanged): No new runtime dependencies beyond Sulu/Symfony. Updates continue to track Sulu’s release cadence — and now Symfony’s too.
• Configuration: Unchanged — only image-formats.yaml requires manual updates for new formats.
• Logging: Still no built-in logging. Add monolog handlers for crop-sync events, command execution, and rename operations.

Support

• Debugging:
  • @2x sync issues: Inspect MediaCropModifiedEvent listeners and me_format_options.
  • Rename failures: Verify storage permissions and subVersion increments.
  • Format generation: Validate YAML schema and XML output.
  • New: Symfony 8.1-specific errors — check deprecation warnings and service-container compilation on the new framework line.
• Documentation: Update internal runbooks to note the new supported version matrix and any Symfony 8.1 migration notes.
• Vendor Support: Still community-only; activity remains limited.

Scaling

• Performance: Unchanged in principle — @2x crop sync is minimal if crops are infrequent; rename is I/O-bound; format generation is CPU-light. Re-benchmark on Symfony 8.1 if you upgrade the framework, since event dispatch cost can shift between majors.
• Horizontal Scaling: No distributed locks or race conditions identified. Safe for multi-server setups.

Failure Modes

Ramp-Up

• Developer Onboarding:
  • 1 hour: Install and test basic features (crop sync, format generation).
  • 2 hours: Understand event listeners and service overrides for customization.
  • +30 mins (new): Review the compatibility matrix and confirm which Symfony/Sulu versions your install supports.
• Content Editor Training:
  • 30 mins: Explain @2x crop consistency benefits.
  • 1 hour: Demo rename command (dry-run first).
• DevOps:
  • 1 hour: Add logging and monitoring for commands.
  • 2 hours: Document backup/restore procedures for rename operations.
  • +1 hour (new): Verify runtime baselines (PHP, extensions) for the Symfony 8.1 path if adopted.