9467040662

Committed 11 Jun 2024 02:02PM UTC coverage: 82.558% (-0.02%) from 82.579%

Build # 9467040662

Build Type

push

github

Committed by

web-flow

Commit Message

log: add "filename:line" prefix by ourself (#1593)

go-sql-driver/mysql#1563 broke the filename:lineno prefix in the log
message by introducing a helper function.
This commit adds the "filename:line" prefix in the helper function
instead of log.Lshortfile option to show correct filename:lineno.

(cherry picked from commit 2f7015e5c)

Run Details

8 of 8 new or added lines in 1 file covered. (100.0%)

2 existing lines in 1 file now uncovered.

3143 of 3807 relevant lines covered (82.56%)

1297216.01 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

74.59

/connection.go

// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
//
// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
// You can obtain one at http://mozilla.org/MPL/2.0/.

package mysql

import (
        "context"
        "database/sql"
        "database/sql/driver"
        "encoding/json"
        "fmt"
        "io"
        "net"
        "runtime"
        "strconv"
        "strings"
        "time"
)

type mysqlConn struct {
        buf              buffer
        netConn          net.Conn
        rawConn          net.Conn    // underlying connection when netConn is TLS connection.
        result           mysqlResult // managed by clearResult() and handleOkPacket().
        cfg              *Config
        connector        *connector
        maxAllowedPacket int
        maxWriteSize     int
        writeTimeout     time.Duration
        flags            clientFlag
        status           statusFlag
        sequence         uint8
        parseTime        bool

        // for context support (Go 1.8+)
        watching bool
        watcher  chan<- context.Context
        closech  chan struct{}
        finished chan<- struct{}
        canceled atomicError // set non-nil if conn is canceled
        closed   atomicBool  // set when conn is closed, before closech is closed
}

// Helper function to call per-connection logger.
func (mc *mysqlConn) log(v ...any) {
        _, filename, lineno, ok := runtime.Caller(1)
        if ok {
                pos := strings.LastIndexByte(filename, '/')
                if pos != -1 {
                        filename = filename[pos+1:]
                }
                prefix := fmt.Sprintf("%s:%d ", filename, lineno)
                v = append([]any{prefix}, v...)
        }

        mc.cfg.Logger.Print(v...)
}

// Handles parameters set in DSN after the connection is established
func (mc *mysqlConn) handleParams() (err error) {
        var cmdSet strings.Builder

        for param, val := range mc.cfg.Params {
                switch param {
                // Charset: character_set_connection, character_set_client, character_set_results
                case "charset":
                        charsets := strings.Split(val, ",")
                        for _, cs := range charsets {
                                // ignore errors here - a charset may not exist
                                if mc.cfg.Collation != "" {
                                        err = mc.exec("SET NAMES " + cs + " COLLATE " + mc.cfg.Collation)
                                } else {
                                        err = mc.exec("SET NAMES " + cs)
                                }
                                if err == nil {
                                        break
                                }
                        }
                        if err != nil {
                                return
                        }

                // Other system vars accumulated in a single SET command
                default:
                        if cmdSet.Len() == 0 {
                                // Heuristic: 29 chars for each other key=value to reduce reallocations
                                cmdSet.Grow(4 + len(param) + 3 + len(val) + 30*(len(mc.cfg.Params)-1))
                                cmdSet.WriteString("SET ")
                        } else {
                                cmdSet.WriteString(", ")
                        }
                        cmdSet.WriteString(param)
                        cmdSet.WriteString(" = ")
                        cmdSet.WriteString(val)
                }
        }

        if cmdSet.Len() > 0 {
                err = mc.exec(cmdSet.String())
                if err != nil {
                        return
                }
        }

        return
}

func (mc *mysqlConn) markBadConn(err error) error {
        if mc == nil {
                return err
        }
        if err != errBadConnNoWrite {
                return err
        }
        return driver.ErrBadConn
}

func (mc *mysqlConn) Begin() (driver.Tx, error) {
        return mc.begin(false)
}

func (mc *mysqlConn) begin(readOnly bool) (driver.Tx, error) {
        if mc.closed.Load() {
                mc.log(ErrInvalidConn)
                return nil, driver.ErrBadConn
        }
        var q string
        if readOnly {
                q = "START TRANSACTION READ ONLY"
        } else {
                q = "START TRANSACTION"
        }
        err := mc.exec(q)
        if err == nil {
                return &mysqlTx{mc}, err
        }
        return nil, mc.markBadConn(err)
}

func (mc *mysqlConn) Close() (err error) {
        // Makes Close idempotent
        if !mc.closed.Load() {
                err = mc.writeCommandPacket(comQuit)
        }

        mc.cleanup()
        mc.clearResult()
        return
}

// Closes the network connection and unsets internal variables. Do not call this
// function after successfully authentication, call Close instead. This function
// is called before auth or on auth failure because MySQL will have already
// closed the network connection.
func (mc *mysqlConn) cleanup() {
        if mc.closed.Swap(true) {
                return
        }

        // Makes cleanup idempotent
        close(mc.closech)
        conn := mc.rawConn
        if conn == nil {
                return
        }
        if err := conn.Close(); err != nil {
                mc.log(err)
        }
        // This function can be called from multiple goroutines.
        // So we can not mc.clearResult() here.
        // Caller should do it if they are in safe goroutine.
}

func (mc *mysqlConn) error() error {
        if mc.closed.Load() {
                if err := mc.canceled.Value(); err != nil {
                        return err
                }
                return ErrInvalidConn
        }
        return nil
}

func (mc *mysqlConn) Prepare(query string) (driver.Stmt, error) {
        if mc.closed.Load() {
                mc.log(ErrInvalidConn)
                return nil, driver.ErrBadConn
        }
        // Send command
        err := mc.writeCommandPacketStr(comStmtPrepare, query)
        if err != nil {
                // STMT_PREPARE is safe to retry.  So we can return ErrBadConn here.
                mc.log(err)
                return nil, driver.ErrBadConn
        }

        stmt := &mysqlStmt{
                mc: mc,
        }

        // Read Result
        columnCount, err := stmt.readPrepareResultPacket()
        if err == nil {
                if stmt.paramCount > 0 {
                        if err = mc.readUntilEOF(); err != nil {
                                return nil, err
                        }
                }

                if columnCount > 0 {
                        err = mc.readUntilEOF()
                }
        }

        return stmt, err
}

func (mc *mysqlConn) interpolateParams(query string, args []driver.Value) (string, error) {
        // Number of ? should be same to len(args)
        if strings.Count(query, "?") != len(args) {
                return "", driver.ErrSkip
        }

        buf, err := mc.buf.takeCompleteBuffer()
        if err != nil {
                // can not take the buffer. Something must be wrong with the connection
                mc.log(err)
                return "", ErrInvalidConn
        }
        buf = buf[:0]
        argPos := 0

        for i := 0; i < len(query); i++ {
                q := strings.IndexByte(query[i:], '?')
                if q == -1 {
                        buf = append(buf, query[i:]...)
                        break
                }
                buf = append(buf, query[i:i+q]...)
                i += q

                arg := args[argPos]
                argPos++

                if arg == nil {
                        buf = append(buf, "NULL"...)
                        continue
                }

                switch v := arg.(type) {
                case int64:
                        buf = strconv.AppendInt(buf, v, 10)
                case uint64:
                        // Handle uint64 explicitly because our custom ConvertValue emits unsigned values
                        buf = strconv.AppendUint(buf, v, 10)
                case float64:
                        buf = strconv.AppendFloat(buf, v, 'g', -1, 64)
                case bool:
                        if v {
                                buf = append(buf, '1')
                        } else {
                                buf = append(buf, '0')
                        }
                case time.Time:
                        if v.IsZero() {
                                buf = append(buf, "'0000-00-00'"...)
                        } else {
                                buf = append(buf, '\'')
                                buf, err = appendDateTime(buf, v.In(mc.cfg.Loc), mc.cfg.timeTruncate)
                                if err != nil {
                                        return "", err
                                }
                                buf = append(buf, '\'')
                        }
                case json.RawMessage:
                        buf = append(buf, '\'')
                        if mc.status&statusNoBackslashEscapes == 0 {
                                buf = escapeBytesBackslash(buf, v)
                        } else {
                                buf = escapeBytesQuotes(buf, v)
                        }
                        buf = append(buf, '\'')
                case []byte:
                        if v == nil {
                                buf = append(buf, "NULL"...)
                        } else {
                                buf = append(buf, "_binary'"...)
                                if mc.status&statusNoBackslashEscapes == 0 {
                                        buf = escapeBytesBackslash(buf, v)
                                } else {
                                        buf = escapeBytesQuotes(buf, v)
                                }
                                buf = append(buf, '\'')
                        }
                case string:
                        buf = append(buf, '\'')
                        if mc.status&statusNoBackslashEscapes == 0 {
                                buf = escapeStringBackslash(buf, v)
                        } else {
                                buf = escapeStringQuotes(buf, v)
                        }
                        buf = append(buf, '\'')
                default:
                        return "", driver.ErrSkip
                }

                if len(buf)+4 > mc.maxAllowedPacket {
                        return "", driver.ErrSkip
                }
        }
        if argPos != len(args) {
                return "", driver.ErrSkip
        }
        return string(buf), nil
}

func (mc *mysqlConn) Exec(query string, args []driver.Value) (driver.Result, error) {
        if mc.closed.Load() {
                mc.log(ErrInvalidConn)
                return nil, driver.ErrBadConn
        }
        if len(args) != 0 {
                if !mc.cfg.InterpolateParams {
                        return nil, driver.ErrSkip
                }
                // try to interpolate the parameters to save extra roundtrips for preparing and closing a statement
                prepared, err := mc.interpolateParams(query, args)
                if err != nil {
                        return nil, err
                }
                query = prepared
        }

        err := mc.exec(query)
        if err == nil {
                copied := mc.result
                return &copied, err
        }
        return nil, mc.markBadConn(err)
}

// Internal function to execute commands
func (mc *mysqlConn) exec(query string) error {
        handleOk := mc.clearResult()
        // Send command
        if err := mc.writeCommandPacketStr(comQuery, query); err != nil {
                return mc.markBadConn(err)
        }

        // Read Result
        resLen, err := handleOk.readResultSetHeaderPacket()
        if err != nil {
                return err
        }

        if resLen > 0 {
                // columns
                if err := mc.readUntilEOF(); err != nil {
                        return err
                }

                // rows
                if err := mc.readUntilEOF(); err != nil {
                        return err
                }
        }

        return handleOk.discardResults()
}

func (mc *mysqlConn) Query(query string, args []driver.Value) (driver.Rows, error) {
        return mc.query(query, args)
}

func (mc *mysqlConn) query(query string, args []driver.Value) (*textRows, error) {
        handleOk := mc.clearResult()

        if mc.closed.Load() {
                mc.log(ErrInvalidConn)
                return nil, driver.ErrBadConn
        }
        if len(args) != 0 {
                if !mc.cfg.InterpolateParams {
                        return nil, driver.ErrSkip
                }
                // try client-side prepare to reduce roundtrip
                prepared, err := mc.interpolateParams(query, args)
                if err != nil {
                        return nil, err
                }
                query = prepared
        }
        // Send command
        err := mc.writeCommandPacketStr(comQuery, query)
        if err == nil {
                // Read Result
                var resLen int
                resLen, err = handleOk.readResultSetHeaderPacket()
                if err == nil {
                        rows := new(textRows)
                        rows.mc = mc

                        if resLen == 0 {
                                rows.rs.done = true

                                switch err := rows.NextResultSet(); err {
                                case nil, io.EOF:
                                        return rows, nil
                                default:
                                        return nil, err
                                }
                        }

                        // Columns
                        rows.rs.columns, err = mc.readColumns(resLen)
                        return rows, err
                }
        }
        return nil, mc.markBadConn(err)
}

// Gets the value of the given MySQL System Variable
// The returned byte slice is only valid until the next read
func (mc *mysqlConn) getSystemVar(name string) ([]byte, error) {
        // Send command
        handleOk := mc.clearResult()
        if err := mc.writeCommandPacketStr(comQuery, "SELECT @@"+name); err != nil {
                return nil, err
        }

        // Read Result
        resLen, err := handleOk.readResultSetHeaderPacket()
        if err == nil {
                rows := new(textRows)
                rows.mc = mc
                rows.rs.columns = []mysqlField{{fieldType: fieldTypeVarChar}}

                if resLen > 0 {
                        // Columns
                        if err := mc.readUntilEOF(); err != nil {
                                return nil, err
                        }
                }

                dest := make([]driver.Value, resLen)
                if err = rows.readRow(dest); err == nil {
                        return dest[0].([]byte), mc.readUntilEOF()
                }
        }
        return nil, err
}

// finish is called when the query has canceled.
func (mc *mysqlConn) cancel(err error) {
        mc.canceled.Set(err)
        mc.cleanup()
}

// finish is called when the query has succeeded.
func (mc *mysqlConn) finish() {
        if !mc.watching || mc.finished == nil {
                return
        }
        select {
        case mc.finished <- struct{}{}:
                mc.watching = false
        case <-mc.closech:
        }
}

// Ping implements driver.Pinger interface
func (mc *mysqlConn) Ping(ctx context.Context) (err error) {
        if mc.closed.Load() {
                mc.log(ErrInvalidConn)
                return driver.ErrBadConn
        }

        if err = mc.watchCancel(ctx); err != nil {
                return
        }
        defer mc.finish()

        handleOk := mc.clearResult()
        if err = mc.writeCommandPacket(comPing); err != nil {
                return mc.markBadConn(err)
        }

        return handleOk.readResultOK()
}

// BeginTx implements driver.ConnBeginTx interface
func (mc *mysqlConn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) {
        if mc.closed.Load() {
                return nil, driver.ErrBadConn
        }

        if err := mc.watchCancel(ctx); err != nil {
                return nil, err
        }
        defer mc.finish()

        if sql.IsolationLevel(opts.Isolation) != sql.LevelDefault {
                level, err := mapIsolationLevel(opts.Isolation)
                if err != nil {
                        return nil, err
                }
                err = mc.exec("SET TRANSACTION ISOLATION LEVEL " + level)
                if err != nil {
                        return nil, err
                }
        }

        return mc.begin(opts.ReadOnly)
}

func (mc *mysqlConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) {
        dargs, err := namedValueToValue(args)
        if err != nil {
                return nil, err
        }

        if err := mc.watchCancel(ctx); err != nil {
                return nil, err
        }

        rows, err := mc.query(query, dargs)
        if err != nil {
                mc.finish()
                return nil, err
        }
        rows.finish = mc.finish
        return rows, err
}

func (mc *mysqlConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) {
        dargs, err := namedValueToValue(args)
        if err != nil {
                return nil, err
        }

        if err := mc.watchCancel(ctx); err != nil {
                return nil, err
        }
        defer mc.finish()

        return mc.Exec(query, dargs)
}

func (mc *mysqlConn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) {
        if err := mc.watchCancel(ctx); err != nil {
                return nil, err
        }

        stmt, err := mc.Prepare(query)
        mc.finish()
        if err != nil {
                return nil, err
        }

        select {
        default:
        case <-ctx.Done():
                stmt.Close()
                return nil, ctx.Err()
        }
        return stmt, nil
}

func (stmt *mysqlStmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) {
        dargs, err := namedValueToValue(args)
        if err != nil {
                return nil, err
        }

        if err := stmt.mc.watchCancel(ctx); err != nil {
                return nil, err
        }

        rows, err := stmt.query(dargs)
        if err != nil {
                stmt.mc.finish()
                return nil, err
        }
        rows.finish = stmt.mc.finish
        return rows, err
}

func (stmt *mysqlStmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) {
        dargs, err := namedValueToValue(args)
        if err != nil {
                return nil, err
        }

        if err := stmt.mc.watchCancel(ctx); err != nil {
                return nil, err
        }
        defer stmt.mc.finish()

        return stmt.Exec(dargs)
}

func (mc *mysqlConn) watchCancel(ctx context.Context) error {
        if mc.watching {
                // Reach here if canceled,
                // so the connection is already invalid
                mc.cleanup()
                return nil
        }
        // When ctx is already cancelled, don't watch it.
        if err := ctx.Err(); err != nil {
                return err
        }
        // When ctx is not cancellable, don't watch it.
        if ctx.Done() == nil {
                return nil
        }
        // When watcher is not alive, can't watch it.
        if mc.watcher == nil {
                return nil
        }

        mc.watching = true
        mc.watcher <- ctx
        return nil
}

func (mc *mysqlConn) startWatcher() {
        watcher := make(chan context.Context, 1)
        mc.watcher = watcher
        finished := make(chan struct{})
        mc.finished = finished
        go func() {
                for {
                        var ctx context.Context
                        select {
                        case ctx = <-watcher:
                        case <-mc.closech:
                                return
                        }

                        select {
                        case <-ctx.Done():
                                mc.cancel(ctx.Err())
                        case <-finished:
                        case <-mc.closech:
                                return
                        }
                }
        }()
}

func (mc *mysqlConn) CheckNamedValue(nv *driver.NamedValue) (err error) {
        nv.Value, err = converter{}.ConvertValue(nv.Value)
        return
}

// ResetSession implements driver.SessionResetter.
// (From Go 1.10)
func (mc *mysqlConn) ResetSession(ctx context.Context) error {
        if mc.closed.Load() {
                return driver.ErrBadConn
        }

        // Perform a stale connection check. We only perform this check for
        // the first query on a connection that has been checked out of the
        // connection pool: a fresh connection from the pool is more likely
        // to be stale, and it has not performed any previous writes that
        // could cause data corruption, so it's safe to return ErrBadConn
        // if the check fails.
        if mc.cfg.CheckConnLiveness {
                conn := mc.netConn
                if mc.rawConn != nil {
                        conn = mc.rawConn
                }
                var err error
                if mc.cfg.ReadTimeout != 0 {
                        err = conn.SetReadDeadline(time.Now().Add(mc.cfg.ReadTimeout))
                }
                if err == nil {
                        err = connCheck(conn)
                }
                if err != nil {
                        mc.log("closing bad idle connection: ", err)
                        return driver.ErrBadConn
                }
        }

        return nil
}

// IsValid implements driver.Validator interface
// (From Go 1.15)
func (mc *mysqlConn) IsValid() bool {
        return !mc.closed.Load()
}

1	// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
2	//
3	// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
4	//
5	// This Source Code Form is subject to the terms of the Mozilla Public
6	// License, v. 2.0. If a copy of the MPL was not distributed with this file,
7	// You can obtain one at http://mozilla.org/MPL/2.0/.
8
9	package mysql
10
11	import (
12	"context"
13	"database/sql"
14	"database/sql/driver"
15	"encoding/json"
16	"fmt"
17	"io"
18	"net"
19	"runtime"
20	"strconv"
21	"strings"
22	"time"
23	)
24
25	type mysqlConn struct {
26	buf buffer
27	netConn net.Conn
28	rawConn net.Conn // underlying connection when netConn is TLS connection.
29	result mysqlResult // managed by clearResult() and handleOkPacket().
30	cfg *Config
31	connector *connector
32	maxAllowedPacket int
33	maxWriteSize int
34	writeTimeout time.Duration
35	flags clientFlag
36	status statusFlag
37	sequence uint8
38	parseTime bool
39
40	// for context support (Go 1.8+)
41	watching bool
42	watcher chan<- context.Context
43	closech chan struct{}
44	finished chan<- struct{}
45	canceled atomicError // set non-nil if conn is canceled
46	closed atomicBool // set when conn is closed, before closech is closed
47	}
48
49	// Helper function to call per-connection logger.
50	func (mc *mysqlConn) log(v ...any) {	590✔
51	_, filename, lineno, ok := runtime.Caller(1)	590✔
52	if ok {	1,180✔
53	pos := strings.LastIndexByte(filename, '/')	590✔
54	if pos != -1 {	1,180✔
55	filename = filename[pos+1:]	590✔
56	}	590✔
57	prefix := fmt.Sprintf("%s:%d ", filename, lineno)	590✔
58	v = append([]any{prefix}, v...)	590✔
59	}
60
61	mc.cfg.Logger.Print(v...)	590✔
62	}
63
64	// Handles parameters set in DSN after the connection is established
65	func (mc *mysqlConn) handleParams() (err error) {	14,758✔
66	var cmdSet strings.Builder	14,758✔
67		14,758✔
68	for param, val := range mc.cfg.Params {	15,298✔
69	switch param {	540✔
70	// Charset: character_set_connection, character_set_client, character_set_results
71	case "charset":	300✔
72	charsets := strings.Split(val, ",")	300✔
73	for _, cs := range charsets {	660✔
74	// ignore errors here - a charset may not exist	360✔
75	if mc.cfg.Collation != "" {	360✔
76	err = mc.exec("SET NAMES " + cs + " COLLATE " + mc.cfg.Collation)	×
77	} else {	360✔
78	err = mc.exec("SET NAMES " + cs)	360✔
79	}	360✔
80	if err == nil {	600✔
81	break	240✔
82	}
83	}
84	if err != nil {	360✔
85	return	60✔
86	}	60✔
87
88	// Other system vars accumulated in a single SET command
89	default:	240✔
90	if cmdSet.Len() == 0 {	480✔
91	// Heuristic: 29 chars for each other key=value to reduce reallocations	240✔
92	cmdSet.Grow(4 + len(param) + 3 + len(val) + 30*(len(mc.cfg.Params)-1))	240✔
93	cmdSet.WriteString("SET ")	240✔
94	} else {	240✔
95	cmdSet.WriteString(", ")	×
96	}	×
97	cmdSet.WriteString(param)	240✔
98	cmdSet.WriteString(" = ")	240✔
99	cmdSet.WriteString(val)	240✔
100	}
101	}
102
103	if cmdSet.Len() > 0 {	14,938✔
104	err = mc.exec(cmdSet.String())	240✔
105	if err != nil {	240✔
106	return	×
107	}	×
108	}
109
110	return	14,698✔
111	}
112
113	func (mc *mysqlConn) markBadConn(err error) error {	448✔
114	if mc == nil {	448✔
115	return err	×
116	}	×
117	if err != errBadConnNoWrite {	866✔
118	return err	418✔
119	}	418✔
120	return driver.ErrBadConn	30✔
121	}
122
123	func (mc *mysqlConn) Begin() (driver.Tx, error) {	×
124	return mc.begin(false)	×
125	}	×
126
127	func (mc *mysqlConn) begin(readOnly bool) (driver.Tx, error) {	3,111✔
128	if mc.closed.Load() {	3,111✔
129	mc.log(ErrInvalidConn)	×
130	return nil, driver.ErrBadConn	×
131	}	×
132	var q string	3,111✔
133	if readOnly {	3,141✔
134	q = "START TRANSACTION READ ONLY"	30✔
135	} else {	3,111✔
136	q = "START TRANSACTION"	3,081✔
137	}	3,081✔
138	err := mc.exec(q)	3,111✔
139	if err == nil {	6,222✔
140	return &mysqlTx{mc}, err	3,111✔
141	}	3,111✔
142	return nil, mc.markBadConn(err)	×
143	}
144
145	func (mc *mysqlConn) Close() (err error) {	14,818✔
146	// Makes Close idempotent	14,818✔
147	if !mc.closed.Load() {	26,550✔
148	err = mc.writeCommandPacket(comQuit)	11,732✔
149	}	11,732✔
150
151	mc.cleanup()	14,818✔
152	mc.clearResult()	14,818✔
153	return	14,818✔
154	}
155
156	// Closes the network connection and unsets internal variables. Do not call this
157	// function after successfully authentication, call Close instead. This function
158	// is called before auth or on auth failure because MySQL will have already
159	// closed the network connection.
160	func (mc *mysqlConn) cleanup() {	122,155✔
161	if mc.closed.Swap(true) {	176,988✔
162	return	54,833✔
163	}	54,833✔
164
165	// Makes cleanup idempotent
166	close(mc.closech)	67,322✔
167	conn := mc.rawConn	67,322✔
168	if conn == nil {	67,472✔
169	return	150✔
170	}	150✔
171	if err := conn.Close(); err != nil {	67,172✔
172	mc.log(err)	×
173	}	×
174	// This function can be called from multiple goroutines.
175	// So we can not mc.clearResult() here.
176	// Caller should do it if they are in safe goroutine.
177	}
178
179	func (mc *mysqlConn) error() error {	17,304✔
180	if mc.closed.Load() {	18,534✔
181	if err := mc.canceled.Value(); err != nil {	2,460✔
182	return err	1,230✔
183	}	1,230✔
184	return ErrInvalidConn	×
185	}
186	return nil	16,074✔
187	}
188
189	func (mc *mysqlConn) Prepare(query string) (driver.Stmt, error) {	2,760✔
190	if mc.closed.Load() {	2,760✔
191	mc.log(ErrInvalidConn)	×
192	return nil, driver.ErrBadConn	×
193	}	×
194	// Send command
195	err := mc.writeCommandPacketStr(comStmtPrepare, query)	2,760✔
196	if err != nil {	2,760✔
197	// STMT_PREPARE is safe to retry. So we can return ErrBadConn here.	×
198	mc.log(err)	×
199	return nil, driver.ErrBadConn	×
200	}	×
201
202	stmt := &mysqlStmt{	2,760✔
203	mc: mc,	2,760✔
204	}	2,760✔
205		2,760✔
206	// Read Result	2,760✔
207	columnCount, err := stmt.readPrepareResultPacket()	2,760✔
208	if err == nil {	5,520✔
209	if stmt.paramCount > 0 {	5,220✔
210	if err = mc.readUntilEOF(); err != nil {	2,460✔
211	return nil, err	×
212	}	×
213	}
214
215	if columnCount > 0 {	4,080✔
216	err = mc.readUntilEOF()	1,320✔
217	}	1,320✔
218	}
219
220	return stmt, err	2,760✔
221	}
222
223	func (mc *mysqlConn) interpolateParams(query string, args []driver.Value) (string, error) {	1,410✔
224	// Number of ? should be same to len(args)	1,410✔
225	if strings.Count(query, "?") != len(args) {	1,470✔
226	return "", driver.ErrSkip	60✔
227	}	60✔
228
229	buf, err := mc.buf.takeCompleteBuffer()	1,350✔
230	if err != nil {	1,350✔
231	// can not take the buffer. Something must be wrong with the connection	×
232	mc.log(err)	×
233	return "", ErrInvalidConn	×
234	}	×
235	buf = buf[:0]	1,350✔
236	argPos := 0	1,350✔
237		1,350✔
238	for i := 0; i < len(query); i++ {	3,930✔
239	q := strings.IndexByte(query[i:], '?')	2,580✔
240	if q == -1 {	3,660✔
241	buf = append(buf, query[i:]...)	1,080✔
242	break	1,080✔
243	}
244	buf = append(buf, query[i:i+q]...)	1,500✔
245	i += q	1,500✔
246		1,500✔
247	arg := args[argPos]	1,500✔
248	argPos++	1,500✔
249		1,500✔
250	if arg == nil {	1,500✔
251	buf = append(buf, "NULL"...)	×
252	continue	×
253	}
254
255	switch v := arg.(type) {	1,500✔
256	case int64:	300✔
257	buf = strconv.AppendInt(buf, v, 10)	300✔
258	case uint64:	30✔
259	// Handle uint64 explicitly because our custom ConvertValue emits unsigned values	30✔
260	buf = strconv.AppendUint(buf, v, 10)	30✔
261	case float64:	×
262	buf = strconv.AppendFloat(buf, v, 'g', -1, 64)	×
263	case bool:	×
264	if v {	×
265	buf = append(buf, '1')	×
266	} else {	×
267	buf = append(buf, '0')	×
268	}	×
269	case time.Time:	360✔
270	if v.IsZero() {	420✔
271	buf = append(buf, "'0000-00-00'"...)	60✔
272	} else {	360✔
273	buf = append(buf, '\'')	300✔
274	buf, err = appendDateTime(buf, v.In(mc.cfg.Loc), mc.cfg.timeTruncate)	300✔
275	if err != nil {	300✔
276	return "", err	×
277	}	×
278	buf = append(buf, '\'')	300✔
279	}
280	case json.RawMessage:	30✔
281	buf = append(buf, '\'')	30✔
282	if mc.status&statusNoBackslashEscapes == 0 {	60✔
283	buf = escapeBytesBackslash(buf, v)	30✔
284	} else {	30✔
285	buf = escapeBytesQuotes(buf, v)	×
286	}	×
287	buf = append(buf, '\'')	30✔
288	case []byte:	×
289	if v == nil {	×
290	buf = append(buf, "NULL"...)	×
291	} else {	×
292	buf = append(buf, "_binary'"...)	×
293	if mc.status&statusNoBackslashEscapes == 0 {	×
294	buf = escapeBytesBackslash(buf, v)	×
295	} else {	×
296	buf = escapeBytesQuotes(buf, v)	×
297	}	×
298	buf = append(buf, '\'')	×
299	}
300	case string:	780✔
301	buf = append(buf, '\'')	780✔
302	if mc.status&statusNoBackslashEscapes == 0 {	1,470✔
303	buf = escapeStringBackslash(buf, v)	690✔
304	} else {	780✔
305	buf = escapeStringQuotes(buf, v)	90✔
306	}	90✔
307	buf = append(buf, '\'')	780✔
308	default:	×
309	return "", driver.ErrSkip	×
310	}
311
312	if len(buf)+4 > mc.maxAllowedPacket {	1,530✔
313	return "", driver.ErrSkip	30✔
314	}	30✔
315	}
316	if argPos != len(args) {	1,320✔
317	return "", driver.ErrSkip	×
318	}	×
319	return string(buf), nil	1,320✔
320	}
321
322	func (mc *mysqlConn) Exec(query string, args []driver.Value) (driver.Result, error) {	13,158✔
323	if mc.closed.Load() {	13,158✔
324	mc.log(ErrInvalidConn)	×
325	return nil, driver.ErrBadConn	×
326	}	×
327	if len(args) != 0 {	14,838✔
328	if !mc.cfg.InterpolateParams {	2,910✔
329	return nil, driver.ErrSkip	1,230✔
330	}	1,230✔
331	// try to interpolate the parameters to save extra roundtrips for preparing and closing a statement
332	prepared, err := mc.interpolateParams(query, args)	450✔
333	if err != nil {	480✔
334	return nil, err	30✔
335	}	30✔
336	query = prepared	420✔
337	}
338
339	err := mc.exec(query)	11,898✔
340	if err == nil {	23,484✔
341	copied := mc.result	11,586✔
342	return &copied, err	11,586✔
343	}	11,586✔
344	return nil, mc.markBadConn(err)	312✔
345	}
346
347	// Internal function to execute commands
348	func (mc *mysqlConn) exec(query string) error {	18,768✔
349	handleOk := mc.clearResult()	18,768✔
350	// Send command	18,768✔
351	if err := mc.writeCommandPacketStr(comQuery, query); err != nil {	18,768✔
352	return mc.markBadConn(err)	×
353	}	×
354
355	// Read Result
356	resLen, err := handleOk.readResultSetHeaderPacket()	18,768✔
357	if err != nil {	19,200✔
358	return err	432✔
359	}	432✔
360
361	if resLen > 0 {	18,336✔
362	// columns	×
363	if err := mc.readUntilEOF(); err != nil {	×
364	return err	×
365	}	×
366
367	// rows
368	if err := mc.readUntilEOF(); err != nil {	×
369	return err	×
370	}	×
371	}
372
373	return handleOk.discardResults()	18,336✔
374	}
375
376	func (mc *mysqlConn) Query(query string, args []driver.Value) (driver.Rows, error) {	120✔
377	return mc.query(query, args)	120✔
378	}	120✔
379
380	func (mc mysqlConn) query(query string, args []driver.Value) (textRows, error) {	7,410✔
381	handleOk := mc.clearResult()	7,410✔
382		7,410✔
383	if mc.closed.Load() {	7,410✔
384	mc.log(ErrInvalidConn)	×
385	return nil, driver.ErrBadConn	×
386	}	×
387	if len(args) != 0 {	9,330✔
388	if !mc.cfg.InterpolateParams {	3,030✔
389	return nil, driver.ErrSkip	1,110✔
390	}	1,110✔
391	// try client-side prepare to reduce roundtrip
392	prepared, err := mc.interpolateParams(query, args)	810✔
393	if err != nil {	810✔
394	return nil, err	×
395	}	×
396	query = prepared	810✔
397	}
398	// Send command
399	err := mc.writeCommandPacketStr(comQuery, query)	6,300✔
400	if err == nil {	12,600✔
401	// Read Result	6,300✔
402	var resLen int	6,300✔
403	resLen, err = handleOk.readResultSetHeaderPacket()	6,300✔
404	if err == nil {	12,534✔
405	rows := new(textRows)	6,234✔
406	rows.mc = mc	6,234✔
407		6,234✔
408	if resLen == 0 {	6,384✔
409	rows.rs.done = true	150✔
410		150✔
411	switch err := rows.NextResultSet(); err {	150✔
412	case nil, io.EOF:	150✔
413	return rows, nil	150✔
414	default:	×
415	return nil, err	×
416	}
417	}
418
419	// Columns
420	rows.rs.columns, err = mc.readColumns(resLen)	6,084✔
421	return rows, err	6,084✔
422	}
423	}
424	return nil, mc.markBadConn(err)	66✔
425	}
426
427	// Gets the value of the given MySQL System Variable
428	// The returned byte slice is only valid until the next read
429	func (mc *mysqlConn) getSystemVar(name string) ([]byte, error) {	60✔
430	// Send command	60✔
431	handleOk := mc.clearResult()	60✔
432	if err := mc.writeCommandPacketStr(comQuery, "SELECT @@"+name); err != nil {	60✔
433	return nil, err	×
434	}	×
435
436	// Read Result
437	resLen, err := handleOk.readResultSetHeaderPacket()	60✔
438	if err == nil {	120✔
439	rows := new(textRows)	60✔
440	rows.mc = mc	60✔
441	rows.rs.columns = []mysqlField{{fieldType: fieldTypeVarChar}}	60✔
442		60✔
443	if resLen > 0 {	120✔
444	// Columns	60✔
445	if err := mc.readUntilEOF(); err != nil {	60✔
446	return nil, err	×
447	}	×
448	}
449
450	dest := make([]driver.Value, resLen)	60✔
451	if err = rows.readRow(dest); err == nil {	120✔
452	return dest[0].([]byte), mc.readUntilEOF()	60✔
453	}	60✔
454	}
455	return nil, err	×
456	}
457
458	// finish is called when the query has canceled.
459	func (mc *mysqlConn) cancel(err error) {	54,713✔
460	mc.canceled.Set(err)	54,713✔
461	mc.cleanup()	54,713✔
462	}	54,713✔
463
464	// finish is called when the query has succeeded.
465	func (mc *mysqlConn) finish() {	102,552✔
466	if !mc.watching \|\| mc.finished == nil {	137,890✔
467	return	35,338✔
468	}	35,338✔
469	select {	67,214✔
470	case mc.finished <- struct{}{}:	12,501✔
471	mc.watching = false	12,501✔
472	case <-mc.closech:	54,713✔
473	}
474	}
475
476	// Ping implements driver.Pinger interface
477	func (mc *mysqlConn) Ping(ctx context.Context) (err error) {	7,131✔
478	if mc.closed.Load() {	7,490✔
479	mc.log(ErrInvalidConn)	359✔
480	return driver.ErrBadConn	359✔
481	}	359✔
482
483	if err = mc.watchCancel(ctx); err != nil {	6,900✔
484	return	128✔
485	}	128✔
486	defer mc.finish()	6,644✔
487		6,644✔
488	handleOk := mc.clearResult()	6,644✔
489	if err = mc.writeCommandPacket(comPing); err != nil {	6,714✔
490	return mc.markBadConn(err)	70✔
491	}	70✔
492
493	return handleOk.readResultOK()	6,574✔
494	}
495
496	// BeginTx implements driver.ConnBeginTx interface
497	func (mc *mysqlConn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) {	3,123✔
498	if mc.closed.Load() {	3,135✔
499	return nil, driver.ErrBadConn	12✔
500	}	12✔
501
502	if err := mc.watchCancel(ctx); err != nil {	3,111✔
503	return nil, err	×
504	}	×
505	defer mc.finish()	3,111✔
506		3,111✔
507	if sql.IsolationLevel(opts.Isolation) != sql.LevelDefault {	3,171✔
508	level, err := mapIsolationLevel(opts.Isolation)	60✔
509	if err != nil {	60✔
510	return nil, err	×
511	}	×
512	err = mc.exec("SET TRANSACTION ISOLATION LEVEL " + level)	60✔
513	if err != nil {	60✔
514	return nil, err	×
515	}	×
516	}
517
518	return mc.begin(opts.ReadOnly)	3,111✔
519	}
520
521	func (mc *mysqlConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) {	7,290✔
522	dargs, err := namedValueToValue(args)	7,290✔
523	if err != nil {	7,290✔
524	return nil, err	×
525	}	×
526
527	if err := mc.watchCancel(ctx); err != nil {	7,290✔
528	return nil, err	×
529	}	×
530
531	rows, err := mc.query(query, dargs)	7,290✔
532	if err != nil {	8,466✔
533	mc.finish()	1,176✔
534	return nil, err	1,176✔
535	}	1,176✔
536	rows.finish = mc.finish	6,114✔
537	return rows, err	6,114✔
538	}
539
540	func (mc *mysqlConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) {	13,128✔
541	dargs, err := namedValueToValue(args)	13,128✔
542	if err != nil {	13,128✔
543	return nil, err	×
544	}	×
545
546	if err := mc.watchCancel(ctx); err != nil {	13,128✔
547	return nil, err	×
548	}	×
549	defer mc.finish()	13,128✔
550		13,128✔
551	return mc.Exec(query, dargs)	13,128✔
552	}
553
554	func (mc *mysqlConn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) {	2,730✔
555	if err := mc.watchCancel(ctx); err != nil {	2,730✔
556	return nil, err	×
557	}	×
558
559	stmt, err := mc.Prepare(query)	2,730✔
560	mc.finish()	2,730✔
561	if err != nil {	2,730✔
562	return nil, err	×
563	}	×
564
565	select {	2,730✔
566	default:	2,730✔
567	case <-ctx.Done():	×
568	stmt.Close()	×
569	return nil, ctx.Err()	×
570	}
571	return stmt, nil	2,730✔
572	}
573
574	func (stmt *mysqlStmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) {	1,800✔
575	dargs, err := namedValueToValue(args)	1,800✔
576	if err != nil {	1,800✔
577	return nil, err	×
578	}	×
579
580	if err := stmt.mc.watchCancel(ctx); err != nil {	1,800✔
581	return nil, err	×
582	}	×
583
584	rows, err := stmt.query(dargs)	1,800✔
585	if err != nil {	1,830✔
586	stmt.mc.finish()	30✔
587	return nil, err	30✔
588	}	30✔
589	rows.finish = stmt.mc.finish	1,770✔
590	return rows, err	1,770✔
591	}
592
593	func (stmt *mysqlStmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) {	1,290✔
594	dargs, err := namedValueToValue(args)	1,290✔
595	if err != nil {	1,290✔
596	return nil, err	×
597	}	×
598
599	if err := stmt.mc.watchCancel(ctx); err != nil {	1,290✔
600	return nil, err	×
601	}	×
602	defer stmt.mc.finish()	1,290✔
603		1,290✔
604	return stmt.Exec(dargs)	1,290✔
605	}
606
607	func (mc *mysqlConn) watchCancel(ctx context.Context) error {	103,443✔
608	if mc.watching {	103,443✔
609	// Reach here if canceled,	×
610	// so the connection is already invalid	×
611	mc.cleanup()	×
612	return nil	×
613	}	×
614	// When ctx is already cancelled, don't watch it.
615	if err := ctx.Err(); err != nil {	104,304✔
616	return err	861✔
617	}	861✔
618	// When ctx is not cancellable, don't watch it.
619	if ctx.Done() == nil {	137,950✔
620	return nil	35,368✔
621	}	35,368✔
622	// When watcher is not alive, can't watch it.
623	if mc.watcher == nil {	67,214✔
624	return nil	×
625	}	×
626
627	mc.watching = true	67,214✔
628	mc.watcher <- ctx	67,214✔
629	return nil	67,214✔
630	}
631
632	func (mc *mysqlConn) startWatcher() {	67,352✔
633	watcher := make(chan context.Context, 1)	67,352✔
634	mc.watcher = watcher	67,352✔
635	finished := make(chan struct{})	67,352✔
636	mc.finished = finished	67,352✔
637	go func() {	134,704✔
638	for {	201,918✔
639	var ctx context.Context	134,566✔
640	select {	134,566✔
641	case ctx = <-watcher:	67,214✔
642	case <-mc.closech:	67,202✔
643	return	67,202✔
644	}
645
646	select {	67,214✔
647	case <-ctx.Done():	54,713✔
648	mc.cancel(ctx.Err())	54,713✔
649	case <-finished:	12,501✔
UNCOV 650	case <-mc.closech:	×
UNCOV 651	return	×
652	}
653	}
654	}()
655	}
656
657	func (mc mysqlConn) CheckNamedValue(nv driver.NamedValue) (err error) {	4,110✔
658	nv.Value, err = converter{}.ConvertValue(nv.Value)	4,110✔
659	return	4,110✔
660	}	4,110✔
661
662	// ResetSession implements driver.SessionResetter.
663	// (From Go 1.10)
664	func (mc *mysqlConn) ResetSession(ctx context.Context) error {	13,871✔
665	if mc.closed.Load() {	13,871✔
666	return driver.ErrBadConn	×
667	}	×
668
669	// Perform a stale connection check. We only perform this check for
670	// the first query on a connection that has been checked out of the
671	// connection pool: a fresh connection from the pool is more likely
672	// to be stale, and it has not performed any previous writes that
673	// could cause data corruption, so it's safe to return ErrBadConn
674	// if the check fails.
675	if mc.cfg.CheckConnLiveness {	27,742✔
676	conn := mc.netConn	13,871✔
677	if mc.rawConn != nil {	27,742✔
678	conn = mc.rawConn	13,871✔
679	}	13,871✔
680	var err error	13,871✔
681	if mc.cfg.ReadTimeout != 0 {	13,871✔
682	err = conn.SetReadDeadline(time.Now().Add(mc.cfg.ReadTimeout))	×
683	}	×
684	if err == nil {	27,742✔
685	err = connCheck(conn)	13,871✔
686	}	13,871✔
687	if err != nil {	13,892✔
688	mc.log("closing bad idle connection: ", err)	21✔
689	return driver.ErrBadConn	21✔
690	}	21✔
691	}
692
693	return nil	13,850✔
694	}
695
696	// IsValid implements driver.Validator interface
697	// (From Go 1.15)
698	func (mc *mysqlConn) IsValid() bool {	27,997✔
699	return !mc.closed.Load()	27,997✔
700	}	27,997✔

go-sql-driver / mysql / 9467040662

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous