Merge pull request #3118 from dolthub/angela/timezone

Validate time zone before setting it

Author: angelamayxie

enginetest/queries/time_queries.go

@@ -54,11 +54,8 @@ var TimeQueryTests = []ScriptTest{
 				Expected: []sql.Row{{time.Date(2025, time.July, 23, 6, 43, 21, 0, time.UTC)}},
 			},
 			{
-				// https://github.com/dolthub/dolt/issues/9559
-				Skip:  true,
-				Query: "set time_zone='invalid time zone",
-				// update to actual error or error string
-				ExpectedErrStr: "Unknown of incorrect time zone: 'invalid time zone'",
+				Query:       "set time_zone='invalid time zone'",
+				ExpectedErr: sql.ErrInvalidTimeZone,
 			},
 		},
 	},

sql/errors.go

@@ -42,6 +42,9 @@ var (
 	// the execution tree.
 	ErrInvalidType = errors.NewKind("invalid type: %s")
 
+	// ErrInvalidTimeZone is thrown when an invalid time zone is found
+	ErrInvalidTimeZone = errors.NewKind("Unknown or incorrect time zone: %s")
+
 	// ErrTableAlreadyExists is thrown when someone tries to create a
 	// table with a name of an existing one
 	ErrTableAlreadyExists = errors.NewKind("table with name %s already exists")

sql/events.go

@@ -401,13 +401,13 @@ func GetTimeValueFromStringInput(field, t string) (time.Time, error) {
 		datetimeVal := fmt.Sprintf("%4d-%02d-%02d %02d:%02d:%02d", year, month, day, hour, minute, second)
 		tVal, err := time.Parse(EventDateSpaceTimeFormat, datetimeVal)
 		if err != nil {
-			return time.Time{}, fmt.Errorf("invalid time zone: %s", sessTz)
+			return time.Time{}, ErrInvalidTimeZone.New(sessTz)
 		}
 
 		// convert the time value to the session timezone for display and storage
 		tVal, ok = ConvertTimeZone(tVal, inputTz, sessTz)
 		if !ok {
-			return time.Time{}, fmt.Errorf("invalid time zone: %s", sessTz)
+			return time.Time{}, ErrInvalidTimeZone.New(sessTz)
 		}
 		return tVal, nil
 	} else {

sql/expression/function/time.go

@@ -1017,7 +1017,7 @@ func (n *Now) Eval(ctx *sql.Context, row sql.Row) (interface{}, error) {
 	if n.prec == nil {
 		t, ok := sql.ConvertTimeZone(currentTime, sql.SystemTimezoneOffset(), sessionTimeZone)
 		if !ok {
-			return nil, fmt.Errorf("invalid time zone: %s", sessionTimeZone)
+			return nil, sql.ErrInvalidTimeZone.New(sessionTimeZone)
 		}
 		tt := time.Date(t.Year(), t.Month(), t.Day(), t.Hour(), t.Minute(), t.Second(), 0, time.UTC)
 		return tt, nil
@@ -1057,7 +1057,7 @@ func (n *Now) Eval(ctx *sql.Context, row sql.Row) (interface{}, error) {
 	// Get the timestamp
 	t, ok := sql.ConvertTimeZone(currentTime, sql.SystemTimezoneOffset(), sessionTimeZone)
 	if !ok {
-		return nil, fmt.Errorf("invalid time zone: %s", sessionTimeZone)
+		return nil, sql.ErrInvalidTimeZone.New(sessionTimeZone)
 	}
 
 	// Calculate precision

sql/rowexec/rel_iters.go

@@ -18,6 +18,7 @@ import (
 	"errors"
 	"io"
 	"strings"
+	"time"
 
 	"github.com/dolthub/go-mysql-server/sql"
 	"github.com/dolthub/go-mysql-server/sql/expression"
@@ -392,6 +393,10 @@ func setSystemVar(ctx *sql.Context, sysVar *expression.SystemVar, right sql.Expr
 	if err != nil {
 		return err
 	}
+	err = validateSystemVariableValue(sysVar.Name, val)
+	if err != nil {
+		return err
+	}
 	err = sysVar.Scope.SetValue(ctx, sysVar.Name, val)
 	if err != nil {
 		return err
@@ -464,6 +469,24 @@ func setSystemVar(ctx *sql.Context, sysVar *expression.SystemVar, right sql.Expr
 	return nil
 }
 
+func validateSystemVariableValue(sysVarName string, val interface{}) error {
+	switch strings.ToLower(sysVarName) {
+	case "time_zone":
+		valStr, ok := val.(string)
+		if !ok {
+			return sql.ErrInvalidTimeZone.New(val)
+		}
+		_, err := time.LoadLocation(valStr)
+		if err == nil {
+			return nil
+		}
+		if !sql.ValidTimeOffset(valStr) {
+			return sql.ErrInvalidTimeZone.New(valStr)
+		}
+	}
+	return nil
+}
+
 // Applies the update expressions given to the row given, returning the new resultant row.
 func applyUpdateExpressions(ctx *sql.Context, updateExprs []sql.Expression, row sql.Row) (sql.Row, error) {
 	var ok bool

sql/time.go

@@ -47,6 +47,10 @@ func ConvertTimeZone(datetime time.Time, fromLocation string, toLocation string)
 	return datetime.Add(delta), true
 }
 
+func ValidTimeOffset(str string) bool {
+	return offsetRegex.MatchString(str)
+}
+
 // MySQLOffsetToDuration takes in a MySQL timezone offset (e.g. "+01:00") and returns it as a time.Duration.
 // If any problems are encountered, an error is returned.
 func MySQLOffsetToDuration(d string) (time.Duration, error) {
@@ -113,7 +117,7 @@ func ConvertTimeToLocation(datetime time.Time, location string) (time.Time, erro
 		return getCopy(datetime, time.UTC).Add(-1 * duration), nil
 	}
 
-	return time.Time{}, errors.New(fmt.Sprintf("error: unable to parse timezone '%s'", location))
+	return time.Time{}, ErrInvalidTimeZone.New(location)
 }
 
 // getCopy recreates the time t in the wanted timezone.