tarantool-client 0.1.0

data/lib/tarantool/client.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require 'msgpack'
+require 'bigdecimal'
+
+require_relative 'client/version'
+require_relative 'client/errors'
+require_relative 'client/configuration'
+require_relative 'client/backoff'
+require_relative 'client/thread_join'
+require_relative 'client/protocol/constants'
+require_relative 'client/box_error'
+require_relative 'client/uuid'
+require_relative 'client/interval'
+require_relative 'client/protocol/extensions'
+require_relative 'client/protocol/extensions/error'
+require_relative 'client/protocol/extensions/uuid'
+require_relative 'client/protocol/extensions/decimal'
+require_relative 'client/protocol/extensions/datetime'
+require_relative 'client/protocol/extensions/interval'
+require_relative 'client/protocol/response'
+require_relative 'client/protocol/codec'
+require_relative 'client/protocol/greeting'
+require_relative 'client/protocol/auth/chap_sha1'
+require_relative 'client/protocol/requests/ping'
+require_relative 'client/protocol/requests/select'
+require_relative 'client/protocol/requests/insert'
+require_relative 'client/protocol/requests/replace'
+require_relative 'client/protocol/requests/update'
+require_relative 'client/protocol/requests/upsert'
+require_relative 'client/protocol/requests/delete'
+require_relative 'client/protocol/requests/call'
+require_relative 'client/protocol/requests/eval'
+require_relative 'client/protocol/requests/execute'
+require_relative 'client/protocol/requests/prepare'
+require_relative 'client/protocol/requests/begin'
+require_relative 'client/protocol/requests/commit'
+require_relative 'client/protocol/requests/rollback'
+require_relative 'client/protocol/requests/auth'
+require_relative 'client/protocol/requests/id'
+require_relative 'client/protocol/requests/watch'
+require_relative 'client/protocol/requests/unwatch'
+require_relative 'client/transport/future'
+require_relative 'client/transport/pending_requests'
+require_relative 'client/transport/stream_ids'
+require_relative 'client/transport/deadline'
+require_relative 'client/transport/timed_lock'
+require_relative 'client/transport/timed_read'
+require_relative 'client/transport/frame_writer'
+require_relative 'client/transport/handshake'
+require_relative 'client/transport/connection'
+require_relative 'client/transport/link_state'
+require_relative 'client/transport/link'
+require_relative 'client/index_info'
+require_relative 'client/space_info'
+require_relative 'client/schema'
+require_relative 'client/schema_cache'
+require_relative 'client/sql_result'
+require_relative 'client/prepared_statement'
+require_relative 'client/transaction_schema'
+require_relative 'client/operations'
+require_relative 'client/transaction_scope'
+require_relative 'client/stream'
+require_relative 'client/callback_guard'
+require_relative 'client/watcher'
+require_relative 'client/watchers'
+require_relative 'client/watchers/dispatcher'
+require_relative 'client/fork_safety'
+require_relative 'client/pool'
+require_relative 'client/pool/member_fork_safety'
+require_relative 'client/pool/member'
+
+module Tarantool
+  # Connection to one Tarantool instance. Safe to share between threads and fibers.
+  class Client
+    include Operations
+    include ForkSafety
+
+    attr_reader :config
+
+    # @api private
+    # Called when the connection is lost, before the first reconnect attempt, then again on the watcher
+    # dispatcher thread after every event of the lost connection and before any of the next one.
+    attr_writer :disconnect_handler
+
+    def initialize(uri = nil, **)
+      @config = Configuration.build(uri, **)
+      @pid = Process.pid
+      @reinit_lock = Mutex.new
+      open_link
+    rescue StandardError
+      @link&.close
+      raise
+    end
+
+    def server_version
+      ensure_fork_safe
+      @link.greeting.version
+    end
+
+    def connected?
+      @pid == Process.pid && @link.connected?
+    end
+
+    def transaction(isolation: :default, timeout: nil, &block)
+      ensure_fork_safe
+      TransactionScope.enter(self) do
+        stream = Stream.new(
+          connection: @link.connection, schema_cache: @schema_cache, id: @stream_ids.next,
+          request_timeout: @config.request_timeout
+        )
+        stream.transaction(isolation:, timeout:, &block)
+      end
+    end
+
+    # The block gets the current value first (nil if the key was never broadcast), then every
+    # change. It runs on a dispatcher thread shared by all watchers of this client, so a slow
+    # block delays the others; exceptions it raises are reported with warn. Calling #unwatch
+    # from another thread may still let one in-flight callback run. After a reconnect the block
+    # is called again with the current value.
+    def watch(key, &block)
+      raise ArgumentError, 'watch requires a block' unless block
+
+      ensure_fork_safe
+      @watchers.add(key, block)
+    end
+
+    def close
+      @link.close
+
+      @watchers.close
+    end
+
+    def inspect
+      "#<#{self.class.name} #{@config.address}>"
+    end
+
+    private
+
+    def link_hooks = { on_connect: method(:load_schema), on_ready: method(:resubscribe), on_lost: method(:lost) }
+
+    def perform(request, timeout: nil, schema_version: nil, on_push: nil)
+      ensure_fork_safe
+      @link.perform(request, timeout: timeout || @config.request_timeout, schema_version:, on_push:)
+    end
+
+    # Runs for every new connection before requests can use it. A new instance may reuse a schema
+    # version with other ids, so the old schema must never resolve a name for it.
+    def load_schema(connection)
+      @schema_cache.replace(Schema.fetch(connection, timeout: @config.request_timeout))
+    end
+
+    def resubscribe(connection)
+      @watchers.resubscribe(connection)
+    end
+
+    def lost
+      return unless @disconnect_handler
+
+      @disconnect_handler.call
+
+      @watchers.defer(&@disconnect_handler)
+    end
+
+    # Name-resolved requests carry the schema version they were resolved against, so the
+    # server rejects them (ER_WRONG_SCHEMA_VERSION) instead of running them on a stale id.
+    def perform_on_space(space, index, timeout: nil, &)
+      return perform(yield(space, index), timeout:) if space.is_a?(Integer) && index.is_a?(Integer)
+
+      perform_by_name(space, index, timeout || @config.request_timeout, &)
+    end
+
+    # Every schema fetch and attempt draws on one deadline, so the whole call stays within timeout.
+    # Waiting for a connection first means the cache already holds its schema or a newer one.
+    def perform_by_name(space, index, timeout, &)
+      ensure_fork_safe
+      deadline = Transport::Deadline.after(timeout)
+      @link.connection(deadline)
+
+      perform_with_schema_check(space, index, deadline, &)
+    rescue TimeoutError
+      raise TimeoutError, "no response within #{timeout}s"
+    end
+
+    def lookup_space(space, timeout)
+      ensure_fork_safe
+      timeout ||= @config.request_timeout
+      deadline = Transport::Deadline.after(timeout)
+      @link.connection(deadline)
+
+      @schema_cache.space_info(space, deadline)
+    rescue TimeoutError
+      raise TimeoutError, "no response within #{timeout}s"
+    end
+
+    def perform_with_schema_check(space, index, deadline)
+      schema, ids = @schema_cache.resolve(space, index, deadline)
+
+      perform_resolved(schema, yield(*ids), deadline)
+    rescue ServerError => e
+      raise unless e.code == Protocol::Constants::ER_WRONG_SCHEMA_VERSION
+
+      fresh = @schema_cache.reload(schema, timeout: Transport::Deadline.remaining(deadline))
+      schema, ids = @schema_cache.resolve(space, index, deadline, fresh)
+      perform_resolved(schema, yield(*ids), deadline)
+    end
+
+    # Only the connection the schema came from: once it is lost, another instance may reuse the
+    # schema version with other ids, so the request fails with it rather than wait for a reconnect.
+    def perform_resolved(schema, request, deadline)
+      timeout = Transport::Deadline.remaining(deadline)
+
+      schema.connection.perform(request, timeout:, schema_version: schema.version)
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: tarantool-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Starlexxx
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: 'Thread-safe IPROTO client for Tarantool 2.11+ and 3.x: CRUD by space
+  and index name, SQL, interactive transactions, push, watchers, background reconnect
+  and a role-aware pool.'
+email:
+- apavlovskiy088@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/tarantool/client.rb
+- lib/tarantool/client/backoff.rb
+- lib/tarantool/client/box_error.rb
+- lib/tarantool/client/callback_guard.rb
+- lib/tarantool/client/configuration.rb
+- lib/tarantool/client/errors.rb
+- lib/tarantool/client/fork_safety.rb
+- lib/tarantool/client/index_info.rb
+- lib/tarantool/client/interval.rb
+- lib/tarantool/client/operations.rb
+- lib/tarantool/client/pool.rb
+- lib/tarantool/client/pool/member.rb
+- lib/tarantool/client/pool/member_fork_safety.rb
+- lib/tarantool/client/prepared_statement.rb
+- lib/tarantool/client/protocol/auth/chap_sha1.rb
+- lib/tarantool/client/protocol/codec.rb
+- lib/tarantool/client/protocol/constants.rb
+- lib/tarantool/client/protocol/extensions.rb
+- lib/tarantool/client/protocol/extensions/datetime.rb
+- lib/tarantool/client/protocol/extensions/decimal.rb
+- lib/tarantool/client/protocol/extensions/error.rb
+- lib/tarantool/client/protocol/extensions/interval.rb
+- lib/tarantool/client/protocol/extensions/uuid.rb
+- lib/tarantool/client/protocol/greeting.rb
+- lib/tarantool/client/protocol/requests/auth.rb
+- lib/tarantool/client/protocol/requests/begin.rb
+- lib/tarantool/client/protocol/requests/call.rb
+- lib/tarantool/client/protocol/requests/commit.rb
+- lib/tarantool/client/protocol/requests/delete.rb
+- lib/tarantool/client/protocol/requests/eval.rb
+- lib/tarantool/client/protocol/requests/execute.rb
+- lib/tarantool/client/protocol/requests/id.rb
+- lib/tarantool/client/protocol/requests/insert.rb
+- lib/tarantool/client/protocol/requests/ping.rb
+- lib/tarantool/client/protocol/requests/prepare.rb
+- lib/tarantool/client/protocol/requests/replace.rb
+- lib/tarantool/client/protocol/requests/rollback.rb
+- lib/tarantool/client/protocol/requests/select.rb
+- lib/tarantool/client/protocol/requests/unwatch.rb
+- lib/tarantool/client/protocol/requests/update.rb
+- lib/tarantool/client/protocol/requests/upsert.rb
+- lib/tarantool/client/protocol/requests/watch.rb
+- lib/tarantool/client/protocol/response.rb
+- lib/tarantool/client/schema.rb
+- lib/tarantool/client/schema_cache.rb
+- lib/tarantool/client/space_info.rb
+- lib/tarantool/client/sql_result.rb
+- lib/tarantool/client/stream.rb
+- lib/tarantool/client/thread_join.rb
+- lib/tarantool/client/transaction_schema.rb
+- lib/tarantool/client/transaction_scope.rb
+- lib/tarantool/client/transport/connection.rb
+- lib/tarantool/client/transport/deadline.rb
+- lib/tarantool/client/transport/frame_writer.rb
+- lib/tarantool/client/transport/future.rb
+- lib/tarantool/client/transport/handshake.rb
+- lib/tarantool/client/transport/link.rb
+- lib/tarantool/client/transport/link_state.rb
+- lib/tarantool/client/transport/pending_requests.rb
+- lib/tarantool/client/transport/stream_ids.rb
+- lib/tarantool/client/transport/timed_lock.rb
+- lib/tarantool/client/transport/timed_read.rb
+- lib/tarantool/client/uuid.rb
+- lib/tarantool/client/version.rb
+- lib/tarantool/client/watcher.rb
+- lib/tarantool/client/watchers.rb
+- lib/tarantool/client/watchers/dispatcher.rb
+homepage: https://github.com/Starlexxx/tarantool-ruby
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Starlexxx/tarantool-ruby/tree/master/tarantool-client
+  changelog_uri: https://github.com/Starlexxx/tarantool-ruby/blob/master/tarantool-client/CHANGELOG.md
+  bug_tracker_uri: https://github.com/Starlexxx/tarantool-ruby/issues
+  homepage_uri: https://github.com/Starlexxx/tarantool-ruby
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: IPROTO client for Tarantool 2.11+ and 3.x
+test_files: []