@trustify-da/trustify-da-javascript-client 0.3.0-ea.e12bc82 → 0.3.0-ea.e645720

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/README.md +191 -11
  2. package/dist/package.json +23 -11
  3. package/dist/src/analysis.d.ts +21 -5
  4. package/dist/src/analysis.js +74 -80
  5. package/dist/src/batch_opts.d.ts +24 -0
  6. package/dist/src/batch_opts.js +35 -0
  7. package/dist/src/cli.js +241 -8
  8. package/dist/src/cyclone_dx_sbom.d.ts +17 -3
  9. package/dist/src/cyclone_dx_sbom.js +48 -8
  10. package/dist/src/index.d.ts +197 -11
  11. package/dist/src/index.js +352 -7
  12. package/dist/src/license/index.d.ts +28 -0
  13. package/dist/src/license/index.js +100 -0
  14. package/dist/src/license/license_utils.d.ts +40 -0
  15. package/dist/src/license/license_utils.js +134 -0
  16. package/dist/src/license/licenses_api.d.ts +34 -0
  17. package/dist/src/license/licenses_api.js +98 -0
  18. package/dist/src/license/project_license.d.ts +20 -0
  19. package/dist/src/license/project_license.js +62 -0
  20. package/dist/src/oci_image/images.d.ts +4 -5
  21. package/dist/src/oci_image/utils.d.ts +4 -4
  22. package/dist/src/oci_image/utils.js +11 -2
  23. package/dist/src/provider.d.ts +17 -5
  24. package/dist/src/provider.js +29 -5
  25. package/dist/src/providers/base_java.d.ts +3 -14
  26. package/dist/src/providers/base_java.js +2 -38
  27. package/dist/src/providers/base_javascript.d.ts +29 -7
  28. package/dist/src/providers/base_javascript.js +129 -22
  29. package/dist/src/providers/base_pyproject.d.ts +153 -0
  30. package/dist/src/providers/base_pyproject.js +315 -0
  31. package/dist/src/providers/golang_gomodules.d.ts +29 -13
  32. package/dist/src/providers/golang_gomodules.js +176 -121
  33. package/dist/src/providers/gomod_parser.d.ts +4 -0
  34. package/dist/src/providers/gomod_parser.js +16 -0
  35. package/dist/src/providers/java_gradle.d.ts +28 -3
  36. package/dist/src/providers/java_gradle.js +128 -4
  37. package/dist/src/providers/java_gradle_groovy.d.ts +1 -1
  38. package/dist/src/providers/java_gradle_kotlin.d.ts +1 -1
  39. package/dist/src/providers/java_maven.d.ts +20 -5
  40. package/dist/src/providers/java_maven.js +126 -6
  41. package/dist/src/providers/javascript_npm.d.ts +1 -0
  42. package/dist/src/providers/javascript_npm.js +21 -0
  43. package/dist/src/providers/javascript_pnpm.d.ts +1 -1
  44. package/dist/src/providers/javascript_pnpm.js +8 -4
  45. package/dist/src/providers/manifest.d.ts +2 -0
  46. package/dist/src/providers/manifest.js +22 -4
  47. package/dist/src/providers/marker_evaluator.d.ts +14 -0
  48. package/dist/src/providers/marker_evaluator.js +191 -0
  49. package/dist/src/providers/processors/yarn_berry_processor.js +88 -5
  50. package/dist/src/providers/python_controller.d.ts +10 -3
  51. package/dist/src/providers/python_controller.js +61 -59
  52. package/dist/src/providers/python_pip.d.ts +15 -4
  53. package/dist/src/providers/python_pip.js +51 -58
  54. package/dist/src/providers/python_pip_pyproject.d.ts +61 -0
  55. package/dist/src/providers/python_pip_pyproject.js +144 -0
  56. package/dist/src/providers/python_poetry.d.ts +75 -0
  57. package/dist/src/providers/python_poetry.js +238 -0
  58. package/dist/src/providers/python_uv.d.ts +55 -0
  59. package/dist/src/providers/python_uv.js +227 -0
  60. package/dist/src/providers/requirements_parser.d.ts +6 -0
  61. package/dist/src/providers/requirements_parser.js +24 -0
  62. package/dist/src/providers/rust_cargo.d.ts +52 -0
  63. package/dist/src/providers/rust_cargo.js +614 -0
  64. package/dist/src/providers/tree-sitter-gomod.wasm +0 -0
  65. package/dist/src/providers/tree-sitter-requirements.wasm +0 -0
  66. package/dist/src/sbom.d.ts +17 -2
  67. package/dist/src/sbom.js +16 -4
  68. package/dist/src/tools.d.ts +48 -6
  69. package/dist/src/tools.js +114 -1
  70. package/dist/src/workspace.d.ts +70 -0
  71. package/dist/src/workspace.js +256 -0
  72. package/package.json +24 -12
