Chore/circular import cleanup (#4957)

* fix bad imports in extension-shared.ts

* fix bad types imports from src/command/render/filters.ts

* fix bad imports from parse-shortcode.ts

* fix bad imports from lib/errors.ts

* fix bad imports from src/core/process.ts

* fix bad imports from src/format/reveal/format-reveal.ts

* fix bad imports from src/core/http.ts

* fix bad imports from src/core/http.ts

* fix bad imports from src/core/port.ts

* fix bad imports from src/publish/provider.ts

* fix bad imports from src/core/console-types.ts

* fix import in test

* fix circular imports

* fix more circular imports

* fix more cyclic imports

* more cyclic imports cleanup

* speed up reporting tool

* remove print

* more cyclic dependencies cleanup

* move constants

* split off render services

* add missing change from prev commit

* add missing files

* invert dependency arrow for format-html and format-reveal

* invert dependency arrow for format-asciidoc

Author: cscheid

package/src/common/import-report/circular-imports.png

@@ -117,7 +117,6 @@ export function graphTranspose(graph: DependencyGraph): DependencyGraph {
 
 export function reachability(
   graph: DependencyGraph,
-  _source: string,
 ): Record<string, Set<string>> {
   const result: Record<string, Set<string>> = Object.fromEntries(
     Object.keys(graph).map((k) => [k, new Set()]),

package/src/common/import-report/deno-info.ts

@@ -10,16 +10,74 @@ import {
 
 import { longestCommonDirPrefix } from "./utils.ts";
 
+function dropTypesFiles(edges: Edge[])
+{
+  return edges.filter(({
+    "from": edgeFrom,
+    to,
+  }) => !(to.endsWith("types.ts") || edgeFrom.endsWith("types.ts")));
+}
+
+function trimCommonPrefix(edges: Edge[])
+{
+  // https://stackoverflow.com/a/68702966
+  const strs: Set<string> = new Set();
+  for (const { "from": edgeFrom, to } of edges) {
+    strs.add(edgeFrom);
+    strs.add(to);
+  }
+  const p = longestCommonDirPrefix(Array.from(strs)).length;
+  return edges.map(({ "from": edgeFrom, to }) => ({
+    "from": edgeFrom.slice(p),
+    to: to.slice(p),
+  }));
+}
+
+function simplify(
+  edges: Edge[],
+  prefixes: string[],
+): Edge[]
+{
+  edges = trimCommonPrefix(edges);
+
+  const result: Edge[] = [];
+  const keepPrefix = (s: string) => {
+    for (const prefix of prefixes) {
+      if (s.startsWith(prefix)) {
+        return prefix + "...";
+      }
+    }
+    return s;
+  }
+  const edgeSet = new Set<string>();
+  for (const edge of edges) {
+    const from = keepPrefix(edge.from);
+    const to = keepPrefix(edge.to);
+    if (from === to) {
+      continue;
+    }
+    const key = `${from} -> ${to}`;
+    if (edgeSet.has(key)) {
+      continue;
+    }
+    edgeSet.add(key);
+    result.push({ from, to });
+  }
+  return result;
+}
+
 function explain(
   graph: DependencyGraph,
 ): Edge[] {
   const result: Edge[] = [];
   const transpose = graphTranspose(graph);
   const visited: Set<string> = new Set();
   let found = false;
+  let count = 0;
+
+  const deps = reachability(graph);
 
   for (const source of Object.keys(graph)) {
-    const deps = reachability(graph, source);
     if (!deps[source]) {
       continue;
     }
@@ -46,14 +104,6 @@ function explain(
 }
 
 function generateGraph(edges: Edge[]): string {
-  // https://stackoverflow.com/a/68702966
-  const strs: Set<string> = new Set();
-  for (const { "from": edgeFrom, to } of edges) {
-    strs.add(edgeFrom);
-    strs.add(to);
-  }
-  const p = longestCommonDirPrefix(Array.from(strs)).length;
-
   const qmdOut: string[] = [];
   qmdOut.push("digraph G {");
   const m: Record<string, number> = {};
@@ -68,7 +118,7 @@ function generateGraph(edges: Edge[]): string {
     qmdOut.push(`  ${m[edgeFrom]} -> ${m[to]};`);
   }
   for (const [name, ix] of Object.entries(m)) {
-    qmdOut.push(`  ${ix} [ label = "${name.slice(p)}", shape = "none" ];`);
+    qmdOut.push(`  ${ix} [ label = "${name}", shape = "none" ];`);
   }
   qmdOut.push("}\n");
   return qmdOut.join("");
@@ -122,10 +172,24 @@ If the second parameter is "--graph", then this program outputs the .dot specifi
   const json = await getDenoInfo(Deno.args[0]);
   const { graph } = moduleGraph(json);
 
-  const result = explain(graph);
-  if (Deno.args[1] === "--graph") {
+  let args = Array.from(Deno.args);
+
+  let result = explain(graph);
+  if (args[1] === "--simplify") {
+    args.splice(1, 1);
+    const prefixes = [];
+    while (!args[1].startsWith("--")) {
+      prefixes.push(args[1]);
+      args.splice(1, 1);
+    }
+    result = simplify(result, prefixes);
+  }
+
+  result = dropTypesFiles(result);
+
+  if (args[1] === "--graph") {
     Deno.writeTextFileSync(
-      Deno.args[2],
+      args[2] ?? "graph.dot",
       generateGraph(result),
     );
   } else {

package/src/common/import-report/explain-all-cycles.ts

@@ -14,7 +14,6 @@ def run(what):
       ("quarto run %s ../../../../src/quarto.ts" % what).split(" "),
       capture_output = True
     ).stdout.decode('utf-8').replace("Bad import from ", "").replace(" to ", " -> ")
-    print(str)
     return ansi_escape.sub("", str)
 ```
 
@@ -29,6 +28,5 @@ Other bad imports:
 
 ```{python}
 #| echo: false
-
 print(run("find-bad-imports.ts"))
 ```

package/src/common/import-report/package_report.qmd

@@ -1,5 +1,6 @@
 // https://stackoverflow.com/a/68702966
 export const longestCommonDirPrefix = (strs: string[]) => {
+  if (strs.length === 0) return "";
   let prefix = strs.reduce((acc, str) => str.length < acc.length ? str : acc);
 
   for (const str of strs) {

package/src/common/import-report/utils.ts

@@ -1,13 +1,13 @@
 /*
-* check.ts
-*
-* Copyright (C) 2021-2022 Posit Software, PBC
-*
-*/
+ * check.ts
+ *
+ * Copyright (C) 2021-2022 Posit Software, PBC
+ */
 
 import { info } from "log/mod.ts";
 
-import { render, renderServices } from "../render/render-shared.ts";
+import { render } from "../render/render-shared.ts";
+import { renderServices } from "../render/render-services.ts";
 
 import { JupyterCapabilities } from "../../core/jupyter/types.ts";
 import { jupyterCapabilities } from "../../core/jupyter/capabilities.ts";

src/command/check/check.ts

@@ -32,14 +32,15 @@ import {
 } from "../../core/lib/yaml-validation/state.ts";
 import { initYamlIntelligenceResourcesFromFilesystem } from "../../core/schema/utils.ts";
 import { kProjectWatchInputs, ProjectContext } from "../../project/types.ts";
+import { projectContext } from "../../project/project-context.ts";
 import {
-  projectContext,
   projectIsServeable,
   projectPreviewServe,
-} from "../../project/project-context.ts";
+} from "../../project/project-shared.ts";
+
 import { isHtmlOutput } from "../../config/format.ts";
 import { renderProject } from "../render/project.ts";
-import { renderServices } from "../render/render-shared.ts";
+import { renderServices } from "../render/render-services.ts";
 import { parseFormatString } from "../../core/pandoc/pandoc-formats.ts";
 import { normalizePath } from "../../core/path.ts";
 import { kCliffyImplicitCwd } from "../../config/constants.ts";

src/command/preview/cmd.ts

@@ -37,17 +37,18 @@ import {
 import { PromiseQueue } from "../../core/promise.ts";
 import { inputFilesDir } from "../../core/render.ts";
 
+import { kQuartoRenderCommand } from "../render/constants.ts";
+
 import {
-  kQuartoRenderCommand,
   previewUnableToRenderResponse,
   previewURL,
   printBrowsePreviewMessage,
   printWatchingForChangesMessage,
   render,
-  renderServices,
   renderToken,
   rswURL,
 } from "../render/render-shared.ts";
+import { renderServices } from "../render/render-services.ts";
 import {
   RenderFlags,
   RenderResult,

src/command/preview/preview.ts

@@ -23,9 +23,10 @@ import {
 import {
   projectContext,
   projectInputFiles,
-  projectIsWebsite,
 } from "../../project/project-context.ts";
 
+import { projectIsWebsite } from "../../project/project-shared.ts";
+
 import { PublishCommandOptions } from "./options.ts";
 import { resolveDeployment } from "./deployment.ts";
 import { AccountPrompt, manageAccounts, resolveAccount } from "./account.ts";

src/command/publish/cmd.ts

@@ -1,9 +1,8 @@
 /*
-* cmd.ts
-*
-* Copyright (C) 2020-2022 Posit Software, PBC
-*
-*/
+ * cmd.ts
+ *
+ * Copyright (C) 2020-2022 Posit Software, PBC
+ */
 
 import { dirname, relative } from "path/mod.ts";
 import { expandGlobSync } from "fs/expand_glob.ts";
@@ -13,7 +12,9 @@ import { info, warning } from "log/mod.ts";
 import { fixupPandocArgs, kStdOut, parseRenderFlags } from "./flags.ts";
 
 import { renderResultFinalOutput } from "./render.ts";
-import { render, renderServices } from "./render-shared.ts";
+import { render } from "./render-shared.ts";
+import { renderServices } from "./render-services.ts";
+
 import { RenderResult } from "./types.ts";
 import { kCliffyImplicitCwd } from "../../config/constants.ts";