@pluv/platform-pluv 2.2.7 → 2.3.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/platform-pluv@2.2.7 build /home/runner/work/pluv/pluv/packages/platform-pluv
+> @pluv/platform-pluv@2.3.0 build /home/runner/work/pluv/pluv/packages/platform-pluv
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-CJS dist/index.js 14.82 KB
-CJS ⚡️ Build success in 137ms
-ESM dist/index.mjs 12.99 KB
-ESM ⚡️ Build success in 141ms
+CJS dist/index.js 16.82 KB
+CJS ⚡️ Build success in 64ms
+ESM dist/index.mjs 14.98 KB
+ESM ⚡️ Build success in 65ms
 DTS Build start
-DTS ⚡️ Build success in 7116ms
+DTS ⚡️ Build success in 6964ms
 DTS dist/index.d.mts 3.79 KB
 DTS dist/index.d.ts  3.79 KB

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @pluv/platform-pluv
 
+## 2.3.0
+
+### Minor Changes
+
+- e48e5d8: Added webhook debug logging.
+
+### Patch Changes
+
+- @pluv/crdt@2.3.0
+- @pluv/io@2.3.0
+- @pluv/types@2.3.0
+
+## 2.2.8
+
+### Patch Changes
+
+- b60ccd8: Fix `PluvServer` fetch config validation.
+- Updated dependencies [b60ccd8]
+    - @pluv/io@2.2.8
+    - @pluv/crdt@2.2.8
+    - @pluv/types@2.2.8
+
 ## 2.2.7
 
 ### Patch Changes

package/dist/index.js

