From bc965ba428a0eaf02fc2200016fa60f9e22bd8e0 Mon Sep 17 00:00:00 2001 From: xingyutangyuan <147447743+xingyutangyuan@users.noreply.github.com> Date: Tue, 28 Nov 2023 23:16:00 -0800 Subject: [PATCH 1/4] Tweak the format of GoogleSql javadoc --- .../src/main/java/com/google/mu/safesql/GoogleSql.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java b/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java index 600e95b109..e189ac1694 100644 --- a/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java +++ b/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java @@ -23,9 +23,11 @@ public final class GoogleSql { /** - * Similar to {@link SafeQuery#template}, except {@link Instant} are translated to `TIMESTAMP()` GoogleSql function, - * {@link ZonedDateTime} are translated to `DTETIME()` GoogleSql function, and {@link LocalDate} are translated - * to `DATE()` GoogleSql function. + * Similar to {@link SafeQuery#template}, but applies additional GoogleSQL translation rules. + * + *

Specifically, {@link Instant} are translated to `TIMESTAMP()` GoogleSql function, + * {@link ZonedDateTime} are translated to `DTETIME()` GoogleSql function, + * and {@link LocalDate} are translated to `DATE()` GoogleSql function. */ public static StringFormat.To template(@CompileTimeConstant String formatString) { return SafeQuery.template(formatString, value -> { From 4154626b3d9738273783d477190d1b51576e81ef Mon Sep 17 00:00:00 2001 From: xingyutangyuan <147447743+xingyutangyuan@users.noreply.github.com> Date: Tue, 28 Nov 2023 23:44:30 -0800 Subject: [PATCH 2/4] Fix GoogleSqlTest --- .../java/com/google/mu/safesql/GoogleSql.java | 2 +- .../java/com/google/mu/safesql/SafeQuery.java | 16 +++++++++------- .../com/google/mu/safesql/GoogleSqlTest.java | 11 ++++++++++- .../com/google/mu/safesql/SafeQueryTest.java | 2 +- 4 files changed, 21 insertions(+), 10 deletions(-) diff --git a/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java b/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java index e189ac1694..3392a5130a 100644 --- a/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java +++ b/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java @@ -23,7 +23,7 @@ public final class GoogleSql { /** - * Similar to {@link SafeQuery#template}, but applies additional GoogleSQL translation rules. + * Much like {@link SafeQuery#template}, but with additional GoogleSQL translation rules. * *

Specifically, {@link Instant} are translated to `TIMESTAMP()` GoogleSql function, * {@link ZonedDateTime} are translated to `DTETIME()` GoogleSql function, diff --git a/mug-guava/src/main/java/com/google/mu/safesql/SafeQuery.java b/mug-guava/src/main/java/com/google/mu/safesql/SafeQuery.java index 88cc20bd43..9d7a429cc5 100644 --- a/mug-guava/src/main/java/com/google/mu/safesql/SafeQuery.java +++ b/mug-guava/src/main/java/com/google/mu/safesql/SafeQuery.java @@ -132,7 +132,8 @@ static StringFormat.To template( placeholders .collect( new StringBuilder(), - (b, p, v) -> b.append(it.next()).append(fillInPlaceholder(p, v, defaultConverter))) + (b, p, v) -> + b.append(it.next()).append(fillInPlaceholder(p, v, defaultConverter))) .append(it.next()) .toString()); }); @@ -158,7 +159,7 @@ public int hashCode() { } private static String fillInPlaceholder( - Substring.Match placeholder, Object value, Function byDefault) { + Substring.Match placeholder, Object value, Function defaultConverter) { validatePlaceholder(placeholder); if (value instanceof Iterable) { Iterable iterable = (Iterable) value; @@ -173,7 +174,8 @@ private static String fillInPlaceholder( return String.join( "\", \"", Iterables.transform(iterable, v -> quotedBy('"', placeholder, v))); } - return String.join(", ", Iterables.transform(iterable, v -> unquoted(placeholder, v))); + return String.join( + ", ", Iterables.transform(iterable, v -> unquoted(placeholder, v, defaultConverter))); } if (placeholder.isImmediatelyBetween("'", "'")) { return quotedBy('\'', placeholder, value); @@ -184,11 +186,11 @@ private static String fillInPlaceholder( if (placeholder.isImmediatelyBetween("`", "`")) { return backquoted(placeholder, value); } - String result = unquoted(placeholder, value); - return result == null ? byDefault.apply(value) : result; + return unquoted(placeholder, value, defaultConverter); } - private static String unquoted(Substring.Match placeholder, Object value) { + private static String unquoted( + Substring.Match placeholder, Object value, Function byDefault) { if (value == null) { return "NULL"; } @@ -210,7 +212,7 @@ private static String unquoted(Substring.Match placeholder, Object value) { + "subqueries must be wrapped in another SafeQuery object;\n" + "and string literals must be quoted like '%s'", TRUSTED_SQL_TYPE_NAME, placeholder); - return null; + return byDefault.apply(value); } private static String quotedBy(char quoteChar, Substring.Match placeholder, Object value) { diff --git a/mug-guava/src/test/java/com/google/mu/safesql/GoogleSqlTest.java b/mug-guava/src/test/java/com/google/mu/safesql/GoogleSqlTest.java index 79cb0c623c..6b5ddba6e6 100644 --- a/mug-guava/src/test/java/com/google/mu/safesql/GoogleSqlTest.java +++ b/mug-guava/src/test/java/com/google/mu/safesql/GoogleSqlTest.java @@ -8,16 +8,25 @@ import java.time.ZoneId; import java.time.ZonedDateTime; +import org.junit.BeforeClass; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; +import com.google.mu.safesql.SafeQueryTest.TrustedSql; + @RunWith(JUnit4.class) public class GoogleSqlTest { + @BeforeClass // Consistently set the system property across the test suite + public static void setUpTrustedType() { + System.setProperty( + "com.google.mu.safesql.SafeQuery.trusted_sql_type", + SafeQueryTest.TrustedSql.class.getName()); + } @Test public void farPastTimestampPlaceholder() { - ZonedDateTime time = ZonedDateTime.of(1900, 1, 1, 0, 0, 0, 0, googleZoneId()); + ZonedDateTime time = ZonedDateTime.of(1900, 1, 1, 0, 0, 0, 0, ZoneId.of("America/Los_Angeles")); assertThat( template("SELECT * FROM tbl WHERE creation_time = {creation_time}") .with(/* creation_time */ time.toInstant())) diff --git a/mug-guava/src/test/java/com/google/mu/safesql/SafeQueryTest.java b/mug-guava/src/test/java/com/google/mu/safesql/SafeQueryTest.java index a0a615d6a6..63670f9cdc 100644 --- a/mug-guava/src/test/java/com/google/mu/safesql/SafeQueryTest.java +++ b/mug-guava/src/test/java/com/google/mu/safesql/SafeQueryTest.java @@ -494,7 +494,7 @@ public void trustedSqlStringShouldNotBeDoubleQuoted() { .contains("TrustedSql should not be quoted: \"{value}\""); } - private static final class TrustedSql { + static final class TrustedSql { private final String sql; TrustedSql(String sql) { From dfa40b31341e5cc83e2c4b38157eecc854db2bb5 Mon Sep 17 00:00:00 2001 From: xingyutangyuan <147447743+xingyutangyuan@users.noreply.github.com> Date: Tue, 28 Nov 2023 23:46:41 -0800 Subject: [PATCH 3/4] Remove unused import --- .../src/test/java/com/google/mu/safesql/GoogleSqlTest.java | 2 -- 1 file changed, 2 deletions(-) diff --git a/mug-guava/src/test/java/com/google/mu/safesql/GoogleSqlTest.java b/mug-guava/src/test/java/com/google/mu/safesql/GoogleSqlTest.java index 6b5ddba6e6..893ea2eb50 100644 --- a/mug-guava/src/test/java/com/google/mu/safesql/GoogleSqlTest.java +++ b/mug-guava/src/test/java/com/google/mu/safesql/GoogleSqlTest.java @@ -13,8 +13,6 @@ import org.junit.runner.RunWith; import org.junit.runners.JUnit4; -import com.google.mu.safesql.SafeQueryTest.TrustedSql; - @RunWith(JUnit4.class) public class GoogleSqlTest { @BeforeClass // Consistently set the system property across the test suite From cf68931b7f7c3e9df31146e4cacd3cb5805405be Mon Sep 17 00:00:00 2001 From: xingyutangyuan <147447743+xingyutangyuan@users.noreply.github.com> Date: Tue, 28 Nov 2023 23:48:44 -0800 Subject: [PATCH 4/4] Fix GoogleSqlTest --- mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java b/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java index 3392a5130a..a3155eb27b 100644 --- a/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java +++ b/mug-guava/src/main/java/com/google/mu/safesql/GoogleSql.java @@ -26,7 +26,7 @@ public final class GoogleSql { * Much like {@link SafeQuery#template}, but with additional GoogleSQL translation rules. * *

Specifically, {@link Instant} are translated to `TIMESTAMP()` GoogleSql function, - * {@link ZonedDateTime} are translated to `DTETIME()` GoogleSql function, + * {@link ZonedDateTime} are translated to `DATETIME()` GoogleSql function, * and {@link LocalDate} are translated to `DATE()` GoogleSql function. */ public static StringFormat.To template(@CompileTimeConstant String formatString) {