Xavier FranciscoandSteve Chávez
1cf54e6575
* Fix #880, Clean and consolidate error responses * Fix #1285, Abort on fatal errors * Add / Detail tests
255 lines
10 KiB
Haskell
255 lines
10 KiB
Haskell
module Feature.RangeSpec where
|
|
|
|
import Test.Hspec
|
|
import Test.Hspec.Wai
|
|
import Test.Hspec.Wai.JSON
|
|
import Network.HTTP.Types
|
|
import Network.Wai.Test (SResponse(simpleHeaders,simpleStatus))
|
|
|
|
import qualified Data.ByteString.Lazy as BL
|
|
|
|
import SpecHelper
|
|
import Network.Wai (Application)
|
|
|
|
import Protolude hiding (get)
|
|
|
|
defaultRange :: BL.ByteString
|
|
defaultRange = [json| { "min": 0, "max": 15 } |]
|
|
|
|
emptyRange :: BL.ByteString
|
|
emptyRange = [json| { "min": 2, "max": 2 } |]
|
|
|
|
spec :: SpecWith Application
|
|
spec = do
|
|
describe "POST /rpc/getitemrange" $ do
|
|
context "without range headers" $ do
|
|
context "with response under server size limit" $
|
|
it "returns whole range with status 200" $
|
|
post "/rpc/getitemrange" defaultRange `shouldRespondWith` 200
|
|
|
|
context "when I don't want the count" $ do
|
|
it "returns range Content-Range with */* for empty range" $
|
|
request methodPost "/rpc/getitemrange" [] emptyRange
|
|
`shouldRespondWith` [json| [] |] {matchHeaders = ["Content-Range" <:> "*/*"]}
|
|
|
|
it "returns range Content-Range with range/*" $
|
|
request methodPost "/rpc/getitemrange" [] defaultRange
|
|
`shouldRespondWith` [json| [{"id":1},{"id":2},{"id":3},{"id":4},{"id":5},{"id":6},{"id":7},{"id":8},{"id":9},{"id":10},{"id":11},{"id":12},{"id":13},{"id":14},{"id":15}] |]
|
|
{ matchHeaders = ["Content-Range" <:> "0-14/*"] }
|
|
|
|
context "with range headers" $ do
|
|
context "of acceptable range" $ do
|
|
it "succeeds with partial content" $ do
|
|
r <- request methodPost "/rpc/getitemrange"
|
|
(rangeHdrs $ ByteRangeFromTo 0 1) defaultRange
|
|
liftIO $ do
|
|
simpleHeaders r `shouldSatisfy`
|
|
matchHeader "Content-Range" "0-1/*"
|
|
simpleStatus r `shouldBe` ok200
|
|
|
|
it "understands open-ended ranges" $
|
|
request methodPost "/rpc/getitemrange"
|
|
(rangeHdrs $ ByteRangeFrom 0) defaultRange
|
|
`shouldRespondWith` 200
|
|
|
|
it "returns an empty body when there are no results" $
|
|
request methodPost "/rpc/getitemrange"
|
|
(rangeHdrs $ ByteRangeFromTo 0 1) emptyRange
|
|
`shouldRespondWith` "[]"
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
it "allows one-item requests" $ do
|
|
r <- request methodPost "/rpc/getitemrange"
|
|
(rangeHdrs $ ByteRangeFromTo 0 0) defaultRange
|
|
liftIO $ do
|
|
simpleHeaders r `shouldSatisfy`
|
|
matchHeader "Content-Range" "0-0/*"
|
|
simpleStatus r `shouldBe` ok200
|
|
|
|
it "handles ranges beyond collection length via truncation" $ do
|
|
r <- request methodPost "/rpc/getitemrange"
|
|
(rangeHdrs $ ByteRangeFromTo 10 100) defaultRange
|
|
liftIO $ do
|
|
simpleHeaders r `shouldSatisfy`
|
|
matchHeader "Content-Range" "10-14/*"
|
|
simpleStatus r `shouldBe` ok200
|
|
|
|
context "of invalid range" $ do
|
|
it "fails with 416 for offside range" $
|
|
request methodPost "/rpc/getitemrange"
|
|
(rangeHdrs $ ByteRangeFromTo 1 0) emptyRange
|
|
`shouldRespondWith` 416
|
|
|
|
it "refuses a range with nonzero start when there are no items" $
|
|
request methodPost "/rpc/getitemrange"
|
|
(rangeHdrsWithCount $ ByteRangeFromTo 1 2) emptyRange
|
|
`shouldRespondWith` "[]"
|
|
{ matchStatus = 416
|
|
, matchHeaders = ["Content-Range" <:> "*/0"]
|
|
}
|
|
|
|
it "refuses a range requesting start past last item" $
|
|
request methodPost "/rpc/getitemrange"
|
|
(rangeHdrsWithCount $ ByteRangeFromTo 100 199) defaultRange
|
|
`shouldRespondWith` "[]"
|
|
{ matchStatus = 416
|
|
, matchHeaders = ["Content-Range" <:> "*/15"]
|
|
}
|
|
|
|
describe "GET /items" $ do
|
|
context "without range headers" $ do
|
|
context "with response under server size limit" $
|
|
it "returns whole range with status 200" $
|
|
get "/items" `shouldRespondWith` 200
|
|
|
|
context "when I don't want the count" $ do
|
|
it "returns range Content-Range with /*" $
|
|
request methodGet "/menagerie"
|
|
[("Prefer", "count=none")] ""
|
|
`shouldRespondWith` "[]"
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
it "returns range Content-Range with range/*" $
|
|
request methodGet "/items?order=id"
|
|
[("Prefer", "count=none")] ""
|
|
`shouldRespondWith` [json| [{"id":1},{"id":2},{"id":3},{"id":4},{"id":5},{"id":6},{"id":7},{"id":8},{"id":9},{"id":10},{"id":11},{"id":12},{"id":13},{"id":14},{"id":15}] |]
|
|
{ matchHeaders = ["Content-Range" <:> "0-14/*"] }
|
|
|
|
it "returns range Content-Range with range/* even using other filters" $
|
|
request methodGet "/items?id=eq.1&order=id"
|
|
[("Prefer", "count=none")] ""
|
|
`shouldRespondWith` [json| [{"id":1}] |]
|
|
{ matchHeaders = ["Content-Range" <:> "0-0/*"] }
|
|
|
|
context "with limit/offset parameters" $ do
|
|
it "no parameters return everything" $
|
|
get "/items?select=id&order=id.asc"
|
|
`shouldRespondWith`
|
|
[json|[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5},{"id":6},{"id":7},{"id":8},{"id":9},{"id":10},{"id":11},{"id":12},{"id":13},{"id":14},{"id":15}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "0-14/*"]
|
|
}
|
|
it "top level limit with parameter" $
|
|
get "/items?select=id&order=id.asc&limit=3"
|
|
`shouldRespondWith` [json|[{"id":1},{"id":2},{"id":3}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "0-2/*"]
|
|
}
|
|
it "headers override get parameters" $
|
|
request methodGet "/items?select=id&order=id.asc&limit=3"
|
|
(rangeHdrs $ ByteRangeFromTo 0 1) ""
|
|
`shouldRespondWith` [json|[{"id":1},{"id":2}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "0-1/*"]
|
|
}
|
|
|
|
it "limit works on all levels" $
|
|
get "/clients?select=id,projects(id,tasks(id))&order=id.asc&limit=1&projects.order=id.asc&projects.limit=2&projects.tasks.order=id.asc&projects.tasks.limit=1"
|
|
`shouldRespondWith`
|
|
[json|[{"id":1,"projects":[{"id":1,"tasks":[{"id":1}]},{"id":2,"tasks":[{"id":3}]}]}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "0-0/*"]
|
|
}
|
|
|
|
it "limit and offset works on first level" $
|
|
get "/items?select=id&order=id.asc&limit=3&offset=2"
|
|
`shouldRespondWith` [json|[{"id":3},{"id":4},{"id":5}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "2-4/*"]
|
|
}
|
|
|
|
it "succeeds if offset equals 0 as a no-op" $
|
|
get "/items?select=id&offset=0"
|
|
`shouldRespondWith`
|
|
[json|[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5},{"id":6},{"id":7},{"id":8},{"id":9},{"id":10},{"id":11},{"id":12},{"id":13},{"id":14},{"id":15}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "0-14/*"]
|
|
}
|
|
|
|
it "succeeds if offset is negative as a no-op" $
|
|
get "/items?select=id&offset=-4"
|
|
`shouldRespondWith`
|
|
[json|[{"id":1},{"id":2},{"id":3},{"id":4},{"id":5},{"id":6},{"id":7},{"id":8},{"id":9},{"id":10},{"id":11},{"id":12},{"id":13},{"id":14},{"id":15}]|]
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "0-14/*"]
|
|
}
|
|
|
|
it "fails if limit equals 0" $
|
|
get "/items?select=id&limit=0"
|
|
`shouldRespondWith` [json|{"message":"HTTP Range error"}|]
|
|
{ matchStatus = 416
|
|
, matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
it "fails if limit is negative" $
|
|
get "/items?select=id&limit=-1"
|
|
`shouldRespondWith` [json|{"message":"HTTP Range error"}|]
|
|
{ matchStatus = 416
|
|
, matchHeaders = [matchContentTypeJson]
|
|
}
|
|
|
|
context "with range headers" $ do
|
|
context "of acceptable range" $ do
|
|
it "succeeds with partial content" $ do
|
|
r <- request methodGet "/items"
|
|
(rangeHdrs $ ByteRangeFromTo 0 1) ""
|
|
liftIO $ do
|
|
simpleHeaders r `shouldSatisfy`
|
|
matchHeader "Content-Range" "0-1/*"
|
|
simpleStatus r `shouldBe` ok200
|
|
|
|
it "understands open-ended ranges" $
|
|
request methodGet "/items"
|
|
(rangeHdrs $ ByteRangeFrom 0) ""
|
|
`shouldRespondWith` 200
|
|
|
|
it "returns an empty body when there are no results" $
|
|
request methodGet "/menagerie"
|
|
(rangeHdrs $ ByteRangeFromTo 0 1) ""
|
|
`shouldRespondWith` "[]"
|
|
{ matchStatus = 200
|
|
, matchHeaders = ["Content-Range" <:> "*/*"]
|
|
}
|
|
|
|
it "allows one-item requests" $ do
|
|
r <- request methodGet "/items"
|
|
(rangeHdrs $ ByteRangeFromTo 0 0) ""
|
|
liftIO $ do
|
|
simpleHeaders r `shouldSatisfy`
|
|
matchHeader "Content-Range" "0-0/*"
|
|
simpleStatus r `shouldBe` ok200
|
|
|
|
it "handles ranges beyond collection length via truncation" $ do
|
|
r <- request methodGet "/items"
|
|
(rangeHdrs $ ByteRangeFromTo 10 100) ""
|
|
liftIO $ do
|
|
simpleHeaders r `shouldSatisfy`
|
|
matchHeader "Content-Range" "10-14/*"
|
|
simpleStatus r `shouldBe` ok200
|
|
|
|
context "of invalid range" $ do
|
|
it "fails with 416 for offside range" $
|
|
request methodGet "/items"
|
|
(rangeHdrs $ ByteRangeFromTo 1 0) ""
|
|
`shouldRespondWith` 416
|
|
|
|
it "refuses a range with nonzero start when there are no items" $
|
|
request methodGet "/menagerie"
|
|
(rangeHdrsWithCount $ ByteRangeFromTo 1 2) ""
|
|
`shouldRespondWith` "[]"
|
|
{ matchStatus = 416
|
|
, matchHeaders = ["Content-Range" <:> "*/0"]
|
|
}
|
|
|
|
it "refuses a range requesting start past last item" $
|
|
request methodGet "/items"
|
|
(rangeHdrsWithCount $ ByteRangeFromTo 100 199) ""
|
|
`shouldRespondWith` "[]"
|
|
{ matchStatus = 416
|
|
, matchHeaders = ["Content-Range" <:> "*/15"]
|
|
}
|