6089636300

Committed 05 Sep 2023 08:50PM UTC coverage: 84.855% (-0.4%) from 85.292%

Build # 6089636300

Build Type

Pull #551

github

Committed by

pmcelhaney

Commit Message

don't collect coverage in black box test so it won't fail because of not meeting coverage threshhold

Pull Request Pull Request #551: black box test

Run Details

704 of 784 branches covered (0.0%)

Branch coverage included in aggregate %.

19 of 19 new or added lines in 1 file covered. (100.0%)

2271 of 2722 relevant lines covered (83.43%)

20.71 hits per line

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

0.0

/src/server/start.ts

/* eslint-disable max-statements */
import nodePath from "node:path";
import { pathToFileURL } from "node:url";

import createDebug from "debug";
import Handlebars from "handlebars";
import { createHttpTerminator, type HttpTerminator } from "http-terminator";
import yaml from "js-yaml";
import Koa from "koa";
import bodyParser from "koa-bodyparser";
import { koaSwagger } from "koa2-swagger-ui";

import { readFile } from "../util/read-file.js";
import { counterfact } from "./counterfact.js";

const debug = createDebug("counterfact:server:start");

// eslint-disable-next-line @typescript-eslint/init-declarations
let httpTerminator: HttpTerminator | undefined;

// eslint-disable-next-line no-underscore-dangle, total-functions/no-partial-url-constructor
const __dirname = nodePath.dirname(new URL(import.meta.url).pathname);

const DEFAULT_PORT = 3100;

Handlebars.registerHelper("escape_route", (route: string) =>
  route.replaceAll(/[^\w/]/gu, "-"),
);

function openapi(openApiPath: string, url: string) {
  return async (ctx: Koa.ExtendableContext, next: Koa.Next) => {
    if (ctx.URL.pathname === "/counterfact/openapi") {
      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
      const openApiDocument = (await yaml.load(
        await readFile(openApiPath),
      )) as {
        host?: string;
        servers?: { description: string; url: string }[];
      };

      openApiDocument.servers ??= [];

      openApiDocument.servers.unshift({
        description: "Counterfact",
        url,
      });

      // OpenApi 2 support:
      openApiDocument.host = url;

      // eslint-disable-next-line require-atomic-updates
      ctx.body = yaml.dump(openApiDocument);

      return;
    }

    // eslint-disable-next-line  n/callback-return
    await next();
  };
}

function page(
  pathname: string,
  templateName: string,
  locals: { [key: string]: unknown },
) {
  return async (ctx: Koa.ExtendableContext, next: Koa.Next) => {
    const render = Handlebars.compile(
      await readFile(
        nodePath.join(__dirname, `../client/${templateName}.html.hbs`),
      ),
    );

    if (ctx.URL.pathname === pathname) {
      ctx.body = render(locals);

      return;
    }

    // eslint-disable-next-line  n/callback-return
    await next();
  };
}

export async function start(config: {
  basePath: string;
  openApiPath: string;
  port: number;
}) {
  const {
    basePath = process.cwd().replaceAll("\\", "/"),
    openApiPath = nodePath
      .join(basePath, "../openapi.yaml")
      .replaceAll("\\", "/"),
    port = DEFAULT_PORT,
  } = config;

  const app = new Koa();

  const { contextRegistry, koaMiddleware, registry } = await counterfact(
    basePath,
    openApiPath,
    config,
  );

  app.use(openapi(openApiPath, `//localhost:${port}`));

  app.use(
    koaSwagger({
      routePrefix: "/counterfact/swagger",

      swaggerOptions: {
        url: "/counterfact/openapi",
      },
    }),
  );

  debug("basePath: %s", basePath);
  debug("routes", registry.routes);

  app.use(
    page("/counterfact/", "index", {
      basePath,
      methods: ["get", "post", "put", "delete", "patch"],

      openApiHref: openApiPath.includes("://")
        ? openApiPath
        : pathToFileURL(openApiPath).href,

      openApiPath,

      routes: registry.routes,
    }),
  );

  app.use(async (ctx, next) => {
    if (ctx.URL.pathname === "/counterfact") {
      ctx.redirect("/counterfact/");

      return;
    }

    if (ctx.URL.pathname === "/counterfact/stop") {
      debug("Stopping server...");
      await httpTerminator?.terminate();
      debug("Server stopped.");

      return;
    }

    // eslint-disable-next-line  n/callback-return
    await next();
  });

  app.use(
    page("/counterfact/rapidoc", "rapi-doc", {
      basePath,
      routes: registry.routes,
    }),
  );

  app.use(bodyParser());

  app.use(koaMiddleware);

  const server = app.listen({
    port,
  });

  httpTerminator = createHttpTerminator({
    server,
  });

  return { contextRegistry };
}

