pino-std 0.0.0-stage → 7.2.0

package/test/req.test.js

@@ -0,0 +1,477 @@
+'use strict'
+
+const { tspl } = require('@matteo.collina/tspl')
+const http = require('node:http')
+const { test } = require('node:test')
+const serializers = require('../lib/req')
+const { wrapRequestSerializer } = require('../')
+
+test('maps request', async (t) => {
+  const p = tspl(t, { plan: 2 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    const serialized = serializers.mapHttpRequest(req)
+    p.ok(serialized.req)
+    p.ok(serialized.req.method)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('does not return excessively long object', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(Object.keys(serialized).length, 6)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.raw is available', async (t) => {
+  const p = tspl(t, { plan: 2 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.foo = 'foo'
+    const serialized = serializers.reqSerializer(req)
+    p.ok(serialized.raw)
+    p.strictEqual(serialized.raw.foo, 'foo')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.raw will be obtained in from input request raw property if input request raw property is truthy', async (t) => {
+  const p = tspl(t, { plan: 2 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.raw = { req: { foo: 'foo' }, res: {} }
+    const serialized = serializers.reqSerializer(req)
+    p.ok(serialized.raw)
+    p.strictEqual(serialized.raw.req.foo, 'foo')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.id defaults to undefined', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.id, undefined)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.id has a non-function value', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(typeof serialized.id === 'function', false)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.id will be obtained from input request info.id when input request id does not exist', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.info = { id: 'test' }
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.id, 'test')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.id has a non-function value with custom id function', async (t) => {
+  const p = tspl(t, { plan: 2 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.id = function () { return 42 }
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(typeof serialized.id === 'function', false)
+    p.strictEqual(serialized.id, 42)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.url will be obtained from input request req.path when input request url is an object', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.path = '/test'
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.url, '/test')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.url will be obtained from input request url.path when input request url is an object', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.url = { path: '/test' }
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.url, '/test')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.url will be obtained from input request url when input request url is not an object', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.url = '/test'
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.url, '/test')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.url will be empty when input request path and url are not defined', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.url, '/')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.url will be obtained from input request originalUrl when available', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.originalUrl = '/test'
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.url, '/test')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.url will be obtained from input request url when req path is a function', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.path = function () {
+      throw new Error('unexpected invocation')
+    }
+    req.url = '/test'
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.url, '/test')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.url being undefined does not throw an error', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.url = undefined
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.url, undefined)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('can wrap request serializers', async (t) => {
+  const p = tspl(t, { plan: 3 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  const serailizer = wrapRequestSerializer(function (req) {
+    p.ok(req.method)
+    p.strictEqual(req.method, 'GET')
+    delete req.method
+    return req
+  })
+
+  function handler (req, res) {
+    const serialized = serailizer(req)
+    p.ok(!serialized.method)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.remoteAddress will be obtained from request socket.remoteAddress as fallback', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.socket = { remoteAddress: 'http://localhost' }
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.remoteAddress, 'http://localhost')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.remoteAddress will be obtained from request info.remoteAddress if available', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.info = { remoteAddress: 'http://localhost' }
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.remoteAddress, 'http://localhost')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.remotePort will be obtained from request socket.remotePort as fallback', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.socket = { remotePort: 3000 }
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.remotePort, 3000)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.remotePort will be obtained from request info.remotePort if available', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.info = { remotePort: 3000 }
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.remotePort, 3000)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.query is available', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.query = '/foo?bar=foobar&bar=foo'
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.query, '/foo?bar=foobar&bar=foo')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.params is available', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (req, res) {
+    req.params = '/foo/bar'
+    const serialized = serializers.reqSerializer(req)
+    p.strictEqual(serialized.params, '/foo/bar')
+    res.end()
+  }
+
+  await p.completed
+})

package/test/res.test.js

