Revert "add: config db-timezone-enabled for optional querying of timezones"

This reverts commit d6c338d588.

CHANGELOG.md

@@ -11,7 +11,6 @@ All notable changes to this project will be documented in this file. From versio
   + Removed unnecessary double count when building the `Content-Range`.
 - Add config `client-error-verbosity` to customize error verbosity by @taimoorzaeem in #4088, #3980, #3824
 - Add `Vary` header to responses by @develop7 in #4609
-- Add config `db-timezone-enabled` for optional querying of timezones by @taimoorzaeem in #4751
 - Log schema cache queries timings on `log-level=debug` by @steve-chavez in #4805
 - Add GHC runtime metrics to the metrics endpoint by @mkleczek in #4862
 - Support running the admin server on a unix socket by @wolfgangwalther in #5003

docs/references/api/preferences.rst

@@ -117,10 +117,6 @@ However, with ``handling=strict``, an invalid time zone preference will throw an
 
   HTTP/1.1 400 Bad Request
 
-.. note::
-
-  This feature requires querying `pg_timezone_names <https://www.postgresql.org/docs/current/view-pg-timezone-names.html>`_ during :ref:`schema_cache` load. If this is not desired, you can disable the feature with :ref:`db-timezone-enabled`.
-
 .. _prefer_return:
 
 Return Representation

docs/references/configuration.rst

@@ -580,21 +580,6 @@ db-schemas
 
   The list of database schemas to expose to clients. See :ref:`schemas`.
 
-.. _db-timezone-enabled:
-
-db-timezone-enabled
--------------------
-
-  =============== =================================
-  **Type**        Boolean
-  **Default**     True
-  **Reloadable**  Y
-  **Environment** PGRST_DB_TIMEZONE_ENABLED
-  **In-Database** pgrst.db_timezone_enabled
-  =============== =================================
-
-  Enables the use of :ref:`prefer_timezone` preference header. Disabled when set to ``false``.
-
 .. _db-tx-end:
 
 db-tx-end

src/library/PostgREST/Config.hs

@@ -95,7 +95,6 @@ data AppConfig = AppConfig
   , configDbSchemas                 :: NonEmpty Text
   , configDbConfig                  :: Bool
   , configDbPreConfig               :: Maybe QualifiedIdentifier
-  , configDbTimezoneEnabled         :: Bool
   , configDbTxAllowOverride         :: Bool
   , configDbTxRollbackAll           :: Bool
   , configDbUri                     :: Text
@@ -186,7 +185,6 @@ toText conf =
       ,("db-schemas",                q . T.intercalate "," . toList . configDbSchemas)
       ,("db-config",                     T.toLower . show . configDbConfig)
       ,("db-pre-config",             q . maybe mempty dumpQi . configDbPreConfig)
-      ,("db-timezone-enabled",           T.toLower . show . configDbTimezoneEnabled)
       ,("db-tx-end",                 q . showTxEnd)
       ,("db-uri",                    q . configDbUri)
       ,("jwt-aud",                   q . fromMaybe mempty . configJwtAudience)
@@ -301,7 +299,6 @@ parser optPath env dbSettings roleSettings roleIsolationLvl =
     <*> parseDbSchemas "db-schemas" "db-schema"
     <*> (fromMaybe True <$> optBool "db-config")
     <*> (fmap toQi <$> optString "db-pre-config")
-    <*> (fromMaybe True <$> optBool "db-timezone-enabled")
     <*> parseTxEnd "db-tx-end" snd
     <*> parseTxEnd "db-tx-end" fst
     <*> (fromMaybe "postgresql://" <$> optString "db-uri")
@@ -737,9 +734,6 @@ exampleConfigFile = S.unlines
   , "## The name of which database schema to expose to REST clients"
   , "db-schemas = \"public\""
   , ""
-  , "## Enable quering pg_timezone_names from db"
-  , "# db-timezone-enabled = true"
-  , ""
   , "## How to terminate database transactions"
   , "## Possible values are:"
   , "## commit (default)"

src/library/PostgREST/Config/Database.hs

@@ -57,7 +57,6 @@ dbSettingsNames =
   ,"db_prepared_statements"
   ,"db_root_spec"
   ,"db_schemas"
-  ,"db_timezone_enabled"
   ,"db_tx_end"
   ,"db_hoisted_tx_settings"
   ,"jwt_aud"

src/library/PostgREST/SchemaCache.hs

