make pebble the clear choice

.github/workflows/bench.yml

@@ -0,0 +1,21 @@
+# runs benchmarks on the pebble and goleveldb backends
+name: Benchmarks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+    benchmarks:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v4
+          - uses: actions/setup-go@v3
+            with:
+              go-version: 1.21
+          - name: Run benchmarks
+            run: go test -bench=.

.golangci.yml

@@ -1,51 +1,113 @@
-linters:
+run:
   tests: true
+  timeout: 10m
+
+linters:
   disable-all: true
   enable:
-    - bodyclose
-    - depguard
-    - dogsled
-    - dupl
+    - exportloopref
     - errcheck
+    - gci
     - goconst
     - gocritic
     - gofumpt
     - gosec
     - gosimple
     - govet
     - ineffassign
-    - lll
     - misspell
     - nakedret
-    - prealloc
     - staticcheck
+    - thelper
+    - typecheck
     - stylecheck
+    - revive
     - typecheck
+    - tenv
     - unconvert
+    # Prefer unparam over revive's unused param. It is more thorough in its checking.
     - unparam
     - unused
-    - nolintlint
+    - misspell
 
 issues:
+  exclude-rules:
+    - text: 'differs only by capitalization to method'
+      linters:
+        - revive
+    - text: 'Use of weak random number generator'
+      linters:
+        - gosec
+    - linters:
+        - staticcheck
+      text: "SA1019:" # silence errors on usage of deprecated funcs
+
+  max-issues-per-linter: 10000
+  max-same-issues: 10000
+
 linters-settings:
-  errcheck:
-    check-blank: true
-  depguard:
+  gci:
+    sections:
+      - standard # Standard section: captures all standard packages.
+      - default # Default section: contains all imports that could not be matched to another section type.
+      - blank # blank imports
+      - dot # dot imports
+      - prefix(github.com/cometbft/cometbft-db)
+    custom-order: true
+  revive:
+    enable-all-rules: true
+    # Do NOT whine about the following, full explanation found in:
+    # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#description-of-available-rules
     rules:
-      main:
-        files:
-          - $all
-          - "!$test"
-        allow:
-          - $gostd
-          - github.com/cometbft
-          - github.com/syndtr/goleveldb/leveldb
-          - github.com/google/btree
-      test:
-        files:
-          - $test
-        allow:
-          - $gostd
-          - github.com/cometbft
-          - github.com/syndtr/goleveldb/leveldb
-          - github.com/stretchr/testify
+      - name: use-any
+        disabled: true
+      - name: if-return
+        disabled: true
+      - name: max-public-structs
+        disabled: true
+      - name: cognitive-complexity
+        disabled: true
+      - name: argument-limit
+        disabled: true
+      - name: cyclomatic
+        disabled: true
+      - name: file-header
+        disabled: true
+      - name: function-length
+        disabled: true
+      - name: function-result-limit
+        disabled: true
+      - name: line-length-limit
+        disabled: true
+      - name: flag-parameter
+        disabled: true
+      - name: add-constant
+        disabled: true
+      - name: empty-lines
+        disabled: true
+      - name: banned-characters
+        disabled: true
+      - name: deep-exit
+        disabled: true
+      - name: confusing-results
+        disabled: true
+      - name: unused-parameter
+        disabled: true
+      - name: modifies-value-receiver
+        disabled: true
+      - name: early-return
+        disabled: true
+      - name: confusing-naming
+        disabled: true
+      - name: defer
+        disabled: true
+      # Disabled in favour of unparam.
+      - name: unused-parameter
+        disabled: true
+      - name: unhandled-error
+        disabled: false
+        arguments:
+          - 'fmt.Printf'
+          - 'fmt.Print'
+          - 'fmt.Println'
+          - 'myFunction'

Makefile

@@ -39,6 +39,10 @@ test-badgerdb:
 	@go test $(PACKAGES) -tags badgerdb -v
 .PHONY: test-badgerdb
 
+test-pebble:
+	@echo "--> Running go test"
+	@go test $(PACKAGES) -tags pebbledb -v
+
 test-all:
 	@echo "--> Running go test"
 	@go test $(PACKAGES) -tags cleveldb,boltdb,rocksdb,grocksdb_clean_link,badgerdb -v
@@ -52,7 +56,6 @@ test-all-with-coverage:
 		-race \
 		-coverprofile=coverage.txt \
 		-covermode=atomic \
-		-tags=memdb,goleveldb,cleveldb,boltdb,rocksdb,grocksdb_clean_link,badgerdb \
 		-v
 .PHONY: test-all-with-coverage
 

backend_test.go

