Compare localized path against editor scene path when reloading

[a-johnston]

Fixes 99232. Tested for res and absolute paths in the gd MRP given in the issue.

[KoBeWi]

The issue is not a bug. No editor API returns an absolute path of an opened scene, you need to manually globalize it. There is just no reason to do so and no reason to support it.
At most I'd document in reload_scene_from_path() description that it only supports project-local paths.

EDIT:
Interestingly, if you provide a path to a scene that isn't open, the current scene will be reloaded by default. This could be noted too.

[a-johnston]

🤷 I can't say I care too much about this, so I'll close the pr if it's not wanted. I just saw #99232 and noted that EditorNode::load_scene does handle converting absolute paths to local ones (and erroring if that path does not point to a local path) so I saw no reason why this couldn't accept an absolute path as well. It's not as though there is any ambiguity of what scene somebody is pointing at in the case of an absolute path so I don't know why the behavior wouldn't be made to match the other function while removing a quirk that would otherwise need to be documented.

[KoBeWi]

So I tried loading external scene (with open_scene_from_path()) and got

Though even if it was possible, these 2 methods are different. reload_scene() works by comparing the requested path with opened scenes. If you open a scene from external path, it will be referenced by that path and you need to provide it to reload_scene(). The API is awkward, but there is no reason to refer to the same scene from both external and local path.

[a-johnston]

Sorry for all the text, but I'm not sure that I understand the issue/pushback. I think there is confusion about the current behavior of the methods in question.

So I tried loading external scene (with open_scene_from_path()) and got

To be sure, this pr doesn't change handling for "truly" external scenes as they couldn't have been opened in the first place due to this warning/error. open_scene_from_path/load_scene does allow (with a caveat, see below) absolute paths so long as they can be localized to a resource within the project data.

Though even if it was possible, these 2 methods are different. reload_scene() works by comparing the requested path with opened scenes. If you open a scene from external path, it will be referenced by that path and you need to provide it to reload_scene().

Both methods actually do this. I had considered this and it seemed like all of the scene path checks would exclusively use and pass along the localized path, but I manually verified that to be the case as well. This did uncover a new and related bug where if you do pass load_scene an absolute path to a scene within the project, it fails to detect if the scene is already open and always creates a new tab for the same scene, even if the scene was previously opened with the absolute path. The change to reload_scene didn't reveal this bug on its own because the scene gets removed before the path is loaded again. The PR has been updated to fix it though.

The API is awkward, but there is no reason to refer to the same scene from both external and local path.

IMHO the reason is that both paths resolve to the same data on disk and having inconsistent handling of absolute and relative paths for data within the project leads to bugs and a less permissive api. Both load_scene and reload_scene currently accept but do not correctly work with absolute paths, and in both cases you can easily end up with diverging or lost scene changes.

[KoBeWi]

It's not like localizing the path will hurt, so whatevs.

[akien-mga]

Thanks!