spooder 3.2.6 → 3.2.8

package/README.md

@@ -37,7 +37,7 @@ Both the runner and the API are configured in the same way by providing a `spood
 ```json
 {
 	"spooder": {
-		"autoRestart": 5000,
+		"auto_restart": 5000,
 		"run": "bun run index.ts",
 		"update": [
 			"git pull",
@@ -81,12 +81,12 @@ While `spooder` uses a `bun run` command by default, it is possible to use any c
 
 ## Auto Restart
 
-In the event that the server exits (regardless of exit code), `spooder` can automatically restart it after a short delay. To enable this feature specify the restart delay in milliseconds as `autoRestart` in the configuration.
+In the event that the server exits (regardless of exit code), `spooder` can automatically restart it after a short delay. To enable this feature specify the restart delay in milliseconds as `auto_restart` in the configuration.
 
 ```json
 {
 	"spooder": {
-		"autoRestart": 5000
+		"auto_restart": 5000
 	}
 }
 ```
@@ -192,12 +192,12 @@ It is recommended that you harden your server code against unexpected exceptions
 
 In the event that the server does encounter an unexpected exception which causes it to exit with a non-zero exit code, `spooder` will automatically raise an issue on GitHub using the canary feature, if configured.
 
-Since this issue has been caught externally, `spooder` has no context of the exception which was raised. Instead, the canary report will contain the output from `stderr`.
+Since this issue has been caught externally, `spooder` has no context of the exception which was raised. Instead, the canary report will contain the output from both `stdout` and `stderr`.
 
 ```json
 {
-	"exitCode": 1,
-	"stderr": [
+	"proc_exit_code": 1,
+	"console_output": [
 		"[2.48ms] \".env.local\"",
 		"Test output",
 		"Test output",
@@ -216,10 +216,26 @@ Since this issue has been caught externally, `spooder` has no context of the exc
 }
 ```
 
+The `proc_exit_code` property contains the exit code that the server exited with.
+
+The `console_output` will contain the last `64` lines of output from `stdout` and `stderr` combined. This can be configured by setting the `spooder.canary.crash_console_history` property.
+
+```json
+{
+	"spooder": {
+		"canary": {
+			"crash_console_history": 128
+		}
+	}
+}
+```
+
 This information is subject to sanitization, as described in the `Sanitization` section, however you should be aware that stack traces may contain sensitive information.
 
 Additionally, Bun includes a relevant code snippet from the source file where the exception was raised. This is intended to help you identify the source of the problem.
 
+Setting `spooder.canary.crash_console_history` to `0` will omit the `console_output` property from the report entirely, which may make it harder to diagnose the problem but will ensure that no sensitive information is leaked.
+
 ## Sanitization
 
 All reports sent via the canary feature are sanitized to prevent sensitive information from being leaked. This includes:
@@ -303,13 +319,17 @@ In addition to the information provided by the developer, `spooder` also include
 		"uv": "1.44.2",
 		"napi": "8",
 		"modules": "108"
+	},
+	"bun": {
+		"version": "0.6.4",
+		"rev": "f02561530fda1ee9396f51c8bc99b38716e38296"
 	}
 }
 ```
 
 # API
 
-`spooder` exposes a build-block style API for developing servers. The API is designed to be minimal to leave control in the hands of the developer and not add overhead for features you may not need.
+`spooder` exposes a building-block style API for developing servers. The API is designed to be minimal to leave control in the hands of the developer and not add overhead for features you may not need.
 
 ```ts
 import { ... } from 'spooder';

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "spooder",
 	"type": "module",
-	"version": "3.2.6",
+	"version": "3.2.8",
 	"exports": {
 		".": {
 			"bun": "./src/api.ts",

package/src/api.ts

@@ -14,12 +14,19 @@ export class ErrorWithMetadata extends Error {
 	async resolve_metadata(): Promise<object> {
 		const metadata = Object.assign({}, this.metadata);
 		for (const [key, value] of Object.entries(metadata)) {
+			let resolved_value = value;
+
 			if (value instanceof Promise)
-				metadata[key] = await value;
+				resolved_value = await value;
 			else if (typeof value === 'function')
-				metadata[key] = value();
+				resolved_value = value();
 			else if (value instanceof ReadableStream)
-				metadata[key] = await new Response(value).text();
+				resolved_value = await Bun.readableStreamToText(value);
+
+			if (typeof resolved_value === 'string' && resolved_value.includes('\n'))
+				resolved_value = resolved_value.split(/\r?\n/);
+
+			metadata[key] = resolved_value;
 		}
 
 		return metadata;

package/src/cli.ts

@@ -36,35 +36,56 @@ async function start_server() {
 		}
 	}
 
+	const crash_console_history = config.canary.crash_console_history;
+	const include_crash_history = crash_console_history > 0;
+
+	const std_mode = include_crash_history ? 'pipe' : 'inherit';
 	const proc = Bun.spawn(parse_command_line(config.run), {
 		cwd: process.cwd(),
-		stdout: 'inherit',
-		stderr: 'pipe'
+		stdout: std_mode,
+		stderr: std_mode
 	});
 
-	await proc.exited;
+	const stream_history = new Array<string>();
+	if (include_crash_history) {
+		const text_decoder = new TextDecoder();
 
-	const proc_exit_code = proc.exitCode;
-	log('server exited with code %s', proc_exit_code);
+		function capture_stream(stream: ReadableStream, output: NodeJS.WritableStream) {
+			const reader = stream.getReader();
 
-	if (proc_exit_code !== 0) {
-		if (proc.stderr !== undefined) {
-			const res = new Response(proc.stderr as ReadableStream);
-
-			res.text().then(async stderr => {
-				await dispatch_report('crash: server exited unexpectedly', [{
-					proc_exit_code,
-					stderr: strip_color_codes(stderr).split(/\r?\n/)
-				}]);
+			reader.read().then(function read_chunk(chunk: ReadableStreamDefaultReadResult<Uint8Array>) {
+				if (chunk.done)
+					return;
+
+				const chunk_str = text_decoder.decode(chunk.value);
+				stream_history.push(...chunk_str.split(/\r?\n/));
+
+				if (stream_history.length > crash_console_history)
+					stream_history.splice(0, stream_history.length - crash_console_history);
+
+				output.write(chunk.value);
+				reader.read().then(read_chunk);
 			});
-		} else {
-			dispatch_report('crash: service exited unexpectedly', [{
-				proc_exit_code
-			}]);
 		}
+
+		capture_stream(proc.stdout as ReadableStream, process.stdout);
+		capture_stream(proc.stderr as ReadableStream, process.stderr);
+	}
+	
+	await proc.exited;
+	
+	const proc_exit_code = proc.exitCode;
+	log('server exited with code %s', proc_exit_code);
+	
+	if (proc_exit_code !== 0) {
+		const console_output = include_crash_history ? strip_color_codes(stream_history.join('\n')) : undefined;
+		dispatch_report('crash: server exited unexpectedly', [{
+			proc_exit_code, console_output
+		}]);
 	}
+	  
 
-	const auto_restart_ms = config.autoRestart;
+	const auto_restart_ms = config.auto_restart;
 	if (auto_restart_ms > -1) {
 		log('restarting server in %dms', auto_restart_ms);
 		setTimeout(start_server, auto_restart_ms);

package/src/config.d.ts

@@ -1,11 +1,12 @@
 declare const internal_config: {
     run: string;
-    autoRestart: number;
+    auto_restart: number;
     update: never[];
     canary: {
         account: string;
         repository: string;
         labels: never[];
+        crash_console_history: number;
         throttle: number;
         sanitize: boolean;
     };

package/src/config.ts

@@ -1,14 +1,15 @@
 import path from 'node:path';
-import { warn } from './utils';
+import { log } from './utils';
 
 const internal_config = {
 	run: 'bun run index.ts',
-	autoRestart: -1,
+	auto_restart: -1,
 	update: [],
 	canary: {
 		account: '',
 		repository: '',
 		labels: [],
+		crash_console_history: 64,
 		throttle: 86400,
 		sanitize: true
 	}
@@ -27,7 +28,7 @@ function validate_config_option(source: ConfigObject, target: ConfigObject, root
 			const actual_type = typeof value;
 
 			if (actual_type !== expected_type) {
-				warn('ignoring invalid configuration value `%s` (expected %s, got %s)', key_name, expected_type, actual_type);
+				log('ignoring invalid configuration value `%s` (expected %s, got %s)', key_name, expected_type, actual_type);
 				continue;
 			}
 
@@ -37,14 +38,14 @@ function validate_config_option(source: ConfigObject, target: ConfigObject, root
 
 				if (is_default_array) {
 					if (!is_actual_array) {
-						warn('ignoring invalid configuration value `%s` (expected array)', key_name);
+						log('ignoring invalid configuration value `%s` (expected array)', key_name);
 						continue;
 					}
 
 					source[key as keyof Config] = value as Config[keyof Config];
 				} else {
 					if (is_actual_array) {
-						warn('ignoring invalid configuration value `%s` (expected object)', key_name);
+						log('ignoring invalid configuration value `%s` (expected object)', key_name);
 						continue;
 					}
 
@@ -54,7 +55,7 @@ function validate_config_option(source: ConfigObject, target: ConfigObject, root
 				source[key as keyof Config] = value as Config[keyof Config];
 			}
 		} else {
-			warn('ignoring unknown configuration key `%s`', key_name);	
+			log('ignoring unknown configuration key `%s`', key_name);	
 		}
 	}
 }
@@ -65,13 +66,13 @@ export async function get_config(): Promise<Config> {
 		const json = await config_file.json();
 
 		if (json.spooder === null || typeof json.spooder !== 'object') {
-			warn('failed to parse spooder configuration in package.json, using defaults');
+			log('failed to parse spooder configuration in package.json, using defaults');
 			return internal_config;
 		}
 
 		validate_config_option(internal_config, json.spooder, 'spooder');
 	} catch (e) {
-		warn('failed to read package.json, using configuration defaults');
+		log('failed to read package.json, using configuration defaults');
 	}
 
 	return internal_config;

package/src/dispatch.ts

@@ -1,6 +1,6 @@
 import { App } from '@octokit/app';
 import { get_config } from './config';
-import { warn, log } from './utils';
+import { log } from './utils';
 import fs from 'node:fs';
 import path from 'node:path';
 import os from 'node:os';
@@ -93,9 +93,9 @@ async function check_cache_table(key: string, repository: string, expiry: number
 			}
 		}
 	} catch (e) {
-		warn('Failed to read canary cache file ' + cache_file_path);
-		warn('Error: ' + (e as Error).message);
-		warn('You should resolve this issue to prevent spamming GitHub with canary reports.');
+		log('Failed to read canary cache file ' + cache_file_path);
+		log('Error: ' + (e as Error).message);
+		log('You should resolve this issue to prevent spamming GitHub with canary reports.');
 	}
 
 	if (cache_table.has(key_hash)) {
@@ -142,6 +142,10 @@ function generate_diagnostics(): object {
 		'platform': os.platform(),
 		'uptime': os.uptime(),
 		'versions': process.versions,
+		'bun': {
+			'version': Bun.version,
+			'rev': Bun.revision,
+		}
 	}
 }
 
@@ -158,7 +162,7 @@ export async function dispatch_report(report_title: string, report_body: Array<u
 
 		const is_cached = await check_cache_table(report_title, canary_repostiory, config.canary.throttle);
 		if (is_cached) {
-			warn('Throttled canary report: ' + report_title);
+			log('Throttled canary report: ' + report_title);
 			return;
 		}
 
@@ -218,6 +222,6 @@ export async function dispatch_report(report_title: string, report_body: Array<u
 			}
 		}
 	} catch (e) {
-		warn('Failed to dispatch canary report: ' + (e as Error)?.message ?? 'unspecified error');
+		log('Failed to dispatch canary report: ' + (e as Error)?.message ?? 'unspecified error');
 	}
 }

package/src/utils.d.ts

@@ -1,7 +1,5 @@
 /** Logs a message to stdout with the prefix `[spooder] ` */
 export declare function log(message: string, ...args: unknown[]): void;
-/** Logs a message to stderr with the prefix `[spooder] ` */
-export declare function warn(message: string, ...args: unknown[]): void;
 /** Strips ANSI color codes from a string */
 export declare function strip_color_codes(str: string): string;
 /** Converts a command line string into an array of arguments */

package/src/utils.ts

@@ -3,11 +3,6 @@ export function log(message: string, ...args: unknown[]): void {
 	console.log('[spooder] ' + message, ...args);
 }
 
-/** Logs a message to stderr with the prefix `[spooder] ` */
-export function warn(message: string, ...args: unknown[]): void {
-	console.error('[spooder] ' + message, ...args);
-}
-
 /** Strips ANSI color codes from a string */
 export function strip_color_codes(str: string): string {
 	return str.replace(/\x1b\[[0-9;]*m/g, '');