Send protobuf payload from Typescript to Java and reverse

Eran_Itach · January 25, 2023, 7:13pm

Hi Temporal!

I’m trying to understand how to send a payload between Typescript SDK and JAVA.

I succeeded to run the workers and the workflows in both sides, so there is a connection between the projects.

In Typescript I tried to use several ways as you can see below.
I don’t know what is the proper way to send it from Typescript and the proper way to get it in JAVA and the reverse way also: JAVA to Typescript.

I tried the following:

I used protobufjs to generate protobuf and then I created a proto and send it as is.

 const testProto = test.create({test: "test1"});
 return testProto;

Then I tried to use the default converter like that:

 return defaultPayloadConverter.toPayload(testProto );

And also used custom payload converter with protobuf as you showed in you protobuf example in typescript-samples app:

 return payloadConverter.toPayload({test: "test1"});

I tried with plain object and also protobuf.

I see the conversion in the logs but in Java I got an error.

what should I do?
what is the proper way to send payloads between those two languages using Temporal?
should I use a regular JSON?
How to send payload from JAVA to Typescript? How do I need to handle this payload in Typescript?

bergundy · January 25, 2023, 8:46pm

The TypeScript SDK has a built-in protobuf payload converter, you’ll need to install that in your worker and client:

github.com

temporalio/sdk-typescript/blob/main/packages/test/src/payload-converters/proto-payload-converter.ts

import { DefaultPayloadConverterWithProtobufs } from '@temporalio/common/lib/protobufs';
import root, { foo } from '../../protos/root'; // eslint-disable-line import/default

// Used in tests
export const messageInstance = foo.bar.ProtoActivityInput.create({ name: 'Proto', age: 1 });

export const payloadConverter = new DefaultPayloadConverterWithProtobufs({ protobufRoot: root });

github.com

temporalio/sdk-typescript/blob/2dab03978c65a4ec10b8336f4ff81356e29b0568/packages/test/src/test-custom-payload-converter.ts#L31


      
              actual = { failed: { failure: { stackTrace: cleanOptionalStackTrace(stackTrace), ...rest } } };
            }
            t.deepEqual(
              coresdk.activity_result.ActivityExecutionResult.create(actual ?? undefined).toJSON(),
              coresdk.activity_result.ActivityExecutionResult.create(expected).toJSON()
            );
          }
          
          
if (RUN_INTEGRATION_TESTS) {
            test('Client and Worker work with provided dataConverter', async (t) => {
              const dataConverter = { payloadConverterPath: require.resolve('./payload-converters/proto-payload-converter') };
              const taskQueue = 'test-custom-payload-converter';
              const worker = await Worker.create({
                ...defaultOptions,
                workflowsPath: require.resolve('./workflows/protobufs'),
                taskQueue,
                dataConverter,
              });
              const client = new WorkflowClient({ dataConverter });
              await worker.runUntil(async () => {
                const result = await client.execute(protobufWorkflow, {

github.com

temporalio/sdk-typescript/blob/2dab03978c65a4ec10b8336f4ff81356e29b0568/packages/test/src/test-payload-converter.ts#L193


      
          });
          Runtime.install({ logger });
          
          
const taskQueue = `${__filename}/${t.title}`;
          const worker = await Worker.create({
            ...defaultOptions,
            workflowsPath: require.resolve('./workflows/protobufs'),
            taskQueue,
          });
          const client = new WorkflowClient({
            dataConverter: { payloadConverterPath: require.resolve('./payload-converters/proto-payload-converter') },
          });
          
          
const handle = await client.start(protobufWorkflow, {
            args: [messageInstance],
            workflowId: uuid4(),
            taskQueue,
          });
          
          
await worker.runUntil(async () => {
            try {

See also this doc in the repo: sdk-typescript/protobuf-libraries.md at main · temporalio/sdk-typescript · GitHub

Eran_Itach · January 26, 2023, 4:00pm

Thank you very much!

Topic		Replies	Views
Using protobuf for communication between java and typescript service Community Support java-sdk	2	655	January 27, 2023
Temporal SDK with typescript - json protobuf Community Support typescript-sdk , data-converter	10	755	January 3, 2024
Problem on running cross language workflow Community Support typescript-sdk	9	902	May 28, 2022
Protobuf data converter issue Community Support java-sdk	1	1179	July 19, 2020
How to use async function in custom payload converter Community Support typescript-sdk , data-converter	5	453	November 1, 2023

Send protobuf payload from Typescript to Java and reverse

Related topics