barehttp 1.0.0 → 2.1.0

package/package.json

@@ -1,16 +1,32 @@
 {
   "name": "barehttp",
-  "version": "1.0.0",
-  "description": "Lightweight and fast HTTP web server",
+  "version": "2.1.0",
+  "description": "Lightweight and fast Node.js web server",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
+  },
   "directories": {
     "lib": "lib",
     "test": "__tests__"
   },
+  "files": [
+    "lib"
+  ],
+  "type": "module",
+  "engines": {
+    "node": ">=22"
+  },
   "scripts": {
-    "build": "rm -rf ./lib && tsc",
-    "test": "jest --runInBand --coverage",
-    "release": "semantic-release"
+    "build": "rm -rf ./lib && tsc -p tsconfig.build.json",
+    "build:dev": "rm -rf ./dev-lib && tsc -p tsconfig.dev.json",
+    "test": "jest --coverage",
+    "lint": "eslint ./src --fix",
+    "release": "semantic-release -e ./.releaserc.json"
   },
   "keywords": [
     "nodejs",
@@ -21,37 +37,53 @@
     "lightweight",
     "fast"
   ],
-  "author": "Konstantin Knyazev <konstantinknyazev@outlook.com>",
+  "author": "Konstantin <29006524+sckv@users.noreply.github.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sckv/barehttp.git"
+  },
   "license": "MIT",
   "dependencies": {
-    "callsites": "^3.1.0",
-    "cookie": "^0.4.1",
-    "cookie-signature": "^1.1.0",
-    "find-my-way": "^4.2.0",
-    "hyperid": "^2.1.0",
-    "pino": "^6.11.3",
-    "pino-pretty": "^5.0.2"
+    "ajv": "^8.17.1",
+    "callsites": "^4.2.0",
+    "cookie": "^1.1.1",
+    "cookie-signature": "^1.2.2",
+    "find-my-way": "^9.3.0",
+    "hyperid": "^3.3.0",
+    "lodash": "^4.17.21",
+    "pino": "^10.1.0",
+    "pino-pretty": "^13.1.3",
+    "ts-morph": "^27.0.2",
+    "ws": "^8.18.3"
   },
   "devDependencies": {
-    "@ts-morph/bootstrap": "^0.9.1",
-    "@types/cookie": "^0.4.0",
-    "@types/cookie-signature": "^1.0.3",
-    "@types/node": "^15.0.2",
-    "@types/pino": "^6.3.8",
-    "@types/jest": "^26.0.23",
-    "@typescript-eslint/eslint-plugin": "^4.22.1",
-    "@typescript-eslint/parser": "^4.22.1",
-    "axios": "^0.21.1",
-    "eslint": "^7.26.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^24.3.6",
-    "express": "^4.17.1",
-    "fastify": "^3.15.1",
-    "jest": "^26.6.3",
-    "semantic-release": "^17.4.2",
-    "supertest": "^6.1.3",
-    "ts-jest": "^26.5.6",
-    "ts-node-dev": "^1.1.6",
-    "typescript": "^4.3.2"
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.2",
+    "@ts-morph/bootstrap": "^0.28.1",
+    "@types/cookie": "^0.6.0",
+    "@types/cookie-signature": "^1.1.2",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.0.3",
+    "@types/pino": "^7.0.4",
+    "@types/ws": "^8.18.1",
+    "@typescript-eslint/eslint-plugin": "^8.50.1",
+    "@typescript-eslint/parser": "^8.50.1",
+    "axios": "^1.13.2",
+    "eslint": "^9.39.2",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^29.11.0",
+    "express": "^5.2.1",
+    "fastify": "^5.6.2",
+    "jest": "^30.2.0",
+    "prettier": "^3.7.4",
+    "semantic-release": "^25.0.2",
+    "supertest": "^7.1.4",
+    "ts-jest": "^29.4.6",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.9.3"
+  },
+  "optionalDependencies": {
+    "bufferutil": "^4.1.0",
+    "utf-8-validate": "^6.0.6"
   }
 }

