[GR-32236] Allow to use time-zone-related data from ZoneRulesProvider.

PullRequest: js/2476

Author: iamstolis

CHANGELOG.md

@@ -7,6 +7,7 @@ See [version roadmap](https://www.graalvm.org/release-notes/version-roadmap/) fo
 
 ## Version 22.2.0
 * Removed experimental option `commonjs-global-properties`. The same functionality can be achieved in user code with a direct call to `require()` after context creation.
+* Added an experimental option `--js.zone-rules-based-time-zones` that allows to use timezone-related data from `ZoneRulesProvider` (instead of ICU4J data files).
 
 ## Version 22.1.0
 * Updated Node.js to version 16.14.2.

graal-js/ci.jsonnet

@@ -151,7 +151,11 @@ local ci = import '../ci.jsonnet';
     // interop benchmarks
     graalJs + common.jdk17 + common.bench  + common.x52            + interopJmhBenchmarks                                                     + {name: 'js-bench-interop-jmh-jdk17-linux-amd64'},
 
-    // POST-MERGE - PGO profiles
+    // POST-MERGE
+    // PGO profiles
     graalJs + common.jdk17 + common.postMerge + common.linux       + downstreamSubstratevmEE   + {environment+: {TAGS: 'pgo_collect_js'}}     + {name: 'js-postmerge-pgo-profiles-jdk17-linux-amd64'},
+
+    // js.zone-rules-based-time-zones
+    graalJs + common.jdk17 + common.postMerge + common.linux       + gateTags('zonerulesbasedtimezones')                                      + {name: 'js-postmerge-zonerulesbasedtimezones-jdk17-linux-amd64'},
   ],
 }

graal-js/mx.graal-js/mx_graal_js.py

@@ -74,7 +74,9 @@ def _graal_js_gate_runner(args, tasks):
     with Task('UnitTests', tasks, tags=[GraalJsDefaultTags.default, GraalJsDefaultTags.all]) as t:
         if t:
             noWebAssemblyTestSuite = '^(?!' + webassemblyTestSuite  + ')'
-            unittest(['--regex', noWebAssemblyTestSuite, '--enable-timing', '--very-verbose', '--suite', _suite.name])
+            commonOptions = ['--enable-timing', '--very-verbose', '--suite', _suite.name]
+            unittest(['--regex', noWebAssemblyTestSuite] + commonOptions)
+            unittest(['--regex', 'ZoneRulesProviderTest', '-Djava.time.zone.DefaultZoneRulesProvider=com.oracle.truffle.js.test.runtime.SimpleZoneRulesProvider'] + commonOptions)
 
     with Task('WebAssemblyTests', tasks, tags=['webassembly', GraalJsDefaultTags.all]) as t:
         if t:
@@ -86,6 +88,7 @@ def _graal_js_gate_runner(args, tasks):
         'directbytebuffer': ['-Dpolyglot.js.direct-byte-buffer=true', 'gate'],
         'cloneuninitialized': ['-Dpolyglot.js.test-clone-uninitialized=true', 'gate'],
         'lazytranslation': ['-Dpolyglot.js.lazy-translation=true', 'gate'],
+        'zonerulesbasedtimezones': ['-Dpolyglot.js.zone-rules-based-time-zones=true', 'gate'],
         'shareengine': ['gate', 'shareengine'],
         'latestversion': ['gate', 'minesversion=2022'],
         'instrument': ['gate', 'instrument', 'timeoutoverall=1800']

graal-js/src/com.oracle.truffle.js.test/src/com/oracle/truffle/js/test/runtime/SimpleZoneRulesProvider.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2022, 2022, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.truffle.js.test.runtime;
+
+import java.time.ZoneOffset;
+import java.time.zone.ZoneRules;
+import java.time.zone.ZoneRulesProvider;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.NavigableMap;
+import java.util.Set;
+import java.util.TimeZone;
+import java.util.TreeMap;
+
+/**
+ * Simple implementation of {@code ZoneRulesProvider} for testing purposes. The data provided by
+ * this implementation have nothing to do with the real tzdb data.
+ */
+public class SimpleZoneRulesProvider extends ZoneRulesProvider {
+
+    @Override
+    protected Set<String> provideZoneIds() {
+        return new HashSet<>(Arrays.asList(TimeZone.getAvailableIDs()));
+    }
+
+    @Override
+    protected ZoneRules provideRules(String zoneId, boolean forCaching) {
+        return ZoneRules.of(ZoneOffset.ofHours(7));
+    }
+
+    @Override
+    protected NavigableMap<String, ZoneRules> provideVersions(String zoneId) {
+        NavigableMap<String, ZoneRules> map = new TreeMap<>();
+        map.put("theOnlyVersion", provideRules(zoneId, false));
+        return map;
+    }
+
+}

