mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
Jon Ayers
0a7a3da178
The provisioner state for a workspace build was being loaded for every long-lived agent rpc connection. Since this state can be anywhere from kilobytes to megabytes this can gradually cause the `coderd` memory footprint to grow over time. It's also a lot of unnecessary allocations for every query that fetches a workspace build since only a few callers ever actually reference the provisioner state. This PR removes it from the returned workspace build and adds a query to fetch the provisioner state explicitly.
122 lines
4.2 KiB
Go
122 lines
4.2 KiB
Go
package gentest_test
|
|
|
|
import (
|
|
"reflect"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
)
|
|
|
|
// TestAuditDBEnumsCovered ensures that all enums in the database are covered by the codersdk enums
|
|
// for audit log strings.
|
|
func TestAuditDBEnumsCovered(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
dbTypes := database.AllResourceTypeValues()
|
|
for _, ty := range dbTypes {
|
|
str := codersdk.ResourceType(ty).FriendlyString()
|
|
require.NotEqualf(t, "unknown", str, "ResourceType %q not covered by codersdk.ResourceType", ty)
|
|
}
|
|
}
|
|
|
|
// TestViewSubsetTemplate ensures TemplateTable is a subset of Template
|
|
func TestViewSubsetTemplate(t *testing.T) {
|
|
t.Parallel()
|
|
table := reflect.TypeOf(database.TemplateTable{})
|
|
joined := reflect.TypeOf(database.Template{})
|
|
|
|
tableFields := allFields(table)
|
|
joinedFields := allFields(joined)
|
|
if !assert.Subset(t, fieldNames(joinedFields), fieldNames(tableFields), "table is not subset") {
|
|
t.Log("Some fields were added to the Template Table without updating the 'template_with_names' view.")
|
|
t.Log("See migration 000138_join_users.up.sql to create the view.")
|
|
}
|
|
}
|
|
|
|
// TestViewSubsetTemplateVersion ensures TemplateVersionTable is a subset TemplateVersion
|
|
func TestViewSubsetTemplateVersion(t *testing.T) {
|
|
t.Parallel()
|
|
table := reflect.TypeOf(database.TemplateVersionTable{})
|
|
joined := reflect.TypeOf(database.TemplateVersion{})
|
|
|
|
tableFields := allFields(table)
|
|
joinedFields := allFields(joined)
|
|
if !assert.Subset(t, fieldNames(joinedFields), fieldNames(tableFields), "table is not subset") {
|
|
t.Log("Some fields were added to the TemplateVersion Table without updating the 'template_version_with_user' view.")
|
|
t.Log("See migration 000141_join_users_build_version.up.sql to create the view.")
|
|
}
|
|
}
|
|
|
|
// TestViewSubsetWorkspaceBuild ensures WorkspaceBuildTable is a subset of
|
|
// WorkspaceBuild, with the exception of ProvisionerState which is
|
|
// intentionally excluded from the workspace_build_with_user view to avoid
|
|
// loading the large Terraform state blob on hot paths.
|
|
func TestViewSubsetWorkspaceBuild(t *testing.T) {
|
|
t.Parallel()
|
|
table := reflect.TypeOf(database.WorkspaceBuildTable{})
|
|
joined := reflect.TypeOf(database.WorkspaceBuild{})
|
|
|
|
tableFields := fieldNames(allFields(table))
|
|
joinedFields := fieldNames(allFields(joined))
|
|
|
|
// ProvisionerState is intentionally excluded from the
|
|
// workspace_build_with_user view to avoid loading multi-MB Terraform
|
|
// state blobs on hot paths. Callers that need it use
|
|
// GetWorkspaceBuildProvisionerStateByID instead.
|
|
excludedFields := map[string]bool{
|
|
"ProvisionerState": true,
|
|
}
|
|
|
|
var filtered []string
|
|
for _, name := range tableFields {
|
|
if !excludedFields[name] {
|
|
filtered = append(filtered, name)
|
|
}
|
|
}
|
|
|
|
if !assert.Subset(t, joinedFields, filtered, "table is not subset") {
|
|
t.Log("Some fields were added to the WorkspaceBuild Table without updating the 'workspace_build_with_user' view.")
|
|
t.Log("See migration 000141_join_users_build_version.up.sql to create the view.")
|
|
}
|
|
}
|
|
|
|
// TestViewSubsetWorkspace ensures WorkspaceTable is a subset of Workspace
|
|
func TestViewSubsetWorkspace(t *testing.T) {
|
|
t.Parallel()
|
|
table := reflect.TypeOf(database.WorkspaceTable{})
|
|
joined := reflect.TypeOf(database.Workspace{})
|
|
|
|
tableFields := allFields(table)
|
|
joinedFields := allFields(joined)
|
|
if !assert.Subset(t, fieldNames(joinedFields), fieldNames(tableFields), "table is not subset") {
|
|
t.Log("Some fields were added to the Workspace Table without updating the 'workspaces_expanded' view.")
|
|
t.Log("See migration 000262_workspace_with_names.up.sql to create the view.")
|
|
}
|
|
}
|
|
|
|
func fieldNames(fields []reflect.StructField) []string {
|
|
names := make([]string, len(fields))
|
|
for i, field := range fields {
|
|
names[i] = field.Name
|
|
}
|
|
return names
|
|
}
|
|
|
|
func allFields(rt reflect.Type) []reflect.StructField {
|
|
fields := make([]reflect.StructField, 0, rt.NumField())
|
|
for i := 0; i < rt.NumField(); i++ {
|
|
field := rt.Field(i)
|
|
if field.Anonymous && field.Type.Kind() == reflect.Struct {
|
|
// Recurse into anonymous struct fields.
|
|
fields = append(fields, allFields(field.Type)...)
|
|
continue
|
|
}
|
|
fields = append(fields, rt.Field(i))
|
|
}
|
|
return fields
|
|
}
|