Add dynamic admin panel for managing entities (#108)

ent/admin/extension.go

@@ -0,0 +1,97 @@
+package admin
+
+import (
+	"embed"
+	"strings"
+	"text/template"
+	"unicode"
+
+	"entgo.io/ent/entc"
+	"entgo.io/ent/entc/gen"
+	"entgo.io/ent/schema/field"
+)
+
+var (
+	//go:embed templates
+	templateDir embed.FS
+)
+
+// Extension is the Ent extension that generates code to support the entity admin panel.
+type Extension struct {
+	entc.DefaultExtension
+}
+
+func (*Extension) Templates() []*gen.Template {
+	return []*gen.Template{
+		gen.MustParse(
+			gen.NewTemplate("admin").
+				Funcs(template.FuncMap{
+					"fieldName":      fieldName,
+					"fieldLabel":     FieldLabel,
+					"fieldIsPointer": fieldIsPointer,
+				}).
+				ParseFS(templateDir, "templates/*tmpl"),
+		),
+	}
+}
+
+// fieldName provides a struct field name from an entity field name (ie, user_id -> UserID).
+func fieldName(name string) string {
+	if len(name) == 0 {
+		return name
+	}
+
+	parts := strings.Split(name, "_")
+	for i := 0; i < len(parts); i++ {
+		if parts[i] == "id" {
+			parts[i] = "ID"
+		} else {
+			parts[i] = upperFirst(parts[i])
+		}
+	}
+
+	return strings.Join(parts, "")
+}
+
+// FieldLabel provides a label for an entity field name (ie, user_id -> User ID).
+func FieldLabel(name string) string {
+	if len(name) == 0 {
+		return name
+	}
+
+	parts := strings.Split(name, "_")
+	for i := 0; i < len(parts); i++ {
+		if parts[i] == "id" {
+			parts[i] = "ID"
+		}
+		if i == 0 {
+			parts[i] = upperFirst(parts[i])
+		}
+	}
+
+	return strings.Join(parts, " ")
+}
+
+// fieldIsPointer determines if a given entity field should be a pointer on the struct.
+func fieldIsPointer(f *gen.Field) bool {
+	switch {
+	case f.Type.Type == field.TypeBool:
+		return false
+	case f.Optional,
+		f.Default,
+		f.Sensitive(),
+		f.Nillable:
+		return true
+	}
+	return false
+}
+
+// upperFirst uppercases the first character of a given string.
+func upperFirst(s string) string {
+	if len(s) == 0 {
+		return s
+	}
+	out := []rune(s)
+	out[0] = unicode.ToUpper(out[0])
+	return string(out)
+}

ent/admin/handler.go

@@ -0,0 +1,319 @@
+// Code generated by ent, DO NOT EDIT.
+package admin
+
+import (
+	"fmt"
+	"net/url"
+	"strconv"
+	"time"
+
+	"entgo.io/ent/dialect/sql"
+	"github.com/labstack/echo/v4"
+
+	"github.com/mikestefanello/pagoda/ent"
+	"github.com/mikestefanello/pagoda/ent/passwordtoken"
+	"github.com/mikestefanello/pagoda/ent/user"
+)
+
+const dateTimeFormat = "2006-01-02T15:04:05"
+const dateTimeFormatNoSeconds = "2006-01-02T15:04"
+
+type Handler struct {
+	client *ent.Client
+	Config HandlerConfig
+}
+
+func NewHandler(client *ent.Client, cfg HandlerConfig) *Handler {
+	return &Handler{
+		client: client,
+		Config: cfg,
+	}
+}
+
+func (h *Handler) Create(ctx echo.Context, entityType string) error {
+	switch entityType {
+	case "PasswordToken":
+		return h.PasswordTokenCreate(ctx)
+	case "User":
+		return h.UserCreate(ctx)
+	default:
+		return fmt.Errorf("unsupported entity type: %s", entityType)
+	}
+}
+
+func (h *Handler) Get(ctx echo.Context, entityType string, id int) (url.Values, error) {
+	switch entityType {
+	case "PasswordToken":
+		return h.PasswordTokenGet(ctx, id)
+	case "User":
+		return h.UserGet(ctx, id)
+	default:
+		return nil, fmt.Errorf("unsupported entity type: %s", entityType)
+	}
+}
+
+func (h *Handler) Delete(ctx echo.Context, entityType string, id int) error {
+	switch entityType {
+	case "PasswordToken":
+		return h.PasswordTokenDelete(ctx, id)
+	case "User":
+		return h.UserDelete(ctx, id)
+	default:
+		return fmt.Errorf("unsupported entity type: %s", entityType)
+	}
+}
+
+func (h *Handler) Update(ctx echo.Context, entityType string, id int) error {
+	switch entityType {
+	case "PasswordToken":
+		return h.PasswordTokenUpdate(ctx, id)
+	case "User":
+		return h.UserUpdate(ctx, id)
+	default:
+		return fmt.Errorf("unsupported entity type: %s", entityType)
+	}
+}
+
+func (h *Handler) List(ctx echo.Context, entityType string) (*EntityList, error) {
+	switch entityType {
+	case "PasswordToken":
+		return h.PasswordTokenList(ctx)
+	case "User":
+		return h.UserList(ctx)
+	default:
+		return nil, fmt.Errorf("unsupported entity type: %s", entityType)
+	}
+}
+
+func (h *Handler) PasswordTokenCreate(ctx echo.Context) error {
+	var payload PasswordToken
+	if err := h.bind(ctx, &payload); err != nil {
+		return err
+	}
+
+	op := h.client.PasswordToken.Create()
+	if payload.Token != nil {
+		op.SetToken(*payload.Token)
+	}
+	op.SetUserID(payload.UserID)
+	if payload.CreatedAt != nil {
+		op.SetCreatedAt(*payload.CreatedAt)
+	}
+	_, err := op.Save(ctx.Request().Context())
+	return err
+}
+
+func (h *Handler) PasswordTokenUpdate(ctx echo.Context, id int) error {
+	entity, err := h.client.PasswordToken.Get(ctx.Request().Context(), id)
+	if err != nil {
+		return err
+	}
+
+	var payload PasswordToken
+	if err = h.bind(ctx, &payload); err != nil {
+		return err
+	}
+
+	op := entity.Update()
+	if payload.Token != nil {
+		op.SetToken(*payload.Token)
+	}
+	op.SetUserID(payload.UserID)
+	if payload.CreatedAt == nil {
+		var empty time.Time
+		op.SetCreatedAt(empty)
+	} else {
+		op.SetCreatedAt(*payload.CreatedAt)
+	}
+	_, err = op.Save(ctx.Request().Context())
+	return err
+}
+
+func (h *Handler) PasswordTokenDelete(ctx echo.Context, id int) error {
+	return h.client.PasswordToken.DeleteOneID(id).
+		Exec(ctx.Request().Context())
+}
+
+func (h *Handler) PasswordTokenList(ctx echo.Context) (*EntityList, error) {
+	page, offset := h.getPageAndOffset(ctx)
+	res, err := h.client.PasswordToken.
+		Query().
+		Limit(h.Config.ItemsPerPage + 1).
+		Offset(offset).
+		Order(passwordtoken.ByID(sql.OrderDesc())).
+		All(ctx.Request().Context())
+
+	if err != nil {
+		return nil, err
+	}
+
+	list := &EntityList{
+		Columns: []string{
+			"User ID",
+			"Created at",
+		},
+		Entities:    make([]EntityValues, 0, len(res)),
+		Page:        page,
+		HasNextPage: len(res) > h.Config.ItemsPerPage,
+	}
+
+	for i := 0; i <= len(res)-1; i++ {
+		list.Entities = append(list.Entities, EntityValues{
+			ID: res[i].ID,
+			Values: []string{
+				fmt.Sprint(res[i].UserID),
+				res[i].CreatedAt.Format(h.Config.TimeFormat),
+			},
+		})
+	}
+
+	return list, err
+}
+
+func (h *Handler) PasswordTokenGet(ctx echo.Context, id int) (url.Values, error) {
+	entity, err := h.client.PasswordToken.Get(ctx.Request().Context(), id)
+	if err != nil {
+		return nil, err
+	}
+
+	v := url.Values{}
+	v.Set("user_id", fmt.Sprint(entity.UserID))
+	v.Set("created_at", entity.CreatedAt.Format(dateTimeFormat))
+	return v, err
+}
+
+func (h *Handler) UserCreate(ctx echo.Context) error {
+	var payload User
+	if err := h.bind(ctx, &payload); err != nil {
+		return err
+	}
+
+	op := h.client.User.Create()
+	op.SetName(payload.Name)
+	op.SetEmail(payload.Email)
+	if payload.Password != nil {
+		op.SetPassword(*payload.Password)
+	}
+	op.SetVerified(payload.Verified)
+	op.SetAdmin(payload.Admin)
+	if payload.CreatedAt != nil {
+		op.SetCreatedAt(*payload.CreatedAt)
+	}
+	_, err := op.Save(ctx.Request().Context())
+	return err
+}
+
+func (h *Handler) UserUpdate(ctx echo.Context, id int) error {
+	entity, err := h.client.User.Get(ctx.Request().Context(), id)
+	if err != nil {
+		return err
+	}
+
+	var payload User
+	if err = h.bind(ctx, &payload); err != nil {
+		return err
+	}
+
+	op := entity.Update()
+	op.SetName(payload.Name)
+	op.SetEmail(payload.Email)
+	if payload.Password != nil {
+		op.SetPassword(*payload.Password)
+	}
+	op.SetVerified(payload.Verified)
+	op.SetAdmin(payload.Admin)
+	_, err = op.Save(ctx.Request().Context())
+	return err
+}
+
+func (h *Handler) UserDelete(ctx echo.Context, id int) error {
+	return h.client.User.DeleteOneID(id).
+		Exec(ctx.Request().Context())
+}
+
+func (h *Handler) UserList(ctx echo.Context) (*EntityList, error) {
+	page, offset := h.getPageAndOffset(ctx)
+	res, err := h.client.User.
+		Query().
+		Limit(h.Config.ItemsPerPage + 1).
+		Offset(offset).
+		Order(user.ByID(sql.OrderDesc())).
+		All(ctx.Request().Context())
+
+	if err != nil {
+		return nil, err
+	}
+
+	list := &EntityList{
+		Columns: []string{
+			"Name",
+			"Email",
+			"Verified",
+			"Admin",
+			"Created at",
+		},
+		Entities:    make([]EntityValues, 0, len(res)),
+		Page:        page,
+		HasNextPage: len(res) > h.Config.ItemsPerPage,
+	}
+
+	for i := 0; i <= len(res)-1; i++ {
+		list.Entities = append(list.Entities, EntityValues{
+			ID: res[i].ID,
+			Values: []string{
+				res[i].Name,
+				res[i].Email,
+				fmt.Sprint(res[i].Verified),
+				fmt.Sprint(res[i].Admin),
+				res[i].CreatedAt.Format(h.Config.TimeFormat),
+			},
+		})
+	}
+
+	return list, err
+}
+
+func (h *Handler) UserGet(ctx echo.Context, id int) (url.Values, error) {
+	entity, err := h.client.User.Get(ctx.Request().Context(), id)
+	if err != nil {
+		return nil, err
+	}
+
+	v := url.Values{}
+	v.Set("name", entity.Name)
+	v.Set("email", entity.Email)
+	v.Set("verified", fmt.Sprint(entity.Verified))
+	v.Set("admin", fmt.Sprint(entity.Admin))
+	return v, err
+}
+
+func (h *Handler) getPageAndOffset(ctx echo.Context) (int, int) {
+	if page, err := strconv.Atoi(ctx.QueryParam(h.Config.PageQueryKey)); err == nil {
+		if page > 1 {
+			return page, (page - 1) * h.Config.ItemsPerPage
+		}
+	}
+	return 1, 0
+}
+
+func (h *Handler) bind(ctx echo.Context, entity any) error {
+	// Echo requires some pre-processing of form values to avoid problems.
+	for k, v := range ctx.Request().Form {
+		// Remove empty field values so Echo's bind does not fail when trying to parse things like
+		// times, etc.
+		if len(v) == 1 && len(v[0]) == 0 {
+			delete(ctx.Request().Form, k)
+			continue
+		}
+
+		// Echo expects datetime values to be in a certain format but that does not align with the datetime-local
+		// HTML form element format, so we will attempt to convert it here.
+		for _, format := range []string{dateTimeFormatNoSeconds, dateTimeFormat} {
+			if t, err := time.Parse(format, v[0]); err == nil {
+				ctx.Request().Form[k][0] = t.Format(time.RFC3339)
+				break
+			}
+		}
+	}
+	return ctx.Bind(entity)
+}

ent/admin/templates/handler.tmpl

@@ -0,0 +1,262 @@
+{{/* Tell Intellij/GoLand to enable the autocompletion based on the *gen.Graph type. */}}
+{{/* gotype: entgo.io/ent/entc/gen.Graph */}}
+
+{{ define "admin/handler" }}
+    // Code generated by ent, DO NOT EDIT.
+    {{- $pkg := base $.Config.Package }}
+    package admin
+
+    import (
+        "fmt"
+        "net/url"
+        "strconv"
+
+        "entgo.io/ent/dialect/sql"
+        "github.com/labstack/echo/v4"
+
+        "{{ $.Config.Package }}"
+        {{- range $n := $.Nodes }}
+            "{{ $.Config.Package }}/{{ $n.Package }}"
+        {{- end }}
+    )
+
+    const dateTimeFormat = "2006-01-02T15:04:05"
+    const dateTimeFormatNoSeconds = "2006-01-02T15:04"
+
+    type Handler struct {
+        client *{{ $pkg }}.Client
+        Config HandlerConfig
+    }
+
+    func NewHandler(client *{{ $pkg }}.Client, cfg HandlerConfig) *Handler {
+        return &Handler{
+            client: client,
+            Config: cfg,
+        }
+    }
+
+    func (h *Handler) Create(ctx echo.Context, entityType string) error {
+        switch entityType {
+        {{- range $n := $.Nodes }}
+        case "{{ $n.Name }}":
+            return h.{{ $n.Name }}Create(ctx)
+        {{- end }}
+        default:
+            return fmt.Errorf("unsupported entity type: %s", entityType)
+        }
+    }
+
+    func (h *Handler) Get(ctx echo.Context, entityType string, id int) (url.Values, error) {
+        switch entityType {
+        {{- range $n := $.Nodes }}
+        case "{{ $n.Name }}":
+            return h.{{ $n.Name }}Get(ctx, id)
+        {{- end }}
+        default:
+            return nil, fmt.Errorf("unsupported entity type: %s", entityType)
+        }
+    }
+
+    func (h *Handler) Delete(ctx echo.Context, entityType string, id int) error {
+        switch entityType {
+        {{- range $n := $.Nodes }}
+        case "{{ $n.Name }}":
+            return h.{{ $n.Name }}Delete(ctx, id)
+        {{- end }}
+        default:
+            return fmt.Errorf("unsupported entity type: %s", entityType)
+        }
+    }
+
+    func (h *Handler) Update(ctx echo.Context, entityType string, id int) error {
+        switch entityType {
+        {{- range $n := $.Nodes }}
+        case "{{ $n.Name }}":
+            return h.{{ $n.Name }}Update(ctx, id)
+        {{- end }}
+        default:
+            return fmt.Errorf("unsupported entity type: %s", entityType)
+        }
+    }
+
+    func (h *Handler) List(ctx echo.Context, entityType string) (*EntityList, error) {
+        switch entityType {
+        {{- range $n := $.Nodes }}
+        case "{{ $n.Name }}":
+            return h.{{ $n.Name }}List(ctx)
+        {{- end }}
+        default:
+            return nil, fmt.Errorf("unsupported entity type: %s", entityType)
+        }
+    }
+
+    {{ range $n := $.Nodes }}
+        func (h *Handler) {{ $n.Name }}Create(ctx echo.Context) error {
+            var payload {{ $n.Name }}
+            if err := h.bind(ctx, &payload); err != nil {
+                return err
+            }
+
+            op := h.client.{{ $n.Name }}.Create()
+            {{- range $f := $n.Fields }}
+                {{- if (fieldIsPointer $f) }}
+                    if payload.{{ fieldName $f.Name }} != nil {
+                        op.Set{{ fieldName $f.Name }}(*payload.{{ fieldName $f.Name }})
+                    }
+                {{- else }}
+                    op.Set{{ fieldName $f.Name }}(payload.{{ fieldName $f.Name }})
+                {{- end }}
+            {{- end }}
+            _, err := op.Save(ctx.Request().Context())
+            return err
+        }
+
+        func (h *Handler) {{ $n.Name }}Update(ctx echo.Context, id int) error {
+            entity, err := h.client.{{ $n.Name }}.Get(ctx.Request().Context(), id)
+            if err != nil {
+                return err
+            }
+
+            var payload {{ $n.Name }}
+            if err = h.bind(ctx, &payload); err != nil {
+                return err
+            }
+
+            op := entity.Update()
+            {{- range $f := $n.Fields }}
+                {{- if not $f.Immutable }}
+                    {{- if $f.Sensitive }}
+                        if payload.{{ fieldName $f.Name }} != nil {
+                            op.Set{{ fieldName $f.Name }}(*payload.{{ fieldName $f.Name }})
+                        }
+                    {{- else if $f.Nillable }}
+                        op.SetNillable{{ fieldName $f.Name }}(payload.{{ fieldName $f.Name }})
+                    {{- else if $f.Optional }}
+                        if payload.{{ fieldName $f.Name }} == nil {
+                            op.Clear{{ fieldName $f.Name }}()
+                        } else {
+                            op.Set{{ fieldName $f.Name }}(*payload.{{ fieldName $f.Name }})
+                        }
+                    {{- else if (fieldIsPointer $f) }}
+                        if payload.{{ fieldName $f.Name }} == nil {
+                            var empty {{ $f.Type }}
+                            op.Set{{ fieldName $f.Name }}(empty)
+                        } else {
+                            op.Set{{ fieldName $f.Name }}(*payload.{{ fieldName $f.Name }})
+                        }
+                    {{- else }}
+                        op.Set{{ fieldName $f.Name }}(payload.{{ fieldName $f.Name }})
+                    {{- end }}
+                {{- end }}
+            {{- end }}
+            _, err = op.Save(ctx.Request().Context())
+            return err
+        }
+
+        func (h *Handler) {{ $n.Name }}Delete(ctx echo.Context, id int) error {
+            return h.client.{{ $n.Name }}.DeleteOneID(id).
+                Exec(ctx.Request().Context())
+        }
+
+        func (h *Handler) {{ $n.Name }}List(ctx echo.Context) (*EntityList, error) {
+            page, offset := h.getPageAndOffset(ctx)
+            res, err := h.client.{{ $n.Name }}.
+                Query().
+                Limit(h.Config.ItemsPerPage+1).
+                Offset(offset).
+                Order({{ $n.Package }}.ByID(sql.OrderDesc())).
+                All(ctx.Request().Context())
+
+            if err != nil {
+                return nil, err
+            }
+
+            list := &EntityList{
+                Columns: []string{
+                    {{- range $f := $n.Fields }}
+                        {{- if not $f.Sensitive }}
+                            "{{ fieldLabel $f.Name }}",
+                        {{- end }}
+                    {{- end }}
+                },
+                Entities: make([]EntityValues, 0, len(res)),
+                Page: page,
+                HasNextPage: len(res) > h.Config.ItemsPerPage,
+            }
+
+            for i := 0; i <= len(res)-1; i++ {
+                list.Entities = append(list.Entities, EntityValues{
+                    ID: res[i].ID,
+                    Values: []string{
+                    {{- range $f := $n.Fields }}
+                        {{- if not $f.Sensitive }}
+                            {{- if eq $f.Type.String "string" }}
+                                res[i].{{ fieldName $f.Name }},
+                            {{- else if eq $f.Type.String "time.Time" }}
+                                res[i].{{ fieldName $f.Name }}.Format(h.Config.TimeFormat),
+                            {{- else }}
+                                fmt.Sprint(res[i].{{ fieldName $f.Name }}),
+                            {{- end }}
+                        {{- end }}
+                    {{- end }}
+                    },
+                })
+            }
+
+            return list, err
+        }
+
+        func (h *Handler) {{ $n.Name }}Get(ctx echo.Context, id int) (url.Values, error) {
+            entity, err := h.client.{{ $n.Name }}.Get(ctx.Request().Context(), id)
+            if err != nil {
+                return nil, err
+            }
+
+            v := url.Values{}
+            {{- range $f := $n.Fields }}
+                {{- if and (not $f.Sensitive) (not $f.Immutable) }}
+                    {{- if eq $f.Type.String "string" }}
+                        v.Set("{{ $f.Name }}", entity.{{ fieldName $f.Name }})
+                    {{- else if eq $f.Type.String "time.Time" }}
+                        v.Set("{{ $f.Name }}", entity.{{ fieldName $f.Name }}.Format(dateTimeFormat))
+                    {{- else }}
+                        v.Set("{{ $f.Name }}", fmt.Sprint(entity.{{ fieldName $f.Name }}))
+                    {{- end }}
+                {{- end }}
+            {{- end }}
+            return v, err
+        }
+    {{ end }}
+
+    func (h *Handler) getPageAndOffset(ctx echo.Context) (int, int) {
+        if page, err := strconv.Atoi(ctx.QueryParam(h.Config.PageQueryKey)); err == nil {
+            if page > 1 {
+                return page, (page-1) * h.Config.ItemsPerPage
+            }
+        }
+        return 1, 0
+    }
+
+    func (h *Handler) bind(ctx echo.Context, entity any) error {
+        // Echo requires some pre-processing of form values to avoid problems.
+        for k, v := range ctx.Request().Form {
+            // Remove empty field values so Echo's bind does not fail when trying to parse things like
+            // times, etc.
+            if len(v) == 1 && len(v[0]) == 0 {
+                delete(ctx.Request().Form, k)
+                continue
+            }
+
+            // Echo expects datetime values to be in a certain format but that does not align with the datetime-local
+            // HTML form element format, so we will attempt to convert it here.
+            for _, format := range []string{dateTimeFormatNoSeconds, dateTimeFormat} {
+                if t, err := time.Parse(format, v[0]); err == nil {
+                    ctx.Request().Form[k][0] = t.Format(time.RFC3339)
+                    break
+                }
+            }
+        }
+        return ctx.Bind(entity)
+    }
+
+{{ end }}

ent/admin/templates/types.tmpl

@@ -0,0 +1,42 @@
+{{/* Tell Intellij/GoLand to enable the autocompletion based on the *gen.Graph type. */}}
+{{/* gotype: entgo.io/ent/entc/gen.Graph */}}
+
+{{ define "admin/types" }}
+    // Code generated by ent, DO NOT EDIT.
+    package admin
+
+    {{- range $n := $.Nodes }}
+        type {{ $n.Name }} struct {
+            {{- range $f := $n.Fields }}
+                {{ fieldName $f.Name }} {{ if (fieldIsPointer $f) }}*{{ end }}{{ $f.Type }} `form:"{{ $f.Name }}"`
+            {{- end }}
+        }
+    {{ end }}
+
+    type EntityList struct {
+        Columns []string
+        Entities []EntityValues
+        Page int
+        HasNextPage bool
+    }
+
+    type EntityValues struct {
+        ID int
+        Values []string
+    }
+
+    type HandlerConfig struct {
+    	ItemsPerPage int
+    	PageQueryKey string
+    	TimeFormat string
+    }
+
+    func GetEntityTypeNames() []string {
+        return []string{
+            {{- range $n := $.Nodes }}
+                "{{ $n.Name }}",
+            {{- end }}
+        }
+    }
+
+{{ end }}

ent/admin/types.go

@@ -0,0 +1,44 @@
+// Code generated by ent, DO NOT EDIT.
+package admin
+
+import "time"
+
+type PasswordToken struct {
+	Token     *string    `form:"token"`
+	UserID    int        `form:"user_id"`
+	CreatedAt *time.Time `form:"created_at"`
+}
+
+type User struct {
+	Name      string     `form:"name"`
+	Email     string     `form:"email"`
+	Password  *string    `form:"password"`
+	Verified  bool       `form:"verified"`
+	Admin     bool       `form:"admin"`
+	CreatedAt *time.Time `form:"created_at"`
+}
+
+type EntityList struct {
+	Columns     []string
+	Entities    []EntityValues
+	Page        int
+	HasNextPage bool
+}
+
+type EntityValues struct {
+	ID     int
+	Values []string
+}
+
+type HandlerConfig struct {
+	ItemsPerPage int
+	PageQueryKey string
+	TimeFormat   string
+}
+
+func GetEntityTypeNames() []string {
+	return []string{
+		"PasswordToken",
+		"User",
+	}
+}