Merge pull request #194 from nilenso/ci-formatting-check

Add formatting check in CI
nilenso · Sep 29, 2024 · c2bfa66 · c2bfa66
2 parents cbf90ae + b13239c
commit c2bfa66
Show file tree

Hide file tree

Showing 77 changed files with 712 additions and 701 deletions.
diff --git a/.github/workflows/test_lint.yml → .github/workflows/fmt_test_lint.yml b/.github/workflows/test_lint.yml → .github/workflows/fmt_test_lint.yml
@@ -3,7 +3,7 @@ name: ci
 on: [ push ]
 
 jobs:
-  test:
+  fmt_test:
     runs-on: ubuntu-20.04
     container: clojure:openjdk-19-tools-deps-1.11.1.1113-bullseye
     services:
@@ -22,6 +22,8 @@ jobs:
           RABBITMQ_DEFAULT_PASS: top-gun
     steps:
       - uses: actions/checkout@v3
+      - name: Check formatting
+        run: clojure -M:cljfmt check
       - name: Run tests
         run: clj -X:test
         env:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -28,6 +28,16 @@ $ clj -X:test                            # Running all tests.
 $ docker-compose down                    # ...when you're done.
 ```
 
+Formatting
+--------
+- Goose adheres to the [weavejester/cljfmt](https://clojars.org/dev.weavejester/cljfmt) library to maintain consistent code formatting.
+- Install the appropriate plugin for your IDE to ensure compliance.
+
+```shell
+$ clj -M:cljfmt fix                      # Automatically fix formatting issues.
+$ clj -M:cljfmt check                    # Check any formatting inconsistencies.
+```
+
 Linting
 --------
 - Install [clj-kondo v2022.10.05](https://github.com/clj-kondo/clj-kondo/blob/master/doc/install.md#installation-script-macos-and-linux)

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ Features
 - Pluggable [Message Broker](https://github.com/nilenso/goose/wiki/Guide-to-Message-Broker-Integration) & [Metrics Backend](https://github.com/nilenso/goose/wiki/Guide-to-Custom-Metrics-Backend)
 - [Scheduled Jobs](https://github.com/nilenso/goose/wiki/Scheduled-Jobs)
 - [Batch Jobs](https://github.com/nilenso/goose/wiki/Batch-Jobs)
-- [Cron Jobs](https://github.com/nilenso/goose/wiki/Cron)
+- [Cron Jobs](https://github.com/nilenso/goose/wiki/Cron-Jobs)
 - [Error Handling & Retries](https://github.com/nilenso/goose/wiki/Error-Handling-&-Retries)
 - [Console](https://github.com/nilenso/goose/wiki/Console)
 - Extensible using [Middlewares](https://github.com/nilenso/goose/wiki/Middlewares)
@@ -76,7 +76,7 @@ com.nilenso/goose {:mvn/version "0.5.3"}
   (w/stop worker) ; Performs graceful shutsdown.
   (rmq/close rmq-consumer))
 ```
