@openapi-typescript-infra/service 1.2.1 → 1.2.2

package/jest.config.js

@@ -3,7 +3,7 @@
  * Instead, edit the coconfig.js or coconfig.ts file in your project root.
  *
  * See https://github.com/gas-buddy/coconfig for more information.
- * @version coconfig@0.12.2
+ * @version coconfig@0.13.3
  */
 const configModule = require('@openapi-typescript-infra/coconfig');
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "An opinionated framework for building configuration driven services - web, api, or job. Uses OpenAPI, pino logging, express, confit, Typescript and Jest.",
   "main": "build/index.js",
   "scripts": {
@@ -55,22 +55,22 @@
     "@godaddy/terminus": "^4.12.1",
     "@opentelemetry/api": "^1.4.1",
     "@opentelemetry/api-metrics": "^0.33.0",
-    "@opentelemetry/exporter-prometheus": "^0.41.0",
-    "@opentelemetry/exporter-trace-otlp-proto": "^0.41.0",
-    "@opentelemetry/instrumentation": "^0.41.0",
+    "@opentelemetry/exporter-prometheus": "^0.41.1",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.41.1",
+    "@opentelemetry/instrumentation": "^0.41.1",
     "@opentelemetry/instrumentation-aws-sdk": "^0.35.0",
     "@opentelemetry/instrumentation-dns": "^0.32.0",
     "@opentelemetry/instrumentation-express": "^0.33.0",
     "@opentelemetry/instrumentation-generic-pool": "^0.32.0",
     "@opentelemetry/instrumentation-graphql": "^0.35.0",
-    "@opentelemetry/instrumentation-http": "^0.41.0",
+    "@opentelemetry/instrumentation-http": "^0.41.1",
     "@opentelemetry/instrumentation-ioredis": "^0.35.0",
     "@opentelemetry/instrumentation-net": "^0.32.0",
     "@opentelemetry/instrumentation-pg": "^0.36.0",
     "@opentelemetry/instrumentation-pino": "^0.34.0",
-    "@opentelemetry/sdk-metrics": "^1.15.0",
-    "@opentelemetry/sdk-node": "^0.41.0",
-    "@opentelemetry/semantic-conventions": "^1.15.0",
+    "@opentelemetry/sdk-metrics": "^1.15.1",
+    "@opentelemetry/sdk-node": "^0.41.1",
+    "@opentelemetry/semantic-conventions": "^1.15.1",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.3.1",
     "eventsource": "^1.1.2",
@@ -79,7 +79,7 @@
     "glob": "^8.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.8",
-    "pino": "^8.14.1",
+    "pino": "^8.14.2",
     "read-pkg-up": "^7.0.1",
     "rest-api-support": "^1.16.3",
     "shortstop-dns": "^1.1.0",
@@ -87,27 +87,27 @@
     "shortstop-yaml": "^1.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
-    "@openapi-typescript-infra/coconfig": "^3.2.0",
+    "@commitlint/cli": "^17.6.7",
+    "@commitlint/config-conventional": "^17.6.7",
+    "@openapi-typescript-infra/coconfig": "^3.3.6",
     "@types/cookie-parser": "^1.4.3",
     "@types/eventsource": "1.1.11",
     "@types/express": "^4.17.17",
     "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.3",
-    "@types/lodash": "^4.14.195",
+    "@types/lodash": "^4.14.196",
     "@types/minimist": "^1.2.2",
-    "@types/node": "^18.16.19",
+    "@types/node": "^18.17.1",
     "@types/supertest": "^2.0.12",
-    "coconfig": "^0.12.2",
-    "eslint": "^8.45.0",
+    "coconfig": "^0.13.3",
+    "eslint": "^8.46.0",
     "eslint-config-gasbuddy": "^7.2.0",
-    "eslint-config-prettier": "^8.8.0",
+    "eslint-config-prettier": "^8.9.0",
     "eslint-plugin-jest": "^27.2.3",
     "husky": "^8.0.3",
-    "jest": "^29.6.1",
+    "jest": "^29.6.2",
     "lint-staged": "^13.2.3",
-    "pino-pretty": "^10.0.1",
+    "pino-pretty": "^10.2.0",
     "pinst": "^3.0.0",
     "supertest": "^6.3.3",
     "ts-jest": "^29.1.1",

package/src/telemetry/index.ts

@@ -24,7 +24,9 @@ function getExporter() {
       url: process.env.OTLP_EXPORTER || 'http://otlp-exporter:4318/v1/traces',
     });
   }
-  return new opentelemetry.tracing.ConsoleSpanExporter();
+  if (process.env.ENABLE_CONSOLE_OLTP_EXPORTER) {
+    return new opentelemetry.tracing.ConsoleSpanExporter();
+  }
 }
 
 export async function startWithTelemetry<

