morluto/rea

Fork 0

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

[GH-ISSUE #6766] [Bug] Unknown sigrok input format returns execution_failure and doctor guidance #4124

New issue

Closed

opened 2026-10-31 00:46:59 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 00:46:59 +00:00

Owner

Originally created by @coygeek on GitHub (Oct 23, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/6766

Before submitting

I searched the open and closed issues for a related report.
I removed credentials, tokens, private paths, and sensitive target data.

Area

Process capture or runtime observation

Observed behavior

An unknown caller-selected input_format falls through to ProviderAdapterError, producing execution_failure and advice to run rea doctor, rather than identifying the invalid format selection.

Observed at REA's production provider/service boundary with a simulated sigrok subprocess. Real sigrok execution was not performed. The producer diagnostic used in the simulation comes from the supported sigrok release's input-module lookup; the source-derived real-tool consequence is distinguished below.

Reproduction

I ran a TypeScript probe using SignalRecordingService(new SigrokRecordingProvider(environment, launcher)). The launcher used spawnOwnedProviderProcess to run a Node subprocess instead of sigrok. The configured executable and limiter paths referred to this test producer, following the command-boundary simulator pattern in tests/boundary/signals/recordingProvider.test.ts.

The subprocess returned a supported-looking version banner for --version, then this refusal for the decode request:

if (process.argv.includes('--version')) {
  console.log('sigrok-cli 0.7.2\nlibsigrokdecode 0.5.3');
} else {
  console.error("cli: Error: unknown input module 'missingformat'.");
  process.exitCode = 1;
}

The service request was:

await service.decode({
  path: capturePath, // an existing temporary .vcd file
  decoders: 'uart',
  input_format: 'missingformat',
});

The projected error below occurred in the one boundary run. No actual decoder, hardware, or client session was exercised. For a real-tool check, a proposed command is rea decode-signal-recording capture.vcd --decoders uart --input_format missingformat --format json; this command was not run.

Expected behavior

Recognize the explicit unknown input-module refusal as invalid caller input, name input_format in the structured issue, retain the producer diagnostic, and direct the caller to correct or omit that selection. The provider already treats explicit decoder, annotation, and channel selector refusals this way. docs/mcp-contracts.md also says invalid input calls should be corrected from their schema.

Impact and scope

The boundary observation shows the wrong typed outcome and recovery guidance for one explicit format refusal. The corresponding real-tool path is source-derived: users who select an unknown format would be directed toward installation diagnostics instead of the rejected argument. Successful decoding, other format errors, and actual sigrok execution were not tested. Correcting the selected format is the practical recovery; decoder discovery does not list input formats.

REA version

Source main at 5f702dd6ccd9e8e505e224854b91678439c3b41f (package version 6.7.0). Latest published release was 6.7.0 when checked; its source has the same generic nonzero-exit fallback and predates the newer selector-refusal handling. The boundary probe ran against main only.

Runtime and platform

Node.js 24.22.1; Linux x64; repository-locked dependencies. Simulated sigrok producer, not an installed sigrok binary.

Target and artifact context

Temporary local .vcd file containing $timescale 1ns $end. No recording samples were decoded; the simulated producer refused the explicit format.

Interface

Other

Earliest failure stage

Capture or observation

Relevant output or evidence

The production error projection returned:

{
  "tag": "ProviderAdapterError",
  "code": "execution_failure",
  "category": "execution_failure",
  "message": "Analysis could not complete. Run `rea doctor` and review the reported details; repeating the unchanged request is not expected to succeed.",
  "details": {
    "provider_id": "sigrok-recording",
    "operation": "decode_signal_recording",
    "diagnostics": {
      "exit_code": 1,
      "stdout": "",
      "stderr": "cli: Error: unknown input module 'missingformat'.\n"
    }
  }
}

Source evidence: selector-refusal classification and nonzero-exit fallback; the selector type omits input_format. In the official sigrok-cli release archive, input.c explicitly calls g_critical("Error: unknown input module '%s'.", mod_id) when the caller's input module cannot be found. This supports the diagnostic selection; it does not establish a real sigrok run here.

Typed outcome or recovery expected

invalid_request, with an issue path of ["input_format"] and actionable selection recovery.

Additional context

Related closed report #5515 covered misspelled decoder IDs and annotation classes. This report concerns the separate explicit input-format selector that the newer classifier still omits.

Triage assessment

Impact level: P2
Assessment status: provisional
Impact basis: The production boundary probe observed a wrong error family and recovery action; the real sigrok consequence is supported by its input-module source but was not executed.
Workaround status: available
Workaround basis: Correct or omit the explicit format selector; the diagnostic retained in the error identifies the rejected module.

Originally created by @coygeek on GitHub (Oct 23, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/6766 ### Before submitting - [x] I searched the open and closed issues for a related report. - [x] I removed credentials, tokens, private paths, and sensitive target data. ### Area Process capture or runtime observation ### Observed behavior An unknown caller-selected `input_format` falls through to `ProviderAdapterError`, producing `execution_failure` and advice to run `rea doctor`, rather than identifying the invalid format selection. Observed at REA's production provider/service boundary with a simulated sigrok subprocess. Real sigrok execution was not performed. The producer diagnostic used in the simulation comes from the supported sigrok release's input-module lookup; the source-derived real-tool consequence is distinguished below. ### Reproduction I ran a TypeScript probe using `SignalRecordingService(new SigrokRecordingProvider(environment, launcher))`. The launcher used `spawnOwnedProviderProcess` to run a Node subprocess instead of sigrok. The configured executable and limiter paths referred to this test producer, following the command-boundary simulator pattern in `tests/boundary/signals/recordingProvider.test.ts`. The subprocess returned a supported-looking version banner for `--version`, then this refusal for the decode request: ```js if (process.argv.includes('--version')) { console.log('sigrok-cli 0.7.2\nlibsigrokdecode 0.5.3'); } else { console.error("cli: Error: unknown input module 'missingformat'."); process.exitCode = 1; } ``` The service request was: ```js await service.decode({ path: capturePath, // an existing temporary .vcd file decoders: 'uart', input_format: 'missingformat', }); ``` The projected error below occurred in the one boundary run. No actual decoder, hardware, or client session was exercised. For a real-tool check, a proposed command is `rea decode-signal-recording capture.vcd --decoders uart --input_format missingformat --format json`; this command was not run. ### Expected behavior Recognize the explicit unknown input-module refusal as invalid caller input, name `input_format` in the structured issue, retain the producer diagnostic, and direct the caller to correct or omit that selection. The provider already treats explicit decoder, annotation, and channel selector refusals this way. `docs/mcp-contracts.md` also says invalid input calls should be corrected from their schema. ### Impact and scope The boundary observation shows the wrong typed outcome and recovery guidance for one explicit format refusal. The corresponding real-tool path is source-derived: users who select an unknown format would be directed toward installation diagnostics instead of the rejected argument. Successful decoding, other format errors, and actual sigrok execution were not tested. Correcting the selected format is the practical recovery; decoder discovery does not list input formats. ### REA version Source `main` at `5f702dd6ccd9e8e505e224854b91678439c3b41f` (package version 6.7.0). Latest published release was 6.7.0 when checked; its source has the same generic nonzero-exit fallback and predates the newer selector-refusal handling. The boundary probe ran against `main` only. ### Runtime and platform Node.js 24.22.1; Linux x64; repository-locked dependencies. Simulated sigrok producer, not an installed sigrok binary. ### Target and artifact context Temporary local `.vcd` file containing `$timescale 1ns $end`. No recording samples were decoded; the simulated producer refused the explicit format. ### Interface Other ### Earliest failure stage Capture or observation ### Relevant output or evidence The production error projection returned: ```json { "tag": "ProviderAdapterError", "code": "execution_failure", "category": "execution_failure", "message": "Analysis could not complete. Run `rea doctor` and review the reported details; repeating the unchanged request is not expected to succeed.", "details": { "provider_id": "sigrok-recording", "operation": "decode_signal_recording", "diagnostics": { "exit_code": 1, "stdout": "", "stderr": "cli: Error: unknown input module 'missingformat'.\n" } } } ``` Source evidence: [selector-refusal classification and nonzero-exit fallback](https://github.com/morluto/rea/blob/5f702dd6ccd9e8e505e224854b91678439c3b41f/src/signals/SigrokRecordingProvider.ts#L260-L284); [the selector type omits `input_format`](https://github.com/morluto/rea/blob/5f702dd6ccd9e8e505e224854b91678439c3b41f/src/signals/sigrokSelectorRejection.ts#L9-L16). In the [official sigrok-cli release archive](https://sigrok.org/download/source/sigrok-cli/sigrok-cli-0.7.2.tar.gz), `input.c` explicitly calls `g_critical("Error: unknown input module '%s'.", mod_id)` when the caller's input module cannot be found. This supports the diagnostic selection; it does not establish a real sigrok run here. ### Typed outcome or recovery expected `invalid_request`, with an issue path of `["input_format"]` and actionable selection recovery. ### Additional context Related closed report #5515 covered misspelled decoder IDs and annotation classes. This report concerns the separate explicit input-format selector that the newer classifier still omits. ### Triage assessment - Impact level: P2 - Assessment status: provisional - Impact basis: The production boundary probe observed a wrong error family and recovery action; the real sigrok consequence is supported by its input-module source but was not executed. - Workaround status: available - Workaround basis: Correct or omit the explicit format selector; the diagnostic retained in the error identifies the rejected module.

bsakaguchi closed this issue

2026-10-31 00:46:59 +00:00

bsakaguchi referenced this issue

2026-10-31 01:11:39 +00:00

[PR #4126] [CLOSED] fix(artifacts): interpret ZIP current-directory prefixes #6074

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#4124

No description provided.

Rows
Columns