conat: put all core testing together in backend/conat/test again

Author: williamstein

src/packages/server/conat/test/core/basic.test.ts renamed to src/packages/backend/conat/test/core/basic.test.ts

@@ -2,8 +2,8 @@
 Very basic test of conats core client and server.
 */
 
-import { connect, before, after } from "./setup";
-import { wait } from "@cocalc/server/conat/test/util";
+import { connect, before, after } from "@cocalc/backend/conat/test/setup";
+import { wait } from "@cocalc/backend/conat/test/util";
 
 beforeAll(before);
 

src/packages/server/conat/test/core/connect.test.ts renamed to src/packages/backend/conat/test/core/connect.test.ts

@@ -1,8 +1,8 @@
-import { getPort } from "@cocalc/server/conat/test/util";
-import { initConatServer } from "@cocalc/server/conat/socketio";
+import { getPort } from "@cocalc/backend/conat/test/util";
+import { initConatServer } from "@cocalc/backend/conat/test/setup";
 import { connect } from "@cocalc/backend/conat/conat";
 import { delay } from "awaiting";
-import { wait } from "@cocalc/server/conat/test/util";
+import { wait } from "@cocalc/backend/conat/test/util";
 
 const path = "/conat";
 let port;

src/packages/server/conat/test/core/core-stream-ephemeral.test.ts renamed to src/packages/backend/conat/test/core/core-stream-ephemeral.test.ts

@@ -1,10 +1,10 @@
-import { connect, before, after } from "./setup";
+import { connect, before, after } from "@cocalc/backend/conat/test/setup";
 import {
   cstream,
   COCALC_STREAM_HEADER,
   type CoreStream,
 } from "@cocalc/conat/sync/core-stream";
-import { wait } from "@cocalc/server/conat/test/util";
+import { wait } from "@cocalc/backend/conat/test/util";
 import type { Client } from "@cocalc/conat/core/client";
 import { is_date as isDate } from "@cocalc/util/misc";
 import { dstream } from "@cocalc/conat/sync/dstream";
@@ -299,8 +299,6 @@ describe("test using ephemeral dstream", () => {
     wait({ until: () => stream.length == 101 });
     expect(stream.get(stream.length - 1)).toBe("x");
   });
-  
-  
 });
 
 afterAll(after);

src/packages/backend/conat/test/setup.ts

@@ -0,0 +1,52 @@
+import { getPort } from "@cocalc/backend/conat/test/util";
+import { type Client } from "@cocalc/backend/conat/conat";
+import {
+  init as createConatServer,
+  type Options,
+  type ConatServer,
+} from "@cocalc/conat/core/server";
+import { Server } from "socket.io";
+import getLogger from "@cocalc/backend/logger";
+
+const logger = getLogger("conat:test:setup");
+
+export const path = "/conat";
+
+export async function initConatServer(
+  options: Partial<Options> = {},
+): Promise<ConatServer> {
+  logger.debug("init");
+  if (!options?.port) {
+    const port = await getPort();
+    options = { ...options, port };
+  }
+
+  return createConatServer({
+    logger: logger.debug,
+    Server,
+    ...options,
+  });
+}
+
+export let server;
+export let port;
+export let address;
+export async function before() {
+  port = await getPort();
+  address = `http://localhost:${port}`;
+  server = await initConatServer({ port, path });
+}
+
+const clients: Client[] = [];
+export function connect() {
+  const cn = server.client();
+  clients.push(cn);
+  return cn;
+}
+
+export async function after() {
+  await server.close();
+  for (const cn of clients) {
+    cn.close();
+  }
+}

src/packages/server/conat/test/util.ts renamed to src/packages/backend/conat/test/util.ts

@@ -10,7 +10,10 @@
     "./auth/*": "./dist/auth/*.js",
     "./auth/tokens/*": "./dist/auth/tokens/*.js"
   },
-  "keywords": ["utilities", "cocalc"],
+  "keywords": [
+    "utilities",
+    "cocalc"
+  ],
   "scripts": {
     "preinstall": "npx only-allow pnpm",
     "clean": "rm -rf dist node_modules",
@@ -20,7 +23,12 @@
     "prepublishOnly": "pnpm test",
     "conat-watch": "node ./bin/conat-watch.cjs"
   },
-  "files": ["dist/**", "bin/**", "README.md", "package.json"],
+  "files": [
+    "dist/**",
+    "bin/**",
+    "README.md",
+    "package.json"
+  ],
   "author": "SageMath, Inc.",
   "license": "SEE LICENSE.md",
   "dependencies": {
@@ -44,6 +52,7 @@
     "prom-client": "^13.0.0",
     "rimraf": "^5.0.5",
     "shell-escape": "^0.2.0",
+    "socket.io": "^4.8.1",
     "socket.io-client": "^4.8.1",
     "supports-color": "^9.0.2",
     "tmp-promise": "^3.0.3",

src/packages/backend/package.json

@@ -38,7 +38,12 @@ import {
 import { createAdapter } from "@socket.io/redis-streams-adapter";
 import Valkey from "iovalkey";
 import { delay } from "awaiting";
-import { ConatError } from "./client";
+import {
+  ConatError,
+  connect,
+  type Client,
+  type ConnectOptions,
+} from "./client";
 
 // This is just the default with socket.io, but we might want a bigger
 // size, which could mean more RAM usage by the servers.
@@ -390,6 +395,17 @@ export class ConatServer {
       }
     });
   };
+
+  // create new client in the same process connected to this server.
+  // This is useful for unit testing and is not cached (i.e., multiple
+  // calls return distinct clients).
+  client = (options?: ConnectOptions): Client => {
+    return connect(`http://localhost:${this.options.port}`, {
+      path: this.options.path,
+      noCache: true,
+      ...options,
+    });
+  };
 }
 
 function getSubjectFromRoom(room: string) {