You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "ForThoseWhoComeAfter (via GitHub)" <gi...@apache.org> on 2025/10/20 08:10:54 UTC
[PR] NIFI-14839 Support different output strategies in ConsumeKinesis [nifi]
ForThoseWhoComeAfter opened a new pull request, #10443:
URL: https://github.com/apache/nifi/pull/10443
<!-- Licensed to the Apache Software Foundation (ASF) under one or more -->
<!-- contributor license agreements. See the NOTICE file distributed with -->
<!-- this work for additional information regarding copyright ownership. -->
<!-- The ASF licenses this file to You under the Apache License, Version 2.0 -->
<!-- (the "License"); you may not use this file except in compliance with -->
<!-- the License. You may obtain a copy of the License at -->
<!-- http://www.apache.org/licenses/LICENSE-2.0 -->
<!-- Unless required by applicable law or agreed to in writing, software -->
<!-- distributed under the License is distributed on an "AS IS" BASIS, -->
<!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -->
<!-- See the License for the specific language governing permissions and -->
<!-- limitations under the License. -->
# Summary
[NIFI-14839](https://issues.apache.org/jira/browse/NIFI-14839)
# Tracking
Please complete the following tracking steps prior to pull request creation.
### Issue Tracking
- [ ] [Apache NiFi Jira](https://issues.apache.org/jira/browse/NIFI) issue created
### Pull Request Tracking
- [ ] Pull Request title starts with Apache NiFi Jira issue number, such as `NIFI-00000`
- [ ] Pull Request commit message starts with Apache NiFi Jira issue number, as such `NIFI-00000`
### Pull Request Formatting
- [ ] Pull Request based on current revision of the `main` branch
- [ ] Pull Request refers to a feature branch with one commit containing changes
# Verification
Please indicate the verification steps performed prior to pull request creation.
### Build
- [ ] Build completed using `./mvnw clean install -P contrib-check`
- [ ] JDK 21
- [ ] JDK 25
### Licensing
- [ ] New dependencies are compatible with the [Apache License 2.0](https://apache.org/licenses/LICENSE-2.0) according to the [License Policy](https://www.apache.org/legal/resolved.html)
- [ ] New dependencies are documented in applicable `LICENSE` and `NOTICE` files
### Documentation
- [ ] Documentation formatting appears as expected in rendered files
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-14839 Support different output strategies in ConsumeKinesis [nifi]
Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory merged PR #10443:
URL: https://github.com/apache/nifi/pull/10443
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-14839 Support different output strategies in ConsumeKinesis [nifi]
Posted by "ForThoseWhoComeAfter (via GitHub)" <gi...@apache.org>.
ForThoseWhoComeAfter commented on code in PR #10443:
URL: https://github.com/apache/nifi/pull/10443#discussion_r2459816176
##########
nifi-extension-bundles/nifi-aws-bundle/nifi-aws-kinesis/src/test/java/org/apache/nifi/processors/aws/kinesis/converter/WrapperRecordConverterTest.java:
##########
@@ -0,0 +1,127 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.processors.aws.kinesis.converter;
+
+import jakarta.annotation.Nullable;
+import org.apache.nifi.serialization.SimpleRecordSchema;
+import org.apache.nifi.serialization.record.MapRecord;
+import org.apache.nifi.serialization.record.Record;
+import org.apache.nifi.serialization.record.RecordField;
+import org.apache.nifi.serialization.record.RecordFieldType;
+import org.apache.nifi.serialization.record.RecordSchema;
+import org.junit.jupiter.api.Test;
+import software.amazon.kinesis.retrieval.KinesisClientRecord;
+
+import java.nio.ByteBuffer;
+import java.time.Instant;
+import java.util.List;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class WrapperRecordConverterTest {
+
+ private static final String KINESIS_METADATA = "kinesisMetadata";
+
+ private static final String TEST_STREAM_NAME = "test-stream";
+ private static final String TEST_SHARD_ID = "shardId-000000000001";
+ private static final String TEST_SEQUENCE_NUMBER = "49590338271490256608559692538361571095921575989136588801";
+ private static final long TEST_SUB_SEQUENCE_NUMBER = 2;
+ private static final String TEST_PARTITION_KEY = "test-partition-key";
+ private static final Instant TEST_ARRIVAL_TIMESTAMP = Instant.ofEpochMilli(1640995200000L);
+
+ private static final String EXPECTED_SHARDED_SEQUENCE_NUMBER = "4959033827149025660855969253836157109592157598913658880100000000000000000002";
+
+ private static final RecordSchema INPUT_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField("name", RecordFieldType.STRING.getDataType()),
+ new RecordField("age", RecordFieldType.INT.getDataType())
+ ));
+ private static final Record INPUT_RECORD = new MapRecord(INPUT_SCHEMA, Map.of(
+ "name", "John Doe",
+ "age", 30
+ ));
+
+ private static final RecordSchema SCHEMA_METADATA = new SimpleRecordSchema(List.of(
+ new RecordField("stream", RecordFieldType.STRING.getDataType()),
+ new RecordField("shardId", RecordFieldType.STRING.getDataType()),
+ new RecordField("sequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("subSequenceNumber", RecordFieldType.LONG.getDataType()),
+ new RecordField("shardedSequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("partitionKey", RecordFieldType.STRING.getDataType()),
+ new RecordField("approximateArrival", RecordFieldType.TIMESTAMP.getDataType())
+ ));
+ private static final RecordSchema EXPECTED_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField(KINESIS_METADATA, RecordFieldType.RECORD.getRecordDataType(SCHEMA_METADATA)),
+ new RecordField("value", RecordFieldType.RECORD.getRecordDataType(INPUT_SCHEMA))
+ ));
+
+ private static final WrapperRecordConverter CONVERTER = new WrapperRecordConverter();
+
+ @Test
+ void testConvertWithApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(TEST_ARRIVAL_TIMESTAMP);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+ assertEquals(INPUT_RECORD, record.getValue("value"));
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = true;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ @Test
+ void testConvertWithoutApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(null);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+ assertEquals(INPUT_RECORD, record.getValue("value"));
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = false;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ private KinesisClientRecord createTestKinesisRecord(final @Nullable Instant arrivalTimestamp) {
+ return KinesisClientRecord.builder()
+ .data(ByteBuffer.allocate(0))
+ .sequenceNumber(TEST_SEQUENCE_NUMBER)
+ .subSequenceNumber(TEST_SUB_SEQUENCE_NUMBER)
+ .partitionKey(TEST_PARTITION_KEY)
+ .approximateArrivalTimestamp(arrivalTimestamp)
+ .build();
+ }
+
+ private static void verifyMetadata(final Record metadata, final boolean expectTimestamp) {
Review Comment:
Thanks, extracted common parts to the new utility class.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-14839 Support different output strategies in ConsumeKinesis [nifi]
Posted by "ForThoseWhoComeAfter (via GitHub)" <gi...@apache.org>.
ForThoseWhoComeAfter commented on code in PR #10443:
URL: https://github.com/apache/nifi/pull/10443#discussion_r2459805123
##########
nifi-extension-bundles/nifi-aws-bundle/nifi-aws-kinesis/src/test/java/org/apache/nifi/processors/aws/kinesis/converter/InjectMetadataRecordConverterTest.java:
##########
@@ -0,0 +1,135 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.processors.aws.kinesis.converter;
+
+import jakarta.annotation.Nullable;
+import org.apache.nifi.serialization.SimpleRecordSchema;
+import org.apache.nifi.serialization.record.MapRecord;
+import org.apache.nifi.serialization.record.Record;
+import org.apache.nifi.serialization.record.RecordField;
+import org.apache.nifi.serialization.record.RecordFieldType;
+import org.apache.nifi.serialization.record.RecordSchema;
+import org.junit.jupiter.api.Test;
+import software.amazon.kinesis.retrieval.KinesisClientRecord;
+
+import java.nio.ByteBuffer;
+import java.time.Instant;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class InjectMetadataRecordConverterTest {
+
+ private static final String KINESIS_METADATA = "kinesisMetadata";
+
+ private static final String TEST_STREAM_NAME = "test-stream";
+ private static final String TEST_SHARD_ID = "shardId-000000000001";
+ private static final String TEST_SEQUENCE_NUMBER = "49590338271490256608559692538361571095921575989136588801";
+ private static final long TEST_SUB_SEQUENCE_NUMBER = 2;
+ private static final String TEST_PARTITION_KEY = "test-partition-key";
+ private static final Instant TEST_ARRIVAL_TIMESTAMP = Instant.ofEpochMilli(1640995200000L);
+
+ private static final String EXPECTED_SHARDED_SEQUENCE_NUMBER = "4959033827149025660855969253836157109592157598913658880100000000000000000002";
+
+ private static final RecordSchema INPUT_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField("name", RecordFieldType.STRING.getDataType()),
+ new RecordField("age", RecordFieldType.INT.getDataType())
+ ));
+ private static final Record INPUT_RECORD = new MapRecord(INPUT_SCHEMA, Map.of(
+ "name", "John Doe",
+ "age", 30
+ ));
+
+ private static final RecordSchema SCHEMA_METADATA = new SimpleRecordSchema(List.of(
+ new RecordField("stream", RecordFieldType.STRING.getDataType()),
+ new RecordField("shardId", RecordFieldType.STRING.getDataType()),
+ new RecordField("sequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("subSequenceNumber", RecordFieldType.LONG.getDataType()),
+ new RecordField("shardedSequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("partitionKey", RecordFieldType.STRING.getDataType()),
+ new RecordField("approximateArrival", RecordFieldType.TIMESTAMP.getDataType())
+ ));
+ private static final RecordSchema EXPECTED_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField("name", RecordFieldType.STRING.getDataType()),
+ new RecordField("age", RecordFieldType.INT.getDataType()),
+ new RecordField(KINESIS_METADATA, RecordFieldType.RECORD.getRecordDataType(SCHEMA_METADATA))
+ ));
+
+ private static final InjectMetadataRecordConverter CONVERTER = new InjectMetadataRecordConverter();
+
+ @Test
+ void testConvertWithApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(TEST_ARRIVAL_TIMESTAMP);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+
+ final Map<String, Object> recordValues = new HashMap<>(record.toMap());
+ recordValues.remove(KINESIS_METADATA);
+ assertEquals(INPUT_RECORD.toMap(), recordValues);
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = true;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ @Test
+ void testConvertWithoutApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(null);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+
+ final Map<String, Object> recordValues = new HashMap<>(record.toMap());
+ recordValues.remove(KINESIS_METADATA);
+ assertEquals(INPUT_RECORD.toMap(), recordValues);
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = false;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ private KinesisClientRecord createTestKinesisRecord(final @Nullable Instant arrivalTimestamp) {
+ return KinesisClientRecord.builder()
+ .data(ByteBuffer.allocate(0))
+ .sequenceNumber(TEST_SEQUENCE_NUMBER)
+ .subSequenceNumber(TEST_SUB_SEQUENCE_NUMBER)
+ .partitionKey(TEST_PARTITION_KEY)
+ .approximateArrivalTimestamp(arrivalTimestamp)
+ .build();
+ }
+
+ private static void verifyMetadata(final Record metadata, final boolean expectTimestamp) {
+ assertEquals(TEST_STREAM_NAME, metadata.getValue("stream"));
+ assertEquals(TEST_SHARD_ID, metadata.getValue("shardId"));
+ assertEquals(TEST_SEQUENCE_NUMBER, metadata.getValue("sequenceNumber"));
+ assertEquals(TEST_SUB_SEQUENCE_NUMBER, metadata.getValue("subSequenceNumber"));
+ assertEquals(EXPECTED_SHARDED_SEQUENCE_NUMBER, metadata.getValue("shardedSequenceNumber"));
+ assertEquals(TEST_PARTITION_KEY, metadata.getValue("partitionKey"));
+
+ if (expectTimestamp) {
+ assertEquals(TEST_ARRIVAL_TIMESTAMP.toEpochMilli(), metadata.getValue("approximateArrival"));
Review Comment:
Sure, I've used the value already declared in `KinesisRecordMetadata`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-14839 Support different output strategies in ConsumeKinesis [nifi]
Posted by "ForThoseWhoComeAfter (via GitHub)" <gi...@apache.org>.
ForThoseWhoComeAfter commented on code in PR #10443:
URL: https://github.com/apache/nifi/pull/10443#discussion_r2459816176
##########
nifi-extension-bundles/nifi-aws-bundle/nifi-aws-kinesis/src/test/java/org/apache/nifi/processors/aws/kinesis/converter/WrapperRecordConverterTest.java:
##########
@@ -0,0 +1,127 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.processors.aws.kinesis.converter;
+
+import jakarta.annotation.Nullable;
+import org.apache.nifi.serialization.SimpleRecordSchema;
+import org.apache.nifi.serialization.record.MapRecord;
+import org.apache.nifi.serialization.record.Record;
+import org.apache.nifi.serialization.record.RecordField;
+import org.apache.nifi.serialization.record.RecordFieldType;
+import org.apache.nifi.serialization.record.RecordSchema;
+import org.junit.jupiter.api.Test;
+import software.amazon.kinesis.retrieval.KinesisClientRecord;
+
+import java.nio.ByteBuffer;
+import java.time.Instant;
+import java.util.List;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class WrapperRecordConverterTest {
+
+ private static final String KINESIS_METADATA = "kinesisMetadata";
+
+ private static final String TEST_STREAM_NAME = "test-stream";
+ private static final String TEST_SHARD_ID = "shardId-000000000001";
+ private static final String TEST_SEQUENCE_NUMBER = "49590338271490256608559692538361571095921575989136588801";
+ private static final long TEST_SUB_SEQUENCE_NUMBER = 2;
+ private static final String TEST_PARTITION_KEY = "test-partition-key";
+ private static final Instant TEST_ARRIVAL_TIMESTAMP = Instant.ofEpochMilli(1640995200000L);
+
+ private static final String EXPECTED_SHARDED_SEQUENCE_NUMBER = "4959033827149025660855969253836157109592157598913658880100000000000000000002";
+
+ private static final RecordSchema INPUT_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField("name", RecordFieldType.STRING.getDataType()),
+ new RecordField("age", RecordFieldType.INT.getDataType())
+ ));
+ private static final Record INPUT_RECORD = new MapRecord(INPUT_SCHEMA, Map.of(
+ "name", "John Doe",
+ "age", 30
+ ));
+
+ private static final RecordSchema SCHEMA_METADATA = new SimpleRecordSchema(List.of(
+ new RecordField("stream", RecordFieldType.STRING.getDataType()),
+ new RecordField("shardId", RecordFieldType.STRING.getDataType()),
+ new RecordField("sequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("subSequenceNumber", RecordFieldType.LONG.getDataType()),
+ new RecordField("shardedSequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("partitionKey", RecordFieldType.STRING.getDataType()),
+ new RecordField("approximateArrival", RecordFieldType.TIMESTAMP.getDataType())
+ ));
+ private static final RecordSchema EXPECTED_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField(KINESIS_METADATA, RecordFieldType.RECORD.getRecordDataType(SCHEMA_METADATA)),
+ new RecordField("value", RecordFieldType.RECORD.getRecordDataType(INPUT_SCHEMA))
+ ));
+
+ private static final WrapperRecordConverter CONVERTER = new WrapperRecordConverter();
+
+ @Test
+ void testConvertWithApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(TEST_ARRIVAL_TIMESTAMP);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+ assertEquals(INPUT_RECORD, record.getValue("value"));
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = true;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ @Test
+ void testConvertWithoutApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(null);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+ assertEquals(INPUT_RECORD, record.getValue("value"));
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = false;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ private KinesisClientRecord createTestKinesisRecord(final @Nullable Instant arrivalTimestamp) {
+ return KinesisClientRecord.builder()
+ .data(ByteBuffer.allocate(0))
+ .sequenceNumber(TEST_SEQUENCE_NUMBER)
+ .subSequenceNumber(TEST_SUB_SEQUENCE_NUMBER)
+ .partitionKey(TEST_PARTITION_KEY)
+ .approximateArrivalTimestamp(arrivalTimestamp)
+ .build();
+ }
+
+ private static void verifyMetadata(final Record metadata, final boolean expectTimestamp) {
Review Comment:
Thanks, extracted common parts to utility class.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-14839 Support different output strategies in ConsumeKinesis [nifi]
Posted by "ForThoseWhoComeAfter (via GitHub)" <gi...@apache.org>.
ForThoseWhoComeAfter commented on code in PR #10443:
URL: https://github.com/apache/nifi/pull/10443#discussion_r2459800208
##########
nifi-extension-bundles/nifi-aws-bundle/nifi-aws-kinesis/src/main/java/org/apache/nifi/processors/aws/kinesis/ConsumeKinesis.java:
##########
@@ -732,6 +754,36 @@ public String getDescription() {
}
}
+ enum OutputStrategy implements DescribedValue {
+ USE_VALUE("Use Content as Value", "Write only the Kinesis Record value to the FlowFile record."),
+ USE_WRAPPER("Use Wrapper", "Write the Kinesis Record value and metadata into the FlowFile record. (See processor's additional details for more information.)"),
Review Comment:
Done
##########
nifi-extension-bundles/nifi-aws-bundle/nifi-aws-kinesis/src/main/java/org/apache/nifi/processors/aws/kinesis/ConsumeKinesis.java:
##########
@@ -732,6 +754,36 @@ public String getDescription() {
}
}
+ enum OutputStrategy implements DescribedValue {
+ USE_VALUE("Use Content as Value", "Write only the Kinesis Record value to the FlowFile record."),
+ USE_WRAPPER("Use Wrapper", "Write the Kinesis Record value and metadata into the FlowFile record. (See processor's additional details for more information.)"),
+ INJECT_METADATA("Inject Metadata",
+ "Write the Kinesis Record value to the FlowFile record and add a sub-record to it with metadata. (See processor's additional details for more information.)");
Review Comment:
Done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-14839 Support different output strategies in ConsumeKinesis [nifi]
Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory commented on code in PR #10443:
URL: https://github.com/apache/nifi/pull/10443#discussion_r2446673119
##########
nifi-extension-bundles/nifi-aws-bundle/nifi-aws-kinesis/src/test/java/org/apache/nifi/processors/aws/kinesis/converter/InjectMetadataRecordConverterTest.java:
##########
@@ -0,0 +1,135 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.processors.aws.kinesis.converter;
+
+import jakarta.annotation.Nullable;
+import org.apache.nifi.serialization.SimpleRecordSchema;
+import org.apache.nifi.serialization.record.MapRecord;
+import org.apache.nifi.serialization.record.Record;
+import org.apache.nifi.serialization.record.RecordField;
+import org.apache.nifi.serialization.record.RecordFieldType;
+import org.apache.nifi.serialization.record.RecordSchema;
+import org.junit.jupiter.api.Test;
+import software.amazon.kinesis.retrieval.KinesisClientRecord;
+
+import java.nio.ByteBuffer;
+import java.time.Instant;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class InjectMetadataRecordConverterTest {
+
+ private static final String KINESIS_METADATA = "kinesisMetadata";
+
+ private static final String TEST_STREAM_NAME = "test-stream";
+ private static final String TEST_SHARD_ID = "shardId-000000000001";
+ private static final String TEST_SEQUENCE_NUMBER = "49590338271490256608559692538361571095921575989136588801";
+ private static final long TEST_SUB_SEQUENCE_NUMBER = 2;
+ private static final String TEST_PARTITION_KEY = "test-partition-key";
+ private static final Instant TEST_ARRIVAL_TIMESTAMP = Instant.ofEpochMilli(1640995200000L);
+
+ private static final String EXPECTED_SHARDED_SEQUENCE_NUMBER = "4959033827149025660855969253836157109592157598913658880100000000000000000002";
+
+ private static final RecordSchema INPUT_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField("name", RecordFieldType.STRING.getDataType()),
+ new RecordField("age", RecordFieldType.INT.getDataType())
+ ));
+ private static final Record INPUT_RECORD = new MapRecord(INPUT_SCHEMA, Map.of(
+ "name", "John Doe",
+ "age", 30
+ ));
+
+ private static final RecordSchema SCHEMA_METADATA = new SimpleRecordSchema(List.of(
+ new RecordField("stream", RecordFieldType.STRING.getDataType()),
+ new RecordField("shardId", RecordFieldType.STRING.getDataType()),
+ new RecordField("sequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("subSequenceNumber", RecordFieldType.LONG.getDataType()),
+ new RecordField("shardedSequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("partitionKey", RecordFieldType.STRING.getDataType()),
+ new RecordField("approximateArrival", RecordFieldType.TIMESTAMP.getDataType())
+ ));
+ private static final RecordSchema EXPECTED_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField("name", RecordFieldType.STRING.getDataType()),
+ new RecordField("age", RecordFieldType.INT.getDataType()),
+ new RecordField(KINESIS_METADATA, RecordFieldType.RECORD.getRecordDataType(SCHEMA_METADATA))
+ ));
+
+ private static final InjectMetadataRecordConverter CONVERTER = new InjectMetadataRecordConverter();
+
+ @Test
+ void testConvertWithApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(TEST_ARRIVAL_TIMESTAMP);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+
+ final Map<String, Object> recordValues = new HashMap<>(record.toMap());
+ recordValues.remove(KINESIS_METADATA);
+ assertEquals(INPUT_RECORD.toMap(), recordValues);
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = true;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ @Test
+ void testConvertWithoutApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(null);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+
+ final Map<String, Object> recordValues = new HashMap<>(record.toMap());
+ recordValues.remove(KINESIS_METADATA);
+ assertEquals(INPUT_RECORD.toMap(), recordValues);
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = false;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ private KinesisClientRecord createTestKinesisRecord(final @Nullable Instant arrivalTimestamp) {
+ return KinesisClientRecord.builder()
+ .data(ByteBuffer.allocate(0))
+ .sequenceNumber(TEST_SEQUENCE_NUMBER)
+ .subSequenceNumber(TEST_SUB_SEQUENCE_NUMBER)
+ .partitionKey(TEST_PARTITION_KEY)
+ .approximateArrivalTimestamp(arrivalTimestamp)
+ .build();
+ }
+
+ private static void verifyMetadata(final Record metadata, final boolean expectTimestamp) {
+ assertEquals(TEST_STREAM_NAME, metadata.getValue("stream"));
+ assertEquals(TEST_SHARD_ID, metadata.getValue("shardId"));
+ assertEquals(TEST_SEQUENCE_NUMBER, metadata.getValue("sequenceNumber"));
+ assertEquals(TEST_SUB_SEQUENCE_NUMBER, metadata.getValue("subSequenceNumber"));
+ assertEquals(EXPECTED_SHARDED_SEQUENCE_NUMBER, metadata.getValue("shardedSequenceNumber"));
+ assertEquals(TEST_PARTITION_KEY, metadata.getValue("partitionKey"));
+
+ if (expectTimestamp) {
+ assertEquals(TEST_ARRIVAL_TIMESTAMP.toEpochMilli(), metadata.getValue("approximateArrival"));
Review Comment:
I recommend declaring `approximateArrival` as a static string and reusing the reference in this method and other methods.
##########
nifi-extension-bundles/nifi-aws-bundle/nifi-aws-kinesis/src/main/java/org/apache/nifi/processors/aws/kinesis/ConsumeKinesis.java:
##########
@@ -732,6 +754,36 @@ public String getDescription() {
}
}
+ enum OutputStrategy implements DescribedValue {
+ USE_VALUE("Use Content as Value", "Write only the Kinesis Record value to the FlowFile record."),
+ USE_WRAPPER("Use Wrapper", "Write the Kinesis Record value and metadata into the FlowFile record. (See processor's additional details for more information.)"),
Review Comment:
```suggestion
USE_WRAPPER("Use Wrapper", "Write the Kinesis Record value and metadata into the FlowFile record. See additional details for more information."),
```
##########
nifi-extension-bundles/nifi-aws-bundle/nifi-aws-kinesis/src/test/java/org/apache/nifi/processors/aws/kinesis/converter/WrapperRecordConverterTest.java:
##########
@@ -0,0 +1,127 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.processors.aws.kinesis.converter;
+
+import jakarta.annotation.Nullable;
+import org.apache.nifi.serialization.SimpleRecordSchema;
+import org.apache.nifi.serialization.record.MapRecord;
+import org.apache.nifi.serialization.record.Record;
+import org.apache.nifi.serialization.record.RecordField;
+import org.apache.nifi.serialization.record.RecordFieldType;
+import org.apache.nifi.serialization.record.RecordSchema;
+import org.junit.jupiter.api.Test;
+import software.amazon.kinesis.retrieval.KinesisClientRecord;
+
+import java.nio.ByteBuffer;
+import java.time.Instant;
+import java.util.List;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class WrapperRecordConverterTest {
+
+ private static final String KINESIS_METADATA = "kinesisMetadata";
+
+ private static final String TEST_STREAM_NAME = "test-stream";
+ private static final String TEST_SHARD_ID = "shardId-000000000001";
+ private static final String TEST_SEQUENCE_NUMBER = "49590338271490256608559692538361571095921575989136588801";
+ private static final long TEST_SUB_SEQUENCE_NUMBER = 2;
+ private static final String TEST_PARTITION_KEY = "test-partition-key";
+ private static final Instant TEST_ARRIVAL_TIMESTAMP = Instant.ofEpochMilli(1640995200000L);
+
+ private static final String EXPECTED_SHARDED_SEQUENCE_NUMBER = "4959033827149025660855969253836157109592157598913658880100000000000000000002";
+
+ private static final RecordSchema INPUT_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField("name", RecordFieldType.STRING.getDataType()),
+ new RecordField("age", RecordFieldType.INT.getDataType())
+ ));
+ private static final Record INPUT_RECORD = new MapRecord(INPUT_SCHEMA, Map.of(
+ "name", "John Doe",
+ "age", 30
+ ));
+
+ private static final RecordSchema SCHEMA_METADATA = new SimpleRecordSchema(List.of(
+ new RecordField("stream", RecordFieldType.STRING.getDataType()),
+ new RecordField("shardId", RecordFieldType.STRING.getDataType()),
+ new RecordField("sequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("subSequenceNumber", RecordFieldType.LONG.getDataType()),
+ new RecordField("shardedSequenceNumber", RecordFieldType.STRING.getDataType()),
+ new RecordField("partitionKey", RecordFieldType.STRING.getDataType()),
+ new RecordField("approximateArrival", RecordFieldType.TIMESTAMP.getDataType())
+ ));
+ private static final RecordSchema EXPECTED_SCHEMA = new SimpleRecordSchema(List.of(
+ new RecordField(KINESIS_METADATA, RecordFieldType.RECORD.getRecordDataType(SCHEMA_METADATA)),
+ new RecordField("value", RecordFieldType.RECORD.getRecordDataType(INPUT_SCHEMA))
+ ));
+
+ private static final WrapperRecordConverter CONVERTER = new WrapperRecordConverter();
+
+ @Test
+ void testConvertWithApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(TEST_ARRIVAL_TIMESTAMP);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+ assertEquals(INPUT_RECORD, record.getValue("value"));
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = true;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ @Test
+ void testConvertWithoutApproximateArrivalTimestamp() {
+ final KinesisClientRecord kinesisRecord = createTestKinesisRecord(null);
+
+ final Record record = CONVERTER.convert(INPUT_RECORD, kinesisRecord, TEST_STREAM_NAME, TEST_SHARD_ID);
+
+ assertEquals(EXPECTED_SCHEMA, record.getSchema());
+ assertEquals(INPUT_RECORD, record.getValue("value"));
+
+ final Record metadata = record.getAsRecord(KINESIS_METADATA, SCHEMA_METADATA);
+ final boolean expectTimestamp = false;
+ verifyMetadata(metadata, expectTimestamp);
+ }
+
+ private KinesisClientRecord createTestKinesisRecord(final @Nullable Instant arrivalTimestamp) {
+ return KinesisClientRecord.builder()
+ .data(ByteBuffer.allocate(0))
+ .sequenceNumber(TEST_SEQUENCE_NUMBER)
+ .subSequenceNumber(TEST_SUB_SEQUENCE_NUMBER)
+ .partitionKey(TEST_PARTITION_KEY)
+ .approximateArrivalTimestamp(arrivalTimestamp)
+ .build();
+ }
+
+ private static void verifyMetadata(final Record metadata, final boolean expectTimestamp) {
Review Comment:
With the similarities to the `InjectMetadata` test class, what do you think about creating a shared utility test class for verifying these metadata values?
##########
nifi-extension-bundles/nifi-aws-bundle/nifi-aws-kinesis/src/main/java/org/apache/nifi/processors/aws/kinesis/ConsumeKinesis.java:
##########
@@ -732,6 +754,36 @@ public String getDescription() {
}
}
+ enum OutputStrategy implements DescribedValue {
+ USE_VALUE("Use Content as Value", "Write only the Kinesis Record value to the FlowFile record."),
+ USE_WRAPPER("Use Wrapper", "Write the Kinesis Record value and metadata into the FlowFile record. (See processor's additional details for more information.)"),
+ INJECT_METADATA("Inject Metadata",
+ "Write the Kinesis Record value to the FlowFile record and add a sub-record to it with metadata. (See processor's additional details for more information.)");
Review Comment:
```suggestion
"Write the Kinesis Record value to the FlowFile record and add a sub-record to it with metadata. See additional details for more information.");
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org