smplkit 2.0.2 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18065d9f25f15af5d853a49d46f1263388359c7acaffa765ca7b98e5d2420a98
-  data.tar.gz: 7f386e4671aa2d5e339264007ba46a7b41c9a9cfa47ff1580514aee3248ebd86
+  metadata.gz: 11737e77b9c137965fcfb0f98d42cca4180131afd974aaa4d7b7107813dbc709
+  data.tar.gz: bf468bfdf381a811581a9a7dabd03aaec863bf37e77a13e7788128179987d430
 SHA512:
-  metadata.gz: e57e30ebc91651ba5376fc6fde90f5ba4550320470d5e9ae7192b15d4b2e5ce0a5492cdc753f2d04892f897cd7d29422c42c6c3e96008a675c53f1a9dfd24983
-  data.tar.gz: 03eca6e00372adf7cebbdebc719f98ffdc3b2ae0768ba788e1205d29abbeeef8755e32a58a14cee8ac52685274de53ecd15bad4c8c07009fac99f4bd7dcfd132
+  metadata.gz: 4956121ef13bc54257048233a7adcb8a35b7d7d8bcfd82e86eecf4776334c33dcfb30cd12dc486d9df0165d493863a4eaa61df0123a6f926d3f2018dff80fe5c
+  data.tar.gz: b6522291313374b8315de8d9883db6af3cdbf1a6d31dee45f2f49aea9c6c7d03b74e309481ffe1adf5f85fdd0cec8244d4c7114ff188ff70be8c3ea7a5f38d66

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/usage_attributes.rb

@@ -0,0 +1,217 @@
+=begin
+#smplkit Audit API
+
+#Append-only change-history substrate for smpl.* resources and customer-application events. ADR-047.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::Audit
+  # Attribute set for a usage resource.  The shape mirrors the ``/api/v1/usage`` contract used by config, flags, and logging — three fields, no per-product extras. Per-period limits live in the product catalog (``GET /api/v1/products``); the usage endpoint reports counts only.
+  class UsageAttributes < ApiModelBase
+    attr_accessor :limit_key
+
+    attr_accessor :period
+
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'limit_key' => :'limit_key',
+        :'period' => :'period',
+        :'value' => :'value'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'limit_key' => :'String',
+        :'period' => :'String',
+        :'value' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::UsageAttributes` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::UsageAttributes`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'limit_key')
+        self.limit_key = attributes[:'limit_key']
+      else
+        self.limit_key = nil
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      else
+        self.period = nil
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      else
+        self.value = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @limit_key.nil?
+        invalid_properties.push('invalid value for "limit_key", limit_key cannot be nil.')
+      end
+
+      if @period.nil?
+        invalid_properties.push('invalid value for "period", period cannot be nil.')
+      end
+
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @limit_key.nil?
+      return false if @period.nil?
+      return false if @value.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] limit_key Value to be assigned
+    def limit_key=(limit_key)
+      if limit_key.nil?
+        fail ArgumentError, 'limit_key cannot be nil'
+      end
+
+      @limit_key = limit_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] period Value to be assigned
+    def period=(period)
+      if period.nil?
+        fail ArgumentError, 'period cannot be nil'
+      end
+
+      @period = period
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] value Value to be assigned
+    def value=(value)
+      if value.nil?
+        fail ArgumentError, 'value cannot be nil'
+      end
+
+      @value = value
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          limit_key == o.limit_key &&
+          period == o.period &&
+          value == o.value
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [limit_key, period, value].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/usage_resource.rb

@@ -45,7 +45,7 @@ module SmplkitGeneratedClient::Audit
       {
         :'id' => :'String',
         :'type' => :'String',
-        :'attributes' => :'Hash<String, Object>'
+        :'attributes' => :'UsageAttributes'
       }
     end
 
@@ -84,9 +84,7 @@ module SmplkitGeneratedClient::Audit
       end
 
       if attributes.key?(:'attributes')
