chore(turbo): rename WorkspaceInfo struct to PackageInfo (#7353)

Author: mehulkar

crates/turborepo-lib/src/framework.rs

@@ -1,6 +1,6 @@
 use std::sync::OnceLock;
 
-use turborepo_repository::package_graph::WorkspaceInfo;
+use turborepo_repository::package_graph::PackageInfo;
 
 #[derive(Debug, PartialEq)]
 enum Strategy {
@@ -137,7 +137,7 @@ fn get_frameworks() -> &'static [Framework] {
 }
 
 impl Matcher {
-    pub fn test(&self, workspace: &WorkspaceInfo, is_monorepo: bool) -> bool {
+    pub fn test(&self, workspace: &PackageInfo, is_monorepo: bool) -> bool {
         // In the case where we're not in a monorepo, i.e. single package mode
         // `unresolved_external_dependencies` is not populated. In which
         // case we should check `dependencies` instead.
@@ -160,7 +160,7 @@ impl Matcher {
     }
 }
 
-pub fn infer_framework(workspace: &WorkspaceInfo, is_monorepo: bool) -> Option<&'static Framework> {
+pub fn infer_framework(workspace: &PackageInfo, is_monorepo: bool) -> Option<&'static Framework> {
     let frameworks = get_frameworks();
 
     frameworks
@@ -171,7 +171,7 @@ pub fn infer_framework(workspace: &WorkspaceInfo, is_monorepo: bool) -> Option<&
 #[cfg(test)]
 mod tests {
     use test_case::test_case;
-    use turborepo_repository::{package_graph::WorkspaceInfo, package_json::PackageJson};
+    use turborepo_repository::{package_graph::PackageInfo, package_json::PackageJson};
 
     use crate::framework::{get_frameworks, infer_framework, Framework};
 
@@ -182,9 +182,9 @@ mod tests {
             .expect("framework not found")
     }
 
-    #[test_case(WorkspaceInfo::default(), None, true; "empty dependencies")]
+    #[test_case(PackageInfo::default(), None, true; "empty dependencies")]
     #[test_case(
-        WorkspaceInfo {
+        PackageInfo {
             unresolved_external_dependencies: Some(
                 vec![("blitz".to_string(), "*".to_string())].into_iter().collect()
             ),
@@ -195,7 +195,7 @@ mod tests {
         "blitz"
     )]
     #[test_case(
-        WorkspaceInfo {
+        PackageInfo {
             unresolved_external_dependencies: Some(
                 vec![("blitz", "*"), ("next", "*")]
                     .into_iter()
@@ -209,7 +209,7 @@ mod tests {
         "Order is preserved (returns blitz, not next)"
     )]
     #[test_case(
-        WorkspaceInfo {
+        PackageInfo {
             unresolved_external_dependencies: Some(
                 vec![("next", "*")]
                     .into_iter()
@@ -223,7 +223,7 @@ mod tests {
         "Finds next without blitz"
     )]
     #[test_case(
-        WorkspaceInfo {
+        PackageInfo {
             unresolved_external_dependencies: Some(
                 vec![("solid-js", "*"), ("solid-start", "*")]
                     .into_iter()
@@ -237,7 +237,7 @@ mod tests {
         "match all strategy works (solid)"
     )]
     #[test_case(
-        WorkspaceInfo {
+        PackageInfo {
             unresolved_external_dependencies: Some(
                 vec![("nuxt3", "*")]
                     .into_iter()
@@ -251,7 +251,7 @@ mod tests {
         "match some strategy works (nuxt)"
     )]
     #[test_case(
-        WorkspaceInfo {
+        PackageInfo {
             unresolved_external_dependencies: Some(
                 vec![("react-scripts", "*")]
                     .into_iter()
@@ -265,7 +265,7 @@ mod tests {
         "match some strategy works (create-react-app)"
     )]
     #[test_case(
-        WorkspaceInfo {
+        PackageInfo {
             package_json: PackageJson {
               dependencies: Some(
                 vec![("next", "*")]
@@ -282,7 +282,7 @@ mod tests {
         "Finds next in non-monorepo"
     )]
     fn test_infer_framework(
-        workspace_info: WorkspaceInfo,
+        workspace_info: PackageInfo,
         expected: Option<&'static Framework>,
         is_monorepo: bool,
     ) {

crates/turborepo-lib/src/run/cache.rs

@@ -6,7 +6,7 @@ use turbopath::{
     AbsoluteSystemPath, AbsoluteSystemPathBuf, AnchoredSystemPath, AnchoredSystemPathBuf,
 };
 use turborepo_cache::{AsyncCache, CacheError, CacheHitMetadata, CacheSource};
-use turborepo_repository::package_graph::WorkspaceInfo;
+use turborepo_repository::package_graph::PackageInfo;
 use turborepo_scm::SCM;
 use turborepo_telemetry::events::{task::PackageTaskEventBuilder, TrackedErrors};
 use turborepo_ui::{
@@ -84,7 +84,7 @@ impl RunCache {
         self: &Arc<Self>,
         // TODO: Group these in a struct
         task_definition: &TaskDefinition,
-        workspace_info: &WorkspaceInfo,
+        workspace_info: &PackageInfo,
         task_id: TaskId<'static>,
         hash: &str,
     ) -> TaskCache {

crates/turborepo-lib/src/run/summary/task_factory.rs

@@ -1,7 +1,7 @@
 use std::collections::HashSet;
 
 use turborepo_env::EnvironmentVariableMap;
-use turborepo_repository::package_graph::{PackageGraph, WorkspaceInfo, WorkspaceName};
+use turborepo_repository::package_graph::{PackageGraph, PackageInfo, WorkspaceName};
 
 use super::{
     execution::TaskExecutionSummary,
@@ -106,7 +106,7 @@ impl<'a> TaskSummaryFactory<'a> {
         &self,
         task_id: &TaskId<'static>,
         execution: Option<TaskExecutionSummary>,
-        workspace_info: &WorkspaceInfo,
+        workspace_info: &PackageInfo,
         display_task: impl Fn(&TaskNode) -> Option<T> + Copy,
     ) -> Result<SharedTaskSummary<T>, Error> {
         // TODO: command should be optional
@@ -202,7 +202,7 @@ impl<'a> TaskSummaryFactory<'a> {
         })
     }
 
-    fn workspace_info(&self, task_id: &TaskId) -> Result<&WorkspaceInfo, Error> {
+    fn workspace_info(&self, task_id: &TaskId) -> Result<&PackageInfo, Error> {
         let workspace_name = WorkspaceName::from(task_id.package());
         self.package_graph
             .workspace_info(&workspace_name)

crates/turborepo-lib/src/task_hash.rs

@@ -10,7 +10,7 @@ use tracing::{debug, Span};
 use turbopath::{AbsoluteSystemPath, AnchoredSystemPath, AnchoredSystemPathBuf};
 use turborepo_cache::CacheHitMetadata;
 use turborepo_env::{BySource, DetailedMap, EnvironmentVariableMap, ResolvedEnvMode};
-use turborepo_repository::package_graph::{WorkspaceInfo, WorkspaceName};
+use turborepo_repository::package_graph::{PackageInfo, WorkspaceName};
 use turborepo_scm::SCM;
 use turborepo_telemetry::events::{
     generic::GenericEventBuilder, task::PackageTaskEventBuilder, EventBuilder,
@@ -70,7 +70,7 @@ impl PackageInputsHashes {
     pub fn calculate_file_hashes<'a>(
         scm: &SCM,
         all_tasks: impl ParallelIterator<Item = &'a TaskNode>,
-        workspaces: HashMap<&WorkspaceName, &WorkspaceInfo>,
+        workspaces: HashMap<&WorkspaceName, &PackageInfo>,
         task_definitions: &HashMap<TaskId<'static>, TaskDefinition>,
         repo_root: &AbsoluteSystemPath,
         telemetry: &GenericEventBuilder,
@@ -213,7 +213,7 @@ impl<'a> TaskHasher<'a> {
         task_id: &TaskId<'static>,
         task_definition: &TaskDefinition,
         task_env_mode: ResolvedEnvMode,
-        workspace: &WorkspaceInfo,
+        workspace: &PackageInfo,
         dependency_set: HashSet<&TaskNode>,
         telemetry: PackageTaskEventBuilder,
     ) -> Result<String, Error> {

crates/turborepo-repository/src/package_graph/builder.rs

@@ -13,7 +13,7 @@ use turbopath::{
 use turborepo_graph_utils as graph;
 use turborepo_lockfiles::Lockfile;
 
-use super::{PackageGraph, PackageNode, WorkspaceInfo, WorkspaceName};
+use super::{PackageGraph, PackageInfo, PackageNode, WorkspaceName};
 use crate::{
     discovery::{
         self, CachingPackageDiscovery, LocalPackageDiscoveryBuilder, PackageDiscovery,
@@ -144,7 +144,7 @@ where
 struct BuildState<'a, S, T> {
     repo_root: &'a AbsoluteSystemPath,
     single: bool,
-    workspaces: HashMap<WorkspaceName, WorkspaceInfo>,
+    workspaces: HashMap<WorkspaceName, PackageInfo>,
     workspace_graph: Graph<PackageNode, ()>,
     node_lookup: HashMap<PackageNode, NodeIndex>,
     lockfile: Option<Box<dyn Lockfile>>,
@@ -201,7 +201,7 @@ where
         let mut workspaces = HashMap::new();
         workspaces.insert(
             WorkspaceName::Root,
-            WorkspaceInfo {
+            PackageInfo {
                 package_json: root_package_json,
                 package_json_path: AnchoredSystemPathBuf::from_raw("package.json").unwrap(),
                 ..Default::default()
@@ -238,7 +238,7 @@ impl<'a, T: PackageDiscovery> BuildState<'a, ResolvedPackageManager, T> {
                 .clone()
                 .ok_or(Error::PackageJsonMissingName(package_json_path))?,
         );
-        let entry = WorkspaceInfo {
+        let entry = PackageInfo {
             package_json: json,
             package_json_path: relative_json_path,
             ..Default::default()
@@ -533,7 +533,7 @@ impl Dependencies {
     pub fn new<'a, I: IntoIterator<Item = (&'a String, &'a String)>>(
         repo_root: &AbsoluteSystemPath,
         workspace_json_path: &AnchoredSystemPathBuf,
-        workspaces: &HashMap<WorkspaceName, WorkspaceInfo>,
+        workspaces: &HashMap<WorkspaceName, PackageInfo>,
         dependencies: I,
     ) -> Self {
         let resolved_workspace_json_path = repo_root.resolve(workspace_json_path);
@@ -561,7 +561,7 @@ impl Dependencies {
 struct DependencySplitter<'a, 'b, 'c> {
     repo_root: &'a AbsoluteSystemPath,
     workspace_dir: &'b AbsoluteSystemPath,
-    workspaces: &'c HashMap<WorkspaceName, WorkspaceInfo>,
+    workspaces: &'c HashMap<WorkspaceName, PackageInfo>,
 }
 
 impl<'a, 'b, 'c> DependencySplitter<'a, 'b, 'c> {
@@ -680,7 +680,7 @@ impl<'a> fmt::Display for DependencyVersion<'a> {
     }
 }
 
-impl WorkspaceInfo {
+impl PackageInfo {
     fn unix_dir_str(&self) -> Result<String, Error> {
         let unix = self
             .package_json_path
@@ -739,7 +739,7 @@ mod test {
             let mut map = HashMap::new();
             map.insert(
                 WorkspaceName::Other("@scope/foo".to_string()),
-                WorkspaceInfo {
+                PackageInfo {
                     package_json: PackageJson {
                         version: Some(package_version.to_string()),
                         ..Default::default()

crates/turborepo-repository/src/package_graph/mod.rs

@@ -25,7 +25,7 @@ pub struct PackageGraph {
     workspace_graph: petgraph::Graph<PackageNode, ()>,
     #[allow(dead_code)]
     node_lookup: HashMap<PackageNode, petgraph::graph::NodeIndex>,
-    workspaces: HashMap<WorkspaceName, WorkspaceInfo>,
+    workspaces: HashMap<WorkspaceName, PackageInfo>,
     package_manager: PackageManager,
     lockfile: Option<Box<dyn Lockfile>>,
 }
@@ -51,18 +51,16 @@ impl WorkspacePackage {
     }
 }
 
-/// WorkspaceInfo represents a package within the workspace.
-/// TODO: The name WorkspaceInfo should be changed to PackageInfo to follow the
-/// Vercel glossary.
+/// PackageInfo represents a package within the workspace.
 #[derive(Debug, Clone, PartialEq, Eq, Default)]
-pub struct WorkspaceInfo {
+pub struct PackageInfo {
     pub package_json: PackageJson,
     pub package_json_path: AnchoredSystemPathBuf,
     pub unresolved_external_dependencies: Option<BTreeMap<PackageName, PackageVersion>>,
     pub transitive_dependencies: Option<HashSet<turborepo_lockfiles::Package>>,
 }
 
-impl WorkspaceInfo {
+impl PackageInfo {
     pub fn package_name(&self) -> Option<String> {
         self.package_json.name.clone()
     }
@@ -176,11 +174,11 @@ impl PackageGraph {
         )
     }
 
-    pub fn workspace_info(&self, workspace: &WorkspaceName) -> Option<&WorkspaceInfo> {
+    pub fn workspace_info(&self, workspace: &WorkspaceName) -> Option<&PackageInfo> {
         self.workspaces.get(workspace)
     }
 
-    pub fn workspaces(&self) -> impl Iterator<Item = (&WorkspaceName, &WorkspaceInfo)> {
+    pub fn workspaces(&self) -> impl Iterator<Item = (&WorkspaceName, &PackageInfo)> {
         self.workspaces.iter()
     }