Add clj-kondo config - first pass

Highlights:
- found 1 bug - `etaoin.ide.api` `:storeTitle` command was calling
`etaoin.api/get-title` with wrong number of args. Fixed.
- found an invalid symbol `num-.` from https://clojure.org/reference/reader:
"Symbols beginning or ending with '.' are reserved by Clojure"
Left as is, but will likely follow up with a name change.

Of note:
- Etaoin uses, and might encourage, the use of `:refer :all` for its
api. Ignoring for now. We can decide how we want to do at some later
date.

Other
- Missing require for `clojure.set` added
- An `if` without else converted to `when`. I like this convention, to me it
conveys that an `if` did not accidentally omit an else condition.
- Unused bindings/paramers prefixed with underscore, unless part of
public API and the unuse is an implementation detail. I find this
convention helpful when glancing at fn signatures, I can quickly tell
what is being used. Mostly left these in as I think they typically
conveyed an interface of sorts, but another option is to omit unused
bindings.
- Unused requires, imports and private vars turfed
- Taught clj-kondo about slingshot macros by bringing in existing clj-kondo
slingshot export config
- Taught clj-kondo about etaoin macros we are using (there are quite a
few!) via `:macroexpand` `:hook`. This is a good first pass, we'll likely
swing around again and create proper clj-kondo hooks in an clj-kondo export
config for fine grained reporting for our users.

Closes clj-commons#390

.clj-kondo/clj-kondo/slingshot/clj_kondo/slingshot/try_plus.clj

