Mailer refactoring #2993
Merged
Mailer refactoring #2993
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This makes it easier to rename methods and translation keys.
Rails doesn't escape text in text/plain outputs, since before Rails 4. See rails/rails#8235
I spent some time working on an alternative translation strategy, without realising some of the plain text implications.
Use the _html suffix to mark that we expect the translations to contain links. Unfortunately, we can't use the _html keys for the plain text emails, since the input options (e.g. username, url) will be html-escaped, before it is passed to the view. So we need to use non-html-suffix keys for the plaintext views, in most cases. Only when the translation options (e.g. url) are guaranteed to not contain any escapable characters can the same translation key be shared.
|
There seems to be a small regression here. Since 06 December, when I get emails through the web site, the initial text ("so-and-so has sent you a message through OpenStreetMap") is HTML escaped, so that the anchor/link around the user name now appears in all its a target="_blank" rel="noopener" style="text-decoration: none; color: #222" glory directly in the message text! |
argh, I'll look into this. |
This was referenced Dec 8, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR contains some translation-related refactoring for the user_mailer.
It took me two attempts to get this right, since there's some subtleties about how the
_htmltranslations interact with plain text mail templates, and so I had to revisit and refactor some (unsubmitted) work that was done last week when I realised what was going on. But I've added a test that would have caught my mistake earlier.In short,
_htmltranslations take the translation options (e.g. something liket(".foo", :username => "Jack & Jill"), html_escapes the options, interpolates them into the translation, and returns the whole thing as a SafeBuffer to avoid further html_escaping in the template. Putting that straight into an html template is fine, since it a) is already a safebuffer and b) is already escaped. But for plain text templates, we don't want any html_escaping of the input options, so we have to avoid using_htmltranslation keys. Hence the duplication between the_htmland non-_htmlkeys.