feat: minimal health check (#2092)

test/SpecHelper.hs

@@ -106,6 +106,7 @@ _baseCfg = let secret = Just $ encodeUtf8 "reallyreallyreallyreallyverysafe" in
   , configServerUnixSocketMode  = 432
   , configDbTxAllowOverride     = True
   , configDbTxRollbackAll       = True
+  , configAdminServerPort       = Nothing
   }
 
 testCfg :: Text -> AppConfig

test/io-tests/configs/expected/aliases.config

@@ -25,3 +25,4 @@ server-host = "!4"
 server-port = 3000
 server-unix-socket = ""
 server-unix-socket-mode = "660"
+admin-server-port = ""

test/io-tests/configs/expected/boolean-numeric.config

@@ -25,3 +25,4 @@ server-host = "!4"
 server-port = 3000
 server-unix-socket = ""
 server-unix-socket-mode = "660"
+admin-server-port = ""

test/io-tests/configs/expected/boolean-string.config

@@ -25,3 +25,4 @@ server-host = "!4"
 server-port = 3000
 server-unix-socket = ""
 server-unix-socket-mode = "660"
+admin-server-port = ""

test/io-tests/configs/expected/defaults.config

@@ -25,3 +25,4 @@ server-host = "!4"
 server-port = 3000
 server-unix-socket = ""
 server-unix-socket-mode = "660"
+admin-server-port = ""

test/io-tests/configs/expected/no-defaults-with-db-other-authenticator.config

@@ -25,5 +25,6 @@ server-host = "0.0.0.0"
 server-port = 80
 server-unix-socket = "/tmp/pgrst_io_test.sock"
 server-unix-socket-mode = "777"
+admin-server-port = 3001
 app.settings.test = "test"
 app.settings.test2 = "test"

test/io-tests/configs/expected/no-defaults-with-db.config

@@ -25,5 +25,6 @@ server-host = "0.0.0.0"
 server-port = 80
 server-unix-socket = "/tmp/pgrst_io_test.sock"
 server-unix-socket-mode = "777"
+admin-server-port = 3001
 app.settings.test = "test"
 app.settings.test2 = "test"

test/io-tests/configs/expected/no-defaults.config

@@ -25,5 +25,6 @@ server-host = "0.0.0.0"
 server-port = 80
 server-unix-socket = "/tmp/pgrst_io_test.sock"
 server-unix-socket-mode = "777"
+admin-server-port = 3001
 app.settings.test = "test"
 app.settings.test2 = "test"

test/io-tests/configs/expected/types.config

@@ -25,4 +25,5 @@ server-host = "!4"
 server-port = 3000
 server-unix-socket = ""
 server-unix-socket-mode = "660"
+admin-server-port = ""
 app.settings.test = "Bool False"

test/io-tests/configs/no-defaults-env.yaml

@@ -28,3 +28,4 @@ PGRST_SERVER_HOST: 0.0.0.0
 PGRST_SERVER_PORT: 80
 PGRST_SERVER_UNIX_SOCKET: /tmp/pgrst_io_test.sock
 PGRST_SERVER_UNIX_SOCKET_MODE: 777
+PGRST_ADMIN_SERVER_PORT: 3001

test/io-tests/configs/no-defaults.config

@@ -25,5 +25,6 @@ server-host = "0.0.0.0"
 server-port = 80
 server-unix-socket = "/tmp/pgrst_io_test.sock"
 server-unix-socket-mode = "777"
+admin-server-port = 3001
 app.settings.test = "test"
 app.settings.test2 = "test"

test/io-tests/test_io.py

@@ -729,3 +729,44 @@ def test_db_prepared_statements_disable(defaultenv):
     with run(env=env) as postgrest:
         response = postgrest.session.post("/rpc/uses_prepared_statements")
         assert response.text == "false"
+
+
+def test_admin_healthy_w_channel(defaultenv):
+    "Should get a success response from the admin server health endpoint when the LISTEN channel is enabled"
+
+    env = {
+        **defaultenv,
+        "PGRST_ADMIN_SERVER_PORT": "3001",
+        "PGRST_DB_CHANNEL_ENABLED": "true",
+    }
+
+    with run(env=env) as postgrest:
+        response = requests.get(f"http://localhost:{env['PGRST_ADMIN_SERVER_PORT']}/health")
+        assert response.status_code == 200
+
+
+def test_admin_healthy_wo_channel(defaultenv):
+    "Should get a success response from the admin server health endpoint when the LISTEN channel is disabled"
+
+    env = {
+        **defaultenv,
+        "PGRST_ADMIN_SERVER_PORT": "3001",
+        "PGRST_DB_CHANNEL_ENABLED": "false",
+    }
+
+    with run(env=env) as postgrest:
+        response = requests.get(f"http://localhost:{env['PGRST_ADMIN_SERVER_PORT']}/health")
+        assert response.status_code == 200
+
+
+def test_admin_not_found(defaultenv):
+    "Should get a not found from the admin server"
+
+    env = {
+        **defaultenv,
+        "PGRST_ADMIN_SERVER_PORT": "3001",
+    }
+
+    with run(env=env) as postgrest:
+        response = requests.get(f"http://localhost:{env['PGRST_ADMIN_SERVER_PORT']}/notfound")
+        assert response.status_code == 404