@contrast/agent 4.31.2 → 5.0.0-alpha.1

package/node_modules/winston-transport/legacy.js

@@ -1,119 +0,0 @@
-'use strict';
-
-const util = require('util');
-const { LEVEL } = require('triple-beam');
-const TransportStream = require('./');
-
-/**
- * Constructor function for the LegacyTransportStream. This is an internal
- * wrapper `winston >= 3` uses to wrap older transports implementing
- * log(level, message, meta).
- * @param {Object} options - Options for this TransportStream instance.
- * @param {Transpot} options.transport - winston@2 or older Transport to wrap.
- */
-
-const LegacyTransportStream = module.exports = function LegacyTransportStream(options = {}) {
-  TransportStream.call(this, options);
-  if (!options.transport || typeof options.transport.log !== 'function') {
-    throw new Error('Invalid transport, must be an object with a log method.');
-  }
-
-  this.transport = options.transport;
-  this.level = this.level || options.transport.level;
-  this.handleExceptions = this.handleExceptions || options.transport.handleExceptions;
-
-  // Display our deprecation notice.
-  this._deprecated();
-
-  // Properly bubble up errors from the transport to the
-  // LegacyTransportStream instance, but only once no matter how many times
-  // this transport is shared.
-  function transportError(err) {
-    this.emit('error', err, this.transport);
-  }
-
-  if (!this.transport.__winstonError) {
-    this.transport.__winstonError = transportError.bind(this);
-    this.transport.on('error', this.transport.__winstonError);
-  }
-};
-
-/*
- * Inherit from TransportStream using Node.js built-ins
- */
-util.inherits(LegacyTransportStream, TransportStream);
-
-/**
- * Writes the info object to our transport instance.
- * @param {mixed} info - TODO: add param description.
- * @param {mixed} enc - TODO: add param description.
- * @param {function} callback - TODO: add param description.
- * @returns {undefined}
- * @private
- */
-LegacyTransportStream.prototype._write = function _write(info, enc, callback) {
-  if (this.silent || (info.exception === true && !this.handleExceptions)) {
-    return callback(null);
-  }
-
-  // Remark: This has to be handled in the base transport now because we
-  // cannot conditionally write to our pipe targets as stream.
-  if (!this.level || this.levels[this.level] >= this.levels[info[LEVEL]]) {
-    this.transport.log(info[LEVEL], info.message, info, this._nop);
-  }
-
-  callback(null);
-};
-
-/**
- * Writes the batch of info objects (i.e. "object chunks") to our transport
- * instance after performing any necessary filtering.
- * @param {mixed} chunks - TODO: add params description.
- * @param {function} callback - TODO: add params description.
- * @returns {mixed} - TODO: add returns description.
- * @private
- */
-LegacyTransportStream.prototype._writev = function _writev(chunks, callback) {
-  for (let i = 0; i < chunks.length; i++) {
-    if (this._accept(chunks[i])) {
-      this.transport.log(
-        chunks[i].chunk[LEVEL],
-        chunks[i].chunk.message,
-        chunks[i].chunk,
-        this._nop
-      );
-      chunks[i].callback();
-    }
-  }
-
-  return callback(null);
-};
-
-/**
- * Displays a deprecation notice. Defined as a function so it can be
- * overriden in tests.
- * @returns {undefined}
- */
-LegacyTransportStream.prototype._deprecated = function _deprecated() {
-  // eslint-disable-next-line no-console
-  console.error([
-    `${this.transport.name} is a legacy winston transport. Consider upgrading: `,
-    '- Upgrade docs: https://github.com/winstonjs/winston/blob/master/UPGRADE-3.0.md'
-  ].join('\n'));
-};
-
-/**
- * Clean up error handling state on the legacy transport associated
- * with this instance.
- * @returns {undefined}
- */
-LegacyTransportStream.prototype.close = function close() {
-  if (this.transport.close) {
-    this.transport.close();
-  }
-
-  if (this.transport.__winstonError) {
-    this.transport.removeListener('error', this.transport.__winstonError);
-    this.transport.__winstonError = null;
-  }
-};

package/node_modules/winston-transport/package.json

