Merge pull request #57 from ESP32Async/fix/allocation

mathieucarbou · web-flow · commit 7a42cb2b1597 · 2025-02-06T13:15:24.000+01:00
fix(mem): allocation checks and request abort on failed allocation
diff --git a/examples/Auth/Auth.ino b/examples/Auth/Auth.ino
@@ -152,4 +152,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/CORS/CORS.ino b/examples/CORS/CORS.ino
@@ -55,4 +55,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/CatchAllHandler/CatchAllHandler.ino b/examples/CatchAllHandler/CatchAllHandler.ino
@@ -128,4 +128,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/ChunkResponse/ChunkResponse.ino b/examples/ChunkResponse/ChunkResponse.ino
@@ -135,4 +135,6 @@ void setup() {
   server.begin();
 }
 
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/EndBegin/EndBegin.ino b/examples/EndBegin/EndBegin.ino
@@ -44,4 +44,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/Filters/Filters.ino b/examples/Filters/Filters.ino
@@ -131,4 +131,6 @@ void setup() {
   // ESP.restart();
 }
 
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/FlashResponse/FlashResponse.ino b/examples/FlashResponse/FlashResponse.ino
@@ -102,4 +102,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/HeaderManipulation/HeaderManipulation.ino b/examples/HeaderManipulation/HeaderManipulation.ino
@@ -83,4 +83,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/Json/Json.ino b/examples/Json/Json.ino
@@ -85,4 +85,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/Logging/Logging.ino b/examples/Logging/Logging.ino
@@ -44,4 +44,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/MessagePack/MessagePack.ino b/examples/MessagePack/MessagePack.ino
@@ -83,4 +83,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/Middleware/Middleware.ino b/examples/Middleware/Middleware.ino
@@ -77,4 +77,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/Params/Params.ino b/examples/Params/Params.ino
@@ -117,4 +117,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/RateLimit/RateLimit.ino b/examples/RateLimit/RateLimit.ino
@@ -59,4 +59,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/Redirect/Redirect.ino b/examples/Redirect/Redirect.ino
@@ -43,4 +43,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/ResumableDownload/ResumableDownload.ino b/examples/ResumableDownload/ResumableDownload.ino
@@ -56,4 +56,6 @@ void setup() {
   server.begin();
 }
 
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/Rewrite/Rewrite.ino b/examples/Rewrite/Rewrite.ino
@@ -47,4 +47,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/SkipServerMiddleware/SkipServerMiddleware.ino b/examples/SkipServerMiddleware/SkipServerMiddleware.ino
@@ -68,4 +68,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/StaticFile/StaticFile.ino b/examples/StaticFile/StaticFile.ino
@@ -117,4 +117,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/examples/Templates/Templates.ino b/examples/Templates/Templates.ino
@@ -94,4 +94,6 @@ void setup() {
 }
 
 // not needed
