fix: Respect timezone for natural language date parsing and align custom date ranges to dates by default to ensure backward compatibility

Author: paveltiunov

packages/cubejs-api-gateway/dateParser.js

@@ -1,14 +1,14 @@
 const chrono = require('chrono-node');
-const moment = require('moment');
+const moment = require('moment-timezone');
 const UserError = require('./UserError');
 
-module.exports = (dateString) => {
+module.exports = (dateString, timezone) => {
   let momentRange;
   dateString = dateString.toLowerCase();
   if (dateString.match(/(this|last)\s+(day|week|month|year|quarter|hour|minute|second)/)) {
     const match = dateString.match(/(this|last)\s+(day|week|month|year|quarter|hour|minute|second)/);
-    let start = moment();
-    let end = moment();
+    let start = moment.tz(timezone);
+    let end = moment.tz(timezone);
     if (match[1] === 'last') {
       start = start.add(-1, match[2]);
       end = end.add(-1, match[2]);
@@ -19,25 +19,25 @@ module.exports = (dateString) => {
     const match = dateString.match(/last\s+(\d+)\s+(day|week|month|year|quarter|hour|minute|second)/);
     const span = match[2] === 'week' ? 'isoWeek' : match[2];
     momentRange = [
-      moment().add(-parseInt(match[1], 10) - 1, match[2]).startOf(span),
-      moment().add(-1, match[2]).endOf(span)
+      moment.tz(timezone).add(-parseInt(match[1], 10) - 1, match[2]).startOf(span),
+      moment.tz(timezone).add(-1, match[2]).endOf(span)
     ];
   } else if (dateString.match(/today/)) {
-    momentRange = [moment().startOf('day'), moment().endOf('day')];
+    momentRange = [moment.tz(timezone).startOf('day'), moment.tz(timezone).endOf('day')];
   } else if (dateString.match(/yesterday/)) {
-    const yesterday = moment().add(-1, 'day');
+    const yesterday = moment.tz(timezone).add(-1, 'day');
     momentRange = [moment(yesterday).startOf('day'), moment(yesterday).endOf('day')];
   } else {
     const results = chrono.parse(dateString);
     if (!results) {
       throw new UserError(`Can't parse date: '${dateString}'`);
     }
     momentRange = results[0].end ? [
-      results[0].start.moment(),
-      results[0].end.moment()
+      moment(results[0].start.moment()).tz(timezone).startOf('day'),
+      moment(results[0].end.moment()).tz(timezone).endOf('day')
     ] : [
-      results[0].start.moment(),
-      results[0].start.moment()
+      moment(results[0].start.moment()).tz(timezone).startOf('day'),
+      moment(results[0].start.moment()).tz(timezone).endOf('day')
     ];
   }
   return momentRange.map(d => d.format(moment.HTML5_FMT.DATETIME_LOCAL_MS));

packages/cubejs-api-gateway/index.js

@@ -206,7 +206,7 @@ const normalizeQuery = (query) => {
     timeDimensions: (query.timeDimensions || []).map(td => {
       let dateRange;
       if (typeof td.dateRange === 'string') {
-        dateRange = dateParser(td.dateRange);
+        dateRange = dateParser(td.dateRange, timezone);
       } else {
         dateRange = td.dateRange && td.dateRange.length === 1 ? [td.dateRange[0], td.dateRange[0]] : td.dateRange;
       }

packages/cubejs-api-gateway/package.json

@@ -6,17 +6,22 @@
   "engines": {
     "node": ">=8.11.1"
   },
+  "scripts": {
+    "test": "jest"
+  },
   "main": "index.js",
   "dependencies": {
     "@hapi/joi": "^14.0.6",
     "chrono-node": "^1.3.11",
     "jsonwebtoken": "^8.3.0",
     "moment": "^2.24.0",
+    "moment-timezone": "^0.5.27",
     "ramda": "^0.25.0"
   },
   "devDependencies": {
     "eslint": "^4.14.0",
     "eslint-plugin-node": "^5.2.1",
+    "jest": "^24.9.0",
     "mocha": "^5.2.0",
     "should": "^13.2.3"
   },