trilogy 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a56e3472569e26552e3c8d7a674b70d9f5e15a546187f75e806f4d56ff5f15b2
-  data.tar.gz: a2c29dc1fcf378be7a26088661401d9d4e7d4253c6823f8e7e84414662947cb1
+  metadata.gz: f36747c1d61f440a5ff6b5d37981b0a11ad26a1b973ebeb9bab84e832b2841a3
+  data.tar.gz: b654bac6dbc4d3451c5101e9f8574de4aee4044d6aa280c0736e3e18ad09c723
 SHA512:
-  metadata.gz: 0f3348ccdf12ae3cef0c34f95e09829528a0bdb09b466774a1a8369fdeae6f4d1fb59df96b1d17e5361aea4656968b5e2149ffbf9fe8337b17d45f0903408122
-  data.tar.gz: 33711de128dd47aeff4ab618d0c3b6032e966b1b52b7dad6352e1588f5d13e54df2d4709c97c006ec63d1fa603a1f190abd58784cea835d26be6c1f56da5b46c
+  metadata.gz: 81aefe81cfe750d70a42915c6a16f6d7211455b255a6588088c8ac6c682240636df5c2269b7090e78ba2ce6f991e3266f1c2b57711130e84fde85a8d38b22a1c
+  data.tar.gz: 3df0441086b141c6c0ebb0d3a216d14205547bd340c06cf0884e1985ac6550023ea8960200c5afe31821160883a3cd96a07a942efb05a9d335153dcdafa83976

data/README.md

