remotivelabs-cli 0.0.13__py3-none-any.whl → 0.0.15__py3-none-any.whl

cli/broker/lib/broker.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import binascii
-import datetime
 import ntpath
 import os
 import posixpath
@@ -183,7 +182,9 @@ class Broker:
             self.__check_playbackmode_result(status)
         return status
 
-    def listen_on_playback(self, callback: Callable[[str], None]):
+    def listen_on_playback(self, repeat: bool, recording_and_namespace: List, callback: Callable[[int, int, str], None]):
+        # include recording_and_namespace if we want to loop the recording
+        # This can probably be improved
         def get_mode(mode: int):
             if mode == 0:
                 return "playing"
@@ -195,14 +196,19 @@ class Broker:
         sub = self.traffic_stub.PlayTrafficStatus(br.common_pb2.Empty())
         for playback_state in sub:
             p = typing.cast(br.traffic_api_pb2.PlaybackInfos, playback_state)
-            offset_time = int(p.playbackInfo[0].playbackMode.offsetTime / 1000000)
+            offset_length = int(p.playbackInfo[0].playbackMode.offsetTime / 1000000)
             start_time = p.playbackInfo[0].playbackMode.startTime
             end_time = p.playbackInfo[0].playbackMode.endTime
             mode = p.playbackInfo[0].playbackMode.mode
 
-            length = int((end_time - start_time) / 1000000)
+            total_length = int((end_time - start_time) / 1000000)
 
