refactor(pg): store empty map as {} not null

stackrox · Jul 25, 2023 · 7d1d2f6 · 7d1d2f6
1 parent 51f5077
commit 7d1d2f6
Show file tree

Hide file tree

Showing 12 changed files with 64 additions and 31 deletions.
diff --git a/central/cluster/store/cluster/postgres/store.go b/central/cluster/store/cluster/postgres/store.go
diff --git a/central/deployment/store/postgres/store.go b/central/deployment/store/postgres/store.go
diff --git a/central/namespace/store/postgres/store.go b/central/namespace/store/postgres/store.go
diff --git a/central/rbac/k8srole/internal/store/postgres/store.go b/central/rbac/k8srole/internal/store/postgres/store.go
diff --git a/central/rbac/k8srolebinding/internal/store/postgres/store.go b/central/rbac/k8srolebinding/internal/store/postgres/store.go
diff --git a/central/serviceaccount/internal/store/postgres/store.go b/central/serviceaccount/internal/store/postgres/store.go
diff --git a/pkg/postgres/pgutils/utils.go b/pkg/postgres/pgutils/utils.go
@@ -76,6 +76,14 @@ func NilOrUUID(value string) *uuid.UUID {
 	return &id
 }
 
+// EmptyOrMap allows for map to be stored explicit as an empty object ({}) rather than null.
+func EmptyOrMap[K comparable, V any, M map[K]V](m M) interface{} {
+	if m == nil {
+		return make(M)
+	}
+	return m
+}
+
 // CreateTableFromModel executes input create statement using the input connection.
 func CreateTableFromModel(ctx context.Context, db *gorm.DB, createStmt *postgres.CreateStmts) {
 	// Partitioned tables are not supported by Gorm migration or models

diff --git a/tools/generate-helpers/pg-table-bindings/multitest/postgres/store.go b/tools/generate-helpers/pg-table-bindings/multitest/postgres/store.go
diff --git a/tools/generate-helpers/pg-table-bindings/store.go.tpl b/tools/generate-helpers/pg-table-bindings/store.go.tpl
@@ -197,6 +197,8 @@ func {{ template "insertFunctionName" $schema }}({{ if eq (len $schema.Children)
         pgutils.NilOrTime({{$field.Getter "obj"}}),
         {{- else if eq $field.SQLType "uuid" }}
         pgutils.NilOrUUID({{$field.Getter "obj"}}),
+        {{- else if eq $field.DataType "map" }}
+        pgutils.EmptyOrMap({{$field.Getter "obj"}}),
         {{- else }}
         {{$field.Getter "obj"}},{{end}}
         {{- end}}
@@ -267,7 +269,9 @@ func {{ template "copyFunctionName" $schema }}(ctx context.Context, s pgSearch.D
             pgutils.NilOrTime({{$field.Getter "obj"}}),
             {{- else if eq $field.SQLType "uuid" }}
             pgutils.NilOrUUID({{$field.Getter "obj"}}),
-            {{- else}}
+            {{- else if eq $field.DataType "map" }}
+            pgutils.EmptyOrMap({{$field.Getter "obj"}}),
+            {{- else }}
             {{$field.Getter "obj"}},{{end}}
             {{- end}}
         })

diff --git a/tools/generate-helpers/pg-table-bindings/test/postgres/store.go b/tools/generate-helpers/pg-table-bindings/test/postgres/store.go
diff --git a/tools/generate-helpers/pg-table-bindings/test/postgres/store_null_map_test.go b/tools/generate-helpers/pg-table-bindings/test/postgres/store_null_map_test.go
@@ -4,6 +4,7 @@ package postgres
 
 import (
 	"context"
+	"fmt"
 
 	"github.com/stackrox/rox/generated/storage"
 	"github.com/stackrox/rox/pkg/sac"
@@ -19,5 +20,25 @@ func (s *TestSingleKeyStructsStoreSuite) TestStoreNilMap() {
 	row := s.testDB.QueryRow(ctx, "select labels from test_single_key_structs")
 	err := row.Scan(&val)
 	s.NoError(err)
-	s.Equal("null", val)
+	s.Equal("{}", val)
+}
+
+func (s *TestSingleKeyStructsStoreSuite) TestStoreNilMapUpsertMany() {
+	ctx := sac.WithAllAccess(context.Background())
+
+	const batchSize = 10000
+	testSingleKeyStructs := make([]*storage.TestSingleKeyStruct, batchSize)
+	for i := range testSingleKeyStructs {
+		testSingleKeyStructs[i] = &storage.TestSingleKeyStruct{
+			Key:  fmt.Sprintf("%d", i),
+			Name: fmt.Sprintf("%d", i),
+		}
+	}
+	s.NoError(s.store.UpsertMany(ctx, testSingleKeyStructs))
+
+	var val string
+	row := s.testDB.QueryRow(ctx, "select labels from test_single_key_structs limit 1")
+	err := row.Scan(&val)
+	s.NoError(err)
+	s.Equal("{}", val)
 }
diff --git a/tools/generate-helpers/pg-table-bindings/testuuidkey/postgres/store.go b/tools/generate-helpers/pg-table-bindings/testuuidkey/postgres/store.go