package/tsconfig.build.json

@@ -5,6 +5,7 @@
     "src/**/*.test.ts",
     "__tests__/**/*.ts",
     "__mocks__/**/*.ts",
-    "coconfig.ts"
+    "coconfig.ts",
+    "vitest.config.ts"
   ]
 }

package/tsconfig.json

@@ -4,7 +4,8 @@
     "src/**/*",
     "__tests__/**/*",
     "__mocks__/**/*",
-    "coconfig.ts"
+    "coconfig.ts",
+    "vitest.config.ts"
   ],
   "exclude": [
     "node_modules",

package/__tests__/config.test.ts

@@ -1,32 +0,0 @@
-import path from 'path';
-
-import { insertConfigurationBefore, loadConfiguration } from '../src/config';
-
-describe('configuration loader', () => {
-  test('overrides and shortstops', async () => {
-    const rootDirectory = path.resolve(__dirname, './fake-serv');
-    const config = await loadConfiguration({
-      name: 'fake-serv',
-      rootDirectory,
-      configurationDirectories: [path.resolve(rootDirectory, './config')],
-    });
-    expect(config.get('logging:level')).toEqual('debug');
-    expect(config.get('google')).toBeTruthy();
-    expect(config.get('google')).not.toEqual('google.com');
-
-    expect(config.get('envswitchoff')).toBeFalsy();
-    expect(config.get('envswitchon')).toBeTruthy();
-
-    expect(config.get('servicetype')).toBeTruthy();
-    expect(config.get('oservicetype')).toBeTruthy();
-    expect(config.get('notservicetype')).toBeFalsy();
-
-    const orig = ['a', 'b', 'd'];
-    const withC = insertConfigurationBefore(orig, 'c', 'd');
-    expect(withC).toEqual(['a', 'b', 'c', 'd']);
-    const withE = insertConfigurationBefore(orig, 'e', 'q');
-    expect(withE).toEqual(['a', 'b', 'd', 'e', 'q']);
-    expect(insertConfigurationBefore(undefined, 'a', 'b')).toEqual(['a', 'b']);
-    expect(insertConfigurationBefore([], 'a', 'b')).toEqual(['a', 'b']);
-  });
-});

package/__tests__/fake-serv/api/fake-serv.yaml

@@ -1,48 +0,0 @@
-openapi: 3.0.0
-info:
-  title: Fake Service
-  version: 1.0.0
-paths:
-  /hello:
-    get:
-      description: Get a greeting
-      parameters:
-        - name: greeting
-          in: query
-          required: false
-          schema:
-            type: string
-        - name: number
-          in: query
-          required: false
-          schema:
-            type: number
-        - name: break_things
-          in: query
-          required: false
-          schema:
-            type: boolean
-      responses:
-        200:
-          description: We responded
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  greeting:
-                    type: string
-    post:
-      description: Test body conversion
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                number:
-                  type: number
-        required: true
-      responses:
-        204:
-          description: I heard you

package/__tests__/fake-serv/config/config.json

@@ -1,16 +0,0 @@
-{
-  "logging": {
-    "level": "debug"
-  },
-  "google": "dns:google.com",
-  "envswitchoff": "env_switch:ENV_VAR_DOESNT_EXIST",
-  "envswitchon": "env_switch:!ENV_VAR_DOESNT_EXIST",
-  "servicetype": "servicetype:serv",
-  "oservicetype": "servicetype:internal",
-  "notservicetype": "servicetype:api",
-  "server": {
-    "metrics": {
-      "enabled": true
-    }
-  }
-}

package/__tests__/fake-serv/src/handlers/hello.ts

@@ -1,10 +0,0 @@
-import { ServiceHandler } from '../../../../src/index';
-import { FakeServLocals } from '../index';
-
-export const get: ServiceHandler<FakeServLocals> = async (req, res) => {
-  res.json({ greeting: req.query.greeting || 'Hello World' });
-};
-
-export const post: ServiceHandler<FakeServLocals> = async (req, res) => {
-  res.sendStatus(204);
-};

package/__tests__/fake-serv/src/index.ts

@@ -1,35 +0,0 @@
-import { RestApiErrorResponse, RestApiSuccessResponse } from 'rest-api-support';
-
-import type { Service, ServiceLocals } from '../../../src/types';
-import { useService } from '../../../src';
-
-export interface FakeServLocals extends ServiceLocals {
-  services: {
-    fakeServ: {
-      get_something(): RestApiSuccessResponse<{ things: string[] }> | RestApiErrorResponse;
-    }
-  }
-}
-
-export function service(): Service<FakeServLocals> {
-  const base = useService<FakeServLocals>();
-  return {
-    ...base,
-    async start(app) {
-      await base.start(app);
-      app.locals.services.fakeServ = {
-        get_something() { throw new Error('Should not be called.'); },
-      };
-    },
-    async onRequest(req, res) {
-      await base.onRequest?.(req, res);
-      res.locals.rawBody = true;
-    },
-    async healthy(app) {
-      await base.healthy?.(app);
-      return new Promise((accept) => {
-        setTimeout(accept, 1000);
-      });
-    },
-  };
-}

package/__tests__/fake-serv/src/routes/error.ts

@@ -1,13 +0,0 @@
-import { ServiceRouter } from '../../../../src/index';
-import { ServiceError } from '../../../../src/error';
-
-export function route(router: ServiceRouter) {
-  router.get('/sync', (req) => {
-    throw new ServiceError(req.app, 'Synchronous error', { code: 'SyncError' });
-  });
-
-  router.get('/async', async (req) => {
-    await new Promise((accept) => { setTimeout(accept, 100); })
-      .then(() => { throw new ServiceError(req.app, 'Async error', { code: 'AsyncError' }); });
-  });
-}

package/__tests__/fake-serv/src/routes/index.ts

@@ -1,22 +0,0 @@
-import type { ServiceExpress, ServiceRouter } from '../../../../src';
-import { FakeServLocals } from '../index';
-
-export function route(
-  router: ServiceRouter<FakeServLocals>,
-  app: ServiceExpress<FakeServLocals>,
-) {
-  const worldRequests = app.locals.meter.createCounter('world_requests', {
-    description: 'Metrics about requests to world',
-  });
-
-  router.get('/world', (req, res) => {
-    worldRequests.add(1, { method: 'get' });
-    res.json({ hello: 'world' });
-  });
-
-  router.post('/world', async (req, res) => {
-    await app.locals.services.fakeServ.get_something();
-    worldRequests.add(1);
-    res.sendStatus(204);
-  });
-}

package/__tests__/fake-serv/src/routes/other/world.ts

@@ -1,7 +0,0 @@
-import type { Router } from 'express';
-
-export function route(router: Router) {
-  router.get('/', (req, res) => {
-    res.json({ hello: 'jupiter' });
-  });
-}

package/__tests__/fake-serv.test.ts

@@ -1,74 +0,0 @@
-import path from 'path';
-
-import request from 'supertest';
-
-import {
-  listen, ServiceStartOptions, shutdownApp, startApp,
-} from '../src/index';
-
-import { FakeServLocals, service } from './fake-serv/src/index';
-
-describe('fake-serv', () => {
-  test('basic service functionality', async () => {
-    const options: ServiceStartOptions<FakeServLocals> = {
-      service,
-      name: 'fake-serv',
-      rootDirectory: path.resolve(__dirname, './fake-serv'),
-      codepath: 'src',
-    };
-    const app = await startApp(options).catch((error) => {
-      console.error(error);
-      throw error;
-    });
-    expect(app).toBeTruthy();
-
-    let { body } = await request(app).get('/world').timeout(500).expect(200);
-    expect(body.hello).toEqual('world');
-
-    ({ body } = await request(app).get('/other/world').timeout(500).expect(200));
-    expect(body.hello).toEqual('jupiter');
-
-    ({ body } = await request(app).get('/hello').query({ greeting: 'Hello Pluto!', number: '6', break_things: true }).expect(200));
-    expect(body.greeting).toEqual('Hello Pluto!');
-
-    // Can't convert green to a number
-    await request(app).get('/hello').query({ greeting: 'Hello Pluto!', number: 'green' }).expect(400);
-
-    // Make sure body paramater conversion works
-    await request(app).post('/hello').send({ number: 'green' }).expect(400);
-    await request(app).post('/hello').send({ number: '6' }).expect(204);
-    await request(app).post('/hello').send({ number: 6 }).expect(204);
-
-    ({ body } = await request(app).get('/error/sync').timeout(1000).expect(500));
-    expect(body.code).toEqual('SyncError');
-
-    ({ body } = await request(app).get('/error/async').timeout(1000).expect(500));
-    expect(body.code).toEqual('AsyncError');
-
-    // Mocking
-    await request(app).post('/world').expect(500);
-
-    // Clean shutdown
-    await expect(shutdownApp(app)).resolves.toBeUndefined();
-    const secondApp = await startApp(options);
-
-    // Make sure we can listen
-    const server = await listen(secondApp);
-
-    // Call metrics
-    await request(secondApp).get('/world').expect(200);
-    await request(secondApp.locals.internalApp).get('/metrics')
-      .expect(200)
-      .expect((res) => expect(res.text).toMatch(/world_requests_total{method="get"} 1/));
-
-    await new Promise<void>((accept, reject) => {
-      server.close((e) => {
-        if (e) {
-          reject(e);
-        } else {
-          accept();
-        }
-      });
-    });
-  });
-});