Django exceptions reach DRF as 500

オープン
#6,391 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
django, python

調査の方向性

Start with contentcuration/contentcuration/viewsets/base.py and the serialize_object behavior linked in the issue, then read the related DRF views and the exception handler strategy in #6387. Add regression tests for each input listed in Context and verify malformed detail-route pks return 404, invalid parameters and submission states return 400, and Django ObjectDoesNotExist returns 404.

索引モデルが issue の本文から書いたものです。

説明

DEV: backend

Overview

Some code raises Django's ValidationError, ObjectDoesNotExist or FieldError inside DRF views. DRF converts only its own exceptions, Http404 and PermissionDenied, so these return 500. BaseValuesViewset.serialize_object also crashes on some malformed pks before it can return its 404.

Complexity: Medium
Target branch: hotfixes

Context

All inputs below were reproduced:

  • BaseValuesViewset.serialize_object:
    • On a model with an integer pk, GET /api/assessmentitem/abc raises UnboundLocalError, because .filter() fails before queryset is assigned. Kolibri fixed this in learningequality/kolibri@eeb4c8207e.
    • On SavedSearch, whose pk is a Django UUIDField, GET /api/search/saved-search/abc raises Django ValidationError, which isn't in the caught tuple.
    • Affected detail routes: assessmentitem, user, admin-users, bookmark, channeluser, communitylibrary_submission, admin_communitylibrary_submission, saved-search.
  • ChannelUserViewSet: GET /api/channeluser/<id> without ?channel= raises FieldError: Cannot resolve keyword 'can_edit'. can_edit and can_view exist only once the channel filter has annotated them.
  • ContentNodeTreeViewset.validate_and_return_params: depth=3, depth=abc, next__gt=-1 and next__gt=abc raise Django ValidationError on the anonymous public tree endpoint. Kolibri has the same code (learningequality/kolibri#15835).
  • resolve calls CommunityLibrarySubmission.save, which raises Django ValidationError when the author is no longer a channel editor or the channel has since become public.
The Change
  • serialize_object should follow Kolibri's fix and also treat Django ValidationError as not found.
  • channeluser retrieve without ?channel= should respond as the list route does. Each other site should return 400 instead of 500.
  • The custom EXCEPTION_HANDLER from the strategy in #6387 lands in this issue.
Acceptance Criteria
General
  • Each detail route listed in Context returns 404 for a malformed pk.
  • channeluser retrieve without ?channel= gets the same response as the list route without ?channel=.
  • Invalid depth and next__gt values return 400.
  • resolve returns 400 with the validation message for the two submission states in Context.
  • Django ValidationError raised in any DRF view returns 400, and ObjectDoesNotExist returns 404.
Testing
  • Each input in Context has a regression test.

AI usage

I scoped the audit and chose the validation strategy in #6387. Claude Code found and reproduced these failures and drafted this issue.

主要言語
Python
スター
212
フォーク
321
平均マージ
1日 7時間
マージ済み PR(30日)
14

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

learningequality/studio のほかの issue

learningequality/studio の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。