node-server-engine 1.1.2 → 1.1.3

package/src/middleware/metrics/metrics.test.ts

@@ -1,46 +1,46 @@
-import { expect } from 'chai';
-import express from 'express';
-import { Counter } from 'prom-client';
-import request from 'supertest';
-import { metrics } from './metrics';
-import { serviceRegistry, instanceRegistry } from 'const/metrics';
-
-describe('Middleware - metrics', () => {
-  beforeEach(() => {
-    instanceRegistry.clear();
-    serviceRegistry.clear();
-  });
-
-  it('should export instance metrics', async () => {
-    new Counter({
-      name: 'instance_test',
-      help: 'instance_test',
-      registers: [instanceRegistry]
-    });
-
-    const app = express();
-    app.use(metrics());
-
-    const { text } = await request(app).get('/metrics/instance').expect(200);
-    expect(text).to.equal(
-      '# HELP instance_test instance_test\n# TYPE instance_test counter\ninstance_test 0\n'
-    );
-  });
-
-  it('should export service metrics', async () => {
-    new Counter({
-      name: 'service_test',
-      help: 'service_test',
-      registers: [serviceRegistry]
-    });
-
-    const app = express();
-    app.use(metrics());
-
-    const { text } = await request(app).get('/metrics/service').expect(200);
-
-    expect(text).to.equal(
-      '# HELP service_test service_test\n# TYPE service_test counter\nservice_test 0\n'
-    );
-  });
-});
+import { expect } from 'chai';
+import express from 'express';
+import { Counter } from 'prom-client';
+import request from 'supertest';
+import { metrics } from './metrics';
+import { serviceRegistry, instanceRegistry } from 'const/metrics';
+
+describe('Middleware - metrics', () => {
+  beforeEach(() => {
+    instanceRegistry.clear();
+    serviceRegistry.clear();
+  });
+
+  it('should export instance metrics', async () => {
+    new Counter({
+      name: 'instance_test',
+      help: 'instance_test',
+      registers: [instanceRegistry]
+    });
+
+    const app = express();
+    app.use(metrics());
+
+    const { text } = await request(app).get('/metrics/instance').expect(200);
+    expect(text).to.equal(
+      '# HELP instance_test instance_test\n# TYPE instance_test counter\ninstance_test 0\n'
+    );
+  });
+
+  it('should export service metrics', async () => {
+    new Counter({
+      name: 'service_test',
+      help: 'service_test',
+      registers: [serviceRegistry]
+    });
+
+    const app = express();
+    app.use(metrics());
+
+    const { text } = await request(app).get('/metrics/service').expect(200);
+
+    expect(text).to.equal(
+      '# HELP service_test service_test\n# TYPE service_test counter\nservice_test 0\n'
+    );
+  });
+});

package/src/middleware/metrics/metrics.ts

@@ -1,24 +1,24 @@
-import { Router, Request, Response } from 'express';
-import { instanceRegistry, serviceRegistry } from 'const/metrics';
-import { reportError } from 'utils/report';
-
-/** Middleware that calculates request time, and exposes metrics related to requests processed by this service */
-export function metrics(): Router {
-  return Router()
-    .use('/metrics/instance', (req: Request, res: Response) => {
-      (async (): Promise<void> => {
-        res.set('Content-Type', instanceRegistry.contentType);
-        res.end(await instanceRegistry.metrics());
-      })().catch((error: Error) => {
-        reportError(error);
-      });
-    })
-    .use('/metrics/service', (req: Request, res: Response) => {
-      (async (): Promise<void> => {
-        res.set('Content-Type', serviceRegistry.contentType);
-        res.end(await serviceRegistry.metrics());
-      })().catch((error: Error) => {
-        reportError(error);
-      });
-    });
-}
+import { Router, Request, Response } from 'express';
+import { instanceRegistry, serviceRegistry } from 'const/metrics';
+import { reportError } from 'utils/report';
+
+/** Middleware that calculates request time, and exposes metrics related to requests processed by this service */
+export function metrics(): Router {
+  return Router()
+    .use('/metrics/instance', (req: Request, res: Response) => {
+      (async (): Promise<void> => {
+        res.set('Content-Type', instanceRegistry.contentType);
+        res.end(await instanceRegistry.metrics());
+      })().catch((error: Error) => {
+        reportError(error);
+      });
+    })
+    .use('/metrics/service', (req: Request, res: Response) => {
+      (async (): Promise<void> => {
+        res.set('Content-Type', serviceRegistry.contentType);
+        res.end(await serviceRegistry.metrics());
+      })().catch((error: Error) => {
+        reportError(error);
+      });
+    });
+}

