@contrast/telemetry 1.16.1 → 1.18.0

package/lib/index.js

@@ -12,7 +12,7 @@
  * engineered, modified, repackaged, sold, redistributed or otherwise used in a
  * way not consistent with the End User License Agreement.
  */
-
+// @ts-check
 'use strict';
 
 const { createHash, randomUUID } = require('crypto');
@@ -33,6 +33,7 @@ const TELEMETRY_VERSION = 'v0'; // TODO: set this to v1 when format is establish
  * @param {{
  *  agentName: string,
  *  agentVersion: string,
+ *  appInfo: import('@contrast/common').AppInfo,
  *  config: import('@contrast/config').Config,
  *  logger: import('@contrast/logger').Logger,
  *  messages: import('@contrast/common').Messages,
@@ -52,6 +53,7 @@ module.exports = function(core) {
   const { instanceId, applicationId } = getIds(appInfo);
 
   const telemetry = core.telemetry = {
+    /** @type {axios.AxiosInstance} */
     client: null,
     instanceId,
     tags: {
@@ -60,13 +62,13 @@ module.exports = function(core) {
       osArch: appInfo.os.architecture,
       osPlatform: appInfo.os.platform,
       osRelease: appInfo.os.release,
-      isContainer: !!appInfo.containerId,
+      isContainer: !!appInfo.containerId, // TODO: this is undefined
       agent: agentName,
       agentVersion,
       isAssess: config.getEffectiveValue('assess.enable'),
       isProtect: config.getEffectiveValue('protect.enable'),
       nodeVersion: appInfo.nodeVersion,
-      telemetryVersion: TELEMETRY_VERSION
+      telemetryVersion: TELEMETRY_VERSION,
     },
     isEnabled() {
       return (
@@ -122,6 +124,34 @@ module.exports = function(core) {
     telemetry.tags.isProtect = config.getEffectiveValue('protect.enable');
   });
 
+  let unsupportedLibs = [];
+  messages.on(Event.UNSUPPORTED_LIBRARY, (metadata) => {
+    unsupportedLibs.push({
+      timestamp: new Date().toISOString(),
+      instance: telemetry.instanceId,
+      tags: {
+        ...telemetry.tags,
+        name: metadata.name,
+        version: metadata.version,
+      },
+      fields: {
+        supported: 0
+      }
+    });
+  });
+
+  setInterval(async () => {
+    if (unsupportedLibs.length < 1) return;
+
+    try {
+      await telemetry.client.post('/dependencies', unsupportedLibs);
+    } catch (err) {
+      logger.error({ err }, 'error occurred while reporting telemetry: /dependencies');
+    }
+
+    unsupportedLibs = [];
+  }, 20_000).unref();
+
   return core.telemetry;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/telemetry",
-  "version": "1.16.1",
+  "version": "1.18.0",
   "description": "Telemetry reporting for the Contrast Node.js agent.",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -13,10 +13,10 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.26.0",
-    "@contrast/config": "1.36.0",
-    "@contrast/core": "1.41.1",
-    "@contrast/logger": "1.14.0",
+    "@contrast/common": "1.28.0",
+    "@contrast/config": "1.38.0",
+    "@contrast/core": "1.43.0",
+    "@contrast/logger": "1.16.0",
     "axios": "^1.7.4",
     "getmac": "^6.3.0"
   }