add apps subcommand that allows to list and delete apps #67

karthik2804 · 2023-08-18T20:17:03Z

This PR adds a new top-level command apps that further has list and delete subcommands.

fixes #9
fixes #40

src/commands/apps.rs

src/commands/mod.rs

src/commands/apps.rs

itowlson · 2023-08-20T21:45:10Z

src/commands/apps.rs

+                let mut app_list_page = client.list_apps(DEFAULT_APPLIST_PAGE_SIZE, None).await?;
+                match (app_list_page.is_last_page, cmd.all) {
+                    (true, _) | (false, true) => println!("Apps ({})", app_list_page.total_items),
+                    (false, false) => println!("Note: Displaying the first {} of {} Apps. To list all the apps run \"spin cloud apps list -all\"", DEFAULT_APPLIST_PAGE_SIZE, app_list_page.total_items),


"all" should be the default (if not the only option). Showing one page is effectively giving the user a random subset, which doesn't seem terribly useful, or am I missing something? I guess maybe if all they care about is the count...?

I like making it the default option - I will add an option called count that returns the total number of apps.

src/commands/apps.rs

src/commands/deploy.rs

itowlson · 2023-08-20T21:53:08Z

src/commands/deploy.rs

@@ -404,7 +404,7 @@ impl DeployCommand {
        cloud_client: &CloudClient,
        name: String,
    ) -> Result<Option<Uuid>> {
-        let apps_vm = CloudClient::list_apps(cloud_client).await?;
+        let apps_vm = CloudClient::list_apps(cloud_client, 50, None).await?;


Maybe out of scope but it feels like this should page too - what is the app is not in the first page?

itowlson · 2023-08-20T21:54:53Z

src/commands/login.rs

@@ -230,7 +231,7 @@ impl LoginCommand {
            insecure: self.insecure,
            token: token.clone(),
        })
-        .list_apps()
+        .list_apps(DEFAULT_APPLIST_PAGE_SIZE, None)


Maybe out of scope, but I believe the page size here could be 1 (since this is just to verify that the creds work, not to actually list any apps).

itowlson · 2023-08-20T21:55:45Z

src/commands/mod.rs

@@ -19,10 +20,21 @@ pub(crate) async fn create_cloud_client(deployment_env_id: Option<&str>) -> Resu
 }

 pub(crate) async fn get_app_id_cloud(cloud_client: &CloudClient, name: &str) -> Result<Uuid> {
-    let apps_vm = CloudClient::list_apps(cloud_client).await?;
+    let apps_vm = CloudClient::list_apps(cloud_client, DEFAULT_APPLIST_PAGE_SIZE, None).await?;


Again, this needs to page (but may be out of scope for this PR)

itowlson · 2023-08-20T21:59:10Z

crates/cloud/src/client.rs

-        api_apps_get(&self.configuration, None, None, None, None, None, None)
-            .await
-            .map_err(format_response_error)
+    pub async fn list_apps(&self, page_size: i32, page_index: Option<i32>) -> Result<AppItemPage> {


page_size and page_index should really be unsigned at the Rust level even if .NET advertises it as signed. (But I get this runs into issues about "what if somebody asks for 2^31 + 1 items how do you convert that Ivan".)

src/commands/apps.rs

itowlson

The only blocker is the incorrect syntax for the count flag, but I think we should also make sure we have consensus on the UI e.g. whether we want to have the count flag, whether we want to have a header row, and whether we want to print anything when there are no entities. This is important because of likely broader implications e.g. we'd probably want the sqlite list command to have the same behaviour.

src/commands/apps.rs

kate-goldenring · 2023-08-22T17:56:11Z

src/commands/apps.rs

+            AppsCommand::List(cmd) => {
+                let client = create_cloud_client(cmd.common.deployment_env_id.as_deref()).await?;
+                let mut app_list_page = client.list_apps(DEFAULT_APPLIST_PAGE_SIZE, None).await?;
+                match app_list_page.total_items > 0 {


Curious, why did you choose to do a match statement here instead of an if statement?

Past reviews have trained me to prefer match over if but I do not know if it is not appropriate here.

i would usually only match on a bool if it was evaluating to a result that the match was capturing. I'm curious if there is a best practice here. @itowlson any thoughts?

For a predicate like this I'd probably choose if because it avoids the clutter of the true => / false => prefixes (but my opinion is not strong, and I am a really poor bellwether for what the Rust Gods consider best practice).

kate-goldenring

I think this is looking ready to switch from Draft to Ready for Review. To your comment @itowlson, I am aligned with no headers and instead output on empty as is done here.

src/commands/apps.rs

itowlson

LGTM, one non-blocking suggestion (plus the comment about if vs match which is also non-blocking)

itowlson · 2023-08-22T20:29:13Z

src/commands/apps.rs

+impl AppsCommand {
+    pub async fn run(self) -> Result<()> {
+        match self {
+            AppsCommand::List(cmd) => {


Style suggestion: In many places we move each leaf command's run implementation down to that leaf command, so the intermediate level becomes (cf. https://github.com/fermyon/spin/blob/60011faf310e673f20fc7d5de20f4df8a99374e7/src/commands/plugins.rs#L43)

impl FieCommand { fn run(&self) { match self { Self::AliceCommand(cmd) => cmd.run(), Self::BobCommand(cmd) => cmd.run(), } } }

This removes a level of structure and indentation from the actual real command logic, and keeps the implementations of the subcommands fully distinct in the source code.

It's not a must-do but it's a pattern I find significantly clearer.

I based it off the structure in variables and sqlite. I do not have a preference here. I am happy to go eitherway. Let me know!

Oh, if cloud-plugin is inlining everything then I guess be consistent.

karthik2804 · 2023-08-22T22:16:17Z

@kate-goldenring @itowlson any strong opinions on match vs if? I am happy to go either way. I can update and then merge.

itowlson · 2023-08-22T22:39:18Z

@karthik2804 I am Team If in this case

Signed-off-by: karthik2804 <karthik.ganeshram@fermyon.com>

karthik2804 · 2023-08-23T03:59:11Z

@itowlson Well I will take the side with Team if this time around then!

itowlson · 2023-08-23T04:01:42Z

karthik2804 requested review from itowlson and kate-goldenring August 18, 2023 20:17

karthik2804 commented Aug 18, 2023

View reviewed changes

src/commands/apps.rs Outdated Show resolved Hide resolved

kate-goldenring reviewed Aug 18, 2023

View reviewed changes

src/commands/apps.rs Outdated Show resolved Hide resolved

src/commands/apps.rs Outdated Show resolved Hide resolved

src/commands/mod.rs Show resolved Hide resolved

karthik2804 force-pushed the subcommand/apps branch 2 times, most recently from 4ea8eb7 to abb0530 Compare August 18, 2023 21:48

itowlson reviewed Aug 20, 2023

View reviewed changes

karthik2804 force-pushed the subcommand/apps branch 2 times, most recently from a0ba904 to 737242a Compare August 21, 2023 15:59

itowlson requested changes Aug 22, 2023

View reviewed changes

src/commands/apps.rs Outdated Show resolved Hide resolved

src/commands/apps.rs Outdated Show resolved Hide resolved

src/commands/apps.rs Show resolved Hide resolved

karthik2804 force-pushed the subcommand/apps branch from 737242a to f2a72e2 Compare August 22, 2023 05:09

kate-goldenring reviewed Aug 22, 2023

View reviewed changes

src/commands/apps.rs Outdated Show resolved Hide resolved

src/commands/apps.rs Outdated Show resolved Hide resolved

karthik2804 force-pushed the subcommand/apps branch from f2a72e2 to b546bd6 Compare August 22, 2023 18:06

karthik2804 marked this pull request as ready for review August 22, 2023 18:07

itowlson approved these changes Aug 22, 2023

View reviewed changes

add apps subcommand that allows to list and delete apps

fda851b

Signed-off-by: karthik2804 <karthik.ganeshram@fermyon.com>

karthik2804 force-pushed the subcommand/apps branch from b546bd6 to fda851b Compare August 23, 2023 03:58

karthik2804 merged commit 50535f7 into fermyon:main Aug 23, 2023
8 checks passed

karthik2804 deleted the subcommand/apps branch August 23, 2023 04:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add apps subcommand that allows to list and delete apps #67

add apps subcommand that allows to list and delete apps #67

karthik2804 commented Aug 18, 2023

itowlson Aug 20, 2023

karthik2804 Aug 21, 2023

itowlson Aug 20, 2023

itowlson Aug 20, 2023

itowlson Aug 20, 2023

itowlson Aug 20, 2023

itowlson left a comment

kate-goldenring Aug 22, 2023

karthik2804 Aug 22, 2023

kate-goldenring Aug 22, 2023

itowlson Aug 22, 2023

kate-goldenring left a comment

itowlson left a comment

itowlson Aug 22, 2023

karthik2804 Aug 22, 2023

itowlson Aug 22, 2023

karthik2804 commented Aug 22, 2023

itowlson commented Aug 22, 2023

karthik2804 commented Aug 23, 2023

itowlson commented Aug 23, 2023

add apps subcommand that allows to list and delete apps #67

add apps subcommand that allows to list and delete apps #67

Conversation

karthik2804 commented Aug 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itowlson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kate-goldenring left a comment

Choose a reason for hiding this comment

itowlson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

karthik2804 commented Aug 22, 2023

itowlson commented Aug 22, 2023

karthik2804 commented Aug 23, 2023

itowlson commented Aug 23, 2023