Add support for additional argument when invoking Corredor script

compose/rest.yaml

@@ -215,6 +215,10 @@ endpoints:
         type: string
         title: Script to execute
         required: true
+      - name: args
+        type: map[string]interface{}
+        parser: parseMapStringInterface
+        title: Arguments to pass to the script
   - name: listTranslations
     method: GET
     title: List translation
@@ -451,6 +455,10 @@ endpoints:
         type: string
         title: Script to execute
         required: true
+      - name: args
+        type: map[string]interface{}
+        parser: parseMapStringInterface
+        title: Arguments to pass to the script
 
   - name: listTranslations
     method: GET
@@ -623,6 +631,10 @@ endpoints:
         type: string
         title: Script to execute
         required: true
+      - name: args
+        type: map[string]interface{}
+        parser: parseMapStringInterface
+        title: Arguments to pass to the script
   - name: listTranslations
     method: GET
     title: List moudle translation
@@ -922,6 +934,10 @@ endpoints:
         type: string
         title: Script to execute
         required: true
+      - name: args
+        type: map[string]interface{}
+        parser: parseMapStringInterface
+        title: Arguments to pass to the script
 - title: Charts
   path: "/namespace/{namespaceID}/chart"
   entrypoint: chart
@@ -1293,3 +1309,7 @@ endpoints:
         type: string
         title: Script to execute
         required: true
+      - name: args
+        type: map[string]interface{}
+        parser: parseMapStringInterface
+        title: Arguments to pass to the script

compose/rest/request/automation.go

@@ -87,6 +87,11 @@ type (
 		//
 		// Script to execute
 		Script string
+
+		// Args POST parameter
+		//
+		// Arguments to pass to the script
+		Args map[string]interface{}
 	}
 )
 
@@ -268,6 +273,7 @@ func NewAutomationTriggerScript() *AutomationTriggerScript {
 func (r AutomationTriggerScript) Auditable() map[string]interface{} {
 	return map[string]interface{}{
 		"script": r.Script,
+		"args":   r.Args,
 	}
 }
 
@@ -276,6 +282,11 @@ func (r AutomationTriggerScript) GetScript() string {
 	return r.Script
 }
 
+// Auditable returns all auditable/loggable parameters
+func (r AutomationTriggerScript) GetArgs() map[string]interface{} {
+	return r.Args
+}
+
 // Fill processes request and fills internal variables
 func (r *AutomationTriggerScript) Fill(req *http.Request) (err error) {
 
@@ -303,6 +314,18 @@ func (r *AutomationTriggerScript) Fill(req *http.Request) (err error) {
 				return err
 			}
 		}
+
+		if val, ok := req.Form["args[]"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		} else if val, ok := req.Form["args"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		}
 	}
 
 	return err

compose/rest/request/module.go

@@ -193,6 +193,11 @@ type (
 		//
 		// Script to execute
 		Script string
+
+		// Args POST parameter
+		//
+		// Arguments to pass to the script
+		Args map[string]interface{}
 	}
 
 	ModuleListTranslations struct {
@@ -733,6 +738,7 @@ func (r ModuleTriggerScript) Auditable() map[string]interface{} {
 		"namespaceID": r.NamespaceID,
 		"moduleID":    r.ModuleID,
 		"script":      r.Script,
+		"args":        r.Args,
 	}
 }
 
@@ -751,6 +757,11 @@ func (r ModuleTriggerScript) GetScript() string {
 	return r.Script
 }
 
+// Auditable returns all auditable/loggable parameters
+func (r ModuleTriggerScript) GetArgs() map[string]interface{} {
+	return r.Args
+}
+
 // Fill processes request and fills internal variables
 func (r *ModuleTriggerScript) Fill(req *http.Request) (err error) {
 
@@ -778,6 +789,18 @@ func (r *ModuleTriggerScript) Fill(req *http.Request) (err error) {
 				return err
 			}
 		}
