@graffy/server 0.17.8-alpha.1 → 0.17.8-alpha.3

package/index.cjs

@@ -5,18 +5,23 @@ const common = require("@graffy/common");
 const debug = require("debug");
 const ws = require("ws");
 const log$1 = debug("graffy:server:http");
-function server$1(store, { auth } = {}) {
+function server$1(store, { auth, allowedOptions = [] } = {}) {
   if (!store) throw new Error("server.store_undef");
   return async (req, res) => {
     const parsed = url.parse(req.url, true);
     const optParam = parsed.query.opts && String(parsed.query.opts);
-    const options = optParam && JSON.parse(decodeURIComponent(optParam));
+    const rawOptions = optParam && JSON.parse(decodeURIComponent(optParam));
+    const safeOptions = Object.fromEntries(
+      Object.entries(rawOptions || {}).filter(
+        ([k]) => allowedOptions.includes(k)
+      )
+    );
     if (req.method === "GET") {
       try {
         const qParam = parsed.query.q && String(parsed.query.q);
         const query = qParam && common.unpack(JSON.parse(decodeURIComponent(qParam)));
         if (req.headers.accept === "text/event-stream") {
-          if (auth && !await auth("watch", common.decodeQuery(query), options)) {
+          if (auth && !await auth("watch", common.decodeQuery(query), safeOptions)) {
             const body = "unauthorized";
             res.writeHead(401, {
               "Content-Type": "text/plain",
@@ -35,7 +40,7 @@ function server$1(store, { auth } = {}) {
           }, 29e3);
           try {
             const stream = store.call("watch", query, {
-              ...options,
+              ...safeOptions,
               raw: true
             });
             for await (const value of stream) {
@@ -77,7 +82,7 @@ data: ${e.message}
         if (auth && !await auth(
           op,
           (op === "write" ? common.decodeGraph : common.decodeQuery)(payload),
-          options
+          safeOptions
         )) {
           const body2 = "unauthorized";
           res.writeHead(401, {
@@ -87,7 +92,7 @@ data: ${e.message}
           res.end(body2);
           return;
         }
-        const value = await store.call(op, payload, options);
+        const value = await store.call(op, payload, safeOptions);
         const body = JSON.stringify(common.pack(value));
         res.writeHead(200, {
           "Content-Type": "application/json",
@@ -116,14 +121,19 @@ data: ${e.message}
 }
 const log = debug("graffy:server:ws");
 const PING_INTERVAL = 3e4;
-function server(store, { auth } = {}) {
+function server(store, { auth, allowedOptions = [] } = {}) {
   if (!store) throw new Error("server.store_undef");
   const wss = new ws.WebSocketServer({ noServer: true });
   wss.on("connection", function connection(ws2) {
     ws2.graffyStreams = {};
     ws2.on("message", async function message(msg) {
       try {
-        const [id, op, packedPayload, options] = JSON.parse(msg);
+        const [id, op, packedPayload, rawOptions] = JSON.parse(msg);
+        const safeOptions = Object.fromEntries(
+          Object.entries(rawOptions || {}).filter(
+            ([k]) => allowedOptions.includes(k)
+          )
+        );
         const payload = common.unpack(packedPayload);
         if (id === ":pong") {
           ws2.pingPending = false;
@@ -131,7 +141,7 @@ function server(store, { auth } = {}) {
         }
         if (auth && op !== "unwatch") {
           const decoded = op === "write" ? common.decodeGraph(payload) : common.decodeQuery(payload);
-          if (!await auth(op, decoded, options)) {
+          if (!await auth(op, decoded, safeOptions)) {
             ws2.send(JSON.stringify([id, "unauthorized"]));
             return;
           }
@@ -140,7 +150,7 @@ function server(store, { auth } = {}) {
           case "read":
           case "write":
             try {
-              const result = await store.call(op, payload, options);
+              const result = await store.call(op, payload, safeOptions);
               ws2.send(JSON.stringify([id, null, common.pack(result)]));
             } catch (e) {
               log(`${op}error:${e.message} ${payload}`);
@@ -150,7 +160,7 @@ function server(store, { auth } = {}) {
           case "watch":
             try {
               const stream = store.call("watch", payload, {
-                ...options,
+                ...safeOptions,
                 raw: true
               });
               ws2.graffyStreams[id] = stream;
@@ -182,7 +192,10 @@ function server(store, { auth } = {}) {
   });
   setInterval(function ping() {
     wss.clients.forEach(function each(ws2) {
-      if (ws2.pingPending) return ws2.terminate();
+      if (ws2.pingPending) {
+        ws2.terminate();
+        return;
+      }
       ws2.pingPending = true;
       ws2.send(JSON.stringify([":ping", Date.now()]));
     });

package/index.mjs

@@ -3,18 +3,23 @@ import { unpack, decodeQuery, pack, decodeGraph } from "@graffy/common";
 import debug from "debug";
 import { WebSocketServer } from "ws";
 const log$1 = debug("graffy:server:http");
-function server$1(store, { auth } = {}) {
+function server$1(store, { auth, allowedOptions = [] } = {}) {
   if (!store) throw new Error("server.store_undef");
   return async (req, res) => {
     const parsed = url.parse(req.url, true);
     const optParam = parsed.query.opts && String(parsed.query.opts);
-    const options = optParam && JSON.parse(decodeURIComponent(optParam));
+    const rawOptions = optParam && JSON.parse(decodeURIComponent(optParam));
+    const safeOptions = Object.fromEntries(
+      Object.entries(rawOptions || {}).filter(
+        ([k]) => allowedOptions.includes(k)
+      )
+    );
     if (req.method === "GET") {
       try {
         const qParam = parsed.query.q && String(parsed.query.q);
         const query = qParam && unpack(JSON.parse(decodeURIComponent(qParam)));
         if (req.headers.accept === "text/event-stream") {
-          if (auth && !await auth("watch", decodeQuery(query), options)) {
+          if (auth && !await auth("watch", decodeQuery(query), safeOptions)) {
             const body = "unauthorized";
             res.writeHead(401, {
               "Content-Type": "text/plain",
@@ -33,7 +38,7 @@ function server$1(store, { auth } = {}) {
           }, 29e3);
           try {
             const stream = store.call("watch", query, {
-              ...options,
+              ...safeOptions,
               raw: true
             });
             for await (const value of stream) {
@@ -75,7 +80,7 @@ data: ${e.message}
         if (auth && !await auth(
           op,
           (op === "write" ? decodeGraph : decodeQuery)(payload),
-          options
+          safeOptions
         )) {
           const body2 = "unauthorized";
           res.writeHead(401, {
@@ -85,7 +90,7 @@ data: ${e.message}
           res.end(body2);
           return;
         }
-        const value = await store.call(op, payload, options);
+        const value = await store.call(op, payload, safeOptions);
         const body = JSON.stringify(pack(value));
         res.writeHead(200, {
           "Content-Type": "application/json",
@@ -114,14 +119,19 @@ data: ${e.message}
 }
 const log = debug("graffy:server:ws");
 const PING_INTERVAL = 3e4;
-function server(store, { auth } = {}) {
+function server(store, { auth, allowedOptions = [] } = {}) {
   if (!store) throw new Error("server.store_undef");
   const wss = new WebSocketServer({ noServer: true });
   wss.on("connection", function connection(ws) {
     ws.graffyStreams = {};
     ws.on("message", async function message(msg) {
       try {
-        const [id, op, packedPayload, options] = JSON.parse(msg);
+        const [id, op, packedPayload, rawOptions] = JSON.parse(msg);
+        const safeOptions = Object.fromEntries(
+          Object.entries(rawOptions || {}).filter(
+            ([k]) => allowedOptions.includes(k)
+          )
+        );
         const payload = unpack(packedPayload);
         if (id === ":pong") {
           ws.pingPending = false;
@@ -129,7 +139,7 @@ function server(store, { auth } = {}) {
         }
         if (auth && op !== "unwatch") {
           const decoded = op === "write" ? decodeGraph(payload) : decodeQuery(payload);
-          if (!await auth(op, decoded, options)) {
+          if (!await auth(op, decoded, safeOptions)) {
             ws.send(JSON.stringify([id, "unauthorized"]));
             return;
           }
@@ -138,7 +148,7 @@ function server(store, { auth } = {}) {
           case "read":
           case "write":
             try {
-              const result = await store.call(op, payload, options);
+              const result = await store.call(op, payload, safeOptions);
               ws.send(JSON.stringify([id, null, pack(result)]));
             } catch (e) {
               log(`${op}error:${e.message} ${payload}`);
@@ -148,7 +158,7 @@ function server(store, { auth } = {}) {
           case "watch":
             try {
               const stream = store.call("watch", payload, {
-                ...options,
+                ...safeOptions,
                 raw: true
               });
               ws.graffyStreams[id] = stream;
@@ -180,7 +190,10 @@ function server(store, { auth } = {}) {
   });
   setInterval(function ping() {
     wss.clients.forEach(function each(ws) {
-      if (ws.pingPending) return ws.terminate();
+      if (ws.pingPending) {
+        ws.terminate();
+        return;
+      }
       ws.pingPending = true;
       ws.send(JSON.stringify([":ping", Date.now()]));
     });

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graffy/server",
   "description": "Node.js library for building an API for a Graffy store.",
   "author": "aravind (https://github.com/aravindet)",
-  "version": "0.17.8-alpha.1",
+  "version": "0.17.8-alpha.3",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,8 +16,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.17.8-alpha.1",
-    "debug": "^4.4.1",
-    "ws": "^8.18.2"
+    "@graffy/common": "0.17.8-alpha.3",
+    "debug": "^4.4.3",
+    "ws": "^8.19.0"
   }
 }

package/types/httpServer.d.ts

@@ -1,12 +1,19 @@
 /**
  * @typedef {import('@graffy/core').default} GraffyStore
  * @param {GraffyStore} store
- * @param {{
- *   auth?: (operation: string, payload: any, options: any) => Promise<boolean>
- * } | undefined} options
+ * @param {object} [options]
+ * @param {(operation: string, payload: any, options: any) => Promise<boolean>} [options.auth]
+ *   Optional callback to authorize each request. Receives the operation name,
+ *   decoded payload, and the filtered options. Return `true` to allow, `false`
+ *   (or a rejected promise) to reject with 401.
+ * @param {string[]} [options.allowedOptions]
+ *   Allowlist of option keys that clients are permitted to pass through to
+ *   `store.call` and the `auth` callback. Any key not in this list is stripped
+ *   from the client-supplied options before use. Defaults to `[]` (strip all).
  * @returns
  */
-export default function server(store: GraffyStore, { auth }?: {
+export default function server(store: GraffyStore, { auth, allowedOptions }?: {
     auth?: (operation: string, payload: any, options: any) => Promise<boolean>;
-} | undefined): (req: any, res: any) => Promise<void>;
+    allowedOptions?: string[];
+}): (req: any, res: any) => Promise<void>;
 export type GraffyStore = import("@graffy/core").default;

package/types/wsServer.d.ts

@@ -1,12 +1,19 @@
 /**
  * @typedef {import('@graffy/core').default} GraffyStore
  * @param {GraffyStore} store
- * @param {{
- *   auth?: (operation: string, payload: any, options: any) => Promise<boolean>
- * } | undefined} options
+ * @param {object} [options]
+ * @param {(operation: string, payload: any, options: any) => Promise<boolean>} [options.auth]
+ *   Optional callback to authorize each request. Receives the operation name,
+ *   decoded payload, and the filtered options. Return `true` to allow, `false`
+ *   (or a rejected promise) to reject with an error response.
+ * @param {string[]} [options.allowedOptions]
+ *   Allowlist of option keys that clients are permitted to pass through to
+ *   `store.call` and the `auth` callback. Any key not in this list is stripped
+ *   from the client-supplied options before use. Defaults to `[]` (strip all).
  * @returns
  */
-export default function server(store: GraffyStore, { auth }?: {
+export default function server(store: GraffyStore, { auth, allowedOptions }?: {
     auth?: (operation: string, payload: any, options: any) => Promise<boolean>;
-} | undefined): (request: any, socket: any, head: any) => Promise<void>;
+    allowedOptions?: string[];
+}): (request: any, socket: any, head: any) => Promise<void>;
 export type GraffyStore = import("@graffy/core").default;