rename inDbTimeZone to localTimestampToUtc

Author: KSDaemon

packages/cubejs-backend-shared/src/time.ts

@@ -192,7 +192,10 @@ export const BUILD_RANGE_START_LOCAL = '__BUILD_RANGE_START_LOCAL';
 
 export const BUILD_RANGE_END_LOCAL = '__BUILD_RANGE_END_LOCAL';
 
-export const inDbTimeZone = (timezone: string, timestampFormat: string, timestamp: string): string | null => {
+/**
+ * Takes timestamp, treat it as time in provided timezone and returns the corresponding timestamp in UTC
+ */
+export const localTimestampToUtc = (timezone: string, timestampFormat: string, timestamp: string): string | null => {
   if (!timestamp) {
     return null;
   }
@@ -231,7 +234,7 @@ export const inDbTimeZone = (timezone: string, timestampFormat: string, timestam
 };
 
 /**
- * Takes timestamp in UTC, treat it as local time in provided timezone and returns the corresponding timestamp in UTC
+ * Takes timestamp in UTC, shift it into provided timezone and returns the corresponding timestamp in UTC
  */
 export const utcToLocalTimeZone = (timezone: string, timestampFormat: string, timestamp: string): string | null => {
   if (!timestamp) {

packages/cubejs-backend-shared/test/time.test.ts

@@ -1,5 +1,5 @@
 import moment from 'moment-timezone';
-import { inDbTimeZone, timeSeries, isPredefinedGranularity, timeSeriesFromCustomInterval } from '../src';
+import { localTimestampToUtc, timeSeries, isPredefinedGranularity, timeSeriesFromCustomInterval } from '../src';
 
 describe('time', () => {
   it('time series - day', () => {
@@ -179,11 +179,11 @@ describe('time', () => {
   });
 
   it('inDbTimeZone', () => {
-    expect(inDbTimeZone('UTC', 'YYYY-MM-DD[T]HH:mm:ss.SSSSSS[Z]', '2020-01-01T00:00:00.000000')).toEqual(
+    expect(localTimestampToUtc('UTC', 'YYYY-MM-DD[T]HH:mm:ss.SSSSSS[Z]', '2020-01-01T00:00:00.000000')).toEqual(
       '2020-01-01T00:00:00.000000Z'
     );
 
-    expect(inDbTimeZone('UTC', 'YYYY-MM-DD[T]HH:mm:ss.SSSSSS[Z]', '2020-01-31T23:59:59.999999')).toEqual(
+    expect(localTimestampToUtc('UTC', 'YYYY-MM-DD[T]HH:mm:ss.SSSSSS[Z]', '2020-01-31T23:59:59.999999')).toEqual(
       '2020-01-31T23:59:59.999999Z'
     );
   });

packages/cubejs-query-orchestrator/src/orchestrator/PreAggregationPartitionRangeLoader.ts

@@ -8,7 +8,7 @@ import {
   reformatInIsoLocal,
   utcToLocalTimeZone,
   timeSeries,
-  inDbTimeZone,
+  localTimestampToUtc,
   extractDate,
 } from '@cubejs-backend/shared';
 import { InlineTable, TableStructure } from '@cubejs-backend/base-driver';
@@ -407,7 +407,7 @@ export class PreAggregationPartitionRangeLoader {
     const { preAggregationStartEndQueries } = this.preAggregation;
     const [startDate, endDate] = await Promise.all(
       preAggregationStartEndQueries.map(
-        async rangeQuery => inDbTimeZone(
+        async rangeQuery => localTimestampToUtc(
           this.preAggregation.timezone,
           'YYYY-MM-DDTHH:mm:ss.SSS',
           PreAggregationPartitionRangeLoader.extractDate(await this.loadRangeQuery(rangeQuery)),
@@ -427,7 +427,7 @@ export class PreAggregationPartitionRangeLoader {
     );
     const [rangeStart, rangeEnd] = await Promise.all(
       preAggregationStartEndQueries.map(
-        async (rangeQuery, i) => inDbTimeZone(
+        async (rangeQuery, i) => localTimestampToUtc(
           this.preAggregation.timezone,
           'YYYY-MM-DDTHH:mm:ss.SSS',
           PreAggregationPartitionRangeLoader.extractDate(
@@ -529,7 +529,7 @@ export class PreAggregationPartitionRangeLoader {
   }
 
   public static inDbTimeZone(preAggregationDescription: any, timestamp: string): string {
-    return inDbTimeZone(preAggregationDescription.timezone, preAggregationDescription.timestampFormat, timestamp);
+    return localTimestampToUtc(preAggregationDescription.timezone, preAggregationDescription.timestampFormat, timestamp);
   }
 
   public static extractDate(data: any): string {

packages/cubejs-schema-compiler/src/adapter/BaseQuery.js

@@ -14,7 +14,7 @@ import inflection from 'inflection';
 import {
   FROM_PARTITION_RANGE,
   MAX_SOURCE_ROW_LIMIT,
-  inDbTimeZone,
+  localTimestampToUtc,
   QueryAlias,
   getEnv,
   timeSeries as timeSeriesBase
@@ -2921,7 +2921,7 @@ export class BaseQuery {
   }
 
   inDbTimeZone(date) {
-    return inDbTimeZone(this.timezone, this.timestampFormat(), date);
+    return localTimestampToUtc(this.timezone, this.timestampFormat(), date);
   }
 
   /**