Files
tasks/common/persistence/sql/sqlplugin/tests/history_execution.go
Tim Deeb-SwihartandGitHub be7b5514a5 Reconnect to SQL databases when connections fail (#5926)
## What changed?

Both our PostgreSQL and MySQL database backends will now automatically
reconnect to the database when certain errors occur: all errors chosen
have been experienced when testing this behavior through an AWS Aurora
RDS failover of either MySQL or PostgreSQL.

For both backends we will reconnect when we see:
- `ECONNRESET`
- `ECONNABORTED`
- `ECONNREFUSED`
- `io.EOF`
- `io.ErrUnexpectedEOF`
- `database/sql/driver.ErrBadConn`

for postgres we will also reconnect on the following SQLStates:
- `25006` read-only transaction
- `57P03` cannot connect now
- `0A000` feature not supported, but ONLY when the message is `cannot
set transaction read-write mode during recovery`

for mysql we will also reconnect when we see the following error codes:
- `1040` too many connections 
- `1792` read-only transaction (SQLstate `25006`)
- `1836` running in read-only mode

This logic is easily extensible should we discover more failure modes
over time

## Why?

We've had multiple community reports of Temporal problems during RDS
failover. One part of this is the fact that we wouldn't necessarily
reconnect; we were at the whims of our chosen SQL abstraction's
connection pooling logic.

## How did you test it?

I manually tested this functionality in the presence of repeated RDS
failovers: 

- [x] postgres12 plugin with pq driver
- [x] postgres12 plugin with pgx driver
- [x] mysql plugin

Automated testing will be added to our regular testing pipelines once
our infrastructure friends have added the support I need (it's in
progress)

## Potential risks

We're concerned there's a correctness issue in our PostgreSQL backend
that's related to our behavior during an RDS failover. If we merge this
before I figure out what's going on, we could hide the issue and make it
harder to reproduce.

## Documentation
N/A

## Is hotfix candidate?
Yes?
2024-05-17 16:59:15 -07:00

354 lines
11 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 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 tests
import (
"math/rand"
"testing"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"go.temporal.io/server/common/persistence/sql/sqlplugin"
"go.temporal.io/server/common/primitives"
"go.temporal.io/server/common/shuffle"
)
type (
historyExecutionSuite struct {
suite.Suite
*require.Assertions
store sqlplugin.DB
}
)
const (
testHistoryExecutionWorkflowID = "random workflow ID"
testHistoryExecutionEncoding = "random encoding"
testHistoryExecutionStateEncoding = "random encoding"
)
var (
testHistoryExecutionData = []byte("random history execution data")
testHistoryExecutionStateData = []byte("random history execution state data")
)
func NewHistoryExecutionSuite(
t *testing.T,
store sqlplugin.DB,
) *historyExecutionSuite {
return &historyExecutionSuite{
Assertions: require.New(t),
store: store,
}
}
func (s *historyExecutionSuite) SetupSuite() {
}
func (s *historyExecutionSuite) TearDownSuite() {
}
func (s *historyExecutionSuite) SetupTest() {
s.Assertions = require.New(s.T())
}
func (s *historyExecutionSuite) TearDownTest() {
}
func (s *historyExecutionSuite) TestInsert_Success() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
nextEventID := rand.Int63()
lastWriteVersion := rand.Int63()
execution := s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
result, err := s.store.InsertIntoExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
}
func (s *historyExecutionSuite) TestInsert_Fail_Duplicate() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
nextEventID := rand.Int63()
lastWriteVersion := rand.Int63()
execution := s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
result, err := s.store.InsertIntoExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
execution = s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
_, err = s.store.InsertIntoExecutions(newExecutionContext(), &execution)
s.Error(err) // TODO persistence layer should do proper error translation
}
func (s *historyExecutionSuite) TestInsertSelect() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
nextEventID := rand.Int63()
lastWriteVersion := rand.Int63()
execution := s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
result, err := s.store.InsertIntoExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
filter := sqlplugin.ExecutionsFilter{
ShardID: shardID,
NamespaceID: namespaceID,
WorkflowID: workflowID,
RunID: runID,
}
row, err := s.store.SelectFromExecutions(newExecutionContext(), filter)
s.NoError(err)
s.Equal(&execution, row)
}
func (s *historyExecutionSuite) TestInsertUpdate_Success() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
nextEventID := rand.Int63()
lastWriteVersion := rand.Int63()
execution := s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
result, err := s.store.InsertIntoExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
execution = s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, rand.Int63(), rand.Int63())
result, err = s.store.UpdateExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err = result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
}
func (s *historyExecutionSuite) TestUpdate_Fail() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
nextEventID := rand.Int63()
lastWriteVersion := rand.Int63()
execution := s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
result, err := s.store.UpdateExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(0, int(rowsAffected))
}
func (s *historyExecutionSuite) TestInsertUpdateSelect() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
nextEventID := rand.Int63()
lastWriteVersion := rand.Int63()
execution := s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
result, err := s.store.InsertIntoExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
execution = s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, rand.Int63(), rand.Int63())
result, err = s.store.UpdateExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err = result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
filter := sqlplugin.ExecutionsFilter{
ShardID: shardID,
NamespaceID: namespaceID,
WorkflowID: workflowID,
RunID: runID,
}
row, err := s.store.SelectFromExecutions(newExecutionContext(), filter)
s.NoError(err)
s.Equal(&execution, row)
}
func (s *historyExecutionSuite) TestDeleteSelect() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
filter := sqlplugin.ExecutionsFilter{
ShardID: shardID,
NamespaceID: namespaceID,
WorkflowID: workflowID,
RunID: runID,
}
result, err := s.store.DeleteFromExecutions(newExecutionContext(), filter)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(0, int(rowsAffected))
_, err = s.store.SelectFromExecutions(newExecutionContext(), filter)
s.Error(err) // TODO persistence layer should do proper error translation
}
func (s *historyExecutionSuite) TestInsertDeleteSelect() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
nextEventID := rand.Int63()
lastWriteVersion := rand.Int63()
execution := s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
result, err := s.store.InsertIntoExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
filter := sqlplugin.ExecutionsFilter{
ShardID: shardID,
NamespaceID: namespaceID,
WorkflowID: workflowID,
RunID: runID,
}
result, err = s.store.DeleteFromExecutions(newExecutionContext(), filter)
s.NoError(err)
rowsAffected, err = result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
_, err = s.store.SelectFromExecutions(newExecutionContext(), filter)
s.Error(err) // TODO persistence layer should do proper error translation
}
func (s *historyExecutionSuite) TestReadLock() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
nextEventID := rand.Int63()
lastWriteVersion := rand.Int63()
execution := s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
result, err := s.store.InsertIntoExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
tx, err := s.store.BeginTx(newExecutionContext())
s.NoError(err)
filter := sqlplugin.ExecutionsFilter{
ShardID: shardID,
NamespaceID: namespaceID,
WorkflowID: workflowID,
RunID: runID,
}
rowDBVersion, rowNextEventID, err := tx.ReadLockExecutions(newExecutionContext(), filter)
s.NoError(err)
s.Equal(execution.DBRecordVersion, rowDBVersion)
s.Equal(execution.NextEventID, rowNextEventID)
s.NoError(tx.Commit())
}
func (s *historyExecutionSuite) TestWriteLock() {
shardID := rand.Int31()
namespaceID := primitives.NewUUID()
workflowID := shuffle.String(testHistoryExecutionWorkflowID)
runID := primitives.NewUUID()
nextEventID := rand.Int63()
lastWriteVersion := rand.Int63()
execution := s.newRandomExecutionRow(shardID, namespaceID, workflowID, runID, nextEventID, lastWriteVersion)
result, err := s.store.InsertIntoExecutions(newExecutionContext(), &execution)
s.NoError(err)
rowsAffected, err := result.RowsAffected()
s.NoError(err)
s.Equal(1, int(rowsAffected))
tx, err := s.store.BeginTx(newExecutionContext())
s.NoError(err)
filter := sqlplugin.ExecutionsFilter{
ShardID: shardID,
NamespaceID: namespaceID,
WorkflowID: workflowID,
RunID: runID,
}
rowDBVersion, rowNextEventID, err := tx.WriteLockExecutions(newExecutionContext(), filter)
s.NoError(err)
s.Equal(execution.DBRecordVersion, rowDBVersion)
s.Equal(execution.NextEventID, rowNextEventID)
s.NoError(tx.Commit())
}
func (s *historyExecutionSuite) newRandomExecutionRow(
shardID int32,
namespaceID primitives.UUID,
workflowID string,
runID primitives.UUID,
nextEventID int64,
lastWriteVersion int64,
) sqlplugin.ExecutionsRow {
return sqlplugin.ExecutionsRow{
ShardID: shardID,
NamespaceID: namespaceID,
WorkflowID: workflowID,
RunID: runID,
NextEventID: nextEventID,
LastWriteVersion: lastWriteVersion,
Data: shuffle.Bytes(testHistoryExecutionData),
DataEncoding: testHistoryExecutionEncoding,
State: shuffle.Bytes(testHistoryExecutionStateData),
StateEncoding: testHistoryExecutionStateEncoding,
}
}