fix: check for null inputs for various timestamp functions (#7180)

confluentinc · Mar 10, 2021 · 42496c1 · 42496c1
1 parent 55f5403
commit 42496c1
Show file tree

Hide file tree

Showing 12 changed files with 82 additions and 16 deletions.
diff --git a/ksqldb-engine/src/main/java/io/confluent/ksql/function/udf/datetime/ConvertTz.java b/ksqldb-engine/src/main/java/io/confluent/ksql/function/udf/datetime/ConvertTz.java
@@ -44,6 +44,9 @@ public Timestamp convertTz(
           description =  "The toTimeZone in java.util.TimeZone ID format. For example: \"UTC\","
               + " \"America/Los_Angeles\", \"PST\", \"Europe/London\"") final String toTimeZone
   ) {
+    if (timestamp == null) {
+      return null;
+    }
     try {
       final long offset = TimeZone.getTimeZone(ZoneId.of(toTimeZone)).getOffset(timestamp.getTime())
           - TimeZone.getTimeZone(ZoneId.of(fromTimeZone)).getOffset(timestamp.getTime());

diff --git a/ksqldb-engine/src/main/java/io/confluent/ksql/function/udf/datetime/FormatTimestamp.java b/ksqldb-engine/src/main/java/io/confluent/ksql/function/udf/datetime/FormatTimestamp.java
@@ -70,6 +70,9 @@ public String formatTimestamp(
       @UdfParameter(
           description =  " timeZone is a java.util.TimeZone ID format, for example: \"UTC\","
               + " \"America/Los_Angeles\", \"PST\", \"Europe/London\"") final String timeZone) {
+    if (timestamp == null) {
+      return null;
+    }
     try {
       final DateTimeFormatter formatter = formatters.get(formatPattern);
       final ZoneId zoneId = ZoneId.of(timeZone);

diff --git a/ksqldb-engine/src/main/java/io/confluent/ksql/function/udf/datetime/FromUnixTime.java b/ksqldb-engine/src/main/java/io/confluent/ksql/function/udf/datetime/FromUnixTime.java
@@ -34,8 +34,11 @@ public class FromUnixTime {
   public Timestamp fromUnixTime(
       @UdfParameter(
           description = "Milliseconds since"
-              + " January 1, 1970, 00:00:00 GMT.") final long epochMilli
+              + " January 1, 1970, 00:00:00 GMT.") final Long epochMilli
   ) {
+    if (epochMilli == null) {
+      return null;
+    }
     return new Timestamp(epochMilli);
   }
 }
diff --git a/ksqldb-engine/src/main/java/io/confluent/ksql/function/udf/datetime/UnixTimestamp.java b/ksqldb-engine/src/main/java/io/confluent/ksql/function/udf/datetime/UnixTimestamp.java
@@ -38,10 +38,13 @@ public long unixTimestamp() {
 
   @Udf(description = "Returns the number of milliseconds "
       + "since 1970-01-01 00:00:00 UTC/GMT represented by the given timestamp.")
-  public long unixTimestamp(
+  public Long unixTimestamp(
       @UdfParameter(
           description = "the TIMESTAMP value.") final Timestamp timestamp
   ) {
+    if (timestamp == null) {
+      return null;
+    }
     return timestamp.getTime();
   }
 }
diff --git a/ksqldb-engine/src/test/java/io/confluent/ksql/function/udf/datetime/ConvertTzTest.java b/ksqldb-engine/src/test/java/io/confluent/ksql/function/udf/datetime/ConvertTzTest.java
@@ -17,6 +17,7 @@
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThrows;
 
 import io.confluent.ksql.function.KsqlFunctionException;
@@ -61,4 +62,13 @@ public void shouldThrowOnInvalidTimezone() {
     // Then:
     assertThat(e.getMessage(), containsString("Invalid time zone"));
   }
+
+  @Test
+  public void shouldReturnNull() {
+    // When:
+    final Object result = udf.convertTz(null, "America/Los_Angeles", "America/New_York");
+
+    // Then:
+    assertNull(result);
+  }
 }
diff --git a/ksqldb-engine/src/test/java/io/confluent/ksql/function/udf/datetime/FormatTimestampTest.java b/ksqldb-engine/src/test/java/io/confluent/ksql/function/udf/datetime/FormatTimestampTest.java
@@ -19,6 +19,7 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.containsString;
 import static org.hamcrest.Matchers.either;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.fail;
 
@@ -127,6 +128,15 @@ public void shouldSupportEmbeddedChars() {
     assertThat(result, is(expectedResult));
   }
 
+  @Test
+  public void shoudlReturnNull() {
+    // When:
+    final Object result = udf.formatTimestamp(null, "yyyy-MM-dd'T'HH:mm:ss.SSS");
+
+    // Then:
+    assertNull(result);
+  }
+
   @Test
   public void shouldThrowIfFormatInvalid() {
     // When:

diff --git a/ksqldb-engine/src/test/java/io/confluent/ksql/function/udf/datetime/FromUnixTimeTest.java b/ksqldb-engine/src/test/java/io/confluent/ksql/function/udf/datetime/FromUnixTimeTest.java
@@ -16,6 +16,7 @@
 
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.Assert.assertNull;
 
 import java.sql.Timestamp;
 import org.junit.Before;
@@ -37,4 +38,13 @@ public void shouldConvertToTimestamp() {
     // Then:
     assertThat(result, is(new Timestamp(100L)));
   }
+
+  @Test
+  public void shouldReturnNull() {
+    // When:
+    final Object result = udf.fromUnixTime(null);
+
+    // Then:
+    assertNull(result);
+  }
 }
diff --git a/ksqldb-engine/src/test/java/io/confluent/ksql/function/udf/datetime/UnixTimestampTest.java b/ksqldb-engine/src/test/java/io/confluent/ksql/function/udf/datetime/UnixTimestampTest.java
@@ -20,6 +20,7 @@
 
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 
 public class UnixTimestampTest {
@@ -52,4 +53,13 @@ public void shouldReturnMilliseconds() {
     // Then:
     assertThat(result, is(100L));
   }
+
+  @Test
+  public void shouldReturnNull() {
+    // When:
+    final Long result = udf.unixTimestamp(null);
+
+    // Then:
+    assertNull(result);
+  }
 }
diff --git a/ksqldb-functional-tests/src/test/resources/query-validation-tests/convert-tz.json b/ksqldb-functional-tests/src/test/resources/query-validation-tests/convert-tz.json
@@ -11,11 +11,13 @@
       ],
       "inputs": [
         {"topic": "test_topic", "key": "0", "value": "100"},
-        {"topic": "test_topic", "key": "0", "value": "1589234313000"}
+        {"topic": "test_topic", "key": "0", "value": "1589234313000"},
+        {"topic": "test_topic", "key": "0", "value": null}
       ],
       "outputs": [
         {"topic": "TS", "key": "0", "value": "10800100"},
-        {"topic": "TS", "key": "0", "value": "1589245113000"}
+        {"topic": "TS", "key": "0", "value": "1589245113000"},
+        {"topic": "TS", "key": "0", "value": null}
       ]
     },
     {
@@ -26,11 +28,13 @@
       ],
       "inputs": [
         {"topic": "test_topic", "key": "0", "value": "100"},
-        {"topic": "test_topic", "key": "0", "value": "1589234313000"}
+        {"topic": "test_topic", "key": "0", "value": "1589234313000"},
+        {"topic": "test_topic", "key": "0", "value": null}
       ],
       "outputs": [
         {"topic": "TS", "key": "0", "value": "10800100"},
-        {"topic": "TS", "key": "0", "value": "1589245113000"}
+        {"topic": "TS", "key": "0", "value": "1589245113000"},
+        {"topic": "TS", "key": "0", "value": null}
       ]
     }
   ]