package/.eslintrc.js

@@ -1,47 +0,0 @@
-module.exports = {
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'jest', 'import'],
-  extends: [
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:import/errors',
-    'plugin:import/warnings',
-    'plugin:import/typescript',
-  ],
-  rules: {
-    // TS
-    '@typescript-eslint/no-var-requires': 0,
-    '@typescript-eslint/no-explicit-any': 0,
-    '@typescript-eslint/no-empty-function': 0,
-    '@typescript-eslint/generic-type-naming': 0,
-    '@typescript-eslint/explicit-function-return-type': 0,
-    '@typescript-eslint/explicit-module-boundary-types': 0,
-    '@typescript-eslint/prefer-namespace-keyword': 0,
-    '@typescript-eslint/no-non-null-assertion': 0,
-    '@typescript-eslint/no-use-before-define': 0,
-    'max-classes-per-file': ['error', 1],
-    // IMPORT
-    'import/prefer-default-export': 0,
-    'import/no-dynamic-require': 0,
-    'import/named': 2,
-    'import/namespace': 2,
-    'import/default': 2,
-    'import/export': 2,
-    'import/no-unresolved': 0,
-    'import/order': [
-      'error',
-      {
-        'newlines-between': 'always',
-        groups: ['external', 'internal', 'index', 'sibling', 'parent', 'builtin'],
-      },
-    ],
-    'import/no-extraneous-dependencies': [
-      'error',
-      {
-        devDependencies: true,
-        optionalDependencies: false,
-        peerDependencies: false,
-      },
-    ],
-  },
-};

package/.github/workflows/release.yml

@@ -1,27 +0,0 @@
-name: Release
-on:
-  push:
-    branches:
-      - master
-jobs:
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 14.15.1
-      - name: Install dependencies
-        run: npm ci
-      - name: Run tests
-        run: npm test
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm run release

package/.jest-setup.js

@@ -1 +0,0 @@
-process.setMaxListeners(999);

package/jest.config.js

@@ -1,8 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  collectCoverageFrom: ['<rootDir>/src/**/*.ts'],
-  coveragePathIgnorePatterns: ['<rootDir>/src/examples'],
-  testMatch: ['<rootDir>/src/**/**.test.ts'],
-  setupFiles: ['<rootDir>/.jest-setup.js'],
-};

package/prettier.config.js

@@ -1,6 +0,0 @@
-module.exports = {
-  trailingComma: 'all',
-  singleQuote: true,
-  printWidth: 100,
-  overrides: [{ files: '*.ts', parser: 'typescript' }],
-};

package/src/context/context.test.ts

@@ -1,30 +0,0 @@
-import { context, enableContext, newContext } from './index';
-
-test("Do not create execution if it's not enabled", () => {
-  newContext('newContext');
-
-  expect(context.current).toBeUndefined();
-});
-
-test('Starts context and attaches an Execution class', () => {
-  const hook = enableContext();
-
-  newContext('newContext');
-
-  expect(context.current?.id).toEqual(expect.any(String));
-  expect(context.current?.type).toBe('newContext');
-
-  hook.disable();
-});
-
-test('Execution class store exists and can store values', () => {
-  const hook = enableContext();
-
-  newContext('newContext');
-
-  context.current?.store.set('store', 'value');
-
-  expect(context.current?.store.get('store')).toBe('value');
-
-  hook.disable();
-});

package/src/context/execution.ts

@@ -1,17 +0,0 @@
-import hyperid from 'hyperid';
-
-const generateId = hyperid();
-
-export class Execution {
-  id: string;
-  type: string;
-  store: Map<string, string | number>;
-  headers: Map<string, string | number>;
-
-  constructor(type: string) {
-    this.id = generateId();
-    this.type = type;
-    this.store = new Map<string, string>();
-    this.headers = new Map<string, string>();
-  }
-}

package/src/context/index.ts

