chore: refactor addProxyAgent and revert removed typedefs

Signed-off-by: Ruben Romero Montes <rromerom@redhat.com>

Author: ruromero

src/analysis.js

@@ -2,28 +2,12 @@ import fs from "node:fs";
 import path from "node:path";
 import { EOL } from "os";
 
-import { HttpsProxyAgent } from "https-proxy-agent";
-
 import { runLicenseCheck } from "./license/index.js";
 import { generateImageSBOM, parseImageRef } from "./oci_image/utils.js";
-import { getCustom, getTokenHeaders , TRUSTIFY_DA_OPERATION_TYPE_HEADER, TRUSTIFY_DA_PACKAGE_MANAGER_HEADER } from "./tools.js";
+import { addProxyAgent, getCustom, getTokenHeaders , TRUSTIFY_DA_OPERATION_TYPE_HEADER, TRUSTIFY_DA_PACKAGE_MANAGER_HEADER } from "./tools.js";
 
 export default { requestComponent, requestStack, requestImages, validateToken }
 
-/**
- * Adds proxy agent configuration to fetch options if a proxy URL is specified
- * @param {RequestInit} options - The base fetch options
- * @param {import("index.js").Options} opts - The trustify DA options that may contain proxy configuration
- * @returns {RequestInit} The fetch options with proxy agent if applicable
- */
-function addProxyAgent(options, opts) {
-	const proxyUrl = getCustom('TRUSTIFY_DA_PROXY_URL', null, opts);
-	if (proxyUrl) {
-		options.agent = new HttpsProxyAgent(proxyUrl);
-	}
-	return options;
-}
-
 /**
  * Send a stack analysis request and get the report as 'text/html' or 'application/json'.
  * @param {import('./provider').Provider} provider - the provided data for constructing the request

src/license/licenses_api.js

@@ -5,10 +5,8 @@
  * @see https://github.com/guacsec/trustify-da-api-spec/blob/main/api/v5/openapi.yaml
  */
 
-import { HttpsProxyAgent } from 'https-proxy-agent';
-
 import { selectTrustifyDABackend } from '../index.js';
-import { getCustom , getTokenHeaders } from '../tools.js';
+import { addProxyAgent, getTokenHeaders } from '../tools.js';
 
 /**
  * Fetch license details by SPDX identifier from the backend GET /api/v5/licenses/{spdx}.
@@ -24,18 +22,13 @@ export async function getLicenseDetails(spdxId, opts = {}) {
 	const url = selectTrustifyDABackend(opts);
 	const finalUrl = new URL(`${url}/api/v5/licenses/${encodeURIComponent(spdxId)}`);
 
-	const fetchOptions = {
+	const fetchOptions = addProxyAgent({
 		method: 'GET',
 		headers: {
 			'Accept': 'application/json',
 			...getTokenHeaders(opts)
 		},
-	};
-
-	const proxyUrl = getCustom('TRUSTIFY_DA_PROXY_URL', null, opts);
-	if (proxyUrl) {
-		fetchOptions.agent = new HttpsProxyAgent(proxyUrl);
-	}
+	}, opts);
 
 	try {
 		const resp = await fetch(finalUrl, fetchOptions);

src/license/project_license.js

@@ -8,7 +8,7 @@ import path from 'node:path';
 
 import { selectTrustifyDABackend } from '../index.js';
 import { matchForLicense, availableProviders } from '../provider.js';
-import { getCustom, getTokenHeaders } from '../tools.js';
+import { addProxyAgent, getTokenHeaders } from '../tools.js';
 
 const LICENSE_FILES = ['LICENSE', 'LICENSE.md', 'LICENSE.txt'];
 
@@ -67,20 +67,14 @@ export async function identifyLicense(licenseFilePath, opts = {}) {
 		const backendUrl = selectTrustifyDABackend(opts);
 		const url = new URL(`${backendUrl}/licenses/identify`);
 		const tokenHeaders = getTokenHeaders(opts);
-		const fetchOptions = {
+		const fetchOptions = addProxyAgent({
 			method: 'POST',
 			headers: {
 				'Content-Type': 'application/octet-stream',
 				...tokenHeaders,
 			},
 			body: fileContent,
-		};
-
-		const proxyUrl = getCustom('TRUSTIFY_DA_PROXY_URL', null, opts);
-		if (proxyUrl) {
-			const { HttpsProxyAgent } = await import('https-proxy-agent');
-			fetchOptions.agent = new HttpsProxyAgent(proxyUrl);
-		}
+		}, opts);
 
 		const resp = await fetch(url, fetchOptions);
 		if (!resp.ok) {

src/providers/base_java.js

@@ -5,6 +5,10 @@ import { PackageURL } from 'packageurl-js'
 
 import { getCustomPath, getGitRootDir, getWrapperPreference, invokeCommand } from "../tools.js"
 
+/** @typedef {import('../provider').Provider} */
+
+/** @typedef {import('../provider').Provided} Provided */
+
 /** @typedef {{name: string, version: string}} Package */
 
 /** @typedef {{groupId: string, artifactId: string, version: string, scope: string, ignore: boolean}} Dependency */

src/providers/base_javascript.js

@@ -7,6 +7,10 @@ import { getCustom, getCustomPath, invokeCommand, toPurl, toPurlFromString } fro
 
 import Manifest from './manifest.js';
 
+/** @typedef {import('../provider').Provider} */
+
+/** @typedef {import('../provider').Provided} Provided */
+
 /**
  * The ecosystem identifier for JavaScript/npm packages
  * @type {string}

src/tools.js

@@ -1,6 +1,7 @@
 import { execFileSync } from "child_process";
 import { EOL } from "os";
 
+import { HttpsProxyAgent } from "https-proxy-agent";
 import { PackageURL } from "packageurl-js";
 
 export const RegexNotToBeLogged = /TRUSTIFY_DA_(.*_)?TOKEN|ex-.*-token|trust-.*-token/
@@ -178,6 +179,20 @@ export const TRUSTIFY_DA_SOURCE_HEADER = "trust-da-source"
 export const TRUSTIFY_DA_OPERATION_TYPE_HEADER = "trust-da-operation-type"
 export const TRUSTIFY_DA_PACKAGE_MANAGER_HEADER = "trust-da-pkg-manager"
 
+/**
+ * Adds proxy agent configuration to fetch options if a proxy URL is specified
+ * @param {RequestInit} options - The base fetch options
+ * @param {import("index.js").Options} opts - The trustify DA options that may contain proxy configuration
+ * @returns {RequestInit} The fetch options with proxy agent if applicable
+ */
+export function addProxyAgent(options, opts) {
+	const proxyUrl = getCustom('TRUSTIFY_DA_PROXY_URL', null, opts);
+	if (proxyUrl) {
+		options.agent = new HttpsProxyAgent(proxyUrl);
+	}
+	return options;
+}
+
 /**
  * Utility function for fetching vendor tokens
  * @param {import("index.js").Options} [opts={}] - optional various options to pass along the application