config-error-handling
Skill658 starsChanged 3 months agoApache-2.0View on GitHub
Add or improve config validation and error messages for Membrane config elements (@MCElement classes) — throwing/wrapping ConfigurationException, deciding where to validate, and understanding why some config errors get a highlighted YAML snippet and others don't. Use whenever asked to add config validation, throw a ConfigurationException, make a config error message more informative, or explain why a config error shows/doesn't show the YAML `>` marker.
In this repository10 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- create-tutorialSkill
- find-exampleSkill
- find-interceptor-implSkill
- membrane-configSkill
- optimize-interceptor-docsSkill
- refactorSkill
- release-notesSkill
- review-branchSkill
- run-example-testSkill
The file
We split this skill into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 38
Prefer failing at init()-time (config-load time) over lazily at first-request time — see …
- Very specific: line 54
Init-time checks: follow DigitalSignatureInterceptorTest's initWith(references...) + assertThrows(RuntimeException.class, () -> …
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Config Error Handling
Two failure phases, two reporting paths
Membrane config errors surface differently depending on when they're thrown, and that's the first thing to get right.
Setter-time — inside an @MCAttribute/@MCChildElement setter, during YAML property binding
(annot/.../yaml/parsing/binding/PropertyBinder.java, populate()). That catch (Throwable cause)
re-wraps into new ConfigurationParsingException(cause.getMessage()) and attaches a
ParsingContext (source location), so RouterCLI renders a highlighted > YAML snippet pointing
at the offending line. Mind the message: reflection wraps a setter's own exception in
InvocationTargetException, and PropertyBinder does not unwrap it, so the message it copies is
the wrapper's (null) — the real text sits in cause.getCause().getMessage(). The
@MCElement(collapsed=true) scalar path in ObjectBinder does unwrap (e.getTargetException()).
Example: WsuTimestampInterceptor.setTtl (core/.../soap/wsse/WsuTimestampInterceptor.java)
catches DateTimeParseException from Duration.parse and rethrows a ConfigurationException
with a concrete valid-example ("PT5M").
Init-time — inside interceptor.init(Router), reached via DefaultRouter.init() →
AbstractRouter.initProxies() → proxy.init(this), i.e. after all YAML parsing has finished.
The YAML bootstrap does carry a ParsingContext into the bean registry, but nothing on this
initProxies() path passes it on, so an interceptor's init() has no source location to report —
not fixable per-interceptor without a cross-cutting change to plumb it through Router/interceptor
init.
ConfigurationException thrown here is caught by
SpringConfigurationErrorHandler.handleConfigurationException
(core/.../exceptions/SpringConfigurationErrorHandler.java:128), which prints a plain
"************** Configuration Error ***..." / "Reason: <cause message>" block — no YAML
snippet. This is the existing, accepted behavior for every interceptor's init()-time checks
(missing keystore, bad key alias, unsupported algorithm, ...), not a bug to chase per class.
Prefer failing at init()-time (config-load time) over lazily at first-request time — see
DigitalSignatureInterceptor.validateConfiguration() for the pattern (checked in init(), before
any request is handled).
Writing a good ConfigurationException message
- Name the bad attribute and the value that was given.
- List valid options built from real constants, not hand-typed strings, so the list can't drift
from what's actually supported — e.g.
DigitalSignatureInterceptor.SUPPORTED_DIGEST_ALGORITHMSis built fromjavax.xml.crypto.dsig.DigestMethod.*, verified experimentally against the JDK's DOMXMLSignatureFactoryrather than assumed from the constant list. - Wrap the causing checked exception with
new ConfigurationException(message, cause)rather than swallowing it —cause.getMessage()is still visible viaReason:in the init-time path.
Testing pattern
- Init-time checks: follow
DigitalSignatureInterceptorTest'sinitWith(references...)+assertThrows(RuntimeException.class, () -> initWith(...))idiom — set the invalid state on a fresh interceptor with an otherwise-valid config, assert init throws. - Setter-time message propagation:
annot/src/test/java/.../YAMLParsingErrorTest.javabuilds ad-hoc@MCElementclasses and asserts on the rendered error report (seeattribute()) — use that as the template. There is currently no test covering a setter-thrown exception's message, which is why theInvocationTargetExceptiongap above goes unnoticed; add one there if you touch that path.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

