Fix several bugs in crash reporter

- `[object Object]` was shown instead of stack trace
- Pseudonyms starting with 0 where not logged at all
- Removed field `origin` since this info is already contained in stacktrace

Author: Jannled

.vscode/settings.json

@@ -157,6 +157,7 @@
 		"ipympl",
 		"ISDEBUGGROUP",
 		"itsdangerous",
+		"jquery",
 		"kaniko",
 		"keepends",
 		"kolloqskill",
@@ -185,6 +186,7 @@
 		"Nmbr",
 		"noopener",
 		"noreferrer",
+		"noscript",
 		"NOTREACHED",
 		"NOTSTARTED",
 		"nullable",
@@ -225,6 +227,7 @@
 		"splitted",
 		"sqlalchemy",
 		"sqlite",
+		"stylesheet",
 		"subfolders",
 		"Teilnehmer",
 		"thinkaloud",

app/router/routerGame.py

@@ -458,15 +458,18 @@ def crashReport():
 	"""Called by the server when an exception escapes to the browser or `console.error()` is called"""
 	serverTime = now()
 
-	writeCrashReport(
+	successful = writeCrashReport(
 		pseudonym=request.form.get('ui', 'Unknown'),
 		group=request.form.get('group', 'Unknown'),
 		timestamp=serverTime,
 		message=request.form.get('message', 'NoMessage'),
 		stackTrace=request.form.get('trace', '')
 	)
 
-	return 'error information send', 200
+	if successful:
+		return 'error information send', 200
+	else:
+		return 'error information rejected', 400
 
 
 def getDefaultUrl(request: Any):

app/storage/crashReport.py

@@ -1,16 +1,14 @@
 from io import TextIOWrapper
 from typing import Optional
 
-from prometheus_client import Gauge
-
 from app.config import MAX_ERROR_LOGS_PER_PLAYER, PSEUDONYM_LENGTH
 from app.prometheusMetrics import ServerMetrics
 from app.storage.participantsDict import exists
 from app.utilsGame import now
 
 crashReportFile: Optional[TextIOWrapper] = None
 
-crashCounts: dict[int, int] = {}
+crashCounts: dict[str, int] = {}
 groupBlacklist: list[str]
 
 def openCrashReporterFile(filePath: str, p_groupBlacklist: list[str], errorLevel: int):
@@ -39,34 +37,38 @@ def writeCrashReport(pseudonym: str, group: str, timestamp: int, message: str, s
 	else:
 		assert crashReportFile is not None
 
-	ui_num = int(pseudonym[:PSEUDONYM_LENGTH], base=16)
-	san_pseudonym = hex(ui_num)[2:] # make sure string is a hex number, remove 0x prefix
-	san_timestamp = str(timestamp)
-	san_message = '%20'.join(str(message.strip()).splitlines(keepends=False))
-	san_trace = stackTrace.splitlines(keepends=False)
-
-	# reject if pseudonym is unknown
-	if not exists(san_pseudonym):
+	# make sure pseudonym is correct length and contains a hex number
+	pseudonym = pseudonym[:PSEUDONYM_LENGTH]
+	if not pseudonym.isalnum():
 		return False
-	
+
+	# reject if pseudonym is not in player database
+	if not exists(pseudonym):
+		return False	
+
 	# reject, if the player threw too many errors
-	if ui_num not in crashCounts:
-		crashCounts[ui_num] = 0
-	elif MAX_ERROR_LOGS_PER_PLAYER > 0 and crashCounts[ui_num] > MAX_ERROR_LOGS_PER_PLAYER:
+	if pseudonym not in crashCounts:
+		crashCounts[pseudonym] = 0
+	elif MAX_ERROR_LOGS_PER_PLAYER > 0 and crashCounts[pseudonym] > MAX_ERROR_LOGS_PER_PLAYER:
 		return False
 
+	san_timestamp = int(timestamp)
+	san_message = '%20'.join(str(message.strip()).splitlines(keepends=False))
+	san_trace = stackTrace.splitlines(keepends=False)
+
 	# Update the Prometheus metrics
 	ServerMetrics.incrementCrashMetrics()
 
 	# Increase the logged errors counter and return success
-	crashCounts[int(pseudonym[:PSEUDONYM_LENGTH], base=16)] += 1
+	crashCounts[pseudonym] += 1
 
 	try:
-		crashReportFile.write('\n[' + san_timestamp + '] ui=' + san_pseudonym + ':\n')
+		# Write to crash reporter file
+		crashReportFile.write(f'\n[{san_timestamp}] ui="{pseudonym}":\n')
 		crashReportFile.write(san_message)
 
-		for l in san_trace:
-			crashReportFile.write('\n\t' + l.strip())
+		for line in san_trace:
+			crashReportFile.write('\n\t' + line.strip())
 
 		crashReportFile.write('\n')
 		crashReportFile.flush()

templates/game.html

@@ -141,10 +141,9 @@
 			/**
 			* Send a crash report to the server containing the pseudonym, message, source file and stack trace.
 			* @param {string} message 
-			* @param {string} origin 
 			* @param {string} trace 
 			*/
-			function sendErrorLog(message, origin, trace)
+			function sendErrorLog(message, trace)
 			{
 				try
 				{
@@ -162,7 +161,6 @@
 						"ui=" + encodeURIComponent(pseudonym) +
 						"&group=" + encodeURIComponent(group) +
 						"&message=" + encodeURIComponent(message) +
-						"&origin=" + encodeURIComponent(origin) +
 						"&trace=" + encodeURIComponent(trace)
 					);
 				}
@@ -175,7 +173,7 @@
 			// Catch all exceptions that escape into the browser
 			window.onerror = (event, source, line, column, error) =>
 			{
-				sendErrorLog(error.message, source + ':' + line + (column > 2000 ? ':' + column : ''), error.stack);
+				sendErrorLog(error.message, error.stack);
 				return false;
 			};
 
@@ -193,7 +191,7 @@
 					return; // Panic we have a problem here
 				}
 
-				sendErrorLog(args[0], "console.error", "");
+				sendErrorLog(args[0], "console.error()");
 				consoleErrorLogger.apply(console, args);
 				recursionBreaker = 0;
 			};