refactor: better tree shaping

guardian · Jan 24, 2023 · ce37682 · ce37682
1 parent 2f2b82b
commit ce37682
Show file tree

Hide file tree

Showing 10 changed files with 149 additions and 95 deletions.
diff --git a/colours.ts b/colours.ts
@@ -2,6 +2,8 @@ import {
   blue,
   cyan,
   gray,
+  green,
+  red,
   yellow,
 } from "https://deno.land/[email protected]/fmt/colors.ts";
 
@@ -12,6 +14,8 @@ export const colour = {
   file: cyan,
   subdued: gray,
   version: yellow,
+  valid: green,
+  invalid: red,
 };
 
 export const format = (name: string, range: Range) =>

diff --git a/fetch_peer_dependencies.test.ts b/fetch_peer_dependencies.test.ts
@@ -14,7 +14,8 @@ Deno.test("Can get peer dependencies", async () => {
     {
       name: "@guardian/core-web-vitals",
       range: new Range("2.0.2"),
-      versions: [new SemVer("2.0.2")],
+      version: new SemVer("2.0.2"),
+      dependencies: [],
       peers: [
         {
           name: "@guardian/libs",
@@ -50,7 +51,8 @@ Deno.test("Can get optional peer dependencies", async () => {
     {
       name: "@guardian/libs",
       range: new Range("12.0.0"),
-      versions: [new SemVer("12.0.0")],
+      version: new SemVer("12.0.0"),
+      dependencies: [],
       peers: [
         {
           name: "tslib",
@@ -78,7 +80,8 @@ Deno.test("Will fail on optional dependencies that are defined locally", async (
     {
       name: "@guardian/libs",
       range: new Range("12.0.0"),
-      versions: [new SemVer("12.0.0")],
+      version: new SemVer("12.0.0"),
+      dependencies: [],
       peers: [
         {
           name: "tslib",
@@ -95,13 +98,15 @@ Deno.test("Will fail on optional dependencies that are defined locally", async (
     {
       name: "tslib",
       range: new Range("2.4.1"),
-      versions: [new SemVer("2.4.1")],
+      version: new SemVer("2.4.1"),
+      dependencies: [],
       peers: [],
     },
     {
       name: "typescript",
       range: new Range("4.2.2"),
-      versions: [new SemVer("4.2.2")],
+      version: new SemVer("4.2.2"),
+      dependencies: [],
       peers: [],
     },
   ]);

diff --git a/fetch_peer_dependencies.ts b/fetch_peer_dependencies.ts
@@ -13,18 +13,19 @@ import {
 import type { Dependency, RegistryDependency } from "./types.ts";
 
 const { parseAsync: parse_peers } = object({
-  versions: record(object({
-    version: string(),
-    dependencies: record(string()).optional(),
-    peerDependencies: record(string()).optional(),
-    peerDependenciesMeta: record(object({ optional: boolean() }))
-      .optional(),
-  })),
+  versions: record(
+    object({
+      version: string(),
+      dependencies: record(string()).optional(),
+      peerDependencies: record(string()).optional(),
+      peerDependenciesMeta: record(object({ optional: boolean() })).optional(),
+    }),
+  ),
 });
 
 export const fetch_peer_dependencies = (
   dependencies: Dependency[],
-  { verbose = false, cache = false } = {},
+  { cache = false } = {},
 ): Promise<RegistryDependency[]> =>
   Promise.all(
     dependencies.map((dependency) =>
@@ -38,29 +39,20 @@ export const fetch_peer_dependencies = (
         .then((res) => res.json())
         .then(parse_peers)
         .then((registry) => {
-          const [version, ...versions] = Object.values(registry.versions)
-            .filter(({ version }) => satisfies(version, dependency.range));
+          const version = Object.values(registry.versions).find(({ version }) =>
+            satisfies(version, dependency.range)
+          );
 
           if (!version) {
             throw new Error(
-              `Could not find ${dependency.name}@${dependency.range.range}`,
-            );
-          }
-
-          if (verbose && Object.keys(version.dependencies ?? {}).length > 0) {
-            console.warn(
-              `🔍 ${
-                format(dependency.name, dependency.range)
-              } – futher deps not analysed`,
+              `Could not find ${format(dependency.name, dependency.range)}`,
             );
           }
 
           const peers = version.peerDependencies
-            ? Object.entries(version.peerDependencies).map((
-              [name, range],
-            ) => {
-              const local_version = dependencies.find((dependency) =>
-                dependency.name === name
+            ? Object.entries(version.peerDependencies).map(([name, range]) => {
+              const local_version = dependencies.find(
+                (dependency) => dependency.name === name,
               )?.range;
 
               const local_min_version = local_version
@@ -77,21 +69,22 @@ export const fetch_peer_dependencies = (
                 ? local_version_matches
                 : is_optional;
 
-              return ({
+              return {
                 name,
                 range: new Range(range),
                 satisfied,
-              });
+              };
             })
             : [];
 
-          return ({
+          return {
             ...dependency,
-            peers,
-            versions: [version, ...versions].map(({ version }) =>
-              new SemVer(version)
+            dependencies: Object.entries(version.dependencies ?? {}).map(
+              ([name, range]) => ({ name, range: new Range(range) }),
             ),
-          });
+            peers,
+            version: new SemVer(version.version),
+          };
         })
         .catch((error) => {
           console.error("🚨 Failed to parse package.json for", dependency.name);
@@ -101,19 +94,25 @@ export const fetch_peer_dependencies = (
   );
 
 Deno.bench("Fetch with cache", async () => {
-  await fetch_peer_dependencies([
-    {
-      name: "@guardian/core-web-vitals",
-      range: new Range("2.0.2"),
-    },
-  ], { cache: true });
+  await fetch_peer_dependencies(
+    [
+      {
+        name: "@guardian/core-web-vitals",
+        range: new Range("2.0.2"),
+      },
+    ],
+    { cache: true },
+  );
 });
 
 Deno.bench("Fetch without cache", async () => {
-  await fetch_peer_dependencies([
-    {
-      name: "@guardian/core-web-vitals",
-      range: new Range("2.0.2"),
-    },
-  ], { cache: false });
+  await fetch_peer_dependencies(
+    [
+      {
+        name: "@guardian/core-web-vitals",
+        range: new Range("2.0.2"),
+      },
+    ],
+    { cache: false },
+  );
 });
diff --git a/find_mismatches.test.ts b/find_mismatches.test.ts
@@ -8,7 +8,8 @@ Deno.test("Works when all dependencies are matched", () => {
       {
         name: "one",
         range: new Range("1.0.0"),
-        versions: [new SemVer("1.0.0")],
+        version: new SemVer("1.0.0"),
+        dependencies: [],
         peers: [
           {
             name: "two",
@@ -25,7 +26,8 @@ Deno.test("Works when all dependencies are matched", () => {
       {
         name: "two",
         range: new Range("2.0.2"),
-        versions: [new SemVer("2.0.2")],
+        version: new SemVer("2.0.2"),
+        dependencies: [],
         peers: [
           { name: "four", satisfied: true, range: new Range("^4") },
         ],
@@ -41,7 +43,8 @@ Deno.test("Fails on invalid range", () => {
       {
         name: "one",
         range: new Range("1.0.0"),
-        versions: [new SemVer("1.0.0")],
+        version: new SemVer("1.0.0"),
+        dependencies: [],
         peers: [
           {
             name: "two",
@@ -53,7 +56,8 @@ Deno.test("Fails on invalid range", () => {
       {
         name: "two",
         range: new Range("2.0.2"),
-        versions: [new SemVer("2.0.2")],
+        version: new SemVer("2.0.2"),
+        dependencies: [],
         peers: [],
       },
     ]),

diff --git a/find_mismatches.ts b/find_mismatches.ts
@@ -3,40 +3,45 @@ import { RegistryDependency } from "./types.ts";
 
 export const count_unsatisfied_peer_dependencies = (
   dependencies: RegistryDependency[],
-  verbose = true,
 ) =>
-  dependencies.map(({ name, range, peers }) => {
-    if (peers.length === 0) return 0;
+  dependencies.map(({ peers }) =>
+    peers.filter((peer) => !peer.satisfied).length
+  )
+    .reduce((acc, curr) => acc + curr);
 
-    const { length: unsatisfied } = peers.filter((peer) => !peer.satisfied);
+export const format_dependencies = (
+  dependencies: RegistryDependency[],
+  verbose = true,
+): void => {
+  dependencies.map(({ name, range, dependencies, peers }) => {
+    console.info(
+      `├─ ${format(name, range)}`,
+    );
 
-    if (unsatisfied === 0) {
-      if (verbose) {
-        console.info(
-          `✅ ${format(name, range)} – all ${
-            colour.file("peerDependencies")
-          } satisfied`,
-        );
-      }
-      return 0;
+    let count = dependencies.length;
+    for (const dependency of dependencies) {
+      const angle = peers.length === 0 && --count === 0 ? "╰" : "├";
+      console.warn(
+        `│  ${angle}─ ${colour.version("▲")} ${
+          format(dependency.name, dependency.range)
+        } – futher ${colour.file("dependencies")} not analysed`,
+      );
     }
 
-    console.error(
-      `🚨 ${format(name, range)} – unsatisfied ${
-        colour.file("peerDependencies")
-      }`,
-    );
-
+    count = peers.length;
     for (const { name, range, satisfied } of peers) {
+      const angle = --count === 0 ? "╰" : "├";
       if (satisfied) {
         if (verbose) {
-          console.info(`   - ✅ ${format(name, range)}`);
+          console.info(
+            `│  ${angle}─ ${colour.valid("○")} ${format(name, range)}`,
+          );
         }
       } else {
         console.error(
-          `   - 🚨 ${format(name, range)}`,
+          `│  ${angle}─ ${colour.invalid("✕")} ${format(name, range)}`,
         );
       }
     }
-    return unsatisfied;
-  }).reduce((acc, curr) => acc + curr);
+  });
+};
diff --git a/fixtures/package.json b/fixtures/package.json
@@ -1,4 +1,6 @@
 {
+  "name": "npm-dependencies",
+  "version": "0.0.1",
   "dependencies": {
     "@guardian/source-foundations": "8.0.0",
     "@guardian/core-web-vitals": "2.0.2"

diff --git a/fixtures/package_valid.json b/fixtures/package_valid.json
@@ -1,4 +1,6 @@
 {
+  "name": "npm-dependencies",
+  "version": "0.0.1",
   "dependencies": {
     "@guardian/ab-core": "2.0.0",
     "@guardian/core-web-vitals": "2.0.2",