Skip to content

fix: missing null and presence checks#7965

Open
YheChen wants to merge 9 commits into
MarkUsProject:masterfrom
YheChen:fix/missing-null-and-presence-checks
Open

fix: missing null and presence checks#7965
YheChen wants to merge 9 commits into
MarkUsProject:masterfrom
YheChen:fix/missing-null-and-presence-checks

Conversation

@YheChen
Copy link
Copy Markdown
Contributor

@YheChen YheChen commented May 27, 2026

Proposed Changes

*(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)*Address the active_record_doctor missing_non_null_constraint and missing_presence_validation checks:

active_record_doctor's missing_non_null_constraint and missing_presence_validation
checks flagged a number of columns where the database schema and the model-level
expectations had drifted apart — columns the models treat as required but that the
database still allowed to be NULL, and vice versa. This PR closes those gaps and fixes
the bugs that the new constraints surfaced.

Schema and model changes:

  • Added a migration setting NOT NULL on columns the models already treat as required
    (timestamps, belongs_to foreign keys, presence-validated columns).
  • Added presence/inclusion/exclusion validators to models for NOT NULL columns that
    lacked them. Booleans use inclusion: [true, false]; columns defaulting to "" / {}
    use exclusion: [nil].
  • Marked Annotation/AnnotationText belongs_to :creator as optional, since the
    column is nullified when a Role is destroyed.

Bugs surfaced by the new constraints:

  • Group creation flows were saving group_name as NULL before renaming.
  • Criterion/GradeEntryStudent#randomly_assign_tas inserted rows with a null ta_id
    when given no TAs.
  • SplitPdfJob now sets split_pdf_log_id when upserting SplitPage rows, which the
    new NOT NULL constraint requires.
Screenshots of your changes (if applicable)
Associated documentation repository pull request (if applicable)

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue) X
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration) X

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have updated the project Changelog (this is required for all changes).
  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

YheChen added 2 commits May 26, 2026 23:41
…ve_record_doctor

Address the active_record_doctor missing_non_null_constraint and
missing_presence_validation checks:

- Add a migration setting NOT NULL on columns the models already treat
  as required (timestamps, belongs_to foreign keys, presence-validated
  columns).
- Add presence/inclusion/exclusion validators to models for NOT NULL
  columns that lacked them. Booleans use inclusion: [true, false] and
  columns defaulting to "" / {} use exclusion: [nil].
- Mark Annotation/AnnotationText belongs_to :creator as optional, since
  the column is nullified when a Role is destroyed.

Fix bugs surfaced by the new constraints:
- Group creation flows were saving group_name as NULL before renaming.
- Criterion/GradeEntryStudent randomly_assign_tas inserted rows with a
  null ta_id when given no TAs.
@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented May 27, 2026

Coverage Report for CI Build 26619086277

Coverage increased (+0.002%) to 90.279%

Details

  • Coverage increased (+0.002%) from the base build.
  • Patch coverage: 61 of 61 lines across 32 files are fully covered (100%).
  • 5 coverage regressions across 1 file.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

5 previously-covered lines in 1 file lost coverage.

File Lines Losing Coverage Coverage
app/controllers/grade_entry_forms_controller.rb 5 79.87%

Coverage Stats

Coverage Status
Relevant Lines: 49945
Covered Lines: 46061
Line Coverage: 92.22%
Relevant Branches: 2151
Covered Branches: 971
Branch Coverage: 45.14%
Branches in Coverage %: Yes
Coverage Strength: 121.68 hits per line

💛 - Coveralls

@YheChen YheChen changed the title WIP: fix: missing null and presence checks fix: missing null and presence checks May 28, 2026
@YheChen YheChen requested a review from david-yz-liu May 28, 2026 01:54
Copy link
Copy Markdown
Collaborator

@david-yz-liu david-yz-liu left a comment

Choose a reason for hiding this comment

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

Hi @YheChen, thanks for making this PR. Overall things look good and I appreciate the bugs you fixed. Two general comments (in addition to the inline comment I left about the changelog):

  1. We use the annotaterb gem to automatically update the comments at the top of each model file when the database schema changes. This should be automatically triggered when you run a rails db:migrate. If that did not happen for you, please look into why that was the case and resolve.
  2. The point about the NULL groups.group_name field is a good one, but I don't want to resolve this by using a temporary name. Please revert the changes relating to group name here, as well as adding the NON NULL constraint on the group name in the database migration. We can work on this in a separate PR (I'll follow up with you on Slack about this). For now you can add to the .activedoctor config file to ignore the group name presence validation mismatch.

Comment thread spec/support/criterion.rb
Comment thread Changelog.md Outdated
- Fixed `(hidden)` assignment labeling for assignments with `visible_on` and/or `visible_until` set (#7944)

### 🔧 Internal changes
- Added `NOT NULL` constraints and presence/inclusion validators flagged by `active_record_doctor` checks `missing_non_null_constraint` and `missing_presence_validation`
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Add the PR number here

@YheChen YheChen force-pushed the fix/missing-null-and-presence-checks branch from de074f2 to f290927 Compare May 29, 2026 05:02
@YheChen YheChen requested a review from david-yz-liu May 29, 2026 20:33
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.

3 participants