Improvement: timezone case-check when apply to date

Author: Wanasit Tanakitrungruang

src/common/refiners/ExtractTimezoneAbbrRefiner.ts

@@ -2,7 +2,7 @@
 import { ParsingContext, Refiner } from "../../chrono";
 import { ParsingResult } from "../../results";
 
-const TIMEZONE_NAME_PATTERN = new RegExp("^\\s*\\(?([A-Z]{2,4})\\)?(?=\\W|$)", "i");
+const TIMEZONE_NAME_PATTERN = new RegExp("^\\s*,?\\s*\\(?([A-Z]{2,4})\\)?(?=\\W|$)", "i");
 const DEFAULT_TIMEZONE_ABBR_MAP = {
     ACDT: 630,
     ACST: 570,
@@ -224,12 +224,20 @@ export default class ExtractTimezoneAbbrRefiner implements Refiner {
                 console.log(`Extracting timezone: '${timezoneAbbr}' into : ${extractedTimezoneOffset}`);
             });
 
-            // We may already have extracted the offset e.g. "11 am GMT+0900 (JST)"
-            // - if they are equal, we also want to take the abbreviation text into result
-            // - if they are not equal, we trust the offset more
             const currentTimezoneOffset = result.start.get("timezoneOffset");
             if (currentTimezoneOffset !== null && extractedTimezoneOffset != currentTimezoneOffset) {
-                return;
+                // We may already have extracted the timezone offset e.g. "11 am GMT+0900 (JST)"
+                // - if they are equal, we also want to take the abbreviation text into result
+                // - if they are not equal, we trust the offset more
+                if (result.start.isCertain("timezoneOffset")) {
+                    return;
+                }
+
+                // This is often because it's relative time with inferred timezone (e.g. in 1 hour, tomorrow)
+                // Then, we want to double check the abbr case (e.g. "GET" not "get")
+                if (timezoneAbbr != match[1]) {
+                    return;
+                }
             }
 
             result.text += match[0];

test/en/en_timezone_exp.test.ts

@@ -1,7 +1,7 @@
 import * as chrono from "../../src";
 import { testSingleCase } from "../test_util";
 
-test("Test - Parsing date with UTC offset", function () {
+test("Test - Parsing date/time with UTC offset", function () {
     testSingleCase(chrono, "wednesday, september 16, 2020 at 11 am utc+02:45 ", (result, text) => {
         expect(result.text).toBe("wednesday, september 16, 2020 at 11 am utc+02:45");
 
@@ -27,7 +27,7 @@ test("Test - Parsing date with UTC offset", function () {
     });
 });
 
-test("Test - Parsing date with GMT offset", function () {
+test("Test - Parsing date/time with GMT offset", function () {
     testSingleCase(chrono, "wednesday, september 16, 2020 at 11 am GMT -08:45 ", (result, text) => {
         expect(result.text).toBe("wednesday, september 16, 2020 at 11 am GMT -08:45");
 
@@ -45,7 +45,7 @@ test("Test - Parsing date with GMT offset", function () {
     });
 });
 
-test("Test - Parsing date with timezone abbreviation", function () {
+test("Test - Parsing date/time with timezone abbreviation", function () {
     testSingleCase(chrono, "wednesday, september 16, 2020 at 11 am", (result, text) => {
         expect(result.text).toBe(text);
 
@@ -73,21 +73,47 @@ test("Test - Parsing date with timezone abbreviation", function () {
     });
 });
 
-test("Test - Not parsing timezone from relative date", function () {
+test("Test - Parsing date with timezone abbreviation", function () {
+    testSingleCase(chrono, "Wednesday, September 16, 2020, EST", (result, text) => {
+        expect(result.text).toBe(text);
+        expect(result.start.get("timezoneOffset")).toBe(-300);
+    });
+});
+
+test("Test - Not parsing timezone from relative time", function () {
     const refDate = new Date(2020, 11 - 1, 14, 13, 48, 22);
 
     testSingleCase(chrono, "in 1 hour get eggs and milk", refDate, (result, text) => {
         expect(result.text).toBe("in 1 hour");
         expect(result.start.get("timezoneOffset")).toBe(-refDate.getTimezoneOffset());
     });
 
-    // testSingleCase(chrono, "in 1 hour GMT", refDate, (result, text) => {
-    //     expect(result.text).toBe("in 1 hour");
-    //     expect(result.start.get("timezoneOffset")).toBe(-refDate.getTimezoneOffset());
-    // });
+    testSingleCase(chrono, "in 3 hours GMT", refDate, (result, text) => {
+        expect(result.text).toBe("in 3 hours");
+        expect(result.start.get("timezoneOffset")).toBe(-refDate.getTimezoneOffset());
+    });
+});
+
+test("Test - Parsing timezone from relative date when valid", function () {
+    const refDate = new Date(2020, 11 - 1, 14, 13, 48, 22);
 
     testSingleCase(chrono, "in 1 day get eggs and milk", refDate, (result, text) => {
         expect(result.text).toBe("in 1 day");
         expect(result.start.get("timezoneOffset")).toBe(-refDate.getTimezoneOffset());
     });
+
+    testSingleCase(chrono, "in 1 day GET", refDate, (result, text) => {
+        expect(result.text).toBe("in 1 day GET");
+        expect(result.start.get("timezoneOffset")).toBe(240);
+    });
+
+    testSingleCase(chrono, "today EST", (result, text) => {
+        expect(result.text).toBe(text);
+        expect(result.start.get("timezoneOffset")).toBe(-300);
+    });
+
+    testSingleCase(chrono, "next week EST", (result, text) => {
+        expect(result.text).toBe(text);
+        expect(result.start.get("timezoneOffset")).toBe(-300);
+    });
 });