Merge pull request #157 from TaloDev/develop

Release 0.36.0

Author: tudddorrr

addons/talo/apis/health_check_api.gd

@@ -5,7 +5,37 @@ class_name HealthCheckAPI extends TaloAPI
 ##
 ## @tutorial: https://docs.trytalo.com/docs/godot/continuity
 
+enum HealthCheckStatus {
+	OK,
+	FAILED,
+	UNKNOWN
+}
+
+## Emitted when internet connectivity is lost.
+signal connection_lost()
+
+## Emitted when internet connectivity is restored.
+signal connection_restored()
+
+var _last_health_check_status := HealthCheckStatus.UNKNOWN
+
 ## Ping the Talo Health Check API to check if Talo can be reached.
 func ping() -> bool:
 	var res := await client.make_request(HTTPClient.METHOD_GET, "")
-	return res.status == 204
+	var success := true if res.status == 204 else false
+	var failed_last_health_check := true if _last_health_check_status == HealthCheckStatus.FAILED else false
+
+	if success:
+		_last_health_check_status = HealthCheckStatus.OK
+		if failed_last_health_check:
+			connection_restored.emit()
+	else:
+		_last_health_check_status = HealthCheckStatus.FAILED
+		if not failed_last_health_check:
+			connection_lost.emit()
+
+	return success
+
+## Get the latest known health check status.
+func get_last_status() -> HealthCheckStatus:
+	return _last_health_check_status

addons/talo/apis/players_api.gd

@@ -17,6 +17,10 @@ signal identification_failed()
 ## Emitted after calling clear_identity().
 signal identity_cleared()
 
+func _ready() -> void:
+	await Talo.init_completed
+	Talo.health_check.connection_restored.connect(_on_connection_restored)
+
 func _handle_identify_success(alias: TaloPlayerAlias, socket_token: String = "") -> TaloPlayer:
 	if not await Talo.is_offline():
 		Talo.socket.reset_connection()
@@ -137,6 +141,24 @@ func clear_identity() -> void:
 
 	identity_cleared.emit()
 
+## Create a new socket token. The Talo socket will use this token to identify the player.
+func create_socket_token() -> String:
+	if Talo.identity_check() != OK:
+		return ""
+	
+	var res := await client.make_request(HTTPClient.METHOD_POST, "/socket-token")
+	match res.status:
+		200:
+			return res.body.socketToken
+		_:
+			return ""
+
+func _on_connection_restored():
+	await Talo.socket.reset_connection()
+	if Talo.identity_check() == OK:
+		var socket_token := await create_socket_token()
+		Talo.socket.set_socket_token(socket_token)
+
 class SearchPage:
 	var players: Array[TaloPlayer]
 	var count: int

addons/talo/apis/saves_api.gd

@@ -57,7 +57,8 @@ func get_saves() -> Array[TaloGameSave]:
 		match res.status:
 			200:
 				online_saves.append_array(res.body.saves.map(func (data: Dictionary): return TaloGameSave.new(data)))
-				saves.append_array(await _saves_manager.get_synced_saves(online_saves))
+				var synced_saves := await _saves_manager.get_synced_saves(online_saves)
+				saves.append_array(synced_saves)
 
 	_saves_manager.all_saves = saves
 	saves_loaded.emit()
@@ -146,10 +147,8 @@ func delete_save(save: TaloGameSave) -> void:
 			return
 
 		var res := await client.make_request(HTTPClient.METHOD_DELETE, "/%s" % save.id)
-
-		match res.status:
-			_:
-				return
+		if res.status != 204:
+			return
 
 	_saves_manager.all_saves = _saves_manager.all_saves.filter(func (s: TaloGameSave): s.id != save.id)
 	_saves_manager.delete_offline_save(save)

addons/talo/plugin.cfg

@@ -3,5 +3,5 @@
 name="Talo Game Services"
 description="Talo (https://trytalo.com) is an open-source game backend. Talo's Godot plugin is the easiest way to add leaderboards, player authentication, socket-based multiplayer and more to your game."
 author="trytalo"
-version="0.35.0"
+version="0.36.0"
 script="talo_autoload.gd"

addons/talo/talo_client.gd

@@ -1,7 +1,7 @@
 class_name TaloClient extends Node
 
 # automatically updated with a pre-commit hook
-const TALO_CLIENT_VERSION = "0.35.0"
+const TALO_CLIENT_VERSION = "0.36.0"
 
 var _base_url: String
 
@@ -65,10 +65,10 @@ func make_request(method: HTTPClient.Method, url: String, body: Dictionary = {},
 		])
 
 	if Talo.settings.log_responses:
