Add timezone handling improvements and related functionality across multiple modules

Author: timdegroot1996

robotframework_dashboard/js/common.js

@@ -208,6 +208,13 @@ function hide_loading_overlay() {
     }
 }
 
+// Strips the ±HH:MM timezone offset suffix from a run_start string.
+// Returns the wall-clock portion (YYYY-MM-DD HH:MM:SS[.fff]) without the tz offset.
+function strip_tz_suffix(s) {
+    const suffix = s.slice(-6);
+    return /^[+-]\d{2}:\d{2}$/.test(suffix) ? s.slice(0, -6) : s;
+}
+
 export {
     camelcase_to_underscore,
     get_next_folder_level,
@@ -225,5 +232,6 @@ export {
     hide_graph_loading,
     update_graphs_with_loading,
     show_loading_overlay,
-    hide_loading_overlay
+    hide_loading_overlay,
+    strip_tz_suffix
 };

robotframework_dashboard/js/eventlisteners.js

@@ -325,9 +325,10 @@ function setup_settings_modal() {
         handler(true);
         document.getElementById(def.elementId).addEventListener(def.event || "click", () => handler());
     });
-    // Re-populate the date filter pickers when the timezone conversion toggle changes,
+    // Re-populate the date filter pickers when either timezone toggle changes,
     // since the displayed timestamps change and the defaults need to match.
     document.getElementById("toggleTimezone").addEventListener("click", () => setup_lowest_highest_dates());
+    document.getElementById("toggleTimezones").addEventListener("click", () => setup_lowest_highest_dates());
     document.getElementById("themeLight").addEventListener("click", () => toggle_theme());
     document.getElementById("themeDark").addEventListener("click", () => toggle_theme());
 

robotframework_dashboard/js/filter.js

@@ -1,7 +1,7 @@
 import { settings } from './variables/settings.js';
 import { compareRunIds } from './variables/graphs.js';
 import { runs, suites, tests, keywords, unified_dashboard_title } from './variables/data.js';
