@saber-usa/node-common 1.7.8 → 1.7.9-alpha.2

package/README.md

@@ -1,43 +1,13 @@
-# Saber Common node functions
+# Node Common
 
-The contains common node functions used across saber applications
+Common nodejs functions used across a number of saber's 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. 
+## License
+AGPLv3
 
 ## Publishing changes
 
-1. Change the version in package.json
-2. Check you are logged in to npm `npm whoami`
-2. Run `npm install` then `npm publish`
-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>`
+1. Increment the version in `package.json`
+2. Check you are logged in to npm using `npm whoami`
+3. You may need to login using `npm login` note your npm user must have 2FA enabled (in your profile)
+4. Run `npm install` then `npm publish`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saber-usa/node-common",
-  "version": "1.7.8",
+  "version": "1.7.9-alpha.2",
   "description": "Common node functions for Saber",
   "main": "src/index.js",
   "type": "module",

package/src/astro.js

@@ -1703,7 +1703,7 @@ const getLeoRpoData = (line1, line2, sats, startTime, endTime) => {
         Line2: line2,
     };
     const pEphem = prop(pElset, start, end, 10000);
-    if(pEphem.length === 0) return results; // Primary may have re-entered the atmosphere
+    if (pEphem.length === 0) return results; // Primary may have re-entered the atmosphere
 
     sats.forEach( (s) => {
         const sEphem = prop(s, start, end, 10000);
@@ -1788,8 +1788,8 @@ const getGeoRpoData = (line1, line2, sats, startTime, endTime, lonTime) => {
         Line1: line1,
         Line2: line2,
     }, start, end, 60000);
-    if(pEphem.length === 0) return results; // Primary may have re-entered the atmosphere
-    
+    if (pEphem.length === 0) return results; // Primary may have re-entered the atmosphere
+
     const lonEvalTime = lonTime ? new Date(lonTime) : new Date(end);
 
     const pLonAndDrift = getLonAndDrift(line1, line2, lonEvalTime);

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/index.js

@@ -41,7 +41,7 @@ const aggregate = {
     ...PropagateUtilsNS,
     ...ballisticPropagatorNS,
     ...NodeVector3DNS,
-    udl,
+    ...udl,
 };
 
 export default aggregate;

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,
+        });
+}

package/src/udl.js

@@ -1,5 +1,14 @@
 import {fixDate} from "./fixDate.js";
-import {calcRegime, getElsetUdlFromTle, getLonAndDrift, getRaanPrecession} from "./astro.js";
+import {
+    calcRegime,
+    getElsetUdlFromTle,
+    getLonAndDrift,
+    getRaanPrecession,
+    raDecToAzEl,
+    azElToRaDec,
+    raDecToGeodetic,
+    estimateSlantRange,
+} from "./astro.js";
 import {lowerCaseObjectKeys} from "./transform.js";
 import {isDefined} from "./utils.js";
 import _ from "lodash";
@@ -113,4 +122,114 @@ export function formatUdlData(topic, udlData) {
     }
 }
 
-export {udlToNpsElset, udlToNpsGroundSite};
+/**
+ * Enriches the Azimuth and Elevation fields of the given object, if needed.
+ *
+ * @param {object} npsOb - The object to be enriched.
+ * @param {array} enrichedFields - The array of already enriched fields.
+ * @return {array} The updated array of enriched fields.
+ */
+const enrichAzimuthAndElevation = (npsOb, enrichedFields) => {
+    const azel = raDecToAzEl(npsOb.ObTime, npsOb.Ra, npsOb.Dec, npsOb.SenLat, npsOb.SenLon);
+    const {Az, El} = azel;
+    if (Az && !npsOb.Azimuth) {
+        npsOb.Azimuth = Az;
+        enrichedFields.push("Azimuth");
+    }
+    if (El && !npsOb.Elevation) {
+        npsOb.Elevation = El;
+        enrichedFields.push("Elevation");
+    }
+    return enrichedFields;
+};
+
+/**
+ * Enriches the Ra and Dec fields of the given object, if needed.
+ *
+ * @param {object} npsOb - The object to be enriched.
+ * @param {array} enrichedFields - The array of already enriched fields.
+ * @return {array} The updated array of enriched fields.
+ */
+const enrichRaAndDec = (npsOb, enrichedFields) => {
+    const radec = azElToRaDec(
+        npsOb.ObTime,
+        npsOb.Azimuth,
+        npsOb.Elevation,
+        npsOb.SenLat,
+        npsOb.SenLon,
+    );
+    const {ra, dec} = radec;
+    if (ra && !npsOb.Ra) {
+        npsOb.Ra = ra;
+        enrichedFields.push("Ra");
+    }
+    if (dec && !npsOb.Dec) {
+        npsOb.Dec = dec;
+        enrichedFields.push("Dec");
+    }
+    return enrichedFields;
+};
+
+/**
+ * Enriches the GeoLon field of the given object, if needed.
+ *
+ * @param {object} npsOb - The object to be enriched.
+ * @param {array} enrichedFields - The array of already enriched fields.
+ * @return {array} The updated array of enriched fields.
+ */
+const enrichGeoLon = (npsOb, enrichedFields) => {
+    // In the absence of range, we estimate the slant range from the sensor to the sat
+    const slantRange = npsOb.Range ?? npsOb.GeoRange ?? estimateSlantRange(
+        npsOb.ObTime,
+        npsOb.Ra, npsOb.Dec,
+        npsOb.SenLat, npsOb.SenLon, npsOb.SenAlt,
+    );
+    const geodetic= raDecToGeodetic(
+        npsOb.ObTime,
+        npsOb.Ra,
+        npsOb.Dec,
+        npsOb.SenLat,
+        npsOb.SenLon,
+        npsOb.SenAlt,
+        slantRange,
+    );
+    npsOb.GeoLon = geodetic.Longitude;
+    npsOb.GeoLat = geodetic.Latitude;
+
+    if (typeof slantRange === "number" && !isNaN(slantRange)) {
+        if (!npsOb.Range && !npsOb.GeoRange) enrichedFields.push("GeoRange");
+        npsOb.GeoRange = slantRange;
+    }
+
+    if (npsOb.GeoLon) enrichedFields.push("GeoLon");
+    if (npsOb.GeoLat) enrichedFields.push("GeoLat");
+    return enrichedFields;
+};
+
+/**
+ * Enriches the given object by adding missing fields.
+ * This is the main function that uses helper functions to enrich different fields of the object.
+ *
+ * @param {object} npsOb - The object to be enriched.
+ * @return {object} The enriched object.
+ */
+const enrichUdlFields = (npsOb) => {
+    let enrichedFields = [];
+
+    if (!npsOb.Azimuth || !npsOb.Elevation) {
+        enrichedFields = enrichAzimuthAndElevation(npsOb, enrichedFields);
+    }
+
+    if (!npsOb.Ra || !npsOb.Dec) {
+        enrichedFields = enrichRaAndDec(npsOb, enrichedFields);
+    }
+
+    if (!npsOb.GeoLon) {
+        enrichedFields = enrichGeoLon(npsOb, enrichedFields);
+    }
+
+    npsOb.EnrichedFields = enrichedFields.join(",");
+    return npsOb;
+};
+
+export {udlToNpsElset, udlToNpsGroundSite, enrichUdlFields};