Refactor noreplyemail language string #76
Merged
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.
Description: This PR refactors the
noreplyemail
language string. This was done to resolve unit test failures in Totara 17:Problem
test_no_exploitable_string_helper_uses server/lib/tests/mustache_str_helper_test.php
Occurring here: https://github.com/catalyst/moodle-tool_emailutils/blob/MOODLE_39_STABLE/templates/postmaster.mustache#L41
Looks like Totara doesn't like it when language string templates/helpers are used like here:
<p>{{#str}} noreplyemail, tool_emailutils, {{ noreply }} {{/str}}</p>
They have a whitelist that can be used to skip certain files, but this would require a core hack:
Solution
Use the
code
HTML element in the Mustache template instead of the language string. This does not change the styling or structure of the template when rendered. This was tested using the template library.This PR also fixes the example context in the template by removing trailing commas and changing
vendors
tovendor
in thevendorinfo
object. This can be tested inadmin/tool/templatelibrary/index.php?component=&search=emailutils