1	/* eslint-disable max-statements */	×
2	import nodePath from "node:path";	×
3	import { pathToFileURL } from "node:url";	×
4		×
5	import createDebug from "debug";	×
6	import Handlebars from "handlebars";	×
7	import { createHttpTerminator, type HttpTerminator } from "http-terminator";	×
8	import yaml from "js-yaml";	×
9	import Koa from "koa";	×
10	import bodyParser from "koa-bodyparser";	×
11	import { koaSwagger } from "koa2-swagger-ui";	×
12		×
13	import { readFile } from "../util/read-file.js";	×
14	import { counterfact } from "./counterfact.js";	×
15		×
16	const debug = createDebug("counterfact:server:start");	×
17		×
18	// eslint-disable-next-line @typescript-eslint/init-declarations	×
19	let httpTerminator: HttpTerminator \| undefined;	×
20		×
21	// eslint-disable-next-line no-underscore-dangle, total-functions/no-partial-url-constructor	×
22	const __dirname = nodePath.dirname(new URL(import.meta.url).pathname);	×
23		×
24	const DEFAULT_PORT = 3100;	×
25		×
26	Handlebars.registerHelper("escape_route", (route: string) =>	×
27	route.replaceAll(/[^\w/]/gu, "-"),	×
28	);	×
29		×
30	function openapi(openApiPath: string, url: string) {	×
31	return async (ctx: Koa.ExtendableContext, next: Koa.Next) => {	×
32	if (ctx.URL.pathname === "/counterfact/openapi") {	×
33	// eslint-disable-next-line @typescript-eslint/consistent-type-assertions	×
34	const openApiDocument = (await yaml.load(	×
35	await readFile(openApiPath),	×
36	)) as {	×
37	host?: string;	×
38	servers?: { description: string; url: string }[];	×
39	};	×
40		×
41	openApiDocument.servers ??= [];	×
42		×
43	openApiDocument.servers.unshift({	×
44	description: "Counterfact",	×
45	url,	×
46	});	×
47		×
48	// OpenApi 2 support:	×
49	openApiDocument.host = url;	×
50		×
51	// eslint-disable-next-line require-atomic-updates	×
52	ctx.body = yaml.dump(openApiDocument);	×
53		×
54	return;	×
55	}	×
56		×
57	// eslint-disable-next-line n/callback-return	×
58	await next();	×
59	};	×
60	}	×
61		×
62	function page(	×
63	pathname: string,	×
64	templateName: string,	×
65	locals: { [key: string]: unknown },	×
66	) {	×
67	return async (ctx: Koa.ExtendableContext, next: Koa.Next) => {	×
68	const render = Handlebars.compile(	×
69	await readFile(	×
70	nodePath.join(__dirname, `../client/${templateName}.html.hbs`),	×
71	),	×
72	);	×
73		×
74	if (ctx.URL.pathname === pathname) {	×
75	ctx.body = render(locals);	×
76		×
77	return;	×
78	}	×
79		×
80	// eslint-disable-next-line n/callback-return	×
81	await next();	×
82	};	×
83	}	×
84		×
85	export async function start(config: {	×
86	basePath: string;	×
87	openApiPath: string;	×
88	port: number;	×
89	}) {	×
90	const {	×
91	basePath = process.cwd().replaceAll("\\", "/"),	×
92	openApiPath = nodePath	×
93	.join(basePath, "../openapi.yaml")	×
94	.replaceAll("\\", "/"),	×
95	port = DEFAULT_PORT,	×
96	} = config;	×
97		×
98	const app = new Koa();	×
99		×
100	const { contextRegistry, koaMiddleware, registry } = await counterfact(	×
101	basePath,	×
102	openApiPath,	×
103	config,	×
104	);	×
105		×
106	app.use(openapi(openApiPath, `//localhost:${port}`));	×
107		×
108	app.use(	×
109	koaSwagger({	×
110	routePrefix: "/counterfact/swagger",	×
111		×
112	swaggerOptions: {	×
113	url: "/counterfact/openapi",	×
114	},	×
115	}),	×
116	);	×
117		×
118	debug("basePath: %s", basePath);	×
119	debug("routes", registry.routes);	×
120		×
121	app.use(	×
122	page("/counterfact/", "index", {	×
123	basePath,	×
124	methods: ["get", "post", "put", "delete", "patch"],	×
125		×
126	openApiHref: openApiPath.includes("://")	×
127	? openApiPath	×
128	: pathToFileURL(openApiPath).href,	×
129		×
130	openApiPath,	×
131		×
132	routes: registry.routes,	×
133	}),	×
134	);	×
135		×
136	app.use(async (ctx, next) => {	×
137	if (ctx.URL.pathname === "/counterfact") {	×
138	ctx.redirect("/counterfact/");	×
139		×
140	return;	×
141	}	×
142		×
143	if (ctx.URL.pathname === "/counterfact/stop") {	×
144	debug("Stopping server...");	×
145	await httpTerminator?.terminate();	×
146	debug("Server stopped.");	×
147		×
148	return;	×
149	}	×
150		×
151	// eslint-disable-next-line n/callback-return	×
152	await next();	×
153	});	×
154		×
155	app.use(	×
156	page("/counterfact/rapidoc", "rapi-doc", {	×
157	basePath,	×
158	routes: registry.routes,	×
159	}),	×
160	);	×
161		×
162	app.use(bodyParser());	×
163		×
164	app.use(koaMiddleware);	×
165		×
166	const server = app.listen({	×
167	port,	×
168	});	×
169		×
170	httpTerminator = createHttpTerminator({	×
171	server,	×
172	});	×
173		×
174	return { contextRegistry };	×
175	}	×

pmcelhaney / counterfact / 6089636300

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