@@ -1,61 +0,0 @@
-import { Execution } from './execution';
-
-import asyncHooks from 'async_hooks';
-
-const running = new Map<number, Execution>();
-const previous = new Map<number, Execution>();
-
-type Context = {
-  current?: Execution;
-  enabled: boolean;
-};
-
-const newContext = (type: string) => {
-  if (!context.enabled) return;
-  context.current = new Execution(type);
-  running.set(asyncHooks.executionAsyncId(), context.current);
-};
-
-const context: Context = {
-  enabled: false,
-} as any;
-
-function init(asyncId: number, _type: string, triggerAsyncId: number) {
-  if (running.get(triggerAsyncId)) {
-    running.set(asyncId, running.get(triggerAsyncId)!);
-  }
-}
-
-function before(asyncId: number) {
-  if (!running.get(asyncId)) return;
-
-  previous.set(asyncId, context.current!);
-  context.current = running.get(asyncId);
-}
-
-function after(asyncId: number) {
-  if (!running.get(asyncId)) return;
-
-  context.current = previous.get(asyncId);
-}
-
-function destroy(asyncId: number) {
-  if (running.get(asyncId)) {
-    running.delete(asyncId);
-    previous.delete(asyncId);
-  }
-}
-
-const hook = asyncHooks.createHook({
-  init,
-  before,
-  after,
-  destroy,
-});
-
-const enableContext = () => {
-  context.enabled = true;
-  return hook.enable();
-};
-
-export { context, newContext, enableContext };

package/src/env.ts

@@ -1,5 +0,0 @@
-export const envs = {
-  isProd: process.env.NODE_ENV === 'production',
-  isDev: process.env.NODE_ENV === 'development',
-  isTest: process.env.NODE_ENV === 'test',
-};

package/src/examples/bare-http.ts

@@ -1,36 +0,0 @@
-import { BareHttp, logMe, context } from '../index';
-
-const app = new BareHttp({ logging: true });
-
-const wait = () => new Promise((resolve) => setTimeout(resolve, 5000));
-app.route.get({
-  route: '/route',
-  options: { timeout: 2000 },
-  handler: async (flow) => {
-    flow.cm?.setCookie('MY KOOKIE', 'value', { domain: 'localhost' });
-    await wait();
-    // throw new Error('just fail');
-    return 'JUST MESSAGE 2';
-  },
-});
-
-app.route.post({
-  route: '/route',
-  handler: async function routeV1(flow) {
-    return 'JUST MESSAGE';
-  },
-});
-
-app
-  .use((flow) => {
-    return;
-  })
-  .use(async (flow) => {
-    return;
-  });
-
-console.log(app.getRoutes());
-
-app.start((address) => {
-  console.log(`BareHttp started at ${address}`);
-});

package/src/examples/express.ts

@@ -1,11 +0,0 @@
-const express = require('express');
-const app = express();
-const port = 3001;
-
-app.get('/route', (req, res) => {
-  res.send('JUST RESPONSE');
-});
-
-app.listen(port, () => {
-  console.log(`Example app listening at http://localhost:${port}`);
-});

package/src/examples/fastify.ts

@@ -1,18 +0,0 @@
-const fastify = require('fastify')({
-  logger: true,
-});
-
-// Declare a route
-fastify.get('/route', function (request, reply) {
-  reply.send('JUST RESPONSE');
-});
-
-// Run the server!
-fastify.listen(3002, function (err, address) {
-  if (err) {
-    fastify.log.error(err);
-    process.exit(1);
-  }
-  console.log('rutting server');
-  fastify.log.info(`server listening on ${address}`);
-});

package/src/index.ts

@@ -1,4 +0,0 @@
-export { BareServer as BareHttp } from './server';
-export type { BareRequest } from './request';
-export { context } from './context';
-export { logMe } from './logger';

package/src/logger/index.ts

