Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Print warning when unknown options are passed to Trilogy#initialize #155

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions contrib/ruby/lib/trilogy.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,18 @@
require "trilogy/encoding"

class Trilogy
VALID_OPTIONS = %i[
host port path database username password encoding
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the distinction between socket and path options?

I see this:

path: DEFAULT_SOCK, # for trilogy
socket: DEFAULT_SOCK, # for mysql2

..but also this:

Copy link
Contributor

@composerinteralia composerinteralia Jan 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think path is a valid option for either trilogy or mysql2. Maybe it used to be called path?

ssl ssl_mode ssl_cipher ssl_ca ssl_capath ssl_key ssl_cert
tls_min_version tls_max_version tls_ciphersuites
read_timeout write_timeout connect_timeout
multi_statement
].freeze

def initialize(options = {})
invalid_keys = options.keys - VALID_OPTIONS
$stderr.puts "[WARNING] Unknown Trilogy options: #{invalid_keys.map(&:inspect).join(", ")}" unless invalid_keys.empty?

options[:port] = options[:port].to_i if options[:port]
mysql_encoding = options[:encoding] || "utf8mb4"
encoding = Trilogy::Encoding.find(mysql_encoding)
Expand Down
2 changes: 2 additions & 0 deletions contrib/ruby/test/client_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ def test_trilogy_connection_options
tls_min_version: 3,
}
assert_equal expected_connection_options, client.connection_options

assert_output('', /\[WARNING\] Unknown Trilogy options: :foo, "bar"/) { new_tcp_client({ foo: "", "bar" => "" }) }
end

def test_trilogy_ping
Expand Down
Loading