griptape-nodes 0.45.1__py3-none-any.whl → 0.47.0__py3-none-any.whl

griptape_nodes/retained_mode/managers/object_manager.py

@@ -55,7 +55,7 @@ class ObjectManager:
         if source_obj is None:
             details = f"Attempted to rename object '{request.object_name}', but no object of that name could be found."
             logger.error(details)
-            return RenameObjectResultFailure(next_available_name=None)
+            return RenameObjectResultFailure(next_available_name=None, result_details=details)
 
         # Is there a collision?
         requested_name_obj = self.attempt_get_object_by_name(request.requested_name)
@@ -73,7 +73,7 @@ class ObjectManager:
                 # Fail it but be nice and offer the next name that WOULD HAVE been available.
                 details = f"Attempted to rename object '{request.object_name}' to '{request.requested_name}'. Failed because another object of that name exists. Next available name would have been '{next_name}'."
                 logger.error(details)
-                return RenameObjectResultFailure(next_available_name=next_name)
+                return RenameObjectResultFailure(next_available_name=next_name, result_details=details)
             # We'll use the next available name.
             final_name = next_name
 
@@ -86,7 +86,7 @@ class ObjectManager:
             case _:
                 details = f"Attempted to rename an object named '{request.object_name}', but that object wasn't of a type supported for rename."
                 logger.error(details)
-                return RenameObjectResultFailure(next_available_name=None)
+                return RenameObjectResultFailure(next_available_name=None, result_details=details)
 
         # Update the object table.
         self._name_to_objects[final_name] = source_obj
@@ -102,10 +102,9 @@ class ObjectManager:
 
     def on_clear_all_object_state_request(self, request: ClearAllObjectStateRequest) -> ResultPayload:  # noqa: C901
         if not request.i_know_what_im_doing:
-            logger.warning(
-                "Attempted to clear all object state and delete everything. Failed because they didn't know what they were doing."
-            )
-            return ClearAllObjectStateResultFailure()
+            details = "Attempted to clear all object state and delete everything. Failed because they didn't know what they were doing."
+            logger.warning(details)
+            return ClearAllObjectStateResultFailure(result_details=details)
         # Let's try and clear it all.
         # Cancel any running flows.
         flows = self.get_filtered_subset(type=ControlFlow)
@@ -115,7 +114,7 @@ class ObjectManager:
                 if not result.succeeded():
                     details = f"Attempted to clear all object state and delete everything. Failed because running flow '{flow_name}' could not cancel."
                     logger.error(details)
-                    return ClearAllObjectStateResultFailure()
+                    return ClearAllObjectStateResultFailure(result_details=details)
 
         try:
             # Reset global execution state first to eliminate all references before deletion
@@ -123,7 +122,7 @@ class ObjectManager:
         except Exception as e:
             details = f"Attempted to reset global execution state. Failed with exception: {e}"
             logger.error(details)
-            return ClearAllObjectStateResultFailure()
+            return ClearAllObjectStateResultFailure(result_details=details)
 
         try:
             # Delete the existing flows, which will clear all nodes and connections.
@@ -131,7 +130,7 @@ class ObjectManager:
         except Exception as e:
             details = f"Attempted to clear all object state and delete everything. Failed with exception: {e}"
             logger.error(details)
-            return ClearAllObjectStateResultFailure()
+            return ClearAllObjectStateResultFailure(result_details=details)
 
         # Clear the current context.
         context_mgr = GriptapeNodes.ContextManager()

griptape_nodes/retained_mode/managers/os_manager.py

@@ -218,17 +218,17 @@ class OSManager:
             sys.stdout.flush()  # Recommended here https://docs.python.org/3/library/os.html#os.execvpe
             os.execvp(args[0], args)  # noqa: S606
 
