Log nomenclature corrections

This commit is contained in:
Adrien Ufferte
2025-11-18 10:23:26 +01:00
parent eee5ee65e6
commit 7c101bd19c
13 changed files with 60 additions and 60 deletions
+6 -6
View File
@@ -74,11 +74,11 @@ func ensure_data_integrity(data: Dictionary[int, Dictionary]) -> Dictionary:
# Check missing keys
if not garden.has("games"):
if not is_init:
Log.warn("Garden %d : Add missing key 'games'." % index)
Log.warn("StudentProgression: Garden %d: Add missing key 'games'." % index)
garden["games"] = [Status.Locked, Status.Locked, Status.Locked]
if not garden.has("look_and_learn"):
if not is_init:
Log.warn("Garden %d : Add missing key 'look_and_learn'." % index)
Log.warn("StudentProgression: Garden %d: Add missing key 'look_and_learn'." % index)
garden["look_and_learn"] = Status.Locked
if not garden.has("last_duration"):
garden["last_duration"] = PackedInt32Array([0, 0, 0])
@@ -88,7 +88,7 @@ func ensure_data_integrity(data: Dictionary[int, Dictionary]) -> Dictionary:
# Check array "games"
if typeof(garden["games"]) != TYPE_ARRAY or (garden["games"] as Array).size() != 3:
if not is_init:
Log.warn("Garden %d : invalid format for 'games' → reset." % index)
Log.warn("StudentProgression: Garden %d: invalid format for 'games' → reset." % index)
garden["games"] = [Status.Locked, Status.Locked, Status.Locked]
# Check value outside of possible enum values
@@ -119,7 +119,7 @@ func ensure_data_integrity(data: Dictionary[int, Dictionary]) -> Dictionary:
for game_index: int in range(3):
if garden["games"][game_index] != Status.Locked or garden["look_and_learn"] != Status.Locked:
if not is_init:
Log.warn("Garden %d : invalid progression (previous not finished) → reset." % index)
Log.warn("StudentProgression: Garden %d: invalid progression (previous not finished) → reset." % index)
garden["games"] = [Status.Locked, Status.Locked, Status.Locked]
garden["look_and_learn"] = Status.Locked
break
@@ -131,13 +131,13 @@ func ensure_data_integrity(data: Dictionary[int, Dictionary]) -> Dictionary:
if garden["games"][game_index] == Status.Locked:
garden["games"][game_index] = Status.Unlocked
if not is_init:
Log.warn("Garden %d : game %d unlocked because lesson is completed" % [index, game_index + 1])
Log.warn("StudentProgression: Garden %d: game %d unlocked because lesson is completed" % [index, game_index + 1])
# Case : previous garden completed → lesson unlocked if needed
elif garden["look_and_learn"] == Status.Locked:
garden["look_and_learn"] = Status.Unlocked
if not is_init:
Log.warn("Garden %d : lesson unlocked because previous garden is completed" % index)
Log.warn("StudentProgression: Garden %d: lesson unlocked because previous garden is completed" % index)
return result
+2 -2
View File
@@ -228,7 +228,7 @@ func _ready() -> void:
if transition_data.has("current_garden_index"):
starting_garden = transition_data.current_garden_index
else:
Log.error("Gardens: initialisation: transition_data exists but does not contains the needed current_garden_index")
Log.error("Gardens: Ready: The transition_data exists but does not contains the needed current_garden_index")
starting_garden = 0
scroll_container.scroll_horizontal = GARDEN_SIZE * starting_garden
@@ -378,7 +378,7 @@ func _ready() -> void:
static func compute_lessons_distribution(total_lessons: int, garden_layouts: Array[GardenLayout]) -> Array[int]:
Log.trace("Gardens: compute_lessons_distribution: total_lessons = %s, garden_layouts count = %s" % [str(total_lessons), str(garden_layouts.size())])
Log.trace("Gardens: ComputeLessonsDistribution: Parameters total_lessons = %s, garden_layouts count = %s" % [str(total_lessons), str(garden_layouts.size())])
var distribution: Array[int] = []
var lessons_left: int = total_lessons
var gardens_left: int = garden_layouts.size()
+1 -1
View File
@@ -41,7 +41,7 @@ func _can_drop_data(_at_position: Vector2, data: Variant) -> bool:
func _drop_data(at_position: Vector2, data: Variant) -> void:
if not data is Dictionary:
Log.error("LessonGPLabel: drop data failed because data is not of type Dictionary")
Log.error("LessonGPLabel: Drop data failed because data is not of type Dictionary")
if not (data as Dictionary).has("gp_id"):
return
var before: bool = at_position.x < size.x / 2
+1 -1
View File
@@ -39,7 +39,7 @@ func setup() -> void:
gp_list = Database.get_gps_for_lesson(lesson_nb, true, true)
if gp_list.size() <= 0:
Log.error("LookAndLearn: setup() did not found any GP for lesson " + str(lesson_nb))
Log.error("LookAndLearn: Setup: Did not found any GP for lesson " + str(lesson_nb))
await OpeningCurtain.open()
_on_tracing_manager_finished()
return
@@ -76,7 +76,7 @@ func _ready() -> void:
# If the language pack is not already downloaded or an update is needed
if not DirAccess.dir_exists_absolute(current_language_path) or current_language_version != server_language_version:
Log.trace("A new version of the language pack has been detected.\n Current version = " + str(current_language_version) + "\n Server version = " + str(server_language_version))
Log.trace("PackageDownloader: A new version of the language pack has been detected.\n Current version = " + str(current_language_version) + "\n Server version = " + str(server_language_version))
checking_label.hide()
download_label.show()
+1 -1
View File
@@ -15,7 +15,7 @@ const PACKAGE_LOADER_SCENE_PATH: String = "res://sources/menus/language_selectio
func _ready() -> void:
Log.info("MainMenu loaded successfulyy")
Log.info("MainMenu: Loaded successfulyy")
version_label.text = ProjectSettings.get_setting("application/config/version")
teacher_label.text = UserDataManager.get_device_settings().teacher
device_id_label.text = str(UserDataManager.get_device_settings().device_id)
+1 -1
View File
@@ -88,7 +88,7 @@ func _on_level_changed(_index: int) -> void:
Log.current_level = selected_level
UserDataManager.get_device_settings().log_level = selected_level
UserDataManager._save_device_settings()
Log.info("Log level changed to %s" % Log.LogLevel.keys()[selected_level])
Log.info("DeveloperSettings: Log level changed to %s" % Log.LogLevel.keys()[selected_level])
func _on_filters_changed(checked: bool, index: int) -> void:
+1 -1
View File
@@ -137,7 +137,7 @@ func _setup_minigame() -> void:
# Find the stimuli and distractions of the minigame.
func _find_stimuli_and_distractions() -> void:
Log.error("Minigame type " + str(minigame_name) + " has not implemented the function _find_stimuli_and_distractions()")
Log.error("BaseMinigame: Minigame type " + str(minigame_name) + " has not implemented the function _find_stimuli_and_distractions()")
return
@@ -204,13 +204,13 @@ func _on_stimulus_pressed(stimulus: Dictionary, _node: Node) -> bool:
if _get_current_stimulus().has("ID"):
_update_remediation_syllable_score(_get_current_stimulus().ID as int, -1)
else:
Log.error("SyllablesMinigame: current stimulus has no ID")
Log.error("SyllablesMinigame: Current stimulus has no ID")
# Handles the pressed stimulus Gps
if stimulus.has("ID"):
_update_remediation_syllable_score(stimulus.ID as int, -1)
else:
Log.warn("SyllablesMinigame: stimulus has no ID")
Log.warn("SyllablesMinigame: Stimulus has no ID")
return true
@@ -3,7 +3,7 @@ extends AudioStreamPlayer
func play_gp(gp: Dictionary) -> void:
Log.trace("Minigame Audio Stream Player: Playing GP " + str(gp))
Log.trace("MinigameAudioStreamPlayer: Playing GP " + str(gp))
if not gp or gp.is_empty():
return
@@ -16,7 +16,7 @@ func play_gp(gp: Dictionary) -> void:
func play_syllable(syllable: Dictionary) -> void:
Log.trace("Minigame Audio Stream Player: Playing Syllable " + str(syllable))
Log.trace("MinigameAudioStreamPlayer: Playing Syllable " + str(syllable))
if not syllable or syllable.is_empty():
return
@@ -28,7 +28,7 @@ func play_syllable(syllable: Dictionary) -> void:
func play_word(word: String) -> void:
Log.trace("Minigame Audio Stream Player: Playing Word " + str(word))
Log.trace("MinigameAudioStreamPlayer: Playing Word " + str(word))
if not word or word.is_empty():
return
+27 -27
View File
@@ -32,7 +32,7 @@ func set_environment(env: int) -> void:
0: environment_url = AWS_API_GATEWAY_ADRESS + "/dev/"
1: environment_url = AWS_API_GATEWAY_ADRESS + "/prod/"
_: environment_url = ""
Log.info("Environment URL set to " + environment_url)
Log.info("ServerManager: Environment URL set to " + environment_url)
func first_login_student() -> void:
@@ -101,7 +101,7 @@ func set_student_data(student_code: int, data: Dictionary) -> Dictionary:
#region Sender functions
func check_internet_access() -> bool:
Log.trace("ServerManager Sending simple request to " + INTERNET_CHECK_URL + " to check if internet is available")
Log.trace("ServerManager: Sending simple request to " + INTERNET_CHECK_URL + " to check if internet is available")
var res: Error = internet_check.request(INTERNET_CHECK_URL)
if res == OK:
return await internet_check_completed
@@ -127,7 +127,7 @@ func _create_request_headers(content_type_json: bool = false) -> PackedStringArr
headers.append("Authorization: Bearer " + teacher_settings.token)
if content_type_json:
headers.append("Content-Type: application/json")
Log.trace("ServerManager Create Header: " + str(headers))
Log.trace("ServerManager: Create Header: " + str(headers))
return headers
@@ -144,13 +144,13 @@ func _get_request(uri: String, params: Dictionary) -> void:
reset_result()
var headers: PackedStringArray = _create_request_headers()
if params.has("password"):
Log.trace("ServerManager Sending GET request.\n URI = %s\n Parameters not logged because it contains a password." % uri)
Log.trace("ServerManager: Sending GET request.\n URI = %s\n Parameters not logged because it contains a password." % uri)
else:
Log.trace("ServerManager Sending GET request.\n URI = %s\n Parameters = %s" % [uri, params])
Log.trace("ServerManager: Sending GET request.\n URI = %s\n Parameters = %s" % [uri, params])
if http_request.request(_create_uri_with_parameters(environment_url + uri, params), headers) == OK:
await request_completed
else:
Log.error("ServerManager Error sending GET request")
Log.error("ServerManager: Error sending GET request")
code = 500
json = {message = "Internal Server Error"}
@@ -160,13 +160,13 @@ func _post_request(uri: String, params: Dictionary) -> void:
var url: String = _create_uri_with_parameters(environment_url + uri, params)
var headers: PackedStringArray = _create_request_headers()
if params.has("password"):
Log.trace("ServerManager Sending POST request.\n URI = %s\n Parameters not logged because it contains a password." % uri)
Log.trace("ServerManager: Sending POST request.\n URI = %s\n Parameters not logged because it contains a password." % uri)
else:
Log.trace("ServerManager Sending POST request.\n URI = %s\n Parameters = %s" % [uri, params])
Log.trace("ServerManager: Sending POST request.\n URI = %s\n Parameters = %s" % [uri, params])
if http_request.request(url, headers, HTTPClient.METHOD_POST, "") == OK:
await request_completed
else:
Log.error("ServerManager Error sending POST request")
Log.error("ServerManager: Error sending POST request")
code = 500
json = {message = "Internal Server Error"}
@@ -176,13 +176,13 @@ func _post_json_request(uri: String, data: Dictionary) -> void:
var req: String = environment_url + uri
var headers: PackedStringArray = _create_request_headers(true)
if data.has("password"):
Log.trace("ServerManager sending POST JSON request.\n URI = %s\n Data not logged because it contains a password." % uri)
Log.trace("ServerManager: Sending POST JSON request.\n URI = %s\n Data not logged because it contains a password." % uri)
else:
Log.trace("ServerManager Sending POST JSON request.\n URI = %s\n Data = %s" % [uri, data])
Log.trace("ServerManager: Sending POST JSON request.\n URI = %s\n Data = %s" % [uri, data])
if http_request.request(req, headers, HTTPClient.METHOD_POST, JSON.stringify(data)) == OK:
await request_completed
else:
Log.error("ServerManager Error sending POST JSON request")
Log.error("ServerManager: Error sending POST JSON request")
code = 500
json = {message = "Internal Server Error"}
@@ -191,11 +191,11 @@ func _delete_request(uri: String, params: Dictionary = {}) -> void:
reset_result()
var req: String = _create_uri_with_parameters(environment_url + uri, params)
var headers: PackedStringArray = _create_request_headers()
Log.trace("ServerManager Sending DELETE request.\n URI = %s\n Parameters = %s" % [uri, params])
Log.trace("ServerManager: Sending DELETE request.\n URI = %s\n Parameters = %s" % [uri, params])
if http_request.request(req, headers, HTTPClient.METHOD_DELETE, "") == OK:
await request_completed
else:
Log.error("ServerManager Error sending DELETE request")
Log.error("ServerManager: Error sending DELETE request")
code = 500
json = {message = "Internal Server Error"}
@@ -203,13 +203,13 @@ func _delete_request(uri: String, params: Dictionary = {}) -> void:
func _on_http_request_request_completed(result_code: int, response_code: int, _headers: PackedStringArray, body: PackedByteArray) -> void:
if result_code != OK:
Log.warn("Cannot complete http request. Error code %d = %s" % [result_code, error_string(result_code)])
Log.warn("ServerManager: Cannot complete http request. Error code %d = %s" % [result_code, error_string(result_code)])
else:
code = response_code
if code == 200:
Log.trace("ServerManager Request Completed. Response code = %d" % response_code)
Log.trace("ServerManager: Request Completed. Response code = %d" % response_code)
else:
Log.warn("ServerManager Request Completed. Response code = %d" % response_code)
Log.warn("ServerManager: Request Completed. Response code = %d" % response_code)
if body:
var str_body: String = body.get_string_from_utf8()
var result: Variant = JSON.parse_string(str_body)
@@ -217,26 +217,26 @@ func _on_http_request_request_completed(result_code: int, response_code: int, _h
if result is Dictionary or result is Array:
var pretty: String = JSON.stringify(result, "\t")
if code == 200:
Log.trace("ServerManager Prettyfied Body received :\n%s" % pretty)
Log.trace("ServerManager: Prettyfied Body received :\n%s" % pretty)
else:
Log.warn("ServerManager Prettyfied Body received :\n%s" % pretty)
Log.warn("ServerManager: Prettyfied Body received :\n%s" % pretty)
else:
if code == 200:
Log.trace("ServerManager Body received = %s" % str_body)
Log.trace("ServerManager: Body received = %s" % str_body)
else:
Log.warn("ServerManager Body received = %s" % str_body)
Log.warn("ServerManager: Body received = %s" % str_body)
if result != null:
json = result
else:
if code == 200:
Log.trace("ServerManager: result null after parsing String to JSON")
Log.trace("ServerManager: Result null after parsing String to JSON")
else:
Log.warn("ServerManager: result null after parsing String to JSON")
Log.warn("ServerManager: Result null after parsing String to JSON")
else:
if code == 200:
Log.trace("ServerManager Body received is empty")
Log.trace("ServerManager: Body received is empty")
else:
Log.warn("ServerManager Body received is empty")
Log.warn("ServerManager: Body received is empty")
success = result_code == OK and response_code == 200
request_completed.emit(success, response_code, json)
loading_rect.hide()
@@ -244,9 +244,9 @@ func _on_http_request_request_completed(result_code: int, response_code: int, _h
func _on_internet_check_request_completed(result_code: int, response_code: int, _headers: PackedStringArray, _body: PackedByteArray) -> void:
if result_code != OK:
Log.warn("Cannot check internet request. Error code %d = %s" % [result_code, error_string(result_code)])
Log.warn("ServerManager: Cannot check internet request. Error code %d = %s" % [result_code, error_string(result_code)])
else:
Log.trace("ServerManager Internet check completed.\n Response code = %s. (200 = OK)" % str(response_code))
Log.trace("ServerManager: Internet check completed.\n Response code = %s. (200 = OK)" % str(response_code))
success = result_code == OK and response_code == 200
internet_check_completed.emit(success)
+11 -11
View File
@@ -98,7 +98,7 @@ func stop_synchronization_timer() -> void:
func register(register_settings: TeacherSettings) -> bool:
if not register_settings:
Log.warn("UserDataManager: register called with invalid register_settings")
Log.warn("UserDataManager: Register: Function called with invalid register_settings")
return false
# Handles device settings
@@ -199,11 +199,11 @@ func safe_load_and_fix_resource(path: String, old_texts: Array[String], new_text
func set_device_id(device: int) -> bool:
if not _device_settings:
Log.warn("UserDataManager: set_device_id called with no device settings loaded")
Log.warn("UserDataManager: SetDeviceID: Function called with no device settings loaded")
return false
if not device:
Log.warn("UserDataManager: set_device_id called with invalid device")
Log.warn("UserDataManager: SetDeviceID: Function called with invalid device ID")
return false
_device_settings.device_id = device
@@ -233,10 +233,10 @@ func delete_teacher_data() -> void:
func student_exists(code: String) -> bool:
if not _device_settings:
Log.trace("UserDataManager: student_exists called with invalid _device_settings")
Log.trace("UserDataManager: StudentExists: Function failed because of invalid _device_settings")
return false
if not teacher_settings:
Log.trace("UserDataManager: student_exists called with invalid teacher_settings")
Log.trace("UserDataManager: StudentExists: Function failed because of invalid teacher_settings")
return false
var students: Array[StudentData] = teacher_settings.students[_device_settings.device_id] as Array[StudentData]
if students:
@@ -248,10 +248,10 @@ func student_exists(code: String) -> bool:
func login_student(code: String) -> bool:
if not _device_settings:
Log.warn("UserDataManager: login_student failed because of invalid _device_settings")
Log.warn("UserDataManager: LoginStudent: Function failed because of invalid _device_settings")
return false
if not teacher_settings:
Log.warn("UserDataManager: login_student failed because of invalid teacher_settings")
Log.warn("UserDataManager: LoginStudent: Function failed because of invalid teacher_settings")
return false
var students: Array[StudentData] = teacher_settings.students[_device_settings.device_id] as Array[StudentData]
@@ -262,16 +262,16 @@ func login_student(code: String) -> bool:
(ServerManager as ServerManagerClass).first_login_student()
return true
Log.warn("UserDataManager: login_student failed, code not found: " + code)
Log.warn("UserDataManager: LoginStudent: Code not found: " + code)
return false
func logout_student() -> bool:
if not _device_settings:
Log.warn("UserDataManager: logout_student failed because of invalid _device_settings")
Log.warn("UserDataManager: LogoutStudent: Function failed because of invalid _device_settings")
return false
if not teacher_settings:
Log.warn("UserDataManager: logout_student failed because of invalid teacher_settings")
Log.warn("UserDataManager: LogoutStudent: Function failed because of invalid teacher_settings")
return false
student = ""
@@ -569,7 +569,7 @@ func save_student_progression_for_code(device: int, code: int, progression: Stud
var progression_path: String = "user://".path_join(_device_settings.teacher).path_join(str(device)).path_join(_device_settings.language).path_join(str(code)).path_join("progression.tres")
var error: Error = ResourceSaver.save(progression, progression_path)
if error != OK:
Log.error("UserDataManager: save_student_progression_for_code(device = %s, code = %s): error %s" % [str(device), str(code), error_string(error)])
Log.error("UserDataManager: SaveStudentProgressionForCode: Device = %s, Code = %s: error %s" % [str(device), str(code), error_string(error)])
func set_student_progression_data(student_code: int, version: String, new_data: Dictionary[int, Dictionary], updated_at: String) -> void:
+3 -3
View File
@@ -39,13 +39,13 @@ func clean_dir(path: String) -> Error:
func delete_directory_recursive(path: String) -> void:
var err: Error = clean_dir(path)
if err != OK:
Log.error("Utils: Error " + error_string(err) + " while cleaning folder: %s" % path)
Log.error("Utils: DeleteDirectoryRecursive: Error " + error_string(err) + " while cleaning folder: %s" % path)
return
err = DirAccess.remove_absolute(path)
if err != OK:
Log.error("Utils: Error " + error_string(err) + " while deleting folder: %s" % path)
Log.error("Utils: DeleteDirectoryRecursive: Error " + error_string(err) + " while deleting folder: %s" % path)
else:
Log.info("Utils: Folder deleted: %s" % path)
Log.info("Utils: DeleteDirectoryRecursive: Folder deleted: %s" % path)
## Returns -1 if version_a is lower than version_b, 0 if they are equals, and 1 if version_a is greater than version_b