@@ -160,15 +160,13 @@ querySchemaCache pgVer conf@AppConfig{..} = do
   cRels   <- sqlTimedStmt gucCRels mempty allComputedRels
   reps    <- sqlTimedStmt gucDReps conf   dataRepresentations
   mHdlers <- sqlTimedStmt gucMHdrs conf   mediaHandlers
-  tzones  <- if configDbTimezoneEnabled
-    then sqlTimedStmt gucTzones mempty timezones
-    else pure S.empty
+  tzones  <- sqlTimedStmt gucTzones mempty timezones
 
   for_ configInternalSCQuerySleepSnd (`SQL.statement` sleepCall) -- only used for testing
 
   qsTime <-
     if isLogDebug
-      then Just <$> SQL.statement mempty (extractTimings configDbTimezoneEnabled)
+      then Just <$> SQL.statement mempty (extractTimings True)
       else pure Nothing
 
   let tabsWViewsPks = addViewPrimaryKeys tabs keyDeps

test/io/configs/expected/aliases.config

@@ -22,7 +22,6 @@ db-pre-request = "check_alias"
 db-prepared-statements = true
 db-root-spec = "open_alias"
 db-schemas = "provided_through_alias"
-db-timezone-enabled = true
 db-tx-end = "commit"
 db-uri = "postgresql://"
 jwt-aud = ""

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

@@ -22,7 +22,6 @@ db-pre-request = ""
 db-prepared-statements = false
 db-root-spec = ""
 db-schemas = "public"
-db-timezone-enabled = true
 db-tx-end = "commit"
 db-uri = "postgresql://"
 jwt-aud = ""

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

@@ -22,7 +22,6 @@ db-pre-request = ""
 db-prepared-statements = false
 db-root-spec = ""
 db-schemas = "public"
-db-timezone-enabled = true
 db-tx-end = "commit"
 db-uri = "postgresql://"
 jwt-aud = ""

test/io/configs/expected/defaults.config

@@ -22,7 +22,6 @@ db-pre-request = ""
 db-prepared-statements = true
 db-root-spec = ""
 db-schemas = "public"
-db-timezone-enabled = true
 db-tx-end = "commit"
 db-uri = "postgresql://"
 jwt-aud = ""

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

@@ -24,7 +24,6 @@ db-pre-request = "test.other_custom_headers"
 db-prepared-statements = false
 db-root-spec = "other_root"
 db-schemas = "test,other_tenant1,other_tenant2"
-db-timezone-enabled = false
 db-tx-end = "rollback-allow-override"
 db-uri = "postgresql://"
 jwt-aud = "https://otherexample.org"

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

@@ -24,7 +24,6 @@ db-pre-request = "test.custom_headers"
 db-prepared-statements = false
 db-root-spec = "root"
 db-schemas = "test,tenant1,tenant2"
-db-timezone-enabled = false
 db-tx-end = "commit-allow-override"
 db-uri = "postgresql://"
 jwt-aud = "https://example.org"

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

@@ -24,7 +24,6 @@ db-pre-request = "please_run_fast"
 db-prepared-statements = false
 db-root-spec = "openapi_v3"
 db-schemas = "multi,tenant,setup"
-db-timezone-enabled = false
 db-tx-end = "rollback-allow-override"
 db-uri = "tmp_db"
 jwt-aud = "https://postgrest.org"

test/io/configs/expected/types.config

@@ -23,7 +23,6 @@ db-pre-request = ""
 db-prepared-statements = true
 db-root-spec = ""
 db-schemas = "public"
-db-timezone-enabled = true
 db-tx-end = "commit"
 db-uri = "postgresql://"
 jwt-aud = ""

test/io/configs/expected/utf-8.config

@@ -22,7 +22,6 @@ db-pre-request = ""
 db-prepared-statements = true
 db-root-spec = ""
 db-schemas = "public"
-db-timezone-enabled = true
 db-tx-end = "commit"
 db-uri = "postgresql://"
 jwt-aud = ""

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

@@ -20,7 +20,6 @@ PGRST_DB_ROOT_SPEC: openapi_v3
 PGRST_DB_SCHEMAS: multi,   tenant,setup
 PGRST_DB_CONFIG: false
 PGRST_DB_PRE_CONFIG: "postgrest.pre_config"
-PGRST_DB_TIMEZONE_ENABLED: false
 PGRST_DB_TX_END: rollback-allow-override
 PGRST_DB_URI: tmp_db
 PGRST_DB_USE_LEGACY_GUCS: false

test/io/configs/no-defaults.config

@@ -18,7 +18,6 @@ db-root-spec = "openapi_v3"
 db-schemas = "multi,   tenant,setup"
 db-config = false
 db-pre-config = "postgrest.pre_config"
