Skip to content

fix(external-storage): correct the reference check #313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jmaeagle99 merged 1 commit into from
May 21, 2026
+9 −6
Merged

fix(external-storage): correct the reference check #313

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions external_storage/handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,20 @@
from aiohttp import web
from google.protobuf import json_format
from temporalio.api.common.v1 import Payload, Payloads
from temporalio.api.sdk.v1 import ExternalStorageReference
from temporalio.converter import ExternalStorage, PayloadCodec

_REFERENCE_MESSAGE_TYPE = ExternalStorageReference.DESCRIPTOR.full_name.encode()

def _is_storage_reference(payload: Payload) -> bool:
"""A payload is an external-storage reference iff it carries external_payloads metadata.

When the SDK offloads a payload to external storage it replaces the
in-band bytes with a small protobuf "claim check" — the ``external_payloads``
repeated field is the marker the SDK uses to recognize it on the way back.
def _is_storage_reference(payload: Payload) -> bool:
"""A payload is an external-storage reference iff its metadata identifies
it as a serialized :class:`ExternalStorageReference` claim check.
"""
return len(payload.external_payloads) > 0
return (
payload.metadata.get("encoding") == b"json/protobuf"
and payload.metadata.get("messageType") == _REFERENCE_MESSAGE_TYPE
)
Comment thread
jmaeagle99 marked this conversation as resolved.


def payload_routes(
Expand Down
Loading