-        if (value = attributes[:'attributes']).is_a?(Hash)
-          self.attributes = value
-        end
+        self.attributes = attributes[:'attributes']
       else
         self.attributes = nil
       end

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client.rb

@@ -39,6 +39,7 @@ require 'smplkit_audit_client/models/http_header'
 require 'smplkit_audit_client/models/retry_failed_deliveries_summary'
 require 'smplkit_audit_client/models/test_forwarder_request'
 require 'smplkit_audit_client/models/test_forwarder_response'
+require 'smplkit_audit_client/models/usage_attributes'
 require 'smplkit_audit_client/models/usage_resource'
 require 'smplkit_audit_client/models/usage_response'
 

data/lib/smplkit/_generated/audit/spec/models/usage_attributes_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#smplkit Audit API
+
+#Append-only change-history substrate for smpl.* resources and customer-application events. ADR-047.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Audit::UsageAttributes
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Audit::UsageAttributes do
+  #let(:instance) { SmplkitGeneratedClient::Audit::UsageAttributes.new }
+
+  describe 'test an instance of UsageAttributes' do
+    it 'should create an instance of UsageAttributes' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::UsageAttributes)
+    end
+  end
+
+  describe 'test attribute "limit_key"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "period"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "value"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/flags/client.rb

@@ -79,6 +79,9 @@ module Smplkit
     # +mgmt.flags.*+. Per-request context is set via
     # +client.set_context([...])+.
     class FlagsClient
+      INITIAL_START_RETRY_DELAY = 1.0
+      MAX_START_RETRY_DELAY = 60.0
+
       def initialize(parent, manage:, metrics:, flags_base_url:, app_base_url:)
         @parent = parent
         @manage = manage
@@ -90,6 +93,9 @@ module Smplkit
 
         @flag_store = {}
         @connected = false
+        @ws_subscribed = false
+        @next_start_attempt_at = 0.0
+        @start_retry_delay = INITIAL_START_RETRY_DELAY
         @cache = ResolutionCache.new
         @handles = {}
         @global_listeners = []
@@ -116,24 +122,44 @@ module Smplkit
 
       # Eagerly initialize the flags subclient.
       #
-      # Drains any pending flag-declaration buffer, fetches all flag
+      # Flushes any pending flag-declaration buffer, fetches all flag
       # definitions, opens the shared WebSocket and subscribes to
       # +flag_changed+ / +flag_deleted+ / +flags_changed+ events.
       #
       # Idempotent — safe to call multiple times. Called automatically on
       # first +flag.get+ evaluation if not invoked manually.
+      #
+      # If the flags-service is unhealthy (e.g. a coordinated rebuild where
+      # the app pod starts before the schema is loaded), the flush or refresh
+      # will fail. Pending declarations stay queued, the client remains
+      # disconnected, and the next call retries after an exponentially
+      # backed-off delay (capped at +MAX_START_RETRY_DELAY+ seconds).
+      # Evaluations during that window fall back to handle defaults.
       def start
         return if @connected
+        return if Process.clock_gettime(Process::CLOCK_MONOTONIC) < @next_start_attempt_at
 
         @environment = @parent._environment
-        flush_flags_safely
-        refresh
+
+        begin
+          @manage.flags.flush
+          refresh
+        rescue StandardError => e
+          schedule_start_retry(e)
+          return
+        end
+
         @connected = true
+        @start_retry_delay = INITIAL_START_RETRY_DELAY
+        @next_start_attempt_at = 0.0
 
         @ws_manager = @parent._ensure_ws
+        return if @ws_subscribed
+
         @ws_manager.on("flag_changed") { |data| handle_flag_changed(data) }
         @ws_manager.on("flag_deleted") { |data| handle_flag_deleted(data) }
         @ws_manager.on("flags_changed") { |data| handle_flags_changed(data) }
+        @ws_subscribed = true
       end
 
       def refresh
@@ -217,10 +243,12 @@ module Smplkit
         handle
       end
 
