feat: support raw value

Author: xepozz

src/DataConverter/DataConverter.php

@@ -33,6 +33,7 @@ public static function createDefault(): DataConverterInterface
         return new DataConverter(
             new NullConverter(),
             new BinaryConverter(),
+            new RawValueConverter(),
             new ProtoJsonConverter(),
             new ProtoConverter(),
             new JsonConverter(),
@@ -47,7 +48,7 @@ public function fromPayload(Payload $payload, $type)
         $encoding = $meta[EncodingKeys::METADATA_ENCODING_KEY];
 
         if (!isset($this->converters[$encoding])) {
-            throw new DataConverterException(\sprintf('Undefined payload encoding %s', $encoding));
+            throw new DataConverterException(\sprintf('Undefined payload encoding "%s"', $encoding));
         }
 
         $type = Type::create($type);

src/DataConverter/EncodingKeys.php

@@ -17,6 +17,7 @@ final class EncodingKeys
     public const METADATA_MESSAGE_TYPE = 'messageType';
     public const METADATA_ENCODING_NULL = 'binary/null';
     public const METADATA_ENCODING_RAW = 'binary/plain';
+    public const METADATA_ENCODING_RAW_VALUE = 'binary';
     public const METADATA_ENCODING_JSON = 'json/plain';
     public const METADATA_ENCODING_PROTOBUF_JSON = 'json/protobuf';
     public const METADATA_ENCODING_PROTOBUF = 'binary/protobuf';

src/DataConverter/RawValue.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * This file is part of Temporal package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Temporal\DataConverter;
+
+use Temporal\Api\Common\V1\Payload;
+
+final class RawValue
+{
+    private Payload $payload;
+
+    public function __construct(Payload $data)
+    {
+        $this->payload = $data;
+    }
+
+    public function getPayload(): Payload
+    {
+        return $this->payload;
+    }
+}

src/DataConverter/RawValueConverter.php

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * This file is part of Temporal package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Temporal\DataConverter;
+
+use Temporal\Api\Common\V1\Payload;
+use Temporal\Exception\DataConverterException;
+
+class RawValueConverter extends Converter
+{
+    public function getEncodingType(): string
+    {
+        return EncodingKeys::METADATA_ENCODING_RAW_VALUE;
+    }
+
+    public function toPayload($value): ?Payload
+    {
+        if (!$value instanceof RawValue) {
+            return null;
+        }
+
+        $payload = $value->getPayload();
+        $payload->setMetadata([EncodingKeys::METADATA_ENCODING_KEY => EncodingKeys::METADATA_ENCODING_RAW_VALUE]);
+
+        return $payload;
+    }
+
+    public function fromPayload(Payload $payload, Type $type): RawValue
+    {
+        if (!$type->isClass() || $type->getName() !== RawValue::class) {
+            throw new DataConverterException(\sprintf('Unable to convert raw data to non %s type', RawValue::class));
+        }
+
+        return new RawValue($payload);
+    }
+}

tests/Acceptance/App/Feature/ClientFactory.php

@@ -4,6 +4,7 @@
 
 namespace Temporal\Tests\Acceptance\App\Feature;
 
+use Temporal\DataConverter\RawValueConverter;
 use Temporal\Tests\Acceptance\App\Attribute\Client;
 use Temporal\Tests\Acceptance\App\Runtime\State;
 use Psr\Container\ContainerInterface;
@@ -52,6 +53,7 @@ public function workflowClient(\ReflectionParameter $context): WorkflowClientInt
         if ($attribute->payloadConverters !== []) {
             $converters = [
                 new NullConverter(),
+                new RawValueConverter(),
                 new BinaryConverter(),
                 new ProtoConverter(),
                 new ProtoJsonConverter(),

tests/Acceptance/Harness/DataConverter/RawValueTest.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Temporal\Tests\Acceptance\Harness\DataConverter\RawValue;
+
+use PHPUnit\Framework\Attributes\Test;
+use Temporal\Api\Common\V1\Payload;
+use Temporal\Api\Workflowservice\V1\StartWorkflowExecutionRequest;
+use Temporal\Client\GRPC\ContextInterface;
+use Temporal\Client\WorkflowStubInterface;
+use Temporal\DataConverter\EncodedValues;
+use Temporal\DataConverter\EncodingKeys;
+use Temporal\DataConverter\RawValue;
+use Temporal\Interceptor\GrpcClientInterceptor;
+use Temporal\Interceptor\PipelineProvider;
+use Temporal\Interceptor\SimplePipelineProvider;
+use Temporal\Interceptor\Trait\WorkflowClientCallsInterceptorTrait;
+use Temporal\Interceptor\WorkflowClient\GetResultInput;
+use Temporal\Interceptor\WorkflowClientCallsInterceptor;
+use Temporal\Tests\Acceptance\App\Attribute\Client;
+use Temporal\Tests\Acceptance\App\Attribute\Stub;
+use Temporal\Tests\Acceptance\App\TestCase;
+use Temporal\Workflow\WorkflowInterface;
+use Temporal\Workflow\WorkflowMethod;
+
+class RawValueTest extends TestCase
+{
+    private Interceptor $interceptor;
+
+    public function pipelineProvider(): PipelineProvider
+    {
+        return new SimplePipelineProvider([$this->interceptor]);
+    }
+
+    #[Test]
+    public function check(
+        #[Stub('Harness_DataConverter_RawValue')]
+        #[Client(pipelineProvider: [self::class, 'pipelineProvider'])]
+        WorkflowStubInterface $stub,
+    ): void {
+        $result = $stub->getResult(RawValue::class);
+
+        self::assertInstanceOf(RawValue::class, $result);
+        self::assertInstanceOf(Payload::class, $result->getPayload());
+        self::assertSame('hello world', $result->getPayload()->getData());
+
+        # Check arguments
+        self::assertNotNull($this->interceptor->startRequest);
+        self::assertNotNull($this->interceptor->result);
+
+        /** @var Payload $payload */
+        $payload = $this->interceptor->startRequest->getInput()?->getPayloads()[0] ?? null;
+        self::assertNotNull($payload);
+
+        self::assertSame(EncodingKeys::METADATA_ENCODING_RAW_VALUE, $payload->getMetadata()['encoding']);
+
+        // Check result value from interceptor
+        /** @var Payload $resultPayload */
+        $resultPayload = $this->interceptor->result->toPayloads()->getPayloads()[0];
+        self::assertSame(EncodingKeys::METADATA_ENCODING_RAW_VALUE, $resultPayload->getMetadata()['encoding']);
+    }
+
+    protected function setUp(): void
+    {
+        $this->interceptor = new Interceptor();
+        parent::setUp();
+    }
+}
+
+#[WorkflowInterface]
+class FeatureWorkflow
+{
+    #[WorkflowMethod('Harness_DataConverter_RawValue')]
+    public function run()
+    {
+        return yield new RawValue(new Payload(['data' => 'hello world']));
+    }
+}
+
+class Interceptor implements GrpcClientInterceptor, WorkflowClientCallsInterceptor
+{
+    use WorkflowClientCallsInterceptorTrait;
+
+    public ?StartWorkflowExecutionRequest $startRequest = null;
+    public ?EncodedValues $result = null;
+
+    public function interceptCall(string $method, object $arg, ContextInterface $ctx, callable $next): object
+    {
+        $arg instanceof StartWorkflowExecutionRequest and $this->startRequest = $arg;
+        return $next($method, $arg, $ctx);
+    }
+
+    public function getResult(GetResultInput $input, callable $next): ?EncodedValues
+    {
+        return $this->result = $next($input);
+    }
+}

tests/Acceptance/worker.php

@@ -21,6 +21,7 @@
 use Temporal\DataConverter\NullConverter;
 use Temporal\DataConverter\ProtoConverter;
 use Temporal\DataConverter\ProtoJsonConverter;
+use Temporal\DataConverter\RawValueConverter;
 use Temporal\Internal\Support\StackRenderer;
 use Temporal\Testing\Command;
 use Temporal\Tests\Acceptance\App\Runtime\Feature;
@@ -52,6 +53,7 @@
     $converters = [
         new NullConverter(),
         new BinaryConverter(),
+        new RawValueConverter(),
         new ProtoJsonConverter(),
         new ProtoConverter(),
         new JsonConverter(),

tests/Unit/DataConverter/RawValueConverterTest.php

@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * This file is part of Temporal package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Unit\DataConverter;
+
+use Temporal\Api\Common\V1\Payload;
+use Temporal\DataConverter\DataConverter;
+use Temporal\DataConverter\DataConverterInterface;
+use Temporal\DataConverter\EncodingKeys;
+use Temporal\DataConverter\RawValue;
+use Temporal\Tests\Unit\AbstractUnit;
+
+/**
+ * @group unit
+ * @group data-converter
+ */
+class RawValueConverterTest extends AbstractUnit
+{
+    public function testRawPayloadEncoding(): void
+    {
+        $innerPayload = new Payload(['data' => 1]);
+        $message = new RawValue($innerPayload);
+
+        $payload = DataConverter::createDefault()->toPayload($message);
+
+        self::assertSame($innerPayload, $payload);
+        self::assertSame(EncodingKeys::METADATA_ENCODING_RAW_VALUE, $payload->getMetadata()[EncodingKeys::METADATA_ENCODING_KEY]);
+    }
+
+    public function testRawPayloadDecoding(): void
+    {
+        $innerPayload = new Payload(['data' => 1]);
+        $message = new RawValue($innerPayload);
+
+        $encoded = DataConverter::createDefault()->toPayload($message);
+        $decoded = DataConverter::createDefault()->fromPayload($encoded, RawValue::class);
+
+        self::assertInstanceOf(RawValue::class, $decoded);
+        self::assertSame($decoded->getPayload(), $encoded);
+    }
+
+    protected function create(): DataConverterInterface
+    {
+        return DataConverter::createDefault();
+    }
+}