package/src/middleware/requestMetrics/index.ts

@@ -1 +1 @@
-export * from './requestMetrics';
+export * from './requestMetrics';

package/src/middleware/requestMetrics/requestMetrics.test.ts

@@ -1,77 +1,77 @@
-import { expect } from 'chai';
-import express from 'express';
-import { faker } from '@faker-js/faker';
-import { stub, match, SinonStub } from 'sinon';
-import request from 'supertest';
-import { requestMetrics } from './requestMetrics';
-import { httpRequestCount, httpRequestDuration } from 'metrics/request';
-
-describe('Middleware - requestMetrics', function () {
-  let requestCountStub: SinonStub;
-  let requestDurationStub: SinonStub;
-
-  beforeEach(() => {
-    requestCountStub = stub(httpRequestCount, 'inc').returns();
-    requestDurationStub = stub(httpRequestDuration, 'observe').returns();
-  });
-
-  it('should handle metrics for the requests', async () => {
-    const service = faker.lorem.word();
-    process.env.CHART = service;
-
-    const app = express();
-    app.use(requestMetrics);
-    app.get('/test', function (req, res) {
-      res.sendStatus(200);
-    });
-
-    await request(app).get('/test').expect(200);
-
-    const labels = { service, path: '/test', method: 'GET', status: '2XX' };
-    expect(requestCountStub).to.have.been.calledOnceWithExactly(labels);
-    expect(requestDurationStub).to.have.been.calledOnceWithExactly(
-      labels,
-      match.number
-    );
-  });
-
-  it('should not keep query parameters in path', async () => {
-    const service = faker.lorem.word();
-    process.env.CHART = service;
-
-    const app = express();
-    app.use(requestMetrics);
-    app.get('/test', function (req, res) {
-      res.sendStatus(200);
-    });
-
-    await request(app).get('/test?param=value').expect(200);
-
-    const labels = { service, path: '/test', method: 'GET', status: '2XX' };
-    expect(requestCountStub).to.have.been.calledOnceWithExactly(labels);
-    expect(requestDurationStub).to.have.been.calledOnceWithExactly(
-      labels,
-      match.number
-    );
-  });
-
-  it('should not keep anchor in path', async () => {
-    const service = faker.lorem.word();
-    process.env.CHART = service;
-
-    const app = express();
-    app.use(requestMetrics);
-    app.get('/test', function (req, res) {
-      res.sendStatus(200);
-    });
-
-    await request(app).get('/test#place').expect(200);
-
-    const labels = { service, path: '/test', method: 'GET', status: '2XX' };
-    expect(requestCountStub).to.have.been.calledOnceWithExactly(labels);
-    expect(requestDurationStub).to.have.been.calledOnceWithExactly(
-      labels,
-      match.number
-    );
-  });
-});
+import { expect } from 'chai';
+import express from 'express';
+import { faker } from '@faker-js/faker';
+import { stub, match, SinonStub } from 'sinon';
+import request from 'supertest';
+import { requestMetrics } from './requestMetrics';
+import { httpRequestCount, httpRequestDuration } from 'metrics/request';
+
+describe('Middleware - requestMetrics', function () {
+  let requestCountStub: SinonStub;
+  let requestDurationStub: SinonStub;
+
+  beforeEach(() => {
+    requestCountStub = stub(httpRequestCount, 'inc').returns();
+    requestDurationStub = stub(httpRequestDuration, 'observe').returns();
+  });
+
+  it('should handle metrics for the requests', async () => {
+    const service = faker.lorem.word();
+    process.env.CHART = service;
+
+    const app = express();
+    app.use(requestMetrics);
+    app.get('/test', function (req, res) {
+      res.sendStatus(200);
+    });
+
+    await request(app).get('/test').expect(200);
+
+    const labels = { service, path: '/test', method: 'GET', status: '2XX' };
+    expect(requestCountStub).to.have.been.calledOnceWithExactly(labels);
+    expect(requestDurationStub).to.have.been.calledOnceWithExactly(
+      labels,
+      match.number
+    );
+  });
+
+  it('should not keep query parameters in path', async () => {
+    const service = faker.lorem.word();
+    process.env.CHART = service;
+
+    const app = express();
+    app.use(requestMetrics);
+    app.get('/test', function (req, res) {
+      res.sendStatus(200);
+    });
+
+    await request(app).get('/test?param=value').expect(200);
+
+    const labels = { service, path: '/test', method: 'GET', status: '2XX' };
+    expect(requestCountStub).to.have.been.calledOnceWithExactly(labels);
+    expect(requestDurationStub).to.have.been.calledOnceWithExactly(
+      labels,
+      match.number
+    );
+  });
+
+  it('should not keep anchor in path', async () => {
+    const service = faker.lorem.word();
+    process.env.CHART = service;
+
+    const app = express();
+    app.use(requestMetrics);
+    app.get('/test', function (req, res) {
+      res.sendStatus(200);
+    });
+
+    await request(app).get('/test#place').expect(200);
+
+    const labels = { service, path: '/test', method: 'GET', status: '2XX' };
+    expect(requestCountStub).to.have.been.calledOnceWithExactly(labels);
+    expect(requestDurationStub).to.have.been.calledOnceWithExactly(
+      labels,
+      match.number
+    );
+  });
+});

