LokGlobalStorageManager don't use File property on StorageAccessor

[Zehir]

Describe the bug
Hello,

I am trying to start using this plugin and it's seems there is an issue here.
I think the File property on the LokStorageAccessor is not used.

To Reproduce
Steps to reproduce the behavior:
With a simple scene ;

And the LokStorageAccessor node ;

And a plugin configuration ;

I have a script on the Game node to test load and save data;

func _ready():
	LokGlobalStorageManager.load_data()
	await LokGlobalStorageManager.loading_finished
	LokGlobalStorageManager.save_data()

And a resource to save/load data ;

class_name GameSaver extends LokStorageAccessorVersion

func _retrieve_data(deps: Dictionary) -> Dictionary:
	prints("GameSaver", "_retrieve_data")
	var game: Game = deps.get(&"game")
	
	return {
		"count": randf()
	}

func _consume_data(res: Dictionary, deps: Dictionary) -> void:
	prints("GameSaver", "_consume_data")
	var game: Game = deps.get(&"game")
	
	var data: Dictionary = res.get("data")
	var error: Error = res.get("status")
	
	if error:
		print("no save")
	print(data.get("count"))

What I get
I am getting a file at user://saves/save/save_2.json

{
	"game_id": {
		"count": 0.794093430042267,
		"version": "1.0.0"
	}
}

And then when reloading the game I am getting the correct data.

Expected behavior
I am expecting that the file name was user://saves/save_foo/save_2.json

Second test
If I do the loading with this code instead ;

@onready var lok_storage_accessor: LokStorageAccessor = $LokStorageAccessor
func _ready():
	lok_storage_accessor.load_data()
	await lok_storage_accessor.loading_finished
	lok_storage_accessor.save_data()

I am getting the correct file name : user://saves/save_foo/save_2.json

Desktop (please complete the following information):
Godot v4.4.stable (4c311cbee) - Windows 11 (build 22631) - Multi-window, 2 monitors - Vulkan (Mobile) - dedicated NVIDIA GeForce RTX 3080 (NVIDIA; 32.0.15.6636) - 12th Gen Intel(R) Core(TM) i9-12900K (24 threads)

[nadjiel]

Hello! So, actually, that's not a bug, it's part of the implementation. It's understandable that you assumed it should behave that way. I do plan on adding more to the documentation about this topic.

What happens is that the LokGlobalStorageManager realizes its operations with all its known LokStorageAccessors
as a whole, so when using the save_data, load_data, read_data and remove_data methods from that autoload, only one save file is accessed per time. That's what you did in this part:

func _ready():
	LokGlobalStorageManager.load_data()
	await LokGlobalStorageManager.loading_finished
	LokGlobalStorageManager.save_data()

The save file used by this method can be defined by the current_file property of the LokGlobalStorageManager, which is inherited from the LokStorageManager. In your case, since you didn't define that property, the save file defaulted to "save", which is just the preffix you configured in the ProjectSettings.

Using the file from multiple LokStorageAccessors in those operations would mean having to realize one operation for each file of those LokStorageAccessors, which would implicate in multiple operations.

When it's wanted to realize operations targeting the LokStorageAccessors files, their own operation methods (save_data, load_data and remove_data) can be used, like you showed in your example:

Second test If I do the loading with this code instead ;

@onready var lok_storage_accessor: LokStorageAccessor = $LokStorageAccessor
func _ready():
	lok_storage_accessor.load_data()
	await lok_storage_accessor.loading_finished
	lok_storage_accessor.save_data()

I am getting the correct file name : user://saves/save_foo/save_2.json

If it's wanted to realize those operations for multiple LokStorageAccessors at once, the LokStorageAccessorGroup's methods save_accessor_group, load_accessor_group and remove_accessor_group can be used.
These methods just essentially call the individual operation methods of each LokStorageAccessor involved. That means that their own methods end up being called, which makes their file property be used in the process.
Since the LokGlobalStorageManager inherits from that LokStorageAccessorGroup class, it can also be used with that purpose.

There's an example showing how that access is made using LokStorageAccessorGroups. It's the file_choosing example. There aren't a lot of comments in it currently, but I think you will understand based on what I explained here.

If you have more questions, though, feel free to ask :)

[Zehir]

Thanks a lot for that detailed response but what did you call an operation ? It's like reading the file to the disk once and call one or many accessors ?

[nadjiel]

In this case, an operation would be the process of accessing (saving, loading or removing) from one save file. This can include one or more partitions and one or more LokStorageAccessors.