npm - barehttp - Versions diffs - 1.0.0 → 2.0.0 - Mend

barehttp 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (83) hide show

package/README.md +185 -28
package/lib/context/execution.d.ts +7 -0
package/lib/context/execution.js +14 -0
package/lib/context/index.d.ts +10 -0
package/lib/context/index.js +46 -0
package/lib/env.d.ts +5 -0
package/lib/env.js +5 -0
package/lib/index.d.ts +5 -0
package/lib/index.js +3 -0
package/lib/logger/index.d.ts +16 -0
package/lib/logger/index.js +26 -0
package/lib/logger/serializers.d.ts +28 -0
package/lib/logger/serializers.js +78 -0
package/lib/middlewares/cookies/cookie-manager.d.ts +25 -0
package/lib/middlewares/cookies/cookie-manager.js +68 -0
package/lib/middlewares/cookies/signer.d.ts +8 -0
package/lib/middlewares/cookies/signer.js +25 -0
package/lib/middlewares/cors/cors.d.ts +38 -0
package/lib/middlewares/cors/cors.js +164 -0
package/lib/request.d.ts +84 -0
package/lib/request.js +260 -0
package/lib/schemas/custom-schema.d.ts +32 -0
package/lib/schemas/custom-schema.js +62 -0
package/lib/schemas/dirty-tsm.d.ts +1 -0
package/lib/schemas/dirty-tsm.js +199 -0
package/lib/schemas/generator.d.ts +7 -0
package/lib/schemas/generator.js +179 -0
package/lib/schemas/helpers.d.ts +27 -0
package/lib/schemas/helpers.js +40 -0
package/lib/schemas/json-schema.d.ts +2 -0
package/lib/schemas/json-schema.js +48 -0
package/lib/schemas/openami-schema.d.ts +2 -0
package/lib/schemas/openami-schema.js +59 -0
package/lib/schemas/project.d.ts +1 -0
package/lib/schemas/project.js +1 -0
package/lib/server.d.ts +154 -0
package/lib/server.js +396 -0
package/lib/utils/content-type.d.ts +54 -0
package/lib/utils/content-type.js +54 -0
package/lib/utils/http-methods.d.ts +11 -0
package/lib/utils/http-methods.js +9 -0
package/lib/utils/index.d.ts +4 -0
package/lib/utils/index.js +4 -0
package/lib/utils/safe-json.d.ts +2 -0
package/lib/utils/safe-json.js +18 -0
package/lib/utils/status-codes.d.ts +339 -0
package/lib/utils/status-codes.js +339 -0
package/lib/utils/status-phrases.d.ts +338 -0
package/lib/utils/status-phrases.js +339 -0
package/lib/websocket.d.ts +36 -0
package/lib/websocket.js +176 -0
package/package.json +64 -32
package/.eslintrc.js +0 -47
package/.github/workflows/release.yml +0 -27
package/.jest-setup.js +0 -1
package/jest.config.js +0 -8
package/prettier.config.js +0 -6
package/src/context/context.test.ts +0 -30
package/src/context/execution.ts +0 -17
package/src/context/index.ts +0 -61
package/src/env.ts +0 -5
package/src/examples/bare-http.ts +0 -36
package/src/examples/express.ts +0 -11
package/src/examples/fastify.ts +0 -18
package/src/index.ts +0 -4
package/src/logger/index.ts +0 -67
package/src/logger/serializers.test.ts +0 -186
package/src/logger/serializers.ts +0 -109
package/src/middlewares/cookies/cookie-manager.ts +0 -86
package/src/middlewares/cookies/signer.ts +0 -30
package/src/report.ts +0 -25
package/src/request.test.ts +0 -143
package/src/request.ts +0 -277
package/src/server.integration.test.ts +0 -296
package/src/server.middlewares.test.ts +0 -93
package/src/server.routes.test.ts +0 -71
package/src/server.ts +0 -450
package/src/utils/content-type.ts +0 -59
package/src/utils/index.ts +0 -2
package/src/utils/safe-json.ts +0 -17
package/src/utils/status-codes.ts +0 -339
package/src/utils/status-phrases.ts +0 -339
package/tsconfig.json +0 -24

package/src/middlewares/cookies/cookie-manager.ts DELETED Viewed

