From 158a2f2f34e2b40cdc79409734e41a377ded6ed1 Mon Sep 17 00:00:00 2001 From: Jovan Ruzic Date: Tue, 29 Nov 2022 09:17:14 +0100 Subject: [PATCH 1/5] feat/MPM-553/add-missing-docblock --- src/Consumer/KafkaConsumerBuilderInterface.php | 2 ++ src/Consumer/KafkaConsumerInterface.php | 8 ++++++++ src/Message/Decoder/DecoderInterface.php | 2 ++ src/Message/Encoder/EncoderInterface.php | 4 ++++ src/Producer/KafkaProducerBuilderInterface.php | 2 ++ 5 files changed, 18 insertions(+) diff --git a/src/Consumer/KafkaConsumerBuilderInterface.php b/src/Consumer/KafkaConsumerBuilderInterface.php index b5badd7..1333032 100644 --- a/src/Consumer/KafkaConsumerBuilderInterface.php +++ b/src/Consumer/KafkaConsumerBuilderInterface.php @@ -4,6 +4,7 @@ namespace Jobcloud\Kafka\Consumer; +use Jobcloud\Kafka\Exception\KafkaConsumerBuilderException; use Jobcloud\Kafka\Message\Decoder\DecoderInterface; interface KafkaConsumerBuilderInterface @@ -127,6 +128,7 @@ public function withLogCallback(callable $logCallback): KafkaConsumerBuilderInte * Returns your consumer instance * * @return KafkaConsumerInterface + * @throws KafkaConsumerBuilderException */ public function build(): KafkaConsumerInterface; } diff --git a/src/Consumer/KafkaConsumerInterface.php b/src/Consumer/KafkaConsumerInterface.php index aeca20a..d49a4d7 100644 --- a/src/Consumer/KafkaConsumerInterface.php +++ b/src/Consumer/KafkaConsumerInterface.php @@ -4,7 +4,11 @@ namespace Jobcloud\Kafka\Consumer; +use Jobcloud\Kafka\Exception\KafkaConsumerConsumeException; +use Jobcloud\Kafka\Exception\KafkaConsumerEndOfPartitionException; +use Jobcloud\Kafka\Exception\KafkaConsumerTimeoutException; use Jobcloud\Kafka\Message\KafkaConsumerMessageInterface; +use RdKafka\Exception as RdKafkaException; use RdKafka\Metadata\Topic as RdKafkaMetadataTopic; use RdKafka\TopicPartition as RdKafkaTopicPartition; @@ -45,6 +49,9 @@ public function isSubscribed(): bool; * @param integer $timeoutMs * @param boolean $autoDecode * @return KafkaConsumerMessageInterface + * @throws KafkaConsumerConsumeException + * @throws KafkaConsumerEndOfPartitionException + * @throws KafkaConsumerTimeoutException */ public function consume(int $timeoutMs = 10000, bool $autoDecode = true): KafkaConsumerMessageInterface; @@ -77,6 +84,7 @@ public function getConfiguration(): array; * @param string $topicName * @param integer $timeoutMs * @return RdKafkaMetadataTopic + * @throws RdKafkaException */ public function getMetadataForTopic(string $topicName, int $timeoutMs = 10000): RdKafkaMetadataTopic; diff --git a/src/Message/Decoder/DecoderInterface.php b/src/Message/Decoder/DecoderInterface.php index 3916102..bb8056b 100644 --- a/src/Message/Decoder/DecoderInterface.php +++ b/src/Message/Decoder/DecoderInterface.php @@ -4,6 +4,7 @@ namespace Jobcloud\Kafka\Message\Decoder; +use FlixTech\SchemaRegistryApi\Exception\SchemaRegistryException; use Jobcloud\Kafka\Message\KafkaConsumerMessageInterface; interface DecoderInterface @@ -11,6 +12,7 @@ interface DecoderInterface /** * @param KafkaConsumerMessageInterface $consumerMessage * @return KafkaConsumerMessageInterface + * @throws SchemaRegistryException */ public function decode(KafkaConsumerMessageInterface $consumerMessage): KafkaConsumerMessageInterface; } diff --git a/src/Message/Encoder/EncoderInterface.php b/src/Message/Encoder/EncoderInterface.php index 07debf8..7cff513 100644 --- a/src/Message/Encoder/EncoderInterface.php +++ b/src/Message/Encoder/EncoderInterface.php @@ -4,6 +4,8 @@ namespace Jobcloud\Kafka\Message\Encoder; +use FlixTech\SchemaRegistryApi\Exception\SchemaRegistryException; +use Jobcloud\Kafka\Exception\AvroEncoderException; use Jobcloud\Kafka\Message\KafkaProducerMessageInterface; interface EncoderInterface @@ -11,6 +13,8 @@ interface EncoderInterface /** * @param KafkaProducerMessageInterface $producerMessage * @return KafkaProducerMessageInterface + * @throws SchemaRegistryException + * @throws AvroEncoderException */ public function encode(KafkaProducerMessageInterface $producerMessage): KafkaProducerMessageInterface; } diff --git a/src/Producer/KafkaProducerBuilderInterface.php b/src/Producer/KafkaProducerBuilderInterface.php index 3912300..e7489dc 100644 --- a/src/Producer/KafkaProducerBuilderInterface.php +++ b/src/Producer/KafkaProducerBuilderInterface.php @@ -4,12 +4,14 @@ namespace Jobcloud\Kafka\Producer; +use Jobcloud\Kafka\Exception\KafkaProducerException; use Jobcloud\Kafka\Message\Encoder\EncoderInterface; interface KafkaProducerBuilderInterface { /** * @return KafkaProducerInterface + * @throws KafkaProducerException */ public function build(): KafkaProducerInterface; From 4beb8408faa9dbceb31bcb694c68b9b0f4831e63 Mon Sep 17 00:00:00 2001 From: Jovan Ruzic Date: Tue, 29 Nov 2022 09:42:42 +0100 Subject: [PATCH 2/5] updated ci config --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index c87974a..43e8936 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -2,7 +2,7 @@ version: 2.1 orbs: ci-caching: jobcloud/ci-caching@3.1 - ci-php: jobcloud/ci-php@2.4 + ci-php: jobcloud/ci-php@2.5 workflows: test-php-kafka-lib: From c3892f0439b6e1d3c07b7ec03cc186720e76c047 Mon Sep 17 00:00:00 2001 From: Jovan Ruzic Date: Tue, 29 Nov 2022 11:12:05 +0100 Subject: [PATCH 3/5] changed Dockerfile --- docker/dev/php/Dockerfile | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docker/dev/php/Dockerfile b/docker/dev/php/Dockerfile index e0c442a..0acd894 100644 --- a/docker/dev/php/Dockerfile +++ b/docker/dev/php/Dockerfile @@ -10,10 +10,7 @@ COPY files/php/ /phpIni # SYS: Install required packages RUN apk --no-cache upgrade && \ - apk --no-cache add bash git sudo openssh autoconf gcc g++ make - -RUN apk add librdkafka librdkafka-dev \ - --update-cache --repository http://dl-3.alpinelinux.org/alpine/edge/community + apk --no-cache add bash git sudo openssh autoconf gcc g++ make librdkafka librdkafka-dev # we need support for users with ID higher than 65k, so instead of using this: #RUN adduser -u $HOST_USER_ID -D -H $HOST_USER From e781a9b4e8a58667eb796bb6fa57e19245b79161 Mon Sep 17 00:00:00 2001 From: Jovan Ruzic Date: Mon, 5 Dec 2022 16:20:36 +0100 Subject: [PATCH 4/5] updated docker image --- docker/dev/php/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/dev/php/Dockerfile b/docker/dev/php/Dockerfile index 0acd894..26b7a51 100644 --- a/docker/dev/php/Dockerfile +++ b/docker/dev/php/Dockerfile @@ -1,4 +1,4 @@ -FROM php:7.4-cli-alpine3.13 +FROM php:7.4-cli-alpine3.16 ARG HOST_USER_ID ARG HOST_USER From 0cba22c7aecb165fee8f5de9956676ff3081bce3 Mon Sep 17 00:00:00 2001 From: Jovan Ruzic Date: Tue, 6 Dec 2022 14:20:11 +0100 Subject: [PATCH 5/5] reverted changes --- src/Consumer/KafkaConsumerBuilderInterface.php | 2 -- src/Consumer/KafkaConsumerInterface.php | 2 -- src/Message/Decoder/DecoderInterface.php | 2 -- src/Message/Encoder/EncoderInterface.php | 4 ---- src/Producer/KafkaProducerBuilderInterface.php | 2 -- 5 files changed, 12 deletions(-) diff --git a/src/Consumer/KafkaConsumerBuilderInterface.php b/src/Consumer/KafkaConsumerBuilderInterface.php index 1333032..b5badd7 100644 --- a/src/Consumer/KafkaConsumerBuilderInterface.php +++ b/src/Consumer/KafkaConsumerBuilderInterface.php @@ -4,7 +4,6 @@ namespace Jobcloud\Kafka\Consumer; -use Jobcloud\Kafka\Exception\KafkaConsumerBuilderException; use Jobcloud\Kafka\Message\Decoder\DecoderInterface; interface KafkaConsumerBuilderInterface @@ -128,7 +127,6 @@ public function withLogCallback(callable $logCallback): KafkaConsumerBuilderInte * Returns your consumer instance * * @return KafkaConsumerInterface - * @throws KafkaConsumerBuilderException */ public function build(): KafkaConsumerInterface; } diff --git a/src/Consumer/KafkaConsumerInterface.php b/src/Consumer/KafkaConsumerInterface.php index d49a4d7..34485a1 100644 --- a/src/Consumer/KafkaConsumerInterface.php +++ b/src/Consumer/KafkaConsumerInterface.php @@ -8,7 +8,6 @@ use Jobcloud\Kafka\Exception\KafkaConsumerEndOfPartitionException; use Jobcloud\Kafka\Exception\KafkaConsumerTimeoutException; use Jobcloud\Kafka\Message\KafkaConsumerMessageInterface; -use RdKafka\Exception as RdKafkaException; use RdKafka\Metadata\Topic as RdKafkaMetadataTopic; use RdKafka\TopicPartition as RdKafkaTopicPartition; @@ -84,7 +83,6 @@ public function getConfiguration(): array; * @param string $topicName * @param integer $timeoutMs * @return RdKafkaMetadataTopic - * @throws RdKafkaException */ public function getMetadataForTopic(string $topicName, int $timeoutMs = 10000): RdKafkaMetadataTopic; diff --git a/src/Message/Decoder/DecoderInterface.php b/src/Message/Decoder/DecoderInterface.php index bb8056b..3916102 100644 --- a/src/Message/Decoder/DecoderInterface.php +++ b/src/Message/Decoder/DecoderInterface.php @@ -4,7 +4,6 @@ namespace Jobcloud\Kafka\Message\Decoder; -use FlixTech\SchemaRegistryApi\Exception\SchemaRegistryException; use Jobcloud\Kafka\Message\KafkaConsumerMessageInterface; interface DecoderInterface @@ -12,7 +11,6 @@ interface DecoderInterface /** * @param KafkaConsumerMessageInterface $consumerMessage * @return KafkaConsumerMessageInterface - * @throws SchemaRegistryException */ public function decode(KafkaConsumerMessageInterface $consumerMessage): KafkaConsumerMessageInterface; } diff --git a/src/Message/Encoder/EncoderInterface.php b/src/Message/Encoder/EncoderInterface.php index 7cff513..07debf8 100644 --- a/src/Message/Encoder/EncoderInterface.php +++ b/src/Message/Encoder/EncoderInterface.php @@ -4,8 +4,6 @@ namespace Jobcloud\Kafka\Message\Encoder; -use FlixTech\SchemaRegistryApi\Exception\SchemaRegistryException; -use Jobcloud\Kafka\Exception\AvroEncoderException; use Jobcloud\Kafka\Message\KafkaProducerMessageInterface; interface EncoderInterface @@ -13,8 +11,6 @@ interface EncoderInterface /** * @param KafkaProducerMessageInterface $producerMessage * @return KafkaProducerMessageInterface - * @throws SchemaRegistryException - * @throws AvroEncoderException */ public function encode(KafkaProducerMessageInterface $producerMessage): KafkaProducerMessageInterface; } diff --git a/src/Producer/KafkaProducerBuilderInterface.php b/src/Producer/KafkaProducerBuilderInterface.php index e7489dc..3912300 100644 --- a/src/Producer/KafkaProducerBuilderInterface.php +++ b/src/Producer/KafkaProducerBuilderInterface.php @@ -4,14 +4,12 @@ namespace Jobcloud\Kafka\Producer; -use Jobcloud\Kafka\Exception\KafkaProducerException; use Jobcloud\Kafka\Message\Encoder\EncoderInterface; interface KafkaProducerBuilderInterface { /** * @return KafkaProducerInterface - * @throws KafkaProducerException */ public function build(): KafkaProducerInterface;