Merge pull request #6 from UMass-Rescue/rescuebox-desktop-compliant

make audio transcribe work with rescuebox desktop

Author: nb950

.gitignore

@@ -3,6 +3,8 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+.vscode/
+
 # C extensions
 *.so
 
@@ -24,6 +26,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+*.bat
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

docs

@@ -14,7 +14,12 @@ python = ">=3.11,<3.13"
 pyyaml = "^6.0.2"
 typer = "^0.12.5"
 llvmlite = "^0.44.0"
+pytest = "^8.3.4"
+httpx = "^0.28.1"
+# add dependencies common to all plugins here
 numba = "^0.61.0"
+torch = "2.2.2"
+numpy = "1.26.4"
 
 rb-lib = { path = "src/rb-lib", develop = true }
 
@@ -23,8 +28,8 @@ rb-doc-parser = { path = "src/rb-doc-parser", develop = true }
 rb-audio-transcription = { path = "src/rb-audio-transcription", develop = true }
 
 # Don't add new packages here, add them appropriately in the list above
-torch = "2.2.2"
-numpy = "1.26.4"
+
+
 
 
 [tool.poetry.group.dev.dependencies]

poetry.lock

@@ -1,29 +1,72 @@
 import multiprocessing
 import os
-
+from starlette.middleware.base import BaseHTTPMiddleware
+import logging
+from logging.config import dictConfig
 from fastapi import FastAPI
 from fastapi.staticfiles import StaticFiles
 from rb.api import routes
 
+log_config = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {
+        "default": {
+            "()": "uvicorn.logging.DefaultFormatter",
+            "fmt": "%(levelprefix)s %(asctime)s %(message)s",
+            "datefmt": "%Y-%m-%d %H:%M:%S",
+
+        },
+    },
+    "handlers": {
+        "default": {
+            "formatter": "default",
+            "class": "logging.StreamHandler",
+            "stream": "ext://sys.stderr",
+        },
+    },
+    "loggers": {
+        "foo-logger": {"handlers": ["default"], "level": "DEBUG"},
+    },
+}
+dictConfig(log_config)
+
+
+
+class LogMiddleware(BaseHTTPMiddleware):
+    async def dispatch(self, request, call_next):
+        logging.debug(f"Request: {request.method} {request.url}")
+        response = await call_next(request)
+        logging.debug(f"Response: {response.status_code}")
+        return response
+
+      
+
 app = FastAPI(
     title="RescueBoxAPI",
     summary="RescueBox is a set of tools for file system investigations.",
     version="0.1.0",
+    debug=True,
     contact={
-        "name": "Jagath Jai Kumar",
+        "name": "Umass Amherst RescuBox Team",
     },
 )
 
+app.add_middleware(LogMiddleware)  
+
 app.mount(
     "/static",
     StaticFiles(directory=os.path.join(os.path.dirname(__file__), "static")),
     name="static",
 )
 
 app.include_router(routes.probes_router, prefix="/probes")
-app.include_router(routes.cli_router)
+app.include_router(routes.cli_to_api_router)
 app.include_router(routes.ui_router)
 
+
+
+
 if __name__ == "__main__":
     import uvicorn
 

pyproject.toml

@@ -9,6 +9,9 @@
 
 from pydantic import BaseModel, ConfigDict, Field, RootModel
 
+API_APPMETDATA="app_metadata"
+API_ROUTES="routes"
+PLUGIN_SCHEMA_SUFFIX="_schema"
 
 class AppMetadata(BaseModel):
     model_config = ConfigDict(

src/rb-api/rb/api/main.py

@@ -1,5 +1,5 @@
-from .cli import cli_router
+from .cli import cli_to_api_router
 from .probes import probes_router
 from .ui import ui_router
 
-__all__ = ["cli_router", "probes_router", "ui_router"]
+__all__ = ["cli_to_api_router", "probes_router", "ui_router"]

src/rb-api/rb/api/models.py

@@ -2,11 +2,10 @@
 import time
 import json
 import logging
-from typing import Callable, Generator, Optional, Any
+from typing import Callable, Generator, Optional
 from pydantic import BaseModel
-
 import typer
-from fastapi import APIRouter, HTTPException, Query
+from fastapi import APIRouter, HTTPException
 from fastapi.responses import StreamingResponse
 from makefun import with_signature
 from rb.lib.stdout import Capturing  # type: ignore
@@ -21,13 +20,12 @@
     BatchTextResponse,
     BatchDirectoryResponse,
 )
-
+from rb.api.models import API_APPMETDATA, API_ROUTES, PLUGIN_SCHEMA_SUFFIX
 from rescuebox.main import app as rescuebox_app
-
 logging.basicConfig(level=logging.DEBUG)
 logger = logging.getLogger(__name__)
 
-cli_router = APIRouter()
+cli_to_api_router = APIRouter()
 
 
 def static_endpoint(callback: Callable, *args, **kwargs) -> ResponseBody:
@@ -36,14 +34,24 @@ def static_endpoint(callback: Callable, *args, **kwargs) -> ResponseBody:
         try:
             logger.debug(f"Executing CLI command: {callback.__name__} with args={args}, kwargs={kwargs}")
             result = callback(*args, **kwargs)  # Ensure this returns a valid Pydantic model
-            logger.debug(f"CLI command output: {result}")
+            
+            logger.debug(f"CLI command output type: {type(result)}")
 
-            if isinstance(result, BaseModel):  # Ensure it's a valid Pydantic model
+            if isinstance(result, ResponseBody):  # Ensure it's a valid Pydantic model
+                return result
+            if isinstance(result, BaseModel):  # Ensure it's a valid Pydantic model , not sure if this is needed for desktop calls
                 return ResponseBody(root=result)
+            if isinstance(result, dict):  # or Ensure it's a valid dict model for desktop app metadata call to work
+                return result
+            if isinstance(result, list):  # or Ensure it's a valid str model for routes call
+                return result
+            if isinstance(result, str):  # or Ensure it's a valid str model for routes call
+                return ResponseBody(root=TextResponse(value=result))
+            # this has an issue of nor sending back details to desktop ui the api caller ?
             raise ValueError(f"Invalid return type from Typer command: {type(result)}")
         except Exception as e:
-            logger.error(f"Error executing CLI command: {e}")
-            raise HTTPException(
+            logger.error("Error executing CLI command: %s", e)
+            raise HTTPException( # pylint: disable=raise-missing-from
                 status_code=400,
                 detail={"error": f"Typer CLI aborted {e}", "stdout": stdout[-10:]},
             )
@@ -52,7 +60,7 @@ def static_endpoint(callback: Callable, *args, **kwargs) -> ResponseBody:
 def streaming_endpoint(callback: Callable, *args, **kwargs) -> Generator:
     """Execute a CLI command and stream the results with proper response handling"""
 
-    logger.debug(f"🚀 Streaming started for command: {callback.__name__} with args={args}, kwargs={kwargs}")
+    logger.debug(f"🚀Streaming started for command: {callback.__name__} with args={args}, kwargs={kwargs}")
 
     for line in capture_stdout_as_generator(callback, *args, **kwargs):
         try:
@@ -96,20 +104,11 @@ def streaming_endpoint(callback: Callable, *args, **kwargs) -> Generator:
         time.sleep(0.01)
 
 
-
 def command_callback(command: typer.models.CommandInfo):
     """Create a FastAPI endpoint handler for a Typer CLI command with `ResponseBody`"""
 
     original_signature = inspect.signature(command.callback)
-    new_params = []
-
-    # Convert Typer CLI arguments to FastAPI-compatible query/body parameters
-    for param in original_signature.parameters.values():
-        if param.default is inspect.Parameter.empty:  # Required argument
-            param = param.replace(default=Query(..., description=f"Required parameter {param.name}"))
-        elif param.default is Ellipsis:  # Typer required argument
-            param = param.replace(default=Query(..., description=f"Required parameter {param.name}"))
-        new_params.append(param)
+    new_params = list(original_signature.parameters.values())
 
     streaming_param = inspect.Parameter(
         "streaming",
@@ -144,14 +143,30 @@ def wrapper(*args, **kwargs) -> ResponseBody:
     router = APIRouter()
 
     for command in plugin.typer_instance.registered_commands:
-        logger.debug(f"Registering FastAPI route for CLI command: {command.callback.__name__}")
 
-        router.add_api_route(
-            f"/{command.callback.__name__}",
-            endpoint=command_callback(command),
-            methods=["POST"],
-            name=command.callback.__name__,
-            response_model=ResponseBody,
-        )
-
-    cli_router.include_router(router, prefix=f"/{plugin.name}", tags=[plugin.name])
+
+        if command.name and (command.name == API_APPMETDATA or
+                             command.name == API_ROUTES  or 
+                             command.name.endswith(PLUGIN_SCHEMA_SUFFIX)):
+            logger.debug(f'plugin command name is {command.name}')
+            router.add_api_route(
+                f"/{command.callback.__name__}",
+                endpoint=command_callback(command),
+                methods=["GET"],
+                name=command.callback.__name__,
+            )
+            # FIXME: prefix /api to make desktop call happy for now , eventually this will go away
+            # GOAL : /audio/routes is valid /api/routes should no longer work
+            cli_to_api_router.include_router(router,prefix=f'/api', tags=[plugin.name])
+
+            logger.debug(f"Registering FastAPI route for {plugin.name} desktop call: {command.callback.__name__}")
+        else:
+            router.add_api_route(
+                f"/{command.callback.__name__}",
+                endpoint=command_callback(command),
+                methods=["POST"],
+                name=command.callback.__name__,
+                response_model=ResponseBody,
+            )
+            logger.debug(f"Registering FastAPI route for {plugin.name} command: {command.callback.__name__}")
+            cli_to_api_router.include_router(router, prefix=f"/{plugin.name}", tags=[plugin.name])