@@ -1,67 +0,0 @@
-import pino, { destination } from 'pino';
-
-import { serializeLog, serializeHttp } from './serializers';
-
-import { envs } from '../env';
-
-const asyncDest = envs.isProd ? [destination({ sync: false })] : [];
-
-const pinoCommonOptions = {
-  timestamp: () => `,"time":"${new Date()[envs.isProd ? 'toISOString' : 'toLocaleTimeString']()}"`,
-  formatters: {
-    level: (label: string) => ({ level: label }),
-  },
-  messageKey: 'message',
-  prettyPrint: !envs.isProd,
-};
-
-const logger = pino(pinoCommonOptions, asyncDest[0]);
-
-if (envs.isProd) {
-  setInterval(function () {
-    logger.flush();
-  }, 10000).unref();
-
-  const handler = pino.final(logger, (err, finalLogger, evt) => {
-    finalLogger.info(`${evt} caught`);
-    if (err) finalLogger.error(err, 'error caused exit');
-    process.exit(err ? 1 : 0);
-  });
-
-  // catch all the ways node might exit
-  process.on('beforeExit', () => handler(null, 'beforeExit'));
-  process.on('exit', () => handler(null, 'exit'));
-  process.on('uncaughtException', (err) => handler(err, 'uncaughtException'));
-  process.on('SIGINT', () => handler(null, 'SIGINT'));
-  process.on('SIGQUIT', () => handler(null, 'SIGQUIT'));
-  process.on('SIGTERM', () => handler(null, 'SIGTERM'));
-}
-
-interface LogMeFn {
-  (obj: unknown, ...args: []): void;
-  (msg: string, ...args: any[]): void;
-}
-
-type LogMe = {
-  info: LogMeFn;
-  warn: LogMeFn;
-  error: LogMeFn;
-  fatal: LogMeFn;
-  debug: LogMeFn;
-  trace: LogMeFn;
-};
-
-export const logHttp = (...params: Parameters<typeof serializeHttp>) => {
-  const { level, logObject } = serializeHttp(...params);
-  logger[level](logObject);
-};
-
-// TODO: remove the test condition
-export const logMe: LogMe = {
-  debug: (...args) => !envs.isTest && logger.debug(serializeLog(...args)),
-  info: (...args) => !envs.isTest && logger.info(serializeLog(...args)),
-  warn: (...args) => !envs.isTest && logger.warn(serializeLog(...args)),
-  error: (...args) => !envs.isTest && logger.error(serializeLog(...args)),
-  fatal: (...args) => !envs.isTest && logger.fatal(serializeLog(...args)),
-  trace: (...args) => !envs.isTest && logger.trace(serializeLog(...args)),
-};

package/src/logger/serializers.test.ts