+
+		if val, ok := req.Form["args[]"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		} else if val, ok := req.Form["args"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		}
 	}
 
 	{

compose/rest/request/namespace.go

@@ -222,6 +222,11 @@ type (
 		//
 		// Script to execute
 		Script string
+
+		// Args POST parameter
+		//
+		// Arguments to pass to the script
+		Args map[string]interface{}
 	}
 
 	NamespaceListTranslations struct {
@@ -980,6 +985,7 @@ func (r NamespaceTriggerScript) Auditable() map[string]interface{} {
 	return map[string]interface{}{
 		"namespaceID": r.NamespaceID,
 		"script":      r.Script,
+		"args":        r.Args,
 	}
 }
 
@@ -993,6 +999,11 @@ func (r NamespaceTriggerScript) GetScript() string {
 	return r.Script
 }
 
+// Auditable returns all auditable/loggable parameters
+func (r NamespaceTriggerScript) GetArgs() map[string]interface{} {
+	return r.Args
+}
+
 // Fill processes request and fills internal variables
 func (r *NamespaceTriggerScript) Fill(req *http.Request) (err error) {
 
@@ -1020,6 +1031,18 @@ func (r *NamespaceTriggerScript) Fill(req *http.Request) (err error) {
 				return err
 			}
 		}
+
+		if val, ok := req.Form["args[]"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		} else if val, ok := req.Form["args"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		}
 	}
 
 	{

compose/rest/request/page.go

@@ -272,6 +272,11 @@ type (
 		//
 		// Script to execute
 		Script string
+
+		// Args POST parameter
+		//
+		// Arguments to pass to the script
+		Args map[string]interface{}
 	}
 
 	PageListTranslations struct {
@@ -1106,6 +1111,7 @@ func (r PageTriggerScript) Auditable() map[string]interface{} {
 		"namespaceID": r.NamespaceID,
 		"pageID":      r.PageID,
 		"script":      r.Script,
+		"args":        r.Args,
 	}
 }
 
@@ -1124,6 +1130,11 @@ func (r PageTriggerScript) GetScript() string {
 	return r.Script
 }
 
+// Auditable returns all auditable/loggable parameters
+func (r PageTriggerScript) GetArgs() map[string]interface{} {
+	return r.Args
+}
+
 // Fill processes request and fills internal variables
 func (r *PageTriggerScript) Fill(req *http.Request) (err error) {
 
@@ -1151,6 +1162,18 @@ func (r *PageTriggerScript) Fill(req *http.Request) (err error) {
 				return err
 			}
 		}
+
+		if val, ok := req.Form["args[]"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		} else if val, ok := req.Form["args"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		}
 	}
 
 	{

compose/rest/request/record.go

@@ -418,6 +418,11 @@ type (
 		//
 		// Script to execute
 		Script string
+
+		// Args POST parameter
+		//
+		// Arguments to pass to the script
+		Args map[string]interface{}
 	}
 )
 
@@ -1773,6 +1778,7 @@ func (r RecordTriggerScriptOnList) Auditable() map[string]interface{} {
 		"namespaceID": r.NamespaceID,
 		"moduleID":    r.ModuleID,
 		"script":      r.Script,
+		"args":        r.Args,
 	}
 }
 
@@ -1791,6 +1797,11 @@ func (r RecordTriggerScriptOnList) GetScript() string {
 	return r.Script
 }
 
+// Auditable returns all auditable/loggable parameters
+func (r RecordTriggerScriptOnList) GetArgs() map[string]interface{} {
+	return r.Args
+}
+
 // Fill processes request and fills internal variables
 func (r *RecordTriggerScriptOnList) Fill(req *http.Request) (err error) {
 
@@ -1818,6 +1829,18 @@ func (r *RecordTriggerScriptOnList) Fill(req *http.Request) (err error) {
 				return err
 			}
 		}
