Arduinojson6 (#8)

* Remove redundant AuthSettingsService. Will re-implement properly soon using JWT.

* Support ArduinoJson >= 6.0.0

* Fix ArduinoJson version to 6.x.x

Author: rjwats

platformio.ini

@@ -23,6 +23,6 @@ build_flags=
 lib_deps =
   https://github.com/PaulStoffregen/Time
   https://github.com/gmag11/NtpClient
-  ArduinoJson@>=5.0.0,<6.0.0
+  ArduinoJson@>=6.0.0,<7.0.0
   https://github.com/me-no-dev/ESPAsyncWebServer
   https://github.com/me-no-dev/AsyncTCP

src/APStatus.cpp

@@ -5,8 +5,8 @@ APStatus::APStatus(AsyncWebServer *server) : _server(server) {
 }
 
 void APStatus::apStatus(AsyncWebServerRequest *request) {
-  AsyncJsonResponse * response = new AsyncJsonResponse();
-  JsonObject& root = response->getRoot();
+  AsyncJsonResponse * response = new AsyncJsonResponse(MAX_AP_STATUS_SIZE);
+  JsonObject root = response->getRoot();
 
   WiFiMode_t currentWiFiMode = WiFi.getMode();
   root["active"] =  (currentWiFiMode == WIFI_AP || currentWiFiMode == WIFI_AP_STA);

src/APStatus.h

@@ -11,9 +11,10 @@
 
 #include <ESPAsyncWebServer.h>
 #include <ArduinoJson.h>
-#include <AsyncJson.h>
+#include <AsyncArduinoJson6.h>
 #include <IPAddress.h>
 
+#define MAX_AP_STATUS_SIZE 1024
 #define AP_STATUS_SERVICE_PATH "/rest/apStatus"
 
 class APStatus {

src/AsyncArduinoJson6.h

@@ -0,0 +1,167 @@
+
+/**
+*  A copy of AsyncJson.h from ESPAsyncWebServer, updated for ArduinoJson6.
+*/
+
+#ifndef ASYNC_ARDUINO_JSON_6_H
+#define ASYNC_ARDUINO_JSON_6_H
+
+#include <ArduinoJson.h>
+#include <WebResponseImpl.h>
+#include <ESPAsyncWebServer.h>
+
+constexpr const char* JSON_MIMETYPE = "application/json";
+
+class ChunkPrint : public Print {
+  private:
+    uint8_t* _destination;
+    size_t _to_skip;
+    size_t _to_write;
+    size_t _pos;
+  public:
+    ChunkPrint(uint8_t* destination, size_t from, size_t len)
+      : _destination(destination), _to_skip(from), _to_write(len), _pos{0} {}
+    virtual ~ChunkPrint(){}
+    size_t write(uint8_t c){
+      if (_to_skip > 0) {
+        _to_skip--;
+        return 1;
+      } else if (_to_write > 0) {
+        _to_write--;
+        _destination[_pos++] = c;
+        return 1;
+      }
+      return 0;
+    }
+    size_t write(const uint8_t *buffer, size_t size) {
+      size_t written = 0;
+      while (written < size && write(buffer[written])) {
+        written++;
+      }
+      return written;
+    }  
+};
+
+class AsyncJsonResponse: public AsyncAbstractResponse {
+  private:
+    DynamicJsonDocument _jsonDocument;
+    bool _isValid;
+    JsonObject _root;    
+
+  public:
+    AsyncJsonResponse(int maxSize): _jsonDocument(maxSize), _isValid{false} {
+      _code = 200;
+      _contentType = JSON_MIMETYPE;
+      _root = _jsonDocument.to<JsonObject>();
+    }
+    ~AsyncJsonResponse() {}    
+    JsonObject getRoot() {
+      return _root;
+    }
+    bool _sourceValid() const {
+      return _isValid; 
+    }
+    size_t setLength() {
+      _contentLength = measureJson(_jsonDocument);
+      if (_contentLength) { _isValid = true; }
+      return _contentLength;
+    }
+    size_t getSize() {
+      return _jsonDocument.size();
+    }
+    size_t _fillBuffer(uint8_t *data, size_t len){
+      ChunkPrint dest(data, _sentLength, len);
+      serializeJson(_jsonDocument, dest);
+      return len;
+    }
+};
+
+typedef std::function<void(AsyncWebServerRequest *request, JsonVariant json)> ArJsonRequestHandlerFunction;
+
+class AsyncCallbackJsonWebHandler: public AsyncWebHandler {
+private:
+protected:
+  const String _uri;
+  WebRequestMethodComposite _method;
+  ArJsonRequestHandlerFunction _onRequest;
+  size_t _contentLength;
+  size_t _maxContentLength;
+public:
+  AsyncCallbackJsonWebHandler(const String& uri, ArJsonRequestHandlerFunction onRequest) : _uri(uri), _method(HTTP_POST|HTTP_PUT|HTTP_PATCH), _onRequest(onRequest), _maxContentLength(16384) {}
+  void setMethod(WebRequestMethodComposite method){ _method = method; }
+  void setMaxContentLength(int maxContentLength){ _maxContentLength = maxContentLength; }
+  void onRequest(ArJsonRequestHandlerFunction fn){ _onRequest = fn; }
+  virtual bool canHandle(AsyncWebServerRequest *request) override final{
+    if(!_onRequest)
+      return false;
+
+    if(!(_method & request->method()))
+      return false;
+
+    if(_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri+"/")))
+      return false;
+
+    if (!request->contentType().equalsIgnoreCase(JSON_MIMETYPE))
+      return false;
+
+    request->addInterestingHeader("ANY");
+    return true;
+  }
+  virtual void handleRequest(AsyncWebServerRequest *request) override final {
+    if(_onRequest) {
+      if (request->_tempObject != NULL) {
+        DynamicJsonDocument _jsonDocument(_maxContentLength);
+        DeserializationError err = deserializeJson(_jsonDocument, (uint8_t*)(request->_tempObject));
+        if (err == DeserializationError::Ok) {
+          _onRequest(request, _jsonDocument.as<JsonVariant>());
+          return;
+        }
+      }
+      request->send(_contentLength > _maxContentLength ? 413 : 400);
+    } else {
+      request->send(500);
+    }
+  }
+  virtual void handleUpload(AsyncWebServerRequest *request, const String& filename, size_t index, uint8_t *data, size_t len, bool final) override final {
+  }
+  virtual void handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) override final {
+    if (_onRequest) {
+      _contentLength = total;
+      if (total > 0 && request->_tempObject == NULL && total < _maxContentLength) {
+        request->_tempObject = malloc(total);
+      }
+      if (request->_tempObject != NULL) {
+        memcpy((uint8_t*)(request->_tempObject) + index, data, len);
+      }
+    }
+  }
+  virtual bool isRequestHandlerTrivial() override final {return _onRequest ? false : true;}
+};
+
+
+/*
+* Listens for a response being destroyed and calls a callback during said distruction.
+*
+* Used so we can take action after the response has been rendered to the client.
+*
+* Avoids having to fork ESPAsyncWebServer with a callback feature - still not a nice use of a destructor!
+*/
+
+typedef std::function<void()> AsyncJsonCallback;
+
+class AsyncJsonCallbackResponse: public AsyncJsonResponse {
+
+  private:
+
+      AsyncJsonCallback _callback;
+
+  public:
+
+    AsyncJsonCallbackResponse(AsyncJsonCallback callback, int maxSize) : AsyncJsonResponse(maxSize), _callback{callback} {}
+    ~AsyncJsonCallbackResponse() {
+      _callback();
+    }
+
+};
+
+#endif

