nats-pure 2.6.0 → 2.7.0

data/lib/nats/io/kv/api.rb

@@ -30,6 +30,10 @@ module NATS
         :republish,
         :direct,
         :validate_keys,
+        # Compress the bucket's stream with S2 (requires nats-server v2.10.0).
+        :compression,
+        # Freeform metadata of the bucket (requires nats-server v2.10.0).
+        :metadata,
         keyword_init: true
       ) do
         def initialize(opts = {})

data/lib/nats/io/kv/bucket_status.rb

@@ -35,6 +35,18 @@ module NATS
       def ttl
         @stream_info.config.max_age / ::NATS::NANOSECONDS
       end
+
+      # Whether the bucket's stream is compressed (requires nats-server v2.10.0).
+      def compressed?
+        compression = @stream_info.config.compression
+        !compression.nil? && compression != "none"
+      end
+
+      # The bucket's metadata, including the metadata that the server sets
+      # (requires nats-server v2.10.0).
+      def metadata
+        @stream_info.config.metadata
+      end
     end
   end
 end

data/lib/nats/io/kv/manager.rb

@@ -59,6 +59,10 @@ module NATS
           raise NATS::KeyValue::KeyHistoryTooLargeError
         end
 
+        unless [true, false, nil].include?(config.compression)
+          raise ArgumentError.new("nats: compression must be true or false")
+        end
+
         stream = JetStream::API::StreamConfig.new(
           name: "KV_#{config.bucket}",
           description: config.description,
@@ -76,7 +80,9 @@ module NATS
           max_msgs_per_subject: config.history,
           num_replicas: config.replicas,
           storage: config.storage,
-          republish: config.republish
+          republish: config.republish,
+          compression: config.compression ? "s2" : nil,
+          metadata: config.metadata
         )
 
         si = add_stream(stream)

data/lib/nats/io/kv.rb

@@ -258,7 +258,8 @@ module NATS
     CONSUMER_STALLED_HDR = "Nats-Consumer-Stalled"
 
     # watch will be signaled when a key that matches the keys
-    # pattern is updated.
+    # pattern is updated. keys can also be an Array of patterns
+    # (requires nats-server v2.10.0); an empty Array watches all keys.
     # The first update after starting the watch is nil in case
     # there are no pending updates.
     def watch(keys, params = {})
@@ -267,7 +268,12 @@ module NATS
       params[:ignore_deletes] ||= false
       params[:idle_heartbeat] ||= 5 # seconds
       params[:inactive_threshold] ||= 5 * 60 # 5 minutes
-      subject = "#{@pre}#{keys}"
+      subject = if keys.is_a?(Array)
+        keys = [">"] if keys.empty?
+        keys.map { |key| "#{@pre}#{key}" }
+      else
+        "#{@pre}#{keys}"
+      end
       init_setup = new_cond
       init_setup_done = false
       nc = @js.nc
@@ -294,7 +300,7 @@ module NATS
       }
 
       # watch_updates callback.
-      sub = @js.subscribe(subject, config: ordered) do |msg|
+      sub = @js.subscribe(subject, stream: @stream, config: ordered) do |msg|
         synchronize do
           if !init_setup_done
             init_setup.wait(@js.opts[:timeout])
@@ -379,6 +385,9 @@ module NATS
       begin
         cinfo = sub.consumer_info
         stream_name = cinfo.stream_name
+        # Snapshot the keys filter too: subscribe set it on the consumer,
+        # not on ordered, and a recreated consumer needs it.
+        filter = cinfo.config.to_h.slice(:filter_subject, :filter_subjects)
 
         synchronize do
           init_setup_done = true
@@ -417,9 +426,11 @@ module NATS
           current
         }
         if !active
-          ccreq = ordered.dup
+          ccreq = ordered.merge(filter)
           ccreq[:deliver_policy] = "by_start_sequence"
-          ccreq[:opt_start_seq] = watcher._sseq
+          # Resume after the last entry. With none yet, that is the start of
+          # the stream, so earlier revisions of the keys are replayed too.
+          ccreq[:opt_start_seq] = watcher._sseq + 1
           ccreq[:deliver_subject] = deliver_subject
           ccreq[:idle_heartbeat] = ordered[:idle_heartbeat]
           ccreq[:inactive_threshold] = ordered[:inactive_threshold]

data/lib/nats/io/subscription.rb

@@ -89,18 +89,19 @@ module NATS
     def next_msg(opts = {})
       timeout = opts[:timeout] ||= 0.5
       synchronize do
-        return @pending_queue.pop if !@pending_queue.empty?
+        if @pending_queue.empty?
+          # Wait for a bit until getting a signal.
+          MonotonicTime.with_nats_timeout(timeout) do
+            wait_for_msgs_cond.wait(timeout)
+          end
 
