conat: rename packages/backend/nats to packages/backend/conat

Author: williamstein

src/package.json

@@ -19,13 +19,13 @@
     "test-parallel": "unset DEBUG && pnpm run version-check && cd packages && pnpm run -r --parallel test",
     "test": "unset DEBUG && pnpm run version-check && cd packages && pnpm run -r test",
     "prettier-all": "cd packages/",
-    "nats-server": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/nats/install').main()\" && node -e \"require('@cocalc/backend/nats/conf').main()\" && node -e \"require('@cocalc/backend/nats/server').main()\"",
+    "nats-server": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/conat/install').main()\" && node -e \"require('@cocalc/backend/conat/conf').main()\" && node -e \"require('@cocalc/backend/conat/server').main()\"",
     "build-nats": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/util && pnpm install && pnpm build && cd ${COCALC_ROOT:=$INIT_CWD}/packages/nats && pnpm install && pnpm build && cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && pnpm install && pnpm build",
-    "nats-server-ci": "pnpm run build-nats && cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/nats/install').main()\" && node -e \"require('@cocalc/backend/nats/conf').main()\" && node -e \"require('@cocalc/backend/nats/server').main()\"",
-    "nats-server-daemon": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/nats/install').main()\" && node -e \"require('@cocalc/backend/nats/conf').main()\" && node -e \"require('@cocalc/backend/nats/server').main({daemon:true})\"",
-    "nats-server-verbose": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/nats/install').main()\" && node -e \"require('@cocalc/backend/nats/conf').main()\" && node -e \"require('@cocalc/backend/nats/server').main({verbose:true})\"",
-    "nats-cli": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/nats/cli').main()\"",
-    "nats-sys": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/nats/cli').main({user:'sys'})\"",
+    "nats-server-ci": "pnpm run build-nats && cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/conat/install').main()\" && node -e \"require('@cocalc/backend/conat/conf').main()\" && node -e \"require('@cocalc/backend/conat/server').main()\"",
+    "nats-server-daemon": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/conat/install').main()\" && node -e \"require('@cocalc/backend/conat/conf').main()\" && node -e \"require('@cocalc/backend/conat/server').main({daemon:true})\"",
+    "nats-server-verbose": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/conat/install').main()\" && node -e \"require('@cocalc/backend/conat/conf').main()\" && node -e \"require('@cocalc/backend/conat/server').main({verbose:true})\"",
+    "nats-cli": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/conat/cli').main()\"",
+    "nats-sys": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/backend && node -e \"require('@cocalc/backend/conat/cli').main({user:'sys'})\"",
     "nats-tiered-storage": "cd ${COCALC_ROOT:=$INIT_CWD}/packages/server && DEBUG=cocalc:* DEBUG_CONSOLE=yes node -e \"require('@cocalc/server/nats/tiered-storage').init()\"",
     "local-ci": "./scripts/ci.sh",
     "conat-server": "cd packages/server && pnpm conat-server",

src/packages/backend/bin/conat-watch.cjs

