trilogy 2.12.5 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb255b4a759f25f1ddbf289fb3d17e163cd4efa1dcdf0537d3c9bafeac7183ab
-  data.tar.gz: 8d89ef7ec7d5a11cc480a3f6fc0c7ba96c4baa761dccb0b773b88cc382897ea8
+  metadata.gz: aa039c6b0e08712590ea5c50bea7c9a6418d56b1878b3c2935568248d0c5deb5
+  data.tar.gz: f76d5315bd82dd00a58c43d7de51885448ba3b72fb0e2adcca3fd132e4bd1163
 SHA512:
-  metadata.gz: 14bd176ad7f6289bb38b42036344b94800831699b82807464f6ee124e7d31c9a17fa474cabf342ae0c8b549f664062aa0dd52b14e75b06c65c1ff717520e9fda
-  data.tar.gz: 7928348c8d89a3e0a5ad5dec06503a9ba3111f0e4f33e4d1448a85407c614c98adbd3adbe4e2e6c763654747a1a484c7437c3cea6c853b448eb105335c8dfb78
+  metadata.gz: 45cb57bc1614f81b1f477e987936b00ba97ec75acd4b88d4e86640848442daa76993cb14fe6b39bccf76c3e7a5a1dc6f86c37d5af96e179c0889c9e50356cac9
+  data.tar.gz: 5da626807137fe79611a85157b4537fde0c7451c047074ddac514732ecfed04f0e665b9e432607aa52fb73830bad176dd6d640fb2ab87019b71e46a44fea3b52

data/README.md

@@ -86,3 +86,5 @@ differences:
   the transcoding step up to the caller.
 * There is no `as` query option. Calling `Trilogy::Result#each` will yield an array
   of row values. If you want a hash you should use `Trilogy::Result#each_hash`.
+* The default `connect_timeout` is 5 seconds, while mysql2 defaults to 120 seconds.
+  Pass `connect_timeout: nil` to disable the timeout.

data/ext/trilogy-ruby/cext.c

@@ -431,6 +431,8 @@ static int _cb_ruby_wait(trilogy_sock_t *sock, trilogy_wait_t wait)
     int state = 0;
     rb_protect(rb_trilogy_wait_protected, (VALUE)&args, &state);
     if (state) {
+        struct trilogy_ctx *ctx = sock->opts.privdata;
+        rb_trilogy_release_buffer(ctx);
         trilogy_sock_shutdown(sock);
         rb_jump_tag(state);
     }
@@ -605,10 +607,24 @@ static int rb_io_descriptor(VALUE io)
 }
 #endif
 
