Skip to content

New message transformation concept #956

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions pkg/rdkafka/ConsumeMessageTransformer.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

declare(strict_types=1);

namespace Enqueue\RdKafka;

interface ConsumeMessageTransformer
{
public function transformConsumeMessage(RdKafkaMessage $message);
}
3 changes: 3 additions & 0 deletions pkg/rdkafka/JsonSerializer.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

namespace Enqueue\RdKafka;

/**
* @deprecated Use ProduceMessageTransformer and/or ConsumeMessageTransformer instead
*/
class JsonSerializer implements Serializer
{
public function toString(RdKafkaMessage $message): string
Expand Down
19 changes: 19 additions & 0 deletions pkg/rdkafka/NullMessageTransformer.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

declare(strict_types=1);

namespace Enqueue\RdKafka;

final class NullMessageTransformer implements ConsumeMessageTransformer, ProduceMessageTransformer
{

public function transformConsumeMessage(RdKafkaMessage $message)
{
return;
}

public function transformProduceMessage(RdKafkaMessage $message)
{
return;
}
}
10 changes: 10 additions & 0 deletions pkg/rdkafka/ProduceMessageTransformer.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

declare(strict_types=1);

namespace Enqueue\RdKafka;

interface ProduceMessageTransformer
{
public function transformProduceMessage(RdKafkaMessage $message);
}
19 changes: 18 additions & 1 deletion pkg/rdkafka/RdKafkaConsumer.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ class RdKafkaConsumer implements Consumer
*/
private $offset;

/**
* @var ConsumeMessageTransformer
*/
private $consumeMessageTransformer;

public function __construct(KafkaConsumer $consumer, RdKafkaContext $context, RdKafkaTopic $topic, Serializer $serializer)
{
$this->consumer = $consumer;
Expand Down Expand Up @@ -164,7 +169,12 @@ private function doReceive(int $timeout): ?RdKafkaMessage
case RD_KAFKA_RESP_ERR__TIMED_OUT:
break;
case RD_KAFKA_RESP_ERR_NO_ERROR:
$message = $this->serializer->toMessage($kafkaMessage->payload);
if (null !== $this->serializer) {
$message = $this->serializer->toMessage($kafkaMessage->payload);
} else {
$message = new RdKafkaMessage($kafkaMessage->payload);
}

$message->setKey($kafkaMessage->key);
$message->setPartition($kafkaMessage->partition);
$message->setKafkaMessage($kafkaMessage);
Expand All @@ -175,6 +185,8 @@ private function doReceive(int $timeout): ?RdKafkaMessage
$message->setHeaders(array_merge($message->getHeaders(), $kafkaMessage->headers));
}

$this->consumeMessageTransformer->transformConsumeMessage($message);

return $message;
default:
throw new \LogicException($kafkaMessage->errstr(), $kafkaMessage->err);
Expand All @@ -183,4 +195,9 @@ private function doReceive(int $timeout): ?RdKafkaMessage

return null;
}

public function setMessageTransformer(ConsumeMessageTransformer $messageTransformer): void
{
$this->consumeMessageTransformer = $messageTransformer;
}
}
23 changes: 22 additions & 1 deletion pkg/rdkafka/RdKafkaContext.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ class RdKafkaContext implements Context
*/
private $rdKafkaConsumers;

/**
* @var ConsumeMessageTransformer
*/
private $consumeMessageTransformer;

/**
* @var ProduceMessageTransformer
*/
private $produceMessageTransformer;

/**
* @param array $config
*/
Expand All @@ -60,6 +70,11 @@ public function __construct(array $config)
$this->rdKafkaConsumers = [];

$this->setSerializer(new JsonSerializer());

$messageTransformer = new NullMessageTransformer();

$this->consumeMessageTransformer = $messageTransformer;
$this->produceMessageTransformer = $messageTransformer;
}

/**
Expand Down Expand Up @@ -96,7 +111,11 @@ public function createTemporaryQueue(): Queue
*/
public function createProducer(): Producer
{
return new RdKafkaProducer($this->getProducer(), $this->getSerializer());
$producer = new RdKafkaProducer($this->getProducer(), $this->getSerializer());

$producer->setMessageTransformer($this->produceMessageTransformer);

return $producer;
}

/**
Expand All @@ -120,6 +139,8 @@ public function createConsumer(Destination $destination): Consumer
$this->getSerializer()
);

$consumer->setMessageTransformer($this->consumeMessageTransformer);

if (isset($this->config['commit_async'])) {
$consumer->setCommitAsync($this->config['commit_async']);
}
Expand Down
20 changes: 19 additions & 1 deletion pkg/rdkafka/RdKafkaProducer.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ class RdKafkaProducer implements Producer
*/
private $producer;

/**
* @var ProduceMessageTransformer
*/
private $produceMessageTransformer;

public function __construct(VendorProducer $producer, Serializer $serializer)
{
$this->producer = $producer;
Expand All @@ -38,7 +43,15 @@ public function send(Destination $destination, Message $message): void
InvalidMessageException::assertMessageInstanceOf($message, RdKafkaMessage::class);

$partition = $message->getPartition() ?: $destination->getPartition() ?: RD_KAFKA_PARTITION_UA;
$payload = $this->serializer->toString($message);

if (null !== $this->serializer) {
$payload = $this->serializer->toString($message);
} else {
$payload = $message->getBody();
}

$this->produceMessageTransformer->transformProduceMessage($message);

$key = $message->getKey() ?: $destination->getKey() ?: null;

$topic = $this->producer->newTopic($destination->getTopicName(), $destination->getConf());
Expand Down Expand Up @@ -111,4 +124,9 @@ public function getTimeToLive(): ?int
{
return null;
}

public function setMessageTransformer(ProduceMessageTransformer $messageTransformer): void
{
$this->produceMessageTransformer = $messageTransformer;
}
}
3 changes: 3 additions & 0 deletions pkg/rdkafka/Serializer.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

namespace Enqueue\RdKafka;

/**
* @deprecated Use ProduceMessageTransformer and/or ConsumeMessageTransformer instead
*/
interface Serializer
{
public function toString(RdKafkaMessage $message): string;
Expand Down
8 changes: 4 additions & 4 deletions pkg/rdkafka/SerializerAwareTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@
trait SerializerAwareTrait
{
/**
* @var Serializer
* @var Serializer|null
*/
private $serializer;

/**
* @param Serializer $serializer
* @param Serializer|null $serializer
*/
public function setSerializer(Serializer $serializer)
public function setSerializer(?Serializer $serializer)
{
$this->serializer = $serializer;
}

/**
* @return Serializer
* @return Serializer|null
*/
public function getSerializer()
{
Expand Down