volcano-sdk 0.5.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 939a91c580dbb07f0cc04f6930c2ea4be62ca7ab7f0106e93b8862d0a310d7b5
-  data.tar.gz: f577bff2cca54ae9fbb5b2375cc45c1671f17fe8372b5f087273251929488ce8
+  metadata.gz: a36dee9d50b8138335752de5e3fdb5007ecd5dfa66547150190de691a048052d
+  data.tar.gz: 97edb400526abafd980ec19278304f80cff3ead5010d7704da7b55128390879e
 SHA512:
-  metadata.gz: 5df58a522d1c82cea769ff810620b9837247781a8e13c25add391d9287fd1bee253ddd672508606f2c59eb93988790d5c68cda418b66a90cb8527a8afb5bac97
-  data.tar.gz: c742eaa7aec57e3f151cb650a10fe1fc10641f862196158c259b6cc9c5cad439df908a4603b4c7d7818b1bcdd5aa0ebbca685cd0c75c78188958a2176921955f
+  metadata.gz: 5c3e7ed134b563780e8c1d64ba26f30f7ae9563d7c2ac219a265dabbf6aa04544600ef1a963abd09f9aa3f4efc2a6e32da0adeaf9a2a45905bd793daffd4101d
+  data.tar.gz: c2abfe5361e2ccff60f6f76a77aa4e2eedc0a033d1ef7649a63c5a6fa8f1edf0996c8141cc5eede6c08e5848e24fa8159e5a550b12edc5a32d16ea6dbf4311aa

data/README.md

@@ -69,6 +69,20 @@ raise "session changed" unless current_session == session
 `current_session` reads immutable local state. It does not refresh or validate
 the token.
 
+Sessions returned by authentication retain the user payload in `session.user`,
+including metadata. The snapshot is deeply immutable and available without a
+request. It is cached data, not proof of authentication; use `auth.user` to fetch
+the server-validated profile. Existing three-field `Session` construction still
+works, with `user: nil`. An adopted snapshot must have the same user ID.
+Snapshots contain deeply frozen JSON data. Plain `Time` timestamps become UTC
+ISO8601 strings with nanosecond precision; symbols become strings. Custom objects,
+container/string/time subclasses, non-finite numbers, duplicate JSON keys, and
+structures deeper than 100 levels raise `TypeError`. Use the typed `auth.user`
+profile when you need Ruby `Time` values. Successful `user`, `update_user`,
+`convert_anonymous`, and `confirm_email_change` calls update this snapshot
+without changing credentials or emitting an authentication-state event.
+Previously returned sessions remain unchanged.
+
 ### Get the current user
 
 ```ruby
@@ -78,8 +92,8 @@ raise "wrong user" unless user.id == session.user_id
 
 `user` sends the active access token to Volcano and returns an immutable,
 server-validated `Volcano::User`. The SDK recursively freezes its strings and
-metadata, but does not cache the profile or replace the session. A session
-change while the request is in flight raises
+metadata and updates `current_session.user`. A session change while the request
+is in flight raises
 `Volcano::Error::SessionChangedError` instead of returning a stale profile.
 `get_user` is available as a cross-SDK alias.
 
@@ -95,8 +109,8 @@ raise "wrong user" unless user.id == session.user_id
 
 `update_user` changes the current user's password, metadata, or both. Metadata
 is a shallow patch: omitted keys remain unchanged, and a `nil` value removes
-that key. The method returns an immutable `Volcano::User` without replacing the
-active session. It rejects a response if another authentication operation
+that key. The method returns an immutable `Volcano::User` and updates the local
+user snapshot. It rejects a response if another authentication operation
 replaces the session while the request is in flight.
 
 ### Request a password reset email
@@ -159,8 +173,8 @@ user = client.auth.confirm_email_change(token: "email-change-token")
 puts user.email
 ```
 
-The method returns the immutable updated user without replacing the active
-session. A successful stale response is rejected if another authentication
+The method returns the immutable updated user and updates the local user
+snapshot. A successful stale response is rejected if another authentication
 operation replaces that session in flight.
 
 ### List sessions

