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.
143 lines
3.3 KiB
Go
143 lines
3.3 KiB
Go
package sqlplugin
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
|
|
"github.com/jmoiron/sqlx"
|
|
"go.temporal.io/server/common/config"
|
|
"go.temporal.io/server/common/log"
|
|
"go.temporal.io/server/common/metrics"
|
|
"go.temporal.io/server/common/resolver"
|
|
)
|
|
|
|
type (
|
|
DbKind int
|
|
)
|
|
|
|
const (
|
|
DbKindUnknown DbKind = iota
|
|
DbKindMain
|
|
DbKindVisibility
|
|
)
|
|
|
|
type VersionedBlob struct {
|
|
Version int64
|
|
Data []byte
|
|
DataEncoding string
|
|
}
|
|
|
|
type (
|
|
// Plugin defines the interface for any SQL database that needs to implement
|
|
Plugin interface {
|
|
CreateDB(dbKind DbKind, cfg *config.SQL, r resolver.ServiceResolver, l log.Logger, mh metrics.Handler) (GenericDB, error)
|
|
|
|
GetVisibilityQueryConverter() VisibilityQueryConverter
|
|
}
|
|
|
|
// TableCRUD defines the API for interacting with the database tables
|
|
TableCRUD interface {
|
|
ClusterMetadata
|
|
Namespace
|
|
Visibility
|
|
QueueMessage
|
|
QueueMetadata
|
|
QueueV2Message
|
|
QueueV2Metadata
|
|
|
|
MatchingTask
|
|
MatchingTaskV2
|
|
MatchingTaskQueue
|
|
MatchingTaskQueueUserData
|
|
|
|
NexusEndpoints
|
|
|
|
HistoryNode
|
|
HistoryTree
|
|
|
|
HistoryShard
|
|
|
|
HistoryExecution
|
|
HistoryExecutionBuffer
|
|
HistoryExecutionActivity
|
|
HistoryExecutionChildWorkflow
|
|
HistoryExecutionTimer
|
|
HistoryExecutionRequestCancel
|
|
HistoryExecutionSignal
|
|
HistoryExecutionSignalRequest
|
|
HistoryExecutionChasm
|
|
|
|
HistoryImmediateTask
|
|
HistoryScheduledTask
|
|
HistoryTransferTask
|
|
HistoryTimerTask
|
|
HistoryReplicationTask
|
|
HistoryReplicationDLQTask
|
|
HistoryVisibilityTask
|
|
}
|
|
|
|
// AdminCRUD defines admin operations for CLI and test suites
|
|
AdminCRUD interface {
|
|
CreateSchemaVersionTables() error
|
|
ReadSchemaVersion(database string) (string, error)
|
|
UpdateSchemaVersion(database string, newVersion string, minCompatibleVersion string) error
|
|
WriteSchemaUpdateLog(oldVersion string, newVersion string, manifestMD5 string, desc string) error
|
|
ListTables(database string) ([]string, error)
|
|
DropTable(table string) error
|
|
DropAllTables(database string) error
|
|
CreateDatabase(database string) error
|
|
DropDatabase(database string) error
|
|
Exec(stmt string, args ...interface{}) error
|
|
}
|
|
|
|
// Tx defines the API for a SQL transaction
|
|
Tx interface {
|
|
TableCRUD
|
|
Commit() error
|
|
Rollback() error
|
|
}
|
|
|
|
// DB defines the API for regular SQL operations of a Temporal server
|
|
DB interface {
|
|
TableCRUD
|
|
GenericDB
|
|
BeginTx(ctx context.Context) (Tx, error)
|
|
IsDupEntryError(err error) bool
|
|
}
|
|
|
|
// AdminDB defines the API for admin SQL operations for CLI and testing suites
|
|
AdminDB interface {
|
|
AdminCRUD
|
|
GenericDB
|
|
ExpectedVersion() string
|
|
VerifyVersion() error
|
|
}
|
|
|
|
GenericDB interface {
|
|
DbName() string
|
|
PluginName() string
|
|
Close() error
|
|
}
|
|
|
|
// Conn defines the API for a single database connection
|
|
Conn interface {
|
|
Rebind(query string) string
|
|
ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
|
|
NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error)
|
|
GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
|
|
SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
|
|
PrepareNamedContext(ctx context.Context, query string) (*sqlx.NamedStmt, error)
|
|
}
|
|
)
|
|
|
|
func (k DbKind) String() string {
|
|
switch k {
|
|
case DbKindMain:
|
|
return "main"
|
|
case DbKindVisibility:
|
|
return "visibility"
|
|
default:
|
|
return "unknown"
|
|
}
|
|
}
|