@@ -1,54 +0,0 @@
-{
-  "name": "winston-transport",
-  "description": "Base stream implementations for winston@3 and up.",
-  "version": "4.4.0",
-  "main": "index.js",
-  "browser": "dist/index.js",
-  "scripts": {
-    "lint": "populist config/*.js index.js",
-    "pretest": "npm run lint && npm run build",
-    "test": "nyc mocha test/*.test.js",
-    "report": "nyc report --reporter=lcov",
-    "build": "./node_modules/.bin/rimraf dist && babel *.js -d ./dist",
-    "prepublishOnly": "npm run build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:winstonjs/winston-transport.git"
-  },
-  "keywords": [
-    "winston",
-    "transport",
-    "winston3"
-  ],
-  "author": "Charlie Robbins <charlie.robbins@gmail.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/winstonjs/winston-transport/issues"
-  },
-  "homepage": "https://github.com/winstonjs/winston-transport#readme",
-  "dependencies": {
-    "readable-stream": "^2.3.7",
-    "triple-beam": "^1.2.0"
-  },
-  "devDependencies": {
-    "@types/node": "^14.0.13",
-    "abstract-winston-transport": ">= 0.3.0",
-    "assume": "^2.2.0",
-    "babel-cli": "^6.26.0",
-    "babel-preset-env": "^1.7.0",
-    "eslint-config-populist": "^4.2.0",
-    "logform": "^2.2.0",
-    "mocha": "^8.0.1",
-    "nyc": "^15.1.0",
-    "rimraf": "^3.0.2",
-    "winston-compat": "^0.1.5"
-  },
-  "engines": {
-    "node": ">= 6.4.0"
-  }
-
-,"_resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.4.0.tgz"
-,"_integrity": "sha512-Lc7/p3GtqtqPBYYtS6KCN3c77/2QCev51DvcJKbkFPQNoj1sinkGwLGFDxkXY9J6p9+EPnYs+D90uwbnaiURTw=="
-,"_from": "winston-transport@4.4.0"
-}

package/node_modules/winston-transport/tsconfig.json

@@ -1,22 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "lib": [
-      "es6"
-    ],
-    "noImplicitAny": true,
-    "noImplicitThis": true,
-    "strictNullChecks": true,
-    "baseUrl": "./",
-    "typeRoots": [
-      "./node_modules/@types",
-      "./node_modules"
-    ],
-    "types": ["node", "logform"],
-    "noEmit": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "files": [
-    "index.d.ts"
-  ]
-}

package/perf-logs.js

