Changes in Durable/Ephemeral creation

[aricart]

Overview

Reference PR nats-io/nats-server#3409 for changes to consumer creation.

Consumer Configuration

• Ephemeral consumers can now supply a name.
• Ephemeral consumers can supply inactive_threshold. The server defaults if not supplied.
• Durable consumers still must supply durable_name.
  • name is not required if durable_name is supplied.
  • If a user supplies both name and durable_name they must be the same, otherwise the server will respond with an error 10017 "consumer name in subject does not match durable name in request". Client side validation of this should be consistent with other behavior in your client.
• If the server is v2.9.0 or later and the user does not provide a name or durable_name, just use the original ephemeral template $JS.API.CONSUMER.CREATE.<stream_name>
• If the server is older than v2.9.0 and the user provides a name, the client should return/throw an error since the old templates/server does not support ephemeral name and the server will supply one that will not match what the client set.

JS.API Templates v2.9.0

The new base template for creating consumers:

$JS.API.CONSUMER.CREATE.<stream_name>.<consumer_name>

consumerName would be the name for ephemerals, durable_name for durables.

Filter Subjects

If the user specifies a filter subject other than >, this should be specified as the last segment.

$JS.API.CONSUMER.CREATE.<stream_name>.<consumer_name>.<filter_subject>

so for example

$JS.API.CONSUMER.CREATE.myStream.myConsumer.mySubject.>
$JS.API.CONSUMER.CREATE.myStream.myConsumer.mySubject.*.foo

The changes is for JS API security enablement and makes it possible to grant permissions to an account/user to create consumers on a stream having a specific filter.

Prefixes

All prefix rules apply as always regarding the $JS.API. portion of the template.

Clients and Tools

• Schemas @ripienaar
• CLI @ripienaar
• Go @piotrpio Adjust consumer creation to nats-server v2.9.0 nats.go#1080
• Java @scottf
• JavaScript @aricart [FEAT] new consumer creation api nats.deno#353
• .Net @scottf
• C @kozlovic [ADDED] Name in consumer configuration nats.c#580
• Python @wallyqs js: support consumer with name nats.py#358
• Ruby @wallyqs
• Rust @Jarema @caspervonb

Other Tasks

• docs.nats.io updated @jnmoyne
• 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.