Merge pull request #37 from yeger00/type-definition-fixes

Fix type definition function and starting to add a test

Author: yeger00

Makefile

@@ -10,7 +10,7 @@ lint:
 
 test:
 	poetry install --no-interaction --no-root --with tests
-	poetry run pytest
+	poetry run pytest $(PYTEST_FLAGS)
 
 publish:
 	poetry install --no-interaction --no-root --with publish

classes.dot

@@ -16,18 +16,25 @@ pip install pylspclient
 ```
 
 # Contributing
-In order to contribute you need to make sure your PR passes all the [Test Package](https://github.com/yeger00/pylspclient/blob/main/.github/workflows/test-pkg.yml) steps. You can run it locally as well:
+In order to contribute you need to make sure your PR passes all the [Test Package](https://github.com/yeger00/pylspclient/blob/main/.github/workflows/test-pkg.yml) steps.
+All the development related commands are wrap with Makefile just for easy access from both the development environment and from the workflows. You can see that most of the commands are only 1 line and you can run them directly.
+You can run it locally as well:
 
 ## Run the tests
 ```
-pip install -e .
-pip install -r requirements.test.txt
-pytest test
+make test
 ```
 
 ## Run the linter
 ```
-ruff check .
+make lint
+```
+
+## New release
+```
+make bump
+make build
+make publish
 ```
 
 # License

docs/README.md

@@ -117,7 +117,7 @@ def typeDefinition(self, textDocument, position):
         :param TextDocumentItem textDocument: The text document.
         :param Position position: The position inside the text document.
         """
-        result_dict = self.lsp_endpoint.call_method("textDocument/definition", textDocument=textDocument, position=position)
+        result_dict = self.lsp_endpoint.call_method("textDocument/typeDefinition", textDocument=textDocument, position=position)
         return [lsp_structs.Location(**result) for result in result_dict]
 
 

pylspclient/lsp_client.py

@@ -0,0 +1,8 @@
+#from __future__ import absolute_import
+
+__all__ = []
+
+from pylspclient.json_rpc_endpoint import JsonRpcEndpoint
+from pylspclient.lsp_client import LspClient
+from pylspclient.lsp_endpoint import LspEndpoint
+from pylspclient import lsp_structs

setup.py

@@ -0,0 +1,93 @@
+from __future__ import print_function
+import json
+from pylspclient import lsp_structs
+import threading
+
+JSON_RPC_REQ_FORMAT = "Content-Length: {json_string_len}\r\n\r\n{json_string}"
+LEN_HEADER = "Content-Length: "
+TYPE_HEADER = "Content-Type: "
+
+
+# TODO: add content-type
+
+
+class MyEncoder(json.JSONEncoder): 
+    """
+    Encodes an object in JSON
+    """
+    def default(self, o): # pylint: disable=E0202
+        return o.__dict__ 
+
+
+class JsonRpcEndpoint(object):
+    '''
+    Thread safe JSON RPC endpoint implementation. Responsible to recieve and send JSON RPC messages, as described in the
+    protocol. More information can be found: https://www.jsonrpc.org/
+    '''
+    def __init__(self, stdin, stdout):
+        self.stdin = stdin
+        self.stdout = stdout
+        self.read_lock = threading.Lock() 
+        self.write_lock = threading.Lock() 
+
+    @staticmethod
+    def __add_header(json_string):
+        '''
+        Adds a header for the given json string
+        
+        :param str json_string: The string
+        :return: the string with the header
+        '''
+        return JSON_RPC_REQ_FORMAT.format(json_string_len=len(json_string), json_string=json_string)
+
+
+    def send_request(self, message):
+        '''
+        Sends the given message.
+
+        :param dict message: The message to send.            
+        '''
+        json_string = json.dumps(message, cls=MyEncoder)
+        jsonrpc_req = self.__add_header(json_string)
+        with self.write_lock:
+            self.stdin.write(jsonrpc_req.encode())
+            self.stdin.flush()
+
+
+    def recv_response(self):
+        '''        
+        Recives a message.
+
+        :return: a message
+        '''
+        with self.read_lock:
+            message_size = None
+            while True:
+                #read header
+                line = self.stdout.readline()
+                if not line:
+                    # server quit
+                    return None
+                line = line.decode("utf-8")
+                if not line.endswith("\r\n"):
+                    raise lsp_structs.ResponseError(lsp_structs.ErrorCodes.ParseError, "Bad header: missing newline")
+                #remove the "\r\n"
+                line = line[:-2]
+                if line == "":
+                    # done with the headers
+                    break
+                elif line.startswith(LEN_HEADER):
+                    line = line[len(LEN_HEADER):]
+                    if not line.isdigit():
+                        raise lsp_structs.ResponseError(lsp_structs.ErrorCodes.ParseError, "Bad header: size is not int")
+                    message_size = int(line)
+                elif line.startswith(TYPE_HEADER):
+                    # nothing todo with type for now.
+                    pass
+                else:
+                    raise lsp_structs.ResponseError(lsp_structs.ErrorCodes.ParseError, "Bad header: unkown header")
+            if not message_size:
+                raise lsp_structs.ResponseError(lsp_structs.ErrorCodes.ParseError, "Bad header: missing size")
+
+            jsonrpc_res = self.stdout.read(message_size).decode("utf-8")
+            return json.loads(jsonrpc_res)