feat: add DependencyMetric and NpmScope

.eslintrc.cjs

@@ -18,10 +18,10 @@ module.exports = {
     'plugin:@typescript-eslint/strict',
     'plugin:eslint-comments/recommended',
     'plugin:jsdoc/recommended-typescript',
-    'plugin:n/recommended',
-    'plugin:vitest/all'
+    'plugin:n/recommended'
   ],
   overrides: [
+    // Special rules for config files
     {
       env: {
         node: true
@@ -33,14 +33,20 @@ module.exports = {
       rules: {
         '@typescript-eslint/no-var-requires': 'off'
       }
+    },
+    // Special rules for test files
+    {
+      files: ['**/*.test.ts'],
+      plugins: ['vitest'],
+      extends: ['plugin:vitest/all']
     }
   ],
   parserOptions: {
     ecmaVersion: 'latest',
     sourceType: 'module',
     project: 'tsconfig.eslint.json'
   },
-  plugins: ['jsdoc', 'notice', 'simple-import-sort', 'vitest'],
+  plugins: ['jsdoc', 'notice', 'simple-import-sort'],
   root: true,
   rules: {
     '@typescript-eslint/explicit-function-return-type': 'off',

.gitignore

@@ -17,3 +17,6 @@ src/schemas/telemetrics-config.schema.json
 
 # Dotenv stuff
 .env
+
+# Allow node_modules folders in test fixtures
+!src/test/__fixtures/projects/**/node_modules

package.json

@@ -46,14 +46,18 @@
     "@opentelemetry/semantic-conventions": "^1.15.2",
     "ajv": "^8.12.0",
     "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "object-scan": "^19.0.2",
     "reflect-metadata": "^0.1.13",
+    "semver": "^7.5.4",
     "tmp-promise": "^3.0.3"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",
     "@types/js-yaml": "^4.0.5",
     "@types/node": "^18.17.12",
+    "@types/lodash": "^4.14.198",
     "@typescript-eslint/eslint-plugin": "^6.5.0",
     "@vitest/coverage-v8": "^0.34.3",
     "eslint": "^8.46.0",

src/declarations.d.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+declare module 'object-scan' {
+  export type ObjectPath = string[]
+
+  export default function objectScan(
+    query: string[],
+    options: {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any -- module types not owned by us
+      filterFn: (obj: { value: any }) => boolean
+    }
+  ): (obj: unknown) => ObjectPath[]
+}

src/main/core/exec.ts

@@ -5,24 +5,30 @@
  * LICENSE file in the root directory of this source tree.
  */
 import childProcess from 'node:child_process'
+import util from 'node:util'
 
 import { guardShell } from './guard-shell.js'
 
+const runCommand = util.promisify(childProcess.exec)
+
 /**
- * Executes a command using childProcess. Throws an exception if the command fails.
+ * Executes a command using childProcess. Throws an exception if the command fails or exits with a
+ * non-zero exit code.
  *
  * @param cmd - The command to invoke.
  * @param options - Options to include along with the command.
- * @throws An exception if the command timed out or exited with a non-zero code.
+ * @throws An error if the command timed out or exited with a non-zero code.
  * @returns The standard output from the command.
  */
-export function exec(cmd: string, options: childProcess.ExecSyncOptionsWithBufferEncoding = {}) {
+export async function exec(cmd: string, options: childProcess.ExecOptions = {}) {
   guardShell(cmd)
 
   const execOptions = {
     env: process.env,
     ...options
   }
 
-  return childProcess.execSync(cmd, execOptions).toString().trim()
+  const proc = await runCommand(cmd, execOptions)
+
+  return proc.stdout.toString().trim()
 }

src/main/core/get-project-root.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { exec } from './exec.js'
+
+/**
+ * Finds and returns the root-most directory of the analyzed project's source tree.
+ *
+ * @param cwd - Current working directory to use as the basis for finding the root directory.
+ * @throws An exception if no usable root data was obtained.
+ * @returns The path of the analyzed project's root directory or null.
+ */
+export async function getProjectRoot(cwd: string): Promise<string> {
+  return await exec('git rev-parse --show-toplevel', { cwd })
+}

src/main/core/guard-shell.ts

@@ -5,6 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import { GuardShellError } from '../exceptions/guard-shell-error.js'
+
 /**
  *  Checks a command for certain disallowed characters and throws an exception if they are found.
  *
@@ -13,8 +15,6 @@
  */
 export function guardShell(cmd: string) {
   if (/[\\$;`]/.exec(cmd) != null) {
-    throw new Error(
-      'Shell guard prevented a command from running because it contained special characters: ' + cmd
-    )
+    throw new GuardShellError('Command contained forbidden characters: ' + cmd)
   }
 }

src/main/core/log/trace.ts

@@ -6,6 +6,7 @@
  */
 import 'reflect-metadata'
 
+import { LoggerNotFoundError } from '../../exceptions/logger-not-found-error.js'
 import { type Loggable } from './loggable.js'
 import { Logger } from './logger.js'
 import { safeStringify } from './safe-stringify.js'
@@ -48,7 +49,7 @@ function Trace(): MethodDecorator {
       const logger: unknown = this.logger
 
       if (!(logger instanceof Logger)) {
-        throw new Error('Attempt to trace method without a defined logger instance')
+        throw new LoggerNotFoundError()
       }
 
       setImmediate(() => {
@@ -58,12 +59,12 @@ function Trace(): MethodDecorator {
       let result: unknown
       try {
         result = original.apply(this, args)
-      } catch (err) {
+      } catch (e) {
         setImmediate(() => {
-          void traceExit(logger, String(propertyKey), err)
+          void traceExit(logger, String(propertyKey), e)
         })
 
-        throw err
+        throw e
       }
 
       setImmediate(() => {

src/main/core/manual-metric-reader.ts

@@ -4,12 +4,35 @@
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { MetricReader } from '@opentelemetry/sdk-metrics'
+import { type CollectionResult, type DataPoint, MetricReader } from '@opentelemetry/sdk-metrics'
+import { type CommonReaderOptions } from '@opentelemetry/sdk-metrics/build/src/types.js'
+
+interface UnlockedDataPoint extends DataPoint<number> {
+  startTime: DataPoint<number>['startTime']
+  endTime: DataPoint<number>['endTime']
+}
 
 /**
  * A metric reader that can be invoked manually with `collect()` to obtain its metrics.
  */
 export class ManualMetricReader extends MetricReader {
+  override async collect(options?: CommonReaderOptions | undefined): Promise<CollectionResult> {
+    const results = await super.collect(options)
+
+    // Zero out all startTime and EndTime attributes in data points
+    results.resourceMetrics.scopeMetrics.forEach((scopeMetric) => {
+      scopeMetric.metrics.forEach((metric) => {
+        metric.dataPoints.forEach((dataPoint) => {
+          const unlocked = dataPoint as UnlockedDataPoint
+          unlocked.startTime = [0, 0]
+          unlocked.endTime = [0, 0]
+        })
+      })
+    })
+
+    return results
+  }
+
   protected override async onShutdown(): Promise<void> {
     throw new Error('Method not implemented.')
   }

src/main/core/scope.ts

@@ -29,9 +29,12 @@ export abstract class Scope extends Loggable {
    */
   public abstract run(): Promise<void>
 
-  private scope?: Meter
+  /**
+   * The metrics captured by this scope.
+   */
+  public readonly metrics: Record<string, Counter>
 
-  private readonly metrics: Record<string, Counter>
+  private scope?: Meter
 
   /**
    * Instantiates a new scope.
@@ -46,7 +49,7 @@ export abstract class Scope extends Loggable {
    *
    * @param dataPoint - The actual metric data.
    */
-  protected capture(dataPoint: ScopeMetric): void {
+  public capture(dataPoint: ScopeMetric): void {
     // Ensure a scope exists
     if (this.scope === undefined) {
       this.scope = opentelemetry.metrics.getMeter(this.name)

src/main/exceptions/guard-shell-error.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * Exception thrown when protecting exec commands from forbidden characters.
+ */
+export class GuardShellError extends Error {}

src/main/exceptions/invalid-object-path-error.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * Exception thrown when protecting exec commands from forbidden characters.
+ */
+export class InvalidObjectPathError extends Error {}

src/main/exceptions/invalid-root-path-error.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * Exception thrown when protecting exec commands from forbidden characters.
+ */
+export class InvalidRootPathError extends Error {
+  constructor(cwd: string, root: string) {
+    super(`${cwd} is not a subpath of ${root}`)
+  }
+}