address comments

Author: DanielZhangQD

docs/source/reference/async.rst

@@ -174,15 +174,15 @@ To view all requests on the server, run ``sky api status``.
 .. code-block:: console
 
     $ # List ongoing requests, default to show 50 requests
-    $ # add `--limit 0` to show all ongoing requests
+    $ # add `-l none` or `-l all` to show all ongoing requests
     $ sky api status
     ID                                    User             Name    Created         Status
     0d35ffa7-2813-4f3b-95c2-c5ab2238df50  user2            logs    a few secs ago  RUNNING
     a9d59602-b82b-4cf8-a10f-5cde4dd76f29  user1            launch  a few secs ago  RUNNING
     skypilot-status-refresh-daemon        skypilot-system  status  5 hrs ago       RUNNING
 
     $ # List finished and ongoing requests, default to show 50 requests
-    $ # add `--limit 0` to show all finished and ongoing requests
+    $ # add `-l none` or `-l all` to show all finished and ongoing requests
     $ sky api status -a
 
 .. hint::

sky/client/cli/command.py

@@ -6162,6 +6162,25 @@ def api_cancel(request_ids: Optional[List[str]], all: bool, all_users: bool):
                     fg='green')
 
 
+class IntOrNone(click.ParamType):
+    """Int or None"""
+    name = 'int-or-none'
+
+    def convert(self, value, param, ctx):
+        if isinstance(value, int):
+            return value
+        if isinstance(value, str) and value.lower() in ('none', 'all'):
+            return None
+        try:
+            return int(value)
+        except ValueError:
+            self.fail(f'{value!r} is not a valid integer or "none" or "all"',
+                      param, ctx)
+
+
+INT_OR_NONE = IntOrNone()
+
+
 @api.command('status', cls=_DocumentedCodeCommand)
 @flags.config_option(expose_value=False)
 @click.argument('request_ids',
@@ -6179,15 +6198,15 @@ def api_cancel(request_ids: Optional[List[str]], all: bool, all_users: bool):
     '--limit',
     '-l',
     default=_NUM_REQUESTS_TO_SHOW,
-    type=int,
+    type=INT_OR_NONE,
     required=False,
     help=(f'Number of requests to show, default is {_NUM_REQUESTS_TO_SHOW},'
-          f' set to 0 to show all requests.'))
+          f' set to "none" or "all" to show all requests.'))
 @flags.verbose_option('Show more details.')
 @usage_lib.entrypoint
 # pylint: disable=redefined-builtin
 def api_status(request_ids: Optional[List[str]], all_status: bool,
-               verbose: bool, limit: int):
+               verbose: bool, limit: Optional[int]):
     """List requests on SkyPilot API server."""
     if not request_ids:
         request_ids = None
