Apply suggestions from code review

microsoft · Oct 27, 2020 · a14ab1a · a14ab1a
1 parent b5e7c98
commit a14ab1a
Show file tree

Hide file tree

Showing 6 changed files with 135 additions and 88 deletions.
diff --git a/packages/deprecate/package.json b/packages/deprecate/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "@definitelytyped/deprecate",
+  "version": "1.0.0",
+  "description": "Loop over the @types packages in npm and mark any that no longer exist in HEAD as deprecated.",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "bin": "dist/index.js",
+  "scripts": {
+    "build": "tsc --build"
+  },
+  "dependencies": {
+    "@definitelytyped/definitions-parser": "^0.0.58-next.6",
+    "@definitelytyped/publisher": "^0.0.58-next.6",
+    "@definitelytyped/utils": "^0.0.58-next.3",
+    "@octokit/graphql": "^4.5.6",
+    "yargs": "^16.1.0"
+  },
+  "devDependencies": {
+    "@types/libnpmsearch": "^2.0.1"
+  }
+}
diff --git a/packages/deprecate/src/index.ts b/packages/deprecate/src/index.ts
@@ -0,0 +1,104 @@
+#!/usr/bin/env node
+
+import { graphql } from "@octokit/graphql";
+import search = require("libnpmsearch");
+import * as yargs from "yargs";
+
+import { AllPackages, getDefinitelyTyped } from "@definitelytyped/definitions-parser";
+import { getSecret, Secret } from "@definitelytyped/publisher/dist/lib/secrets";
+import { loggerWithErrors, NpmPublishClient } from "@definitelytyped/utils";
+
+async function main() {
+  const [log] = loggerWithErrors();
+
+  const options = {
+    definitelyTypedPath: `${__dirname}/../../../../DefinitelyTyped`,
+    progress: true,
+    parseInParallel: true
+  };
+  const dt = await getDefinitelyTyped(options, log);
+  const allPackages = await AllPackages.read(dt);
+
+  const { dry } = yargs.argv;
+  const client = dry || (await NpmPublishClient.create(await getSecret(Secret.NPM_TOKEN)));
+
+  // Loop over the @types packages in npm and mark any that no longer
+  // exist in HEAD as deprecated.
+  let from = 0;
+  let objects;
+  do {
+    const opts = {
+      limit: 250,
+      from
+    };
+    objects = await search("@types", opts);
+    for (const { name: fullNpmName } of objects) {
+      const name = fullNpmName.slice("@types/".length);
+      // If they don't exist in the types directory or in
+      // notNeededPackages.json then mark them deprecated. Reference the
+      // commit/pull request that removed them.
+      if (!allPackages.tryGetLatestVersion(name) && !allPackages.getNotNeededPackage(name)) {
+        log.info(`Deprecating ${name}`);
+        const {
+          repository: {
+            ref: {
+              target: {
+                history: {
+                  nodes: [commit]
+                }
+              }
+            }
+          }
+        } = await graphql(
+          `
+            query($path: String!) {
+              repository(name: "DefinitelyTyped", owner: "DefinitelyTyped") {
+                ref(qualifiedName: "master") {
+                  target {
+                    ... on Commit {
+                      history(first: 1, path: $path) {
+                        nodes {
+                          associatedPullRequests(first: 1) {
+                            nodes {
+                              url
+                            }
+                          }
+                          messageHeadline
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          `,
+          {
+            headers: { authorization: `token ${process.env.GH_API_TOKEN}` },
+            path: `types/${name}`
+          }
+        );
+        let deprecatedMessage;
+        if (commit) {
+          const {
+            associatedPullRequests: {
+              nodes: [pullRequest]
+            },
+            messageHeadline
+          } = commit;
+          deprecatedMessage = messageHeadline;
+          if (pullRequest) {
+            deprecatedMessage += ` (${pullRequest.url})`;
+          }
+        }
+        if (dry) {
+          log.info(`(dry) Skip deprecate removed package ${fullNpmName}`);
+        } else {
+          log.info(`Deprecating ${fullNpmName} with message: ${deprecatedMessage}`);
+          await (client as NpmPublishClient).deprecate(fullNpmName, "", deprecatedMessage);
+        }
+      }
+    }
+    from += objects.length;
+  } while (objects.length >= 250 && from <= 5000);
+}
+main();
diff --git a/packages/deprecate/tsconfig.json b/packages/deprecate/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "references": [{ "path": "../definitions-parser" }, { "path": "../publisher" }, { "path": "../utils" }]
+}
diff --git a/packages/publisher/package.json b/packages/publisher/package.json
@@ -11,7 +11,6 @@
     "@definitelytyped/retag": "^0.0.58-next.6",
     "@definitelytyped/typescript-versions": "^0.0.57",
     "@definitelytyped/utils": "^0.0.58-next.3",
