Change the default db-channel-enabled config value from False to True (#1880)

src/PostgREST/CLI.hs

@@ -160,7 +160,7 @@ exampleConfigFile =
       |db-channel = "pgrst"
       |
       |## Enable or disable the notification channel
-      |db-channel-enabled = false
+      |db-channel-enabled = true
       |
       |## Enable in-database configuration
       |db-config = true

src/PostgREST/Config.hs

@@ -193,7 +193,7 @@ parser optPath env dbSettings =
     <$> parseAppSettings "app.settings"
     <*> reqString "db-anon-role"
     <*> (fromMaybe "pgrst" <$> optString "db-channel")
-    <*> (fromMaybe False <$> optBool "db-channel-enabled")
+    <*> (fromMaybe True <$> optBool "db-channel-enabled")
     <*> (maybe ["public"] splitOnCommas <$> optValue "db-extra-search-path")
     <*> optWithAlias (optInt "db-max-rows")
                      (optInt "max-rows")

test/SpecHelper.hs

@@ -76,7 +76,7 @@ _baseCfg = let secret = Just $ encodeUtf8 "reallyreallyreallyreallyverysafe" in
     configAppSettings           = [ ("app.settings.app_host", "localhost") , ("app.settings.external_api_secret", "0123456789abcdef") ]
   , configDbAnonRole            = "postgrest_test_anonymous"
   , configDbChannel             = mempty
-  , configDbChannelEnabled      = False
+  , configDbChannelEnabled      = True
   , configDbExtraSearchPath     = []
   , configDbMaxRows             = Nothing
   , configDbPoolSize            = 10

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

@@ -1,6 +1,6 @@
 db-anon-role = "required"
 db-channel = "pgrst"
-db-channel-enabled = false
+db-channel-enabled = true
 db-extra-search-path = "public"
 db-max-rows = 1000
 db-pool = 10

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

@@ -1,6 +1,6 @@
 db-anon-role = "required"
 db-channel = "pgrst"
-db-channel-enabled = false
+db-channel-enabled = true
 db-extra-search-path = "public"
 db-max-rows = ""
 db-pool = 10

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

@@ -1,6 +1,6 @@
 db-anon-role = "postgrest_test_anonymous"
 db-channel = "postgrest"
-db-channel-enabled = true
+db-channel-enabled = false
 db-extra-search-path = "public,extensions,other"
 db-max-rows = 100
 db-pool = 1

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

@@ -1,6 +1,6 @@
 db-anon-role = "postgrest_test_anonymous"
 db-channel = "postgrest"
-db-channel-enabled = true
+db-channel-enabled = false
 db-extra-search-path = "public,extensions,private"
 db-max-rows = 1000
 db-pool = 1

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

@@ -1,6 +1,6 @@
 db-anon-role = "root"
 db-channel = "postgrest"
-db-channel-enabled = true
+db-channel-enabled = false
 db-extra-search-path = "public,test"
 db-max-rows = 1000
 db-pool = 1

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

@@ -1,6 +1,6 @@
 db-anon-role = "required"
 db-channel = "pgrst"
-db-channel-enabled = false
+db-channel-enabled = true
 db-extra-search-path = "public"
 db-max-rows = ""
 db-pool = 10

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

@@ -2,7 +2,7 @@ PGRST_APP_SETTINGS_test2: test
 PGRST_APP_SETTINGS_test: test
 PGRST_DB_ANON_ROLE: root
 PGRST_DB_CHANNEL: postgrest
-PGRST_DB_CHANNEL_ENABLED: true
+PGRST_DB_CHANNEL_ENABLED: false
 PGRST_DB_EXTRA_SEARCH_PATH: public, test
 PGRST_DB_MAX_ROWS: 1000
 PGRST_DB_POOL: 1

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

@@ -1,6 +1,6 @@
 db-anon-role = "root"
 db-channel = "postgrest"
-db-channel-enabled = true
+db-channel-enabled = false
 db-extra-search-path = "public, test"
 db-max-rows = 1000
 db-pool = 1