-        # Wait for a bit until getting a signal.
-        MonotonicTime.with_nats_timeout(timeout) do
-          wait_for_msgs_cond.wait(timeout)
+          raise NATS::Timeout if @pending_queue.empty?
         end
 
-        if !@pending_queue.empty?
-          return @pending_queue.pop
-        else
-          raise NATS::Timeout
-        end
+        # Decrease pending size since consumed already
+        msg = @pending_queue.pop
+        self.pending_size -= msg.data.size
+        msg
       end
     end
 

data/lib/nats/io/version.rb

@@ -17,7 +17,7 @@
 module NATS
   module IO
     # VERSION is the version of the client announced on CONNECT to the server.
-    VERSION = "2.6.0"
+    VERSION = "2.7.0"
 
     # LANG is the lang runtime of the client announced on CONNECT to the server.
     LANG = "#{RUBY_ENGINE}#{RUBY_VERSION}".freeze

data/sig/nats/io/jetstream/api.rbs

@@ -7,18 +7,27 @@ module NATS
       class SequenceInfo < Struct[Integer]
       end
 
-      class ConsumerInfo < Struct[String | NATS::JetStream::API::ConsumerConfig | NATS::JetStream::API::SequenceInfo | Integer | Hash[Symbol, untyped]]
+      class PriorityGroupState < Struct[String | Time]
       end
 
-      class ConsumerConfig < Struct[String | Integer]
+      class ConsumerInfo < Struct[String | NATS::JetStream::API::ConsumerConfig | NATS::JetStream::API::SequenceInfo | Integer | Hash[Symbol, untyped] | Time | bool | Array[NATS::JetStream::API::PriorityGroupState]]
+      end
+
+      class ConsumerConfig < Struct[String | Integer | Time | Array[String]]
         def to_json: (*Hash[untyped, untyped]) -> String
       end
 
+      class ConsumerPauseResponse < Struct[bool | Time | Integer]
+      end
+
+      class ConsumerResetResponse < Struct[NATS::JetStream::API::ConsumerInfo | Integer]
+      end
+
       class StreamConfig < Struct[String | Hash[Symbol, untyped] | NATS::JetStream::API::StreamState | bool | Integer]
         def to_json: (*Hash[untyped, untyped]) -> String
       end
 
-      class StreamInfo < Struct[String | Hash[Symbol, untyped]]
+      class StreamInfo < Struct[String | Hash[Symbol, untyped] | Array[Hash[Symbol, untyped]] | Time]
       end
 
       class StreamState < Struct[Integer]

data/sig/nats/io/jetstream/errors.rbs

@@ -49,6 +49,18 @@ module NATS
 
       class BadRequest < NATS::JetStream::Error::APIError
       end
+
+      class ConsumerAlreadyExists < NATS::JetStream::Error::BadRequest
+      end
+
+      class ConsumerDoesNotExist < NATS::JetStream::Error::BadRequest
+      end
+
+      class ConsumerInvalidReset < NATS::JetStream::Error::BadRequest
+      end
+
+      class PinIdMismatch < NATS::JetStream::Error::APIError
+      end
     end
   end
 end

data/sig/nats/io/jetstream/header.rbs

@@ -0,0 +1,33 @@
+module NATS
+  class JetStream
+    module Header
+      MSG_ID: 'Nats-Msg-Id'
+      EXPECTED_STREAM: 'Nats-Expected-Stream'
+      EXPECTED_LAST_SEQUENCE: 'Nats-Expected-Last-Sequence'
+      EXPECTED_LAST_SUBJECT_SEQUENCE: 'Nats-Expected-Last-Subject-Sequence'
+      EXPECTED_LAST_SUBJECT_SEQUENCE_SUBJECT: 'Nats-Expected-Last-Subject-Sequence-Subject'
+      EXPECTED_LAST_MSG_ID: 'Nats-Expected-Last-Msg-Id'
+      ROLLUP: 'Nats-Rollup'
+      MSG_TTL: 'Nats-TTL'
+      MARKER_REASON: 'Nats-Marker-Reason'
+      STREAM: 'Nats-Stream'
+      SUBJECT: 'Nats-Subject'
+      SEQUENCE: 'Nats-Sequence'
+      TIME_STAMP: 'Nats-Time-Stamp'
+      LAST_SEQUENCE: 'Nats-Last-Sequence'
+      STREAM_SOURCE: 'Nats-Stream-Source'
+      BATCH_ID: 'Nats-Batch-Id'
+      BATCH_SEQUENCE: 'Nats-Batch-Sequence'
+      BATCH_COMMIT: 'Nats-Batch-Commit'
+      SCHEDULE: 'Nats-Schedule'
+      SCHEDULE_TARGET: 'Nats-Schedule-Target'
+      SCHEDULE_SOURCE: 'Nats-Schedule-Source'
+      SCHEDULE_TTL: 'Nats-Schedule-TTL'
+      SCHEDULE_TIME_ZONE: 'Nats-Schedule-Time-Zone'
+      SCHEDULE_ROLLUP: 'Nats-Schedule-Rollup'
+      SCHEDULER: 'Nats-Scheduler'
+      SCHEDULE_NEXT: 'Nats-Schedule-Next'
+      REQUIRED_API_LEVEL: 'Nats-Required-Api-Level'
+    end
+  end
+end

