ed4b1c5..master · typeable/postgresql-simple

.github/workflows/haskell-ci.yml+22−15

@@ -8,9 +8,9 @@

88#

99# For more information, see https://github.com/haskell-CI/haskell-ci

1010#

11−# version: 0.16.6

11+# version: 0.17.20231110

1212#

13−# REGENDATA ("0.16.6",["github","cabal.project"])

13+# REGENDATA ("0.17.20231110",["github","cabal.project"])

1414#

1515name: Haskell-CI

1616on:

@@ -38,14 +38,19 @@ jobs:

3838 strategy:

3939 matrix:

4040 include:

41− - compiler: ghc-9.6.2

41+ - compiler: ghc-9.8.1

4242 compilerKind: ghc

43− compilerVersion: 9.6.2

43+ compilerVersion: 9.8.1

4444 setup-method: ghcup

4545 allow-failure: false

46− - compiler: ghc-9.4.5

46+ - compiler: ghc-9.6.3

4747 compilerKind: ghc

48− compilerVersion: 9.4.5

48+ compilerVersion: 9.6.3

49+ setup-method: ghcup

50+ allow-failure: false

51+ - compiler: ghc-9.4.8

52+ compilerKind: ghc

53+ compilerVersion: 9.4.8

4954 setup-method: ghcup

5055 allow-failure: false

5156 - compiler: ghc-9.2.8

@@ -81,18 +86,18 @@ jobs:

8186 apt-get install -y --no-install-recommends gnupg ca-certificates dirmngr curl git software-properties-common libtinfo5

8287 if [ "${{ matrix.setup-method }}" = ghcup ]; then

8388 mkdir -p "$HOME/.ghcup/bin"

84− curl -sL https://downloads.haskell.org/ghcup/0.1.19.2/x86_64-linux-ghcup-0.1.19.2 > "$HOME/.ghcup/bin/ghcup"

89+ curl -sL https://downloads.haskell.org/ghcup/0.1.20.0/x86_64-linux-ghcup-0.1.20.0 > "$HOME/.ghcup/bin/ghcup"

8590 chmod a+x "$HOME/.ghcup/bin/ghcup"

