Lint all the code

.circleci/config.yml

@@ -100,6 +100,14 @@ jobs:
           key: v1-jackdaw-repo-{{ .Branch }}-{{ .Revision }}
           paths:
             - .
+  lint:
+    executor: machine
+    working_directory: /home/circleci/jackdaw
+    steps:
+      - checkout
+      - run: ls -la
+      - run: docker run --volume `pwd`:/project --rm --workdir /project cljkondo/clj-kondo sh -c 'clj-kondo --lint src test' || true
+
   deps:
     <<: *build_config
     steps:
@@ -111,6 +119,8 @@ jobs:
           key: *mvn_cache_key
           paths:
             - /home/circleci/.m2
+
+
   test:
     <<: *test_config
     steps:
@@ -159,6 +169,7 @@ workflows:
   version: 2
   build_and_test:
     jobs:
+      - lint
       - checkout_code
       - deps:
           requires:

.clj-kondo/config.edn

@@ -0,0 +1,10 @@
+{:linters {:unused-binding { ;; ignore unused :as binding.
+                            :exclude-destructured-as true}
+           :unresolved-symbol { ;; `thrown-with-msg-and-data?` is a legit extension to the `is` macro
+                               ;; via an `assert-expr` defmethod (see clojure.test doc)
+                               :exclude [(clojure.test/is [thrown-with-msg-and-data?])]}}
+
+ :lint-as {clojure.test.check.clojure-test/defspec clojure.core/def
+           jackdaw.data/defn->data clojure.core/defn
+           jackdaw.test.transports/deftransport clojure.core/defn
+           manifold.deferred/loop clojure.core/let}}

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### Unreleased
+
+- Add clj-kondo and fix all lint warnings and errors [#323](https://github.com/FundingCircle/jackdaw/pull/323)
+
 ### [0.9.5] - [2022-05-26]
 
 * Move away from deprecated class ConsumerRecordFactory (to prepare migration to Kafka Streams 3.2.0)

src/jackdaw/admin.clj

@@ -158,7 +158,7 @@
   {:pre [(client? client)
          (sequential? topics)]}
   (->> @(describe-topics* client (map :topic-name topics))
-       (every? (fn [[topic-name {:keys [partition-info]}]]
+       (every? (fn [[_topic-name {:keys [partition-info]}]]
                  (every? (fn [part-info]
                            (and (boolean (:leader part-info))
                                 (seq (:isr part-info))))

src/jackdaw/client.clj

@@ -26,16 +26,16 @@
 
 ;;;; Producer
 
-(defn ^KafkaProducer producer
+(defn producer
   "Return a producer with the supplied properties and optional Serdes."
-  ([config]
+  (^KafkaProducer [config]
    (KafkaProducer. ^java.util.Properties (jd/map->Properties config)))
-  ([config {:keys [^Serde key-serde ^Serde value-serde]}]
+  (^KafkaProducer [config {:keys [^Serde key-serde ^Serde value-serde]}]
    (KafkaProducer. ^java.util.Properties (jd/map->Properties config)
                    (.serializer key-serde)
                    (.serializer value-serde))))
 
-(defn ^Callback callback
+(defn callback
   "Return a kafka `Callback` function out of a clojure `fn`.
 
   The fn must be of 2-arity, being `[record-metadata?, ex?]` where the
@@ -44,9 +44,9 @@
   the record.
 
   Callbacks are `void`, so the return value is ignored."
-  [on-completion]
+  ^Callback [on-completion]
   (reify Callback
-    (onCompletion [this record-meta exception]
+    (onCompletion [_this record-meta exception]
       (on-completion record-meta exception))))
 
 (defn send!
@@ -89,11 +89,11 @@
 
 ;;;; Consumer
 
-(defn ^KafkaConsumer consumer
+(defn consumer
   "Return a consumer with the supplied properties and optional Serdes."
-  ([config]
+  (^KafkaConsumer [config]
    (KafkaConsumer. ^java.util.Properties (jd/map->Properties config)))
-  ([config {:keys [^Serde key-serde ^Serde value-serde] :as t}]
+  (^KafkaConsumer [config {:keys [^Serde key-serde ^Serde value-serde] :as t}]
 
    (when-not (or key-serde
                  (get config "key.deserializer"))
@@ -134,15 +134,15 @@
                                 topic-configs))
   consumer)
 
-(defn ^KafkaConsumer subscribed-consumer
+(defn subscribed-consumer
   "Given a broker configuration and topics, returns a consumer that is
   subscribed to all of the given topic descriptors.
 
   WARNING: All topics subscribed to by a single consumer must share a
   single pair of key and value serde instances. The serdes of the
   first requested topic are used, and all other topics are expected to
   be able to use same serdes."
-  [config topic-configs]
+  ^KafkaConsumer [config topic-configs]
   (when-not (sequential? topic-configs)
     (throw (ex-info "subscribed-consumer takes a seq of topics!"
                     {:topic-configs topic-configs})))

src/jackdaw/client/partitioning.clj

@@ -34,7 +34,8 @@
   in `jackdaw.client` but backed by the partitioning machinery."
   {:license
    "BSD 3-Clause License <https://github.com/FundingCircle/jackdaw/blob/master/LICENSE>"}
-  (:require [jackdaw.client :as jc]
+  (:require [clojure.string :as str]
+            [jackdaw.client :as jc]
             [jackdaw.data :as jd])
   (:import org.apache.kafka.clients.producer.Producer
            org.apache.kafka.common.serialization.Serde
@@ -49,9 +50,9 @@
   [{:keys [record-key] :as t}]
   (let [record-key (as-> record-key %
                      (-> %
-                         (clojure.string/replace  "$." "")
-                         (clojure.string/replace  "_" "-")
-                         (clojure.string/split  #"\."))
+                         (str/replace  "$." "")
+                         (str/replace  "_" "-")
+                         (str/split  #"\."))
                      (mapv keyword %))]
     (assoc t ::key-fn #(get-in % record-key))))
 
@@ -63,7 +64,7 @@
 
 (defn default-partition
   "The kafka default partitioner. As a `::partition-fn`"
-  [{:keys [topic-name key-serde]} key value partitions]
+  [{:keys [topic-name key-serde]} key _value partitions]
   (let [key-bytes (.serialize (.serializer ^Serde key-serde) topic-name key)]
     (default-partitioner* key-bytes partitions)))
 
@@ -91,11 +92,11 @@
        (partition-fn t key value %)
        (->ProducerRecord producer t % key value))
      (jd/->ProducerRecord t key value)))
-  ([^Producer producer topic partition key value]
+  ([^Producer _producer topic partition key value]
    (jd/->ProducerRecord topic (int partition) key value))
-  ([^Producer producer topic partition timestamp key value]
+  ([^Producer _producer topic partition timestamp key value]
    (jd/->ProducerRecord topic partition  timestamp key value))
-  ([^Producer producer topic partition timestamp key value headers]
+  ([^Producer _producer topic partition timestamp key value headers]
    (jd/->ProducerRecord topic partition timestamp key value headers)))
 
 (defn produce!
@@ -107,15 +108,15 @@
   ([producer topic value]
    (jc/send! producer
              (->ProducerRecord producer topic value)))
-  ([producer topic key value]
+  ([producer topic _key value]
    (jc/send! producer
              (->ProducerRecord producer topic value)))
-  ([producer topic partition key value]
+  ([producer topic partition _key value]
    (jc/send! producer
              (->ProducerRecord producer topic partition topic value)))
-  ([producer topic partition timestamp key value]
+  ([producer topic partition timestamp _key value]
    (jc/send! producer
              (->ProducerRecord producer topic partition timestamp topic value)))
-  ([producer topic partition timestamp key value headers]
+  ([producer topic partition timestamp _key value headers]
    (jc/send! producer
              (->ProducerRecord producer topic partition timestamp topic value headers))))

src/jackdaw/data.clj

@@ -34,7 +34,8 @@
              (datafy [o] o)))))
 
 ;;; Just vendor this - not worth the footwork to import the "real" one
-
+;; Ignore clj-kondo's warning: Unresolved namespace clojure.core.protocols. Are you missing a require?
+#_{:clj-kondo/ignore [:unresolved-namespace]}
 (defn datafy
   "Attempts to return x as data.
 

src/jackdaw/data/admin.clj

@@ -16,7 +16,6 @@
     (ConfigEntry. k (:value v))))
 
 (defn->data ConfigEntry->data
-  ""
   [^ConfigEntry e]
   {:name (.name e)
    :value (.value e)
@@ -27,13 +26,11 @@
 ;;; Config
 
 (defn map->Config
-  ""
   ^Config [m]
   (Config.
    (map (partial apply ->ConfigEntry) m)))
 
 (defn->data Config->data
-  ""
   [^Config c]
   (into {}
         (comp (map ConfigEntry->data)
@@ -44,15 +41,13 @@
 ;;; TopicDescription
 
 (defn->data TopicDescription->data
-  ""
   [^TopicDescription td]
   {:is-internal? (.isInternal td)
    :partition-info (map datafy (.partitions td))})
 
 ;;; NewTopic
 
 (defn map->NewTopic
-  ""
   [{:keys [:topic-name
            :partition-count
            :replication-factor
@@ -71,7 +66,6 @@
 ;;;; Result types
 
 (defn->data DescribeClusterResult->data
-  ""
   [^DescribeClusterResult dcr]
   {:cluster-id (-> dcr .clusterId .get)
    :controller (-> dcr .controller .get datafy)

src/jackdaw/data/common.clj

@@ -10,7 +10,6 @@
 ;;; Node
 
 (defn->data Node->data
-  ""
   [^Node node]
   {:host (.host node)
    :port (.port node)
@@ -31,7 +30,6 @@
 ;;; TopicPartitionInfo
 
 (defn->data TopicPartitionInfo->data
-  ""
   [^TopicPartitionInfo tpi]
   {:isr (mapv datafy (.isr tpi))
    :leader (datafy (.leader tpi))
@@ -40,26 +38,23 @@
 
 ;;; Topic partition tuples
 
-(defn ^TopicPartition ->TopicPartition
+(defn ->TopicPartition
   "Given unrolled ctor-style arguments, create a Kafka `TopicPartition`."
-  [{:keys [:topic-name]} partition]
+  ^TopicPartition [{:keys [:topic-name]} partition]
   (TopicPartition. topic-name (int partition)))
 
 (defn map->TopicPartition
-  "Given a `::topic-parititon`, build an equivalent `TopicPartition`.
+  "Given a `topic-partition`, build an equivalent `TopicPartition`.
 
   Inverts `(datafy ^TopicPartition tp)`."
-  [{:keys [topic-name
-           partition]
-    :as m}]
+  [{:keys [partition] :as m}]
   (->TopicPartition m partition))
 
 (defn->data TopicPartition->data [^TopicPartition tp]
   {:topic-name (.topic tp)
    :partition (.partition tp)})
 
 (defn as-TopicPartition
-  ""
   ^TopicPartition [o]
   (cond (instance? TopicPartition o)
         o

src/jackdaw/data/common_config.clj

@@ -8,15 +8,12 @@
 ;;; ConfigResource.Type
 
 (def +broker-config-resource-type+
-  ""
   ConfigResource$Type/BROKER)
 
 (def +topic-config-resource-type+
-  ""
   ConfigResource$Type/TOPIC)
 
 (def +unknown-config-resource-type+
-  ""
   ConfigResource$Type/UNKNOWN)
 
 (defn ->ConfigResourceType [o]
@@ -26,7 +23,6 @@
     +unknown-config-resource-type+))
 
 (defn->data ConfigResourceType->data
-  ""
   [^ConfigResource$Type crt]
   (cond (= +broker-config-resource-type+ crt)
         :config-resource/broker
@@ -40,22 +36,18 @@
 ;;; ConfigResource
 
 (defn ->ConfigResource
-  ""
   [^ConfigResource$Type type ^String name]
   (ConfigResource. type name))
 
 (defn ->topic-resource
-  ""
   [name]
   (->ConfigResource +topic-config-resource-type+ name))
 
 (defn ->broker-resource
-  ""
   [name]
   (->ConfigResource +broker-config-resource-type+ name))
 
 (defn->data ConfigResource->data
-  ""
   [^ConfigResource cr]
   {:name (.name cr)
    :type (datafy (.type cr))})

src/jackdaw/data/consumer.clj

@@ -6,15 +6,16 @@
 
 (import '[org.apache.kafka.clients.consumer
           ConsumerRecord OffsetAndTimestamp]
-        'org.apache.kafka.common.header.Headers)
+        'org.apache.kafka.common.header.Headers
+        'org.apache.kafka.common.record.TimestampType)
 
 (set! *warn-on-reflection* true)
 
-(defn ^ConsumerRecord ->ConsumerRecord
+(defn ->ConsumerRecord
   "Given unrolled ctor-style arguments create a Kafka `ConsumerRecord`.
 
   Convenient for testing the consumer API and its helpers."
-  [{:keys [:topic-name]} partition offset ts ts-type
+  ^ConsumerRecord [{:keys [:topic-name]} partition offset ts ts-type
    key-size value-size key value ^Headers headers]
   (ConsumerRecord. topic-name
                    (int partition)
@@ -72,16 +73,15 @@
 
 ;;; OffsetAndTimestamp tuples
 
-(defn ^OffsetAndTimestamp ->OffsetAndTimestamp
-  [{:keys [offset timestamp]}]
+(defn ->OffsetAndTimestamp
+  ^OffsetAndTimestamp [{:keys [offset timestamp]}]
   (OffsetAndTimestamp. offset (long timestamp)))
 
 (defn->data OffsetAndTimestamp->data [^OffsetAndTimestamp ots]
   {:offset (.offset ots)
    :timestamp (.timestamp ots)})
 
-(defn map->OffsetAndTimestamp
-  [{:keys [offset timestamp] :as m}]
+(defn map->OffsetAndTimestamp [m]
   (->OffsetAndTimestamp m))
 
 (defn as-OffsetAndTimestamp