-import { show_loading_overlay, hide_loading_overlay } from './common.js';
+import { show_loading_overlay, hide_loading_overlay, strip_tz_suffix } from './common.js';
 import { set_local_storage_item } from './localstorage.js';
 import {
     filteredAmount,
@@ -13,6 +13,16 @@ import {
     selectedTagSetting
 } from './variables/globals.js';
 
+// Sort an array of run objects by wall-clock run_start (timezone offset stripped),
+// ensuring correct chronological order when timestamps span mixed timezone offsets.
+function sort_wall_clock(data) {
+    return [...data].sort((a, b) => {
+        const ak = strip_tz_suffix(a.run_start);
+        const bk = strip_tz_suffix(b.run_start);
+        return ak < bk ? -1 : ak > bk ? 1 : 0;
+    });
+}
+
 // function updates the data in the graphs whenever filters are updated
 function setup_filtered_data_and_filters() {
     filteredRuns = remove_milliseconds(runs)
@@ -40,6 +50,13 @@ function setup_filtered_data_and_filters() {
     filteredSuites = filter_data(filteredSuites);
     filteredTests = filter_data(filteredTests);
     filteredKeywords = filter_data(filteredKeywords);
+    // re-sort all filtered data by wall-clock run_start so mixed-timezone datasets
+    // appear in the correct chronological order on graphs (timestamps may have been
+    // converted or had their offsets stripped above, so re-sort here is the source of truth)
+    filteredRuns = sort_wall_clock(filteredRuns);
+    filteredSuites = sort_wall_clock(filteredSuites);
+    filteredTests = sort_wall_clock(filteredTests);
+    filteredKeywords = sort_wall_clock(filteredKeywords);
     // set titles with amount of filtered items
     const runAmount = Object.keys(filteredRuns).length
     const message = `<h6>showing ${runAmount} of ${filteredAmount} runs</h6>`
@@ -220,7 +237,13 @@ function filter_dates(runs) {
         return runs;  // Return all runs if invalid range
     }
     return runs.filter(run => {
-        const runStart = new Date(run.run_start.replace(" ", "T"));
+        // When not converting timezones, strip any timezone offset so the run_start is treated
+        // as a plain wall-clock time matching the date picker values (which are also wall-clock).
+        let rs = run.run_start.replace(" ", "T");
+        if (!settings.show.convertTimezone) {
+            rs = strip_tz_suffix(rs);
+        }
+        const runStart = new Date(rs);
         return runStart >= fromDateTime && runStart <= toDateTime;
     });
 }

robotframework_dashboard/js/graph_data/duration.js

@@ -3,6 +3,7 @@ import { inFullscreen, inFullscreenGraph } from "../variables/globals.js";
 import { barConfig, lineConfig } from "../variables/chartconfig.js";
 import { compareRunIds } from "../variables/graphs.js";
 import { exclude_from_suite_data } from "./helpers.js";
+import { strip_tz_suffix } from "../common.js";
 
 // function to prepare the data in the correct format for duration graphs
 function get_duration_graph_data(dataType, graphType, objectDataAttribute, filteredData) {
@@ -61,7 +62,6 @@ function get_duration_graph_data(dataType, graphType, objectDataAttribute, filte
             map.set(label, (map.get(label) || 0) + duration);
         }
         return Array.from(map.entries())
-            .sort(([a], [b]) => new Date(a) - new Date(b))
             .slice(-limit)
             .map(([label, total]) => [label, Math.round(total * 100) / 100]);
     };
@@ -126,7 +126,10 @@ function get_duration_graph_data(dataType, graphType, objectDataAttribute, filte
         for (const value of filteredData) {
             if (!should_include(value)) continue;
             const name = suiteSelectSuitesCombined && dataType === "suite" ? "All Suites Combined" : value.name;
-            const run_start = new Date(value.run_start.replace(" ", "T"));
+            // When not converting timezones, strip any tz offset so x positions are wall-clock
+            // based and consistent with what the user sees in run_start labels.
+            const rs = strip_tz_suffix(value.run_start);
+            const run_start = new Date(rs.replace(" ", "T"));
             const val = Math.round(value[objectDataAttribute] * 100) / 100;
             if (!sets.has(name)) sets.set(name, [{ x: run_start, y: val, _run_start: value.run_start }]);
             else sets.get(name).push({ x: run_start, y: val, _run_start: value.run_start });

robotframework_dashboard/js/graph_data/failed.js

@@ -2,6 +2,7 @@ import { settings } from "../variables/settings.js";
 import { inFullscreen, inFullscreenGraph } from "../variables/globals.js";
 import { convert_timeline_data } from "./helpers.js";
 import { failedConfig } from "../variables/chartconfig.js";
+import { strip_tz_suffix } from "../common.js";
 
 // function to prepare the data in the correct format for most failed graphs
 function get_most_failed_data(dataType, graphType, filteredData, recent) {
@@ -81,7 +82,7 @@ function get_most_failed_data(dataType, graphType, filteredData, recent) {
             runStarts.forEach(runStart => runStartsSet.add(runStart));
             count++;
         }
-        const runStarts = Array.from(runStartsSet).sort((a, b) => new Date(a).getTime() - new Date(b).getTime());
+        const runStarts = Array.from(runStartsSet).sort((a, b) => new Date(strip_tz_suffix(a)).getTime() - new Date(strip_tz_suffix(b)).getTime());
         let datasets = [];
         let runAxis = 0;
         const pointMeta = {};

robotframework_dashboard/js/graph_data/flaky.js

@@ -1,6 +1,7 @@
 import { settings } from "../variables/settings.js";
 import { passedConfig, failedConfig, skippedConfig } from "../variables/chartconfig.js";
 import { convert_timeline_data } from "./helpers.js";
+import { strip_tz_suffix } from "../common.js";
 
 // function to prepare the data in the correct format for (recent) most flaky test graph
 function get_most_flaky_data(dataType, graphType, filteredData, ignore, recent, limit) {
@@ -60,7 +61,7 @@ function get_most_flaky_data(dataType, graphType, filteredData, ignore, recent,
     });
     if (recent) { // do extra filtering to get most recent flaky tests at the top
         sortedData.sort(function (a, b) {
-            return new Date(b[1].failed_run_starts[b[1].failed_run_starts.length - 1].replace(" ", "T")).getTime() - new Date(a[1].failed_run_starts[a[1].failed_run_starts.length - 1].replace(" ", "T")).getTime()
+            return new Date(strip_tz_suffix(b[1].failed_run_starts[b[1].failed_run_starts.length - 1].replace(" ", "T"))).getTime() - new Date(strip_tz_suffix(a[1].failed_run_starts[a[1].failed_run_starts.length - 1].replace(" ", "T"))).getTime()
         })
     }
 
@@ -99,7 +100,7 @@ function get_most_flaky_data(dataType, graphType, filteredData, ignore, recent,
         var datasets = [];
         var runAxis = 0;
         const pointMeta = {};
-        runStarts = runStarts.sort((a, b) => new Date(a).getTime() - new Date(b).getTime())
+        runStarts = runStarts.sort((a, b) => new Date(strip_tz_suffix(a)).getTime() - new Date(strip_tz_suffix(b)).getTime())
         for (const runStart of runStarts) {
             for (const label of labels) {
                 var foundValues = [];

robotframework_dashboard/js/graph_data/messages.js

@@ -3,6 +3,7 @@ import { inFullscreen, inFullscreenGraph } from "../variables/globals.js";
 import { failedConfig } from "../variables/chartconfig.js";
 import { message_config } from "../variables/data.js";
 import { convert_timeline_data } from "./helpers.js";
+import { strip_tz_suffix } from "../common.js";
 
 // function to prepare the data in the correct format for messages graphs
 function get_messages_data(dataType, graphType, filteredData) {
@@ -78,7 +79,7 @@ function get_messages_data(dataType, graphType, filteredData) {
             runStarts.forEach(runStart => runStartsSet.add(runStart));
             count++;
         }
-        const runStarts = Array.from(runStartsSet).sort((a, b) => new Date(a).getTime() - new Date(b).getTime());
+        const runStarts = Array.from(runStartsSet).sort((a, b) => new Date(strip_tz_suffix(a)).getTime() - new Date(strip_tz_suffix(b)).getTime());
         var datasets = [];
         let runAxis = 0;
         const pointMeta = {};

robotframework_dashboard/js/variables/data.js

@@ -1,8 +1,8 @@
 // prepare input data
-const runs = decode_and_decompress("placeholder_runs").sort((a, b) => new Date(a.run_start.replace(" ", "T")).getTime() - new Date(b.run_start.replace(" ", "T")).getTime());
-const suites = decode_and_decompress("placeholder_suites").sort((a, b) => new Date(a.run_start.replace(" ", "T")).getTime() - new Date(b.run_start.replace(" ", "T")).getTime());
-const tests = decode_and_decompress("placeholder_tests").sort((a, b) => new Date(a.run_start.replace(" ", "T")).getTime() - new Date(b.run_start.replace(" ", "T")).getTime());
-const keywords = decode_and_decompress("placeholder_keywords").sort((a, b) => new Date(a.run_start.replace(" ", "T")).getTime() - new Date(b.run_start.replace(" ", "T")).getTime());
+const runs = decode_and_decompress("placeholder_runs");
+const suites = decode_and_decompress("placeholder_suites");
+const tests = decode_and_decompress("placeholder_tests");
+const keywords = decode_and_decompress("placeholder_keywords");
 
 function decode_and_decompress(base64Str) {
     if (base64Str.includes("placeholder_")) return [];

scripts/example.bat

@@ -6,10 +6,10 @@ robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002338.xml:pro
 robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002400.xml:dev:project_2 --projectversion 1.2 --timezone=+00:00
 robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002431.xml:prod:project_1 --projectversion 1.2
 robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002457.xml:dev:project_2 --projectversion 1.2
-robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002528.xml:prod:project_1 --projectversion 2.0 -z -03:00
-robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002549.xml:dev:project_2 --projectversion 2.3 -z -05:00
-robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002636.xml:prod:project_1 --projectversion 2.3 -z -05:00
+robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002528.xml:prod:project_1 --projectversion 2.0 --timezone=-03:00
+robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002549.xml:dev:project_2 --projectversion 2.3 --timezone=-05:00
+robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002636.xml:prod:project_1 --projectversion 2.3 --timezone=-05:00
 robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002703.xml:dev:project_2 --projectversion 2.3 --timezone=-07:00
-robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002739.xml:prod:project_1 -z -07:00
-robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002915.xml:prod:project_1 --projectversion 2.0 -z -08:00
-robotdashboard -n robot_dashboard -o .\atest\resources\outputs\output-20250313-003006.xml:prod:project_1 --uselogs -z -09:00
+robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002739.xml:prod:project_1 --timezone=-07:00
+robotdashboard -g -l -o .\atest\resources\outputs\output-20250313-002915.xml:prod:project_1 --projectversion 2.0 --timezone=-08:00
+robotdashboard -n robot_dashboard -o .\atest\resources\outputs\output-20250313-003006.xml:prod:project_1 --uselogs --timezone=-09:00