Merge pull request #929 from sodabrew/appveyor-2.4

Windows build fixes for Ruby 2.0, Appveyor fixes for Ruby 2.4

Author: sodabrew

.travis.yml

@@ -45,12 +45,6 @@ matrix:
         mariadb: 10.2
         hosts:
           - mysql2gem.example.com
-    - rvm: 2.0.0
-      env: DB=mysql51
-      dist: precise
-      addons:
-        hosts:
-          - mysql2gem.example.com
     - rvm: 2.0.0
       env: DB=mysql55
       dist: precise
@@ -84,6 +78,3 @@ matrix:
     - os: osx
       rvm: 2.3
       env: DB=mysql56
-    - rvm: 2.0.0
-      env: DB=mysql51
-      dist: precise

.travis_mysql51.sh

@@ -2,11 +2,6 @@
 
 set -eux
 
-# Install MySQL 5.1 if DB=mysql51
-if [[ -n ${DB-} && x$DB =~ ^xmysql51 ]]; then
-  sudo bash .travis_mysql51.sh
-fi
-
 # Install MySQL 5.7 if DB=mysql57
 if [[ -n ${DB-} && x$DB =~ ^xmysql57 ]]; then
   sudo bash .travis_mysql57.sh

.travis_setup.sh

@@ -530,7 +530,7 @@ This gem is tested with the following MySQL and MariaDB versions:
 
  * MySQL 5.5, 5.6, 5.7, 8.0
  * MySQL Connector/C 6.0 and 6.1 (primarily on Windows)
- * MariaDB 5.5, 10.0, 10.1
+ * MariaDB 5.5, 10.0, 10.1, 10.2
 
 ### Ruby on Rails / Active Record
 

README.md

@@ -6,7 +6,6 @@ install:
   - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
   - ruby --version
   - gem --version
-  - gem install bundler --quiet --no-ri --no-rdoc
   - bundler --version
   - bundle install --without benchmarks --path vendor/bundle
   - IF DEFINED MINGW_PACKAGE_PREFIX (ridk exec pacman -S --noconfirm --needed %MINGW_PACKAGE_PREFIX%-libmariadbclient)

appveyor.yml

@@ -400,7 +400,7 @@ static VALUE rb_mysql_get_ssl_cipher(VALUE self)
   return rb_str;
 }
 
