Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Override password reset email send when creating user if SMTP not set up #2206

Merged
merged 5 commits into from
Oct 6, 2024

Conversation

jhs-panda
Copy link
Contributor

@jhs-panda jhs-panda commented Sep 15, 2024

Description

If SMTP is not properly set up, creating a user will not send the typical password reset email. Instead, it will create the user but flash a message to the user.

Motivation and Context

With SMTP Config set up with single-sender, the password reset email does not send successfully when creating a new user. Issue #2204
In the case that SMTP is not set up successfully, a user is still created but a message is flashed that the password reset email was not successfully sent.

How Has This Been Tested?

Before:
Creating new user
Screen Shot 2024-09-15 at 2 06 51 PM

After:
Creating a user but SMTP not set up.
Screen Shot 2024-09-29 at 2 08 28 PM
Screen Shot 2024-09-29 at 2 08 45 PM

If error other than SMTP comes up, flash error message and destroy user (since already created but if unusable, no point in keeping).
Screen Shot 2024-09-29 at 2 10 04 PM

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting
  • My change requires a change to the documentation, which is located at Autolab Docs
  • I have updated the documentation accordingly, included in this PR

Other issues / help required

If unsure, feel free to submit first and we'll help you along.

Copy link
Contributor

coderabbitai bot commented Sep 15, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve modifications to the user creation process in the UsersController and User model. Specifically, the functionality that automatically sends password reset instructions to newly created users has been commented out in the instructor_create method of the User model. The create method in the UsersController has been updated to include error handling for the reset password instructions, capturing potential errors during the process and providing appropriate user feedback.

Changes

File Change Summary
app/controllers/users_controller.rb Modified the create method to include error handling when sending reset password instructions.
app/models/user.rb Commented out the call to user.send_reset_password_instructions in the instructor_create method.

Possibly related PRs

Suggested labels

Type: Bug, small


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1047d65 and 19a4659.

📒 Files selected for processing (1)
  • app/controllers/users_controller.rb (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/controllers/users_controller.rb

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@jhs-panda jhs-panda linked an issue Sep 15, 2024 that may be closed by this pull request
@20wildmanj
Copy link
Contributor

Could you change this so that instead of just commenting out the send password reset lines, there is code to catch the exception and flash the error?

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (1)
app/controllers/users_controller.rb (1)

130-132: Reconsider Destroying User on Email Failure

Destroying the user record if sending reset password instructions fails might not be ideal, especially if the user was successfully created. This could lead to inconsistent system states and poor user experience.

Consider keeping the user record and notifying an administrator or allowing the user to reset their password manually later. Here's a suggested change:

          rescue => e
            flash[:error] = "Successfully created user but encountered an error: #{e.message}"
-           @user.destroy
            redirect_to(users_path)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0aff723 and d385ce4.

📒 Files selected for processing (1)
  • app/controllers/users_controller.rb (1 hunks)

app/controllers/users_controller.rb Outdated Show resolved Hide resolved
app/controllers/users_controller.rb Outdated Show resolved Hide resolved
app/controllers/users_controller.rb Outdated Show resolved Hide resolved
@jhs-panda jhs-panda changed the title Override password reset email send when creating user Override password reset email send when creating user if SMTP not set up Sep 29, 2024
Copy link
Contributor

@KesterTan KesterTan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jhs-panda jhs-panda added this pull request to the merge queue Oct 6, 2024
Merged via the queue into master with commit fe2bbca Oct 6, 2024
6 checks passed
@jhs-panda jhs-panda deleted the override_smtp branch October 6, 2024 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to add new user in nightly
3 participants