Skip to content

Validate UUIDField values when a queryset is filtered, not when it runs #425

Open

Description

@rtibbles

❌ This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.

Overview

morango's UUIDField checks values only in get_db_prep_value, which runs when a queryset executes. Django's fields check values in get_prep_value, which runs when .filter() is called, so callers that wrap .filter() in try (Django forms, django-filter, DRF's get_object_or_404) never see morango's error. Kolibri's API returns a 500 for malformed ids in many places because of this.

Complexity: Low
Target branch: release-v0.9.x

Context

In morango/models/fields/uuids.py:

  • Model.objects.filter(id="abc") succeeds. Evaluating it raises ValueError: badly formed hexadecimal UUID string.
  • Model.objects.filter(id=5) or filter(id={"a": 1}) raises KeyError: 'invalid' on evaluation, because get_db_prep_value reads self.error_messages["invalid"], which CharField doesn't define.

Django's own UUIDField.get_prep_value calls to_python, which raises django.core.exceptions.ValidationError with code invalid.

The Change

  • morango's UUIDField should reject a malformed value when the lookup is built, raising django.core.exceptions.ValidationError with code invalid, as Django's UUIDField does.
  • Values the field accepts today (32-char hex, dashed UUID strings, uuid.UUID instances) keep working and keep being stored as 32-char hex.

Acceptance Criteria

  • filter(id="abc") raises ValidationError with code invalid when .filter() is called.
  • filter(id=5), filter(id={"a": 1}) and filter(id=["a"]) raise the same ValidationError, not KeyError or TypeError.
  • filter(id__in=["abc"]) raises the same ValidationError.
  • Hex, dashed and uuid.UUID values filter and save as before.
  • Released in a 0.9.x release.

AI usage

I had Claude Code sweep Kolibri's API code for unvalidated request input and trace the malformed-id 500s to this field. I chose the fix. Claude Code drafted the issue. Kolibri tracking issue: learningequality/kolibri#15838.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions