feat(resource): implement ResourceHandler CRUD and discovery methods #1054

Merged

hamza.khyari merged 1 commit from feature/resource-handler-crud into master 2026-03-24 14:40:34 +00:00

Conversation 2 Commits 1 Files changed 13 +2008 -33

hamza.khyari commented 2026-03-18 11:29:50 +00:00

Member

Copy link

Summary

• Extend the ResourceHandler protocol with six new content operations: read, write, delete, list_children, diff, and discover_children
• Add frozen dataclass result types (Content, WriteResult, DeleteResult, DiffResult) to the handler protocol
• Implement all six methods for GitCheckoutHandler (via git plumbing + filesystem), FsDirectoryHandler (via pathlib/os/difflib), and partial support for DevcontainerHandler (read/write/discover via devcontainer exec)
• DatabaseResourceHandler inherits NotImplementedError stubs pending connection management
• 19 Behave scenarios + 2 Robot integration tests (read → write → diff cycle) covering all handlers

Details

Protocol Extension (protocol.py)

• Content — frozen dataclass with data: bytes, encoding, content_hash, metadata, and a .text convenience property
• WriteResult — success, bytes_written, content_hash, message
• DeleteResult — success, message
• DiffResult — has_changes, unified_diff, files_changed, insertions, deletions
• All six methods added to ResourceHandler Protocol with full Google-style docstrings

Base Handler (_base.py)

• NotImplementedError defaults for all six methods so existing handlers remain valid
• _require_location() helper extracted for DRY location validation
• _derive_child_id() helper for generating ULID-valid child resource IDs

Handler Implementations

• GitCheckoutHandler: read (git show + fs fallback), write (file write), delete (unlink + git rm --cached), list_children (git ls-tree), diff (git diff --no-index), discover_children (git ls-tree -d)
• FsDirectoryHandler: read (pathlib), write (pathlib), delete (unlink/rmtree), list_children (os.listdir), diff (difflib unified), discover_children (os.scandir)
• DevcontainerHandler: read (devcontainer exec cat), write (devcontainer exec tee), discover_children (devcontainer exec ls)

Tests

• 19 Behave scenarios: read, write, delete, list_children, diff, discover_children for FsDirectory and GitCheckout handlers, plus NotImplementedError defaults for Database handler
• 2 Robot integration tests: full read → write → diff cycle on real temp directories and git repos

ISSUES CLOSED: #827

## Summary - Extend the `ResourceHandler` protocol with six new content operations: `read`, `write`, `delete`, `list_children`, `diff`, and `discover_children` - Add frozen dataclass result types (`Content`, `WriteResult`, `DeleteResult`, `DiffResult`) to the handler protocol - Implement all six methods for `GitCheckoutHandler` (via git plumbing + filesystem), `FsDirectoryHandler` (via pathlib/os/difflib), and partial support for `DevcontainerHandler` (read/write/discover via `devcontainer exec`) - `DatabaseResourceHandler` inherits `NotImplementedError` stubs pending connection management - 19 Behave scenarios + 2 Robot integration tests (read → write → diff cycle) covering all handlers ## Details ### Protocol Extension (`protocol.py`) - `Content` — frozen dataclass with `data: bytes`, `encoding`, `content_hash`, `metadata`, and a `.text` convenience property - `WriteResult` — `success`, `bytes_written`, `content_hash`, `message` - `DeleteResult` — `success`, `message` - `DiffResult` — `has_changes`, `unified_diff`, `files_changed`, `insertions`, `deletions` - All six methods added to `ResourceHandler` Protocol with full Google-style docstrings ### Base Handler (`_base.py`) - `NotImplementedError` defaults for all six methods so existing handlers remain valid - `_require_location()` helper extracted for DRY location validation - `_derive_child_id()` helper for generating ULID-valid child resource IDs ### Handler Implementations - **GitCheckoutHandler**: `read` (git show + fs fallback), `write` (file write), `delete` (unlink + git rm --cached), `list_children` (git ls-tree), `diff` (git diff --no-index), `discover_children` (git ls-tree -d) - **FsDirectoryHandler**: `read` (pathlib), `write` (pathlib), `delete` (unlink/rmtree), `list_children` (os.listdir), `diff` (difflib unified), `discover_children` (os.scandir) - **DevcontainerHandler**: `read` (devcontainer exec cat), `write` (devcontainer exec tee), `discover_children` (devcontainer exec ls) ### Tests - 19 Behave scenarios: read, write, delete, list_children, diff, discover_children for FsDirectory and GitCheckout handlers, plus NotImplementedError defaults for Database handler - 2 Robot integration tests: full read → write → diff cycle on real temp directories and git repos ISSUES CLOSED: #827

