019056dc-98d1-4fa6-b475-a7aef51f4b90

Committed 26 Jun 2024 11:23PM UTC coverage: 71.557% (-0.001%) from 71.558%

Build # 019056dc-98d1-4fa6-b475-a7aef51f4b90

Build Type

push

buildkite

Committed by

web-flow

Commit Message

Fix encoding bug to index context header in search attributes (#6148)

What changed?

json marshal raw string bytes before store in search attributes

Why?

Context Header stores the raw string bytes; but search attributes should store json strings rather than raw string bytes. Otherwise, it will cause unmarshal error in creating visibility message.

How did you test it?

unit test

Run Details

15 of 19 new or added lines in 3 files covered. (78.95%)

24 existing lines in 7 files now uncovered.

107133 of 149716 relevant lines covered (71.56%)

2587.42 hits per line

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

65.0

/common/persistence/sql/sqlplugin/postgres/db.go

// Copyright (c) 2019 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package postgres

import (
        "context"
        "database/sql"
        "time"

        "github.com/jmoiron/sqlx"
        "github.com/lib/pq"

        "github.com/uber/cadence/common/persistence/sql/sqldriver"
        "github.com/uber/cadence/common/persistence/sql/sqlplugin"
)

type (
        db struct {
                converter   DataConverter
                driver      sqldriver.Driver
                originalDBs []*sqlx.DB
                numDBShards int
        }
)

func (pdb *db) GetTotalNumDBShards() int {
        return pdb.numDBShards
}

var _ sqlplugin.DB = (*db)(nil)
var _ sqlplugin.Tx = (*db)(nil)

// ErrDupEntry indicates a duplicate primary key i.e. the row already exists,
// check http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html
const ErrDupEntry = "23505"

const ErrInsufficientResources = "53000"
const ErrTooManyConnections = "53300"

func (pdb *db) IsDupEntryError(err error) bool {
        sqlErr, ok := err.(*pq.Error)
        return ok && sqlErr.Code == ErrDupEntry
}

func (pdb *db) IsNotFoundError(err error) bool {
        return err == sql.ErrNoRows
}

func (pdb *db) IsTimeoutError(err error) bool {
        return err == context.DeadlineExceeded
}

func (pdb *db) IsThrottlingError(err error) bool {
        sqlErr, ok := err.(*pq.Error)
        if ok {
                if sqlErr.Code == ErrTooManyConnections ||
                        sqlErr.Code == ErrInsufficientResources {
                        return true
                }
        }
        return false
}

// newDB returns an instance of DB, which is a logical
// connection to the underlying postgres database
// dbShardID is needed when tx is not nil
func newDB(xdbs []*sqlx.DB, tx *sqlx.Tx, dbShardID int, numDBShards int) (*db, error) {
        driver, err := sqldriver.NewDriver(xdbs, tx, dbShardID)
        if err != nil {
                return nil, err
        }

        db := &db{
                converter:   &converter{},
                originalDBs: xdbs, // this is kept because newDB will be called again when starting a transaction
                driver:      driver,
                numDBShards: numDBShards,
        }
        return db, nil
}

// BeginTx starts a new transaction and returns a reference to the Tx object
func (pdb *db) BeginTx(ctx context.Context, dbShardID int) (sqlplugin.Tx, error) {
        xtx, err := pdb.driver.BeginTxx(ctx, dbShardID, nil)
        if err != nil {
                return nil, err
        }
        return newDB(pdb.originalDBs, xtx, dbShardID, pdb.numDBShards)
}

// Commit commits a previously started transaction
func (pdb *db) Commit() error {
        return pdb.driver.Commit()
}

// Rollback triggers rollback of a previously started transaction
func (pdb *db) Rollback() error {
        return pdb.driver.Rollback()
}

// Close closes the connection to the mysql db
func (pdb *db) Close() error {
        return pdb.driver.Close()
}

// PluginName returns the name of the mysql plugin
func (pdb *db) PluginName() string {
        return PluginName
}

// SupportsTTL returns weather Postgres supports TTL
func (pdb *db) SupportsTTL() bool {
        return false
}

// MaxAllowedTTL returns the max allowed ttl Postgres supports
func (pdb *db) MaxAllowedTTL() (*time.Duration, error) {
        return nil, sqlplugin.ErrTTLNotSupported
}

// SupportsTTL returns weather Postgre supports Asynchronous transaction
func (pdb *db) SupportsAsyncTransaction() bool {
        return false
}

1	// Copyright (c) 2019 Uber Technologies, Inc.
2	//
3	// Permission is hereby granted, free of charge, to any person obtaining a copy
4	// of this software and associated documentation files (the "Software"), to deal
5	// in the Software without restriction, including without limitation the rights
6	// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7	// copies of the Software, and to permit persons to whom the Software is
8	// furnished to do so, subject to the following conditions:
9	//
10	// The above copyright notice and this permission notice shall be included in
11	// all copies or substantial portions of the Software.
12	//
13	// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14	// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15	// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16	// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17	// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18	// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19	// THE SOFTWARE.
20
21	package postgres
22
23	import (
24	"context"
25	"database/sql"
26	"time"
27
28	"github.com/jmoiron/sqlx"
29	"github.com/lib/pq"
30
31	"github.com/uber/cadence/common/persistence/sql/sqldriver"
32	"github.com/uber/cadence/common/persistence/sql/sqlplugin"
33	)
34
35	type (
36	db struct {
37	converter DataConverter
38	driver sqldriver.Driver
39	originalDBs []*sqlx.DB
40	numDBShards int
41	}
42	)
43
44	func (pdb *db) GetTotalNumDBShards() int {	32,651✔
45	return pdb.numDBShards	32,651✔
46	}	32,651✔
47
48	var _ sqlplugin.DB = (*db)(nil)
49	var _ sqlplugin.Tx = (*db)(nil)
50
51	// ErrDupEntry indicates a duplicate primary key i.e. the row already exists,
52	// check http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html
53	const ErrDupEntry = "23505"
54
55	const ErrInsufficientResources = "53000"
56	const ErrTooManyConnections = "53300"
57
58	func (pdb *db) IsDupEntryError(err error) bool {	9✔
59	sqlErr, ok := err.(*pq.Error)	9✔
60	return ok && sqlErr.Code == ErrDupEntry	9✔
61	}	9✔
62
63	func (pdb *db) IsNotFoundError(err error) bool {	210✔
64	return err == sql.ErrNoRows	210✔
65	}	210✔
66
UNCOV 67	func (pdb *db) IsTimeoutError(err error) bool {	×
UNCOV 68	return err == context.DeadlineExceeded	×
UNCOV 69	}	×
70
UNCOV 71	func (pdb *db) IsThrottlingError(err error) bool {	×
UNCOV 72	sqlErr, ok := err.(*pq.Error)	×
UNCOV 73	if ok {	×
74	if sqlErr.Code == ErrTooManyConnections \|\|	×
75	sqlErr.Code == ErrInsufficientResources {	×
76	return true	×
77	}	×
78	}
UNCOV 79	return false	×
80	}
81
82	// newDB returns an instance of DB, which is a logical
83	// connection to the underlying postgres database
84	// dbShardID is needed when tx is not nil
85	func newDB(xdbs []sqlx.DB, tx sqlx.Tx, dbShardID int, numDBShards int) (*db, error) {	5,954✔
86	driver, err := sqldriver.NewDriver(xdbs, tx, dbShardID)	5,954✔
87	if err != nil {	5,954✔
88	return nil, err	×
89	}	×
90
91	db := &db{	5,954✔
92	converter: &converter{},	5,954✔
93	originalDBs: xdbs, // this is kept because newDB will be called again when starting a transaction	5,954✔
94	driver: driver,	5,954✔
95	numDBShards: numDBShards,	5,954✔
96	}	5,954✔
97	return db, nil	5,954✔
98	}
99
100	// BeginTx starts a new transaction and returns a reference to the Tx object
101	func (pdb *db) BeginTx(ctx context.Context, dbShardID int) (sqlplugin.Tx, error) {	5,835✔
102	xtx, err := pdb.driver.BeginTxx(ctx, dbShardID, nil)	5,835✔
103	if err != nil {	5,835✔
UNCOV 104	return nil, err	×
UNCOV 105	}	×
106	return newDB(pdb.originalDBs, xtx, dbShardID, pdb.numDBShards)	5,835✔
107	}
108
109	// Commit commits a previously started transaction
110	func (pdb *db) Commit() error {	5,725✔
111	return pdb.driver.Commit()	5,725✔
112	}	5,725✔
113
114	// Rollback triggers rollback of a previously started transaction
115	func (pdb *db) Rollback() error {	111✔
116	return pdb.driver.Rollback()	111✔
117	}	111✔
118
119	// Close closes the connection to the mysql db
120	func (pdb *db) Close() error {	120✔
121	return pdb.driver.Close()	120✔
122	}	120✔
123
124	// PluginName returns the name of the mysql plugin
125	func (pdb *db) PluginName() string {	1,947✔
126	return PluginName	1,947✔
127	}	1,947✔
128
129	// SupportsTTL returns weather Postgres supports TTL
130	func (pdb *db) SupportsTTL() bool {	3,380✔
131	return false	3,380✔
132	}	3,380✔
133
134	// MaxAllowedTTL returns the max allowed ttl Postgres supports
135	func (pdb db) MaxAllowedTTL() (time.Duration, error) {	×
136	return nil, sqlplugin.ErrTTLNotSupported	×
137	}	×
138
139	// SupportsTTL returns weather Postgre supports Asynchronous transaction
140	func (pdb *db) SupportsAsyncTransaction() bool {	×
141	return false	×
142	}	×

uber / cadence / 019056dc-98d1-4fa6-b475-a7aef51f4b90

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