Skip to content

Python: FileSessionStore.set fails on Windows for long session IDs because its temp file name is 38 characters longer than the snapshot #9682

Open

Description

FileSessionStore.set() writes each snapshot through a sibling temp file named .<snapshot name>.<uuid hex>.tmp, which is 38 characters longer than the snapshot file. On Windows with long paths disabled (the default, LongPathsEnabled = 0), a session ID at MAX_SESSION_ID_LENGTH (128) whose snapshot path fits under the 260-character limit can still fail to save, because the temp path does not fit.

This shows up as a failing unit test on my Windows 11 machine: tests/core/test_sessions.py::TestFileSessionStore::test_opaque_session_id_round_trips_through_safe_filename[xxx...x-False] fails with FileNotFoundError on the .tmp path. CI on windows-latest passes, I believe because GitHub's Windows runners enable long paths.

Minimal repro (Windows, long paths off, agent-framework-core at 67ba500):

import asyncio, tempfile
from pathlib import Path
from agent_framework import AgentSession, FileSessionStore

async def main():
    base = Path(tempfile.mkdtemp())
    sid = "x" * FileSessionStore.MAX_SESSION_ID_LENGTH
    storage = base / ("d" * (240 - (len(str(base)) + 1 + len(sid) + 5) - 1))
    store = FileSessionStore(storage)
    print(len(str(store._session_file_path(sid))))  # 240: the snapshot path itself fits
    await store.set(sid, AgentSession(session_id="s"))  # FileNotFoundError on the .tmp path

asyncio.run(main())

Expected: the session saves, since its snapshot path is under the limit. Actual: FileNotFoundError: [Errno 2] No such file or directory: '...\.xxx...x.json.<uuid>.tmp'.

Environment: Windows 11, Python 3.11.9, agent-framework-core 1.23.0 from main.

Proposed fix: name the temp file .maf-session-<uuid hex>.tmp, independent of the session ID, the way FileCheckpointStorage (.maf-ckpt-<uuid>.tmp) and _filesystem._atomic_write_text (.maf-state-<uuid>.tmp) already do, plus a regression test that checks the temp name does not grow with the ID. I have this ready and would like to open the PR if the direction is fine.

AI assistance: an AI coding assistant helped find the cause and draft this issue; the failing test and the repro above were run on my Windows 11 machine.

Metadata

Metadata

Labels

pythonUsage: [Issues, PRs], Target: Pythonready-for-implementationMaintainers agree the problem and direction are ready for implementation.

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions