@@ -44,15 +44,15 @@ import PostgREST.ApiRequest (Action (..),
4444 Payload (.. ))
4545import PostgREST.Config (AppConfig (.. ))
4646import PostgREST.Error (Error (.. ))
47- import PostgREST.MediaType (MTPlanFormat (.. ),
48- MediaType (.. ))
47+ import PostgREST.MediaType (MediaType (.. ))
4948import PostgREST.Query.SqlFragment (sourceCTEName )
5049import PostgREST.RangeQuery (NonnegRange , allRange ,
5150 convertToLimitZeroRange ,
5251 restrictRange )
5352import PostgREST.SchemaCache (SchemaCache (.. ))
5453import PostgREST.SchemaCache.Identifiers (FieldName ,
5554 QualifiedIdentifier (.. ),
55+ RelIdentifier (.. ),
5656 Schema )
5757import PostgREST.SchemaCache.Relationship (Cardinality (.. ),
5858 Junction (.. ),
@@ -61,7 +61,7 @@ import PostgREST.SchemaCache.Relationship (Cardinality (..),
6161 relIsToOne )
6262import PostgREST.SchemaCache.Representations (DataRepresentation (.. ),
6363 RepresentationsMap )
64- import PostgREST.SchemaCache.Routine (ResultAggregate (.. ),
64+ import PostgREST.SchemaCache.Routine (MediaHandler (.. ),
6565 Routine (.. ),
6666 RoutineMap ,
6767 RoutineParam (.. ),
@@ -93,25 +93,28 @@ import Protolude hiding (from)
9393data WrappedReadPlan = WrappedReadPlan {
9494 wrReadPlan :: ReadPlanTree
9595, wrTxMode :: SQL. Mode
96- , wrResAgg :: ResultAggregate
96+ , wrHandler :: MediaHandler
9797, wrMedia :: MediaType
98+ , wrIdent :: QualifiedIdentifier
9899}
99100
100101data MutateReadPlan = MutateReadPlan {
101102 mrReadPlan :: ReadPlanTree
102103, mrMutatePlan :: MutatePlan
103104, mrTxMode :: SQL. Mode
104- , mrResAgg :: ResultAggregate
105+ , mrHandler :: MediaHandler
105106, mrMedia :: MediaType
107+ , mrIdent :: QualifiedIdentifier
106108}
107109
108110data CallReadPlan = CallReadPlan {
109111 crReadPlan :: ReadPlanTree
110112, crCallPlan :: CallPlan
111113, crTxMode :: SQL. Mode
112114, crProc :: Routine
113- , crResAgg :: ResultAggregate
115+ , crHandler :: MediaHandler
114116, crMedia :: MediaType
117+ , crIdent :: QualifiedIdentifier
115118}
116119
117120data InspectPlan = InspectPlan {
@@ -122,17 +125,17 @@ data InspectPlan = InspectPlan {
122125wrappedReadPlan :: QualifiedIdentifier -> AppConfig -> SchemaCache -> ApiRequest -> Either Error WrappedReadPlan
123126wrappedReadPlan identifier conf sCache apiRequest@ ApiRequest {iPreferences= Preferences {.. },.. } = do
124127 rPlan <- readPlan identifier conf sCache apiRequest
125- mediaType <- mapLeft ApiRequestError $ negotiateContent conf iAction iAcceptMediaType
128+ (hdler, mediaType) <- mapLeft ApiRequestError $ negotiateContent conf apiRequest identifier iAcceptMediaType (dbMediaHandlers sCache)
126129 if not (null invalidPrefs) && preferHandling == Just Strict then Left $ ApiRequestError $ InvalidPreferences invalidPrefs else Right ()
127- return $ WrappedReadPlan rPlan SQL. Read(mediaToAggregate mediaType apiRequest) mediaType
130+ return $ WrappedReadPlan rPlan SQL. Readhdler mediaType identifier
128131
129132mutateReadPlan :: Mutation -> ApiRequest -> QualifiedIdentifier -> AppConfig -> SchemaCache -> Either Error MutateReadPlan
130133mutateReadPlan mutation apiRequest@ ApiRequest {iPreferences= Preferences {.. },.. } identifier conf sCache = do
131134 rPlan <- readPlan identifier conf sCache apiRequest
132135 mPlan <- mutatePlan mutation identifier apiRequest sCache rPlan
133- mediaType <- mapLeft ApiRequestError $ negotiateContent conf iAction iAcceptMediaType
134136 if not (null invalidPrefs) && preferHandling == Just Strict then Left $ ApiRequestError $ InvalidPreferences invalidPrefs else Right ()
135- return $ MutateReadPlan rPlan mPlan SQL. Write
137+ (hdler, mediaType) <- mapLeft ApiRequestError $ negotiateContent conf apiRequest identifier iAcceptMediaType (dbMediaHandlers sCache)
138+ return $ MutateReadPlan rPlan mPlan SQL. Write
136139
137140callReadPlan :: QualifiedIdentifier -> AppConfig -> SchemaCache -> ApiRequest -> InvokeMethod -> Either Error CallReadPlan
138141callReadPlan identifier conf sCache apiRequest@ ApiRequest {iPreferences= Preferences {.. },.. } invMethod = do
@@ -156,15 +159,19 @@ callReadPlan identifier conf sCache apiRequest@ApiRequest{iPreferences=Preferenc
156159 (InvPost , Routine. Immutable-> SQL. Read
157160 (InvPost , Routine. Volatile-> SQL. Write
158161 cPlan = callPlan proc apiRequest paramKeys args rPlan
159- mediaType <- mapLeft ApiRequestError $ negotiateContent conf iAction iAcceptMediaType
162+ (hdler, mediaType) <- mapLeft ApiRequestError $ negotiateContent conf apiRequest relIdentifier iAcceptMediaType (dbMediaHandlers sCache)
160163 if not (null invalidPrefs) && preferHandling == Just Strict then Left $ ApiRequestError $ InvalidPreferences invalidPrefs else Right ()
161- return $ CallReadPlan rPlan cPlan txMode proc (mediaToAggregate mediaType apiRequest) mediaType
164+ return $ CallReadPlan rPlan cPlan txMode proc hdler mediaType relIdentifier
162165 where
163166 qsParams' = QueryParams. qsParams iQueryParams
164167
165- inspectPlan :: AppConfig -> ApiRequest -> Either Error InspectPlan
166- inspectPlan conf apiRequest = do
167- mediaType <- mapLeft ApiRequestError $ negotiateContent conf (iAction apiRequest) (iAcceptMediaType apiRequest)
168+ inspectPlan :: ApiRequest -> Either Error InspectPlan
169+ inspectPlan apiRequest = do
170+ let producedMTs = [MTOpenAPI , MTApplicationJSON , MTAny ]
171+ accepts = iAcceptMediaType apiRequest
172+ mediaType <- if not . null $ L. intersect accepts producedMTs
173+ then Right MTOpenAPI
174+ else Left . ApiRequestError . MediaTypeError $ MediaType. toMime <$> accepts
168175 return $ InspectPlan mediaType SQL. Read
169176
170177{-|
@@ -824,52 +831,34 @@ inferColsEmbedNeeds (Node ReadPlan{select} forest) pkCols
824831addFilterToLogicForest :: CoercibleFilter -> [CoercibleLogicTree ] -> [CoercibleLogicTree ]
825832addFilterToLogicForest flt lf = CoercibleStmnt flt : lf
826833
827- mediaToAggregate :: MediaType -> ApiRequest -> ResultAggregate
828- mediaToAggregate mt apiReq@ ApiRequest {iAction= act, iPreferences= Preferences {preferRepresentation= rep}} =
829- if noAgg then NoAgg
830- else case mt of
831- MTApplicationJSON -> BuiltinAggJson
832- MTSingularJSON strip -> BuiltinAggSingleJson strip
833- MTArrayJSONStrip -> BuiltinAggArrayJsonStrip
834- MTGeoJSON -> BuiltinAggGeoJson
835- MTTextCSV -> BuiltinAggCsv
836- MTAny -> BuiltinAggJson
837- MTOpenAPI -> BuiltinAggJson
838- MTUrlEncoded -> NoAgg -- TODO: unreachable since a previous step (producedMediaTypes) whitelists the media types that can become aggregates.
839-
840- -- Doing `Accept: application/vnd.pgrst.plan; for="application/vnd.pgrst.plan"` doesn't make sense, so we just empty the body.
841- -- TODO: fail instead to be more strict
842- MTPlan (MTPlan {}) _ _ -> NoAgg
843- MTPlan media _ _ -> mediaToAggregate media apiReq
844- _ -> NoAgg
845- where
846- noAgg = case act of
847- ActionMutate _ -> rep == Just HeadersOnly || rep == Just None || isNothing rep
848- ActionRead _isHead -> _isHead -- no need for an aggregate on HEAD https://github.com/PostgREST/postgrest/issues/2849
849- ActionInvoke invMethod -> invMethod == InvHead
850- _ -> False
851-
852834-- | Do content negotiation. i.e. choose a media type based on the intersection of accepted/produced media types.
853- negotiateContent :: AppConfig -> Action -> [MediaType ] -> Either ApiRequestError MediaType
854- negotiateContent conf action accepts =
855- case firstAcceptedPick of
856- Just MTAny -> Right MTApplicationJSON -- by default(for */*) we respond with json
857- Just mt -> Right
858- Nothing -> Left . MediaTypeError $ map MediaType. toMime accepts
835+ negotiateContent :: AppConfig -> ApiRequest -> QualifiedIdentifier -> [MediaType ] ->
836+ HM. HashMapRelIdentifier , MediaType ) MediaHandler -> Either ApiRequestError (MediaHandler , MediaType )
837+ negotiateContent conf ApiRequest {iAction= act, iPreferences= Preferences {preferRepresentation= rep}} identifier accepts produces =
838+ mtAnyToJSON $ case (act, firstAcceptedPick) of
839+ (_, Nothing ) -> Left . MediaTypeError $ map MediaType. toMime accepts
840+ (ActionMutate _, Just (x, mt)) -> Right if rep == Just Full then x else NoAgg , mt)
841+ -- no need for an aggregate on HEAD https://github.com/PostgREST/postgrest/issues/2849
842+ -- TODO: despite no aggregate, these are responding with a Content-Type, which is not correct.
843+ (ActionRead True Just (_, mt)) -> Right NoAgg , mt)
844+ (ActionInvoke InvHead , Just (_, mt)) -> Right NoAgg , mt)
845+ (_, Just (x, mt)) -> Right
859846 where
847+ -- TODO initial */* is not overridable
848+ -- initial handlers in the schema cache have a */* to BuiltinAggJson but they don't preserve the media type (application/json)
849+ -- for now we just convert the resultant */* to application/json here
850+ mtAnyToJSON = mapRight (\ (x, y) -> (x, if y == MTAny then MTApplicationJSON else y))
860851 -- if there are multiple accepted media types, pick the first
861- firstAcceptedPick = listToMaybe $ L. intersect accepts $ producedMediaTypes conf action
862-
863- producedMediaTypes :: AppConfig -> Action -> [MediaType ]
864- producedMediaTypes conf action =
865- case action of
866- ActionRead _ -> defaultMediaTypes
867- ActionInvoke _ -> defaultMediaTypes
868- ActionInfo -> defaultMediaTypes
869- ActionMutate _ -> defaultMediaTypes
870- ActionInspect _ -> inspectMediaTypes
871- where
872- inspectMediaTypes = [MTOpenAPI , MTApplicationJSON , MTArrayJSONStrip , MTAny ]
873- defaultMediaTypes =
874- [MTApplicationJSON , MTArrayJSONStrip , MTSingularJSON True MTSingularJSON False MTGeoJSON , MTTextCSV ] ++
875- [MTPlan MTApplicationJSON PlanText mempty | configDbPlanEnabled conf] ++ [MTAny ]
852+ firstAcceptedPick = listToMaybe $ mapMaybe searchMT accepts
853+ lookupIdent mt = -- first search for an aggregate that applies to the particular relation, then for one that applies to anyelement
854+ HM. lookup (RelId identifier, mt) produces <|> HM. lookup (RelAnyElement , mt) produces
855+ searchMT mt = case mt of
856+ -- all the vendored media types have special handling as they have media type parameters, they cannot be overridden
857+ m@ (MTVndSingularJSON strip) -> Just (BuiltinAggSingleJson strip, m)
858+ m@ MTVndArrayJSONStrip -> Just (BuiltinAggArrayJsonStrip , m)
859+ m@ (MTVndPlan (MTVndSingularJSON strip) _ _) -> mtPlanToNothing $ Just (BuiltinAggSingleJson strip, m)
860+ m@ (MTVndPlan MTVndArrayJSONStrip _ _) -> mtPlanToNothing $ Just (BuiltinAggArrayJsonStrip , m)
861+ -- all the other media types can be overridden
862+ m@ (MTVndPlan mType _ _) -> mtPlanToNothing $ (,) <$> lookupIdent mType <*> pure m
863+ x -> (,) <$> lookupIdent x <*> pure x
864+ mtPlanToNothing x = if configDbPlanEnabled conf then x else Nothing -- don't find anything if the plan media type is not allowed
0 commit comments