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.

Sign up for GitHub

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

Improve handling of quoted table names #13612

Merged
merged 1 commit into from
Apr 10, 2025
Merged

Improve handling of quoted table names #13612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 28 additions & 4 deletions instrumentation-api-incubator/src/main/jflex/SqlSanitizer.jflex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@ OPEN_PAREN = "("
CLOSE_PAREN = ")"
OPEN_COMMENT = "/*"
CLOSE_COMMENT = "*/"
IDENTIFIER = ([:letter:] | "_") ([:letter:] | [0-9] | [_.])*
UNQUOTED_IDENTIFIER = ([:letter:] | "_") ([:letter:] | [0-9] | "_")*
IDENTIFIER_PART = {UNQUOTED_IDENTIFIER} | {DOUBLE_QUOTED_STR} | {BACKTICK_QUOTED_STR}
// We are using {UNQUOTED_IDENTIFIER} instead of {IDENTIFIER_PART} here because DOUBLE_QUOTED_STR
// and BACKTICK_QUOTED_STR are handled separately. Depending on the context they appear in they will
// either be recorded as the identifier or replaced with ?.
IDENTIFIER = {UNQUOTED_IDENTIFIER} | ({IDENTIFIER_PART} ("." {IDENTIFIER_PART})+)
BASIC_NUM = [.+-]* [0-9] ([0-9] | [eE.+-])*
HEX_NUM = "0x" ([a-f] | [A-F] | [0-9])+
QUOTED_STR = "'" ("''" | [^'])* "'"
Expand Down Expand Up @@ -69,12 +74,31 @@ WHITESPACE = [ \t\r\n]+
return builder.length() > LIMIT;
}

private String removeQuotes(String identifierName, String quote) {
// remove quotes from the start and end of the identifier ("table" is transformed to table), if
// identifier contains quote anywhere else besides start and end leave it as is (quotes are not
// removed from "schema"."table")
if (identifierName.startsWith(quote) && identifierName.endsWith(quote)) {
String s = identifierName.substring(1, identifierName.length() - 1);
if (!s.contains(quote)) {
return s;
}
}
return identifierName;
}

/** @return text matched by current token without enclosing double quotes or backticks */
private String readIdentifierName() {
String identifierName = yytext();
if (identifierName != null && ((identifierName.startsWith("\"") && identifierName.endsWith("\""))
|| (identifierName.startsWith("`") && identifierName.endsWith("`")))) {
identifierName = identifierName.substring(1, identifierName.length() - 1);
if (identifierName != null) {
String result = removeQuotes(identifierName, "\"");
if (!result.equals(identifierName)) {
return result;
}
result = removeQuotes(identifierName, "`");
if (!result.equals(identifierName)) {
return result;
}
}
return identifierName;
}
Expand Down
4 changes: 4 additions & 0 deletions .../io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlStatementSanitizerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,11 @@ public Stream<? extends Arguments> provideArguments(ExtensionContext context) {
// Select
Arguments.of("SELECT x, y, z FROM schema.table", expect("SELECT", "schema.table")),
Arguments.of("SELECT x, y, z FROM `schema table`", expect("SELECT", "schema table")),
Arguments.of(
"SELECT x, y, z FROM `schema`.`table`", expect("SELECT", "`schema`.`table`")),
Arguments.of("SELECT x, y, z FROM \"schema table\"", expect("SELECT", "schema table")),
Arguments.of(
"SELECT x, y, z FROM \"schema\".\"table\"", expect("SELECT", "\"schema\".\"table\"")),
Arguments.of(
"WITH subquery as (select a from b) SELECT x, y, z FROM table",
expect("SELECT", null)),
Expand Down
Loading