Improve MJML Mailer Performance by Caching Compiled Templates #126
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Currently, MJML templates are compiled every time a mailer is called, which significantly slows down test execution. This can impact overall performance, especially in test suites with frequent mailer calls.
Proposed Solution
This PR introduces caching for compiled MJML templates, leveraging the fact that mailer templates typically do not change frequently. Compiled templates are now cached in
tmp/mjml_cache
, and if a template is modified, it automatically detects the change, recompiles the template, and updates the cache.How it Works:
Caveats:
Dynamic data/local variables: The dynamic data passed from your tests will not be reflected in the cached templates. To avoid this, consider:
If you have suggestions for improving these caveats or avoiding them entirely, I'd love to hear your feedback!