+
+		if val, ok := req.Form["args[]"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		} else if val, ok := req.Form["args"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		}
 	}
 
 	{

compose/rest/request/util.go

@@ -3,6 +3,7 @@ package request
 //lint:file-ignore U1000 Ignore unused code, part of request pkg toolset
 
 import (
+	"encoding/json"
 	"strconv"
 	"strings"
 )
@@ -31,3 +32,13 @@ func (args ProcedureArgs) Get(name string) string {
 
 	return ""
 }
+
+func parseMapStringInterface(ss []string) (map[string]interface{}, error) {
+	if len(ss) == 0 {
+		return nil, nil
+	}
+
+	out := make(map[string]interface{})
+
+	return out, json.Unmarshal([]byte(ss[0]), out)
+}

pkg/corredor/types.go

@@ -1,8 +1,11 @@
 package corredor
 
 import (
+	"encoding/json"
 	"fmt"
 	"strings"
+
+	"github.com/cortezaproject/corteza-server/pkg/eventbus"
 )
 
 type (
@@ -34,6 +37,12 @@ type (
 		Bundle string `json:"bundle,omitempty"`
 		Type   string `json:"type,omitempty"`
 	}
+
+	// allows passing extra kv with event arguments
+	scriptArgs struct {
+		event ScriptArgs
+		extra map[string]interface{}
+	}
 )
 
 // FindByName returns script from the set if it exists
@@ -60,3 +69,62 @@ func (ss *ScriptSecurity) String() (o string) {
 		strings.Join(ss.Deny, ","),
 	)
 }
+
+func ExtendScriptArgs(ev ScriptArgs, args map[string]interface{}) ScriptArgs {
+	return &scriptArgs{
+		event: ev,
+		extra: args,
+	}
+}
+
+func (s *scriptArgs) ResourceType() string {
+	return s.event.ResourceType()
+
+}
+
+func (s *scriptArgs) EventType() string {
+	return s.event.EventType()
+}
+
+func (s *scriptArgs) Match(matcher eventbus.ConstraintMatcher) bool {
+	return s.event.Match(matcher)
+}
+
+func (s *scriptArgs) Encode() (enc map[string][]byte, err error) {
+	if enc, err = s.event.Encode(); err != nil {
+		return nil, err
+	}
+
+	if enc == nil {
+		enc = make(map[string][]byte)
+	}
+
+	for k, v := range s.extra {
+		if enc[k] != nil {
+			// skip all that were encoded
+			// by event encoder
+			continue
+		}
+
+		if enc[k], err = json.Marshal(v); err != nil {
+			return nil, err
+		}
+	}
+
+	return
+}
+
+func (s *scriptArgs) Decode(dec map[string][]byte) (err error) {
+	if err = s.event.Decode(dec); err != nil {
+		return
+	}
+
+	for k := range s.extra {
+		// @todo how do we omit one decoded by event?
+		if err = json.Unmarshal(dec[k], s.extra[k]); err != nil {
+			return
+		}
+	}
+
+	return
+}

system/rest.yaml

@@ -392,6 +392,10 @@ endpoints:
         type: string
         title: Script to execute
         required: true
+      - name: args
+        type: map[string]interface{}
+        parser: parseMapStringInterface
+        title: Arguments to pass to the script
 - title: Users
   path: "/users"
   entrypoint: user
@@ -652,6 +656,10 @@ endpoints:
         type: string
         title: Script to execute
         required: true
+      - name: args
+        type: map[string]interface{}
+        parser: parseMapStringInterface
+        title: Arguments to pass to the script
   - name: sessionsRemove
     method: DELETE
     title: Remove all auth sessions of user
@@ -873,6 +881,10 @@ endpoints:
         type: string
         title: Script to execute
         required: true
+      - name: args
+        type: map[string]interface{}
+        parser: parseMapStringInterface
+        title: Arguments to pass to the script
   - name: reorder
     method: POST
     title: Reorder applications
@@ -1544,6 +1556,10 @@ endpoints:
         type: string
         title: Script to execute
         required: true
+      - name: args
+        type: map[string]interface{}
+        parser: parseMapStringInterface
+        title: Arguments to pass to the script
 - title: Action log
   entrypoint: actionlog
   path: "/actionlog"

system/rest/application.go

