chore: unit tests and code format

Author: cesconix

.npmrc

@@ -1 +1,2 @@
 enable-pre-post-scripts=true
+package-manager-strict=false

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pinorama",
-  "version": "0.1.0-alpha.0",
+  "version": "0.1.0",
   "description": "simple, log search for pino",
   "license": "MIT",
   "author": {
@@ -30,7 +30,7 @@
     "lint-staged": "^15.2.2",
     "turbo": "^1.13.3"
   },
-  "packageManager": "pnpm@9.0.6",
+  "packageManager": "pnpm@9",
   "engines": {
     "node": ">=20"
   }

packages/pino-pinorama-transport/package.json

@@ -8,9 +8,12 @@
   "bin": {
     "pino-pinorama": "./dist/cli.mjs"
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "test": "vitest",
+    "test:cov": "vitest run --coverage",
     "test:debug": "vitest --inspect-brk --no-file-parallelism",
     "clean": "rimraf ./dist",
     "build": "pnpm clean && tsc",
@@ -24,14 +27,15 @@
   "license": "MIT",
   "devDependencies": {
     "@types/minimist": "^1.2.5",
-    "@types/node": "^20.12.7",
+    "@types/node": "^20.12.11",
+    "@vitest/coverage-v8": "^1.6.0",
     "pino": "^9.0.0",
     "pinorama-client": "workspace:*",
     "pinorama-server": "workspace:*",
-    "rimraf": "^5.0.5",
-    "tsx": "^4.7.3",
+    "rimraf": "^5.0.6",
+    "tsx": "^4.10.0",
     "typescript": "^5.4.5",
-    "vitest": "^1.5.2"
+    "vitest": "^1.6.0"
   },
   "publishConfig": {
     "access": "public"

packages/pino-pinorama-transport/src/lib.mts

@@ -41,7 +41,9 @@ export default function pinoramaTransport(
   }
 
   /* close */
-  const closeFn = async () => flushFn && (await flushFn())
+  const closeFn = async () => {
+    return flushFn && (await flushFn())
+  }
 
   /* parseLine */
   const parseLineFn = (line: string) => {
@@ -64,7 +66,7 @@ export default function pinoramaTransport(
 /**
  * Filters and returns options specified by keys.
  */
-function filterOptions<T extends object>(
+export function filterOptions<T extends object>(
   options: Partial<T>,
   keys: (keyof T)[]
 ): Partial<T> | undefined {

packages/pino-pinorama-transport/tests/cli.test.mts

@@ -0,0 +1,96 @@
+import { PinoramaClient } from "pinorama-client"
+import { afterEach, describe, expect, it, vi } from "vitest"
+import pinoramaTransport, { filterOptions } from "../src/lib.mts"
+
+vi.mock("pinorama-client", async (importOriginal) => {
+  const mod = await importOriginal<typeof import("pinorama-client")>()
+  return {
+    ...mod,
+    PinoramaClient: vi.fn(function () {
+      this.isFlushed = false
+      this.bulkInsert = vi.fn(() => {
+        return {
+          flush: () => {
+            this.isFlushed = true
+          }
+        }
+      })
+    })
+  }
+})
+
+const exampleOptions = {
+  url: "http://example.com",
+  maxRetries: 3,
+  backoff: 500,
+  backoffFactor: 2,
+  backoffMax: 10000,
+  adminSecret: "secret123",
+  batchSize: 50, // not a client option
+  flushInterval: 2000 // not a client option
+}
+
+describe("pinoramaTransport", () => {
+  const mockedClient = vi.mocked(PinoramaClient)
+
+  afterEach(() => {
+    vi.restoreAllMocks()
+  })
+
+  it("should initialize client with correct filtered options", async () => {
+    pinoramaTransport(exampleOptions)
+
+    expect(PinoramaClient).toHaveBeenCalledWith({
+      url: "http://example.com",
+      maxRetries: 3,
+      backoff: 500,
+      backoffFactor: 2,
+      backoffMax: 10000,
+      adminSecret: "secret123"
+    })
+  })
+
+  it("should properly call the bulkInsert client function", async () => {
+    const stream = pinoramaTransport(exampleOptions)
+
+    expect(mockedClient.mock.instances[0].bulkInsert).toHaveBeenCalledWith(
+      stream,
+      {
+        batchSize: exampleOptions.batchSize,
+        flushInterval: exampleOptions.flushInterval
+      }
+    )
+  })
+
+  it("should call the flush client function on destroy stream", async () => {
+    const stream = pinoramaTransport(exampleOptions)
+
+    stream.write('{"msg":"hello world"}\n')
+    stream.destroy()
+
+    expect(mockedClient.mock.instances[0].isFlushed).toBe(true)
+  })
+})
+
+describe("filterOptions", () => {
+  it("should return an object with only specified keys", async () => {
+    const filtered = filterOptions(exampleOptions, [
+      "url",
+      "maxRetries",
+      "backoff"
+    ])
+
+    expect(filtered).toEqual({
+      url: exampleOptions.url,
+      maxRetries: exampleOptions.maxRetries,
+      backoff: exampleOptions.backoff
+    })
+  })
+
+  it("should not modify the original options object", async () => {
+    const originalOptions = { ...exampleOptions }
+    filterOptions(exampleOptions, ["url"])
+
+    expect(exampleOptions).toEqual(originalOptions)
+  })
+})