add protobuf transport and refactor to support (#24)

Author: joshuadavidthomas

.github/workflows/test.yml

@@ -35,6 +35,11 @@ jobs:
           enable-cache: true
           version: ${{ env.UV_VERSION }}
 
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Install dependencies and build
         run: |
           uv sync --frozen

.just/proto.just

@@ -0,0 +1,37 @@
+set unstable := true
+
+justfile := justfile_directory() + "/.just/proto.just"
+
+[private]
+default:
+    @just --list --justfile {{ justfile }}
+
+[no-cd]
+[private]
+check:
+    #!/usr/bin/env sh
+    if ! command -v protoc > /dev/null 2>&1; then
+        echo "protoc is not installed. Please install protobuf-compiler"
+        exit 1
+    fi
+
+[private]
+fmt:
+    @just --fmt --justfile {{ justfile }}
+
+# Generate protobuf code for both Rust and Python
+[no-cd]
+gen:
+  @just proto rust
+  @just proto py
+
+# Generate protobuf code for Rust
+[no-cd]
+rust: check
+    cargo build -p djls-types
+
+# Generate protobuf code for Python
+[no-cd]
+py: check
+    protoc -I=proto --python_out=python/djls proto/*.proto
+

Cargo.toml

@@ -9,10 +9,13 @@ djls-django = { path = "crates/djls-django" }
 djls-ipc = { path = "crates/djls-ipc" }
 djls-python = { path = "crates/djls-python" }
 djls-server = { path = "crates/djls-server" }
+djls-types = { path = "crates/djls-types" }
 djls-worker = { path = "crates/djls-worker" }
 
 anyhow = "1.0.94"
 async-trait = "0.1.83"
+prost = "0.13"
+bytes = "1.9"
 serde = { version = "1.0.215", features = ["derive"] }
 serde_json = "1.0.133"
 thiserror = "2.0.6"

Justfile

@@ -1,6 +1,8 @@
 set dotenv-load := true
 set unstable := true
 
+mod proto ".just/proto.just"
+
 # List all available commands
 [private]
 default:

crates/djlc-cli/Cargo.toml

@@ -9,6 +9,7 @@ djls-ipc = { workspace = true }
 djls-server = { workspace = true }
 
 anyhow = { workspace = true }
+serde_json = { workspace = true }
 tokio = { workspace = true }
 
 clap = { version = "4.5.23", features = ["derive"] }

crates/djlc-cli/src/main.rs

@@ -33,10 +33,6 @@ impl CommonOpts {
 enum Commands {
     /// Start the LSP server
     Serve(CommonOpts),
-    /// Get Python environment information
-    Info(CommonOpts),
-    /// Print the version
-    Version(CommonOpts),
 }
 
 #[tokio::main]
@@ -49,22 +45,6 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
                 PythonProcess::new("djls.lsp", Transport::Json, opts.health_check_interval())?;
             djls_server::serve(python).await?
         }
-        Commands::Info(opts) => {
-            let mut python =
-                PythonProcess::new("djls.lsp", Transport::Json, opts.health_check_interval())?;
-            match python.send("python_setup", None) {
-                Ok(info) => println!("{}", info),
-                Err(e) => eprintln!("Failed to get info: {}", e),
-            }
-        }
-        Commands::Version(opts) => {
-            let mut python =
-                PythonProcess::new("djls.lsp", Transport::Json, opts.health_check_interval())?;
-            match python.send("version", None) {
-                Ok(version) => println!("Python module version: {}", version),
-                Err(e) => eprintln!("Failed to get version: {}", e),
-            }
-        }
     }
 
     Ok(())

crates/djls-django/src/apps.rs

@@ -1,4 +1,4 @@
-use djls_ipc::{parse_json_response, JsonResponse, PythonProcess, TransportError};
+use djls_ipc::{JsonResponse, PythonProcess, TransportError, TransportMessage, TransportResponse};
 use serde::Deserialize;
 use std::fmt;
 
@@ -55,10 +55,18 @@ impl Apps {
     }
 
     pub fn check_installed(python: &mut PythonProcess, app: &str) -> Result<bool, TransportError> {
-        let response = python.send("installed_apps_check", Some(vec![app.to_string()]))?;
-        let response = parse_json_response(response)?;
-        let result = InstalledAppsCheck::try_from(response)?;
-        Ok(result.has_app)
+        let message = TransportMessage::Json("installed_apps_check".to_string());
+        let response = python.send(message, Some(vec![app.to_string()]))?;
+        match response {
+            TransportResponse::Json(json_str) => {
+                let json_response: JsonResponse = serde_json::from_str(&json_str)?;
+                let result = InstalledAppsCheck::try_from(json_response)?;
+                Ok(result.has_app)
+            }
+            _ => Err(TransportError::Process(
+                "Unexpected response type".to_string(),
+            )),
+        }
     }
 }
 

crates/djls-django/src/django.rs

@@ -1,7 +1,7 @@
 use crate::apps::Apps;
 use crate::gis::{check_gis_setup, GISError};
 use crate::templates::TemplateTags;
-use djls_ipc::{parse_json_response, JsonResponse, PythonProcess, TransportError};
+use djls_ipc::{JsonResponse, PythonProcess, TransportError, TransportMessage, TransportResponse};
 use djls_python::{ImportCheck, Python};
 use serde::Deserialize;
 use std::fmt;
@@ -23,9 +23,17 @@ struct DjangoSetup {
 
 impl DjangoSetup {
     pub fn setup(python: &mut PythonProcess) -> Result<JsonResponse, ProjectError> {
-        let response = python.send("django_setup", None)?;
-        let response = parse_json_response(response)?;
-        Ok(response)
+        let message = TransportMessage::Json("django_setup".to_string());
+        let response = python.send(message, None)?;
+        match response {
+            TransportResponse::Json(json_str) => {
+                let json_response: JsonResponse = serde_json::from_str(&json_str)?;
+                Ok(json_response)
+            }
+            _ => Err(ProjectError::Transport(TransportError::Process(
+                "Unexpected response type".to_string(),
+            ))),
+        }
     }
 }
 

crates/djls-ipc/Cargo.toml

@@ -4,8 +4,12 @@ version = "0.0.0"
 edition = "2021"
 
 [dependencies]
+djls-types = { workspace = true }
+
 anyhow = { workspace = true }
 async-trait = { workspace = true }
+prost = { workspace = true }
+bytes = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 thiserror = { workspace = true }

crates/djls-ipc/src/lib.rs

@@ -7,3 +7,5 @@ pub use transport::parse_raw_response;
 pub use transport::JsonResponse;
 pub use transport::Transport;
 pub use transport::TransportError;
+pub use transport::TransportMessage;
+pub use transport::TransportResponse;