-		print_rich("[color=green]--> %s %s %s %s[/color]" % [
+		print_rich("[color=green]--> %s %s [%s] %s[/color]" % [
 			_get_method_name(method),
 			full_url,
-			"[%s]" % status,
+			status,
 			json.data
 		])
 
@@ -78,8 +78,9 @@ func make_request(method: HTTPClient.Method, url: String, body: Dictionary = {},
 	}
 
 	if ret.status >= 400:
-		handle_error(ret)
+		handle_error(method, url, ret)
 
+	await Talo.continuity_manager.handle_post_response_healthcheck(full_url, res)
 	if Talo.continuity_manager.request_can_be_replayed(method, full_url, res):
 		Talo.continuity_manager.push_request(method, full_url, body, all_headers, continuity_timestamp)
 
@@ -118,17 +119,17 @@ func _build_full_url(url: String) -> String:
 		url.replace(" ", "%20")
 	]
 
-func handle_error(res: Dictionary) -> void:
+func handle_error(method: HTTPClient.Method, url: String, res: Dictionary) -> void:
 	if res.body != null:
 		if res.body.has("message"):
-			push_error("%s: %s" % [res.status, res.body.message])
+			push_error("%s %s [%s]: %s" % [_get_method_name(method), url, res.status, res.body.message])
 			return
 
 		if res.body.has("errors"):
-			push_error("%s: %s" % [res.status, res.body.errors])
+			push_error("%s %s [%s]: %s" % [_get_method_name(method), url, res.status, res.body.errors])
 			return
 
-	push_error("%s: Unknown error" % res.status)
+	push_error("%s %s [%s]: Unknown error" % [_get_method_name(method), url, res.status])
 
 class TaloClientResponse:
 	var result: int

addons/talo/talo_settings.gd

@@ -8,6 +8,9 @@ var _config_file: ConfigFile
 const SETTINGS_PATH := "res://addons/talo/settings.cfg"
 const DEFAULT_API_URL := "https://api.trytalo.com"
 
+const DEV_FEATURE_TAG := "talo_dev"
+const LIVE_FEATURE_TAG := "talo_live"
+
 ## Your Talo access key, allowing you to connect to the Talo API and access data based on its scopes
 var access_key: String:
 	get:
@@ -109,7 +112,11 @@ func _init() -> void:
 			print_rich("[color=yellow]Warning: Talo access_key in settings.cfg is empty[/color]")
 
 func is_debug_build() -> bool:
-	return OS.is_debug_build()
+	if OS.has_feature(LIVE_FEATURE_TAG):
+		return false
+	if OS.has_feature(DEV_FEATURE_TAG):
+		return true
+	return OS.is_debug_build() 
 
 ## Save the Talo settings to the config file
 func save_config():

addons/talo/talo_socket.gd

@@ -103,9 +103,6 @@ func close_connection(code: int = 1000, reason: String = "") -> void:
 
 ## Close the current connection and create a new connection to the Talo Socket server.
 func reset_connection() -> void:
-	if not _identified:
-		return
-
 	close_connection()
 	_reset_socket()
 	open_connection()

addons/talo/utils/continuity_manager.gd

@@ -6,8 +6,9 @@ var _requests: Array = []
 const _CONTINUITY_PATH = "user://tc.bin"
 const _CONTINUITY_TIMESTAMP_HEADER = "X-Talo-Continuity-Timestamp"
 
+const _HEALTH_CHECK_ENDPOINT := "/v1/health-check"
 const _EXCLUDED_ENDPOINTS: Array[String] = [
-	"/v1/health-check",
+	_HEALTH_CHECK_ENDPOINT,
 	"/v1/players/auth",
 	"/v1/players/identify",
 	"/v1/socket-tickets"
@@ -96,3 +97,18 @@ func request_can_be_replayed(method: HTTPClient.Method, url: String, res: TaloCl
 func clear_requests() -> void:
 	_requests.clear()
 	_write_requests()
+
+func handle_post_response_healthcheck(url: String, res: TaloClient.TaloClientResponse):
+	if url.find(_HEALTH_CHECK_ENDPOINT) != -1:
+		return
+
+	var success := true if res.result == HTTPRequest.RESULT_SUCCESS else false
+
+	if success:
+		# if offline mode is enabled, check if it should be disabled
+		if Talo.health_check.get_last_status() == Talo.health_check.HealthCheckStatus.FAILED:
+			await Talo.health_check.ping()
+	else:
+		# if offline mode isn't enabled, check if it should be enabled
+		if Talo.health_check.get_last_status() != Talo.health_check.HealthCheckStatus.FAILED:
+			await Talo.health_check.ping()

addons/talo/utils/saves_manager.gd

@@ -64,17 +64,19 @@ func get_synced_saves(online_saves: Array[TaloGameSave]) -> Array[TaloGameSave]:
 	var saves: Array[TaloGameSave] = []
 	var offline_saves: Array[TaloGameSave] = read_offline_saves()
 
-	if not offline_saves.is_empty():
+	if offline_saves.is_empty():
+		saves.append_array(online_saves)
+	else:
 		for online_save in online_saves:
 			var filtered := offline_saves.filter(func (save: TaloGameSave): return save.id == online_save.id)
 			if not filtered.is_empty():
-				var save := await sync_save(online_save, filtered.front())
-				saves.push_back(save)
+				var synced_save := await sync_save(online_save, filtered.front())
+				saves.push_back(synced_save)
 			else:
 				saves.push_back(online_save)
 
-		var synced_saves := await sync_offline_saves(offline_saves)
-		saves.append_array(synced_saves)
+		var synced_offline_saves := await sync_offline_saves(offline_saves)
+		saves.append_array(synced_offline_saves)
 
 	return saves