cube-js/cube

Pre-aggregations with elasticsearch as datasource are not timezone aware

Open

#7700 opened on Jan 29, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (19,563 stars) (1,965 forks)batch import
driver:elasticsearchhelp wanted

Description

When creating pre-aggregations with different time zones and elasticsearch as a data source, the time dimension of the results is not converted to each applicable time zone because 'convertTz' is not implemented in the "ElasticSearchQuery" adapter. The convertTz function code can be as follows:

public convertTz(field: string): string {
    const tz = moment().tz(this.timezone);
    // TODO respect day light saving
    const [hour, minute] = tz.format('Z').split(':');
    const [hourInt, minuteInt] = [parseInt(hour, 10), parseInt(minute, 10) * Math.sign(parseInt(hour, 10))];
    let result = field;
    if (hourInt !== 0) {
      result = `TIMESTAMPADD('hour', ${hourInt}, ${result})`;
    }
    if (minuteInt !== 0) {
      result = `TIMESTAMPADD('minute', ${minuteInt}, ${result})`;
    }
    return result;
}

Contributor guide

Tech stack
javascripttypescriptnodejselasticsearch
Domain
backenddatabase
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScriptElasticsearch query syntaxmoment.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue involves implementing the convertTz function in the ElasticSearchQuery adapter. Locate the adapter file (likely in packages/cubejs elasticsearch driver/src/ElasticSearchQuery.ts). Follow the pattern from other adapters' convertTz implementations, using moment.js to apply timezone offset via TIMESTAMPADD. Ensure daylight saving time is handled and the function integrates with existing pre aggregation logic. No existing PRs; the maintainers have not clarified scope, so the implementation should be straightforward.