spooder 3.2.7 → 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.7",
+	"version": "3.2.8",
 	"exports": {
 		".": {
 			"bun": "./src/api.ts",

package/src/api.ts

@@ -21,7 +21,7 @@ export class ErrorWithMetadata extends Error {
 			else if (typeof value === 'function')
 				resolved_value = value();
 			else if (value instanceof ReadableStream)
-				resolved_value = 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/);

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

@@ -3,12 +3,13 @@ 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
 	}

package/src/dispatch.ts

@@ -142,6 +142,10 @@ function generate_diagnostics(): object {
 		'platform': os.platform(),
 		'uptime': os.uptime(),
 		'versions': process.versions,
+		'bun': {
+			'version': Bun.version,
+			'rev': Bun.revision,
+		}
 	}
 }