Add websocket-keepalive middleware

Author: weavejester

README.md

@@ -152,7 +152,7 @@ The following configuration keys are supported:
 
   - `:store` - The Ring session store to use for storing sessions.
 
-- `:static`
+- `:static` -
   A map of options to configure how to find static content.
 
   - `:files` -
@@ -168,6 +168,15 @@ The following configuration keys are supported:
     and the rest of the map is passed as options. May also be a
     collection of the above.
 
+- `:websocket`
+   A map of options to configure websocket behavior.
+
+   - `:keepalive` -
+     If true, periodically pings the client to keep the connection
+     alive via the [websocket keepalive][16] middleware. A map of
+     options may also be passed to set the `:period` of the keepalive in
+     milliseconds.
+
 
 [1]: https://ring-clojure.github.io/ring/ring.middleware.multipart-params.html
 [2]: https://ring-clojure.github.io/ring/ring.middleware.nested-params.html
@@ -184,6 +193,7 @@ The following configuration keys are supported:
 [13]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
 [14]: https://ring-clojure.github.io/ring/ring.middleware.file.html
 [15]: https://ring-clojure.github.io/ring/ring.middleware.resource.html
+[16]: https://ring-clojure.github.io/ring-websocket-middleware/ring.websocket.keepalive.html
 
 ## License
 

project.clj

@@ -7,7 +7,8 @@
                  [ring/ring-core "1.13.0"]
                  [ring/ring-ssl "0.4.0"]
                  [ring/ring-headers "0.4.0"]
-                 [ring/ring-anti-forgery "1.4.0"]]
+                 [ring/ring-anti-forgery "1.4.0"]
+                 [org.ring-clojure/ring-websocket-middleware "0.2.1"]]
   :aliases
   {"test-all" ["with-profile" "default:+1.10:+1.11:+1.12" "test"]}
   :profiles

src/ring/middleware/defaults.clj

@@ -17,7 +17,8 @@
             [ring.middleware.default-charset :refer [wrap-default-charset]]
             [ring.middleware.absolute-redirects :refer [wrap-absolute-redirects]]
             [ring.middleware.ssl :refer [wrap-ssl-redirect wrap-hsts wrap-forwarded-scheme]]
-            [ring.middleware.proxy-headers :refer [wrap-forwarded-remote-addr]]))
+            [ring.middleware.proxy-headers :refer [wrap-forwarded-remote-addr]]
+            [ring.websocket.keepalive :refer [wrap-websocket-keepalive]]))
 
 (def default-session-store (cookie-store))
 
@@ -54,7 +55,8 @@
    :responses {:not-modified-responses true
                :absolute-redirects     false
                :content-types          true
-               :default-charset        "utf-8"}})
+               :default-charset        "utf-8"}
+   :websocket {:keepalive true}})
 
 (def secure-site-defaults
   "A default configuration for a browser-accessible website that's accessed
@@ -103,6 +105,7 @@
        secure-site-defaults"
   [handler config]
   (-> handler
+      (wrap wrap-websocket-keepalive (get-in config [:websocket :keepalive] false))
       (wrap wrap-anti-forgery     (get-in config [:security :anti-forgery] false))
       (wrap wrap-flash            (get-in config [:session :flash] false))
       (wrap wrap-session          (:session config false))

test/ring/middleware/defaults_test.clj

@@ -2,7 +2,9 @@
   (:require [clojure.test :refer :all]
             [ring.middleware.defaults :refer :all]
             [ring.util.response :refer [response content-type not-found]]
-            [ring.mock.request :refer [request header]]))
+            [ring.mock.request :refer [request header]]
+            [ring.websocket :as ws]
+            [ring.websocket.protocols :as wsp]))
 
 (deftest test-wrap-defaults
   (testing "api defaults"
@@ -248,4 +250,22 @@
                       (wrap-defaults site-defaults))]
       (is (= 403 (:status (handler (request :post "/")))))
       (is (= 200 (:status (handler (-> (request :post "/")
-                                       (header "X-Ring-Anti-Forgery" "1")))))))))
+                                       (header "X-Ring-Anti-Forgery" "1"))))))))
+
+  (testing "websocket pings"
+    (let [ping-count (atom 0)
+          socket     (reify wsp/Socket
+                       (-open? [_] true)
+                       (-send [_ _])
+                       (-ping [_ _] (swap! ping-count inc))
+                       (-pong [_ _])
+                       (-close [_ _ _]))
+          response   {::ws/listener {}}
+          handler    (wrap-defaults (constantly response)
+                                    {:websocket {:keepalive {:period 10}}})
+          listener   (::ws/listener (handler {}))]
+      (wsp/on-open listener socket)
+      (Thread/sleep 41)
+      (wsp/on-close listener socket 1000 "")
+      (Thread/sleep 20)
+      (is (= 4 @ping-count)))))