aws-kclrb 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e606b4662cdbb79ec9bc55dfc314c311fbffaa332d203cf84c386095173a3aea
-  data.tar.gz: 4c21857b56f8e596bcb3072ee706611b145a43214a87e12a349e870395bc5b0e
+  metadata.gz: 3beff85e7553d852f6c1dfadd44ee7279fdb29256f2ed40fd98358b51751ae72
+  data.tar.gz: 3c63d7db385a48655dfde264d574859084d71aa7eb5dd3f4642673e8076fca53
 SHA512:
-  metadata.gz: 30a46ab76ecaafa685cc156aaa036bda590717a4d47ec82b96683eadb3f8a9ca893d76a73d361006450b5c44bee54356281459e3a764bf76929167c30798d14d
-  data.tar.gz: 416dcfc937ead185262d3ffe77f4d27fc90bb0c190865b98c323774074b925b0a8177746be39a7c1ca5ef6a46876ca460e23d45ce3971dd629ac597e902fc15b
+  metadata.gz: 8c6979336047673a21d5012c4ecd7afb23e51c51aa510b359b5520af40911ceff6a32db68f496fa6c55d2d9112ff9b754607e7a1d2badd47f8a4b943c84ad983
+  data.tar.gz: b180e3db5cf893c5104cd2522eb5d997015f241be081d974f0f5deb317177d2934a95dc7ef6d805c4cc64d6d98c28581d9c21e0199bc32c7c6ccd3e66171d8cf

data/README.md

