griptape-nodes 0.38.1__py3-none-any.whl → 0.41.0__py3-none-any.whl

griptape_nodes/__init__.py

@@ -18,7 +18,6 @@ with console.status("Loading Griptape Nodes...") as status:
     from typing import Any, Literal
 
     import httpx
-    from dotenv import load_dotenv
     from rich.box import HEAVY_EDGE
     from rich.panel import Panel
     from rich.progress import Progress
@@ -27,6 +26,7 @@ with console.status("Loading Griptape Nodes...") as status:
     from xdg_base_dirs import xdg_config_home, xdg_data_home
 
     from griptape_nodes.app import start_app
+    from griptape_nodes.drivers.storage import StorageBackend
     from griptape_nodes.drivers.storage.griptape_cloud_storage_driver import GriptapeCloudStorageDriver
     from griptape_nodes.retained_mode.griptape_nodes import GriptapeNodes, engine_version
     from griptape_nodes.retained_mode.managers.config_manager import ConfigManager
@@ -83,8 +83,6 @@ os_manager = OSManager()
 
 def main() -> None:
     """Main entry point for the Griptape Nodes CLI."""
-    load_dotenv(ENV_FILE, override=True)
-
     # Hack to make paths "just work". # noqa: FIX004
     # Without this, packages like `nodes` don't properly import.
     # Long term solution could be to make `nodes` a proper src-layout package
@@ -159,7 +157,7 @@ def _handle_bucket_config(config: InitConfig, storage_backend: str | None) -> st
     """Handle bucket configuration step (depends on API key and storage backend)."""
     storage_backend_bucket_id = None
 
-    if storage_backend == "gtc":
+    if storage_backend == StorageBackend.GTC.value:
         if config.interactive:
             storage_backend_bucket_id = _prompt_for_gtc_bucket_name(default_bucket_name=config.bucket_name)
         elif config.bucket_name is not None:
@@ -286,7 +284,7 @@ def _get_args() -> argparse.Namespace:
     init_parser.add_argument(
         "--storage-backend",
         help="Set the storage backend ('local' or 'gtc').",
-        choices=["local", "gtc"],
+        choices=list(StorageBackend),
         default=ENV_STORAGE_BACKEND,
     )
     init_parser.add_argument(
@@ -429,7 +427,7 @@ Enter 'gtc' to use Griptape Cloud Bucket Storage, or press Return to accept the
         try:
             storage_backend = Prompt.ask(
                 "Storage Backend",
-                choices=["gtc", "local"],
+                choices=list(StorageBackend),
                 default=default_storage_backend,
                 show_default=True,
             )
@@ -703,8 +701,8 @@ def _sync_libraries() -> None:
         extracted_libs = extracted_root / "libraries"
 
         # Copy directories from synced libraries without removing existing content
+        console.print(f"[green]Syncing libraries to {dest_nodes.resolve()}...[/green]")
         dest_nodes.mkdir(parents=True, exist_ok=True)
-
         for library_dir in extracted_libs.iterdir():
             if library_dir.is_dir():
                 dest_library_dir = dest_nodes / library_dir.name
@@ -796,7 +794,7 @@ def _uninstall_self() -> None:
     os_manager.replace_process(["uv", "tool", "uninstall", "griptape-nodes"])
 
 
-def _parse_key_value_pairs(pairs: list[str] | None) -> dict[str, str] | None:
+def _parse_key_value_pairs(pairs: list[str] | None) -> dict[str, Any] | None:
     """Parse key=value pairs from a list of strings.
 
     Args:
@@ -822,7 +820,13 @@ def _parse_key_value_pairs(pairs: list[str] | None) -> dict[str, str] | None:
             console.print(f"[bold red]Empty key in pair: {pair}[/bold red]")
             continue
 
-        result[key] = value
+        # Try to parse value as JSON, fall back to string if it fails
+        try:
+            parsed_value = json.loads(value)
+            result[key] = parsed_value
+        except (json.JSONDecodeError, ValueError):
+            # If JSON parsing fails, use the original string value
+            result[key] = value
 
     return result if result else None
 

griptape_nodes/app/__init__.py

@@ -1,5 +1,14 @@
 """App package."""
 
-from griptape_nodes.app.app import start_app
+import os
+
+if os.getenv("GTN_USE_SESSIONS", "False").lower() == "true":
+    # Sessions are only available in the staging environment
+    os.environ["GRIPTAPE_NODES_API_BASE_URL"] = os.getenv(
+        "GRIPTAPE_NODES_API_BASE_URL", "https://api.nodes-staging.griptape.ai"
+    )
+    from griptape_nodes.app.app_sessions import start_app
+else:
+    from griptape_nodes.app.app import start_app
 
 __all__ = ["start_app"]

griptape_nodes/app/app.py

@@ -14,7 +14,6 @@ from typing import Any, cast
 from urllib.parse import urljoin
 
 import uvicorn
-from dotenv import get_key
 from fastapi import FastAPI, HTTPException, Request
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.staticfiles import StaticFiles
@@ -28,7 +27,6 @@ from rich.logging import RichHandler
 from rich.panel import Panel
 from websockets.asyncio.client import connect
 from websockets.exceptions import ConnectionClosed, WebSocketException
-from xdg_base_dirs import xdg_config_home
 
 # This import is necessary to register all events, even if not technically used
 from griptape_nodes.retained_mode.events import app_events, execution_events
@@ -342,7 +340,8 @@ def _process_event_queue() -> None:
 
 def __create_async_websocket_connection() -> Any:
     """Create an async WebSocket connection to the Nodes API."""
-    api_key = get_key(xdg_config_home() / "griptape_nodes" / ".env", "GT_CLOUD_API_KEY")
+    secrets_manager = GriptapeNodes.SecretsManager()
+    api_key = secrets_manager.get_secret("GT_CLOUD_API_KEY")
     if api_key is None:
         message = Panel(
             Align.center(

griptape_nodes/app/app_sessions.py

@@ -0,0 +1,458 @@
+from __future__ import annotations
+
+import asyncio
+import binascii
+import json
+import logging
+import os
+import signal
+import sys
+import threading
+from pathlib import Path
+from queue import Queue
+from typing import Any, cast
+from urllib.parse import urljoin
+
+import uvicorn
+from fastapi import FastAPI, HTTPException, Request
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.staticfiles import StaticFiles
+from griptape.events import (
+    EventBus,
+    EventListener,
+)
+from rich.align import Align
+from rich.console import Console
+from rich.logging import RichHandler
+from rich.panel import Panel
+from websockets.asyncio.client import connect
+from websockets.exceptions import ConnectionClosed, WebSocketException
+
+# This import is necessary to register all events, even if not technically used
+from griptape_nodes.retained_mode.events import app_events, execution_events
+from griptape_nodes.retained_mode.events.base_events import (
+    AppEvent,
+    EventRequest,
+    EventResultFailure,
+    EventResultSuccess,
+    ExecutionEvent,
+    ExecutionGriptapeNodeEvent,
+    GriptapeNodeEvent,
+    ProgressEvent,
+    deserialize_event,
+)
+from griptape_nodes.retained_mode.events.logger_events import LogHandlerEvent
+from griptape_nodes.retained_mode.griptape_nodes import GriptapeNodes
+
+# This is a global event queue that will be used to pass events between threads
+event_queue = Queue()
+
+# Global WebSocket connection for sending events
+ws_connection_for_sending = None
+event_loop = None
+
+# Whether to enable the static server
+STATIC_SERVER_ENABLED = os.getenv("STATIC_SERVER_ENABLED", "true").lower() == "true"
+# Host of the static server
+STATIC_SERVER_HOST = os.getenv("STATIC_SERVER_HOST", "localhost")
+# Port of the static server
+STATIC_SERVER_PORT = int(os.getenv("STATIC_SERVER_PORT", "8124"))
+# URL path for the static server
+STATIC_SERVER_URL = os.getenv("STATIC_SERVER_URL", "/static")
+# Log level for the static server
+STATIC_SERVER_LOG_LEVEL = os.getenv("STATIC_SERVER_LOG_LEVEL", "info").lower()
+
+
+class EventLogHandler(logging.Handler):
+    """Custom logging handler that emits log messages as AppEvents.
+
+    This is used to forward log messages to the event queue so they can be sent to the GUI.
+    """
+
+    def emit(self, record: logging.LogRecord) -> None:
+        event_queue.put(
+            AppEvent(
+                payload=LogHandlerEvent(message=record.getMessage(), levelname=record.levelname, created=record.created)
+            )
+        )
+
+
+# Logger for this module. Important that this is not the same as the griptape_nodes logger or else we'll have infinite log events.
+logger = logging.getLogger("griptape_nodes_app")
+console = Console()
+
+
+def start_app() -> None:
+    """Main entry point for the Griptape Nodes app.
+
+    Starts the event loop and listens for events from the Nodes API.
+    """
+    _init_event_listeners()
+
+    griptape_nodes_logger = logging.getLogger("griptape_nodes")
+    # When running as an app, we want to forward all log messages to the event queue so they can be sent to the GUI
+    griptape_nodes_logger.addHandler(EventLogHandler())
+    griptape_nodes_logger.addHandler(RichHandler(show_time=True, show_path=False, markup=True, rich_tracebacks=True))
+    griptape_nodes_logger.setLevel(logging.INFO)
+
+    # Listen for any signals to exit the app
+    for sig in (signal.SIGINT, signal.SIGTERM):
+        signal.signal(sig, lambda *_: sys.exit(0))
+
+    # SSE subscription pushes events into event_queue
+    threading.Thread(target=_listen_for_api_events, daemon=True).start()
+
+    if STATIC_SERVER_ENABLED:
+        threading.Thread(target=_serve_static_server, daemon=True).start()
+
+    _process_event_queue()
+
+
+def _serve_static_server() -> None:
+    """Run FastAPI with Uvicorn in order to serve static files produced by nodes."""
+    config_manager = GriptapeNodes.ConfigManager()
+    app = FastAPI()
+
+    static_dir = config_manager.workspace_path / config_manager.merged_config["static_files_directory"]
+
+    if not static_dir.exists():
+        static_dir.mkdir(parents=True, exist_ok=True)
+
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=[
+            os.getenv("GRIPTAPE_NODES_UI_BASE_URL", "https://app.nodes.griptape.ai"),
+            "https://app.nodes-staging.griptape.ai",
+            "http://localhost:5173",
+        ],
+        allow_credentials=True,
+        allow_methods=["OPTIONS", "GET", "POST", "PUT"],
+        allow_headers=["*"],
+    )
+
+    app.mount(
+        STATIC_SERVER_URL,
+        StaticFiles(directory=static_dir),
+        name="static",
+    )
+
+    @app.post("/static-upload-urls")
+    async def create_static_file_upload_url(request: Request) -> dict:
+        """Create a URL for uploading a static file.
+
+        Similar to a presigned URL, but for uploading files to the static server.
+        """
+        base_url = request.base_url
+        body = await request.json()
+        file_name = body["file_name"]
+        url = urljoin(str(base_url), f"/static-uploads/{file_name}")
+
+        return {"url": url}
+
+    @app.put("/static-uploads/{file_name:str}")
+    async def create_static_file(request: Request, file_name: str) -> dict:
+        """Upload a static file to the static server."""
+        if not STATIC_SERVER_ENABLED:
+            msg = "Static server is not enabled. Please set STATIC_SERVER_ENABLED to True."
+            raise ValueError(msg)
+
+        if not static_dir.exists():
+            static_dir.mkdir(parents=True, exist_ok=True)
+        data = await request.body()
+        try:
+            Path(static_dir / file_name).write_bytes(data)
+        except binascii.Error as e:
+            msg = f"Invalid base64 encoding for file {file_name}."
+            logger.error(msg)
+            raise HTTPException(status_code=400, detail=msg) from e
+        except (OSError, PermissionError) as e:
+            msg = f"Failed to write file {file_name} to {config_manager.workspace_path}: {e}"
+            logger.error(msg)
+            raise HTTPException(status_code=500, detail=msg) from e
+
+        static_url = f"http://{STATIC_SERVER_HOST}:{STATIC_SERVER_PORT}{STATIC_SERVER_URL}/{file_name}"
+        return {"url": static_url}
+
+    @app.post("/engines/request")
+    async def create_event(request: Request) -> None:
+        body = await request.json()
+        if "payload" in body:
+            __process_api_event(body["payload"])
+
+    logging.getLogger("uvicorn").addHandler(
+        RichHandler(show_time=True, show_path=False, markup=True, rich_tracebacks=True)
+    )
+
+    uvicorn.run(
+        app, host=STATIC_SERVER_HOST, port=STATIC_SERVER_PORT, log_level=STATIC_SERVER_LOG_LEVEL, log_config=None
+    )
+
+
+def _init_event_listeners() -> None:
+    """Set up the Griptape EventBus EventListeners."""
+    EventBus.add_event_listener(
+        event_listener=EventListener(on_event=__process_node_event, event_types=[GriptapeNodeEvent])
+    )
+
+    EventBus.add_event_listener(
+        event_listener=EventListener(
+            on_event=__process_execution_node_event,
+            event_types=[ExecutionGriptapeNodeEvent],
+        )
+    )
+
+    EventBus.add_event_listener(
+        event_listener=EventListener(
+            on_event=__process_progress_event,
+            event_types=[ProgressEvent],
+        )
+    )
+
+    EventBus.add_event_listener(
+        event_listener=EventListener(
+            on_event=__process_app_event,  # pyright: ignore[reportArgumentType] TODO: https://github.com/griptape-ai/griptape-nodes/issues/868
+            event_types=[AppEvent],  # pyright: ignore[reportArgumentType] TODO: https://github.com/griptape-ai/griptape-nodes/issues/868
+        )
+    )
+
+
+async def _alisten_for_api_requests() -> None:
+    """Listen for events from the Nodes API and process them asynchronously."""
+    global ws_connection_for_sending, event_loop  # noqa: PLW0603
+    event_loop = asyncio.get_running_loop()  # Store the event loop reference
+    nodes_app_url = os.getenv("GRIPTAPE_NODES_UI_BASE_URL", "https://nodes.griptape.ai")
+    logger.info("Listening for events from Nodes API via async WebSocket")
+
+    # Auto reconnect https://websockets.readthedocs.io/en/stable/reference/asyncio/client.html#opening-a-connection
+    connection_stream = __create_async_websocket_connection()
+    initialized = False
+    async for ws_connection in connection_stream:
+        try:
+            ws_connection_for_sending = ws_connection  # Store for sending events
+            if not initialized:
+                __broadcast_app_initialization_complete(nodes_app_url)
+                initialized = True
+
+            async for message in ws_connection:
+                try:
+                    data = json.loads(message)
+
+                    payload = data.get("payload", {})
+                    __process_api_event(payload)
+                except Exception:
+                    logger.exception("Error processing event, skipping.")
+        except ConnectionClosed:
+            continue
+        except Exception as e:
+            logger.error("Error while listening for events. Retrying in 2 seconds... %s", e)
+            await asyncio.sleep(2)
+
+
+def _listen_for_api_events() -> None:
+    """Run the async WebSocket listener in an event loop."""
+    asyncio.run(_alisten_for_api_requests())
+
+
+def __process_node_event(event: GriptapeNodeEvent) -> None:
+    """Process GriptapeNodeEvents and send them to the API."""
+    # Emit the result back to the GUI
+    result_event = event.wrapped_event
+    if isinstance(result_event, EventResultSuccess):
+        dest_socket = "success_result"
+    elif isinstance(result_event, EventResultFailure):
+        dest_socket = "failure_result"
+    else:
+        msg = f"Unknown/unsupported result event type encountered: '{type(result_event)}'."
+        raise TypeError(msg) from None
+
+    # Don't send events over the wire that don't have a request_id set (e.g. engine-internal events)
+    event_json = result_event.json()
+    __schedule_async_task(__emit_message(dest_socket, event_json))
+
+
+def __process_execution_node_event(event: ExecutionGriptapeNodeEvent) -> None:
+    """Process ExecutionGriptapeNodeEvents and send them to the API."""
+    result_event = event.wrapped_event
+    if type(result_event.payload).__name__ == "NodeStartProcessEvent":
+        GriptapeNodes.EventManager().current_active_node = result_event.payload.node_name
+    event_json = result_event.json()
+
+    if type(result_event.payload).__name__ == "ResumeNodeProcessingEvent":
+        node_name = result_event.payload.node_name
+        logger.info("Resuming Node '%s'", node_name)
+        flow_name = GriptapeNodes.NodeManager().get_node_parent_flow_by_name(node_name)
+        request = EventRequest(request=execution_events.SingleExecutionStepRequest(flow_name=flow_name))
+        event_queue.put(request)
+
+    if type(result_event.payload).__name__ == "NodeFinishProcessEvent":
+        if result_event.payload.node_name != GriptapeNodes.EventManager().current_active_node:
+            msg = "Node start and finish do not match."
+            raise KeyError(msg) from None
+        GriptapeNodes.EventManager().current_active_node = None
+    __schedule_async_task(__emit_message("execution_event", event_json))
+
+
+def __process_progress_event(gt_event: ProgressEvent) -> None:
+    """Process Griptape framework events and send them to the API."""
+    node_name = gt_event.node_name
+    if node_name:
+        value = gt_event.value
+        payload = execution_events.GriptapeEvent(
+            node_name=node_name, parameter_name=gt_event.parameter_name, type=type(gt_event).__name__, value=value
+        )
+        event_to_emit = ExecutionEvent(payload=payload)
+        __schedule_async_task(__emit_message("execution_event", event_to_emit.json()))
+
+
+def __process_app_event(event: AppEvent) -> None:
+    """Process AppEvents and send them to the API."""
+    # Let Griptape Nodes broadcast it.
+    GriptapeNodes.broadcast_app_event(event.payload)
+
+    __schedule_async_task(__emit_message("app_event", event.json()))
+
+
+def _process_event_queue() -> None:
+    """Listen for events in the event queue and process them.
+
+    Event queue will be populated by background threads listening for events from the Nodes API.
+    """
+    while True:
+        event = event_queue.get(block=True)
+        if isinstance(event, EventRequest):
+            request_payload = event.request
+            GriptapeNodes.handle_request(request_payload)
+        elif isinstance(event, AppEvent):
+            __process_app_event(event)
+        else:
+            logger.warning("Unknown event type encountered: '%s'.", type(event))
+
+        event_queue.task_done()
+
+
+def __create_async_websocket_connection() -> Any:
+    """Create an async WebSocket connection to the Nodes API."""
+    secrets_manager = GriptapeNodes.SecretsManager()
+    api_key = secrets_manager.get_secret("GT_CLOUD_API_KEY")
+    if api_key is None:
+        message = Panel(
+            Align.center(
+                "[bold red]Nodes API key is not set, please run [code]gtn init[/code] with a valid key: [/bold red]"
+                "[code]gtn init --api-key <your key>[/code]\n"
+                "[bold red]You can generate a new key from [/bold red][bold blue][link=https://nodes.griptape.ai]https://nodes.griptape.ai[/link][/bold blue]",
+            ),
+            title="🔑 ❌ Missing Nodes API Key",
+            border_style="red",
+            padding=(1, 4),
+        )
+        console.print(message)
+        sys.exit(1)
+
+    endpoint = urljoin(
+        os.getenv("GRIPTAPE_NODES_API_BASE_URL", "https://api.nodes.griptape.ai").replace("http", "ws"),
+        "/ws/engines/events?publish_channel=responses&subscribe_channel=requests",
+    )
+
+    return connect(
+        endpoint,
+        additional_headers={"Authorization": f"Bearer {api_key}"},
+    )
+
+
+async def __emit_message(event_type: str, payload: str) -> None:
+    """Send a message via WebSocket asynchronously."""
+    global ws_connection_for_sending  # noqa: PLW0602
+    if ws_connection_for_sending is None:
+        logger.warning("WebSocket connection not available for sending message")
+        return
+
+    try:
+        body = {"type": event_type, "payload": json.loads(payload) if payload else {}}
+        await ws_connection_for_sending.send(json.dumps(body))
+    except WebSocketException as e:
+        logger.error("Error sending event to Nodes API: %s", e)
+    except Exception as e:
+        logger.error("Unexpected error while sending event to Nodes API: %s", e)
+
+
+def __schedule_async_task(coro: Any) -> None:
+    """Schedule an async coroutine to run in the event loop from a sync context."""
+    if event_loop and event_loop.is_running():
+        asyncio.run_coroutine_threadsafe(coro, event_loop)
+    else:
+        logger.warning("Event loop not available for scheduling async task")
+
+
+def __broadcast_app_initialization_complete(nodes_app_url: str) -> None:
+    """Broadcast the AppInitializationComplete event to all listeners.
+
+    This is used to notify the GUI that the app is ready to receive events.
+    """
+    # Initialize engine ID and persistent data
+    from griptape_nodes.retained_mode.events.base_events import BaseEvent
+
+    BaseEvent.initialize_engine_id()
+    BaseEvent.initialize_session_id()
+
+    # Broadcast this to anybody who wants a callback on "hey, the app's ready to roll"
+    payload = app_events.AppInitializationComplete()
+    app_event = AppEvent(payload=payload)
+    __process_app_event(app_event)
+
+    engine_version_request = app_events.GetEngineVersionRequest()
+    engine_version_result = GriptapeNodes.get_instance().handle_engine_version_request(engine_version_request)
+    if isinstance(engine_version_result, app_events.GetEngineVersionResultSuccess):
+        engine_version = f"v{engine_version_result.major}.{engine_version_result.minor}.{engine_version_result.patch}"
+    else:
+        engine_version = "<UNKNOWN ENGINE VERSION>"
+
+    # Get current session ID
+    session_id = GriptapeNodes.get_session_id()
+    session_info = f" | Session: {session_id[:8]}..." if session_id else " | No Session"
+
+    message = Panel(
+        Align.center(
+            f"[bold green]Engine is ready to receive events[/bold green]\n"
+            f"[bold blue]Return to: [link={nodes_app_url}]{nodes_app_url}[/link] to access the Workflow Editor[/bold blue]",
+            vertical="middle",
+        ),
+        title="🚀 Griptape Nodes Engine Started",
+        subtitle=f"[green]{engine_version}{session_info}[/green]",
+        border_style="green",
+        padding=(1, 4),
+    )
+    console.print(message)
+
+
+def __process_api_event(data: dict) -> None:
+    """Process API events and send them to the event queue."""
+    try:
+        data["request"]
+    except KeyError:
+        msg = "Error: 'request' was expected but not found."
+        raise RuntimeError(msg) from None
+
+    try:
+        event_type = data["event_type"]
+        if event_type != "EventRequest":
+            msg = "Error: 'event_type' was found on request, but did not match 'EventRequest' as expected."
+            raise RuntimeError(msg) from None
+    except KeyError:
+        msg = "Error: 'event_type' not found in request."
+        raise RuntimeError(msg) from None
+
+    # Now attempt to convert it into an EventRequest.
+    try:
+        request_event: EventRequest = cast("EventRequest", deserialize_event(json_data=data))
+    except Exception as e:
+        msg = f"Unable to convert request JSON into a valid EventRequest object. Error Message: '{e}'"
+        raise RuntimeError(msg) from None
+
+    # Add a request_id to the payload
+    request_id = request_event.request.request_id
+    request_event.request.request_id = request_id
+
+    # Add the event to the queue
+    event_queue.put(request_event)
+
+    return request_id

griptape_nodes/bootstrap/workflow_executors/__init__.py

@@ -0,0 +1 @@
+"""Workflow executors package."""