diff --git a/ksqldb-functional-tests/src/test/resources/query-validation-tests/from-unixtime.json b/ksqldb-functional-tests/src/test/resources/query-validation-tests/from-unixtime.json
@@ -11,11 +11,13 @@
       ],
       "inputs": [
         {"topic": "test_topic", "key": "0", "value": "100"},
-        {"topic": "test_topic", "key": "0", "value": "1589234313000"}
+        {"topic": "test_topic", "key": "0", "value": "1589234313000"},
+        {"topic": "test_topic", "key": "0", "value": null}
       ],
       "outputs": [
         {"topic": "TS", "key": "0", "value": "100"},
-        {"topic": "TS", "key": "0", "value": "1589234313000"}
+        {"topic": "TS", "key": "0", "value": "1589234313000"},
+        {"topic": "TS", "key": "0", "value": null}
       ]
     }
   ]

diff --git a/ksqldb-functional-tests/src/test/resources/query-validation-tests/timestamp-to-string.json b/ksqldb-functional-tests/src/test/resources/query-validation-tests/timestamp-to-string.json
@@ -38,10 +38,12 @@
         "CREATE STREAM OUTPUT AS SELECT K, FORMAT_TIMESTAMP(TIME, 'yyyy-MM-dd HH:mm:ss zzz','America/Los_Angeles') FROM input;"
       ],
       "inputs": [
-        {"topic": "input", "value": {"time": 1526075913000}, "timestamp": 1526075913000}
+        {"topic": "input", "value": {"time": 1526075913000}, "timestamp": 1526075913000},
+        {"topic": "input", "value": {"time": null}, "timestamp": 1526075913000}
       ],
       "outputs": [
-        {"topic": "OUTPUT", "value": {"KSQL_COL_0":"2018-05-11 14:58:33 PDT"}, "timestamp": 1526075913000}
+        {"topic": "OUTPUT", "value": {"KSQL_COL_0":"2018-05-11 14:58:33 PDT"}, "timestamp": 1526075913000},
+        {"topic": "OUTPUT", "value": {"KSQL_COL_0":null}, "timestamp": 1526075913000}
       ]
     },
     {
@@ -51,10 +53,12 @@
         "CREATE STREAM OUTPUT AS SELECT K, FORMAT_TIMESTAMP(TIME, 'yyyy-MM-dd HH:mm:ss') FROM input;"
       ],
       "inputs": [
-        {"topic": "input", "value": {"time": 1526075913000}, "timestamp": 1526075913000}
+        {"topic": "input", "value": {"time": 1526075913000}, "timestamp": 1526075913000},
+        {"topic": "input", "value": {"time": null}, "timestamp": 1526075913000}
       ],
       "outputs": [
-        {"topic": "OUTPUT", "value": {"KSQL_COL_0":"2018-05-11 21:58:33"}, "timestamp": 1526075913000}
+        {"topic": "OUTPUT", "value": {"KSQL_COL_0":"2018-05-11 21:58:33"}, "timestamp": 1526075913000},
+        {"topic": "OUTPUT", "value": {"KSQL_COL_0":null}, "timestamp": 1526075913000}
       ]
     }
   ]

