XContent change to support parsing and display of TimeZone fields on schedules

Author: lukewhiting

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

@@ -10,9 +10,12 @@
 import org.elasticsearch.xcontent.XContentParser;
 
 import java.io.IOException;
+import java.time.DateTimeException;
+import java.time.ZoneId;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Set;
+import java.util.TimeZone;
 
 public class ScheduleRegistry {
     private final Map<String, Schedule.Parser<? extends Schedule>> parsers = new HashMap<>();
@@ -29,9 +32,15 @@ public Schedule parse(String context, XContentParser parser) throws IOException
         String type = null;
         XContentParser.Token token;
         Schedule schedule = null;
+        TimeZone timeZone = null; // Default to UTC
         while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) {
             if (token == XContentParser.Token.FIELD_NAME) {
-                type = parser.currentName();
+                var fieldName = parser.currentName();
+                if (fieldName.equals(ScheduleTrigger.TIMEZONE_FIELD)) {
+                    timeZone = parseTimezone(parser);
+                } else {
+                    type = parser.currentName();
+                }
             } else if (type != null) {
                 schedule = parse(context, type, parser);
             } else {
@@ -44,9 +53,38 @@ public Schedule parse(String context, XContentParser parser) throws IOException
         if (schedule == null) {
             throw new ElasticsearchParseException("could not parse schedule. expected a schedule type field, but no fields were found");
         }
+
+        if (timeZone != null && schedule instanceof CronnableSchedule cronnableSchedule) {
+            cronnableSchedule.setTimeZone(timeZone);
+        } else if (timeZone != null) {
+            throw new ElasticsearchParseException(
+                "could not parse schedule. Timezone is not supported for schedule type [{}]",
+                schedule.type()
+            );
+        }
+
         return schedule;
     }
 
+    private static TimeZone parseTimezone(XContentParser parser) throws IOException {
+        TimeZone timeZone;
+        XContentParser.Token token = parser.nextToken();
+        if (token == XContentParser.Token.VALUE_STRING) {
+            String text = parser.text();
+            try {
+                timeZone = TimeZone.getTimeZone(ZoneId.of(text));
+            } catch (DateTimeException e) {
+                throw new ElasticsearchParseException("could not parse schedule. invalid timezone [{}]", e, text);
+            }
+        } else {
+            throw new ElasticsearchParseException(
+                "could not parse schedule. expected a string value for timezone, but found [{}] instead",
+                token
+            );
+        }
+        return timeZone;
+    }
+
     public Schedule parse(String context, String type, XContentParser parser) throws IOException {
         Schedule.Parser<?> scheduleParser = parsers.get(type);
         if (scheduleParser == null) {

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

@@ -14,6 +14,7 @@
 public class ScheduleTrigger implements Trigger {
 
     public static final String TYPE = "schedule";
+    public static final String TIMEZONE_FIELD = "timezone";
 
     private final Schedule schedule;
 
@@ -49,7 +50,13 @@ public int hashCode() {
 
     @Override
     public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
-        return builder.startObject().field(schedule.type(), schedule, params).endObject();
+        builder.startObject();
+        if (schedule instanceof CronnableSchedule cronnableSchedule && cronnableSchedule.getTimeZone() != null) {
+            builder.field(TIMEZONE_FIELD, cronnableSchedule.getTimeZone().getID());
+        }
+
+        builder.field(schedule.type(), schedule, params);
+        return builder.endObject();
     }
 
     public static Builder builder(Schedule schedule) {

x-pack/plugin/watcher/src/test/java/org/elasticsearch/xpack/watcher/trigger/schedule/ScheduleRegistryTests.java

@@ -14,6 +14,7 @@
 
 import java.util.HashSet;
 import java.util.Set;
+import java.util.TimeZone;
 
 import static org.elasticsearch.xcontent.XContentFactory.jsonBuilder;
 import static org.hamcrest.Matchers.equalTo;
@@ -50,14 +51,21 @@ public void testParserInterval() throws Exception {
 
     public void testParseCron() throws Exception {
         Object cron = randomBoolean() ? Schedules.cron("* 0/5 * * * ?") : Schedules.cron("* 0/2 * * * ?", "* 0/3 * * * ?", "* 0/5 * * * ?");
-        XContentBuilder builder = jsonBuilder().startObject().field(CronSchedule.TYPE, cron).endObject();
+        TimeZone timeZone = null;
+        XContentBuilder builder = jsonBuilder().startObject().field(CronSchedule.TYPE, cron);
+        if (randomBoolean()) {
+            timeZone = randomTimeZone();
+            builder.field(ScheduleTrigger.TIMEZONE_FIELD, timeZone.getID());
+        }
+        builder.endObject();
         BytesReference bytes = BytesReference.bytes(builder);
         XContentParser parser = createParser(JsonXContent.jsonXContent, bytes);
         parser.nextToken();
-        Schedule schedule = registry.parse("ctx", parser);
+        CronnableSchedule schedule = (CronnableSchedule) registry.parse("ctx", parser);
         assertThat(schedule, notNullValue());
         assertThat(schedule, instanceOf(CronSchedule.class));
         assertThat(schedule, is(cron));
+        assertThat(schedule.getTimeZone(), equalTo(timeZone));
     }
 
     public void testParseHourly() throws Exception {