jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: fixes server timings' precision (#3227)

Browse Source 
* test: fix test_io accordingly
This commit is contained in:
Andrei Dziahel
2024-02-14 12:26:34 -05:00
committed by GitHub
parent b22bb748f2
commit 3432f75ed4
2 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/PostgREST/Response/Performance.hs
+5 -2
View File
@@ -1,3 +1,4 @@
{-# LANGUAGE NumericUnderscores #-}
module PostgREST.Response.Performance module PostgREST.Response.Performance
( ServerTiming (..) ( ServerTiming (..)
, serverTimingHeader , serverTimingHeader
@@ -8,6 +9,7 @@ import qualified Network.HTTP.Types as HTTP
import Numeric (showFFloat) import Numeric (showFFloat)
import Protolude import Protolude
-- | ServerTiming represents the timing data for a request, in seconds.
data ServerTiming = data ServerTiming =
ServerTiming ServerTiming
{ jwt :: Maybe Double { jwt :: Maybe Double
@@ -19,14 +21,15 @@ data ServerTiming =
deriving (Show) deriving (Show)
-- | Render the Server-Timing header from a ServerTimingData -- | Render the Server-Timing header from a ServerTimingData
-- The duration precision is milliseconds, per the docs
-- --
-- >>> serverTimingHeader ServerTiming { plan=Just 0.1, transaction=Just 0.2, response=Just 0.3, jwt=Just 0.4, parse=Just 0.5} -- >>> serverTimingHeader ServerTiming { plan=Just 0.1, transaction=Just 0.2, response=Just 0.3, jwt=Just 0.4, parse=Just 0.5}
-- ("Server-Timing","jwt;dur=400000.0, parse;dur=500000.0, plan;dur=100000.0, transaction;dur=200000.0, response;dur=300000.0") -- ("Server-Timing","jwt;dur=400.0, parse;dur=500.0, plan;dur=100.0, transaction;dur=200.0, response;dur=300.0")
serverTimingHeader :: ServerTiming -> HTTP.Header serverTimingHeader :: ServerTiming -> HTTP.Header
serverTimingHeader timing = serverTimingHeader timing =
("Server-Timing", renderTiming) ("Server-Timing", renderTiming)
where where
renderMetric metric = maybe "" (\dur -> BS.concat [metric, BS.pack $ ";dur=" <> showFFloat (Just 1) (dur * 1000000) ""]) renderMetric metric = maybe "" (\dur -> BS.concat [metric, BS.pack $ ";dur=" <> showFFloat (Just 1) (dur * 1_000) ""])
renderTiming = BS.intercalate ", " $ (\(k, v) -> renderMetric k (v timing)) <$> renderTiming = BS.intercalate ", " $ (\(k, v) -> renderMetric k (v timing)) <$>
[ ("jwt", jwt) [ ("jwt", jwt)
, ("parse", parse) , ("parse", parse)
test/io/test_io.py
+4 -4
View File
@@ -1170,9 +1170,9 @@ def test_server_timing_jwt_should_decrease_on_subsequent_requests(defaultenv):
first_dur = parse_server_timings_header(first_timings)["jwt"] first_dur = parse_server_timings_header(first_timings)["jwt"]
second_dur = parse_server_timings_header(second_timings)["jwt"] second_dur = parse_server_timings_header(second_timings)["jwt"]
# their difference should be atleast 300, implying # their difference should be atleast 0.3ms, implying
# that JWT Caching is working as expected # that JWT Caching is working as expected
assert (first_dur - second_dur) > 300.0 assert (first_dur - second_dur) > 0.3
# just added to complete code coverage # just added to complete code coverage
@@ -1252,9 +1252,9 @@ def test_jwt_cache_with_no_exp_claim(defaultenv):
first_dur = parse_server_timings_header(first_timings)["jwt"] first_dur = parse_server_timings_header(first_timings)["jwt"]
second_dur = parse_server_timings_header(second_timings)["jwt"] second_dur = parse_server_timings_header(second_timings)["jwt"]
# their difference should be atleast 300, implying # their difference should be atleast 0.3ms, implying
# that JWT Caching is working as expected # that JWT Caching is working as expected
assert (first_dur - second_dur) > 300.0 assert (first_dur - second_dur) > 0.3
def test_preflight_request_with_cors_allowed_origin_config(defaultenv): def test_preflight_request_with_cors_allowed_origin_config(defaultenv):