smplkit 3.0.134 → 3.0.135

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf2f498b2e69289af423a44bb47b11c024cb9fa6f6a5d92c59c9386a2495636c
-  data.tar.gz: 6427e58289966df501d6484c772c662256e16536d346b60681268bb1f7a93aba
+  metadata.gz: 0c1cba1222e1ec1109993202959fa417b65752d969da90230f6f4ed913de9753
+  data.tar.gz: d1656093905daa0e565c6fb20c482b922251d2a4eb0dfbc7ca8684bc323abac5
 SHA512:
-  metadata.gz: 1f34027f5bd130aab9c529b2336c81bae00c1ebe17c28128a3abddd9ba6adeea2c437a858e7aaba2f008a4526dc5eb09240c4e569f07dd2071179f653c449078
-  data.tar.gz: 5c341e78b89c8a5b8ad314a7fd75867b8937817dbe43e86b4f7f572acbbb73ed4d6ac11a9aea05fa83a98a0c29f3cb46efeb174a6693be6374d54068e0b4fa59
+  metadata.gz: 4c18d2ec862ee1ad4b58539f326aaa55e6868de62205fe037998a00f90cb6d3c60676d80ab3f94771d8923d9c08543133d861358dc9c18dd1ff35a57ae15e783
+  data.tar.gz: d9225dd299dbbeac794f58a7fbd48713e10166e4f7e266a4eedd4ead1649c7315542de018a5d1bfe1aa1796cb7f82d4c04bfac4fdab30ab1ecd21ac4ba48ad2c

data/lib/smplkit/client.rb

@@ -102,7 +102,7 @@ module Smplkit
                    MetricsReporter.new(http_client: @app_http, environment: cfg.environment, service: cfg.service)
                  end
 
-      @ws_manager = nil
+      @event_stream = nil
       # Platform's cross-cutting CRUD on one client; wired into this parent so
       # it borrows the shared app transport, and owns the context-registration
       # buffer. Built BEFORE flags so the contexts seam below is available.
@@ -111,17 +111,17 @@ module Smplkit
       # (the settings sub-client uses Faraday directly).
       @account = Account::AccountClient.new(api_key: cfg.api_key, base_url: app_url, extra_headers: extra_headers)
       # Config's full surface on one client; wired into this parent so it
-      # borrows the shared config transport and WebSocket.
+      # borrows the shared config transport and event stream.
       @config = Config::ConfigClient.new(parent: self, transport: @transports.config_http, metrics: @metrics)
       # Flags' full surface on one client; wired into this parent so it borrows
-      # the shared flags transport and WebSocket. ``contexts`` is the injection
-      # seam for evaluation-context registration, wired to
+      # the shared flags transport and event stream. ``contexts`` is the
+      # injection seam for evaluation-context registration, wired to
       # ``client.platform.contexts``.
       @flags = Flags::FlagsClient.new(
         parent: self, transport: @transports.flags_http, contexts: @platform.contexts, metrics: @metrics
       )
       # Logging's full surface on one client; wired into this parent so it
-      # borrows the shared logging transport and WebSocket. The two management
+      # borrows the shared logging transport and event stream. The two management
       # sub-clients live at client.logging.loggers / client.logging.log_groups.
       @logging = Logging::LoggingClient.new(parent: self, transport: @transports.logging_http, metrics: @metrics)
       # Audit's full surface on one client; this runtime instance scopes audit
@@ -148,35 +148,35 @@ module Smplkit
       @init_thread = nil
     end
 
-    # Optionally pre-warm the SDK and block until the live socket is up.
+    # Optionally pre-warm the SDK and block until the live stream is up.
     #
     # Eagerly connects config and flags — flushing discovery, pre-fetching all
-    # flags and configs into the local cache, opening the live-updates WebSocket
-    # — and waits for the handshake to complete. After this returns, +flag.get+
-    # / +client.config.subscribe+ hit cache (no first-request connect tax) and
-    # any +on_change+ listeners receive every server event from this point
-    # forward.
+    # flags and configs into the local cache, opening the live-updates event
+    # stream — and waits for the connect to complete. After this returns,
+    # +flag.get+ / +client.config.subscribe+ hit cache (no first-request
+    # connect tax) and any +on_change+ listeners receive every server event
+    # from this point forward.
     #
     # Optional: config and flags connect lazily on first live use, so this is
