feat: Workspaces and File API (#2)

* feat: Add websocket connection

* feat: Socket Workspaces

* fix: workflow

* update: move to gorilla websockets

* feat: File API and LSP Instances

Author: vigneshd332

.githooks/pre-commit

@@ -5,7 +5,7 @@ echo "\033[36m
 Running golangci-lint
 ======================================================================"
 
-golangci-lint run . 
+golangci-lint run . --config .golangci.yaml
 
 if [ $? != 0 ]; then
     echo "\033[31m

.github/workflows/golangci-lint.yml

@@ -9,7 +9,7 @@ on:
 
 permissions:
   contents: read
-  
+
 jobs:
   golangci:
     name: Lint
@@ -23,4 +23,4 @@ jobs:
         uses: golangci/golangci-lint-action@v3
         with:
           version: latest
-          args: "--out-${NO_FUTURE}format colored-line-number --print-issued-lines --print-linter-name"
+          args: "--config .golangci.yaml --out-${NO_FUTURE}format colored-line-number --print-issued-lines --print-linter-name"

.gitignore

@@ -1,3 +1,4 @@
 .env
 server
-.vscode
+.vscode
+workspaces

Dockerfile

@@ -15,7 +15,7 @@ FROM build AS dev
 
 WORKDIR /app
 
-RUN apk add --no-cache make
+RUN apk add --no-cache make ccls
 
 RUN go install github.com/cespare/reflex@latest
 

controllers/.gitkeep

@@ -0,0 +1,27 @@
+package controllers
+
+import (
+	"fmt"
+	"io/ioutil"
+
+	"github.com/delta/codecharacter-lsp-2023/models"
+)
+
+func handleFileUpdate(message map[string]interface{}, ws *models.WebsocketConnection) error {
+	fmt.Println("Processing File Update Request")
+	var filename string
+	switch ws.Language {
+	case "cpp":
+		filename = "run.cpp"
+	case "java":
+		filename = "run.java"
+	case "python":
+		filename = "run.py"
+	}
+	err := ioutil.WriteFile(ws.WorkspacePath+"/"+filename, []byte(message["code"].(string)), 0644)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+	return nil
+}

controllers/file.go

@@ -0,0 +1,48 @@
+package controllers
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/delta/codecharacter-lsp-2023/models"
+	"github.com/gorilla/websocket"
+)
+
+func HandleMessage(ws *models.WebsocketConnection, messageBytes []byte) error {
+	var message map[string]interface{}
+	err := json.Unmarshal(messageBytes, &message)
+	if err != nil {
+		return err
+	}
+	_, isPresent := message["jsonrpc"]
+	fmt.Println("Is JSONRPC? : ", isPresent)
+	if isPresent {
+		return handleJSONRPCRequest(ws, messageBytes)
+	}
+	return handleWebSocketRequest(ws, message)
+}
+
+func SendMessage(ws *models.WebsocketConnection, message map[string]interface{}) error {
+	messageBytes, err := json.Marshal(message)
+	if err != nil {
+		return err
+	}
+	err = ws.Connection.WriteMessage(websocket.TextMessage, messageBytes)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func handleJSONRPCRequest(ws *models.WebsocketConnection, messageBytes []byte) error {
+	fmt.Println("JSONRPC Request : ", string(messageBytes), " with ID : ", ws.ID)
+	return nil
+}
+
+func handleWebSocketRequest(ws *models.WebsocketConnection, message map[string]interface{}) error {
+	fmt.Println("Websocket Request : ", message, " with ID : ", ws.ID)
+	if message["operation"] == "fileUpdate" {
+		return handleFileUpdate(message, ws)
+	}
+	return nil
+}

controllers/message.go

@@ -11,3 +11,4 @@ services:
       - ${SERVER_PORT}:8000
     volumes:
       - .:/app
+      - ./workspaces:/app/workspaces

docker-compose.yml

@@ -8,8 +8,11 @@ require (
 	github.com/labstack/echo/v4 v4.9.0
 )
 
+require github.com/gorilla/websocket v1.5.0
+
 require (
 	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
+	github.com/google/uuid v1.3.0
 	github.com/labstack/gommon v0.4.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.16 // indirect

go.mod

@@ -5,6 +5,10 @@ github.com/fatih/color v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
 github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk=
 github.com/golang-jwt/jwt v3.2.2+incompatible h1:IfV12K8xAKAnZqdXVzCZ+TOjboZ2keLg81eXfW3O+oY=
 github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
+github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
+github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
+github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/joho/godotenv v1.4.0 h1:3l4+N6zfMWnkbPEXKng2o2/MR5mSwTrBih4ZEkkz1lg=
 github.com/joho/godotenv v1.4.0/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/labstack/echo/v4 v4.9.0 h1:wPOF1CE6gvt/kmbMR4dGzWvHMPT+sAEUJOwOTtvITVY=

go.sum

@@ -2,6 +2,7 @@ package main
 
 import (
 	"github.com/delta/codecharacter-lsp-2023/config"
+	"github.com/delta/codecharacter-lsp-2023/router"
 	"github.com/delta/codecharacter-lsp-2023/utils"
 
 	"github.com/labstack/echo/v4"
@@ -14,6 +15,7 @@ func main() {
 	utils.InitLogger(server)
 	server.Use(middleware.CORS())
 	config.InitConfig()
+	router.InitRoutes(server)
 
 	server.Logger.Fatal(server.Start(":" + config.ServerPort))
 }

main.go

@@ -0,0 +1,16 @@
+package models
+
+import (
+	"os/exec"
+
+	"github.com/google/uuid"
+	"github.com/gorilla/websocket"
+)
+
+type WebsocketConnection struct {
+	ID            uuid.UUID
+	Connection    *websocket.Conn
+	Language      string
+	WorkspacePath string
+	LSPServer     *exec.Cmd
+}

models/websocket.go

@@ -0,0 +1,11 @@
+package router
+
+import (
+	"net/http"
+
+	"github.com/labstack/echo/v4"
+)
+
+func home(c echo.Context) error {
+	return c.String(http.StatusOK, "Hello! Welcome to the CodeCharacter LSP Project")
+}

router/home.go

@@ -0,0 +1,8 @@
+package router
+
+import "github.com/labstack/echo/v4"
+
+func InitRoutes(server *echo.Echo) {
+	server.GET("/", home)
+	server.GET("/ws/:language", handleWebSocketConnection)
+}

router/router.go

@@ -0,0 +1,14 @@
+package router
+
+import (
+	"github.com/delta/codecharacter-lsp-2023/utils"
+	"github.com/labstack/echo/v4"
+)
+
+func handleWebSocketConnection(c echo.Context) error {
+	err := utils.InitWebsocket(c)
+	if err != nil {
+		return err
+	}
+	return nil
+}

router/websocket.go

@@ -0,0 +1,42 @@
+package utils
+
+import (
+	"fmt"
+	"os"
+	"os/exec"
+
+	"github.com/delta/codecharacter-lsp-2023/models"
+)
+
+func CreateLSPServer(wsConnectionParams *models.WebsocketConnection) error {
+	switch wsConnectionParams.Language {
+	case "cpp":
+		return createCppServer(wsConnectionParams)
+	}
+	return nil
+}
+
+func createCppServer(wsConnectionParams *models.WebsocketConnection) error {
+	wsConnectionParams.LSPServer = exec.Command("ccls", `--init={
+		"index":{
+		  "onChange":true,
+		  "trackDependency":0,
+		  "threads":2,
+		  "comments":0
+		},
+		"cache":{
+		  "retainInMemory":0,
+		  "directory":"./`+wsConnectionParams.WorkspacePath+`"
+		},
+		"diagnostics":{
+		  "onSave":1500
+		}
+	  }`)
+	wsConnectionParams.LSPServer.Stderr = os.Stderr
+	err := wsConnectionParams.LSPServer.Start()
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+	return nil
+}

utils/lsp.go

@@ -0,0 +1,98 @@
+package utils
+
+import (
+	"fmt"
+	"net/http"
+	"os"
+
+	"github.com/delta/codecharacter-lsp-2023/controllers"
+	"github.com/delta/codecharacter-lsp-2023/models"
+	"github.com/google/uuid"
+	"github.com/gorilla/websocket"
+	"github.com/labstack/echo/v4"
+)
+
+var upgrader = websocket.Upgrader{}
+
+func InitWebsocket(c echo.Context) error {
+	var ws models.WebsocketConnection
+	id := uuid.New()
+	ws.ID = id
+	language := c.Param("language")
+	if language != "cpp" && language != "java" && language != "python" {
+		return c.String(http.StatusBadRequest, "Invalid Language")
+	}
+	ws.Language = language
+	fmt.Println("WS Connection Created with ID : ", id, " and Language : ", language)
+	wsConn, err := upgrader.Upgrade(c.Response(), c.Request(), nil)
+	if err != nil {
+		return c.String(http.StatusBadRequest, "Error Upgrading to Websocket Connection")
+	}
+	ws.Connection = wsConn
+	err = createWebsocketConnection(&ws)
+	if err != nil {
+		return c.String(http.StatusBadGateway, "Something went wrong, contact the event administrator.")
+	}
+	return nil
+}
+
+func dropConnection(ws *models.WebsocketConnection) {
+	err := os.RemoveAll(ws.WorkspacePath)
+	if err != nil {
+		fmt.Println(err)
+	}
+	if ws.LSPServer != nil {
+		err = ws.LSPServer.Process.Signal(os.Interrupt)
+		if err != nil {
+			fmt.Println(err)
+		}
+		// Reads process exit state to remove the <defunct> process from the system process table
+		err = ws.LSPServer.Wait()
+		if err != nil {
+			fmt.Println(err)
+		}
+	}
+	ws.Connection.Close()
+	fmt.Println("Dropped WS Connection : ", ws.ID)
+}
+
+func createWebsocketConnection(ws *models.WebsocketConnection) error {
+	defer dropConnection(ws)
+
+	ws.WorkspacePath = "workspaces/" + ws.ID.String()
+	err := os.Mkdir(ws.WorkspacePath, os.ModePerm)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+	err = CreateLSPServer(ws)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+	err = listen(ws)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+	return nil
+}
+
+func listen(ws *models.WebsocketConnection) error {
+	for {
+		fmt.Println("Listening for Messages")
+		_, messageBytes, err := ws.Connection.ReadMessage()
+		if err != nil {
+			if websocket.IsUnexpectedCloseError(err, websocket.CloseNormalClosure, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
+				fmt.Println("WS Connection ", ws.ID, " closing with error : ", err)
+				return err
+			}
+			return nil
+		}
+		err = controllers.HandleMessage(ws, messageBytes)
+		if err != nil {
+			fmt.Println(err)
+			return err
+		}
+	}
+}