vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-09 17:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/api/get_work_dir_files.py.dox.md
Alessandro ffddc3ebcb Promote Files into shared canvas surface 
Add Files to the universal canvas rail and sidebar flow, with a reusable floating surface modal chrome that matches Browser/Desktop behavior.

Make the File Browser modal draggable/resizable with Focus mode, keep Editor on the same draggable modal helper, and preserve dock/undock handoff state.

Harden File Browser startup so empty paths resolve to the default workdir, restyle the Up control, compact New file/New folder actions, and hide Modified before Name/Size in narrow containers.

Update DOX contracts and focused regression coverage for the new Files surface, modal chrome, default-path fallback, and compact layout behavior.
2026-06-23 11:19:58 +02:00

2.2 KiB
Raw Permalink Blame History

get_work_dir_files.py DOX

Purpose

  • Own the get_work_dir_files.py API endpoint.
  • This module handles workdir file operations for get work dir files.
  • Keep this file-level DOX profile synchronized with get_work_dir_files.py because this directory is intentionally flat.

Ownership

  • get_work_dir_files.py owns the runtime implementation.
  • get_work_dir_files.py.dox.md owns durable notes about responsibilities, contracts, side effects, and verification for that implementation.
  • Classes:
  • GetWorkDirFiles (ApiHandler)
    • get_methods(cls)
    • async process(self, input: dict, request: Request) -> dict | Response
  • Top-level functions:
  • async get_files(path)

Runtime Contracts

  • HTTP handlers must derive from helpers.api.ApiHandler; WebSocket handlers must derive from helpers.ws.WsHandler.
  • Update this file whenever request payloads, authentication or CSRF requirements, response shapes, route side effects, or WebSocket event contracts change.
  • GetWorkDirFiles is an ApiHandler.
  • GetWorkDirFiles defines process(...).
  • GetWorkDirFiles defines get_methods(...).
  • Imported dependency areas include: helpers, helpers.api, helpers.file_browser.

Key Concepts

  • Important called helpers/classes observed in the source: FileBrowser, browser.get_files, runtime.call_development_function.
  • Empty path requests and explicit $WORK_DIR requests resolve to the default workdir path before FileBrowser is called, so the WebUI never receives an empty startup path for the default file browser view.
  • Keep request/response, tool, or helper semantics documented here at the same time as source changes.

Work Guidance

  • Preserve authentication, CSRF, loopback, and API-key checks unless the endpoint contract explicitly changes.
  • Update frontend callers, plugin callers, and tests together when payload shape changes.
  • Use helpers.api.Response for non-JSON responses, files, redirects, or status-specific replies.

Verification

  • Run endpoint-specific or API/WebSocket tests for changed behavior; smoke-test browser callers when no focused test exists.
  • No direct test reference was found by name search; choose the nearest behavioral test or perform a focused smoke check.

Child DOX Index

No child DOX files.