276 lines
10 KiB
Haskell
276 lines
10 KiB
Haskell
module Feature.Query.DeleteSpec where
|
|
|
|
import Data.Aeson.QQ
|
|
|
|
import Network.Wai (Application)
|
|
|
|
import Network.HTTP.Types
|
|
import Test.Hspec hiding (pendingWith)
|
|
import Test.Hspec.Wai
|
|
import Test.Hspec.Wai.JSON
|
|
|
|
import Protolude hiding (get)
|
|
import SpecHelper
|
|
|
|
tblDataBefore = [aesonQQ|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 2, "name": "item-2" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
spec :: SpecWith ((), Application)
|
|
spec =
|
|
describe "Deleting" $ do
|
|
context "existing record" $ do
|
|
it "succeeds with 204 and deletion count" $
|
|
request methodDelete "/items?id=eq.1"
|
|
[]
|
|
""
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "*/*" ]
|
|
}
|
|
|
|
it "returns the deleted item and count if requested" $
|
|
request methodDelete "/items?id=eq.2" [("Prefer", "return=representation"), ("Prefer", "count=exact")] ""
|
|
`shouldRespondWith` [json|[{"id":2}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "*/1"
|
|
, "Preference-Applied" <:> "return=representation"]
|
|
}
|
|
|
|
it "ignores ?select= when return not set or return=minimal" $ do
|
|
request methodDelete "/items?id=eq.3&select=id"
|
|
[]
|
|
""
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "*/*" ]
|
|
}
|
|
request methodDelete "/items?id=eq.3&select=id"
|
|
[("Prefer", "return=minimal")]
|
|
""
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "*/*"
|
|
, "Preference-Applied" <:> "return=minimal"]
|
|
}
|
|
|
|
it "returns the deleted item and shapes the response" $
|
|
request methodDelete "/complex_items?id=eq.2&select=id,name" [("Prefer", "return=representation")] ""
|
|
`shouldRespondWith` [json|[{"id":2,"name":"Two"}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
it "can rename and cast the selected columns" $
|
|
request methodDelete "/complex_items?id=eq.3&select=ciId:id::text,ciName:name" [("Prefer", "return=representation")] ""
|
|
`shouldRespondWith` [json|[{"ciId":"3","ciName":"Three"}]|]
|
|
|
|
it "can embed (parent) entities" $
|
|
request methodDelete "/tasks?id=eq.8&select=id,name,project:projects(id)" [("Prefer", "return=representation")] ""
|
|
`shouldRespondWith` [json|[{"id":8,"name":"Code OSX","project":{"id":4}}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
it "embeds an O2O relationship after delete" $ do
|
|
request methodDelete "/students?id=eq.1&select=name,students_info(address)"
|
|
[("Prefer", "return=representation")] ""
|
|
`shouldRespondWith`
|
|
[json|[
|
|
{
|
|
"name": "John Doe",
|
|
"students_info":{"address":"Street 1"}
|
|
}
|
|
]|]
|
|
{ matchStatus = 200,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
request methodDelete "/students_info?id=eq.1&select=address,students(name)"
|
|
[("Prefer", "return=representation")] ""
|
|
`shouldRespondWith`
|
|
[json|[
|
|
{
|
|
"address": "Street 1",
|
|
"students":{"name": "John Doe"}
|
|
}
|
|
]|]
|
|
{ matchStatus = 200,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
context "known route, no records matched" $
|
|
it "includes [] body if return=rep" $
|
|
request methodDelete "/items?id=eq.101"
|
|
[("Prefer", "return=representation")] ""
|
|
`shouldRespondWith` "[]"
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
context "totally unknown route" $
|
|
it "fails with 404" $
|
|
request methodDelete "/foozle?id=eq.101" [] "" `shouldRespondWith` 404
|
|
|
|
context "table with limited privileges" $ do
|
|
it "fails deleting the row when return=representation and selecting all the columns" $
|
|
request methodDelete "/app_users?id=eq.1" [("Prefer", "return=representation")] mempty
|
|
`shouldRespondWith` 401
|
|
|
|
it "succeeds deleting the row when return=representation and selecting only the privileged columns" $
|
|
request methodDelete "/app_users?id=eq.1&select=id,email" [("Prefer", "return=representation")]
|
|
[json| { "password": "passxyz" } |]
|
|
`shouldRespondWith` [json|[ { "id": 1, "email": "test@123.com" } ]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
it "suceeds deleting the row with no explicit select when using return=minimal" $
|
|
request methodDelete "/app_users?id=eq.2"
|
|
[("Prefer", "return=minimal")]
|
|
mempty
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [matchHeaderAbsent hContentType
|
|
, "Preference-Applied" <:> "return=minimal" ]
|
|
}
|
|
|
|
it "suceeds deleting the row with no explicit select by default" $
|
|
request methodDelete "/app_users?id=eq.3"
|
|
[]
|
|
mempty
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [matchHeaderAbsent hContentType]
|
|
}
|
|
|
|
context "limited delete" $ do
|
|
it "works with the limit and offset query params" $
|
|
baseTable "limited_delete_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items?order=id&limit=1&offset=1" mempty mempty
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "works with the limit query param plus a filter" $
|
|
baseTable "limited_delete_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items?order=id&limit=1&id=gt.1" mempty mempty
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "fails without an explicit order by" $
|
|
request methodDelete "/limited_delete_items?limit=1&offset=1"
|
|
[("Prefer", "tx=commit")]
|
|
mempty
|
|
`shouldRespondWith`
|
|
[json| {
|
|
"code":"PGRST109",
|
|
"hint": "Apply an 'order' using unique column(s)",
|
|
"details": null,
|
|
"message": "A 'limit' was applied without an explicit 'order'"
|
|
}|]
|
|
{ matchStatus = 400 }
|
|
|
|
it "fails when not ordering by a unique column" $
|
|
request methodDelete "/limited_delete_items_wnonuniq_view?order=static&limit=1"
|
|
[("Prefer", "tx=commit")]
|
|
mempty
|
|
`shouldRespondWith`
|
|
[json| {
|
|
"code":"PGRST110",
|
|
"hint": null,
|
|
"details":"Results contain 3 rows changed but the maximum number allowed is 1",
|
|
"message":"The maximum number of rows allowed to change was surpassed"
|
|
}|]
|
|
{ matchStatus = 400 }
|
|
|
|
it "works with views with an explicit order by unique col" $
|
|
baseTable "limited_delete_items_view" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items_view?order=id&limit=1&offset=1" mempty mempty
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "works with views with an explicit order by composite pk" $
|
|
baseTable "limited_delete_items_cpk_view" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items_cpk_view?order=id,name&limit=1&offset=1" mempty mempty
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "works on a table without a pk by ordering by 'ctid'" $
|
|
baseTable "limited_delete_items_no_pk" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items_no_pk?order=ctid&limit=1&offset=1" mempty mempty
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "ignores the Range header" $ do
|
|
baseTable "limited_delete_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items"
|
|
(rangeHdrs (ByteRangeFromTo 0 0)) mempty
|
|
`shouldMutateInto`
|
|
[json|[]|]
|
|
|
|
baseTable "limited_delete_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items?id=gte.2"
|
|
(rangeHdrs (ByteRangeFromTo 0 0)) mempty
|
|
`shouldMutateInto`
|
|
[json|[ { "id": 1, "name": "item-1" } ]|]
|
|
|
|
it "ignores the Range header and does not do a limited delete" $
|
|
baseTable "limited_delete_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items?order=id"
|
|
(rangeHdrs (ByteRangeFromTo 0 0)) mempty
|
|
`shouldMutateInto`
|
|
[json|[]|]
|
|
|
|
it "ignores the Range header and does not throw an invalid range error" $
|
|
baseTable "limited_delete_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items?order=id&limit=1&offset=1"
|
|
(rangeHdrs (ByteRangeFromTo 0 0)) mempty
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "ignores the Range header but not the limit and offset params" $
|
|
baseTable "limited_delete_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodDelete "/limited_delete_items?order=id&limit=2&offset=1"
|
|
(rangeHdrs (ByteRangeFromTo 1 1)) mempty
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
]|]
|