morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #7163] docs(errors): point catalogue rows at the current error owners #7689

New issue

Open

opened 2026-11-03 13:39:40 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-11-03 13:39:40 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/7163
Author: @Iyanuoluwa007
Created: 10/25/2026
Status: 🔄 Open

Base: main ← Head: docs/error-catalogue-moved-sources

📝 Commits (1)

7414402 docs(errors): point catalogue rows at the current error owners

📊 Changes

1 file changed (+21 additions, -21 deletions)

View changed files

📝 docs/user-visible-errors.csv (+21 -21)

📄 Description

Summary

21 rows in docs/user-visible-errors.csv cite a source file that no longer exists, so a reader auditing an error's copy cannot find its owner. This repoints each row to the file that now defines it. Documentation only; no issue was filed for it.

Problem and expected behavior

21 rows cite src/domain/errors.ts, which #636 (735c10059, "split error taxonomy into thematic modules") removed.
The two src/application/Upgrade.ts rows this PR first covered were fixed on main by #7795, so this PR was rebuilt on current main without them.

Every other src/ location in the catalogue resolves (row 91 cites two existing files), except row 72, which is removed and correctly cites its historical file. The incur and @modelcontextprotocol/server rows name dependencies, not repository files.

Change and scope

Only the path before : in location changes; the :ClassName / :step suffix and every other column stay as they are. Each class was mapped by git grep -lE "export class <Name>\b" -- src, and each maps to exactly one file:

Rows	New file
AnalysisCapabilityUnavailableError, AnalysisOutputError, AnalysisProtocolError, AnalysisTimeoutError, AnalysisInputError, AnalysisCancelledError	`src/domain/analysisErrorCore.ts`
HopperRemoteError, HopperProtocolError, HopperProcessError, HopperStartError, HopperTimeoutError, HopperCancelledError	`src/domain/hopperErrors.ts`
BinaryTargetError, ConfigurationError, NoBinaryOpenError	`src/domain/configurationErrors.ts`
EvidenceFileError, EvidenceIntegrityError	`src/domain/evidenceErrors.ts`
ProviderAdapterError	`src/domain/providerAdapterError.ts`
ArtifactOperationError	`src/domain/artifactOperationError.ts`
UnknownRegistryError	`src/domain/unknownRegistryError.ts`
ProviderSelectionError	`src/domain/providerSelectionError.ts`
ProcessCaptureError	`src/process/capture/ProcessCaptureError.ts`

Not included: row 15's proposed_replacement is marked implemented but is not what users see (the ProcessCaptureError constructor always sets userMessage, so the generic fallback is not reached). That needs a decision about what the row should claim, so it belongs in a separate change.

Follow the contribution scope.
Unresolved scope, authority, side effects, or required verification block
integration. Link the required maintainer scope decision for new providers or
capabilities involving target execution, injection, mutation, or protection
recovery; ordinary fixes within existing boundaries may state "not applicable".
Draft PRs may leave the scope decision pending and the readiness and merge checklists
unchecked. Maintainers can help resolve open questions.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation only (location column of docs/user-visible-errors.csv).
Contribution scope fit and linked maintainer decision: not applicable.
CLI and MCP/tool-catalog contract: none.
Provider, bridge, target-format, or platform compatibility: none.
Evidence, artifact, provenance, or reconstruction contract: none.
Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable.
Generated metadata (docs/public/product-catalog.json), package, or installation impact (CI generates and validates ignored catalogs and skills/; edit authored instructions in .agents/skills/reverse-engineer-anything/ and never commit build outputs): none; nothing in the repository parses this CSV.

Expected effects (check known effects; use documentation-only on its own).
Unchecked items do not establish absence; leave uncertainties visible.

Read existing files or captured data.
Launch or attach to a process.
Inject instrumentation or run scripts/code.
Change process memory, registers, files, or configuration.
Contact network services.
Recover protected code or work around protections.
Documentation or usability only; no target interaction.
Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

Tests added or updated: none (documentation only).
Base reproduction or other evidence: source-derived. On main, a script checking each row's location path with os.path.exists lists these 21 rows (plus row 72 and the dependency rows above). After the change, no non-removed src/ row cites a missing file. git log --diff-filter=D identifies the removing commits. The CSV still parses with csv.DictReader: 109 rows, no extra columns; the diff is 21 lines.
User-visible CLI/MCP output (if applicable): not applicable.
Remaining proof gaps: npm run docs:check not run locally; CI runs it. Stale proposed_replacement wording is out of scope, as noted above.

Not a boundary fix: documentation only. For boundary fixes, identify the applicable boundary regressions
and lifecycle regressions
covered by the evidence above, and explain relevant gaps.

For evidence-bearing changes:

Observed, derived, and inferred claims remain distinguishable.
Artifact identity, source provenance, and failed attempts remain preserved.
Unsupported, incomplete, unavailable, or uncertain outcomes remain visible.

Validation performed

Location audit script on main (34577eb1c): 21 stale rows; on this branch: 0.
git grep -lE "export class <Name>\b" -- src for each of the 22 classes: exactly one defining file each.
csv.DictReader re-parse: 109 rows, columns intact.
Pre-push npm run check:fast (typecheck, lint): passed.

Compatibility, safety, and release

Breaking changes or migration steps: none.
Real Hopper/Ghidra, browser, or OS coverage: none.
Package or release metadata impact: none.
Security, privacy, process, or containment review: none.

Author readiness

Human owner: @Iyanuoluwa007

I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
I declare this PR ready for initial maintainer review.

Before merge