@@ -27,7 +27,6 @@ $ gem install trilogy
 ``` ruby
 client = Trilogy.new(host: "127.0.0.1", port: 3306, username: "root", read_timeout: 2)
 if client.ping
-  client.query_options[:database_timezone] = :utc
   client.change_db "mydb"
 
   result = client.query("SELECT id, created_at FROM users LIMIT 10")
@@ -63,7 +62,7 @@ bundle exec rake build
 
 The official Ruby bindings are inside of the canonical trilogy repository itself.
 
-1. Fork it ( https://github.com/github/trilogy/fork )
+1. Fork it ( https://github.com/trilogy-libraries/trilogy/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/ext/trilogy-ruby/cext.c

@@ -17,7 +17,7 @@
 
 VALUE Trilogy_CastError;
 static VALUE Trilogy_BaseConnectionError, Trilogy_ProtocolError, Trilogy_SSLError, Trilogy_QueryError,
-    Trilogy_ConnectionClosedError, Trilogy_ConnectionRefusedError, Trilogy_ConnectionResetError,
+    Trilogy_ConnectionClosedError,
     Trilogy_TimeoutError, Trilogy_SyscallError, Trilogy_Result, Trilogy_EOFError;
 
 static ID id_socket, id_host, id_port, id_username, id_password, id_found_rows, id_connect_timeout, id_read_timeout,
@@ -43,9 +43,7 @@ static void mark_trilogy(void *ptr)
 static void free_trilogy(void *ptr)
 {
     struct trilogy_ctx *ctx = ptr;
-    if (ctx->conn.socket != NULL) {
-        trilogy_free(&ctx->conn);
-    }
+    trilogy_free(&ctx->conn);
     xfree(ptr);
 }
 
@@ -90,12 +88,8 @@ static struct trilogy_ctx *get_open_ctx(VALUE obj)
 NORETURN(static void trilogy_syserr_fail_str(int, VALUE));
 static void trilogy_syserr_fail_str(int e, VALUE msg)
 {
-    if (e == ECONNREFUSED) {
-        rb_raise(Trilogy_ConnectionRefusedError, "%" PRIsVALUE, msg);
-    } else if (e == ECONNRESET) {
-        rb_raise(Trilogy_ConnectionResetError, "%" PRIsVALUE, msg);
-    } else if (e == EPIPE) {
-        // Backwards compatibility: This error class makes no sense, but matches legacy behavior
+    if (e == EPIPE) {
+        // Backwards compatibility: This error message is a bit odd, but includes "TRILOGY_CLOSED_CONNECTION" to match legacy string matching
         rb_raise(Trilogy_EOFError, "%" PRIsVALUE ": TRILOGY_CLOSED_CONNECTION: EPIPE", msg);
     } else {
         VALUE exc = rb_funcall(Trilogy_SyscallError, id_from_errno, 2, INT2NUM(e), msg);
@@ -309,6 +303,7 @@ static int try_connect(struct trilogy_ctx *ctx, trilogy_handshake_t *handshake,
     int rc = args.rc;
 
     if (rc != TRILOGY_OK) {
+        trilogy_sock_close(sock);
         return rc;
     }
 
@@ -316,8 +311,10 @@ static int try_connect(struct trilogy_ctx *ctx, trilogy_handshake_t *handshake,
 escape the GVL on each wait operation without going through call_without_gvl */
     sock->wait_cb = _cb_ruby_wait;
     rc = trilogy_connect_send_socket(&ctx->conn, sock);
-    if (rc < 0)
+    if (rc < 0) {
+        trilogy_sock_close(sock);
         return rc;
+    }
 
     while (1) {
         rc = trilogy_connect_recv(&ctx->conn, handshake);
@@ -425,7 +422,7 @@ static void authenticate(struct trilogy_ctx *ctx, trilogy_handshake_t *handshake
     }
 }
 
-static VALUE rb_trilogy_initialize(VALUE self, VALUE encoding, VALUE charset, VALUE opts)
+static VALUE rb_trilogy_connect(VALUE self, VALUE encoding, VALUE charset, VALUE opts)
 {
     struct trilogy_ctx *ctx = get_ctx(self);
     trilogy_sockopt_t connopt = {0};
@@ -436,7 +433,6 @@ static VALUE rb_trilogy_initialize(VALUE self, VALUE encoding, VALUE charset, VA
     connopt.encoding = NUM2INT(charset);
 
     Check_Type(opts, T_HASH);
-    rb_ivar_set(self, id_connection_options, opts);
 
     if ((val = rb_hash_lookup(opts, ID2SYM(id_ssl_mode))) != Qnil) {
         Check_Type(val, T_FIXNUM);
@@ -578,9 +574,6 @@ static VALUE rb_trilogy_initialize(VALUE self, VALUE encoding, VALUE charset, VA
     }
 
     int rc = try_connect(ctx, &handshake, &connopt);
-    if (rc == TRILOGY_TIMEOUT) {
-        rb_raise(Trilogy_TimeoutError, "trilogy_connect_recv");
-    }
     if (rc != TRILOGY_OK) {
         if (connopt.path) {
             handle_trilogy_error(ctx, rc, "trilogy_connect - unable to connect to %s", connopt.path);
@@ -1104,7 +1097,7 @@ RUBY_FUNC_EXPORTED void Init_cext()
     VALUE Trilogy = rb_const_get(rb_cObject, rb_intern("Trilogy"));
     rb_define_alloc_func(Trilogy, allocate_trilogy);
 
-    rb_define_private_method(Trilogy, "_initialize", rb_trilogy_initialize, 3);
+    rb_define_private_method(Trilogy, "_connect", rb_trilogy_connect, 3);
     rb_define_method(Trilogy, "change_db", rb_trilogy_change_db, 1);
     rb_define_alias(Trilogy, "select_db", "change_db");
     rb_define_method(Trilogy, "query", rb_trilogy_query, 1);
@@ -1159,12 +1152,6 @@ RUBY_FUNC_EXPORTED void Init_cext()
     Trilogy_TimeoutError = rb_const_get(Trilogy, rb_intern("TimeoutError"));
     rb_global_variable(&Trilogy_TimeoutError);
 
-    Trilogy_ConnectionRefusedError = rb_const_get(Trilogy, rb_intern("ConnectionRefusedError"));
-    rb_global_variable(&Trilogy_ConnectionRefusedError);
-
-    Trilogy_ConnectionResetError = rb_const_get(Trilogy, rb_intern("ConnectionResetError"));
-    rb_global_variable(&Trilogy_ConnectionResetError);
-
     Trilogy_BaseConnectionError = rb_const_get(Trilogy, rb_intern("BaseConnectionError"));
     rb_global_variable(&Trilogy_BaseConnectionError);
 

data/ext/trilogy-ruby/extconf.rb

@@ -2,8 +2,12 @@ require "mkmf"
 
 # concatenate trilogy library sources to allow the compiler to optimise across
 # source files
+
+trilogy_src_dir = File.realpath("src", __dir__)
 File.binwrite("trilogy.c",
-  Dir["#{__dir__}/src/**/*.c"].map { |src| File.binread(src) }.join)
+  Dir["#{trilogy_src_dir}/**/*.c"].map { |src|
+    %{#line 1 "#{src}"\n} + File.binread(src)
+  }.join)
 
 $objs = %w[trilogy.o cast.o cext.o]
 $CFLAGS << " -I #{__dir__}/inc -std=gnu99 -fvisibility=hidden"

data/ext/trilogy-ruby/src/buffer.c

@@ -57,4 +57,9 @@ int trilogy_buffer_putc(trilogy_buffer_t *buffer, uint8_t c)
     return TRILOGY_OK;
 }
 
-void trilogy_buffer_free(trilogy_buffer_t *buffer) { free(buffer->buff); }
+void trilogy_buffer_free(trilogy_buffer_t *buffer)
+{
+    free(buffer->buff);
+    buffer->buff = NULL;
+    buffer->len = buffer->cap = 0;
+}

data/ext/trilogy-ruby/src/socket.c

@@ -100,8 +100,15 @@ static int _cb_raw_close(trilogy_sock_t *_sock)
     if (sock->fd != -1) {
         rc = close(sock->fd);
     }
+
     if (sock->addr) {
-        freeaddrinfo(sock->addr);
+        if (sock->base.opts.hostname == NULL && sock->base.opts.path != NULL) {
+            /* We created these with calloc so must free them instead of calling freeaddrinfo */
+            free(sock->addr->ai_addr);
+            free(sock->addr);
+        } else {
+            freeaddrinfo(sock->addr);
+        }
     }
 
     free(sock->base.opts.hostname);
@@ -189,6 +196,7 @@ static int raw_connect_internal(struct trilogy_sock *sock, const struct addrinfo
 {
     int sockerr;
     socklen_t sockerr_len = sizeof(sockerr);
+    int rc = TRILOGY_SYSERR;
 
     sock->fd = socket(ai->ai_family, SOCK_STREAM, ai->ai_protocol);
     if (sock->fd < 0) {
@@ -244,8 +252,8 @@ static int raw_connect_internal(struct trilogy_sock *sock, const struct addrinfo
         }
     }
 
-    if (trilogy_sock_wait_write((trilogy_sock_t *)sock) < 0) {
-        goto fail;
+    if ((rc = trilogy_sock_wait_write((trilogy_sock_t *)sock)) < 0) {
+        goto failrc;
     }
 
     if (getsockopt(sock->fd, SOL_SOCKET, SO_ERROR, &sockerr, &sockerr_len) < 0) {
@@ -263,9 +271,11 @@ static int raw_connect_internal(struct trilogy_sock *sock, const struct addrinfo
     return TRILOGY_OK;
 
 fail:
+    rc = TRILOGY_SYSERR;
+failrc:
     close(sock->fd);
     sock->fd = -1;
-    return TRILOGY_SYSERR;
+    return rc;
 }
 
 static int _cb_raw_connect(trilogy_sock_t *_sock)
@@ -377,6 +387,9 @@ static ssize_t ssl_io_return(struct trilogy_sock *sock, ssize_t ret)
         int rc = SSL_get_error(sock->ssl, (int)ret);
         if (rc == SSL_ERROR_WANT_WRITE || rc == SSL_ERROR_WANT_READ) {
             return (ssize_t)TRILOGY_AGAIN;
+        } else if (rc == SSL_ERROR_ZERO_RETURN) {
+            // Server has closed the connection for writing by sending the close_notify alert
+            return (ssize_t)TRILOGY_CLOSED_CONNECTION;
         } else if (rc == SSL_ERROR_SYSCALL && !ERR_peek_error()) {
             if (errno == 0) {
                 // On OpenSSL <= 1.1.1, SSL_ERROR_SYSCALL with an errno value

data/lib/trilogy/error.rb

@@ -12,7 +12,7 @@ class Trilogy
   end
 
   # Trilogy may raise various syscall errors, which we treat as Trilogy::Errors.
-  class SyscallError
+  module SyscallError
     ERRORS = {}
 
     Errno.constants
@@ -20,7 +20,10 @@ class Trilogy
       .select { |c| c.is_a?(Class) && c < SystemCallError }
       .each do |c|
         errno_name = c.to_s.split('::').last
-        ERRORS[c::Errno] = const_set(errno_name, Class.new(c) { include Trilogy::ConnectionError })
+        ERRORS[c::Errno] = const_set(errno_name, Class.new(c) {
+          include Trilogy::ConnectionError
+          singleton_class.define_method(:===, Module.instance_method(:===))
+        })
       end
 
     ERRORS.freeze
@@ -32,6 +35,11 @@ class Trilogy
     end
   end
 
+  ConnectionRefusedError = SyscallError::ECONNREFUSED
+  deprecate_constant :ConnectionRefusedError
+  ConnectionResetError = SyscallError::ECONNRESET
+  deprecate_constant :ConnectionResetError
+
   class BaseError < StandardError
     include Error
 
@@ -58,21 +66,7 @@ class Trilogy
   class CastError < ClientError
   end
 
-  class TimeoutError < Errno::ETIMEDOUT
-    include ConnectionError
-
-    def initialize(error_message = nil, error_code = nil)
-      super
-      @error_code = error_code
-    end
-  end
-
-  class ConnectionRefusedError < Errno::ECONNREFUSED
-    include ConnectionError
-  end
-
-  class ConnectionResetError < Errno::ECONNRESET
-    include ConnectionError
+  class TimeoutError < BaseConnectionError
   end
 
   # DatabaseError was replaced by ProtocolError, but we'll keep it around as an
@@ -117,7 +111,7 @@ class Trilogy
     include ConnectionError
   end
 
-  # Occurrs when a socket read or write returns EOF or when an operation is
+  # Occurs when a socket read or write returns EOF or when an operation is
   # attempted on a socket which previously encountered an error.
   class EOFError < BaseConnectionError
   end

data/lib/trilogy/version.rb

@@ -1,3 +1,3 @@
 class Trilogy
-  VERSION = "2.6.0"
+  VERSION = "2.7.0"
 end

data/lib/trilogy.rb

@@ -12,8 +12,10 @@ class Trilogy
     mysql_encoding = options[:encoding] || "utf8mb4"
     encoding = Trilogy::Encoding.find(mysql_encoding)
     charset = Trilogy::Encoding.charset(mysql_encoding)
+    @connection_options = options
+    @connected_host = nil
 
-    _initialize(encoding, charset, options)
+    _connect(encoding, charset, options)
   end
 
   def connection_options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trilogy
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - GitHub Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2024-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: A friendly MySQL-compatible library for Ruby, binding to libtrilogy