@@ -1,86 +0,0 @@
-import cookie from 'cookie';
-import { secretsOperator } from './signer';
-import { logMe } from '../../logger';
-import type { BareRequest } from '../../request';
-export type CookieManagerOptions = cookie.CookieSerializeOptions & {
-  signed?: boolean;
-  parseOptions?: cookie.CookieParseOptions;
-  secret?: string | string[];
-};
-export class CookieManager {
-  signer: null | ReturnType<typeof secretsOperator>;
-  constructor(private options: CookieManagerOptions = {}, private flow: BareRequest) {
-    const secret = this.options.secret || '';
-    const enableRotation = Array.isArray(secret);
-    this.signer = typeof secret === 'string' || enableRotation ? secretsOperator(secret) : null;
-  }
-  setCookie(
-    name: string,
-    value: string,
-    options?: CookieManagerOptions,
-    signer?: ReturnType<typeof secretsOperator>,
-  ) {
-    const localSigner = signer || this.signer;
-    const opts = options || this.options;
-    if (opts.expires && Number.isInteger(opts.expires)) {
-      opts.expires = new Date(opts.expires);
-    }
-    if (opts.signed && localSigner) {
-      value = localSigner.sign(value);
-    }
-    const serialized = cookie.serialize(name, value, opts);
-    let setCookie = this.flow.getHeader('Set-Cookie');
-    if (!setCookie) {
-      this.flow.setHeader('Set-Cookie', serialized);
-      return;
-    }
-    if (typeof setCookie === 'string') {
-      setCookie = [setCookie];
-    }
-    setCookie.push(serialized);
-    this.flow.setHeader('Set-Cookie', setCookie);
-  }
-  clearCookie(name: string, options: CookieManagerOptions = {}) {
-    const opts = {
-      path: '/',
-      ...options,
-      expires: new Date(1),
-      signed: undefined,
-      maxAge: undefined,
-    };
-    return this.setCookie(name, '', opts);
-  }
-  parseCookie(rawCookie?: string): { [k: string]: string } {
-    if (!rawCookie) return {};
-    const result = {};
-    const values = rawCookie?.split(';');
-    for (let i = 0; i < values.length - 1; i++) {
-      const split = values[i].trim().split('=');
-      if (split.length == 2) result[split[0]] = split[1];
-    }
-    return result;
-  }
-  unsignCookie(value) {
-    if (!this.signer) {
-      logMe.error('No signer defined for the cookies, unsign wont work');
-      return;
-    }
-    return this.signer.unsign(value);
-  }
-}

package/src/middlewares/cookies/signer.ts DELETED Viewed

@@ -1,30 +0,0 @@
-import cookieSignature from 'cookie-signature';
-export function secretsOperator(secret: string | string[]) {
-  const secrets = Array.isArray(secret) ? secret : [secret];
-  const [signingKey] = secrets;
-  return {
-    sign(value: string) {
-      return cookieSignature.sign(value, signingKey);
-    },
-    unsign(signedValue) {
-      let valid = false;
-      let renew = false;
-      let value: string | null = null;
-      for (const key of secrets) {
-        const result = cookieSignature.unsign(signedValue, key);
-        if (result !== false) {
-          valid = true;
-          renew = key !== signingKey;
-          value = result;
-          break;
-        }
-      }
-      return { valid, renew, value };
-    },
-  };
-}

package/src/report.ts DELETED Viewed

@@ -1,25 +0,0 @@
-import { RouteReport } from './server';
-export function generateReport(routes: Map<string, RouteReport>) {
-  const lines: string[] = [];
-  lines.push(
-    '<!DOCTYPE html><html><head><title>Routes usage</title><meta charset="utf-8"></head><body><table style="border: 2px;border-style: ridge;border-radius: 5px;padding: 10px;"><tr><th>Route</th><th>Hits</th><th>Successes</th><th>Fails</th></tr>',
-  );
-  const sorted = [...routes].sort(([a], [b]) => {
-    if (a > b) return 1;
-    else if (b > a) return -1;
-    return 0;
-  });
-  sorted.forEach(([route, stats]) => {
-    lines.push(
-      `<tr><td>${route}</td><td>${stats.hits}</td><td>${stats.success}</td><td>${stats.fails}</td></tr>`,
-    );
-  });
-  lines.push('</table></body></html>');
-  return lines.join('');
-}

package/src/request.test.ts DELETED Viewed

