Skip to content

Detect emulated spanner and apply workaround #759

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

Merged
merged 1 commit into from
Sep 8, 2025
Merged

Detect emulated spanner and apply workaround #759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions storage/gcp/antispam/gcp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,15 @@
package gcp

import (
"bytes"
"compress/gzip"
"context"
"encoding/base64"
"errors"
"fmt"
"io"
"iter"
"os"
"sync/atomic"
"time"

Expand Down Expand Up @@ -191,6 +196,17 @@ func (d *AntispamStorage) Follower(b func([]byte) ([][]byte, error)) tessera.Fol
// does not support BatchWrite :(
f.updateIndex = f.batchUpdateIndex

if r := os.Getenv("SPANNER_EMULATOR_HOST"); r != "" {
const warn = `H4sIAAAAAAAAA83VwRGAIAwEwH+qoFwrsEAr8eEDPZO7gxkcGV6G7IAJ2tr8iDp07Fs6J7BnImcK5J3EmHVIT2Dvp2YTVJMu/y1+X+jiFQ84LtK9mLHr0aqh+K15PwkWRDaPrcbU5WdMKILtCDMF5hSgQEdJlw/36D7eRYqPfsVNVBcMsNH2QQKq/p957Yr8RfWIE22t7L7ABwAA`
r, _ := base64.StdEncoding.DecodeString(warn)
gzr, _ := gzip.NewReader(bytes.NewReader([]byte(r)))
w, _ := io.ReadAll(gzr)
klog.Warningf("%s\nWarning: you're running under the Spanner emulator - this is not a supported environment!\n\n", string(w))

// Hack in a workaround for spannertest not supporting BatchWrites
f.updateIndex = emulatorWorkaroundUpdateIndexTx
}

return f
}

Expand Down Expand Up @@ -460,3 +476,10 @@ func createAndPrepareTables(ctx context.Context, spannerDB string, ddl []string,
}
return nil
}

// emulatorWorkaroundUpdateIndexTx is a workaround for spannertest not supporting BatchWrites.
// We use this func as a replacement for follower's updateIndex hook, and simply commit the index
// updates inline with the larger transaction.
func emulatorWorkaroundUpdateIndexTx(_ context.Context, txn *spanner.ReadWriteTransaction, ms []*spanner.Mutation) error {
return txn.BufferWrite(ms)
}
13 changes: 0 additions & 13 deletions storage/gcp/antispam/gcp_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,11 @@
package gcp

import (
"context"
"crypto/sha256"
"os"
"testing"
"time"

"cloud.google.com/go/spanner"
"cloud.google.com/go/spanner/spannertest"
"github.com/transparency-dev/tessera"
"github.com/transparency-dev/tessera/api"
Expand Down Expand Up @@ -78,8 +76,6 @@ func TestAntispamStorage(t *testing.T) {
}()

f := as.Follower(testBundleHasher)
// Hack in a workaround for spannertest not supporting BatchWrites
f.(*follower).updateIndex = updateIndexTx

go f.Follow(t.Context(), fl.LogReader)

Expand Down Expand Up @@ -168,8 +164,6 @@ func TestAntispamPushbackRecovers(t *testing.T) {
}()

f := as.Follower(testBundleHasher)
// Hack in a workaround for spannertest not supporting BatchWrites
f.(*follower).updateIndex = updateIndexTx

entryIndex := make(map[string]uint64)
a := tessera.NewPublicationAwaiter(t.Context(), fl.LogReader.ReadCheckpoint, 100*time.Millisecond)
Expand Down Expand Up @@ -249,10 +243,3 @@ func testBundleHasher(b []byte) ([][]byte, error) {
}
return r, err
}

// updateIndexTx is a workaround for spannertest not supporting BatchWrites.
// We use this func as a replacement for follower's updateIndex hook, and simply commit the index
// updates inline with the larger transaction.
func updateIndexTx(_ context.Context, txn *spanner.ReadWriteTransaction, ms []*spanner.Mutation) error {
return txn.BufferWrite(ms)
}
Loading