@@ -0,0 +1,120 @@
+'use strict'
+
+/* eslint-disable no-prototype-builtins */
+
+const { tspl } = require('@matteo.collina/tspl')
+const http = require('node:http')
+const { test } = require('node:test')
+const serializers = require('../lib/res')
+const { wrapResponseSerializer } = require('../')
+
+test('res.raw is not enumerable', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (_req, res) {
+    const serialized = serializers.resSerializer(res)
+    p.strictEqual(serialized.propertyIsEnumerable('raw'), false)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('res.raw is available', async (t) => {
+  const p = tspl(t, { plan: 2 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (_req, res) {
+    res.statusCode = 200
+    const serialized = serializers.resSerializer(res)
+    p.ok(serialized.raw)
+    p.strictEqual(serialized.raw.statusCode, 200)
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('can wrap response serializers', async (t) => {
+  const p = tspl(t, { plan: 3 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  const serializer = wrapResponseSerializer(function (res) {
+    p.ok(res.statusCode)
+    p.strictEqual(res.statusCode, 200)
+    delete res.statusCode
+    return res
+  })
+
+  function handler (_req, res) {
+    res.end()
+    res.statusCode = 200
+    const serialized = serializer(res)
+    p.ok(!serialized.statusCode)
+  }
+
+  await p.completed
+})
+
+test('res.headers is serialized', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (_req, res) {
+    res.setHeader('x-custom', 'y')
+    const serialized = serializers.resSerializer(res)
+    p.strictEqual(serialized.headers['x-custom'], 'y')
+    res.end()
+  }
+
+  await p.completed
+})
+
+test('req.url will be obtained from input request url when input request url is not an object', async (t) => {
+  const p = tspl(t, { plan: 1 })
+
+  const server = http.createServer(handler)
+  server.unref()
+  server.listen(0, () => {
+    http.get(server.address(), () => {})
+  })
+
+  t.after(() => server.close())
+
+  function handler (_req, res) {
+    const serialized = serializers.resSerializer(res)
+    p.strictEqual(serialized.statusCode, null)
+    res.end()
+  }
+
+  await p.completed
+})

package/test/types/index.test-d.ts

@@ -0,0 +1,71 @@
+import {IncomingMessage, ServerResponse} from "http";
+import {
+  err,
+  errWithCause,
+  req,
+  res,
+  SerializedError,
+  SerializedRequest,
+  wrapErrorSerializer,
+  wrapRequestSerializer,
+  wrapResponseSerializer,
+  SerializedResponse
+} from '../../';
+
+const customErrorSerializer = (error: SerializedError) => {
+  return {
+    myOwnError: {
+      data: `${error.type}-${error.message}\n\n${error.stack}`,
+    }
+  };
+};
+
+const customRequestSerializer = (req: SerializedRequest) => {
+  const {
+    headers,
+    id,
+    method,
+    raw,
+    remoteAddress,
+    remotePort,
+    url,
+    query,
+    params,
+  } = req;
+  return {
+    myOwnRequest: {
+      data: `${method}-${id}-${remoteAddress}-${remotePort}-${url}`,
+      headers,
+      raw,
+    }
+  };
+};
+
+const customResponseSerializer = (res: SerializedResponse) => {
+  const {headers, raw, statusCode} = res;
+  return {
+    myOwnResponse: {
+      data: statusCode,
+      headers,
+      raw,
+    }
+  };
+};
+
+const fakeError = new Error('A fake error for testing');
+const serializedError: SerializedError = err(fakeError);
+const mySerializer = wrapErrorSerializer(customErrorSerializer);
+
+const fakeErrorWithCause = new Error('A fake error for testing with cause', { cause: new Error('An inner fake error') });
+const serializedErrorWithCause: SerializedError = errWithCause(fakeError);
+
+const request: IncomingMessage = {} as IncomingMessage
+const serializedRequest: SerializedRequest = req(request);
+const myReqSerializer = wrapRequestSerializer(customRequestSerializer);
+
+const response: ServerResponse = {} as ServerResponse
+const myResSerializer = wrapResponseSerializer(customResponseSerializer);
+const serializedResponse = res(response);
+
+myResSerializer(response)
+

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": [ "es2022" ],
+    "module": "commonjs",
+    "noEmit": true,
+    "strict": true
+  },
+  "include": [
+    "./test/types/*.test-d.ts",
+    "./index.d.ts"
+  ]
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.