hamza.khyari added the

Type

Bug

Type

Support

labels 2026-03-18 11:29:50 +00:00

hamza.khyari added

Bounty

$100

Priority

Medium

State

In Review

Type

Discussion

and removed

Type

Bug

Type

Support

labels 2026-03-18 11:30:05 +00:00

hamza.khyari added this to the v3.6.0 milestone 2026-03-18 11:30:19 +00:00

hamza.khyari added

Type

Feature

and removed

Type

Discussion

Bounty

$100

labels 2026-03-18 11:30:40 +00:00

hamza.khyari self-assigned this 2026-03-18 11:40:50 +00:00

hamza.khyari removed the

Priority

Medium

label 2026-03-18 11:44:19 +00:00

freemo approved these changes 2026-03-19 04:55:33 +00:00

Dismissed

freemo left a comment

Copy link

Code Review — PR #1054 feat(resource): implement ResourceHandler CRUD and discovery methods

Comprehensive implementation across the full handler hierarchy. The architecture is clean: protocol layer defines 4 frozen dataclasses + 6 method signatures, base layer provides DRY helpers and NotImplementedError defaults, and each handler implements what it can. Good design decisions:

• Content.text property with encoding-aware decode
• _derive_child_id() using SHA-256 → Crockford Base32 for ULID-compatible IDs
• GitCheckoutHandler with filesystem fallback for untracked files
• DevcontainerHandler implementing read/write/discover via devcontainer exec

19 Behave scenarios + 2 Robot integration tests provide solid coverage. The DatabaseResourceHandler correctly inherits NotImplementedError stubs pending connection management — good boundary decision.

Approved. No issues found.

## Code Review — PR #1054 `feat(resource): implement ResourceHandler CRUD and discovery methods` Comprehensive implementation across the full handler hierarchy. The architecture is clean: protocol layer defines 4 frozen dataclasses + 6 method signatures, base layer provides DRY helpers and `NotImplementedError` defaults, and each handler implements what it can. Good design decisions: - `Content.text` property with encoding-aware decode - `_derive_child_id()` using SHA-256 → Crockford Base32 for ULID-compatible IDs - `GitCheckoutHandler` with filesystem fallback for untracked files - `DevcontainerHandler` implementing read/write/discover via `devcontainer exec` 19 Behave scenarios + 2 Robot integration tests provide solid coverage. The `DatabaseResourceHandler` correctly inherits `NotImplementedError` stubs pending connection management — good boundary decision. **Approved.** No issues found.

freemo requested reviews from freemo, brent.edwards 2026-03-19 05:17:01 +00:00

freemo commented 2026-03-23 03:42:15 +00:00

Owner

Copy link

Day 43 Review — Rebase Required

This PR has merge conflicts with master and cannot be merged in its current state. This is one of 9 Hamza PRs in the resource/LSP domain (v3.5.0-v3.6.0) that all have conflicts. These PRs likely share a common dependency chain and should be rebased sequentially.

@hamza.khyari: Please rebase onto current master. If multiple PRs depend on each other, start with the base PR in the chain and work upward.

