{-| Module : PostgREST.Error Description : PostgREST error HTTP responses -} {-# OPTIONS_GHC -fno-warn-orphans #-} {-# LANGUAGE RecordWildCards #-} module PostgREST.Error ( errorResponseFor , ApiRequestError(..) , PgError(..) , Error(..) , errorPayload , singularityError ) where import qualified Data.Aeson as JSON import qualified Data.ByteString.Char8 as BS import qualified Data.FuzzySet as Fuzzy import qualified Data.HashMap.Strict as HM import qualified Data.Text as T import qualified Data.Text.Encoding as T import qualified Data.Text.Encoding.Error as T import qualified Hasql.Pool as SQL import qualified Hasql.Session as SQL import qualified Network.HTTP.Types.Status as HTTP import Data.Aeson ((.=)) import Network.Wai (Response, responseLBS) import Network.HTTP.Types.Header (Header) import PostgREST.ApiRequest.Types (ApiRequestError (..), QPError (..), RangeError (..)) import PostgREST.MediaType (MediaType (..)) import qualified PostgREST.MediaType as MediaType import PostgREST.SchemaCache.Identifiers (QualifiedIdentifier (..), Schema) import PostgREST.SchemaCache.Relationship (Cardinality (..), Junction (..), Relationship (..), RelationshipsMap) import PostgREST.SchemaCache.Routine (Routine (..), RoutineParam (..)) import Protolude class (JSON.ToJSON a) => PgrstError a where status :: a -> HTTP.Status headers :: a -> [Header] errorPayload :: a -> LByteString errorPayload = JSON.encode errorResponseFor :: a -> Response errorResponseFor err = responseLBS (status err) (headers err) $ errorPayload err instance PgrstError ApiRequestError where status AmbiguousRelBetween{} = HTTP.status300 status AmbiguousRpc{} = HTTP.status300 status BinaryFieldError{} = HTTP.status406 status MediaTypeError{} = HTTP.status415 status InvalidBody{} = HTTP.status400 status InvalidFilters = HTTP.status405 status InvalidRpcMethod{} = HTTP.status405 status InvalidRange{} = HTTP.status416 status NotFound = HTTP.status404 status NoRelBetween{} = HTTP.status400 status NoRpc{} = HTTP.status404 status NotEmbedded{} = HTTP.status400 status PutLimitNotAllowedError = HTTP.status400 status QueryParamError{} = HTTP.status400 status RelatedOrderNotToOne{} = HTTP.status400 status SpreadNotToOne{} = HTTP.status400 status UnacceptableFilter{} = HTTP.status400 status UnacceptableSchema{} = HTTP.status406 status UnsupportedMethod{} = HTTP.status405 status LimitNoOrderError = HTTP.status400 status ColumnNotFound{} = HTTP.status400 headers _ = [MediaType.toContentType MTApplicationJSON] instance JSON.ToJSON ApiRequestError where toJSON (QueryParamError (QPError message details)) = JSON.object [ "code" .= ApiRequestErrorCode00, "message" .= message, "details" .= details, "hint" .= JSON.Null] toJSON (InvalidRpcMethod method) = JSON.object [ "code" .= ApiRequestErrorCode01, "message" .= ("Cannot use the " <> T.decodeUtf8 method <> " method on RPC"), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (InvalidBody errorMessage) = JSON.object [ "code" .= ApiRequestErrorCode02, "message" .= T.decodeUtf8 errorMessage, "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (InvalidRange rangeError) = JSON.object [ "code" .= ApiRequestErrorCode03, "message" .= ("Requested range not satisfiable" :: Text), "details" .= (case rangeError of NegativeLimit -> "Limit should be greater than or equal to zero." LowerGTUpper -> "The lower boundary must be lower than or equal to the upper boundary in the Range header." OutOfBounds lower total -> "An offset of " <> lower <> " was requested, but there are only " <> total <> " rows."), "hint" .= JSON.Null] toJSON InvalidFilters = JSON.object [ "code" .= ApiRequestErrorCode05, "message" .= ("Filters must include all and only primary key columns with 'eq' operators" :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (UnacceptableSchema schemas) = JSON.object [ "code" .= ApiRequestErrorCode06, "message" .= ("The schema must be one of the following: " <> T.intercalate ", " schemas), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (MediaTypeError cts) = JSON.object [ "code" .= ApiRequestErrorCode07, "message" .= ("None of these media types are available: " <> T.intercalate ", " (map T.decodeUtf8 cts)), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON NotFound = JSON.object [] toJSON (NotEmbedded resource) = JSON.object [ "code" .= ApiRequestErrorCode08, "message" .= ("'" <> resource <> "' is not an embedded resource in this request" :: Text), "details" .= JSON.Null, "hint" .= ("Verify that '" <> resource <> "' is included in the 'select' query parameter." :: Text)] toJSON LimitNoOrderError = JSON.object [ "code" .= ApiRequestErrorCode09, "message" .= ("A 'limit' was applied without an explicit 'order'":: Text), "details" .= JSON.Null, "hint" .= ("Apply an 'order' using unique column(s)" :: Text)] toJSON (BinaryFieldError ct) = JSON.object [ "code" .= ApiRequestErrorCode13, "message" .= ((T.decodeUtf8 (MediaType.toMime ct) <> " requested but more than one column was selected") :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON PutLimitNotAllowedError = JSON.object [ "code" .= ApiRequestErrorCode14, "message" .= ("limit/offset querystring parameters are not allowed for PUT" :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (UnsupportedMethod method) = JSON.object [ "code" .= ApiRequestErrorCode17, "message" .= ("Unsupported HTTP method: " <> T.decodeUtf8 method), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (RelatedOrderNotToOne origin target) = JSON.object [ "code" .= ApiRequestErrorCode18, "message" .= ("A related order on '" <> target <> "' is not possible" :: Text), "details" .= ("'" <> origin <> "' and '" <> target <> "' do not form a many-to-one or one-to-one relationship" :: Text), "hint" .= JSON.Null] toJSON (SpreadNotToOne origin target) = JSON.object [ "code" .= ApiRequestErrorCode19, "message" .= ("A spread operation on '" <> target <> "' is not possible" :: Text), "details" .= ("'" <> origin <> "' and '" <> target <> "' do not form a many-to-one or one-to-one relationship" :: Text), "hint" .= JSON.Null] toJSON (UnacceptableFilter target) = JSON.object [ "code" .= ApiRequestErrorCode20, "message" .= ("Bad operator on the '" <> target <> "' embedded resource":: Text), "details" .= ("Only is null or not is null filters are allowed on embedded resources":: Text), "hint" .= JSON.Null] toJSON (NoRelBetween parent child embedHint schema allRels) = JSON.object [ "code" .= SchemaCacheErrorCode00, "message" .= ("Could not find a relationship between '" <> parent <> "' and '" <> child <> "' in the schema cache" :: Text), "details" .= ("Searched for a foreign key relationship between '" <> parent <> "' and '" <> child <> maybe mempty ("' using the hint '" <>) embedHint <> "' in the schema '" <> schema <> "', but no matches were found."), "hint" .= noRelBetweenHint parent child schema allRels] toJSON (AmbiguousRelBetween parent child rels) = JSON.object [ "code" .= SchemaCacheErrorCode01, "message" .= ("Could not embed because more than one relationship was found for '" <> parent <> "' and '" <> child <> "'" :: Text), "details" .= (compressedRel <$> rels), "hint" .= ("Try changing '" <> child <> "' to one of the following: " <> relHint rels <> ". Find the desired relationship in the 'details' key." :: Text)] toJSON (NoRpc schema procName argumentKeys hasPreferSingleObject contentType isInvPost allProcs overloadedProcs) = let func = schema <> "." <> procName prms = T.intercalate ", " argumentKeys prmsMsg = "(" <> prms <> ")" prmsDet = " with parameter" <> (if length argumentKeys > 1 then "s " else " ") <> prms fmtPrms p = if null argumentKeys then " without parameters" else p onlySingleParams = hasPreferSingleObject || (isInvPost && contentType `elem` [MTTextPlain, MTTextXML, MTOctetStream]) in JSON.object [ "code" .= SchemaCacheErrorCode02, "message" .= ("Could not find the function " <> func <> (if onlySingleParams then "" else fmtPrms prmsMsg) <> " in the schema cache"), "details" .= ("Searched for the function " <> func <> (case (hasPreferSingleObject, isInvPost, contentType) of (True, _, _) -> " with a single json/jsonb parameter" (_, True, MTTextPlain) -> " with a single unnamed text parameter" (_, True, MTTextXML) -> " with a single unnamed xml parameter" (_, True, MTOctetStream) -> " with a single unnamed bytea parameter" (_, True, MTApplicationJSON) -> fmtPrms prmsDet <> " or with a single unnamed json/jsonb parameter" _ -> fmtPrms prmsDet) <> ", but no matches were found in the schema cache."), -- The hint will be null in the case of single unnamed parameter functions "hint" .= if onlySingleParams then Nothing else noRpcHint schema procName argumentKeys allProcs overloadedProcs ] toJSON (AmbiguousRpc procs) = JSON.object [ "code" .= SchemaCacheErrorCode03, "message" .= ("Could not choose the best candidate function between: " <> T.intercalate ", " [pdSchema p <> "." <> pdName p <> "(" <> T.intercalate ", " [ppName a <> " => " <> ppType a | a <- pdParams p] <> ")" | p <- procs]), "details" .= JSON.Null, "hint" .= ("Try renaming the parameters or the function itself in the database so function overloading can be resolved" :: Text)] toJSON (ColumnNotFound relName colName) = JSON.object [ "code" .= SchemaCacheErrorCode04, "message" .= ("Column '" <> colName <> "' of relation '" <> relName <> "' does not exist" :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] -- | -- If no relationship is found then: -- -- Looks for parent suggestions if parent not found -- Looks for child suggestions if parent is found but child is not -- Gives no suggestions if both are found (it means that there is a problem with the embed hint) -- -- >>> :set -Wno-missing-fields -- >>> let qi t = QualifiedIdentifier "api" t -- >>> let rel ft = Relationship{relForeignTable = qi ft} -- >>> let rels = HM.fromList [((qi "films", "api"), [rel "directors", rel "roles", rel "actors"])] -- -- >>> noRelBetweenHint "film" "directors" "api" rels -- Just "Perhaps you meant 'films' instead of 'film'." -- -- >>> noRelBetweenHint "films" "role" "api" rels -- Just "Perhaps you meant 'roles' instead of 'role'." -- -- >>> noRelBetweenHint "films" "role" "api" rels -- Just "Perhaps you meant 'roles' instead of 'role'." -- -- >>> noRelBetweenHint "films" "actors" "api" rels -- Nothing -- -- >>> noRelBetweenHint "noclosealternative" "roles" "api" rels -- Nothing -- -- >>> noRelBetweenHint "films" "noclosealternative" "api" rels -- Nothing -- -- >>> noRelBetweenHint "films" "noclosealternative" "noclosealternative" rels -- Nothing -- noRelBetweenHint :: Text -> Text -> Schema -> RelationshipsMap -> Maybe Text noRelBetweenHint parent child schema allRels = ("Perhaps you meant '" <>) <$> if isJust findParent then (<> "' instead of '" <> child <> "'.") <$> suggestChild else (<> "' instead of '" <> parent <> "'.") <$> suggestParent where findParent = HM.lookup (QualifiedIdentifier schema parent, schema) allRels fuzzySetOfParents = Fuzzy.fromList [qiName (fst p) | p <- HM.keys allRels, snd p == schema] fuzzySetOfChildren = Fuzzy.fromList [qiName (relForeignTable c) | c <- fromMaybe [] findParent] suggestParent = Fuzzy.getOne fuzzySetOfParents parent -- Do not give suggestion if the child is found in the relations (weight = 1.0) suggestChild = headMay [snd k | k <- Fuzzy.get fuzzySetOfChildren child, fst k < 1.0] -- | -- If no function is found with the given name, it does a fuzzy search to all the functions -- in the same schema and shows the best match as hint. -- -- >>> :set -Wno-missing-fields -- >>> let procs = [(QualifiedIdentifier "api" "test"), (QualifiedIdentifier "api" "another"), (QualifiedIdentifier "private" "other")] -- -- >>> noRpcHint "api" "testt" ["val", "param", "name"] procs [] -- Just "Perhaps you meant to call the function api.test" -- -- >>> noRpcHint "api" "other" [] procs [] -- Just "Perhaps you meant to call the function api.another" -- -- >>> noRpcHint "api" "noclosealternative" [] procs [] -- Nothing -- -- If a function is found with the given name, but no params match, then it does a fuzzy search -- to all the overloaded functions' params using the form "param1, param2, param3, ..." -- and shows the best match as hint. -- -- >>> let procsDesc = [Function {pdParams = [RoutineParam {ppName="val"}, RoutineParam {ppName="param"}, RoutineParam {ppName="name"}]}, Function {pdParams = [RoutineParam {ppName="id"}, RoutineParam {ppName="attr"}]}] -- -- >>> noRpcHint "api" "test" ["vall", "pqaram", "nam"] procs procsDesc -- Just "Perhaps you meant to call the function api.test(name, param, val)" -- -- >>> noRpcHint "api" "test" ["val", "param"] procs procsDesc -- Just "Perhaps you meant to call the function api.test(name, param, val)" -- -- >>> noRpcHint "api" "test" ["id", "attrs"] procs procsDesc -- Just "Perhaps you meant to call the function api.test(attr, id)" -- -- >>> noRpcHint "api" "test" ["id"] procs procsDesc -- Just "Perhaps you meant to call the function api.test(attr, id)" -- -- >>> noRpcHint "api" "test" ["noclosealternative"] procs procsDesc -- Nothing -- noRpcHint :: Text -> Text -> [Text] -> [QualifiedIdentifier] -> [Routine] -> Maybe Text noRpcHint schema procName params allProcs overloadedProcs = fmap (("Perhaps you meant to call the function " <> schema <> ".") <>) possibleProcs where fuzzySetOfProcs = Fuzzy.fromList [qiName k | k <- allProcs, qiSchema k == schema] fuzzySetOfParams = Fuzzy.fromList $ listToText <$> [[ppName prm | prm <- pdParams ov] | ov <- overloadedProcs] -- Cannot do a fuzzy search like: Fuzzy.getOne [[Text]] [Text], where [[Text]] is the list of params for each -- overloaded function and [Text] the given params. This converts those lists to text to make fuzzy search possible. -- E.g. ["val", "param", "name"] into "(name, param, val)" listToText = ("(" <>) . (<> ")") . T.intercalate ", " . sort possibleProcs | null overloadedProcs = Fuzzy.getOne fuzzySetOfProcs procName | otherwise = (procName <>) <$> Fuzzy.getOne fuzzySetOfParams (listToText params) compressedRel :: Relationship -> JSON.Value -- An ambiguousness error cannot happen for computed relationships TODO refactor so this mempty is not needed compressedRel ComputedRelationship{} = JSON.object mempty compressedRel Relationship{..} = let fmtEls els = "(" <> T.intercalate ", " els <> ")" in JSON.object $ ("embedding" .= (qiName relTable <> " with " <> qiName relForeignTable :: Text)) : case relCardinality of M2M Junction{..} -> [ "cardinality" .= ("many-to-many" :: Text) , "relationship" .= (qiName junTable <> " using " <> junConstraint1 <> fmtEls (snd <$> junColsSource) <> " and " <> junConstraint2 <> fmtEls (snd <$> junColsTarget)) ] M2O cons relColumns -> [ "cardinality" .= ("many-to-one" :: Text) , "relationship" .= (cons <> " using " <> qiName relTable <> fmtEls (fst <$> relColumns) <> " and " <> qiName relForeignTable <> fmtEls (snd <$> relColumns)) ] O2O cons relColumns -> [ "cardinality" .= ("one-to-one" :: Text) , "relationship" .= (cons <> " using " <> qiName relTable <> fmtEls (fst <$> relColumns) <> " and " <> qiName relForeignTable <> fmtEls (snd <$> relColumns)) ] O2M cons relColumns -> [ "cardinality" .= ("one-to-many" :: Text) , "relationship" .= (cons <> " using " <> qiName relTable <> fmtEls (fst <$> relColumns) <> " and " <> qiName relForeignTable <> fmtEls (snd <$> relColumns)) ] relHint :: [Relationship] -> Text relHint rels = T.intercalate ", " (hintList <$> rels) where hintList Relationship{..} = let buildHint rel = "'" <> qiName relForeignTable <> "!" <> rel <> "'" in case relCardinality of M2M Junction{..} -> buildHint (qiName junTable) M2O cons _ -> buildHint cons O2O cons _ -> buildHint cons O2M cons _ -> buildHint cons -- An ambiguousness error cannot happen for computed relationships TODO refactor so this mempty is not needed hintList ComputedRelationship{} = mempty data PgError = PgError Authenticated SQL.UsageError type Authenticated = Bool instance PgrstError PgError where status (PgError authed usageError) = pgErrorStatus authed usageError headers err = if status err == HTTP.status401 then [MediaType.toContentType MTApplicationJSON, ("WWW-Authenticate", "Bearer") :: Header] else [MediaType.toContentType MTApplicationJSON] instance JSON.ToJSON PgError where toJSON (PgError _ usageError) = JSON.toJSON usageError instance JSON.ToJSON SQL.UsageError where toJSON (SQL.ConnectionUsageError e) = JSON.object [ "code" .= ConnectionErrorCode00, "message" .= ("Database connection error. Retrying the connection." :: Text), "details" .= (T.decodeUtf8With T.lenientDecode $ fromMaybe "" e :: Text), "hint" .= JSON.Null] toJSON (SQL.SessionUsageError e) = JSON.toJSON e -- SQL.Error toJSON SQL.AcquisitionTimeoutUsageError = JSON.object [ "code" .= ConnectionErrorCode03, "message" .= ("Timed out acquiring connection from connection pool." :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] instance JSON.ToJSON SQL.QueryError where toJSON (SQL.QueryError _ _ e) = JSON.toJSON e instance JSON.ToJSON SQL.CommandError where toJSON (SQL.ResultError (SQL.ServerError c m d h _p)) = JSON.object [ "code" .= (T.decodeUtf8 c :: Text), "message" .= (T.decodeUtf8 m :: Text), "details" .= (fmap T.decodeUtf8 d :: Maybe Text), "hint" .= (fmap T.decodeUtf8 h :: Maybe Text)] toJSON (SQL.ResultError resultError) = JSON.object [ "code" .= InternalErrorCode00, "message" .= (show resultError :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (SQL.ClientError d) = JSON.object [ "code" .= ConnectionErrorCode01, "message" .= ("Database client error. Retrying the connection." :: Text), "details" .= (fmap T.decodeUtf8 d :: Maybe Text), "hint" .= JSON.Null] pgErrorStatus :: Bool -> SQL.UsageError -> HTTP.Status pgErrorStatus _ (SQL.ConnectionUsageError _) = HTTP.status503 pgErrorStatus _ SQL.AcquisitionTimeoutUsageError = HTTP.status504 pgErrorStatus _ (SQL.SessionUsageError (SQL.QueryError _ _ (SQL.ClientError _))) = HTTP.status503 pgErrorStatus authed (SQL.SessionUsageError (SQL.QueryError _ _ (SQL.ResultError rError))) = case rError of (SQL.ServerError c m _ _ _) -> case BS.unpack c of '0':'8':_ -> HTTP.status503 -- pg connection err '0':'9':_ -> HTTP.status500 -- triggered action exception '0':'L':_ -> HTTP.status403 -- invalid grantor '0':'P':_ -> HTTP.status403 -- invalid role specification "23503" -> HTTP.status409 -- foreign_key_violation "23505" -> HTTP.status409 -- unique_violation "25006" -> HTTP.status405 -- read_only_sql_transaction '2':'5':_ -> HTTP.status500 -- invalid tx state '2':'8':_ -> HTTP.status403 -- invalid auth specification '2':'D':_ -> HTTP.status500 -- invalid tx termination '3':'8':_ -> HTTP.status500 -- external routine exception '3':'9':_ -> HTTP.status500 -- external routine invocation '3':'B':_ -> HTTP.status500 -- savepoint exception '4':'0':_ -> HTTP.status500 -- tx rollback '5':'3':_ -> HTTP.status503 -- insufficient resources '5':'4':_ -> HTTP.status413 -- too complex '5':'5':_ -> HTTP.status500 -- obj not on prereq state '5':'7':'P':'0':'1':_ -> HTTP.status503 -- terminating connection due to administrator command '5':'7':_ -> HTTP.status500 -- operator intervention '5':'8':_ -> HTTP.status500 -- system error 'F':'0':_ -> HTTP.status500 -- conf file error 'H':'V':_ -> HTTP.status500 -- foreign data wrapper error "P0001" -> HTTP.status400 -- default code for "raise" 'P':'0':_ -> HTTP.status500 -- PL/pgSQL Error 'X':'X':_ -> HTTP.status500 -- internal Error "42883"-> if BS.isPrefixOf "function xmlagg(" m then HTTP.status406 else HTTP.status404 -- undefined function "42P01" -> HTTP.status404 -- undefined table "42501" -> if authed then HTTP.status403 else HTTP.status401 -- insufficient privilege 'P':'T':n -> fromMaybe HTTP.status500 (HTTP.mkStatus <$> readMaybe n <*> pure m) _ -> HTTP.status400 _ -> HTTP.status500 data Error = ApiRequestError ApiRequestError | GucHeadersError | GucStatusError | JwtTokenInvalid Text | JwtTokenMissing | JwtTokenRequired | NoSchemaCacheError | OffLimitsChangesError Int64 Integer | PgErr PgError | PutMatchingPkError | SingularityError Integer instance PgrstError Error where status (ApiRequestError err) = status err status GucHeadersError = HTTP.status500 status GucStatusError = HTTP.status500 status JwtTokenInvalid{} = HTTP.unauthorized401 status JwtTokenMissing = HTTP.status500 status JwtTokenRequired = HTTP.unauthorized401 status NoSchemaCacheError = HTTP.status503 status OffLimitsChangesError{} = HTTP.status400 status (PgErr err) = status err status PutMatchingPkError = HTTP.status400 status SingularityError{} = HTTP.status406 headers (ApiRequestError err) = headers err headers (JwtTokenInvalid m) = [MediaType.toContentType MTApplicationJSON, invalidTokenHeader m] headers JwtTokenRequired = [MediaType.toContentType MTApplicationJSON, requiredTokenHeader] headers (PgErr err) = headers err headers SingularityError{} = [MediaType.toContentType (MTSingularJSON False)] headers _ = [MediaType.toContentType MTApplicationJSON] instance JSON.ToJSON Error where toJSON NoSchemaCacheError = JSON.object [ "code" .= ConnectionErrorCode02, "message" .= ("Could not query the database for the schema cache. Retrying." :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON JwtTokenMissing = JSON.object [ "code" .= JWTErrorCode00, "message" .= ("Server lacks JWT secret" :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (JwtTokenInvalid message) = JSON.object [ "code" .= JWTErrorCode01, "message" .= (message :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON JwtTokenRequired = JSON.object [ "code" .= JWTErrorCode02, "message" .= ("Anonymous access is disabled" :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (OffLimitsChangesError n maxs) = JSON.object [ "code" .= ApiRequestErrorCode10, "message" .= ("The maximum number of rows allowed to change was surpassed" :: Text), "details" .= T.unwords ["Results contain", show n, "rows changed but the maximum number allowed is", show maxs], "hint" .= JSON.Null] toJSON GucHeadersError = JSON.object [ "code" .= ApiRequestErrorCode11, "message" .= ("response.headers guc must be a JSON array composed of objects with a single key and a string value" :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON GucStatusError = JSON.object [ "code" .= ApiRequestErrorCode12, "message" .= ("response.status guc must be a valid status code" :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON PutMatchingPkError = JSON.object [ "code" .= ApiRequestErrorCode15, "message" .= ("Payload values do not match URL in primary key column(s)" :: Text), "details" .= JSON.Null, "hint" .= JSON.Null] toJSON (SingularityError n) = JSON.object [ "code" .= ApiRequestErrorCode16, "message" .= ("JSON object requested, multiple (or no) rows returned" :: Text), "details" .= T.unwords ["The result contains", show n, "rows"], "hint" .= JSON.Null] toJSON (PgErr err) = JSON.toJSON err toJSON (ApiRequestError err) = JSON.toJSON err invalidTokenHeader :: Text -> Header invalidTokenHeader m = ("WWW-Authenticate", "Bearer error=\"invalid_token\", " <> "error_description=" <> encodeUtf8 (show m)) requiredTokenHeader :: Header requiredTokenHeader = ("WWW-Authenticate", "Bearer") singularityError :: (Integral a) => a -> Error singularityError = SingularityError . toInteger -- Error codes are grouped by common modules or characteristics data ErrorCode -- PostgreSQL connection errors = ConnectionErrorCode00 | ConnectionErrorCode01 | ConnectionErrorCode02 | ConnectionErrorCode03 -- API Request errors | ApiRequestErrorCode00 | ApiRequestErrorCode01 | ApiRequestErrorCode02 | ApiRequestErrorCode03 | ApiRequestErrorCode04 -- no longer used (used to be mapped to ParseRequestError) | ApiRequestErrorCode05 | ApiRequestErrorCode06 | ApiRequestErrorCode07 | ApiRequestErrorCode08 | ApiRequestErrorCode09 | ApiRequestErrorCode10 | ApiRequestErrorCode11 | ApiRequestErrorCode12 | ApiRequestErrorCode13 | ApiRequestErrorCode14 | ApiRequestErrorCode15 | ApiRequestErrorCode16 | ApiRequestErrorCode17 | ApiRequestErrorCode18 | ApiRequestErrorCode19 | ApiRequestErrorCode20 -- Schema Cache errors | SchemaCacheErrorCode00 | SchemaCacheErrorCode01 | SchemaCacheErrorCode02 | SchemaCacheErrorCode03 | SchemaCacheErrorCode04 -- JWT authentication errors | JWTErrorCode00 | JWTErrorCode01 | JWTErrorCode02 -- Internal errors related to the Hasql library | InternalErrorCode00 instance JSON.ToJSON ErrorCode where toJSON e = JSON.toJSON (buildErrorCode e) -- New group of errors will be added at the end of all the groups and will have the next prefix in the sequence -- New errors are added at the end of the group they belong to and will have the next code in the sequence buildErrorCode :: ErrorCode -> Text buildErrorCode code = "PGRST" <> case code of ConnectionErrorCode00 -> "000" ConnectionErrorCode01 -> "001" ConnectionErrorCode02 -> "002" ConnectionErrorCode03 -> "003" ApiRequestErrorCode00 -> "100" ApiRequestErrorCode01 -> "101" ApiRequestErrorCode02 -> "102" ApiRequestErrorCode03 -> "103" ApiRequestErrorCode04 -> "104" ApiRequestErrorCode05 -> "105" ApiRequestErrorCode06 -> "106" ApiRequestErrorCode07 -> "107" ApiRequestErrorCode08 -> "108" ApiRequestErrorCode09 -> "109" ApiRequestErrorCode10 -> "110" ApiRequestErrorCode11 -> "111" ApiRequestErrorCode12 -> "112" ApiRequestErrorCode13 -> "113" ApiRequestErrorCode14 -> "114" ApiRequestErrorCode15 -> "115" ApiRequestErrorCode16 -> "116" ApiRequestErrorCode17 -> "117" ApiRequestErrorCode18 -> "118" ApiRequestErrorCode19 -> "119" ApiRequestErrorCode20 -> "120" SchemaCacheErrorCode00 -> "200" SchemaCacheErrorCode01 -> "201" SchemaCacheErrorCode02 -> "202" SchemaCacheErrorCode03 -> "203" SchemaCacheErrorCode04 -> "204" JWTErrorCode00 -> "300" JWTErrorCode01 -> "301" JWTErrorCode02 -> "302" InternalErrorCode00 -> "X00"