feat: Add PreResourceResolver to accommodate list/detail pattern (#46)

* feat: Add PreResourceResolver to accomdate list/detail pattern

* fix: Fix some codegen related to preresourceresolver

* Update schema/table.go

Co-authored-by: Herman Schaaf <[email protected]>

Co-authored-by: Herman Schaaf <[email protected]>

Author: yevgenypats

codegen/golang.go

@@ -159,6 +159,7 @@ func NewTableFromStruct(name string, obj interface{}, opts ...TableOptions) (*Ta
 		}
 		t.Columns = append(t.Columns, column)
 	}
+
 	return &t, nil
 }
 

codegen/table.go

@@ -12,13 +12,14 @@ type ResourceDefinition struct {
 type TableDefinition struct {
 	Name        string
 	Description string
-	Columns     []ColumnDefinition
-	Relations   []*TableDefinition
+	Columns     ColumnDefinitions
+	Relations   []string
 
 	Resolver             string
 	IgnoreError          string
 	Multiplex            string
 	PostResourceResolver string
+	PreResourceResolver  string
 	Options              schema.TableCreationOptions
 	nameTransformer      func(string) string
 	skipFields           []string

codegen/templates/table.go.tpl

@@ -5,6 +5,9 @@
     {{- end}}
 		{{- if .Resolver}}
     Resolver:     {{.Resolver}},
+    {{- end}}
+    {{- if .PreResourceResolver}}
+    PreResourceResolver:     {{.PreResourceResolver}},
     {{- end}}
 		{{- if .Multiplex}}
     Multiplex:    {{.Multiplex}},
@@ -17,7 +20,7 @@
 		},
 {{with .Relations}}
 		Relations: []*schema.Table{
-{{range .}}{{template "table.go.tpl" .}}{{end}}
+{{range .}}{{.}}{{end}},
 		},
 {{end}}
 }

schema/resource.go

@@ -72,6 +72,11 @@ func (r *Resource) Set(key string, value interface{}) error {
 	return nil
 }
 
+// Override original item (this is useful for apis that follow list/details pattern)
+func (r *Resource) SetItem(item interface{}) {
+	r.Item = item
+}
+
 func (r *Resource) Id() uuid.UUID {
 	if r.Data[CqIdColumn.Name] == nil {
 		return uuid.UUID{}

schema/table.go

@@ -43,8 +43,12 @@ type Table struct {
 	IgnoreError IgnoreErrorFunc `json:"-"`
 	// Multiplex returns re-purposed meta clients. The sdk will execute the table with each of them
 	Multiplex func(meta ClientMeta) []ClientMeta `json:"-"`
-	// Post resource resolver is called after all columns have been resolved, and before resource is inserted to database.
+	// PostResourceResolver is called after all columns have been resolved, but before the Resource is sent to be inserted. The ordering of resolvers is:
+	//  (Table) Resolver → PreResourceResolver → ColumnResolvers → PostResourceResolver
 	PostResourceResolver RowResolver `json:"-"`
+	// PreResourceResolver is called before all columns are resolved but after Resource is created. The ordering of resolvers is:
+	//  (Table) Resolver → PreResourceResolver → ColumnResolvers → PostResourceResolver
+	PreResourceResolver RowResolver `json:"-"`
 	// Options allow modification of how the table is defined when created
 	Options TableCreationOptions `json:"options"`
 
@@ -200,6 +204,13 @@ func (t Table) Resolve(ctx context.Context, meta ClientMeta, syncTime time.Time,
 		totalResources += len(objects)
 		for i := range objects {
 			resource := NewResourceData(&t, parent, syncTime, objects[i])
+			if t.PreResourceResolver != nil {
+				if err := t.PreResourceResolver(ctx, meta, resource); err != nil {
+					meta.Logger().Error().Str("table_name", t.Name).Err(err).Msg("pre resource resolver failed")
+				} else {
+					meta.Logger().Trace().Str("table_name", t.Name).Msg("pre resource resolver finished successfully")
+				}
+			}
 			t.resolveColumns(ctx, meta, resource)
 			if t.PostResourceResolver != nil {
 				meta.Logger().Trace().Str("table_name", t.Name).Msg("post resource resolver started")
@@ -226,22 +237,22 @@ func (t Table) Resolve(ctx context.Context, meta ClientMeta, syncTime time.Time,
 func (t Table) resolveColumns(ctx context.Context, meta ClientMeta, resource *Resource) {
 	for _, c := range t.Columns {
 		if c.Resolver != nil {
-			meta.Logger().Trace().Str("colum_name", c.Name).Str("table_name", t.Name).Msg("column resolver custom started")
+			meta.Logger().Trace().Str("column_name", c.Name).Str("table_name", t.Name).Msg("column resolver custom started")
 			if err := c.Resolver(ctx, meta, resource, c); err != nil {
-				meta.Logger().Error().Str("colum_name", c.Name).Str("table_name", t.Name).Err(err).Msg("column resolver finished with error")
+				meta.Logger().Error().Str("column_name", c.Name).Str("table_name", t.Name).Err(err).Msg("column resolver finished with error")
 			}
-			meta.Logger().Trace().Str("colum_name", c.Name).Str("table_name", t.Name).Msg("column resolver finished successfully")
+			meta.Logger().Trace().Str("column_name", c.Name).Str("table_name", t.Name).Msg("column resolver finished successfully")
 		} else {
-			meta.Logger().Trace().Str("colum_name", c.Name).Str("table_name", t.Name).Msg("column resolver default started")
+			meta.Logger().Trace().Str("column_name", c.Name).Str("table_name", t.Name).Msg("column resolver default started")
 			// base use case: try to get column with CamelCase name
 			v := funk.Get(resource.Item, strcase.ToCamel(c.Name), funk.WithAllowZero())
 			if v != nil {
 				if err := resource.Set(c.Name, v); err != nil {
-					meta.Logger().Error().Str("colum_name", c.Name).Str("table_name", t.Name).Err(err).Msg("column resolver default finished with error")
+					meta.Logger().Error().Str("column_name", c.Name).Str("table_name", t.Name).Err(err).Msg("column resolver default finished with error")
 				}
-				meta.Logger().Trace().Str("colum_name", c.Name).Str("table_name", t.Name).Msg("column resolver default finished successfully")
+				meta.Logger().Trace().Str("column_name", c.Name).Str("table_name", t.Name).Msg("column resolver default finished successfully")
 			} else {
-				meta.Logger().Trace().Str("colum_name", c.Name).Str("table_name", t.Name).Msg("column resolver default finished successfully with nil")
+				meta.Logger().Trace().Str("column_name", c.Name).Str("table_name", t.Name).Msg("column resolver default finished successfully with nil")
 			}
 		}
 	}