Move webserver-related namespaces -> metabase.server.* (#14279)

.dir-locals.el

@@ -28,7 +28,7 @@
                               (p/def-map-type '(2 nil nil (:defn)))
                               (p.types/defrecord+ '(2 nil nil (:defn)))
                               (tools.macro/macrolet '(1 (:defn))))))
-                  ;; if you're using clj-refactor (highly recommended!), prefer prefix notation when cleaning the ns form
+                  ;; if you're using clj-refactor (highly recommended!)
                   (cljr-favor-prefix-notation . nil)
                   ;; prefer keeping source width about ~118, GitHub seems to cut off stuff at either 119 or 120 and
                   ;; it's nicer to look at code in GH when you don't have to scroll back and forth

dev/src/dev.clj

@@ -4,13 +4,14 @@
             [honeysql.core :as hsql]
             [metabase.api.common :as api-common]
             [metabase.core :as mbc]
+            [metabase.core.initialization-status :as init-status]
             [metabase.db :as mdb]
             [metabase.driver :as driver]
             [metabase.driver.sql-jdbc.execute :as sql-jdbc.execute]
-            [metabase.handler :as handler]
-            [metabase.plugins :as pluguns]
+            [metabase.plugins :as plugins]
             [metabase.query-processor.timezone :as qp.timezone]
             [metabase.server :as server]
+            [metabase.server.handler :as handler]
             [metabase.test :as mt]
             [metabase.test.data.impl :as data.impl]
             [metabase.util :as u]))
@@ -27,10 +28,10 @@
   []
   (when-not @initialized?
     (init!))
-  (metabase.server/start-web-server! #'metabase.handler/app)
-  (metabase.db/setup-db!)
-  (metabase.plugins/load-plugins!)
-  (metabase.core.initialization-status/set-complete!))
+  (server/start-web-server! #'handler/app)
+  (mdb/setup-db!)
+  (plugins/load-plugins!)
+  (init-status/set-complete!))
 
 (defn stop!
   []

enterprise/backend/src/metabase_enterprise/sandbox/api/routes.clj

@@ -4,7 +4,7 @@
             [metabase-enterprise.sandbox.api.gtap :as gtap]
             [metabase-enterprise.sandbox.api.table :as table]
             [metabase-enterprise.sandbox.api.user :as user]
-            [metabase.middleware.auth :as middleware.auth]))
+            [metabase.server.middleware.auth :as middleware.auth]))
 
 ;; this is copied from `metabase.api.routes` because if we require that above we will destroy startup times for `lein
 ;; ring server`
@@ -16,6 +16,7 @@
   (compojure/context
    "/mt"
    []
+
    (compojure/routes
     (compojure/context "/gtap" [] (+auth gtap/routes))
     (compojure/context "/user" [] (+auth user/routes))))

enterprise/backend/src/metabase_enterprise/sandbox/models/group_table_access_policy.clj

@@ -6,12 +6,12 @@
             [clojure.walk :as walk]
             [medley.core :as m]
             [metabase.mbql.normalize :as normalize]
-            [metabase.middleware.session :as session]
             [metabase.models.card :as card :refer [Card]]
             [metabase.models.interface :as i]
             [metabase.models.table :as table]
             [metabase.plugins.classloader :as classloader]
             [metabase.query-processor.error-type :as qp.error-type]
+            [metabase.server.middleware.session :as session]
             [metabase.util :as u]
             [metabase.util.i18n :refer [tru]]
             [metabase.util.schema :as su]

enterprise/backend/src/metabase_enterprise/sso/api/routes.clj

@@ -2,7 +2,7 @@
   (:require [compojure.core :as compojure]
             [metabase-enterprise.sso.api.sso :as sso]))
 
-;; This needs to be installed in the `metabase.routes/routes` -- not `metabase.api.routes/routes` !!!
+;; This needs to be installed in the `metabase.server.routes/routes` -- not `metabase.api.routes/routes` !!!
 (compojure/defroutes ^{:doc "Ring routes for auth (SAML) API endpoints."} routes
   (compojure/context
    "/auth"

enterprise/backend/src/metabase_enterprise/sso/integrations/jwt.clj

@@ -7,7 +7,7 @@
             [metabase.api.common :as api]
             [metabase.api.session :as session]
             [metabase.integrations.common :as integrations.common]
-            [metabase.middleware.session :as mw.session]
+            [metabase.server.middleware.session :as mw.session]
             [metabase.util.i18n :refer [tru]]
             [ring.util.response :as resp])
   (:import java.net.URLEncoder))

enterprise/backend/src/metabase_enterprise/sso/integrations/saml.clj

@@ -10,8 +10,8 @@
             [metabase.api.common :as api]
             [metabase.api.session :as session]
             [metabase.integrations.common :as integrations.common]
