@saber-usa/node-common 1.7.5 → 1.7.6

package/README.md

@@ -1,42 +1,42 @@
-# Saber Common node functions
-
-The contains common node functions used across saber applications
-
-## Logger
-
-The logger component is a standard logger based on [winston](https://github.com/winstonjs/winston). The logger factory
-creates a default console logger for errors along with exception/rejection catching. By setting the `CONSOLE_LOG` 
-variable to `true` will turn on the console logger for local development. The log level is configured by the `LOG_LEVEL`
-environment variable to one of the following levels: `emerg`, `alert`, `crit`, `error`, `warning`, `warn`, `notice`, 
-`info`, `debug` (default level is `error`). The reason using an environment variable for the level is useful when 
-deployed to the server. Changing the environment variable is easier than setting a new flag in the script execution.
-
-### Usage
-
-To create a new logger, just pass in options to the factory:
-
-```javascript
-const logger = loggerFactory(opts);
-
-logger.debug("This is a debug message");
-```
-
-For further usage, consult [winston](https://github.com/winstonjs/winston)
-
-### Options
-
-- `nameSpace` help distinguish where the logger message comes from.
-- `additionalData` Data to include with each message 
-- `level` overwrite the `LOG_LEVEL` environment level
-
-## Transformer
-
-A transformer for object keys is provided. This will take an object and transform the keys using a function. 
-
-## Publishing changes
-
-1. Change the version in package.json
-2. Run `npm publish && npm install`
-3. Enable GPG in GIT: `git config --global commit.gpgsign true`
-4. Run `gpg --list-keys` to get your <id> 
+# Saber Common node functions
+
+The contains common node functions used across saber applications
+
+## Logger
+
+The logger component is a standard logger based on [winston](https://github.com/winstonjs/winston). The logger factory
+creates a default console logger for errors along with exception/rejection catching. By setting the `CONSOLE_LOG` 
+variable to `true` will turn on the console logger for local development. The log level is configured by the `LOG_LEVEL`
+environment variable to one of the following levels: `emerg`, `alert`, `crit`, `error`, `warning`, `warn`, `notice`, 
+`info`, `debug` (default level is `error`). The reason using an environment variable for the level is useful when 
+deployed to the server. Changing the environment variable is easier than setting a new flag in the script execution.
+
+### Usage
+
+To create a new logger, just pass in options to the factory:
+
+```javascript
+const logger = loggerFactory(opts);
+
+logger.debug("This is a debug message");
+```
+
+For further usage, consult [winston](https://github.com/winstonjs/winston)
+
+### Options
+
+- `nameSpace` help distinguish where the logger message comes from.
+- `additionalData` Data to include with each message 
+- `level` overwrite the `LOG_LEVEL` environment level
+
+## Transformer
+
+A transformer for object keys is provided. This will take an object and transform the keys using a function. 
+
+## Publishing changes
+
+1. Change the version in package.json
+2. Run `npm publish && npm install`
+3. Enable GPG in GIT: `git config --global commit.gpgsign true`
+4. Run `gpg --list-keys` to get your <id> 
 5. Tell the GIT to use your key `git config user.signingkey <id>`

package/package.json

@@ -1,51 +1,51 @@
-{
-  "name": "@saber-usa/node-common",
-  "version": "1.7.5",
-  "description": "Common node functions for Saber",
-  "main": "src/index.js",
-  "type": "module",
-  "scripts": {
-    "lint": "eslint . --ext js",
-    "lint:fix": "eslint . --ext js --fix",
-    "test": "jest --no-coverage --silent",
-    "test:unit": "jest --coverage --runInBand --no-watch",
-    "sonar": "node --experimental-vm-modules sonar-project.js"
-  },
-  "files": [
-    "src/**/*"
-  ],
-  "author": "Saber USA",
-  "license": "ISC",
-  "dependencies": {
-    "@aws-sdk/client-s3": "^3.666.0",
-    "date-fns": "^4.1.0",
-    "lodash": "4.17.21",
-    "mathjs": "^14.7.0",
-    "pious-squid": "^2.3.0",
-    "plotly": "^1.0.6",
-    "satellite.js": "^6.0.1",
-    "solar-calculator": "^0.3.0",
-    "three": "^0.178.0",
-    "winston": "3.3.3"
-  },
-  "devDependencies": {
-    "@babel/core": "7.16.0",
-    "@babel/eslint-parser": "7.16.3",
-    "@babel/plugin-transform-modules-commonjs": "7.16.0",
-    "@jest/globals": "27.4.4",
-    "eslint-config-google": "0.14.0",
-    "eslint-plugin-jest": "25.3.0",
-    "jest": "29.7.0",
-    "jest-diff": "29.7.0",
-    "nodemon": "3.1.4",
-    "sonarqube-scanner": "3.0.1"
-  },
-  "overrides": {
-    "braces": "3.0.3"
-  },
-  "babel": {
-    "plugins": [
-      "@babel/plugin-transform-modules-commonjs"
-    ]
-  }
-}
+{
+  "name": "@saber-usa/node-common",
+  "version": "1.7.6",
+  "description": "Common node functions for Saber",
+  "main": "src/index.js",
+  "type": "module",
+  "scripts": {
+    "lint": "eslint . --ext js",
+    "lint:fix": "eslint . --ext js --fix",
+    "test": "jest --no-coverage --silent",
+    "test:unit": "jest --coverage --runInBand --no-watch",
+    "sonar": "node --experimental-vm-modules sonar-project.js"
+  },
+  "files": [
+    "src/**/*"
+  ],
+  "author": "Saber USA",
+  "license": "ISC",
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.666.0",
+    "date-fns": "^4.1.0",
+    "lodash": "4.17.21",
+    "mathjs": "^14.7.0",
+    "pious-squid": "^2.3.0",
+    "plotly": "^1.0.6",
+    "satellite.js": "^6.0.1",
+    "solar-calculator": "^0.3.0",
+    "three": "^0.178.0",
+    "winston": "3.3.3"
+  },
+  "devDependencies": {
+    "@babel/core": "7.16.0",
+    "@babel/eslint-parser": "7.16.3",
+    "@babel/plugin-transform-modules-commonjs": "7.16.0",
+    "@jest/globals": "27.4.4",
+    "eslint-config-google": "0.14.0",
+    "eslint-plugin-jest": "25.3.0",
+    "jest": "29.7.0",
+    "jest-diff": "29.7.0",
+    "nodemon": "3.1.4",
+    "sonarqube-scanner": "3.0.1"
+  },
+  "overrides": {
+    "braces": "3.0.3"
+  },
+  "babel": {
+    "plugins": [
+      "@babel/plugin-transform-modules-commonjs"
+    ]
+  }
+}

package/src/LaunchNominalClass.js

@@ -21,8 +21,6 @@ const ReferenceFrame = {
 };
 
 class LaunchNominalClass {
-    
-
     /** Get position at a given time in specified reference frame
      *
      * @param {Date} utc - UTC time

package/src/astro.js

@@ -42,7 +42,8 @@ import {DEG2RAD,
     WGS72_EARTH_EQUATORIAL_RADIUS_KM,
     WGS84_EARTH_EQUATORIAL_RADIUS_KM,
     MILLIS_PER_DAY,
-    GEO_ALTITUDE_KM} from "./constants.js";
+    GEO_ALTITUDE_KM,
+    ERROR_CODES} from "./constants.js";
 
 // Solar Terminator
 // Returns sun latitude and longitude as -180/180
@@ -74,6 +75,98 @@ const checkTle = (line1, line2) => {
     }
 };
 
+/**
+ * Validates the output of the satellite.js propagate function.
+ * The satellite.js propagate function returns a object with the following properties:
+ * - position: {x: number, y: number, z: number}
+ * - velocity: {x: number, y: number, z: number}
+ * - meanElements: {am: number, em: number, im: number, Om: number, om: number, nm: number, mm: number}
+ *
+ * When propgation fails, the output is null. However, there are cases where the output is not null, but the position and velocity are NaN.
+ * This happens when the input satrec is invalid or malformed due to a bad TLE, in some way. This is rare, and hard to reproduce.
+ *
+ * This function takes into account those rare cases as part of the validation.
+ *
+ * @param {Object} out The output of the satellite.js propagate function.
+ * @return {boolean} true if the propagation output is valid, false otherwise
+ */
+const isPropagateValid = (out) => {
+    if (out === null || out === undefined) {
+        return false;
+    }
+
+    if (out.position) {
+        const pos = out.position;
+        if (pos.x === null || pos.x === undefined || Number.isNaN(pos.x)
+            || pos.y === null || pos.y === undefined || Number.isNaN(pos.y)
+            || pos.z === null || pos.z === undefined || Number.isNaN(pos.z)) {
+            return false;
+        }
+    }
+
+    if (out.velocity) {
+        const vel = out.velocity;
+        if (vel.x === null || vel.x === undefined || Number.isNaN(vel.x)
+            || vel.y === null || vel.y === undefined || Number.isNaN(vel.y)
+            || vel.z === null || vel.z === undefined || Number.isNaN(vel.z)) {
+            return false;
+        }
+    }
+
+    return true;
+};
+
+/** A function that attempts to propagate a satellite record to a given time, and returns a standardized output object.
+ *
+ * @param {Object} satrec The satellite record from satellite.js
+ * @param {Date} time The time to propagate the satellite to
+ * @return {Object} An object with the following properties:
+ * - ok: 0 or 1
+ * - err: null or an error message
+ * - out: null or the output of the satellite.js propagate function
+ */
+const tryPropagateSatrec = (satrec, time) => {
+    // Validate time
+    if (!time || !(time instanceof Date)) {
+        return {
+            ok: 0,
+            err: ERROR_CODES.INVALID_TIME_INPUT,
+            out: null,
+        };
+    }
+    // Validate satrec
+    if (!satrec) {
+        return {
+            ok: 0,
+            err: ERROR_CODES.INVALID_SATELLITE_RECORD,
+            out: null,
+        };
+    }
+    // Propagate
+    try {
+        const out = propagate(satrec, time);
+        // Validate propagate output
+        if (!isPropagateValid(out)) {
+            return {
+                ok: 0,
+                err: ERROR_CODES.INVALID_PROPAGATE_OUTPUT + `: ${satrec.error}`,
+                out: null,
+            };
+        }
+        return {
+            ok: 1,
+            err: null,
+            out: out,
+        };
+    } catch (e) {
+        return {
+            ok: 0,
+            err: ERROR_CODES.INVALID_PROPAGATE_OUTPUT + `: ${e.message}`,
+            out: null,
+        };
+    }
+};
+
 /**
  * Calculates the semi-major axis in kilometers from a satellite record.
  * @param {Object} satrec The satellite record from satellite.js
@@ -3209,6 +3302,7 @@ export {REGIMES,
     getRaanDetails,
     isSatInShadow,
     calculateGeoCrossingTimes,
+    tryPropagateSatrec,
 };
 export const raDecToGeodetic = RaDecToGeodetic;
 export const getResiduals = GetResiduals;

package/src/checkNetwork.cjs

@@ -1,20 +1,20 @@
-const _ = require("lodash");
-const {resolve4} = require("dns").promises;
-
-
-const checkRecord = (hostName) => resolve4(hostName).
-    then((addresss) => !_.isEmpty(addresss)).
-    catch(_.stubFalse);
-
-
-module.exports.checkRecord = checkRecord;
-module.exports.checkNetwork = (domains) => Promise.all(
-    _.map(
-        domains,
-        (hostName) => checkRecord(hostName).
-            then((found) => found
-                ? hostName
-                : null,
-            ),
-    ),
-).then((resolved) => _.flow(_.compact, _.first)(resolved) || null);
+const _ = require("lodash");
+const {resolve4} = require("dns").promises;
+
+
+const checkRecord = (hostName) => resolve4(hostName).
+    then((addresss) => !_.isEmpty(addresss)).
+    catch(_.stubFalse);
+
+
+module.exports.checkRecord = checkRecord;
+module.exports.checkNetwork = (domains) => Promise.all(
+    _.map(
+        domains,
+        (hostName) => checkRecord(hostName).
+            then((found) => found
+                ? hostName
+                : null,
+            ),
+    ),
+).then((resolved) => _.flow(_.compact, _.first)(resolved) || null);

package/src/constants.js

@@ -28,3 +28,8 @@ export const REGIMES = {
     GeoDrifter: 512,
 };
 
+export const ERROR_CODES = {
+    INVALID_TIME_INPUT: "Invalid time input",
+    INVALID_SATELLITE_RECORD: "Invalid satellite record",
+    INVALID_PROPAGATE_OUTPUT: "Invalid propagate output",
+};

package/src/loggerFactory.cjs

@@ -1,98 +1,98 @@
-const winston = require("winston");
-const {
-    createLogger,
-    format,
-    transports,
-} = winston;
-const cj = (data) => Object.keys(data).length > 0
-    ? JSON.stringify(data, null, 2)
-    : null;
-
-const isTest = process.env.NODE_ENV === "test";
-
-const defaultLogger = new transports.Console({
-    silent: isTest,
-    level: "warn",
-    format: format.errors({stack: true}),
-    timestamp: true,
-});
-
-const errorLogger = new transports.Console({
-    silent: isTest,
-    format: format.errors({stack: true}),
-});
-
-/**
- * Creates a logger
- *
- * @param {String} nameSpace Namespace for the logger
- * @param {Object} additionalData additional data to include with logging
- * @param {string} level Default logging level to set (overwrites environment setting)
- * @return {winston.Logger}
- */
-module.exports.loggerFactory = ({
-    nameSpace = "saber",
-    additionalData = {},
-    level,
-} = {}) => {
-    const logLevel = process.env.LOG_LEVEL || "warn";
-    const isConsole = !!(process.env.CONSOLE_LOG);
-
-    const loggerTransport = isConsole
-        ? new transports.Console({
-            defaultMeta: additionalData,
-            level: level || logLevel,
-            format: format.combine(
-                format.errors({stack: true}),
-                format.cli(),
-                // eslint-disable-next-line max-len
-                format.printf(({
-                    level,
-                    message,
-                    nameSpace,
-                    stack,
-                    ...rest
-                }) =>
-                    [
-                        level,
-                        `[${nameSpace}]`,
-                        ":",
-                        message,
-                        stack,
-                        cj(rest),
-                    ].filter((value) => !!value)
-                        .join(" "),
-                ),
-            ),
-        })
-        : defaultLogger;
-
-    const config = {
-        levels: {
-            // RFC5424
-            emerg: 0,
-            alert: 1,
-            crit: 2,
-            error: 3,
-            warning: 4,
-            notice: 5,
-            info: 6,
-            debug: 7,
-            // npm levels
-            warn: 4,
-            verbose: 6,
-            silly: 8,
-        },
-        exitOnError: false,
-        transports: [loggerTransport],
-        // Console logger from above will log errors
-        exceptionHandlers: !isConsole ? [errorLogger] : [],
-        rejectionHandlers: !isConsole ? [errorLogger] : [],
-    };
-
-    return createLogger(config)
-        .child({
-            ...additionalData,
-            nameSpace: nameSpace,
-        });
-}
+const winston = require("winston");
+const {
+    createLogger,
+    format,
+    transports,
+} = winston;
+const cj = (data) => Object.keys(data).length > 0
+    ? JSON.stringify(data, null, 2)
+    : null;
+
+const isTest = process.env.NODE_ENV === "test";
+
+const defaultLogger = new transports.Console({
+    silent: isTest,
+    level: "warn",
+    format: format.errors({stack: true}),
+    timestamp: true,
+});
+
+const errorLogger = new transports.Console({
+    silent: isTest,
+    format: format.errors({stack: true}),
+});
+
+/**
+ * Creates a logger
+ *
+ * @param {String} nameSpace Namespace for the logger
+ * @param {Object} additionalData additional data to include with logging
+ * @param {string} level Default logging level to set (overwrites environment setting)
+ * @return {winston.Logger}
+ */
+module.exports.loggerFactory = ({
+    nameSpace = "saber",
+    additionalData = {},
+    level,
+} = {}) => {
+    const logLevel = process.env.LOG_LEVEL || "warn";
+    const isConsole = !!(process.env.CONSOLE_LOG);
+
+    const loggerTransport = isConsole
+        ? new transports.Console({
+            defaultMeta: additionalData,
+            level: level || logLevel,
+            format: format.combine(
+                format.errors({stack: true}),
+                format.cli(),
+                // eslint-disable-next-line max-len
+                format.printf(({
+                    level,
+                    message,
+                    nameSpace,
+                    stack,
+                    ...rest
+                }) =>
+                    [
+                        level,
+                        `[${nameSpace}]`,
+                        ":",
+                        message,
+                        stack,
+                        cj(rest),
+                    ].filter((value) => !!value)
+                        .join(" "),
+                ),
+            ),
+        })
+        : defaultLogger;
+
+    const config = {
+        levels: {
+            // RFC5424
+            emerg: 0,
+            alert: 1,
+            crit: 2,
+            error: 3,
+            warning: 4,
+            notice: 5,
+            info: 6,
+            debug: 7,
+            // npm levels
+            warn: 4,
+            verbose: 6,
+            silly: 8,
+        },
+        exitOnError: false,
+        transports: [loggerTransport],
+        // Console logger from above will log errors
+        exceptionHandlers: !isConsole ? [errorLogger] : [],
+        rejectionHandlers: !isConsole ? [errorLogger] : [],
+    };
+
+    return createLogger(config)
+        .child({
+            ...additionalData,
+            nameSpace: nameSpace,
+        });
+}