@@ -1,143 +0,0 @@
-import { BareRequest } from './request';
-import { IncomingMessage, ServerResponse } from 'http';
-import { Socket } from 'net';
-const sock = new Socket({ readable: true, writable: true });
-const createRequest = () => {
-  const inc = new IncomingMessage(sock);
-  const out = new ServerResponse(inc);
-  const request = new BareRequest(inc, out);
-  return { inc, out, request };
-};
-test('Generates uuid upon instantiation', () => {
-  const { request } = createRequest();
-  expect(request.uuid).not.toBeUndefined();
-});
-test('Gets an uuid upon instantiation from headers', () => {
-  const { inc, out } = createRequest();
-  inc.headers['x-request-id'] = 'SOME_UUID';
-  const request = new BareRequest(inc, out);
-  expect(request.uuid).toBe('SOME_UUID');
-});
-test('Adds logging listener if set up', () => {
-  const { inc, out } = createRequest();
-  const listeners = out.listenerCount('close');
-  new BareRequest(inc, out, true);
-  expect(out.listenerCount('close')).toBe(listeners + 1);
-});
-test('Gets response header', () => {
-  const { request } = createRequest();
-  request['headers']['Content-Length'] = '99';
-  expect(request.getHeader('Content-Length')).toBe('99');
-});
-test('Adds basic headers to the request upon instantiation', () => {
-  const { request } = createRequest();
-  expect(request.getHeader('Content-Type')).toBe('text/plain');
-  expect(request.getHeader('X-Request-Id')).toEqual(expect.any(String));
-});
-// headers
-test('Disables cache', () => {
-  const { request } = createRequest();
-  request.disableCache();
-  expect(request['cache']).toBeFalsy();
-});
-test('Sets cache headers for private; max-age=3800; must-revalidate', () => {
-  const { request } = createRequest();
-  request.setCache({
-    cacheability: 'private',
-    expirationKind: 'max-age',
-    expirationSeconds: 3800,
-    revalidation: 'must-revalidate',
-  });
-  expect(request.getHeader('Cache-Control')).toBe('private; max-age=3800; must-revalidate');
-});
-test('Sets cache headers for no-store; max-age=0; must-revalidate', () => {
-  const { request } = createRequest();
-  request.setCache({
-    cacheability: 'no-store',
-    expirationKind: 'max-age',
-    expirationSeconds: 0,
-    revalidation: 'must-revalidate',
-  });
-  expect(request.getHeader('Cache-Control')).toBe('no-store; max-age=0; must-revalidate');
-});
-test('Sets response header', () => {
-  const { request } = createRequest();
-  request.setHeader('Vary', 'Origin');
-  expect(request.getHeader('Vary')).toBe('Origin');
-});
-test('Sets multiple response headers', () => {
-  const { request } = createRequest();
-  request.setHeaders({ Vary: 'Origin', Host: 'http://barehttp.com' });
-  expect(request.getHeader('Vary')).toBe('Origin');
-  expect(request.getHeader('Host')).toBe('http://barehttp.com');
-});
-test('Does not get request cookie if cookie manager is disabled', () => {
-  const token = '34his7dh3is8dyabf04y8ei';
-  const { inc, request } = createRequest();
-  inc.headers['cookie'] = `access_token=${token};`;
-  request['populateCookies']();
-  expect(request.getCookie('access_token')).toBe(undefined);
-});
-test('Gets request cookie if cookie manager is enabled', () => {
-  const token = '34his7dh3is8dyabf04y8ei';
-  const { inc, request } = createRequest();
-  inc.headers['cookie'] = `access_token=${token};`;
-  request['attachCookieManager']();
-  request['populateCookies']();
-  expect(request.getCookie('access_token')).toBe(token);
-});
-test('Gets all request cookies', () => {
-  const token = '34his7dh3is8dyabf04y8ei';
-  const refererId = '8237485';
-  const { inc, request } = createRequest();
-  inc.headers['cookie'] = `access_token=${token}; referer_id=${refererId};`;
-  request['attachCookieManager']();
-  request['populateCookies']();
-  expect(request.getCookie('access_token')).toBe(token);
-  expect(request.getCookie('referer_id')).toBe(refererId);
-});
-test('Sets response code (HTTP)', () => {});
-test('Sets and sends response code (HTTP)', () => {});
-test('Streams a response stream to the socket', () => {});
-test('Sends a JSON to the response', () => {});
-test('Sends a serializable data to the response', () => {});
-test('Reads body correctly', () => {});

package/src/request.ts DELETED Viewed