-            [metabase.middleware.session :as mw.session]
             [metabase.public-settings :as public-settings]
+            [metabase.server.middleware.session :as mw.session]
             [metabase.util :as u]
             [metabase.util.i18n :refer [trs tru]]
             [ring.util.codec :as codec]

enterprise/backend/test/metabase_enterprise/sandbox/api/gtap_test.clj

@@ -2,11 +2,11 @@
   (:require [expectations :refer :all]
             [metabase-enterprise.sandbox.models.group-table-access-policy :refer [GroupTableAccessPolicy]]
             [metabase.http-client :as http]
-            [metabase.middleware.util :as middleware.u]
             [metabase.models.card :refer [Card]]
             [metabase.models.permissions-group :refer [PermissionsGroup]]
             [metabase.models.table :refer [Table]]
             [metabase.public-settings.metastore :as metastore]
+            [metabase.server.middleware.util :as middleware.u]
             [metabase.test.data.users :refer :all]
             [metabase.test.util :as tu]
             [toucan.util.test :as tt]))

enterprise/backend/test/metabase_enterprise/sso/integrations/saml_test.clj

@@ -5,12 +5,12 @@
             [metabase-enterprise.sso.integrations.sso-settings :as sso-settings]
             [metabase.config :as config]
             [metabase.http-client :as http]
-            [metabase.middleware.session :as mw.session]
             [metabase.models.permissions-group :as group :refer [PermissionsGroup]]
             [metabase.models.permissions-group-membership :refer [PermissionsGroupMembership]]
             [metabase.models.user :refer [User]]
             [metabase.public-settings :as public-settings]
             [metabase.public-settings.metastore-test :as metastore-test]
+            [metabase.server.middleware.session :as mw.session]
             [metabase.test :as mt]
             [metabase.test.fixtures :as fixtures]
             [metabase.test.util :as tu]

project.clj

@@ -19,8 +19,8 @@
    "run-ee"                            ["with-profile" "+run,+ee" "run"]
    "run-with-repl"                     ["with-profile" "+run-with-repl" "repl"]
    "run-with-repl-ee"                  ["with-profile" "+run-with-repl,+ee" "repl"]
-   "ring"                              ["with-profile" "+ring" "ring"]
-   "ring-ee"                           ["with-profile" "+ring,+ee" "ring"]
+   ;; "ring"                              ["with-profile" "+ring" "ring"]
+   ;; "ring-ee"                           ["with-profile" "+ring,+ee" "ring"]
    "test"                              ["with-profile" "+test" "test"]
    "test-ee"                           ["with-profile" "+test,+ee" "test"]
    "bikeshed"                          ["with-profile" "+bikeshed" "bikeshed"
@@ -274,24 +274,25 @@
                    (metabase.core/-main))
       :timeout 60000}}]
 
+   ;; DISABLED FOR NOW SINCE IT'S BROKEN -- SEE #12181
    ;; start the dev HTTP server with 'lein ring server'