@@ -1,155 +0,0 @@
-#!/usr/bin/env node
-/**
-Copyright: 2023 Contrast Security, Inc
-  Contact: support@contrastsecurity.com
-  License: Commercial
-
-  NOTICE: This Software and the patented inventions embodied within may only be
-  used as part of Contrast Security’s commercial offerings. Even though it is
-  made available through public repositories, use of this Software is subject to
-  the applicable End User Licensing Agreement found at
-  https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
-  between Contrast Security and the End User. The Software may not be reverse
-  engineered, modified, repackaged, sold, redistributed or otherwise used in a
-  way not consistent with the End User License Agreement.
-*/
-'use strict';
-
-const { program } = require('commander');
-const fs = require('fs');
-const readline = require('readline');
-
-const LOG_REGEX = /req-perf-logger - /;
-
-/*
- * transform raw data to more consumable values
- * (nano->ms, calculate percentages)
- */
-function transform(data) {
-  // lame but make a new object so they get logged in insertion order
-  const newData = { path: data.path, method: data.method };
-  newData.instrumentationTimeMs = data.instrumentationTime / 10 ** 6;
-  newData.totalTimeMs = data.totalTime / 10 ** 6;
-  newData.instrumentationOverheadPerc =
-    (data.instrumentationTime / data.totalTime) * 100;
-
-  newData.events = [];
-  for (let i = 0; i < data.events.length; i++) {
-    newData.events[i] = { name: data.events[i].name, times: {} };
-    newData.events[i].times.preMs = data.events[i].times.pre / 10 ** 6;
-    newData.events[i].times.postMs = data.events[i].times.post / 10 ** 6;
-    newData.events[i].times.origMs = data.events[i].times.orig / 10 ** 6;
-    newData.events[i].times.preOverheadPerc =
-      (data.events[i].times.pre / data.events[i].times.orig) * 100;
-    newData.events[i].times.postOverheadPerc =
-      (data.events[i].times.post / data.events[i].times.orig) * 100;
-    newData.events[i].times.totalOverheadPerc =
-      ((data.events[i].times.pre + data.events[i].times.post) /
-        data.events[i].times.orig) *
-      100;
-  }
-  return newData;
-}
-
-/*
- * merge an entry with already accumulated data
- */
-function merge(accum, data) {
-  accum.count = accum.count + 1;
-  accum.instrumentationTimeMs += data.instrumentationTimeMs;
-  accum.totalTimeMs += data.totalTimeMs;
-  accum.instrumentationOverheadPerc =
-    (accum.instrumentationTimeMs / accum.totalTimeMs) * 100;
-
-  const newDataEvents = data.events.reduce((accum, cur) => {
-    accum[cur.name] = cur;
-    return accum;
-  }, {});
-
-  for (let i = 0; i < accum.events.length; i++) {
-    const { name } = accum.events[i];
-    if (!newDataEvents[name]) {
-      continue;
-    }
-    accum.events[i].times.preMs += newDataEvents[name].times.preMs;
-    accum.events[i].times.postMs += newDataEvents[name].times.postMs;
-    accum.events[i].times.origMs += newDataEvents[name].times.origMs;
-    accum.events[i].times.preOverheadPerc =
-      (accum.events[i].times.preMs / accum.events[i].times.origMs) * 100;
-    accum.events[i].times.postOverheadPerc =
-      (accum.events[i].times.postMs / accum.events[i].times.origMs) * 100;
-    accum.events[i].times.totalOverheadPerc =
-      ((accum.events[i].times.preMs + accum.events[i].times.postMs) /
-        accum.events[i].times.origMs) *
-      100;
-    delete newDataEvents[name];
-  }
-
-  // append any remaining events from the new data
-  Array.prototype.push.apply(accum.events, Object.values(newDataEvents));
-  return accum;
-}
-
-async function processFile(filename, filter, group) {
-  const rl = readline.createInterface({
-    input: fs.createReadStream(filename),
-    crlfDelay: Infinity
-  });
-
-  const merged = {};
-  for await (const line of rl) {
-    if (line.match(LOG_REGEX)) {
-      const data = transform(JSON.parse(line.split(LOG_REGEX)[1]));
-      if (filter && !data.path.match(filter)) {
-        continue;
-      }
-      if (!group) {
-        console.log(JSON.stringify(data, null, 4));
-      } else {
-        const key = filter
-          ? `regex:${data.method}`
-          : `${data.path}:${data.method}`;
-        if (filter) {
-          // path is meaningless if we're merging w/ a filter
-          delete data.path;
-        }
-        if (!merged[key]) {
-          merged[key] = data;
-          merged[key].count = 1;
-        } else {
-          merged[key] = merge(merged[key], data);
-        }
-      }
-    }
-  }
-
-  if (group) {
-    console.log(JSON.stringify(Object.values(merged), null, 4));
-  }
-}
-
-program
-  .arguments('<log_file>')
-  .option(
-    '-g, --group',
-    'group like requests together (defaults by req path, but uses filter regex if specified)'
-  )
-  .option('-f, --filter <regex>', 'filter (and group if specified) by regex');
-
-program.parse(process.argv);
-if (program.args.length === 0) {
-  program.help();
-}
-
-let filterRegex;
-if (program.filter) {
-  try {
-    filterRegex = new RegExp(program.filter);
-  } catch (e) {
-    console.error('invalid filter regex');
-    process.exit(-1); // eslint-disable-line no-process-exit
-
-  }
-}
-
-processFile(program.args[0], filterRegex, program.group);

package/system-diagnostics.js

