isClient is false in OnDestroy

[Ghetaldus]

Describe the bug
When player disconnects isClient is false in OnDestroy on dedicated server.

[IMPORTANT] How can we reproduce the issue, step by step:
Please tell us how to reproduce your issue, STEP BY STEP, with one of our built in examples.

• Import latest Mirror version from git
• Open scene MirrorBasic from Basic example
• Open Player script from Basic example and add OnDestroy with debugs, like so for example:

void OnDestroy()
{
    Debug.Log("isClient " + isClient);
    Debug.Log("isLocalPlayer " + isLocalPlayer);
    Debug.Log("isServer " + isServer);
    Debug.Log("NetworkClient.active " + NetworkClient.active);
    Debug.Log("NetworkServer.active " + NetworkServer.active);
}

• Build it
• Start in Unity editor as server only
• Run your build as a client
• Stop Client and look at the logs in Unity editor console

Expected behavior
isClient should be true in OnDestroy

Desktop (please complete the following information):

• OS: Windows 10
• Build target: Standalone, Windows
• Unity version: 2021.3.35 & 2022.3.21
• Mirror branch: 89.7.4

[Ghetaldus]

Also just found that tests for isServer OnDestroy are also failing.

[Ghetaldus]

Here are some more finds I've made while debugging:

• Destroy in NetworkServer calls on Unspawn(obj) and right after that destroys the object (which calls OnDestroy on these objects)
• Unspawn(obj) calls on identity.ResetState(), which resets all the bools (isClient, isServer etc) to false
• That in turn makes all those bools always false for us in OnDestroy

[miwarnec]

Checking!

[miwarnec]

Hey @Ghetaldus maybe I am misunderstanding this.

• You are starting the server-only
• You connect a client
• You disconnect the client
• You expect IsClient to be 'true' on the server?

That's what you mentioned in the first post.
IsClient is only ever true on 'client', never on 'server', so this behaviour would correct as is no?

If I test the other way around: build=server-only, editor=client, the IsClient flag is true as we would expect:

[Ghetaldus]

Yeah, you are right there with isClient.
However even isServer flag is cleared out on the server before OnDestroy happens.

You can run tests for OnDestroyIsServerTrue and you will see that these fails.

[MrGadget1024]

@Ghetaldus

Also just found that tests for isServer OnDestroy are also failing.

You're looking at PlayMode tests - we haven't maintained those in ages because CI doesn't run them. The tests themselves are broken.

[MrGadget1024]

• Destroy in NetworkServer calls on Unspawn(obj) and right after that destroys the object (which calls OnDestroy on these objects)
• Unspawn(obj) calls on identity.ResetState(), which resets all the bools (isClient, isServer etc) to false
• That in turn makes all those bools always false for us in OnDestroy

Override OnStopServer and OnStopClient instead. Also you should be calling NetworkServer.Destroy instead of just Destroy.

[Ghetaldus]

Thanks Mr. G! I've already started refactoring code to use OnStopServer/OnStopClient, instead of OnDestroy.

[miwarnec]

I checked the server logs again.

You are right, isServer is false there.

[miwarnec]

call stack:

[miwarnec]

fixed:

PR: #3848
thanks for reporting @Ghetaldus