@@ -270,46 +270,89 @@ var PluvPlatform = class extends import_io.AbstractPlatform {
       return token;
     });
     this._webhooksRouter = new import_hono.Hono().basePath("/").post("/", (c) => __async(this, null, function* () {
-      var _a, _b, _c, _d, _e, _f, _g;
+      var _a, _b, _c, _d, _e, _f, _g, _h;
       const [algorithm, signature] = (_b = (_a = c.req.header(SIGNATURE_HEADER)) == null ? void 0 : _a.split("=")) != null ? _b : [];
       try {
-        if (!this._webhookSecret) throw new HttpError("Unauthorized", 401);
-        if (algorithm !== SIGNATURE_ALGORITHM) throw new HttpError("Unauthorized", 401);
-        if (!signature) throw new HttpError("Unauthorized", 401);
+        if (!this._webhookSecret) {
+          this._logDebug("Missing webhook secret");
+          throw new HttpError("Unauthorized", 401);
+        }
+        if (algorithm !== SIGNATURE_ALGORITHM) {
+          this._logDebug(
+            `Verification algorithm is not ${SIGNATURE_ALGORITHM}. Found: `,
+            algorithm
+          );
+          throw new HttpError("Unauthorized", 401);
+        }
+        if (!signature) {
+          this._logDebug("Missing webhook signature");
+          throw new HttpError("Unauthorized", 401);
+        }
         const [payload, webhookSecret] = yield Promise.all([
           c.req.json(),
           typeof this._webhookSecret === "string" ? this._webhookSecret : yield this._webhookSecret()
-        ]);
+        ]).catch((error) => {
+          this._logDebug(
+            "Could not derive webhook secret: ",
+            error instanceof Error ? error.message : "Unexpected error"
+          );
+          throw error;
+        });
         const verified = yield verifyWebhook({
           payload: (0, import_fast_json_stable_stringify.default)(payload),
           signature,
           secret: webhookSecret
+        }).catch((error) => {
+          this._logDebug(
+            "Error while verifying webhook: ",
+            error instanceof Error ? error.message : "Unexpected error"
+          );
+          return false;
         });
-        if (!verified) throw new HttpError("Unauthorized", 401);
+        if (!verified) {
+          this._logDebug("Failed to verify webhook");
+          throw new HttpError("Unauthorized", 401);
+        }
         const parsed = ZodEvent.safeParse(payload);
-        if (!parsed.success) throw new HttpError("Invalid request", 400);
+        if (!parsed.success) {
+          this._logDebug(
+            "Failed to validate event payload:",
+            JSON.stringify((_c = parsed.data) != null ? _c : {}, null, 4)
+          );
+          throw new HttpError("Invalid request", 400);
+        }
         const { event, data } = parsed.data;
         const context = this._getContext();
         switch (event) {
           case "initial-storage": {
             const room = data.room;
-            const storage = typeof room === "string" ? (_d = yield (_c = this._getInitialStorage) == null ? void 0 : _c.call(this, { context, room })) != null ? _d : null : null;
-            return createSuccessResponse(c, { event, room, storage });
+            const storage = typeof room === "string" ? (_e = yield (_d = this._getInitialStorage) == null ? void 0 : _d.call(this, { context, room })) != null ? _e : null : null;
+            try {
+              return createSuccessResponse(c, { event, room, storage });
+            } catch (error) {
+              this._logDebug("Could not create getInitialStorage response");
+              throw error;
+            }
           }
           case "room-deleted": {
             const room = data.room;
             const encodedState = data.storage;
             yield Promise.resolve(
-              (_e = this._listeners) == null ? void 0 : _e.onRoomDeleted({ context, encodedState, room })
+              (_f = this._listeners) == null ? void 0 : _f.onRoomDeleted({ context, encodedState, room })
             );
-            return createSuccessResponse(c, { event, room });
+            try {
+              return createSuccessResponse(c, { event, room });
+            } catch (error) {
+              this._logDebug("Could not create onRoomDeleted response");
+              throw error;
+            }
           }
           case "user-connected": {
             const room = data.room;
             const encodedState = data.storage;
             const user = data.user;
             yield Promise.resolve(
-              (_f = this._listeners) == null ? void 0 : _f.onUserConnected({
+              (_g = this._listeners) == null ? void 0 : _g.onUserConnected({
                 context,
                 encodedState,
                 platform: this,
@@ -317,14 +360,19 @@ var PluvPlatform = class extends import_io.AbstractPlatform {
                 user
               })
             );
-            return createSuccessResponse(c, { event, room });
+            try {
+              return createSuccessResponse(c, { event, room });
+            } catch (error) {
+              this._logDebug("Could not create onUserConnected response");
+              throw error;
+            }
           }
           case "user-disconnected": {
             const room = data.room;
             const encodedState = data.storage;
             const user = data.user;
             yield Promise.resolve(
-              (_g = this._listeners) == null ? void 0 : _g.onUserDisconnected({
+              (_h = this._listeners) == null ? void 0 : _h.onUserDisconnected({
                 context,
                 encodedState,
                 platform: this,
@@ -332,7 +380,12 @@ var PluvPlatform = class extends import_io.AbstractPlatform {
                 user
               })
             );
-            return createSuccessResponse(c, { event, room });
+            try {
+              return createSuccessResponse(c, { event, room });
+            } catch (error) {
+              this._logDebug("Could not create onUserDisconnected response");
+              throw error;
+            }
           }
           default: {
             throw new HttpError("Unknown event", 400);
@@ -388,12 +441,19 @@ var PluvPlatform = class extends import_io.AbstractPlatform {
     throw new Error("Not implemented");
   }
   validateConfig(config) {
-    if (!config.authorize)
+    this._logDebug("validating config with properties:", Object.keys(config != null ? config : {}));
+    if (!config.authorize) {
+      this._logDebug("Config `authorize` must be provided to `platformPluv`");
       throw new Error("Config `authorize` must be provided to `platformPluv`");
-    if (!!config.onRoomMessage)
+    }
+    if (!!config.onRoomMessage) {
+      this._logDebug("Config `onRoomMessage` is not supported on `platformPluv`");
       throw new Error("Config `onRoomMessage` is not supported on `platformPluv`");
-    if (!!config.onStorageUpdated)
+    }
+    if (!!config.onStorageUpdated) {
+      this._logDebug("Config `onStorageUpdated` is not supported on `platformPluv`");
       throw new Error("Config `onStorageUpdated` is not supported on `platformPluv`");
+    }
     this._getInitialStorage = config.getInitialStorage;
     this._listeners = {
       onRoomDeleted: (event) => {

package/dist/index.mjs

@@ -240,46 +240,89 @@ var PluvPlatform = class extends AbstractPlatform {
       return token;
     });
     this._webhooksRouter = new Hono().basePath("/").post("/", (c) => __async(this, null, function* () {
-      var _a, _b, _c, _d, _e, _f, _g;
+      var _a, _b, _c, _d, _e, _f, _g, _h;
       const [algorithm, signature] = (_b = (_a = c.req.header(SIGNATURE_HEADER)) == null ? void 0 : _a.split("=")) != null ? _b : [];
       try {
-        if (!this._webhookSecret) throw new HttpError("Unauthorized", 401);
-        if (algorithm !== SIGNATURE_ALGORITHM) throw new HttpError("Unauthorized", 401);
-        if (!signature) throw new HttpError("Unauthorized", 401);
+        if (!this._webhookSecret) {
+          this._logDebug("Missing webhook secret");
+          throw new HttpError("Unauthorized", 401);
+        }
+        if (algorithm !== SIGNATURE_ALGORITHM) {
+          this._logDebug(
+            `Verification algorithm is not ${SIGNATURE_ALGORITHM}. Found: `,
+            algorithm
+          );
+          throw new HttpError("Unauthorized", 401);
+        }
+        if (!signature) {
+          this._logDebug("Missing webhook signature");
+          throw new HttpError("Unauthorized", 401);
+        }
         const [payload, webhookSecret] = yield Promise.all([
           c.req.json(),
           typeof this._webhookSecret === "string" ? this._webhookSecret : yield this._webhookSecret()
-        ]);
+        ]).catch((error) => {
+          this._logDebug(
+            "Could not derive webhook secret: ",
+            error instanceof Error ? error.message : "Unexpected error"
+          );
+          throw error;
+        });
         const verified = yield verifyWebhook({
           payload: stringify(payload),
           signature,
           secret: webhookSecret
+        }).catch((error) => {
+          this._logDebug(
+            "Error while verifying webhook: ",
+            error instanceof Error ? error.message : "Unexpected error"
+          );
+          return false;
         });
-        if (!verified) throw new HttpError("Unauthorized", 401);
+        if (!verified) {
+          this._logDebug("Failed to verify webhook");
+          throw new HttpError("Unauthorized", 401);
+        }
         const parsed = ZodEvent.safeParse(payload);
-        if (!parsed.success) throw new HttpError("Invalid request", 400);
+        if (!parsed.success) {
+          this._logDebug(
+            "Failed to validate event payload:",
+            JSON.stringify((_c = parsed.data) != null ? _c : {}, null, 4)
+          );
+          throw new HttpError("Invalid request", 400);
+        }
         const { event, data } = parsed.data;
         const context = this._getContext();
         switch (event) {
           case "initial-storage": {
             const room = data.room;
-            const storage = typeof room === "string" ? (_d = yield (_c = this._getInitialStorage) == null ? void 0 : _c.call(this, { context, room })) != null ? _d : null : null;
-            return createSuccessResponse(c, { event, room, storage });
+            const storage = typeof room === "string" ? (_e = yield (_d = this._getInitialStorage) == null ? void 0 : _d.call(this, { context, room })) != null ? _e : null : null;
+            try {
+              return createSuccessResponse(c, { event, room, storage });
+            } catch (error) {
+              this._logDebug("Could not create getInitialStorage response");
+              throw error;
+            }
           }
           case "room-deleted": {
             const room = data.room;
             const encodedState = data.storage;
             yield Promise.resolve(
-              (_e = this._listeners) == null ? void 0 : _e.onRoomDeleted({ context, encodedState, room })
+              (_f = this._listeners) == null ? void 0 : _f.onRoomDeleted({ context, encodedState, room })
             );
-            return createSuccessResponse(c, { event, room });
+            try {
+              return createSuccessResponse(c, { event, room });
+            } catch (error) {
+              this._logDebug("Could not create onRoomDeleted response");
+              throw error;
+            }
           }
           case "user-connected": {
             const room = data.room;
             const encodedState = data.storage;
             const user = data.user;
             yield Promise.resolve(
-              (_f = this._listeners) == null ? void 0 : _f.onUserConnected({
+              (_g = this._listeners) == null ? void 0 : _g.onUserConnected({
                 context,
                 encodedState,
                 platform: this,
@@ -287,14 +330,19 @@ var PluvPlatform = class extends AbstractPlatform {
                 user
               })
             );
-            return createSuccessResponse(c, { event, room });
+            try {
+              return createSuccessResponse(c, { event, room });
+            } catch (error) {
+              this._logDebug("Could not create onUserConnected response");
+              throw error;
+            }
           }
           case "user-disconnected": {
             const room = data.room;
             const encodedState = data.storage;
             const user = data.user;
             yield Promise.resolve(
-              (_g = this._listeners) == null ? void 0 : _g.onUserDisconnected({
+              (_h = this._listeners) == null ? void 0 : _h.onUserDisconnected({
                 context,
                 encodedState,
                 platform: this,
@@ -302,7 +350,12 @@ var PluvPlatform = class extends AbstractPlatform {
                 user
               })
             );
-            return createSuccessResponse(c, { event, room });
+            try {
+              return createSuccessResponse(c, { event, room });
+            } catch (error) {
+              this._logDebug("Could not create onUserDisconnected response");
+              throw error;
+            }
           }
           default: {
             throw new HttpError("Unknown event", 400);
@@ -358,12 +411,19 @@ var PluvPlatform = class extends AbstractPlatform {
     throw new Error("Not implemented");
   }
   validateConfig(config) {
-    if (!config.authorize)
+    this._logDebug("validating config with properties:", Object.keys(config != null ? config : {}));
+    if (!config.authorize) {
+      this._logDebug("Config `authorize` must be provided to `platformPluv`");
       throw new Error("Config `authorize` must be provided to `platformPluv`");
-    if (!!config.onRoomMessage)
+    }
+    if (!!config.onRoomMessage) {
+      this._logDebug("Config `onRoomMessage` is not supported on `platformPluv`");
       throw new Error("Config `onRoomMessage` is not supported on `platformPluv`");
-    if (!!config.onStorageUpdated)
+    }
+    if (!!config.onStorageUpdated) {
+      this._logDebug("Config `onStorageUpdated` is not supported on `platformPluv`");
       throw new Error("Config `onStorageUpdated` is not supported on `platformPluv`");
+    }
     this._getInitialStorage = config.getInitialStorage;
     this._listeners = {
       onRoomDeleted: (event) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/platform-pluv",
-  "version": "2.2.7",
+  "version": "2.3.0",
   "description": "@pluv/io adapter for pluv.io",
   "author": "leedavidcs",
   "license": "MIT",
@@ -21,16 +21,16 @@
     "fast-json-stable-stringify": "^2.1.0",
     "hono": "^4.7.10",
     "zod": "^3.25.17",
-    "@pluv/crdt": "^2.2.7",
-    "@pluv/io": "^2.2.7",
-    "@pluv/types": "^2.2.7"
+    "@pluv/types": "^2.3.0",
+    "@pluv/crdt": "^2.3.0",
+    "@pluv/io": "^2.3.0"
   },
   "devDependencies": {
     "eslint": "^9.27.0",
     "tsup": "^8.5.0",
     "typescript": "^5.8.3",
-    "@pluv/tsconfig": "^2.2.7",
-    "eslint-config-pluv": "^2.2.7"
+    "@pluv/tsconfig": "^2.3.0",
+    "eslint-config-pluv": "^2.3.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/PluvPlatform.ts

@@ -199,12 +199,20 @@ export class PluvPlatform<
     }
 
     public validateConfig(config: any): void {
-        if (!config.authorize)
+        this._logDebug("validating config with properties:", Object.keys(config ?? {}));
+
+        if (!config.authorize) {
+            this._logDebug("Config `authorize` must be provided to `platformPluv`");
             throw new Error("Config `authorize` must be provided to `platformPluv`");
-        if (!!config.onRoomMessage)
+        }
+        if (!!config.onRoomMessage) {
+            this._logDebug("Config `onRoomMessage` is not supported on `platformPluv`");
             throw new Error("Config `onRoomMessage` is not supported on `platformPluv`");
-        if (!!config.onStorageUpdated)
+        }
+        if (!!config.onStorageUpdated) {
+            this._logDebug("Config `onStorageUpdated` is not supported on `platformPluv`");
             throw new Error("Config `onStorageUpdated` is not supported on `platformPluv`");
+        }
 
         this._getInitialStorage = config.getInitialStorage;
         this._listeners = {
@@ -220,28 +228,62 @@ export class PluvPlatform<
             const [algorithm, signature] = c.req.header(SIGNATURE_HEADER)?.split("=") ?? [];
 
             try {
-                if (!this._webhookSecret) throw new HttpError("Unauthorized", 401);
-                if (algorithm !== SIGNATURE_ALGORITHM) throw new HttpError("Unauthorized", 401);
-                if (!signature) throw new HttpError("Unauthorized", 401);
+                if (!this._webhookSecret) {
+                    this._logDebug("Missing webhook secret");
+                    throw new HttpError("Unauthorized", 401);
+                }
+                if (algorithm !== SIGNATURE_ALGORITHM) {
+                    this._logDebug(
+                        `Verification algorithm is not ${SIGNATURE_ALGORITHM}. Found: `,
+                        algorithm,
+                    );
+                    throw new HttpError("Unauthorized", 401);
+                }
+                if (!signature) {
+                    this._logDebug("Missing webhook signature");
+                    throw new HttpError("Unauthorized", 401);
+                }
 
                 const [payload, webhookSecret] = await Promise.all([
                     c.req.json(),
                     typeof this._webhookSecret === "string"
                         ? this._webhookSecret
                         : await this._webhookSecret(),
-                ]);
+                ]).catch((error) => {
+                    this._logDebug(
+                        "Could not derive webhook secret: ",
+                        error instanceof Error ? error.message : "Unexpected error",
+                    );
+                    throw error;
+                });
 
                 const verified = await verifyWebhook({
                     payload: stringify(payload),
                     signature,
                     secret: webhookSecret,
+                }).catch((error) => {
+                    this._logDebug(
+                        "Error while verifying webhook: ",
+                        error instanceof Error ? error.message : "Unexpected error",
+                    );
+
+                    return false;
                 });
 
-                if (!verified) throw new HttpError("Unauthorized", 401);
+                if (!verified) {
+                    this._logDebug("Failed to verify webhook");
+                    throw new HttpError("Unauthorized", 401);
+                }
 
                 const parsed = ZodEvent.safeParse(payload);
 
-                if (!parsed.success) throw new HttpError("Invalid request", 400);
+                if (!parsed.success) {
+                    this._logDebug(
+                        "Failed to validate event payload:",
+                        JSON.stringify(parsed.data ?? {}, null, 4),
+                    );
+                    throw new HttpError("Invalid request", 400);
+                }
 
                 const { event, data } = parsed.data;
                 const context = this._getContext();
@@ -254,7 +296,12 @@ export class PluvPlatform<
                                 ? ((await this._getInitialStorage?.({ context, room })) ?? null)
                                 : null;
 
-                        return createSuccessResponse(c, { event, room, storage });
+                        try {
+                            return createSuccessResponse(c, { event, room, storage });
+                        } catch (error) {
+                            this._logDebug("Could not create getInitialStorage response");
+                            throw error;
+                        }
                     }
                     case "room-deleted": {
                         const room = data.room;
@@ -264,7 +311,12 @@ export class PluvPlatform<
                             this._listeners?.onRoomDeleted({ context, encodedState, room }),
                         );
 
-                        return createSuccessResponse(c, { event, room });
+                        try {
+                            return createSuccessResponse(c, { event, room });
+                        } catch (error) {
+                            this._logDebug("Could not create onRoomDeleted response");
+                            throw error;
+                        }
                     }
                     case "user-connected": {
                         const room = data.room;
@@ -281,7 +333,12 @@ export class PluvPlatform<
                             }),
                         );
 
-                        return createSuccessResponse(c, { event, room });
+                        try {
+                            return createSuccessResponse(c, { event, room });
+                        } catch (error) {
+                            this._logDebug("Could not create onUserConnected response");
+                            throw error;
+                        }
                     }
                     case "user-disconnected": {
                         const room = data.room;
@@ -298,7 +355,12 @@ export class PluvPlatform<
                             }),
                         );
 
-                        return createSuccessResponse(c, { event, room });
+                        try {
+                            return createSuccessResponse(c, { event, room });
+                        } catch (error) {
+                            this._logDebug("Could not create onUserDisconnected response");
+                            throw error;
+                        }
                     }
                     default: {
                         throw new HttpError("Unknown event", 400);