[ts][phaser] SpinePlugin incorrect lifecycle for handling of resize events in a scene

[kimdanielarthur-cowlabs]

SpinePlugin listens to the Phaser.Scale.Events.RESIZE event in order to udpate the renderer camera on viewport resizes.

Current implementation:

• event listener added at scene plugin boot()
• event listener removed on scene shutdown

This breaks with the lifecycle pattern of Phaser scenes where a scene can be started and shutdown multiple times. shutdown may occur for every start.

Reproduction and symptoms;

1. Load app
2. scene.start("LevelSceneKey", levelData)
3. observe resize events render correctly at different sizes
4. scene.start("LevelSceneKey", level2Data)
5. observe resizing viewport causes spine rendering to be squashed and aspect ratio incorrect as SpinePlugin viewport is not updated

Suggested fix:

• Move the removal of event listener to scene destroy instead of shutdown which should represent the same points in life and death of scene

[davidetan]

Thanks for reporting this. I'll take care of it approximately in a couple of week!

[kimdanielarthur-cowlabs]

Sounds good! Meanwhile workaround is easy as calling resize on SpinePlugin manually

[davidetan]

I'm back!
Unfortunately, I am not able to reproduce the issue. What you say makes a lot of sense, but even when following the steps you described above, the onResize is invoked correctly.

Can you share a small repro project?

[kimdanielarthur-cowlabs]

Maybe if you share your repro project i can just use that to see if i can get it to happen there?

[davidetan]

It's usually the other way around. Users reporting bugs should share a repro :)

I just updated our basic example locally, you can easily do the same.

[kimdanielarthur-cowlabs]

hehe yes for sure :)

Was just thinking that you had an example project where you had tried to reproduce it but were not able and I could just look at that to see if it is the same pattern that causes it on my end.

but if you dont i can see if I can see if there is time to make a repro

[davidetan]

In the example above I just added an event listener to (re)start the current scene, as you described above. After I restart the scene, the resize callback is still invoked.

[kimdanielarthur-cowlabs]

It could be different behaviour if restarting current scene, my game does

SceneA->destroy->LoadingScene->destroy->SceneA

[davidetan]

Ok, I was finally able to reproduce the issue.
I think that it does not make any sense that the resize callback is invoked all the times. It should be invoked only when the scene is active.

So, probably is correct to remove the listener on shutdown, but it should be added on start, rather than once on boot.

[kimdanielarthur-cowlabs]

Yes exactly, perfect!