Fix missing WS debug messages (#1851)

Amend #1843 , since we have updated ESPAsyncWebServer Fixes (again) #1300 Gather WS debug messages in a buffer and flush every N times info,keys,crash actually output data now
xoseperez · Aug 12, 2019 · d4dea17 · d4dea17
1 parent 2142343
commit d4dea17
Show file tree

Hide file tree

Showing 18 changed files with 4,090 additions and 4,028 deletions.
diff --git a/code/espurna/data/index.all.html.gz b/code/espurna/data/index.all.html.gz
diff --git a/code/espurna/data/index.light.html.gz b/code/espurna/data/index.light.html.gz
diff --git a/code/espurna/data/index.lightfox.html.gz b/code/espurna/data/index.lightfox.html.gz
diff --git a/code/espurna/data/index.rfbridge.html.gz b/code/espurna/data/index.rfbridge.html.gz
diff --git a/code/espurna/data/index.rfm69.html.gz b/code/espurna/data/index.rfm69.html.gz
diff --git a/code/espurna/data/index.sensor.html.gz b/code/espurna/data/index.sensor.html.gz
diff --git a/code/espurna/data/index.small.html.gz b/code/espurna/data/index.small.html.gz
diff --git a/code/espurna/data/index.thermostat.html.gz b/code/espurna/data/index.thermostat.html.gz
diff --git a/code/espurna/static/index.all.html.gz.h b/code/espurna/static/index.all.html.gz.h
diff --git a/code/espurna/static/index.light.html.gz.h b/code/espurna/static/index.light.html.gz.h
diff --git a/code/espurna/static/index.lightfox.html.gz.h b/code/espurna/static/index.lightfox.html.gz.h
diff --git a/code/espurna/static/index.rfbridge.html.gz.h b/code/espurna/static/index.rfbridge.html.gz.h
diff --git a/code/espurna/static/index.rfm69.html.gz.h b/code/espurna/static/index.rfm69.html.gz.h
diff --git a/code/espurna/static/index.sensor.html.gz.h b/code/espurna/static/index.sensor.html.gz.h
diff --git a/code/espurna/static/index.small.html.gz.h b/code/espurna/static/index.small.html.gz.h
diff --git a/code/espurna/static/index.thermostat.html.gz.h b/code/espurna/static/index.thermostat.html.gz.h
diff --git a/code/espurna/ws.ino b/code/espurna/ws.ino
@@ -162,30 +162,75 @@ bool _wsAuth(AsyncWebSocketClient * client) {
 
 #if DEBUG_WEB_SUPPORT
 
-bool wsDebugSend(const char* prefix, const char* message) {
- if (!wsConnected()) return false;
+struct ws_debug_msg_t {
+ ws_debug_msg_t(const char* prefix, const char* message) :
+ prefix(prefix), message(message)
+ {}
+ String prefix;
+ String message;
+};
 
- // via: https://arduinojson.org/v6/assistant/
- // we use 1 object for "weblog", 2nd one for "message". "prefix", optional
- StaticJsonBuffer<JSON_OBJECT_SIZE(1) + JSON_OBJECT_SIZE(2)> jsonBuffer;
- JsonObject& root = jsonBuffer.createObject();
- JsonObject& weblog = root.createNestedObject("weblog");
+struct ws_debug_t {
 
- weblog["message"] = message;
- if (prefix && (prefix[0] != '\0')) {
- weblog["prefix"] = prefix;
+ ws_debug_t(size_t capacity) :
+ flush(false),
+ current(0),
+ capacity(capacity)
+ {
+ messages.reserve(capacity);
  }
 
- // TODO: avoid serializing twice and just measure json ourselves?
- //const size_t len = strlen(message) + strlen(prefix)
- // + strlen("{\"weblog\":}")
- // + strlen("{\"message\":\"\"}")
- // + (strlen(prefix) ? strlen("\",\"prefix\":\"\"") : 0);
- //wsSend(root, len);
- wsSend(root);
+ void add(const char* prefix, const char* message) {
+ if (current >= capacity) {
+ flush = true;
+ send();
+ }
 
+ messages.emplace(messages.begin() + current, prefix, message);
+ flush = true;
+ ++current;
+ }
+
+ void send() {
+ if (!flush) return;
+ // ref: http://arduinojson.org/v5/assistant/
+ // {"weblog": {"msg":[...],"pre":[...]}}
+ DynamicJsonBuffer jsonBuffer(2*JSON_ARRAY_SIZE(messages.size()) + JSON_OBJECT_SIZE(1) + JSON_OBJECT_SIZE(2));
+
+ JsonObject& root = jsonBuffer.createObject();
+ JsonObject& weblog = root.createNestedObject("weblog");
+
+ JsonArray& msg = weblog.createNestedArray("msg");
+ JsonArray& pre = weblog.createNestedArray("pre");
+
+ for (auto& message : messages) {
+ pre.add(message.prefix.c_str());
+ msg.add(message.message.c_str());
+ }
+
+ wsSend(root);
+ messages.clear();
+ current = 0;
+ flush = false;
+ }
+
+ bool flush;
+ size_t current;
+ const size_t capacity;
+ std::vector<ws_debug_msg_t> messages;
+
+};
+
+// TODO: move to the headers?
+constexpr const size_t WS_DEBUG_MSG_BUFFER = 8;
+ws_debug_t _ws_debug(WS_DEBUG_MSG_BUFFER);
+
+bool wsDebugSend(const char* prefix, const char* message) {
+ if (!wsConnected()) return false;
+ _ws_debug.add(prefix, message);
  return true;
 }
+
 #endif
 
 // Check the existing setting before saving it
@@ -599,6 +644,9 @@ void _wsLoop() {
  if (!wsConnected()) return;
  _wsDoUpdate();
  _wsHandleClientData();
+ #if DEBUG_WEB_SUPPORT
+ _ws_debug.send();
+ #endif
 }
 
 // -----------------------------------------------------------------------------

diff --git a/code/html/custom.js b/code/html/custom.js
@@ -1642,10 +1642,15 @@ function processData(data) {
  if ("weblog" === key) {
  websock.send("{}");
 
- if (value.prefix) {
- $("#weblog").append(new Text(value.prefix));
+ msg = value["msg"];
+ pre = value["pre"];
+
+ for (var i=0; i < msg.length; ++i) {
+ if (pre[i]) {
+ $("#weblog").append(new Text(pre[i]));
+ }
+ $("#weblog").append(new Text(msg[i]));
  }
- $("#weblog").append(new Text(value.message));
 
  $("#weblog").scrollTop($("#weblog")[0].scrollHeight - $("#weblog").height());
  return;