make codepod (cli) support /path/to/repo; publish codepod to npm (#565)

Author: lihebi

apps/api/.gitignore

@@ -1,3 +1,5 @@
 dist/
 conns/conn-*.json
-prisma/dev.db
+prisma/dev.db
+example-repo/
+public/

apps/api/.npmignore

@@ -1,20 +1,26 @@
 {
-  "name": "api",
-  "version": "1.0.0",
+  "name": "codepod",
+  "version": "0.0.4",
   "license": "MIT",
   "scripts": {
     "build": "tsc",
     "start": "node build/run.js",
     "dev": "ts-node-dev src/run.ts",
     "test": "jest --config jest.config.js"
   },
+  "bin": {
+    "codepod": "./build/bin.js"
+  },
   "dependencies": {
-    "@codepod/yjs": "workspace:^",
+    "@codepod/ui": "workspace:^",
+    "commander": "^11.0.0",
     "cors": "^2.8.5",
     "express": "^4.18.2",
     "jest": "^29.0.3",
+    "lib0": "^0.2.83",
     "lodash": "^4.17.21",
     "ws": "^8.2.3",
+    "y-protocols": "^1.0.5",
     "yjs": "^13.6.7"
   },
   "devDependencies": {

apps/api/package.json

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+import { program } from "commander";
+import { startServer } from "./server";
+
+// This is a binary executable to run the server.
+
+// First, parse the command line arguments.
+// CMD: codepod /path/to/repo
+
+program
+  .version("0.0.1")
+  .arguments("<repoPath>")
+  .action(function (repoPath) {
+    console.log("repoPath", repoPath);
+    // start the server
+    startServer({ port: 4001, blobDir: repoPath });
+  });
+
+program.parse(process.argv);

apps/api/src/bin.ts

@@ -1,3 +1,6 @@
 import { startServer } from "./server";
 
-startServer({ port: 4000 });
+const blobDir = `${process.cwd()}/example-repo`;
+console.log("blobDir", blobDir);
+
+startServer({ port: 4000, blobDir });

apps/api/src/run.ts

@@ -2,26 +2,32 @@ import express from "express";
 import http from "http";
 import { WebSocketServer } from "ws";
 
-import { createSetupWSConnection } from "@codepod/yjs";
+import { createSetupWSConnection } from "./yjs/yjs-setupWS";
 import { bindState, writeState } from "./yjs-blob";
 
 import cors from "cors";
 
-export async function startServer({ port }) {
+export async function startServer({ port, blobDir }) {
+  console.log("starting server ..");
   const app = express();
   app.use(express.json({ limit: "20mb" }));
   // support cors
   app.use(cors());
   // serve static files generated from UI
-  app.use(express.static("../../packages/ui/dist"));
+  const path = `${__dirname}/../public`;
+  console.log("html path: ", path);
+  app.use(express.static(path));
 
   const http_server = http.createServer(app);
 
   // Yjs websocket
   const wss = new WebSocketServer({ noServer: true });
 
   wss.on("connection", (...args) =>
-    createSetupWSConnection(bindState, writeState)(...args)
+    createSetupWSConnection(
+      (doc, repoId) => bindState(doc, repoId, blobDir),
+      writeState
+    )(...args)
   );
 
   http_server.on("upgrade", async (request, socket, head) => {

apps/api/src/server.ts

@@ -50,10 +50,7 @@ function getDebouncedCallback(key) {
   return debounceRegistry.get(key);
 }
 
-// FIXME hard-coded path.
-const blobDir = "/tmp/example-repo";
-
-async function handleSaveBlob({ repoId, yDocBlob }) {
+async function handleSaveBlob({ repoId, yDocBlob, blobDir }) {
   console.log("save blob", repoId, yDocBlob.length);
   // create the yjs-blob folder if not exists
   if (!fs.existsSync(blobDir)) {
@@ -67,7 +64,7 @@ async function handleSaveBlob({ repoId, yDocBlob }) {
  * This function is called when setting up the WS connection, after the loadFromCodePod step.
  * TODO need to make sure this is only called once per repo, regardless of how many users are connected later.
  */
-function setupObserversToDB(ydoc: Y.Doc, repoId: string) {
+function setupObserversToDB(ydoc: Y.Doc, repoId: string, blobDir: string) {
   console.log("setupObserversToDB for repo", repoId);
   //   just observe and save the entire doc
   function observer(_, transaction) {
@@ -82,7 +79,7 @@ function setupObserversToDB(ydoc: Y.Doc, repoId: string) {
       // FIXME it may be too expensive to update the entire doc.
       // FIXME history is discarded
       const update = Y.encodeStateAsUpdate(ydoc);
-      handleSaveBlob({ repoId, yDocBlob: Buffer.from(update) });
+      handleSaveBlob({ repoId, yDocBlob: Buffer.from(update), blobDir });
     });
   }
   const rootMap = ydoc.getMap("rootMap");
@@ -101,7 +98,7 @@ function setupObserversToDB(ydoc: Y.Doc, repoId: string) {
 /**
  * This function is called when setting up the WS connection, as a first step.
  */
-async function loadFromFS(ydoc: Y.Doc, repoId: string) {
+async function loadFromFS(ydoc: Y.Doc, repoId: string, blobDir: string) {
   // load from the database and write to the ydoc
   console.log("=== loadFromFS");
   // read the blob from file system
@@ -124,11 +121,11 @@ async function loadFromFS(ydoc: Y.Doc, repoId: string) {
   }
 }
 
-export async function bindState(doc: Y.Doc, repoId: string) {
+export async function bindState(doc: Y.Doc, repoId: string, blobDir: string) {
   // Load persisted document state from the database.
-  await loadFromFS(doc, repoId);
+  await loadFromFS(doc, repoId, blobDir);
   // Observe changes and write to the database.
-  setupObserversToDB(doc, repoId);
+  setupObserversToDB(doc, repoId, blobDir);
   // setupObserversToRuntime(doc, repoId);
   // reset runtime status
   // clear runtimeMap status/commands but keep the ID

apps/api/src/yjs-blob.ts

@@ -6,7 +6,7 @@ import * as syncProtocol from "y-protocols/sync";
 
 import { encoding, decoding, map } from "lib0";
 
-let writeState = () => {
+let writeState: () => any = () => {
   throw new Error("writeState not set");
 };
 let bindState = async (doc: Y.Doc, repoId: string) => {
@@ -275,7 +275,10 @@ const pingTimeout = 30000;
  * @param {any} req
  * @param {any} opts
  */
-export const createSetupWSConnection = (_bindState, _writeState) => {
+export const createSetupWSConnection = (
+  _bindState: (doc: Y.Doc, repoId: string) => any,
+  _writeState: () => any
+) => {
   // set the writeState and bindState functions
   writeState = _writeState;
   bindState = _bindState;

packages/yjs/src/yjs-setupWS.ts renamed to apps/api/src/yjs/yjs-setupWS.ts

@@ -1,5 +1,5 @@
 {
-  "name": "spawner",
+  "name": "@codepod/spawner",
   "version": "1.0.0",
   "license": "MIT",
   "scripts": {

apps/spawner/package.json

@@ -1,6 +1,5 @@
 {
-  "name": "ui",
-  "private": true,
+  "name": "@codepod/ui",
   "version": "0.0.0",
   "type": "module",
   "main": "src/index.tsx",