Conversation
`read-models get|snapshots|instances` send their positional argument as the read model identifier, but the help text called it a container name and pointed at 'cratis read-models list' - which prints both an Identifier and a Container column. A user following the help picked the wrong column, and the server answered with an unhandled error rather than a useful message. Align the argument descriptions, the LlmOption metadata and the settings doc comment with what is actually sent, and name the column to read it from. No behaviour change; the wire value was always the identifier. Adds a spec so the help text and the wire payload cannot drift apart again.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
read-models get,snapshotsandinstancessend their positional argument as the read model identifier, but the help text called it a container name and pointed atcratis read-models list— which prints both anIdentifierand aContainercolumn.A user following the help picked the wrong column and the server answered with an unhandled error rather than a useful message.
No tracking issue exists; found capturing CLI output with 3.1.6 against Chronicle 18.1.6.
Fixed
<READ_MODEL>argument is described as the read model identifier and names the column to read it from, matching what the commands actually send.Notes for review
ReadModelIdentifier. This aligns the[Description], the[LlmOption]metadata and the settings doc comment with it.fix/read-model-lookup-miss-guard, which turns the resultingNullReferenceExceptioninto a meaningful error. The two are independent; either can merge first.GetReadModelInstancesCommandcatches an RPC error whose detail contains"NullReferenceException"and reports it as "read model is client-owned". That was papering over the server defect above and is the wrong explanation for an unknown identifier — worth re-scoping once the Chronicle fix ships. Left untouched here.read-models occurrencesuses a different argument name (<READ_MODEL_TYPE>) and may be worth a consistency pass.Verification
Identifiercolumn thatListReadModelsCommandprints — so help text and wire payload cannot drift apart again.Cli.Specs: 1,111 tests passing.