data/lib/volcano/auth.rb

@@ -86,14 +86,21 @@ module Volcano
       owned_session(
         access_token: payload.fetch('access_token'),
         refresh_token: payload.fetch('refresh_token'),
-        user_id: payload.fetch('user').fetch('id')
+        user_id: payload.fetch('user').fetch('id'),
+        user: payload.fetch('user')
       )
     end
 
     def complete_session?(session)
       return false unless session.is_a?(Session)
 
-      session.to_h.values.all? { |value| value.is_a?(String) && !value.strip.empty? }
+      values = [session.access_token, session.refresh_token, session.user_id]
+      values.all? { |value| value.is_a?(String) && !value.strip.empty? } &&
+        matching_session_user?(session)
+    end
+
+    def matching_session_user?(session)
+      session.user.nil? || (session.user.is_a?(Hash) && session.user['id'] == session.user_id)
     end
 
     def owned_complete_session(session)
@@ -102,11 +109,12 @@ module Volcano
       owned_session(**session.to_h)
     end
 
-    def owned_session(access_token:, refresh_token:, user_id:)
+    def owned_session(access_token:, refresh_token:, user_id:, user: nil)
       Session.new(
         access_token: access_token.dup.freeze,
         refresh_token: refresh_token.dup.freeze,
-        user_id: user_id.dup.freeze
+        user_id: user_id.dup.freeze,
+        user: user
       )
     end
   end

data/lib/volcano/auth_anonymous.rb

@@ -20,10 +20,7 @@ module Volcano
         anonymous_conversion_response(current.access_token, email, password, metadata),
         200
       )
-      user = build_user(user_payload(payload))
-      raise Error::SessionChangedError unless @client.capture_session.first == generation
-
-      user
+      cache_current_user(payload, generation)
     end
 
     private

data/lib/volcano/auth_email_change.rb

@@ -30,10 +30,7 @@ module Volcano
       raise Error::AuthenticationError, 'No active session' unless current
 
       payload = Transport.body(confirm_email_change_response(current.access_token, token), 200)
-      user = build_user(user_payload(payload))
-      raise Error::SessionChangedError unless @client.capture_session.first == generation
-
-      user
+      cache_current_user(payload, generation)
     end
 
     private

data/lib/volcano/auth_get_user.rb

@@ -19,16 +19,21 @@ module Volcano
       raise Error::AuthenticationError, 'No active session' unless current
 
       payload = Transport.body(get_user_response(current.access_token), 200)
-      user = build_user(user_payload(payload))
-      raise Error::SessionChangedError unless @client.capture_session.first == generation
-
-      user
+      cache_current_user(payload, generation)
     end
 
     alias get_user user
 
     private
 
+    def cache_current_user(payload, generation)
+      profile = user_payload(payload)
+      user = build_user(profile)
+      raise Error::SessionChangedError unless @client.update_session_user_if_current?(profile, generation)
+
+      user
+    end
+
     def get_user_response(access_token)
       Transport.invoke do
         @transport.auth_get_user(authorization: access_token)

data/lib/volcano/auth_state.rb

@@ -50,10 +50,9 @@ module Volcano
 
     def store_if_current?(session, generation, event: :signed_in, notifications: nil)
       dispatch = @mutex.synchronize do
-        callbacks = replace_if_current(session, generation, event)
-        return false unless callbacks
+        return false unless generation == @generation
 
-        enqueue_notification(callbacks, event, session)
+        enqueue_notification(replace(session, event), event, session)
       end
       return true unless dispatch
 
@@ -61,6 +60,16 @@ module Volcano
       true
     end
 
+    def update_user_if_current?(user, generation)
+      @mutex.synchronize do
+        return false unless generation == @generation && @session
+        raise Error::AuthenticationError, 'Profile belongs to a different user' unless user['id'] == @session.user_id
+
+        @session = Session.new(**@session.to_h, user: user)
+        true
+      end
+    end
+
     def subscribe(&callback)
       callback_id, dispatch = @mutex.synchronize do
         id, current = register(callback)
