feat(cli): opt into cli-engine pagination for domain/dns list and api search [DEVEX-972]

rust/Cargo.toml

@@ -46,7 +46,7 @@ zip = { version = "8.6.0", default-features = false, features = ["deflate-flate2
 iso_currency = "0.5.3"
 
 [dev-dependencies]
-httpmock = "0.7"
+httpmock = "0.8"
 tempfile = "3"
 
 [lints.rust]

rust/domains-client/Cargo.toml

@@ -30,5 +30,5 @@ prettyplease = "0.2"
 syn = "2"
 
 [dev-dependencies]
-httpmock = "0.7"
+httpmock = "0.8"
 tokio = { version = "1", features = ["macros", "rt-multi-thread", "sync"] }

rust/src/api_explorer/mod.rs

@@ -1555,7 +1555,11 @@ fn search_command() -> RuntimeCommandSpec {
             .with_tier(Tier::Read)
             .no_auth(true)
             .with_default_fields("domain,method,path,summary")
-            .with_output_schema::<ApiEndpoint>(),
+            .with_output_schema::<ApiEndpoint>()
+            .with_pagination(PaginationConfig {
+                max_limit: 100,
+                ..Default::default()
+            }),
         |_cred, args: SearchArgs| async move {
             let hits = search_endpoints(catalog(), &args.query);
             if hits.is_empty() {
@@ -2174,14 +2178,25 @@ fn schema_get_command() -> RuntimeCommandSpec {
 
 #[cfg(test)]
 mod tests {
-    use cli_engine::{Cli, CliConfig};
+    use cli_engine::{Cli, CliConfig, PaginationConfig};
 
-    use super::{catalog, find_endpoint, merge_required_scopes};
+    use super::{catalog, find_endpoint, merge_required_scopes, search_command};
 
     fn v(items: &[&str]) -> Vec<String> {
         items.iter().map(|s| (*s).to_owned()).collect()
     }
 
+    #[test]
+    fn search_command_opts_into_pagination_with_no_default_and_a_max_limit() {
+        assert_eq!(
+            search_command().spec.pagination,
+            Some(PaginationConfig {
+                max_limit: 100,
+                ..Default::default()
+            })
+        );
+    }
+
     #[test]
     fn merge_flags_only_when_no_endpoint_scopes() {
         assert_eq!(merge_required_scopes(v(&["a", "b"]), &[]), v(&["a", "b"]));

rust/src/application/client.rs

@@ -418,16 +418,11 @@ mod tests {
                 when.method(POST)
                     .path("/v1/apps/app-registry-subgraph")
                     .header("authorization", "Bearer test-token")
-                    .matches(|req| {
-                        req.body
-                            .as_ref()
-                            .map(|b| {
-                                let body = String::from_utf8_lossy(b);
-                                body.contains("activateRelease")
-                                    && body.contains("app-123")
-                                    && body.contains("rel-456")
-                            })
-                            .unwrap_or(false)
+                    .is_true(|req| {
+                        let body = req.body_string();
+                        body.contains("activateRelease")
+                            && body.contains("app-123")
+                            && body.contains("rel-456")
                     });
                 then.status(200).json_body(json!({
                     "data": { "activateRelease": { "id": "rel-456", "status": "ACTIVE" } }
@@ -476,15 +471,9 @@ mod tests {
             .mock_async(|when, then| {
                 when.method(POST)
                     .path("/v1/apps/app-registry-subgraph")
-                    .matches(|req| {
-                        req.body
-                            .as_ref()
-                            .map(|b| {
-                                let body = String::from_utf8_lossy(b);
-                                body.contains("updateApplication")
-                                    && body.contains(r#""status":"ACTIVE""#)
-                            })
-                            .unwrap_or(false)
+                    .is_true(|req| {
+                        let body = req.body_string();
+                        body.contains("updateApplication") && body.contains(r#""status":"ACTIVE""#)
                     });
                 then.status(200).json_body(json!({
                     "data": { "updateApplication": { "id": "app-1", "status": "ACTIVE" } }
@@ -533,7 +522,7 @@ mod tests {
             matches!(err, ClientError::TooLarge { .. }),
             "unexpected: {err}"
         );
-        assert_eq!(mock.hits_async().await, 0);
+        assert_eq!(mock.calls_async().await, 0);
     }
 
     #[tokio::test]
@@ -565,7 +554,7 @@ mod tests {
             matches!(err, ClientError::Http { status: 403, .. }),
             "unexpected: {err}"
         );
-        assert_eq!(mock.hits_async().await, 1);
+        assert_eq!(mock.calls_async().await, 1);
     }
 
     #[tokio::test]
@@ -597,7 +586,7 @@ mod tests {
             matches!(err, ClientError::Http { status: 503, .. }),
             "unexpected: {err}"
         );
-        assert_eq!(mock.hits_async().await, 3);
+        assert_eq!(mock.calls_async().await, 3);
     }
 
     #[tokio::test]
@@ -609,10 +598,9 @@ mod tests {
                     .path("/upload")
                     .header("x-amz-signature", "sig")
                     // assert x-amz-meta-upload-id was stripped
-                    .matches(|req| {
-                        !req.headers
+                    .is_true(|req| {
+                        !req.headers_vec()
                             .iter()
-                            .flatten()
                             .any(|(k, _)| k.eq_ignore_ascii_case("x-amz-meta-upload-id"))
                     });
                 then.status(200).header("etag", "\"abc123\"");
@@ -673,7 +661,7 @@ mod tests {
             matches!(err, ClientError::InvalidHeader(_)),
             "unexpected: {err}"
         );
-        assert_eq!(mock.hits_async().await, 0);
+        assert_eq!(mock.calls_async().await, 0);
     }
 
     #[tokio::test]
@@ -710,6 +698,6 @@ mod tests {
                 .expect("upload shared payload");
         }
 
-        mock.assert_hits_async(2).await;
+        mock.assert_calls_async(2).await;
     }
 }

rust/src/application/commands/mod.rs

@@ -1,6 +1,6 @@
 use cli_engine::{
-    CommandResult, CommandSpec, GroupSpec, NextAction, NextActionParam, RuntimeCommandSpec,
-    RuntimeGroupSpec, StreamSender, TableColumn, Tier,
+    CommandResult, CommandSpec, GroupSpec, NextAction, NextActionParam, PaginationConfig,
+    RuntimeCommandSpec, RuntimeGroupSpec, StreamSender, TableColumn, Tier,
 };
 use serde_json::{Value, json};
 
@@ -251,7 +251,11 @@ fn list_command() -> RuntimeCommandSpec {
             .with_system("applications")
             .with_tier(Tier::Read)
             .with_default_fields("name,label,status")
-            .with_output_schema::<ApplicationSummary>(),
+            .with_output_schema::<ApplicationSummary>()
+            .with_pagination(PaginationConfig {
+                max_limit: 200,
+                ..Default::default()
+            }),
         |ctx| async move {
             let client = make_client(&ctx).await?;
             let data = client.list_applications().await.map_err(client_err)?;
@@ -1846,12 +1850,12 @@ pub fn add_extension_group() -> RuntimeGroupSpec {
 
 #[cfg(test)]
 mod tests {
-    use cli_engine::{Cli, CliConfig, Stage};
+    use cli_engine::{Cli, CliConfig, PaginationConfig, Stage};
     use serde_json::json;
 
     use super::{
-        add_config_next_actions, deploy_next_actions, init_view_columns, update_command,
-        validate_command, validate_remote_application,
+        add_config_next_actions, deploy_next_actions, init_view_columns, list_command,
+        update_command, validate_command, validate_remote_application,
     };
 
     #[test]
@@ -1860,6 +1864,17 @@ mod tests {
         assert_eq!(deploy_next_actions("app").len(), 3);
     }
 
+    #[test]
+    fn list_command_opts_into_pagination_with_no_default_and_a_max_limit() {
+        assert_eq!(
+            list_command().spec.pagination,
+            Some(PaginationConfig {
+                max_limit: 200,
+                ..Default::default()
+            })
+        );
+    }
+
     #[test]
     fn add_config_next_actions_skips_empty_name_prefill() {
         let actions = add_config_next_actions("");

rust/src/dns/list.rs

@@ -1,6 +1,8 @@
 //! `dns list` — list DNS records for a domain, with optional type/name filters.
 
-use cli_engine::{CliCoreError, CommandResult, CommandSpec, RuntimeCommandSpec, Tier};
+use cli_engine::{
+    CliCoreError, CommandResult, CommandSpec, PaginationConfig, RuntimeCommandSpec, Tier,
+};
 use serde_json::{Value, json};
 
 use crate::domain::make_client;
@@ -38,7 +40,11 @@ pub(super) fn command() -> RuntimeCommandSpec {
             .with_tier(Tier::Read)
             .with_default_fields("type,name,data,ttl")
             .with_json_schema::<types::DnsRecord>()
-            .with_scopes(&[DOMAINS_READ]),
+            .with_scopes(&[DOMAINS_READ])
+            .with_pagination(PaginationConfig {
+                max_limit: 500,
+                ..Default::default()
+            }),
         |ctx, args: ListArgs| async move {
             let domain = args.domain;
             let type_opt = args.record_type;
@@ -66,3 +72,20 @@ pub(super) fn command() -> RuntimeCommandSpec {
         },
     )
 }
+
+#[cfg(test)]
+mod tests {
+    use super::command;
+    use cli_engine::PaginationConfig;
+
+    #[test]
+    fn opts_into_pagination_with_no_default_and_a_max_limit() {
+        assert_eq!(
+            command().spec.pagination,
+            Some(PaginationConfig {
+                max_limit: 500,
+                ..Default::default()
+            })
+        );
+    }
+}

rust/src/dns/set.rs

@@ -1002,12 +1002,12 @@ mod tests {
         .await;
 
         assert_eq!(
-            create.hits_async().await,
+            create.calls_async().await,
             0,
             "no create for a no-op replace"
         );
         assert_eq!(
-            delete.hits_async().await,
+            delete.calls_async().await,
             0,
             "no delete for a no-op replace"
         );
@@ -1047,7 +1047,7 @@ mod tests {
         .await;
 
         assert_eq!(
-            delete.hits_async().await,
+            delete.calls_async().await,
             0,
             "the old record must not be touched when the create fails"
         );

rust/src/domain/list.rs

@@ -1,7 +1,8 @@
 //! `gddy domain list` — list the domains in the account (v1).
 
 use cli_engine::{
-    CliCoreError, CommandResult, CommandSpec, NextActionParam, Result, RuntimeCommandSpec, Tier,
+    CliCoreError, CommandResult, CommandSpec, NextActionParam, PaginationConfig, Result,
+    RuntimeCommandSpec, Tier,
 };
 use serde_json::json;
 
@@ -48,14 +49,17 @@ pub(super) fn command() -> RuntimeCommandSpec {
                 "List the domains registered to your account. Shows domain, status, \
                  expiry, and auto-renew by default; use --fields to pick columns. Hides \
                  domains that are cancelled or otherwise not visible unless --show-hidden \
-                 is passed; use --status to filter to specific status values (repeatable, \
-                 overrides the default filter).",
+                 is passed; use --status to filter to specific status values (repeatable).",
             )
             .with_system("domain")
             .with_tier(Tier::Read)
             .with_default_fields("domain,status,expires,renewAuto")
             .with_json_schema::<types::V1DomainSummary>()
-            .with_scopes(&[DOMAINS_READ]),
+            .with_scopes(&[DOMAINS_READ])
+            .with_pagination(PaginationConfig {
+                max_limit: 500,
+                ..Default::default()
+            }),
         |ctx, args: ListArgs| async move {
             let debug = !ctx.middleware.debug.is_empty();
             let statuses = parse_statuses(&args.status)?;
@@ -89,9 +93,25 @@ pub(super) fn command() -> RuntimeCommandSpec {
 
 #[cfg(test)]
 mod tests {
-    use super::{parse_statuses, wants_visible_only};
+    use super::{command, parse_statuses, wants_visible_only};
+    use cli_engine::PaginationConfig;
     use domains_client::types;
 
+    /// Regression pin: `domain list` opts into pagination with no forced
+    /// `default_limit` (an unflagged invocation must keep returning every
+    /// domain, exactly like before this feature existed) but a `max_limit`
+    /// so `--limit` can't be pointed at an absurd value.
+    #[test]
+    fn opts_into_pagination_with_no_default_and_a_max_limit() {
+        assert_eq!(
+            command().spec.pagination,
+            Some(PaginationConfig {
+                max_limit: 500,
+                ..Default::default()
+            })
+        );
+    }
+
     #[test]
     fn parse_statuses_is_case_insensitive_and_validates() {
         use types::ListStatusesItem;

rust/src/hosting/nodejs/client.rs

@@ -415,12 +415,7 @@ mod tests {
             .mock_async(|when, then| {
                 when.method(POST)
                     .path("/v1/hosting/nodejs/apps/app-1/source")
-                    .matches(|req| {
-                        req.body
-                            .as_ref()
-                            .map(|b| String::from_utf8_lossy(b).contains("zipFile"))
-                            .unwrap_or(false)
-                    });
+                    .is_true(|req| req.body_string().contains("zipFile"));
                 then.status(200).json_body(json!({ "jobId": "upload-1" }));
             })
             .await;

rust/src/onboarding/ensure.rs

@@ -225,7 +225,7 @@ mod tests {
         );
         assert!(stderr.is_empty());
         status.assert_async().await;
-        assert_eq!(complete.hits_async().await, 0);
+        assert_eq!(complete.calls_async().await, 0);
     }
 
     #[tokio::test]
@@ -262,7 +262,7 @@ mod tests {
         .expect_err("agreements required");
 
         assert!(err.to_string().contains("agreements must be accepted"));
-        assert_eq!(complete.hits_async().await, 0);
+        assert_eq!(complete.calls_async().await, 0);
     }
 
     #[tokio::test]
@@ -376,6 +376,6 @@ mod tests {
         .expect_err("prompt I/O error must be reported");
 
         assert!(err.to_string().contains("writer unavailable"));
-        assert_eq!(complete.hits_async().await, 0);
+        assert_eq!(complete.calls_async().await, 0);
     }
 }