Fix Sequel instrumentation when executing literal strings #1185
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When instrumenting an application using the `sequel` integration, tracing was failing for a case like the following:
```ruby
db.run(
Sequel.lit("UPDATE foo SET bar = :wat WHERE bar = :var", wat: 2, var: 1)
)
```
When using `Sequel.lit` in this context, it returns a `Sequel::SQL::PlaceholderLiteralString`.
This object does not respond to `prepared_sql`, the method expected by `Datadog::Contrib::Sequel::Utils.parse_opts`.
To coerce a `Sequel::SQL::PlaceholderLiteralString` into a `String`, `Sequel::Database#literal` (`Sequel::Dataset#literal`) may be used.
Unfortunately a duck-type approach for the variety of types the `sql` argument may take is not possible as when `sql` is a `String` because `#literal` escapes `'`s:
```ruby
db.literal("SELECT * FROM tbl WHERE name = 'foo'") # => "'SELECT * FROM tbl WHERE name = ''foo'''"
```
marcotc
approved these changes
Sep 23, 2020
There was a problem hiding this comment.
Thank you very much for your contribution, @matchbookmac!
The changes look good. 👍
marcotc
added
community
|
For the CI failures, I recommend you update this branch with latest master, as we have recently fixed a few CI test issues. |
…sequel-instrumentation-fail-for-sql-expression
marcotc
changed the title
|
Thanks! |
matchbookmac
deleted the
sequel-instrumentation-fail-for-sql-expression
branch
|
👋 @matchbookmac This has been released in 0.41.0 https://github.com/DataDog/dd-trace-rb/releases/tag/v0.41.0, thanks again for the contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When instrumenting an application using the
sequelintegration, tracing was failing for a case like the following:When using
Sequel.litin this context, it returns aSequel::SQL::PlaceholderLiteralString.This object does not respond to
prepared_sql, the method expected byDatadog::Contrib::Sequel::Utils.parse_opts.To coerce a
Sequel::SQL::PlaceholderLiteralStringinto aString,Sequel::Database#literal(Sequel::Dataset#literal) may be used.Unfortunately, a duck-type approach for the variety of types the
sqlargument may take is not possible whensqlis aStringbecause#literalescapes's:As such, it is necessary to check the type of
sqlin order to coerce it.