@@ -1,4 +1,4 @@
-const { getEnv } = require('@cocalc/backend/nats')
+const { getEnv } = require('@cocalc/backend/conat')
 
 async function main() {
     const subject = process.argv[2] ?? '>';

src/packages/backend/nats/cli.ts renamed to src/packages/backend/conat/cli.ts

@@ -1,7 +1,7 @@
 /*
 Configure nats-server, i.e., generate configuration files.
 
-node -e "require('@cocalc/backend/nats/conf').main()"
+node -e "require('@cocalc/backend/conat/conf').main()"
 
 
 

src/packages/backend/nats/conat.ts renamed to src/packages/backend/conat/conat.ts

@@ -13,7 +13,7 @@ import { inboxPrefix } from "@cocalc/conat/names";
 import { setNatsClient } from "@cocalc/conat/client";
 import getConnection, {
   setConnectionOptions,
-} from "@cocalc/backend/nats/persistent-connection";
+} from "@cocalc/backend/conat/persistent-connection";
 import { hostname } from "os";
 
 export { getConnection };

src/packages/backend/nats/conf.ts renamed to src/packages/backend/conat/conf.ts

@@ -14,17 +14,17 @@ Installation happens automatically, e.g,. when you do 'pnpm nats-server' or
 start the hub via 'pnpm hub'.   However, you can explicitly do
 an install as follows:
 
-~/cocalc/src/packages/backend/nats$ DEBUG=cocalc:* DEBUG_CONSOLE=yes node
+~/cocalc/src/packages/backend/conat$ DEBUG=cocalc:* DEBUG_CONSOLE=yes node
 Welcome to Node.js v18.17.1.
 Type ".help" for more information.
 
 Install latest tested version of nats-server and nats cli:
 
-    > await require('@cocalc/backend/nats/install').install()
+    > await require('@cocalc/backend/conat/install').install()
 
 Installing just the server:
 
-    > await require('@cocalc/backend/nats/install').installNatsServer()
+    > await require('@cocalc/backend/conat/install').installNatsServer()
 */
 
 import { nats } from "@cocalc/backend/data";

src/packages/backend/nats/env.ts renamed to src/packages/backend/conat/env.ts

@@ -1,10 +1,10 @@
 /*
 EXAMPLE:
 
-~/cocalc/src/packages/backend/nats$ n
+~/cocalc/src/packages/backend/conat$ n
 Welcome to Node.js v18.17.1.
 Type ".help" for more information.
-> a = require('@cocalc/backend/nats/nkeys')
+> a = require('@cocalc/backend/conat/nkeys')
 {
   publicKey: [Function: publicKey],
   createPrivateKey: [Function: createPrivateKey]

src/packages/backend/nats/index.ts renamed to src/packages/backend/conat/index.ts

@@ -8,7 +8,7 @@ pnpm exec jest --watch --forceExit --detectOpenHandles "read.test.ts"
 
 */
 
-import "@cocalc/backend/nats";
+import "@cocalc/backend/conat";
 import { close, createServer, readFile } from "@cocalc/conat/files/read";
 import { createReadStream } from "fs";
 import { file as tempFile } from "tmp-promise";

src/packages/backend/nats/install.ts renamed to src/packages/backend/conat/install.ts

@@ -8,7 +8,7 @@ DEVELOPMENT:
 
 */
 
-import "@cocalc/backend/nats";
+import "@cocalc/backend/conat";
 import { close, createServer, writeFile } from "@cocalc/conat/files/write";
 import { createWriteStream, createReadStream } from "fs";
 import { file as tempFile } from "tmp-promise";

src/packages/backend/nats/nkeys.ts renamed to src/packages/backend/conat/nkeys.ts

@@ -8,7 +8,7 @@ DEVELOPMENT:
 */
 
 // this sets client
-import "@cocalc/backend/nats";
+import "@cocalc/backend/conat";
 
 import { init, close } from "@cocalc/conat/llm/server";
 import { llm } from "@cocalc/conat/llm/client";

src/packages/backend/nats/persist.ts renamed to src/packages/backend/conat/persist.ts

@@ -8,7 +8,7 @@ pnpm test --forceExit service.test.ts
 
 import { callNatsService, createNatsService } from "@cocalc/conat/service";
 import { once } from "@cocalc/util/async-utils";
-import "@cocalc/backend/nats";
+import "@cocalc/backend/conat";
 
 describe("create a service and test it out", () => {
   let s;

src/packages/backend/nats/persistent-connection.ts renamed to src/packages/backend/conat/persistent-connection.ts

@@ -7,7 +7,7 @@ pnpm exec jest --forceExit "akv.test.ts"
 
 */
 
-import { dkv as createDkv, akv as createAkv } from "@cocalc/backend/nats/sync";
+import { dkv as createDkv, akv as createAkv } from "@cocalc/backend/conat/sync";
 import { once } from "@cocalc/util/async-utils";
 import { getMaxPayload } from "@cocalc/conat/util";
 

src/packages/backend/nats/server.ts renamed to src/packages/backend/conat/server.ts

@@ -9,9 +9,9 @@ DEVELOPMENT:
 pnpm exec jest --forceExit "binary.test.ts"
 */
 
-import "@cocalc/backend/nats"; // ensure client is setup
+import "@cocalc/backend/conat"; // ensure client is setup
 import { getMaxPayload } from "@cocalc/conat/util";
-import { dstream, dkv } from "@cocalc/backend/nats/sync";
+import { dstream, dkv } from "@cocalc/backend/conat/sync";
 
 describe("test binary data with a dstream", () => {
   let s,

src/packages/backend/nats/sync.ts renamed to src/packages/backend/conat/sync.ts

@@ -13,11 +13,11 @@ If this suddenly breaks, see the comment in packages/nats/sync/general-kv.ts
 about potentially having to fork NATS.
 */
 
-import "@cocalc/backend/nats"; // ensure client is setup
+import "@cocalc/backend/conat"; // ensure client is setup
 import { getMaxPayload } from "@cocalc/conat/util";
 import { createDstream } from "./util";
-import { dstream } from "@cocalc/backend/nats/sync";
-import { dkv as createDkv } from "@cocalc/backend/nats/sync";
+import { dstream } from "@cocalc/backend/conat/sync";
+import { dkv as createDkv } from "@cocalc/backend/conat/sync";
 
 describe("create a dstream and a dkv and write a large chunk to each", () => {
   let maxPayload = 0;

src/packages/backend/nats/test/files/read.test.ts renamed to src/packages/backend/conat/test/files/read.test.ts

@@ -7,7 +7,7 @@ pnpm exec jest --forceExit "dko.test.ts"
 
 */
 
-import { dko as createDko } from "@cocalc/backend/nats/sync";
+import { dko as createDko } from "@cocalc/backend/conat/sync";
 import { getMaxPayload } from "@cocalc/conat/util";
 
 describe("create a public dko and do a basic operation", () => {

src/packages/backend/nats/test/files/write.test.ts renamed to src/packages/backend/conat/test/files/write.test.ts

@@ -7,7 +7,7 @@ pnpm exec jest --watch --forceExit "dkv-merge.test.ts"
 
 */
 
-import { dkv as createDkv } from "@cocalc/backend/nats/sync";
+import { dkv as createDkv } from "@cocalc/backend/conat/sync";
 import { once } from "@cocalc/util/async-utils";
 import { diff_match_patch } from "@cocalc/util/dmp";
 

src/packages/backend/nats/test/llm.test.ts renamed to src/packages/backend/conat/test/llm.test.ts

@@ -7,7 +7,7 @@ pnpm test dkv.test.ts
 
 */
 
-import { dkv as createDkv } from "@cocalc/backend/nats/sync";
+import { dkv as createDkv } from "@cocalc/backend/conat/sync";
 import { once } from "@cocalc/util/async-utils";
 import { delay } from "awaiting";
 

src/packages/backend/nats/test/service.test.ts renamed to src/packages/backend/conat/test/service.test.ts

@@ -8,7 +8,7 @@ pnpm test dstream.test.ts
 */
 
 import { createDstream as create } from "./util";
-import { dstream as createDstream } from "@cocalc/backend/nats/sync";
+import { dstream as createDstream } from "@cocalc/backend/conat/sync";
 import { once } from "@cocalc/util/async-utils";
 
 describe("create a dstream and do some basic operations", () => {

src/packages/backend/nats/test/sync/akv.test.ts renamed to src/packages/backend/conat/test/sync/akv.test.ts

@@ -11,7 +11,7 @@ pnpm test estream.test.ts
 */
 
 import { createDstreamEphemeral as create } from "./util";
-import { dstream as createDstream0 } from "@cocalc/backend/nats/sync";
+import { dstream as createDstream0 } from "@cocalc/backend/conat/sync";
 import { once } from "@cocalc/util/async-utils";
 
 async function createDstream<T>(opts) {

src/packages/backend/nats/test/sync/binary.test.ts renamed to src/packages/backend/conat/test/sync/binary.test.ts

@@ -11,7 +11,7 @@ pnpm exec jest --forceExit "general-kv.test.ts"
 */
 // import { once } from "@cocalc/util/async-utils";
 import { delay } from "awaiting";
-import { getEnv } from "@cocalc/backend/nats/env";
+import { getEnv } from "@cocalc/backend/conat/env";
 import { GeneralKV } from "@cocalc/conat/sync/general-kv";
 import { getMaxPayload } from "@cocalc/conat/util";
 

src/packages/backend/nats/test/sync/chunk.test.ts renamed to src/packages/backend/conat/test/sync/chunk.test.ts

@@ -6,9 +6,9 @@ DEVELOPMENT:
 pnpm exec jest --forceExit "headers.test.ts"
 */
 
-import "@cocalc/backend/nats"; // ensure client is setup
+import "@cocalc/backend/conat"; // ensure client is setup
 import { getMaxPayload } from "@cocalc/conat/util";
-import { dstream, stream, dkv, kv } from "@cocalc/backend/nats/sync";
+import { dstream, stream, dkv, kv } from "@cocalc/backend/conat/sync";
 import { once } from "@cocalc/util/async-utils";
 
 describe("test headers with a stream", () => {

src/packages/backend/nats/test/sync/dko.test.ts renamed to src/packages/backend/conat/test/sync/dko.test.ts

@@ -7,8 +7,8 @@ pnpm exec jest --forceExit "limits.test.ts"
 
 */
 
-import { dkv as createDkv } from "@cocalc/backend/nats/sync";
-import { dstream as createDstream } from "@cocalc/backend/nats/sync";
+import { dkv as createDkv } from "@cocalc/backend/conat/sync";
+import { dstream as createDstream } from "@cocalc/backend/conat/sync";
 import { delay } from "awaiting";
 import { once } from "@cocalc/util/async-utils";
 

src/packages/backend/nats/test/sync/dkv-merge.test.ts renamed to src/packages/backend/conat/test/sync/dkv-merge.test.ts

@@ -12,7 +12,7 @@ pnpm exec jest --forceExit "open-files.test.ts"
 
 */
 
-import { openFiles as createOpenFiles } from "@cocalc/backend/nats/sync";
+import { openFiles as createOpenFiles } from "@cocalc/backend/conat/sync";
 import { once } from "@cocalc/util/async-utils";
 import { delay } from "awaiting";
 

src/packages/backend/nats/test/sync/dkv.test.ts renamed to src/packages/backend/conat/test/sync/dkv.test.ts

@@ -1,4 +1,4 @@
-import { dstream } from "@cocalc/backend/nats/sync";
+import { dstream } from "@cocalc/backend/conat/sync";
 
 export async function createDstream() {
   const name = `test-${Math.random()}`;

src/packages/backend/nats/test/sync/dstream.test.ts renamed to src/packages/backend/conat/test/sync/dstream.test.ts

@@ -5,7 +5,7 @@ pnpm test ./time.test.ts
 */
 
 // this sets client
-import "@cocalc/backend/nats";
+import "@cocalc/backend/conat";
 
 import time, { getSkew } from "@cocalc/conat/time";
 
@@ -33,7 +33,7 @@ import { timeClient, createTimeService } from "@cocalc/conat/service/time";
 
 describe("start the time server and client and test that it works", () => {
   it("starts the time server and queries it", async () => {
-    await import("@cocalc/backend/nats");
+    await import("@cocalc/backend/conat");
     createTimeService();
     const client = timeClient();
     const t = await client.time();

src/packages/backend/nats/test/sync/estream.test.ts renamed to src/packages/backend/conat/test/sync/estream.test.ts

@@ -2,7 +2,7 @@
 DEVELOPMENT:
 
 ~/cocalc/src/packages/backend$ node
-> require('@cocalc/backend/nats'); c = require('@cocalc/conat/client').getClient()
+> require('@cocalc/backend/conat'); c = require('@cocalc/conat/client').getClient()
 > c.state
 'connected'
 > Object.keys(await c.getNatsEnv())

src/packages/backend/nats/test/sync/general-kv.test.ts renamed to src/packages/backend/conat/test/sync/general-kv.test.ts

@@ -41,11 +41,11 @@ The methods you call on the client to build everything are:
  - subscribe, subscribeSync - subscribe to a subject which returns an
    async iterator over all messages that match the subject published by 
    anyone with permission to do so.   If you provide the same optional 
-   queue parameter for multiple subscribers, then one subscriber receives 
-   each message. The async form confirms the subscription was created 
+   queue parameter for multiple subscribers, then one subscriber in each queue group
+   receives each message. The async form confirms the subscription was created 
    before returning. A client may only create one subscription to a 
    given subject at a time, to greatly reduce the chance of leaks and 
-   simplify code.  There is no size limit on messages. 
+   simplify code.  **There is no size limit on messages.**
    Subscriptions are guaranteed to stay valid until the client ends them;
    they do not stop working due to client or server reconnects or restarts.
    
@@ -55,7 +55,7 @@ The methods you call on the client to build everything are:
 
  - request - send a message to a subject, and if there is at least one
    subscriber listening, it may respond.  If there are no subscribers,
-   it throws a 503 error.  To create a microservice, you just subscribe
+   it throws a 503 error.  To create a microservice, subscribe
    to a subject pattern and called mesg.respond(...) on each message you
    receive.
    
@@ -135,7 +135,7 @@ for something that definitely works perfectly.
 
 For developing at the command line, cd to packages/backend, then in node:
 
-   c = require('@cocalc/backend/nats/conat').connect()
+   c = require('@cocalc/backend/conat/conat').connect()
    
 or
 
@@ -147,7 +147,7 @@ or
    
 // in another console
 
-   c = require('@cocalc/backend/nats/conat').connect()
+   c = require('@cocalc/backend/conat/conat').connect()
    c.publish('a', 'hello there')
 
 // in browser (right now)

src/packages/backend/nats/test/sync/headers.test.ts renamed to src/packages/backend/conat/test/sync/headers.test.ts

@@ -24,11 +24,11 @@ over a websocket for compute servers, so would just copy that code.
 
 DEVELOPMENT:
 
-See src/packages/backend/nats/test/files/read.test.ts for unit tests.
+See src/packages/backend/conat/test/files/read.test.ts for unit tests.
 
 ~/cocalc/src/packages/backend$ node
 
-require('@cocalc/backend/nats'); a = require('@cocalc/conat/files/read'); a.createServer({project_id:'00847397-d6a8-4cb0-96a8-6ef64ac3e6cf',compute_server_id:0,createReadStream:require('fs').createReadStream})
+require('@cocalc/backend/conat'); a = require('@cocalc/conat/files/read'); a.createServer({project_id:'00847397-d6a8-4cb0-96a8-6ef64ac3e6cf',compute_server_id:0,createReadStream:require('fs').createReadStream})
 
 for await (const chunk of await a.readFile({project_id:'00847397-d6a8-4cb0-96a8-6ef64ac3e6cf',compute_server_id:0,path:'/tmp/a'})) { console.log({chunk}); }
 

src/packages/backend/nats/test/sync/limits.test.ts renamed to src/packages/backend/conat/test/sync/limits.test.ts

@@ -50,11 +50,11 @@ Here's how it works from the side of whoever is sending the file:
 
 DEVELOPMENT:
 
-See src/packages/backend/nats/test/files/write.test.ts for unit tests.
+See src/packages/backend/conat/test/files/write.test.ts for unit tests.
 
 ~/cocalc/src/packages/backend$ node
 
-require('@cocalc/backend/nats'); a = require('@cocalc/conat/files/write');
+require('@cocalc/backend/conat'); a = require('@cocalc/conat/files/write');
 
 project_id = '00847397-d6a8-4cb0-96a8-6ef64ac3e6cf'; compute_server_id = 0; await a.createServer({project_id,compute_server_id,createWriteStream:require('fs').createWriteStream});
 

src/packages/backend/nats/test/sync/open-files.test.ts renamed to src/packages/backend/conat/test/sync/open-files.test.ts

@@ -44,7 +44,7 @@ export function initContext(opts: {
 export function createDatabase(...args): Database {
   if (betterSqlite3 == null) {
     throw Error(
-      "nats/persist must be initialized with the better-sqlite3 module -- import from backend/nats/persist instead",
+      "conat/persist must be initialized with the better-sqlite3 module -- import from backend/nats/persist instead",
     );
   }
   return new betterSqlite3(...args);

src/packages/backend/nats/test/sync/util.ts renamed to src/packages/backend/conat/test/sync/util.ts

@@ -12,20 +12,20 @@ Change to the packages/backend directory and run node.
 
 TERMINAL 1: This sets up the environment and starts the server running:
 
-   require('@cocalc/backend/nats/persist').initServer()
+   require('@cocalc/backend/conat/persist').initServer()
 
 
 TERMINAL 2: In another node session, create a client:
 
-    user = {account_id:'00000000-0000-4000-8000-000000000000'}; storage = {path:'a.db'}; const {id, lifetime, stream} = await require('@cocalc/backend/nats/persist').getAll({user, storage, options:{lifetime:1000*60}}); console.log({id}); for await(const x of stream) { console.log(x.data) }; console.log("DONE")
+    user = {account_id:'00000000-0000-4000-8000-000000000000'}; storage = {path:'a.db'}; const {id, lifetime, stream} = await require('@cocalc/backend/conat/persist').getAll({user, storage, options:{lifetime:1000*60}}); console.log({id}); for await(const x of stream) { console.log(x.data) }; console.log("DONE")
 
 // client also does this periodically to keep subscription alive:
 
     await renew({user, id }) 
 
 TERMINAL 3:
 
-user = {account_id:'00000000-0000-4000-8000-000000000000'}; storage = {path:'a.db'}; const {set,get} = require('@cocalc/backend/nats/persist');  const { messageData } =require("@cocalc/conat/core/client"); 0;
+user = {account_id:'00000000-0000-4000-8000-000000000000'}; storage = {path:'a.db'}; const {set,get} = require('@cocalc/backend/conat/persist');  const { messageData } =require("@cocalc/conat/core/client"); 0;
 
    await set({user, storage, messageData:messageData('hi')})
    
@@ -37,7 +37,7 @@ user = {account_id:'00000000-0000-4000-8000-000000000000'}; storage = {path:'a.d
    
 Also getAll using start_seq:
 
-   cf = const {id, lifetime, stream} = await require('@cocalc/backend/nats/persist').getAll({user, storage, start_seq:10, options:{lifetime:1000*60}}); for await(const x of stream) { console.log(x) };
+   cf = const {id, lifetime, stream} = await require('@cocalc/backend/conat/persist').getAll({user, storage, start_seq:10, options:{lifetime:1000*60}}); for await(const x of stream) { console.log(x) };
 */
 
 import { pstream, type Message as StoredMessage } from "./storage";

src/packages/backend/nats/test/time.test.ts renamed to src/packages/backend/conat/test/time.test.ts

@@ -15,7 +15,7 @@ Development:
 # non-channel full communication
 
 Primus = require('@cocalc/conat/primus').Primus;
-env = await require('@cocalc/backend/nats').getEnv();
+env = await require('@cocalc/backend/conat').getEnv();
 server = new Primus({subject:'test',env,role:'server',id:'s'});
 sparks = []; server.on("connection", (spark) => sparks.push(spark));
 

src/packages/conat/client.ts

@@ -14,7 +14,7 @@ There is no need to close this because it is stateless.
 DEVELOPMENT:
 
 ~/cocalc/src/packages/backend$ node
-> t =  require("@cocalc/backend/nats/sync").akv({name:'test'})
+> t =  require("@cocalc/backend/conat/sync").akv({name:'test'})
 
 */