-db-timezone-enabled = false
 db-tx-end = "rollback-allow-override"
 db-uri = "tmp_db"
 jwt-aud = "https://postgrest.org"

test/io/fixtures/db_config.sql

@@ -13,7 +13,6 @@ ALTER ROLE db_config_authenticator SET pgrst.db_pre_request = 'test.custom_heade
 ALTER ROLE db_config_authenticator SET pgrst.db_prepared_statements = 'false';
 ALTER ROLE db_config_authenticator SET pgrst.db_root_spec = 'root';
 ALTER ROLE db_config_authenticator SET pgrst.db_schemas = 'test, tenant1, tenant2';
-ALTER ROLE db_config_authenticator SET pgrst.db_timezone_enabled = 'false';
 ALTER ROLE db_config_authenticator SET pgrst.db_tx_end = 'commit-allow-override';
 ALTER ROLE db_config_authenticator SET pgrst.jwt_aud = 'https://example.org';
 ALTER ROLE db_config_authenticator SET pgrst.jwt_cache_max_entries = '86400';
@@ -71,7 +70,6 @@ ALTER ROLE other_authenticator SET pgrst.db_pre_request = 'test.other_custom_hea
 ALTER ROLE other_authenticator SET pgrst.db_prepared_statements = 'false';
 ALTER ROLE other_authenticator SET pgrst.db_root_spec = 'other_root';
 ALTER ROLE other_authenticator SET pgrst.db_schemas = 'test, other_tenant1, other_tenant2';
-ALTER ROLE other_authenticator SET pgrst.db_timezone_enabled = 'false';
 ALTER ROLE other_authenticator SET pgrst.jwt_aud = 'https://otherexample.org';
 ALTER ROLE other_authenticator SET pgrst.jwt_secret = 'ODERREALLYREALLYREALLYREALLYVERYSAFE';
 ALTER ROLE other_authenticator SET pgrst.jwt_secret_is_base64 = 'false';

test/io/test_io.py

@@ -994,16 +994,13 @@ def test_schema_cache_query_sleep_logs(defaultenv):
         assert 1000 < observed_ms < 2000
 
 
-@pytest.mark.parametrize("timezone_enabled", ["true", "false"])
 @pytest.mark.parametrize("level", ["crit", "error", "warn", "info", "debug"])
