Support NATS error codes for JetStream interactions

[ripienaar]

Overview

Prefer NATS error codes when conditionally handling JetStream API errors and expose the code to users.

The basic idea is that in the past we would return errors like replicas > 1 not supported in non-clustered mode in the ApiErr and clients would parse these messages if they wanted to handle different errors differently.

Another case would be when accessing a consumer, you'd get a error like 404 but you would not know if this is due to a stream being missing or a consumer being missing.

We now have codes in addition to the errors, the replicas > 1 not supported in non-clustered mode has code 10074, libraries should check this code rather than parse the text. The error text is not part of the API promises and we need to be able to make changes to language, typos, etc.

The cli has nats error lookup 10074 to compliment these.

The behavior is documented in ADR-7, initial server PR nats-io/nats-server#2168

Clients and Tools

• Schemas @ripienaar nats-io/jsm.go@bf9eafc
• CLI @ripienaar
• Go @piotrpio
• Java @scottf
• JavaScript @aricart
• .Net @ColinSullivan1
• C @kozlovic (implemented since the get-go, currently on branch https://github.com/nats-io/nats.c/tree/js)
• Python @wallyqs
• Rust @Jarema

Other Tasks

• docs.nats.io updated
• Update ADR to Implemented
• Update client features spreadsheet

Client authors please update with your progress. If you open issues in your own repositories as a result of this request, please link them to this one by pasting the issue URL in a comment or main issue description.

[wallyqs]

Following releases of the Go client use errors wrapping for JetStream errors to capture APIError details: nats-io/nats.go#1047