Rebase priority: HIGH — these PRs represent significant feature work that is blocked by merge conflicts. Every day they remain conflicted is a day they cannot be reviewed or merged.

**Day 43 Review — Rebase Required** This PR has merge conflicts with `master` and cannot be merged in its current state. This is one of 9 Hamza PRs in the resource/LSP domain (v3.5.0-v3.6.0) that all have conflicts. These PRs likely share a common dependency chain and should be rebased sequentially. @hamza.khyari: Please rebase onto current `master`. If multiple PRs depend on each other, start with the base PR in the chain and work upward. **Rebase priority**: HIGH — these PRs represent significant feature work that is blocked by merge conflicts. Every day they remain conflicted is a day they cannot be reviewed or merged.

hamza.khyari force-pushed feature/resource-handler-crud from 7a73033970 to 295b0aa19f 2026-03-24 12:36:34 +00:00 Compare

hamza.khyari dismissed freemo's review 2026-03-24 12:36:34 +00:00

Reason:

New commits pushed, approval review dismissed automatically according to repository settings

hamza.khyari force-pushed feature/resource-handler-crud from e7b5330a6b to 90e5bbb99c 2026-03-24 13:53:58 +00:00 Compare

hamza.khyari scheduled this pull request to auto merge when all checks succeed 2026-03-24 14:00:47 +00:00

hamza.khyari merged commit 4a5f826f77 into master 2026-03-24 14:40:34 +00:00

hamza.khyari referenced this pull request from a commit 2026-03-24 14:40:36 +00:00

