Scripting: Switch watcher to use joda bwc time objects (#35966)

This commit converts the watcher execution context to use the joda
compat java time objects. It also again removes the joda methods from
the painless whitelist.

Author: rjernst

docs/painless/painless-contexts/painless-watcher-condition-context.asciidoc

@@ -12,13 +12,13 @@ to test if a response is necessary.
 `ctx['watch_id']` (`String`, read-only)::
         The id of the watch.
 
-`ctx['execution_time']` (`DateTime`, read-only)::
+`ctx['execution_time']` (`ZonedDateTime`, read-only)::
         The start time for the watch.
 
-`ctx['trigger']['scheduled_time']` (`DateTime`, read-only)::
+`ctx['trigger']['scheduled_time']` (`ZonedDateTime`, read-only)::
         The scheduled trigger time for the watch.
 
-`ctx['trigger']['triggered_time']` (`DateTime`, read-only)::
+`ctx['trigger']['triggered_time']` (`ZonedDateTime`, read-only)::
         The actual trigger time for the watch.
 
 `ctx['metadata']` (`Map`, read-only)::

docs/painless/painless-contexts/painless-watcher-transform-context.asciidoc

@@ -12,13 +12,13 @@ data into a new payload for use in a response to a condition.
 `ctx['watch_id']` (`String`, read-only)::
         The id of the watch.
 
-`ctx['execution_time']` (`DateTime`, read-only)::
+`ctx['execution_time']` (`ZonedDateTime`, read-only)::
         The start time for the watch.
 
-`ctx['trigger']['scheduled_time']` (`DateTime`, read-only)::
+`ctx['trigger']['scheduled_time']` (`ZonedDateTime`, read-only)::
         The scheduled trigger time for the watch.
 
-`ctx['trigger']['triggered_time']` (`DateTime`, read-only)::
+`ctx['trigger']['triggered_time']` (`ZonedDateTime`, read-only)::
         The actual trigger time for the watch.
 
 `ctx['metadata']` (`Map`, read-only)::

modules/lang-painless/spi/src/main/java/org/elasticsearch/painless/spi/Whitelist.java

@@ -48,8 +48,7 @@ public final class Whitelist {
         "java.util.txt",
         "java.util.function.txt",
         "java.util.regex.txt",
-        "java.util.stream.txt",
-        "joda.time.txt"
+        "java.util.stream.txt"
     };
 
     public static final List<Whitelist> BASE_WHITELISTS =

modules/lang-painless/src/main/resources/org/elasticsearch/painless/spi/joda.time.txt

@@ -22,6 +22,8 @@
 import org.apache.logging.log4j.LogManager;
 import org.elasticsearch.common.SuppressForbidden;
 import org.elasticsearch.common.logging.DeprecationLogger;
+import org.elasticsearch.common.time.DateFormatter;
+import org.elasticsearch.common.time.DateFormatters;
 import org.elasticsearch.common.time.DateUtils;
 import org.joda.time.DateTime;
 
@@ -42,11 +44,13 @@
 import java.time.temporal.TemporalUnit;
 import java.time.temporal.WeekFields;
 import java.util.Locale;
+import java.util.Objects;
 
 /**
  * A wrapper around ZonedDateTime that exposes joda methods for backcompat.
  */
 public class JodaCompatibleZonedDateTime {
+    private static final DateFormatter DATE_FORMATTER = DateFormatters.forPattern("strict_date_time");
     private static final DeprecationLogger deprecationLogger =
         new DeprecationLogger(LogManager.getLogger(JodaCompatibleZonedDateTime.class));
 
@@ -75,7 +79,10 @@ public ZonedDateTime getZonedDateTime() {
 
     @Override
     public boolean equals(Object o) {
-        return dt.equals(o);
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        JodaCompatibleZonedDateTime that = (JodaCompatibleZonedDateTime) o;
+        return Objects.equals(dt, that.dt);
     }
 
     @Override
@@ -85,7 +92,7 @@ public int hashCode() {
 
     @Override
     public String toString() {
-        return dt.toString();
+        return DATE_FORMATTER.format(dt);
     }
 
     public boolean isAfter(ZonedDateTime o) {

server/src/main/java/org/elasticsearch/script/JodaCompatibleZonedDateTime.java

@@ -97,6 +97,10 @@ void assertMethodDeprecation(Runnable assertions, String oldMethod, String newMe
         assertDeprecation(assertions, "Use of the joda time method [" + oldMethod + "] is deprecated. Use [" + newMethod + "] instead.");
     }
 
+    public void testEquals() {
+        assertThat(javaTime, equalTo(javaTime));
+    }
+
     public void testToString() {
         assertThat(javaTime.toString(), equalTo(jodaTime.toString()));
     }

server/src/test/java/org/elasticsearch/script/JodaCompatibleZonedDateTimeTests.java

@@ -15,6 +15,7 @@
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
 import org.elasticsearch.index.mapper.DateFieldMapper;
+import org.elasticsearch.script.JodaCompatibleZonedDateTime;
 import org.joda.time.DateTime;
 import org.joda.time.DateTimeZone;
 
@@ -35,6 +36,9 @@ public static DateTime convertToDate(Object value, Clock clock) {
         if (value instanceof DateTime) {
             return (DateTime) value;
         }
+        if (value instanceof JodaCompatibleZonedDateTime) {
+            return new DateTime(((JodaCompatibleZonedDateTime) value).toInstant().toEpochMilli(), DateTimeZone.UTC);
+        }
         if (value instanceof String) {
             return parseDateMath((String) value, DateTimeZone.UTC, clock);
         }

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/watcher/support/WatcherDateTimeUtils.java

@@ -8,10 +8,13 @@
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.xcontent.ToXContentObject;
 import org.elasticsearch.common.xcontent.XContentBuilder;
+import org.elasticsearch.script.JodaCompatibleZonedDateTime;
 import org.elasticsearch.xpack.core.watcher.support.WatcherDateTimeUtils;
 import org.joda.time.DateTime;
 
 import java.io.IOException;
+import java.time.Instant;
+import java.time.ZoneOffset;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -25,7 +28,8 @@ public TriggerEvent(String jobName, DateTime triggeredTime) {
         this.jobName = jobName;
         this.triggeredTime = triggeredTime;
         this.data = new HashMap<>();
-        data.put(Field.TRIGGERED_TIME.getPreferredName(), triggeredTime);
+        data.put(Field.TRIGGERED_TIME.getPreferredName(),
+            new JodaCompatibleZonedDateTime(Instant.ofEpochMilli(triggeredTime.getMillis()), ZoneOffset.UTC));
     }
 
     public String jobName() {

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/watcher/trigger/TriggerEvent.java

@@ -5,9 +5,12 @@
  */
 package org.elasticsearch.xpack.watcher.support;
 
+import org.elasticsearch.script.JodaCompatibleZonedDateTime;
 import org.elasticsearch.xpack.core.watcher.execution.WatchExecutionContext;
 import org.elasticsearch.xpack.core.watcher.watch.Payload;
 
+import java.time.Instant;
+import java.time.ZoneOffset;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -34,7 +37,8 @@ public static Map<String, Object> createCtx(WatchExecutionContext ctx, Payload p
         Map<String, Object> ctxModel = new HashMap<>();
         ctxModel.put(ID, ctx.id().value());
         ctxModel.put(WATCH_ID, ctx.id().watchId());
-        ctxModel.put(EXECUTION_TIME, ctx.executionTime());
+        ctxModel.put(EXECUTION_TIME,
+            new JodaCompatibleZonedDateTime(Instant.ofEpochMilli(ctx.executionTime().getMillis()), ZoneOffset.UTC));
         ctxModel.put(TRIGGER, ctx.triggerEvent().data());
         if (payload != null) {
             ctxModel.put(PAYLOAD, payload.data());

x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/support/Variables.java

@@ -9,13 +9,16 @@
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
+import org.elasticsearch.script.JodaCompatibleZonedDateTime;
 import org.elasticsearch.xpack.core.watcher.support.WatcherDateTimeUtils;
 import org.elasticsearch.xpack.core.watcher.trigger.TriggerEvent;
 import org.joda.time.DateTime;
 import org.joda.time.DateTimeZone;
 
 import java.io.IOException;
 import java.time.Clock;
+import java.time.Instant;
+import java.time.ZoneOffset;
 
 public class ScheduleTriggerEvent extends TriggerEvent {
 
@@ -28,7 +31,8 @@ public ScheduleTriggerEvent(DateTime triggeredTime, DateTime scheduledTime) {
     public ScheduleTriggerEvent(String jobName, DateTime triggeredTime, DateTime scheduledTime) {
         super(jobName, triggeredTime);
         this.scheduledTime = scheduledTime;
-        data.put(Field.SCHEDULED_TIME.getPreferredName(), scheduledTime);
+        data.put(Field.SCHEDULED_TIME.getPreferredName(),
+            new JodaCompatibleZonedDateTime(Instant.ofEpochMilli(scheduledTime.getMillis()), ZoneOffset.UTC));
     }
 
     @Override

x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/trigger/schedule/ScheduleTriggerEvent.java

@@ -16,6 +16,7 @@
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
 import org.elasticsearch.common.xcontent.json.JsonXContent;
+import org.elasticsearch.script.JodaCompatibleZonedDateTime;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.xpack.core.watcher.actions.Action;
 import org.elasticsearch.xpack.core.watcher.common.secret.Secret;
@@ -52,6 +53,8 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.nio.charset.StandardCharsets;
+import java.time.Instant;
+import java.time.ZoneOffset;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -129,6 +132,7 @@ public void testExecute() throws Exception {
         Map<String, Object> metadata = MapBuilder.<String, Object>newMapBuilder().put("_key", "_val").map();
 
         DateTime now = DateTime.now(DateTimeZone.UTC);
+        JodaCompatibleZonedDateTime jodaJavaNow = new JodaCompatibleZonedDateTime(Instant.ofEpochMilli(now.getMillis()), ZoneOffset.UTC);
 
         Wid wid = new Wid("watch1", now);
         WatchExecutionContext ctx = mockExecutionContextBuilder("watch1")
@@ -139,14 +143,14 @@ public void testExecute() throws Exception {
                 .buildMock();
 
         Map<String, Object> triggerModel = new HashMap<>();
-        triggerModel.put("triggered_time", now);
-        triggerModel.put("scheduled_time", now);
+        triggerModel.put("triggered_time", jodaJavaNow);
+        triggerModel.put("scheduled_time", jodaJavaNow);
         Map<String, Object> ctxModel = new HashMap<>();
         ctxModel.put("id", ctx.id().value());
         ctxModel.put("watch_id", "watch1");
         ctxModel.put("payload", data);
         ctxModel.put("metadata", metadata);
-        ctxModel.put("execution_time", now);
+        ctxModel.put("execution_time", jodaJavaNow);
         ctxModel.put("trigger", triggerModel);
         ctxModel.put("vars", emptyMap());
         Map<String, Object> expectedModel = singletonMap("ctx", ctxModel);

x-pack/plugin/watcher/src/test/java/org/elasticsearch/xpack/watcher/actions/email/EmailActionTests.java

@@ -16,6 +16,7 @@
 import org.elasticsearch.common.xcontent.XContentParser;
 import org.elasticsearch.common.xcontent.XContentType;
 import org.elasticsearch.common.xcontent.json.JsonXContent;
+import org.elasticsearch.script.JodaCompatibleZonedDateTime;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.xpack.core.watcher.actions.Action;
 import org.elasticsearch.xpack.core.watcher.execution.WatchExecutionContext;
@@ -35,6 +36,8 @@
 import org.junit.Before;
 
 import java.io.IOException;
+import java.time.Instant;
+import java.time.ZoneOffset;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
@@ -78,6 +81,7 @@ public void testExecute() throws Exception {
         Map<String, Object> metadata = MapBuilder.<String, Object>newMapBuilder().put("_key", "_val").map();
 
         DateTime now = DateTime.now(DateTimeZone.UTC);
+        JodaCompatibleZonedDateTime jodaJavaNow = new JodaCompatibleZonedDateTime(Instant.ofEpochMilli(now.getMillis()), ZoneOffset.UTC);
 
         Wid wid = new Wid(randomAlphaOfLength(5), now);
         WatchExecutionContext ctx = mockExecutionContextBuilder(wid.watchId())
@@ -88,14 +92,14 @@ public void testExecute() throws Exception {
                 .buildMock();
 
         Map<String, Object> triggerModel = new HashMap<>();
-        triggerModel.put("triggered_time", now);
-        triggerModel.put("scheduled_time", now);
+        triggerModel.put("triggered_time", jodaJavaNow);
+        triggerModel.put("scheduled_time", jodaJavaNow);
         Map<String, Object> ctxModel = new HashMap<>();
         ctxModel.put("id", ctx.id().value());
         ctxModel.put("watch_id", wid.watchId());
         ctxModel.put("payload", data);
         ctxModel.put("metadata", metadata);
-        ctxModel.put("execution_time", now);
+        ctxModel.put("execution_time", jodaJavaNow);
         ctxModel.put("trigger", triggerModel);
         ctxModel.put("vars", Collections.emptyMap());
         Map<String, Object> expectedModel = singletonMap("ctx", ctxModel);

x-pack/plugin/watcher/src/test/java/org/elasticsearch/xpack/watcher/actions/hipchat/HipChatActionTests.java

@@ -10,6 +10,7 @@
 import org.elasticsearch.common.SuppressLoggerChecks;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
+import org.elasticsearch.script.JodaCompatibleZonedDateTime;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.xpack.core.watcher.actions.Action;
 import org.elasticsearch.xpack.core.watcher.execution.WatchExecutionContext;
@@ -22,6 +23,8 @@
 import org.junit.Before;
 
 import java.io.IOException;
+import java.time.Instant;
+import java.time.ZoneOffset;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -55,18 +58,19 @@ public void init() throws IOException {
 
     public void testExecute() throws Exception {
         final DateTime now = DateTime.now(UTC);
+        JodaCompatibleZonedDateTime jodaJavaNow = new JodaCompatibleZonedDateTime(Instant.ofEpochMilli(now.getMillis()), ZoneOffset.UTC);
 
         WatchExecutionContext ctx = WatcherTestUtils.mockExecutionContextBuilder("_watch_id")
                 .time("_watch_id", now)
                 .buildMock();
 
         Map<String, Object> triggerModel = new HashMap<>();
-        triggerModel.put("scheduled_time", now);
-        triggerModel.put("triggered_time", now);
+        triggerModel.put("scheduled_time", jodaJavaNow);
+        triggerModel.put("triggered_time", jodaJavaNow);
         Map<String, Object> ctxModel = new HashMap<>();
         ctxModel.put("id", ctx.id().value());
         ctxModel.put("watch_id", "_watch_id");
-        ctxModel.put("execution_time", now);
+        ctxModel.put("execution_time", jodaJavaNow);
         ctxModel.put("payload", emptyMap());
         ctxModel.put("metadata", emptyMap());
         ctxModel.put("vars", emptyMap());