-void loop() {}
+void loop() {
+  delay(100);
+}
diff --git a/src/AsyncEventSource.cpp b/src/AsyncEventSource.cpp
@@ -26,7 +26,7 @@ static String generateEventMessage(const char *message, const char *event, uint3
 
   if (!str.reserve(len)) {
 #ifdef ESP32
-    log_e("Failed to allocate buffer");
+    log_e("Failed to allocate");
 #endif
     return emptyString;
   }
diff --git a/src/AsyncJson.cpp b/src/AsyncJson.cpp
@@ -152,8 +152,9 @@ void AsyncCallbackJsonWebHandler::handleBody(AsyncWebServerRequest *request, uin
       request->_tempObject = malloc(total);
       if (request->_tempObject == NULL) {
 #ifdef ESP32
-        log_e("Failed to allocate buffer");
+        log_e("Failed to allocate");
 #endif
+        request->abort();
         return;
       }
     }
diff --git a/src/AsyncMessagePack.cpp b/src/AsyncMessagePack.cpp
@@ -104,8 +104,9 @@ void AsyncCallbackMessagePackWebHandler::handleBody(AsyncWebServerRequest *reque
       request->_tempObject = malloc(total);
       if (request->_tempObject == NULL) {
 #ifdef ESP32
-        log_e("Failed to allocate buffer");
+        log_e("Failed to allocate");
 #endif
+        request->abort();
         return;
       }
     }
diff --git a/src/AsyncWebHeader.cpp b/src/AsyncWebHeader.cpp
@@ -25,7 +25,7 @@ String AsyncWebHeader::toString() const {
     str.concat(asyncsrv::T_rn);
   } else {
 #ifdef ESP32
-    log_e("Failed to allocate buffer");
+    log_e("Failed to allocate");
 #endif
   }
   return str;
diff --git a/src/AsyncWebSocket.cpp b/src/AsyncWebSocket.cpp
@@ -67,8 +67,9 @@ size_t webSocketSendFrame(AsyncClient *client, bool final, uint8_t opcode, bool
   uint8_t *buf = (uint8_t *)malloc(headLen);
   if (buf == NULL) {
 #ifdef ESP32
-    log_e("Failed to allocate buffer");
+    log_e("Failed to allocate");
 #endif
+    client->abort();
     return 0;
   }
 
@@ -170,7 +171,7 @@ class AsyncWebSocketControl {
 
       if (_data == NULL) {
 #ifdef ESP32
-        log_e("Failed to allocate buffer");
+        log_e("Failed to allocate");
 #endif
         _len = 0;
       } else {
@@ -522,7 +523,8 @@ void AsyncWebSocketClient::close(uint16_t code, const char *message) {
       return;
     } else {
 #ifdef ESP32
-      log_e("Failed to allocate buffer");
+      log_e("Failed to allocate");
+      _client->abort();
 #endif
     }
   }
@@ -1252,6 +1254,13 @@ void AsyncWebSocket::handleRequest(AsyncWebServerRequest *request) {
   }
   const AsyncWebHeader *key = request->getHeader(WS_STR_KEY);
   AsyncWebServerResponse *response = new AsyncWebSocketResponse(key->value(), this);
+  if (response == NULL) {
+#ifdef ESP32
+    log_e("Failed to allocate");
+#endif
+    request->abort();
+    return;
+  }
   if (request->hasHeader(WS_STR_PROTOCOL)) {
     const AsyncWebHeader *protocol = request->getHeader(WS_STR_PROTOCOL);
     // ToDo: check protocol
@@ -1261,23 +1270,11 @@ void AsyncWebSocket::handleRequest(AsyncWebServerRequest *request) {
 }
 
 AsyncWebSocketMessageBuffer *AsyncWebSocket::makeBuffer(size_t size) {
-  AsyncWebSocketMessageBuffer *buffer = new AsyncWebSocketMessageBuffer(size);
-  if (buffer->length() != size) {
-    delete buffer;
-    return nullptr;
-  } else {
-    return buffer;
-  }
+  return new AsyncWebSocketMessageBuffer(size);
 }
 
 AsyncWebSocketMessageBuffer *AsyncWebSocket::makeBuffer(const uint8_t *data, size_t size) {
-  AsyncWebSocketMessageBuffer *buffer = new AsyncWebSocketMessageBuffer(data, size);
-  if (buffer->length() != size) {
-    delete buffer;
-    return nullptr;
-  } else {
-    return buffer;
-  }
+  return new AsyncWebSocketMessageBuffer(data, size);
 }
 
 /*
@@ -1298,7 +1295,7 @@ AsyncWebSocketResponse::AsyncWebSocketResponse(const String &key, AsyncWebSocket
 #else
   String k;
   if (!k.reserve(key.length() + WS_STR_UUID_LEN)) {
-    log_e("Failed to allocate buffer");
+    log_e("Failed to allocate");
     return;
   }
   k.concat(key);
diff --git a/src/ESPAsyncWebServer.h b/src/ESPAsyncWebServer.h
@@ -218,7 +218,7 @@ class AsyncWebServerRequest {
 
   std::list<AsyncWebHeader> _headers;
   std::list<AsyncWebParameter> _params;
-  std::vector<String> _pathParams;
+  std::list<String> _pathParams;
 
   std::unordered_map<const char *, String, std::hash<const char *>, std::equal_to<const char *>> _attributes;
 
@@ -790,13 +790,13 @@ class AsyncHeaderFreeMiddleware : public AsyncMiddleware {
     _toKeep.push_back(name);
   }
   void unKeep(const char *name) {
-    _toKeep.erase(std::remove(_toKeep.begin(), _toKeep.end(), name), _toKeep.end());
+    _toKeep.remove(name);
   }
 
   void run(AsyncWebServerRequest *request, ArMiddlewareNext next);
 
 private:
-  std::vector<const char *> _toKeep;
+  std::list<const char *> _toKeep;
 };
 
 // filter out specific headers from the incoming request
@@ -806,13 +806,13 @@ class AsyncHeaderFilterMiddleware : public AsyncMiddleware {
     _toRemove.push_back(name);
   }
   void unFilter(const char *name) {
-    _toRemove.erase(std::remove(_toRemove.begin(), _toRemove.end(), name), _toRemove.end());
+    _toRemove.remove(name);
   }
 
   void run(AsyncWebServerRequest *request, ArMiddlewareNext next);
 
 private:
-  std::vector<const char *> _toRemove;
+  std::list<const char *> _toRemove;
 };
 
 // curl-like logging of incoming requests
diff --git a/src/Middleware.cpp b/src/Middleware.cpp
@@ -140,20 +140,22 @@ void AsyncAuthenticationMiddleware::run(AsyncWebServerRequest *request, ArMiddle
 }
 
 void AsyncHeaderFreeMiddleware::run(AsyncWebServerRequest *request, ArMiddlewareNext next) {
-  std::vector<const char *> reqHeaders;
-  request->getHeaderNames(reqHeaders);
-  for (const char *h : reqHeaders) {
+  std::list<const char *> toRemove;
+  for (auto &h : request->getHeaders()) {
     bool keep = false;
     for (const char *k : _toKeep) {
-      if (strcasecmp(h, k) == 0) {
+      if (strcasecmp(h.name().c_str(), k) == 0) {
         keep = true;
         break;
       }
     }
     if (!keep) {
-      request->removeHeader(h);
+      toRemove.push_back(h.name().c_str());
     }
   }
+  for (const char *h : toRemove) {
+    request->removeHeader(h);
+  }
   next();
 }
 
diff --git a/src/WebAuthentication.cpp b/src/WebAuthentication.cpp
@@ -87,7 +87,7 @@ String genRandomMD5() {
   char *out = (char *)malloc(33);
   if (out == NULL || !getMD5((uint8_t *)(&r), 4, out)) {
 #ifdef ESP32
-    log_e("Failed to allocate buffer");
+    log_e("Failed to allocate");
 #endif
     return emptyString;
   }
@@ -100,7 +100,7 @@ static String stringMD5(const String &in) {
   char *out = (char *)malloc(33);
   if (out == NULL || !getMD5((uint8_t *)(in.c_str()), in.length(), out)) {
 #ifdef ESP32
-    log_e("Failed to allocate buffer");
+    log_e("Failed to allocate");
 #endif
     return emptyString;
   }
@@ -116,15 +116,15 @@ String generateDigestHash(const char *username, const char *password, const char
   char *out = (char *)malloc(33);
   if (out == NULL) {
 #ifdef ESP32
-    log_e("Failed to allocate buffer");
+    log_e("Failed to allocate");
 #endif
     return emptyString;
   }
 
   String in;
   if (!in.reserve(strlen(username) + strlen(realm) + strlen(password) + 2)) {
 #ifdef ESP32
-    log_e("Failed to allocate buffer");
+    log_e("Failed to allocate");
 #endif
     free(out);
     return emptyString;
@@ -138,7 +138,7 @@ String generateDigestHash(const char *username, const char *password, const char
 
   if (!getMD5((uint8_t *)(in.c_str()), in.length(), out)) {
 #ifdef ESP32
-    log_e("Failed to allocate buffer");
+    log_e("Failed to allocate");
 #endif
     free(out);
     return emptyString;
diff --git a/src/WebHandlers.cpp b/src/WebHandlers.cpp
diff --git a/src/WebRequest.cpp b/src/WebRequest.cpp
diff --git a/src/WebResponses.cpp b/src/WebResponses.cpp
diff --git a/src/WebServer.cpp b/src/WebServer.cpp

Original file line number	Diff line number	Diff line change
`@@ -152,4 +152,6 @@ void setup() {`
`152`	`152`	`}`
`153`	`153`
`154`	`154`	`// not needed`
`155`		`-void loop() {}`
	`155`	`+void loop() {`
	`156`	`+ delay(100);`
	`157`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -55,4 +55,6 @@ void setup() {`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`// not needed`
`58`		`-void loop() {}`
	`58`	`+void loop() {`
	`59`	`+ delay(100);`
	`60`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -128,4 +128,6 @@ void setup() {`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`// not needed`
`131`		`-void loop() {}`
	`131`	`+void loop() {`
	`132`	`+ delay(100);`
	`133`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -135,4 +135,6 @@ void setup() {`
`135`	`135`	`server.begin();`
`136`	`136`	`}`
`137`	`137`
`138`		`-void loop() {}`
	`138`	`+void loop() {`
	`139`	`+ delay(100);`
	`140`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -44,4 +44,6 @@ void setup() {`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`// not needed`
`47`		`-void loop() {}`
	`47`	`+void loop() {`
	`48`	`+ delay(100);`
	`49`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -131,4 +131,6 @@ void setup() {`
`131`	`131`	`// ESP.restart();`
`132`	`132`	`}`
`133`	`133`
`134`		`-void loop() {}`
	`134`	`+void loop() {`
	`135`	`+ delay(100);`
	`136`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -102,4 +102,6 @@ void setup() {`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`// not needed`
`105`		`-void loop() {}`
	`105`	`+void loop() {`
	`106`	`+ delay(100);`
	`107`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -83,4 +83,6 @@ void setup() {`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`// not needed`
`86`		`-void loop() {}`
	`86`	`+void loop() {`
	`87`	`+ delay(100);`
	`88`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -85,4 +85,6 @@ void setup() {`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`// not needed`
`88`		`-void loop() {}`
	`88`	`+void loop() {`
	`89`	`+ delay(100);`
	`90`	`+}`