b16ed7d · haskell-servant/servant-elm

git.iko.soy/haskell-servant/servant-elm

Merge pull request #74 from cachix/feat-http-type

Allow overriding the `Http.Error` type

commitb16ed7d17399dceb5777d1de54dffe7715b52579 authorDomen Kožar <domen@dev.si> dateSun 14 Jan 2024, 23:22 (3 years ago) parent52acb31 6955f45

13 files changed+30−20

unifiedsplit

src/Servant/Elm/Internal/Generate.hs+15−5

@@ -53,17 +53,22 @@ data ElmOptions = ElmOptions

5353 argument.

5454 -}

5555 urlPrefix :: UrlPrefix

56− , elmTypeAlterations :: (EType -> EType)

56+ , elmTypeAlterations :: (EType -> EType)

5757 -- ^ Alterations to perform on ETypes before code generation.

5858 , elmAlterations :: (ETypeDef -> ETypeDef)

5959 -- ^ Alterations to perform on ETypeDefs before code generation.

60− , elmToString :: (EType -> Text)

60+ , elmToString :: (EType -> Text)

6161 -- ^ Elm functions creating a string from a given type.

6262 , emptyResponseElmTypes :: [EType]

6363 -- ^ Types that represent an empty Http response.

6464 , stringElmTypes :: [EType]

6565 -- ^ Types that represent a String.

6666 , expectJsonMethod :: Text

67+ -- ^ The function to use for JSON responses.

68+ , expectStringMethod :: Text

69+ -- ^ The function to use for string responses.

70+ , httpErrorType :: Text

71+ -- ^ The type to use for Http errors.

6772 }

6873

6974

@@ -87,6 +92,9 @@ The default options are:

8792> , stringElmTypes =

8893> [ getType (Proxy :: Proxy String)

8994> , getType (Proxy :: Proxy T.Text) ]

95+> , expectJsonMethod = "Http.expectJson"

96+> , expectStringMethod = "Http.expectString"

97+> , httpErrorType = "Http.Error"

9098> }

9199-}

92100defElmOptions :: ElmOptions

@@ -103,6 +111,8 @@ defElmOptions = ElmOptions

103111 , toElmType (Proxy :: Proxy T.Text)

104112 ]

105113 , expectJsonMethod = "Http.expectJson"

114+ , expectStringMethod = "Http.expectString"

115+ , httpErrorType = "Http.Error"

106116 }

107117

108118

@@ -311,7 +321,7 @@ mkTypeSignature opts request =

311321 toMsgType :: Maybe Doc

312322 toMsgType = do

313323 result <- fmap elmTypeRef $ request ^. F.reqReturnType

314− Just ("(Result Http.Error " <+> parens result <+> " -> msg)")

324+ Just ("(Result" <+> stext (httpErrorType opts) <+> parens result <+> "-> msg)")

315325

316326 returnType :: Maybe Doc

317327 returnType = do

@@ -503,11 +513,11 @@ mkRequest opts request =

503513 | isEmptyType opts $ (elmTypeAlterations opts) elmTypeExpr

504514 -- let elmConstructor = T.pack (renderElm elmTypeExpr)

505515 ->

506− "Http.expectString " <> line <+> indent i "(\\x -> case x of" <> line <+>

516+ stext (expectStringMethod opts) <> line <+> indent i "(\\x -> case x of" <> line <+>

507517 indent i "Err e -> toMsg (Err e)" <> line <+>

508518 indent i "Ok _ -> toMsg (Ok ()))"

509519 Just elmTypeExpr ->

510− stext (expectJsonMethod opts) <+> " toMsg" <+> renderDecoderName ((elmTypeAlterations opts) elmTypeExpr)

520+ stext (expectJsonMethod opts) <+> "toMsg" <+> renderDecoderName ((elmTypeAlterations opts) elmTypeExpr)

511521 Nothing -> error "mkHttpRequest: no reqReturnType?"

512522 -- case request ^. F.reqReturnType of

513523 -- Just elmTypeExpr | isEmptyType opts elmTypeExpr ->

test/elm-sources/getBooksByIdSource.elm+1−1

@@ -8,7 +8,7 @@ type Book = Book

88jsonDecBook : Json.Decode.Decoder Book

99jsonDecBook = Debug.todo ""

1010

11−getBooksById : Int -> (Result Http.Error (Book) -> msg) -> Cmd msg

11+getBooksById : Int -> (Result Http.Error (Book) -> msg) -> Cmd msg

1212getBooksById capture_id toMsg =

1313 let

1414 params =

test/elm-sources/getBooksByTitleSource.elm+1−1

@@ -7,7 +7,7 @@ import Json.Decode as J

77type alias Book = {}

88jsonDecBook = J.succeed {}

10−getBooksByTitlespace : String -> (Result Http.Error (Book) -> msg) -> Cmd msg

10+getBooksByTitlespace : String -> (Result Http.Error (Book) -> msg) -> Cmd msg

1111getBooksByTitlespace capture_title_space toMsg =

1212 let

1313 params =

test/elm-sources/getBooksSource.elm+1−1

@@ -9,7 +9,7 @@ type alias Book = {}

1010jsonDecBook = J.succeed {}

1111

12−getBooks : Bool -> (Maybe String) -> (Maybe Int) -> String -> (List (Maybe Bool)) -> (Result Http.Error ((List Book)) -> msg) -> Cmd msg

12+getBooks : Bool -> (Maybe String) -> (Maybe Int) -> String -> (List (Maybe Bool)) -> (Result Http.Error ((List Book)) -> msg) -> Cmd msg

1313getBooks query_published query_sort query_year query_category query_filters toMsg =

1414 let

1515 params =

test/elm-sources/getNothingSource.elm+2−2

@@ -4,7 +4,7 @@ import Http

44import Url.Builder

7−getNothing : (Result Http.Error (()) -> msg) -> Cmd msg

7+getNothing : (Result Http.Error (()) -> msg) -> Cmd msg

88getNothing toMsg =

99 let

1010 params =

@@ -25,7 +25,7 @@ getNothing toMsg =

2525 , body =

2626 Http.emptyBody

2727 , expect =

28− Http.expectString

28+ Http.expectString

2929 (\x -> case x of

3030 Err e -> toMsg (Err e)

3131 Ok _ -> toMsg (Ok ()))

test/elm-sources/getOneSource.elm+1−1

@@ -5,7 +5,7 @@ import Json.Decode exposing (..)

55import Url.Builder

8−getOne : (Result Http.Error (Int) -> msg) -> Cmd msg

8+getOne : (Result Http.Error (Int) -> msg) -> Cmd msg

99getOne toMsg =

1010 let

1111 params =

test/elm-sources/getOneWithDynamicUrlSource.elm+1−1

@@ -5,7 +5,7 @@ import Url.Builder

55import Json.Decode exposing (..)

8−getOne : String -> (Result Http.Error (Int) -> msg) -> Cmd msg

8+getOne : String -> (Result Http.Error (Int) -> msg) -> Cmd msg

99getOne urlBase toMsg =

1010 let

1111 params =

test/elm-sources/getPolymorphicData.elm+1−1

@@ -14,7 +14,7 @@ jsonDecSomeRecord : Json.Decode.Decoder SomeRecord

1414jsonDecSomeRecord = Debug.todo "finish"

1515

1616

17−getPolymorphicData : (Result Http.Error ((PolymorphicData (List String) SomeRecord)) -> msg) -> Cmd msg

17+getPolymorphicData : (Result Http.Error ((PolymorphicData (List String) SomeRecord)) -> msg) -> Cmd msg

1818getPolymorphicData toMsg =

1919 let

2020 params =

test/elm-sources/getWithaheaderSource.elm+1−1

@@ -5,7 +5,7 @@ import Url.Builder

55import Json.Decode exposing (..)

8−getWithaheader : (Maybe String) -> (Maybe Int) -> String -> Int -> (Result Http.Error (String) -> msg) -> Cmd msg

8+getWithaheader : (Maybe String) -> (Maybe Int) -> String -> Int -> (Result Http.Error (String) -> msg) -> Cmd msg

99getWithaheader header_myStringHeader header_MyIntHeader header_MyRequiredStringHeader header_MyRequiredIntHeader toMsg =

1010 let

1111 params =

test/elm-sources/getWitharesponseheaderSource.elm+1−1

@@ -5,7 +5,7 @@ import Url.Builder

55import Json.Decode exposing (..)

8−getWitharesponseheader : (Result Http.Error (String) -> msg) -> Cmd msg

8+getWitharesponseheader : (Result Http.Error (String) -> msg) -> Cmd msg

99getWitharesponseheader toMsg =

1010 let

1111 params =

test/elm-sources/postBooksSource.elm+2−2

@@ -7,7 +7,7 @@ import Json.Encode as Enc

77type alias Book = {}

88jsonEncBook = \b -> Enc.object []

10−postBooks : Book -> (Result Http.Error (()) -> msg) -> Cmd msg

10+postBooks : Book -> (Result Http.Error (()) -> msg) -> Cmd msg

1111postBooks body toMsg =

1212 let

1313 params =

@@ -28,7 +28,7 @@ postBooks body toMsg =

2828 , body =

2929 Http.jsonBody (jsonEncBook body)

3030 , expect =

31− Http.expectString

31+ Http.expectString

3232 (\x -> case x of

3333 Err e -> toMsg (Err e)

3434 Ok _ -> toMsg (Ok ()))

test/elm-sources/postTwoSource.elm+1−1

@@ -6,7 +6,7 @@ import Json.Encode

66import Url.Builder

9−postTwo : String -> (Result Http.Error ((Maybe Int)) -> msg) -> Cmd msg

9+postTwo : String -> (Result Http.Error ((Maybe Int)) -> msg) -> Cmd msg

1010postTwo body toMsg =

1111 let

1212 params =

test/elm-sources/putNothingSource.elm+2−2

@@ -4,7 +4,7 @@ import Http

44import Url.Builder

7−putNothing : (Result Http.Error (()) -> msg) -> Cmd msg

7+putNothing : (Result Http.Error (()) -> msg) -> Cmd msg

88putNothing toMsg =

99 let

1010 params =

@@ -25,7 +25,7 @@ putNothing toMsg =

2525 , body =

2626 Http.emptyBody

2727 , expect =

28− Http.expectString

28+ Http.expectString

2929 (\x -> case x of

3030 Err e -> toMsg (Err e)

3131 Ok _ -> toMsg (Ok ()))