@@ -1,277 +0,0 @@
-import hyperid from 'hyperid';
-import { StatusCodes, StatusPhrases } from './utils/';
-import { JSONParse, JSONStringify } from './utils/safe-json';
-import { logHttp, logMe } from './logger';
-import { ContentType } from './utils/content-type';
-import { CookieManager, CookieManagerOptions } from './middlewares/cookies/cookie-manager';
-import { types } from 'util';
-import type { IncomingMessage, ServerResponse } from 'http';
-const generateId = hyperid();
-type Codes<K extends keyof typeof StatusCodes = keyof typeof StatusCodes> = {
-  [L in typeof StatusCodes[K]]: typeof StatusPhrases[K];
-};
-type Cacheability = 'public' | 'private' | 'no-cache' | 'no-store';
-type ExpirationType =
-  | 'max-age'
-  | 's-maxage'
-  | 'max-stale'
-  | 'min-fresh'
-  | 'stale-while-revalidate'
-  | 'stale-if-error';
-type Revalidation = 'must-revalidate' | 'proxy-revalidate' | 'immutable';
-export type CacheOpts = {
-  cacheability: Cacheability;
-  expirationKind: ExpirationType;
-  /**
-   * Default 3600
-   */
-  expirationSeconds?: number;
-  revalidation?: Revalidation;
-};
-const statusTuples = Object.entries(StatusCodes).reduce((acc, [name, status]) => {
-  acc[status] = StatusPhrases[name];
-  return acc;
-}, {} as Codes);
-export class BareRequest {
-  uuid: string;
-  params: { [k: string]: string | undefined } = {};
-  remoteIp?: string;
-  requestBody?: any;
-  requestHeaders: { [key: string]: any };
-  statusToSend = 200;
-  cm?: CookieManager;
-  sent = false;
-  private cache = true;
-  private startTime: [seconds: number, nanoseconds: number];
-  private startDate = new Date();
-  private remoteClient = '';
-  private countTimeFormat: 'ms' | 's' = 's';
-  private headers: { [header: string]: string | string[] } = {};
-  private cookies: { [cooke: string]: string } = {};
-  private contentType?: keyof typeof ContentType;
-  private timeout?: NodeJS.Timeout;
-  constructor(
-    public _originalRequest: IncomingMessage,
-    public _originalResponse: ServerResponse,
-    logging?: boolean,
-  ) {
-    this.uuid = (_originalRequest.headers['x-request-id'] as string) || generateId();
-    this.remoteIp = _originalRequest.socket.remoteAddress;
-    this.contentType = this._originalRequest.headers['content-type'] as any;
-    this.requestHeaders = this._originalRequest.headers;
-    _originalRequest['id'] = this.uuid; // to receive an id later on in the route handler
-    this.setHeaders({ 'Content-Type': 'text/plain', 'X-Request-Id': this.uuid });
-    this.startTime = process.hrtime();
-    // call logging section
-    if (logging === true) {
-      _originalResponse.on('close', () =>
-        logHttp(
-          this.headers,
-          this.startDate,
-          this.remoteClient,
-          _originalRequest,
-          _originalResponse,
-        ),
-      );
-    }
-  }
-  private readBody() {
-    if (['POST', 'PATCH', 'PUT'].includes(this._originalRequest.method!))
-      return new Promise<void>((resolve, reject) => {
-        const temp: any = [];
-        this._originalRequest
-          .on('data', (chunk) => temp.push(chunk))
-          .on('end', () => {
-            const parsed = this.classifyRequestBody(temp);
-            if (types.isNativeError(parsed)) reject(parsed);
-            this.requestBody = parsed;
-            resolve();
-          })
-          .on('error', reject);
-      });
-  }
-  private attachCookieManager(opts?: CookieManagerOptions) {
-    this.cm = new CookieManager(opts, this);
-  }
-  private populateCookies() {
-    this.cookies = this.cm?.parseCookie(this._originalRequest.headers.cookie) || {};
-  }
-  private classifyRequestBody(data: Buffer[]) {
-    const wholeChunk = Buffer.concat(data);
-    switch (this.contentType) {
-      case 'text/plain':
-        return wholeChunk.toString();
-      case 'application/json':
-        return JSONParse(wholeChunk.toString());
-      case 'application/x-www-form-urlencoded':
-        const store = {};
-        for (const curr of wholeChunk.toString().split('&')) {
-          const [key, value] = curr.split('=');
-          if (!key || !value) return null; // form urlencoded is not correct
-          store[key] = value;
-        }
-        return store;
-      default:
-        return wholeChunk;
-    }
-  }
-  private setRemoteClient(remoteClient: string) {
-    this.remoteClient = remoteClient;
-  }
-  private setRequestTime() {
-    const diff = process.hrtime(this.startTime);
-    const time =
-      diff[0] * (this.countTimeFormat === 's' ? 1 : 1e3) +
-      diff[1] * (this.countTimeFormat === 's' ? 1e-9 : 1e-6);
-    this.setHeaders({
-      'X-Processing-Time': time,
-      'X-Processing-Time-Mode': this.countTimeFormat === 's' ? 'seconds' : 'milliseconds',
-    });
-  }
-  private setTimeFormat(format: 's' | 'ms') {
-    this.countTimeFormat = format;
-  }
-  private cleanHeader(header: string) {
-    delete this.headers[header];
-  }
-  private attachTimeout(timeout: number) {
-    if (this.timeout) clearTimeout(this.timeout);
-    this.timeout = setTimeout(() => {
-      this.status(503);
-      this.send('Server aborted connection by overtime');
-    }, timeout);
-    // attach listener to clear the timeout
-    this._originalResponse.on('close', () => this.timeout && clearTimeout(this.timeout));
-  }
-  private setParams(params: { [k: string]: string | undefined }) {
-    this.params = params;
-  }
-  // ======== PUBLIC APIS ========
-  getHeader(header: string) {
-    return this.headers[header];
-  }
-  getCookie(cookie: string) {
-    return this.cookies[cookie];
-  }
-  getCookies() {
-    return { ...this.cookies };
-  }
-  disableCache() {
-    this.cache = false;
-  }
-  setCache(cacheOpts: CacheOpts) {
-    const cacheHeader: string[] = [];
-    const directive = 'Cache-Control';
-    if (cacheOpts.cacheability) cacheHeader.push(cacheOpts.cacheability);
-    if (cacheOpts.expirationKind)
-      cacheHeader.push(`${cacheOpts.expirationKind}=${cacheOpts.expirationSeconds ?? 3600}`);
-    if (cacheOpts.revalidation) cacheHeader.push(cacheOpts.revalidation);
-    if (cacheHeader.length > 0) this.setHeader(directive, cacheHeader.join('; '));
-  }
-  setHeader(header: string, value: string | number | string[] | number[]) {
-    this.headers[header] = Array.isArray(value) ? value.map((v) => '' + v).join('; ') : '' + value;
-  }
-  setHeaders(headers: { [header: string]: string | number }) {
-    for (const header of Object.keys(headers)) {
-      this.headers[header] = '' + headers[header];
-    }
-  }
-  status(status: typeof StatusCodes[keyof typeof StatusCodes]) {
-    this.statusToSend = status;
-  }
-  sendStatus(status: typeof StatusCodes[keyof typeof StatusCodes]) {
-    this.status(status);
-    this.send();
-  }
-  stream<T extends NodeJS.WritableStream>(stream: T) {
-    this._originalResponse.pipe(stream, { end: true });
-  }
-  json(data: any) {
-    // to generate with fast-json-stringify schema issue #1
-    const jsoned = JSONStringify(data);
-    this.setHeader('Content-Type', 'application/json');
-    this.send(jsoned ? jsoned : undefined);
-  }
-  send(chunk?: string | ArrayBuffer | NodeJS.ArrayBufferView | SharedArrayBuffer) {
-    if (this._originalResponse.socket?.destroyed) {
-      logMe.error("Tying to send into closed client's stream");
-      return;
-    }
-    if (this._originalResponse.headersSent) {
-      logMe.error('Trying to send with the headers already sent');
-      return;
-    }
-    this.sent = true;
-    let toSend = chunk;
-    switch (chunk?.constructor) {
-      case Uint16Array:
-      case Uint8Array:
-      case Uint32Array:
-        toSend = Buffer.from((chunk as any).buffer);
-    }
-    // work basic headers
-    if (typeof chunk !== 'undefined' && chunk !== null)
-      this.setHeader('Content-Length', Buffer.byteLength(chunk, 'utf-8'));
-    if (!this.cache)
-      this.setHeaders({ 'Cache-Control': 'no-store', Expire: 0, Pragma: 'no-cache' });
-    if (this.statusToSend >= 400 && this.statusToSend !== 404 && this.statusToSend !== 410)
-      this.cleanHeader('Cache-Control');
-    this.setRequestTime();
-    // perform sending
-    this._originalResponse.writeHead(
-      this.statusToSend,
-      statusTuples[this.statusToSend],
-      this.headers,
-    );
-    this._originalResponse.end(toSend);
-  }
-}