-    # purely a pre-warm / WebSocket-ready barrier. Logging integration is *not*
+    # purely a pre-warm / stream-ready barrier. Logging integration is *not*
     # connected here — call +client.logging.install+ separately if you want it
     # (it installs adapters and hooks into your application's logger, which
     # should be opt-in).
     #
     # @param timeout [Float] Maximum seconds to wait for the live-updates
-    #   WebSocket handshake before giving up. Defaults to +10.0+.
+    #   event stream to connect before giving up. Defaults to +10.0+.
     # @return [void]
-    # @raise [Smplkit::TimeoutError] If the WebSocket fails to connect within
-    #   +timeout+ seconds.
+    # @raise [Smplkit::TimeoutError] If the event stream fails to connect
+    #   within +timeout+ seconds.
     def wait_until_ready(timeout: 10.0)
       @flags._ensure_connected
       @config._ensure_connected
-      ws = _ensure_ws
+      stream = _ensure_event_stream
       deadline = monotonic_now + timeout
-      while ws.connection_status != "connected"
+      while stream.connection_status != "connected"
         if monotonic_now >= deadline
-          raise TimeoutError, "Live-updates websocket did not connect within #{timeout}s " \
-                              "(status: #{ws.connection_status.inspect})"
+          raise TimeoutError, "Live-updates event stream did not connect within #{timeout}s " \
+                              "(status: #{stream.connection_status.inspect})"
         end
 
         sleep(0.05)
@@ -235,8 +235,8 @@ module Smplkit
       @logging._close
       @flags._close
       @audit._close
-      @ws_manager&.stop
-      @ws_manager = nil
+      @event_stream&.stop
+      @event_stream = nil
       # Close the shared per-service HTTP transports (app/config/flags/logging/
       # jobs). client.platform/account borrow the app transport and close
       # nothing; client.audit owns and closed its own transport above.
@@ -256,7 +256,7 @@ module Smplkit
     #
     # Idempotent and thread-safe (lock + flag); a no-op after +close+. Triggered
     # by the first config/flags/logging operation, +set_context+,
-    # +wait_until_ready+, or WebSocket open — never at construction.
+    # +wait_until_ready+, or event stream open — never at construction.
     def _ensure_started
       @start_lock.synchronize do
         return if @started || @closed
@@ -267,13 +267,13 @@ module Smplkit
       @init_thread = Thread.new { register_service_context }
     end
 
-    def _ensure_ws
+    def _ensure_event_stream
       _ensure_started
-      if @ws_manager.nil?
-        @ws_manager = SharedWebSocket.new(app_base_url: @app_base_url, api_key: @api_key, metrics: @metrics)
-        @ws_manager.start
+      if @event_stream.nil?
+        @event_stream = EventStream.new(app_base_url: @app_base_url, api_key: @api_key, metrics: @metrics)
+        @event_stream.start
       end
-      @ws_manager
+      @event_stream
     end
 
     private

data/lib/smplkit/config/client.rb

@@ -14,17 +14,17 @@
 #   resolved read), +bind+ (a live Struct/Hash binding), +on_change+, and
 #   +refresh+. The first live call transparently flushes discovery, fetches and
 #   resolves every config into the local cache, and opens the live-updates
-#   WebSocket — no explicit install step.
+#   event stream — no explicit install step.
 #
 # The client supports two construction shapes:
 #
 # * *Wired* into +Smplkit::Client+ — borrows the parent's config transport for
-#   both runtime fetch and CRUD and the parent's shared WebSocket for the live
-#   channel. This is the common path.
+#   both runtime fetch and CRUD and the parent's shared event stream for the
+#   live channel. This is the common path.
 # * *Standalone* — +ConfigClient.new(api_key: ..., base_url: ..., ...)+ builds
 #   and owns its own config transport, and on first live use opens and owns its
