Initial scaffold for rover dev rewrite (#2228)

Author: dotdat

Cargo.toml

@@ -45,6 +45,7 @@ default = ["composition-js"]
 # notably, it is disabled for x86_64-unknown-linux-musl builds
 # because of this GitHub issue: https://github.com/denoland/deno/issues/3711
 composition-js = []
+dev-next = []
 
 ### cross-workspace dependencies
 # these dependencies can be used by any other workspace crate by specifying the dependency like so:

src/command/dev/compose.rs src/command/dev/legacy/compose.rs

@@ -6,7 +6,7 @@ use apollo_federation_types::config::{FederationVersion, SupergraphConfig};
 use camino::Utf8PathBuf;
 use rover_std::{errln, Fs};
 
-use crate::command::dev::do_dev::log_err_and_continue;
+use crate::command::dev::legacy::do_dev::log_err_and_continue;
 use crate::command::supergraph::compose::{Compose, CompositionOutput};
 use crate::options::PluginOpts;
 use crate::utils::client::StudioClientConfig;

src/command/dev/do_dev.rs src/command/dev/legacy/do_dev.rs

@@ -6,14 +6,13 @@ use futures::stream::StreamExt;
 use futures::FutureExt;
 use rover_std::warnln;
 
-use crate::command::dev::protocol::FollowerMessage;
+use crate::command::dev::{legacy::protocol::FollowerMessage, Dev};
 use crate::utils::client::StudioClientConfig;
 use crate::utils::supergraph_config::get_supergraph_config;
 use crate::{RoverError, RoverOutput, RoverResult};
 
 use super::protocol::{FollowerChannel, FollowerMessenger, LeaderChannel, LeaderSession};
 use super::router::RouterConfigHandler;
-use super::Dev;
 
 pub fn log_err_and_continue(err: RoverError) -> RoverError {
     let _ = err.print();

src/command/dev/introspect.rs src/command/dev/legacy/introspect.rs

@@ -4,7 +4,7 @@ use anyhow::anyhow;
 use reqwest::Client;
 use rover_std::Style;
 
-use crate::command::dev::protocol::{SubgraphSdl, SubgraphUrl};
+use crate::command::dev::legacy::protocol::{SubgraphSdl, SubgraphUrl};
 use crate::command::graph::Introspect as GraphIntrospect;
 use crate::command::subgraph::Introspect as SubgraphIntrospect;
 use crate::options::IntrospectOpts;

src/command/dev/legacy/mod.rs

@@ -0,0 +1,26 @@
+#[cfg(feature = "composition-js")]
+mod compose;
+
+#[cfg(feature = "composition-js")]
+mod do_dev;
+
+#[cfg(feature = "composition-js")]
+mod introspect;
+
+#[cfg(feature = "composition-js")]
+mod protocol;
+
+#[cfg(feature = "composition-js")]
+mod router;
+
+#[cfg(feature = "composition-js")]
+mod schema;
+
+#[cfg(feature = "composition-js")]
+mod netstat;
+
+#[cfg(not(feature = "composition-js"))]
+mod no_dev;
+
+#[cfg(feature = "composition-js")]
+mod watcher;

src/command/dev/netstat.rs src/command/dev/legacy/netstat.rs

@@ -5,7 +5,7 @@ use std::{
 };
 use url::Host;
 
-use crate::command::dev::protocol::SubgraphUrl;
+use crate::command::dev::legacy::protocol::SubgraphUrl;
 
 pub fn normalize_loopback_urls(url: &SubgraphUrl) -> Vec<SubgraphUrl> {
     let hosts = match url.host() {

src/command/dev/no_dev.rs src/command/dev/legacy/no_dev.rs

@@ -1,8 +1,10 @@
-use super::Dev;
-use crate::{utils::client::StudioClientConfig, RoverError, RoverOutput, RoverResult};
 use anyhow::anyhow;
 use camino::Utf8PathBuf;
 
+use crate::{
+    command::dev::Dev, utils::client::StudioClientConfig, RoverError, RoverOutput, RoverResult,
+};
+
 impl Dev {
     pub async fn run(
         &self,

src/command/dev/protocol/follower/message.rs src/command/dev/legacy/protocol/follower/message.rs

@@ -3,7 +3,7 @@ use apollo_federation_types::javascript::SubgraphDefinition;
 use serde::{Deserialize, Serialize};
 use std::fmt::Debug;
 
-use crate::command::dev::protocol::{entry_from_definition, SubgraphEntry, SubgraphName};
+use crate::command::dev::legacy::protocol::{entry_from_definition, SubgraphEntry, SubgraphName};
 use crate::{RoverError, RoverResult, PKG_VERSION};
 
 #[derive(Serialize, Deserialize, Debug, Clone)]

src/command/dev/protocol/follower/messenger.rs src/command/dev/legacy/protocol/follower/messenger.rs

@@ -5,7 +5,7 @@ use apollo_federation_types::javascript::SubgraphDefinition;
 use crossbeam_channel::{Receiver, Sender};
 use interprocess::local_socket::traits::Stream;
 
-use crate::command::dev::protocol::{
+use crate::command::dev::legacy::protocol::{
     create_socket_name, socket_read, socket_write, FollowerMessage, LeaderMessageKind,
     SubgraphKeys, SubgraphName,
 };

src/command/dev/protocol/follower/mod.rs src/command/dev/legacy/protocol/follower/mod.rs

@@ -21,9 +21,11 @@ use tracing::{info, warn};
 
 use crate::{
     command::dev::{
-        compose::ComposeRunner,
-        do_dev::log_err_and_continue,
-        router::{RouterConfigHandler, RouterRunner},
+        legacy::{
+            compose::ComposeRunner,
+            do_dev::log_err_and_continue,
+            router::{RouterConfigHandler, RouterRunner},
+        },
         OVERRIDE_DEV_COMPOSITION_VERSION,
     },
     options::PluginOpts,

src/command/dev/protocol/leader.rs src/command/dev/legacy/protocol/leader.rs

@@ -11,7 +11,7 @@ use rover_std::warnln;
 
 use crate::options::ProfileOpt;
 use crate::utils::client::StudioClientConfig;
-use crate::{command::dev::do_dev::log_err_and_continue, RoverError, RoverResult};
+use crate::{command::dev::legacy::do_dev::log_err_and_continue, RoverError, RoverResult};
 
 #[derive(Debug)]
 pub struct BackgroundTask {

src/command/dev/protocol/mod.rs src/command/dev/legacy/protocol/mod.rs

@@ -13,7 +13,7 @@ use rover_std::{warnln, Fs};
 
 use crate::utils::expansion::expand;
 use crate::{
-    command::dev::{do_dev::log_err_and_continue, SupergraphOpts},
+    command::dev::{legacy::do_dev::log_err_and_continue, SupergraphOpts},
     RoverError, RoverResult,
 };
 
@@ -295,7 +295,7 @@ mod tests {
 
     use rstest::rstest;
 
-    use crate::command::dev::router::RouterConfigHandler;
+    use crate::command::dev::legacy::router::RouterConfigHandler;
 
     #[rstest]
     #[cfg_attr(windows, case("\\\\.\\pipe\\supergraph-127.0.0.1:4000.sock"))]

src/command/dev/protocol/socket.rs src/command/dev/legacy/protocol/socket.rs

@@ -11,8 +11,10 @@ use std::net::SocketAddr;
 use std::time::{Duration, Instant};
 
 use crate::command::dev::{
-    do_dev::log_err_and_continue,
-    router::{BackgroundTask, BackgroundTaskLog},
+    legacy::{
+        do_dev::log_err_and_continue,
+        router::{BackgroundTask, BackgroundTaskLog},
+    },
     OVERRIDE_DEV_ROUTER_VERSION,
 };
 use crate::command::install::Plugin;

src/command/dev/protocol/types.rs src/command/dev/legacy/protocol/types.rs

@@ -9,8 +9,11 @@ use rover_client::blocking::StudioClient;
 use crate::options::ProfileOpt;
 use crate::{
     command::dev::{
-        netstat::normalize_loopback_urls, protocol::FollowerMessenger,
-        watcher::SubgraphSchemaWatcher, SupergraphOpts,
+        legacy::{
+            netstat::normalize_loopback_urls, protocol::FollowerMessenger,
+            watcher::SubgraphSchemaWatcher,
+        },
+        SupergraphOpts,
     },
     options::OptionalSubgraphOpts,
     utils::client::StudioClientConfig,

src/command/dev/router/command.rs src/command/dev/legacy/router/command.rs

@@ -16,7 +16,7 @@ use rover_client::shared::GraphRef;
 use rover_std::{errln, Fs};
 
 use crate::{
-    command::dev::{
+    command::dev::legacy::{
         introspect::{IntrospectRunnerKind, UnknownIntrospectRunner},
         protocol::{FollowerMessenger, SubgraphKey},
     },

src/command/dev/router/config.rs src/command/dev/legacy/router/config.rs

@@ -4,39 +4,18 @@ use apollo_federation_types::config::FederationVersion;
 use camino::Utf8PathBuf;
 use clap::Parser;
 use derive_getters::Getters;
-use serde::Serialize;
-
 use rover_client::shared::GraphRef;
+use serde::Serialize;
 
-use crate::options::{OptionalSubgraphOpts, PluginOpts};
-use crate::utils::parsers::FileDescriptorType;
-
-#[cfg(feature = "composition-js")]
-mod compose;
-
-#[cfg(feature = "composition-js")]
-mod do_dev;
-
-#[cfg(feature = "composition-js")]
-mod introspect;
-
-#[cfg(feature = "composition-js")]
-mod protocol;
-
-#[cfg(feature = "composition-js")]
-mod router;
-
-#[cfg(feature = "composition-js")]
-mod schema;
-
-#[cfg(feature = "composition-js")]
-mod netstat;
-
-#[cfg(not(feature = "composition-js"))]
-mod no_dev;
+use crate::{
+    options::{OptionalSubgraphOpts, PluginOpts},
+    utils::parsers::FileDescriptorType,
+};
 
-#[cfg(feature = "composition-js")]
-mod watcher;
+#[cfg(not(feature = "dev-next"))]
+pub mod legacy;
+#[cfg(feature = "dev-next")]
+pub mod next;
 
 #[derive(Debug, Serialize, Parser)]
 pub struct Dev {

src/command/dev/router/mod.rs src/command/dev/legacy/router/mod.rs

@@ -0,0 +1,13 @@
+use camino::Utf8PathBuf;
+
+use crate::{command::Dev, utils::client::StudioClientConfig, RoverOutput, RoverResult};
+
+impl Dev {
+    pub async fn run(
+        &self,
+        _override_install_path: Option<Utf8PathBuf>,
+        _client_config: StudioClientConfig,
+    ) -> RoverResult<RoverOutput> {
+        todo!()
+    }
+}

src/command/dev/router/runner.rs src/command/dev/legacy/router/runner.rs

@@ -6,6 +6,7 @@ mod lint;
 mod publish;
 
 use clap::Parser;
+#[cfg(not(feature = "dev-next"))]
 pub use introspect::Introspect;
 use serde::Serialize;
 

src/command/dev/schema.rs src/command/dev/legacy/schema.rs

@@ -6,6 +6,7 @@ mod lint;
 mod list;
 mod publish;
 
+#[cfg(not(feature = "dev-next"))]
 pub use introspect::Introspect;
 
 use clap::Parser;

src/command/dev/watcher.rs src/command/dev/legacy/watcher.rs

@@ -6,8 +6,10 @@ use std::{
 };
 
 use anyhow::{anyhow, Context};
+#[cfg(not(feature = "dev-next"))]
+use apollo_federation_types::config::FederationVersion::LatestFedTwo;
 use apollo_federation_types::{
-    config::{FederationVersion, FederationVersion::LatestFedTwo, PluginVersion, SupergraphConfig},
+    config::{FederationVersion, PluginVersion, SupergraphConfig},
     rover::BuildResult,
 };
 use camino::Utf8PathBuf;
@@ -69,6 +71,7 @@ pub struct SupergraphComposeOpts {
 }
 
 impl Compose {
+    #[cfg(not(feature = "dev-next"))]
     pub fn new(compose_opts: PluginOpts) -> Self {
         Self {
             opts: SupergraphComposeOpts {

src/command/dev/mod.rs

@@ -4,7 +4,7 @@ use crate::options::LicenseAccepter;
 use clap::Parser;
 use serde::Serialize;
 
-#[cfg(feature = "composition-js")]
+#[cfg(all(feature = "composition-js", not(feature = "dev-next")))]
 use crate::{utils::client::StudioClientConfig, RoverResult};
 
 #[derive(Debug, Clone, Serialize, Parser)]
@@ -22,7 +22,7 @@ pub struct PluginOpts {
     pub skip_update: bool,
 }
 
-#[cfg(feature = "composition-js")]
+#[cfg(all(feature = "composition-js", not(feature = "dev-next")))]
 impl PluginOpts {
     pub fn prompt_for_license_accept(&self, client_config: &StudioClientConfig) -> RoverResult<()> {
         self.elv2_license_accepter

src/command/dev/next/mod.rs

@@ -1,21 +1,22 @@
+#[cfg(not(feature = "dev-next"))]
 use std::io::{self, IsTerminal};
 
-#[cfg(feature = "composition-js")]
+#[cfg(all(feature = "composition-js", not(feature = "dev-next")))]
 use anyhow::{Context, Result};
 use camino::Utf8PathBuf;
 use clap::{self, Parser};
-#[cfg(feature = "composition-js")]
+#[cfg(all(feature = "composition-js", not(feature = "dev-next")))]
 use clap::{error::ErrorKind as ClapErrorKind, CommandFactory};
-#[cfg(feature = "composition-js")]
+#[cfg(all(feature = "composition-js", not(feature = "dev-next")))]
 use dialoguer::Input;
-#[cfg(feature = "composition-js")]
+#[cfg(all(feature = "composition-js", not(feature = "dev-next")))]
 use reqwest::Url;
 use serde::{Deserialize, Serialize};
 
-#[cfg(feature = "composition-js")]
+#[cfg(all(feature = "composition-js", not(feature = "dev-next")))]
 use rover_std::{Fs, Style};
 
-#[cfg(feature = "composition-js")]
+#[cfg(all(feature = "composition-js", not(feature = "dev-next")))]
 use crate::cli::Rover;
 
 #[derive(Debug, Clone, Serialize, Deserialize, Parser)]
@@ -69,7 +70,7 @@ pub struct OptionalSubgraphOpts {
     pub subgraph_retries: u64,
 }
 
-#[cfg(feature = "composition-js")]
+#[cfg(all(feature = "composition-js", not(feature = "dev-next")))]
 impl OptionalSubgraphOpts {
     pub fn prompt_for_name(&self) -> Result<String> {
         if let Some(name) = &self.subgraph_name {