graal-js/src/com.oracle.truffle.js.test/src/com/oracle/truffle/js/test/runtime/ZoneRulesProviderTest.java

@@ -0,0 +1,100 @@
+/*
+ * Copyright (c) 2022, 2022, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.truffle.js.test.runtime;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assume.assumeTrue;
+
+import com.oracle.truffle.js.lang.JavaScriptLanguage;
+import com.oracle.truffle.js.runtime.JSContextOptions;
+import com.oracle.truffle.js.test.JSTest;
+import org.graalvm.polyglot.Context;
+import org.junit.Before;
+import org.junit.Test;
+
+/**
+ * Tests of {@code js.zone-rules-based-time-zones} option.
+ */
+public class ZoneRulesProviderTest {
+
+    @Before
+    public void setUp() {
+        String provider = System.getProperty("java.time.zone.DefaultZoneRulesProvider");
+        assumeTrue(SimpleZoneRulesProvider.class.getName().equals(provider));
+    }
+
+    @Test
+    public void testNoIntl() {
+        try (Context context = newContext(false)) {
+            context.eval(JavaScriptLanguage.ID, "date = new Date(Date.UTC(2020, 3, 25, 12, 13, 14))");
+            // SimpleZoneRulesProvider uses +7 offset for all time-zones
+            assertResult(context, "date.toString()", "Sat Apr 25 2020 19:13:14 GMT+0700 (CET)");
+            assertResult(context, "date.toLocaleString()", "Sat Apr 25 2020 19:13:14 GMT+0700 (CET)");
+            assertResult(context, "date.toTimeString()", "19:13:14 GMT+0700 (CET)");
+            assertResult(context, "date.toLocaleTimeString()", "19:13:14");
+        }
+    }
+
+    @Test
+    public void testIntl() {
+        try (Context context = newContext(true)) {
+            context.eval(JavaScriptLanguage.ID, "date = new Date(Date.UTC(2020, 3, 25, 12, 13, 14))");
+            // SimpleZoneRulesProvider uses +7 offset for all time-zones
+            assertResult(context, "date.toLocaleString()", "4/25/2020, 7:13:14 PM");
+            assertResult(context, "date.toLocaleTimeString()", "7:13:14 PM");
+            assertResult(context, "new Intl.DateTimeFormat('en', { dateStyle: 'long', timeStyle: 'long' }).format(date)", "April 25, 2020 at 7:13:14 PM GMT+7");
+        }
+    }
+
+    private static Context newContext(boolean intl) {
+        return JSTest.newContextBuilder().//
+                        option(JSContextOptions.TIME_ZONE_NAME, "Europe/Prague").//
+                        option(JSContextOptions.INTL_402_NAME, Boolean.toString(intl)).//
+                        option(JSContextOptions.ZONE_RULES_BASED_TIME_ZONES_NAME, "true").//
+                        build();
+    }
+
+    private static void assertResult(Context context, String code, String expectedResult) {
+        String actualResult = context.eval(JavaScriptLanguage.ID, code).toString();
+        assertEquals(expectedResult, actualResult);
+    }
+
+}

graal-js/src/com.oracle.truffle.js/src/com/oracle/truffle/js/nodes/intl/InitializeDateTimeFormatNode.java

@@ -210,7 +210,7 @@ private TimeZone toTimeZone(Object timeZoneValue) {
                 errorBranch.enter();
                 throw Errors.createRangeErrorInvalidTimeZone(name);
             }
-            return IntlUtil.getICUTimeZone(tzId);
+            return IntlUtil.getICUTimeZone(tzId, context);
         } else {
             return getRealm().getLocalTimeZone();
         }

graal-js/src/com.oracle.truffle.js/src/com/oracle/truffle/js/runtime/JSContextOptions.java

@@ -226,6 +226,11 @@ public String apply(String tz) {
         }
     }));
 
+    public static final String ZONE_RULES_BASED_TIME_ZONES_NAME = JS_OPTION_PREFIX + "zone-rules-based-time-zones";
+    @Option(name = ZONE_RULES_BASED_TIME_ZONES_NAME, category = OptionCategory.EXPERT, help = "Use ZoneRulesProvider instead of time-zone data from ICU4J.") //
+    public static final OptionKey<Boolean> ZONE_RULES_BASED_TIME_ZONES = new OptionKey<>(false);
+    @CompilationFinal private boolean zoneRulesBasedTimeZones;
+
     public static final String TIMER_RESOLUTION_NAME = JS_OPTION_PREFIX + "timer-resolution";
     @Option(name = TIMER_RESOLUTION_NAME, category = OptionCategory.USER, usageSyntax = "<nanoseconds>", help = "Resolution of timers (performance.now() and Date built-ins) in nanoseconds. Fuzzy time is used when set to 0.") //
     public static final OptionKey<Long> TIMER_RESOLUTION = new OptionKey<>(1000000L);