-      def flush_flags_safely
-        @manage.flags.flush
-      rescue StandardError => e
-        Smplkit.debug("registration", "bulk flag registration failed: #{e.class}: #{e.message}")
+      def schedule_start_retry(exc)
+        delay = @start_retry_delay
+        @next_start_attempt_at = Process.clock_gettime(Process::CLOCK_MONOTONIC) + delay
+        @start_retry_delay = [delay * 2, MAX_START_RETRY_DELAY].min
+        Smplkit.debug("registration",
+                      "flags client start failed (will retry in #{delay}s): #{exc.class}: #{exc.message}")
       end
 
       def fetch_all_flags

data/lib/smplkit/management/buffer.rb

@@ -42,6 +42,10 @@ module Smplkit
     end
 
     # Thread-safe batch buffer for flag declarations.
+    #
+    # Use +peek+ + +commit(ids)+ for the send path so a failed POST leaves
+    # declarations queued for the next attempt. +drain+ is unconditional and
+    # used only by tests/teardown.
     class FlagRegistrationBuffer
       def initialize
         @seen = {}
@@ -61,6 +65,17 @@ module Smplkit
         end
       end
 
+      def peek
+        @lock.synchronize { @pending.dup }
+      end
+
+      def commit(ids)
+        return if ids.nil? || ids.empty?
+
+        committed = ids.to_set
+        @lock.synchronize { @pending.reject! { |item| committed.include?(item["id"]) } }
+      end
+
       def drain
         @lock.synchronize do
           batch = @pending

data/lib/smplkit/management/client.rb

@@ -538,11 +538,24 @@ module Smplkit
 
       def register(declaration)
         @buffer.add(declaration)
-        flush if @buffer.pending_count >= Management::FLAG_BATCH_FLUSH_SIZE
+        return unless @buffer.pending_count >= Management::FLAG_BATCH_FLUSH_SIZE
+
+        begin
+          flush
+        rescue StandardError => e
+          Smplkit.debug("registration", "threshold flag flush failed: #{e.class}: #{e.message}")
+        end
       end
 
+      # POST pending declarations to the bulk endpoint.
+      #
+      # Items remain in the buffer until the request succeeds, so a flush
+      # against an unhealthy service is automatically retried by the next
+      # +flush+ call (lazy +start+ retry, periodic background flush, or
+      # final flush on close). Raises on failure — callers decide whether
+      # to retry.
       def flush
-        batch = @buffer.drain
+        batch = @buffer.peek
         return if batch.empty?
 
         flag_items = batch.map do |entry|
@@ -553,8 +566,11 @@ module Smplkit
         end
         body = SmplkitGeneratedClient::Flags::FlagBulkRequest.new(flags: flag_items)
         ErrorMapping.call { @api.bulk_register_flags(body) }
-      rescue StandardError => e
-        Smplkit.debug("registration", "flag flush failed: #{e.class}: #{e.message}")
+        @buffer.commit(batch.map { |b| b["id"] })
+      end
+
+      def pending_count
+        @buffer.pending_count
       end
 
       def list

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.4
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -403,6 +403,7 @@ files:
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/retry_failed_deliveries_summary.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/test_forwarder_request.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/test_forwarder_response.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/usage_attributes.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/usage_resource.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/usage_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/version.rb
@@ -430,6 +431,7 @@ files:
 - lib/smplkit/_generated/audit/spec/models/retry_failed_deliveries_summary_spec.rb
 - lib/smplkit/_generated/audit/spec/models/test_forwarder_request_spec.rb
 - lib/smplkit/_generated/audit/spec/models/test_forwarder_response_spec.rb
+- lib/smplkit/_generated/audit/spec/models/usage_attributes_spec.rb
 - lib/smplkit/_generated/audit/spec/models/usage_resource_spec.rb
 - lib/smplkit/_generated/audit/spec/models/usage_response_spec.rb
 - lib/smplkit/_generated/audit/spec/spec_helper.rb