package/src/middleware/requestMetrics/requestMetrics.ts

@@ -1,20 +1,20 @@
-import { Request, Response } from 'express';
-import responseTime from 'response-time';
-import { httpRequestCount, httpRequestDuration } from 'metrics';
-
-/** Middleware that gets metrics on each request */
-export const requestMetrics = responseTime(
-  (request: Request, response: Response, time: number) => {
-    const labels = {
-      path: (request.route?.path ?? request.path) as string,
-      method: request.method,
-      status: response.statusCode
-        ? `${response.statusCode.toString().substring(0, 1)}XX`
-        : '',
-      service: process.env.CHART
-    };
-
-    httpRequestCount.inc(labels);
-    httpRequestDuration.observe(labels, time / 1000);
-  }
-);
+import { Request, Response } from 'express';
+import responseTime from 'response-time';
+import { httpRequestCount, httpRequestDuration } from 'metrics';
+
+/** Middleware that gets metrics on each request */
+export const requestMetrics = responseTime(
+  (request: Request, response: Response, time: number) => {
+    const labels = {
+      path: (request.route?.path ?? request.path) as string,
+      method: request.method,
+      status: response.statusCode
+        ? `${response.statusCode.toString().substring(0, 1)}XX`
+        : '',
+      service: process.env.CHART
+    };
+
+    httpRequestCount.inc(labels);
+    httpRequestDuration.observe(labels, time / 1000);
+  }
+);

package/src/middleware/swaggerDocs/index.ts

@@ -1,2 +1,2 @@
-export * from './swaggerDocs';
-export * from './swaggerDocs.types';
+export * from './swaggerDocs';
+export * from './swaggerDocs.types';

package/src/middleware/swaggerDocs/swaggerDocs.ts