This PR addresses a concrete problem or an agreed enhancement.
Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
The PR has one focused outcome and the title follows type(scope): outcome.
Related issue is linked, or the reason for not linking one is stated above.
Tests cover changed observable behavior and meaningful failure paths.
Owning docs, contracts, and generated metadata are updated where needed.
User-visible CLI/MCP changes include representative output.
I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/7163 **Author:** [@Iyanuoluwa007](https://github.com/Iyanuoluwa007) **Created:** 10/25/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs/error-catalogue-moved-sources` --- ### 📝 Commits (1) - [`7414402`](https://github.com/morluto/rea/commit/74144025824da100df11dffca8022af24e65490c) docs(errors): point catalogue rows at the current error owners ### 📊 Changes **1 file changed** (+21 additions, -21 deletions) <details> <summary>View changed files</summary> 📝 `docs/user-visible-errors.csv` (+21 -21) </details> ### 📄 Description  ## Summary  21 rows in `docs/user-visible-errors.csv` cite a source file that no longer exists, so a reader auditing an error's copy cannot find its owner. This repoints each row to the file that now defines it. Documentation only; no issue was filed for it. ## Problem and expected behavior  - 21 rows cite `src/domain/errors.ts`, which #636 (735c10059, "split error taxonomy into thematic modules") removed. - The two `src/application/Upgrade.ts` rows this PR first covered were fixed on main by #7795, so this PR was rebuilt on current main without them. Every other `src/` location in the catalogue resolves (row 91 cites two existing files), except row 72, which is `removed` and correctly cites its historical file. The `incur` and `@modelcontextprotocol/server` rows name dependencies, not repository files. ## Change and scope  Only the path before `:` in `location` changes; the `:ClassName` / `:step` suffix and every other column stay as they are. Each class was mapped by `git grep -lE "export class <Name>\b" -- src`, and each maps to exactly one file: | Rows | New file | |---|---| | AnalysisCapabilityUnavailableError, AnalysisOutputError, AnalysisProtocolError, AnalysisTimeoutError, AnalysisInputError, AnalysisCancelledError | `src/domain/analysisErrorCore.ts` | | HopperRemoteError, HopperProtocolError, HopperProcessError, HopperStartError, HopperTimeoutError, HopperCancelledError | `src/domain/hopperErrors.ts` | | BinaryTargetError, ConfigurationError, NoBinaryOpenError | `src/domain/configurationErrors.ts` | | EvidenceFileError, EvidenceIntegrityError | `src/domain/evidenceErrors.ts` | | ProviderAdapterError | `src/domain/providerAdapterError.ts` | | ArtifactOperationError | `src/domain/artifactOperationError.ts` | | UnknownRegistryError | `src/domain/unknownRegistryError.ts` | | ProviderSelectionError | `src/domain/providerSelectionError.ts` | | ProcessCaptureError | `src/process/capture/ProcessCaptureError.ts` | Not included: row 15's `proposed_replacement` is marked implemented but is not what users see (the `ProcessCaptureError` constructor always sets `userMessage`, so the generic fallback is not reached). That needs a decision about what the row should claim, so it belongs in a separate change. Follow the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope). Unresolved scope, authority, side effects, or required verification block integration. Link the required maintainer scope decision for new providers or capabilities involving target execution, injection, mutation, or protection recovery; ordinary fixes within existing boundaries may state "not applicable". Draft PRs may leave the scope decision pending and the readiness and merge checklists unchecked. Maintainers can help resolve open questions. ## Contract and boundary impact  - Semantic owner and earliest changed stage: documentation only (`location` column of `docs/user-visible-errors.csv`).  - Contribution scope fit and linked maintainer decision: not applicable. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact (CI generates and validates ignored catalogs and `skills/`; edit authored instructions in `.agents/skills/reverse-engineer-anything/` and never commit build outputs): none; nothing in the repository parses this CSV. Expected effects (check known effects; use documentation-only on its own). Unchecked items do not establish absence; leave uncertainties visible. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage  - Tests added or updated: none (documentation only). - Base reproduction or other evidence: source-derived. On main, a script checking each row's `location` path with `os.path.exists` lists these 21 rows (plus row 72 and the dependency rows above). After the change, no non-removed `src/` row cites a missing file. `git log --diff-filter=D` identifies the removing commits. The CSV still parses with `csv.DictReader`: 109 rows, no extra columns; the diff is 21 lines. - User-visible CLI/MCP output (if applicable): not applicable. - Remaining proof gaps: `npm run docs:check` not run locally; CI runs it. Stale `proposed_replacement` wording is out of scope, as noted above. Not a boundary fix: documentation only. For boundary fixes, identify the applicable [boundary regressions](https://github.com/morluto/rea/blob/main/docs/testing.md#boundary-regressions) and [lifecycle regressions](https://github.com/morluto/rea/blob/main/docs/testing.md#lifecycle-regressions) covered by the evidence above, and explain relevant gaps. For evidence-bearing changes: - [x] Observed, derived, and inferred claims remain distinguishable. - [x] Artifact identity, source provenance, and failed attempts remain preserved. - [x] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. ## Validation performed  - Location audit script on main (34577eb1c): 21 stale rows; on this branch: 0. - `git grep -lE "export class <Name>\b" -- src` for each of the 22 classes: exactly one defining file each. - `csv.DictReader` re-parse: 109 rows, columns intact. - Pre-push `npm run check:fast` (typecheck, lint): passed. ## Compatibility, safety, and release  - Breaking changes or migration steps: none.  - Real Hopper/Ghidra, browser, or OS coverage: none. - Package or release metadata impact: none. - Security, privacy, process, or containment review: none. ## Author readiness  Human owner: @Iyanuoluwa007 - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge  - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [ ] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

2026-11-03 13:39:40 +00:00

No milestone

No project

No assignees

1 participant

Notifications

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

morluto/rea#7689

No description provided.

Rows
Columns