Skip to content

Remove NextGen version handling code from mysql package #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kyleconroy merged 1 commit into from
Apr 26, 2026
Merged

Remove NextGen version handling code from mysql package #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ module github.com/sqlc-dev/marino
go 1.25

require (
github.com/coreos/go-semver v0.3.1
github.com/go-sql-driver/mysql v1.7.1
github.com/pingcap/errors v0.11.5-0.20250523034308-74f78ae071ee
github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86
Expand Down
2 changes: 0 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
github.com/coreos/go-semver v0.3.1 h1:yi21YpKnrx1gt5R+la8n5WgS0kCrsPp33dmEyHReZr4=
github.com/coreos/go-semver v0.3.1/go.mod h1:irMmmIw/7yzSRPWryHsK7EYSg09caPQL03VsM8rvUec=
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=
Expand Down
63 changes: 1 addition & 62 deletions mysql/const.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import (
"fmt"
"strings"

"github.com/coreos/go-semver/semver"
"github.com/pingcap/errors"
"github.com/sqlc-dev/marino/format"
)
Expand All @@ -33,77 +32,17 @@ const (
// one with MySQL compatibility version, with this fixed then we can parse TiDB
// version from ServerVersion.
VersionSeparator = "-TiDB-"

// tidbXReleaseVersionPrefix is used in `select tidb_version()` output of nextgen.
tidbXReleaseVersionPrefix = "CLOUD."

legacyTiDBReleaseVersionPlaceholder = "v8.4.0-this-is-a-placeholder"
// tidbXPlaceholderReleaseVersion is the default release version for nextgen when no
// release version is injected during build, such as when running in IDE.
tidbXPlaceholderReleaseVersion = "v26.3.0-this-is-a-placeholder"
// TiDBXVerMinYear is set to 2025 just for sanity check.
// our first release of next-gen since 2025
TiDBXVerMinYear = 2025
// TiDBXVerMaxYear is set to 2099 just for sanity check, we don't expect the
// year part of release version to be larger than this.
// enough for now.
TiDBXVerMaxYear = 2099
)

// Version information.
var (
// TiDBReleaseVersion is initialized by (git describe --tags) in Makefile.
TiDBReleaseVersion = legacyTiDBReleaseVersionPlaceholder
TiDBReleaseVersion = "v8.4.0-this-is-a-placeholder"

// ServerVersion is the version information of this tidb-server in MySQL's format.
ServerVersion = fmt.Sprintf("%s%s%s", mysqlCompatibilityVersion, VersionSeparator, TiDBReleaseVersion)
)

// NormalizeTiDBReleaseVersionForNextGen rewrites the legacy placeholder into a nextgen
// placeholder that follows `v[2-digit-year].[month].[fix-version]`.
// pkg/parser is Golang project, it cannot use kerneltype pkg to conditionally
// compile different code for next-gen and classic, so we have to rewrite the
// placeholder value in this function.
func NormalizeTiDBReleaseVersionForNextGen(releaseVersion string) string {
// the version is not set if we run next-gen tidb from IDE.
if releaseVersion == legacyTiDBReleaseVersionPlaceholder {
return tidbXPlaceholderReleaseVersion
}
return releaseVersion
}

// BuildTiDBXReleaseVersion converts mysql.TiDBReleaseVersion into the nextgen visible
// version format `CLOUD.<4-digit-year-2-digit-month>.<fix-version><optional-pre-release>`.
func BuildTiDBXReleaseVersion(releaseVersion string) (string, error) {
if !strings.HasPrefix(releaseVersion, "v") {
return "", errors.Errorf("invalid TiDB release version %q, should start with 'v'", releaseVersion)
}
rawVer := strings.TrimPrefix(releaseVersion, "v")
ver, err := semver.NewVersion(rawVer)
if err != nil {
return "", errors.Errorf("invalid TiDB release version %q, expect a semantic version", releaseVersion)
}
year := 2000 + ver.Major
if year < TiDBXVerMinYear || year > TiDBXVerMaxYear || ver.Minor < 1 || ver.Minor > 12 {
return "", errors.Errorf("invalid TiDB release version %q, the semantic version part should be in [2-digit-year].[month].[fix-version]-[xxx] format", releaseVersion)
}
preRelease := string(ver.PreRelease)
if preRelease != "" {
preRelease = "-" + preRelease
}
return fmt.Sprintf("%s%d%02d.%d%s", tidbXReleaseVersionPrefix, year, ver.Minor, ver.Patch, preRelease), nil
}

// BuildTiDBXServerVersion converts mysql.TiDBReleaseVersion into MySQL server version
// format `8.0.11-TiDB-CLOUD.<4-digit-year-2-digit-month>.<fix-version>`.
func BuildTiDBXServerVersion(releaseVersion string) (string, error) {
tidbXReleaseVersion, err := BuildTiDBXReleaseVersion(releaseVersion)
if err != nil {
return "", err
}
return fmt.Sprintf("%s%s%s", mysqlCompatibilityVersion, VersionSeparator, tidbXReleaseVersion), nil
}

// Header information.
const (
OKHeader byte = 0x00
Expand Down
54 changes: 1 addition & 53 deletions mysql/const_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@
package mysql

import (
"testing"

"reflect"
"strings"
"testing"
)

func TestSQLMode(t *testing.T) {
Expand Down Expand Up @@ -104,53 +102,3 @@ func TestVersionSeparator(t *testing.T) {
t.Fatalf("got %v, want %v", VersionSeparator, "-TiDB-")
}
}

func TestBuildTiDBXReleaseVersion(t *testing.T) {
tidbXVersion, err := BuildTiDBXReleaseVersion("v26.3.0")
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual("CLOUD.202603.0", tidbXVersion) {
t.Fatalf("got %v, want %v", tidbXVersion, "CLOUD.202603.0")
}

tidbXVersion, err = BuildTiDBXReleaseVersion("v26.3.0-xxx")
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual("CLOUD.202603.0-xxx", tidbXVersion) {
t.Fatalf("got %v, want %v", tidbXVersion, "CLOUD.202603.0-xxx")
}

serverVersion, err := BuildTiDBXServerVersion("v26.3.0")
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual("8.0.11-TiDB-CLOUD.202603.0", serverVersion) {
t.Fatalf("got %v, want %v", serverVersion, "8.0.11-TiDB-CLOUD.202603.0")
}

serverVersion, err = BuildTiDBXServerVersion("v26.3.0-xxx")
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual("8.0.11-TiDB-CLOUD.202603.0-xxx", serverVersion) {
t.Fatalf("got %v, want %v", serverVersion, "8.0.11-TiDB-CLOUD.202603.0-xxx")
}

for _, ver := range []string{"26.1.1", "v26xxxx", "v24.1.1", "v26.0.1", "v26.13.1"} {
_, err = BuildTiDBXReleaseVersion(ver)
if err == nil || !strings.Contains(err.Error(), "invalid TiDB release version") {
t.Fatalf("expected error containing %q, got %v", "invalid TiDB release version", err)
}
}
}

func TestNormalizeTiDBReleaseVersionForNextGen(t *testing.T) {
if !reflect.DeepEqual(tidbXPlaceholderReleaseVersion, NormalizeTiDBReleaseVersionForNextGen(legacyTiDBReleaseVersionPlaceholder)) {
t.Fatalf("got %v, want %v", NormalizeTiDBReleaseVersionForNextGen(legacyTiDBReleaseVersionPlaceholder), tidbXPlaceholderReleaseVersion)
}
if !reflect.DeepEqual("v26.3.0", NormalizeTiDBReleaseVersionForNextGen("v26.3.0")) {
t.Fatalf("got %v, want %v", NormalizeTiDBReleaseVersionForNextGen("v26.3.0"), "v26.3.0")
}
}
Loading