7663382357

Committed 26 Jan 2024 02:55AM UTC coverage: 86.296% (+0.3%) from 85.998%

Build # 7663382357

Build Type

Pull #739

github

Committed by

web-flow

Commit Message

Merge branch 'main' into rework-context

Pull Request Pull Request #739: Rework context

Run Details

887 of 977 branches covered (0.0%)

Branch coverage included in aggregate %.

34 of 38 new or added lines in 4 files covered. (89.47%)

17 existing lines in 1 file now uncovered.

2778 of 3270 relevant lines covered (84.95%)

41.63 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

81.82

/src/server/module-loader.ts

import { once } from "node:events";
import { type Dirent, existsSync } from "node:fs";
import fs from "node:fs/promises";
import nodePath from "node:path";
import { pathToFileURL } from "node:url";

import { type FSWatcher, watch } from "chokidar";
import createDebug from "debug";

import { type Context, ContextRegistry } from "./context-registry.js";
import type { Module, Registry } from "./registry.js";

const debug = createDebug("counterfact:typescript-generator:module-loader");

interface ContextModule {
  Context: Context;
}

function isContextModule(
  module: ContextModule | Module,
): module is ContextModule {
  return "Context" in module && typeof module.Context === "function";
}

function reportLoadError(error: unknown, fileUrl: string) {
  if (
    String(error) ===
    "SyntaxError: Identifier 'Context' has already been declared"
  ) {
    // Not sure why Node throws this error. It doesn't seem to matter.
    return;
  }

  process.stdout.write(`\nError loading ${fileUrl}:\n~~${String(error)}~~\n`);
}

export class ModuleLoader extends EventTarget {
  private readonly basePath: string;

  public readonly registry: Registry;

  private watcher: FSWatcher | undefined;

  private readonly contextRegistry: ContextRegistry;

  public constructor(
    basePath: string,
    registry: Registry,
    contextRegistry = new ContextRegistry(),
  ) {
    super();
    this.basePath = basePath.replaceAll("\\", "/");
    this.registry = registry;
    this.contextRegistry = contextRegistry;
  }

  public async watch(): Promise<void> {
    this.watcher = watch(`${this.basePath}/**/*.{js,mjs,ts,mts}`).on(
      "all",
      // eslint-disable-next-line max-statements
      (eventName: string, pathNameOriginal: string) => {
        const pathName = pathNameOriginal.replaceAll("\\", "/");

        if (!["add", "change", "unlink"].includes(eventName)) {
          return;
        }

        const parts = nodePath.parse(pathName.replace(this.basePath, ""));
        const url = `/${parts.dir}/${parts.name}`
          .replaceAll("\\", "/")
          .replaceAll(/\/+/gu, "/");

        if (eventName === "unlink") {
          this.registry.remove(url);
          this.dispatchEvent(new Event("remove"));
        }

        const fileUrl = `${pathToFileURL(
          pathName,
        ).toString()}?cacheBust=${Date.now()}`;

        debug("importing module: %s", fileUrl);

        // eslint-disable-next-line import/no-dynamic-require, no-unsanitized/method
        import(fileUrl)
          // eslint-disable-next-line promise/prefer-await-to-then
          .then((endpoint: ContextModule | Module) => {
            this.dispatchEvent(new Event(eventName));

            if (pathName.includes("_.context")) {
              this.contextRegistry.update(
                parts.dir,

                // @ts-expect-error TS says Context has no constructable signatures but that's not true?
                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/consistent-type-assertions
                new (endpoint as ContextModule).Context(),
              );
              return "context";
            }

            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
            this.registry.add(url, endpoint as Module);

            return "path";
          })
          // eslint-disable-next-line promise/prefer-await-to-then
          .catch((error: unknown) => {
            reportLoadError(error, fileUrl);
          });
      },
    );
    await once(this.watcher, "ready");
  }

  public async stopWatching(): Promise<void> {
    await this.watcher?.close();
  }

  public async load(directory = ""): Promise<void> {
    if (
      !existsSync(nodePath.join(this.basePath, directory).replaceAll("\\", "/"))
    ) {
      throw new Error(`Directory does not exist ${this.basePath}`);
    }

    const files = await fs.readdir(
      nodePath.join(this.basePath, directory).replaceAll("\\", "/"),
      {
        withFileTypes: true,
      },
    );

    const imports = files.flatMap(async (file): Promise<void> => {
      const extension = file.name.split(".").at(-1);

      if (file.isDirectory()) {
        await this.load(
          nodePath.join(directory, file.name).replaceAll("\\", "/"),
        );

        return;
      }

      if (!["js", "mjs", "mts", "ts"].includes(extension ?? "")) {
        return;
      }

      const fullPath = nodePath
        .join(this.basePath, directory, file.name)
        .replaceAll("\\", "/");
      await this.loadEndpoint(fullPath, directory, file);
    });

    await Promise.all(imports);
  }

