Merge branch 'master' into 32bit_arm

Author: dveeden

.github/workflows/ci.yml

@@ -100,7 +100,7 @@ jobs:
         with:
           go-version: stable
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v7
         with:
           version: latest
           args: --timeout=3m

.golangci.yml

@@ -1,35 +1,47 @@
+version: "2"
 linters:
-  disable-all: true
+  default: none
   enable:
-    # All code is ready for:
     - errcheck
-    - gofumpt
-    - goimports
     - govet
-    - gosimple
     - ineffassign
     - misspell
     - nakedret
     - nolintlint
     - staticcheck
-    - typecheck
     - unconvert
     - unused
     - whitespace
-    # ToDo:
-    #- gocritic
-    #- golint
-linters-settings:
-  nolintlint:
-    allow-unused: false
-    require-specific: true
-
-  govet:
-    enable-all: true
-    disable:
-      - fieldalignment
-      - lostcancel
-      - shadow
-issues:
-  exclude-files:
-    - client/examples_test.go
+  settings:
+    govet:
+      disable:
+        - fieldalignment
+        - lostcancel
+        - shadow
+      enable-all: true
+    nolintlint:
+      require-specific: true
+      allow-unused: false
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - client/examples_test.go
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - gofumpt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - client/examples_test.go
+      - third_party$
+      - builtin$
+      - examples$

CHANGELOG.md