@@ -186,7 +186,7 @@ func (ctrl *Application) TriggerScript(ctx context.Context, r *request.Applicati
 	}
 
 	// @todo implement same behaviour as we have on record - Application+oldApplication
-	err = corredor.Service().Exec(ctx, r.Script, event.ApplicationOnManual(application, application))
+	err = corredor.Service().Exec(ctx, r.Script, corredor.ExtendScriptArgs(event.ApplicationOnManual(application, application), r.Args))
 	return application, err
 }
 

system/rest/automation.go

@@ -2,6 +2,7 @@ package rest
 
 import (
 	"context"
+
 	"github.com/cortezaproject/corteza-server/pkg/api"
 	"github.com/cortezaproject/corteza-server/pkg/corredor"
 	"github.com/cortezaproject/corteza-server/system/rest/request"
@@ -46,5 +47,5 @@ func (ctrl *Automation) Bundle(ctx context.Context, r *request.AutomationBundle)
 }
 
 func (ctrl *Automation) TriggerScript(ctx context.Context, r *request.AutomationTriggerScript) (interface{}, error) {
-	return api.OK(), corredor.Service().Exec(ctx, r.Script, event.SystemOnManual())
+	return api.OK(), corredor.Service().Exec(ctx, r.Script, corredor.ExtendScriptArgs(event.SystemOnManual(), r.Args))
 }

system/rest/request/application.go

@@ -228,6 +228,11 @@ type (
 		//
 		// Script to execute
 		Script string
+
+		// Args POST parameter
+		//
+		// Arguments to pass to the script
+		Args map[string]interface{}
 	}
 
 	ApplicationReorder struct {
@@ -933,6 +938,7 @@ func (r ApplicationTriggerScript) Auditable() map[string]interface{} {
 	return map[string]interface{}{
 		"applicationID": r.ApplicationID,
 		"script":        r.Script,
+		"args":          r.Args,
 	}
 }
 
@@ -946,6 +952,11 @@ func (r ApplicationTriggerScript) GetScript() string {
 	return r.Script
 }
 
+// Auditable returns all auditable/loggable parameters
+func (r ApplicationTriggerScript) GetArgs() map[string]interface{} {
+	return r.Args
+}
+
 // Fill processes request and fills internal variables
 func (r *ApplicationTriggerScript) Fill(req *http.Request) (err error) {
 
@@ -973,6 +984,18 @@ func (r *ApplicationTriggerScript) Fill(req *http.Request) (err error) {
 				return err
 			}
 		}
+
+		if val, ok := req.Form["args[]"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		} else if val, ok := req.Form["args"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		}
 	}
 
 	{

system/rest/request/automation.go

@@ -87,6 +87,11 @@ type (
 		//
 		// Script to execute
 		Script string
+
+		// Args POST parameter
+		//
+		// Arguments to pass to the script
+		Args map[string]interface{}
 	}
 )
 
@@ -268,6 +273,7 @@ func NewAutomationTriggerScript() *AutomationTriggerScript {
 func (r AutomationTriggerScript) Auditable() map[string]interface{} {
 	return map[string]interface{}{
 		"script": r.Script,
+		"args":   r.Args,
 	}
 }
 
@@ -276,6 +282,11 @@ func (r AutomationTriggerScript) GetScript() string {
 	return r.Script
 }
 
+// Auditable returns all auditable/loggable parameters
+func (r AutomationTriggerScript) GetArgs() map[string]interface{} {
+	return r.Args
+}
+
 // Fill processes request and fills internal variables
 func (r *AutomationTriggerScript) Fill(req *http.Request) (err error) {
 
@@ -303,6 +314,18 @@ func (r *AutomationTriggerScript) Fill(req *http.Request) (err error) {
 				return err
 			}
 		}
+
+		if val, ok := req.Form["args[]"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		} else if val, ok := req.Form["args"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		}
 	}
 
 	return err

system/rest/request/role.go

@@ -236,6 +236,11 @@ type (
 		//
 		// Script to execute
 		Script string
+
+		// Args POST parameter
+		//
+		// Arguments to pass to the script
+		Args map[string]interface{}
 	}
 )
 
