steve-chavez
c45e85c5a6
BREAKING CHANGE: For the cases where one to one relationships are detected, json objects will be returned instead of json arrays of length 1. If you wish to override this behavior, you can use computed relationships to return arrays again.
524 lines
19 KiB
Haskell
524 lines
19 KiB
Haskell
module Feature.Query.UpdateSpec where
|
|
|
|
import Data.Aeson.QQ
|
|
|
|
import Network.Wai (Application)
|
|
import Test.Hspec hiding (pendingWith)
|
|
|
|
import Network.HTTP.Types
|
|
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 = do
|
|
describe "Patching record" $ do
|
|
context "to unknown uri" $
|
|
it "indicates no table found by returning 404" $
|
|
request methodPatch "/fake" []
|
|
[json| { "real": false } |]
|
|
`shouldRespondWith` 404
|
|
|
|
context "on an empty table" $
|
|
it "indicates no records found to update by returning 404" $
|
|
request methodPatch "/empty_table" []
|
|
[json| { "extra":20 } |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 404,
|
|
matchHeaders = [matchHeaderAbsent hContentType]
|
|
}
|
|
|
|
context "with invalid json payload" $
|
|
it "fails with 400 and error" $
|
|
request methodPatch "/simple_pk" [] "}{ x = 2"
|
|
`shouldRespondWith`
|
|
[json|{"message":"Error in $: Failed reading: not a valid json value at '}{x=2'","code":"PGRST102","details":null,"hint":null}|]
|
|
{ matchStatus = 400,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
context "with no payload" $
|
|
it "fails with 400 and error" $
|
|
request methodPatch "/items" [] ""
|
|
`shouldRespondWith`
|
|
[json|{"message":"Error in $: not enough input","code":"PGRST102","details":null,"hint":null}|]
|
|
{ matchStatus = 400,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
context "in a nonempty table" $ do
|
|
it "can update a single item" $ do
|
|
patch "/items?id=eq.2"
|
|
[json| { "id":42 } |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "0-0/*" ]
|
|
}
|
|
|
|
it "returns empty array when no rows updated and return=rep" $
|
|
request methodPatch "/items?id=eq.999999"
|
|
[("Prefer", "return=representation")] [json| { "id":999999 } |]
|
|
`shouldRespondWith` "[]"
|
|
{
|
|
matchStatus = 404,
|
|
matchHeaders = []
|
|
}
|
|
|
|
it "gives a 404 when no rows updated" $
|
|
request methodPatch "/items?id=eq.99999999" []
|
|
[json| { "id": 42 } |]
|
|
`shouldRespondWith` 404
|
|
|
|
it "returns updated object as array when return=rep" $
|
|
request methodPatch "/items?id=eq.2"
|
|
[("Prefer", "return=representation")] [json| { "id":2 } |]
|
|
`shouldRespondWith` [json|[{"id":2}]|]
|
|
{ matchStatus = 200,
|
|
matchHeaders = ["Content-Range" <:> "0-0/*"]
|
|
}
|
|
|
|
it "can update multiple items" $ do
|
|
get "/no_pk?select=a&b=eq.1"
|
|
`shouldRespondWith`
|
|
[json|[]|]
|
|
|
|
request methodPatch "/no_pk?b=eq.0"
|
|
[("Prefer", "tx=commit")]
|
|
[json| { b: "1" } |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "0-1/*"
|
|
, "Preference-Applied" <:> "tx=commit" ]
|
|
}
|
|
|
|
-- check it really got updated
|
|
get "/no_pk?select=a&b=eq.1"
|
|
`shouldRespondWith`
|
|
[json|[ { a: "1" }, { a: "2" } ]|]
|
|
|
|
-- put value back for other tests
|
|
request methodPatch "/no_pk?b=eq.1"
|
|
[("Prefer", "tx=commit")]
|
|
[json| { b: "0" } |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [matchHeaderAbsent hContentType]
|
|
}
|
|
|
|
it "can set a column to NULL" $ do
|
|
request methodPatch "/no_pk?a=eq.1"
|
|
[("Prefer", "return=representation")]
|
|
[json| { b: null } |]
|
|
`shouldRespondWith`
|
|
[json| [{ a: "1", b: null }] |]
|
|
|
|
context "filtering by a computed column" $ do
|
|
it "is successful" $
|
|
request methodPatch
|
|
"/items?is_first=eq.true"
|
|
[("Prefer", "return=representation")]
|
|
[json| { id: 100 } |]
|
|
`shouldRespondWith` [json| [{ id: 100 }] |]
|
|
{ matchStatus = 200,
|
|
matchHeaders = [matchContentTypeJson, "Content-Range" <:> "0-0/*"]
|
|
}
|
|
|
|
it "indicates no records updated by returning 404" $
|
|
request methodPatch
|
|
"/items?always_true=eq.false"
|
|
[("Prefer", "return=representation")]
|
|
[json| { id: 100 } |]
|
|
`shouldRespondWith` "[]"
|
|
{ matchStatus = 404,
|
|
matchHeaders = []
|
|
}
|
|
|
|
context "with representation requested" $ do
|
|
it "can provide a representation" $ do
|
|
_ <- post "/items"
|
|
[json| { id: 1 } |]
|
|
request methodPatch
|
|
"/items?id=eq.1"
|
|
[("Prefer", "return=representation")]
|
|
[json| { id: 99 } |]
|
|
`shouldRespondWith` [json| [{id:99}] |]
|
|
{ matchHeaders = [matchContentTypeJson] }
|
|
-- put value back for other tests
|
|
void $ request methodPatch "/items?id=eq.99" [] [json| { "id":1 } |]
|
|
|
|
it "can return computed columns" $
|
|
request methodPatch
|
|
"/items?id=eq.1&select=id,always_true"
|
|
[("Prefer", "return=representation")]
|
|
[json| { id: 1 } |]
|
|
`shouldRespondWith` [json| [{ id: 1, always_true: true }] |]
|
|
{ matchHeaders = [matchContentTypeJson] }
|
|
|
|
it "can select overloaded computed columns" $ do
|
|
request methodPatch
|
|
"/items?id=eq.1&select=id,computed_overload"
|
|
[("Prefer", "return=representation")]
|
|
[json| { id: 1 } |]
|
|
`shouldRespondWith` [json| [{ id: 1, computed_overload: true }] |]
|
|
{ matchHeaders = [matchContentTypeJson] }
|
|
request methodPatch
|
|
"/items2?id=eq.1&select=id,computed_overload"
|
|
[("Prefer", "return=representation")]
|
|
[json| { id: 1 } |]
|
|
`shouldRespondWith` [json| [{ id: 1, computed_overload: true }] |]
|
|
{ matchHeaders = [matchContentTypeJson] }
|
|
|
|
it "ignores ?select= when return not set or return=minimal" $ do
|
|
request methodPatch "/items?id=eq.1&select=id"
|
|
[] [json| { id:1 } |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "0-0/*" ]
|
|
}
|
|
request methodPatch "/items?id=eq.1&select=id"
|
|
[("Prefer", "return=minimal")]
|
|
[json| { id:1 } |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "0-0/*" ]
|
|
}
|
|
|
|
context "when patching with an empty body" $ do
|
|
it "makes no updates and returns 204 without return= and without ?select=" $ do
|
|
request methodPatch "/items"
|
|
[]
|
|
[json| {} |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "*/*" ]
|
|
}
|
|
|
|
request methodPatch "/items"
|
|
[]
|
|
[json| [] |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "*/*" ]
|
|
}
|
|
|
|
request methodPatch "/items"
|
|
[]
|
|
[json| [{}] |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "*/*" ]
|
|
}
|
|
|
|
it "makes no updates and returns 204 without return= and with ?select=" $ do
|
|
request methodPatch "/items?select=id"
|
|
[]
|
|
[json| {} |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "*/*" ]
|
|
}
|
|
|
|
request methodPatch "/items?select=id"
|
|
[]
|
|
[json| [] |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "*/*" ]
|
|
}
|
|
|
|
request methodPatch "/items?select=id"
|
|
[]
|
|
[json| [{}] |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [ matchHeaderAbsent hContentType
|
|
, "Content-Range" <:> "*/*" ]
|
|
}
|
|
|
|
it "makes no updates and returns 200 with return=rep and without ?select=" $
|
|
request methodPatch "/items" [("Prefer", "return=representation")] [json| {} |]
|
|
`shouldRespondWith` "[]"
|
|
{
|
|
matchStatus = 200,
|
|
matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
it "makes no updates and returns 200 with return=rep and with ?select=" $
|
|
request methodPatch "/items?select=id" [("Prefer", "return=representation")] [json| {} |]
|
|
`shouldRespondWith` "[]"
|
|
{
|
|
matchStatus = 200,
|
|
matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
it "makes no updates and returns 200 with return=rep and with ?select= for overloaded computed columns" $
|
|
request methodPatch "/items?select=id,computed_overload" [("Prefer", "return=representation")] [json| {} |]
|
|
`shouldRespondWith` "[]"
|
|
{
|
|
matchStatus = 200,
|
|
matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
context "with unicode values" $
|
|
it "succeeds and returns values intact" $ do
|
|
request methodPatch "/no_pk?a=eq.1"
|
|
[("Prefer", "return=representation")]
|
|
[json| { "a":"圍棋", "b":"￥" } |]
|
|
`shouldRespondWith`
|
|
[json|[ { "a":"圍棋", "b":"￥" } ]|]
|
|
|
|
context "PATCH with ?columns parameter" $ do
|
|
it "ignores json keys not included in ?columns" $ do
|
|
request methodPatch "/articles?id=eq.1&columns=body"
|
|
[("Prefer", "return=representation")]
|
|
[json| {"body": "Some real content", "smth": "here", "other": "stuff", "fake_id": 13} |]
|
|
`shouldRespondWith`
|
|
[json|[{"id": 1, "body": "Some real content", "owner": "postgrest_test_anonymous"}]|]
|
|
|
|
it "ignores json keys and gives 404 if no record updated" $
|
|
request methodPatch "/articles?id=eq.2001&columns=body" [("Prefer", "return=representation")]
|
|
[json| {"body": "Some real content", "smth": "here", "other": "stuff", "fake_id": 13} |] `shouldRespondWith` 404
|
|
|
|
context "tables with self reference foreign keys" $ do
|
|
it "embeds children after update" $
|
|
request methodPatch "/web_content?id=eq.0&select=id,name,web_content(name)"
|
|
[("Prefer", "return=representation")]
|
|
[json|{"name": "tardis-patched"}|]
|
|
`shouldRespondWith`
|
|
[json|
|
|
[ { "id": 0, "name": "tardis-patched", "web_content": [ { "name": "fezz" }, { "name": "foo" }, { "name": "bar" } ]} ]
|
|
|]
|
|
{ matchStatus = 200,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
it "embeds parent, children and grandchildren after update" $
|
|
request methodPatch "/web_content?id=eq.0&select=id,name,web_content(name,web_content(name)),parent_content:p_web_id(name)"
|
|
[("Prefer", "return=representation")]
|
|
[json|{"name": "tardis-patched-2"}|]
|
|
`shouldRespondWith`
|
|
[json| [
|
|
{
|
|
"id": 0,
|
|
"name": "tardis-patched-2",
|
|
"parent_content": { "name": "wat" },
|
|
"web_content": [
|
|
{ "name": "fezz", "web_content": [ { "name": "wut" } ] },
|
|
{ "name": "foo", "web_content": [] },
|
|
{ "name": "bar", "web_content": [] }
|
|
]
|
|
}
|
|
] |]
|
|
{ matchStatus = 200,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
it "embeds children after update without explicitly including the id in the ?select" $
|
|
request methodPatch "/web_content?id=eq.0&select=name,web_content(name)"
|
|
[("Prefer", "return=representation")]
|
|
[json|{"name": "tardis-patched"}|]
|
|
`shouldRespondWith`
|
|
[json|
|
|
[ { "name": "tardis-patched", "web_content": [ { "name": "fezz" }, { "name": "foo" }, { "name": "bar" } ]} ]
|
|
|]
|
|
{ matchStatus = 200,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
it "embeds an M2M relationship plus parent after update" $
|
|
request methodPatch "/users?id=eq.1&select=name,tasks(name,project:projects(name))"
|
|
[("Prefer", "return=representation")]
|
|
[json|{"name": "Kevin Malone"}|]
|
|
`shouldRespondWith`
|
|
[json|[
|
|
{
|
|
"name": "Kevin Malone",
|
|
"tasks": [
|
|
{ "name": "Design w7", "project": { "name": "Windows 7" } },
|
|
{ "name": "Code w7", "project": { "name": "Windows 7" } },
|
|
{ "name": "Design w10", "project": { "name": "Windows 10" } },
|
|
{ "name": "Code w10", "project": { "name": "Windows 10" } }
|
|
]
|
|
}
|
|
]|]
|
|
{ matchStatus = 200,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
it "embeds an O2O relationship after update" $ do
|
|
request methodPatch "/students?id=eq.1&select=name,students_info(address)"
|
|
[("Prefer", "return=representation")]
|
|
[json|{"name": "Johnny Doe"}|]
|
|
`shouldRespondWith`
|
|
[json|[
|
|
{
|
|
"name": "Johnny Doe",
|
|
"students_info":{"address":"Street 1"}
|
|
}
|
|
]|]
|
|
{ matchStatus = 200,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
request methodPatch "/students_info?id=eq.1&select=address,students(name)"
|
|
[("Prefer", "return=representation")]
|
|
[json|{"address": "New Street 1"}|]
|
|
`shouldRespondWith`
|
|
[json|[
|
|
{
|
|
"address": "New Street 1",
|
|
"students":{"name": "John Doe"}
|
|
}
|
|
]|]
|
|
{ matchStatus = 200,
|
|
matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
context "table with limited privileges" $ do
|
|
it "succeeds updating row and gives a 204 when using return=minimal" $
|
|
request methodPatch "/app_users?id=eq.1"
|
|
[("Prefer", "return=minimal")]
|
|
[json| { "password": "passxyz" } |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [matchHeaderAbsent hContentType]
|
|
}
|
|
|
|
it "can update without return=minimal and no explicit select" $
|
|
request methodPatch "/app_users?id=eq.1"
|
|
[]
|
|
[json| { "password": "passabc" } |]
|
|
`shouldRespondWith`
|
|
""
|
|
{ matchStatus = 204
|
|
, matchHeaders = [matchHeaderAbsent hContentType]
|
|
}
|
|
|
|
context "limited update" $ do
|
|
it "works with the limit query param" $
|
|
baseTable "limited_update_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodPatch "/limited_update_items?order=id&limit=2"
|
|
[json| {"name": "updated-item"} |]
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "updated-item" }
|
|
, { "id": 2, "name": "updated-item" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "works with the limit query param plus a filter" $
|
|
baseTable "limited_update_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodPatch "/limited_update_items?order=id&limit=1&id=gt.2"
|
|
[json| {"name": "updated-item"} |]
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 2, "name": "item-2" }
|
|
, { "id": 3, "name": "updated-item" }
|
|
]|]
|
|
|
|
it "works with the limit and offset query params" $
|
|
baseTable "limited_update_items" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodPatch "/limited_update_items?order=id&limit=1&offset=1"
|
|
[json| {"name": "updated-item"} |]
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 2, "name": "updated-item" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "fails without an explicit order by" $
|
|
request methodPatch "/limited_update_items?limit=1&offset=1"
|
|
[("Prefer", "tx=commit")]
|
|
[json| {"name": "updated-item"} |]
|
|
`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 methodPatch "/limited_update_items_wnonuniq_view?order=static&limit=1"
|
|
[("Prefer", "tx=commit")]
|
|
[json| {"name": "updated-item"} |]
|
|
`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_update_items_view" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodPatch "/limited_update_items_view?order=id&limit=1&offset=1"
|
|
[json| {"name": "updated-item"} |]
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 2, "name": "updated-item" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "works with views with an explicit order by composite pk" $
|
|
baseTable "limited_update_items_cpk_view" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodPatch "/limited_update_items_cpk_view?order=id,name&limit=1&offset=1"
|
|
[json| {"name": "updated-item"} |]
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "item-1" }
|
|
, { "id": 2, "name": "updated-item" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|
|
|
|
it "works on a table without a pk by ordering by 'ctid'" $
|
|
baseTable "limited_update_items_no_pk" "id" tblDataBefore
|
|
`mutatesWith`
|
|
requestMutation methodPatch "/limited_update_items_no_pk?order=ctid&limit=1"
|
|
[json| {"name": "updated-item"} |]
|
|
`shouldMutateInto`
|
|
[json|[
|
|
{ "id": 1, "name": "updated-item" }
|
|
, { "id": 2, "name": "item-2" }
|
|
, { "id": 3, "name": "item-3" }
|
|
]|]
|