-   :ring
-   [:exclude-tests
-    :include-all-drivers
-    {:dependencies
-     ;; used internally by lein ring to track namespace changes. Newer version contains fix by yours truly with 1000x
-     ;; faster launch time
-     [[ns-tracker "0.4.0"]]
-
-     :plugins
-     [[lein-ring "0.12.5" :exclusions [org.clojure/clojure]]]
-
-     :ring
-     {:handler      metabase.handler/app
-      :init         metabase.core/init!
-      :async?       true
-      :destroy      metabase.core/destroy
-      :reload-paths ["src"]}}]
+   ;; :ring
+   ;; [:exclude-tests
+   ;;  :include-all-drivers
+   ;;  {:dependencies
+   ;;   ;; used internally by lein ring to track namespace changes. Newer version contains fix by yours truly with 1000x
+   ;;   ;; faster launch time
+   ;;   [[ns-tracker "0.4.0"]]
+
+   ;;   :plugins
+   ;;   [[lein-ring "0.12.5" :exclusions [org.clojure/clojure]]]
+
+   ;;   :ring
+   ;;   {:handler      metabase.server.handler/app
+   ;;    :init         metabase.core/init!
+   ;;    :async?       true
+   ;;    :destroy      metabase.core/destroy
+   ;;    :reload-paths ["src"]}}]
 
    :with-include-drivers-middleware
    {:plugins

resources/frontend_client/index_template.html

@@ -36,7 +36,7 @@
       {{{localizationJSON}}}
     </script>
 
-    <!-- If you modify this script, make sure you update the whitelisted Content-Security-Policy hash in metabase.middleware.security -->
+    <!-- If you modify this script, make sure you update the whitelisted Content-Security-Policy hash in metabase.server.middleware.security -->
     <script type="text/javascript">{{{bootstrapJS}}}</script>
   </head>
 
@@ -49,7 +49,7 @@
     {{/enableGoogleAuth}}
 
     <!-- Google Analytics -->
-    <!-- If you modify this script, make sure you update the whitelisted Content-Security-Policy hash in metabase.middleware.security -->
+    <!-- If you modify this script, make sure you update the whitelisted Content-Security-Policy hash in metabase.server.middleware.security -->
     {{#enableAnonTracking}}
       <script type="text/javascript">{{{googleAnalyticsJS}}}</script>
     {{/enableAnonTracking}}

src/metabase/api/routes.clj

@@ -39,9 +39,9 @@
             [metabase.api.user :as user]
             [metabase.api.util :as util]
             [metabase.config :as config]
-            [metabase.middleware.auth :as middleware.auth]
-            [metabase.middleware.exceptions :as middleware.exceptions]
             [metabase.plugins.classloader :as classloader]
+            [metabase.server.middleware.auth :as middleware.auth]
+            [metabase.server.middleware.exceptions :as middleware.exceptions]
             [metabase.util :as u]
             [metabase.util.i18n :refer [deferred-tru]]))
 

src/metabase/api/session.clj

@@ -10,11 +10,11 @@
             [metabase.email.messages :as email]
             [metabase.events :as events]
             [metabase.integrations.ldap :as ldap]
-            [metabase.middleware.session :as mw.session]
             [metabase.models.session :refer [Session]]
             [metabase.models.setting :as setting :refer [defsetting]]
             [metabase.models.user :as user :refer [User]]
             [metabase.public-settings :as public-settings]
+            [metabase.server.middleware.session :as mw.session]
             [metabase.util :as u]
             [metabase.util.i18n :as ui18n :refer [deferred-tru trs tru]]
             [metabase.util.password :as pass]

src/metabase/api/setup.clj

@@ -6,7 +6,6 @@
             [metabase.email :as email]
             [metabase.events :as events]
             [metabase.integrations.slack :as slack]
-            [metabase.middleware.session :as mw.session]
             [metabase.models.card :refer [Card]]
             [metabase.models.collection :refer [Collection]]
             [metabase.models.dashboard :refer [Dashboard]]
@@ -19,6 +18,7 @@
             [metabase.models.table :refer [Table]]
             [metabase.models.user :as user :refer [User]]
             [metabase.public-settings :as public-settings]
+            [metabase.server.middleware.session :as mw.session]
             [metabase.setup :as setup]
             [metabase.util :as u]
             [metabase.util.i18n :as i18n :refer [tru]]

src/metabase/async/api_response.clj

@@ -12,7 +12,7 @@
             [clojure.java.io :as io]
             [clojure.tools.logging :as log]
             [compojure.response :refer [Sendable]]
-            [metabase.middleware.exceptions :as mw.exceptions]
+            [metabase.server.middleware.exceptions :as mw.exceptions]
             [metabase.util :as u]
             [metabase.util.i18n :as ui18n :refer [trs]]
             [ring.core.protocols :as ring.protocols]

src/metabase/core.clj

@@ -7,13 +7,13 @@
             [metabase.core.initialization-status :as init-status]
             [metabase.db :as mdb]
             [metabase.events :as events]
-            [metabase.handler :as handler]
             [metabase.metabot :as metabot]
             [metabase.models.user :refer [User]]
             [metabase.plugins :as plugins]
             [metabase.plugins.classloader :as classloader]
             [metabase.sample-data :as sample-data]
             [metabase.server :as server]
+            [metabase.server.handler :as handler]
             [metabase.setup :as setup]
             [metabase.task :as task]
             [metabase.troubleshooting :as troubleshooting]

src/metabase/handler.clj

-(ns metabase.handler
-  "Top-level Metabase Ring handler."
-  (:require [metabase.config :as config]
-            [metabase.middleware.auth :as mw.auth]
-            [metabase.middleware.exceptions :as mw.exceptions]
-            [metabase.middleware.json :as mw.json]
-            [metabase.middleware.log :as mw.log]
-            [metabase.middleware.misc :as mw.misc]
-            [metabase.middleware.security :as mw.security]
-            [metabase.middleware.session :as mw.session]
-            [metabase.middleware.ssl :as mw.ssl]
-            [metabase.plugins.classloader :as classloader]
-            [metabase.routes :as routes]
-            [ring.middleware.cookies :refer [wrap-cookies]]
-            [ring.middleware.gzip :refer [wrap-gzip]]
-            [ring.middleware.keyword-params :refer [wrap-keyword-params]]
-            [ring.middleware.params :refer [wrap-params]]))
-
-;; required here because this namespace is not actually used anywhere but we need it to be loaded because it adds
-;; impls for handling `core.async` channels as web server responses
-(classloader/require 'metabase.async.api-response)
-
-
-(def app
-  "The primary entry point to the Ring HTTP server."
-  (->
-   ;; in production, dereference routes now because they will not change at runtime, so we don't need to waste time
-   ;; dereferencing the var on every request. For dev & test, use the var instead so it can be tweaked without having
-   ;; to restart the web server
-   (if config/is-prod?
-     routes/routes
-     #'routes/routes)
-   ;; ▼▼▼ POST-PROCESSING ▼▼▼ happens from TOP-TO-BOTTOM
-   mw.exceptions/catch-uncaught-exceptions ; catch any Exceptions that weren't passed to `raise`
-   mw.exceptions/catch-api-exceptions      ; catch exceptions and return them in our expected format
-   mw.log/log-api-call
-   mw.security/add-security-headers        ; Add HTTP headers to API responses to prevent them from being cached
-   mw.json/wrap-json-body                  ; extracts json POST body and makes it avaliable on request
-   mw.json/wrap-streamed-json-response     ; middleware to automatically serialize suitable objects as JSON in responses
-   wrap-keyword-params                     ; converts string keys in :params to keyword keys
-   wrap-params                             ; parses GET and POST params as :query-params/:form-params and both as :params
-   mw.misc/maybe-set-site-url              ; set the value of `site-url` if it hasn't been set yet
-   mw.session/bind-current-user            ; Binds *current-user* and *current-user-id* if :metabase-user-id is non-nil
-   mw.session/wrap-current-user-info       ; looks for :metabase-session-id and sets :metabase-user-id and other info if Session ID is valid
-   mw.session/wrap-session-id              ; looks for a Metabase Session ID and assoc as :metabase-session-id
-   mw.auth/wrap-api-key                    ; looks for a Metabase API Key on the request and assocs as :metabase-api-key
-   wrap-cookies                            ; Parses cookies in the request map and assocs as :cookies
-   mw.misc/add-content-type                ; Adds a Content-Type header for any response that doesn't already have one
-   mw.misc/disable-streaming-buffering     ; Add header to streaming (async) responses so ngnix doesn't buffer keepalive bytes
-   wrap-gzip                               ; GZIP response if client can handle it
-   mw.misc/bind-request                    ; bind `metabase.middleware.misc/*request*` for the duration of the request
-   mw.ssl/redirect-to-https-middleware))   ; Redirect to HTTPS if configured to do so
-;; ▲▲▲ PRE-PROCESSING ▲▲▲ happens from BOTTOM-TO-TOP

src/metabase/models/card.clj

@@ -6,7 +6,6 @@
             [metabase.api.common :as api :refer [*current-user-id*]]
             [metabase.mbql.normalize :as normalize]
             [metabase.mbql.util :as mbql.u]
-            [metabase.middleware.session :as session]
             [metabase.models.collection :as collection]
             [metabase.models.dependency :as dependency]
             [metabase.models.field-values :as field-values]
@@ -19,6 +18,7 @@
             [metabase.plugins.classloader :as classloader]
             [metabase.public-settings :as public-settings]
             [metabase.query-processor.util :as qputil]
+            [metabase.server.middleware.session :as session]
             [metabase.util :as u]
             [metabase.util.i18n :as ui18n :refer [tru]]
             [toucan.db :as db]

src/metabase/models/session.clj

 (ns metabase.models.session
   (:require [buddy.core.codecs :as codecs]
             [buddy.core.nonce :as nonce]
-            [metabase.middleware.misc :as mw.misc]
-            [metabase.middleware.util :as mw.util]
+            [metabase.server.middleware.misc :as mw.misc]
+            [metabase.server.middleware.util :as mw.util]
             [metabase.util :as u]
             [schema.core :as s]
             [toucan.models :as models]))

src/metabase/pulse.clj

@@ -4,7 +4,6 @@
             [metabase.email :as email]
             [metabase.email.messages :as messages]
             [metabase.integrations.slack :as slack]
-            [metabase.middleware.session :as session]
             [metabase.models.card :refer [Card]]
             [metabase.models.dashboard :refer [Dashboard]]
             [metabase.models.dashboard-card :refer [DashboardCard]]
@@ -13,6 +12,7 @@
             [metabase.pulse.render :as render]
             [metabase.query-processor :as qp]
             [metabase.query-processor.timezone :as qp.timezone]
+            [metabase.server.middleware.session :as session]
             [metabase.util :as u]
             [metabase.util.i18n :refer [deferred-tru trs tru]]
             [metabase.util.ui-logic :as ui]