Add new node module to test timezone correctness

Add new timezone test module don't run tz test twice
finos · Jan 30, 2021 · 7e758e2 · 7e758e2
1 parent 44be6ad
commit 7e758e2
Show file tree

Hide file tree

Showing 5 changed files with 218 additions and 5 deletions.
diff --git a/packages/perspective/package.json b/packages/perspective/package.json
@@ -29,7 +29,8 @@
         "docs": "npm-run-all docs:jsdoc docs:deploy",
         "docs:jsdoc": "jsdoc2md src/js/perspective.js -p list --separators --no-gfm > README.md",
         "docs:deploy": "(echo \"---\nid: perspective\ntitle: perspective API\n---\n\n\"; cat README.md) > ../../docs/obj/perspective.md",
-        "test:run": "jest --color --ci",
+        "test:run": "jest --color --ci --testPathIgnorePatterns='timezone'",
+        "test_timezone:run": "jest --color --ci --config=test/config/timezone/jest.config.js --rootDir=. timezone.spec.js",
         "test": "npm-run-all test:run",
         "clean": "rimraf dist"
     },

diff --git a/packages/perspective/test/config/timezone/jest.config.js b/packages/perspective/test/config/timezone/jest.config.js
@@ -0,0 +1,12 @@
+/******************************************************************************
+ *
+ * Copyright (c) 2017, the Perspective Authors.
+ *
+ * This file is part of the Perspective library, distributed under the terms of
+ * the Apache License 2.0.  The full license can be found in the LICENSE file.
+ *
+ */
+
+module.exports = {
+    globalSetup: "<rootDir>/test/config/timezone/set_timezone.js"
+};
diff --git a/packages/perspective/test/config/timezone/set_timezone.js b/packages/perspective/test/config/timezone/set_timezone.js
@@ -0,0 +1,12 @@
+/******************************************************************************
+ *
+ * Copyright (c) 2017, the Perspective Authors.
+ *
+ * This file is part of the Perspective library, distributed under the terms of
+ * the Apache License 2.0.  The full license can be found in the LICENSE file.
+ *
+ */
+
+module.exports = async () => {
+    process.env.TZ = "America/New_York";
+};
diff --git a/packages/perspective/test/js/timezone/timezone.spec.js b/packages/perspective/test/js/timezone/timezone.spec.js
@@ -0,0 +1,161 @@
+/******************************************************************************
+ *
+ * Copyright (c) 2017, the Perspective Authors.
+ *
+ * This file is part of the Perspective library, distributed under the terms of
+ * the Apache License 2.0.  The full license can be found in the LICENSE file.
+ *
+ */
+
+const perspective = require("../../../dist/cjs/perspective.node.js");
+
+const date_data = [
+    {x: new Date(2020, 0, 1)}, // 2020/01/01
+    {x: new Date(2020, 2, 8)}, // 2020/03/08
+    {x: new Date(2020, 9, 1)}, // 2020/10/01
+    {x: new Date(2020, 10, 1)}, // 2020/11/01
+    {x: new Date(2020, 11, 31)} // 2020/12/31
+];
+
+const date_data_local = [
+    {x: new Date(2020, 0, 1).toLocaleDateString()}, // 2020/01/01
+    {x: new Date(2020, 2, 8).toLocaleDateString()}, // 2020/03/08
+    {x: new Date(2020, 9, 1).toLocaleDateString()}, // 2020/10/01
+    {x: new Date(2020, 10, 1).toLocaleDateString()}, // 2020/11/01
+    {x: new Date(2020, 11, 31).toLocaleDateString()} // 2020/12/31
+];
+
+const datetime_data = [
+    {x: new Date(2019, 1, 28, 23, 59, 59)}, // 2019/02/28 23:59:59 GMT-0500
+    {x: new Date(2020, 1, 29, 0, 0, 1)}, // 2020/02/29 00:00:01 GMT-0500
+    {x: new Date(2020, 2, 8, 1, 59, 59)}, // 2020/03/8 01:59:59 GMT-0400
+    {x: new Date(2020, 2, 8, 2, 0, 1)}, // 2020/03/8 02:00:01 GMT-0500
+    {x: new Date(2020, 9, 1, 15, 11, 55)}, // 2020/10/01 15:30:55 GMT-0400
+    {x: new Date(2020, 10, 1, 19, 29, 55)}, // 2020/11/01 19:30:55 GMT-0400
+    {x: new Date(2020, 11, 31, 7, 42, 55)} // 2020/12/31 07:30:55 GMT-0500
+];
+
+const datetime_data_local = [
+    {x: new Date(2019, 1, 28, 23, 59, 59).toLocaleString()}, // 2019/02/28 23:59:59 GMT-0500
+    {x: new Date(2020, 1, 29, 0, 0, 1).toLocaleString()}, // 2020/02/29 00:00:01 GMT-0500
+    {x: new Date(2020, 2, 8, 1, 59, 59).toLocaleString()}, // 2020/03/8 01:59:59 GMT-0400
+    {x: new Date(2020, 2, 8, 2, 0, 1).toLocaleString()}, // 2020/03/8 02:00:01 GMT-0500
+    {x: new Date(2020, 9, 1, 15, 11, 55).toLocaleString()}, // 2020/10/01 15:30:55 GMT-0400
+    {x: new Date(2020, 10, 1, 19, 29, 55).toLocaleString()}, // 2020/11/01 19:30:55 GMT-0400
+    {x: new Date(2020, 11, 31, 7, 42, 55).toLocaleString()} // 2020/12/31 07:30:55 GMT-0500
+];
+
+/**
+ * Check that two datasets containing datetimes are equal, specifically that
+ * that their locale strings and timezone offsets are equal.
+ *
+ * @param {*} output output of `view.to_json()`
+ * @param {*} expected expected dataset
+ */
+const check_datetime = (output, expected) => {
+    expect(output.length).toEqual(expected.length);
+    for (let i = 0; i < output.length; i++) {
+        let date = new Date(output[i]["x"]);
+        expect(date.toLocaleString()).toEqual(expected[i]["x"].toLocaleString());
+        expect(date.getTimezoneOffset()).toEqual(expected[i]["x"].getTimezoneOffset());
+    }
+};
+
+describe("Timezone Tests", () => {
+    beforeAll(() => {
+        expect(process.env.TZ).toBe("America/New_York");
+        expect(new Date().getTimezoneOffset()).toBe(300);
+        console.log("TZ set to", process.env.TZ);
+    });
+
+    /**
+     * Date() values are treated as UTC, and localized on output.
+     */
+    it("Displays date correctly from Date()", async () => {
+        const table = perspective.table(date_data);
+        expect(await table.schema()).toEqual({x: "date"});
+        const view = table.view();
+        let data = await view.to_json();
+        check_datetime(data, date_data);
+    });
+
+    /**
+     * Date strings are treated as UTC, and then localized on output. BUT this
+     * can lead to confusion when users try to parse date strings that are in
+     * a specific locale format - when I give Perspective a datestring like
+     * "02/09/2020", I expect it to be parsed as local time and displayed as-is,
+     * instead of being displayed as "02/08/2020 19:00:00", because of the
+     * assumption that the string is UTC and its subsequent conversion to
+     * local time by adding the hour offset.
+     */
+    it("Displays date correctly from ISO date string", async () => {
+        // Converts automatically to ISO-formatted string
+        const deepcopy = JSON.parse(JSON.stringify(date_data));
+        const table = perspective.table({
+            x: "date"
+        });
+        table.update(deepcopy);
+        const view = table.view();
+        let data = await view.to_json();
+        check_datetime(data, date_data);
+    });
+
+    /**
+     * TODO: this test neeeds to fail on docker at the same place as local,
+     * perhaps the locale isn't right.
+     *
+     * This test will fail in local - because the strings are assumed to be UTC,
+     * they are incorrectly converted from midnight to 7pm on the preceding
+     * day due to the time difference. In some sense, this behavior is
+     * "correct" - it just breaks the assumptions a user would have when they
+     * provide a date string, which is especially important in filtering because
+     * there is no way to provide a Date() object to the filter.
+     *
+     * TODO: fixing this would entail pre-converting filters to new Date(),
+     * in JS, since we know the behavior for new Date() is always correct, and
+     * then users can type in a date string in local time and have it filter
+     * down to the correct value.
+     */
+    it("Displays date correctly from local date string", async () => {
+        const table = perspective.table(date_data_local);
+        const view = table.view();
+        let data = await view.to_json();
+
+        for (let i = 0; i < data.length; i++) {
+            let date = new Date(data[i]["x"]);
+            expect(date.toLocaleDateString()).toEqual(date_data_local[i]["x"]);
+        }
+    });
+
+    it("Displays datetime correctly from Date()", async () => {
+        const table = perspective.table(datetime_data);
+        expect(await table.schema()).toEqual({x: "datetime"});
+        const view = table.view();
+        let data = await view.to_json();
+        check_datetime(data, datetime_data);
+    });
+
+    it("Displays datetime correctly from ISO date string", async () => {
+        // Converts automatically to ISO-formatted string
+        const deepcopy = JSON.parse(JSON.stringify(datetime_data));
+        const table = perspective.table(deepcopy);
+        expect(await table.schema()).toEqual({x: "datetime"});
+        const view = table.view();
+        let data = await view.to_json();
+        check_datetime(data, datetime_data);
+    });
+
+    /**
+     * TODO: this test needs to fail on docker and local at the same place.
+     */
+    it("Displays datetime correctly from local date string", async () => {
+        const table = perspective.table(datetime_data_local);
+        const view = table.view();
+        let data = await view.to_json();
+
+        for (let i = 0; i < data.length; i++) {
+            let date = new Date(data[i]["x"]);
+            expect(date.toLocaleString()).toEqual(" " + datetime_data_local[i]["x"]);
+        }
+    });
+});
diff --git a/scripts/test_js.js b/scripts/test_js.js
@@ -10,6 +10,7 @@
 const {bash, execute, getarg, docker} = require("./script_utils.js");
 const fs = require("fs");
 