-    def on_open_associated_file_request(self, request: OpenAssociatedFileRequest) -> ResultPayload:  # noqa: C901, PLR0911, PLR0912
+    def on_open_associated_file_request(self, request: OpenAssociatedFileRequest) -> ResultPayload:  # noqa: PLR0911, PLR0912, PLR0915, C901
         # Validate that exactly one of path_to_file or file_entry is provided
         if request.path_to_file is None and request.file_entry is None:
             msg = "Either path_to_file or file_entry must be provided"
             logger.error(msg)
-            return OpenAssociatedFileResultFailure()
+            return OpenAssociatedFileResultFailure(result_details=msg)
 
         if request.path_to_file is not None and request.file_entry is not None:
             msg = "Only one of path_to_file or file_entry should be provided, not both"
             logger.error(msg)
-            return OpenAssociatedFileResultFailure()
+            return OpenAssociatedFileResultFailure(result_details=msg)
 
         # Get the file path to open
         if request.file_entry is not None:
@@ -241,13 +241,13 @@ class OSManager:
             # This should never happen due to validation above, but type checker needs it
             msg = "No valid file path provided"
             logger.error(msg)
-            return OpenAssociatedFileResultFailure()
+            return OpenAssociatedFileResultFailure(result_details=msg)
 
         # At this point, file_path_str is guaranteed to be a string
         if file_path_str is None:
             msg = "No valid file path provided"
             logger.error(msg)
-            return OpenAssociatedFileResultFailure()
+            return OpenAssociatedFileResultFailure(result_details=msg)
 
         # Sanitize and validate the path (file or directory)
         try:
@@ -256,12 +256,12 @@ class OSManager:
         except (ValueError, RuntimeError):
             details = f"Invalid file path: '{file_path_str}'"
             logger.info(details)
-            return OpenAssociatedFileResultFailure()
+            return OpenAssociatedFileResultFailure(result_details=details)
 
         if not path.exists():
             details = f"Path does not exist: '{path}'"
             logger.info(details)
-            return OpenAssociatedFileResultFailure()
+            return OpenAssociatedFileResultFailure(result_details=details)
 
         logger.info("Attempting to open path: %s on platform: %s", path, sys.platform)
 
@@ -288,8 +288,9 @@ class OSManager:
 
                 xdg_path = next((p for p in xdg_paths if Path(p).exists()), None)
                 if not xdg_path:
-                    logger.info("xdg-open not found in standard locations")
-                    return OpenAssociatedFileResultFailure()
+                    details = "xdg-open not found in standard locations"
+                    logger.info(details)
+                    return OpenAssociatedFileResultFailure(result_details=details)
 
                 subprocess.run(  # noqa: S603
                     [xdg_path, str(path)],
@@ -301,20 +302,19 @@ class OSManager:
             else:
                 details = f"Unsupported platform: '{platform_name}'"
                 logger.info(details)
-                return OpenAssociatedFileResultFailure()
+                return OpenAssociatedFileResultFailure(result_details=details)
 
             return OpenAssociatedFileResultSuccess()
         except subprocess.CalledProcessError as e:
-            logger.error(
-                "Process error when opening file: return code=%s, stdout=%s, stderr=%s",
-                e.returncode,
-                e.stdout,
-                e.stderr,
+            details = (
+                f"Process error when opening file: return code={e.returncode}, stdout={e.stdout}, stderr={e.stderr}"
             )
-            return OpenAssociatedFileResultFailure()
+            logger.error(details)
+            return OpenAssociatedFileResultFailure(result_details=details)
         except Exception as e:
-            logger.error("Exception occurred when trying to open path: %s", type(e).__name__)
-            return OpenAssociatedFileResultFailure()
+            details = f"Exception occurred when trying to open path: {e}"
+            logger.error(details)
+            return OpenAssociatedFileResultFailure(result_details=details)
 
     def _detect_mime_type(self, file_path: Path) -> str | None:
         """Detect MIME type for a file. Returns None for directories or if detection fails."""
@@ -349,18 +349,18 @@ class OSManager:
             if not directory.exists():
                 msg = f"Directory does not exist: {directory}"
                 logger.error(msg)
-                return ListDirectoryResultFailure()
+                return ListDirectoryResultFailure(result_details=msg)
             if not directory.is_dir():
                 msg = f"Directory is not a directory: {directory}"
                 logger.error(msg)
-                return ListDirectoryResultFailure()
+                return ListDirectoryResultFailure(result_details=msg)
 
             # Check workspace constraints
             is_workspace_path, relative_or_abs_path = self._validate_workspace_path(directory)
             if request.workspace_only and not is_workspace_path:
                 msg = f"Directory is outside workspace: {directory}"
                 logger.error(msg)
-                return ListDirectoryResultFailure()
+                return ListDirectoryResultFailure(result_details=msg)
 
             entries = []
             try:
@@ -393,7 +393,7 @@ class OSManager:
             except (OSError, PermissionError) as e:
                 msg = f"Error listing directory {directory}: {e}"
                 logger.error(msg)
-                return ListDirectoryResultFailure()
+                return ListDirectoryResultFailure(result_details=msg)
 
             # Return appropriate path format based on mode
             if request.workspace_only:
@@ -409,7 +409,7 @@ class OSManager:
         except Exception as e:
             msg = f"Unexpected error in list_directory: {type(e).__name__}: {e}"
             logger.error(msg)
-            return ListDirectoryResultFailure()
+            return ListDirectoryResultFailure(result_details=msg)
 
     def on_read_file_request(self, request: ReadFileRequest) -> ResultPayload:
         """Handle a request to read file contents with automatic text/binary detection."""
@@ -436,7 +436,7 @@ class OSManager:
             file_info = f" for file: {file_path}" if file_path is not None else ""
             msg = f"Validation error in read_file{file_info}: {e}"
             logger.error(msg)
-            return ReadFileResultFailure()
+            return ReadFileResultFailure(result_details=msg)
         except Exception as e:
             # Try to include file path in error message if available
             path_info = ""
@@ -447,7 +447,7 @@ class OSManager:
 
             msg = f"Unexpected error in read_file{path_info}: {type(e).__name__}: {e}"
             logger.error(msg)
-            return ReadFileResultFailure()
+            return ReadFileResultFailure(result_details=msg)
 
     def _read_file_content(
         self, file_path: Path, request: ReadFileRequest
@@ -748,7 +748,7 @@ class OSManager:
             if request.workspace_only and is_absolute:
                 msg = f"Absolute path is outside workspace: {full_path_str}"
                 logger.error(msg)
-                return CreateFileResultFailure()
+                return CreateFileResultFailure(result_details=msg)
 
             # Resolve path - if absolute, use as-is; if relative, align to workspace
             if is_absolute:
@@ -783,7 +783,7 @@ class OSManager:
             path_info = request.get_full_path() if hasattr(request, "get_full_path") else str(request.path)
             msg = f"Failed to create {'directory' if request.is_directory else 'file'} at {path_info}: {e}"
             logger.error(msg)
-            return CreateFileResultFailure()
+            return CreateFileResultFailure(result_details=msg)
 
     def on_rename_file_request(self, request: RenameFileRequest) -> ResultPayload:
         """Handle a request to rename a file or directory."""
@@ -798,13 +798,13 @@ class OSManager:
             if not old_path.exists():
                 msg = f"Source path does not exist: {old_path}"
                 logger.error(msg)
-                return RenameFileResultFailure()
+                return RenameFileResultFailure(result_details=msg)
 
             # Check if new path already exists
             if new_path.exists():
                 msg = f"Destination path already exists: {new_path}"
                 logger.error(msg)
-                return RenameFileResultFailure()
+                return RenameFileResultFailure(result_details=msg)
 
             # Check workspace constraints for both paths
             is_old_in_workspace, _ = self._validate_workspace_path(old_path)
@@ -813,7 +813,7 @@ class OSManager:
             if request.workspace_only and (not is_old_in_workspace or not is_new_in_workspace):
                 msg = f"One or both paths are outside workspace: {old_path} -> {new_path}"
                 logger.error(msg)
-                return RenameFileResultFailure()
+                return RenameFileResultFailure(result_details=msg)
 
             # Create parent directories for new path if needed
             new_path.parent.mkdir(parents=True, exist_ok=True)
@@ -827,4 +827,4 @@ class OSManager:
         except Exception as e:
             msg = f"Failed to rename {request.old_path} to {request.new_path}: {e}"
             logger.error(msg)
-            return RenameFileResultFailure()
+            return RenameFileResultFailure(result_details=msg)

griptape_nodes/retained_mode/managers/secrets_manager.py

@@ -53,12 +53,12 @@ class SecretsManager:
 
     def on_handle_get_secret_request(self, request: GetSecretValueRequest) -> ResultPayload:
         secret_key = SecretsManager._apply_secret_name_compliance(request.key)
-        secret_value = self.get_secret(secret_key)
+        secret_value = self.get_secret(secret_key, should_error_on_not_found=request.should_error_on_not_found)
 
-        if secret_value is None:
+        if secret_value is None and request.should_error_on_not_found:
             details = f"Secret '{secret_key}' not found."
             logger.error(details)
-            return GetSecretValueResultFailure()
+            return GetSecretValueResultFailure(result_details=details)
 
         return GetSecretValueResultSuccess(value=secret_value)
 
@@ -90,12 +90,12 @@ class SecretsManager:
         if not ENV_VAR_PATH.exists():
             details = f"Secret file does not exist: '{ENV_VAR_PATH}'"
             logger.error(details)
-            return DeleteSecretValueResultFailure()
+            return DeleteSecretValueResultFailure(result_details=details)
 
         if get_key(ENV_VAR_PATH, secret_name) is None:
             details = f"Secret {secret_name} not found in {ENV_VAR_PATH}"
             logger.error(details)
-            return DeleteSecretValueResultFailure()
+            return DeleteSecretValueResultFailure(result_details=details)
 
         unset_key(ENV_VAR_PATH, secret_name)
 

griptape_nodes/retained_mode/managers/static_files_manager.py

@@ -50,21 +50,22 @@ class StaticFilesManager:
 
         match storage_backend:
             case StorageBackend.GTC:
-                bucket_id = secrets_manager.get_secret("GT_CLOUD_BUCKET_ID")
+                bucket_id = secrets_manager.get_secret("GT_CLOUD_BUCKET_ID", should_error_on_not_found=False)
 
                 if not bucket_id:
-                    msg = "GT_CLOUD_BUCKET_ID secret is required for gtc storage backend"
-                    logger.error(msg)
-                    raise ValueError(msg)
-
-                static_files_directory = config_manager.get_config_value(
-                    "static_files_directory", default="staticfiles"
-                )
-                self.storage_driver = GriptapeCloudStorageDriver(
-                    bucket_id=bucket_id,
-                    api_key=secrets_manager.get_secret("GT_CLOUD_API_KEY"),
-                    static_files_directory=static_files_directory,
-                )
+                    logger.warning(
+                        "GT_CLOUD_BUCKET_ID secret is not available, falling back to local storage. Run `gtn init` to set it up."
+                    )
+                    self.storage_driver = LocalStorageDriver()
+                else:
+                    static_files_directory = config_manager.get_config_value(
+                        "static_files_directory", default="staticfiles"
+                    )
+                    self.storage_driver = GriptapeCloudStorageDriver(
+                        bucket_id=bucket_id,
+                        api_key=secrets_manager.get_secret("GT_CLOUD_API_KEY"),
+                        static_files_directory=static_files_directory,
+                    )
             case StorageBackend.LOCAL:
                 self.storage_driver = LocalStorageDriver()
             case _:
@@ -93,14 +94,14 @@ class StaticFilesManager:
         except (binascii.Error, ValueError) as e:
             msg = f"Failed to decode base64 content for file {file_name}: {e}"
             logger.error(msg)
-            return CreateStaticFileResultFailure(error=msg)
+            return CreateStaticFileResultFailure(error=msg, result_details=msg)
 
         try:
             url = self.save_static_file(content_bytes, file_name)
         except ValueError as e:
             msg = f"Failed to create static file for file {file_name}: {e}"
             logger.error(msg)
-            return CreateStaticFileResultFailure(error=msg)
+            return CreateStaticFileResultFailure(error=msg, result_details=msg)
 
         return CreateStaticFileResultSuccess(url=url)
 
@@ -122,7 +123,7 @@ class StaticFilesManager:
         except ValueError as e:
             msg = f"Failed to create presigned URL for file {file_name}: {e}"
             logger.error(msg)
-            return CreateStaticFileUploadUrlResultFailure(error=msg)
+            return CreateStaticFileUploadUrlResultFailure(error=msg, result_details=msg)
 
         return CreateStaticFileUploadUrlResultSuccess(
             url=response["url"], headers=response["headers"], method=response["method"]
@@ -146,7 +147,7 @@ class StaticFilesManager:
         except ValueError as e:
             msg = f"Failed to create presigned URL for file {file_name}: {e}"
             logger.error(msg)
-            return CreateStaticFileDownloadUrlResultFailure(error=msg)
+            return CreateStaticFileDownloadUrlResultFailure(error=msg, result_details=msg)
 
         return CreateStaticFileDownloadUrlResultSuccess(url=url)
 

griptape_nodes/retained_mode/managers/sync_manager.py

@@ -144,8 +144,9 @@ class SyncManager:
             self._active_sync_tasks[sync_task_id] = sync_thread
             sync_thread.start()
         except Exception as e:
-            logger.error("Failed to start cloud workflow sync: %s", str(e))
-            return StartSyncAllCloudWorkflowsResultFailure()
+            details = f"Failed to start cloud workflow sync: {e!s}"
+            logger.error(details)
+            return StartSyncAllCloudWorkflowsResultFailure(result_details=details)
         else:
             logger.info("Started background sync for %d workflow files", len(workflow_files))
             return StartSyncAllCloudWorkflowsResultSuccess(

griptape_nodes/retained_mode/managers/version_compatibility_manager.py

@@ -14,8 +14,10 @@ from griptape_nodes.retained_mode.griptape_nodes import GriptapeNodes, Version
 
 if TYPE_CHECKING:
     from griptape_nodes.node_library.library_registry import LibrarySchema
+    from griptape_nodes.node_library.workflow_registry import WorkflowMetadata
     from griptape_nodes.retained_mode.managers.event_manager import EventManager
     from griptape_nodes.retained_mode.managers.library_lifecycle.library_status import LibraryStatus
+    from griptape_nodes.retained_mode.managers.workflow_manager import WorkflowManager
 
 logger = logging.getLogger("griptape_nodes")
 
@@ -39,16 +41,41 @@ class LibraryVersionCompatibilityCheck(ABC):
         """Perform the library compatibility check."""
 
 
+class WorkflowVersionCompatibilityIssue(NamedTuple):
+    """Represents a workflow version compatibility issue found in a workflow."""
+
+    message: str
+    severity: WorkflowManager.WorkflowStatus
+
+
+class WorkflowVersionCompatibilityCheck(ABC):
+    """Abstract base class for workflow version compatibility checks."""
+
+    @abstractmethod
+    def applies_to_workflow(self, workflow_metadata: WorkflowMetadata) -> bool:
+        """Return True if this check applies to the given workflow."""
+
+    @abstractmethod
+    def check_workflow(self, workflow_metadata: WorkflowMetadata) -> list[WorkflowVersionCompatibilityIssue]:
+        """Perform the workflow compatibility check."""
+
+
 class VersionCompatibilityManager:
     """Manages version compatibility checks for libraries and other components."""
 
     def __init__(self, event_manager: EventManager) -> None:
         self._event_manager = event_manager
         self._compatibility_checks: list[LibraryVersionCompatibilityCheck] = []
+        self._workflow_compatibility_checks: list[WorkflowVersionCompatibilityCheck] = []
         self._discover_version_checks()
 
     def _discover_version_checks(self) -> None:
-        """Automatically discover and register library version compatibility checks."""
+        """Automatically discover and register library and workflow version compatibility checks."""
+        self._discover_library_version_checks()
+        self._discover_workflow_version_checks()
+
+    def _discover_library_version_checks(self) -> None:
+        """Discover and register library version compatibility checks."""
         # Get the path to the version_compatibility/versions directory
         import griptape_nodes.version_compatibility.versions as versions_module
 
@@ -59,6 +86,21 @@ class VersionCompatibilityManager:
             if version_dir.is_dir() and not version_dir.name.startswith("__"):
                 self._discover_checks_in_version_dir(version_dir)
 
+    def _discover_workflow_version_checks(self) -> None:
+        """Discover and register workflow version compatibility checks."""
+        try:
+            import griptape_nodes.version_compatibility.workflow_versions as workflow_versions_module
+
+            workflow_versions_path = Path(workflow_versions_module.__file__).parent
+
+            # Iterate through version directories
+            for version_dir in workflow_versions_path.iterdir():
+                if version_dir.is_dir() and not version_dir.name.startswith("__"):
+                    self._discover_workflow_checks_in_version_dir(version_dir)
+        except ImportError:
+            # workflow_versions directory doesn't exist yet, skip discovery
+            logger.debug("No workflow version compatibility checks directory found, skipping workflow check discovery")
+
     def _discover_checks_in_version_dir(self, version_dir: Path) -> None:
         """Discover compatibility checks in a specific version directory."""
         # Iterate through Python files in the version directory
@@ -82,6 +124,33 @@ class VersionCompatibilityManager:
                     self._compatibility_checks.append(check_instance)
                     logger.debug("Registered library version compatibility check: %s", attr_name)
 
+    def _discover_workflow_checks_in_version_dir(self, version_dir: Path) -> None:
+        """Discover workflow compatibility checks in a specific version directory."""
+        # Iterate through Python files in the version directory
+        for check_file in version_dir.glob("*.py"):
+            if check_file.name.startswith("__"):
+                continue
+
+            # Import the module
+            module_path = f"griptape_nodes.version_compatibility.workflow_versions.{version_dir.name}.{check_file.stem}"
+            try:
+                module = importlib.import_module(module_path)
+            except ImportError as e:
+                logger.debug("Failed to import workflow compatibility check module %s: %s", module_path, e)
+                continue
+
+            # Look for classes that inherit from WorkflowVersionCompatibilityCheck
+            for attr_name in dir(module):
+                attr = getattr(module, attr_name)
+                if (
+                    isinstance(attr, type)
+                    and issubclass(attr, WorkflowVersionCompatibilityCheck)
+                    and attr is not WorkflowVersionCompatibilityCheck
+                ):
+                    check_instance = attr()
+                    self._workflow_compatibility_checks.append(check_instance)
+                    logger.debug("Registered workflow version compatibility check: %s", attr_name)
+
     def check_library_version_compatibility(
         self, library_data: LibrarySchema
     ) -> list[LibraryVersionCompatibilityIssue]:
@@ -96,6 +165,20 @@ class VersionCompatibilityManager:
 
         return version_issues
 
+    def check_workflow_version_compatibility(
+        self, workflow_metadata: WorkflowMetadata
+    ) -> list[WorkflowVersionCompatibilityIssue]:
+        """Check a workflow for version compatibility issues."""
+        version_issues = []
+
+        # Run all discovered workflow compatibility checks
+        for check_instance in self._workflow_compatibility_checks:
+            if check_instance.applies_to_workflow(workflow_metadata):
+                issues = check_instance.check_workflow(workflow_metadata)
+                version_issues.extend(issues)
+
+        return version_issues
+
     def _get_current_engine_version(self) -> Version:
         """Get the current engine version."""
         result = GriptapeNodes.handle_request(GetEngineVersionRequest())