Merge branch 'master' into 1829-add-monadmask-monadcatch-to-delayed-io

Author: tchoutri

.github/workflows/code-style.yaml

@@ -1,4 +1,4 @@
-name: Code style check
+name: Code style checks
 
 concurrency:
   group: formatting-${{ github.ref_name }}
@@ -13,11 +13,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 1
       - name: Install Nix
         uses: cachix/install-nix-action@v31
       - name: Check code formatting
         run: |
-          nix develop '#haskellFormatter' --command fourmolu --mode=check --check-idempotence servant servant-*
+          nix develop '#haskellFormatter' --command fourmolu --mode=check --check-idempotence servant servant-*
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 1
+      - name: Install Nix
+        uses: cachix/install-nix-action@v31
+      - name: Run hlint check
+        run: |
+          nix develop '#haskellLinter' --command hlint servant servant-*

.github/workflows/master.yml

@@ -27,7 +27,7 @@ jobs:
     strategy:
       matrix: ${{ fromJSON(needs.generate-matrix.outputs.matrix) }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - uses: haskell-actions/setup@v2
       id: setup-haskell-cabal
       name: Setup Haskell

hlint.yaml renamed to .hlint.yaml

@@ -45,15 +45,12 @@
 #
 # Generalise map to fmap, ++ to <>
 # - group: {name: generalise, enabled: true}
+#
+# Replace return with pure
+- group: {name: future, enabled: true}
 
 
 # Ignore some builtin hints
-- ignore: {name: Redundant do}
-- ignore: {name: Parse error}
-- ignore: {name: Use fmap}
-- ignore: {name: Use list comprehension}
-- ignore: {name: Use lambda-case}
-- ignore: {name: Eta reduce}
 # - ignore: {name: Use const, within: SpecialModule} # Only within certain modules
 
 

cabal.project

@@ -78,11 +78,3 @@ if(impl(ghc >= 9.6.1))
 
   package lzma
     flags: -pkgconfig
-
-if impl (ghc >= 9.10)
-  allow-newer: servant-openapi3:base
-
-if impl (ghc >= 9.12)
-  allow-newer: postgresql-simple:base
-  allow-newer: postgresql-simple:template-haskell
-  allow-newer: pipes-safe:base

changelog.d/pr-1835

@@ -0,0 +1,9 @@
+synopsis: Re-export client authentication primitives from `servant-client`
+packages: servant-client-core, servant-client
+prs: #1835
+issues: #1834
+description: {
+Add `AuthClientData`, `AuthenticatedRequest`, and `mkAuthenticatedRequest` to the `Servant.Client.Core.Reexport` module, which is re-exported within `servant-client`.
+
+This means that authenticated client requests can now be made using `servant-client` only, without an explicit dependency on `servant-client-core`.
+}

changelog.d/pr-1843

@@ -0,0 +1,7 @@
+synopsis: Set `errBody` of `defaultErrorFormatters.notFoundErrorFormatter`
+packages: servant-server
+prs: #1843
+issues: #1790
+description: {
+  Set `errBody` of `defaultErrorFormatters.notFoundErrorFormatter` to avoid an empty body.
+}

changelog.d/pr-1844

@@ -0,0 +1,7 @@
+synopsis: Add support for `OperationId`
+packages: servant, servant-client, servant-docs, servant-server, servant-swagger
+prs: #1844
+issues: N/A
+description: {
+  Add `OperationId`, which can direct code and docs generation.
+}

doc/cookbook/basic-auth/BasicAuth.lhs

@@ -71,7 +71,7 @@ api :: Proxy API
 api = Proxy
 
 server :: Server API
-server usr = return (site usr)
+server usr = pure (site usr)
 ```
 
 In order to protect our endpoint (`"mysite" :> Get '[JSON] Website`), we simply
@@ -105,10 +105,10 @@ checkBasicAuth db = BasicAuthCheck $ \basicAuthData ->
       password = decodeUtf8 (basicAuthPassword basicAuthData)
   in
   case Map.lookup username db of
-    Nothing -> return NoSuchUser
+    Nothing -> pure NoSuchUser
     Just u  -> if pass u == password
-               then return (Authorized u)
-               else return BadPassword
+               then pure (Authorized u)
+               else pure BadPassword
 ```
 
 This check simply looks up the user in the "database" and makes sure the

doc/cookbook/basic-streaming/Streaming.lhs

@@ -8,12 +8,12 @@ In other words, without streaming libraries.
 - Some basic usage doesn't require usage of streaming libraries,
   like `conduit`, `pipes`, `machines` or `streaming`.
   We have bindings for them though.
-- Similar example is bundled with each of our streaming library interop packages (see 
+- Similar example is bundled with each of our streaming library interop packages (see
 [servant-pipes](https://github.com/haskell-servant/servant/blob/master/servant-pipes/example/Main.hs),
 [servant-conduit](https://github.com/haskell-servant/servant/blob/master/servant-conduit/example/Main.hs) and
 [servant-machines](https://github.com/haskell-servant/servant/blob/master/servant-machines/example/Main.hs))
 - `SourceT` doesn't have *Prelude* with handy combinators, so we have to write
-  things ourselves. (Note to self: `mapM` and `foldM` would be handy to have). 
+  things ourselves. (Note to self: `mapM` and `foldM` would be handy to have).
 
 ## Code
 
@@ -64,19 +64,19 @@ server :: Server API
 server = fast :<|> slow :<|> readme :<|> proxy where
     fast n = liftIO $ do
         putStrLn $ "/get/" ++ show n
-        return $ fastSource n
+        pure $ fastSource n
 
     slow n = liftIO $ do
         putStrLn $ "/slow/" ++ show n
-        return $ slowSource n
+        pure $ slowSource n
 
     readme = liftIO $ do
         putStrLn "/proxy"
-        return (S.readFile "README.md")
+        pure (S.readFile "README.md")
 
     proxy c = liftIO $ do
         putStrLn "/proxy"
-        return c
+        pure c
 
     -- for some reason unfold leaks?
     fastSource = S.fromStepT . mk where
@@ -116,8 +116,8 @@ main = do
                     x <- S.unSourceT src (go (0 :: Int))
                     print x
                   where
-                    go !acc S.Stop        = return acc
-                    go !acc (S.Error err) = print err >> return acc
+                    go !acc S.Stop        = pure acc
+                    go !acc (S.Error err) = print err >> pure acc
                     go !acc (S.Skip s)    = go acc s
                     go !acc (S.Effect ms) = ms >>= go acc
                     go !acc (S.Yield _ s) = go (acc + 1) s

doc/cookbook/curl-mock/CurlMock.lhs

@@ -141,10 +141,10 @@ generateEndpoint :: Text -> Req Mocked -> IO Text
 generateEndpoint host req =
   case maybeBody of
     Just body ->
-      body >>= \b -> return $ T.intercalate " " [ "curl", "-X", method, "-d", "'" <> b <> "'"
+      body >>= \b -> pure $ T.intercalate " " [ "curl", "-X", method, "-d", "'" <> b <> "'"
                                                 , "-H 'Content-Type: application/json'", host <> "/" <> url ]
     Nothing ->
-      return $ T.intercalate " " [ "curl", "-X", method, host <> "/" <> url ]
+      pure $ T.intercalate " " [ "curl", "-X", method, host <> "/" <> url ]
   where
     method = decodeUtf8 $ req ^. reqMethod