HubSpot · boulter · May 1, 2023 · May 1, 2023 · May 1, 2023 · May 1, 2023
diff --git a/src/main/java/com/hubspot/jinjava/JinjavaConfig.java b/src/main/java/com/hubspot/jinjava/JinjavaConfig.java
@@ -40,6 +40,7 @@
 import java.nio.charset.StandardCharsets;
 import java.time.ZoneId;
 import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
 import java.util.HashMap;
 import java.util.Locale;
 import java.util.Map;
@@ -49,6 +50,17 @@
 import javax.el.ELResolver;
 
 public class JinjavaConfig {
+  public static final ZonedDateTime DEFAULT_DATE_TIME_FILTER_ARG = ZonedDateTime.of(
+    2024,
+    6,
+    1,
+    0,
+    0,
+    0,
+    0,
+    ZoneId.of("UTC")
+  );
+
   private final Charset charset;
   private final Locale locale;
   private final ZoneId timeZone;
@@ -73,6 +85,7 @@ public class JinjavaConfig {
   private final int maxNumDeferredTokens;
   private final InterpreterFactory interpreterFactory;
   private final DateTimeProvider dateTimeProvider;
+  private final boolean useCurrentTimeForNullDateTimeFilterArgs;
   private TokenScannerSymbols tokenScannerSymbols;
   private final ELResolver elResolver;
   private final ExecutionMode executionMode;
@@ -140,6 +153,8 @@ private JinjavaConfig(Builder builder) {
     objectMapper = setupObjectMapper(builder.objectMapper);
     objectUnwrapper = builder.objectUnwrapper;
     processors = builder.processors;
+    useCurrentTimeForNullDateTimeFilterArgs =
+      builder.useCurrentTimeForNullDateTimeFilterArgs;
   }
 
   private ObjectMapper setupObjectMapper(@Nullable ObjectMapper objectMapper) {
@@ -288,6 +303,10 @@ public DateTimeProvider getDateTimeProvider() {
     return dateTimeProvider;
   }
 
+  public boolean getUseCurrentTimeForNullDateTimeFilterArgs() {
+    return useCurrentTimeForNullDateTimeFilterArgs;
+  }
+
   public static class Builder {
     private Charset charset = StandardCharsets.UTF_8;
     private Locale locale = Locale.ENGLISH;
@@ -322,6 +341,7 @@ public static class Builder {
 
     private ObjectUnwrapper objectUnwrapper = new JinjavaObjectUnwrapper();
     private JinjavaProcessors processors = JinjavaProcessors.newBuilder().build();
+    private boolean useCurrentTimeForNullDateTimeFilterArgs = true;
 
     private Builder() {}
 
@@ -508,6 +528,11 @@ public Builder withProcessors(JinjavaProcessors jinjavaProcessors) {
       return this;
     }
 
+    public Builder withUseCurrentTimeForNullDateTileFilterArgs(boolean useCurrentTime) {
+      this.useCurrentTimeForNullDateTimeFilterArgs = useCurrentTime;
+      return this;
+    }
+
     public JinjavaConfig build() {
       return new JinjavaConfig(this);
     }

diff --git a/src/main/java/com/hubspot/jinjava/lib/filter/BetweenTimesFilter.java b/src/main/java/com/hubspot/jinjava/lib/filter/BetweenTimesFilter.java
@@ -1,5 +1,6 @@
 package com.hubspot.jinjava.lib.filter;
 
+import com.hubspot.jinjava.JinjavaConfig;
 import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
 import com.hubspot.jinjava.doc.annotations.JinjavaParam;
 import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;
@@ -73,15 +74,21 @@ private ZonedDateTime getZonedDateTime(Object var, String position) {
     } else {
       JinjavaInterpreter interpreter = JinjavaInterpreter.getCurrent();
 
-      interpreter.addError(
-        TemplateError.fromMissingFilterArgException(
-          new InvalidArgumentException(
-            interpreter,
-            getName() + " filter called with null " + position,
-            getName()
+      if (var == null) {
+        interpreter.addError(
+          TemplateError.fromMissingFilterArgException(
+            new InvalidArgumentException(
+              interpreter,
+              getName() + " filter called with null " + position,
+              getName()
+            )
           )
-        )
-      );
+        );
+
+        if (!interpreter.getConfig().getUseCurrentTimeForNullDateTimeFilterArgs()) {
+          var = JinjavaConfig.DEFAULT_DATE_TIME_FILTER_ARG;
+        }
+      }
 
       return Functions.getDateTimeArg(var, ZoneOffset.UTC);
     }

diff --git a/src/main/java/com/hubspot/jinjava/lib/filter/time/DateTimeFormatHelper.java b/src/main/java/com/hubspot/jinjava/lib/filter/time/DateTimeFormatHelper.java
@@ -94,19 +94,23 @@ private DateTimeFormatter buildFormatter(String format) {
     }
   }
 
-  public void checkForNullVar(Object var, String name) {
+  public Object checkForNullVar(Object var, String name) {
+    JinjavaInterpreter interpreter = JinjavaInterpreter.getCurrent();
+
     if (var == null) {
-      JinjavaInterpreter
-        .getCurrent()
-        .addError(
-          TemplateError.fromMissingFilterArgException(
-            new InvalidArgumentException(
-              JinjavaInterpreter.getCurrent(),
-              name,
-              name + " filter called with null value"
-            )
+      interpreter.addError(
+        TemplateError.fromMissingFilterArgException(
+          new InvalidArgumentException(
+            JinjavaInterpreter.getCurrent(),
+            name,
+            name + " filter called with null datetime"
           )
-        );
+        )
+      );
+      if (!interpreter.getConfig().getUseCurrentTimeForNullDateTimeFilterArgs()) {
+        return JinjavaConfig.DEFAULT_DATE_TIME_FILTER_ARG;
+      }
     }
+    return var;
   }
 }
diff --git a/src/main/java/com/hubspot/jinjava/lib/filter/time/FormatDateFilter.java b/src/main/java/com/hubspot/jinjava/lib/filter/time/FormatDateFilter.java
@@ -48,12 +48,11 @@ public class FormatDateFilter implements Filter {
 
   @Override
   public Object filter(Object var, JinjavaInterpreter interpreter, String... args) {
-    HELPER.checkForNullVar(var, NAME);
     return format(var, args);
   }
 
   public static Object format(Object var, String... args) {
-    return HELPER.format(var, args);
+    return HELPER.format(HELPER.checkForNullVar(var, NAME), args);
   }
 
   @Override

diff --git a/src/main/java/com/hubspot/jinjava/lib/filter/time/FormatDatetimeFilter.java b/src/main/java/com/hubspot/jinjava/lib/filter/time/FormatDatetimeFilter.java
@@ -54,8 +54,7 @@ public Object filter(Object var, JinjavaInterpreter interpreter, String... args)
   }
 
   public static Object format(Object var, String... args) {
-    HELPER.checkForNullVar(var, NAME);
-    return HELPER.format(var, args);
+    return HELPER.format(HELPER.checkForNullVar(var, NAME), args);
   }
 
   @Override

diff --git a/src/main/java/com/hubspot/jinjava/lib/filter/time/FormatTimeFilter.java b/src/main/java/com/hubspot/jinjava/lib/filter/time/FormatTimeFilter.java
@@ -52,8 +52,7 @@ public Object filter(Object var, JinjavaInterpreter interpreter, String... args)
   }
 
   public static Object format(Object var, String... args) {
-    HELPER.checkForNullVar(var, NAME);
-    return HELPER.format(var, args);
+    return HELPER.format(HELPER.checkForNullVar(var, NAME), args);
   }
 
   @Override

diff --git a/src/main/java/com/hubspot/jinjava/lib/fn/Functions.java b/src/main/java/com/hubspot/jinjava/lib/fn/Functions.java
@@ -43,6 +43,7 @@ public class Functions {
   public static final String STRING_TO_DATE_FUNCTION = "stringToDate";
 
   public static final int DEFAULT_RANGE_LIMIT = 1000;
+  private static final String DATETIMEFORMAT_FILTER = "datetimeformat";
 
   @JinjavaDoc(
     value = "Only usable within blocks, will render the contents of the parent block by calling super.",
@@ -187,14 +188,15 @@ public static ZonedDateTime today(String... var) {
   public static String dateTimeFormat(Object var, String... format) {
     ZoneId zoneOffset = ZoneId.of("UTC");
 
+    JinjavaInterpreter interpreter = JinjavaInterpreter.getCurrent();
     if (format.length > 1 && format[1] != null) {
       String timezone = format[1];
       try {
         zoneOffset = ZoneId.of(timezone);
       } catch (DateTimeException e) {
         throw new InvalidArgumentException(
-          JinjavaInterpreter.getCurrent(),
-          "datetimeformat",
+          interpreter,
+          DATETIMEFORMAT_FILTER,
           String.format("Invalid timezone: %s", timezone)
         );
       }
@@ -205,17 +207,18 @@ public static String dateTimeFormat(Object var, String... format) {
     }
 
     if (var == null) {
-      JinjavaInterpreter
-        .getCurrent()
-        .addError(
-          TemplateError.fromMissingFilterArgException(
-            new InvalidArgumentException(
-              JinjavaInterpreter.getCurrent(),
-              "datetimeformat",
-              "datetimeformat filter called with null datetime"
-            )
+      interpreter.addError(
+        TemplateError.fromMissingFilterArgException(
+          new InvalidArgumentException(
+            interpreter,
+            DATETIMEFORMAT_FILTER,
+            DATETIMEFORMAT_FILTER + " filter called with null datetime"
           )
-        );
+        )
+      );
+      if (!interpreter.getConfig().getUseCurrentTimeForNullDateTimeFilterArgs()) {
+        var = JinjavaConfig.DEFAULT_DATE_TIME_FILTER_ARG;
+      }
     }
 
     ZonedDateTime d = getDateTimeArg(var, zoneOffset);
@@ -299,6 +302,8 @@ public static ZonedDateTime getDateTimeArg(Object var, ZoneId zoneOffset) {
   public static long unixtimestamp(Object... var) {
     Object filterVar = var == null || var.length == 0 ? null : var[0];
 
+    JinjavaInterpreter interpreter = JinjavaInterpreter.getCurrent();
+
     if (filterVar == null) {
       JinjavaInterpreter
         .getCurrent()
@@ -311,7 +316,12 @@ public static long unixtimestamp(Object... var) {
             )
           )
         );
+
+      if (!interpreter.getConfig().getUseCurrentTimeForNullDateTimeFilterArgs()) {
+        filterVar = JinjavaConfig.DEFAULT_DATE_TIME_FILTER_ARG;
+      }
     }
+
     ZonedDateTime d = getDateTimeArg(filterVar, ZoneOffset.UTC);
 
     if (d == null) {

diff --git a/src/test/java/com/hubspot/jinjava/lib/filter/DateTimeFormatFilterTest.java b/src/test/java/com/hubspot/jinjava/lib/filter/DateTimeFormatFilterTest.java
@@ -4,7 +4,10 @@
 
 import com.google.common.collect.ImmutableMap;
 import com.hubspot.jinjava.BaseInterpretingTest;
+import com.hubspot.jinjava.Jinjava;
+import com.hubspot.jinjava.JinjavaConfig;
 import com.hubspot.jinjava.interpret.InvalidArgumentException;
+import com.hubspot.jinjava.interpret.JinjavaInterpreter;
 import com.hubspot.jinjava.interpret.RenderResult;
 import com.hubspot.jinjava.interpret.TemplateError;
 import com.hubspot.jinjava.interpret.TemplateError.ErrorType;
@@ -29,6 +32,27 @@ public void setup() {
     d = ZonedDateTime.parse("2013-11-06T14:22:00.000+00:00[UTC]");
   }
 
+  @Test
+  public void itUsesDeprecationDateIfNoDateProvided() {
+    Jinjava jinjava = new Jinjava(
+      JinjavaConfig
+        .newBuilder()
+        .withUseCurrentTimeForNullDateTileFilterArgs(false)
+        .build()
+    );
+
+    JinjavaInterpreter interpreter = jinjava.newInterpreter();
+    JinjavaInterpreter.pushCurrent(interpreter);
+    try {
+      assertThat(filter.filter(null, interpreter))
+        .isEqualTo(StrftimeFormatter.format(JinjavaConfig.DEFAULT_DATE_TIME_FILTER_ARG));
+      assertThat(interpreter.getErrors().get(0).getMessage())
+        .contains("datetimeformat filter called with null datetime");
+    } finally {
+      JinjavaInterpreter.popCurrent();
+    }
+  }
+
   @Test
   public void itUsesTodayIfNoDateProvided() {
     assertThat(filter.filter(null, interpreter))

diff --git a/src/test/java/com/hubspot/jinjava/lib/filter/UnixTimestampFilterTest.java b/src/test/java/com/hubspot/jinjava/lib/filter/UnixTimestampFilterTest.java
@@ -2,7 +2,11 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import com.google.common.collect.ImmutableMap;
 import com.hubspot.jinjava.BaseInterpretingTest;
+import com.hubspot.jinjava.Jinjava;
+import com.hubspot.jinjava.JinjavaConfig;
+import com.hubspot.jinjava.interpret.JinjavaInterpreter;
 import java.time.ZonedDateTime;
 import org.junit.After;
 import org.junit.Before;
@@ -28,4 +32,44 @@ public void tearDown() {
   public void itRendersFromDate() {
     assertThat(interpreter.renderFlat("{{ d|unixtimestamp }}")).isEqualTo(timestamp);
   }
+
+  @Test
+  public void itDefaultsToCurrentDate() {
+    Jinjava jinjava = new Jinjava(
+      JinjavaConfig
+        .newBuilder()
+        .withDateTimeProvider(() -> d.toEpochSecond() * 1000)
+        .withUseCurrentTimeForNullDateTileFilterArgs(true)
+        .build()
+    );
+
+    JinjavaInterpreter.pushCurrent(jinjava.newInterpreter());
+
+    try {
+      assertThat(jinjava.render("{{ null | unixtimestamp }}", ImmutableMap.of()))
+        .isEqualTo(timestamp);
+    } finally {
+      JinjavaInterpreter.popCurrent();
+    }
+  }
+
+  @Test
+  public void itDefaultsToDeprecationDate() {
+    Jinjava jinjava = new Jinjava(
+      JinjavaConfig
+        .newBuilder()
+        .withDateTimeProvider(() -> d.toEpochSecond() * 1000)
+        .withUseCurrentTimeForNullDateTileFilterArgs(false)
+        .build()
+    );
+
+    JinjavaInterpreter.pushCurrent(jinjava.newInterpreter());
+
+    try {
+      assertThat(jinjava.render("{{ null | unixtimestamp }}", ImmutableMap.of()))
+        .isEqualTo("1717200000000");
+    } finally {
+      JinjavaInterpreter.popCurrent();
+    }
+  }
 }