Per-message TTLs set metadata API level to 1 (#6363)

As per the ADR: > When either these settings are set the Stream should require API level `1`. Signed-off-by: Neil Twigg <[email protected]>
nats-io · Jan 10, 2025 · bd4be70 · bd4be70
2 parents 158d7cd + f053ba0
commit bd4be70
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/server/jetstream_versioning.go b/server/jetstream_versioning.go
@@ -30,14 +30,25 @@ const (
 //   - cfg!=nil, prevCfg!=nil		update stream: required metadata is updated
 //
 // Any dynamic metadata is removed, it must not be stored and only be added for responses.
-func setStaticStreamMetadata(cfg *StreamConfig, prevCfg *StreamConfig) {
+func setStaticStreamMetadata(cfg *StreamConfig, _ *StreamConfig) {
 	if cfg.Metadata == nil {
 		cfg.Metadata = make(map[string]string)
 	} else {
 		deleteDynamicMetadata(cfg.Metadata)
 	}
 
 	var requiredApiLevel int
+	requires := func(level int) {
+		if level > requiredApiLevel {
+			requiredApiLevel = level
+		}
+	}
+
+	// TTLs were added in v2.11 and require API level 1.
+	if cfg.AllowMsgTTL {
+		requires(1)
+	}
+
 	cfg.Metadata[JSRequiredLevelMetadataKey] = strconv.Itoa(requiredApiLevel)
 }
 
@@ -59,24 +70,29 @@ func setDynamicStreamMetadata(cfg *StreamConfig) *StreamConfig {
 //   - cfg!=nil, prevCfg!=nil		update consumer: required metadata is updated
 //
 // Any dynamic metadata is removed, it must not be stored and only be added for responses.
-func setStaticConsumerMetadata(cfg *ConsumerConfig, prevCfg *ConsumerConfig) {
+func setStaticConsumerMetadata(cfg *ConsumerConfig, _ *ConsumerConfig) {
 	if cfg.Metadata == nil {
 		cfg.Metadata = make(map[string]string)
 	} else {
 		deleteDynamicMetadata(cfg.Metadata)
 	}
 
 	var requiredApiLevel int
+	requires := func(level int) {
+		if level > requiredApiLevel {
+			requiredApiLevel = level
+		}
+	}
 
 	// Added in 2.11, absent | zero is the feature is not used.
 	// one could be stricter and say even if its set but the time
 	// has already passed it is also not needed to restore the consumer
 	if cfg.PauseUntil != nil && !cfg.PauseUntil.IsZero() {
-		requiredApiLevel = 1
+		requires(1)
 	}
 
 	if cfg.PriorityPolicy != PriorityNone || cfg.PinnedTTL != 0 || len(cfg.PriorityGroups) > 0 {
-		requiredApiLevel = 1
+		requires(1)
 	}
 
 	cfg.Metadata[JSRequiredLevelMetadataKey] = strconv.Itoa(requiredApiLevel)

diff --git a/server/jetstream_versioning_test.go b/server/jetstream_versioning_test.go
@@ -79,6 +79,12 @@ func TestJetStreamSetStaticStreamMetadata(t *testing.T) {
 			prev:             &StreamConfig{},
 			expectedMetadata: metadataAtLevel("0"),
 		},
+		{
+			desc:             "create/AllowMsgTTL",
+			cfg:              &StreamConfig{AllowMsgTTL: true},
+			prev:             nil,
+			expectedMetadata: metadataAtLevel("1"),
+		},
 	} {
 		t.Run(test.desc, func(t *testing.T) {
 			setStaticStreamMetadata(test.cfg, test.prev)