-Refer to wiki for [Redis](https://github.com/nilenso/goose/wiki/Redis), [Cron](https://github.com/nilenso/goose/wiki/Cron), [Error Handling](https://github.com/nilenso/goose/wiki/Error-Handling-&-Retries), [Monitoring](https://github.com/nilenso/goose/wiki/Monitoring-&-Alerting), [Production Readiness](https://github.com/nilenso/goose/wiki/Production-Readiness), etc.
+Refer to wiki for [Redis](https://github.com/nilenso/goose/wiki/Redis), [Cron Jobs](https://github.com/nilenso/goose/wiki/Cron-Jobs), [Error Handling](https://github.com/nilenso/goose/wiki/Error-Handling-&-Retries), [Monitoring](https://github.com/nilenso/goose/wiki/Monitoring-&-Alerting), [Production Readiness](https://github.com/nilenso/goose/wiki/Production-Readiness), etc.
 
 Getting Help
 ---------

diff --git a/architecture-decisions/README.md b/architecture-decisions/README.md
@@ -23,7 +23,7 @@ Index
 1. [Enqueue-Dequeue](https://github.com/nilenso/goose/blob/main/architecture-decisions/pages/enqueue-dequeue.md)
 1. [Priority/Customized Queues](https://github.com/nilenso/goose/blob/main/architecture-decisions/pages/priority-queues.md)
 1. [Scheduled Jobs](https://github.com/nilenso/goose/blob/main/architecture-decisions/pages/scheduled-jobs.md)
-1. [Cron Jobs](https://github.com/nilenso/goose/blob/main/architecture-decisions/pages/periodic-jobs.md)
+1. [Cron Jobs](https://github.com/nilenso/goose/blob/main/architecture-decisions/pages/cron-jobs.md)
 1. [Batch Jobs](https://github.com/nilenso/goose/blob/main/architecture-decisions/pages/batch-jobs.md)
 1. [Error-handling & Retrying](https://github.com/nilenso/goose/blob/main/architecture-decisions/pages/error-handling.md)
 1. [API](https://github.com/nilenso/goose/blob/main/architecture-decisions/pages/api.md)

diff --git a/...itecture-decisions/pages/periodic-jobs.md → architecture-decisions/pages/cron-jobs.md b/...itecture-decisions/pages/periodic-jobs.md → architecture-decisions/pages/cron-jobs.md
diff --git a/deps.edn b/deps.edn
@@ -21,6 +21,8 @@
                         :exec-fn     test-runner/test-and-shutdown}
            :repl       {:extra-deps {vvvvalvalval/scope-capture  {:mvn/version "0.3.2"}
                                      org.clojure/tools.namespace {:mvn/version "1.3.0"}}}
+           :cljfmt     {:deps      {dev.weavejester/cljfmt {:mvn/version "0.12.0"}}
+                        :main-opts ["-m" "cljfmt.main"]}
            :redis-perf {:extra-paths ["perf"]
                         :exec-fn     goose.redis.load/benchmark
                         :extra-deps  {criterium/criterium                 {:mvn/version "0.4.6"}

diff --git a/src/goose/api/batch.clj b/src/goose/api/batch.clj
@@ -1,7 +1,7 @@
 (ns goose.api.batch
   (:require
-    [goose.broker :as b]
-    [goose.client]))
+   [goose.broker :as b]
+   [goose.client]))
 
 (defn status
   "For given `:batch-id`, reports progress of a batch.

diff --git a/src/goose/api/cron_jobs.clj b/src/goose/api/cron_jobs.clj
@@ -1,12 +1,12 @@
 (ns goose.api.cron-jobs
-  "API to manage Cron Entries.\\
+  "API to manage Cron Entries & Cron-Scheduled Jobs.\\
   To update a cron entry, call [[goose.client/perform-every]] since it is idempotent.
   - [API wiki](https://github.com/nilenso/goose/wiki/API)"
   (:require
-    [goose.broker :as b]))
+   [goose.broker :as b]))
 
 (defn size
-  "Returns count of Cron entries."
+  "Returns count of Cron Jobs."
   [broker]
   (b/cron-jobs-size broker))
 

diff --git a/src/goose/api/dead_jobs.clj b/src/goose/api/dead_jobs.clj
@@ -3,7 +3,7 @@
   - [API wiki](https://github.com/nilenso/goose/wiki/API)"
   (:refer-clojure :exclude [pop])
   (:require
-    [goose.broker :as b]))
+   [goose.broker :as b]))
 
 (defn size
   "Returns count of Dead Jobs."

diff --git a/src/goose/api/enqueued_jobs.clj b/src/goose/api/enqueued_jobs.clj
@@ -2,7 +2,7 @@
   "API to manage enqueued jobs.
   - [API wiki](https://github.com/nilenso/goose/wiki/API)"
   (:require
-    [goose.broker :as b]))
+   [goose.broker :as b]))
 
 (defn list-all-queues
   "Lists all the queues."

diff --git a/src/goose/api/scheduled_jobs.clj b/src/goose/api/scheduled_jobs.clj
@@ -2,7 +2,7 @@
   "API to manage scheduled jobs.
   - [API wiki](https://github.com/nilenso/goose/wiki/API)"
   (:require
-    [goose.broker :as b]))
+   [goose.broker :as b]))
 
 (defn size
   "Returns count of Scheduled Jobs."

diff --git a/src/goose/batch.clj b/src/goose/batch.clj
@@ -1,9 +1,9 @@
 (ns goose.batch
   (:require
-    [goose.job :as job]
-    [goose.utils :as u]
+   [goose.job :as job]
+   [goose.utils :as u]
 
-    [clojure.tools.logging :as log]))
+   [clojure.tools.logging :as log]))
 
 (defn construct-args
   "A utility function to construct a collection of args for batch-jobs."

diff --git a/src/goose/broker.clj b/src/goose/broker.clj
@@ -43,7 +43,7 @@
   (scheduled-jobs-purge [this] "Purges all the Scheduled Jobs.")
 
   ;; cron jobs API
-  (cron-jobs-size [this] "Returns count of Cron entries.")
+  (cron-jobs-size [this] "Returns count of Cron Entries.")
   (cron-jobs-find-by-name [this entry-name] "Finds a Cron Entry by `:name`.")
   (cron-jobs-delete [this entry-name] "Deletes Cron Entry & Cron-Scheduled Job of given `:name`.")
   (cron-jobs-purge [this] "Purges all the Cron Entries & Cron-Scheduled Jobs.")

diff --git a/src/goose/brokers/redis/api/batch.clj b/src/goose/brokers/redis/api/batch.clj
@@ -1,9 +1,9 @@
 (ns ^:no-doc goose.brokers.redis.api.batch
   (:require
-    [goose.brokers.redis.api.enqueued-jobs :as enqueued-jobs]
-    [goose.brokers.redis.api.scheduled-jobs :as scheduled-jobs]
-    [goose.brokers.redis.batch :as batch]
-    [goose.brokers.redis.commands :as redis-cmds]))
+   [goose.brokers.redis.api.enqueued-jobs :as enqueued-jobs]
+   [goose.brokers.redis.api.scheduled-jobs :as scheduled-jobs]
+   [goose.brokers.redis.batch :as batch]
+   [goose.brokers.redis.commands :as redis-cmds]))
 
 (defn status [redis-conn id]
   (batch/get-batch redis-conn id))

diff --git a/src/goose/brokers/redis/api/dead_jobs.clj b/src/goose/brokers/redis/api/dead_jobs.clj
@@ -1,9 +1,9 @@
 (ns ^:no-doc goose.brokers.redis.api.dead-jobs
   (:refer-clojure :exclude [pop])
   (:require
-    [goose.brokers.redis.commands :as redis-cmds]
-    [goose.defaults :as d]
-    [goose.job :as job]))
+   [goose.brokers.redis.commands :as redis-cmds]
+   [goose.defaults :as d]
+   [goose.job :as job]))
 
 (defn size [redis-conn]
   (redis-cmds/sorted-set-size redis-conn d/prefixed-dead-queue))
@@ -51,7 +51,7 @@
 
 (defn delete-older-than [redis-conn epoch-ms]
   (< 0 (redis-cmds/del-from-sorted-set-until
-         redis-conn d/prefixed-dead-queue epoch-ms)))
+        redis-conn d/prefixed-dead-queue epoch-ms)))
 
 (defn purge [redis-conn]
   (= 1 (redis-cmds/del-keys redis-conn d/prefixed-dead-queue)))

