fix(signals): report rejected sigrok selectors as invalid input (#5570)

sigrok-cli refusals of a caller-supplied decoder ID or annotation class
were reported as execution_failure with "Run `rea doctor`" advice, which
has no sigrok check. Recognize the observed sigrok-cli 0.7.2 refusals at
the provider boundary only when the rejected name matches a caller
selector, and report invalid_request naming the decoders or annotations
argument, retaining the captured output and pointing to
inspect_signal_decoders. Other non-zero exits stay provider failures.

Fixes #5515

Co-authored-by: Claude Opus 5.5 <[email protected]>
This commit is contained in:
Kaoru0822andClaude Opus 5.5 authored and GitHub committed 2026-10-20 22:52:33 -07:00
1 parent c1e04bf8c0
commit 4dfe3464b2
3 files changed
+141 -2

No files matched your search

+23 -2
View File
@@ -7,6 +7,10 @@ import {
DecoderDiscoveryBudgetError,
parseDecoderDiscovery,
} from "./parseDecoderDiscovery.js";
import {
parseSigrokSelectorRejection,
type SigrokSelectorRejection,
} from "./sigrokSelectorRejection.js";
import {
BOUNDED_PRODUCER_LIMITS as LIMITS,
prlimitArgumentVector,
@@ -166,7 +170,12 @@ export class SigrokRecordingProvider implements SignalRecordingPort {
root = await this.createRuntime();
this.#resources.retain(root, undefined);
const snapshotPath = join(root.path, "recording");
const execute = async (args: readonly string[]) => {
const execute = async (
args: readonly string[],
rejectedSelector?: (
stderr: string,
) => SigrokSelectorRejection | undefined,
) => {
capturedOutput = undefined;
const output = await runOwnedCommand(
{
@@ -222,6 +231,16 @@ export class SigrokRecordingProvider implements SignalRecordingPort {
);
phase = previousPhase;
resourcePath = "path" in input ? input.path : command;
const rejection =
output.exitCode === 0
? undefined
: rejectedSelector?.(output.stderr.text);
if (rejection !== undefined)
throw new AnalysisInputError(
operation,
{ capturedOutput, userMessage: rejection.message },
[rejection],
);
if (output.exitCode !== 0)
throw new ProviderAdapterError(
SIGROK_PROVIDER_IDENTITY.id,
@@ -311,7 +330,9 @@ export class SigrokRecordingProvider implements SignalRecordingPort {
? []
: [`--protocol-decoder-annotations=${input.annotations}`]),
];
const output = await execute(args);
const output = await execute(args, (stderr) =>
parseSigrokSelectorRejection(stderr, input),
);
phase = "integrity";
resourcePath = snapshotPath;
if (
+52
View File
@@ -0,0 +1,52 @@
import type { AnalysisInputIssue } from "../domain/analysisErrorCore.js";
import type { DecodeSignalRecordingInput } from "../domain/signals/signalRecording.js";
export type SigrokSelectorRejection = AnalysisInputIssue & {
readonly message: string;
};
const rejectedSelector = (
field: "decoders" | "annotations",
producerMessage: string,
): SigrokSelectorRejection => ({
path: [field],
reason: "invalid_value",
message: `sigrok-cli rejected the ${field} selector: ${producerMessage} Use inspect_signal_decoders to list installed decoder IDs, or pass a decoder ID to show its options and annotation classes.`,
});
/**
* Recognize only observed sigrok-cli 0.7.2 selector refusals whose rejected
* name equals a caller-supplied selector; other failures stay unclassified.
*/
export const parseSigrokSelectorRejection = (
stderr: string,
input: Pick<DecodeSignalRecordingInput, "decoders" | "annotations">,
): SigrokSelectorRejection | undefined => {
const lines = new Set(stderr.split("\n"));
// sigrok-cli stacks decoders with "," and appends options with ":".
for (const entry of input.decoders.split(",")) {
const id = entry.split(":")[0] ?? "";
const producerMessage = `Failed to load protocol decoder ${id}.`;
// A missing module named exactly after the decoder separates an unknown ID
// from an installed decoder whose own imports or code fail to load.
if (
id !== "" &&
lines.has(producerMessage) &&
lines.has(
`srd: ModuleNotFoundError: Failed to load decoder ${id}: import by name failed: No module named '${id}'`,
)
)
return rejectedSelector("decoders", producerMessage);
}
// Annotation selections are "decoder=class:class,decoder".
for (const entry of input.annotations?.split(",") ?? []) {
const [decoder = "", classes, ...rest] = entry.split("=");
if (decoder === "" || classes === undefined || rest.length > 0) continue;
for (const annotation of classes.split(":")) {
const producerMessage = `Annotation '${annotation}' not found for protocol decoder '${decoder}'.`;
if (annotation !== "" && lines.has(producerMessage))
return rejectedSelector("annotations", producerMessage);
}
}
return undefined;
};