diff --git a/ksqldb-functional-tests/src/test/resources/query-validation-tests/unix-timestamp.json b/ksqldb-functional-tests/src/test/resources/query-validation-tests/unix-timestamp.json
@@ -11,11 +11,13 @@
       ],
       "inputs": [
         {"topic": "test_topic", "key": "0", "value": "a"},
-        {"topic": "test_topic", "key": "0", "value": "b"}
+        {"topic": "test_topic", "key": "0", "value": "b"},
+        {"topic": "test_topic", "key": "0", "value": null}
       ],
       "outputs": [
         {"topic": "TS", "key": "0", "value": "true"},
-        {"topic": "TS", "key": "0", "value": "true"}
+        {"topic": "TS", "key": "0", "value": "true"},
+        {"topic": "TS", "key": "0", "value": null}
       ]
     },
     {
@@ -26,11 +28,13 @@
       ],
       "inputs": [
         {"topic": "test_topic", "key": "0", "value": "100"},
-        {"topic": "test_topic", "key": "0", "value": "1589234313000"}
+        {"topic": "test_topic", "key": "0", "value": "1589234313000"},
+        {"topic": "test_topic", "key": "0", "value": null}
       ],
       "outputs": [
         {"topic": "TS", "key": "0", "value": "100"},
-        {"topic": "TS", "key": "0", "value": "1589234313000"}
+        {"topic": "TS", "key": "0", "value": "1589234313000"},
+        {"topic": "TS", "key": "0", "value": null}
       ]
     }
   ]