@@ -6220,8 +6239,12 @@ def api_status(request_ids: Optional[List[str]], all_status: bool,
         if verbose:
             dummy_row.append('-')
         table.add_row(dummy_row)
-        click.echo()
     click.echo(table)
+    if limit and len(request_list) >= limit:
+        click.echo()
+        click.echo(
+            f'Showing {limit} requests. Use "-l none" or "-l all" to show'
+            f' all requests.')
 
 
 @api.command('login', cls=_DocumentedCodeCommand)

sky/client/sdk.py

@@ -2159,7 +2159,7 @@ def api_status(
     request_ids: Optional[List[Union[server_common.RequestId[T], str]]] = None,
     # pylint: disable=redefined-builtin
     all_status: bool = False,
-    request_limit: int = 0,
+    limit: Optional[int] = None,
     fields: Optional[List[str]] = None,
 ) -> List[payloads.RequestPayload]:
     """Lists all requests.
@@ -2169,7 +2169,7 @@ def api_status(
             If None, all requests are queried.
         all_status: Whether to list all finished requests as well. This argument
             is ignored if request_ids is not None.
-        request_limit: The number of requests to show. If 0, show all requests.
+        limit: The number of requests to show. If None, show all requests.
         fields: The fields to get. If None, get all fields.
 
     Returns:
@@ -2182,7 +2182,7 @@ def api_status(
     body = payloads.RequestStatusBody(
         request_ids=request_ids,
         all_status=all_status,
-        request_limit=request_limit,
+        limit=limit,
         fields=fields,
     )
     response = server_common.make_authenticated_request(

sky/server/constants.py

@@ -64,3 +64,7 @@
 
 # Cookie header for stream request id.
 STREAM_REQUEST_HEADER = 'X-SkyPilot-Stream-Request-ID'
+
+# Valid empty values for pickled fields (base64-encoded pickled None)
+# base64.b64encode(pickle.dumps(None)).decode('utf-8')
+EMPTY_PICKLED_VALUE = 'gAROLg=='

sky/server/requests/payloads.py

@@ -573,7 +573,7 @@ class RequestStatusBody(pydantic.BaseModel):
     """The request body for the API request status endpoint."""
     request_ids: Optional[List[str]] = None
     all_status: bool = False
-    request_limit: int = 0
+    limit: Optional[int] = None
     fields: Optional[List[str]] = None
 
 

sky/server/requests/requests.py

@@ -349,19 +349,15 @@ def _update_request_row_fields(
     # Convert tuple to dictionary for easier manipulation
     content = dict(zip(fields, row))
 
-    # Valid empty values for pickled fields (base64-encoded pickled None)
-    # base64.b64encode(pickle.dumps(None)).decode('utf-8')
-    empty_pickled_value = 'gAROLg=='
-
     # Required fields in RequestPayload
     if 'request_id' not in fields:
         content['request_id'] = ''
     if 'name' not in fields:
         content['name'] = ''
     if 'entrypoint' not in fields:
-        content['entrypoint'] = empty_pickled_value
+        content['entrypoint'] = server_constants.EMPTY_PICKLED_VALUE
     if 'request_body' not in fields:
-        content['request_body'] = empty_pickled_value
+        content['request_body'] = server_constants.EMPTY_PICKLED_VALUE
     if 'status' not in fields:
         content['status'] = RequestStatus.PENDING.value
     if 'created_at' not in fields:
@@ -732,7 +728,7 @@ class RequestTaskFilter:
             Mutually exclusive with exclude_request_names.
         finished_before: if provided, only include requests finished before this
             timestamp.
-        request_limit: the number of requests to show. If 0, show all requests.
+        limit: the number of requests to show. If None, show all requests.
 
     Raises:
         ValueError: If both exclude_request_names and include_request_names are
@@ -744,7 +740,7 @@ class RequestTaskFilter:
     exclude_request_names: Optional[List[str]] = None
     include_request_names: Optional[List[str]] = None
     finished_before: Optional[float] = None
-    request_limit: int = 0
+    limit: Optional[int] = None
     fields: Optional[List[str]] = None
 
     def __post_init__(self):
@@ -792,8 +788,8 @@ def build_query(self) -> Tuple[str, List[Any]]:
             columns_str = ', '.join(self.fields)
         query_str = (f'SELECT {columns_str} FROM {REQUEST_TABLE}{filter_str} '
                      'ORDER BY created_at DESC')
-        if self.request_limit > 0:
-            query_str += f' LIMIT {self.request_limit}'
+        if self.limit is not None:
+            query_str += f' LIMIT {self.limit}'
         return query_str, filter_params
 
 

sky/server/server.py

@@ -1625,8 +1625,8 @@ async def api_status(
         None, description='Request IDs to get status for.'),
     all_status: bool = fastapi.Query(
         False, description='Get finished requests as well.'),
-    request_limit: int = fastapi.Query(
-        0, description='Number of requests to show. If 0, show all requests.'),
+    limit: Optional[int] = fastapi.Query(
+        None, description='Number of requests to show.'),
     fields: Optional[List[str]] = fastapi.Query(
         None, description='Fields to get. If None, get all fields.'),
 ) -> List[payloads.RequestPayload]:
@@ -1641,7 +1641,7 @@ async def api_status(
         request_tasks = await requests_lib.get_request_tasks_with_fields_async(
             req_filter=requests_lib.RequestTaskFilter(
                 status=statuses,
-                request_limit=request_limit,
+                limit=limit,
                 fields=fields,
             ),
             fields=fields,

tests/load_tests/workloads/basic.sh

@@ -28,12 +28,11 @@ sky stop $CLUSTER -y
 sky status -u --refresh
 sky start $CLUSTER -y
 sky down $CLUSTER -y
-sky api status
+sky api status -l none
 sky jobs launch -y -n $JOB --infra $CLOUD 'for i in {1..60}; do echo "$i" && sleep 0.1; done' --workdir ${workdir}
 sky jobs queue
 sky jobs logs -n $JOB || true
 sky jobs logs -n $JOB --controller
 sky volumes ls
 sky show-gpus
 sky cost-report --days 7
-

tests/smoke_tests/backward_compat/test_backward_compat.py

@@ -578,7 +578,7 @@ def test_client_server_compatibility_old_server(self, generic_cloud: str):
             f'{self.ACTIVATE_BASE} && {smoke_tests_utils.SKY_API_RESTART} && '
             f'sky jobs launch -d --infra {generic_cloud} -y {smoke_tests_utils.LOW_RESOURCE_ARG} -n {job_name} "echo hello world; sleep 60"',
             # No restart on switch to current, cli in current, server in base, verify cli works with different version of sky server
-            f'{self.ACTIVATE_CURRENT} && sky api status',
+            f'{self.ACTIVATE_CURRENT} && sky api status -l none',
             f'{self.ACTIVATE_CURRENT} && sky api info',
             f'{self.ACTIVATE_CURRENT} && {self._wait_for_managed_job_status(job_name, [sky.ManagedJobStatus.RUNNING])}',
             f'{self.ACTIVATE_CURRENT} && result="$(sky jobs queue)"; echo "$result"; echo "$result" | grep {job_name} | grep RUNNING',

tests/smoke_tests/test_api_server.py

@@ -253,13 +253,13 @@ def test_requests_scheduling(generic_cloud: str):
                     f'sky launch -y -c {name} --cloud {generic_cloud} {smoke_tests_utils.LOW_RESOURCE_ARG} -n dispatch tests/test_yamls/minimal.yaml',
                     f'for i in {{1..10}}; do sky exec {name} -n job-${{i}} "sleep 60" --async; done',
                     # Wait for all reqeusts get scheduled and executed, do not check the status here to make this case focus.
-                    (f's=$(sky api status -a | grep {username});'
+                    (f's=$(sky api status -a -l none | grep {username});'
                      'timeout=60; start=$SECONDS; '
                      'until ! echo "$s" | grep "" | grep "PENDING|RUNNING"; do '
                      '  if [ $((SECONDS - start)) -gt $timeout ]; then '
                      '    echo "Timeout waiting for jobs to be scheduled"; exit 1; '
                      '  fi; '
-                     f'  sleep 5; s=$(sky api status -a | grep {username});'
+                     f'  sleep 5; s=$(sky api status -a -l none | grep {username});'
                      '  echo "Waiting for request get scheduled"; echo "$s"; '
                      'done'),
                 ],