Merged
Conversation
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
OpenAPI ChangesShow/hide ## Changes for v0.yaml:Unexpected changes? Ensure your branch is up-to-date with |
| ) | ||
| return successful_enrollments | ||
|
|
||
| return successful_enrollments[0] if successful_enrollments else None |
There was a problem hiding this comment.
Bug: The create() method returns None on enrollment failure, causing an AttributeError and a 500 error in the view layer when serializing the response.
Severity: HIGH
Suggested Fix
Instead of returning None when successful_enrollments is empty, the create() method should raise a serializers.ValidationError with an appropriate error message. This will allow the view to handle the failure gracefully and return a 400 Bad Request response.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: courses/serializers/v1/courses.py#L190
Potential issue: The `CourseRunEnrollmentSerializer.create()` method returns `None` if
the `successful_enrollments` list is empty, which can happen if an enrollment fails in
the `create_run_enrollments()` function. The `UserEnrollmentsApiViewSet` uses Django
REST Framework's `CreateModelMixin`, which expects a model instance from `create()`.
When it receives `None`, it attempts to serialize it, leading to an `AttributeError`
when accessing attributes on the `None` object. This causes the API to return a 500
error instead of a meaningful error message indicating the enrollment failure.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
cp-at-mit