  // eslint-disable-next-line max-statements
  private async loadEndpoint(
    fullPath: string,
    directory: string,
    file: Dirent,
  ) {
    const fileUrl = `${pathToFileURL(
      fullPath,
    ).toString()}?cacheBust=${Date.now()}`;

    try {
      // eslint-disable-next-line import/no-dynamic-require, no-unsanitized/method, @typescript-eslint/consistent-type-assertions
      const endpoint: ContextModule | Module = (await import(fileUrl)) as
        | ContextModule
        | Module;

      if (file.name.includes("_.context")) {
        if (isContextModule(endpoint)) {
          this.contextRegistry.add(
            `/${directory.replaceAll("\\", "/")}`,

            // @ts-expect-error TS says Context has no constructable signatures but that's not true?
            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
            new endpoint.Context(),
          );
        }
      } else {
        const url = `/${nodePath.join(
          directory,
          nodePath.parse(file.name).name,
        )}`
          .replaceAll("\\", "/")
          .replaceAll(/\/+/gu, "/");

        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
        this.registry.add(url, endpoint as Module);
      }
    } catch (error: unknown) {
      if (
        String(error) ===
        "SyntaxError: Identifier 'Context' has already been declared"
      ) {
        // Not sure why Node throws this error. It doesn't seem to matter.
        return;
      }

      process.stdout.write(`\nError loading ${fileUrl}:\n${String(error)}\n`);
    }
  }
}

