easy-ping 0.8.1 → 0.10.0

package/dist/dialect-CvBJSydR.d.cts

@@ -0,0 +1,10 @@
+type Row = Record<string, unknown>;
+type SqlResult = {
+    rows: readonly Row[];
+    /** Rows an INSERT/UPDATE/DELETE touched; drivers without RETURNING report through this. */
+    affectedRows: number;
+};
+/** The whole driver contract for the MySQL and SQLite adapters. */
+type SqlExec = (text: string, params: readonly unknown[]) => Promise<SqlResult>;
+
+export type { SqlExec as S, SqlResult as a };

package/dist/dialect-CvBJSydR.d.ts

@@ -0,0 +1,10 @@
+type Row = Record<string, unknown>;
+type SqlResult = {
+    rows: readonly Row[];
+    /** Rows an INSERT/UPDATE/DELETE touched; drivers without RETURNING report through this. */
+    affectedRows: number;
+};
+/** The whole driver contract for the MySQL and SQLite adapters. */
+type SqlExec = (text: string, params: readonly unknown[]) => Promise<SqlResult>;
+
+export type { SqlExec as S, SqlResult as a };

package/dist/index.cjs

@@ -209,6 +209,7 @@ function createScopedSigner(secret, pluginId, purposes, onViolation) {
 var STREAM_HIGH_WATER_MARK = 256;
 var MAX_BODY_BYTES = 64 * 1024;
 var MAX_READ_IDS = 200;
+var SESSION_ERROR = /* @__PURE__ */ Symbol("session-error");
 var PRIVATE_HEADERS = {
   "cache-control": "private, no-store",
   "x-content-type-options": "nosniff"
@@ -308,13 +309,26 @@ function csrfCheck(request, url, trusted) {
 function createHandler(deps) {
   const trustedOrigins = deps.trustedOrigins ?? [];
   const maxBodyBytes = deps.maxBodyBytes ?? MAX_BODY_BYTES;
+  let warnedBadUserId = false;
   async function resolveUserId(request) {
+    let id;
     try {
-      return await deps.session.getUserId(request);
+      id = await deps.session.getUserId(request);
     } catch (error) {
       deps.logger.error("session.getUserId threw", { error });
-      return "error";
+      return SESSION_ERROR;
     }
+    if (id === null || id === void 0) return null;
+    if (typeof id !== "string" || id === "") {
+      if (!warnedBadUserId) {
+        warnedBadUserId = true;
+        deps.logger.warn(
+          `session.getUserId returned ${id === "" ? "an empty string" : typeof id}; treating the request as unauthenticated. Return a non-empty string or null.`
+        );
+      }
+      return null;
+    }
+    return id;
   }
   async function bearerMatches(request, secret) {
     if (!secret) return false;
@@ -337,7 +351,7 @@ function createHandler(deps) {
         if (rejected) return rejected;
       }
       const userId = await resolveUserId(request);
-      if (userId === "error") return empty(500);
+      if (userId === SESSION_ERROR) return empty(500);
       if (userId === null) return empty(401);
       return harden(await route2.handler({ request, userId, claims: null, params: {} }));
     }
@@ -378,7 +392,7 @@ function createHandler(deps) {
       if (rejected) return rejected;
     }
     const userId = await resolveUserId(request);
-    if (userId === "error") return empty(500);
+    if (userId === SESSION_ERROR) return empty(500);
     if (userId === null) return empty(401);
     if (request.method === "GET" && path === "/events") {
       if (!deps.events) return empty(404);
@@ -582,12 +596,23 @@ var ESCAPES = {
 var escapeHtml = (value) => String(value ?? "").replace(/[&<>"']/g, (char) => ESCAPES[char] ?? char);
 
 // src/core/rate-limit.ts
+var UNKEYED = "\0unkeyed";
 var clientAddress = (request) => {
   const headers = request.headers;
   return headers.get("cf-connecting-ip") ?? headers.get("x-real-ip") ?? headers.get("x-forwarded-for")?.split(",")[0]?.trim() ?? null;
 };
 function createRateLimiter(config) {
-  const keyOf = config.key ?? clientAddress;
+  let warned = false;
+  const keyOf = config.key ?? ((request) => {
+    const address = clientAddress(request);
+    if (address !== null) return address;
+    if (!warned) {
+      warned = true;
+      config.onUnkeyed?.();
+    }
+    return UNKEYED;
+  });
+  const maxKeys = Math.max(1, config.maxKeys ?? 1e4);
   const buckets = /* @__PURE__ */ new Map();
   let lastSweep = 0;
   return (request) => {
@@ -600,7 +625,12 @@ function createRateLimiter(config) {
     }
     let bucket = buckets.get(key);
     if (!bucket || bucket.resetAt <= now) {
+      if (!bucket && buckets.size >= maxKeys) {
+        const oldest = buckets.keys().next().value;
+        if (oldest !== void 0) buckets.delete(oldest);
+      }
       bucket = { count: 0, resetAt: now + config.windowMs };
+      buckets.delete(key);
       buckets.set(key, bucket);
     }
     bucket.count += 1;
@@ -1095,6 +1125,22 @@ function createPluginStore(pluginId, schema, storage, prefix) {
     }
     return declaration;
   }
+  function writable(table) {
+    const declaration = resolve(table);
+    if (declaration.readOnly) {
+      throw new ConfigError(
+        `plugin "${pluginId}" tried to write "${table}", which it declares readOnly.`
+      );
+    }
+    return declaration;
+  }
+  function notEverything(table, where, action) {
+    if (Object.keys(where).length === 0) {
+      throw new ConfigError(
+        `plugin "${pluginId}" called ${action}("${table}", {}), which would touch every row. Pass a condition.`
+      );
+    }
+  }
   function checkFields(table, fields, context) {
     for (const field of fields) {
       const spec = Object.hasOwn(table.fields, field) ? table.fields[field] : void 0;
@@ -1153,7 +1199,7 @@ function createPluginStore(pluginId, schema, storage, prefix) {
       });
     },
     async insert(table, rows) {
-      const declaration = resolve(table);
+      const declaration = writable(table);
       for (const row of rows) checkRow(declaration, row, "insert");
       return storage.insertRows(
         qualified(declaration),
@@ -1161,7 +1207,7 @@ function createPluginStore(pluginId, schema, storage, prefix) {
       );
     },
     async upsert(table, rows, options) {
-      const declaration = resolve(table);
+      const declaration = writable(table);
       for (const row of rows) checkRow(declaration, row, "upsert");
       checkFields(declaration, options.onConflict, "onConflict");
       return storage.insertRows(
@@ -1171,14 +1217,16 @@ function createPluginStore(pluginId, schema, storage, prefix) {
       );
     },
     async update(table, where, set) {
-      const declaration = resolve(table);
+      const declaration = writable(table);
       checkWhere(declaration, where);
+      notEverything(table, where, "update");
       checkRow(declaration, set, "update");
       return storage.updateRows(qualified(declaration), where, serialize(declaration, set));
     },
     async remove(table, where) {
-      const declaration = resolve(table);
+      const declaration = writable(table);
       checkWhere(declaration, where);
+      notEverything(table, where, "remove");
       return storage.deleteRows(qualified(declaration), where);
     }
   };
@@ -1257,7 +1305,18 @@ function validate(config, plugins) {
       }
     }
   }
+  const core = new Set(CORE_ROUTES.map((route) => `${route.method} ${route.path}`));
   const routes = /* @__PURE__ */ new Set();
+  for (const plugin of plugins) {
+    for (const route of plugin.routes ?? []) {
+      const signature = `${route.method} ${route.path}`;
+      if (core.has(signature)) {
+        throw new ConfigError(
+          `plugin "${plugin.id}" registers "${signature}", which is a core route. Pick another path.`
+        );
+      }
+    }
+  }
   for (const plugin of plugins) {
     for (const route of plugin.routes ?? []) {
       const signature = `${route.method} ${route.path}`;
@@ -1374,7 +1433,12 @@ function easyPing(config) {
     trustedOrigins: config.trustedOrigins,
     onRequest: config.onRequest,
     maxBodyBytes: config.maxBodyBytes,
-    rateLimit: config.rateLimit ? createRateLimiter(config.rateLimit) : void 0,
+    rateLimit: config.rateLimit ? createRateLimiter({
+      onUnkeyed: () => logger.warn(
+        "rateLimit: a request arrived with no cf-connecting-ip, x-real-ip or x-forwarded-for header, so every such request shares one bucket. Put the app behind a proxy that sets one of them, or pass rateLimit.key (a session or API key)."
+      ),
+      ...config.rateLimit
+    }) : void 0,
     cronMaxSweeps: config.cron?.maxSweeps,
     ...config.cron?.secret ? { cronSecret: config.cron.secret } : {},
     ...config.machineSecret ?? config.cron?.secret ? { machineSecret: config.machineSecret ?? config.cron?.secret } : {}