@@ -1,186 +0,0 @@
-import { getStatusLevel, parseError, serializeHttp, serializeLog } from './serializers';
-
-describe('logger - loglevel', () => {
-  test('Correctly gets http log level from the returning http status <300', () => {
-    expect(getStatusLevel(200)).toBe('info');
-  });
-  test('Correctly gets http log level from the returning http status >=400 && <500', () => {
-    expect(getStatusLevel(422)).toBe('warn');
-  });
-  test('Correctly gets http log level from the returning http status >=500', () => {
-    expect(getStatusLevel(500)).toBe('error');
-  });
-});
-const req = {
-  socket: { remoteAddress: '123.123.123.123' },
-  method: 'POST',
-  url: '/route',
-  httpVersionMajor: 1,
-  httpVersionMinor: 1,
-  headers: { 'request-header': 'JAS(D*8y2joidA&T12' },
-  httpVersion: '1.1',
-};
-const res = {
-  statusCode: 200,
-};
-
-describe('logger - http call serializer', () => {
-  test('Correctly serializes an req/res for an http log', () => {
-    expect(
-      serializeHttp(
-        { 'my-header': 'header-value' },
-        { toISOString: () => 'SOME_DATE' } as any,
-        'remote.client',
-        req as any,
-        res as any,
-      ),
-    ).toEqual({
-      level: 'info',
-      logObject: {
-        message: '123.123.123.123 remote.client SOME_DATE "POST /route HTTP/1.1" 200 -',
-        timestamp: expect.any(Number),
-        trace: undefined,
-        request: {
-          headers: { 'request-header': 'JAS(D*8y2joidA&T12' },
-          http_version: '1.1',
-          id: 'unknown',
-          method: 'POST',
-          url: '/route',
-        },
-        response: {
-          status_code: res.statusCode,
-          headers: { 'my-header': 'header-value' },
-        },
-        duration: 'unknown',
-      },
-    });
-  });
-});
-
-describe('logger - parse error with fields', () => {
-  test('Correctly parses an error with additional enumerable fields', () => {
-    const customError = new Error('custom error message') as any;
-    customError.additionalProp = 'value';
-    expect(parseError(customError, {})).toEqual({
-      error: {
-        additionalProp: 'value',
-        kind: 'Error',
-        stack: expect.any(String),
-      },
-      message: 'custom error message',
-    });
-  });
-});
-
-// common logger
-describe('logger - common logger serializer', () => {
-  test('Correctly serializes log for only text', () => {
-    expect(serializeLog('just log message')).toEqual({
-      location: expect.any(String),
-      logger: {
-        method_name: 'asyncJestTest',
-        name: 'pino',
-        version: 'v1.0.0',
-      },
-      message: 'just log message',
-      timestamp: expect.any(Number),
-      trace: undefined,
-    });
-  });
-
-  test('Correctly serializes log for text + object', () => {
-    expect(serializeLog('just log message', { obj: 'to_log' })).toEqual({
-      location: expect.any(String),
-      logger: {
-        method_name: 'asyncJestTest',
-        name: 'pino',
-        version: 'v1.0.0',
-      },
-      message: 'just log message',
-      timestamp: expect.any(Number),
-      trace: undefined,
-      args: [{ obj: 'to_log' }],
-    });
-  });
-
-  test('Correctly serializes log for object', () => {
-    expect(serializeLog({ obj: 'to_log', anotherKey: 9839485 })).toEqual({
-      location: expect.any(String),
-      logger: {
-        method_name: 'asyncJestTest',
-        name: 'pino',
-        version: 'v1.0.0',
-      },
-      message: 'EMPTY_MESSAGE',
-      timestamp: expect.any(Number),
-      trace: undefined,
-      args: { obj: 'to_log', anotherKey: 9839485 },
-    });
-  });
-
-  test('Correctly serializes log for multiple objects', () => {
-    expect(
-      serializeLog({ obj: 'to_log', anotherKey: 9839485 }, { additional: 'properties' }),
-    ).toEqual({
-      location: expect.any(String),
-      logger: {
-        method_name: 'asyncJestTest',
-        name: 'pino',
-        version: 'v1.0.0',
-      },
-      message: 'EMPTY_MESSAGE',
-      timestamp: expect.any(Number),
-      trace: undefined,
-      args: [{ obj: 'to_log', anotherKey: 9839485 }, { additional: 'properties' }],
-    });
-  });
-
-  test('Correctly serializes log for error', () => {
-    const customError = new Error('custom error message') as any;
-    customError.additionalProp = 'value';
-
-    expect(serializeLog(customError)).toEqual({
-      location: expect.any(String),
-      logger: {
-        method_name: 'asyncJestTest',
-        name: 'pino',
-        version: 'v1.0.0',
-      },
-      message: 'custom error message',
-      timestamp: expect.any(Number),
-      trace: undefined,
-      error: {
-        additionalProp: 'value',
-        kind: 'Error',
-        stack: expect.any(String),
-      },
-    });
-  });
-
-  test('Correctly serializes log for error when error is not first argument', () => {
-    const customError = new Error('custom error message') as any;
-    customError.additionalProp = 'value';
-
-    expect(serializeLog('message for the log', customError)).toEqual({
-      location: expect.any(String),
-      logger: {
-        method_name: 'asyncJestTest',
-        name: 'pino',
-        version: 'v1.0.0',
-      },
-      message: 'message for the log',
-      timestamp: expect.any(Number),
-      trace: undefined,
-      args: [
-        {
-          error: {
-            additionalProp: 'value',
-            kind: 'Error',
-            stack: expect.any(String),
-          },
-          message: 'custom error message',
-        },
-      ],
-    });
-  });
-});