Skip to content

feat: resolve full dependency tree #9

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
48 changes: 41 additions & 7 deletions src/domain/getPackageDependencies.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
PackageVersion,
} from "./types";
import { maxSatisfying } from "semver";
import axios from "axios";

/**
* A function which resolves the direct dependencies of a
Expand All @@ -25,7 +26,7 @@ export async function getPackageDependencies(
packageName: PackageName,
packageVersion: PackageVersion,
getPackage: PackageGetter,
): Promise<Record<PackageName, PackageVersion>> {
): Promise<Record<PackageName, Package>> {
const npmPackage: NPMPackage = await getPackage(packageName);

const packageForVersion = npmPackage.versions[packageVersion];
Expand All @@ -34,15 +35,48 @@ export async function getPackageDependencies(
}

const dependenciesWithRange = packageForVersion?.dependencies ?? {};
const dependencies: Record<PackageName, PackageVersion> = {};
const dependencies: Record<string, Package> = {};

for (const [dependencyName, range] of Object.entries(dependenciesWithRange)) {
const dependency: NPMPackage = await getPackage(dependencyName);

const maxSatisfyingVersion =
maxSatisfying(Object.keys(dependency.versions), range) ?? range;
dependencies[dependencyName] = maxSatisfyingVersion;
dependencies[dependencyName] = await resolveDependenciesRecursively(
dependencyName,
range,
);
}

return dependencies;
}

async function resolveDependenciesRecursively(
name: string,
range: string,
): Promise<Package> {
const npmPackage = await (
await axios.get(`https://registry.npmjs.org/${name}`)
).data;

const maxSatisfyingVersion = maxSatisfying(
Object.keys(npmPackage.versions),
range,
) as string;

if (!npmPackage.versions[maxSatisfyingVersion]) {
throw new Error();
}

const dependencies: Record<string, Package> = {};
for (const [name, range] of Object.entries(
npmPackage.versions[maxSatisfyingVersion].dependencies ?? {},
)) {
// eslint-disable-next-line
// @ts-ignore
dependencies[name] = await resolveDependenciesRecursively(name, range);
}

return { version: maxSatisfyingVersion, dependencies };
}

interface Package {
version: string;
dependencies: Record<PackageName, Package>;
}
9 changes: 7 additions & 2 deletions tests/routes/getPackage.integration.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ describe("/package/:packageName/:packageVersion endpoint", () => {
server.close();
});

it("responds with list of dependencies", async () => {
it("responds with a tree of dependencies", async () => {
const packageName = "react";
const version = "16.3.0";
const address = `http://localhost:${port}/package/${packageName}/${version}`;
Expand All @@ -42,7 +42,12 @@ describe("/package/:packageName/:packageVersion endpoint", () => {
const expectedResponse = {
name: "react",
version: "16.3.0",
dependencies: { "loose-envify": "1.1.0" },
dependencies: {
"loose-envify": {
version: "1.1.0",
dependencies: { "js-tokens": { version: "1.0.3", dependencies: {} } },
},
},
};

expect(response.data).toEqual(expectedResponse);
Expand Down
Loading