Return 4xx instead of 500 for malformed API requests
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
调研方向
This umbrella issue covers malformed input across DRF viewsets, /api/sync/, plain Django views, kolibri_public, and search; it names shared patterns and regression tests but leaves the individual root causes to sub-issues. Start by checking whether a scoped sub-issue exists, then read its cited view or serializer and reproduce the malformed request in a regression test. Done means that input returns an appropriate 400 or 404, with a test covering it; the issue says contributions are not open here.
由索引模型根据 Issue 内容生成。
描述
❌ This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.
Overview
Studio's API returns HTTP 500 for many malformed requests: a body with the wrong JSON shape, a query parameter of the wrong type, a value out of range, or a malformed id. In every case the request is the client's error and should get a 400 or 404 that says what is wrong. An audit of every endpoint found the remaining cases and grouped them by root cause. Each sub-issue fixes one root cause wherever it occurs, using the validation pattern set out below.
Scope
- Included: validation of request input (body, query params, URL kwargs) across DRF viewsets,
/api/sync/, plain Django views, and the publickolibri_publicandsearchAPIs. - Included: sync change handlers that error on malformed changes instead of returning a validation error for that change.
- Excluded: the
/api/internal/*endpoints used by ricecooker, which are to be deprecated and removed in favour of the sync endpoint. - Excluded: permission checks and data-integrity bugs, which have their own issues.
Guidance
- Target
hotfixes. - Each fix needs a regression test that sends the malformed input and asserts the 4xx. In tests, the DRF test client re-raises view exceptions, so the current behaviour shows up as an exception rather than a 500 status.
Strategy
- Every request body is validated by a DRF serializer with
is_valid(raise_exception=True). Plain Django views that parserequest.bodybecome DRF@api_viewviews. - Every query parameter is a typed django-filter filter on the viewset's FilterSet, such as
UUIDFilter/UUIDInFilterfromcontentcuration/contentcuration/viewsets/common.py,NumberFilter,BooleanFilterorChoiceFilter. ACharFilterwhose value is parsed by hand doesn't count. - Serializer fields carry the model's limits (
max_length, min/max value, choices), so a value that passes validation also saves to the database. - One custom DRF
EXCEPTION_HANDLERmaps DjangoValidationErrorto 400 andObjectDoesNotExistto 404, as a backstop. - Studio's
ValuesViewset(contentcuration/contentcuration/viewsets/base.py) is an older copy of Kolibri'skolibri/core/api.py. Fixes there follow Kolibri's shape.
AI usage
I scoped the audit, excluded the internal endpoints, and chose the validation strategy. Claude Code audited every endpoint, reproduced each finding with a temporary test, grouped the findings by root cause, and drafted this issue.
- 主要语言
- Python
- 星标
- 212
- 派生
- 321
- 平均合并
- 1 天 7 小时
- 30 天内合并 PR
- 14
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
learningequality/studio 的其他 Issue
-
Community library status changes don't update `date_updated`可能已有人在做 @ArpitaSamanta10 今天认领。 未关闭community-contribution-in-progress DEV: backend good first issue help wanted
难度 2/5 1-3 小时 新手友好度 84/100
learningequality/studio#6414 · 8 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
DEV: backend
难度 2/5 1-3 小时 新手友好度 82/100
learningequality/studio#6410 ·
维护者通常 1 天内回复
-
DEV: backend
难度 2/5 1-3 小时 新手友好度 76/100
learningequality/studio#6409 ·
维护者通常 1 天内回复
-
DEV: backend
难度 2/5 1-3 小时 新手友好度 78/100
learningequality/studio#6407 ·
维护者通常 1 天内回复
-
Stripe webhook accepts events when no webhook secret is configured可能已有人在做 @adibmbrk 今天认领。 未关闭community-contribution-in-progress DEV: backend good first issue help wanted
难度 2/5 1-3 小时 新手友好度 78/100
learningequality/studio#6404 · 3 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 learningequality/studio 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 77/100
canonical/paas-charm#407 · 1 条评论 ·
维护者通常 5 天内回复
-
bug
难度 1/5 1 小时以内 新手友好度 90/100
FAIRmat-NFDI/pynxtools-spm#136 ·
维护者通常 1 天内回复
-
enhancement tooling
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
`read_nexus` entry point points to a function that no longer exists可能已有人在做 @RubelMozumder 今天认领。 未关闭annotator bug
难度 1/5 1 小时以内 新手友好度 88/100
FAIRmat-NFDI/pynxtools#876 · 1 条评论 ·
维护者通常 1 天内回复
-
[Bug]: HTTP 499 (Client Closed Request) is classified as a non-retryable format_error, so a mid-flight abort fails the turn over instead of retrying可能已有人在做 @yipinghuang1991 今天认领。 未关闭comp/agent P2 type/bug
难度 2/5 1-3 小时 新手友好度 82/100
NousResearch/hermes-agent#156837 ·
维护者通常 1 天内回复