Merge pull request 'feat(resource): implement ResourceHandler CRUD and discovery methods' (#1054) from feature/resource-handler-crud into master

Sign in to join this conversation.

Reviewers

No reviewers

freemo

brent.edwards

Labels

Clear labels   

auto/needs-reevaluation

Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.

  

controller-managed

Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.

  

auto/blocked-by-deps

PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.

  

auto/ci-timeout

Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.

  

auto/claimed-implementer

Currently being processed by an implementer worker.

  

auto/claimed-merge

Currently being processed by the merge driver.

  

auto/claimed-reviewer

Currently being processed by a reviewer worker.

  

auto/driver-down

Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.

  

auto/invariant-violation

Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.

  

auto/last-attempt-tier-0

In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.

  

auto/last-attempt-tier-1

In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.

  

auto/last-attempt-tier-2

In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.

  

auto/last-attempt-tier-min

In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.

  

Automation Tracking

Tracking issues used by the AI Automation system for agents to communicate and report.

  

auto/needs-conflict-resolution

Rebase conflict needs LLM conflict-resolver.

  

auto/needs-implementer

Failing CI needs implementer attention.

  

auto/postmortem

Documenting a driver incident or rollback.

  

auto/ready-to-merge

Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.

  

auto/restart-throttled

Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.

  

auto/revert

Revert PR backing out an invariant violation. Fast-tracked through the merge driver.

  

auto/sentinel

Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.

  

auto/stale-inactivity

No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.

  

auto/unstable

Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.

  

Blocked

A ticket in a blocked state and unable to complete until some other task is completed first.

  

Bounty

$100

A bounty of $100 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$1000

A bounty of $1000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$10000

A bounty of $10000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$20

A bounty of $20 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$2000

A bounty of $2000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$250

A bounty of $250 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$50

A bounty of $50 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$500

A bounty of $500 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$5000

A bounty of $5000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$750

A bounty of $750 for any open-source contributor who provides a MR that solves this issue

  

MoSCoW

Could have

Could have feature in order to satisfy the epic/legendary.

  

MoSCoW

Must have

Must have feature in order to satisfy the epic/legendary.

  

MoSCoW

Should have

Should have feature in order to satisfy the epic/legendary.

  

Needs Feedback

There are questions in the ticket that can not be completed until the project owner provides clarity.

  

Points

1

1 man-hours worth of work for an expert with no learning curve.

  

Points

13

13 man-hours worth of work for an expert with no learning curve.

  

Points

2

2 man-hours worth of work for an expert with no learning curve.

  

Points

21

21 man-hours worth of work for an expert with no learning curve.

  

Points

3

3 man-hours worth of work for an expert with no learning curve.

  

Points

34

34 man-hours worth of work for an expert with no learning curve.

  

Points

5

5 man-hours worth of work for an expert with no learning curve.

  

Points

55

55 man-hours worth of work for an expert with no learning curve.

  

Points

8

8 man-hours worth of work for an expert with no learning curve.

  

Points

88

88 man-hours worth of work for an expert with no learning curve.

  

Priority

Backlog

This ticket has backlogged priority and is not to be worked on yet

  

Priority

CI Blocker

Critical priority issue that blocks CI/CD pipeline and prevents PR merges

  

Priority

Critical

The priority is critical

  

Priority

High

The priority is high

  

Priority

Low

The priority is low

  

Priority

Medium

The priority is medium

  

Signed-off: Owner

When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  

Signed-off: Scrum Master

When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  

Signed-off: Tech Lead

When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  

Spike

A ticket for learning a tool or technology that is needed to be able to do future planning and design.

  

State

Completed

The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.

  

State

Duplicate

A ticket that represents the same content as an existing ticket.

  

State

In Progress

A ticket that is actively being developed.

  

State

In Review

A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.

  

State

Paused

This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.

  

State

Unverified

All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.

  

State

Verified

The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.

  

State

Wont Do

This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.

  

Type

Automation

Any edits or discussion about the AI automated coding system.

  

Type

Bug

Something that doesnt work as intended.

  

Type

Discussion

Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.

  

Type

Documentation

An error or improvement needed in the documentation.

  

Type

Epic

Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.

  

Type

Feature

Some new functionality not present.

  

Type

Legendary

A type of Epic which will contain other Epics.

  

Type

Refactor

A code change that restructures existing code without changing its external behavior.

  

Type

Support

Someone needs help using the project.

  

Type

Task

A generic task that doesnt fit into the other type categories.

  

Type

Testing

Work exclusively focusing on fixing or expanding testing.

No labels

auto/needs-reevaluation

controller-managed

auto/blocked-by-deps

auto/ci-timeout

auto/claimed-implementer

auto/claimed-merge

auto/claimed-reviewer

auto/driver-down

auto/invariant-violation

auto/last-attempt-tier-0

auto/last-attempt-tier-1

auto/last-attempt-tier-2

auto/last-attempt-tier-min

Automation Tracking

auto/needs-conflict-resolution

auto/needs-implementer

auto/postmortem

auto/ready-to-merge

auto/restart-throttled

auto/revert

auto/sentinel

auto/stale-inactivity

auto/unstable

Blocked

Bounty

$100

Bounty

$1000

Bounty

$10000

Bounty

$20

Bounty

$2000

Bounty

$250

Bounty

$50

Bounty

$500

Bounty

$5000

Bounty

$750

MoSCoW

Could have

MoSCoW

Must have

MoSCoW

Should have

Needs Feedback

Points

1

Points

13

Points

2

Points

21

Points

3

Points

34

Points

5

Points

55

Points

8

Points

88

Priority

Backlog

Priority

CI Blocker

Priority

Critical

Priority

High

Priority

Low

Priority

Medium

Signed-off: Owner

Signed-off: Scrum Master

Signed-off: Tech Lead

Spike

State

Completed

State

Duplicate

State

In Progress

State

In Review

State

Paused

State

Unverified

State

Verified

State

Wont Do

Type

Automation

Type

Bug

Type

Discussion

Type

Documentation

Type

Epic

Type

Feature

Type

Legendary

Type

Refactor

Type

Support

Type

Task

Type

Testing

Milestone

Clear milestone

No items

No milestone

v3.6.0

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

hamza.khyari

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

cleveragents/cleveragents-core!1054

No description provided.