conat: more service unit tests

Author: williamstein

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

@@ -11,8 +11,7 @@ import {
   createServiceClient,
   createServiceHandler,
 } from "@cocalc/conat/service/typed";
-import { once } from "@cocalc/util/async-utils";
-import { before, after, connect } from "@cocalc/backend/conat/test/setup";
+import { before, after } from "@cocalc/backend/conat/test/setup";
 import { wait } from "@cocalc/backend/conat/test/util";
 import { is_date as isDate } from "@cocalc/util/misc";
 import { delay } from "awaiting";
@@ -23,14 +22,11 @@ beforeAll(before);
 
 describe("create a service and test it out", () => {
   let s;
-  let subject;
   it("creates a service", async () => {
     s = createConatService({
       service: "echo",
       handler: (mesg) => mesg.repeat(2),
     });
-    subject = s.subject;
-    await once(s, "running");
     expect(await callConatService({ service: "echo", mesg: "hello" })).toBe(
       "hellohello",
     );
@@ -42,16 +38,6 @@ describe("create a service and test it out", () => {
       await callConatService({ service: "echo", mesg: "hi", timeout: 250 });
     }).rejects.toThrowError("timeout");
   });
-
-  // [ ] TODO: broken!
-  it.skip("creates a listener on the same subject and try to call to verify timeout works", async () => {
-    const client = connect();
-    const sub = await client.subscribe(subject);
-    await expect(async () => {
-      await callConatService({ service: "echo", mesg: "hi", timeout: 250 });
-    }).rejects.toThrowError("timeout");
-    sub.close();
-  });
 });
 
 describe("verify that you can create a service AFTER calling it and things to still work fine", () => {
@@ -231,4 +217,42 @@ describe("create a service with specified client, stop and start the server, and
   });
 });
 
+describe("create a slow service and check that the timeout parameter works", () => {
+  let s;
+  it("creates a slow service", async () => {
+    s = createConatService({
+      service: "slow",
+      handler: async (d) => {
+        await delay(d);
+        return { delay: d };
+      },
+    });
+  });
+
+  it("confirms it works", async () => {
+    const t0 = Date.now();
+    const r = await callConatService({
+      service: s.name,
+      mesg: 50,
+    });
+    expect(r).toEqual({ delay: 50 });
+    expect(Date.now() - t0).toBeGreaterThan(45);
+    expect(Date.now() - t0).toBeLessThan(500);
+  });
+
+  it("confirms it throws a timeout error", async () => {
+    await expect(async () => {
+      await callConatService({
+        service: s.name,
+        mesg: 5000,
+        timeout: 75,
+      });
+    }).rejects.toThrowError("imeout");
+  });
+
+  it("clean up", async () => {
+    s.close();
+  });
+});
+
 afterAll(after);

src/packages/conat/core/client.ts

@@ -619,13 +619,12 @@ export class Client {
         code: 503,
       });
     }
-
     for await (const resp of sub) {
       sub.stop();
       return resp;
     }
     sub.stop();
-    throw Error("timeout");
+    throw new ConatError("timeout", { code: 408 });
   };
 
   async *requestMany(

src/packages/conat/service/service.ts

@@ -59,6 +59,7 @@ export async function callConatService(opts: ServiceCall): Promise<any> {
   const data = opts.mesg ?? null;
 
   const doRequest = async () => {
+    // console.log("doRequest...");
     resp = await cn.request(subject, data, {
       timeout,
     });
@@ -69,16 +70,15 @@ export async function callConatService(opts: ServiceCall): Promise<any> {
     return result;
   };
 
-  // we just try to call the service first
   try {
+    // try to call the service:
     return await doRequest();
   } catch (err) {
     // console.log(`request to '${subject}' failed -- ${err}`);
     // it failed.
     if (opts.noRetry) {
       throw err;
     }
-    // it's a nats problem
     const p = opts.path ? `${trunc_middle(opts.path, 64)}:` : "";
     if (err.code == 503) {
       // it's actually just not ready, so
@@ -92,10 +92,12 @@ export async function callConatService(opts: ServiceCall): Promise<any> {
         }
         throw err;
       }
-    } else if (err.code == "TIMEOUT") {
+    } else if (err.code == 408) {
       throw Error(
-        `Timeout: service ${p}${opts.service} did not respond for ${Math.round(timeout / 1000)} seconds`,
+        `Timeout: service '${p}${opts.service}' did not respond for ${Math.round(timeout / 1000)} seconds`,
       );
+    } else {
+      throw err;
     }
   }
 }