10 Commits

Author SHA1 Message Date
jdl
0d8cc762c0 wip 2024-11-19 16:20:18 +01:00
jdl
5577f90f95 wip 2024-11-19 08:57:49 +01:00
jdl
587cd1c9b4 wip 2024-11-18 17:04:37 +01:00
jdl
3b23aeabbe wip 2024-11-18 17:01:17 +01:00
jdl
687206bb45 wip 2024-11-17 15:25:13 +01:00
jdl
5d442fa681 wip 2024-11-17 15:18:05 +01:00
jdl
84bc5e48e8 wip 2024-11-15 19:27:39 +01:00
jdl
1691e1c477 wip 2024-11-12 21:40:37 +01:00
jdl
c8582acf01 wip 2024-11-12 21:11:54 +01:00
jdl
b894b639ea wip 2024-11-12 20:57:56 +01:00
11 changed files with 302 additions and 49 deletions

22
go.mod Normal file
View File

@@ -0,0 +1,22 @@
module git.crumpington.com/lib/go
go 1.23.2
require (
github.com/lib/pq v1.10.9
github.com/mailgun/mailgun-go/v4 v4.18.5
github.com/mattn/go-sqlite3 v1.14.24
golang.org/x/crypto v0.29.0
golang.org/x/net v0.31.0
)
require (
github.com/go-chi/chi/v5 v5.0.8 // indirect
github.com/json-iterator/go v1.1.10 // indirect
github.com/mailgun/errors v0.3.0 // indirect
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 // indirect
github.com/sirupsen/logrus v1.9.0 // indirect
golang.org/x/sys v0.27.0 // indirect
golang.org/x/text v0.20.0 // indirect
)

44
go.sum Normal file
View File

@@ -0,0 +1,44 @@
github.com/ahmetb/go-linq v3.0.0+incompatible h1:qQkjjOXKrKOTy83X8OpRmnKflXKQIL/mC/gMVVDMhOA=
github.com/ahmetb/go-linq v3.0.0+incompatible/go.mod h1:PFffvbdbtw+QTB0WKRP0cNht7vnCfnGlEpak/DVg5cY=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/go-chi/chi/v5 v5.0.8 h1:lD+NLqFcAi1ovnVZpsnObHGW4xb4J8lNmoYVfECH1Y0=
github.com/go-chi/chi/v5 v5.0.8/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
github.com/json-iterator/go v1.1.10 h1:Kz6Cvnvv2wGdaG/V8yMvfkmNiXq9Ya2KUv4rouJJr68=
github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
github.com/mailgun/errors v0.3.0 h1:g8R8lodkwqk5WIVMAClyUqt0PSd5JTVgobB+H7C2sLs=
github.com/mailgun/errors v0.3.0/go.mod h1:+ltknP+jhv3gZ1StKY6ugoQECcPxDCaSdmYesqTZcLQ=
github.com/mailgun/mailgun-go/v4 v4.18.5 h1:wZnTutW/fzxNyJVBMa6O4LLGW/hO+IGfKpuqBT4nbVs=
github.com/mailgun/mailgun-go/v4 v4.18.5/go.mod h1:+d4FCswFAukgYc1XtKK2IxOYaVxjVm8AN2z/5TBiT8M=
github.com/mattn/go-sqlite3 v1.14.24 h1:tpSp2G2KyMnnQu99ngJ47EIkWVmliIizyZBfPrBWDRM=
github.com/mattn/go-sqlite3 v1.14.24/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y=
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc=
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 h1:Esafd1046DLDQ0W1YjYsBW+p8U2u7vzgW2SQVmlNazg=
github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
golang.org/x/crypto v0.29.0 h1:L5SG1JTTXupVV3n6sUqMTeWbjAyfPwoda2DLX8J8FrQ=
golang.org/x/crypto v0.29.0/go.mod h1:+F4F4N5hv6v38hfeYwTdx20oUvLLc+QfrE9Ax9HtgRg=
golang.org/x/net v0.31.0 h1:68CPQngjLL0r2AlUKiSxtQFKvzRVbnzLwMUn5SzcLHo=
golang.org/x/net v0.31.0/go.mod h1:P4fl1q7dY2hnZFxEk4pPSkDHF+QqjitcnDjUQyMM+pM=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.27.0 h1:wBqf8DvsY9Y/2P8gAfPDEYNuS30J4lPHJxXSb/nJZ+s=
golang.org/x/sys v0.27.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/text v0.20.0 h1:gK/Kv2otX8gz+wn7Rmb3vT96ZwuoxnQlY+HlJVj7Qug=
golang.org/x/text v0.20.0/go.mod h1:D4IsuqiFMhST5bX19pQ9ikHC2GsaKyk/oF+pn3ducp4=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

43
mgmailer/mailer.go Normal file
View File

