mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Rodrigo ZhouandGitHub
5d64c0b65f
## What changed?
Unify Visibility query converters.
The new query converter is the struct `query.QueryConverter[ExprT]`. The
generic parameter specify the output type of the converter (in ES is
`elastic.Query`, in SQL is `sqlparser.Expr`).
The query converter has a `query.StoreQueryConverter[ExprT]`. This is
the Visibility store specific implementation for building the output
query.
For example, the store needs to implement `BuildAndExpr(exprs)` to tell
the query converter how to build the `AND` expression. In SQL, it's
`*sqlparser.AndExpr{exprs}`. In Elasticsearch, it's
`elastic.NewBoolQuery().Filter(exprs)`.
The store query converter for SQL needs a plugin query converter called
`sqlplugin.VisibilityQueryConverter` which is implemented by each plugin
(MySQL, PostgreSQL, SQLite). This interface is needed to build DB
specific syntax for `KeywordList` and `Text` searches as well as to
build the final `SELECT` statements.
Added dynamic config `system.VisibilityEnableUnifiedQueryConverter` that
acts as switch between the legacy and the unified query converters.
## Why?
There are two query converters: one for Elasticsearch, and another for
SQL.
They are somewhat similar, and have quite a few code duplications for
validation, modifying the query, etc.
Unifying the query converter ensures that we provide the exact same
behavior across different Visibility stores.
## How did you test it?
- [x] built
- [x] run locally and tested manually
- [x] covered by existing tests
- [x] added new unit test(s)
- [ ] added new functional test(s)
I've added a lot of unit tests for the new code with coverage close to
100%.
Note that there has been basically no changes to functional tests, which
suggests that the change works well.
## Potential risks
There might be some edge cases that either query converters that this
unified query converter might deal differently.
110 lines
3.0 KiB
Go
110 lines
3.0 KiB
Go
package postgresql
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/jmoiron/sqlx"
|
|
"go.temporal.io/api/serviceerror"
|
|
"go.temporal.io/server/common/clock"
|
|
"go.temporal.io/server/common/config"
|
|
"go.temporal.io/server/common/log"
|
|
"go.temporal.io/server/common/metrics"
|
|
"go.temporal.io/server/common/persistence/sql"
|
|
"go.temporal.io/server/common/persistence/sql/sqlplugin"
|
|
"go.temporal.io/server/common/persistence/sql/sqlplugin/postgresql/driver"
|
|
"go.temporal.io/server/common/persistence/sql/sqlplugin/postgresql/session"
|
|
"go.temporal.io/server/common/resolver"
|
|
)
|
|
|
|
const (
|
|
// PluginName is the name of the plugin
|
|
PluginName = "postgres12"
|
|
PluginNamePGX = "postgres12_pgx"
|
|
)
|
|
|
|
var defaultDatabaseNames = []string{
|
|
"postgres", // normal PostgreSQL default DB name
|
|
"defaultdb", // special behavior for Aiven: #1389
|
|
}
|
|
|
|
type plugin struct {
|
|
driver driver.Driver
|
|
queryConverter sqlplugin.VisibilityQueryConverter
|
|
}
|
|
|
|
var _ sqlplugin.Plugin = (*plugin)(nil)
|
|
|
|
func init() {
|
|
sql.RegisterPlugin(PluginName, &plugin{
|
|
driver: &driver.PQDriver{},
|
|
queryConverter: &queryConverter{},
|
|
})
|
|
sql.RegisterPlugin(PluginNamePGX, &plugin{
|
|
driver: &driver.PGXDriver{},
|
|
queryConverter: &queryConverter{},
|
|
})
|
|
}
|
|
|
|
func (p *plugin) GetVisibilityQueryConverter() sqlplugin.VisibilityQueryConverter {
|
|
return p.queryConverter
|
|
}
|
|
|
|
// CreateDB initialize the db object
|
|
func (p *plugin) CreateDB(
|
|
dbKind sqlplugin.DbKind,
|
|
cfg *config.SQL,
|
|
r resolver.ServiceResolver,
|
|
logger log.Logger,
|
|
metricsHandler metrics.Handler,
|
|
) (sqlplugin.GenericDB, error) {
|
|
connect := func() (*sqlx.DB, error) {
|
|
if cfg.Connect != nil {
|
|
return cfg.Connect(cfg)
|
|
}
|
|
return p.createDBConnection(cfg, r)
|
|
}
|
|
needsRefresh := p.driver.IsConnNeedsRefreshError
|
|
handle := sqlplugin.NewDatabaseHandle(dbKind, connect, needsRefresh, logger, metricsHandler, clock.NewRealTimeSource())
|
|
db := newDB(dbKind, cfg.DatabaseName, p.driver, handle, nil)
|
|
return db, nil
|
|
}
|
|
|
|
// CreateDBConnection creates a returns a reference to a logical connection to the
|
|
// underlying SQL database. The returned object is to tied to a single
|
|
// SQL database and the object can be used to perform CRUD operations on
|
|
// the tables in the database
|
|
func (p *plugin) createDBConnection(
|
|
cfg *config.SQL,
|
|
resolver resolver.ServiceResolver,
|
|
) (*sqlx.DB, error) {
|
|
if cfg.DatabaseName != "" {
|
|
postgresqlSession, err := session.NewSession(cfg, p.driver, resolver)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return postgresqlSession.DB, nil
|
|
}
|
|
|
|
// database name not provided
|
|
// try defaults
|
|
defer func() { cfg.DatabaseName = "" }()
|
|
|
|
var errors []error
|
|
for _, databaseName := range defaultDatabaseNames {
|
|
cfg.DatabaseName = databaseName
|
|
if postgresqlSession, err := session.NewSession(
|
|
cfg,
|
|
p.driver,
|
|
resolver,
|
|
); err == nil {
|
|
return postgresqlSession.DB, nil
|
|
} else {
|
|
errors = append(errors, err)
|
|
}
|
|
}
|
|
return nil, serviceerror.NewUnavailable(
|
|
fmt.Sprintf("unable to connect to DB, tried default DB names: %v, errors: %v", strings.Join(defaultDatabaseNames, ","), errors),
|
|
)
|
|
}
|