Skip to content
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.

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

[Bug] Sending a query that is not registered in the workflow results in an "Encoded failure" when encode_common_attributes=True #641

Open
antmendoza opened this issue Sep 11, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@antmendoza
Copy link
Member

What are you really trying to do?

List workflow queries using the UI (Queries tab)

image

Describe the bug

The UI shows "Encoded failure" but this is an error thrown by the worker when the UI tries to get the list of queries the workflow exposes with queryType: "@@temporal-internal__list

I get the same error when I use the client to send a query that is not registered in the workflow, and the client configuration has the data_converter which failure_converter_class has encode_common_attributes=True

Minimal Reproduction

Full reproduction is here https://github.com/antmendoza/my-temporal-pocs/tree/main/python/_8156

clone https://github.com/temporalio/samples-python/tree/main/encryption

Add the following modifications:

  • Create a new DefaultFailureConverter with encode_common_attributes=True
class FailureConverterWithDecodedAttributes(temporalio.DefaultFailureConverter):
    def __init__(self) -> None:
        super().__init__(encode_common_attributes=True)
  • Add failure_converter_class=FailureConverterWithDecodedAttributes to the client.
    client = await Client.connect(
        "localhost:7233",
        # Use the default converter, but change the codec
        data_converter=dataclasses.replace(
            temporalio.converter.default(),
            payload_codec=EncryptionCodec(),
            failure_converter_class=FailureConverterWithDecodedAttributes,
        ),
    )

After running a workflow, try to send a query that does not exist for the workflow.

        await client.get_workflow_handle("encryption-workflow-id").query("non-existing-query")

The query will fail with "Encoded failure"

@antmendoza antmendoza added the bug Something isn't working label Sep 11, 2024
@cretz
Copy link
Member

cretz commented Sep 11, 2024

Hrmm, so this is a general Temporal Core SDK issue where query failures use the Failure structure but the server doesn't support that for query failures. I will confer with the team on this.

@cretz
Copy link
Member

cretz commented Oct 10, 2024

I believe we have confirmed that this is due to the UI using query failures to populate the query list but encrypting these failures is incompatible with that. We have filed an issue with the UI team to support failure decryption.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants