Release 0.17.0

.gitignore

@@ -0,0 +1,19 @@
+# default excludes
+
+# maven
+target
+
+# intellij
+*.iml
+.idea
+
+# eclipse
+*.project
+*.classpath
+.settings
+
+# mac os
+.DS_Store
+
+# local spring boot configuration
+/config

AUTHORS

@@ -0,0 +1,4 @@
+Contributors:
+
+Alexander Palamarchuk
+Leo Kuzmanovic

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+    Copyright 2019 idealo internet GmbH
+
+   Licensed 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.

README.md

@@ -0,0 +1,97 @@
+# Kafka EX1
+
+**Kafka EX1** is an autoconfigurable utility to equip your Spring Kafka listeners with the idempotency,
+maintaining the "exactly-once" (the name of the artifact is a play of these words) semantics.
+
+A typical use case for this is when a Kafka consumer executes one or a set of actions (e.g. sending an email) that should not be performed twice.
+But if you discover that your live system has a bug, which in some cases leads to non-retryable exceptions thrown to the consumer.
+With Kafka you can simply reset the offsets of the consumer and re-process the events from the moment the bug went live. This however demands you
+implement an extra-logic in your software, so that it understands what actions were already done and what weren't, so that you execute the missing steps,
+but not redo them. In quite many cases it is _universally_ enough just to remember a record and to ignore the whole consumer handler method call.
+And **Kafka EX1** will help you here easily. The only thing you need to have is persistence.
+
+## Requirements
+* Java 11
+* Spring Boot 2.2
+* Spring Kafka
+* Redis (the only supported persistence provider at the moment)
+
+## Installation
+1. Add dependency to your pom.xml.
+We are currently working on publishing the "Kafka EX1" artifact to Maven Central. Whilst this hasn't you can build it on your own. 
+
+2. Enable AspectJ proxying:
+```java
+@EnableAspectJAutoProxy
+@SpringBootApplication
+public class Application {
+  // ...    
+}
+```
+
+3. Set Spring Redis autoconfiguration properties:
+```yaml
+spring:
+  redis:
+    sentinel:
+      master: as_op_redis
+      nodes:
+        - 'redis-01.example.net:26379'
+        - 'redis-02.example.net:26379'
+        - 'redis-03.example.net:26379'
+```
+
+## Usage
+In order to use the @IdempotentListener annotation you have to supply Kafka listeners with sets of record parameters 
+ that are unique at least within their consumer group.
+
+It can be one surrogate event UUID taken from the header if publish records equipped with that:
+```java
+class MyTopicListener {
+    @KafkaListener(topics = "my-topic")
+    @IdempotentListener(ttl = 86400)
+    public void onEvent(
+            @Payload MyEvent event,
+            @IdempotencyId @Header(name = "EVENT_ID") String eventId) {
+       // ...
+    }   
+    // ...
+}
+```
+When this listener method is called @IdempotentListener will take care of iterating over all arguments annotated 
+ with @IdempotencyId, build a unique key out of them and persist it in Redis with the configured TTL.
+ If the annotation parameter "ttl" is not set, the default global setting is used (also configurable; see below).
+
+The most universal way of supplying unique record keys is to use the topic name, partition and offset. You don't need to do 
+ anything with producers, because Spring will take care of them automatically:
+```java
+import org.springframework.kafka.support.KafkaHeaders;
+
+class MyTopicListener {
+    @KafkaListener(topics = "my-topic")
+    @IdempotentListener
+    public void onEvent(
+            @Payload MyEvent event,
+            @IdempotencyId @Header(KafkaHeaders.RECEIVED_TOPIC) String topic,
+            @IdempotencyId @Header(KafkaHeaders.RECEIVED_PARTITION_ID) int partition,
+            @IdempotencyId @Header(KafkaHeaders.OFFSET) Long offset) {
+       // ...
+    }   
+    // ...
+}
+```
+
+Of course you can use shared Redis even if there are multiple applications consuming from same topic.
+ The library automatically prefixes all keys with consumer group id taken from the autoconfigured Spring Kafka properties. 
+
+## Configuration
+There is a number of properties that can change the behavior of Kafka Idempotency.
+
+| Property | Default | Description |
+| :---: | :---: | :---: |
+| `idealo.kafka.idempotency.enabled` | true | Use this to disable the library completely |  
+| `idealo.kafka.idempotency.listener.checkEnabled` | true  | Using this property you can completely ignore the idempotency check even if the annotation `@IdempotentListener` is set. <br />This might be useful e.g. if you want to temporarily force the listeners re-consume all the events ignoring saved idempotency markers. <br />Note that the idempotency markers keep to be persisted independently of this setting. |  
+| `idealo.kafka.idempotency.listener.persistenceEnabled` | true | Using this property you can completely disable saving the idempotency markers. <br /> This might be useful is something in your setup is broken, but you do not want to block record consumption. <br />Note that there'll be no way to provide the only-one semantic for the records that were consumed during this setting was set to false. |  
+| `idealo.kafka.idempotency.listener.ttl` | 7d | Duration of the guaranteed idempotency per record. <br />After expiring, the information about a consumed record is removed from persistence. <br />This can be overridden per listener, directly in `@IdempotentListener`. |  
+| `idealo.kafka.idempotency.listener.keyPrefix` | kafkaidmp | Prefix used for all the keys persisted in Redis that contain the idempotency information. Whilst in Redis it is only possible to use the TTL feature only on the keys, we cannot use Sets in order to at least namespace the data handled by this library. The workaround for this is to use simple "1-character" strings in the root namespace, where the information for the lookup is hold by the keys. This is how a typical key with the default prefix looks like: <br />`kafkaidmp_myconsumerid_1c9bb6f0-5b91-4be7-acad-6bf089ed0bef`. <br />If the traffic in the topic you use this library is really of a high scale, you should monitor the memory footprint of the idempotency data in Redis. This property give you extra means for optimisation. |  
+| `idealo.kafka.idempotency.listener.suppressErrors` | false | If true, any exceptions during the lookup or persistence are logged, but not bubbled up to the listener container. <br />A typical case when this matter is e.g. short outages of the Redis cluster. If this happens, the idempotency data cannot be persisted, hence cannot be later looked up and therefore the idempotency is simply not maintained. Such behavior is inconsistent and should be avoided. However in practice the error handling and acknowledgment logic are sometimes not properly configured, which in case of such an outage leads to skipped records, which is normally worse, than inability to maintain the exactly-one semantic. If this is your situation, you can set this option to true. <br />     * Note that this only changes the behavior of the look up hook, as it already makes no sense to throw an exception after the record handler has correctly finished its work: a retry would make it process the same record again, whereas it indeed relies on the idempotency check to maintain the exactly-one semantics.|  

jenkins/pipeline.groovy

@@ -0,0 +1,42 @@
+@Library('idp@0.17.11')
+
+String sourceRepository = 'ssh://git@code.eu.idealo.com:7999/dk/kafka-consumer-idempotency.git'
+
+pipeline {
+    agent { node { label 'java' } }
+
+    environment {
+        IDP_SKIP_STAGES = true
+    }
+
+    stages {
+        stage('test and install new version') {
+            steps {
+                script {
+                    idp_maven {
+                        gitRepoUrl = sourceRepository
+                        mavenGoals = "clean install"
+                        jdkVersion = 'openjdk-11.0.2'
+                    }
+                }
+            }
+        }
+        stage('release to artifactory') {
+            steps {
+                script {
+                    idp_createBuildVersion {
+                        gitRepoUrl = sourceRepository
+                    }
+                }
+                script {
+                    idp_buildReleasable {
+                        mvnSkipTests = true
+                        artifactoryTargetRepo = 'libs-commit-local'
+                        jdkVersion = 'openjdk-11.0.2'
+                    }
+                }
+            }
+        }
+    }
+
+}