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

stackrox · Jul 24, 2023 · baad7ef · baad7ef
1 parent 28823ac
commit baad7ef
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 16 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
@@ -205,6 +205,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}}

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
@@ -19,5 +19,5 @@ 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)
 }
diff --git a/tools/generate-helpers/pg-table-bindings/testuuidkey/postgres/store.go b/tools/generate-helpers/pg-table-bindings/testuuidkey/postgres/store.go