dbos debug can't deserialize non primitive python types used as parameters

[devhawk]

If you have code like this in your entrypoint file:

class DataPipeline(BaseModel):
    platform: str
    content: str
    message_id: int

@DBOS.workflow()
def create_data_pipeline(request: DataPipeline):
    # code omitted

The request parameter doesn't get deserialized correctly when using the replay debugger.

[devhawk]

Initial investigation reveals the issue to be that parameter is serialized with the type name __main__.DataPipeline. WHen executing a python file directly, it's module name is set to __main__. However, when we run in the debugger, the module name changes so jsonpickle cannot locate the class to deserialize into.

[devhawk]

Workaround: move the parameter class declarations out of the entrypoint file. This will ensure the fully qualified type name will be consistent between normal execution and debugging.

[af-md]

Update: the workaround worked! unfortunately only on new workflows. I can't replay any of the execution prior to moving the Type declaration out of the main file

[devhawk]

Update: the workaround worked! unfortunately only on new workflows. I can't replay any of the execution prior to moving the Type declaration out of the main file

This is expected. Moving the type into a separate file gives it a consistent fully-qualified type name when launching directly and under the debugger. But this consistent type name is also different from the type name when the type was in the entrypoint file.

We are keeping this issue open until we implement a solution that does not require moving the type to a different file.