Use xds-common go library.
[src/xds/xds-server.git] / lib / apiv1 / exec.go
index f7beea6..654ff64 100644 (file)
@@ -7,22 +7,25 @@ import (
        "time"
 
        "github.com/gin-gonic/gin"
-       "github.com/iotbzh/xds-server/lib/common"
+       common "github.com/iotbzh/xds-common/golib"
 )
 
 // ExecArgs JSON parameters of /exec command
 type ExecArgs struct {
-       ID         string   `json:"id"`
-       RPath      string   `json:"rpath"` // relative path into project
-       Cmd        string   `json:"cmd" binding:"required"`
-       Args       []string `json:"args"`
-       CmdTimeout int      `json:"timeout"` // command completion timeout in Second
+       ID            string   `json:"id" binding:"required"`
+       SdkID         string   `json:"sdkid"` // sdk ID to use for setting env
+       Cmd           string   `json:"cmd" binding:"required"`
+       Args          []string `json:"args"`
+       Env           []string `json:"env"`
+       RPath         string   `json:"rpath"`         // relative path into project
+       ExitImmediate bool     `json:"exitImmediate"` // when true, exit event sent immediately when command exited (IOW, don't wait file synchronization)
+       CmdTimeout    int      `json:"timeout"`       // command completion timeout in Second
 }
 
 // ExecOutMsg Message send on each output (stdout+stderr) of executed command
 type ExecOutMsg struct {
        CmdID     string `json:"cmdID"`
-       Timestamp string `json:timestamp`
+       Timestamp string `json:"timestamp"`
        Stdout    string `json:"stdout"`
        Stderr    string `json:"stderr"`
 }
@@ -30,13 +33,15 @@ type ExecOutMsg struct {
 // ExecExitMsg Message send when executed command exited
 type ExecExitMsg struct {
        CmdID     string `json:"cmdID"`
-       Timestamp string `json:timestamp`
+       Timestamp string `json:"timestamp"`
        Code      int    `json:"code"`
        Error     error  `json:"error"`
 }
 
-// Event name send in WS
+// ExecOutEvent Event send in WS when characters are received
 const ExecOutEvent = "exec:output"
+
+// ExecExitEvent Event send in WS when program exited
 const ExecExitEvent = "exec:exit"
 
 var execCommandID = 1
@@ -49,7 +54,7 @@ func (s *APIService) execCmd(c *gin.Context) {
                return
        }
 
-       // TODO: add permission
+       // TODO: add permission ?
 
        // Retrieve session info
        sess := s.sessions.Get(c)
@@ -73,7 +78,7 @@ func (s *APIService) execCmd(c *gin.Context) {
                return
        }
 
-       prj := s.cfg.GetFolderFromID(id)
+       prj := s.mfolder.GetFolderFromID(id)
        if prj == nil {
                common.APIError(c, "Unknown id")
                return
@@ -87,14 +92,23 @@ func (s *APIService) execCmd(c *gin.Context) {
 
        // Define callback for output
        var oCB common.EmitOutputCB
-       oCB = func(sid string, id int, stdout, stderr string) {
+       oCB = func(sid string, id int, stdout, stderr string, data *map[string]interface{}) {
                // IO socket can be nil when disconnected
                so := s.sessions.IOSocketGet(sid)
                if so == nil {
                        s.log.Infof("%s not emitted: WS closed - sid: %s - msg id:%d", ExecOutEvent, sid, id)
                        return
                }
-               s.log.Debugf("%s emitted - WS sid %s - id:%d", ExecOutEvent, sid, id)
+
+               // Retrieve project ID and RootPath
+               prjID := (*data)["ID"].(string)
+               prjRootPath := (*data)["RootPath"].(string)
+
+               // Cleanup any references to internal rootpath in stdout & stderr
+               stdout = strings.Replace(stdout, prjRootPath, "", -1)
+               stderr = strings.Replace(stderr, prjRootPath, "", -1)
+
+               s.log.Debugf("%s emitted - WS sid %s - id:%d - prjID:%s", ExecOutEvent, sid, id, prjID)
 
                // FIXME replace by .BroadcastTo a room
                err := (*so).Emit(ExecOutEvent, ExecOutMsg{
@@ -109,7 +123,7 @@ func (s *APIService) execCmd(c *gin.Context) {
        }
 
        // Define callback for output
-       eCB := func(sid string, id int, code int, err error) {
+       eCB := func(sid string, id int, code int, err error, data *map[string]interface{}) {
                s.log.Debugf("Command [Cmd ID %d] exited: code %d, error: %v", id, code, err)
 
                // IO socket can be nil when disconnected
@@ -119,6 +133,30 @@ func (s *APIService) execCmd(c *gin.Context) {
                        return
                }
 
+               // Retrieve project ID and RootPath
+               prjID := (*data)["ID"].(string)
+               exitImm := (*data)["ExitImmediate"].(bool)
+
+               // XXX - workaround to be sure that Syncthing detected all changes
+               if err := s.mfolder.ForceSync(prjID); err != nil {
+                       s.log.Errorf("Error while syncing folder %s: %v", prjID, err)
+               }
+               if !exitImm {
+                       // Wait end of file sync
+                       // FIXME pass as argument
+                       tmo := 60
+                       for t := tmo; t > 0; t-- {
+                               s.log.Debugf("Wait file insync for %s (%d/%d)", prjID, t, tmo)
+                               if sync, err := s.mfolder.IsFolderInSync(prjID); sync || err != nil {
+                                       if err != nil {
+                                               s.log.Errorf("ERROR IsFolderInSync (%s): %v", prjID, err)
+                                       }
+                                       break
+                               }
+                               time.Sleep(time.Second)
+                       }
+               }
+
                // FIXME replace by .BroadcastTo a room
                e := (*so).Emit(ExecExitEvent, ExecExitMsg{
                        CmdID:     strconv.Itoa(id),
@@ -133,14 +171,30 @@ func (s *APIService) execCmd(c *gin.Context) {
 
        cmdID := execCommandID
        execCommandID++
+       cmd := []string{}
+
+       // Setup env var regarding Sdk ID (used for example to setup cross toolchain)
+       if envCmd := s.sdks.GetEnvCmd(args.SdkID, prj.DefaultSdk); len(envCmd) > 0 {
+               cmd = append(cmd, envCmd...)
+               cmd = append(cmd, "&&")
+       }
 
-       cmd := "cd " + prj.GetFullPath(args.RPath) + " && " + args.Cmd
+       cmd = append(cmd, "cd", prj.GetFullPath(args.RPath), "&&", args.Cmd)
        if len(args.Args) > 0 {
-               cmd += " " + strings.Join(args.Args, " ")
+               cmd = append(cmd, args.Args...)
        }
 
-       s.log.Debugf("Execute [Cmd ID %d]: %v %v", cmdID, cmd)
-       err := common.ExecPipeWs(cmd, sop, sess.ID, cmdID, execTmo, s.log, oCB, eCB)
+       // Append client project dir to environment
+       args.Env = append(args.Env, "CLIENT_PROJECT_DIR="+prj.RelativePath)
+
+       s.log.Debugf("Execute [Cmd ID %d]: %v", cmdID, cmd)
+
+       data := make(map[string]interface{})
+       data["ID"] = prj.ID
+       data["RootPath"] = prj.RootPath
+       data["ExitImmediate"] = args.ExitImmediate
+
+       err := common.ExecPipeWs(cmd, args.Env, sop, sess.ID, cmdID, execTmo, s.log, oCB, eCB, &data)
        if err != nil {
                common.APIError(c, err.Error())
                return