feat: jsonrpc integration & cpp autocomplete (#5)

* feat: add player code submodule

* feat: Symlinks and refactoring

* feat[WIP]: Integrate JSONRPC

* Feat : Integrate ccls language server

* fix: pre commit

* Refactor : Improve readability

* Fix : send both file and folder path

* refactor: readablity

* update: submodule

* fix: removed unnecessary variables/checks

---------

Co-authored-by: shubham-1806 <[email protected]>
Co-authored-by: Ashwani <[email protected]>

Author: 3 people

.env.example

@@ -1,2 +1,3 @@
 TARGET=dev
 SERVER_PORT=8000
+FRONTEND_URL=http://localhost:3000

.githooks/pre-commit

@@ -5,13 +5,14 @@ echo "\033[36m
 Running golangci-lint
 ======================================================================"
 
-golangci-lint run . --config .golangci.yaml
+golangci-lint run --config .golangci.yaml
 
 if [ $? != 0 ]; then
     echo "\033[31m
 ======================================================================
 golangci-lint check failed
 ======================================================================"
+    exit 1
 else
     echo "\033[32m 
 ======================================================================

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "player_code"]
+	path = player_code
+	url = https://github.com/delta/codecharacter-default-codes-2022.git

Dockerfile

@@ -1,5 +1,10 @@
+## Base
+FROM golang:1.18-alpine AS base
+
+RUN apk add --no-cache build-base ccls py3-lsp-server
+
 ## Build
-FROM golang:1.18-alpine AS build
+FROM base AS build
 
 WORKDIR /app
 
@@ -15,7 +20,7 @@ FROM build AS dev
 
 WORKDIR /app
 
-RUN apk add --no-cache make ccls
+RUN apk add --no-cache make
 
 RUN go install github.com/cespare/reflex@latest
 
@@ -24,7 +29,7 @@ CMD ["make watch"]
 
 
 ## Prod
-FROM alpine:latest AS prod
+FROM base AS prod
 
 WORKDIR /
 

config/environment.go

@@ -10,6 +10,7 @@ import (
 )
 
 var ServerPort string
+var FrontendURL string
 
 func InitConfig() {
 	err := godotenv.Load()
@@ -18,4 +19,5 @@ func InitConfig() {
 	}
 
 	ServerPort = os.Getenv("SERVER_PORT")
+	FrontendURL = os.Getenv("FRONTEND_URL")
 }

controllers/file.go

@@ -1,27 +1,25 @@
 package controllers
 
 import (
-	"fmt"
 	"io/ioutil"
+	"path/filepath"
 
 	"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)
+	filename := "player" + ws.Language.GetExtension()
+	return ioutil.WriteFile(ws.WorkspacePath+"/"+filename, []byte(message["code"].(string)), 0644)
+}
+
+func getAbsPath(ws *models.WebsocketConnection) error {
+	absFolderPath, err := filepath.Abs(ws.WorkspacePath)
+	responseBody := make(map[string]interface{})
 	if err != nil {
-		fmt.Println(err)
-		return err
+		return SendErrorMessage(ws, err)
 	}
-	return nil
+	responseBody["status"] = "success"
+	responseBody["folderpath"] = absFolderPath
+	responseBody["filepath"] = absFolderPath + "/player" + ws.Language.GetExtension()
+	return SendMessage(ws, responseBody)
 }

controllers/jsonrpc.go