@@ -5,14 +5,15 @@ import (
 	"os"
 	"path/filepath"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
 // Register a test backend for PrefixDB as well, with some unrelated junk data
 func init() {
-	//nolint: errcheck
+	//nolint: errcheck, revive // probably should check errors?
 	registerDBCreator("prefixdb", func(name, dir string) (DB, error) {
 		mdb := NewMemDB()
 		mdb.Set([]byte("a"), []byte{1})
@@ -22,17 +23,25 @@ func init() {
 		mdb.Set([]byte("u"), []byte{21})
 		mdb.Set([]byte("z"), []byte{26})
 		return NewPrefixDB(mdb, []byte("test/")), nil
-	}, false)
+	})
 }
 
 func cleanupDBDir(dir, name string) {
-	err := os.RemoveAll(filepath.Join(dir, name) + ".db")
-	if err != nil {
-		panic(err)
+	for i := 0; i < 5; i++ {
+		err := os.RemoveAll(filepath.Join(dir, name) + ".db")
+		if err != nil {
+			if i == 4 { // If this was the last attempt, panic
+				panic(err)
+			}
+			time.Sleep(time.Second) // Wait for a second before the next attempt
+		} else {
+			break // If there was no error, break the loop
+		}
 	}
 }
 
 func testBackendGetSetDelete(t *testing.T, backend BackendType) {
+	t.Helper()
 	// Default
 	dirname, err := os.MkdirTemp("", fmt.Sprintf("test_backend_%s_", backend))
 	require.Nil(t, err)
@@ -161,6 +170,8 @@ func TestDBIterator(t *testing.T) {
 }
 
 func testDBIterator(t *testing.T, backend BackendType) {
+	t.Helper()
+
 	name := fmt.Sprintf("test_%x", randStr(12))
 	dir := os.TempDir()
 	db, err := NewDB(name, backend, dir)
@@ -317,6 +328,8 @@ func testDBIterator(t *testing.T, backend BackendType) {
 }
 
 func verifyIterator(t *testing.T, itr Iterator, expected []int64, msg string) {
+	t.Helper()
+
 	var list []int64
 	for itr.Valid() {
 		key := itr.Key()
@@ -335,6 +348,8 @@ func TestDBBatch(t *testing.T) {
 }
 
 func testDBBatch(t *testing.T, backend BackendType) {
+	t.Helper()
+
 	name := fmt.Sprintf("test_%x", randStr(12))
 	dir := os.TempDir()
 	db, err := NewDB(name, backend, dir)
@@ -396,8 +411,12 @@ func testDBBatch(t *testing.T, backend BackendType) {
 
 	// it should be possible to close an empty batch, and to re-close a closed batch
 	batch = db.NewBatch()
-	batch.Close()
-	batch.Close()
+	if err := batch.Close(); err != nil {
+		require.NoError(t, err)
+	}
+	if err := batch.Close(); err != nil {
+		require.NoError(t, err)
+	}
 
 	// all other operations on a closed batch should error
 	require.Error(t, batch.Set([]byte("a"), []byte{9}))
@@ -407,6 +426,7 @@ func testDBBatch(t *testing.T, backend BackendType) {
 }
 
 func assertKeyValues(t *testing.T, db DB, expect map[string][]byte) {
+	t.Helper()
 	iter, err := db.Iterator(nil, nil)
 	require.NoError(t, err)
 	defer iter.Close()

badger_db.go

@@ -12,7 +12,7 @@ import (
 	"github.com/dgraph-io/badger/v2"
 )
 
-func init() { registerDBCreator(BadgerDBBackend, badgerDBCreator, true) }
+func init() { registerDBCreator(BadgerDBBackend, badgerDBCreator) }
 
 func badgerDBCreator(dbName, dir string) (DB, error) {
 	return NewBadgerDB(dbName, dir)

boltdb.go

@@ -19,7 +19,7 @@ var (
 func init() {
 	registerDBCreator(BoltDBBackend, func(name, dir string) (DB, error) {
 		return NewBoltDB(name, dir)
-	}, false)
+	})
 }
 
 // BoltDB is a wrapper around etcd's fork of bolt (https://github.com/etcd-io/bbolt).

cleveldb.go

@@ -14,7 +14,7 @@ func init() {
 	dbCreator := func(name string, dir string) (DB, error) {
 		return NewCLevelDB(name, dir)
 	}
-	registerDBCreator(CLevelDBBackend, dbCreator, false)
+	registerDBCreator(CLevelDBBackend, dbCreator)
 }
 
 // CLevelDB uses the C LevelDB database via a Go wrapper.