+const DEBUG_FLAG = getarg("--debug") ? "" : "--silent";
 const IS_PUPPETEER = !!getarg("--private-puppeteer");
 const IS_WRITE = !!getarg("--write") || process.env.WRITE_TESTS;
 const IS_LOCAL_PUPPETEER = fs.existsSync("node_modules/puppeteer");
@@ -32,6 +33,9 @@ function silent(x) {
     return bash`output=$(${x}); ret=$?; echo "\${output}"; exit $ret`;
 }
 
+/**
+ * Run tests for all packages in parallel.
+ */
 function jest() {
     return bash`
         PSP_SATURATE=${!!getarg("--saturate")} 
@@ -42,13 +46,29 @@ function jest() {
         --rootDir=.
         --config=packages/perspective-test/jest.all.config.js 
         --color
-        --verbose 
+        --verbose
         --maxWorkers=50%
+        --testPathIgnorePatterns='timezone'
         ${getarg("--bail") && "--bail"}
         ${getarg("--debug") || "--silent 2>&1 --noStackTrace"} 
         --testNamePattern="${get_regex()}"`;
 }
 
+/**
+ * Run timezone tests in a new Node process.
+ */
+function jest_timezone() {
+    return bash`
+        node_modules/.bin/lerna exec 
+        --concurrency 1 
+        --no-bail
+        --scope="@finos/perspective" 
+        -- 
+        yarn test_timezone:run
+        ${DEBUG_FLAG}
+        --testNamePattern="${get_regex()}"`;
+}
+
 function get_regex() {
     const regex = getarg`-t`;
     if (regex) {
@@ -71,11 +91,16 @@ try {
                 --scope="@finos/${PACKAGE}"`;
         }
         if (getarg("--quiet")) {
+            console.log("-- Running Perspective.js timezone test suite in quiet mode");
+            execute(silent(jest_timezone()));
             console.log("-- Running test suite in quiet mode");
             execute(silent(jest()));
         } else if (process.env.PACKAGE) {
-            const debug = getarg("--debug") ? "" : "--silent";
-            console.log("-- Running test suite in individual mode");
+            console.log(`-- Running "${PACKAGE}" test suite`);
+            if (PACKAGE === "perspective") {
+                console.log("-- Running Perspective.js timezone test suite");
+                execute(jest_timezone());
+            }
             execute`
                 PSP_SATURATE=${!!getarg("--saturate")}
                 PSP_PAUSE_ON_FAILURE=${!!getarg("--interactive")}
@@ -87,10 +112,12 @@ try {
                 --scope="@finos/${PACKAGE}" 
                 -- 
                 yarn test:run
-                ${debug}
+                ${DEBUG_FLAG}
                 ${getarg("--interactive") && "--runInBand"}
                 --testNamePattern="${get_regex()}"`;
         } else {
+            console.log("-- Running Perspective.js timezone test suite");
+            execute(jest_timezone());
             console.log("-- Running test suite in fast mode");
             execute(jest());
         }