Better error handling and size limits for visualization file loading, re:#385 re:#376

Author: jcoffland

CHANGELOG.md

@@ -1,6 +1,9 @@
 Folding@home Client Changelog
 =============================
 
+## v8.5.1
+ - Better error handling and size limits for vis file loading. #385 #376
+
 ## v8.5
  - Small improvements to Windows shutdown handling.
  - Added option and core parameters for HIP.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fah-client",
-  "version": "8.5.0",
+  "version": "8.5.1",
   "bin": {"fah-client": "./fah-client"},
   "author": "Joseph Coffland <[email protected]>",
   "homepage": "https://foldingathome.org/",

src/fah/client/Unit.cpp

@@ -74,6 +74,9 @@ using namespace std;
 
 
 namespace {
+  static const uint64_t maxViewerBytes = 1e8;
+
+
   string idFromSig(const string &sig) {
     if (sig.empty()) return "";
     return Digest::urlBase64(sig, "sha256");
@@ -677,43 +680,75 @@ void Unit::readInfo() {
 
 
 void Unit::readViewerData() {
-  if (getState() < UNIT_CORE) return;
-  if (topology.isNull()) readViewerTop();
-  if (readViewerFrame()) triggerNext();
+  if (viewerFail < 0 || getState() < UNIT_CORE) return;
+
+  try {
+    if (topology.isNull()) readViewerTop();
+    return readViewerFrame();
+  } CATCH_WARNING;
+
+  if (5 < ++viewerFail) {
+    if (topology.isNull()) {
+      LOG_WARNING("Giving up on reading visualization");
+      viewerFail = -1;
+
+    } else {
+      LOG_WARNING("Giving up on reading visualization frame " << viewerFrame++);
+      viewerFail = 0;
+    }
+  }
 }
 
 
 void Unit::readViewerTop() {
   string filename = getDirectory() + "/viewerTop.json";
 
   if (existsAndOlderThan(filename, 10)) {
-    topology = JSON::Reader::parseFile(filename);
     frames.clear();
+    viewerBytes = SystemUtilities::getFileSize(filename);
+
+    if (maxViewerBytes < viewerBytes) {
+      LOG_WARNING("Visualization topology too large, disabling visualization");
+      viewerFail = -1;
+      return;
+    }
+
+    topology = JSON::Reader::parseFile(filename);
+    viewerFail = 0;
   }
 }
 
 
-bool Unit::readViewerFrame() {
+void Unit::readViewerFrame() {
   string filename =
     getDirectory() + String::printf("/viewerFrame%d.json", viewerFrame);
 
   if (existsAndOlderThan(filename, 10)) {
+    uint64_t bytes = SystemUtilities::getFileSize(filename);
+
+    if (maxViewerBytes < viewerBytes + bytes) {
+      LOG_WARNING("Visualization size exceeded at frame " << viewerFrame
+        << ", no more frames will be loaded");
+      viewerFail = -1;
+      return;
+    }
+
     auto frame = JSON::Reader::parseFile(filename);
 
     if (!frames.empty() && *frames.back() == *frame)
       LOG_WARNING("Visualization frame " << viewerFrame
-                  << " unchanged, skipping");
+        << " unchanged, skipping");
 
     else if (!frame->empty()) {
       frames.push_back(frame);
       insert("frames", (uint32_t)frames.size());
+      viewerBytes += bytes;
     }
 
     viewerFrame++;
-    return true;
+    viewerFail = 0;
+    triggerNext(); // Try to load another frame
   }
-
-  return false;
 }
 
 

src/fah/client/Unit.h

@@ -68,6 +68,8 @@ namespace FAH {
       cb::SmartPointer<Core>          core;
 
       unsigned viewerFrame = 0;
+      int      viewerFail  = 0;
+      uint64_t viewerBytes = 0;
 
       cb::SmartPointer<CoreProcess> process;
       cb::SmartPointer<cb::TailFileToLog> logCopier;
@@ -163,7 +165,7 @@ namespace FAH {
       void readInfo();
       void readViewerData();
       void readViewerTop();
-      bool readViewerFrame();
+      void readViewerFrame();
       void setResults(const std::string &status, const std::string &dataHash);
       void finalizeRun();
       void stopRun();