Merge branch 'master' into add-visible-field-to-schema

Author: chenhuiyeh

.github/workflows/ci.yml

@@ -10,8 +10,8 @@ jobs:
   test:
     strategy:
       matrix:
-        go: [ "1.24", "1.23", "1.22" ]
-        os: [ ubuntu-24.04, ubuntu-22.04 ]
+        go: [ "1.24", "1.23" ]
+        os: [ ubuntu-latest, ubuntu-24.04, ubuntu-22.04 ]
     name: Tests Go ${{ matrix.go }} on ${{ matrix.os }} # This name is used in main branch protection rules
     runs-on: ${{ matrix.os }}
 
@@ -56,8 +56,9 @@ jobs:
     strategy:
       matrix:
         mysql_version:
-          - 8.0.40
-          - 8.4.3
+          - 8.0.42
+          - 8.4.5
+          - 9.3.0
     name: Tests with MySQL ${{ matrix.mysql_version }}
     runs-on: ubuntu-latest
     services:
@@ -100,16 +101,19 @@ 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
 
   platforms:
     strategy:
       matrix:
-        arch: [ "amd64", "arm64" ]
+        arch: [ "amd64", "arm64", "arm" ]
         os: [ "linux", "freebsd", "darwin" ]
+        exclude:
+          - arch: "arm"
+            os: "darwin"
     name: platforms
     runs-on: ubuntu-latest
     steps:

.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))

README.md

@@ -18,6 +18,7 @@ This library has been tested or deployed on the following operating systems and
 | Linux            | amd64        | ✅                | ✅ | Check GitHub Actions of this project.                                                                                          |
 | Linux            | s390x        | ✅                | ✅ | A daily CI runs on an s390x VM, supported by the [IBM Z and LinuxONE Community](https://www.ibm.com/community/z/open-source/). |
 | Linux            | arm64        | ✅                | ❌ | Deployed in a production environment of a user.                                                                                |
+| Linux            | arm          | ✅                | ❌ | A test in CI to make sure builds for 32-bits platforms work.                                                                   |
 | FreeBSD          | amd64        | ✅                | ❌ | Sporadically tested by developers.                                                                                             |
 
 Other platforms supported by Go may also work, but they have not been verified. Feel free to report your test results.
@@ -497,15 +498,15 @@ For the old logging package `github.com/siddontang/go-log/log`, a converting pac
 ## 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/sync.go

@@ -324,13 +324,34 @@ func (c *Canal) WaitUntilPos(pos mysql.Position, timeout time.Duration) error {
 	}
 }
 
