Translations for Email Notifications

NikoHadouken commented 2 months ago

Description

This PR adds translations for transactional email notifications sent by rallly.

fixes #547

Checklist

Please check off all the following items with an "x" in the boxes before requesting a review.

[x] I have performed a self-review of my code
[x] My code follows the code style of this project
[ ] I have commented my code, particularly in hard-to-understand areas

Todo

[x] support translations in email content
[x] support translations in email subjects
[ ] add translations support for every email template
[ ] add translations for all supported languages

Summary by CodeRabbit

New Features
- Enhanced email templates with dynamic subject lines for various email notifications, improving contextual relevance.
- Added localization support for German and English email templates, enhancing user experience through personalized content.
- Introduced a method for generating email subjects based on provided properties, allowing for tailored communications.
Bug Fixes
- Removed dynamic tokens from email subjects to enhance security and reduce potential confusion for users.
Chores
- Updated internationalization functionality to support multiple languages seamlessly.

vercel[bot] commented 2 months ago

Someone is attempting to deploy a commit to the rallly Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes involve modifications to email templates and localization support in the application. The email subject lines have been updated or removed to enhance security and contextual relevance. Additionally, new methods for dynamically generating subject lines based on email content have been introduced. Localization has been implemented for email templates, allowing for translated content based on user preferences.

Changes

Files	Change Summary
apps/web/src/utils/auth.ts, packages/backend/trpc/routers/auth.ts, packages/backend/trpc/routers/polls.ts, packages/backend/trpc/routers/polls/participants.ts	Subject lines in various email templates have been removed or modified for clarity and security.
packages/backend/trpc/routers/polls/comments.ts, packages/emails/src/send-email.tsx, packages/emails/src/templates/_components/email-context.tsx	Added or modified dynamic subject generation methods and localization support.
packages/emails/locales/de/emails.json, packages/emails/locales/en/emails.json	New localization files for email templates have been created for German and English.
packages/emails/src/templates/*.tsx (finalized-host.tsx, finalized-participant.tsx, login.tsx, new-comment.tsx, new-participant-confirmation.tsx, new-participant.tsx, new-poll.tsx, register.tsx)	Added `getSubject` methods to various email components for dynamic subject line generation.

Assessment against linked issues

Objective	Addressed	Explanation
Support translated emails (547)	✅
Dynamic generation of subject lines (547)	✅
Maintain clarity in email communications (547)	❌	Some subject lines were removed, affecting clarity.

Poem

🐇 In fields of code where emails bloom,
A subject line brings light to gloom.
With translations bright and features new,
Our messages now sing in hues!
A hop, a jump, to clearer skies,
With every change, our joy will rise! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

NikoHadouken commented 2 months ago

It would probably better to refactor some i18next related code into the @rallly/languages package.

apps/web/src/app/i18n.ts
apps/web/src/app/i18n/settings.ts
packages/emails/src/i18n.ts

We could put the instance creation function and shared settings in there.

NikoHadouken commented 2 months ago

Is packages/emails/locales a good place for notification translation files or should we try to keep all translation files in one place? All other translations are in apps/web/public/locales so far but this is maybe not a good place for email translations because they are only needed sever-sided.

lukevella commented 2 months ago

Hey @NikoHadouken , I think you're on the right track putting the translation files in packages/emails/locales. We shouldn't mix them with the web translations because we don't want these loaded on the client application and while server rendering Next.js pages. They're only needed on specific routes - just the trpc endpoint at the moment. At the same time, we don't want to be loading the entire web app translation files when all we want is to translate the emails so having separate instances is the right way to go.

Trying to consolidate everything into @rallly/languages could work but lets focus on getting things working as is. I think you've done a great job organizing things so far. Well done!

NikoHadouken commented 2 months ago

@lukevella Good dicision. I will update the i18next part in the emails package to behave like the one in web and implement translations in the other templates next.

lukevella commented 2 months ago

I'm also, considering going through the templates and updating their content so no need to go through and update all of them. If it's working for one email I can go through and update the rest. It will be easier to source translations through Crowdin as well.

lukevella / rallly