@@ -1,199 +0,0 @@
-#!/usr/bin/env node
-/**
-Copyright: 2023 Contrast Security, Inc
-  Contact: support@contrastsecurity.com
-  License: Commercial
-
-  NOTICE: This Software and the patented inventions embodied within may only be
-  used as part of Contrast Security’s commercial offerings. Even though it is
-  made available through public repositories, use of this Software is subject to
-  the applicable End User Licensing Agreement found at
-  https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
-  between Contrast Security and the End User. The Software may not be reverse
-  engineered, modified, repackaged, sold, redistributed or otherwise used in a
-  way not consistent with the End User License Agreement.
-*/
-'use strict';
-
-const path = require('path');
-const fs = require('fs');
-const os = require('os');
-const pkg = require('./package');
-const { setup } = require('./lib/core/config/util');
-const logger = require('./lib/core/logger')('contrast:system-diagnostics');
-
-const HELP_MESSAGE = `
-Description:
-  The system-diagnostics utility returns the system info for the server/container the agent is running on.
-
-Usage:
-  npx -p @contrast/agent system-diagnostics --help
-  npx -p @contrast/agent system-diagnostics [options]
-
-Options:
-  --quiet      -q     Prevents output of the report to the console.
-  --output     -o     The directory to write the report in. Defaults to the current directory.
-`;
-
-
-const isDocker = () => {
-  const MOUNTINFO_REGEX = /\/docker\/containers\/(.*?)\//;
-  const CGROUP_REGEX = /:\/docker\/([^/]+)$/;
-
-  try {
-    const results = fs.readFileSync('/proc/self/mountinfo', 'utf8').match(MOUNTINFO_REGEX);
-    if (results) return { isDocker: true, containerID: results[1] };
-  } catch (err) {
-    // else check /proc/self/cgroup
-  }
-
-  try {
-    const results = fs.readFileSync('/proc/self/cgroup', 'utf8').match(CGROUP_REGEX);
-    if (results) return { isDocker: true, containerID: results[1] };
-  } catch (err) {
-    // else check /.dockerenv
-  }
-
-  try {
-    const result = fs.statSync('/.dockerenv');
-    if (result) return { isDocker: true, containerID: undefined };
-  } catch (err) {
-    // if there's not such file we can conclude it's not docker env
-  }
-
-  return { isDocker: false, containerID: undefined };
-};
-
-function isUsingPM2() {
-  const used = !!process.env.pmx;
-  let version = null;
-
-  for (const pathVar of ['npm_package_json', 'PWD']) {
-    const packagePath = process.env[pathVar];
-    if (packagePath) {
-      try {
-        version = require(path.join(packagePath, 'package.json')).dependencies['pm2'];
-      } catch (err) {
-        //
-      }
-    }
-    if (version) break;
-  }
-
-  return { used, version };
-}
-
-const diagnostics = {
-  parseArgv(argv) {
-    const args = {
-      help: false,
-      output: 'contrast_system_info.json',
-      quiet: false,
-    };
-
-    for (let i = 0; i < argv.length; i++) {
-      const arg = argv[i];
-
-      switch (arg) {
-        case '--help':
-          args.help = true;
-          return args;
-        case '--output':
-        case '-o': {
-          // grab the next value and skip in the next loop
-          const output = argv[++i];
-          if (!output) {
-            throw new Error('Expected a value to be provided after --output');
-          }
-          args.output = output;
-          break;
-        }
-        case '--quiet':
-        case '-q':
-          args.quiet = true;
-          break;
-        default:
-          if (!arg.startsWith('-')) {
-            args.entry = arg;
-          }
-          break;
-      }
-    }
-
-    return args;
-  },
-
-  outputSystemInfo(args, info) {
-    try {
-      fs.accessSync(path.join(args.output, '..'), fs.constants.RDWD_OK);
-      fs.writeFileSync(args.output, JSON.stringify(info, null, 2), 'utf-8');
-    } catch (err) {
-      console.log(`Couldn't create system info file: ${err}`);
-    }
-
-    if (!args.quiet) {
-      fs.writeFileSync(1, JSON.stringify(info, null, 2), 'utf-8');
-    }
-  },
-
-  fetchSystemInfo() {
-    const yaml = setup({}, logger);
-    const appPath = process.cwd();
-
-    const info = {
-      ReportDate: new Date(),
-      MachineName: os.hostname(),
-      Contrast: {
-        Url: yaml.api.url,
-        Proxy: yaml.api.proxy,
-        Server: {
-          Name: yaml._flat['server.name'],
-        },
-        Agent: {
-          Name: '@contrast/agent',
-          Version: pkg.version,
-        },
-      },
-      Node: {
-        Version: process.version
-      },
-      OperatingSystem: {
-        Architecture: os.arch(),
-        Name: os.type(),
-        Version: os.release(),
-        KernelVersion: os.version(),
-        CPU: {
-          type: os.cpus()[0].model,
-          count: os.cpus().length,
-        }
-      },
-      Host: {
-        Docker: isDocker(),
-        PM2: isUsingPM2(),
-        Memory: {
-          Total: (os.totalmem() / 1e6).toFixed(0).concat(' MB'),
-          Free: (os.freemem() / 1e6).toFixed(0).concat(' MB'),
-          Used: ((os.totalmem() - os.freemem()) / 1e6).toFixed(0).concat(' MB'),
-        }
-      },
-      Application: appPath ? require(path.join(appPath, 'package.json')) : null,
-    };
-
-    return info;
-  }
-};
-module.exports = diagnostics;
-
-// only run if this file is being executed as an entry script
-// istanbul ignore next
-
-if (require.main === module) {
-  const args = diagnostics.parseArgv(process.argv.slice(2));
-
-  if (args.help) {
-    console.log(HELP_MESSAGE);
-  } else {
-    const info = diagnostics.fetchSystemInfo();
-    diagnostics.outputSystemInfo(args, info);
-  }
-}