refactor(webserver): Response cleanup

Hypfer · Jun 16, 2022 · 839310a · 839310a
1 parent 6e2d2e1
commit 839310a
Show file tree

Hide file tree

Showing 27 changed files with 37 additions and 40 deletions.
diff --git a/backend/lib/robots/MiioValetudoRobot.js b/backend/lib/robots/MiioValetudoRobot.js
@@ -302,7 +302,7 @@ class MiioValetudoRobot extends ValetudoRobot {
                 .update(JSON.stringify(info))
                 .digest("base64");
 
-            res.status(200).send({
+            res.json({
                 "info": info,
                 "timestamp": req.query["timestamp"],
                 "sign": signature

diff --git a/backend/lib/webserver/NetworkAdvertisementManagerRouter.js b/backend/lib/webserver/NetworkAdvertisementManagerRouter.js
@@ -31,7 +31,7 @@ class NetworkAdvertisementManagerRouter {
 
                 res.sendStatus(200);
             } else {
-                res.status(400).send("invalid request body");
+                res.sendStatus(400);
             }
         });
 

diff --git a/backend/lib/webserver/ValetudoEventRouter.js b/backend/lib/webserver/ValetudoEventRouter.js
@@ -40,12 +40,12 @@ class ValetudoEventRouter {
                     try {
                         await this.valetudoEventStore.interact(event, req.body.interaction);
                     } catch (e) {
-                        return res.status(400).send("Failed to interact with event: " + e?.message);
+                        return res.status(500).send("Failed to interact with event: " + e?.message);
                     }
 
                     res.json(event);
                 } else {
-                    res.status(400).send("Missing or invalid request body");
+                    res.sendStatus(400);
                 }
             } else {
                 res.sendStatus(404);

diff --git a/backend/lib/webserver/ValetudoRouter.js b/backend/lib/webserver/ValetudoRouter.js
@@ -117,15 +117,15 @@ class ValetudoRouter {
 
 
                 if (!options.password && (webserverConfig.basicAuth.enabled === false && options.enabled === true)) {
-                    res.status(400).send("Missing password for basic auth enable. Don't lock yourself out!");
+                    res.sendStatus(400);
                 } else {
                     webserverConfig.basicAuth = options;
 
                     this.config.set("webserver", webserverConfig);
                     res.sendStatus(200);
                 }
             } else {
-                res.status(400).send("bad request body");
+                res.sendStatus(400);
             }
 
         });

diff --git a/backend/lib/webserver/WebServer.js b/backend/lib/webserver/WebServer.js
@@ -100,7 +100,7 @@ class WebServer {
             // even if it is not being validated by the schema
             if (req.method === "PUT" || req.method === "POST") {
                 if (Tools.IS_EMPTY_OBJECT_OR_UNDEFINED_OR_NULL(req.body)) {
-                    res.status(400).send("Missing or empty body");
+                    res.sendStatus(400);
                 } else {
                     next();
                 }

diff --git a/backend/lib/webserver/capabilityRouters/AutoEmptyDockManualTriggerCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/AutoEmptyDockManualTriggerCapabilityRouter.js
@@ -11,7 +11,7 @@ class AutoEmptyDockManualTriggerCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Missing or invalid request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/BasicControlCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/BasicControlCapabilityRouter.js
@@ -28,7 +28,7 @@ class BasicControlCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/CombinedVirtualRestrictionsCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/CombinedVirtualRestrictionsCapabilityRouter.js
@@ -36,7 +36,7 @@ class CombinedVirtualRestrictionsCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Missing virtualWalls or restrictedZones property in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/ConsumableMonitoringCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/ConsumableMonitoringCapabilityRouter.js
@@ -27,7 +27,7 @@ class ConsumableMonitoringCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/DoNotDisturbCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/DoNotDisturbCapabilityRouter.js
@@ -21,7 +21,7 @@ class DoNotDisturbCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Missing parameters in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/GoToLocationCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/GoToLocationCapabilityRouter.js
@@ -14,7 +14,7 @@ class GoToLocationCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/LocateCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/LocateCapabilityRouter.js
@@ -11,7 +11,7 @@ class LocateCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/ManualControlCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/ManualControlCapabilityRouter.js
@@ -39,11 +39,11 @@ class ManualControlCapabilityRouter extends CapabilityRouter {
                             this.sendErrorResponse(req, res, e);
                         }
                     } else {
-                        res.status(400).send("Missing movementCommand in request body");
+                        res.sendStatus(400);
                     }
                     break;
                 default:
-                    res.status(400).send("Invalid action in request body");
+                    res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/MapResetCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/MapResetCapabilityRouter.js
@@ -11,7 +11,7 @@ class MapResetCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/MapSegmentEditCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/MapSegmentEditCapabilityRouter.js
@@ -18,7 +18,7 @@ class MapSegmentEditCapabilityRouter extends CapabilityRouter {
                             this.sendErrorResponse(req, res, e);
                         }
                     } else {
-                        res.status(400).send("Invalid request");
+                        res.sendStatus(400);
                     }
                     break;
                 case "split_segment":
@@ -35,11 +35,11 @@ class MapSegmentEditCapabilityRouter extends CapabilityRouter {
                             this.sendErrorResponse(req, res, e);
                         }
                     } else {
-                        res.status(400).send("Invalid request");
+                        res.sendStatus(400);
                     }
                     break;
                 default:
