flightdeck 0.2.3 → 0.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flightdeck",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "license": "MIT",
   "author": {
     "name": "Jeremy Banka",
@@ -12,6 +12,7 @@
   "type": "module",
   "files": [
     "dist",
+    "gen",
     "src"
   ],
   "main": "dist/lib.js",
@@ -22,26 +23,29 @@
   },
   "dependencies": {
     "@t3-oss/env-core": "0.11.1",
-    "cron": "3.2.1",
-    "zod": "3.23.8",
-    "atom.io": "0.30.4",
+    "cron": "3.3.1",
+    "zod": "3.24.1",
+    "atom.io": "0.30.6",
     "comline": "0.1.6"
   },
   "devDependencies": {
-    "@types/node": "22.9.1",
+    "@biomejs/js-api": "0.7.1",
+    "@biomejs/wasm-nodejs": "1.9.4",
+    "@types/node": "22.10.2",
     "@types/tmp": "0.2.6",
-    "bun-types": "1.1.35",
-    "concurrently": "9.1.0",
+    "bun-types": "1.1.42",
+    "concurrently": "9.1.1",
+    "json-schema-to-zod": "2.6.0",
     "rimraf": "6.0.1",
     "tmp": "0.2.3",
     "tsup": "8.3.5",
-    "vitest": "2.1.5"
+    "vitest": "3.0.0-beta.3",
+    "varmint": "0.3.4"
   },
   "scripts": {
+    "gen": "bun ./__scripts__/gen.bun.ts",
     "build": "rimraf dist && concurrently \"bun:build:*\" && concurrently \"bun:schema:*\"",
-    "build:bin:flightdeck": "bun build --outdir dist --target node --external flightdeck --external atom.io --external comline --external zod -- src/flightdeck.bin.ts",
-    "build:bin:klaxon": "bun build --outdir dist --target node --external flightdeck --external atom.io --external comline --external zod -- src/klaxon.bin.ts",
-    "build:lib": "bun build --outdir dist --target node --external flightdeck --external atom.io --external comline --external zod -- src/lib.ts ",
+    "build:js": "bun ./__scripts__/build.bun.ts",
     "build:dts": "tsup",
     "schema:flightdeck": "bun ./src/flightdeck.bin.ts --outdir=dist -- schema",
     "lint:biome": "biome check -- .",

package/src/flightdeck.bin.ts

@@ -3,11 +3,21 @@
 import * as path from "node:path"
 
 import type { OptionsGroup } from "comline"
-import { cli, optional, parseNumberOption } from "comline"
+import { cli, optional, parseBooleanOption, parseNumberOption } from "comline"
 import { z } from "zod"
 
 import type { FlightDeckOptions } from "./flightdeck.lib"
-import { FlightDeck } from "./flightdeck.lib"
+import { FlightDeck, FlightDeckLogger } from "./flightdeck.lib"
+
+const CLI_LOGGER = new FlightDeckLogger(`comline`, process.pid, undefined, {
+	jsonLogging: true,
+})
+Object.assign(console, {
+	log: CLI_LOGGER.info.bind(CLI_LOGGER),
+	info: CLI_LOGGER.info.bind(CLI_LOGGER),
+	warn: CLI_LOGGER.warn.bind(CLI_LOGGER),
+	error: CLI_LOGGER.error.bind(CLI_LOGGER),
+})
 
 const FLIGHTDECK_MANUAL = {
 	optionsSchema: z.object({
@@ -20,6 +30,7 @@ const FLIGHTDECK_MANUAL = {
 			install: z.string(),
 			checkAvailability: z.string(),
 		}),
+		jsonLogging: z.boolean().optional(),
 	}),
 	options: {
 		port: {
@@ -55,6 +66,13 @@ const FLIGHTDECK_MANUAL = {
 			example: `--scripts="{\\"download\\":\\"npm i",\\"install\\":\\"npm run build\\"}"`,
 			parse: JSON.parse,
 		},
+		jsonLogging: {
+			flag: `j`,
+			required: false,
+			description: `Enable json logging.`,
+			example: `--jsonLogging`,
+			parse: parseBooleanOption,
+		},
 	},
 } satisfies OptionsGroup<FlightDeckOptions>
 

package/src/flightdeck.lib.ts

@@ -3,13 +3,16 @@ import type { Server } from "node:http"
 import { createServer } from "node:http"
 import { homedir } from "node:os"
 import { resolve } from "node:path"
+import { inspect } from "node:util"
 
 import { Future } from "atom.io/internal"
 import { discoverType } from "atom.io/introspection"
 import { fromEntries, toEntries } from "atom.io/json"
 import { ChildSocket } from "atom.io/realtime-server"
 import { CronJob } from "cron"
+import { z } from "zod"
 
+import type { LnavFormat } from "../gen/lnav-format-schema.gen"
 import { FilesystemStorage } from "./filesystem-storage"
 import { env } from "./flightdeck.env"
 
@@ -37,6 +40,7 @@ export type FlightDeckOptions<S extends string = string> = {
 	}
 	port?: number | undefined
 	flightdeckRootDir?: string | undefined
+	jsonLogging?: boolean | undefined
 }
 
 export class FlightDeck<S extends string = string> {
@@ -61,7 +65,7 @@ export class FlightDeck<S extends string = string> {
 
 	protected logger: Pick<Console, `error` | `info` | `warn`>
 	protected serviceLoggers: {
-		readonly [service in S]: Pick<Console, `error` | `info` | `warn`>
+		readonly [service in S]: FlightDeckLogger
 	}
 
 	protected updateAvailabilityChecker: CronJob | null = null
@@ -95,34 +99,21 @@ export class FlightDeck<S extends string = string> {
 		this.servicesReadyToUpdate = { ...this.defaultServicesReadyToUpdate }
 		this.autoRespawnDeadServices = true
 
-		this.logger = {
-			info: (...args: any[]) => {
-				console.log(`${this.options.packageName}:`, ...args)
-			},
-			warn: (...args: any[]) => {
-				console.warn(`${this.options.packageName}:`, ...args)
-			},
-			error: (...args: any[]) => {
-				console.error(`${this.options.packageName}:`, ...args)
-			},
-		}
+		this.logger = new FlightDeckLogger(
+			this.options.packageName,
+			process.pid,
+			undefined,
+			{ jsonLogging: this.options.jsonLogging ?? false },
+		)
 		this.serviceLoggers = fromEntries(
 			servicesEntries.map(([serviceName]) => [
 				serviceName,
-				{
-					info: (...args: any[]) => {
-						console.log(`${this.options.packageName}::${serviceName}:`, ...args)
-					},
-					warn: (...args: any[]) => {
-						console.warn(`${this.options.packageName}::${serviceName}:`, ...args)
-					},
-					error: (...args: any[]) => {
-						console.error(
-							`${this.options.packageName}::${serviceName}:`,
-							...args,
-						)
-					},
-				},
+				new FlightDeckLogger(
+					this.options.packageName,
+					process.pid,
+					serviceName,
+					{ jsonLogging: this.options.jsonLogging ?? false },
+				),
 			]),
 		)
 
@@ -316,13 +307,15 @@ export class FlightDeck<S extends string = string> {
 			cwd: this.options.flightdeckRootDir,
 			env: import.meta.env,
 		})
-		this.services[serviceName] = new ChildSocket(
+		const serviceLogger = this.serviceLoggers[serviceName]
+		const service = (this.services[serviceName] = new ChildSocket(
 			serviceProcess,
 			`${this.options.packageName}::${serviceName}`,
-			console,
-		)
+			serviceLogger,
+		))
+		serviceLogger.processCode = service.process.pid ?? -1
 		this.services[serviceName].onAny((...messages) => {
-			this.serviceLoggers[serviceName].info(`💬`, ...messages)
+			serviceLogger.info(`💬`, ...messages)
 		})
 		this.services[serviceName].on(`readyToUpdate`, () => {
 			this.logger.info(`Service "${serviceName}" is ready to update.`)
@@ -444,3 +437,213 @@ export class FlightDeck<S extends string = string> {
 		}
 	}
 }
+
+export const flightDeckLogSchema = z.object({
+	level: z.union([z.literal(`info`), z.literal(`warn`), z.literal(`ERR!`)]),
+	timestamp: z.number(),
+	package: z.string(),
+	service: z.string().optional(),
+	process: z.number(),
+	body: z.string(),
+})
+export type FlightDeckLog = z.infer<typeof flightDeckLogSchema>
+
+const LINE_FORMAT = `line-format` satisfies keyof LnavFormat
+const VALUE = `value` satisfies keyof LnavFormat
+
+export type LnavFormatVisualComponent = Exclude<
+	Exclude<LnavFormat[`line-format`], undefined>[number],
+	string
+>
+
+export type LnavFormatBreakdown = Exclude<LnavFormat[`value`], undefined>
+export type MemberOf<T> = T[keyof T]
+export type LnavFormatValueDefinition = MemberOf<LnavFormatBreakdown>
+
+export type FlightDeckFormat = {
+	[LINE_FORMAT]: (
+		| string
+		| (LnavFormatVisualComponent & {
+				field: keyof FlightDeckLog | `__level__` | `__timestamp__`
+		  })
+	)[]
+	[VALUE]: {
+		[K in keyof FlightDeckLog]: LnavFormatValueDefinition & {
+			kind: FlightDeckLog[K] extends number | undefined
+				? `integer`
+				: FlightDeckLog[K] extends string | undefined
+					? `string`
+					: never
+		}
+	}
+}
+
+export const FLIGHTDECK_LNAV_FORMAT = {
+	title: `FlightDeck Log`,
+	description: `Format for events logged by the FlightDeck process manager.`,
+	"file-type": `json`,
+	"timestamp-field": `timestamp`,
+	"subsecond-field": `subsecond`,
+	"subsecond-units": `milli`,
+	"opid-field": `service`,
+	"level-field": `level`,
+	level: {
+		info: `info`,
+		warning: `warn`,
+		error: `err!`,
+	},
+	"ordered-by-time": true,
+
+	[LINE_FORMAT]: [
+		{
+			field: `__level__`,
+		},
+		{
+			prefix: ` `,
+			field: `__timestamp__`,
+			"timestamp-format": `%Y-%m-%dT%H:%M:%S.%L%Z`,
+		},
+		{
+			prefix: ` `,
+			field: `package`,
+		},
+		{
+			prefix: `::`,
+			field: `service`,
+			"default-value": ``,
+		},
+		{
+			prefix: `[`,
+			field: `process`,
+			suffix: `]`,
+			"min-width": 5,
+		},
+		{
+			prefix: `: `,
+			field: `body`,
+		},
+	],
+
+	[VALUE]: {
+		timestamp: {
+			kind: `integer`,
+		},
+		level: {
+			kind: `string`,
+		},
+		package: {
+			kind: `string`,
+		},
+		service: {
+			kind: `string`,
+		},
+		process: {
+			kind: `integer`,
+		},
+		body: {
+			kind: `string`,
+		},
+	},
+} as const satisfies FlightDeckFormat & LnavFormat
+
+export class FlightDeckLogger
+	implements Pick<Console, `error` | `info` | `warn`>
+{
+	public readonly packageName: string
+	public readonly serviceName?: string
+	public readonly jsonLogging: boolean
+	public processCode: number
+	public constructor(
+		packageName: string,
+		processCode: number,
+		serviceName?: string,
+		options?: { jsonLogging: boolean },
+	) {
+		this.packageName = packageName
+		if (serviceName) {
+			this.serviceName = serviceName
+		}
+		this.processCode = processCode
+		this.jsonLogging = options?.jsonLogging ?? false
+	}
+	public info(...messages: unknown[]): void {
+		if (this.jsonLogging) {
+			const log: FlightDeckLog = {
+				timestamp: Date.now(),
+				level: `info`,
+				process: this.processCode,
+				package: this.packageName,
+				body: messages
+					.map((message) =>
+						typeof message === `string`
+							? message
+							: inspect(message, false, null, true),
+					)
+					.join(` `),
+			}
+			if (this.serviceName) {
+				log.service = this.serviceName
+			}
+			process.stdout.write(JSON.stringify(log) + `\n`)
+		} else {
+			const source = this.serviceName
+				? `${this.packageName}::${this.serviceName}`
+				: this.packageName
+			console.log(`${source}:`, ...messages)
+		}
+	}
+
+	public warn(...messages: unknown[]): void {
+		if (this.jsonLogging) {
+			const log: FlightDeckLog = {
+				timestamp: Date.now(),
+				level: `warn`,
+				process: this.processCode,
+				package: this.packageName,
+				body: messages
+					.map((message) =>
+						typeof message === `string`
+							? message
+							: inspect(message, false, null, true),
+					)
+					.join(` `),
+			}
+			if (this.serviceName) {
+				log.service = this.serviceName
+			}
+			process.stdout.write(JSON.stringify(log) + `\n`)
+		} else {
+			const source = this.serviceName
+				? `${this.packageName}::${this.serviceName}`
+				: this.packageName
+			console.warn(`${source}:`, ...messages)
+		}
+	}
+
+	public error(...messages: unknown[]): void {
+		if (this.jsonLogging) {
+			const log: FlightDeckLog = {
+				timestamp: Date.now() + Math.floor(Math.random() * 1000),
+				level: `ERR!`,
+				process: this.processCode,
+				package: this.packageName,
+				body: messages
+					.map((message) =>
+						typeof message === `string`
+							? message
+							: inspect(message, false, null, true),
+					)
+					.join(` `),
+			}
+			if (this.serviceName) {
+				log.service = this.serviceName
+			}
+			process.stdout.write(JSON.stringify(log) + `\n`)
+		} else {
+			const source = this.serviceName
+				? `${this.packageName}::${this.serviceName}`
+				: this.packageName
+			console.error(`${source}:`, ...messages)
+		}
+	}
+}