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

Fixed faulty nil checks #2139

Merged
merged 3 commits into from
Jun 26, 2024
Merged

Fixed faulty nil checks #2139

merged 3 commits into from
Jun 26, 2024

Conversation

coder6583
Copy link
Contributor

Description

  • Fixed faulty nil checks produced by using .find instead of .find_by
  • Wrote more nil checks that redirect users to valid URLs

Motivation and Context

It prevents the website from responding with ruby errors, and redirects users to valid website and shows them their error.
Issue #2128

How Has This Been Tested?

  • grading.rb
    • Accessed /courses/:course_name/assessments/:assessment_name/score_grader_info/:id with an invalid id and made sure it redirects the user back to the assessment page
    • Accessed gradebook and made sure it shows the correct scores
  • course_user_data_controller.rb
    • Accessed /course/:course_name/course_user_data/:id with a valid id and made sure that it showed the user
    • Accessed /course/:course_name/course_user_data/:id with an invalid id and made sure that it went back to the user list with the correct error
  • courses_controller.rb
    • Ran MOSS cheat checker and made sure it works
  • groups_controller.rb
    • Created two assignments with two users, one with and one without a group. Imported the group into the one without a group
  • users_controller.rb
    • Accessed /users and checked there are users
    • Accessed /users/:id with valid user id and checked that it shows the user
    • Accessed /users/:id with an invalid user id and check that it goes back to /users
  • schedulers_controller.rb, lti_nrps_controller.rb, updateGradebook.rb
    • Could not figure out how to test them

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

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

Other issues / help required

I need some help on testing schedulers_controller.rb, lti_nrps_controller.rb, updateGradebook.rb.

Copy link
Contributor

coderabbitai bot commented Apr 1, 2024

Walkthrough

Walkthrough

The recent changes enhance error handling and user interaction in specific controller actions. Notably, methods now check for the presence of records before performing actions, providing clear error messages and redirection when records are not found. Some methods, like destroy and destroyConfirm, have been removed to simplify controllers.

Changes

File Change Summary
app/controllers/course_user_data_controller.rb Added nil checks for show, edit, and update methods; removed destroy and destroyConfirm methods.
app/controllers/assessments_controller.rb Enhanced grade method to check for @problem and @submission existence, added error handling and redirection.

Sequence Diagram(s)

Updated show method in course_user_data_controller.rb

sequenceDiagram
    participant User
    participant CourseUserDataController

    User ->> CourseUserDataController: show(params[:id])
    CourseUserDataController ->> CourseUserDataController: find_by(id: params[:id])
    alt User found
        CourseUserDataController ->> User: Render view with user
    else User not found
        CourseUserDataController ->> User: flash[:error], redirect_to users path
    end
Loading

Updated grade method in assessments_controller.rb

sequenceDiagram
    participant User
    participant AssessmentsController

    User ->> AssessmentsController: grade(params[:problem], params[:submission])
    AssessmentsController ->> AssessmentsController: find_by(id: params[:problem])
    alt Problem found
        AssessmentsController ->> AssessmentsController: find_by(id: params[:submission])
        alt Submission found
            AssessmentsController ->> User: Render grade view
        else Submission not found
            AssessmentsController ->> User: flash[:error], redirect_to an action
        end
    else Problem not found
        AssessmentsController ->> User: flash[:error], redirect_to an action
    end
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 802420f and 322e51b.

Files selected for processing (1)
  • app/controllers/assessments_controller.rb (1 hunks)
Additional comments not posted (1)
app/controllers/assessments_controller.rb (1)

458-467: Improved nil handling using find_by and redirection.

The changes to use find_by instead of find for @problem and @submission are correctly implemented. The addition of nil checks and redirections enhances robustness by preventing errors when records are not found.

However, consider adding logging for these error cases to help with debugging and maintaining records of such events.


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>.
    • 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 Configration 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.

@coder6583 coder6583 linked an issue Apr 1, 2024 that may be closed by this pull request
@coder6583 coder6583 requested review from a team and 20wildmanj and removed request for a team April 1, 2024 21:22
app/controllers/assessments_controller.rb Outdated Show resolved Hide resolved
app/controllers/assessments_controller.rb Outdated Show resolved Hide resolved
Copy link
Contributor

@20wildmanj 20wildmanj left a comment

Choose a reason for hiding this comment

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

to be honest don't know how to check scheduler either but otherwise looks good to me! If you could remove the unused code that would be good.

@coder6583 coder6583 added this pull request to the merge queue Jun 26, 2024
Merged via the queue into master with commit e10a1b6 Jun 26, 2024
5 checks passed
@coder6583 coder6583 deleted the somanarita-faulty-nil-checks branch June 26, 2024 19:48
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.

Faulty nil checks after using a find method
2 participants