fix: prevent stack overflow when logging error occurs

marcelkottmann · marcelkottmann · commit c135531684d0 · 2021-09-05T08:48:46.000+02:00
diff --git a/components/esp32-javascript/modules/esp32-javascript/filelogging.js b/components/esp32-javascript/modules/esp32-javascript/filelogging.js
@@ -54,12 +54,18 @@ function cleanupOldLogs() {
     }
 }
 global.el_flushLogBuffer = function () {
+    var swap = global.logBuffer; // swap to prevent endless loop when error occurs in this method
+    global.logBuffer = new stringbuffer_1.StringBuffer();
     var logFile = exports.FILE_LOGGING_DIRECTORY + "/logs-" + getLogFileNumber() + ".txt";
-    var ret = appendFile(logFile, global.logBuffer.toString());
-    if (ret < 0) {
-        console.error("Could not flush log file. Space exceeded?");
+    try {
+        var ret = appendFile(logFile, swap.toString());
+        if (ret < 0) {
+            console.error("Could not flush log file. Space exceeded?");
+        }
+    }
+    catch (error) {
+        console.error("Could not open log file. Space exceeded?");
     }
-    global.logBuffer = new stringbuffer_1.StringBuffer();
     if (fileSize(logFile) > exports.LOG_FILE_SIZE_LIMIT) {
         logFileNumber++;
     }
diff --git a/components/esp32-javascript/modules/esp32-javascript/filelogging.ts b/components/esp32-javascript/modules/esp32-javascript/filelogging.ts
@@ -57,13 +57,19 @@ function cleanupOldLogs() {
 }
 
 global.el_flushLogBuffer = function (): void {
+  const swap = global.logBuffer; // swap to prevent endless loop when error occurs in this method
+  global.logBuffer = new StringBuffer();
+
   const logFile = `${FILE_LOGGING_DIRECTORY}/logs-${getLogFileNumber()}.txt`;
-  const ret = appendFile(logFile, global.logBuffer.toString());
-  if (ret < 0) {
-    console.error("Could not flush log file. Space exceeded?");
+  try {
+    const ret = appendFile(logFile, swap.toString());
+    if (ret < 0) {
+      console.error("Could not flush log file. Space exceeded?");
+    }
+  } catch (error) {
+    console.error("Could not open log file. Space exceeded?");
   }
 
-  global.logBuffer = new StringBuffer();
   if (fileSize(logFile) > LOG_FILE_SIZE_LIMIT) {
     logFileNumber++;
   }

Original file line number	Diff line number	Diff line change
`@@ -54,12 +54,18 @@ function cleanupOldLogs() {`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`	`global.el_flushLogBuffer = function () {`
	`57`	`+ var swap = global.logBuffer; // swap to prevent endless loop when error occurs in this method`
	`58`	`+ global.logBuffer = new stringbuffer_1.StringBuffer();`
`57`	`59`	`var logFile = exports.FILE_LOGGING_DIRECTORY + "/logs-" + getLogFileNumber() + ".txt";`
`58`		`- var ret = appendFile(logFile, global.logBuffer.toString());`
`59`		`- if (ret < 0) {`
`60`		`- console.error("Could not flush log file. Space exceeded?");`
	`60`	`+ try {`
	`61`	`+ var ret = appendFile(logFile, swap.toString());`
	`62`	`+ if (ret < 0) {`
	`63`	`+ console.error("Could not flush log file. Space exceeded?");`
	`64`	`+ }`
	`65`	`+ }`
	`66`	`+ catch (error) {`
	`67`	`+ console.error("Could not open log file. Space exceeded?");`
`61`	`68`	`}`
`62`		`- global.logBuffer = new stringbuffer_1.StringBuffer();`
`63`	`69`	`if (fileSize(logFile) > exports.LOG_FILE_SIZE_LIMIT) {`
`64`	`70`	`logFileNumber++;`
`65`	`71`	`}`