@@ -0,0 +1,43 @@
package mgmailer
import (
"context"
"fmt"
"sync/atomic"
"time"
"github.com/mailgun/mailgun-go/v4"
)
type Config struct {
MailgunDomain string
MailgunAPIKey string
SenderEmail string
SenderName string
}
type Mailer struct {
conf atomic.Pointer[Config]
mg atomic.Pointer[mailgun.MailgunImpl]
}
func (m *Mailer) Update(conf Config) {
m.conf.Store(&conf)
m.mg.Store(mailgun.NewMailgun(conf.MailgunDomain, conf.MailgunAPIKey))
}
func (m *Mailer) Send(subject, body, to string) error {
mg := m.mg.Load()
conf := m.conf.Load()
message := mailgun.NewMessage(
fmt.Sprintf("%s <%s>", conf.SenderName, conf.SenderEmail),
subject,
body,
to)
ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
defer cancel()
_, _, err := mg.Send(ctx, message)
return err
}

View File

@@ -14,7 +14,7 @@ func ErrIsForeignKey(err error) bool {
return ErrHasCode(err, "23503") return ErrHasCode(err, "23503")
} }
func ErrIsSerializationFaiilure(err error) bool { func ErrIsSerializationFailure(err error) bool {
return ErrHasCode(err, "40001") return ErrHasCode(err, "40001")
} }

View File

