add plugin.do_{file,string}_with_payload

Author: vadv

plugin/README.md

@@ -17,6 +17,7 @@ local plugin_body = [[
 ]]
 
 -- plugin.do_string(body)
+-- also you can use: plugin.do_file(filename)
 local print_plugin = plugin.do_string(plugin_body)
 print_plugin:run()
 time.sleep(2)
@@ -25,7 +26,17 @@ time.sleep(1)
 
 local running = print_plugin:is_running()
 if running then error("already running") end
-
--- also you can use: plugin.do_file(filename)
 -- also you can get last error: print_plugin:error()
+
+-- plugin.do_string_with_payload()
+-- also you can use: plugin.do_file_with_payload(filename)
+local job_body = [[
+    print(payload)
+]]
+local print_plugin_with_payload = plugin.do_string_with_payload(plugin_body, "text of payload")
+print_plugin_with_payload:run()
+-- must print: "text of payload"
+time.sleep(1)
+local running = print_plugin:is_running()
+if running then error("already running") end
 ```

plugin/api.go

@@ -38,8 +38,9 @@ type luaPlugin struct {
 	cancelFunc context.CancelFunc
 	running    bool
 	error      error
-	body       string
-	filename   string
+	body       *string
+	filename   *string
+	jobPayload *string
 }
 
 func (p *luaPlugin) getError() error {
@@ -68,7 +69,7 @@ func (p *luaPlugin) setRunning(val bool) {
 	p.running = val
 }
 
-// NewPluginState return lua state for plugin
+// NewPluginState return lua state
 func NewPluginState() *lua.LState {
 	state := lua.NewState()
 	// preload all
@@ -100,22 +101,27 @@ func NewPluginState() *lua.LState {
 
 func (p *luaPlugin) start() {
 	p.Lock()
-
 	state := NewPluginState()
 	p.state = state
 	p.error = nil
 	p.running = true
+	isBody := (p.filename == nil)
+	if !(p.jobPayload == nil) {
+		payload := *p.jobPayload
+		state.SetGlobal(`payload`, lua.LString(payload))
+	}
 	ctx, cancelFunc := context.WithCancel(context.Background())
-	p.state.SetContext(ctx)
 	p.cancelFunc = cancelFunc
-	isBody := (p.filename == "")
+	p.state.SetContext(ctx)
 	p.Unlock()
 
 	// blocking
 	if isBody {
-		p.setError(p.state.DoString(p.body))
+		body := *p.body
+		p.setError(p.state.DoString(body))
 	} else {
-		p.setError(p.state.DoFile(p.filename))
+		filename := *p.filename
+		p.setError(p.state.DoFile(filename))
 	}
 	p.setRunning(false)
 }
@@ -132,7 +138,7 @@ func checkPlugin(L *lua.LState, n int) *luaPlugin {
 // DoString lua plugin.do_string(body) returns plugin_ud
 func DoString(L *lua.LState) int {
 	body := L.CheckString(1)
-	p := &luaPlugin{body: body}
+	p := &luaPlugin{body: &body}
 	ud := L.NewUserData()
 	ud.Value = p
 	L.SetMetatable(ud, L.GetTypeMetatable(`plugin_ud`))
@@ -143,7 +149,31 @@ func DoString(L *lua.LState) int {
 // DoFile lua plugin.do_file(filename) returns plugin_ud
 func DoFile(L *lua.LState) int {
 	filename := L.CheckString(1)
-	p := &luaPlugin{filename: filename}
+	p := &luaPlugin{filename: &filename}
+	ud := L.NewUserData()
+	ud.Value = p
+	L.SetMetatable(ud, L.GetTypeMetatable(`plugin_ud`))
+	L.Push(ud)
+	return 1
+}
+
+// DoFileWithPayload lua plugin.async() returns (plugin_ud, err)
+func DoFileWithPayload(L *lua.LState) int {
+	filename := L.CheckString(1)
+	payload := L.CheckString(2)
+	p := &luaPlugin{filename: &filename, jobPayload: &payload}
+	ud := L.NewUserData()
+	ud.Value = p
+	L.SetMetatable(ud, L.GetTypeMetatable(`plugin_ud`))
+	L.Push(ud)
+	return 1
+}
+
+// DoStringWithPayload lua plugin.async() returns (plugin_ud, err)
+func DoStringWithPayload(L *lua.LState) int {
+	body := L.CheckString(1)
+	payload := L.CheckString(2)
+	p := &luaPlugin{body: &body, jobPayload: &payload}
 	ud := L.NewUserData()
 	ud.Value = p
 	L.SetMetatable(ud, L.GetTypeMetatable(`plugin_ud`))

plugin/loader.go

@@ -15,9 +15,9 @@ func Preload(L *lua.LState) {
 // Loader is the module loader function.
 func Loader(L *lua.LState) int {
 
-	plugin_ud := L.NewTypeMetatable(`plugin_ud`)
-	L.SetGlobal(`plugin_ud`, plugin_ud)
-	L.SetField(plugin_ud, "__index", L.SetFuncs(L.NewTable(), map[string]lua.LGFunction{
+	pluginUd := L.NewTypeMetatable(`plugin_ud`)
+	L.SetGlobal(`plugin_ud`, pluginUd)
+	L.SetField(pluginUd, "__index", L.SetFuncs(L.NewTable(), map[string]lua.LGFunction{
 		"run":        Run,
 		"error":      Error,
 		"stop":       Stop,
@@ -31,6 +31,8 @@ func Loader(L *lua.LState) int {
 }
 
 var api = map[string]lua.LGFunction{
-	"do_string": DoString,
-	"do_file":   DoFile,
+	"do_string":              DoString,
+	"do_file":                DoFile,
+	"do_string_with_payload": DoStringWithPayload,
+	"do_file_with_payload":   DoFileWithPayload,
 }

plugin/test/.gitignore

@@ -1 +1,2 @@
 /file.txt
+/payload.txt

plugin/test/test_api.lua

@@ -41,3 +41,26 @@ if err then error(err) end
 print(data)
 local i = tonumber(data)
 if i < 1 then error("i < 1") end
+
+
+-- test with payload
+local plugin_body_2 = [[
+    local ioutil = require("ioutil")
+    local err = ioutil.write_file("./test/payload.txt", payload)
+    if err then error(err) end
+]]
+local test_payload = "OK"
+local plugin_with_payload = plugin.do_string_with_payload(plugin_body_2, test_payload)
+plugin_with_payload:run()
+
+time.sleep(1)
+local i = 0
+while plugin_with_payload:is_running() do
+    time.sleep(1)
+    i = i + 1
+    if i > 3 then error("timeout") end
+end
+
+local data, err = ioutil.read_file("./test/payload.txt")
+if err then error(err) end
+if not(data == test_payload) then error("data <> test_payload") end