@@ -0,0 +1,63 @@
+package controllers
+
+import (
+	"bufio"
+	"encoding/json"
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/delta/codecharacter-lsp-2023/models"
+)
+
+func StreamReader(ws *models.WebsocketConnection) {
+	if ws.LSPServer.Process == nil {
+		return
+	}
+	for {
+		var responseMessageBytes []byte
+		reader := bufio.NewReader(ws.LSPServer.Stdout)
+		contentLengthLine, err := reader.ReadBytes('\n')
+		var contentLengthHeader string
+		contentLengthHeader = string(contentLengthLine)
+		if err != nil {
+			if err.Error() == "EOF" {
+				return
+			}
+			continue
+		}
+		const prefix = "Content-Length: "
+		const suffix = "\r\n"
+		contentLengthHeader = strings.TrimPrefix(contentLengthHeader, prefix)
+		contentLengthHeader = strings.TrimSuffix(contentLengthHeader, suffix)
+		contentLength, err := strconv.Atoi(contentLengthHeader)
+		if err != nil {
+			continue
+		}
+		_, err = reader.ReadBytes('\n')
+		if err != nil {
+			continue
+		}
+		for i := 0; i < contentLength; i++ {
+			currbyte, err := reader.ReadByte()
+			if err != nil {
+				continue
+			}
+			responseMessageBytes = append(responseMessageBytes, currbyte)
+		}
+		var responseMessage map[string]interface{}
+		err = json.Unmarshal(responseMessageBytes, &responseMessage)
+		if err != nil {
+			continue
+		}
+		_ = SendMessage(ws, responseMessage)
+	}
+}
+
+func handleJSONRPC(ws *models.WebsocketConnection, requestMessageBytes []byte) error {
+	contentLength := len(requestMessageBytes)
+	header := fmt.Sprintf("Content-Length: %d\n\n", contentLength)
+	requestMessage := header + string(requestMessageBytes)
+	_, err := ws.LSPServer.Stdin.Write([]byte(requestMessage))
+	return err
+}

controllers/message.go

