Files
tasks/common/persistence/cassandra/version_checker.go
Vladyslav SimonenkoandGitHub cacba8f347 Log errors when doing version compatibility check for Cassandra and SQL (#8100)
## What changed?
Changes version compability checks to pass the real logger, so that the
error messages would be seeing in the log

## Why?

Before, the error was generic and there were no logs indicating the real
error (see https://github.com/temporalio/temporal/issues/7939):
```
sql schema version compatibility check failed: unable to read DB schema version keyspace/database: temporal error: no usable database connection found
```

With this change, the log would contain the actual error:
```
{"level":"error","ts":"2025-07-25T15:30:49.660-0700","msg":"sql handle: unable to refresh database connection pool","error":"pq: no pg_hba.conf entry for host \"127.0.0.1\", ...
```

The alternative solution would be to return the error, but the design of
common/persistence/sql/sqlplugin/db_handle.go suggests we hold the
abstraction boundaries, by returning generic errors and logging specific
errors.

## How did you test it?
- [X] built
- [X] run locally and tested manually
- [X] covered by existing tests
2025-07-28 11:47:14 -07:00

63 lines
1.8 KiB
Go

package cassandra
import (
"github.com/gocql/gocql"
"go.temporal.io/server/common/config"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
commongocql "go.temporal.io/server/common/persistence/nosql/nosqlplugin/cassandra/gocql"
"go.temporal.io/server/common/persistence/schema"
"go.temporal.io/server/common/resolver"
cassandraschema "go.temporal.io/server/schema/cassandra"
)
// VerifyCompatibleVersion ensures that the installed version of temporal and visibility keyspaces
// is greater than or equal to the expected version.
// In most cases, the versions should match. However if after a schema upgrade there is a code
// rollback, the code version (expected version) would fall lower than the actual version in
// cassandra.
func VerifyCompatibleVersion(
cfg config.Persistence,
r resolver.ServiceResolver,
logger log.Logger,
) error {
return checkMainKeyspace(cfg, r, logger)
}
func checkMainKeyspace(
cfg config.Persistence,
r resolver.ServiceResolver,
logger log.Logger,
) error {
ds, ok := cfg.DataStores[cfg.DefaultStore]
if ok && ds.Cassandra != nil {
return CheckCompatibleVersion(*ds.Cassandra, r, cassandraschema.Version, logger)
}
return nil
}
// CheckCompatibleVersion check the version compatibility
func CheckCompatibleVersion(
cfg config.Cassandra,
r resolver.ServiceResolver,
expectedVersion string,
logger log.Logger,
) error {
session, err := commongocql.NewSession(
func() (*gocql.ClusterConfig, error) {
return commongocql.NewCassandraCluster(cfg, r)
},
logger,
metrics.NoopMetricsHandler,
)
if err != nil {
return err
}
defer session.Close()
schemaVersionReader := NewSchemaVersionReader(session)
return schema.VerifyCompatibleVersion(schemaVersionReader, cfg.Keyspace, expectedVersion)
}