Skip to content

Commit

Permalink
replication,cmd: improve flavor handling
Browse files Browse the repository at this point in the history
For `go-mysqlbinlog` and `go-canal`: return an error for invalid
flavors.

For `go-mysqlbinlog`: log a non-critical error if the server version has "MariaDB"
in it but the flavor isn't set to "mariadb".
  • Loading branch information
dveeden committed Nov 14, 2024
1 parent c7b7533 commit 9d2038e
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 0 deletions.
7 changes: 7 additions & 0 deletions cmd/go-canal/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (

"github.com/go-mysql-org/go-mysql/canal"
"github.com/go-mysql-org/go-mysql/mysql"
"github.com/pingcap/errors"
)

var (
Expand Down Expand Up @@ -41,6 +42,12 @@ var (
func main() {
flag.Parse()

err := mysql.ValidateFlavor(*flavor)
if err != nil {
fmt.Printf("Flavor error: %v\n", errors.ErrorStack(err))
return
}

cfg := canal.NewDefaultConfig()
cfg.Addr = net.JoinHostPort(*host, strconv.Itoa(*port))
cfg.User = *user
Expand Down
6 changes: 6 additions & 0 deletions cmd/go-mysqlbinlog/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ func main() {
MaxReconnectAttempts: 10,
}

err := mysql.ValidateFlavor(*flavor)
if err != nil {
fmt.Printf("Flavor error: %v\n", errors.ErrorStack(err))
return
}

b := replication.NewBinlogSyncer(cfg)

pos := mysql.Position{Name: *file, Pos: uint32(*pos)}
Expand Down
23 changes: 23 additions & 0 deletions mysql/mysql_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -337,3 +337,26 @@ func mysqlGTIDfromString(t *testing.T, gtidStr string) MysqlGTIDSet {

return *gtid.(*MysqlGTIDSet)
}

func TestValidateFlavor(t *testing.T) {
tbls := []struct {
flavor string
valid bool
}{
{"mysql", true},
{"mariadb", true},
{"maria", false},
{"MariaDB", true},
{"msql", false},
{"mArIAdb", true},
}

for _, f := range tbls {
err := ValidateFlavor(f.flavor)
if f.valid == true {
require.NoError(t, err)
} else {
require.Error(t, err)
}
}
}
17 changes: 17 additions & 0 deletions mysql/validate.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package mysql

import (
"fmt"
"strings"
)

func ValidateFlavor(flavor string) error {
switch strings.ToLower(flavor) {
case MySQLFlavor:
return nil
case MariaDBFlavor:
return nil
default:
return fmt.Errorf("%s is not a valid flavor", flavor)
}
}
14 changes: 14 additions & 0 deletions replication/binlogsyncer.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"net"
"os"
"strconv"
"strings"
"sync"
"time"

Expand Down Expand Up @@ -424,6 +425,15 @@ func (b *BinlogSyncer) GetNextPosition() Position {
return b.nextPos
}

func (b *BinlogSyncer) checkFlavor() {
serverVersion := b.c.GetServerVersion()
if b.cfg.Flavor != MariaDBFlavor &&
strings.Contains(b.c.GetServerVersion(), "MariaDB") {
b.cfg.Logger.Errorf("misconfigured flavor (%s) for server %s",
b.cfg.Flavor, serverVersion)
}
}

// StartSync starts syncing from the `pos` position.
func (b *BinlogSyncer) StartSync(pos Position) (*BinlogStreamer, error) {
b.cfg.Logger.Infof("begin to sync binlog from position %s", pos)
Expand All @@ -439,6 +449,8 @@ func (b *BinlogSyncer) StartSync(pos Position) (*BinlogStreamer, error) {
return nil, errors.Trace(err)
}

b.checkFlavor()

return b.startDumpStream(), nil
}

Expand Down Expand Up @@ -477,6 +489,8 @@ func (b *BinlogSyncer) StartSyncGTID(gset GTIDSet) (*BinlogStreamer, error) {
return nil, err
}

b.checkFlavor()

return b.startDumpStream(), nil
}

Expand Down

0 comments on commit 9d2038e

Please sign in to comment.