Migrating language server from Websockets to raw TCP

(cherry picked from commit 24b27043fe)

modules/gdscript/language_server/gdscript_language_protocol.cpp

@@ -32,32 +32,107 @@
 #include "core/io/json.h"
 #include "core/os/copymem.h"
 #include "core/project_settings.h"
+#include "editor/editor_log.h"
 #include "editor/editor_node.h"
 
 GDScriptLanguageProtocol *GDScriptLanguageProtocol::singleton = NULL;
 
-void GDScriptLanguageProtocol::on_data_received(int p_id) {
+Error GDScriptLanguageProtocol::LSPeer::handle_data() {
-	lastest_client_id = p_id;
+	int read = 0;
-	Ref<WebSocketPeer> peer = server->get_peer(p_id);
+	// Read headers
-	PoolByteArray data;
+	if (!has_header) {
-	if (OK == peer->get_packet_buffer(data)) {
+		while (true) {
-		String message;
+			if (req_pos >= LSP_MAX_BUFFER_SIZE) {
-		message.parse_utf8((const char *)data.read().ptr(), data.size());
+				req_pos = 0;
-		if (message.begins_with("Content-Length:")) return;
+				ERR_FAIL_COND_V_MSG(true, ERR_OUT_OF_MEMORY, "Response header too big");
-		String output = process_message(message);
+			}
-		if (!output.empty()) {
+			Error err = connection->get_partial_data(&req_buf[req_pos], 1, read);
-			CharString charstr = output.utf8();
+			if (err != OK)
-			peer->put_packet((const uint8_t *)charstr.ptr(), charstr.length());
+				return FAILED;
+			else if (read != 1) // Busy, wait until next poll
+				return ERR_BUSY;
+			char *r = (char *)req_buf;
+			int l = req_pos;
+
+			// End of headers
+			if (l > 3 && r[l] == '\n' && r[l - 1] == '\r' && r[l - 2] == '\n' && r[l - 3] == '\r') {
+				r[l - 3] = '\0'; // Null terminate to read string
+				String header;
+				header.parse_utf8(r);
+				content_length = header.substr(16).to_int();
+				has_header = true;
+				req_pos = 0;
+				break;
+			}
+			req_pos++;
 		}
 	}
+	if (has_header) {
+		while (req_pos < content_length) {
+			if (req_pos >= LSP_MAX_BUFFER_SIZE) {
+				req_pos = 0;
+				has_header = false;
+				ERR_FAIL_COND_V_MSG(req_pos >= LSP_MAX_BUFFER_SIZE, ERR_OUT_OF_MEMORY, "Response content too big");
+			}
+			Error err = connection->get_partial_data(&req_buf[req_pos], 1, read);
+			if (err != OK)
+				return FAILED;
+			else if (read != 1)
+				return ERR_BUSY;
+			req_pos++;
+		}
+
+		// Parse data
+		String msg;
+		msg.parse_utf8((const char *)req_buf, req_pos);
+
+		// Reset to read again
+		req_pos = 0;
+		has_header = false;
+
+		// Response
+		String output = GDScriptLanguageProtocol::get_singleton()->process_message(msg);
+		if (!output.empty()) {
+			res_queue.push_back(output.utf8());
+		}
+	}
+	return OK;
 }
 
-void GDScriptLanguageProtocol::on_client_connected(int p_id, const String &p_protocal) {
+Error GDScriptLanguageProtocol::LSPeer::send_data() {
-	clients.set(p_id, server->get_peer(p_id));
+	int sent = 0;
+	if (!res_queue.empty()) {
+		CharString c_res = res_queue[0];
+		if (res_sent < c_res.size()) {
+			Error err = connection->put_partial_data((const uint8_t *)c_res.get_data() + res_sent, c_res.size() - res_sent - 1, sent);
+			if (err != OK) {
+				return err;
+			}
+			res_sent += sent;
+		}
+		// Response sent
+		if (res_sent >= c_res.size() - 1) {
+			res_sent = 0;
+			res_queue.remove(0);
+		}
+	}
+	return OK;
 }
 
-void GDScriptLanguageProtocol::on_client_disconnected(int p_id, bool p_was_clean_close) {
+Error GDScriptLanguageProtocol::on_client_connected() {
-	clients.erase(p_id);
+	Ref<StreamPeerTCP> tcp_peer = server->take_connection();
+	ERR_FAIL_COND_V_MSG(clients.size() >= LSP_MAX_CLIENTS, FAILED, "Max client limits reached");
+	Ref<LSPeer> peer = new LSPeer;
+	peer->connection = tcp_peer;
+	clients.set(next_client_id, peer);
+	next_client_id++;
+	EditorNode::get_log()->add_message("Connection Taken", EditorLog::MSG_TYPE_EDITOR);
+	return OK;
+}
+
+void GDScriptLanguageProtocol::on_client_disconnected(int p_client_id) {
+	clients.erase(p_client_id);
+	EditorNode::get_log()->add_message("Disconnected", EditorLog::MSG_TYPE_EDITOR);
 }
 
 String GDScriptLanguageProtocol::process_message(const String &p_text) {
@@ -83,11 +158,9 @@ String GDScriptLanguageProtocol::format_output(const String &p_text) {
 void GDScriptLanguageProtocol::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("initialize", "params"), &GDScriptLanguageProtocol::initialize);
 	ClassDB::bind_method(D_METHOD("initialized", "params"), &GDScriptLanguageProtocol::initialized);
-	ClassDB::bind_method(D_METHOD("on_data_received"), &GDScriptLanguageProtocol::on_data_received);
 	ClassDB::bind_method(D_METHOD("on_client_connected"), &GDScriptLanguageProtocol::on_client_connected);
 	ClassDB::bind_method(D_METHOD("on_client_disconnected"), &GDScriptLanguageProtocol::on_client_disconnected);
-	ClassDB::bind_method(D_METHOD("notify_all_clients", "p_method", "p_params"), &GDScriptLanguageProtocol::notify_all_clients, DEFVAL(Variant()));
+	ClassDB::bind_method(D_METHOD("notify_client", "p_method", "p_params"), &GDScriptLanguageProtocol::notify_client, DEFVAL(Variant()), DEFVAL(-1));
-	ClassDB::bind_method(D_METHOD("notify_client", "p_method", "p_params", "p_client"), &GDScriptLanguageProtocol::notify_client, DEFVAL(Variant()), DEFVAL(-1));
 	ClassDB::bind_method(D_METHOD("is_smart_resolve_enabled"), &GDScriptLanguageProtocol::is_smart_resolve_enabled);
 	ClassDB::bind_method(D_METHOD("get_text_document"), &GDScriptLanguageProtocol::get_text_document);
 	ClassDB::bind_method(D_METHOD("get_workspace"), &GDScriptLanguageProtocol::get_workspace);
@@ -116,11 +189,12 @@ Dictionary GDScriptLanguageProtocol::initialize(const Dictionary &p_params) {
 		Dictionary params;
 		params["path"] = workspace->root;
 		Dictionary request = make_notification("gdscrip_client/changeWorkspace", params);
-		if (Ref<WebSocketPeer> *peer = clients.getptr(lastest_client_id)) {
+
+		Ref<LSPeer> peer = clients.get(latest_client_id);
+		if (peer != NULL) {
 			String msg = JSON::print(request);
 			msg = format_output(msg);
-			CharString charstr = msg.utf8();
+			(*peer)->res_queue.push_back(msg.utf8());
-			(*peer)->put_packet((const uint8_t *)charstr.ptr(), charstr.length());
 		}
 	}
 
@@ -153,61 +227,59 @@ void GDScriptLanguageProtocol::initialized(const Variant &p_params) {
 }
 
 void GDScriptLanguageProtocol::poll() {
-	server->poll();
+	if (server->is_connection_available()) {
+		on_client_connected();
+	}
+	const int *id = NULL;
+	while ((id = clients.next(id))) {
+		Ref<LSPeer> peer = clients.get(*id);
+		StreamPeerTCP::Status status = peer->connection->get_status();
+		if (status == StreamPeerTCP::STATUS_NONE || status == StreamPeerTCP::STATUS_ERROR) {
+			on_client_disconnected(*id);
+			id = NULL;
+		} else {
+			if (peer->connection->get_available_bytes() > 0) {
+				latest_client_id = *id;
+				Error err = peer->handle_data();
+				if (err != OK && err != ERR_BUSY) {
+					on_client_disconnected(*id);
+					id = NULL;
+				}
+			}
+			Error err = peer->send_data();
+			if (err != OK && err != ERR_BUSY) {
+				on_client_disconnected(*id);
+				id = NULL;
+			}
+		}
+	}
 }
 
 Error GDScriptLanguageProtocol::start(int p_port, const IP_Address &p_bind_ip) {
-	if (server == NULL) {
+	return server->listen(p_port, p_bind_ip);
-		server = dynamic_cast<WebSocketServer *>(ClassDB::instance("WebSocketServer"));
-		ERR_FAIL_COND_V(!server, FAILED);
-		server->set_buffers(8192, 1024, 8192, 1024); // 8mb should be way more than enough
-		server->connect("data_received", this, "on_data_received");
-		server->connect("client_connected", this, "on_client_connected");
-		server->connect("client_disconnected", this, "on_client_disconnected");
-	}
-	server->set_bind_ip(p_bind_ip);
-	return server->listen(p_port);
 }
 
 void GDScriptLanguageProtocol::stop() {
-	const int *ptr = clients.next(NULL);
+	const int *id = NULL;
-	while (ptr) {
+	while ((id = clients.next(id))) {
-		clients.get(*ptr)->close();
+		Ref<LSPeer> peer = clients.get(*id);
-		ptr = clients.next(ptr);
+		peer->connection->disconnect_from_host();
 	}
+
 	server->stop();
-	clients.clear();
 }
 
-void GDScriptLanguageProtocol::notify_all_clients(const String &p_method, const Variant &p_params) {
+void GDScriptLanguageProtocol::notify_client(const String &p_method, const Variant &p_params, int p_client_id) {
-
+	if (p_client_id == -1) {
-	Dictionary message = make_notification(p_method, p_params);
+		p_client_id = latest_client_id;
-	String msg = JSON::print(message);
-	msg = format_output(msg);
-	CharString charstr = msg.utf8();
-	const int *p_id = clients.next(NULL);
-	while (p_id != NULL) {
-		Ref<WebSocketPeer> peer = clients.get(*p_id);
-		(*peer)->put_packet((const uint8_t *)charstr.ptr(), charstr.length());
-		p_id = clients.next(p_id);
 	}
-}
+	Ref<LSPeer> peer = clients.get(p_client_id);
-
-void GDScriptLanguageProtocol::notify_client(const String &p_method, const Variant &p_params, int p_client) {
-
-	if (p_client == -1) {
-		p_client = lastest_client_id;
-	}
-
-	Ref<WebSocketPeer> *peer = clients.getptr(p_client);
 	ERR_FAIL_COND(peer == NULL);
 
 	Dictionary message = make_notification(p_method, p_params);
 	String msg = JSON::print(message);
 	msg = format_output(msg);
-	CharString charstr = msg.utf8();
+	peer->res_queue.push_back(msg.utf8());
-
-	(*peer)->put_packet((const uint8_t *)charstr.ptr(), charstr.length());
 }
 
 bool GDScriptLanguageProtocol::is_smart_resolve_enabled() const {
@@ -219,7 +291,7 @@ bool GDScriptLanguageProtocol::is_goto_native_symbols_enabled() const {
 }
 
 GDScriptLanguageProtocol::GDScriptLanguageProtocol() {
-	server = NULL;
+	server.instance();
 	singleton = this;
 	_initialized = false;
 	workspace.instance();
@@ -228,9 +300,6 @@ GDScriptLanguageProtocol::GDScriptLanguageProtocol() {
 	set_scope("completionItem", text_document.ptr());
 	set_scope("workspace", workspace.ptr());
 	workspace->root = ProjectSettings::get_singleton()->get_resource_path();
-}
+	latest_client_id = 0;
-
+	next_client_id = 0;
-GDScriptLanguageProtocol::~GDScriptLanguageProtocol() {
-	memdelete(server);
-	server = NULL;
 }

modules/gdscript/language_server/gdscript_language_protocol.h

@@ -31,16 +31,36 @@
 #ifndef GDSCRIPT_PROTOCAL_SERVER_H
 #define GDSCRIPT_PROTOCAL_SERVER_H
 
+#include "core/io/stream_peer.h"
+#include "core/io/stream_peer_tcp.h"
+#include "core/io/tcp_server.h"
 #include "gdscript_text_document.h"
 #include "gdscript_workspace.h"
 #include "lsp.hpp"
 #include "modules/jsonrpc/jsonrpc.h"
-#include "modules/websocket/websocket_peer.h"
+
-#include "modules/websocket/websocket_server.h"
+#define LSP_MAX_BUFFER_SIZE 4194304
+#define LSP_MAX_CLIENTS 8
 
 class GDScriptLanguageProtocol : public JSONRPC {
 	GDCLASS(GDScriptLanguageProtocol, JSONRPC)
 
+private:
+	struct LSPeer : Reference {
+		Ref<StreamPeerTCP> connection;
+
+		uint8_t req_buf[LSP_MAX_BUFFER_SIZE];
+		int req_pos = 0;
+		bool has_header = false;
+		bool has_content = false;
+		int content_length = 0;
+		Vector<CharString> res_queue;
+		int res_sent = 0;
+
+		Error handle_data();
+		Error send_data();
+	};
+
 	enum LSPErrorCode {
 		RequestCancelled = -32800,
 		ContentModified = -32801,
@@ -48,16 +68,16 @@ class GDScriptLanguageProtocol : public JSONRPC {
 
 	static GDScriptLanguageProtocol *singleton;
 
-	HashMap<int, Ref<WebSocketPeer> > clients;
+	HashMap<int, Ref<LSPeer> > clients;
-	WebSocketServer *server;
+	Ref<TCP_Server> server;
-	int lastest_client_id;
+	int latest_client_id;
+	int next_client_id;
 
 	Ref<GDScriptTextDocument> text_document;
 	Ref<GDScriptWorkspace> workspace;
 
-	void on_data_received(int p_id);
+	Error on_client_connected();
-	void on_client_connected(int p_id, const String &p_protocal);
+	void on_client_disconnected(int p_client_id);
-	void on_client_disconnected(int p_id, bool p_was_clean_close);
 
 	String process_message(const String &p_text);
 	String format_output(const String &p_text);
@@ -80,14 +100,12 @@ public:
 	Error start(int p_port, const IP_Address &p_bind_ip);
 	void stop();
 
-	void notify_all_clients(const String &p_method, const Variant &p_params = Variant());
+	void notify_client(const String &p_method, const Variant &p_params = Variant(), int p_client_id = -1);
-	void notify_client(const String &p_method, const Variant &p_params = Variant(), int p_client = -1);
 
 	bool is_smart_resolve_enabled() const;
 	bool is_goto_native_symbols_enabled() const;
 
 	GDScriptLanguageProtocol();
-	~GDScriptLanguageProtocol();
 };
 
 #endif