swarpc 0.3.0 → 0.4.0

package/dist/swarpc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"swarpc.d.ts","sourceRoot":"","sources":["../src/swarpc.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EAClB,MAAM,YAAY,CAAA;AAEnB,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE3E,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACnC,YAAY,CAAC,UAAU,CAAC,CAyE1B;AA4DD,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACnC,YAAY,CAAC,UAAU,CAAC,CAmC1B"}
+{"version":3,"file":"swarpc.d.ts","sourceRoot":"","sources":["../src/swarpc.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EAClB,MAAM,YAAY,CAAA;AAEnB,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE3E,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACnC,YAAY,CAAC,UAAU,CAAC,CA+E1B;AA4DD,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACnC,YAAY,CAAC,UAAU,CAAC,CAyC1B"}

package/dist/swarpc.js

@@ -32,6 +32,7 @@ export function Server(procedures, { worker } = {}) {
         };
         self.addEventListener("message", async (event) => {
             const { functionName, requestId, input } = PayloadSchema.assert(event.data);
+            l.server.debug(requestId, `Received request for ${functionName}`, input);
             const postError = async (error) => postMessage({
                 functionName,
                 requestId,
@@ -45,12 +46,15 @@ export function Server(procedures, { worker } = {}) {
                 return;
             }
             await implementation(input, async (progress) => {
+                l.server.debug(requestId, `Progress for ${functionName}`, progress);
                 await postMessage({ functionName, requestId, progress });
             })
                 .catch(async (error) => {
+                l.server.error(requestId, `Error in ${functionName}`, error);
                 await postError(error);
             })
                 .then(async (result) => {
+                l.server.debug(requestId, `Result for ${functionName}`, result);
                 await postMessage({ functionName, requestId, result });
             });
         });
@@ -58,7 +62,7 @@ export function Server(procedures, { worker } = {}) {
     return instance;
 }
 function generateRequestId() {
-    return Math.random().toString(36).substring(2, 15);
+    return Math.random().toString(16).substring(2, 8).toUpperCase();
 }
 const pendingRequests = new Map();
 let _clientListenerStarted = false;
@@ -71,11 +75,11 @@ async function startClientListener(worker) {
             throw new Error("[SWARPC Client] Service Worker is not active");
         }
         if (!navigator.serviceWorker.controller) {
-            console.warn("[SWARPC Client] Service Worker is not controlling the page");
+            l.client.warn("", "Service Worker is not controlling the page");
         }
     }
     const w = worker ?? navigator.serviceWorker;
-    console.log("[SWARPC Client] Starting client listener on", w);
+    l.client.debug("", "Starting client listener on", w);
     w.addEventListener("message", (event) => {
         const { functionName, requestId, ...data } = event.data || {};
         if (!requestId) {
@@ -102,6 +106,10 @@ async function startClientListener(worker) {
 export function Client(procedures, { worker } = {}) {
     const instance = { [zProcedures]: procedures };
     for (const functionName of Object.keys(procedures)) {
+        if (typeof functionName !== "string") {
+            throw new Error(`[SWARPC Client] Invalid function name, don't use symbols`);
+        }
+        // @ts-expect-error
         instance[functionName] = (async (input, onProgress = () => { }) => {
             procedures[functionName].input.assert(input);
             await startClientListener(worker);
@@ -111,12 +119,45 @@ export function Client(procedures, { worker } = {}) {
             }
             return new Promise((resolve, reject) => {
                 if (!worker && !navigator.serviceWorker.controller)
-                    console.warn("[SWARPC Client] Service Worker is not controlling the page");
+                    l.client.warn("", "Service Worker is not controlling the page");
                 const requestId = generateRequestId();
                 pendingRequests.set(requestId, { resolve, onProgress, reject });
+                l.client.debug(requestId, `Requesting ${functionName} with`, input);
                 w.postMessage({ functionName, input, requestId });
             });
         });
     }
     return instance;
 }
+const l = {
+    server: {
+        debug: (rqid, message, ...args) => log("debug", "server", rqid, message, ...args),
+        info: (rqid, message, ...args) => log("info", "server", rqid, message, ...args),
+        warn: (rqid, message, ...args) => log("warn", "server", rqid, message, ...args),
+        error: (rqid, message, ...args) => log("error", "server", rqid, message, ...args),
+    },
+    client: {
+        debug: (rqid, message, ...args) => log("debug", "client", rqid, message, ...args),
+        info: (rqid, message, ...args) => log("info", "client", rqid, message, ...args),
+        warn: (rqid, message, ...args) => log("warn", "client", rqid, message, ...args),
+        error: (rqid, message, ...args) => log("error", "client", rqid, message, ...args),
+    },
+};
+function log(severity, side, rqid, message, ...args) {
+    const prefix = "[" +
+        ["SWARPC", side, rqid ? `%c${rqid}%c` : ""].filter(Boolean).join(" ") +
+        "]";
+    const prefixStyles = rqid ? ["color: cyan;", "color: inherit;"] : [];
+    if (severity === "debug") {
+        console.debug(prefix, ...prefixStyles, message, ...args);
+    }
+    else if (severity === "info") {
+        console.info(prefix, ...prefixStyles, message, ...args);
+    }
+    else if (severity === "warn") {
+        console.warn(prefix, ...prefixStyles, message, ...args);
+    }
+    else if (severity === "error") {
+        console.error(prefix, ...prefixStyles, message, ...args);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swarpc",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Full type-safe RPC library for service worker -- move things off of the UI thread with ease!",
   "keywords": [
     "service-workers",

package/src/swarpc.ts

@@ -58,6 +58,9 @@ export function Server<Procedures extends ProceduresMap>(
       const { functionName, requestId, input } = PayloadSchema.assert(
         event.data
       )
+
+      l.server.debug(requestId, `Received request for ${functionName}`, input)
+
       const postError = async (error: any) =>
         postMessage({
           functionName,
@@ -74,12 +77,15 @@ export function Server<Procedures extends ProceduresMap>(
       }
 
       await implementation(input, async (progress: any) => {
+        l.server.debug(requestId, `Progress for ${functionName}`, progress)
         await postMessage({ functionName, requestId, progress })
       })
         .catch(async (error: any) => {
+          l.server.error(requestId, `Error in ${functionName}`, error)
           await postError(error)
         })
         .then(async (result: any) => {
+          l.server.debug(requestId, `Result for ${functionName}`, result)
           await postMessage({ functionName, requestId, result })
         })
     })
@@ -89,7 +95,7 @@ export function Server<Procedures extends ProceduresMap>(
 }
 
 function generateRequestId(): string {
-  return Math.random().toString(36).substring(2, 15)
+  return Math.random().toString(16).substring(2, 8).toUpperCase()
 }
 
 type PendingRequest = {
@@ -111,12 +117,12 @@ async function startClientListener(worker?: Worker) {
     }
 
     if (!navigator.serviceWorker.controller) {
-      console.warn("[SWARPC Client] Service Worker is not controlling the page")
+      l.client.warn("", "Service Worker is not controlling the page")
     }
   }
 
   const w = worker ?? navigator.serviceWorker
-  console.log("[SWARPC Client] Starting client listener on", w)
+  l.client.debug("", "Starting client listener on", w)
   w.addEventListener("message", (event) => {
     const { functionName, requestId, ...data } =
       (event as MessageEvent).data || {}
@@ -157,6 +163,13 @@ export function Client<Procedures extends ProceduresMap>(
   for (const functionName of Object.keys(procedures) as Array<
     keyof Procedures
   >) {
+    if (typeof functionName !== "string") {
+      throw new Error(
+        `[SWARPC Client] Invalid function name, don't use symbols`
+      )
+    }
+
+    // @ts-expect-error
     instance[functionName] = (async (input: unknown, onProgress = () => {}) => {
       procedures[functionName].input.assert(input)
       await startClientListener(worker)
@@ -170,14 +183,13 @@ export function Client<Procedures extends ProceduresMap>(
 
       return new Promise((resolve, reject) => {
         if (!worker && !navigator.serviceWorker.controller)
-          console.warn(
-            "[SWARPC Client] Service Worker is not controlling the page"
-          )
+          l.client.warn("", "Service Worker is not controlling the page")
 
         const requestId = generateRequestId()
 
         pendingRequests.set(requestId, { resolve, onProgress, reject })
 
+        l.client.debug(requestId, `Requesting ${functionName} with`, input)
         w.postMessage({ functionName, input, requestId })
       })
     }) as SwarpcClient<Procedures>[typeof functionName]
@@ -185,3 +197,51 @@ export function Client<Procedures extends ProceduresMap>(
 
   return instance as SwarpcClient<Procedures>
 }
+
+const l = {
+  server: {
+    debug: (rqid: string | null, message: string, ...args: any[]) =>
+      log("debug", "server", rqid, message, ...args),
+    info: (rqid: string | null, message: string, ...args: any[]) =>
+      log("info", "server", rqid, message, ...args),
+    warn: (rqid: string | null, message: string, ...args: any[]) =>
+      log("warn", "server", rqid, message, ...args),
+    error: (rqid: string | null, message: string, ...args: any[]) =>
+      log("error", "server", rqid, message, ...args),
+  },
+  client: {
+    debug: (rqid: string | null, message: string, ...args: any[]) =>
+      log("debug", "client", rqid, message, ...args),
+    info: (rqid: string | null, message: string, ...args: any[]) =>
+      log("info", "client", rqid, message, ...args),
+    warn: (rqid: string | null, message: string, ...args: any[]) =>
+      log("warn", "client", rqid, message, ...args),
+    error: (rqid: string | null, message: string, ...args: any[]) =>
+      log("error", "client", rqid, message, ...args),
+  },
+}
+
+function log(
+  severity: "debug" | "info" | "warn" | "error",
+  side: "server" | "client",
+  rqid: string | null,
+  message: string,
+  ...args: any[]
+) {
+  const prefix =
+    "[" +
+    ["SWARPC", side, rqid ? `%c${rqid}%c` : ""].filter(Boolean).join(" ") +
+    "]"
+
+  const prefixStyles = rqid ? ["color: cyan;", "color: inherit;"] : []
+
+  if (severity === "debug") {
+    console.debug(prefix, ...prefixStyles, message, ...args)
+  } else if (severity === "info") {
+    console.info(prefix, ...prefixStyles, message, ...args)
+  } else if (severity === "warn") {
+    console.warn(prefix, ...prefixStyles, message, ...args)
+  } else if (severity === "error") {
+    console.error(prefix, ...prefixStyles, message, ...args)
+  }
+}