Skip to content

Python: fix(devui): validate conversation metadata at the route boundary - #10361

Open
tang-ontheway wants to merge 2 commits into
microsoft:mainfrom
tang-ontheway:fix/devui-validate-conversation-metadata
Open

tang-ontheway wants to merge 2 commits into
microsoft:mainfrom
tang-ontheway:fix/devui-validate-conversation-metadata

Conversation

@tang-ontheway

Copy link
Copy Markdown

Motivation & Context

The DevUI conversation create and update routes accepted any JSON value as metadata and stored it verbatim. One such write was enough to break GET /v1/conversations for every caller until the server restarted, while single conversation reads kept working, which made the failure look random:

{"detail": "Failed to list conversations: 'NoneType' object has no attribute 'copy'"}

The crash was in list_conversations_by_metadata (_conversations.py), where conv_data.get("metadata", {}).copy() returned the stored non-map value and .copy() raised. The Conversations API contract says metadata is a map of string keys to string values, so the write should have been rejected in the first place.

Description & Review Guide

  • What are the major changes?
    • validate_conversation_metadata() is now applied at the store boundary in create_conversation() and update_conversation(). Metadata that is not a map of string keys to string values raises ConversationMetadataValidationError; an explicit None is normalized to an empty map.
    • The create and update routes map ConversationMetadataValidationError to 400, so a malformed write is a client error at the boundary instead of a stored value that breaks a later read.
    • Readers (get_conversation(), list_conversations_by_metadata()) now go through _stored_metadata(), which reports a value that is not a map as no metadata at all. This keeps conversations that were stored before the validation existed readable and keeps the list endpoint from failing on them.
  • What is the impact of these changes?
    • A write with malformed metadata is rejected with 400; the stored state stays valid, so GET /v1/conversations can no longer be taken down by one bad write.
    • A missing conversation still answers with 404, and valid metadata behaves exactly as before.
    • No public API change: the Conversation model and the request/response shapes are untouched.
  • What do you want reviewers to focus on?
    • Whether normalizing an explicit metadata: null to an empty map on update is the expected behavior, or whether it should be rejected as well.

Related Issue

Fixes #9860

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: An AI coding assistant helped locate the metadata handling path, draft the regression tests, and prepare this description. The analysis, the reproduction and the test results were verified by me against main at commit 92838b6.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

@microsoft-github-policy-service

Copy link
Copy Markdown

tang-ontheway please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The metadata validator silently coerces non-string keys, allowing distinct entries to collapse and lose data instead of enforcing the documented string-key/string-value contract.

1 open issue
What changed in this PR

This PR addresses #9860 by hardening DevUI conversation metadata handling so malformed writes cannot break conversation listing.

Changes:

  • Validates metadata at the store boundary and normalizes explicit null to an empty map.
  • Returns HTTP 400 for metadata validation errors while preserving 404 responses for missing conversations.
  • Adds defensive metadata reads and regression tests for store and route behavior.
File Description
python/​packages/​devui/​tests/​devui/​test_conversation_metadata.py Adds validation, null-normalization, legacy-read, and HTTP response tests.
python/​packages/​devui/​agent_framework_devui/​_server.py Maps metadata validation failures to HTTP 400.
python/​packages/​devui/​agent_framework_devui/​_conversations.py Adds write validation and defensive reads for stored metadata.

Review effort: Balanced

raise ConversationMetadataValidationError(
"metadata values must be strings; invalid keys: " + ", ".join(sorted(str(key) for key in invalid_values))
)
return {str(key): value for key, value in metadata.items()}

@surlymochan Nick (surlymochan) left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Verified the validation path and the route mapping: None normalizes to {}, non-map and non-string values raise ConversationMetadataValidationError, create answers 400 with the OpenAIError shape, update answers 400, and a missing conversation still answers 404. The legacy-tolerance read path (_stored_metadata dropping non-string values instead of failing) is the right call for pre-validation rows.

Three consistency questions:

  1. The two routes return different 400 shapes: create builds an OpenAIError (invalid_request_error / invalid_metadata), while update raises a plain HTTPException(400) with detail=str(e). Is that split intentional, or should update use the same OpenAIError body so clients see one error contract?
  2. Precedence: update_conversation in the store checks existence before validating metadata, so invalid metadata on a missing conversation answers 404, not 400. The test pins 404 for valid metadata on a missing id, but the invalid-metadata-plus-missing-id combination is unpinned. Is 404-first the intended precedence?
  3. Keys are coerced with str(key) rather than rejected, so a direct store caller passing non-string keys (e.g. {7: "x"}) silently gets {"7": "x"}, even though the contract says "a map of string keys to string values". Intended leniency, or should non-string keys raise like non-string values do?

Also confirmed: the update route's metadata=None clearing the map (200 + {}) matches the docstring's "explicit None is normalized to an empty map" — flagging only because clearing on None is a behaviour worth a deliberate decision, not an accident.

@tang-ontheway
tang-ontheway deployed to github-app-auth November 16, 2026 02:59 — with GitHub Actions Active
@tang-ontheway

Copy link
Copy Markdown
Author

Thanks Nick (@surlymochan) for the thorough check and Copilot for catching the key coercion! Addressed in 8673f98:

  1. Non-string keys (point 3 & Copilot review). validate_conversation_metadata now rejects non-string keys with ConversationMetadataValidationError instead of coercing them with str(key) (so {1: "first", "1": "second"} or {7: "x"} fails rather than silently collapsing/coercing). _stored_metadata still keeps the defensive str(key) tolerance for legacy pre-validation entries.
  2. 400 error shape on create_conversation vs update_conversation (point 1). Intentional consistency with the surrounding routes in _server.py: create_conversation uses OpenAIError / JSONResponse throughout its handler, whereas update_conversation (alongside list_conversations, retrieve_conversation, and delete_conversation) uses HTTPException (404/500). Happy to switch update_conversation to OpenAIError too if you'd prefer it aligned with create_conversation.
  3. 404-first precedence on update_conversation (point 2). Yes, checking conversation existence before mutating/validating is intentional so a request targeting a non-existent conversation returns 404 rather than 400.

Verified with .venv/bin/pytest packages/devui/tests/ (247 passed, 4 skipped) and .venv/bin/ruff check.

This branch was successfully deployed

1 active deployment
github-app-auth — 8673f98a Deployed Nov 16, 2026 by tang-ontheway via add_label #27898
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python: [Bug]: DevUI conversation metadata accepts non-map values and then the conversation list fails

3 participants