refactor: Rename Auth.getAuthResult to Auth.authenticate

getAuthResult suggests authentication result is already available and it just needs to be read. But in reality this function performs full JWT validation (ie. parsing, signature verification, claims validation).

Renaming it to authenticate so that the name is no longer misleading.

Author: mkleczek

src/PostgREST/App.hs

@@ -196,7 +196,7 @@ postgrestResponse appState maybeSchemaCache req = do
   let observer = liftIO . AppState.getObserver appState
 
   authResult@AuthResult{..} <-
-    withTiming @"jwt" $ Auth.getAuthResult conf (liftIO $ AppState.getTime appState) (AppState.getJwtCacheState appState) $ ApiRequest.userBearerAuth req
+    withTiming @"jwt" $ Auth.authenticate conf (liftIO $ AppState.getTime appState) (AppState.getJwtCacheState appState) $ ApiRequest.userBearerAuth req
   -- save authRole
   tell $ pure authRole
 

src/PostgREST/Auth.hs

@@ -15,7 +15,7 @@ very simple authentication system inside the PostgreSQL database.
 {-# LANGUAGE LambdaCase       #-}
 {-# LANGUAGE NamedFieldPuns   #-}
 module PostgREST.Auth
-  ( getAuthResult )
+  ( authenticate )
   where
 
 import           Control.Monad.Error.Class
@@ -39,8 +39,8 @@ import Protolude
 
 -- | Perform authentication and authorization
 --   Parse JWT and return AuthResult
-getAuthResult :: (MonadError Error m, MonadIO m) => AppConfig -> m UTCTime -> JwtCacheState -> Maybe ByteString -> m AuthResult
-getAuthResult cfg@AppConfig{configJwtRoleClaimKey, configDbAnonRole} getTime jwtCacheState token = do
+authenticate :: (MonadError Error m, MonadIO m) => AppConfig -> m UTCTime -> JwtCacheState -> Maybe ByteString -> m AuthResult
+authenticate cfg@AppConfig{configJwtRoleClaimKey, configDbAnonRole} getTime jwtCacheState token = do
   time <- getTime
   let
     parseClaims mclaims = do
@@ -60,7 +60,7 @@ getAuthResult cfg@AppConfig{configJwtRoleClaimKey, configDbAnonRole} getTime jwt
         unquoted v               = LBS.toStrict $ JSON.encode v
 
   parseClaims =<< lookupJwtCache jwtCacheState token
-{-# INLINABLE getAuthResult #-}
+{-# INLINABLE authenticate #-}
 
 data ValidAud = VAString Text | VAArray [Text] deriving Generic
 instance JSON.FromJSON ValidAud where