Use a newtype for the serialized PackageId in Proc Macro Server

scarb/src/compiler/plugin/collection.rs

@@ -3,6 +3,7 @@ use std::{collections::HashMap, sync::Arc};
 use anyhow::Result;
 use cairo_lang_semantic::{inline_macros::get_default_plugin_suite, plugin::PluginSuite};
 use itertools::Itertools;
+use scarb_proc_macro_server_types::scope::SerializedPackageId;
 
 use crate::{
     compiler::{CairoCompilationUnit, CompilationUnitComponentId, CompilationUnitDependency},
@@ -58,7 +59,7 @@ pub struct WorkspaceProcMacros {
     /// A mapping of the form: `package (as a serialized [`PackageId`]) -> plugin`.
     /// Contains IDs of all packages from the workspace, each mapped to a [`ProcMacroHostPlugin`] which contains
     /// **all proc macro dependencies of the package** collected from **all compilation units it appears in**.
-    pub macros_for_packages: HashMap<String, Arc<ProcMacroHostPlugin>>,
+    pub macros_for_packages: HashMap<SerializedPackageId, Arc<ProcMacroHostPlugin>>,
 }
 
 impl WorkspaceProcMacros {
@@ -90,7 +91,7 @@ impl WorkspaceProcMacros {
 
                 let plugin = Arc::new(ProcMacroHostPlugin::try_new(deduplicated_instances)?);
 
-                Ok((package_id, plugin))
+                Ok((package_id.into(), plugin))
             })
             .collect::<Result<HashMap<_, _>>>()?;
 
@@ -100,7 +101,7 @@ impl WorkspaceProcMacros {
     }
 
     /// Returns a [`ProcMacroHostPlugin`] assigned to the package with `package_id`.
-    pub fn get(&self, package_id: &str) -> Option<Arc<ProcMacroHostPlugin>> {
+    pub fn get(&self, package_id: &SerializedPackageId) -> Option<Arc<ProcMacroHostPlugin>> {
         self.macros_for_packages.get(package_id).cloned()
     }
 }

utils/scarb-proc-macro-server-types/src/methods/defined_macros.rs

@@ -1,5 +1,7 @@
 use std::collections::HashMap;
 
+use crate::scope::SerializedPackageId;
+
 use super::Method;
 use serde::{Deserialize, Serialize};
 
@@ -16,7 +18,7 @@ pub struct DefinedMacrosResponse {
     /// A mapping of the form: `package (as a serialized `PackageId`) -> macros info`.
     /// Contains serialized IDs of all packages from the workspace,
     /// mapped to the [`PackageDefinedMacrosInfo`], describing macros available for them.
-    pub macros_by_package_id: HashMap<String, PackageDefinedMacrosInfo>,
+    pub macros_by_package_id: HashMap<SerializedPackageId, PackageDefinedMacrosInfo>,
 }
 
 /// Response structure containing lists of all defined macros available for one package.

utils/scarb-proc-macro-server-types/src/scope.rs

@@ -1,8 +1,37 @@
+use std::fmt::Display;
+
 use serde::{Deserialize, Serialize};
 
+/// A string-serialized `PackageId` from the Scarb workspace.
+/// Follows the schema: "crate-name version source-path".
+#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, Hash)]
+#[repr(transparent)] // Guarantees a backward-compatibility with the previous version.
+pub struct SerializedPackageId(pub String);
+
+impl From<String> for SerializedPackageId {
+    fn from(value: String) -> Self {
+        Self(value)
+    }
+}
+
+impl Display for SerializedPackageId {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", self.0)
+    }
+}
+
+impl SerializedPackageId {
+    pub fn name(&self) -> &str {
+        self.0
+            .split(" ")
+            .next()
+            .expect("SerializedPackageId should follow a format `<name> <version> (<source>)`")
+    }
+}
+
 /// A description of the location in the workspace where particular macro is available.
 #[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, Hash)]
 pub struct ProcMacroScope {
     /// Serialized `PackageId` of the package in which context the action occurs.
-    pub package_id: String,
+    pub package_id: SerializedPackageId,
 }

utils/scarb-test-support/src/proc_macro_server.rs

@@ -7,6 +7,7 @@ use scarb_proc_macro_server_types::methods::defined_macros::DefinedMacros;
 use scarb_proc_macro_server_types::methods::defined_macros::DefinedMacrosParams;
 use scarb_proc_macro_server_types::methods::defined_macros::PackageDefinedMacrosInfo;
 use scarb_proc_macro_server_types::methods::Method;
+use scarb_proc_macro_server_types::scope::SerializedPackageId;
 use std::collections::HashMap;
 use std::io::BufRead;
 use std::io::BufReader;
@@ -73,7 +74,7 @@ pub struct ProcMacroClient {
 /// identified by the `package_id` which is a serialized `PackageId`.
 pub struct DefinedMacrosInfo {
     /// An ID of the package recognized by PMS.
-    pub package_id: String,
+    pub package_id: SerializedPackageId,
     /// A proper part of the response, related to the main component of the main CU.
     pub defined_macros: PackageDefinedMacrosInfo,
 }
@@ -193,7 +194,7 @@ impl ProcMacroClient {
         // Usually, we can't discover the ID of the mock package used in test, so we extract it from the PMS response.
         let package_id = response
             .keys()
-            .find(|cu_id| cu_id.starts_with(package_name))
+            .find(|cu_id| cu_id.0.starts_with(package_name))
             .expect("Response from Proc Macro Server should contain the main compilation unit.")
             .to_owned();