@rubriclab/bunl 0.0.9 → 0.0.11

package/README.md

@@ -2,32 +2,64 @@
 
 ## A Bun WebSocket re-write of LocalTunnel
 
+### Usage
+
 To try it:
 
 ```bash
 bun x bunl -p 3000 -d dev.rubric.me -s my-name
 ```
 
+### Development
+
 To install dependencies:
 
 ```bash
 bun i
 ```
 
+To run the server:
+
+```bash
+bun server
+```
+
+(Optional) to run a dummy process on localhost:3000:
+
+```bash
+bun demo
+```
+
 To run the client:
 
 ```bash
-bun lt
+bun client -p 3000
 ```
 
-To run the server:
+With full args:
 
 ```bash
-bun server
+bun client --port 3000 --domain localhost:1234 --subdomain my-subdomain
 ```
 
-To run a dummy server on localhost:3000:
+### [WIP] Deployment
+
+To build the client code:
 
 ```bash
-bun demo
+bun run build
 ```
+
+To deploy the server, for example on [Fly](https://fly.io):
+
+```bash
+fly launch && fly deploy
+```
+
+Making sure to set `DOMAIN` to your domain:
+
+```bash
+fly secrets set DOMAIN=example.so
+```
+
+Open to PRs!

package/build/client.js

@@ -1,4 +1,5 @@
-#! /usr/bin/env node
+#! /usr/bin/env bun
+// client.ts
 import { parseArgs } from "util";
 async function main({ url, domain, subdomain }) {
   const serverUrl = `ws://${domain || "localhost:1234"}?new${
@@ -14,14 +15,11 @@ async function main({ url, domain, subdomain }) {
         headers: data.headers,
       })
         .then((res) => res.text())
-        .then((res) => {
-          socket.send(res);
-        });
+        .then((res) => socket.send(res));
     }
   });
   socket.addEventListener("open", (event) => {
-    console.log("socket ready:", !!event.target.readyState);
-    socket.ping();
+    if (!event.target.readyState) throw "Not ready";
   });
 }
 var { values } = parseArgs({
@@ -43,7 +41,7 @@ var { values } = parseArgs({
   },
   allowPositionals: true,
 });
-if (!values.port) throw "pass --port 3000";
+if (!values.port) throw "pass -p 3000";
 main({
   url: `localhost:${values.port}`,
   domain: values.domain,

package/client.ts

@@ -24,15 +24,12 @@ async function main({
         headers: data.headers,
       })
         .then((res) => res.text())
-        .then((res) => {
-          socket.send(res);
-        });
+        .then((res) => socket.send(res));
     }
   });
 
   socket.addEventListener("open", (event) => {
-    console.log("socket ready:", !!(event.target as any).readyState);
-    socket.ping();
+    if (!(event.target as any).readyState) throw "Not ready";
   });
 }
 
@@ -60,7 +57,7 @@ const { values } = parseArgs({
   allowPositionals: true,
 });
 
-if (!values.port) throw "pass --port 3000";
+if (!values.port) throw "pass -p 3000";
 
 main({
   url: `localhost:${values.port}`,

package/package.json

@@ -1,14 +1,14 @@
 {
   "bin": {
-    "bunl": "./build/client.js"
+    "bunl": "build/client.js"
   },
   "name": "@rubriclab/bunl",
   "description": "expose localhost to the world",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/RubricLab/bunl.git"
+    "url": "git+https://github.com/RubricLab/bunl.git"
   },
   "dependencies": {
     "human-id": "^4.1.1"
@@ -16,11 +16,12 @@
   "devDependencies": {
     "@types/bun": "latest"
   },
-  "main": "./build/client.js",
+  "main": "build/client.js",
   "scripts": {
-    "server": "bun --hot server.ts",
-    "lt": "bun --hot client.ts",
-    "demo": "bun --hot demo.ts"
+    "server": "bun server.ts",
+    "client": "bun --hot client.ts",
+    "demo": "bun --hot demo.ts",
+    "build": "BUILD=build/client.js && bun build client.ts --outdir build --target node && echo -e \"#! /usr/bin/env bun\n$(cat $BUILD)\" > $BUILD"
   },
   "type": "module",
   "peerDependencies": {

package/server.ts

@@ -4,7 +4,7 @@ import { uid } from "./utils";
 type Client = { id: string };
 
 const port = Bun.env.PORT || 1234;
-const protocol = "http";
+const scheme = Bun.env.SCHEME || "http";
 const domain = Bun.env.DOMAIN || `localhost:${port}`;
 
 const clients = new Map<string, ServerWebSocket<Client>>();
@@ -16,17 +16,17 @@ serve<Client>({
     const reqUrl = new URL(req.url);
 
     if (reqUrl.searchParams.has("new")) {
-      const id = reqUrl.searchParams.get("subdomain") || uid();
+      const requested = reqUrl.searchParams.get("subdomain");
+      const id = requested && !clients.has(requested) ? requested : uid();
       const upgraded = server.upgrade(req, { data: { id } });
       if (upgraded) return;
-      else return new Response("Upgrade failed :(", { status: 500 });
+      else return new Response("upgrade failed", { status: 500 });
     }
 
     const subdomain = reqUrl.hostname.split(".")[0];
 
     if (!clients.has(subdomain)) {
-      console.log(`\x1b[31m${subdomain} not found \x1b[0m`);
-      return new Response("client not found :(", { status: 404 });
+      return new Response("client not found", { status: 404 });
     }
 
     // The magic: forward the req to the client
@@ -42,7 +42,7 @@ serve<Client>({
     let res = clientData.get(subdomain);
 
     // Poll every second for the client to respond
-    // TODO: replace this with a way for the client to trigger this
+    // TODO: replace poll with a client-triggered callback
     while (!res) {
       await sleep(1000);
       retries--;
@@ -63,8 +63,7 @@ serve<Client>({
       clients.set(ws.data.id, ws);
       ws.send(
         JSON.stringify({
-          id: ws.data.id,
-          url: `${protocol}://${ws.data.id}.${domain}`,
+          url: `${scheme}://${ws.data.id}.${domain}`,
         })
       );
     },
@@ -73,7 +72,7 @@ serve<Client>({
       clientData.set(ws.data.id, message);
     },
     close(ws) {
-      console.log(`closing ${ws.data.id}`);
+      console.log("closing", ws.data.id);
       clients.delete(ws.data.id);
     },
   },