mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-31 09:41:46 +00:00
Pradeep Ashwathanarayan
cee4515c2e
fix(gomod): handle bare ../ replace paths in gomodTidyAll When a go.mod file uses a replace directive pointing to the parent directory with no sub-path (e.g. `replace example.com/root => ../`), gomodTidyAll would silently skip running `go mod tidy` on that module and any of its dependents. The root cause was in the `localReplace` regex where the localPath capture group used `\S+` (one or more non-whitespace), so `../` — with nothing after the slash — was never matched. Only paths like `../subdir` were picked up. Changing `\S+` to `\S*` allows zero-or-more trailing characters, so bare `../` and `./` now parse correctly and the dependency graph is built properly.
84 lines
2.4 KiB
TypeScript
84 lines
2.4 KiB
TypeScript
import { Graph, depthFirstSearch, topologicalSort } from 'graph-data-structure';
|
|
import upath from 'upath';
|
|
import { readLocalFile } from '../../../util/fs/index.ts';
|
|
import {
|
|
getMatchingFiles,
|
|
resolveRelativePathToRoot,
|
|
} from '../../../util/fs/util.ts';
|
|
import { regEx } from '../../../util/regex.ts';
|
|
import { scm } from '../../platform/scm.ts';
|
|
|
|
// `[^\S\n]` is horizontal whitespace, so a match never crosses a line boundary.
|
|
// `[^\s/]` rules out comment lines, and lets this match the single line form as
|
|
// well as the lines inside a `replace (...)` block.
|
|
const localReplace = regEx(
|
|
/^[^\S\n]*(?:replace[^\S\n]+)?[^\s/]\S*(?:[^\S\n]+\S+)?[^\S\n]+=>[^\S\n]+(?<localPath>\.{1,2}\/\S*)/gm,
|
|
);
|
|
|
|
/**
|
|
* Get the target paths of all `replace` directives which point to a local directory.
|
|
*/
|
|
export function parseLocalReplacePaths(content: string): string[] {
|
|
return Array.from(
|
|
content.matchAll(localReplace),
|
|
(match) => match.groups!.localPath,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Build a graph of all `go.mod` files based on their local `replace` directives.
|
|
* Edges point from a module to the modules which depend on it, so
|
|
* `graph.adjacent(x)` returns the dependents of `x`.
|
|
*/
|
|
async function buildDependencyGraph(): Promise<Graph> {
|
|
const graph = new Graph();
|
|
const goModFiles = getMatchingFiles('**/go.mod', await scm.getFileList());
|
|
const known = new Set(goModFiles);
|
|
|
|
for (const f of goModFiles) {
|
|
graph.addNode(f);
|
|
}
|
|
|
|
for (const f of goModFiles) {
|
|
const content = await readLocalFile(f, 'utf8');
|
|
if (!content) {
|
|
continue;
|
|
}
|
|
|
|
for (const localPath of parseLocalReplacePaths(content)) {
|
|
const dependency = upath.join(
|
|
resolveRelativePathToRoot(f, localPath),
|
|
'go.mod',
|
|
);
|
|
if (known.has(dependency)) {
|
|
graph.addEdge(dependency, f);
|
|
}
|
|
}
|
|
}
|
|
|
|
return graph;
|
|
}
|
|
|
|
/**
|
|
* Get all `go.mod` files which transitively depend on `packageFileName`, ordered
|
|
* so that a module always comes before the modules which depend on it.
|
|
* The given `packageFileName` is not included.
|
|
*/
|
|
export async function getGoModulesInTidyOrder(
|
|
packageFileName: string,
|
|
): Promise<string[]> {
|
|
const graph = await buildDependencyGraph();
|
|
if (!graph.adjacent(packageFileName)) {
|
|
return [];
|
|
}
|
|
|
|
const dependents = new Set(
|
|
depthFirstSearch(graph, {
|
|
sourceNodes: [packageFileName],
|
|
includeSourceNodes: false,
|
|
}),
|
|
);
|
|
|
|
return topologicalSort(graph).filter((f) => dependents.has(f));
|
|
}
|