@@ -1,114 +1,114 @@
-import fs from 'fs';
-import { Router } from 'express';
-import { glob } from 'glob';
-import YAML from 'yamljs';
-import swaggerUi from 'swagger-ui-express';
-import {
-  EndpointDocumentation,
-  IndexDocumentation,
-  ResponsesConfig,
-  EndpointConfig,
-  SchemasConfig,
-  SwaggerConfig
-} from './swaggerDocs.types';
-
-/** Get the paths of all the endpoint documentation files */
-function getEndpointDocPaths(): Array<string> {
-  return [
-    ...glob.sync(`${process.cwd()}/src/**/*.docs.yaml`),
-    ...glob.sync(`${process.cwd()}/dist/**/*.docs.yaml`)
-  ];
-}
-
-/** Get the paths of all the schema files */
-function getSchemaPaths(): Array<string> {
-  return [
-    ...glob.sync(`${process.cwd()}/src/docs/schemas/*.yaml`),
-    ...glob.sync(`${process.cwd()}/dist/docs/schemas/*.yaml`)
-  ];
-}
-
-/** Get the paths of all the response files */
-function getResponsePaths(): Array<string> {
-  return [
-    ...glob.sync(`${process.cwd()}/src/docs/responses/*.yaml`),
-    ...glob.sync(`${process.cwd()}/dist/docs/responses/*.yaml`)
-  ];
-}
-
-/**
- * Load all data files and merge them in a single object
- * @param files
- * @return {Object}
- */
-function loadAndMergeData(files: Array<string>): EndpointDocumentation {
-  return files
-    .map((file) => YAML.load(file) as EndpointDocumentation)
-    .reduce((result, endpoint) => {
-      for (const path of Object.keys(endpoint)) {
-        if (!(path in result)) result[path] = {};
-        result[path] = { ...result[path], ...endpoint[path] };
-      }
-      return result;
-    }, {});
-}
-
-/** Load documentation files of all the endpoints */
-function loadEndpoints(): EndpointConfig {
-  const paths = getEndpointDocPaths();
-  const endpoints = loadAndMergeData(paths);
-  return {
-    paths: endpoints
-  };
-}
-
-/** Load documentation files of all the schemas */
-function loadSchemas(): SchemasConfig {
-  const paths = getSchemaPaths();
-  const schemas = loadAndMergeData(paths);
-  return { schemas };
-}
-
-/** Load documentation files of all the responses */
-function loadResponses(): ResponsesConfig {
-  const paths = getResponsePaths();
-  const responses = loadAndMergeData(paths);
-  return { responses };
-}
-
-/** Load the whole Swagger config */
-function loadConfig(): SwaggerConfig {
-  const indexPath = `${process.cwd()}/src/docs/index.yaml`;
-  const config = (
-    fs.existsSync(indexPath) ? YAML.load(indexPath) : {}
-  ) as IndexDocumentation;
-  const schemaConfig = loadSchemas();
-  const responseConfig = loadResponses();
-  const endpointConfig = loadEndpoints();
-  return {
-    ...config,
-    ...endpointConfig,
-    components: {
-      ...config.components,
-      ...schemaConfig,
-      ...responseConfig
-    }
-  };
-}
-
-/**
- * Get a middleware that serves the documentation
- * @return {Router}
- */
-export function swaggerDocs(): Router {
-  // Stringify the result and replace any environment variable, then turn it again to an object
-  const stringifiedDocumentation = JSON.stringify(loadConfig());
-  const placeholderRegex = /##(.+?)##/g;
-  const overwrittenDocumentation = stringifiedDocumentation.replace(
-    placeholderRegex,
-    (match: string, p1: string): string => process.env[p1] ?? ''
-  );
-  const config = JSON.parse(overwrittenDocumentation) as EndpointDocumentation;
-  
-  return Router().use('/docs', swaggerUi.serve, swaggerUi.setup(config));
-}
+import fs from 'fs';
+import { Router } from 'express';
+import { glob } from 'glob';
+import YAML from 'yamljs';
+import swaggerUi from 'swagger-ui-express';
+import {
+  EndpointDocumentation,
+  IndexDocumentation,
+  ResponsesConfig,
+  EndpointConfig,
+  SchemasConfig,
+  SwaggerConfig
+} from './swaggerDocs.types';
+
+/** Get the paths of all the endpoint documentation files */
+function getEndpointDocPaths(): Array<string> {
+  return [
+    ...glob.sync(`${process.cwd()}/src/**/*.docs.yaml`),
+    ...glob.sync(`${process.cwd()}/dist/**/*.docs.yaml`)
+  ];
+}
+
+/** Get the paths of all the schema files */
+function getSchemaPaths(): Array<string> {
+  return [
+    ...glob.sync(`${process.cwd()}/src/docs/schemas/*.yaml`),
+    ...glob.sync(`${process.cwd()}/dist/docs/schemas/*.yaml`)
+  ];
+}
+
+/** Get the paths of all the response files */
+function getResponsePaths(): Array<string> {
+  return [
+    ...glob.sync(`${process.cwd()}/src/docs/responses/*.yaml`),
+    ...glob.sync(`${process.cwd()}/dist/docs/responses/*.yaml`)
+  ];
+}
+
+/**
+ * Load all data files and merge them in a single object
+ * @param files
+ * @return {Object}
+ */
+function loadAndMergeData(files: Array<string>): EndpointDocumentation {
+  return files
+    .map((file) => YAML.load(file) as EndpointDocumentation)
+    .reduce((result, endpoint) => {
+      for (const path of Object.keys(endpoint)) {
+        if (!(path in result)) result[path] = {};
+        result[path] = { ...result[path], ...endpoint[path] };
+      }
+      return result;
+    }, {});
+}
+
+/** Load documentation files of all the endpoints */
+function loadEndpoints(): EndpointConfig {
+  const paths = getEndpointDocPaths();
+  const endpoints = loadAndMergeData(paths);
+  return {
+    paths: endpoints
+  };
+}
+
+/** Load documentation files of all the schemas */
+function loadSchemas(): SchemasConfig {
+  const paths = getSchemaPaths();
+  const schemas = loadAndMergeData(paths);
+  return { schemas };
+}
+
+/** Load documentation files of all the responses */
+function loadResponses(): ResponsesConfig {
+  const paths = getResponsePaths();
+  const responses = loadAndMergeData(paths);
+  return { responses };
+}
+
+/** Load the whole Swagger config */
+function loadConfig(): SwaggerConfig {
+  const indexPath = `${process.cwd()}/src/docs/index.yaml`;
+  const config = (
+    fs.existsSync(indexPath) ? YAML.load(indexPath) : {}
+  ) as IndexDocumentation;
+  const schemaConfig = loadSchemas();
+  const responseConfig = loadResponses();
+  const endpointConfig = loadEndpoints();
+  return {
+    ...config,
+    ...endpointConfig,
+    components: {
+      ...config.components,
+      ...schemaConfig,
+      ...responseConfig
+    }
+  };
+}
+
+/**
+ * Get a middleware that serves the documentation
+ * @return {Router}
+ */
+export function swaggerDocs(): Router {
+  // Stringify the result and replace any environment variable, then turn it again to an object
+  const stringifiedDocumentation = JSON.stringify(loadConfig());
+  const placeholderRegex = /##(.+?)##/g;
+  const overwrittenDocumentation = stringifiedDocumentation.replace(
+    placeholderRegex,
+    (match: string, p1: string): string => process.env[p1] ?? ''
+  );
+  const config = JSON.parse(overwrittenDocumentation) as EndpointDocumentation;
+  
+  return Router().use('/docs', swaggerUi.serve, swaggerUi.setup(config));
+}