-#   own WebSocket. +close+ tears down only the owned transport and owned
-#   WebSocket.
+#   own event stream. +close+ tears down only the owned transport and owned
+#   event stream.
 module Smplkit
   module Config
     # Module-level helpers for the config client. Extracted so they can be
@@ -339,7 +339,7 @@ module Smplkit
     # resolver fills in whatever is missing (+~/.smplkit+ / env vars /
     # defaults). +environment+/+service+ resolve the same way (constructor
     # argument wins). The app base URL is returned alongside so a standalone
-    # client can open its own WebSocket against the event gateway.
+    # client can open its own event stream against the app service.
     #
     # @api private
     # @param api_key [String, nil] API key, or +nil+ to resolve it.
@@ -392,7 +392,7 @@ module Smplkit
     # is pure CRUD. The live surface (+subscribe+ / +get_value+ / +bind+ /
     # +on_change+ / +refresh+) connects lazily on first use — the first call
     # flushes discovery, fetches and resolves all configs into the local cache,
-    # and opens the live-updates WebSocket. No explicit install step is
+    # and opens the live-updates event stream. No explicit install step is
     # required.
     class ConfigClient
       # Sentinel distinguishing "no default supplied" from an explicit +nil+
@@ -418,8 +418,8 @@ module Smplkit
       # @param debug [Boolean, nil] Enable SDK debug logging.
       # @param extra_headers [Hash{String => String}, nil] Extra headers
       #   attached to every request.
-      # @param streaming [Boolean] Live updates over WebSocket (default
-      #   +true+): the first live call opens a shared socket and config changes
+      # @param streaming [Boolean] Live updates over the event stream (default
+      #   +true+): the first live call opens a shared stream and config changes
       #   stream in. Set +false+ for the stateless read-through surface: the
       #   first live call still fetches and resolves every config once
       #   (blocking), reads stay local, +refresh+ re-fetches on demand, and NO
@@ -478,8 +478,8 @@ module Smplkit
         @connected = false
         @lock = Mutex.new
         @listeners = [] # [callback, config_id_or_nil, item_key_or_nil]
-        @ws_manager = nil
-        @owns_ws = false
+        @event_stream = nil
+        @owns_stream = false
       end
 
       # ----------------------------------------------------------------
@@ -648,7 +648,7 @@ module Smplkit
       # authoritative and synced onto the bound object; if it is brand-new, the
       # cache entry is seeded in-memory from the bound object's values resolved
       # through its bound parent chain (no network round-trip). On every
-      # WebSocket-delivered change thereafter the bound object is mutated in
+      # stream-delivered change thereafter the bound object is mutated in
       # place. Readers always see the current resolved value with no proxy
       # indirection.
       #
@@ -677,7 +677,7 @@ module Smplkit
 
         parent_id = register_binding_declaration(id, config, parent)
 
-        # Register the binding BEFORE syncing so WebSocket dispatch finds it.
+        # Register the binding BEFORE syncing so event dispatch finds it.
         @bindings[id] = config
         @bound_parents[id] = parent_id
         seed_or_sync_binding(id, config)
@@ -803,17 +803,17 @@ module Smplkit
 
       # Release resources — only those this client owns.
       #
-      # Tears down the owned WebSocket (opened by a standalone client on first
-      # live use) and the owned HTTP transport (standalone construction). A
-      # wired client borrows the parent's transport and WebSocket and closes
-      # neither.
+      # Tears down the owned event stream (opened by a standalone client on
+      # first live use) and the owned HTTP transport (standalone construction).
+      # A wired client borrows the parent's transport and event stream and
+      # closes neither.
       #
       # @return [void]
       def close
-        if @owns_ws && @ws_manager
-          @ws_manager.stop
-          @ws_manager = nil
-          @owns_ws = false
+        if @owns_stream && @event_stream
+          @event_stream.stop
+          @event_stream = nil
+          @owns_stream = false
         end
         nil
       end
@@ -848,29 +848,31 @@ module Smplkit
       private
 
       # ----------------------------------------------------------------