@@ -0,0 +1,44 @@
+(ns clj-kondo.slingshot.try-plus
+  (:require [clj-kondo.hooks-api :as api]))
+
+(defn expand-catch [catch-node]
+  (let [[catch catchee & exprs] (:children catch-node)
+        catchee-sexpr (api/sexpr catchee)]
+    (cond (vector? catchee-sexpr)
+          (let [[selector & exprs] exprs]
+            (api/list-node
+             [catch (api/token-node 'Exception) (api/token-node '_e#)
+              (api/list-node
+               (list* (api/token-node 'let)
+                      (api/vector-node [selector (api/token-node nil)])
+                      exprs))]))
+          :else catch-node)))
+
+(defn try+ [{:keys [node]}]
+  (let [children (rest (:children node))
+        [body catches]
+        (loop [body children
+               body-exprs []
+               catches []]
+          (if (seq body)
+            (let [f (first body)
+                  f-sexpr (api/sexpr f)]
+              (if (and (seq? f-sexpr) (= 'catch (first f-sexpr)))
+                (recur (rest body)
+                       body-exprs
+                       (conj catches (expand-catch f)))
+                (recur (rest body)
+                       (conj body-exprs f)
+                       catches)))
+            [body-exprs catches]))
+        new-node (api/list-node
+                  [(api/token-node 'let)
+                   (api/vector-node
+                    [(api/token-node '&throw-context) (api/token-node nil)])
+                   (api/token-node '&throw-context) ;; use throw-context to avoid warning
+                   (with-meta (api/list-node (list* (api/token-node 'try)
+                                                    (concat body catches)))
+                     (meta node))])]
+    ;; (prn (api/sexpr new-node))
+    {:node new-node}))
+

.clj-kondo/clj-kondo/slingshot/config.edn

@@ -0,0 +1,2 @@
+{:hooks
+ {:analyze-call {slingshot.slingshot/try+ clj-kondo.slingshot.try-plus/try+}}}

.clj-kondo/config.edn

@@ -0,0 +1,19 @@
+{:config-paths ^:replace [] ;; don't adopt any user preferences
+
+ :hooks
+ ;; for now we'll use the simple macroexpand, can move to hooks for finer grained errors later
+ {:macroexpand
+  {etaoin.util/defmethods etaoin.util/defmethods
+   etaoin.util/with-tmp-dir etaoin.util/with-tmp-dir
+   etaoin.util/with-tmp-file etaoin.util/with-tmp-file
+
+   etaoin.api/with-key-down etaoin.api/with-key-down
+   etaoin.api/with-pointer-btn-down etaoin.api/with-pointer-btn-down
+   etaoin.api/with-pointer-left-btn-down etaoin.api/with-pointer-left-btn-down
+   etaoin.api/with-driver etaoin.api/with-driver
+   etaoin.api/with-chrome etaoin.api/with-chrome
+   etaoin.api/with-firefox etaoin.api/with-firefox}}
+
+ :linters
+ ;; etaoin is dsl-ish and does make use of :refer :all, can decide if we like that at some later date
+ {:refer-all {:level :off}}}

.clj-kondo/etaoin/api.clj

@@ -0,0 +1,41 @@
+(ns etaoin.api)
+
+(defmacro with-key-down
+  [input key & body]
+  `(-> ~input
+       (add-key-down ~key)
+       ~@body
+       (add-key-up ~key)))
+
+(defmacro with-pointer-btn-down
+  [input button & body]
+  `(-> ~input
+       (add-pointer-down ~button)
+       ~@body
+       (add-pointer-up ~button)))
+
+(defmacro with-pointer-left-btn-down
+  [input & body]
+  `(-> ~input
+       add-pointer-down
+       ~@body
+       add-pointer-up))
+
+;; simplified to remove with-pool which is of no consequence to linting
+(defmacro with-driver
+  [type opt bind & body]
+  `(let [~bind (boot-driver ~type ~opt)]
+     (try
+       ~@body
+       (finally
+         (quit ~bind)))))
+
+(defmacro with-firefox
+  [opt bind & body]
+  `(with-driver :firefox ~opt ~bind
+     ~@body))
+
+(defmacro with-chrome
+  [opt bind & body]
+  `(with-driver :chrome ~opt ~bind
+     ~@body))

.clj-kondo/etaoin/util.clj

@@ -0,0 +1,18 @@
+(ns etaoin.util)
+
+(defmacro defmethods
+  "Declares multimethods in batch. For each dispatch value from
+  dispatch-vals, creates a new method."
+  [multifn dispatch-vals & fn-tail]
+  `(doseq [dispatch-val# ~dispatch-vals]
+     (defmethod ~multifn dispatch-val# ~@fn-tail)))
+
+;; essence only for linting
+(defmacro with-tmp-file [prefix suffix bind & body]
+  `(let [~bind "somepath"]
+     ~@body))
+
+;; essence only for linting
+(defmacro with-tmp-dir [prefix bind & body]
+  `(let [~bind "somepath"]
+     ~@body))

CHANGELOG.adoc

@@ -6,6 +6,7 @@ A release with an intentional breaking changes is marked with [breaking]
 
 * https://github.com/clj-commons/etaoin/issues/383[#383]: Drop testing for Safari on Windows, Apple no longer releases Safari for Windows
 * https://github.com/clj-commons/etaoin/issues/388[#388]: Drop testing for PhantomJS, development has long ago stopped for PhantomJS
+* https://github.com/clj-commons/etaoin/issues/387[#387]: No longer testing multiple key modifiers for a single webdriver send keys request
 * https://github.com/clj-commons/etaoin/issues/384[#384]: Look for `safaridriver` on PATH by default
 * https://github.com/clj-commons/etaoin/issues/402[#402]: Only send body for webdriver `POST` requests to appease `safaridriver`
 * https://github.com/clj-commons/etaoin/issues/403[#403]: The `select` fn now clicks on the `select` element before clicking the `option` element to appease `safaridriver`
@@ -16,7 +17,7 @@ A release with an intentional breaking changes is marked with [breaking]
 * Internal quality
 ** https://github.com/clj-commons/etaoin/issues/382[#382]: Fix process fork testing on Windows
 ** https://github.com/clj-commons/etaoin/issues/391[#391]: Identify browser name on failed ide tests
-** https://github.com/clj-commons/etaoin/issues/387[#387]: No longer testing multiple key modifiers for a single webdriver send keys request
+** https://github.com/clj-commons/etaoin/issues/390[#390]: Add internal clj-kondo config
 
 == v0.4.6
 

env/dev/demo.clj

@@ -1,4 +1,4 @@
-
+#_{:clj-kondo/ignore [:use]}
 (use 'etaoin.api)
 (require '[etaoin.keys :as k])
 

src/etaoin/api.clj

@@ -34,8 +34,7 @@
             [slingshot.slingshot :refer [try+ throw+]])
 
   (:import java.util.Date
-           java.text.SimpleDateFormat
-           (java.io IOException)))
+           java.text.SimpleDateFormat))
 
 ;;
 ;; defaults
@@ -107,7 +106,7 @@
                      :method :get
                      :path [:session (:session driver) :element :active])))
   "
-  [{:keys [driver method path data result]}]
+  [{:keys [driver method path data]}]
   (client/call driver method path data))
 
 ;;
@@ -839,7 +838,7 @@
 
 (defmethod perform-actions
   :phantom
-  [driver input & inputs]
+  [_driver _input & _inputs]
   (util/error "Phantom doesn't support w3c actions."))
 
 (defmulti release-actions dispatch-driver)
@@ -854,7 +853,7 @@
 
 (defmethod release-actions
   :phantom
-  [driver input & inputs]
+  [_driver _input & _inputs]
   (util/error "Phantom doesn't support w3c actions."))
 
 ;;
@@ -1765,14 +1764,14 @@
 (defn scroll-top
   "Scrolls to top of the page keeping current horizontal position."
   [driver]
-  (let [{:keys [x y]} (get-scroll driver)]
+  (let [{:keys [x _y]} (get-scroll driver)]
     (scroll driver x 0)))
 
 (defn scroll-bottom
   "Scrolls to bottom of the page keeping current horizontal position."
   [driver]
   (let [y-max         (js-execute driver "return document.body.scrollHeight;")
-        {:keys [x y]} (get-scroll driver)]
+        {:keys [x _y]} (get-scroll driver)]
     (scroll driver x y-max)))
 
 (def ^{:doc "Default scroll offset in pixels."}
@@ -2266,7 +2265,7 @@
 
 (defn wait
   "Sleeps for N seconds."
-  ([driver sec]
+  (#_{:clj-kondo/ignore [:unused-binding]} [driver sec]
    (wait sec))
   ([sec]
    (Thread/sleep (* sec 1000))))
@@ -2822,7 +2821,7 @@
 
   Under the hood, it sends the file's name as a sequence of keys
   to the input."
-  (fn [driver q file]
+  (fn [_driver _q file]
     (type file)))
 
 (defmethod upload-file String
@@ -2999,7 +2998,7 @@
 
 (defmethod screenshot-element
   :default
-  [driver q file]
+  [_driver _q _file]
   (util/error "This driver doesn't support screening elements."))
 
 (defmethods screenshot-element
@@ -3355,7 +3354,7 @@
 
   (try (delete-session driver)
        (catch Exception e
-         (if (not (= 404 (:status (ex-data e))))
+         (when (not (= 404 (:status (ex-data e))))
            ;; the exception was caused by something other than "session not found"
            (throw e))))
 

src/etaoin/client.clj

@@ -45,9 +45,6 @@
 (defn- get-url-path [items]
   (str/join "/" (map url-item-str items)))
 
-(defn- status-selector [resp]
-  (-> resp :status integer?))
-
 (defmacro with-pool [opt & body]
   `(client/with-connection-pool ~opt
      ~@body))

src/etaoin/dev.clj

@@ -11,7 +11,7 @@
 (defn try-parse-int
   [line]
   (try (Integer/parseInt line)
-       (catch Exception e
+       (catch Exception _e
          line)))
 
 
@@ -101,9 +101,9 @@
                          :headers headers}))
 
       :network/responsereceived
-      (let [{:keys [response]}                                params
-            {:keys [method headers mimeType remoteIPAddress]} response
-            {:keys [status]}                                  headers]
+      (let [{:keys [response]}                         params
+            {:keys [headers mimeType remoteIPAddress]} response
+            {:keys [status]}                           headers]
         (assoc acc
                :state 2
                :response {:status    (try-parse-int status)

src/etaoin/driver.clj

@@ -110,27 +110,27 @@
 
 (defmethod options-name
   :firefox
-  [driver]
+  [_driver]
   :moz:firefoxOptions)
 
 (defmethod options-name
   :chrome
-  [driver]
+  [_driver]
   :chromeOptions)
 
 (defmethod options-name
   :safari
-  [driver]
+  [_driver]
   :safariOptions)
 
 (defmethod options-name
   :edge
-  [driver]
+  [_driver]
   :edgeOptions)
 
 (defmethod options-name
   :opera
-  [driver]
+  [_driver]
   :operaOptions)
 
 (defn set-options-args
@@ -148,7 +148,7 @@
 
 (defmethod set-profile
   :default
-  [driver profile]
+  [driver _profile]
   (log/infof "This driver doesn't support setting a profile.")
   driver)
 
@@ -191,7 +191,7 @@
 
 (defmethod set-window-size
   :default
-  [driver w h]
+  [driver _w _h]
   (log/infof "This driver doesn't support setting window size.")
   driver)
 
@@ -216,7 +216,7 @@
 
 (defmethod set-url
   :default
-  [driver url]
+  [driver _url]
   (log/infof "This driver doesn't support setting initial URL.")
   driver)
 
@@ -262,7 +262,7 @@
 
 (defmethod is-headless?
   :phantom
-  [driver]
+  [_driver]
   true)
 
 ;;
@@ -299,7 +299,7 @@
 
 (defmethod set-prefs
   :default
-  [driver prefs]
+  [driver _prefs]
   (log/infof "This driver doesn't support setting preferences.")
   driver)
 
@@ -314,8 +314,8 @@
 ;; Download folder
 ;;
 
-(defn- ^String add-trailing-slash
-  [^String path]
+(defn- add-trailing-slash
+  ^String [^String path]
   (let [sep java.io.File/separator]
     (if (string/ends-with? path sep)
       path
@@ -327,7 +327,7 @@
 
 (defmethod set-download-dir
   :default
-  [driver path]
+  [driver _path]
   (log/infof "This driver doesn't support setting a download directory.")
   driver)
 
@@ -497,20 +497,18 @@
   {:arglists '([driver user-agent])}
   dispatch-driver)
 
-
 (defmethods set-user-agent
   [:chrome :edge]
   [driver user-agent]
   (set-options-args driver [(str "--user-agent=" user-agent)]))
 
-
 (defmethods set-user-agent
   [:firefox]
   [driver user-agent]
   (set-prefs driver {:general.useragent.override user-agent}))
 
 (defmethods set-user-agent
   [:default]
-  [driver user-agent]
+  [driver _user-agent]
   (log/infof "This driver doesn't support setting a user-agent.")
   driver)