+static inline VALUE config_set_str(VALUE opts, ID key, char **member)
+{
+    VALUE val = rb_hash_aref(opts, ID2SYM(key));
+    if (NIL_P(val)) {
+        return Qfalse;
+    }
+
+    Check_Type(val, T_STRING);
+    *member = StringValueCStr(val);
+    return val;
+}
+
 static VALUE rb_trilogy_connect(VALUE self, VALUE raw_socket, VALUE encoding, VALUE charset, VALUE opts)
 {
     struct trilogy_ctx *ctx = get_ctx(self);
-    trilogy_sockopt_t connopt = {0};
+    trilogy_sockopt_t connopt = {
+        .privdata = ctx,
+    };
     trilogy_handshake_t handshake;
     VALUE val;
 
@@ -658,10 +674,10 @@ static VALUE rb_trilogy_connect(VALUE self, VALUE raw_socket, VALUE encoding, VA
         connopt.max_allowed_packet = NUM2SIZET(val);
     }
 
-    if ((val = rb_hash_lookup(opts, ID2SYM(id_host))) != Qnil) {
-        Check_Type(val, T_STRING);
+    VALUE host = config_set_str(opts, id_host, &connopt.hostname);
+    VALUE path;
 
-        connopt.hostname = StringValueCStr(val);
+    if (host) {
         connopt.port = 3306;
 
         if ((val = rb_hash_lookup(opts, ID2SYM(id_port))) != Qnil) {
@@ -671,26 +687,17 @@ static VALUE rb_trilogy_connect(VALUE self, VALUE raw_socket, VALUE encoding, VA
     } else {
         connopt.path = (char *)"/tmp/mysql.sock";
 
-        if ((val = rb_hash_lookup(opts, ID2SYM(id_socket))) != Qnil) {
-            Check_Type(val, T_STRING);
-            connopt.path = StringValueCStr(val);
-        }
-    }
-
-    if ((val = rb_hash_aref(opts, ID2SYM(id_username))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.username = StringValueCStr(val);
+        path = config_set_str(opts, id_socket, &connopt.path);
     }
 
-    if ((val = rb_hash_aref(opts, ID2SYM(id_password))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.password = RSTRING_PTR(val);
-        connopt.password_len = RSTRING_LEN(val);
+    VALUE username = config_set_str(opts, id_username, &connopt.username);
+    VALUE password = config_set_str(opts, id_password, &connopt.password);
+    if (password) {
+        connopt.password_len = RSTRING_LEN(password);
     }
 
-    if ((val = rb_hash_aref(opts, ID2SYM(id_database))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.database = StringValueCStr(val);
+    VALUE database = config_set_str(opts, id_database, &connopt.database);
+    if (database) {
         connopt.flags |= TRILOGY_CAPABILITIES_CONNECT_WITH_DB;
     }
 
@@ -710,45 +717,14 @@ static VALUE rb_trilogy_connect(VALUE self, VALUE raw_socket, VALUE encoding, VA
         connopt.flags |= TRILOGY_CAPABILITIES_MULTI_STATEMENTS;
     }
 
-    if ((val = rb_hash_aref(opts, ID2SYM(id_ssl_ca))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.ssl_ca = StringValueCStr(val);
-    }
-
-    if ((val = rb_hash_aref(opts, ID2SYM(id_ssl_capath))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.ssl_capath = StringValueCStr(val);
-    }
-
-    if ((val = rb_hash_aref(opts, ID2SYM(id_ssl_cert))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.ssl_cert = StringValueCStr(val);
-    }
-
-    if ((val = rb_hash_aref(opts, ID2SYM(id_ssl_cipher))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.ssl_cipher = StringValueCStr(val);
-    }
-
-    if ((val = rb_hash_aref(opts, ID2SYM(id_ssl_crl))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.ssl_crl = StringValueCStr(val);
-    }
-
-    if ((val = rb_hash_aref(opts, ID2SYM(id_ssl_crlpath))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.ssl_crlpath = StringValueCStr(val);
-    }
-
-    if ((val = rb_hash_aref(opts, ID2SYM(id_ssl_key))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.ssl_key = StringValueCStr(val);
-    }
-
-    if ((val = rb_hash_aref(opts, ID2SYM(id_tls_ciphersuites))) != Qnil) {
-        Check_Type(val, T_STRING);
-        connopt.tls_ciphersuites = StringValueCStr(val);
-    }
+    VALUE ssl_ca = config_set_str(opts, id_ssl_ca, &connopt.ssl_ca);
+    VALUE ssl_capath = config_set_str(opts, id_ssl_capath, &connopt.ssl_capath);
+    VALUE ssl_cert = config_set_str(opts, id_ssl_cert, &connopt.ssl_cert);
+    VALUE ssl_cipher = config_set_str(opts, id_ssl_cipher, &connopt.ssl_cipher);
+    VALUE ssl_crl = config_set_str(opts, id_ssl_crl, &connopt.ssl_crl);
+    VALUE ssl_crlpath = config_set_str(opts, id_ssl_crlpath, &connopt.ssl_crlpath);
+    VALUE ssl_key = config_set_str(opts, id_ssl_key, &connopt.ssl_key);
+    VALUE tls_ciphersuites = config_set_str(opts, id_tls_ciphersuites, &connopt.tls_ciphersuites);
 
     if ((val = rb_hash_aref(opts, ID2SYM(id_tls_min_version))) != Qnil) {
         Check_Type(val, T_FIXNUM);
@@ -787,6 +763,21 @@ static VALUE rb_trilogy_connect(VALUE self, VALUE raw_socket, VALUE encoding, VA
 
     rb_trilogy_release_buffer(ctx);
 
+    // Ensure all our strings are pinned.
+    RB_GC_GUARD(host);
+    RB_GC_GUARD(username);
+    RB_GC_GUARD(password);
+    RB_GC_GUARD(path);
+    RB_GC_GUARD(database);
+    RB_GC_GUARD(ssl_ca);
+    RB_GC_GUARD(ssl_capath);
+    RB_GC_GUARD(ssl_cert);
+    RB_GC_GUARD(ssl_cipher);
+    RB_GC_GUARD(ssl_crl);
+    RB_GC_GUARD(ssl_crlpath);
+    RB_GC_GUARD(ssl_key);
+    RB_GC_GUARD(tls_ciphersuites);
+
     return Qnil;
 }
 
@@ -795,6 +786,7 @@ static VALUE rb_trilogy_change_db(VALUE self, VALUE database)
     struct trilogy_ctx *ctx = get_open_ctx(self);
 
     StringValue(database);
+    database = rb_str_new_frozen(database);
 
     rb_trilogy_acquire_buffer(ctx);
 
@@ -826,6 +818,7 @@ static VALUE rb_trilogy_change_db(VALUE self, VALUE database)
     }
 
     rb_trilogy_release_buffer(ctx);
+    RB_GC_GUARD(database);
 
     return Qtrue;
 }
@@ -1065,6 +1058,7 @@ static VALUE execute_read_query_response(struct trilogy_ctx *ctx)
 
     // If we have seen an unexpected exception, jump to it so it gets raised.
     if (state) {
+        rb_trilogy_release_buffer(ctx);
         trilogy_sock_shutdown(ctx->conn.socket);
         rb_jump_tag(state);
     }
@@ -1135,6 +1129,7 @@ static VALUE rb_trilogy_query(VALUE self, VALUE query)
 
     StringValue(query);
     query = rb_str_export_to_enc(query, ctx->encoding);
+    query = rb_str_new_frozen(query);
 
     rb_trilogy_acquire_buffer(ctx);
 
@@ -1148,6 +1143,7 @@ static VALUE rb_trilogy_query(VALUE self, VALUE query)
         handle_trilogy_error(ctx, rc, "trilogy_query_send");
     }
 
+    RB_GC_GUARD(query);
     return execute_read_query_response(ctx);
 }
 
@@ -1191,9 +1187,11 @@ static VALUE rb_trilogy_ping(VALUE self)
 static VALUE rb_trilogy_escape(VALUE self, VALUE str)
 {
     struct trilogy_ctx *ctx = get_open_ctx(self);
-    rb_encoding *str_enc = rb_enc_get(str);
 
     StringValue(str);
+    str = rb_str_new_frozen(str);
+
+    rb_encoding *str_enc = rb_enc_get(str);
 
     if (!rb_enc_asciicompat(str_enc)) {
         rb_raise(rb_eEncCompatError, "input string must be ASCII-compatible");
@@ -1214,6 +1212,7 @@ static VALUE rb_trilogy_escape(VALUE self, VALUE str)
 
     rb_trilogy_release_buffer(ctx);
 
+    RB_GC_GUARD(str);
     return escaped_string;
 }
 

data/ext/trilogy-ruby/inc/trilogy/blocking.h

@@ -237,7 +237,7 @@ int trilogy_stmt_bind_data(trilogy_conn_t *conn, trilogy_stmt_t *stmt, uint16_t
 
 /* trilogy_stmt_read_full_row - Read a row from the prepared statement execute response.
  *
- * This should only be called after a sucessful call to trilogy_stmt_execute.
+ * This should only be called after a successful call to trilogy_stmt_execute.
  * You should continue calling this until TRILOGY_EOF is returned. Denoting the end
  * of the result set.
  *

data/ext/trilogy-ruby/inc/trilogy/buffer.h

@@ -68,7 +68,7 @@ int trilogy_buffer_write(trilogy_buffer_t *buffer, const uint8_t *ptr, size_t le
 
 /* trilogy_buffer_free - Free an trilogy_buffer_t's underlying storage. The buffer
  * must be re-initialized with trilogy_buffer_init if it is to be reused. Any
- * operations performed on an unintialized or freed buffer are undefined.
+ * operations performed on an uninitialized or freed buffer are undefined.
  *
  * buffer - An initialized trilogy_buffer_t.
  */

data/ext/trilogy-ruby/inc/trilogy/client.h

@@ -607,7 +607,7 @@ void trilogy_free(trilogy_conn_t *conn);
  * conn - A pre-initialized trilogy_conn_t pointer.
  *
  * Return values:
- *   TRILOGY_OK                 - The connection was successfuly discarded and freed.
+ *   TRILOGY_OK                 - The connection was successfully discarded and freed.
  *   TRILOGY_SYSERR             - A system error occurred, check errno. The connection wasn't freed.
  */
 int trilogy_discard(trilogy_conn_t *conn);
@@ -665,7 +665,7 @@ int trilogy_stmt_prepare_recv(trilogy_conn_t *conn, trilogy_stmt_t *stmt_out);
 
 /* trilogy_stmt_bind_data_send - Send a prepared statement bind long data command to the server.
  *
- * There is no pairing `trilogy_stmt_bind_data_recv` fucntion to this one because the server
+ * There is no pairing `trilogy_stmt_bind_data_recv` function to this one because the server
  * doesn't send a response to this command.
  *
  * conn      - A connected trilogy_conn_t pointer. Using a disconnected trilogy_conn_t is
@@ -734,7 +734,7 @@ int trilogy_stmt_execute_recv(trilogy_conn_t *conn, uint64_t *column_count_out);
 
 /* trilogy_stmt_read_row - Read a row from the prepared statement execute response.
  *
- * This should only be called after a sucessful call to trilogy_stmt_execute_recv.
+ * This should only be called after a successful call to trilogy_stmt_execute_recv.
  * You should continue calling this until TRILOGY_EOF is returned. Denoting the end
  * of the result set.
  *
@@ -809,7 +809,7 @@ int trilogy_stmt_reset_recv(trilogy_conn_t *conn);
 
 /* trilogy_stmt_close_send - Send a prepared statement close command to the server.
  *
- * There is no pairing `trilogy_stmt_close_recv` fucntion to this one because the server
+ * There is no pairing `trilogy_stmt_close_recv` function to this one because the server
  * doesn't send a response to this command.
  *
  * conn  - A connected trilogy_conn_t pointer. Using a disconnected trilogy_conn_t is

data/ext/trilogy-ruby/inc/trilogy/protocol.h

@@ -317,7 +317,7 @@ typedef enum {
     /* The column is part of a primary key.                                                                            \
      */                                                                                                                \
     XX(TRILOGY_COLUMN_FLAG_PRI_KEY, 0x2)                                                                               \
-    /* The column has the `UNIQUE` flag set. Requring all values to be unique.                                         \
+    /* The column has the `UNIQUE` flag set. Requiring all values to be unique.                                        \
      */                                                                                                                \
     XX(TRILOGY_COLUMN_FLAG_UNIQUE_KEY, 0x4)                                                                            \
     /* The column is part of a key.                                                                                    \
@@ -889,7 +889,7 @@ int trilogy_parse_ok_packet(const uint8_t *buff, size_t len, uint32_t capabiliti
 /* trilogy_parse_eof_packet - Parse an EOF packet.
  *
  * buff         - A pointer to the buffer containing the EOF packet data.
- * len          - The lenght of buff in bytes.
+ * len          - The length of buff in bytes.
  * capabilities - A bitmask of TRILOGY_CAPABILITIES_t flags.
  * out_packet   - Out parameter; A pointer to a pre-allocated
  * trilogy_eof_packet_t.

data/ext/trilogy-ruby/inc/trilogy/socket.h

@@ -72,6 +72,8 @@ typedef struct {
     TRILOGY_CAPABILITIES_t flags;
 
     size_t max_allowed_packet;
+
+    void *privdata;
 } trilogy_sockopt_t;
 
 typedef struct trilogy_sock_t {

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

@@ -567,7 +567,7 @@ int trilogy_build_auth_packet(trilogy_builder_t *builder, const char *user, cons
     }
 
     if (pass_len > 0) {
-        // Fallback to te default unless we have SHA2 requested
+        // Fallback to the default unless we have SHA2 requested
         if (!strcmp("caching_sha2_password", auth_plugin)) {
             trilogy_pack_scramble_sha2_hash(scramble, pass, pass_len, auth_response, &auth_response_len);
         } else {

data/lib/trilogy/version.rb

@@ -1,3 +1,3 @@
 class Trilogy
-  VERSION = "2.12.5"
+  VERSION = "2.13.0"
 end

data/lib/trilogy.rb

@@ -22,15 +22,22 @@ class Trilogy
       super
     end
 
+    NEVER = { Object => :never }.freeze
+    IMMEDIATE = { Object => :immediate }.freeze
+
     synchronized_methods = Trilogy.public_instance_methods(false) - %i(closed? server_version)
     source = synchronized_methods.flat_map do |method|
       [
         "def #{method}(...)",
-          "raise SynchronizationError unless @mutex.try_lock",
-          "begin",
-            "super",
-          "ensure",
-            "@mutex.unlock",
+          "Thread.handle_interrupt(NEVER) do",
+            "raise SynchronizationError unless @mutex.try_lock",
+            "begin",
+              "Thread.handle_interrupt(IMMEDIATE) do",
+                "super",
+              "end",
+            "ensure",
+              "@mutex.unlock",
+            "end",
           "end",
         "end",
       ]
@@ -52,7 +59,7 @@ class Trilogy
     begin
       if host = options[:host]
         port = options[:port] || 3306
-        connect_timeout = options[:connect_timeout] || options[:write_timeout]
+        connect_timeout = options.fetch(:connect_timeout, 5) || options[:write_timeout]
 
         socket = TCPSocket.new(host, port, connect_timeout: connect_timeout)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trilogy
 version: !ruby/object:Gem::Version
-  version: 2.12.5
+  version: 2.13.0
 platform: ruby
 authors:
 - GitHub Engineering
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A friendly MySQL-compatible library for Ruby, binding to libtrilogy
 test_files: []