8691 "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER" || (cat "$HOME"/.ghcup/logs/*.* && false)

87− "$HOME/.ghcup/bin/ghcup" install cabal 3.10.1.0 || (cat "$HOME"/.ghcup/logs/*.* && false)

92+ "$HOME/.ghcup/bin/ghcup" install cabal 3.10.2.0 || (cat "$HOME"/.ghcup/logs/*.* && false)

8893 else

8994 apt-add-repository -y 'ppa:hvr/ghc'

9095 apt-get update

9196 apt-get install -y "$HCNAME"

9297 mkdir -p "$HOME/.ghcup/bin"

93− curl -sL https://downloads.haskell.org/ghcup/0.1.19.2/x86_64-linux-ghcup-0.1.19.2 > "$HOME/.ghcup/bin/ghcup"

98+ curl -sL https://downloads.haskell.org/ghcup/0.1.20.0/x86_64-linux-ghcup-0.1.20.0 > "$HOME/.ghcup/bin/ghcup"

9499 chmod a+x "$HOME/.ghcup/bin/ghcup"

95− "$HOME/.ghcup/bin/ghcup" install cabal 3.10.1.0 || (cat "$HOME"/.ghcup/logs/*.* && false)

100+ "$HOME/.ghcup/bin/ghcup" install cabal 3.10.2.0 || (cat "$HOME"/.ghcup/logs/*.* && false)

96101 fi

97102 env:

98103 HCKIND: ${{ matrix.compilerKind }}

@@ -106,17 +111,19 @@ jobs:

106111 echo "CABAL_CONFIG=$HOME/.cabal/config" >> "$GITHUB_ENV"

107112 HCDIR=/opt/$HCKIND/$HCVER

108113 if [ "${{ matrix.setup-method }}" = ghcup ]; then

109− HC=$HOME/.ghcup/bin/$HCKIND-$HCVER

114+ HC=$("$HOME/.ghcup/bin/ghcup" whereis ghc "$HCVER")

115+ HCPKG=$(echo "$HC" | sed 's#ghc$#ghc-pkg#')

116+ HADDOCK=$(echo "$HC" | sed 's#ghc$#haddock#')

110117 echo "HC=$HC" >> "$GITHUB_ENV"

111− echo "HCPKG=$HOME/.ghcup/bin/$HCKIND-pkg-$HCVER" >> "$GITHUB_ENV"

112− echo "HADDOCK=$HOME/.ghcup/bin/haddock-$HCVER" >> "$GITHUB_ENV"

113− echo "CABAL=$HOME/.ghcup/bin/cabal-3.10.1.0 -vnormal+nowrap" >> "$GITHUB_ENV"

118+ echo "HCPKG=$HCPKG" >> "$GITHUB_ENV"

119+ echo "HADDOCK=$HADDOCK" >> "$GITHUB_ENV"

120+ echo "CABAL=$HOME/.ghcup/bin/cabal-3.10.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"

114121 else

115122 HC=$HCDIR/bin/$HCKIND

116123 echo "HC=$HC" >> "$GITHUB_ENV"

117124 echo "HCPKG=$HCDIR/bin/$HCKIND-pkg" >> "$GITHUB_ENV"

118125 echo "HADDOCK=$HCDIR/bin/haddock" >> "$GITHUB_ENV"

119− echo "CABAL=$HOME/.ghcup/bin/cabal-3.10.1.0 -vnormal+nowrap" >> "$GITHUB_ENV"

126+ echo "CABAL=$HOME/.ghcup/bin/cabal-3.10.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"

120127 fi

121128

122129 HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\d+)\.(\d+)\.(\d+)(\.(\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')

.github/workflows/simple.yml+2−2

@@ -14,7 +14,7 @@ jobs:

1414 strategy:

1515 matrix:

1616 os: [macos-latest, windows-latest]

17− ghc: ['8.10','9.0','9.2','9.4.5','9.6.2']

17+ ghc: ['8.10','9.0','9.2','9.4.8','9.6.3','9.8.1']

1818 fail-fast: false

1919 timeout-minutes:

2020 60

@@ -29,7 +29,7 @@ jobs:

2929 uses: haskell/actions/setup@v2

3030 with:

3131 ghc-version: ${{ matrix.ghc }}

32− cabal-version: '3.10.1.0'

32+ cabal-version: '3.10.2.0'

3333

3434 - name: Set up PostgreSQL

3535 uses: ikalnytskyi/action-setup-postgres@v3

CHANGES.md+3

@@ -4,6 +4,9 @@

44 * Use `postgresql-libpq >=0.10.0.0`. It includes critical fixes,

55 by using `postgresql-simple >=0.7` you won't get older `postgresql-libpq`.

66 * Drop support for GHC prior 8.6

7+ * Added a class for `postgresql-simple` exceptions: `SomePostgreSqlException`.

8+ This allows to catch all `postgresql-simple` exceptions at once.

9+ (c.f. `AsyncException` in `base).

710

811### Version 0.6.5.1 (2023-07-09)

912

postgresql-simple.cabal+19−16

@@ -1,6 +1,7 @@

11cabal-version: 1.12

22name: postgresql-simple

33version: 0.7.0.0

4+x-revision: 1

45synopsis: Mid-Level PostgreSQL client library

56description:

67 Mid-Level PostgreSQL client library, forked from mysql-simple.

@@ -28,8 +29,9 @@ tested-with:

2829 || ==8.10.7

2930 || ==9.0.2

3031 || ==9.2.8

31− || ==9.4.5

32− || ==9.6.2

32+ || ==9.4.8

33+ || ==9.6.3

34+ || ==9.8.1

3335

3436library

3537 default-language: Haskell2010

@@ -75,25 +77,25 @@ library

7577

7678 -- GHC bundled libs

7779 build-depends:

78− base >=4.12.0.0 && <4.19

79− , bytestring >=0.10.8.2 && <0.12

80+ base >=4.12.0.0 && <4.20

81+ , bytestring >=0.10.8.2 && <0.13

8082 , containers >=0.6.0.1 && <0.7

81− , template-haskell >=2.14.0.0 && <2.21

82− , text >=1.2.3.0 && <1.3 || >=2.0 && <2.1

83+ , template-haskell >=2.14.0.0 && <2.22

84+ , text >=1.2.3.0 && <1.3 || >=2.0 && <2.2

8385 , time-compat >=1.9.5 && <1.12

8486 , transformers >=0.5.6.2 && <0.7

8587

8688 -- Other dependencies

8789 build-depends:

88− aeson >=1.4.1.0 && <1.6 || >=2.0.0.0 && <2.3

89− , attoparsec >=0.13.2.2 && <0.15

90− , case-insensitive >=1.2.0.11 && <1.3

91− , hashable >=1.2.7.0 && <1.5

92− , Only >=0.1 && <0.1.1

93− , postgresql-libpq >=0.10.0.0 && <0.11

94− , scientific >=0.3.6.2 && <0.4

95− , uuid-types >=1.0.3 && <1.1

96− , vector >=0.12.0.1 && <0.14

90+ aeson >=2.1.2.1 && <2.3

91+ , attoparsec >=0.14.4 && <0.15

92+ , case-insensitive >=1.2.1.0 && <1.3

93+ , hashable >=1.4.3.0 && <1.5

94+ , Only >=0.1 && <0.1.1

95+ , postgresql-libpq >=0.10.0.0 && <0.11

96+ , scientific >=0.3.7.0 && <0.4

97+ , uuid-types >=1.0.5 && <1.1

98+ , vector >=0.13.0.0 && <0.14

9799

98100 default-extensions:

99101 BangPatterns

@@ -128,10 +130,11 @@ test-suite test

128130 main-is: Main.hs

129131 other-modules:

130132 Common

133+ Exception

134+ Interval

131135 Notify

132136 Serializable

133137 Time

134− Interval

135138

136139 ghc-options: -threaded

137140 ghc-options: -Wall -fno-warn-name-shadowing -fno-warn-unused-do-bind

src/Database/PostgreSQL/Simple.hs+1

@@ -64,6 +64,7 @@ module Database.PostgreSQL.Simple

6464 , Only(..)

6565 , (:.)(..)

6666 -- ** Exceptions

67+ , SomePostgreSqlException(..)

6768 , SqlError(..)

6869 , PQ.ExecStatus(..)

6970 , FormatError(..)

src/Database/PostgreSQL/Simple/Errors.hs+3−1

@@ -59,7 +59,9 @@ data ConstraintViolation

5959 deriving (Show, Eq, Ord, Typeable)

6060

6161-- Default instance should be enough

62−instance Exception ConstraintViolation

62+instance Exception ConstraintViolation where

63+ toException = postgresqlExceptionToException

64+ fromException = postgresqlExceptionFromException

6365

6466

6567-- | Tries to convert 'SqlError' to 'ConstrainViolation', checks sqlState and

src/Database/PostgreSQL/Simple/FromField.hs+4−6

@@ -118,7 +118,7 @@ module Database.PostgreSQL.Simple.FromField

118118

119119import Control.Applicative ( Const(Const), (<|>), (<$>), pure, (*>), (<*) )

120120import Control.Concurrent.MVar (MVar, newMVar)

121−import Control.Exception (Exception)

121+import Control.Exception (Exception (toException, fromException))

122122import qualified Data.Aeson as JSON

123123import Data.Attoparsec.ByteString.Char8 hiding (Result)

124124import Data.ByteString (ByteString)

@@ -154,11 +154,7 @@ import qualified Data.UUID.Types as UUID

154154import Data.Scientific (Scientific)

155155import GHC.Real (infinity, notANumber)

156156

157−#if MIN_VERSION_aeson(2,1,2)

158157import qualified Data.Aeson.Types as JSON

159−#else

160−import qualified Data.Aeson.Internal as JSON

161−#endif

162158

163159-- | Exception thrown if conversion from a SQL value to a Haskell

164160-- value fails.

@@ -186,7 +182,9 @@ data ResultError = Incompatible { errSQLType :: String

186182 -- between metadata and actual data in a row).

187183 deriving (Eq, Show, Typeable)

188184

189−instance Exception ResultError

185+instance Exception ResultError where

186+ toException = postgresqlExceptionToException

187+ fromException = postgresqlExceptionFromException

190188

191189left :: Exception a => a -> Conversion b

192190left = conversionError

src/Database/PostgreSQL/Simple/Internal.hs+31−3

@@ -1,6 +1,8 @@

11{-# LANGUAGE CPP, BangPatterns, DoAndIfThenElse, RecordWildCards #-}

22{-# LANGUAGE DeriveDataTypeable, DeriveGeneric #-}

33{-# LANGUAGE GeneralizedNewtypeDeriving #-}

4+{-# LANGUAGE ExistentialQuantification #-}

5+{-# LANGUAGE InstanceSigs #-}

46

57------------------------------------------------------------------------------

68-- |

@@ -81,6 +83,25 @@ data Connection = Connection {

8183instance Eq Connection where

8284 x == y = connectionHandle x == connectionHandle y

8385

86+-- | Superclass for postgresql exceptions

87+data SomePostgreSqlException = forall e. Exception e => SomePostgreSqlException e

88+ deriving Typeable

89+

90+postgresqlExceptionToException :: Exception e => e -> SomeException

91+postgresqlExceptionToException = toException . SomePostgreSqlException

92+

93+postgresqlExceptionFromException :: Exception e => SomeException -> Maybe e

94+postgresqlExceptionFromException x = do

95+ SomePostgreSqlException a <- fromException x

96+ cast a

97+

98+instance Show SomePostgreSqlException where

99+ showsPrec :: Int -> SomePostgreSqlException -> ShowS

100+ showsPrec p (SomePostgreSqlException e) = showsPrec p e

101+

102+instance Exception SomePostgreSqlException where

103+ displayException (SomePostgreSqlException e) = displayException e

104+

84105data SqlError = SqlError {

85106 sqlState :: ByteString

86107 , sqlExecStatus :: ExecStatus

@@ -92,7 +113,10 @@ data SqlError = SqlError {

92113fatalError :: ByteString -> SqlError

93114fatalError msg = SqlError "" FatalError msg "" ""

94115

95−instance Exception SqlError

116+instance Exception SqlError where

117+ toException = postgresqlExceptionToException

118+ fromException = postgresqlExceptionFromException

119+

96120

97121-- | Exception thrown if 'query' is used to perform an @INSERT@-like

98122-- operation, or 'execute' is used to perform a @SELECT@-like operation.

@@ -101,7 +125,9 @@ data QueryError = QueryError {

101125 , qeQuery :: Query

102126 } deriving (Eq, Show, Typeable)

103127

104−instance Exception QueryError

128+instance Exception QueryError where

129+ toException = postgresqlExceptionToException

130+ fromException = postgresqlExceptionFromException

105131

106132-- | Exception thrown if a 'Query' could not be formatted correctly.

107133-- This may occur if the number of \'@?@\' characters in the query

@@ -112,7 +138,9 @@ data FormatError = FormatError {

112138 , fmtParams :: [ByteString]

113139 } deriving (Eq, Show, Typeable)

114140

115−instance Exception FormatError

141+instance Exception FormatError where

142+ toException = postgresqlExceptionToException

143+ fromException = postgresqlExceptionFromException

116144

117145data ConnectInfo = ConnectInfo {

118146 connectHost :: String

test/Exception.hsnew file+70

@@ -0,0 +1,70 @@

1+{-# LANGUAGE CPP #-}

2+{-# LANGUAGE OverloadedStrings #-}

3+{-# LANGUAGE ScopedTypeVariables #-}

4+

5+module Exception (testExceptions) where

6+

7+import Database.PostgreSQL.Simple

8+import Test.Tasty.HUnit (Assertion, assertBool)

9+import Common (TestEnv)

10+import Control.Exception (Exception (..), SomeException)

11+import Data.Maybe (isJust)

12+import Data.Either (isLeft)

13+import Control.Exception (throwIO, try)

14+

15+testExceptions :: TestEnv -> Assertion

16+testExceptions _ = do

17+ let sqlError = SqlError

18+ { sqlState = ""

19+ , sqlExecStatus = FatalError

20+ , sqlErrorMsg = ""

21+ , sqlErrorDetail = ""

22+ , sqlErrorHint = ""

23+ }

24+ let sqlEx :: SomeException = toException sqlError

25+ assertBool "SqlError is SomePostgreSqlException" $ isJust (fromException sqlEx :: Maybe SomePostgreSqlException)

26+ assertBool "SqlError is SqlError" $ isJust (fromException sqlEx :: Maybe SqlError)

27+ eSqlError :: Either SqlError () <- try $ throwIO sqlEx

28+ assertBool "Can catch SqlError" $ isLeft eSqlError

29+ eSqlPostgreSqlEx :: Either SomePostgreSqlException () <- try $ throwIO sqlEx

30+ assertBool "Can catch SomePostgreSqlException from SqlError" $ isLeft eSqlPostgreSqlEx

31+

32+ let formatError = FormatError

33+ { fmtMessage = ""

34+ , fmtQuery = ""

35+ , fmtParams = []

36+ }

37+ let formatEx :: SomeException = toException formatError

38+ assertBool "FormatError is SomePostgreSqlException" $ isJust (fromException formatEx :: Maybe SomePostgreSqlException)

39+ assertBool "FormatError is FormatError" $ isJust (fromException formatEx :: Maybe FormatError)

40+ eFormatError :: Either FormatError () <- try $ throwIO formatEx

41+ assertBool "Can catch FormatError" $ isLeft eFormatError

42+ eFormatPostreSqlEx :: Either SomePostgreSqlException () <- try $ throwIO formatEx

43+ assertBool "Can catch SomePostgreSqlException from FormatError" $ isLeft eFormatPostreSqlEx

44+

45+ let queryError = QueryError

46+ { qeMessage = ""

47+ , qeQuery = ""

48+ }

49+ let queryEx :: SomeException = toException queryError

50+ assertBool "QueryError is SomePostgreSqlException" $ isJust (fromException queryEx :: Maybe SomePostgreSqlException)

51+ assertBool "QueryError is QueryError" $ isJust (fromException queryEx :: Maybe QueryError)

52+ eQueryError :: Either QueryError () <- try $ throwIO queryEx

53+ assertBool "Can catch QueryError" $ isLeft eQueryError

54+ eQueryPostgreSqlEx :: Either SomePostgreSqlException () <- try $ throwIO queryEx

55+ assertBool "Can catch SomePostgreSqlException from QueryError" $ isLeft eQueryPostgreSqlEx

56+

57+ let resultError = Incompatible

58+ { errSQLType = ""

59+ , errSQLTableOid = Nothing

60+ , errSQLField = ""

61+ , errHaskellType = ""

62+ , errMessage = ""

63+ }

64+ let resultEx :: SomeException = toException resultError

65+ assertBool "ResultError is SomePostgreSqlException" $ isJust (fromException resultEx :: Maybe SomePostgreSqlException)

66+ assertBool "ResultError is ResultError" $ isJust (fromException resultEx :: Maybe ResultError)

67+ eResultEx :: Either ResultError () <- try $ throwIO resultEx

68+ assertBool "Can catch ResultError" $ isLeft eResultEx

69+ eResultPostgreSqlEx :: Either SomePostgreSqlException () <- try $ throwIO resultEx

70+ assertBool "Can catch SomePostgreSqlException from ResultError" $ isLeft eResultPostgreSqlEx

test/Main.hs+2

@@ -55,6 +55,7 @@ import Notify

5555import Serializable

5656import Time

5757import Interval

58+import Exception (testExceptions)

5859

5960tests :: TestEnv -> TestTree

6061tests env = testGroup "tests"

@@ -84,6 +85,7 @@ tests env = testGroup "tests"

8485 , testCase "2-ary generic" . testGeneric2

8586 , testCase "3-ary generic" . testGeneric3

8687 , testCase "Timeout" . testTimeout

88+ , testCase "Exceptions" . testExceptions

8789 ]

8890

8991testBytea :: TestEnv -> TestTree