@@ -11,38 +11,38 @@ This package wraps and manages the interaction with the [MultiLangDaemon][multi-
 executable. A record processor in Ruby typically looks something like:
 
 ```ruby
-    #! /usr/bin/env ruby
-
-    require 'aws/kclrb'
-
-    class SampleRecordProcessor < Aws::KCLrb::V2::RecordProcessorBase
-      def init_processor(initialize_input)
-        # initialize
-      end
-
-      def process_records(process_records_input)
-        # process batch of records
-      end
-
-      def lease_lost(lease_lost_input)
-        # lease was lost, cleanup
-      end
-
-      def shard_ended(shard_ended_input)
-        # shard has ended, cleanup
-      end
-
-      def shutdown_requested(shutdown_requested_input)
-        # shutdown has been requested
-      end
-    end
-
-    if __FILE__ == $0
-      # Start the main processing loop
-      record_processor = SampleRecordProcessor.new
-      driver = Aws::KCLrb::KCLProcess.new(record_processor)
-      driver.run
-    end
+#! /usr/bin/env ruby
+
+require 'aws/kclrb'
+
+class SampleRecordProcessor < Aws::KCLrb::V2::RecordProcessorBase
+  def init_processor(initialize_input)
+    # initialize
+  end
+
+  def process_records(process_records_input)
+    # process batch of records
+  end
+
+  def lease_lost(lease_lost_input)
+    # lease was lost, cleanup
+  end
+
+  def shard_ended(shard_ended_input)
+    # shard has ended, cleanup
+  end
+
+  def shutdown_requested(shutdown_requested_input)
+    # shutdown has been requested
+  end
+end
+
+if __FILE__ == $0
+  # Start the main processing loop
+  record_processor = SampleRecordProcessor.new
+  driver = Aws::KCLrb::KCLProcess.new(record_processor)
+  driver.run
+end
 ```
 
 ## Before You Get Started
@@ -51,7 +51,7 @@ Before running the samples, you'll want to make sure that your environment is
 configured to allow the samples to use your
 [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html).
 
-By default the samples use the [DefaultAWSCredentialsProviderChain][DefaultAWSCredentialsProviderChain]
+By default the samples use the [DefaultCredentialsProvider][DefaultCredentialsProvider]
 so you'll want to make your credentials available to one of the credentials providers in that
 provider chain. There are several ways to do this such as providing a `~/.aws/credentials` file,
 or if you're running on Amazon EC2, you can associate an IAM role with your instance with appropriate
@@ -94,11 +94,11 @@ To run the data producer, run the following commands:
 
 #### Notes
 
-* The [AWS Ruby SDK gem][aws-ruby-sdk-gem] needs to be installed as a pre-requisite. To install,
+* The [AWS Ruby SDK gem][aws-ruby-sdk-gem] for Kinesis needs to be installed as a pre-requisite. To install,
   run:
 
   ```sh
-      sudo gem install aws-sdk
+      sudo gem install aws-sdk-kinesis
   ```
 
 * The script `samples/sample_kcl_producer.rb` takes several parameters that you can use
@@ -187,6 +187,43 @@ all languages.
 
 ## Release Notes
 
+### Release 3.0.0 (November 6, 2024)
+* New lease assignment / load balancing algorithm
+  * KCL 3.x introduces a new lease assignment and load balancing algorithm. It assigns leases among workers based on worker utilization metrics and throughput on each lease, replacing the previous lease count-based lease assignment algorithm.
+  * When KCL detects higher variance in CPU utilization among workers, it proactively reassigns leases from over-utilized workers to under-utilized workers for even load balancing. This ensures even CPU utilization across workers and removes the need to over-provision the stream processing compute hosts.
+* Optimized DynamoDB RCU usage
+  * KCL 3.x optimizes DynamoDB read capacity unit (RCU) usage on the lease table by implementing a global secondary index with leaseOwner as the partition key. This index mirrors the leaseKey attribute from the base lease table, allowing workers to efficiently discover their assigned leases by querying the index instead of scanning the entire table.
+  * This approach significantly reduces read operations compared to earlier KCL versions, where workers performed full table scans, resulting in higher RCU consumption.
+* Graceful lease handoff
+  * KCL 3.x introduces a feature called "graceful lease handoff" to minimize data reprocessing during lease reassignments. Graceful lease handoff allows the current worker to complete checkpointing of processed records before transferring the lease to another worker. For graceful lease handoff, you should implement checkpointing logic within the existing `shutdownRequested()` method.
+  * This feature is enabled by default in KCL 3.x, but you can turn off this feature by adjusting the configuration property `isGracefulLeaseHandoffEnabled`.
+  * While this approach significantly reduces the probability of data reprocessing during lease transfers, it doesn't completely eliminate the possibility. To maintain data integrity and consistency, it's crucial to design your downstream consumer applications to be idempotent. This ensures that the application can handle potential duplicate record processing without adverse effects.
+* New DynamoDB metadata management artifacts
+  * KCL 3.x introduces two new DynamoDB tables for improved lease management:
+    * Worker metrics table: Records CPU utilization metrics from each worker. KCL uses these metrics for optimal lease assignments, balancing resource utilization across workers. If CPU utilization metric is not available, KCL assigns leases to balance the total sum of shard throughput per worker instead.
+    * Coordinator state table: Stores internal state information for workers. Used to coordinate in-place migration from KCL 2.x to KCL 3.x and leader election among workers.
+  * Follow this [documentation](https://docs.aws.amazon.com/streams/latest/dev/kcl-migration-from-2-3.html#kcl-migration-from-2-3-IAM-permissions) to add required IAM permissions for your KCL application.
+* Other improvements and changes
+  * Dependency on the AWS SDK for Java 1.x has been fully removed.
+    * The Glue Schema Registry integration functionality no longer depends on AWS SDK for Java 1.x. Previously, it required this as a transient dependency.
+    * Multilangdaemon has been upgraded to use AWS SDK for Java 2.x. It no longer depends on AWS SDK for Java 1.x.
+  * `idleTimeBetweenReadsInMillis` (PollingConfig) now has a minimum default value of 200.
+    * This polling configuration property determines the [publishers](https://github.com/awslabs/amazon-kinesis-client/blob/master/amazon-kinesis-client/src/main/java/software/amazon/kinesis/retrieval/polling/PrefetchRecordsPublisher.java) wait time between GetRecords calls in both success and failure cases. Previously, setting this value below 200 caused unnecessary throttling. This is because Amazon Kinesis Data Streams supports up to five read transactions per second per shard for shared-throughput consumers.
+  * Shard lifecycle management is improved to deal with edge cases around shard splits and merges to ensure records continue being processed as expected.
+* Migration
+  * The programming interfaces of KCL 3.x remain identical with KCL 2.x for an easier migration. For detailed migration instructions, please refer to the [Migrate consumers from KCL 2.x to KCL 3.x](https://docs.aws.amazon.com/streams/latest/dev/kcl-migration-from-2-3.html) page in the Amazon Kinesis Data Streams developer guide.
+* Configuration properties
+  * New configuration properties introduced in KCL 3.x are listed in this [doc](https://github.com/awslabs/amazon-kinesis-client/blob/master/docs/kcl-configurations.md#new-configurations-in-kcl-3x).
+  * Deprecated configuration properties in KCL 3.x are listed in this [doc](https://github.com/awslabs/amazon-kinesis-client/blob/master/docs/kcl-configurations.md#discontinued-configuration-properties-in-kcl-3x). You need to keep the deprecated configuration properties during the migration from any previous KCL version to KCL 3.x.
+* Metrics
+  * New CloudWatch metrics introduced in KCL 3.x are explained in the [Monitor the Kinesis Client Library with Amazon CloudWatch](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-kcl.html) in the Amazon Kinesis Data Streams developer guide. The following operations are newly added in KCL 3.x:
+    * `LeaseAssignmentManager`
+    * `WorkerMetricStatsReporter`
+    * `LeaseDiscovery`
+
+### Release 2.1.1 (February 21, 2023)
+* [#69](https://github.com/awslabs/amazon-kinesis-client-ruby/pull/69) Include `pom.xml` in the gemspec
+
 ### Release 2.1.0 (January 12, 2023)
 * Upgraded to use version 2.4.4 of the [Amazon Kinesis Client library][amazon-kcl-github]
 
@@ -229,8 +266,8 @@ all languages.
 [amazon-kcl]: http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-record-processor-app.html
 [amazon-kcl-github]: https://github.com/awslabs/amazon-kinesis-client
 [amazon-kinesis-python-github]: https://github.com/awslabs/amazon-kinesis-client-python
-[multi-lang-daemon]: https://github.com/awslabs/amazon-kinesis-client/blob/master/src/main/java/com/amazonaws/services/kinesis/multilang/package-info.java
-[DefaultAWSCredentialsProviderChain]: http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html
+[multi-lang-daemon]: https://github.com/awslabs/amazon-kinesis-client/blob/master/amazon-kinesis-client-multilang/src/main/java/software/amazon/kinesis/multilang/package-info.java
+[DefaultCredentialsProvider]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/auth/credentials/DefaultCredentialsProvider.html
 [kinesis-forum]: http://developer.amazonwebservices.com/connect/forum.jspa?forumID=169
 [aws-ruby-sdk-gem]: https://rubygems.org/gems/aws-sdk
 

data/VERSION

@@ -1 +1 @@
-2.1.0
+3.0.0

data/lib/aws/kclrb/kcl_process.rb

@@ -52,8 +52,8 @@ module Aws
       # @param action [Hash] A hash that represents an action to take with
       #   appropriate attributes, as retrieved from {IOProxy#read_action}, e.g.
       #
-      #   - `{"action":"initialize","shardId":"shardId-123"}`
-      #   - `{"action":"processRecords","records":[{"data":"bWVvdw==","partitionKey":"cat","sequenceNumber":"456"}]}`
+      #   - `{"action":"initialize","shardId":"shardId-123","sequenceNumber":123}`
+      #   - `{"action":"processRecords","records":[{"data":"bWVvdw==","partitionKey":"cat","sequenceNumber":"456"}],"millisBehindLatest":"0"}`
       #   - `{"action":"shutdown","reason":"TERMINATE"}`
       # @raise [MalformedAction] if the action is missing expected attributes.
       def process_action(action)

data/pom.xml

@@ -0,0 +1,402 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <properties>
+        <awssdk.version>2.25.64</awssdk.version>
+        <kcl.version>3.0.0</kcl.version>
+        <netty.version>4.1.108.Final</netty.version>
+        <netty-reactive.version>2.0.6</netty-reactive.version>
+        <fasterxml-jackson.version>2.13.5</fasterxml-jackson.version>
+        <logback.version>1.3.14</logback.version>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>software.amazon.kinesis</groupId>
+            <artifactId>amazon-kinesis-client-multilang</artifactId>
+            <version>${kcl.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.kinesis</groupId>
+            <artifactId>amazon-kinesis-client</artifactId>
+            <version>${kcl.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>kinesis</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>dynamodb</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <!-- https://mvnrepository.com/artifact/software.amazon.awssdk/dynamodb-enhanced -->
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>dynamodb-enhanced</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <!-- https://mvnrepository.com/artifact/com.amazonaws/dynamodb-lock-client -->
+        <dependency>
+            <groupId>com.amazonaws</groupId>
+            <artifactId>dynamodb-lock-client</artifactId>
+            <version>1.3.0</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>cloudwatch</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>netty-nio-client</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>metrics-spi</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>sts</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>protocol-core</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>aws-query-protocol</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>aws-cbor-protocol</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>aws-json-protocol</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>json-utils</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>third-party-jackson-core</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>third-party-jackson-dataformat-cbor</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>profiles</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>sdk-core</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>aws-core</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>endpoints-spi</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>auth</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>http-client-spi</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>regions</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>annotations</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>utils</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>apache-client</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>arns</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>http-auth-spi</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>http-auth</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>http-auth-aws</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>checksums-spi</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>checksums</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>identity-spi</artifactId>
+            <version>${awssdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-codec-http</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-codec-http2</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-codec</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-transport</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-resolver</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-common</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-buffer</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-handler</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-transport-native-epoll</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-transport-native-unix-common</artifactId>
+            <version>${netty.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.typesafe.netty</groupId>
+            <artifactId>netty-reactive-streams-http</artifactId>
+            <version>${netty-reactive.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.typesafe.netty</groupId>
+            <artifactId>netty-reactive-streams</artifactId>
+            <version>${netty-reactive.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.reactivestreams</groupId>
+            <artifactId>reactive-streams</artifactId>
+            <version>1.0.3</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>32.1.1-jre</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.code.findbugs</groupId>
+            <artifactId>jsr305</artifactId>
+            <version>3.0.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.checkerframework</groupId>
+            <artifactId>checker-qual</artifactId>
+            <version>2.5.2</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.errorprone</groupId>
+            <artifactId>error_prone_annotations</artifactId>
+            <version>2.7.1</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.j2objc</groupId>
+            <artifactId>j2objc-annotations</artifactId>
+            <version>1.3</version>
+        </dependency>
+        <dependency>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>animal-sniffer-annotations</artifactId>
+            <version>1.20</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.protobuf</groupId>
+            <artifactId>protobuf-java</artifactId>
+            <version>4.27.5</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.14.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>2.0.13</version>
+        </dependency>
+        <dependency>
+            <groupId>io.reactivex.rxjava3</groupId>
+            <artifactId>rxjava</artifactId>
+            <version>3.1.8</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-cbor</artifactId>
+            <version>${fasterxml-jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>${fasterxml-jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${fasterxml-jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-annotations</artifactId>
+            <version>${fasterxml-jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon</groupId>
+            <artifactId>flow</artifactId>
+            <version>1.7</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+            <version>4.5.13</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-codec</groupId>
+            <artifactId>commons-codec</artifactId>
+            <version>1.15</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpcore</artifactId>
+            <version>4.4.15</version>
+        </dependency>
+        <dependency>
+            <groupId>com.amazon.ion</groupId>
+            <artifactId>ion-java</artifactId>
+            <version>1.11.4</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.glue</groupId>
+            <artifactId>schema-registry-serde</artifactId>
+            <version>1.1.19</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>com.amazonaws</groupId>
+                    <artifactId>aws-java-sdk-sts</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+        <dependency>
+            <groupId>joda-time</groupId>
+            <artifactId>joda-time</artifactId>
+            <version>2.10.13</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-core</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.beust</groupId>
+            <artifactId>jcommander</artifactId>
+            <version>1.82</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-io</groupId>
+            <artifactId>commons-io</artifactId>
+            <version>2.16.1</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-logging</groupId>
+            <artifactId>commons-logging</artifactId>
+            <version>1.1.3</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-collections4</artifactId>
+            <version>4.4</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-beanutils</groupId>
+            <artifactId>commons-beanutils</artifactId>
+            <version>1.9.4</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-collections</groupId>
+            <artifactId>commons-collections</artifactId>
+            <version>3.2.2</version>
+        </dependency>
+    </dependencies>
+</project>

data/spec/kcl_process_spec.rb

@@ -27,66 +27,124 @@ module Aws::KCLrb
       end
     end
 
-    def shutdown(checkpointer, reason)
-      checkpointer.checkpoint  if reason == 'TERMINATE'
+    def shutdown_requested(checkpointer)
+      checkpointer.checkpoint
     end
   end
 
+  class TestRecordProcessorV2 < Aws::KCLrb::V2::RecordProcessorBase
+
+    def init_processor(shard_id)
+      # no-op
+    end
+
+    def shutdown_requested(shutdown_requested_input)
+      shutdown_requested_input.checkpointer.checkpoint
+    end
+
+    def process_records(process_records_input)
+      last_seq = nil
+      records = process_records_input.records
+      records.each do |record|
+        last_seq = record['sequenceNumber']
+      end
+
+      if last_seq
+        checkpointer = process_records_input.checkpointer
+        begin
+          checkpointer.checkpoint(last_seq)
+        rescue CheckpointError => cpe
+          if cpe.value == 'ThrottlingException'
+            checkpointer.checkpoint(last_seq)
+          else
+            raise
+          end
+        end
+      end
+    end
+
+  end
+
   describe KCLProcess do
-    describe "#run" do
-      it "should respond to each action by invoking the corresponding processor's method and write a status message to the output IO" do
-        input_specs = [
-          {:method => :init_processor, :action => 'initialize', :input => '{"action":"initialize","shardId":"shard-000001"}'},
-          {:method => :process_records, :action => 'processRecords', :input => '{"action":"processRecords","records":[]}'},
-          {:method => :shutdown, :action => 'shutdown', :input => '{"action":"shutdown","reason":"TERMINATE"}'},
-        ]
-        # pick any of the actions randomly to avoid writing a test for each
-        input_spec = input_specs.sample
-        processor = double(RecordProcessorBase)
-        expect(processor).to receive(input_spec[:method]).once
-        input = StringIO.new(input_spec[:input])
+
+    input_specs = [
+      {:method => :init_processor, :action => 'initialize', :input => '{"action":"initialize","shardId":"shard-000001","sequenceNumber":123456789}'},
+      {:method => :process_records, :action => 'processRecords', :input => '{"action":"processRecords","records":[],"millisBehindLatest":0}'},
+      {:method => :shutdown, :action => 'shutdownRequested', :input => '{"action":"shutdownRequested","reason":"TERMINATE"}'}
+    ]
+    versions = [1, 2]
+
+    describe "#action_response" do
+
+      before(:each) do
+        @processor = double(RecordProcessorBase)
+      end
+
+      input_specs.each do |input_spec|
+        versions.each do |version|
+          it "V#{version} should respond to #{input_spec[:method]} action by invoking the corresponding processor's method and write a status message to the output IO" do
+            allow(@processor).to receive(:version).and_return(version)
+            action_response_common_test(input_spec[:method], input_spec[:action], input_spec[:input], version)
+          end
+        end
+      end
+
+      def action_response_common_test(method, action, input, version)
+        if method == :shutdown
+          expected_shutdown_input = version == 1 ? Aws::KCLrb::CheckpointerImpl : Aws::KCLrb::V2::ShutdownRequestedInput
+          allow(@processor).to receive(:shutdown_requested).with(expected_shutdown_input).and_return(nil)
+        else
+          expect(@processor).to receive(method).once
+        end
+        input = StringIO.new(input)
         output = StringIO.new
         error = StringIO.new
-        driver = KCLProcess.new(processor, input, output, error)
+        driver = KCLProcess.new(@processor, input, output, error)
         driver.run
 
-        expected_output = %Q[{"action":"status","responseFor":"#{input_spec[:action]}"}]
-        expect( output.string.gsub(/\s+/, "") ).to eq(expected_output.gsub(/\s+/, ""))
-        expect( error.string ).to eq("")
-        expect( input.eof? ).to eq(true)
+        expected_output = %Q[{"action":"status","responseFor":"#{action}"}]
+        expect(output.string.gsub(/\s+/, "")).to eq(expected_output.gsub(/\s+/, ""))
+        expect(error.string).to eq("")
+        expect(input.eof?).to eq(true)
       end
-      it "should process a normal stream of actions and produce expected output" do
-        input_string = <<-INPUT
-{"action":"initialize","shardId":"shardId-123"}
-{"action":"processRecords","records":[{"data":"bWVvdw==","partitionKey":"cat","sequenceNumber":"456"}]}
+
+    end
+
+    describe "#run" do
+      versions.each do |version|
+        it "V#{version} should process a normal stream of actions and produce expected output" do
+          input_string = <<-INPUT
+{"action":"initialize","shardId":"shardId-123","sequenceNumber":123}
+{"action":"processRecords","records":[{"data":"bWVvdw==","partitionKey":"cat","sequenceNumber":"456"}],"millisBehindLatest":"0"}
 {"action":"checkpoint","sequenceNumber":"456","error":"ThrottlingException"}
 {"action":"checkpoint","sequenceNumber":"456"}
-{"action":"shutdown","reason":"TERMINATE"}
+{"action":"shutdownRequested","reason":"TERMINATE"}
 {"action":"checkpoint","sequenceNumber":"456"}
-        INPUT
+          INPUT
 
-        # NOTE: The first checkpoint is expected to fail
-        #       with a ThrottlingException and hence the
-        #       retry.
-        expected_output_string = <<-OUTPUT
+          # NOTE: The first checkpoint is expected to fail
+          #       with a ThrottlingException and hence the
+          #       retry.
+          expected_output_string = <<-OUTPUT
 {"action":"status","responseFor":"initialize"}
 {"action":"checkpoint","sequenceNumber":"456"}
 {"action":"checkpoint","sequenceNumber":"456"}
 {"action":"status","responseFor":"processRecords"}
 {"action":"checkpoint","sequenceNumber":null}
-{"action":"status","responseFor":"shutdown"}
-        OUTPUT
-        processor = TestRecordProcessor.new
-        input = StringIO.new(input_string)
-        output = StringIO.new
-        error = StringIO.new
-        driver = KCLProcess.new(processor, input, output, error)
-        driver.run
+{"action":"status","responseFor":"shutdownRequested"}
+          OUTPUT
+          processor = version == 1 ? TestRecordProcessor.new : TestRecordProcessorV2.new
+          input = StringIO.new(input_string)
+          output = StringIO.new
+          error = StringIO.new
+          driver = KCLProcess.new(processor, input, output, error)
+          driver.run
 
-        # outputs should be same modulo some whitespaces
-        expect( output.string.gsub(/\s+/, "") ).to eq(expected_output_string.gsub(/\s+/, ""))
-        expect( error.string ).to eq("")
-        expect( input.eof? ).to eq(true)
+          # outputs should be same modulo some whitespaces
+          expect( output.string.gsub(/\s+/, "") ).to eq(expected_output_string.gsub(/\s+/, ""))
+          expect( error.string ).to eq("")
+          expect( input.eof? ).to eq(true)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-kclrb
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Amazon Web Services
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -24,8 +24,36 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A ruby interface for the Amazon Kinesis Client Library MultiLangDaemon
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -42,6 +70,7 @@ files:
 - lib/aws/kclrb/kcl_process.rb
 - lib/aws/kclrb/messages.rb
 - lib/aws/kclrb/record_processor.rb
+- pom.xml
 - spec/checkpointer_spec.rb
 - spec/io_proxy_spec.rb
 - spec/kcl_process_spec.rb
@@ -50,7 +79,7 @@ homepage: http://github.com/aws/amazon-kinesis-client-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Amazon Kinesis Client Library for Ruby
 test_files: []