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(npm): Use schema for PackageSource parsing #22314

Merged
merged 3 commits into from May 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
80 changes: 52 additions & 28 deletions lib/modules/datasource/npm/get.ts
@@ -1,6 +1,7 @@
import url from 'node:url';
import is from '@sindresorhus/is';
import { DateTime } from 'luxon';
import { z } from 'zod';
import { GlobalConfig } from '../../../config/global';
import { HOST_DISABLED } from '../../../constants/error-messages';
import { logger } from '../../../logger';
Expand All @@ -13,11 +14,6 @@ import { joinUrlParts } from '../../../util/url';
import type { Release, ReleaseResult } from '../types';
import type { CachedReleaseResult, NpmResponse } from './types';

interface PackageSource {
sourceUrl?: string;
sourceDirectory?: string;
}

const SHORT_REPO_REGEX = regEx(
/^((?<platform>bitbucket|github|gitlab):)?(?<shortRepo>[A-Za-z0-9_.-]+\/[A-Za-z0-9_.-]+)$/
);
Expand All @@ -28,27 +24,49 @@ const platformMapping: Record<string, string> = {
gitlab: 'https://gitlab.com/',
};

function getPackageSource(repository: any): PackageSource {
const res: PackageSource = {};
if (repository) {
if (is.nonEmptyString(repository)) {
const shortMatch = repository.match(SHORT_REPO_REGEX);
if (shortMatch?.groups) {
const { platform = 'github', shortRepo } = shortMatch.groups;
res.sourceUrl = platformMapping[platform] + shortRepo;
} else {
res.sourceUrl = repository;
}
} else if (is.nonEmptyString(repository.url)) {
res.sourceUrl = repository.url;
}
if (is.nonEmptyString(repository.directory)) {
res.sourceDirectory = repository.directory;
}
}
return res;
interface PackageSource {
sourceUrl: string | null;
sourceDirectory: string | null;
}

const PackageSource = z
.union([
z
.string()
.nonempty()
.transform((repository): PackageSource => {
let sourceUrl: string | null = null;
const sourceDirectory = null;
const shortMatch = repository.match(SHORT_REPO_REGEX);
if (shortMatch?.groups) {
const { platform = 'github', shortRepo } = shortMatch.groups;
sourceUrl = platformMapping[platform] + shortRepo;
} else {
sourceUrl = repository;
}
return { sourceUrl, sourceDirectory };
}),
z
.object({
url: z.string().nonempty().nullish(),
directory: z.string().nonempty().nullish(),
})
.transform(({ url, directory }) => {
const res: PackageSource = { sourceUrl: null, sourceDirectory: null };

if (url) {
res.sourceUrl = url;
}

if (directory) {
res.sourceDirectory = directory;
}

return res;
}),
])
.catch({ sourceUrl: null, sourceDirectory: null });

export async function getDependency(
http: Http,
registryUrl: string,
Expand Down Expand Up @@ -124,18 +142,24 @@ export async function getDependency(
res.repository ??= latestVersion?.repository;
res.homepage ??= latestVersion?.homepage;

const { sourceUrl, sourceDirectory } = getPackageSource(res.repository);
const { sourceUrl, sourceDirectory } = PackageSource.parse(res.repository);

// Simplify response before caching and returning
const dep: ReleaseResult = {
homepage: res.homepage,
sourceUrl,
sourceDirectory,
releases: [],
tags: res['dist-tags'],
registryUrl,
};

if (sourceUrl) {
dep.sourceUrl = sourceUrl;
}

if (sourceDirectory) {
dep.sourceDirectory = sourceDirectory;
}

if (latestVersion?.deprecated) {
dep.deprecationMessage = `On registry \`${registryUrl}\`, the "latest" version of dependency \`${packageName}\` has the following deprecation notice:\n\n\`${latestVersion.deprecated}\`\n\nMarking the latest version of an npm package as deprecated results in the entire package being considered deprecated, so contact the package author you think this is a mistake.`;
}
Expand All @@ -152,7 +176,7 @@ export async function getDependency(
if (res.versions?.[version].deprecated) {
release.isDeprecated = true;
}
const source = getPackageSource(res.versions?.[version].repository);
const source = PackageSource.parse(res.versions?.[version].repository);
if (source.sourceUrl && source.sourceUrl !== dep.sourceUrl) {
release.sourceUrl = source.sourceUrl;
}
Expand Down