@@ -1051,6 +1056,7 @@ func (r RoleTriggerScript) Auditable() map[string]interface{} {
 	return map[string]interface{}{
 		"roleID": r.RoleID,
 		"script": r.Script,
+		"args":   r.Args,
 	}
 }
 
@@ -1064,6 +1070,11 @@ func (r RoleTriggerScript) GetScript() string {
 	return r.Script
 }
 
+// Auditable returns all auditable/loggable parameters
+func (r RoleTriggerScript) GetArgs() map[string]interface{} {
+	return r.Args
+}
+
 // Fill processes request and fills internal variables
 func (r *RoleTriggerScript) Fill(req *http.Request) (err error) {
 
@@ -1091,6 +1102,18 @@ func (r *RoleTriggerScript) Fill(req *http.Request) (err error) {
 				return err
 			}
 		}
+
+		if val, ok := req.Form["args[]"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		} else if val, ok := req.Form["args"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		}
 	}
 
 	{

system/rest/request/user.go

@@ -266,6 +266,11 @@ type (
 		//
 		// Script to execute
 		Script string
+
+		// Args POST parameter
+		//
+		// Arguments to pass to the script
+		Args map[string]interface{}
 	}
 
 	UserSessionsRemove struct {
@@ -1139,6 +1144,7 @@ func (r UserTriggerScript) Auditable() map[string]interface{} {
 	return map[string]interface{}{
 		"userID": r.UserID,
 		"script": r.Script,
+		"args":   r.Args,
 	}
 }
 
@@ -1152,6 +1158,11 @@ func (r UserTriggerScript) GetScript() string {
 	return r.Script
 }
 
+// Auditable returns all auditable/loggable parameters
+func (r UserTriggerScript) GetArgs() map[string]interface{} {
+	return r.Args
+}
+
 // Fill processes request and fills internal variables
 func (r *UserTriggerScript) Fill(req *http.Request) (err error) {
 
@@ -1179,6 +1190,18 @@ func (r *UserTriggerScript) Fill(req *http.Request) (err error) {
 				return err
 			}
 		}
+
+		if val, ok := req.Form["args[]"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		} else if val, ok := req.Form["args"]; ok {
+			r.Args, err = parseMapStringInterface(val)
+			if err != nil {
+				return err
+			}
+		}
 	}
 
 	{

system/rest/request/util.go

@@ -1,13 +1,15 @@
 package request
 
-//lint:file-ignore U1000 Ignore unused code, part of request pkg toolset
+import (
+	"encoding/json"
+)
 
-// is checks if string s is contained in matches
-func is(s string, matches ...string) bool {
-	for _, v := range matches {
-		if s == v {
-			return true
-		}
+func parseMapStringInterface(ss []string) (map[string]interface{}, error) {
+	if len(ss) == 0 {
+		return nil, nil
 	}
-	return false
+
+	out := make(map[string]interface{})
+
+	return out, json.Unmarshal([]byte(ss[0]), out)
 }

system/rest/role.go

@@ -208,7 +208,7 @@ func (ctrl *Role) TriggerScript(ctx context.Context, r *request.RoleTriggerScrip
 	}
 
 	// @todo implement same behaviour as we have on record - role+oldRole
-	err = corredor.Service().Exec(ctx, r.Script, event.RoleOnManual(role, role))
+	err = corredor.Service().Exec(ctx, r.Script, corredor.ExtendScriptArgs(event.RoleOnManual(role, role), r.Args))
 	return role, err
 }
 

system/rest/user.go

@@ -231,7 +231,7 @@ func (ctrl *User) TriggerScript(ctx context.Context, r *request.UserTriggerScrip
 	}
 
 	// @todo implement same behaviour as we have on record - user+oldUser
-	err = corredor.Service().Exec(ctx, r.Script, event.UserOnManual(user, user))
+	err = corredor.Service().Exec(ctx, r.Script, corredor.ExtendScriptArgs(event.UserOnManual(user, user), r.Args))
 	return user, err
 
 }