JhumanJ / OpnForm

Beautiful Open-Source Form Builder
https://opnform.com
GNU Affero General Public License v3.0
2.26k stars 303 forks source link

fix email from address in self hosted mode #573

Closed madassdev closed 2 months ago

madassdev commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve modifications to the getFromEmail method in two classes: SubmissionConfirmationMail and FormSubmissionNotification. Both classes now include a conditional check that returns a configured email address when the application is self-hosted. If not self-hosted, the original behavior of generating a unique email address with a timestamp is retained. This update enhances the flexibility of email address handling based on the application's hosting configuration.

Changes

File Change Summary
api/app/Mail/Forms/SubmissionConfirmationMail.php
api/app/Notifications/Forms/FormSubmissionNotification.php
Introduced conditional logic in getFromEmail method to return a configured email address if the application is self-hosted; otherwise, it generates a unique email address with a timestamp.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant MailService

    User->>App: Submit Form
    App->>MailService: Call getFromEmail()
    alt Self-hosted
        MailService-->>App: Return configured email address
    else Not self-hosted
        MailService-->>App: Generate unique email address with timestamp
    end
    App-->>User: Send Confirmation Email

Poem

🐰 In the garden where emails bloom,
A change has come to lift the gloom.
If self-hosted, a steady name,
If not, a timestamp adds some fame.
Hooray for flexibility, we cheer,
With every message, joy draws near! 🌼


Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 2c70ed090e0c48ec1563537f262fdaa72b723de3 and cd1c13bf5c78bc8c11325e10c8574ac2e5d5c062.
Files selected for processing (2) * api/app/Mail/Forms/SubmissionConfirmationMail.php (1 hunks) * api/app/Notifications/Forms/FormSubmissionNotification.php (1 hunks)
Additional comments not posted (2)
api/app/Mail/Forms/SubmissionConfirmationMail.php (1)
`57-60`: **LGTM!** The changes to the `getFromEmail` method look good. The conditional check for self-hosted deployments allows the application to use a different email address configured in the application settings. This enhances the flexibility of the method and does not introduce any breaking changes or side effects.
api/app/Notifications/Forms/FormSubmissionNotification.php (1)
`66-68`: **LGTM!** The changes align with the PR objective to fix the email from address in self-hosted mode. Using the configured mail from address in self-hosted mode ensures that the emails have a consistent from address, while generating a unique from address in non-self-hosted mode helps with email deliverability and tracking.
--- 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 , please review it.` -- `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 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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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.