Skip to content

Commit

Permalink
[Gauge Plugin] Fix Missing Object handling (#7923)
Browse files Browse the repository at this point in the history
* checking if the metadata exists before acting on it

* added a test to catch missing object errors in gauges

* remove waitForTimeout and add in check for time conductor successful start offset update

* hardening the test by checking for the time before the time change

* add "pageerror" to cspell
  • Loading branch information
jvigliotta authored Dec 3, 2024
1 parent ea9947c commit ba4d8a4
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,8 @@
"countup",
"darkmatter",
"Undeletes",
"SSSZ"
"SSSZ",
"pageerror"
],
"dictionaries": ["npm", "softwareTerms", "node", "html", "css", "bash", "en_US", "en-gb", "misc"],
"ignorePaths": [
Expand Down
55 changes: 54 additions & 1 deletion e2e/tests/functional/plugins/gauge/gauge.e2e.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ import { v4 as uuid } from 'uuid';

import {
createDomainObjectWithDefaults,
createExampleTelemetryObject
createExampleTelemetryObject,
setRealTimeMode,
setStartOffset
} from '../../../../appActions.js';
import { expect, test } from '../../../../pluginFixtures.js';

Expand Down Expand Up @@ -166,6 +168,57 @@ test.describe('Gauge', () => {
);
});

test('Gauge does not break when an object is missing', async ({ page }) => {
// Set up error listeners
const pageErrors = [];

// Listen for uncaught exceptions
page.on('pageerror', (err) => {
pageErrors.push(err.message);
});

await setRealTimeMode(page);

// Create a Gauge
const gauge = await createDomainObjectWithDefaults(page, {
type: 'Gauge',
name: 'Gauge with missing object'
});

// Create a Sine Wave Generator in the Gauge with a loading delay
const missingSWG = await createExampleTelemetryObject(page, gauge.uuid);

// Remove the object from local storage
await page.evaluate(
([missingObject]) => {
const mct = localStorage.getItem('mct');
const mctObjects = JSON.parse(mct);
delete mctObjects[missingObject.uuid];
localStorage.setItem('mct', JSON.stringify(mctObjects));
},
[missingSWG]
);

// Verify start bounds
await expect(page.getByLabel('Start offset: 00:30:00')).toBeVisible();

// Nav to the Gauge
await page.goto(gauge.url, { waitUntil: 'domcontentloaded' });

// adjust time bounds and ensure they are updated
await setStartOffset(page, {
startHours: '00',
startMins: '45',
startSecs: '00'
});

// Verify start bounds changed
await expect(page.getByLabel('Start offset: 00:45:00')).toBeVisible();

// // Verify no errors were thrown
expect(pageErrors).toHaveLength(0);
});

test('Gauge enforces composition policy', async ({ page }) => {
// Create a Gauge
await createDomainObjectWithDefaults(page, {
Expand Down
5 changes: 5 additions & 0 deletions src/plugins/gauge/components/GaugeComponent.vue
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,11 @@ export default {
},
request(domainObject = this.telemetryObject) {
this.metadata = this.openmct.telemetry.getMetadata(domainObject);

if (!this.metadata) {
return;
}

this.formats = this.openmct.telemetry.getFormatMap(this.metadata);
const LimitEvaluator = this.openmct.telemetry.getLimits(domainObject);
LimitEvaluator.limits().then(this.updateLimits);
Expand Down

0 comments on commit ba4d8a4

Please sign in to comment.