Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add similar unique violation check as sql for spanner #287

Merged
merged 4 commits into from
May 4, 2023
Merged

add similar unique violation check as sql for spanner #287

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ecc7c9
add similar unique violation check as sql for spanner
May 1, 2023
12cb9c3
removed match and just unrwap error code directly with helper
May 3, 2023
083d319
added vinces nit and new wrapped test
May 3, 2023
7dd21d0
nit
May 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions database/spanner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ import (
"database/sql"
"fmt"

"github.com/moov-io/base/log"

"cloud.google.com/go/spanner"
"github.com/golang-migrate/migrate/v4/database"
migspanner "github.com/golang-migrate/migrate/v4/database/spanner"
_ "github.com/googleapis/go-sql-spanner"
"google.golang.org/grpc/codes"

"github.com/moov-io/base/log"
)

func spannerConnection(logger log.Logger, cfg SpannerConfig, databaseName string) (*sql.DB, error) {
Expand All @@ -24,3 +26,11 @@ func SpannerMigrationDriver(cfg SpannerConfig, databaseName string) (database.Dr
s := migspanner.Spanner{}
return s.Open(fmt.Sprintf("spanner://projects/%s/instances/%s/databases/%s?x-migrations-table=spanner_schema_migrations&x-clean-statements=true", cfg.Project, cfg.Instance, databaseName))
}

// SpannerUniqueViolation returns true when the provided error matches the Spanner code
// for duplicate entries (violating a unique table constraint).
// Refer to https://cloud.google.com/spanner/docs/error-codes for Spanner error definitions,
// and https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto for error codes
func SpannerUniqueViolation(err error) bool {
return spanner.ErrCode(err) == codes.AlreadyExists
}
23 changes: 22 additions & 1 deletion database/spanner_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@ import (
"context"
"testing"

"cloud.google.com/go/spanner"
"github.com/googleapis/gax-go/v2/apierror"
"github.com/stretchr/testify/require"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"

"github.com/moov-io/base/database"
"github.com/moov-io/base/database/testdb"
"github.com/moov-io/base/log"
"github.com/stretchr/testify/require"
)

func Test_OpenConnection(t *testing.T) {
Expand Down Expand Up @@ -69,3 +74,19 @@ func Test_MigrateAndRun(t *testing.T) {
defer rows.Close()
require.NoError(t, rows.Err())
}

func TestSpannerUniqueViolation(t *testing.T) {
errMsg := "Failed to insert row with primary key ({pk#primary_key:\"282f6ffcd9ba5b029afbf2b739ee826e22d9df3b\"}) due to previously existing row"
// Test backwards-compatible parsing of spanner.Error (soon to be deprecated) from Spanner client
oldSpannerErr := spanner.ToSpannerError(status.New(codes.AlreadyExists, errMsg).Err())
if !database.SpannerUniqueViolation(oldSpannerErr) {
t.Error("should have matched unique violation")
}

// Test new apirerror.APIError response from Spanner client
newSpannerErr, parseErr := apierror.FromError(status.New(codes.AlreadyExists, errMsg).Err())
require.True(t, parseErr)
if !database.SpannerUniqueViolation(newSpannerErr) {
t.Error("should have matched unique violation")
}
}