-func (c *Canal) GetMasterPos() (mysql.Position, error) {
-	showBinlogStatus := "SHOW BINARY LOG STATUS"
-	if eq, err := c.conn.CompareServerVersion("8.4.0"); (err == nil) && (eq < 0) {
-		showBinlogStatus = "SHOW MASTER STATUS"
+// getShowBinaryLogQuery returns the correct SQL statement to query binlog status
+// for the given database flavor and server version.
+//
+// Sources:
+//
+//	MySQL:   https://dev.mysql.com/doc/relnotes/mysql/8.4/en/news-8-4-0.html
+//	MariaDB: https://mariadb.com/kb/en/show-binlog-status
+func getShowBinaryLogQuery(flavor, serverVersion string) string {
+	switch flavor {
+	case mysql.MariaDBFlavor:
+		eq, err := mysql.CompareServerVersions(serverVersion, "10.5.2")
+		if (err == nil) && (eq >= 0) {
+			return "SHOW BINLOG STATUS"
+		}
+	case mysql.MySQLFlavor:
+		eq, err := mysql.CompareServerVersions(serverVersion, "8.4.0")
+		if (err == nil) && (eq >= 0) {
+			return "SHOW BINARY LOG STATUS"
+		}
 	}
 
-	rr, err := c.Execute(showBinlogStatus)
+	return "SHOW MASTER STATUS"
+}
+
+func (c *Canal) GetMasterPos() (mysql.Position, error) {
+	query := getShowBinaryLogQuery(c.cfg.Flavor, c.conn.GetServerVersion())
+
+	rr, err := c.Execute(query)
 	if err != nil {
 		return mysql.Position{}, errors.Trace(err)
 	}

canal/sync_test.go

@@ -0,0 +1,31 @@
+package canal
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestGetShowBinaryLogQuery(t *testing.T) {
+	tests := []struct {
+		flavor        string
+		serverVersion string
+		expected      string
+	}{
+		{flavor: "mariadb", serverVersion: "10.5.2", expected: "SHOW BINLOG STATUS"},
+		{flavor: "mariadb", serverVersion: "10.6.0", expected: "SHOW BINLOG STATUS"},
+		{flavor: "mariadb", serverVersion: "10.4.0", expected: "SHOW MASTER STATUS"},
+		{flavor: "mysql", serverVersion: "8.4.0", expected: "SHOW BINARY LOG STATUS"},
+		{flavor: "mysql", serverVersion: "8.4.1", expected: "SHOW BINARY LOG STATUS"},
+		{flavor: "mysql", serverVersion: "8.0.33", expected: "SHOW MASTER STATUS"},
+		{flavor: "mysql", serverVersion: "5.7.41", expected: "SHOW MASTER STATUS"},
+		{flavor: "other", serverVersion: "1.0.0", expected: "SHOW MASTER STATUS"},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.flavor+"_"+tt.serverVersion, func(t *testing.T) {
+			got := getShowBinaryLogQuery(tt.flavor, tt.serverVersion)
+			require.Equal(t, tt.expected, got)
+		})
+	}
+}

client/auth.go

@@ -222,6 +222,8 @@ func (c *Conn) writeAuthHandshake() error {
 		c.ccaps&mysql.CLIENT_COMPRESS | c.ccaps&mysql.CLIENT_ZSTD_COMPRESSION_ALGORITHM |
 		c.ccaps&mysql.CLIENT_LOCAL_FILES
 
+	capability &^= c.clientExplicitOffCaps
+
 	// To enable TLS / SSL
 	if c.tlsConfig != nil {
 		capability |= mysql.CLIENT_SSL

client/conn.go

@@ -45,6 +45,9 @@ type Conn struct {
 	capability uint32
 	// client-set capabilities only
 	ccaps uint32
+	// Capability flags explicitly disabled by the client via UnsetCapability()
+	// These flags are removed from the final advertised capability set during handshake.
+	clientExplicitOffCaps uint32
 
 	attributes map[string]string
 
@@ -152,9 +155,9 @@ func ConnectWithDialer(ctx context.Context, network, addr, user, password, dbNam
 
 	c.Conn = packet.NewConnWithTimeout(conn, c.ReadTimeout, c.WriteTimeout, c.BufferSize)
 	if c.tlsConfig != nil {
-		seq := c.Conn.Sequence
+		seq := c.Sequence
 		c.Conn = packet.NewTLSConnWithTimeout(conn, c.ReadTimeout, c.WriteTimeout)
-		c.Conn.Sequence = seq
+		c.Sequence = seq
 	}
 
 	if err = c.handshake(); err != nil {
@@ -163,9 +166,9 @@ func ConnectWithDialer(ctx context.Context, network, addr, user, password, dbNam
 	}
 
 	if c.ccaps&mysql.CLIENT_COMPRESS > 0 {
-		c.Conn.Compression = mysql.MYSQL_COMPRESS_ZLIB
+		c.Compression = mysql.MYSQL_COMPRESS_ZLIB
 	} else if c.ccaps&mysql.CLIENT_ZSTD_COMPRESSION_ALGORITHM > 0 {
-		c.Conn.Compression = mysql.MYSQL_COMPRESS_ZSTD
+		c.Compression = mysql.MYSQL_COMPRESS_ZSTD
 	}
 
 	// if a collation was set with a ID of > 255, then we need to call SET NAMES ...
@@ -234,14 +237,17 @@ func (c *Conn) Ping() error {
 	return nil
 }
 
-// SetCapability enables the use of a specific capability
+// SetCapability marks the specified flag as explicitly enabled by the client.
 func (c *Conn) SetCapability(cap uint32) {
 	c.ccaps |= cap
+	c.clientExplicitOffCaps &^= cap
 }
 
-// UnsetCapability disables the use of a specific capability
+// UnsetCapability marks the specified flag as explicitly disabled by the client.
+// This disables the flag even if the server supports it.
 func (c *Conn) UnsetCapability(cap uint32) {
-	c.ccaps &= ^cap
+	c.ccaps &^= cap
+	c.clientExplicitOffCaps |= cap
 }
 
 // HasCapability returns true if the connection has the specific capability

client/conn_test.go

@@ -119,14 +119,14 @@ func (s *connTestSuite) TestExecuteMultiple() {
 			// also, since this is not the last query, the SERVER_MORE_RESULTS_EXISTS
 			// flag should be set
 			require.True(s.T(), result.Status&mysql.SERVER_MORE_RESULTS_EXISTS > 0)
-			require.Equal(s.T(), 0, result.Resultset.RowNumber())
+			require.Equal(s.T(), 0, result.RowNumber())
 			require.Equal(s.T(), uint64(1), result.AffectedRows)
 			require.NoError(s.T(), err)
 		case 1:
 			// the SELECT query should have an resultset
 			// still not the last query, flag should be set
 			require.True(s.T(), result.Status&mysql.SERVER_MORE_RESULTS_EXISTS > 0)
-			require.Greater(s.T(), result.Resultset.RowNumber(), 0)
+			require.Greater(s.T(), result.RowNumber(), 0)
 			require.NoError(s.T(), err)
 		case 3:
 			// this query is obviously bogus so the error should be non-nil
@@ -175,7 +175,7 @@ func (s *connTestSuite) TestExecuteSelectStreaming() {
 			// result.Resultset must be defined at this point
 			require.NotNil(s.T(), result.Resultset)
 			// Check number of columns
-			require.Len(s.T(), result.Resultset.Fields, colsInResult)
+			require.Len(s.T(), result.Fields, colsInResult)
 
 			perResultCallbackCalledTimes++
 			return nil