@@ -79,12 +88,6 @@ module Volcano
       @callbacks.keys
     end
 
-    def replace_if_current(session, generation, event)
-      return unless generation == @generation
-
-      replace(session, event)
-    end
-
     def register(callback)
       callback_id = @next_callback_id
       @next_callback_id += 1
@@ -130,7 +133,7 @@ module Volcano
     def notify(callback_ids, event, session)
       failure = nil
       callback_ids.each do |callback_id|
-        notify_callback(callback_id, event, session)
+        @mutex.synchronize { @callbacks[callback_id] }&.call(event, session)
       rescue StandardError => e
         Warning.warn("Volcano auth-state callback failed (#{e.class})\n")
       rescue *CALLBACK_FAILURES => e
@@ -139,10 +142,5 @@ module Volcano
       end
       failure
     end
-
-    def notify_callback(callback_id, event, session)
-      callback = @mutex.synchronize { @callbacks[callback_id] }
-      callback&.call(event, session)
-    end
   end
 end

data/lib/volcano/auth_update_user.rb

@@ -11,10 +11,7 @@ module Volcano
         update_user_response(current.access_token, password:, metadata:),
         200
       )
-      user = build_user(user_payload(payload))
-      raise Error::SessionChangedError unless @client.capture_session.first == generation
-
-      user
+      cache_current_user(payload, generation)
     end
 
     private

data/lib/volcano/client.rb

@@ -89,6 +89,10 @@ module Volcano
       @auth_state.subscribe(...)
     end
 
+    def update_session_user_if_current?(...)
+      @auth_state.update_user_if_current?(...)
+    end
+
     private
 
     def database_with_token(name, token)

data/lib/volcano/models.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Volcano
-  Session = Data.define(:access_token, :refresh_token, :user_id)
   AUTH_SESSION_ATTRIBUTES = %i[
     id user_id provider expires_at is_active is_current user_agent ip_address last_ip_address
     last_activity_at session_started_at created_at updated_at

data/lib/volcano/session.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'time'
+
+module Volcano
+  SESSION_USER_CODER = JSON::Coder.new(freeze: true, allow_duplicate_key: false) do |value|
+    value.instance_of?(Time) ? Time.at(value.to_r).utc.iso8601(9) : value
+  end
+  private_constant :SESSION_USER_CODER
+
+  # In-memory credentials with an optional, unverified local user snapshot.
+  Session = Data.define(:access_token, :refresh_token, :user_id, :user) do
+    def initialize(access_token:, refresh_token:, user_id:, user: nil)
+      super(access_token:, refresh_token:, user_id:, user: immutable_user(user))
+    end
+
+    private
+
+    def immutable_user(value)
+      SESSION_USER_CODER.load(SESSION_USER_CODER.dump(value))
+    rescue JSON::GeneratorError, JSON::NestingError
+      raise TypeError, 'Session user snapshot must contain JSON values or timestamps', cause: nil
+    end
+  end
+end

data/lib/volcano/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Volcano
-  VERSION = '0.5.3'
+  VERSION = '0.7.0'
 end

data/lib/volcano.rb

@@ -3,6 +3,7 @@
 require_relative 'volcano/version'
 require_relative 'volcano/connection_string'
 require_relative 'volcano/models'
+require_relative 'volcano/session'
 require_relative 'volcano/function_response'
 require_relative 'volcano/log_responses'
 require_relative 'volcano/storage_models'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: volcano-sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Kong
@@ -65,6 +65,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -560,6 +574,7 @@ files:
 - lib/volcano/realtime/protocol_recovery_position.rb
 - lib/volcano/realtime/reconnect.rb
 - lib/volcano/redaction.rb
+- lib/volcano/session.rb
 - lib/volcano/sign_up_result.rb
 - lib/volcano/storage.rb
 - lib/volcano/storage_models.rb