-#ifdef HAVE_CONST_MYSQL_OPT_CONNECT_ATTR_ADD
+#ifdef CLIENT_CONNECT_ATTRS
 static int opt_connect_attr_add_i(VALUE key, VALUE value, VALUE arg)
 {
   mysql_client_wrapper *wrapper = (mysql_client_wrapper *)arg;
@@ -428,7 +428,7 @@ static VALUE rb_mysql_connect(VALUE self, VALUE user, VALUE pass, VALUE host, VA
   args.mysql       = wrapper->client;
   args.client_flag = NUM2ULONG(flags);
 
-#ifdef HAVE_CONST_MYSQL_OPT_CONNECT_ATTR_ADD
+#ifdef CLIENT_CONNECT_ATTRS
   mysql_options(wrapper->client, MYSQL_OPT_CONNECT_ATTR_RESET, 0);
   rb_hash_foreach(conn_attrs, opt_connect_attr_add_i, (VALUE)wrapper);
 #endif
@@ -1558,6 +1558,16 @@ void init_mysql2_client() {
       LONG2NUM(CLIENT_BASIC_FLAGS));
 #endif
 
+#ifdef CLIENT_CONNECT_ATTRS
+  rb_const_set(cMysql2Client, rb_intern("CONNECT_ATTRS"),
+      LONG2NUM(CLIENT_CONNECT_ATTRS));
+#else
+  /* HACK because MySQL 5.5 and earlier don't define this constant,
+   * but we're using it in our default connection flags. */
+  rb_const_set(cMysql2Client, rb_intern("CONNECT_ATTRS"),
+      INT2NUM(0));
+#endif
+
 #if defined(FULL_SSL_MODE_SUPPORT) // MySQL 5.7.11 and above
   rb_const_set(cMysql2Client, rb_intern("SSL_MODE_DISABLED"), INT2NUM(SSL_MODE_DISABLED));
   rb_const_set(cMysql2Client, rb_intern("SSL_MODE_PREFERRED"), INT2NUM(SSL_MODE_PREFERRED));

ext/mysql2/client.c

@@ -52,6 +52,13 @@ def add_ssl_defines(header)
 # If the user has provided a --with-mysql-dir argument, we must respect it or fail.
 inc, lib = dir_config('mysql')
 if inc && lib
+  # Ruby versions below 2.0 on Unix and below 2.1 on Windows
+  # do not properly search for lib directories, and must be corrected:
+  # https://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/39717
+  unless lib && lib[-3, 3] == 'lib'
+    @libdir_basename = 'lib'
+    inc, lib = dir_config('mysql')
+  end
   abort "-----\nCannot find include dir(s) #{inc}\n-----" unless inc && inc.split(File::PATH_SEPARATOR).any? { |dir| File.directory?(dir) }
   abort "-----\nCannot find library dir(s) #{lib}\n-----" unless lib && lib.split(File::PATH_SEPARATOR).any? { |dir| File.directory?(dir) }
   warn "-----\nUsing --with-mysql-dir=#{File.dirname inc}\n-----"
@@ -103,7 +110,6 @@ def add_ssl_defines(header)
 have_const('SERVER_QUERY_NO_GOOD_INDEX_USED', mysql_h)
 have_const('SERVER_QUERY_NO_INDEX_USED', mysql_h)
 have_const('SERVER_QUERY_WAS_SLOW', mysql_h)
-have_const('MYSQL_OPT_CONNECT_ATTR_ADD', mysql_h) # for mysql_options4
 
 # This is our wishlist. We use whichever flags work on the host.
 # -Wall and -Wextra are included by default.

ext/mysql2/extconf.rb

@@ -11,7 +11,7 @@ def self.default_query_options
         database_timezone: :local,   # timezone Mysql2 will assume datetime objects are stored in
         application_timezone: nil,   # timezone Mysql2 will convert to before handing the object back to the caller
         cache_rows: true,            # tells Mysql2 to use its internal row cache for results
-        connect_flags: REMEMBER_OPTIONS | LONG_PASSWORD | LONG_FLAG | TRANSACTIONS | PROTOCOL_41 | SECURE_CONNECTION,
+        connect_flags: REMEMBER_OPTIONS | LONG_PASSWORD | LONG_FLAG | TRANSACTIONS | PROTOCOL_41 | SECURE_CONNECTION | CONNECT_ATTRS,
         cast: true,
         default_file: nil,
         default_group: nil,
@@ -64,11 +64,6 @@ def initialize(opts = {})
       # SSL verify is a connection flag rather than a mysql_ssl_set option
       flags |= SSL_VERIFY_SERVER_CERT if opts[:sslverify]
 
-      # Set default program_name in performance_schema.session_connect_attrs
-      # and performance_schema.session_account_connect_attrs
-      conn_attrs = opts[:connect_attrs] || {}
-      conn_attrs[:program_name] = $PROGRAM_NAME unless conn_attrs.key?(:program_name)
-
       if %i[user pass hostname dbname db sock].any? { |k| @query_options.key?(k) }
         warn "============= WARNING FROM mysql2 ============="
         warn "The options :user, :pass, :hostname, :dbname, :db, and :sock are deprecated and will be removed at some point in the future."
@@ -90,9 +85,7 @@ def initialize(opts = {})
       port = port.to_i unless port.nil?
       database = database.to_s unless database.nil?
       socket = socket.to_s unless socket.nil?
-      conn_attrs = conn_attrs.each_with_object({}) do |(key, value), hash|
-        hash[key.to_s] = value.to_s
-      end
+      conn_attrs = parse_connect_attrs(opts[:connect_attrs])
 
       connect user, pass, host, port, database, socket, flags, conn_attrs
     end
@@ -122,6 +115,17 @@ def parse_flags_array(flags, initial = 0)
       end
     end
 
+    # Set default program_name in performance_schema.session_connect_attrs
+    # and performance_schema.session_account_connect_attrs
+    def parse_connect_attrs(conn_attrs)
+      return {} if Mysql2::Client::CONNECT_ATTRS.zero?
+      conn_attrs ||= {}
+      conn_attrs[:program_name] ||= $PROGRAM_NAME
+      conn_attrs.each_with_object({}) do |(key, value), hash|
+        hash[key.to_s] = value.to_s
+      end
+    end
+
     def query(sql, options = {})
       Thread.handle_interrupt(::Mysql2::Util::TIMEOUT_ERROR_CLASS => :never) do
         _query(sql, @query_options.merge(options))

lib/mysql2/client.rb

@@ -79,7 +79,8 @@ def connect(*args)
                    Mysql2::Client::LONG_FLAG |
                    Mysql2::Client::TRANSACTIONS |
                    Mysql2::Client::PROTOCOL_41 |
-                   Mysql2::Client::SECURE_CONNECTION
+                   Mysql2::Client::SECURE_CONNECTION |
+                   Mysql2::Client::CONNECT_ATTRS
     expect(client.connect_args.last[6]).to eql(client_flags)
   end
 
@@ -438,17 +439,17 @@ def run_gc
 
   it "should set default program_name in connect_attrs" do
     client = new_client
-    if Mysql2::Client.info[:version] < '5.6' || client.info[:version] < '5.6'
-      pending('Both client and server versions must be MySQL 5.6 or later.')
+    if Mysql2::Client::CONNECT_ATTRS.zero? || client.server_info[:version].match(/10.[01].\d+-MariaDB/)
+      pending('Both client and server versions must be MySQL 5.6 or MariaDB 10.2 or later.')
     end
     result = client.query("SELECT attr_value FROM performance_schema.session_account_connect_attrs WHERE processlist_id = connection_id() AND attr_name = 'program_name'")
     expect(result.first['attr_value']).to eq($PROGRAM_NAME)
   end
 
   it "should set custom connect_attrs" do
     client = new_client(connect_attrs: { program_name: 'my_program_name', foo: 'fooval', bar: 'barval' })
-    if Mysql2::Client.info[:version] < '5.6' || client.info[:version] < '5.6'
-      pending('Both client and server versions must be MySQL 5.6 or later.')
+    if Mysql2::Client::CONNECT_ATTRS.zero? || client.server_info[:version].match(/10.[01].\d+-MariaDB/)
+      pending('Both client and server versions must be MySQL 5.6 or MariaDB 10.2 or later.')
     end
     results = Hash[client.query("SELECT * FROM performance_schema.session_account_connect_attrs WHERE processlist_id = connection_id()").map { |x| x.values_at('ATTR_NAME', 'ATTR_VALUE') }]
     expect(results['program_name']).to eq('my_program_name')