data/sig/nats/io/jetstream/js/header.rbs

@@ -11,6 +11,7 @@ module NATS
         ExpectedLastMsgID: 'Nats-Expected-Last-Msg-Id'
         LastConsumerSeq: 'Nats-Last-Consumer'
         LastStreamSeq: 'Nats-Last-Stream'
+        PinId: 'Nats-Pin-Id'
       end
     end
   end

data/sig/nats/io/jetstream/js/status.rbs

@@ -6,6 +6,7 @@ module NATS
         NoMsgs: '404'
         NotFound: '404'
         RequestTimeout: '408'
+        PinIdMismatch: '423'
         ServiceUnavailable: '503'
       end
     end

data/sig/nats/io/jetstream/js.rbs

@@ -6,11 +6,13 @@ module NATS
       # class << self
       def self.next_req_to_json: (Hash[Symbol, untyped]) -> String
 
+      def self.parse_time: (String?) -> Time?
+
       def self.is_status_msg: (NATS::Msg) -> bool
 
       def self.check_503_error: (NATS::Msg) -> void
 
-      def self.from_msg: (NATS::Msg) -> NATS::JetStream::API::Error
+      def self.from_msg: (NATS::Msg) -> (NATS::JetStream::API::Error | NATS::JetStream::Error::PinIdMismatch)
 
       def self.from_error: (Hash[Symbol, untyped]) -> (
           NATS::JetStream::Error::ServiceUnavailable |

data/sig/nats/io/jetstream/manager.rbs

@@ -9,12 +9,24 @@ module NATS
 
       def delete_stream: (String, ?Hash[Symbol, untyped]) -> bool
 
-      def add_consumer: (String, JetStream::API::ConsumerConfig, ?Hash[Symbol, untyped]) -> JetStream::API::ConsumerInfo
+      def add_consumer: (String, JetStream::API::ConsumerConfig | Hash[Symbol, untyped], ?Hash[Symbol, untyped]) -> JetStream::API::ConsumerInfo
+
+      def create_consumer: (String, JetStream::API::ConsumerConfig | Hash[Symbol, untyped], ?Hash[Symbol, untyped]) -> JetStream::API::ConsumerInfo
+
+      def update_consumer: (String, JetStream::API::ConsumerConfig | Hash[Symbol, untyped], ?Hash[Symbol, untyped]) -> JetStream::API::ConsumerInfo
 
       def consumer_info: (String, String, ?Hash[Symbol, untyped]) -> JetStream::API::ConsumerInfo
 
       def delete_consumer: (String, String, ?Hash[Symbol, untyped]) -> bool
 
+      def pause_consumer: (String, String, Time | String, ?Hash[Symbol, untyped]) -> JetStream::API::ConsumerPauseResponse
+
+      def resume_consumer: (String, String, ?Hash[Symbol, untyped]) -> JetStream::API::ConsumerPauseResponse
+
+      def unpin_consumer: (String, String, String, ?Hash[Symbol, untyped]) -> bool
+
+      def reset_consumer: (String, String, ?Hash[Symbol, untyped]) -> JetStream::API::ConsumerResetResponse
+
       def find_stream_name_by_subject: (String, ?Hash[Symbol, untyped]) -> String
 
       def get_msg: (String, ?Hash[Symbol, untyped]) -> JetStream::API::RawStreamMsg
@@ -25,9 +37,17 @@ module NATS
 
       private
 
+      def upsert_consumer: (String, JetStream::API::ConsumerConfig | Hash[Symbol, untyped], String?, Hash[Symbol, untyped]) -> JetStream::API::ConsumerInfo
+
+      def request_pause: (String, String, Hash[Symbol, String], Hash[Symbol, untyped]) -> JetStream::API::ConsumerPauseResponse
+
+      def rfc3339: (Time | String | nil) -> String?
+
       def api_request: (String, String, ?Hash[Symbol, untyped]) -> Hash[Symbol, untyped]
 
       def _lift_msg_to_raw_msg: (NATS::Msg) -> JetStream::API::RawStreamMsg
+
+      def stream_config_json: (JetStream::API::StreamConfig) -> String
     end
   end
 end

data/sig/nats/io/jetstream/pull_subscription.rbs

@@ -4,11 +4,49 @@ module NATS
       class PubAck < Struct[String | Numeric | bool]
       end
 
+      UNCHECKED_PULL_AGE: Integer
+
+      def self.extended: (NATS::Subscription) -> void
+
       def next_msg: (untyped) -> void
 
-      def fetch: (Integer, Hash[Symbol, untyped]) -> Array[NATS::Msg]
+      def fetch: (Integer, Hash[Symbol, untyped]) ?{ (NATS::Msg) -> void } -> Array[NATS::Msg]
 
       def consumer_info: (Hash[Symbol, untyped]) -> NATS::JetStream::ConsumerInfo
+
+      private
+
+      def pull_and_wait: (Array[NATS::Msg], Hash[Symbol, untyped], Float) ?{ (NATS::Msg) -> void } -> bool
+
+      def pull_pending: (Array[NATS::Msg], Hash[Symbol, untyped], Float) ?{ (NATS::Msg) -> void } -> bool
+
+      def receive: (Array[NATS::Msg], Integer, String?, ^() -> NATS::Msg?) ?{ (NATS::Msg) -> void } -> bool
+
+      def release: (NATS::Subscription, Float) -> void
+
+      def hand_over: (NATS::Subscription, ?Float) -> void
+
+      def keep: (NATS::Msg) -> void
+
+      def collect: (Array[NATS::Msg], NATS::Msg) ?{ (NATS::Msg) -> void } -> void
+
+      def pull_ended?: (NATS::Msg) -> bool
+
+      def pull_expires: (Float) -> Integer
+
+      def wait_pending: (String, Float) -> NATS::Msg?
+
+      def next_pending: (?String?) -> NATS::Msg?
+
+      def next_reply: (NATS::Subscription, Float) -> NATS::Msg?
+
+      def pull: (Hash[Symbol, untyped], String) -> String?
+
+      def pop_pending: () -> NATS::Msg?
+
+      def track_pin: (NATS::Msg) -> NATS::Msg
+
+      def forget_pin: (String?) -> void
     end
   end
-end
+end

data/sig/nats/io/jetstream.rbs

@@ -6,10 +6,18 @@ module NATS
     class PubAck < Struct[String | Numeric | bool]
     end
 
-    def publish: (String, String, Hash[Symbol, untyped]) -> NATS::JetStream::PubAck
+    def publish: (String, ?String, **untyped) -> NATS::JetStream::PubAck
 
     def subscribe: (String, Hash[Symbol, untyped]) { (?(NATS::Msg | String), ?String, ?String, ?Hash[Symbol, untyped]) -> void } -> NATS::JetStream::PushSubscription
 
     def pull_subscribe: (String, String, Hash[Symbol, untyped]) -> NATS::JetStream::PullSubscription
+
+    private
+
+    def msg_ttl: (Integer | :never) -> String
+
+    def schedule_header: (target: String, ?at: Time?, ?every: Integer?, ?cron: String?, ?source: String?, ?ttl: (Integer | :never)?, ?time_zone: String?, ?rollup: bool?) -> Hash[String, String]
+
+    def nonempty_string?: (untyped) -> bool
   end
 end

data/sig/nats/io/kv/bucket_status.rbs

@@ -12,6 +12,10 @@ module NATS
       def history: () -> Integer
 
       def ttl: () -> Float
+
+      def compressed?: () -> bool
+
+      def metadata: () -> Hash[Symbol, String]?
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nats-pure
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Waldemar Quevedo
@@ -196,6 +196,7 @@ files:
 - lib/nats/io/jetstream.rb
 - lib/nats/io/jetstream/api.rb
 - lib/nats/io/jetstream/errors.rb
+- lib/nats/io/jetstream/header.rb
 - lib/nats/io/jetstream/js.rb
 - lib/nats/io/jetstream/js/config.rb
 - lib/nats/io/jetstream/js/header.rb
@@ -235,6 +236,7 @@ files:
 - sig/nats/io/jetstream.rbs
 - sig/nats/io/jetstream/api.rbs
 - sig/nats/io/jetstream/errors.rbs
+- sig/nats/io/jetstream/header.rbs
 - sig/nats/io/jetstream/js.rbs
 - sig/nats/io/jetstream/js/config.rbs
 - sig/nats/io/jetstream/js/header.rbs