-def test_schema_cache_query_timings_log(level, timezone_enabled, defaultenv):
+def test_schema_cache_query_timings_log(level, defaultenv):
     "Schema cache query timings should be logged on log-level=debug."
 
     env = {
         **defaultenv,
         "PGRST_LOG_LEVEL": level,
-        # when this is disabled, it should log 0 for tzones
-        "PGRST_DB_TIMEZONE_ENABLED": timezone_enabled,
     }
     # here we also capture the tzones: <value> ms
     log_pattern = re.compile(
@@ -1018,10 +1015,7 @@ def test_schema_cache_query_timings_log(level, timezone_enabled, defaultenv):
 
         if level == "debug":
             assert len(timing_matches) == 1
-            if timezone_enabled == "false":
-                assert float(timing_matches[0].group(1)) == 0
-            else:
-                assert float(timing_matches[0].group(1)) > 0
+            assert float(timing_matches[0].group(1)) > 0
         else:
             assert not timing_matches
 

test/observability/ObsHelper.hs

@@ -90,7 +90,6 @@ baseCfg = let secret = encodeUtf8 "reallyreallyreallyreallyverysafe" in
   , configDbSchemas                 = fromList ["test"]
   , configDbConfig                  = False
   , configDbPreConfig               = Nothing
-  , configDbTimezoneEnabled         = True
   , configDbUri                     = "postgresql://"
   , configFilePath                  = Nothing
   , configJWKS                      = rightToMaybe $ parseSecret secret

test/spec/Feature/Query/Preferences/TimezoneSpec.hs

@@ -5,13 +5,12 @@ import Test.Hspec
 import Test.Hspec.Wai
 import Test.Hspec.Wai.JSON
 
-import PostgREST.Config (AppConfig (..))
-
 import Protolude  hiding (get)
 import SpecHelper
 
-enabledSpec :: SpecWithConfig
-enabledSpec withConfig = withConfig baseCfg $ describe "test Prefer: timezone with db-timezone-enabled is true" $ do
+spec :: SpecWithConfig
+spec withConfig = withConfig baseCfg $
+  describe "test Prefer: timezone with db-timezone-enabled is true" $ do
     context "test Prefer: timezone=America/Los_Angeles" $ do
       it "should change timezone with handling=strict" $
         request methodGet "/timestamps"
@@ -59,34 +58,3 @@ enabledSpec withConfig = withConfig baseCfg $ describe "test Prefer: timezone wi
           { matchStatus = 200
           , matchHeaders = [matchContentTypeJson
                            , "Preference-Applied" <:> "handling=lenient"]}
-
-
-disabledSpec :: SpecWithConfig
-disabledSpec withConfig = withConfig (baseCfg { configDbTimezoneEnabled = False }) $
-  describe "test Prefer: timezone with db-timezone-enabled is false" $ do
-    context "test Prefer: timezone=America/Los_Angeles when timezone is disabled" $ do
-      it "should throw error with handling=strict" $
-        request methodGet "/timestamps"
-          [("Prefer", "handling=strict, timezone=America/Los_Angeles")]
-          ""
-          `shouldRespondWith`
-          [json|{"code":"PGRST122","details":"Invalid preferences: timezone=America/Los_Angeles","hint":null,"message":"Invalid preferences given with handling=strict"}|]
-          { matchStatus = 400 }
-
-      it "should return with default timezone without handling or with handling=lenient" $ do
-        request methodGet "/timestamps"
-          [("Prefer", "timezone=America/Los_Angeles")]
-          ""
-          `shouldRespondWith`
-          [json|[{"t":"2023-10-18T12:37:59.611+00:00"}, {"t":"2023-10-18T14:37:59.611+00:00"}, {"t":"2023-10-18T16:37:59.611+00:00"}]|]
-          { matchStatus = 200
-          , matchHeaders = [matchContentTypeJson]}
-
-        request methodGet "/timestamps"
-          [("Prefer", "handling=lenient, timezone=America/Los_Angeles")]
-          ""
-          `shouldRespondWith`
-          [json|[{"t":"2023-10-18T12:37:59.611+00:00"}, {"t":"2023-10-18T14:37:59.611+00:00"}, {"t":"2023-10-18T16:37:59.611+00:00"}]|]
-          { matchStatus = 200
-          , matchHeaders = [matchContentTypeJson
-                           , "Preference-Applied" <:> "handling=lenient"]}

test/spec/Main.hs

@@ -149,7 +149,7 @@ main = do
         , ("Feature.Query.PlanSpec.spec"                       , Feature.Query.PlanSpec.spec)
         , ("Feature.Query.Preferences.HandlingSpec"            , Feature.Query.Preferences.HandlingSpec.spec)
         , ("Feature.Query.Preferences.MaxAffectedSpec"         , Feature.Query.Preferences.MaxAffectedSpec.spec)
-        , ("Feature.Query.Preferences.TimezoneSpec.enabledSpec", Feature.Query.Preferences.TimezoneSpec.enabledSpec)
+        , ("Feature.Query.Preferences.TimezoneSpec"            , Feature.Query.Preferences.TimezoneSpec.spec)
         , ("Feature.Query.PreparedStatementsSpec.spec"         , Feature.Query.PreparedStatementsSpec.spec)
         , ("Feature.Query.QueryLimitedSpec"                    , Feature.Query.QueryLimitedSpec.spec)
         , ("Feature.Query.QuerySpec"                           , Feature.Query.QuerySpec.spec actualPgVersion)
@@ -174,7 +174,6 @@ main = do
     parallel $ describe "Feature.ExtraSearchPathSpec" $ Feature.ExtraSearchPathSpec.spec withConfigDbs
     parallel $ describe "Feature.Query.PostGISSpec" $ Feature.Query.PostGISSpec.spec withConfigDbs
     parallel $ describe "Feature.Query.MultipleSchemaSpec" $ Feature.Query.MultipleSchemaSpec.spec withConfigDbs
-    parallel $ describe "Feature.Query.Preferences.TimezoneSpec.disabledSpec" $ Feature.Query.Preferences.TimezoneSpec.disabledSpec withConfigDbs
 
     -- Note: the rollback tests can not run in parallel, because they test persistence and
     -- this results in race conditions

test/spec/SpecHelper.hs

@@ -152,7 +152,6 @@ baseCfg = let secret = encodeUtf8 "reallyreallyreallyreallyverysafe" in
   , configDbSchemas                 = fromList ["test"]
   , configDbConfig                  = False
   , configDbPreConfig               = Nothing
-  , configDbTimezoneEnabled         = True
   , configDbUri                     = "postgresql://"
   , configFilePath                  = Nothing
   , configJWKS                      = rightToMaybe $ parseSecret secret