-      # Live surface: lazy connect + transport / WebSocket helpers
+      # Live surface: lazy connect + transport / event stream helpers
       # ----------------------------------------------------------------
 
-      def ensure_ws
-        return @parent._ensure_ws unless @parent.nil?
+      def ensure_event_stream
+        return @parent._ensure_event_stream unless @parent.nil?
 
-        if @ws_manager.nil?
-          @ws_manager = SharedWebSocket.new(
+        if @event_stream.nil?
+          @event_stream = EventStream.new(
             app_base_url: @app_base_url, api_key: @standalone_api_key, metrics: @metrics
           )
-          @ws_manager.start
-          @owns_ws = true
+          @event_stream.start
+          @owns_stream = true
         end
-        @ws_manager
+        @event_stream
       end
 
       # Open the live connection to the running Smpl Config service.
       #
       # Flushes any buffered discovery declarations, fetches and resolves every
       # config for the configured environment into the local cache, opens the
-      # shared WebSocket, and subscribes to +config_changed+ / +config_deleted+
-      # / +configs_changed+ events. In stateless mode (+streaming: false+) no
-      # socket is ever created; +refresh+ re-fetches on demand.
+      # shared event stream, and subscribes to +config_changed+ /
+      # +config_deleted+ / +configs_changed+ events. Also registers the
+      # bulk-refresh path as the stream's reconnect refetch, so a stream outage
+      # ends with a full re-sync. In stateless mode (+streaming: false+) no
+      # stream is ever created; +refresh+ re-fetches on demand.
       #
       # Idempotent and internal — every live method calls it on first use, so
       # the live surface auto-connects with no explicit step.
@@ -892,10 +894,11 @@ module Smplkit
         @connected = true
         return unless @streaming
 
-        @ws_manager = ensure_ws
-        @ws_manager.on("config_changed") { |data| handle_config_changed(data) }
-        @ws_manager.on("config_deleted") { |data| handle_config_deleted(data) }
-        @ws_manager.on("configs_changed") { |data| handle_configs_changed(data) }
+        @event_stream = ensure_event_stream
+        @event_stream.on("config_changed") { |data| handle_config_changed(data) }
+        @event_stream.on("config_deleted") { |data| handle_config_deleted(data) }
+        @event_stream.on("configs_changed") { |data| handle_configs_changed(data) }
+        @event_stream.on_reconnect { handle_configs_changed({}) }
       end
 
       # List configs directly from the API for the runtime cache.
@@ -1047,7 +1050,7 @@ module Smplkit
       #
       # A freshly-bound config lives only as a seed until it is flushed and
       # fetched; without this, any cache rebuild (a manual refresh, or a
-      # WebSocket event for another config) would drop it. Server-present
+      # push event for another config) would drop it. Server-present
       # configs are already in +new_cache+ and are authoritative — only bound
       # ids missing from it are re-seeded.
       def merge_pending_seeds(new_cache)
@@ -1124,7 +1127,7 @@ module Smplkit
       end
 
       # ----------------------------------------------------------------
-      # Internal: event handlers (called by SharedWebSocket)
+      # Internal: event handlers (called by EventStream)
       # ----------------------------------------------------------------
 
       # Re-resolve every config in +store+ and fire change listeners.
@@ -1189,7 +1192,7 @@ module Smplkit
 
           new_store[key] = cfg
           ensure_ancestors_cached(new_store)
-          rebuild_from_store(new_store, source: "websocket")
+          rebuild_from_store(new_store, source: "push")
         rescue StandardError => e
           Smplkit.debug("config", "config_changed handler failed for #{key.inspect}: #{e.class}: #{e.message}")
         end
@@ -1202,11 +1205,11 @@ module Smplkit
         new_store = @lock.synchronize { @raw_config_store.dup }
         return if new_store.delete(key).nil?
 
-        rebuild_from_store(new_store, source: "websocket")
+        rebuild_from_store(new_store, source: "push")
       end
 
       def handle_configs_changed(_data)
-        do_refresh("websocket")
+        do_refresh("push")
       rescue StandardError => e
         Smplkit.debug("config", "configs_changed refresh failed: #{e.class}: #{e.message}")
       end