@@ -0,0 +1,191 @@
1
+ // PEP 508 environment marker evaluator.
2
+ // Filters Python dependencies by platform/version markers so that e.g.
3
+ // "pywin32 ; sys_platform == 'win32'" is excluded on Linux/macOS.
4
+ // See https://peps.python.org/pep-0508/#environment-markers
5
+ import os from 'node:os';
6
+ import { getCustomPath, invokeCommand } from '../tools.js';
7
+ let cachedPythonVersions = undefined;
8
+ function getPythonVersions() {
9
+ if (cachedPythonVersions !== undefined) {
10
+ return cachedPythonVersions;
11
+ }
12
+ try {
13
+ let python = getCustomPath('python3');
14
+ let out = invokeCommand(python, ['-c', "import sys; v=sys.version_info; print(f'{v.major}.{v.minor} {v.major}.{v.minor}.{v.micro}')"], { timeout: 5000 }).toString().trim();
15
+ let [short, full] = out.split(' ');
16
+ cachedPythonVersions = { short, full };
17
+ }
18
+ catch {
19
+ cachedPythonVersions = null;
20
+ }
21
+ return cachedPythonVersions;
22
+ }
23
+ /**
24
+ * Maps Node.js/OS values to PEP 508 marker variables.
25
+ * Example: on Linux, sys_platform='linux', platform_system='Linux', os_name='posix'
26
+ * @returns {Record<string, string>}
27
+ */
28
+ export function getEnvironmentMarkers() {
29
+ let platform = process.platform;
30
+ let systemMap = { win32: 'Windows', linux: 'Linux', darwin: 'Darwin' };
31
+ let machine = typeof os.machine === 'function' ? os.machine() : process.arch;
32
+ let pyVer = getPythonVersions();
33
+ return {
34
+ sys_platform: platform,
35
+ platform_system: systemMap[platform] || platform,
36
+ os_name: platform === 'win32' ? 'nt' : 'posix',
37
+ platform_machine: machine,
38
+ platform_release: os.release(),
39
+ platform_version: os.version?.() || '',
40
+ python_version: pyVer?.short || '',
41
+ python_full_version: pyVer?.full || '',
42
+ implementation_name: 'cpython',
43
+ };
44
+ }
45
+ function compareVersions(left, right) {
46
+ let lParts = left.split('.').map(Number);
47
+ let rParts = right.split('.').map(Number);
48
+ let len = Math.max(lParts.length, rParts.length);
49
+ for (let i = 0; i < len; i++) {
50
+ let l = lParts[i] || 0;
51
+ let r = rParts[i] || 0;
52
+ if (l < r) {
53
+ return -1;
54
+ }
55
+ if (l > r) {
56
+ return 1;
57
+ }
58
+ }
59
+ return 0;
60
+ }
61
+ // Evaluates a single comparison like sys_platform == 'win32' or python_version >= '3.8'.
62
+ // Version-bearing variables (python_version, python_full_version) use numeric comparison;
63
+ // all others use string equality. Returns false when the env value is missing.
64
+ function evaluateComparison(variable, op, value, env) {
65
+ let envVal = env[variable];
66
+ if (envVal === undefined || envVal === '') {
67
+ return false;
68
+ }
69
+ let isVersion = variable.includes('version');
70
+ if (isVersion) {
71
+ let cmp = compareVersions(envVal, value);
72
+ switch (op) {
73
+ case '==': return cmp === 0;
74
+ case '!=': return cmp !== 0;
75
+ case '>=': return cmp >= 0;
76
+ case '<=': return cmp <= 0;
77
+ case '>': return cmp > 0;
78
+ case '<': return cmp < 0;
79
+ case '~=': {
80
+ let parts = value.split('.');
81
+ parts.pop();
82
+ let prefix = parts.join('.');
83
+ return envVal.startsWith(prefix) && cmp >= 0;
84
+ }
85
+ default: return true;
86
+ }
87
+ }
88
+ switch (op) {
89
+ case '==': return envVal === value;
90
+ case '!=': return envVal !== value;
91
+ case 'in': return value.includes(envVal);
92
+ case 'not in': return !value.includes(envVal);
93
+ default: return envVal === value;
94
+ }
95
+ }
96
+ // Parses a single marker comparison into {variable, op, value}.
97
+ // Handles both normal and reversed forms:
98
+ // "sys_platform == 'linux'" → { variable: 'sys_platform', op: '==', value: 'linux' }
99
+ // "'linux' == sys_platform" → { variable: 'sys_platform', op: '==', value: 'linux' }
100
+ function parseAtom(expr) {
101
+ // Normal form: variable op 'value'
102
+ let m = expr.match(/^\s*([\w.]+)\s*(~=|!=|==|>=|<=|>|<|not\s+in|in)\s*["']([^"']*)["']\s*$/);
103
+ if (m) {
104
+ return { variable: m[1], op: m[2].replace(/\s+/g, ' '), value: m[3] };
105
+ }
106
+ // Reversed form: 'value' op variable — reverse directional operators
107
+ let mReverse = expr.match(/^\s*["']([^"']*)['"]\s*(~=|!=|==|>=|<=|>|<|not\s+in|in)\s*([\w.]+)\s*$/);
108
+ if (mReverse) {
109
+ let reverseOp = { '<': '>', '>': '<', '<=': '>=', '>=': '<=' };
110
+ let op = mReverse[2].replace(/\s+/g, ' ');
111
+ return { variable: mReverse[3], op: reverseOp[op] || op, value: mReverse[1] };
112
+ }
113
+ return null;
114
+ }
115
+ /**
116
+ * Evaluates a full PEP 508 marker expression against the current platform.
117
+ * Example: "sys_platform == 'win32' and python_version >= '3.8'" → false on Linux
118
+ * Empty/missing markers return true (unconditional dependency).
119
+ * @param {string} markerExpr
120
+ * @returns {boolean}
121
+ */
122
+ export function evaluateMarker(markerExpr) {
123
+ if (!markerExpr || !markerExpr.trim()) {
124
+ return true;
125
+ }
126
+ let env = getEnvironmentMarkers();
127
+ return evaluateExpr(markerExpr.trim(), env);
128
+ }
129
+ function evaluateExpr(expr, env) {
130
+ let orParts = splitLogical(expr, ' or ');
131
+ if (orParts.length > 1) {
132
+ return orParts.some(part => evaluateExpr(part, env));
133
+ }
134
+ let andParts = splitLogical(expr, ' and ');
135
+ if (andParts.length > 1) {
136
+ return andParts.every(part => evaluateExpr(part, env));
137
+ }
138
+ let trimmed = expr.trim();
139
+ if (trimmed.startsWith('(') && trimmed.endsWith(')')) {
140
+ return evaluateExpr(trimmed.slice(1, -1), env);
141
+ }
142
+ let atom = parseAtom(trimmed);
143
+ if (!atom) {
144
+ return true;
145
+ }
146
+ return evaluateComparison(atom.variable, atom.op, atom.value, env);
147
+ }
148
+ // Splits an expression by " and " or " or " at the top level, skipping
149
+ // separators inside parentheses or quoted strings.
150
+ // Example: splitLogical("a == 'x' and (b == 'y' or c == 'z')", " and ")
151
+ // → ["a == 'x'", "(b == 'y' or c == 'z')"]
152
+ function splitLogical(expr, sep) {
153
+ let parts = [];
154
+ let depth = 0;
155
+ let current = '';
156
+ let i = 0;
157
+ let quoteChar = null;
158
+ while (i < expr.length) {
159
+ let ch = expr[i];
160
+ if (quoteChar) {
161
+ if (ch === quoteChar) {
162
+ quoteChar = null;
163
+ }
164
+ current += ch;
165
+ i++;
166
+ continue;
167
+ }
168
+ if (ch === '"' || ch === "'") {
169
+ quoteChar = ch;
170
+ current += ch;
171
+ i++;
172
+ continue;
173
+ }
174
+ if (ch === '(') {
175
+ depth++;
176
+ }
177
+ if (ch === ')') {
178
+ depth--;
179
+ }
180
+ if (depth === 0 && expr.substring(i, i + sep.length) === sep) {
181
+ parts.push(current);
182
+ current = '';
183
+ i += sep.length;
184
+ continue;
185
+ }
186
+ current += ch;
187
+ i++;
188
+ }
189
+ parts.push(current);
190
+ return parts.filter(p => p.trim());
191
+ }
@@ -15,7 +15,10 @@ export default class Yarn_berry_processor extends Yarn_processor {
15
15
  * @returns {string[]} Command arguments for listing dependencies
16
16
  */
17
17
  listCmdArgs(includeTransitive) {
18
- return ['info', includeTransitive ? '--recursive' : '--all', '--json'];
18
+ // --all is needed to include workspace members in the output
19
+ return includeTransitive
20
+ ? ['info', '--recursive', '--all', '--json']
21
+ : ['info', '--all', '--json'];
19
22
  }
20
23
  /**
21
24
  * Returns the command arguments for updating the lock file
@@ -48,13 +51,15 @@ export default class Yarn_berry_processor extends Yarn_processor {
48
51
  if (!depTree) {
49
52
  return new Map();
50
53
  }
51
- return new Map(depTree.filter(dep => !this.#isRoot(dep.value)).map(dep => {
54
+ return new Map(depTree.filter(dep => !this.#isRoot(dep.value))
55
+ .map(dep => {
52
56
  const depName = dep.value;
53
57
  const idx = depName.lastIndexOf('@');
54
58
  const name = depName.substring(0, idx);
55
59
  const version = dep.children.Version;
56
60
  return [name, toPurl(purlType, name, version)];
57
- }));
61
+ })
62
+ .filter(([name]) => this._manifest.dependencies.includes(name)));
58
63
  }
59
64
  /**
60
65
  * Checks if a dependency is the root package
@@ -66,7 +71,8 @@ export default class Yarn_berry_processor extends Yarn_processor {
66
71
  if (!name) {
67
72
  return false;
68
73
  }
69
- return name.endsWith("@workspace:.");
74
+ // Workspace members use paths like "member-a@workspace:packages/member-a", not just "@workspace:."
75
+ return name.startsWith(`${this._manifest.name}@workspace:`);
70
76
  }
71
77
  /**
72
78
  * Adds dependencies to the SBOM
@@ -77,14 +83,58 @@ export default class Yarn_berry_processor extends Yarn_processor {
77
83
  if (!depTree) {
78
84
  return;
79
85
  }
86
+ // Build index of nodes by their value for quick lookup
87
+ const nodeIndex = new Map();
88
+ depTree.forEach(n => nodeIndex.set(n.value, n));
89
+ // Determine the set of node values reachable from root via production deps
90
+ const prodDeps = new Set(this._manifest.dependencies);
91
+ const reachable = new Set();
92
+ const queue = [];
93
+ // Seed with root's production dependencies
94
+ const rootNode = depTree.find(n => this.#isRoot(n.value));
95
+ if (rootNode?.children?.Dependencies) {
96
+ for (const d of rootNode.children.Dependencies) {
97
+ const to = this.#purlFromLocator(d.locator);
98
+ if (to) {
99
+ const fullName = to.namespace ? `${to.namespace}/${to.name}` : to.name;
100
+ if (prodDeps.has(fullName)) {
101
+ queue.push(d.locator);
102
+ }
103
+ }
104
+ }
105
+ }
106
+ // BFS to find all transitively reachable packages
107
+ while (queue.length > 0) {
108
+ const locator = queue.shift();
109
+ if (reachable.has(locator)) {
110
+ continue;
111
+ }
112
+ reachable.add(locator);
113
+ const node = nodeIndex.get(this.#nodeValueFromLocator(locator));
114
+ if (node?.children?.Dependencies) {
115
+ for (const d of node.children.Dependencies) {
116
+ if (!reachable.has(d.locator)) {
117
+ queue.push(d.locator);
118
+ }
119
+ }
120
+ }
121
+ }
122
+ // Only emit edges for root and reachable nodes
80
123
  depTree.forEach(n => {
81
124
  const depName = n.value;
82
- const from = this.#isRoot(depName) ? toPurlFromString(sbom.getRoot().purl) : this.#purlFromNode(depName, n);
125
+ const isRoot = this.#isRoot(depName);
126
+ if (!isRoot && !this.#isReachableNode(depName, reachable)) {
127
+ return;
128
+ }
129
+ const from = isRoot ? toPurlFromString(sbom.getRoot().purl) : this.#purlFromNode(depName, n);
83
130
  const deps = n.children?.Dependencies;
84
131
  if (!deps) {
85
132
  return;
86
133
  }
87
134
  deps.forEach(d => {
135
+ if (!reachable.has(d.locator)) {
136
+ return;
137
+ }
88
138
  const to = this.#purlFromLocator(d.locator);
89
139
  if (to) {
90
140
  sbom.addDependency(from, to);
@@ -92,6 +142,39 @@ export default class Yarn_berry_processor extends Yarn_processor {
92
142
  });
93
143
  });
94
144
  }
145
+ /**
146
+ * Converts a locator to the node value format used in yarn info output
147
+ * @param {string} locator - e.g. "express@npm:4.17.1"
148
+ * @returns {string} The node value, same as locator for non-virtual
149
+ * @private
150
+ */
151
+ #nodeValueFromLocator(locator) {
152
+ // Virtual locators: "@scope/name@virtual:hash#npm:version" → "@scope/name@npm:version"
153
+ const virtualMatch = Yarn_berry_processor.VIRTUAL_LOCATOR_PATTERN.exec(locator);
154
+ if (virtualMatch) {
155
+ return `${virtualMatch[1]}@npm:${virtualMatch[2]}`;
156
+ }
157
+ return locator;
158
+ }
159
+ /**
160
+ * Checks if a node is in the reachable set by matching its value against reachable locators
161
+ * @param {string} depName - The node value (e.g. "express@npm:4.17.1")
162
+ * @param {Set<string>} reachable - Set of reachable locators
163
+ * @returns {boolean}
164
+ * @private
165
+ */
166
+ #isReachableNode(depName, reachable) {
167
+ if (reachable.has(depName)) {
168
+ return true;
169
+ }
170
+ // Check if any reachable locator resolves to this node value
171
+ for (const locator of reachable) {
172
+ if (this.#nodeValueFromLocator(locator) === depName) {
173
+ return true;
174
+ }
175
+ }
176
+ return false;
177
+ }
95
178
  /**
96
179
  * Creates a PackageURL from a dependency locator
97
180
  * @param {string} locator - The dependency locator
@@ -1,4 +1,4 @@
1
- /** @typedef {{name: string, version: string, dependencies: DependencyEntry[]}} DependencyEntry */
1
+ /** @typedef {{name: string, version: string, dependencies: DependencyEntry[], hashes?: Array<{alg: string, content: string}>}} DependencyEntry */
2
2
  export default class Python_controller {
3
3
  /**
4
4
  * Constructor to create new python controller instance to interact with pip package manager
@@ -15,17 +15,24 @@ export default class Python_controller {
15
15
  realEnvironment: boolean;
16
16
  pathToRequirements: string;
17
17
  options: {};
18
+ parser: Promise<import("web-tree-sitter").Parser>;
19
+ requirementsQuery: Promise<import("web-tree-sitter").Query>;
20
+ pinnedVersionQuery: Promise<import("web-tree-sitter").Query>;
18
21
  prepareEnvironment(): void;
19
22
  /**
20
23
  *
21
24
  * @param {boolean} includeTransitive - whether to return include in returned object transitive dependencies or not
22
- * @return {[DependencyEntry]}
25
+ * @return {Promise<[DependencyEntry]>}
23
26
  */
24
- getDependencies(includeTransitive: boolean): [DependencyEntry];
27
+ getDependencies(includeTransitive: boolean): Promise<[DependencyEntry]>;
25
28
  #private;
26
29
  }
27
30
  export type DependencyEntry = {
28
31
  name: string;
29
32
  version: string;
30
33
  dependencies: DependencyEntry[];
34
+ hashes?: Array<{
35
+ alg: string;
36
+ content: string;
37
+ }>;
31
38
  };
@@ -2,6 +2,7 @@ import fs from "node:fs";
2
2
  import path from 'node:path';
3
3
  import os, { EOL } from "os";
4
4
  import { environmentVariableIsPopulated, getCustom, invokeCommand } from "../tools.js";
5
+ import { getParser, getRequirementQuery, getPinnedVersionQuery } from './requirements_parser.js';
5
6
  function getPipFreezeOutput() {
6
7
  try {
7
8
  return environmentVariableIsPopulated("TRUSTIFY_DA_PIP_FREEZE") ? new Buffer.from(process.env["TRUSTIFY_DA_PIP_FREEZE"], 'base64').toString('ascii') : invokeCommand(this.pathToPipBin, ['freeze', '--all']).toString();
@@ -18,7 +19,7 @@ function getPipShowOutput(depNames) {
18
19
  throw new Error('fail invoking \'pip show\' to fetch metadata for all installed packages in environment', { cause: error });
19
20
  }
20
21
  }
21
- /** @typedef {{name: string, version: string, dependencies: DependencyEntry[]}} DependencyEntry */
22
+ /** @typedef {{name: string, version: string, dependencies: DependencyEntry[], hashes?: Array<{alg: string, content: string}>}} DependencyEntry */
22
23
  export default class Python_controller {
23
24
  pythonEnvDir;
24
25
  pathToPipBin;
@@ -26,6 +27,9 @@ export default class Python_controller {
26
27
  realEnvironment;
27
28
  pathToRequirements;
28
29
  options;
30
+ parser;
31
+ requirementsQuery;
32
+ pinnedVersionQuery;
29
33
  /**
30
34
  * Constructor to create new python controller instance to interact with pip package manager
31
35
  * @param {boolean} realEnvironment - whether to use real environment supplied by client or to create virtual environment
@@ -41,6 +45,9 @@ export default class Python_controller {
41
45
  this.prepareEnvironment();
42
46
  this.pathToRequirements = pathToRequirements;
43
47
  this.options = options;
48
+ this.parser = getParser();
49
+ this.requirementsQuery = getRequirementQuery();
50
+ this.pinnedVersionQuery = getPinnedVersionQuery();
44
51
  }
45
52
  prepareEnvironment() {
46
53
  if (!this.realEnvironment) {
@@ -86,6 +93,24 @@ export default class Python_controller {
86
93
  }
87
94
  }
88
95
  }
96
+ /**
97
+ * Parse the requirements.txt file using tree-sitter and return structured requirement data.
98
+ * @return {Promise<{name: string, version: string|null, hasMarker: boolean}[]>}
99
+ */
100
+ async #parseRequirements() {
101
+ const content = fs.readFileSync(this.pathToRequirements).toString();
102
+ const tree = (await this.parser).parse(content);
103
+ return Promise.all((await this.requirementsQuery).matches(tree.rootNode).map(async (match) => {
104
+ const reqNode = match.captures.find(c => c.name === 'req').node;
105
+ const name = match.captures.find(c => c.name === 'name').node.text;
106
+ const versionMatches = (await this.pinnedVersionQuery).matches(reqNode);
107
+ const version = versionMatches.length > 0
108
+ ? versionMatches[0].captures.find(c => c.name === 'version').node.text
109
+ : null;
110
+ const hasMarker = reqNode.children.some(c => c.type === 'marker_spec');
111
+ return { name, version, hasMarker };
112
+ }));
113
+ }
89
114
  #decideIfWindowsOrLinuxPath(fileName) {
90
115
  if (os.platform() === "win32") {
91
116
  return fileName + ".exe";
@@ -97,9 +122,9 @@ export default class Python_controller {
97
122
  /**
98
123
  *
99
124
  * @param {boolean} includeTransitive - whether to return include in returned object transitive dependencies or not
100
- * @return {[DependencyEntry]}
125
+ * @return {Promise<[DependencyEntry]>}
101
126
  */
102
- getDependencies(includeTransitive) {
127
+ async getDependencies(includeTransitive) {
103
128
  let startingTime;
104
129
  let endingTime;
105
130
  if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
@@ -124,10 +149,10 @@ export default class Python_controller {
124
149
  if (matchManifestVersions === "true") {
125
150
  throw new Error("Conflicting settings, TRUSTIFY_DA_PYTHON_INSTALL_BEST_EFFORTS=true can only work with MATCH_MANIFEST_VERSIONS=false");
126
151
  }
127
- this.#installingRequirementsOneByOne();
152
+ await this.#installingRequirementsOneByOne();
128
153
  }
129
154
  }
130
- let dependencies = this.#getDependenciesImpl(includeTransitive);
155
+ let dependencies = await this.#getDependenciesImpl(includeTransitive);
131
156
  this.#cleanEnvironment();
132
157
  if (process.env["TRUSTIFY_DA_DEBUG"] === "true") {
133
158
  endingTime = new Date();
@@ -137,16 +162,14 @@ export default class Python_controller {
137
162
  }
138
163
  return dependencies;
139
164
  }
140
- #installingRequirementsOneByOne() {
141
- let requirementsContent = fs.readFileSync(this.pathToRequirements);
142
- let requirementsRows = requirementsContent.toString().split(EOL);
143
- requirementsRows.filter((line) => !line.trim().startsWith("#")).filter((line) => line.trim() !== "").forEach((dependency) => {
144
- let dependencyName = getDependencyName(dependency);
165
+ async #installingRequirementsOneByOne() {
166
+ const requirements = await this.#parseRequirements();
167
+ requirements.forEach(({ name }) => {
145
168
  try {
146
- invokeCommand(this.pathToPipBin, ['install', dependencyName]);
169
+ invokeCommand(this.pathToPipBin, ['install', name]);
147
170
  }
148
171
  catch (error) {
149
- throw new Error(`Failed in best-effort installing ${dependencyName} in virtual python environment`, { cause: error });
172
+ throw new Error(`Failed in best-effort installing ${name} in virtual python environment`, { cause: error });
150
173
  }
151
174
  });
152
175
  }
@@ -163,34 +186,26 @@ export default class Python_controller {
163
186
  }
164
187
  }
165
188
  }
166
- #getDependenciesImpl(includeTransitive) {
167
- let dependencies = new Array();
189
+ async #getDependenciesImpl(includeTransitive) {
190
+ let dependencies = [];
168
191
  let usePipDepTree = getCustom("TRUSTIFY_DA_PIP_USE_DEP_TREE", "false", this.options);
169
- let freezeOutput;
170
- let lines;
171
- let depNames;
172
- let pipShowOutput;
173
192
  let allPipShowDeps;
174
193
  let pipDepTreeJsonArrayOutput;
175
194
  if (usePipDepTree !== "true") {
176
- freezeOutput = getPipFreezeOutput.call(this);
177
- lines = freezeOutput.split(EOL);
178
- depNames = lines.map(line => getDependencyName(line));
195
+ const freezeOutput = getPipFreezeOutput.call(this);
196
+ const lines = freezeOutput.split(EOL);
197
+ const depNames = lines.map(line => getDependencyName(line));
198
+ const pipShowOutput = getPipShowOutput.call(this, depNames);
199
+ allPipShowDeps = pipShowOutput.split(EOL + "---" + EOL);
179
200
  }
180
201
  else {
181
202
  pipDepTreeJsonArrayOutput = getDependencyTreeJsonFromPipDepTree(this.pathToPipBin, this.pathToPythonBin);
182
203
  }
183
- if (usePipDepTree !== "true") {
184
- pipShowOutput = getPipShowOutput.call(this, depNames);
185
- allPipShowDeps = pipShowOutput.split(EOL + "---" + EOL);
186
- }
187
- //debug
188
- // pipShowOutput = "alternative pip show output goes here for debugging"
189
204
  let matchManifestVersions = getCustom("MATCH_MANIFEST_VERSIONS", "true", this.options);
190
- let linesOfRequirements = fs.readFileSync(this.pathToRequirements).toString().split(EOL).filter((line) => !line.trim().startsWith("#")).map(line => line.trim());
205
+ let parsedRequirements = await this.#parseRequirements();
191
206
  let CachedEnvironmentDeps = {};
192
207
  if (usePipDepTree !== "true") {
193
- allPipShowDeps.forEach((record) => {
208
+ allPipShowDeps.forEach(record => {
194
209
  let dependencyName = getDependencyNameShow(record).toLowerCase();
195
210
  CachedEnvironmentDeps[dependencyName] = record;
196
211
  CachedEnvironmentDeps[dependencyName.replace("-", "_")] = record;
@@ -210,40 +225,27 @@ export default class Python_controller {
210
225
  CachedEnvironmentDeps[packageName.replace("_", "-")] = pipDepTreeEntryForCache;
211
226
  });
212
227
  }
213
- linesOfRequirements.forEach((dep) => {
214
- // if matchManifestVersions setting is turned on , then
215
- if (matchManifestVersions === "true") {
216
- let dependencyName;
217
- let manifestVersion;
228
+ parsedRequirements.forEach(({ name: depName, version: manifestVersion, hasMarker }) => {
229
+ if (hasMarker && CachedEnvironmentDeps[depName.toLowerCase()] === undefined) {
230
+ return;
231
+ }
232
+ if (matchManifestVersions === "true" && manifestVersion != null) {
218
233
  let installedVersion;
219
- let doubleEqualSignPosition;
220
- if (dep.includes("==")) {
221
- doubleEqualSignPosition = dep.indexOf("==");
222
- manifestVersion = dep.substring(doubleEqualSignPosition + 2).trim();
223
- if (manifestVersion.includes("#")) {
224
- let hashCharIndex = manifestVersion.indexOf("#");
225
- manifestVersion = manifestVersion.substring(0, hashCharIndex);
234
+ if (CachedEnvironmentDeps[depName.toLowerCase()] !== undefined) {
235
+ if (usePipDepTree !== "true") {
236
+ installedVersion = getDependencyVersion(CachedEnvironmentDeps[depName.toLowerCase()]);
226
237
  }
227
- dependencyName = getDependencyName(dep);
228
- // only compare between declared version in manifest to installed version , if the package is installed.
229
- if (CachedEnvironmentDeps[dependencyName.toLowerCase()] !== undefined) {
230
- if (usePipDepTree !== "true") {
231
- installedVersion = getDependencyVersion(CachedEnvironmentDeps[dependencyName.toLowerCase()]);
232
- }
233
- else {
234
- installedVersion = CachedEnvironmentDeps[dependencyName.toLowerCase()].version;
235
- }
238
+ else {
239
+ installedVersion = CachedEnvironmentDeps[depName.toLowerCase()].version;
236
240
  }
237
- if (installedVersion) {
238
- if (manifestVersion.trim() !== installedVersion.trim()) {
239
- throw new Error(`Can't continue with analysis - versions mismatch for dependency name ${dependencyName} (manifest version=${manifestVersion}, installed version=${installedVersion}).If you want to allow version mismatch for analysis between installed and requested packages, set environment variable/setting MATCH_MANIFEST_VERSIONS=false`);
240
- }
241
+ }
242
+ if (installedVersion) {
243
+ if (manifestVersion.trim() !== installedVersion.trim()) {
244
+ throw new Error(`Can't continue with analysis - versions mismatch for dependency name ${depName} (manifest version=${manifestVersion}, installed version=${installedVersion}).If you want to allow version mismatch for analysis between installed and requested packages, set environment variable/setting MATCH_MANIFEST_VERSIONS=false`);
241
245
  }
242
246
  }
243
247
  }
244
- let path = new Array();
245
- let depName = getDependencyName(dep);
246
- //array to track a path for each branch in the dependency tree
248
+ let path = [];
247
249
  path.push(depName.toLowerCase());
248
250
  bringAllDependencies(dependencies, depName, CachedEnvironmentDeps, includeTransitive, path, usePipDepTree);
249
251
  });
@@ -347,11 +349,11 @@ function bringAllDependencies(dependencies, dependencyName, cachedEnvironmentDep
347
349
  version = record.version;
348
350
  directDeps = record.dependencies;
349
351
  }
350
- let targetDeps = new Array();
352
+ let targetDeps = [];
351
353
  let entry = { "name": depName, "version": version, "dependencies": [] };
352
354
  dependencies.push(entry);
353
355
  directDeps.forEach((dep) => {
354
- let depArray = new Array();
356
+ let depArray = [];
355
357
  // to avoid infinite loop, check if the dependency not already on current path, before going recursively resolving its dependencies.
356
358
  if (!path.includes(dep.toLowerCase())) {
357
359
  // send to recurrsion the path + the current dep
@@ -3,12 +3,17 @@ declare namespace _default {
3
3
  export { validateLockFile };
4
4
  export { provideComponent };
5
5
  export { provideStack };
6
+ export { readLicenseFromManifest };
6
7
  }
7
8
  export default _default;
8
9
  export type DependencyEntry = {
9
10
  name: string;
10
11
  version: string;
11
12
  dependencies: DependencyEntry[];
13
+ hashes?: Array<{
14
+ alg: string;
15
+ content: string;
16
+ }>;
12
17
  };
13
18
  /**
14
19
  * @param {string} manifestName - the subject manifest name-type
@@ -23,13 +28,19 @@ declare function validateLockFile(): boolean;
23
28
  * Provide content and content type for python-pip component analysis.
24
29
  * @param {string} manifest - path to requirements.txt for component report
25
30
  * @param {{}} [opts={}] - optional various options to pass along the application
26
- * @returns {Provided}
31
+ * @returns {Promise<Provided>}
27
32
  */
28
- declare function provideComponent(manifest: string, opts?: {} | undefined): Provided;
33
+ declare function provideComponent(manifest: string, opts?: {}): Promise<Provided>;
29
34
  /**
30
35
  * Provide content and content type for python-pip stack analysis.
31
36
  * @param {string} manifest - the manifest path or name
32
37
  * @param {{}} [opts={}] - optional various options to pass along the application
33
- * @returns {Provided}
38
+ * @returns {Promise<Provided>}
34
39
  */
35
- declare function provideStack(manifest: string, opts?: {} | undefined): Provided;
40
+ declare function provideStack(manifest: string, opts?: {}): Promise<Provided>;
41
+ /**
42
+ * Python requirements.txt has no standard license field
43
+ * @param {string} manifestPath - path to requirements.txt
44
+ * @returns {string|null}
45
+ */
46
+ declare function readLicenseFromManifest(manifestPath: string): string | null;