feat: use Url type instead of String

Author: kkharji

bsp-server/src/request.rs

@@ -267,14 +267,21 @@ mod se {
     use super::*;
     #[test]
     fn initialize() {
-        let mut params = InitializeBuild::default();
+        let mut params = InitializeBuild::new(
+            "MyName",
+            "1",
+            "2",
+            Url::from_file_path("/tmp/lua_27s2fl").unwrap(),
+            Default::default(),
+            Default::default(),
+        );
         params.set_display_name("MyName".into());
 
         let value = &Request::InitializeBuild(3.into(), params);
         let result = to_string(value).unwrap();
         assert_eq!(
             result,
-            "{\"id\":3,\"method\":\"build/initialize\",\"params\":{\"displayName\":\"MyName\",\"capabilities\":{\"languageIds\":[]}}}"
+           "{\"id\":3,\"method\":\"build/initialize\",\"params\":{\"displayName\":\"MyName\",\"version\":\"1\",\"bspVersion\":\"2\",\"rootUri\":\"file:///tmp/lua_27s2fl\",\"capabilities\":{\"languageIds\":[]},\"data\":null}}" 
         );
     }
 
@@ -442,7 +449,7 @@ mod de {
     use super::*;
     #[test]
     fn initialize() {
-        let value = "{\"id\":3,\"method\":\"build/initialize\",\"params\":{\"displayName\":\"MyName\",\"capabilities\":{\"languageIds\":[]}}}";
+        let value = "{\"id\":3,\"method\":\"build/initialize\",\"params\":{\"displayName\":\"MyName\",\"version\":\"1\",\"bspVersion\":\"2\",\"rootUri\":\"file:///tmp/lua_27s2fl\",\"capabilities\":{\"languageIds\":[]},\"data\":null}}";
         let msg = serde_json::from_str(value).unwrap();
         assert!(matches!(
             msg,

bsp-types/src/bt_dependency_modules.rs

@@ -53,7 +53,7 @@ impl BuildTargetDependencyModulesResult {
     }
 }
 
-#[derive(Default, Debug, Serialize, Deserialize, PartialEq, Eq)]
+#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
 pub struct DependencyModulesItem {
     target: BuildTargetIdentifier,
     modules: Vec<DependencyModule>,

bsp-types/src/bt_dependency_sources.rs

@@ -37,7 +37,7 @@ pub struct BuildTargetDependencySourcesResult {
     items: Vec<DependencySourcesItem>,
 }
 
-#[derive(Default, Debug, Serialize, Deserialize, PartialEq, Eq)]
+#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
 pub struct DependencySourcesItem {
     target: BuildTargetIdentifier,
     /// List of resources containing source files of the

bsp-types/src/bt_did_change.rs

@@ -13,7 +13,7 @@ impl BuildTargetDidChange {
     pub const METHOD: &'static str = "buildTarget/didChange";
 }
 
-#[derive(Default, Debug, Serialize, Deserialize, Clone)]
+#[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct BuildTargetEvent {
     /// The identifier for the changed build target.
     pub target: BuildTargetIdentifier,
@@ -36,7 +36,8 @@ impl BuildTargetEvent {
     pub fn new_simple(target: BuildTargetIdentifier) -> Self {
         Self {
             target,
-            ..Default::default()
+            kind: Default::default(),
+            data: Default::default(),
         }
     }
 }

bsp-types/src/bt_identifier.rs

@@ -1,12 +1,13 @@
+use lsp_types::Url;
 use serde::{Deserialize, Serialize};
 
-#[derive(Default, Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
+#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
 pub struct BuildTargetIdentifier {
-    uri: String,
+    uri: Url,
 }
 
 impl BuildTargetIdentifier {
-    pub fn new(uri: String) -> Self {
+    pub fn new(uri: Url) -> Self {
         Self { uri }
     }
 
@@ -16,11 +17,7 @@ impl BuildTargetIdentifier {
     }
 
     /// Set the bsp build target identifier's uri.
-    pub fn set_uri(&mut self, uri: String) {
+    pub fn set_uri(&mut self, uri: Url) {
         self.uri = uri;
     }
-
-    pub fn is_empty(&self) -> bool {
-        self.uri.is_empty()
-    }
 }

bsp-types/src/bt_resources.rs

@@ -55,7 +55,7 @@ impl BuildTargetResourcesResult {
     }
 }
 
-#[derive(Default, Debug, Serialize, Deserialize, PartialEq, Eq)]
+#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
 pub struct Resources {
     target: BuildTargetIdentifier,
     /// List of resource files.

bsp-types/src/bt_sources.rs

@@ -1,4 +1,5 @@
 use super::BuildTargetIdentifier;
+use lsp_types::Url;
 use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Clone, Default, Serialize, Deserialize)]
@@ -47,7 +48,7 @@ impl BuildTargetSourcesResult {
     }
 }
 
-#[derive(Debug, Default, Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub struct SourcesCollection {
     target: BuildTargetIdentifier,
 
@@ -81,12 +82,12 @@ impl SourcesCollection {
     }
 }
 
-#[derive(Debug, Default, Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub struct Sources {
     /// Either a text document or a directory. A directory entry must end with a
     /// forward slash "/" and a directory entry implies that every nested text
     /// document within the directory belongs to this source item.
-    uri: String,
+    uri: Url,
 
     /// Type of file of the source item, such as whether it is file or directory.
     kind: SourceKind,
@@ -97,7 +98,10 @@ pub struct Sources {
 }
 
 impl Sources {
-    pub fn new(uri: String, kind: SourceKind, generated: bool) -> Self {
+    /// Either a text document or a directory. A directory entry must end with a
+    /// forward slash "/" and a directory entry implies that every nested text
+    /// document within the directory belongs to this source item.
+    pub fn new(uri: Url, kind: SourceKind, generated: bool) -> Self {
         Self {
             uri,
             kind,
@@ -116,12 +120,12 @@ impl Sources {
     }
 
     /// Get a reference to the bsp sources item's uri.
-    pub fn uri(&self) -> &str {
-        self.uri.as_ref()
+    pub fn uri(&self) -> &Url {
+        &self.uri
     }
 
     /// Set the bsp sources item's uri.
-    pub fn set_uri(&mut self, uri: String) {
+    pub fn set_uri(&mut self, uri: Url) {
         self.uri = uri;
     }
 

bsp-types/src/debug_session_start.rs

@@ -1,4 +1,5 @@
 use super::BuildTargetIdentifier;
+use lsp_types::Url;
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
 
@@ -63,5 +64,11 @@ impl DebugSessionStart {
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
 pub struct DebugSessionStartResult {
     /** The Debug Adapter Protocol server's connection uri */
-    uri: String,
+    uri: Url,
+}
+
+impl DebugSessionStartResult {
+    pub fn new(uri: Url) -> Self {
+        Self { uri }
+    }
 }

bsp-types/src/initialize_params.rs

@@ -1,11 +1,12 @@
 use std::path::PathBuf;
 
 use super::ClientCapabilities;
+use lsp_types::Url;
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
 
-#[derive(Default, Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
-#[serde(rename_all = "camelCase", default)]
+#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
+#[serde(rename_all = "camelCase")]
 /// Like the language server protocol, the initialize request is sent as the first request from the
 /// client to the server. If the server receives a request or notification before the initialize
 /// request it should act as follows:
@@ -22,18 +23,18 @@ pub struct InitializeBuild {
     /// Name of the client
     display_name: String,
     /// The version of the client
-    #[serde(skip_serializing_if = "String::is_empty")]
+    #[serde(skip_serializing_if = "String::is_empty", default)]
     version: String,
     /// The BSP version that the client speaks
-    #[serde(skip_serializing_if = "String::is_empty")]
+    #[serde(skip_serializing_if = "String::is_empty", default)]
     bsp_version: String,
     /// The rootUri of the workspace
-    #[serde(skip_serializing_if = "String::is_empty")]
-    root_uri: String,
+    root_uri: Url,
     /// The capabilities of the client
+    #[serde(default)]
     capabilities: ClientCapabilities,
     /// Additional metadata about the client
-    #[serde(skip_serializing_if = "Option::is_none")]
+    #[serde(skip_serializing_if = "Option::is_none", default)]
     data: Option<Value>,
 }
 
@@ -42,7 +43,7 @@ impl InitializeBuild {
         display_name: S,
         version: S,
         bsp_version: S,
-        root_uri: S,
+        root_uri: Url,
         capabilities: ClientCapabilities,
         data: Value,
     ) -> Self {
@@ -60,7 +61,7 @@ impl InitializeBuild {
         display_name: S,
         version: S,
         bsp_version: S,
-        root_uri: S,
+        root_uri: Url,
         capabilities: ClientCapabilities,
     ) -> Self {
         Self {
@@ -99,14 +100,12 @@ impl InitializeBuild {
     }
 
     /// Get a reference to the bsp initialize build params's root uri.
-    pub fn root_path(&self) -> Option<PathBuf> {
-        self.root_uri
-            .strip_prefix("file://")
-            .map(|s| PathBuf::from(s))
+    pub fn root_path(&self) -> PathBuf {
+        self.root_uri.path().into()
     }
 
     /// Set the bsp initialize build params's root uri.
-    pub fn set_root_uri(&mut self, root_uri: String) {
+    pub fn set_root_uri(&mut self, root_uri: Url) {
         self.root_uri = root_uri;
     }
 

bsp-types/src/lib.rs

@@ -45,6 +45,7 @@ pub use initialize_params::*;
 pub use initialize_result::*;
 pub use language::*;
 pub use log_message::*;
+pub use lsp_types::Url;
 pub use message_type::*;
 pub use providers::*;
 pub use publish_diagnostics::*;