fix(#7670): Ensure objects unsubscribe from staleness when destroyed

e2e/appActions.js

@@ -101,8 +101,19 @@ async function createDomainObjectWithDefaults(
   // If there are any further parameters, fill them in
   for (const [key, value] of Object.entries(customParameters)) {
     const input = page.locator(`form[name="mctForm"] ${key}`);
-    await input.fill('');
-    await input.fill(value);
+    const inputType = await input.getAttribute('type');
+
+    if (inputType === 'checkbox') {
+      // Locate the slider span associated with the checkbox
+      const slider = input.locator('+ .c-toggle-switch__slider');
+      const isChecked = await input.isChecked();
+      if ((value === 'true' && !isChecked) || (value === 'false' && isChecked)) {
+        await slider.click();
+      }
+    } else {
+      await input.fill('');
+      await input.fill(value);
+    }
   }
 
   // Click OK button and wait for Navigate event

e2e/tests/functional/staleness.e2e.spec.js

@@ -0,0 +1,63 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2023, 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 { createDomainObjectWithDefaults, navigateToObjectWithRealTime } from '../../appActions.js';
+import { expect, test } from '../../pluginFixtures.js';
+
+test.describe('Staleness', () => {
+  test.beforeEach(async ({ page }) => {
+    await page.goto('./', { waitUntil: 'domcontentloaded' });
+  });
+
+  test('Does not show staleness after navigating from a stale object', async ({ page }) => {
+    const objectViewSelector = '.c-object-view';
+    const isStaleClass = 'is-stale';
+    const staleSWG = await createDomainObjectWithDefaults(page, {
+      type: 'Sine Wave Generator',
+      name: 'SWG',
+      parent: 'mine',
+      customParameters: {
+        'label:has([aria-label="Provide Staleness Updates"]) > input': 'true'
+      }
+    });
+    const folder = await createDomainObjectWithDefaults(page, {
+      type: 'Folder',
+      name: 'Folder 1'
+    });
+
+    // Navigate to the stale object
+    await navigateToObjectWithRealTime(page, staleSWG.url);
+
+    // Wait for staleness to be updated
+    await page.waitForSelector(`.${isStaleClass}`, { state: 'attached' });
+
+    // Immediately navigate to the folder
+    await page.goto(folder.url);
+
+    // Verify that staleness is not shown
+    const objectView = page.locator(objectViewSelector);
+    const containsStaleClass = await objectView.evaluate((node, staleClass) => {
+      return node.classList.contains(staleClass);
+    }, isStaleClass);
+    await expect(containsStaleClass).toBeFalsy();
+  });
+});

example/generator/SinewaveStalenessProvider.js

@@ -26,15 +26,13 @@ export default class SinewaveLimitProvider extends EventEmitter {
   #openmct;
   #observingStaleness;
   #watchingTheClock;
-  #isRealTime;
 
   constructor(openmct) {
     super();
 
     this.#openmct = openmct;
     this.#observingStaleness = {};
     this.#watchingTheClock = false;
-    this.#isRealTime = undefined;
   }
 
   supportsStaleness(domainObject) {
@@ -61,10 +59,7 @@ export default class SinewaveLimitProvider extends EventEmitter {
   subscribeToStaleness(domainObject, callback) {
     const id = this.#getObjectKeyString(domainObject);
 
-    if (this.#isRealTime === undefined) {
-      this.#updateRealTime(this.#openmct.time.getMode());
-    }
-
+    this.#realtimeCheck();
     this.#handleClockUpdate();
 
     if (this.#observerExists(id)) {
@@ -92,17 +87,15 @@ export default class SinewaveLimitProvider extends EventEmitter {
 
     if (observers && !this.#watchingTheClock) {
       this.#watchingTheClock = true;
-      this.#openmct.time.on('modeChanged', this.#updateRealTime, this);
+      this.#openmct.time.on('modeChanged', this.#realtimeCheck, this);
     } else if (!observers && this.#watchingTheClock) {
       this.#watchingTheClock = false;
-      this.#openmct.time.off('modeChanged', this.#updateRealTime, this);
+      this.#openmct.time.off('modeChanged', this.#realtimeCheck, this);
     }
   }
 
-  #updateRealTime(mode) {
-    this.#isRealTime = mode !== 'fixed';
-
-    if (!this.#isRealTime) {
+  #realtimeCheck() {
+    if (!this.#openmct.time.isRealTime()) {
       Object.keys(this.#observingStaleness).forEach((id) => {
         this.#updateStaleness(id, false);
       });
@@ -140,7 +133,7 @@ export default class SinewaveLimitProvider extends EventEmitter {
   }
 
   #providingStaleness(domainObject) {
-    return domainObject.telemetry?.staleness === true && this.#isRealTime;
+    return domainObject.telemetry?.staleness === true && this.#openmct.time.isRealTime();
   }
 
   #getObjectKeyString(object) {

src/ui/components/ObjectView.vue

@@ -352,6 +352,10 @@ export default {
     show(object, viewKey, immediatelySelect, currentObjectPath) {
       this.updateStyle();
 
+      if (this.domainObject) {
+        this.triggerUnsubscribeFromStaleness(this.domainObject);
+      }
+
       if (this.removeSelectable) {
         this.removeSelectable();
         delete this.removeSelectable;