package/src/middleware/swaggerDocs/swaggerDocs.types.ts

@@ -1,41 +1,41 @@
-/** Documentation content */
-export interface EndpointDocumentation {
-  [path: string]: { [key: string]: unknown };
-}
-
-/** Documentation content  */
-interface ComponentDocumentation {
-  [name: string]: { [key: string]: unknown };
-}
-
-/** root documentation config */
-export interface IndexDocumentation extends EndpointDocumentation {
-  /** Global components to be documented */
-  components: ComponentDocumentation;
-}
-
-/** Documentation config for endpoints */
-export interface EndpointConfig {
-  /** Documentation content */
-  paths: EndpointDocumentation;
-}
-
-/** Documentation config for responses */
-export interface ResponsesConfig {
-  /** Documentation content */
-  responses: ComponentDocumentation;
-}
-
-/** Documentation config for schemas */
-export interface SchemasConfig {
-  /** Documentation content */
-  schemas: ComponentDocumentation;
-}
-
-export type SwaggerConfig = IndexDocumentation &
-  EndpointConfig & {
-    /** Shared components documentation */
-    components: IndexDocumentation['components'] &
-      ResponsesConfig &
-      SchemasConfig;
-  };
+/** Documentation content */
+export interface EndpointDocumentation {
+  [path: string]: { [key: string]: unknown };
+}
+
+/** Documentation content  */
+interface ComponentDocumentation {
+  [name: string]: { [key: string]: unknown };
+}
+
+/** root documentation config */
+export interface IndexDocumentation extends EndpointDocumentation {
+  /** Global components to be documented */
+  components: ComponentDocumentation;
+}
+
+/** Documentation config for endpoints */
+export interface EndpointConfig {
+  /** Documentation content */
+  paths: EndpointDocumentation;
+}
+
+/** Documentation config for responses */
+export interface ResponsesConfig {
+  /** Documentation content */
+  responses: ComponentDocumentation;
+}
+
+/** Documentation config for schemas */
+export interface SchemasConfig {
+  /** Documentation content */
+  schemas: ComponentDocumentation;
+}
+
+export type SwaggerConfig = IndexDocumentation &
+  EndpointConfig & {
+    /** Shared components documentation */
+    components: IndexDocumentation['components'] &
+      ResponsesConfig &
+      SchemasConfig;
+  };

package/src/middleware/userResolver/index.ts

@@ -1 +1 @@
-export * from './userResolver';
+export * from './userResolver';