improvement: log system details

Xananax · Xananax · commit b1a84f45bafa · 2022-01-12T01:46:41.000+04:00
diff --git a/autoload/Log.gd b/autoload/Log.gd
@@ -11,9 +11,23 @@ enum LEVEL {
 
 var also_print_to_godot := false;
 var _js_available := OS.has_feature("JavaScript")
+var is_joypad = false
+var joypad_index = -1
 var GDQUEST: JavaScriptObject
 
 
+func _init() -> void:
+	var _err = Input.connect("joy_connection_changed", self, "_on_joy_connection_changed")
+	if not _js_available:
+		return
+	GDQUEST = JavaScript.get_interface("GDQUEST")
+	if not GDQUEST:
+		_js_available = false
+		return
+	trim_if_over_limit()
+	log_system_info_if_log_is_empty(get_info())
+
+
 func write(level: int, properties: Dictionary, message: String) -> void:
 	if also_print_to_godot and OS.is_debug_build():
 		var level_index := LEVEL.values().find(level)
@@ -33,9 +47,7 @@ func write(level: int, properties: Dictionary, message: String) -> void:
 				print(object)
 	if not _js_available:
 		return
-	var props = JavaScript.create_object("Object", {})
-	for key in properties:
-		props[key] = properties[key]
+	var props = godot_dict_to_js_obj(properties)
 	match(level):
 		LEVEL.FATAL:
 			# warning-ignore:unsafe_property_access
@@ -57,16 +69,6 @@ func write(level: int, properties: Dictionary, message: String) -> void:
 			GDQUEST.log.trace(props, message)
 
 
-func _init() -> void:
-	if not _js_available:
-		return
-	GDQUEST = JavaScript.get_interface("GDQUEST")
-	if not GDQUEST:
-		_js_available = false
-		return
-	trim_if_over_limit()
-
-
 func trace(properties: Dictionary, message: String) -> void:
 	write(LEVEL.TRACE, properties, message)
 
@@ -102,8 +104,55 @@ func download() -> void:
 
 # Makes sure the log doesn't fill user's localStorage. Safe to call in all 
 # environments, will no-op when JS is not available.
-func trim_if_over_limit(max_kilo_bytes := 1000) -> void:
+func trim_if_over_limit(max_kilo_bytes := 1000) -> bool:
 	if not _js_available:
-		return
+		return false
 	# warning-ignore:unsafe_property_access
-	GDQUEST.log.trimIfOverLimit(max_kilo_bytes)
+	return GDQUEST.log.trimIfOverLimit(max_kilo_bytes)
+
+
+# Logs system info if the log is empty. Safe to call in all environments, will
+# no-op when JS is not available.
+func log_system_info_if_log_is_empty(additional_data := {}) -> void:
+	if not _js_available:
+		return
+	if additional_data.size() > 0:
+		var props = godot_dict_to_js_obj(additional_data)
+		# warning-ignore:unsafe_property_access
+		GDQUEST.log.logSystemInfoIfLogIsEmpty(props)
+	else:
+		# warning-ignore:unsafe_property_access
+		GDQUEST.log.logSystemInfoIfLogIsEmpty()
+
+
+func godot_dict_to_js_obj(properties: Dictionary):
+	var props = JavaScript.create_object("Object", {})
+	for key in properties:
+		var value = properties[key]
+		if value is Dictionary:
+			value = godot_dict_to_js_obj(value)
+		elif value is Vector2 or value is Vector3:
+			value = "%s"%[value]
+		props[key] = value
+	return props
+
+
+func get_info():
+	var info = {
+		"OS": OS.get_name(),
+		"datetime": OS.get_datetime(),
+		"video_driver": OS.get_video_driver_name(OS.get_current_video_driver()),
+		"video_adapter": VisualServer.get_video_adapter_name(),
+		"video_vendor": VisualServer.get_video_adapter_vendor(),
+		"screen_size": OS.get_screen_size(),
+		"screen_dpi": OS.get_screen_dpi(),
+		"cores": OS.get_processor_count(),
+		"locale": OS.get_locale(),
+		"joypad": Input.get_joy_name(joypad_index) if is_joypad else "" 
+	}
+	return info
+
+
+func _on_joy_connection_changed(device_id, connected):
+	is_joypad = connected
+	joypad_index = device_id
diff --git a/html_export/static/bootstrap.d.ts b/html_export/static/bootstrap.d.ts
@@ -23,7 +23,8 @@ interface Log {
   display: () => void;
   clear: () => void;
   download: () => void;
-  trimIfOverLimit: (maxKiloBytes?: number) => void;
+  trimIfOverLimit: (maxKiloBytes?: number) => boolean;
+  logSystemInfoIfLogIsEmpty: (additionalData?: Record<string, any>) => void;
   get: () => LogLine[];
 }
 interface GodotEngineInstanceStartGameOptions {
diff --git a/html_export/static/bootstrap.js b/html_export/static/bootstrap.js
@@ -71,7 +71,6 @@ window.GDQUEST = ((/** @type {GDQuestLib} */ GDQUEST) => {
      */
     const onProgress = (current, total) => {
       if (total > 0) {
-        console.info("loading...", total);
         setStatusMode(StatusMode.PROGRESS);
         displayPercentage(current / total);
         if (current === total) {
@@ -214,8 +213,7 @@ window.GDQUEST = ((/** @type {GDQuestLib} */ GDQUEST) => {
           } else {
             console.log(msg);
           }
-        }
-        if (level < 40) {
+        } else if (level < 40) {
           if (anything) {
             console.info(msg, anything);
           } else {
@@ -247,15 +245,43 @@ window.GDQUEST = ((/** @type {GDQuestLib} */ GDQUEST) => {
 
     /** @type { Log['trimIfOverLimit'] } */
     const trimIfOverLimit = (maxKiloBytes = 1000) => {
+      let response = false;
       while (getLocalStorageSize() > maxKiloBytes) {
         log_lines.shift();
         localStorage.setItem(KEY, JSON.stringify(log_lines));
+        response = true;
+      }
+      return response;
+    };
+
+    const logSystemInfoIfLogIsEmpty = (additionalData = {}) => {
+      if (log_lines.length == 0) {
+        const { userAgent, vendor } = navigator;
+        const { width, height } = screen;
+        const { innerHeight, innerWidth } = window;
+        const data = {
+          userAgent,
+          vendor,
+          width,
+          height,
+          innerHeight,
+          innerWidth,
+          ...additionalData,
+        };
+        makeLogFunction(LEVELS.TRACE)(data, `INIT`);
       }
     };
 
     /** @type { Log } */
     // @ts-ignore
-    const log = { display, clear, get, trimIfOverLimit, download };
+    const log = {
+      display,
+      clear,
+      get,
+      trimIfOverLimit,
+      download,
+      logSystemInfoIfLogIsEmpty,
+    };
     Object.keys(LEVELS).forEach(
       (key) => (log[key.toLowerCase()] = makeLogFunction(LEVELS[key]))
     );
