Emit null on loading a Snapshot that was not found

Signed-off-by: Jacob Ibáñez Sánchez <jacobibanez@jacobibanez.com>

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.8.3
+### Return null when Snapshot is not found
+Ass suggested by @TheSkyOne in [this issue](https://github.com/Iakobs/godot-play-game-services/issues/38), when calling to `SnapshotClient.load_game()` and the snapshot is not found, the `game_loaded` signal will now return a null, instead of not being emitted at all as before.
+
 ## v1.8.2
 ### Add origin field to SnapshotConflict object
 As suggested by @RProduction in [this issue](https://github.com/Iakobs/godot-play-game-services/issues/35), I added an `origin` field to the `SnapshotConflict` object coming in the `SnapshotClient.conflict_emitted` signal. This field value is either `SAVE` or `LOAD`, indicating what method originally triggered the Snapshot conflict.

plugin/demo/scenes/snapshots/Snapshots.gd

@@ -49,6 +49,10 @@ func _connect_save_game_data() -> void:
 	)
 	SnapshotsClient.game_loaded.connect(
 		func(snapshot: SnapshotsClient.Snapshot):
+			if snapshot == null:
+				print("Snapshot not found!")
+				return
+
 			_reset_save_game_data()
 
 			var metadata = snapshot.metadata

plugin/export_scripts_template/autoloads/snapshots_client.gd

@@ -14,7 +14,7 @@ signal game_saved(is_saved: bool, save_data_name: String, save_data_description:
 ## a saved game in the window presented after calling the [method show_saved_games]
 ## method.[br]
 ## [br]
-## [param snapshot]: The loaded snapshot.
+## [param snapshot]: The loaded snapshot, or null if the snapshot wasn't found.
 signal game_loaded(snapshot: Snapshot)
 
 ## Signal emitted after saving or loading a game, if a conflict is found.[br]
@@ -38,7 +38,10 @@ func _ready() -> void:
 		)
 		GodotPlayGameServices.android_plugin.gameLoaded.connect(func(json_data: String):
 			var safe_dictionary := GodotPlayGameServices.json_marshaller.safe_parse_dictionary(json_data)
-			game_loaded.emit(Snapshot.new(safe_dictionary))
+			if safe_dictionary.is_empty():
+				game_loaded.emit(null)
+			else:
+				game_loaded.emit(Snapshot.new(safe_dictionary))
 		)
 		GodotPlayGameServices.android_plugin.conflictEmitted.connect(func(json_data: String):
 			var safe_dictionary := GodotPlayGameServices.json_marshaller.safe_parse_dictionary(json_data)

plugin/export_scripts_template/marshalling/json_marshaller.gd

@@ -34,6 +34,8 @@ func safe_parse_dictionary(json_dictionary: String) -> Dictionary:
 		var data_received = _json.data
 		if typeof(data_received) == TYPE_DICTIONARY:
 			return data_received
+		elif typeof(data_received) == TYPE_NIL:
+			return {}
 		else:
 			printerr("Unexpected data received from JSON Dictionary:\n%s" % json_dictionary)
 	else:

plugin/export_scripts_template/plugin.cfg

@@ -3,5 +3,5 @@
 name="GodotPlayGameServices"
 description="A Godot 4.3 plugin for Google Play Game Services"
 author="Jacob Ibáñez Sánchez"
-version="1.8.2"
+version="1.8.3"
 script="export_plugin.gd"

plugin/src/main/java/com/jacobibanez/plugin/android/godotplaygameservices/signals/Signals.kt

@@ -186,7 +186,7 @@ object SnapshotSignals {
      * This signal is emitted when calling the [com.jacobibanez.plugin.android.godotplaygameservices.GodotAndroidPlugin.loadGame] method
      * or after selecting a saved game in the window opened by the [com.jacobibanez.plugin.android.godotplaygameservices.GodotAndroidPlugin.showSavedGames] method.
      *
-     * @return A [Dictionary] representing a [com.google.android.gms.games.snapshot.Snapshot](https://developers.google.com/android/reference/com/google/android/gms/games/snapshot/Snapshot).
+     * @return A [Dictionary] representing a [com.google.android.gms.games.snapshot.Snapshot](https://developers.google.com/android/reference/com/google/android/gms/games/snapshot/Snapshot) or null if the Snapshot wasn't found.
      */
     val gameLoaded = SignalInfo("gameLoaded", String::class.java)
 

plugin/src/main/java/com/jacobibanez/plugin/android/godotplaygameservices/snapshots/SnapshotsProxy.kt

@@ -4,6 +4,7 @@ import android.app.Activity
 import android.content.Intent
 import android.util.Log
 import androidx.core.app.ActivityCompat
+import com.google.android.gms.common.api.ApiException
 import com.google.android.gms.games.PlayGames
 import com.google.android.gms.games.SnapshotsClient
 import com.google.android.gms.games.SnapshotsClient.EXTRA_SNAPSHOT_METADATA
@@ -33,6 +34,7 @@ class SnapshotsProxy(
     private val tag = SnapshotsProxy::class.java.simpleName
 
     private val showSavedGamesRequestCode = 9010
+    private val snapshotNotFoundCode = 26570
 
     fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
         if (requestCode == showSavedGamesRequestCode && resultCode == Activity.RESULT_OK) {
@@ -116,10 +118,19 @@ class SnapshotsProxy(
                         )
                     }
                 } else {
+                    val exception = task.exception
                     Log.e(
                         tag,
-                        "Error while opening Snapshot $fileName for loading. Cause: ${task.exception}"
+                        "Error while opening Snapshot $fileName for loading. Cause: $exception"
                     )
+                    if (exception is ApiException && exception.statusCode == snapshotNotFoundCode) {
+                        emitSignal(
+                            godot,
+                            GODOT_PLUGIN_NAME,
+                            gameLoaded,
+                            Gson().toJson(null)
+                        )
+                    }
                 }
             }
     }