diff --git a/src/goose/brokers/redis/api/enqueued_jobs.clj b/src/goose/brokers/redis/api/enqueued_jobs.clj
@@ -1,8 +1,8 @@
 (ns ^:no-doc goose.brokers.redis.api.enqueued-jobs
   (:require
-    [goose.brokers.redis.commands :as redis-cmds]
-    [goose.defaults :as d]
-    [goose.job :as job]))
+   [goose.brokers.redis.commands :as redis-cmds]
+   [goose.defaults :as d]
+   [goose.job :as job]))
 
 (defn list-all-queues
   "Lists all the queues"

diff --git a/src/goose/brokers/redis/api/scheduled_jobs.clj b/src/goose/brokers/redis/api/scheduled_jobs.clj
@@ -1,8 +1,8 @@
 (ns ^:no-doc goose.brokers.redis.api.scheduled-jobs
   (:require
-    [goose.brokers.redis.commands :as redis-cmds]
-    [goose.defaults :as d]
-    [goose.job :as job]))
+   [goose.brokers.redis.commands :as redis-cmds]
+   [goose.defaults :as d]
+   [goose.job :as job]))
 
 (defn size [redis-conn]
   (redis-cmds/sorted-set-size redis-conn d/prefixed-schedule-queue))

diff --git a/src/goose/brokers/redis/batch.clj b/src/goose/brokers/redis/batch.clj
@@ -1,15 +1,15 @@
 (ns ^:no-doc goose.brokers.redis.batch
   (:require
-    [goose.batch :as batch]
-    [goose.brokers.redis.commands :as redis-cmds]
-    [goose.defaults :as d]
-    [goose.job :as job]
-    [goose.metrics :as m]
-    [goose.retry]
-    [goose.utils :as u]
+   [goose.batch :as batch]
+   [goose.brokers.redis.commands :as redis-cmds]
+   [goose.defaults :as d]
+   [goose.job :as job]
+   [goose.metrics :as m]
+   [goose.retry]
+   [goose.utils :as u]
 
-    [taoensso.carmine :as car]
-    [clojure.tools.logging :as log]))
+   [taoensso.carmine :as car]
+   [clojure.tools.logging :as log]))
 
 (defn batch-keys [id]
   {:batch-hash   (d/prefix-batch id)
@@ -24,40 +24,40 @@
         pruned-batch-state (dissoc batch :jobs)
         job-ids (map :id jobs)]
     (redis-cmds/atomic
-      redis-conn
-      (car/multi)
-      (car/hmset* batch-hash pruned-batch-state)
-      (apply car/sadd enqueued-set job-ids)
-      (doseq [job jobs]
-        (car/lpush (:ready-queue job) job)))))
+     redis-conn
+     (car/multi)
+     (car/hmset* batch-hash pruned-batch-state)
+     (apply car/sadd enqueued-set job-ids)
+     (doseq [job jobs]
+       (car/lpush (:ready-queue job) job)))))
 
 ;;; When fetching a hash from Redis, primitive data types
 ;;; like integer, boolean and keyword get converted to string.
 ;;; We restore data types to avoid any type-casting errors.
 (defn- restore-data-types
   [{:keys [linger-sec total status created-at] :as batch}]
   (assoc batch
-    :linger-sec (Long/valueOf linger-sec)
-    :total (Long/valueOf total)
-    :status (keyword status)
-    :created-at (Long/valueOf created-at)))
+         :linger-sec (Long/valueOf linger-sec)
+         :total (Long/valueOf total)
+         :status (keyword status)
+         :created-at (Long/valueOf created-at)))
 
 (defn get-batch
   [redis-conn id]
   (let [{:keys [batch-hash enqueued-set retrying-job-set success-set dead-set]} (batch-keys id)
         [batch enqueued retrying success dead] (redis-cmds/wcar*
-                                                 redis-conn
-                                                 (car/parse-map (car/hgetall batch-hash) :keywordize)
-                                                 (car/scard enqueued-set)
-                                                 (car/scard retrying-job-set)
-                                                 (car/scard success-set)
-                                                 (car/scard dead-set))]
+                                                redis-conn
+                                                (car/parse-map (car/hgetall batch-hash) :keywordize)
+                                                (car/scard enqueued-set)
+                                                (car/scard retrying-job-set)
+                                                (car/scard success-set)
+                                                (car/scard dead-set))]
     (when (not-empty batch)
       (assoc (restore-data-types batch)
-        :enqueued enqueued
-        :retrying retrying
-        :success success
-        :dead dead))))
+             :enqueued enqueued
+             :retrying retrying
+             :success success
+             :dead dead))))
 
 (defn- record-metrics
   [{:keys [metrics-plugin]}
@@ -77,17 +77,17 @@
   (let [{:keys [batch-hash success-set dead-set]} (batch-keys id)
         callback (batch/new-callback-job batch id completion-status)]
     (redis-cmds/atomic
-      redis-conn
-      (car/multi)
+     redis-conn
+     (car/multi)
       ;; Enqueue callback to front of queue.
-      (car/rpush ready-queue callback)
+     (car/rpush ready-queue callback)
       ;; Update batch status to reflect completion status.
-      (car/hset batch-hash :status completion-status)
+     (car/hset batch-hash :status completion-status)
       ;; Terminal job execution marks completion of a batch, NOT callback execution.
       ;; Clean-up batch after enqueuing callback.
-      (car/expire batch-hash linger-sec "NX")
-      (car/expire success-set linger-sec "NX")
-      (car/expire dead-set linger-sec "NX"))))
+     (car/expire batch-hash linger-sec "NX")
+     (car/expire success-set linger-sec "NX")
+     (car/expire dead-set linger-sec "NX"))))
 
 (defn- mark-batch-completion
   [{:keys [redis-conn] :as opts} job batch-id completion-status]
@@ -123,13 +123,13 @@
   [redis-conn src dst job-id batch-keys status]
   (let [{:keys [enqueued-set retrying-set success-set dead-set]} batch-keys
         [_ atomic-results] (redis-cmds/atomic
-                             redis-conn
-                             (car/multi)
-                             (car/smove src dst job-id)
-                             (car/scard enqueued-set)
-                             (car/scard retrying-set)
-                             (car/scard success-set)
-                             (car/scard dead-set))
+                            redis-conn
+                            (car/multi)
+                            (car/smove src dst job-id)
+                            (car/scard enqueued-set)
+                            (car/scard retrying-set)
+                            (car/scard success-set)
+                            (car/scard dead-set))
         [_ enqueued retrying success dead] atomic-results]
     (reset! status (batch/status-from-job-states enqueued retrying success dead))))