-            callback(f"{(datetime.timedelta(seconds=offset_time))} / {(datetime.timedelta(seconds=length))} ({get_mode(mode)})")
+            if mode == 2 and repeat:
+                # If we get a stop and is fairly (this is mostly not 100%) close to the end
+                # we repeat the recording when files are included
+                if abs(total_length - offset_length) < 5:
+                    self.play(recording_and_namespace)
+            callback(offset_length, total_length, get_mode(mode))
 
     def pause(self, namespace: str, path: str, silent: bool = False):
         playback_list = [

cli/cloud/recordings.py

@@ -17,8 +17,10 @@ from cli.errors import ErrorPrinter
 
 from ..broker.lib.broker import Broker
 from . import rest_helper as rest
+from .recordings_playback import app as playback_app
 
 app = typer.Typer()
+app.add_typer(playback_app, name="playback")
 
 
 def uid(p):
@@ -365,52 +367,64 @@ def copy(
     )
 
 
-@app.command()
+@app.command(deprecated=True)
 def play(
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     broker: str = typer.Option(None, help="Broker to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
 ):
+    """
+    Plays a recording (Deprecated - Use recordings playback play)"
+    """
     _do_change_playback_mode("play", recording_session, broker, project)
 
 
-@app.command()
+@app.command(deprecated=True)
 def pause(
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     broker: str = typer.Option(None, help="Broker to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
 ):
+    """
+    Pause recording (Deprecated - Use recordings playback pause")
+    """
     _do_change_playback_mode("pause", recording_session, broker, project)
 
 
-@app.command(name="playback-status")
+@app.command(name="playback-status", deprecated=True)
 def playback_status(
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     broker: str = typer.Option(None, help="Broker to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
 ):
     """
-    Display status and progress of the recording beeing played
+    Playback progress (Deprecated - Use recordings playback progress)
     """
     _do_change_playback_mode("status", recording_session, broker, project)
 
 
-@app.command()
+@app.command(deprecated=True)
 def seek(
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     seconds: int = typer.Option(..., min=0, help="Target offset in seconds"),
     broker: str = typer.Option(None, help="Broker to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
 ):
+    """
+    Seek into recording (Deprecated - Use recordings playback seek)
+    """
     _do_change_playback_mode("seek", recording_session, broker, project, seconds)
 
 
-@app.command()
+@app.command(deprecated=True)
 def stop(
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     broker: str = typer.Option(None, help="Broker to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
 ):
+    """
+    Stop recording (Deprecated - Use recordings playback stop)
+    """
     _do_change_playback_mode("stop", recording_session, broker, project)
 
 

cli/cloud/recordings_playback.py

@@ -0,0 +1,178 @@
+from __future__ import annotations
+
+import datetime
+import json
+import tempfile
+from typing import List
+
+import grpc
+import rich
+import typer
+from rich.progress import Progress, SpinnerColumn, TextColumn
+
+from cli.errors import ErrorPrinter
+
+from ..broker.lib.broker import Broker
+from . import rest_helper as rest
+
+app = typer.Typer(
+    help="""
+Support for playback of a recording on a cloud broker, make sure to always mount a recording first
+"""
+)
+
+
+@app.command()
+def play(
+    recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
+    broker: str = typer.Option(None, help="Broker to use"),
+    project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
+    show_progress: bool = typer.Option(False, help="Show progress after started playing"),
+    repeat: bool = typer.Option(False, help="Repeat recording - must keep command running in terminal"),
+):
+    """
+    Start playing a recording.
+    There is no problem invoking play multiple times since if it is already playing the command will be ignored.
+    Use --repeat to have the recording replayed when it reaches the end.
+    """
+
+    _do_change_playback_mode("play", recording_session, broker, project, progress_on_play=show_progress, repeat=repeat)
+
+
+@app.command()
+def pause(
+    recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
+    broker: str = typer.Option(None, help="Broker to use"),
+    project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
+):
+    """
+    Pause a recording
+    """
+    _do_change_playback_mode("pause", recording_session, broker, project)
+
+
+@app.command()
+def progress(
+    recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
+    broker: str = typer.Option(None, help="Broker to use"),
+    project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
+):
+    """
+    Shows progress of the recording playing.
+    Use --repeat to have the recording replayed when it reaches the end.
+    """
+    _do_change_playback_mode("status", recording_session, broker, project)
+
+
+@app.command()
+def seek(
+    recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
+    seconds: int = typer.Option(..., min=0, help="Target offset in seconds"),
+    broker: str = typer.Option(None, help="Broker to use"),
+    project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
+):
+    """
+    Seek seconds into a recording
+    """
+    _do_change_playback_mode("seek", recording_session, broker, project, seconds)
+
+
+@app.command()
+def stop(
+    recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
+    broker: str = typer.Option(None, help="Broker to use"),
+    project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
+):
+    """
+    Stop playing
+    """
+    _do_change_playback_mode("stop", recording_session, broker, project)
+
+
+def _do_change_playback_mode(
+    mode: str,
+    recording_session: str,
+    broker: str,
+    project: str,
+    seconds: int | None = None,
+    progress_on_play: bool = False,
+    repeat: bool = False,
+):  # noqa: C901
+    response = rest.handle_get(f"/api/project/{project}/files/recording/{recording_session}", return_response=True)
+    r = json.loads(response.text)
+    recordings: list = r["recordings"]
+    files = list(map(lambda rec: {"recording": rec["fileName"], "namespace": rec["metadata"]["namespace"]}, recordings))
+
+    if broker is not None:
+        response = rest.handle_get(f"/api/project/{project}/brokers/{broker}", return_response=True, allow_status_codes=[404])
+    else:
+        response = rest.handle_get(f"/api/project/{project}/brokers/personal", return_response=True, allow_status_codes=[404])
+    if response.status_code == 404:
+        broker_arg = ""
+        if broker is not None:
+            broker_arg = f" --broker {broker} --ensure-broker-started"
+        ErrorPrinter.print_generic_error("You need to mount the recording before you play")
+        ErrorPrinter.print_hint(f"remotive cloud recordings mount {recording_session}{broker_arg} --project {project}")
+        exit(1)
+
+    broker_info = json.loads(response.text)
+    broker = Broker(broker_info["url"], None)
+
+    _verify_recording_on_broker(broker, recording_session, mode, project)
+
+    if mode == "pause":
+        broker.pause_play(files, True)
+    elif mode == "play":
+        broker.play(files, True)
+        if progress_on_play or repeat:
+            _track_progress(broker, repeat, files)
+    elif mode == "seek":
+        broker.seek(files, int(seconds * 1000000), True)
+    elif mode == "stop":
+        broker.seek(files, 0, True)
+    elif mode == "status":
+        _track_progress(broker, repeat, files)
+    else:
+        raise Exception(f"Illegal command {mode}")
+
+
+def _track_progress(broker: Broker, repeat: bool, files: List):
+    p = Progress(SpinnerColumn(), TextColumn("[progress.description]{task.description}"), transient=True)
+    t = p.add_task("label", total=1)
+    if repeat:
+        rich.print(":point_right: Keep this command running in terminal to keep the recording play with repeat")
+    with p:
+
+        def print_progress(offset: int, total: int, current_mode: str):
+            p.update(
+                t,
+                description=f"{(datetime.timedelta(seconds=offset))} " f"/ {(datetime.timedelta(seconds=total))} ({current_mode})",
+            )
+
+        broker.listen_on_playback(repeat, files, print_progress)
+
+
+def _verify_recording_on_broker(broker: Broker, recording_session: str, mode: str, project: str):
+    try:
+        # Here we try to verify that we are operating on a recording that is mounted on the
+        # broker so we can verify this before we try playback and can also present some good
+        # error messages
+        tmp = tempfile.NamedTemporaryFile()
+        broker.download(".cloud.context", tmp.name, True)
+        with open(tmp.name, "r") as f:
+            json_context = json.loads(f.read())
+            if json_context["recordingSessionId"] != recording_session:
+                ErrorPrinter.print_generic_error(
+                    f"The recording id mounted is '{json_context['recordingSessionId']}' "
+                    f"which  not the same as you are trying to {mode}, "
+                    "use cmd below to mount this recording"
+                )
+                ErrorPrinter.print_hint(f"remotive cloud recordings mount {recording_session} --project {project}")
+                exit(1)
+    except grpc.RpcError as rpc_error:
+        if rpc_error.code() == grpc.StatusCode.NOT_FOUND:
+            ErrorPrinter.print_generic_error(f"You must use mount to prepare a recording before you can use {mode}")
+            ErrorPrinter.print_hint(f"remotive cloud recordings mount {recording_session} --project {project}")
+        else:
+            ErrorPrinter.print_grpc_error(rpc_error)
+        exit(1)

{remotivelabs_cli-0.0.13.dist-info → remotivelabs_cli-0.0.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: remotivelabs-cli
-Version: 0.0.13
+Version: 0.0.15
 Summary: CLI for operating RemotiveCloud and RemotiveBroker
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com

{remotivelabs_cli-0.0.13.dist-info → remotivelabs_cli-0.0.15.dist-info}/RECORD

@@ -4,7 +4,7 @@ cli/broker/brokers.py,sha256=sSX--mm5ln5RUFR60VFHQR6NWu4Qz7Jqi2Ws-4TJsDI,3052
 cli/broker/export.py,sha256=GxwE9ufWRwfxVh3eTLkwuOqwUOtsvS9Wb7b-BooULC8,3734
 cli/broker/files.py,sha256=_8elBjbmJ5MEEeFGJ7QYkXzyuLDCDpO6UvEVXHbRy7U,4133
 cli/broker/lib/__about__.py,sha256=xnZ5V6ZcHW9dhWLWdMzVjYJbEnMKpeXm0_S_mbNzypE,141
-cli/broker/lib/broker.py,sha256=fmGsdxmdC3llrIvr0o3E2cpkGHU6mxrbZ7_ac2ZqVvU,20664
+cli/broker/lib/broker.py,sha256=b4MO38_SamR2eE-ClDZMWSVpVRfQ6HQ27ALVpmmVGXc,21071
 cli/broker/playback.py,sha256=oOfC8Jn4Ib-nc9T6ob_uNXZSeCWfft7MrMQPafH4U2I,4846
 cli/broker/record.py,sha256=gEvo3myHbIl6UyXzhJE741NiwRrFf7doBg6HXzzp5z0,1382
 cli/broker/scripting.py,sha256=sLDtuktWsVk0fJ3RW4kYyh-_YAVJP3VM0xFIQR499Oo,3392
@@ -16,7 +16,8 @@ cli/cloud/brokers.py,sha256=wa3uMg91IZdrP0tMpTdO9cBIkZHtMHxQ-zEXwFiye_I,4127
 cli/cloud/cloud_cli.py,sha256=nRRXFF_IgUMayerxS-h7oqsNe6tt34Q5VeThq8gatEg,1443
 cli/cloud/configs.py,sha256=2p1mCHf5BwYNtwbY0Cbed5t6-79WHGKWU4Fv6LuJ21o,4069
 cli/cloud/projects.py,sha256=-uqltAOficwprOKaPd2R0Itm4sqTz3VJNs9Sc8jtO5k,1369
-cli/cloud/recordings.py,sha256=F42VXWuoIVKmjkSxr4fq0M9w1GwszNE1kUbkVzxEaf4,20334
+cli/cloud/recordings.py,sha256=0xQw8iv-NjUUqxQjq5O4WqNYsew2lNlQ9Z0Qevl2f9E,20844
+cli/cloud/recordings_playback.py,sha256=ygJRBbJ_BYmrEZ7k0j2b11N3xrrgmOdL3jZckJ-f-uU,7120
 cli/cloud/rest_helper.py,sha256=g7lmGosAS0IDlo9Aso0bH0tdlLTCz0IYx3R71DXKtkc,6491
 cli/cloud/sample_recordings.py,sha256=g1X6JTxvzWInSP9R1BJsDmL4WqvpEKqjdJR_xT4bo1U,639
 cli/cloud/service_account_tokens.py,sha256=7vjoMd6Xq7orWCUP7TVUVa86JA0OiX8O10NZcHUE6rM,2294
@@ -32,8 +33,8 @@ cli/tools/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 cli/tools/can/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 cli/tools/can/can.py,sha256=kSd1c-nxxXyeKkm19oDILiDBZsKOcpjsUT0T3xox5Qs,2172
 cli/tools/tools.py,sha256=LwQdWMcJ19pCyKUsVfSB2B3R6ui61NxxFWP0Nrnd5Jk,198
-remotivelabs_cli-0.0.13.dist-info/LICENSE,sha256=qDPP_yfuv1fF-u7EfexN-cN3M8aFgGVndGhGLovLKz0,608
-remotivelabs_cli-0.0.13.dist-info/METADATA,sha256=q4vUcxbJSS14XERa8zL9nWJpHA6bVeFSWnja5b75tEo,1224
-remotivelabs_cli-0.0.13.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-remotivelabs_cli-0.0.13.dist-info/entry_points.txt,sha256=lvDhPgagLqW_KTnLPCwKSqfYlEp-1uYVosRiPjsVj10,45
-remotivelabs_cli-0.0.13.dist-info/RECORD,,
+remotivelabs_cli-0.0.15.dist-info/LICENSE,sha256=qDPP_yfuv1fF-u7EfexN-cN3M8aFgGVndGhGLovLKz0,608
+remotivelabs_cli-0.0.15.dist-info/METADATA,sha256=6WwZlFqtnnC892J5T6m_Zgs1XGz_wnyNzzihRRFDY_Q,1224
+remotivelabs_cli-0.0.15.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+remotivelabs_cli-0.0.15.dist-info/entry_points.txt,sha256=lvDhPgagLqW_KTnLPCwKSqfYlEp-1uYVosRiPjsVj10,45
+remotivelabs_cli-0.0.15.dist-info/RECORD,,