User:YvanZo/Draft/MusicBrainz Email Renderer

From MusicBrainz Wiki
< User:YvanZo
Revision as of 18:00, 29 November 2023 by YvanZo (talk | contribs) (→‎MJML email renderer: Don't forget the text/plain part)
Jump to navigationJump to search

MJML email renderer

Proposed mentors: bitmap, reosarevok, yvanzo
Languages/skills: React.js, Rust
Forum for discussion
Estimated Project Length: TBD hours
Difficulty: TBD

MusicBrainz Server can send emails to users in different occasions: email verification, edit notes, subscription edits, autoeditor election… So far these emails are generated in text only format using Template Toolkit which has had its day.

A modern replacement can be MJML through either the React.js wrapper mjml-react or the Rust reimplementation MRML. The first option would allow to reuse some components from the website frontend which has been mostly converted to React (jira:MBS-8609), while the second option would be blazing fast (170× faster than the original Node.js implementation) but would require much work for components.

However a multipart email (text/HTML + text/plain) is still wanted here, while MJML is focused on generating HTML only. So the plain text alternative part should probably be generated using a tool like html2text.