Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Simplify lookup function #32968

Merged
merged 1 commit into from
Dec 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 0 additions & 56 deletions lib/workers/repository/process/__snapshots__/fetch.spec.ts.snap

This file was deleted.

45 changes: 43 additions & 2 deletions lib/workers/repository/process/fetch.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,33 @@ describe('workers/repository/process/fetch', () => {
],
};
await fetchUpdates(config, packageFiles);
expect(packageFiles).toMatchSnapshot();
expect(packageFiles).toEqual({
npm: [
{
deps: [
{
depName: 'abcd',
packageName: 'abcd',
skipReason: 'ignored',
updates: [],
},
{
depName: 'foo',
packageName: 'foo',
skipReason: 'disabled',
updates: [],
},
{
depName: 'skipped',
packageName: 'skipped',
skipReason: 'some-reason',
updates: [],
},
],
packageFile: 'package.json',
},
],
});
expect(packageFiles.npm[0].deps[0].skipReason).toBe('ignored');
expect(packageFiles.npm[0].deps[0].updates).toHaveLength(0);
expect(packageFiles.npm[0].deps[1].skipReason).toBe('disabled');
Expand All @@ -71,7 +97,22 @@ describe('workers/repository/process/fetch', () => {
};
lookupUpdates.mockResolvedValue({ updates: ['a', 'b'] } as never);
await fetchUpdates(config, packageFiles);
expect(packageFiles).toMatchSnapshot();
expect(packageFiles).toEqual({
maven: [
{
deps: [
{
datasource: 'maven',
depName: 'bbb',
packageName: 'bbb',
updates: ['a', 'b'],
},
],
extractedConstraints: { other: 'constraint', some: 'constraint' },
packageFile: 'pom.xml',
},
],
});
});

it('skips deps with empty names', async () => {
Expand Down
77 changes: 49 additions & 28 deletions lib/workers/repository/process/fetch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,38 @@ import { Result } from '../../../util/result';
import { LookupStats } from '../../../util/stats';
import { PackageFiles } from '../package-files';
import { lookupUpdates } from './lookup';
import type { LookupUpdateConfig } from './lookup/types';
import type { LookupUpdateConfig, UpdateResult } from './lookup/types';

async function fetchDepUpdates(
type LookupResult = Result<PackageDependency, Error>;

async function lookup(
packageFileConfig: RenovateConfig & PackageFile,
indep: PackageDependency,
): Promise<Result<PackageDependency, Error>> {
): Promise<LookupResult> {
const dep = clone(indep);

dep.updates = [];

if (is.string(dep.depName)) {
dep.depName = dep.depName.trim();
}

dep.packageName ??= dep.depName;

if (dep.skipReason) {
return Result.ok(dep);
}

if (!is.nonEmptyString(dep.packageName)) {
dep.skipReason = 'invalid-name';
return Result.ok(dep);
}

if (dep.isInternal && !packageFileConfig.updateInternalDeps) {
dep.skipReason = 'internal-package';
}
if (dep.skipReason) {
return Result.ok(dep);
}

const { depName } = dep;
// TODO: fix types
let depConfig = mergeChildConfig(packageFileConfig, dep);
Expand All @@ -46,24 +57,33 @@ async function fetchDepUpdates(
depConfig.versioning ??= getDefaultVersioning(depConfig.datasource);
depConfig = await applyPackageRules(depConfig, 'pre-lookup');
depConfig.packageName ??= depConfig.depName;

if (depConfig.ignoreDeps!.includes(depName!)) {
// TODO: fix types (#22198)
logger.debug(`Dependency: ${depName!}, is ignored`);
dep.skipReason = 'ignored';
} else if (depConfig.enabled === false) {
return Result.ok(dep);
}

if (depConfig.enabled === false) {
logger.debug(`Dependency: ${depName!}, is disabled`);
dep.skipReason = 'disabled';
} else {
if (depConfig.datasource) {
const { val: updateResult, err } = await LookupStats.wrap(
depConfig.datasource,
() =>
Result.wrap(lookupUpdates(depConfig as LookupUpdateConfig)).unwrap(),
);

if (updateResult) {
Object.assign(dep, updateResult);
} else {
return Result.ok(dep);
}

if (!depConfig.datasource) {
return Result.ok(dep);
}

return LookupStats.wrap(depConfig.datasource, async () => {
return await Result.wrap(lookupUpdates(depConfig as LookupUpdateConfig))
.onValue((dep) => {
logger.trace({ dep }, 'Dependency lookup success');
})
.onError((err) => {
logger.trace({ err, depName }, 'Dependency lookup error');
})
.catch((err): Result<UpdateResult, Error> => {
if (
packageFileConfig.repoIsOnboarded === true ||
!(err instanceof ExternalHostError)
Expand All @@ -72,17 +92,18 @@ async function fetchDepUpdates(
}

const cause = err.err;
dep.warnings ??= [];
dep.warnings.push({
topic: 'Lookup Error',
// TODO: types (#22198)
message: `${depName!}: ${cause.message}`,
return Result.ok({
updates: [],
warnings: [
{
topic: 'Lookup Error',
message: `${depName}: ${cause.message}`,
},
],
});
}
}
dep.updates ??= [];
}
return Result.ok(dep);
})
.transform((upd): PackageDependency => Object.assign(dep, upd));
});
}

async function fetchManagerPackagerFileUpdates(
Expand All @@ -101,7 +122,7 @@ async function fetchManagerPackagerFileUpdates(
const { manager } = packageFileConfig;
const queue = pFile.deps.map(
(dep) => async (): Promise<PackageDependency> => {
const updates = await fetchDepUpdates(packageFileConfig, dep);
const updates = await lookup(packageFileConfig, dep);
return updates.unwrapOrThrow();
},
);
Expand Down
Loading