1	import { once } from "node:events";	2✔
2	import { type Dirent, existsSync } from "node:fs";	2✔
3	import fs from "node:fs/promises";	2✔
4	import nodePath from "node:path";	2✔
5	import { pathToFileURL } from "node:url";	2✔
6		2✔
7	import { type FSWatcher, watch } from "chokidar";	2✔
8	import createDebug from "debug";	2✔
9		2✔
10	import { type Context, ContextRegistry } from "./context-registry.js";	2✔
11	import type { Module, Registry } from "./registry.js";	2✔
12		2✔
13	const debug = createDebug("counterfact:typescript-generator:module-loader");	2✔
14		2✔
15	interface ContextModule {	2✔
16	Context: Context;	2✔
17	}	2✔
18		2✔
19	function isContextModule(	8✔
20	module: ContextModule \| Module,	8✔
21	): module is ContextModule {	8✔
22	return "Context" in module && typeof module.Context === "function";	8✔
23	}	8✔
24		2✔
25	function reportLoadError(error: unknown, fileUrl: string) {	×
26	if (	×
27	String(error) ===	×
28	"SyntaxError: Identifier 'Context' has already been declared"	×
29	) {	×
30	// Not sure why Node throws this error. It doesn't seem to matter.	×
31	return;	×
32	}	×
33		×
34	process.stdout.write(`\nError loading ${fileUrl}:\n~~${String(error)}~~\n`);	×
35	}	×
36		2✔
37	export class ModuleLoader extends EventTarget {	2✔
38	private readonly basePath: string;	12✔
39		12✔
40	public readonly registry: Registry;	12✔
41		12✔
42	private watcher: FSWatcher \| undefined;	12✔
43		12✔
44	private readonly contextRegistry: ContextRegistry;	12✔
45		12✔
46	public constructor(	12✔
47	basePath: string,	12✔
48	registry: Registry,	12✔
49	contextRegistry = new ContextRegistry(),	12✔
50	) {	12✔
51	super();	12✔
52	this.basePath = basePath.replaceAll("\\", "/");	12✔
53	this.registry = registry;	12✔
54	this.contextRegistry = contextRegistry;	12✔
55	}	12✔
56		12✔
57	public async watch(): Promise<void> {	12✔
58	this.watcher = watch(`${this.basePath}/*/.{js,mjs,ts,mts}`).on(	6✔
59	"all",	6✔
60	// eslint-disable-next-line max-statements	6✔
61	(eventName: string, pathNameOriginal: string) => {	6✔
62	const pathName = pathNameOriginal.replaceAll("\\", "/");	8✔
63		8✔
64	if (!["add", "change", "unlink"].includes(eventName)) {	8!
65	return;	×
66	}	×
67		8✔
68	const parts = nodePath.parse(pathName.replace(this.basePath, ""));	8✔
69	const url = `/${parts.dir}/${parts.name}`	8✔
70	.replaceAll("\\", "/")	8✔
71	.replaceAll(/\/+/gu, "/");	8✔
72		8✔
73	if (eventName === "unlink") {	8✔
74	this.registry.remove(url);	2✔
75	this.dispatchEvent(new Event("remove"));	2✔
76	}	2✔
77		8✔
78	const fileUrl = `${pathToFileURL(	8✔
79	pathName,	8✔
80	).toString()}?cacheBust=${Date.now()}`;	8✔
81		8✔
82	debug("importing module: %s", fileUrl);	8✔
83		8✔
84	// eslint-disable-next-line import/no-dynamic-require, no-unsanitized/method	8✔
85	import(fileUrl)	8✔
86	// eslint-disable-next-line promise/prefer-await-to-then	8✔
87	.then((endpoint: ContextModule \| Module) => {	8✔
88	this.dispatchEvent(new Event(eventName));	8✔
89		8✔
90	if (pathName.includes("_.context")) {	8!
UNCOV 91	this.contextRegistry.update(	×
UNCOV 92	parts.dir,	×
UNCOV 93		×
NEW UNCOV 94	// @ts-expect-error TS says Context has no constructable signatures but that's not true?	×
NEW UNCOV 95	// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/consistent-type-assertions	×
NEW UNCOV 96	new (endpoint as ContextModule).Context(),	×
NEW 97	);	×
98	return "context";	×
99	}	×
100		8✔
101	// eslint-disable-next-line @typescript-eslint/consistent-type-assertions	8✔
102	this.registry.add(url, endpoint as Module);	8✔
103		8✔
104	return "path";	8✔
105	})	8✔
106	// eslint-disable-next-line promise/prefer-await-to-then	8✔
107	.catch((error: unknown) => {	8✔
UNCOV 108	reportLoadError(error, fileUrl);	×
UNCOV 109	});	×
110	},	8✔
111	);	6✔
112	await once(this.watcher, "ready");	6✔
113	}	6✔
114		12✔
115	public async stopWatching(): Promise<void> {	12✔
116	await this.watcher?.close();	6✔
117	}	6✔
118		12✔
119	public async load(directory = ""): Promise<void> {	12✔
120	if (	20✔
121	!existsSync(nodePath.join(this.basePath, directory).replaceAll("\\", "/"))	20✔
122	) {	20!
UNCOV 123	throw new Error(`Directory does not exist ${this.basePath}`);	×
UNCOV 124	}	×
125		20✔
126	const files = await fs.readdir(	20✔
127	nodePath.join(this.basePath, directory).replaceAll("\\", "/"),	20✔
128	{	20✔
129	withFileTypes: true,	20✔
130	},	20✔
131	);	20✔
132		20✔
133	const imports = files.flatMap(async (file): Promise<void> => {	20✔
134	const extension = file.name.split(".").at(-1);	26✔
135		26✔
136	if (file.isDirectory()) {	26✔
137	await this.load(	8✔
138	nodePath.join(directory, file.name).replaceAll("\\", "/"),	8✔
139	);	8✔
140		8✔
141	return;	8✔
142	}	8✔
143		18✔
144	if (!["js", "mjs", "mts", "ts"].includes(extension ?? "")) {	26!
145	return;	2✔
146	}	2✔
147		16✔
148	const fullPath = nodePath	16✔
149	.join(this.basePath, directory, file.name)	16✔
150	.replaceAll("\\", "/");	16✔
151	await this.loadEndpoint(fullPath, directory, file);	16✔
152	});	16✔
153		20✔
154	await Promise.all(imports);	20✔
155	}	20✔
156		12✔
157	// eslint-disable-next-line max-statements	12✔
158	private async loadEndpoint(	12✔
159	fullPath: string,	16✔
160	directory: string,	16✔
161	file: Dirent,	16✔
162	) {	16✔
163	const fileUrl = `${pathToFileURL(	16✔
164	fullPath,	16✔
165	).toString()}?cacheBust=${Date.now()}`;	16✔
166		16✔
167	try {	16✔
168	// eslint-disable-next-line import/no-dynamic-require, no-unsanitized/method, @typescript-eslint/consistent-type-assertions	16✔
169	const endpoint: ContextModule \| Module = (await import(fileUrl)) as	16✔
170	\| ContextModule	16✔
171	\| Module;	16✔
172		16✔
173	if (file.name.includes("_.context")) {	16✔
174	if (isContextModule(endpoint)) {	8✔
175	this.contextRegistry.add(	8✔
176	`/${directory.replaceAll("\\", "/")}`,	8✔
177		8✔
178	// @ts-expect-error TS says Context has no constructable signatures but that's not true?	8✔
179	// eslint-disable-next-line @typescript-eslint/no-unsafe-argument	8✔
180	new endpoint.Context(),	8✔
181	);	8✔
182	}	8✔
183	} else {	8✔
184	const url = `/${nodePath.join(	8✔
185	directory,	8✔
186	nodePath.parse(file.name).name,	8✔
187	)}`	8✔
188	.replaceAll("\\", "/")	8✔
189	.replaceAll(/\/+/gu, "/");	8✔
190		8✔
191	// eslint-disable-next-line @typescript-eslint/consistent-type-assertions	8✔
192	this.registry.add(url, endpoint as Module);	8✔
193	}	8✔
194	} catch (error: unknown) {	16!
UNCOV 195	if (	×
UNCOV 196	String(error) ===	×
UNCOV 197	"SyntaxError: Identifier 'Context' has already been declared"	×
UNCOV 198	) {	×
UNCOV 199	// Not sure why Node throws this error. It doesn't seem to matter.	×
UNCOV 200	return;	×
UNCOV 201	}	×
202		×
203	process.stdout.write(`\nError loading ${fileUrl}:\n${String(error)}\n`);	×
204	}	×
205	}	16✔
206	}	12✔

pmcelhaney / counterfact / 7663382357

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous