Callbacks not working anymore

[Telestes]

Hi MizunagiKB!

I'm very thankful that you made a PlayFab wrapper for Godot. I'm using your unofficial SDK since 10 months with very little problems. Since a few days callbacks are not working anymore (no code changes in my project, beta test run). In file PlayFabHttpClient.gd this code:

if status_curr != STATUS_BODY: if _current_request.o_result != null: if _current_request.o_result.update_count > 0: _current_request = dispatch(_current_request)

via dispatch() is responsible for calling the registered callback functions. But now the last code line isn't executed anymore and therefore no callbacks are called.

Do you have the same behavior?
Any ideas how to solve it?

Many thanks in advance,
-Telestes

Godot version 3.5

PS: Yes, I contacted PlayFab, see here https://community.playfab.com/questions/143179/any-api-changes-to-clientregisterplayfabuser-and-l.html

[MizunagiKB]

Hello, @Telestes

Upon investigating the issue, I found a bug in the CRequest of the PlayFabHttpClient.gd that I created.
The problem was that when the response format data sent from Playfab was in chunk format, the data could not be read correctly. I have now modified this so that if the data is in chunk format, it will continue to read the data until it is complete.

About the cause

I do not know why Playfab changed from a normal response to a chunk format,
but it is probably for the following reasons:

• To handle more connections, they may have added async processing and returned the data in chunks.
• Anticipating that the data size would increase, they may have decided to send the data in divided transmissions instead of all at once.

Either way, the fact that HTTP was not processed correctly is due to my code.

How to fix

I have just made a correction for this.

Please update PlayFab_GDScriptSdk and regenerate it with SDKGenerator.
https://github.com/MizunagiKB/PlayFab_GDScriptSdk

or

The direct modification is only in PlayFabHttpClient.gd, so it should work if you replace this.
https://github.com/MizunagiKB/PlayFab_GDScriptSdk/blob/main/proj/PlayFabSDK/PlayFabHttpClient.gd

[Telestes]

Hello MizunagiKB,

thank you for updating the 'PlayFabHttpClient.gd' code, it is working fine with chunked responses.
If PlayFab goes back to unchunked responses in the future, will the new code handle this correct also like in the past?

[MizunagiKB]

Please take the following as a premise before reading this text.

• This fix has not gone through code review or commercial product level testing.
• Both Godot Engine and Playfab are constantly updating, so it is unclear whether they will work in the future.

The fixed code assumes that Godot Engine’s implementation of HTTPClient::has_response succeeds only once before getting the response.

https://github.com/godotengine/godot/blob/3.5/core/io/http_client.cpp

Therefore, this behavior is unknown in future versions of Godot Engine, so I made another fix that does not rely on this behavior.

I just committed it, so you can apply this fix by updating to the latest version.

9ad0c69

About the question

The question you asked was “Does Playfab work even if it returns from Chunk to Body?”, which is about the behavior of HTTPClient implemented in Godot Engine.

I am not a developer of Godot Engine itself, but I can only judge from the results that are currently working, but in my 3.5.2, the actual data acquisition is done by read_response_body_chunk regardless of the response.

Please check the source code of Godot Engine to see how it actually works. Also, to verify the operation, you can create an HTTPServer that returns Body and Chunk for the same request and test both responses.

For example, you can prepare a test environment with the following code in Python.

import json

from fastapi import FastAPI
from fastapi.responses import JSONResponse, StreamingResponse

app = FastAPI()

response_count: int = 0
dictdata = {"strvalue": "0123456789ABCDEF", "intvalue": 1234}
jsontext = json.dumps(dictdata)


def gen_streaming_data():
    for v in jsontext:
        yield v


@app.post("/Client/RegisterPlayFabUser")
def Client_RegisterPlayFabUser():
    global response_count

    response_count += 1

    if response_count & 1:
        print("response body")
        return JSONResponse(dictdata)
    else:
        print("response chunked")
        return StreamingResponse(
            content=gen_streaming_data(),
            media_type="application/json",
        )

[Telestes]

Thank you for creating this second 'PlayFabHttpClient.gd' update, it works and addresses possible future changes. In line 319 is one equal sign too much, it should be status_curr = STATUS_DISCONNECTED
The issue can be closed.

[MizunagiKB]

Thank you for your bug report.
The issue has been resolved.

The bug you reported was indeed something that needed to be fixed.
Fortunately, we are always retrieving the current status at line 314.
Therefore, we were merely initializing the variable that holds the status, but it is true that we were performing an unintended operation.

If you hadn’t informed us, we might have left it as it is.
Your help was greatly appreciated.