@@ -667,6 +672,7 @@ private void cacheOptions() {
         });
         this.parseOnly = readBooleanOption(PARSE_ONLY);
         this.debug = readBooleanOption(DEBUG_BUILTIN);
+        this.zoneRulesBasedTimeZones = readBooleanOption(ZONE_RULES_BASED_TIME_ZONES);
         this.timerResolution = patchLongOption(TIMER_RESOLUTION, TIMER_RESOLUTION_NAME, timerResolution, msg -> {
             timerResolutionCyclicAssumption.invalidate(msg);
             timerResolutionCurrentAssumption = timerResolutionCyclicAssumption.getAssumption();
@@ -857,6 +863,10 @@ public boolean isV8LegacyConst() {
         return v8LegacyConst;
     }
 
+    public boolean hasZoneRulesBasedTimeZones() {
+        return zoneRulesBasedTimeZones;
+    }
+
     public boolean canAgentBlock() {
         return agentCanBlock;
     }
@@ -1153,6 +1163,7 @@ public int hashCode() {
         hash = 53 * hash + (this.debug ? 1 : 0);
         hash = 53 * hash + (this.directByteBuffer ? 1 : 0);
         hash = 53 * hash + (this.parseOnly ? 1 : 0);
+        hash = 53 * hash + (this.zoneRulesBasedTimeZones ? 1 : 0);
         hash = 53 * hash + (int) this.timerResolution;
         hash = 53 * hash + (this.agentCanBlock ? 1 : 0);
         hash = 53 * hash + (this.awaitOptimization ? 1 : 0);
@@ -1255,6 +1266,9 @@ public boolean equals(Object obj) {
         if (this.parseOnly != other.parseOnly) {
             return false;
         }
+        if (this.zoneRulesBasedTimeZones != other.zoneRulesBasedTimeZones) {
+            return false;
+        }
         if (this.timerResolution != other.timerResolution) {
             return false;
         }

graal-js/src/com.oracle.truffle.js/src/com/oracle/truffle/js/runtime/JSRealm.java

@@ -2596,7 +2596,7 @@ public TimeZone getLocalTimeZone() {
 
     @TruffleBoundary
     private TimeZone getICUTimeZoneFromEnv() {
-        return IntlUtil.getICUTimeZone(getLocalTimeZoneId());
+        return IntlUtil.getICUTimeZone(getLocalTimeZoneId(), getContext());
     }
 
     public ZoneId getLocalTimeZoneId() {
@@ -2990,7 +2990,7 @@ public void setLocalTimeZone(String tzId) {
         try {
             if (tzId != null) {
                 newZoneId = ZoneId.of(tzId);
-                newTimeZone = IntlUtil.getICUTimeZone(tzId);
+                newTimeZone = IntlUtil.getICUTimeZone(tzId, getContext());
             } else {
                 // Reset to default time zone (fields are reinitialized on next use).
                 newZoneId = null;

graal-js/src/com.oracle.truffle.js/src/com/oracle/truffle/js/runtime/util/IntlUtil.java

@@ -41,6 +41,7 @@
 package com.oracle.truffle.js.runtime.util;
 
 import java.time.ZoneId;
+import java.time.zone.ZoneRulesProvider;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashSet;
@@ -873,14 +874,22 @@ public static void ensureIsWellFormedUnitIdentifier(String unitIdentifier) {
     }
 
     @TruffleBoundary
-    public static TimeZone getICUTimeZone(String tzId) {
+    public static TimeZone getICUTimeZone(String tzId, JSContext context) {
         assert tzId != null;
-        return TimeZone.getTimeZone(tzId);
+        if (context.getContextOptions().hasZoneRulesBasedTimeZones()) {
+            return new ZoneRulesBasedTimeZone(tzId, ZoneRulesProvider.getRules(tzId, false));
+        } else {
+            return TimeZone.getTimeZone(tzId);
+        }
     }
 
     @TruffleBoundary
-    public static TimeZone getICUTimeZone(ZoneId zoneId) {
-        return getICUTimeZone(toICUTimeZoneId(zoneId));
+    public static TimeZone getICUTimeZone(ZoneId zoneId, JSContext context) {
+        if (context.getContextOptions().hasZoneRulesBasedTimeZones()) {
+            return new ZoneRulesBasedTimeZone(zoneId.getId(), zoneId.getRules());
+        } else {
+            return TimeZone.getTimeZone(toICUTimeZoneId(zoneId));
+        }
     }
 
     private static String toICUTimeZoneId(ZoneId zoneId) {