|
| 1 | +{-| |
| 2 | +Module: Test.ControllerSupportSpec |
| 3 | +-} |
| 4 | +module Test.ControllerSupportSpec where |
| 5 | + |
| 6 | +import IHP.Prelude |
| 7 | +import Test.Hspec |
| 8 | +import IHP.ControllerSupport (requestBodyJSON) |
| 9 | +import IHP.Controller.Response (ResponseException(..)) |
| 10 | +import IHP.Environment (Environment (..)) |
| 11 | +import qualified IHP.FrameworkConfig as FrameworkConfig |
| 12 | +import qualified IHP.RequestVault as RequestVault |
| 13 | +import Wai.Request.Params.Middleware (RequestBody (..), requestBodyVaultKey) |
| 14 | +import qualified Data.Vault.Lazy as Vault |
| 15 | +import qualified Data.Aeson as Aeson |
| 16 | +import qualified Network.Wai as Wai |
| 17 | +import qualified Control.Exception as Exception |
| 18 | +import qualified Data.ByteString.Lazy as LBS |
| 19 | +import qualified Data.ByteString as BS |
| 20 | +import Network.HTTP.Types (status400) |
| 21 | +import System.IO.Unsafe (unsafePerformIO) |
| 22 | +import Data.ByteString.Builder (toLazyByteString) |
| 23 | + |
| 24 | +tests = do |
| 25 | + describe "IHP.ControllerSupport" do |
| 26 | + describe "requestBodyJSON" do |
| 27 | + it "should return parsed JSON value for valid JSONBody" do |
| 28 | + let jsonValue = Aeson.object [("name", Aeson.String "test")] |
| 29 | + let requestBody = JSONBody { jsonPayload = Just jsonValue, rawPayload = "{\"name\":\"test\"}" } |
| 30 | + request <- buildRequest requestBody Development |
| 31 | + let ?request = request |
| 32 | + result <- requestBodyJSON |
| 33 | + result `shouldBe` jsonValue |
| 34 | + |
| 35 | + it "should return 400 for FormBody" do |
| 36 | + let requestBody = FormBody { params = [], files = [], rawPayload = "" } |
| 37 | + request <- buildRequest requestBody Development |
| 38 | + let ?request = request |
| 39 | + result <- Exception.try requestBodyJSON |
| 40 | + case result of |
| 41 | + Left (ResponseException response) -> do |
| 42 | + Wai.responseStatus response `shouldBe` status400 |
| 43 | + let body = responseBody response |
| 44 | + body `shouldSatisfy` bodyContains "form content type" |
| 45 | + Right _ -> expectationFailure "Expected ResponseException" |
| 46 | + |
| 47 | + it "should return 400 for JSONBody with empty body" do |
| 48 | + let requestBody = JSONBody { jsonPayload = Nothing, rawPayload = "" } |
| 49 | + request <- buildRequest requestBody Development |
| 50 | + let ?request = request |
| 51 | + result <- Exception.try requestBodyJSON |
| 52 | + case result of |
| 53 | + Left (ResponseException response) -> do |
| 54 | + Wai.responseStatus response `shouldBe` status400 |
| 55 | + let body = responseBody response |
| 56 | + body `shouldSatisfy` bodyContains "request body is empty" |
| 57 | + Right _ -> expectationFailure "Expected ResponseException" |
| 58 | + |
| 59 | + it "should return 400 for JSONBody with invalid JSON" do |
| 60 | + let requestBody = JSONBody { jsonPayload = Nothing, rawPayload = "not valid json" } |
| 61 | + request <- buildRequest requestBody Development |
| 62 | + let ?request = request |
| 63 | + result <- Exception.try requestBodyJSON |
| 64 | + case result of |
| 65 | + Left (ResponseException response) -> do |
| 66 | + Wai.responseStatus response `shouldBe` status400 |
| 67 | + let body = responseBody response |
| 68 | + body `shouldSatisfy` bodyContains "not valid json" |
| 69 | + Right _ -> expectationFailure "Expected ResponseException" |
| 70 | + |
| 71 | + it "should truncate long payloads in dev mode" do |
| 72 | + let longPayload = LBS.pack (replicate 500 65) -- 500 bytes of 'A' |
| 73 | + let requestBody = JSONBody { jsonPayload = Nothing, rawPayload = longPayload } |
| 74 | + request <- buildRequest requestBody Development |
| 75 | + let ?request = request |
| 76 | + result <- Exception.try requestBodyJSON |
| 77 | + case result of |
| 78 | + Left (ResponseException response) -> do |
| 79 | + let body = responseBody response |
| 80 | + body `shouldSatisfy` bodyContains "truncated" |
| 81 | + body `shouldSatisfy` bodyContains "raw request body was" |
| 82 | + Right _ -> expectationFailure "Expected ResponseException" |
| 83 | + |
| 84 | + it "should omit raw payload in production mode" do |
| 85 | + let requestBody = JSONBody { jsonPayload = Nothing, rawPayload = "not valid json" } |
| 86 | + request <- buildRequest requestBody Production |
| 87 | + let ?request = request |
| 88 | + result <- Exception.try requestBodyJSON |
| 89 | + case result of |
| 90 | + Left (ResponseException response) -> do |
| 91 | + Wai.responseStatus response `shouldBe` status400 |
| 92 | + let body = responseBody response |
| 93 | + body `shouldSatisfy` (not . bodyContains "not valid json") |
| 94 | + body `shouldSatisfy` (not . bodyContains "raw request body was") |
| 95 | + Right _ -> expectationFailure "Expected ResponseException" |
| 96 | + |
| 97 | +bodyContains :: BS.ByteString -> LBS.ByteString -> Bool |
| 98 | +bodyContains needle haystack = BS.isInfixOf needle (LBS.toStrict haystack) |
| 99 | + |
| 100 | +buildRequest :: RequestBody -> Environment -> IO Wai.Request |
| 101 | +buildRequest requestBody environment = do |
| 102 | + frameworkConfig <- FrameworkConfig.buildFrameworkConfig (FrameworkConfig.option environment) |
| 103 | + pure Wai.defaultRequest |
| 104 | + { Wai.vault = Vault.insert RequestVault.frameworkConfigVaultKey frameworkConfig |
| 105 | + $ Vault.insert requestBodyVaultKey requestBody Vault.empty |
| 106 | + } |
| 107 | + |
| 108 | +-- | Extract the body from a WAI Response (works for responseLBS responses) |
| 109 | +responseBody :: Wai.Response -> LBS.ByteString |
| 110 | +responseBody response = |
| 111 | + let (_, _, withBody) = Wai.responseToStream response |
| 112 | + in unsafePerformIO $ withBody $ \streamingBody -> do |
| 113 | + ref <- newIORef mempty |
| 114 | + streamingBody |
| 115 | + (\chunk -> modifyIORef ref (<> chunk)) |
| 116 | + (pure ()) |
| 117 | + builder <- readIORef ref |
| 118 | + pure (toLazyByteString builder) |
0 commit comments