src/AsyncJsonCallbackResponse.h

@@ -14,7 +14,7 @@
 * Really only of use where there is a determinate payload size.
 */
 
-typedef std::function<void(AsyncWebServerRequest *request, JsonVariant &json)> JsonRequestCallback;
+typedef std::function<void(AsyncWebServerRequest *request, JsonDocument &jsonDocument)> JsonRequestCallback;
 
 class AsyncJsonRequestWebHandler: public AsyncWebHandler {
 
@@ -72,10 +72,10 @@ class AsyncJsonRequestWebHandler: public AsyncWebHandler {
 
       // parse JSON and if possible handle the request
       if (request->_tempObject) {
-        DynamicJsonBuffer jsonBuffer;
-        JsonVariant json = jsonBuffer.parse((uint8_t *) request->_tempObject);
-        if (json.success()) {
-          _onRequest(request, json);
+        DynamicJsonDocument jsonDocument(_maxContentLength);
+        DeserializationError error = deserializeJson(jsonDocument, (uint8_t *) request->_tempObject);
+        if (error == DeserializationError::Ok) {
+          _onRequest(request, jsonDocument);
         }else{
           request->send(400);
         }

src/AsyncJsonRequestWebHandler.h

@@ -5,8 +5,8 @@ NTPStatus::NTPStatus(AsyncWebServer *server) : _server(server) {
 }
 
 void NTPStatus::ntpStatus(AsyncWebServerRequest *request) {
-  AsyncJsonResponse * response = new AsyncJsonResponse();
-  JsonObject& root = response->getRoot();
+  AsyncJsonResponse * response = new AsyncJsonResponse(MAX_NTP_STATUS_SIZE);
+  JsonObject root = response->getRoot();
 
   // request time now first, this can sometimes force a sync
   time_t timeNow = now();

src/AuthSettingsService.cpp

@@ -11,10 +11,11 @@
 
 #include <ESPAsyncWebServer.h>
 #include <ArduinoJson.h>
-#include <AsyncJson.h>
+#include <AsyncArduinoJson6.h>
 #include <TimeLib.h>
 #include <NtpClientLib.h>
 
+#define MAX_NTP_STATUS_SIZE 1024
 #define NTP_STATUS_SERVICE_PATH "/rest/ntpStatus"
 
 class NTPStatus {