Replace Angular code that synchronizes URL parameters with Time API (#3089)

* Added new test to telemetry tables to check that telemetry data is correctly rendered in rows

* Added test tools for mocking builtins

* Changed order that promises are resolved to address race condition

* Remove duplicate installation of UTC Time System

* Added additional test telemetry

* Start Open MCT headless

* Added headless mode start option. Fixes #3064

* Added new non-angular URL handler

* Removed legacy Angular TimeSettingsURLHandler

* Added function to testTools to reset application state

* Use resetApplicationState function from telemetry table spec

* Added new TimeSettingsURLHandler to plugins

* Added missing semicolons

* #2826 Refactored code into separate class

* Handling of hash-relative URLs

* Refactoring URL sync code

* Refactored to external class

* Moved utils to new 'utils' directory. Refactored location util functions from class to exported functions

* Added test specs for openmctLocation

* Added new function to destroy instances of Open MCT between test runs

* Ensure test specs are cleaning up after themselves

* Added test spec for new URLTimeSettingsSynchronizer

* Removed use of shell script as it doesn't work in windows

* Pushed test coverage to 100%

* Added missing copyright statement

* Removed debugging output

* Fixed linting error

* Upgrade node version

* Clear cache

* Re-enabled tests

Co-authored-by: Melanie Lean <melanielean@Melanies-MacBook-Pro.local>
Co-authored-by: Shefali Joshi <simplyrender@gmail.com>
Co-authored-by: Deep Tailor <deep.j.tailor@nasa.gov>

src/plugins/URLTimeSettingsSynchronizer/URLTimeSettingsSynchronizer.js

@@ -0,0 +1,230 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+import {
+    getAllSearchParams,
+    setAllSearchParams
+} from 'utils/openmctLocation';
+
+const TIME_EVENTS = ['bounds', 'timeSystem', 'clock', 'clockOffsets'];
+const SEARCH_MODE = 'tc.mode';
+const SEARCH_TIME_SYSTEM = 'tc.timeSystem';
+const SEARCH_START_BOUND = 'tc.startBound';
+const SEARCH_END_BOUND = 'tc.endBound';
+const SEARCH_START_DELTA = 'tc.startDelta';
+const SEARCH_END_DELTA = 'tc.endDelta';
+const MODE_FIXED = 'fixed';
+
+export default class URLTimeSettingsSynchronizer {
+    constructor(openmct) {
+        this.openmct = openmct;
+        this.isUrlUpdateInProgress = false;
+
+        this.initialize = this.initialize.bind(this);
+        this.destroy = this.destroy.bind(this);
+        this.updateTimeSettings = this.updateTimeSettings.bind(this);
+        this.setUrlFromTimeApi = this.setUrlFromTimeApi.bind(this);
+
+        openmct.on('start', this.initialize);
+        openmct.on('destroy', this.destroy);
+    }
+
+    initialize() {
+        this.updateTimeSettings();
+
+        window.addEventListener('hashchange', this.updateTimeSettings);
+        TIME_EVENTS.forEach(event => {
+            this.openmct.time.on(event, this.setUrlFromTimeApi);
+        });
+
+    }
+
+    destroy() {
+        window.removeEventListener('hashchange', this.updateTimeSettings);
+        this.openmct.off('start', this.initialize);
+        this.openmct.off('destroy', this.destroy);
+
+        TIME_EVENTS.forEach(event => {
+            this.openmct.time.off(event, this.setUrlFromTimeApi);
+        });
+    }
+
+    updateTimeSettings() {
+        // Prevent from triggering self
+        if (!this.isUrlUpdateInProgress) {
+            let timeParameters = this.parseParametersFromUrl();
+
+
+            if (this.areTimeParametersValid(timeParameters)) {
+                this.setTimeApiFromUrl(timeParameters);
+            } else {
+                this.setUrlFromTimeApi();
+            }
+        } else {
+            this.isUrlUpdateInProgress = false;
+        }
+    }
+
+    parseParametersFromUrl() {
+        let searchParams = getAllSearchParams();
+
+        let mode = searchParams.get(SEARCH_MODE);
+        let timeSystem = searchParams.get(SEARCH_TIME_SYSTEM);
+
+        let startBound = parseInt(searchParams.get(SEARCH_START_BOUND), 10);
+        let endBound = parseInt(searchParams.get(SEARCH_END_BOUND), 10);
+        let bounds = {
+            start: startBound,
+            end: endBound
+        };
+
+        let startOffset = parseInt(searchParams.get(SEARCH_START_DELTA), 10);
+        let endOffset = parseInt(searchParams.get(SEARCH_END_DELTA), 10);
+        let clockOffsets = {
+            start: 0 - startOffset,
+            end: endOffset
+        };
+
+        return {
+            mode,
+            timeSystem,
+            bounds,
+            clockOffsets
+        };
+    }
+
+    setTimeApiFromUrl(timeParameters) {
+        if (timeParameters.mode === 'fixed') {
+            if (this.openmct.time.timeSystem().key !== timeParameters.timeSystem) {
+                this.openmct.time.timeSystem(
+                    timeParameters.timeSystem,
+                    timeParameters.bounds
+                );
+            } else if (!this.areStartAndEndEqual(this.openmct.time.bounds(), timeParameters.bounds)) {
+                this.openmct.time.bounds(timeParameters.bounds);
+            }
+            if (this.openmct.time.clock()) {
+                this.openmct.time.stopClock();
+            }
+        } else {
+            if (!this.openmct.time.clock() ||
+                this.openmct.time.clock().key !== timeParameters.mode) {
+                this.openmct.time.clock(timeParameters.mode, timeParameters.clockOffsets);
+            } else if (!this.areStartAndEndEqual(this.openmct.time.clockOffsets(), timeParameters.clockOffsets)) {
+                this.openmct.time.clockOffsets(timeParameters.clockOffsets);
+            }
+            if (!this.openmct.time.timeSystem() ||
+                this.openmct.time.timeSystem().key !== timeParameters.timeSystem) {
+                this.openmct.time.timeSystem(timeParameters.timeSystem);
+            }
+        }
+    }
+
+    setUrlFromTimeApi() {
+        let searchParams = getAllSearchParams();
+        let clock = this.openmct.time.clock();
+        let bounds = this.openmct.time.bounds();
+        let clockOffsets = this.openmct.time.clockOffsets();
+
+        if (clock === undefined) {
+            searchParams.set(SEARCH_MODE, MODE_FIXED);
+            searchParams.set(SEARCH_START_BOUND, bounds.start);
+            searchParams.set(SEARCH_END_BOUND, bounds.end);
+
+            searchParams.delete(SEARCH_START_DELTA);
+            searchParams.delete(SEARCH_END_DELTA);
+        } else {
+            searchParams.set(SEARCH_MODE, clock.key);
+
+            if (clockOffsets !== undefined) {
+                searchParams.set(SEARCH_START_DELTA, 0 - clockOffsets.start);
+                searchParams.set(SEARCH_END_DELTA, clockOffsets.end);
+            } else {
+                searchParams.delete(SEARCH_START_DELTA);
+                searchParams.delete(SEARCH_END_DELTA);
+            }
+            searchParams.delete(SEARCH_START_BOUND);
+            searchParams.delete(SEARCH_END_BOUND);
+        }
+
+        searchParams.set(SEARCH_TIME_SYSTEM, this.openmct.time.timeSystem().key);
+        this.isUrlUpdateInProgress = true;
+        setAllSearchParams(searchParams);
+    }
+
+    areTimeParametersValid(timeParameters) {
+        let isValid = false;
+
+        if (this.isModeValid(timeParameters.mode) &&
+            this.isTimeSystemValid(timeParameters.timeSystem)) {
+
+            if (timeParameters.mode === 'fixed') {
+                isValid = this.areStartAndEndValid(timeParameters.bounds);
+            } else {
+                isValid = this.areStartAndEndValid(timeParameters.clockOffsets);
+            }
+        }
+
+        return isValid;
+    }
+
+    areStartAndEndValid(bounds) {
+        return bounds !== undefined &&
+            bounds.start !== undefined &&
+            bounds.start !== null &&
+            bounds.end !== undefined &&
+            bounds.start !== null &&
+            !isNaN(bounds.start) &&
+            !isNaN(bounds.end);
+    }
+
+    isTimeSystemValid(timeSystem) {
+        let isValid = timeSystem !== undefined;
+        if (isValid) {
+            let timeSystemObject = this.openmct.time.timeSystems.get(timeSystem);
+            isValid = timeSystemObject !== undefined;
+        }
+        return isValid;
+    }
+
+    isModeValid(mode) {
+        let isValid = false;
+
+        if (mode !== undefined &&
+            mode !== null) {
+            isValid = true;
+        }
+
+        if (isValid) {
+            if (mode.toLowerCase() === MODE_FIXED) {
+                isValid = true;
+            } else {
+                isValid = this.openmct.time.clocks.get(mode) !== undefined;
+            }
+        }
+        return isValid;
+    }
+
+    areStartAndEndEqual(firstBounds, secondBounds) {
+        return firstBounds.start === secondBounds.start &&
+            firstBounds.end === secondBounds.end;
+    }
+}

src/plugins/URLTimeSettingsSynchronizer/plugin.js

@@ -0,0 +1,28 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+import URLTimeSettingsSynchronizer from "./URLTimeSettingsSynchronizer.js";
+
+export default function () {
+    return function install(openmct) {
+        return new URLTimeSettingsSynchronizer(openmct);
+    }
+}

src/plugins/URLTimeSettingsSynchronizer/pluginSpec.js

@@ -0,0 +1,307 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+import {
+    createOpenMct,
+    resetApplicationState
+} from 'utils/testing';
+
+describe("The URLTimeSettingsSynchronizer", () => {
+    let openmct;
+    let testClock;
+    beforeAll(() => resetApplicationState());
+
+    beforeEach((done) => {
+        openmct = createOpenMct();
+        openmct.install(openmct.plugins.LocalTimeSystem());
+        testClock = jasmine.createSpyObj("testClock", ["start", "stop", "tick", "currentValue", "on", "off"]);
+        testClock.key = "test-clock";
+        testClock.currentValue.and.returnValue(0);
+
+        openmct.time.addClock(testClock);
+
+        openmct.on('start', done);
+        openmct.startHeadless();
+    });
+
+    afterEach(() => resetApplicationState(openmct));
+
+    describe("realtime mode", () => {
+        it("when the clock is set via the time API, it is immediately reflected in the URL", () => {
+            //Test expected initial conditions
+            expect(window.location.hash.includes('tc.mode=fixed')).toBe(true);
+
+            openmct.time.clock('local', {start: -1000, end: 100});
+
+            expect(window.location.hash.includes('tc.mode=local')).toBe(true);
+
+            //Test that expected initial conditions are no longer true
+            expect(window.location.hash.includes('tc.mode=fixed')).toBe(false);
+        });
+        it("when offsets are set via the time API, they are immediately reflected in the URL", () => {
+            //Test expected initial conditions
+            expect(window.location.hash.includes('tc.startDelta')).toBe(false);
+            expect(window.location.hash.includes('tc.endDelta')).toBe(false);
+
+            openmct.time.clock('local', {start: -1000, end: 100});
+            expect(window.location.hash.includes('tc.startDelta=1000')).toBe(true);
+            expect(window.location.hash.includes('tc.endDelta=100')).toBe(true);
+
+            openmct.time.clockOffsets({start: -2000, end: 200});
+            expect(window.location.hash.includes('tc.startDelta=2000')).toBe(true);
+            expect(window.location.hash.includes('tc.endDelta=200')).toBe(true);
+
+            //Test that expected initial conditions are no longer true
+            expect(window.location.hash.includes('tc.mode=fixed')).toBe(false);
+        });
+        describe("when set in the url", () => {
+            it("will change from fixed to realtime mode when the mode changes", () => {
+                expectLocationToBeInFixedMode();
+                return switchToRealtimeMode().then(() => {
+                    let clock = openmct.time.clock();
+
+                    expect(clock).toBeDefined();
+                    expect(clock.key).toBe('local');
+                });
+            });
+            it("the clock is correctly set in the API from the URL parameters", () => {
+                return switchToRealtimeMode().then(() => {
+                    let resolveFunction;
+                    return new Promise((resolve) => {
+                        resolveFunction = resolve;
+
+                        //The 'hashchange' event appears to be asynchronous, so we need to wait until a clock change has been
+                        //detected in the API.
+                        openmct.time.on('clock', resolveFunction);
+                        let hash = window.location.hash;
+                        hash = hash.replace('tc.mode=local', 'tc.mode=test-clock');
+                        window.location.hash = hash;
+                    }).then(() => {
+                        let clock = openmct.time.clock();
+                        expect(clock).toBeDefined();
+                        expect(clock.key).toBe('test-clock');
+                        openmct.time.off('clock', resolveFunction);
+                    });
+                });
+            });
+            it("the clock offsets are correctly set in the API from the URL parameters", () => {
+                return switchToRealtimeMode().then(() => {
+                    let resolveFunction;
+                    return new Promise((resolve) => {
+                        resolveFunction = resolve;
+                        //The 'hashchange' event appears to be asynchronous, so we need to wait until a clock change has been
+                        //detected in the API.
+                        openmct.time.on('clockOffsets', resolveFunction);
+                        let hash = window.location.hash;
+                        hash = hash.replace('tc.startDelta=1000', 'tc.startDelta=2000');
+                        hash = hash.replace('tc.endDelta=100', 'tc.endDelta=200');
+                        window.location.hash = hash;
+                    }).then(() => {
+                        let clockOffsets = openmct.time.clockOffsets();
+                        expect(clockOffsets).toBeDefined();
+                        expect(clockOffsets.start).toBe(-2000);
+                        expect(clockOffsets.end).toBe(200);
+                        openmct.time.off('clockOffsets', resolveFunction);
+                    });
+                });
+            });
+            it("the time system is correctly set in the API from the URL parameters", () => {
+                return switchToRealtimeMode().then(() => {
+                    let resolveFunction;
+                    return new Promise((resolve) => {
+                        resolveFunction = resolve;
+
+                        //The 'hashchange' event appears to be asynchronous, so we need to wait until a clock change has been
+                        //detected in the API.
+                        openmct.time.on('timeSystem', resolveFunction);
+                        let hash = window.location.hash;
+                        hash = hash.replace('tc.timeSystem=utc', 'tc.timeSystem=local');
+                        window.location.hash = hash;
+                    }).then(() => {
+                        let timeSystem = openmct.time.timeSystem();
+                        expect(timeSystem).toBeDefined();
+                        expect(timeSystem.key).toBe('local');
+                        openmct.time.off('timeSystem', resolveFunction);
+                    });
+                });
+            });
+        });
+    });
+    describe("fixed timespan mode", () => {
+        beforeEach(() => {
+            openmct.time.stopClock();
+            openmct.time.timeSystem('utc', {start: 0, end: 1});
+        });
+
+        it("when bounds are set via the time API, they are immediately reflected in the URL", ()=>{
+            //Test expected initial conditions
+            expect(window.location.hash.includes('tc.startBound=0')).toBe(true);
+            expect(window.location.hash.includes('tc.endBound=1')).toBe(true);
+
+            openmct.time.bounds({start: 10, end: 20});
+
+            expect(window.location.hash.includes('tc.startBound=10')).toBe(true);
+            expect(window.location.hash.includes('tc.endBound=20')).toBe(true);
+
+            //Test that expected initial conditions are no longer true
+            expect(window.location.hash.includes('tc.startBound=0')).toBe(false);
+            expect(window.location.hash.includes('tc.endBound=1')).toBe(false);
+        });
+
+        it("when time system is set via the time API, it is immediately reflected in the URL", ()=>{
+            //Test expected initial conditions
+            expect(window.location.hash.includes('tc.timeSystem=utc')).toBe(true);
+
+            openmct.time.timeSystem('local', {start: 20, end: 30});
+
+            expect(window.location.hash.includes('tc.timeSystem=local')).toBe(true);
+
+            //Test that expected initial conditions are no longer true
+            expect(window.location.hash.includes('tc.timeSystem=utc')).toBe(false);
+        });
+        describe("when set in the url", () => {
+            it("time system changes are reflected in the API", () => {
+                let resolveFunction;
+
+                return new Promise((resolve) => {
+                    let timeSystem = openmct.time.timeSystem();
+                    resolveFunction = resolve;
+
+                    expect(timeSystem.key).toBe('utc');
+                    window.location.hash = window.location.hash.replace('tc.timeSystem=utc', 'tc.timeSystem=local');
+
+                    openmct.time.on('timeSystem', resolveFunction);
+                }).then(() => {
+                    let timeSystem = openmct.time.timeSystem();
+                    expect(timeSystem.key).toBe('local');
+
+                    openmct.time.off('timeSystem', resolveFunction);
+                });
+            });
+            it("mode can be changed from realtime to fixed", () => {
+                return switchToRealtimeMode().then(() => {
+                    expectLocationToBeInRealtimeMode();
+
+                    expect(openmct.time.clock()).toBeDefined();
+                }).then(switchToFixedMode).then(() => {
+                    let clock = openmct.time.clock();
+                    expect(clock).not.toBeDefined();
+                });
+            });
+            it("bounds are correctly set in the API from the URL parameters", () => {
+                let resolveFunction;
+
+                expectLocationToBeInFixedMode();
+
+                return new Promise((resolve) => {
+                    resolveFunction = resolve;
+                    openmct.time.on('bounds', resolveFunction);
+                    let hash = window.location.hash;
+                    hash = hash.replace('tc.startBound=0', 'tc.startBound=222')
+                        .replace('tc.endBound=1', 'tc.endBound=333');
+                    window.location.hash = hash;
+                }).then(() => {
+                    let bounds = openmct.time.bounds();
+
+                    expect(bounds).toBeDefined();
+                    expect(bounds.start).toBe(222);
+                    expect(bounds.end).toBe(333);
+                });
+            });
+            it("bounds are correctly set in the API from the URL parameters where only the end bound changes", () => {
+                let resolveFunction;
+
+                expectLocationToBeInFixedMode();
+
+                return new Promise((resolve) => {
+                    resolveFunction = resolve;
+                    openmct.time.on('bounds', resolveFunction);
+                    let hash = window.location.hash;
+                    hash = hash.replace('tc.endBound=1', 'tc.endBound=333');
+                    window.location.hash = hash;
+                }).then(() => {
+                    let bounds = openmct.time.bounds();
+
+                    expect(bounds).toBeDefined();
+                    expect(bounds.start).toBe(0);
+                    expect(bounds.end).toBe(333);
+                });
+            });
+        });
+    });
+
+    function setRealtimeLocationParameters() {
+        let hash = window.location.hash.toString()
+            .replace('tc.mode=fixed', 'tc.mode=local')
+            .replace('tc.startBound=0', 'tc.startDelta=1000')
+            .replace('tc.endBound=1', 'tc.endDelta=100');
+
+        window.location.hash = hash;
+    }
+
+    function setFixedLocationParameters() {
+        let hash = window.location.hash.toString()
+            .replace('tc.mode=local', 'tc.mode=fixed')
+            .replace('tc.timeSystem=utc', 'tc.timeSystem=local')
+            .replace('tc.startDelta=1000', 'tc.startBound=50')
+            .replace('tc.endDelta=100', 'tc.endBound=60');
+
+        window.location.hash = hash;
+    }
+
+    function switchToRealtimeMode() {
+        let resolveFunction;
+        return new Promise((resolve) => {
+            resolveFunction = resolve;
+            openmct.time.on('clock', resolveFunction);
+            setRealtimeLocationParameters();
+        }).then(() => {
+            openmct.time.off('clock', resolveFunction);
+        });
+    }
+
+    function switchToFixedMode() {
+        let resolveFunction;
+        return new Promise((resolve) => {
+            resolveFunction = resolve;
+            //The 'hashchange' event appears to be asynchronous, so we need to wait until a clock change has been
+            //detected in the API.
+            openmct.time.on('clock', resolveFunction);
+            setFixedLocationParameters();
+        }).then(() => {
+            openmct.time.off('clock', resolveFunction);
+        });
+    }
+
+    function expectLocationToBeInRealtimeMode() {
+        expect(window.location.hash.includes('tc.mode=local')).toBe(true);
+        expect(window.location.hash.includes('tc.startDelta=1000')).toBe(true);
+        expect(window.location.hash.includes('tc.endDelta=100')).toBe(true);
+        expect(window.location.hash.includes('tc.mode=fixed')).toBe(false);
+    }
+
+    function expectLocationToBeInFixedMode() {
+        expect(window.location.hash.includes('tc.mode=fixed')).toBe(true);
+        expect(window.location.hash.includes('tc.startBound=0')).toBe(true);
+        expect(window.location.hash.includes('tc.endBound=1')).toBe(true);
+        expect(window.location.hash.includes('tc.mode=local')).toBe(false);
+    }
+});