-    "@octokit/graphql": "^4.5.6",
     "@octokit/rest": "^16.1.0",
     "adal-node": "^0.1.22",
     "applicationinsights": "^1.0.7",
@@ -28,7 +27,6 @@
   },
   "devDependencies": {
     "@types/fs-extra": "4.0.0",
-    "@types/libnpmsearch": "^2.0.1",
     "@types/mz": "^0.0.31",
     "@types/node": "^12.12.29",
     "@types/oboe": "^2.0.28",

diff --git a/packages/publisher/src/full.ts b/packages/publisher/src/full.ts
@@ -51,7 +51,7 @@ export default async function full(
   const changedPackages = await calculateVersions(dt, infoClient, log);
   await generatePackages(dt, allPackages, changedPackages);
   await createSearchIndex(allPackages, infoClient);
-  await publishPackages(allPackages, changedPackages, dry, githubAccessToken, fetcher);
+  await publishPackages(changedPackages, dry, githubAccessToken, fetcher);
   await publishRegistry(dt, allPackages, dry, infoClient);
   await validate(dt);
 }
diff --git a/packages/publisher/src/publish-packages.ts b/packages/publisher/src/publish-packages.ts
@@ -1,6 +1,4 @@
 import applicationinsights = require("applicationinsights");
-import search = require("libnpmsearch");
-import { graphql } from "@octokit/graphql";
 import * as yargs from "yargs";
 
 import { defaultLocalOptions } from "./lib/common";
@@ -54,10 +52,8 @@ if (!module.parent) {
         log
       );
     } else {
-      const allPackages = await AllPackages.read(dt);
       await publishPackages(
-        allPackages,
-        await readChangedPackages(allPackages),
+        await readChangedPackages(await AllPackages.read(dt)),
         dry,
         process.env.GH_API_TOKEN || "",
         new Fetcher()
@@ -67,7 +63,6 @@ if (!module.parent) {
 }
 
 export default async function publishPackages(
-  allPackages: AllPackages,
   changedPackages: ChangedPackages,
   dry: boolean,
   githubAccessToken: string,
@@ -192,85 +187,6 @@ export default async function publishPackages(
     cacheDirPath
   );
 
-  // Loop over the @types packages in npm and mark any that no longer
-  // exist in HEAD as deprecated.
-  let from = 0;
-  let objects;
-  do {
-    const opts = {
-      limit: 250,
-      from
-    };
-    objects = await search("@types", opts);
-    for (const { name: fullNpmName } of objects) {
-      const name = fullNpmName.slice("@types/".length);
-      // If they don't exist in the types directory or in
-      // notNeededPackages.json then mark them deprecated. Reference the
-      // commit/pull request that removed them.
-      if (!allPackages.tryGetLatestVersion(name) && !allPackages.getNotNeededPackage(name)) {
-        log(`Deprecating ${name}`);
-        const {
-          repository: {
-            ref: {
-              target: {
-                history: {
-                  nodes: [commit]
-                }
-              }
-            }
-          }
-        } = await graphql(
-          `
-            query($path: String!) {
-              repository(name: "DefinitelyTyped", owner: "DefinitelyTyped") {
-                ref(qualifiedName: "master") {
-                  target {
-                    ... on Commit {
-                      history(first: 1, path: $path) {
-                        nodes {
-                          associatedPullRequests(first: 1) {
-                            nodes {
-                              url
-                            }
-                          }
-                          messageHeadline
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          `,
-          {
-            headers: { authorization: `token ${githubAccessToken}` },
-            path: `types/${name}`
-          }
-        );
-        let deprecatedMessage;
-        if (commit) {
-          const {
-            associatedPullRequests: {
-              nodes: [pullRequest]
-            },
-            messageHeadline
-          } = commit;
-          deprecatedMessage = messageHeadline;
-          if (pullRequest) {
-            deprecatedMessage += ` (${pullRequest.url})`;
-          }
-        }
-        if (dry) {
-          log(`(dry) Skip deprecate removed package ${fullNpmName}`);
-        } else {
-          log(`Deprecating ${fullNpmName} with message: ${deprecatedMessage}`);
-          await client.deprecate(fullNpmName, "", deprecatedMessage);
-        }
-      }
-    }
-    from += objects.length;
-  } while (objects.length >= 250 && from <= 5000);
-
   await writeLog("publishing.md", logResult());
   console.log("Done!");
 }