@@ -1,3 +1,42 @@
+### Tag v1.12.0 (2025-04-01)
+
+> **Note:**
+> This version changes the logging framework to [`log/slog`](https://go.dev/blog/slog). If you use a custom logger then check the [Logging section](https://github.com/go-mysql-org/go-mysql?tab=readme-ov-file#logging) of the README.
+
+* Server: Rework NewConn/defaultServer. [#1021](https://github.com/go-mysql-org/go-mysql/pull/1021) ([dveeden](https://github.com/dveeden))
+* Replication: add IsEmpty method to GTIDSet interface & implementations. [#1019](https://github.com/go-mysql-org/go-mysql/pull/1019) ([wesleywright](https://github.com/wesleywright))
+* Give `RowsEvent` a method to inspect the underlying event type.. [#1016](https://github.com/go-mysql-org/go-mysql/pull/1016) ([proton-lisandro-pin](https://github.com/proton-lisandro-pin))
+* Test: add test for TransactionPayloadEvent. [#1018](https://github.com/go-mysql-org/go-mysql/pull/1018) ([lance6716](https://github.com/lance6716))
+* CONTRIBUTING: Add note about testing locally. [#1014](https://github.com/go-mysql-org/go-mysql/pull/1014) ([dveeden](https://github.com/dveeden))
+* Replication: check hostname length. [#1013](https://github.com/go-mysql-org/go-mysql/pull/1013) ([dveeden](https://github.com/dveeden))
+* Initial contributor guide. [#1010](https://github.com/go-mysql-org/go-mysql/pull/1010) ([dveeden](https://github.com/dveeden))
+* Dump: Fix Unlick typo. [#1011](https://github.com/go-mysql-org/go-mysql/pull/1011) ([dveeden](https://github.com/dveeden))
+* Improve unit tests around `Hasresultset` and `WriteValue`. [#1006](https://github.com/go-mysql-org/go-mysql/pull/1006) ([stgarrity](https://github.com/stgarrity))
+* Replace github.com/siddontang/go-log with log/slog. [#993](https://github.com/go-mysql-org/go-mysql/pull/993) ([serprex](https://github.com/serprex))
+* Support MySQL vector type. [#1004](https://github.com/go-mysql-org/go-mysql/pull/1004) ([serprex](https://github.com/serprex))
+* Test: remove time-based checking. [#1002](https://github.com/go-mysql-org/go-mysql/pull/1002) ([lance6716](https://github.com/lance6716))
+* Replication: Add mysql::serialization based Gtid Log Event. [#990](https://github.com/go-mysql-org/go-mysql/pull/990) ([dveeden](https://github.com/dveeden))
+* Replication: Set `source_binlog_checksum` as well. [#1003](https://github.com/go-mysql-org/go-mysql/pull/1003) ([dveeden](https://github.com/dveeden))
+* Add support for MariaDB ED25519 plugin. [#998](https://github.com/go-mysql-org/go-mysql/pull/998) ([heavycrystal](https://github.com/heavycrystal))
+* Driver: context support. [#997](https://github.com/go-mysql-org/go-mysql/pull/997) ([serprex](https://github.com/serprex))
+* Use math/bits OnesCount to preallocate slices. [#995](https://github.com/go-mysql-org/go-mysql/pull/995) ([serprex](https://github.com/serprex))
+* Fix bug: context timeout inside for loop, it will case memory leak. [#999](https://github.com/go-mysql-org/go-mysql/pull/999) ([maaars](https://github.com/maaars))
+* Lint: gofumpt. [#996](https://github.com/go-mysql-org/go-mysql/pull/996) ([serprex](https://github.com/serprex))
+* Avoid utils.Now failing sometime around the year 2262. [#994](https://github.com/go-mysql-org/go-mysql/pull/994) ([serprex](https://github.com/serprex))
+* Client: Make example testable. [#987](https://github.com/go-mysql-org/go-mysql/pull/987) ([dveeden](https://github.com/dveeden))
+* CI: Update nolintlint config. [#991](https://github.com/go-mysql-org/go-mysql/pull/991) ([dveeden](https://github.com/dveeden))
+* CI: Remove Ubuntu 20.04. [#989](https://github.com/go-mysql-org/go-mysql/pull/989) ([dveeden](https://github.com/dveeden))
+* Server: Correctly handle `COM_STMT_EXECUTE` without rebind. [#984](https://github.com/go-mysql-org/go-mysql/pull/984) ([dveeden](https://github.com/dveeden))
+* README: add Platform Support section. [#981](https://github.com/go-mysql-org/go-mysql/pull/981) ([lance6716](https://github.com/lance6716))
+* Change how we import the mysql package. [#982](https://github.com/go-mysql-org/go-mysql/pull/982) ([dveeden](https://github.com/dveeden))
+* Server: Correct the check for Resultset. [#983](https://github.com/go-mysql-org/go-mysql/pull/983) ([dveeden](https://github.com/dveeden))
+* Client,mysql: Add support for Query Attributes. [#976](https://github.com/go-mysql-org/go-mysql/pull/976) ([dveeden](https://github.com/dveeden))
+* Use 4-byte UTF-8 by default. [#979](https://github.com/go-mysql-org/go-mysql/pull/979) ([dveeden](https://github.com/dveeden))
+* Client: Set `_client_version` connection attribute. [#978](https://github.com/go-mysql-org/go-mysql/pull/978) ([dveeden](https://github.com/dveeden))
+* Cleanup init functions. [#977](https://github.com/go-mysql-org/go-mysql/pull/977) ([serprex](https://github.com/serprex))
+* Server: set `CLIENT_CONNECT_ATTRS`. [#975](https://github.com/go-mysql-org/go-mysql/pull/975) ([dveeden](https://github.com/dveeden))
+* Mysql,client,driver: Add more docs/comments and update constants. [#974](https://github.com/go-mysql-org/go-mysql/pull/974) ([dveeden](https://github.com/dveeden))
+
 ## Tag v1.11.0 (2025-01-23)
 * Mysql: Fix GetInt() with negative NEWDECIMAL result. [#972](https://github.com/go-mysql-org/go-mysql/pull/972) ([dveeden](https://github.com/dveeden))
 * Client: Update docs. [#970](https://github.com/go-mysql-org/go-mysql/pull/970) ([dveeden](https://github.com/dveeden))

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# How to contribute
+
+## Your first contribution
+
+- Best to first create an issue and discuss the problem and possible solution.
+  - This isn't needed for small/obvious fixes.
+  - What is the context? e.g. what versions of go-mysql, MySQL, etc does this apply to?
+  - Do you have a simple test case? This can just be example code, it doesn't have to be a full test case.
+  - Why do you need this change?
+- Format your code with [gofumpt](https://github.com/mvdan/gofumpt) if possible. (`make fmt` does this for you)
+- Reference an issue in the PR if you have one.
+- Update the `README.md` if applicable.
+- Add tests where applicable.
+
+## Asking for help
+
+- Don't be afraid to ask for help in an issue or PR.
+
+## Testing
+
+Testing is done with GitHub actions.
+
+If you want to run test locally you can use the following flags:
+
+```
+  -db string
+  -host string
+  -pass string
+  -port string
+  -user string
+```
+
+Example:
+```
+$ cd client
+$ go test -args -db test2 -port 3307
+```
+
+Testing locally with Docker or Podman can be done like this:
+```
+podman run \
+--rm \
+--env MYSQL_ALLOW_EMPTY_PASSWORD=1 \
+--env MYSQL_ROOT_HOST='%' \
+-p3307:3306 \
+-it \
+container-registry.oracle.com/mysql/community-server:8.0 \
+--gtid-mode=ON \
+--enforce-gtid-consistency=ON
+```
+
+Substitude `podman` with `docker` if you're using docker. This uses `--rm` to remove the container when it stops. It also enabled GTID by passing options to `mysqld`.

README.md

@@ -148,7 +148,6 @@ package main
 
 import (
 	"github.com/go-mysql-org/go-mysql/canal"
-	"github.com/siddontang/go-log/log"
 )
 
 type MyEventHandler struct {
@@ -492,39 +491,22 @@ We pass all tests in https://github.com/bradfitz/go-sql-test using go-mysql driv
 
 ## Logging
 
-Logging by default is send to stdout.
-
-To disable logging completely:
-```go
-import "github.com/siddontang/go-log/log"
-...
-        nullHandler, _ := log.NewNullHandler()
-        cfg.Logger = log.NewDefault(nullHandler)
-```
-
-To write logging to any [`io.Writer`](https://pkg.go.dev/io#Writer):
-```go
-import "github.com/siddontang/go-log/log"
-...
-        w := ...
-        streamHandler, _ := log.NewStreamHandler(w)
-        cfg.Logger = log.NewDefault(streamHandler)
-```
-
-Or you can implement your own [`log.Handler`](https://pkg.go.dev/github.com/siddontang/go-log/log#Handler).
+Logging uses [log/slog](https://pkg.go.dev/log/slog) and by default is sent to standard out.
 
+For the old logging package `github.com/siddontang/go-log/log`, a converting package 
+`https://github.com/serprex/slog-siddontang` is available.
 ## How to migrate to this repo
 To change the used package in your repo it's enough to add this `replace` directive to your `go.mod`:
 ```
-replace github.com/siddontang/go-mysql => github.com/go-mysql-org/go-mysql v1.11.0
+replace github.com/siddontang/go-mysql => github.com/go-mysql-org/go-mysql v1.12.0
 ```
 
 This can be done by running this command:
 ```
-go mod edit -replace=github.com/siddontang/go-mysql=github.com/go-mysql-org/go-mysql@v1.11.0
+go mod edit -replace=github.com/siddontang/go-mysql=github.com/go-mysql-org/go-mysql@v1.12.0
 ```
 
-v1.11.0 - is the last tag in repo, feel free to choose what you want.
+v1.12.0 - is the last tag in repo, feel free to choose what you want.
 
 ## Credits
 

canal/canal.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"log/slog"
 	"net"
 	"os"
 	"regexp"
@@ -21,7 +22,6 @@ import (
 	"github.com/go-mysql-org/go-mysql/utils"
 	"github.com/pingcap/errors"
 	"github.com/pingcap/tidb/pkg/parser"
-	"github.com/siddontang/go-log/log"
 )
 
 // Canal can sync your MySQL data into everywhere, like Elasticsearch, Redis, etc...
@@ -66,8 +66,7 @@ var (
 func NewCanal(cfg *Config) (*Canal, error) {
 	c := new(Canal)
 	if cfg.Logger == nil {
-		streamHandler, _ := log.NewStreamHandler(os.Stdout)
-		cfg.Logger = log.NewDefault(streamHandler)
+		cfg.Logger = slog.Default()
 	}
 	if cfg.Dialer == nil {
 		dialer := &net.Dialer{}
@@ -243,14 +242,14 @@ func (c *Canal) run() error {
 		close(c.dumpDoneCh)
 
 		if err != nil {
-			c.cfg.Logger.Errorf("canal dump mysql err: %v", err)
+			c.cfg.Logger.Error("canal dump mysql err", slog.Any("error", err))
 			return errors.Trace(err)
 		}
 	}
 
 	if err := c.runSyncBinlog(); err != nil {
 		if errors.Cause(err) != context.Canceled {
-			c.cfg.Logger.Errorf("canal start sync binlog err: %v", err)
+			c.cfg.Logger.Error("canal start sync binlog err", slog.Any("error", err))
 			return errors.Trace(err)
 		}
 	}
@@ -259,7 +258,7 @@ func (c *Canal) run() error {
 }
 
 func (c *Canal) Close() {
-	c.cfg.Logger.Infof("closing canal")
+	c.cfg.Logger.Info("closing canal")
 	c.m.Lock()
 	defer c.m.Unlock()
 
@@ -379,7 +378,7 @@ func (c *Canal) GetTable(db string, table string) (*schema.Table, error) {
 			c.errorTablesGetTime[key] = utils.Now()
 			c.tableLock.Unlock()
 			// log error and return ErrMissingTableMeta
-			c.cfg.Logger.Errorf("canal get table meta err: %v", errors.Trace(err))
+			c.cfg.Logger.Error("canal get table meta err", slog.Any("error", errors.Trace(err)))
 			return nil, schema.ErrMissingTableMeta
 		}
 		return nil, err

canal/canal_test.go

@@ -6,7 +6,6 @@ import (
 	"time"
 
 	"github.com/pingcap/tidb/pkg/parser"
-	"github.com/siddontang/go-log/log"
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
@@ -99,7 +98,7 @@ func (s *canalTestSuite) SetupSuite() {
 
 	s.execute("SET GLOBAL binlog_format = 'ROW'")
 
-	s.c.SetEventHandler(&testEventHandler{})
+	s.c.SetEventHandler(&testEventHandler{T: s.T()})
 	go func() {
 		set, _ := mysql.ParseGTIDSet("mysql", "")
 		err = s.c.StartFromGTID(set)
@@ -126,10 +125,11 @@ func (s *canalTestSuite) execute(query string, args ...interface{}) *mysql.Resul
 
 type testEventHandler struct {
 	DummyEventHandler
+	T *testing.T
 }
 
 func (h *testEventHandler) OnRow(e *RowsEvent) error {
-	log.Infof("OnRow %s %v\n", e.Action, e.Rows)
+	h.T.Log("OnRow", e.Action, e.Rows)
 	umi, ok := e.Rows[0][4].(uint32) // 4th col is umi. mysqldump gives uint64 instead of uint32
 	if ok && (umi != umiA && umi != umiB && umi != umiC) {
 		return fmt.Errorf("invalid unsigned medium int %d", umi)

canal/config.go

@@ -2,15 +2,14 @@ package canal
 
 import (
 	"crypto/tls"
+	"log/slog"
 	"math/rand"
 	"net"
 	"os"
 	"time"
 
 	"github.com/BurntSushi/toml"
 	"github.com/pingcap/errors"
-	"github.com/siddontang/go-log/log"
-	"github.com/siddontang/go-log/loggers"
 
 	"github.com/go-mysql-org/go-mysql/client"
 	"github.com/go-mysql-org/go-mysql/mysql"
@@ -101,12 +100,13 @@ type Config struct {
 	TLSConfig *tls.Config
 
 	// Set Logger
-	Logger loggers.Advanced
+	Logger *slog.Logger
 
 	// Set Dialer
 	Dialer client.Dialer
 
-	// Set Localhost
+	// Set the hostname that is used when registering as replica. This is similar to `report_host` in MySQL.
+	// This will be truncated if it is longer than 255 characters.
 	Localhost string
 
 	// EventCacheCount is the capacity of the BinlogStreamer internal event channel.
@@ -150,8 +150,7 @@ func NewDefaultConfig() *Config {
 	c.Dump.DiscardErr = true
 	c.Dump.SkipMasterData = false
 
-	streamHandler, _ := log.NewStreamHandler(os.Stdout)
-	c.Logger = log.NewDefault(streamHandler)
+	c.Logger = slog.Default()
 
 	dialer := &net.Dialer{}
 	c.Dialer = dialer.DialContext