refactor(plugin): refactor plugin

Author: vm-001

admin/api/plugins.go

@@ -44,10 +44,7 @@ func (api *API) CreatePlugin(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	p, err := model.Plugin()
-	api.assert(err)
-	model.Config = utils.Must(p.MarshalConfig())
-	err = api.db.PluginsWS.Insert(r.Context(), &model)
+	err := api.db.PluginsWS.Insert(r.Context(), &model)
 	api.assert(err)
 
 	api.json(201, w, model)
@@ -73,11 +70,6 @@ func (api *API) UpdatePlugin(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	p, err := model.Plugin()
-	api.assert(err)
-
-	model.Config = utils.Must(p.MarshalConfig())
-
 	model.ID = id
 	err = api.db.PluginsWS.Update(r.Context(), model)
 	api.assert(err)

db/entities/plugin.go

@@ -1,6 +1,7 @@
 package entities
 
 import (
+	"database/sql/driver"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -44,11 +45,11 @@ func (m *Plugin) Validate() error {
 	}
 
 	// validate plugin configuration
-	p, err := m.Plugin()
+	p, err := m.ToPlugin()
 	if err != nil {
 		return err
 	}
-	if err = p.ValidateConfig(); err != nil {
+	if err = p.ValidateConfig(m.Config); err != nil {
 		if e, ok := err.(*errs.ValidateError); ok {
 			e.Fields = map[string]interface{}{
 				"config": e.Fields,
@@ -57,6 +58,13 @@ func (m *Plugin) Validate() error {
 		}
 		return err
 	}
+
+	err = p.Init(m.Config)
+	if err != nil {
+		return err
+	}
+	m.Config = p.GetConfig()
+
 	return nil
 }
 
@@ -69,44 +77,40 @@ func (m *Plugin) UnmarshalJSON(data []byte) error {
 	return json.Unmarshal(data, (*alias)(m))
 }
 
-func (m *Plugin) Plugin() (plugin.Plugin, error) {
-	r := plugin.GetRegistration(m.Name)
-	if r == nil {
+func (m *Plugin) ToPlugin() (plugin.Plugin, error) {
+	executor, ok := plugin.New(m.Name)
+	if !ok {
 		return nil, fmt.Errorf("unknown plugin name: '%s'", m.Name)
 	}
-
-	executor, err := r.New(m.Config)
-	if err != nil {
-		return nil, err
-	}
 	return executor, nil
 }
 
-type PluginConfiguration json.RawMessage
+type PluginConfiguration map[string]interface{}
 
-func (m PluginConfiguration) MarshalYAML() (interface{}, error) {
-	if len(m) == 0 {
-		return nil, nil
-	}
-	data := make(map[string]interface{})
-	err := json.Unmarshal(m, &data)
-	if err != nil {
-		return nil, err
+func (m PluginConfiguration) GetString(key string, def string) string {
+	val, ok := m[key]
+	if !ok {
+		return def
 	}
-	return data, nil
+	return val.(string)
 }
 
-func (m PluginConfiguration) MarshalJSON() ([]byte, error) {
+func (m *PluginConfiguration) Scan(src interface{}) error {
+	return json.Unmarshal(src.([]byte), m)
+}
+
+func (m PluginConfiguration) Value() (driver.Value, error) {
 	if m == nil {
-		return []byte("null"), nil
+		return []byte(`{}`), nil
 	}
-	return m, nil
+	return json.Marshal(m)
 }
 
 func (m *PluginConfiguration) UnmarshalJSON(data []byte) error {
-	if m == nil {
-		return errors.New("json.RawMessage: UnmarshalJSON on nil pointer")
+	v := make(map[string]interface{})
+	if err := json.Unmarshal(data, &v); err != nil {
+		return err
 	}
-	*m = append((*m)[0:0], data...)
+	*m = v
 	return nil
 }

go.mod

@@ -63,6 +63,7 @@ require (
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.19 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
 	github.com/oasdiff/yaml v0.0.0-20250309154309-f31be36b4037 // indirect
 	github.com/oasdiff/yaml3 v0.0.0-20250309153720-d2182401db90 // indirect

go.sum

@@ -170,6 +170,8 @@ github.com/mattn/go-sqlite3 v1.14.22 h1:2gZY6PC6kBnID23Tichd1K+Z0oS6nE/XwU+Vz/5o
 github.com/mattn/go-sqlite3 v1.14.22/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y=
 github.com/mfridman/tparse v0.18.0 h1:wh6dzOKaIwkUGyKgOntDW4liXSo37qg5AXbIhkMV3vE=
 github.com/mfridman/tparse v0.18.0/go.mod h1:gEvqZTuCgEhPbYk/2lS3Kcxg1GmTxxU7kTC8DvP0i/A=
+github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
+github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/moby/docker-image-spec v1.3.1 h1:jMKff3w6PgbfSa69GfNg+zN/XLhfXJGnEx3Nl2EsFP0=
 github.com/moby/docker-image-spec v1.3.1/go.mod h1:eKmb5VW8vQEh/BAr2yvVNvuiJuY6UIocYsFu/DxxRpo=
 github.com/moby/term v0.5.0 h1:xt8Q1nalod/v7BqbG21f8mQPqH+xAaC9C3N3wfWbVP0=

openapi.yml

@@ -936,7 +936,7 @@ components:
           nullable: true
         config:
           type: object
-          nullable: true
+          default: {}
         metadata:
           $ref: "#/components/schemas/Metadata"
         created_at:
@@ -988,3 +988,33 @@ components:
       required:
         - quota
         - period
+
+
+    WasmPluginConfiguration:
+      type: object
+      properties:
+        file:
+          type: string
+        envs:
+          type: object
+          additionalProperties:
+            type: string
+          default: { }
+      required:
+        - file
+
+    FunctionPluginConfiguration:
+      type: object
+      properties:
+        function:
+          type: string
+          maxLength: 1048576
+      required:
+        - function
+
+    WebhookxSignaturePluginConfiguration:
+      type: object
+      properties:
+        signing_secret:
+          type: string
+          minLength: 1

pkg/declarative/types.go

@@ -54,11 +54,6 @@ func (cfg *Configuration) Validate() error {
 			if err := model.Validate(); err != nil {
 				return err
 			}
-			p, err := model.Plugin()
-			if err != nil {
-				return err
-			}
-			model.Config = utils.Must(p.MarshalConfig())
 		}
 	}
 
@@ -67,11 +62,6 @@ func (cfg *Configuration) Validate() error {
 			if err := model.Validate(); err != nil {
 				return err
 			}
-			p, err := model.Plugin()
-			if err != nil {
-				return err
-			}
-			model.Config = utils.Must(p.MarshalConfig())
 		}
 	}
 

pkg/plugin/base.go

@@ -0,0 +1,46 @@
+package plugin
+
+import (
+	"context"
+	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/mitchellh/mapstructure"
+	"github.com/webhookx-io/webhookx/pkg/openapi"
+	"github.com/webhookx-io/webhookx/utils"
+)
+
+// Configuration plugin configuration
+type Configuration interface {
+	Schema() *openapi3.Schema
+}
+
+type BasePlugin[T Configuration] struct {
+	Config T
+}
+
+func (p *BasePlugin[T]) Init(config map[string]interface{}) error {
+	return mapstructure.Decode(config, &p.Config)
+}
+
+func (p *BasePlugin[T]) GetConfig() map[string]interface{} {
+	m, err := utils.StructToMap(p.Config)
+	if err != nil {
+		panic(err)
+	}
+	return m
+}
+
+func (p *BasePlugin[T]) ValidateConfig(config map[string]interface{}) error {
+	err := openapi.Validate(p.Config.Schema(), config)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *BasePlugin[T]) ExecuteOutbound(ctx context.Context, outbound *Outbound) error {
+	panic("not implemented")
+}
+
+func (p *BasePlugin[T]) ExecuteInbound(ctx context.Context, inbound *Inbound) (InboundResult, error) {
+	panic("not implemented")
+}

pkg/plugin/plugin.go

@@ -1,36 +1,36 @@
 package plugin
 
 import (
-	"encoding/json"
+	"context"
 	"net/http"
 )
 
 type Plugin interface {
-	ExecuteOutbound(outbound *Outbound, context *Context) error
-	ExecuteInbound(inbound *Inbound) (InboundResult, error)
-	ValidateConfig() error
-	MarshalConfig() ([]byte, error)
-}
+	// Name returns plugin's name
+	Name() string
 
-type BasePlugin[T any] struct {
-	Name   string
-	Config T
-}
+	// Init inits plugin with configuration
+	Init(config map[string]interface{}) error
 
-func (p *BasePlugin[T]) UnmarshalConfig(data []byte) error {
-	return json.Unmarshal(data, &p.Config)
-}
+	// GetConfig returns plugin's configuration
+	GetConfig() map[string]interface{}
 
-func (p *BasePlugin[T]) MarshalConfig() ([]byte, error) {
-	return json.Marshal(p.Config)
-}
+	// ValidateConfig validates plugin's configuration
+	ValidateConfig(config map[string]interface{}) error
 
-func (p *BasePlugin[T]) ExecuteOutbound(outbound *Outbound, context *Context) error {
-	panic("not implemented")
+	// ExecuteInbound executes inbound
+	ExecuteInbound(ctx context.Context, inbound *Inbound) (InboundResult, error)
+
+	// ExecuteOutbound executes outbound
+	ExecuteOutbound(ctx context.Context, outbound *Outbound) error
 }
 
-func (p *BasePlugin[T]) ExecuteInbound(inbound *Inbound) (InboundResult, error) {
-	panic("not implemented")
+func New(name string) (Plugin, bool) {
+	r := GetRegistration(name)
+	if r == nil {
+		return nil, false
+	}
+	return r.Factory(), true
 }
 
 type Outbound struct {
@@ -46,10 +46,6 @@ type Inbound struct {
 	RawBody  []byte
 }
 
-type Context struct {
-	//Workspace *entities.Workspace
-}
-
 type InboundResult struct {
 	Terminated bool
 	Payload    []byte

pkg/plugin/registry.go

@@ -12,26 +12,24 @@ const (
 	TypeOutbound Type = "outbound"
 )
 
-type NewPluginFunc func(config []byte) (Plugin, error)
-
 type Registration struct {
-	Type Type
-	New  NewPluginFunc
+	Type    Type
+	Factory func() Plugin
 }
 
 var mux sync.RWMutex
-var registry = make(map[string]*Registration)
+var registry = map[string]*Registration{}
 
-func RegisterPlugin(typ Type, name string, fn NewPluginFunc) {
+func RegisterPlugin(typ Type, name string, fn func() Plugin) {
 	mux.Lock()
 	defer mux.Unlock()
 	if _, ok := registry[name]; ok {
 		panic(fmt.Sprintf("plugin '%s' already registered", name))
 	}
 
 	registry[name] = &Registration{
-		Type: typ,
-		New:  fn,
+		Type:    typ,
+		Factory: fn,
 	}
 }