@@ -2,7 +2,6 @@ package controllers
 
 import (
 	"encoding/json"
-	"fmt"
 
 	"github.com/delta/codecharacter-lsp-2023/models"
 	"github.com/gorilla/websocket"
@@ -15,7 +14,6 @@ func HandleMessage(ws *models.WebsocketConnection, messageBytes []byte) error {
 		return err
 	}
 	_, isPresent := message["jsonrpc"]
-	fmt.Println("Is JSONRPC? : ", isPresent)
 	if isPresent {
 		return handleJSONRPCRequest(ws, messageBytes)
 	}
@@ -27,22 +25,26 @@ func SendMessage(ws *models.WebsocketConnection, message map[string]interface{})
 	if err != nil {
 		return err
 	}
-	err = ws.Connection.WriteMessage(websocket.TextMessage, messageBytes)
-	if err != nil {
-		return err
-	}
-	return nil
+	return ws.Connection.WriteMessage(websocket.TextMessage, messageBytes)
+}
+
+func SendErrorMessage(ws *models.WebsocketConnection, message error) error {
+	responseBody := make(map[string]interface{})
+	responseBody["status"] = "error"
+	responseBody["message"] = message.Error()
+	return SendMessage(ws, responseBody)
 }
 
 func handleJSONRPCRequest(ws *models.WebsocketConnection, messageBytes []byte) error {
-	fmt.Println("JSONRPC Request : ", string(messageBytes), " with ID : ", ws.ID)
-	return nil
+	return handleJSONRPC(ws, messageBytes)
 }
 
 func handleWebSocketRequest(ws *models.WebsocketConnection, message map[string]interface{}) error {
-	fmt.Println("Websocket Request : ", message, " with ID : ", ws.ID)
-	if message["operation"] == "fileUpdate" {
+	switch message["operation"] {
+	case "fileUpdate":
 		return handleFileUpdate(message, ws)
+	case "getAbsPath":
+		return getAbsPath(ws)
 	}
 	return nil
 }

go.mod

@@ -6,11 +6,7 @@ require (
 	github.com/fatih/color v1.13.0
 	github.com/joho/godotenv v1.4.0
 	github.com/labstack/echo/v4 v4.9.0
-)
-
-require github.com/gorilla/websocket v1.5.0
-
-require (
+	github.com/gorilla/websocket v1.5.0
 	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

main.go

@@ -13,8 +13,11 @@ func main() {
 
 	server := echo.New()
 	utils.InitLogger(server)
-	server.Use(middleware.CORS())
 	config.InitConfig()
+	server.Use(middleware.CORSWithConfig(middleware.CORSConfig{
+		AllowOrigins: []string{config.FrontendURL},
+		AllowHeaders: []string{echo.HeaderOrigin, echo.HeaderContentType, echo.HeaderAccept},
+	}))
 	router.InitRoutes(server)
 
 	server.Logger.Fatal(server.Start(":" + config.ServerPort))

models/language.go

@@ -0,0 +1,17 @@
+package models
+
+type Language int
+
+const (
+	Cpp = iota
+	Java
+	Python
+)
+
+func (lang Language) GetLanguage() string {
+	return []string{"cpp", "java", "python"}[lang]
+}
+
+func (lang Language) GetExtension() string {
+	return []string{".cpp", ".java", ".py"}[lang]
+}

models/lsp.go

@@ -0,0 +1,14 @@
+package models
+
+import (
+	"io"
+	"os"
+	"os/exec"
+)
+
+type LSPServer struct {
+	Process   *exec.Cmd
+	Stdin     io.WriteCloser
+	Stdout    io.ReadCloser
+	DevNullFd *os.File
+}

models/websocket.go

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

player_code

@@ -33,6 +33,10 @@
   ```sh
   cp .env.example .env
   ```
+- Init Submodules
+  ```sh
+  git submodule update --init
+  ```
 - Enable githooks
   ```sh
   git config core.hooksPath .githooks

readme.md

@@ -6,9 +6,5 @@ import (
 )
 
 func handleWebSocketConnection(c echo.Context) error {
-	err := utils.InitWebsocket(c)
-	if err != nil {
-		return err
-	}
-	return nil
+	return utils.InitWebsocket(c)
 }

router/websocket.go

@@ -0,0 +1,64 @@
+package servers
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"os/exec"
+
+	"github.com/delta/codecharacter-lsp-2023/models"
+)
+
+func createCppServer(ws *models.WebsocketConnection) error {
+	filename := "compile_commands.json"
+	err := ioutil.WriteFile(ws.WorkspacePath+"/"+filename, []byte(createCompileCommands(ws)), 0644)
+	if err != nil {
+		return err
+	}
+	ws.LSPServer.Process = exec.Command("ccls", `--init={
+		"index":{
+		  "onChange":true,
+		  "trackDependency":0,
+		  "threads":2,
+		  "comments":0
+		},
+		"cache":{
+		  "retainInMemory":1
+		},
+		"diagnostics":{
+		  "onSave":1500
+		}
+	  }`)
+	ws.LSPServer.Stdin, err = ws.LSPServer.Process.StdinPipe()
+	if err != nil {
+		return err
+	}
+	ws.LSPServer.Stdout, err = ws.LSPServer.Process.StdoutPipe()
+	if err != nil {
+		return err
+	}
+	devnull, _ := os.OpenFile(os.DevNull, os.O_WRONLY, 0755)
+	ws.LSPServer.Process.Stderr = devnull
+	ws.LSPServer.DevNullFd = devnull
+	return ws.LSPServer.Process.Start()
+}
+
+func createCompileCommands(ws *models.WebsocketConnection) string {
+	return fmt.Sprintf(`[
+		{
+		  "directory": "%[1]s",
+		  "command": "/usr/bin/c++ -std=c++17 -I%[1]s/player_code.h  -o CMakeFiles/MyProject.dir/main.cpp.o -c %[1]s/main.cpp",
+		  "file": "%[1]s/main.cpp"
+		},
+		{
+		  "directory": "%[1]s",
+		  "command": "/usr/bin/c++ -std=c++17 -I%[1]s/player_code.h  -o CMakeFiles/MyProject.dir/player_code.cpp.o -c %[1]s/player_code.cpp",
+		  "file": "%[1]s/player_code.cpp"
+		},
+		{
+		  "directory": "%[1]s",
+		  "command": "/usr/bin/c++ -std=c++17 -I%[1]s/player_code.h  -o CMakeFiles/MyProject.dir/player.cpp.o -c %[1]s/player.cpp",
+		  "file": "%[1]s/player.cpp"
+		}
+		]`, ws.WorkspacePath)
+}