spooder 2.0.8 → 3.0.0

package/README.md

@@ -8,33 +8,63 @@
 
 > **Warning** - This project is developed for [Bun](https://bun.sh/), which at the time of writing is still experimental. It is not recommended to use this project in production environments unless you understand the risks.
 
-## Structure
+## Installation
 
-`spooder` consists of two primary parts: the `instance` and the `watcher`.
+```bash
+bun add spooder --global
+```
+
+## Runner
 
-The `instance` is an API that can be imported into a Bun process to scaffold a web server instance. It is intended as a common set of tools for building individiual domain instances.
+`spooder` also includes a global command-line tool for running the server. It is recommended that you run this in a `screen` session.
 
-The `watcher` is a daemon responsible for updating, starting and monitoring a collection of `instance` processes. It is intended to be run as a service on the host machine.
+```bash
+screen -S spooder # Create a new screen session
+cd /var/www/my_server/
+spooder
+```
 
-## Watcher
+`spooder` will load the `module` defined in your `package.json` in a new process using `bun run <module>`. This can be overridden using the `entry` property of the `spooder section` in your `package.json`.
 
-```toml
-# /var/www/spooder.toml
-[[domains]]
-name = "testdomain.net"
-path = "/var/www/testdomain.net"
-port = 3000
+```json
+{
+	"spooder": {
+		"entry": "index.ts"
+	}
+}
 ```
 
-```bash
-# Installation
-bun add spooder -g
+In the event that the server exits (regardless of exit code), `spooder` will automatically restart it after a short delay. This delay is configurable in the `spooder` section of your `package.json`.
+
+```json
+{
+	"spooder": {
+		"autoRestart": true, // Defaults to true.
+		"restartDelay": 5000, // Defaults to 5000ms.
+	}
+}
 ```
 
-```bash
-# Running the watcher
-screen -S spooder # Create a new screen session
-spooder
+When starting your server, `spooder` can automatically update the source code by running `git pull` in the working directory. This feature is disabled by default and can be enabled in the `spooder` section of your `package.json`.
+
+```json
+{
+	"spooder": {
+		"autoUpdate": true // Defaults to false.
+	}
+}
+```
+
+When `autoUpdate` is enabled, your server process can initiate a self-update by terminating with the exit code `205`. This will cause `spooder` to run `git pull` and restart the server, which can be useful for responding to webhooks.
+
+If `autoUpdate` is disabled, all exit codes will be considered a crash and the server will be restarted if `autoRestart` is enabled.
+
+## API
+
+`spooder` exposes a simple API which can be imported into your project for bootstrapping a server in Bun. 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 serve from 'spooder'; // WIP
 ```
 
 ## License

package/package.json

@@ -1,17 +1,13 @@
 {
 	"name": "spooder",
 	"type": "module",
-	"version": "2.0.8",
-	"bin": {
-		"spooder": "./src/instance.ts",
-		"spooder-update": "./src/update.ts",
-		"spooder-heartbeat": "./src/heartbeat.ts"
-	},
+	"module": "./src/api.ts",
+	"version": "3.0.0",
 	"devDependencies": {
 		"@types/node": "^20.0.0",
 		"bun-types": "^0.5.0"
 	},
-	"dependencies": {
-		"zod": "^3.21.4"
+	"bin": {
+		"spooder": "./src/cli.ts"
 	}
 }

package/src/api.d.ts

@@ -0,0 +1 @@
+export declare function test_api(): void;

package/src/api.ts

@@ -0,0 +1,3 @@
+export function test_api() {
+	console.log('test_api :: hello world!');
+}

package/src/cli.ts

@@ -0,0 +1 @@
+console.log('Welcome to the Spooder CLI!');

package/src/heartbeat.d.ts

@@ -1 +0,0 @@
-#!/usr/bin/env bun

package/src/heartbeat.ts

@@ -1,6 +0,0 @@
-#!/usr/bin/env bun
-
-// TODO: Iterate over all directories in /var/www and identify which ones are spooder domains.
-// TODO: For each spooder domain, check if the process is running.
-// TODO: Run `spooder` inside any domain directory that is not running.
-// TODO: Report crashed domains somewhere/somehow?

package/src/instance.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env bun
-export {};

package/src/instance.ts

@@ -1,23 +0,0 @@
-#!/usr/bin/env bun
-
-import { join } from 'node:path';
-
-async function write_pid_file() {
-	const pid_file = join(process.cwd(), '.spooder_pid');
-	await Bun.write(pid_file, process.pid.toString());
-}
-
-async function main() {
-	await write_pid_file();
-
-	const index_file = join(process.cwd(), 'index.ts');
-	// TODO: Add error handling if index_file does not exist?
-
-	const module = await import(index_file);
-	console.log(module);
-	// TODO: Add a route for GitHub webhooks.
-	// TODO: Add authentication for the webhook to prevent abuse.
-	// TODO: Run `spooder-update` when the webhook is triggered, then self-terminate.
-}
-
-main();

package/src/update.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env bun
-export {};

package/src/update.ts

@@ -1,93 +0,0 @@
-#!/usr/bin/env bun
-
-import { join } from 'node:path';
-import { z } from 'zod';
-
-const ConfigSchema = z.object({
-	domain: z.object({
-		name: z.string(),
-		port: z.number()
-	}),
-
-	git: z.object({
-		url: z.string(),
-		branch: z.string().default('main')
-	}).optional()
-});
-
-async function get_last_pid() : Promise<number> {
-	const pid_file = Bun.file(join(process.cwd(), '.spooder_pid'));
-	if (pid_file.size > 0) {
-		const pid = parseInt(await pid_file.text());
-		if (!isNaN(pid))
-			return pid;
-	}
-
-	return -1;
-}
-
-async function pid_is_running(pid: number) : Promise<boolean> {
-	const process = Bun.spawnSync(['ps', '-p', pid.toString()]);
-	if (!process.success)
-		return false;
-
-	const stdout = process.stdout?.toString();
-
-	// Ensure stdout contains more than one line.
-	if (!stdout || stdout.split('\n').length <= 1)
-		return false;
-
-	return false;
-}
-
-async function wait_for_pid_to_exit(pid: number) : Promise<void> {
-	console.log(`Waiting for process ${pid} to exit...`);
-	while (await pid_is_running(pid))
-		await Bun.sleep(1000);
-}
-
-function is_git_repository(directory: string): boolean {
-	// The command `git rev-parse --is-inside-work-tree` returns `true` to stdout
-	// if the current working directory is inside a git repository.
-	const process = Bun.spawnSync(['git', 'rev-parse', '--is-inside-work-tree'], { cwd: directory });
-	return process.stdout?.toString().trim() === 'true';
-}
-
-function pull_git_repository(directory: string, url: string, branch: string) {
-	console.log(`Pulling git repository ${branch} @ ${url} into ${directory}...`);
-	const process = Bun.spawnSync(['git', 'pull', url, branch], { cwd: directory });
-	if (!process.success)
-		throw new Error('Failed to pull git repository.');
-}
-
-function init_git_repository(directory: string) {
-	console.log(`Initializing git repository in ${directory}...`);
-	const process = Bun.spawnSync(['git', 'init'], { cwd: directory });
-	if (!process.success)
-		throw new Error('Failed to initialize git repository.');
-}
-
-async function load_configuration() {
-	const config_file = join(process.cwd(), 'spooder.toml');
-	return ConfigSchema.parse(await import(config_file));
-}
-
-async function main() {
-	const config = await load_configuration();
-
-	// Wait for the previous process, if it exists, to exit.
-	await wait_for_pid_to_exit(await get_last_pid());
-
-	const cwd = process.cwd();
-	if (config.git) {
-		if (!is_git_repository(cwd))
-			init_git_repository(cwd);
-		
-		pull_git_repository(cwd, config.git.url, config.git.branch);
-	}
-	
-	const server = Bun.spawn(['spooder'], { cwd });
-	server.unref();
-}
-
-main();