@@ -60,7 +60,7 @@ func (r SerialTxRunner) WithTx(db *sql.DB, fn func(*sql.Tx) error) error {
if err == nil { if err == nil {
return nil return nil
} }
if timeout > r.MaxTimeout || !ErrIsSerializationFaiilure(err) { if timeout > r.MaxTimeout || !ErrIsSerializationFailure(err) {
return err return err
} }
sleepTimeout := timeout + time.Duration(rand.Int63n(int64(timeout/10))) sleepTimeout := timeout + time.Duration(rand.Int63n(int64(timeout/10)))

View File

@@ -48,27 +48,29 @@ func {{.Type}}_Insert(
func {{.Type}}_Update( func {{.Type}}_Update(
tx TX, tx TX,
row *{{.Type}}, row *{{.Type}},
) (found bool, err error) { ) (err error) {
{{.Type}}_Sanitize(row) {{.Type}}_Sanitize(row)
if err = {{.Type}}_Validate(row); err != nil { if err = {{.Type}}_Validate(row); err != nil {
return false, err return err
} }
result, err := tx.Exec("{{.UpdateQuery}}", {{.UpdateArgs}}) result, err := tx.Exec("{{.UpdateQuery}}", {{.UpdateArgs}})
if err != nil { if err != nil {
return false, err return err
} }
n, err := result.RowsAffected() n, err := result.RowsAffected()
if err != nil { if err != nil {
panic(err) panic(err)
} }
switch n {
if n > 1 { case 0:
return sql.ErrNoRows
case 1:
return nil
default:
panic("multiple rows updated") panic("multiple rows updated")
} }
return n != 0, nil
} }
{{- end}} {{- end}}
@@ -77,27 +79,29 @@ func {{.Type}}_Update(
func {{.Type}}_UpdateFull( func {{.Type}}_UpdateFull(
tx TX, tx TX,
row *{{.Type}}, row *{{.Type}},
) (found bool, err error) { ) (err error) {
{{.Type}}_Sanitize(row) {{.Type}}_Sanitize(row)
if err = {{.Type}}_Validate(row); err != nil { if err = {{.Type}}_Validate(row); err != nil {
return false, err return err
} }
result, err := tx.Exec("{{.UpdateFullQuery}}", {{.UpdateFullArgs}}) result, err := tx.Exec("{{.UpdateFullQuery}}", {{.UpdateFullArgs}})
if err != nil { if err != nil {
return false, err return err
} }
n, err := result.RowsAffected() n, err := result.RowsAffected()
if err != nil { if err != nil {
panic(err) panic(err)
} }
switch n {
if n > 1 { case 0:
return sql.ErrNoRows
case 1:
return nil
default:
panic("multiple rows updated") panic("multiple rows updated")
} }
return n != 0, nil
} }
{{- end}} {{- end}}
@@ -109,22 +113,24 @@ func {{.Type}}_UpdateFull(
func {{.Type}}_Delete( func {{.Type}}_Delete(
tx TX, tx TX,
{{.PKFunctionArgs -}} {{.PKFunctionArgs -}}
) (found bool, err error) { ) (err error) {
result, err := tx.Exec("{{.DeleteQuery}}", {{.DeleteArgs}}) result, err := tx.Exec("{{.DeleteQuery}}", {{.DeleteArgs}})
if err != nil { if err != nil {
return false, err return err
} }
n, err := result.RowsAffected() n, err := result.RowsAffected()
if err != nil { if err != nil {
panic(err) panic(err)
} }
switch n {
if n > 1 { case 0:
return sql.ErrNoRows
case 1:
return nil
default:
panic("multiple rows deleted") panic("multiple rows deleted")
} }
return n != 0, nil
} }
{{- end}} {{- end}}

View File

@@ -2,9 +2,7 @@
## Transactions ## Transactions
Simplify postgres transactions using `WithTx` for serializable transactions, Simplify transactions using `WithTx`.
or `WithTxDefault` for the default isolation level. Use the `SerialTxRunner`
type to get automatic retries of serialization errors.
## Migrations ## Migrations
@@ -20,26 +18,3 @@ func init() {
Migrate(db, migrations) // Check the error, of course. Migrate(db, migrations) // Check the error, of course.
} }
``` ```
## Testing
In order to test this packge, we need to create a test user and database:
```
sudo su postgres
psql
CREATE DATABASE test;
CREATE USER test WITH ENCRYPTED PASSWORD 'test';
GRANT ALL PRIVILEGES ON DATABASE test TO test;
use test
GRANT ALL ON SCHEMA public TO test;
```
Check that you can connect via the command line:
```
psql -h 127.0.0.1 -U test --password test
```

8
sqliteutil/errors.go Normal file
View File

@@ -0,0 +1,8 @@
package sqliteutil
import "github.com/mattn/go-sqlite3"
func ErrIsConstraint(err error) bool {
e, ok := err.(sqlite3.Error)
return ok && e.Code == 19
}

39
webutil/formscanner.go Normal file
View File

@@ -0,0 +1,39 @@
package webutil
import (
"errors"
"fmt"
"net/url"
)
var ErrUnsupportedType = errors.New("unsupported type")
type FormScanner struct {
form url.Values
err error
}
func NewFormScanner(form url.Values) *FormScanner {
return &FormScanner{form: form}
}
func (s *FormScanner) Scan(name string, val any) *FormScanner {
if s.err != nil {
return s
}
switch v := val.(type) {
case *bool:
*v = s.form.Has(name)
default:
if err := scan(s.form.Get(name), v); err != nil {
s.err = fmt.Errorf("Error in field %s: %w", name, err)
}
}
return s
}
func (s *FormScanner) Error() error {
return s.err
}

31
webutil/pathscaner.go Normal file
View File

@@ -0,0 +1,31 @@
package webutil
import (
"fmt"
"net/http"
)
type PathScanner struct {
r *http.Request
err error
}
func NewPathScanner(r *http.Request) *PathScanner {
return &PathScanner{r: r}
}
func (s *PathScanner) Scan(name string, val any) *PathScanner {
if s.err != nil {
return s
}
if err := scan(s.r.PathValue(name), val); err != nil {
s.err = fmt.Errorf("Error in field %s: %w", name, err)
}
return s
}
func (s *PathScanner) Error() error {
return s.err
}

85
webutil/scanner.go Normal file
View File

@@ -0,0 +1,85 @@
package webutil
import "strconv"
func scan(raw string, val any) error {
switch v := val.(type) {
case *string:
*v = raw
case *int:
if i, err := strconv.ParseInt(raw, 10, 64); err != nil {
return err
} else {
*v = int(i)
}
case *int8:
if i, err := strconv.ParseInt(raw, 10, 8); err != nil {
return err
} else {
*v = int8(i)
}
case *int16:
if i, err := strconv.ParseInt(raw, 10, 16); err != nil {
return err
} else {
*v = int16(i)
}
case *int32:
if i, err := strconv.ParseInt(raw, 10, 32); err != nil {
return err
} else {
*v = int32(i)
}
case *int64:
if i, err := strconv.ParseInt(raw, 10, 64); err != nil {
return err
} else {
*v = int64(i)
}
case *uint:
if i, err := strconv.ParseUint(raw, 10, 64); err != nil {
return err
} else {
*v = uint(i)
}
case *uint8:
if i, err := strconv.ParseUint(raw, 10, 8); err != nil {
return err
} else {
*v = uint8(i)
}
case *uint16:
if i, err := strconv.ParseUint(raw, 10, 16); err != nil {
return err
} else {
*v = uint16(i)
}
case *uint32:
if i, err := strconv.ParseUint(raw, 10, 32); err != nil {
return err
} else {
*v = uint32(i)
}
case *uint64:
if i, err := strconv.ParseUint(raw, 10, 64); err != nil {
return err
} else {
*v = uint64(i)
}
case *float32:
if f, err := strconv.ParseFloat(raw, 32); err != nil {
return err
} else {
*v = float32(f)
}
case *float64:
if f, err := strconv.ParseFloat(raw, 64); err != nil {
return err
} else {
*v = float64(f)
}
default:
return ErrUnsupportedType
}
return nil
}