bzync-nextsql 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f8ea5d62b319951e5324da7495acd2b082dc3c05945b9c7cd8810f81ab204ed
-  data.tar.gz: 773874cbee89f62cea0754249800a087f8de553e79a90c7f0d5d6e85026f0a39
+  metadata.gz: c3ea6924ca4732695f486e9def584fd7d8eb6dfb90e646c54819c047ee4ff61a
+  data.tar.gz: e70bf019af638b3ba62255994dfe881a033c340ccc1f6f20732a625e3a0dd19e
 SHA512:
-  metadata.gz: 4c6cd6f4f39cd9aceedaaf0a373e8deedbe7a217ea9fdd0e04231bfc28409eeceb8cd84294b776ec1a48d8621fdf797e5007bc4203ff9bec950d95799333c128
-  data.tar.gz: 302b1dcfc03a25f1ac6ef126d99c9a1cfcb0c2c04dbf44414f8e4558e20b9029c8c0c5f2153f4f0de4326ff8ccb421944970ddb25412822d6cfc01887296050b
+  metadata.gz: 8115ef2bd516eefc60bc59c5a237e71f668571cc95cdaf97cd37928eb73582552fdbd912ff6ec16c2b46256218dc89f0c853049cad0e7038aae895aa3b6dc573
+  data.tar.gz: 27caa6edbcf6b55c10e9af5f2fb59159a32d3d4f9cbfbb5bdd96f1ba744b7435ccf9a1430585219ed8a6fb5fdaaed2efdd2063de75752f5186cb2b55486962b2

data/lib/nextsql/client.rb

@@ -6,6 +6,7 @@
 
 require "socket"
 require "openssl"
+require "ipaddr"
 
 require_relative "protocol"
 require_relative "errors"
@@ -40,7 +41,6 @@ module NextSQL
   # from multiple threads/fibers — open one Connection per worker, or use
   # +Cluster+ which pools one connection per node.
   class Connection
-    LOOPBACK_RE = /\A127\.\d{1,3}\.\d{1,3}\.\d{1,3}\z/.freeze
     CONNECT_TIMEOUT = 10.0
 
     class << self
@@ -73,9 +73,12 @@ module NextSQL
         host, = split_host_port(addr, allow_bare: true)
         host = host.strip.downcase
         return true if host == "localhost"
-        return true if %w[::1 0:0:0:0:0:0:0:1].include?(host)
 
-        LOOPBACK_RE.match?(host)
+        begin
+          IPAddr.new(host).loopback?
+        rescue IPAddr::Error
+          false
+        end
       end
 
       def validate_config!(cfg)
@@ -369,12 +372,17 @@ module NextSQL
 
     def handshake
       cfg = @cfg
-      write_frame(Protocol::TYPE_HELLO, Protocol.encode_hello(Protocol::VERSION, 0, "\x00" * 8, cfg.database, cfg.user, cfg.realm))
+      write_frame(Protocol::TYPE_HELLO,
+                  Protocol.encode_hello(Protocol::VERSION, Protocol::FLAG_PUBLIC_ERROR_CODES, "\x00" * 8,
+                                        cfg.database, cfg.user, cfg.realm))
       typ, payload = read_frame
       raise unexpected(typ, payload) if typ != Protocol::TYPE_HELLO_OK
 
-      _version, auth_method, secret = Protocol.decode_hello_ok(payload)
+      _version, auth_method, secret, flags = Protocol.decode_hello_ok(payload)
       @secret = secret
+      # Diagnostic only: decode_error reads the field whenever it is present,
+      # so nothing depends on this having been echoed.
+      @public_error_codes = (flags & Protocol::FLAG_PUBLIC_ERROR_CODES) != 0
       write_frame(Protocol::TYPE_AUTH, Protocol.u16str(cfg.password))
       typ, payload = read_frame
       raise unexpected(typ, payload) if typ != Protocol::TYPE_AUTH_OK

data/lib/nextsql/errors.rb

@@ -10,8 +10,16 @@ module NextSQL
   class Error < StandardError
     attr_reader :error_code
 
-    def initialize(error_code, message = "")
+    # +public_code+ is the stable ERR_* name from docs/error-codes.md. It is
+    # set only on an error received over a connection that negotiated the
+    # public taxonomy, and is "" otherwise -- for a local error, or an older
+    # server. +error_code+ always carries the legacy class, so retry logic
+    # keeps reading that and nothing should require +public_code+.
+    attr_reader :public_code
+
+    def initialize(error_code, message = "", public_code = "")
       @error_code = error_code
+      @public_code = public_code
       super(message.empty? ? error_code : message)
     end
   end

data/lib/nextsql/protocol.rb

@@ -53,6 +53,12 @@ module NextSQL
     AUTH_PASSWORD = 1
     AUTH_PASSWORD_KEY = 2
     FLAG_CANCEL = 1
+    # FLAG_PUBLIC_ERROR_CODES asks the server for the stable ERR_* error
+    # taxonomy (docs/error-codes.md). A server that does not implement it
+    # ignores the bit and keeps the NSQL v1 error shape, which decode_error
+    # still reads, so setting it is safe against any server version. The server
+    # echoes it in the hello-ok flags when it was accepted.
+    FLAG_PUBLIC_ERROR_CODES = 2
     FLAG_NULL = 0x01
 
     KIND_UUID = 1
@@ -313,9 +319,16 @@ module NextSQL
     end
 
     def decode_hello_ok(b)
-      raise ProtocolError, "bad hello-ok length" unless b.bytesize == 11
-
-      [u16(b, 0), b.getbyte(2), b.byteslice(3, 8)]
+      raise ProtocolError, "bad hello-ok length" unless [11, 13].include?(b.bytesize)
+
+      flags = 0
+      if b.bytesize == 13
+        flags = u16(b, 11)
+        # The server omits the field when it accepted no capability, so a
+        # present-but-zero field is a second encoding of the v1 hello-ok.
+        raise ProtocolError, "empty hello-ok flags" if flags.zero?
+      end
+      [u16(b, 0), b.getbyte(2), b.byteslice(3, 8), flags]
     end
 
     def encode_query(sql, params)
@@ -946,8 +959,16 @@ module NextSQL
 
     def decode_error(b)
       code, off = read_u16_string(b, 0, MAX_NAME)
-      msg, = read_u16_string(b, off, MAX_NAME)
-      Error.new(code, msg)
+      msg, off = read_u16_string(b, off, MAX_NAME)
+      # Optional trailing field, present only from a server that accepted
+      # FLAG_PUBLIC_ERROR_CODES. Its absence is normal -- an older server
+      # ignores the request bit -- so this must never be required.
+      public_code = ""
+      if off < b.bytesize
+        public_code, = read_u16_string(b, off, MAX_NAME)
+        raise ProtocolError, "empty public error code" if public_code.empty?
+      end
+      Error.new(code, msg, public_code)
     end
 
     def encode_set_read_consistency(mode, max_staleness_ms)

data/lib/nextsql/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NextSQL
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bzync-nextsql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rayan Reynaldo