Adding abort signal for object and telemetry requests (#58)

Bump to rc1 Co-authored-by: David Tsay <[email protected]>
NASA-AMMOS · Jul 7, 2023 · 6eaa524 · 6eaa524
1 parent e00c1be
commit 6eaa524
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 26 deletions.
diff --git a/package.json b/package.json
@@ -31,7 +31,7 @@
     "mini-css-extract-plugin": "2.6.0",
     "moment": "2.29.4",
     "node-bourbon": "^4.2.3",
-    "openmct": "nasa/openmct#omm-r5.1.0-rc2",
+    "openmct": "nasa/openmct#omm-r5.1.0-rc3",
     "openmct-legacy-support": "akhenry/openmct-legacy-support#omm-r5.1.0-rc1",
     "printj": "^1.2.1",
     "raw-loader": "^0.5.1",

diff --git a/src/historical/HistoricalProvider.js b/src/historical/HistoricalProvider.js
@@ -34,6 +34,7 @@ define([
         batchRequest: function (batch) {
             const requests = _.values(batch.requestsById);
             const params = requests[0].params;
+            const options = requests[0].options;
 
             params.lad_type = params.sort;
             params.select = '(dn,eu,channel_id,ert,scet,sclk,lst,record_type,dn_alarm_state,eu_alarm_state,module,realtime,dss_id)'
@@ -51,7 +52,7 @@ define([
                 requestURL = ladURL;
             }
 
-            mcws.dataTable(requestURL)
+            mcws.dataTable(requestURL, { signal: options.signal })
                 .read(params)
                 .then(function (res) {
                     const valuesByChannelId = _.groupBy(res, 'channel_id');
@@ -89,6 +90,7 @@ define([
         batchRequest: function (batch) {
             const requests = _.values(batch.requestsById);
             const params = requests[0].params;
+            const options = requests[0].options;
 
             params.minmax = '(' +
                 [
@@ -101,7 +103,7 @@ define([
             params.filter.channel_id__in = _.map(requests, 'domainObject.telemetry.channel_id');
             setSortFilter(params);
 
-            mcws.dataTable(requests[0].domainObject.telemetry.channelMinMaxUrl)
+            mcws.dataTable(requests[0].domainObject.telemetry.channelMinMaxUrl, { signal: options.signal })
                 .read(params)
                 .then(function (res) {
                     const valuesByChannelId = _.groupBy(res, 'channel_id');
@@ -167,7 +169,7 @@ define([
 
             setSortFilter(params);
 
-            return mcws.dataTable(url)
+            return mcws.dataTable(url, { signal: options.signal })
                 .read(params);
         }
     }, {
@@ -180,7 +182,7 @@ define([
             setMaxResults(domainObject, options, params);
             setSortFilter(params);
 
-            const promise = mcws.dataTable(domainObject.telemetry.dataProductUrl)
+            const promise = mcws.dataTable(domainObject.telemetry.dataProductUrl, { signal: options.signal })
                 .read(params);
 
             if (domainObject.type === 'vista.dataProducts') {
@@ -229,7 +231,7 @@ define([
                     domainObject.telemetry.alarmLevel.toUpperCase();
             }
 
-            const dataTable = mcws.dataTable(domainObject.telemetry.channelHistoricalUrl);
+            const dataTable = mcws.dataTable(domainObject.telemetry.channelHistoricalUrl, { signal: options.signal });
 
             return Promise.all([
                 dataTable.read(dnQueryParams),
@@ -258,7 +260,7 @@ define([
             delete params.filter[options.domain + '__gte'];
             delete params.filter[options.domain + '__lte'];
 
-            return mcws.dataTable(domainObject.telemetry.commandEventUrl)
+            return mcws.dataTable(domainObject.telemetry.commandEventUrl, { signal: options.signal })
                 .read(params)
                 .then(function (res) {
                     return res;
@@ -279,7 +281,7 @@ define([
             setMaxResults(domainObject, options, params);
             setSortFilter(params);
 
-            return mcws.dataTable(domainObject.telemetry.channelHistoricalUrl)
+            return mcws.dataTable(domainObject.telemetry.channelHistoricalUrl, { signal: options.signal })
                 .read(params);
         }
     }];
@@ -301,7 +303,7 @@ define([
             params.filter.channel_id__in = _.map(requests, 'domainObject.telemetry.channel_id');
             setSortFilter(params);
 
-            mcws.dataTable(requests[0].domainObject.telemetry.channelHistoricalUrl)
+            mcws.dataTable(requests[0].domainObject.telemetry.channelHistoricalUrl, { signal: options.signal })
                 .read(params)
                 .then(function (res) {
                     const valuesByChannelId = _.groupBy(res, 'channel_id');
@@ -323,7 +325,7 @@ define([
             setSortFilter(params);
             setMaxResults(domainObject, options, params);
 
-            return mcws.dataTable(domainObject.telemetry.channelHistoricalUrl)
+            return mcws.dataTable(domainObject.telemetry.channelHistoricalUrl, { signal: options.signal })
                 .read(params);
         }
     };

diff --git a/src/persistence/MCWSPersistenceProvider.js b/src/persistence/MCWSPersistenceProvider.js
@@ -79,6 +79,7 @@ export default class MCWSPersistenceProvider {
      */
     async get(identifier, abortSignal) {
         const { key, namespace } = identifier;
+        const options = {};
 
         // check if it is a namespace that has subnamespaces, if so, we return this item dynamically
         if (identifier.key === 'container') {
@@ -91,7 +92,11 @@ export default class MCWSPersistenceProvider {
             return createModelFromNamespaceDefinition('system', containerNamespace, containedNamespaceIdentifiers);
         }
 
-        const persistenceNamespace = await this.#getNamespace(namespace);
+        if (abortSignal) {
+            options.signal = abortSignal;
+        }
+
+        const persistenceNamespace = await this.#getNamespace(namespace, options);
 
         try {
             let result = await persistenceNamespace.opaqueFile(key).read();
@@ -146,13 +151,13 @@ export default class MCWSPersistenceProvider {
         return domainObject;
     }
 
-    async #getNamespace(persistenceSpace) {
+    async #getNamespace(persistenceSpace, options) {
         const persistenceNamespaces = await this.getPersistenceNamespaces();
         const persistenceNamespace = persistenceNamespaces.find((namespace) => {
             return namespace.key === persistenceSpace;
         })
 
-        return mcws.namespace(persistenceNamespace.url);
+        return mcws.namespace(persistenceNamespace.url, options);
     }
 
     /**

diff --git a/src/services/mcws/DataTableMIO.js b/src/services/mcws/DataTableMIO.js
@@ -17,9 +17,10 @@ import MIO from './MIO';
  */
 
 class DataTableMIO extends MIO {
-    constructor(url) {
+    constructor(url, options) {
         super(url);
 
+        this.options = options;
         this.type = 'datatable';
     }
 

diff --git a/src/services/mcws/MIO.js b/src/services/mcws/MIO.js
@@ -74,7 +74,17 @@ export default class MIO {
             options.body = JSON.stringify(body);
         }
 
-        return mcwsClient.request(options);
+        if (this.options?.signal) {
+            options.signal = this.options.signal;
+        }
+
+        return mcwsClient.request(options)
+            .catch(error => {
+                // suppress abort errors
+                if (error.name !== 'AbortError') {
+                    throw error;
+                }
+            });
     }
 
     async getMetadata() {

diff --git a/src/services/mcws/NamespaceMIO.js b/src/services/mcws/NamespaceMIO.js
@@ -14,9 +14,10 @@ import DataTableMIO from './DataTableMIO';
  * @augments MIO
  */
 class NamespaceMIO extends MIO {
-    constructor(url) {
+    constructor(url, options) {
         super(url);
 
+        this.options = options;
         this.type = 'namespace';
     }
 
@@ -46,7 +47,7 @@ class NamespaceMIO extends MIO {
      * @returns {OpaqueFileMIO} a handle to the opaque file
      */
     opaqueFile(name) {
-        return new OpaqueFileMIO(`${this.url}/${name}`);
+        return new OpaqueFileMIO(`${this.url}/${name}`, this.options);
     }
 
     /**
@@ -64,7 +65,7 @@ class NamespaceMIO extends MIO {
     * @returns {NamespaceMIO} a handle to that namespace
     */
     namespace(name) {
-        return new NamespaceMIO(`${this.url}/${name}`);
+        return new NamespaceMIO(`${this.url}/${name}`, this.options);
     }
 
     /**
@@ -79,7 +80,7 @@ class NamespaceMIO extends MIO {
     * @returns {DataTableMIO} a handle to that datatable
     */
     dataTable(name) {
-        return new DataTableMIO(`${this.url}/${name}`);
+        return new DataTableMIO(`${this.url}/${name}`, this.options);
     }
 
     /**

diff --git a/src/services/mcws/OpaqueFileMIO.js b/src/services/mcws/OpaqueFileMIO.js
@@ -17,9 +17,10 @@ import MIO from './MIO';
  */
 
 class OpaqueFileMIO extends MIO {
-    constructor(url) {
+    constructor(url, options) {
         super(url);
 
+        this.options = options;
         this.type = 'opaque_file';
     }
 

diff --git a/src/services/mcws/mcws.js b/src/services/mcws/mcws.js
@@ -12,16 +12,16 @@ class MCWS {
         client.configure(config);
     }
 
-    namespace(name) {
-        return new NamespaceMIO(name);
+    namespace(name, options) {
+        return new NamespaceMIO(name, options);
     }
 
-    dataTable(name) {
-        return new DataTableMIO(name);
+    dataTable(name, options) {
+        return new DataTableMIO(name, options);
     }
 
-    opaqueFile(name) {
-        return new OpaqueFileMIO(name);
+    opaqueFile(name, options) {
+        return new OpaqueFileMIO(name, options);
     }
 }