-                    res.status(400).send("Invalid action in request body");
+                    res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/MapSegmentRenameCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/MapSegmentRenameCapabilityRouter.js
@@ -17,10 +17,10 @@ class MapSegmentRenameCapabilityRouter extends CapabilityRouter {
                         this.sendErrorResponse(req, res, e);
                     }
                 } else {
-                    res.status(400).send("Invalid request");
+                    res.sendStatus(400);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/MapSegmentationCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/MapSegmentationCapabilityRouter.js
@@ -36,10 +36,10 @@ class MapSegmentationCapabilityRouter extends CapabilityRouter {
                         this.sendErrorResponse(req, res, e);
                     }
                 } else {
-                    res.status(400).send("Missing segment_ids");
+                    res.sendStatus(400);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/MapSnapshotCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/MapSnapshotCapabilityRouter.js
@@ -16,7 +16,7 @@ class MapSnapshotCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/MappingPassCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/MappingPassCapabilityRouter.js
@@ -11,7 +11,7 @@ class MappingPassCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/PendingMapChangeHandlingCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/PendingMapChangeHandlingCapabilityRouter.js
@@ -32,7 +32,7 @@ class PendingMapChangeHandlingCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Missing parameters in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/PresetSelectionCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/PresetSelectionCapabilityRouter.js
@@ -19,7 +19,7 @@ class PresetSelectionCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Missing name in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/QuirksCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/QuirksCapabilityRouter.js
@@ -20,7 +20,7 @@ class QuirksCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Missing parameters in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/SpeakerTestCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/SpeakerTestCapabilityRouter.js
@@ -11,7 +11,7 @@ class SpeakerTestCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/SpeakerVolumeControlCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/SpeakerVolumeControlCapabilityRouter.js
@@ -14,11 +14,8 @@ class SpeakerVolumeControlCapabilityRouter extends CapabilityRouter {
 
         this.router.put("/", this.validator, async (req, res) => {
             if (req.body.action === "set_volume") {
-                if (req.body.value === undefined) {
-                    res.status(400).send("Missing value for set_volume");
-                    return;
-                } else if (typeof req.body.value !== "number") {
-                    res.status(400).send("Value for set_volume must be a number");
+                if (typeof req.body.value !== "number") {
+                    res.sendStatus(400);
                     return;
                 }
 
@@ -30,7 +27,7 @@ class SpeakerVolumeControlCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/VoicePackManagementCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/VoicePackManagementCapabilityRouter.js
@@ -26,7 +26,7 @@ class VoicePackManagementCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid request");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/capabilityRouters/ZoneCleaningCapabilityRouter.js b/backend/lib/webserver/capabilityRouters/ZoneCleaningCapabilityRouter.js
@@ -22,7 +22,7 @@ class ZoneCleaningCapabilityRouter extends CapabilityRouter {
                     this.sendErrorResponse(req, res, e);
                 }
             } else {
-                res.status(400).send("Invalid action in request body");
+                res.sendStatus(400);
             }
         });
     }

diff --git a/backend/lib/webserver/doc/ValetudoEventRouter.openapi.json b/backend/lib/webserver/doc/ValetudoEventRouter.openapi.json
@@ -105,8 +105,8 @@
             }
           }
         },
-        "400": {
-          "$ref": "#/components/responses/400"
+        "500": {
+          "$ref": "#/components/responses/500"
         },
         "404": {
           "$ref": "#/components/responses/404"