synapse-sdk 1.0.0b24__py3-none-any.whl → 2025.9.3__py3-none-any.whl

synapse_sdk/plugins/categories/upload/actions/upload/context.py

@@ -0,0 +1,185 @@
+from datetime import datetime
+from pathlib import Path
+from typing import Any, Dict, List, Optional
+
+from .run import UploadRun
+
+
+class StepResult:
+    """Result of a workflow step execution."""
+
+    def __init__(
+        self,
+        success: bool = True,
+        data: Dict[str, Any] = None,
+        error: str = None,
+        rollback_data: Dict[str, Any] = None,
+        skipped: bool = False,
+        original_exception: Optional[Exception] = None,
+    ):
+        self.success = success
+        self.data = data or {}
+        self.error = error
+        self.rollback_data = rollback_data or {}
+        self.skipped = skipped
+        self.original_exception = original_exception
+        self.timestamp = datetime.now()
+
+    def __bool__(self):
+        return self.success
+
+
+class UploadContext:
+    """Shared context for all upload workflow steps."""
+
+    def __init__(self, params: Dict, run: UploadRun, client: Any):
+        self.params = params
+        self.run = run
+        self.client = client
+
+        # Core state
+        self.storage = None
+        self.pathlib_cwd = None
+        self.metadata: Dict[str, Dict[str, Any]] = {}
+        self.file_specifications: Dict[str, Any] = {}
+        self.organized_files: List[Dict[str, Any]] = []
+        self.uploaded_files: List[Dict[str, Any]] = []
+        self.data_units: List[Dict[str, Any]] = []
+
+        # Progress and metrics
+        self.metrics: Dict[str, Any] = {}
+        self.errors: List[str] = []
+        self.step_results: List[StepResult] = []
+
+        # Strategies (injected by orchestrator)
+        self.strategies: Dict[str, Any] = {}
+
+        # Rollback information
+        self.rollback_data: Dict[str, Any] = {}
+
+    def update(self, result: StepResult) -> None:
+        """Update context with step results."""
+        self.step_results.append(result)
+
+        if result.success:
+            # Update context state with step data
+            for key, value in result.data.items():
+                if hasattr(self, key):
+                    setattr(self, key, value)
+                else:
+                    # Store in a general data dictionary
+                    if not hasattr(self, 'step_data'):
+                        self.step_data = {}
+                    self.step_data[key] = value
+
+            # Store rollback data
+            if result.rollback_data:
+                self.rollback_data.update(result.rollback_data)
+        else:
+            # Record error
+            if result.error:
+                self.errors.append(result.error)
+
+    def get_result(self) -> Dict[str, Any]:
+        """Get final result dictionary."""
+        return {
+            'uploaded_files_count': len(self.uploaded_files),
+            'generated_data_units_count': len(self.data_units),
+            'success': len(self.errors) == 0,
+            'errors': self.errors,
+            'metrics': self.metrics,
+        }
+
+    def has_errors(self) -> bool:
+        """Check if context has any errors."""
+        return len(self.errors) > 0
+
+    def get_last_step_result(self) -> Optional[StepResult]:
+        """Get the result of the last executed step."""
+        return self.step_results[-1] if self.step_results else None
+
+    def get_step_result_by_name(self, step_name: str) -> Optional[StepResult]:
+        """Get step result by step name (stored in rollback_data)."""
+        for result in self.step_results:
+            if result.rollback_data.get('step_name') == step_name:
+                return result
+        return None
+
+    def clear_errors(self) -> None:
+        """Clear all errors (useful for retry scenarios)."""
+        self.errors.clear()
+
+    def add_error(self, error: str) -> None:
+        """Add an error to the context."""
+        self.errors.append(error)
+
+    def get_param(self, key: str, default: Any = None) -> Any:
+        """Get parameter value with default."""
+        return self.params.get(key, default)
+
+    def set_storage(self, storage: Any) -> None:
+        """Set storage object."""
+        self.storage = storage
+
+    def set_pathlib_cwd(self, path: Path) -> None:
+        """Set current working directory path."""
+        self.pathlib_cwd = path
+
+    def set_file_specifications(self, specs: Dict[str, Any]) -> None:
+        """Set file specifications."""
+        self.file_specifications = specs
+
+    def add_organized_files(self, files: List[Dict[str, Any]]) -> None:
+        """Add organized files to context."""
+        self.organized_files.extend(files)
+
+    def add_uploaded_files(self, files: List[Dict[str, Any]]) -> None:
+        """Add uploaded files to context."""
+        self.uploaded_files.extend(files)
+
+    def add_data_units(self, units: List[Dict[str, Any]]) -> None:
+        """Add data units to context."""
+        self.data_units.extend(units)
+
+    def update_metrics(self, category: str, metrics: Dict[str, Any]) -> None:
+        """Update metrics for a specific category."""
+        if category not in self.metrics:
+            self.metrics[category] = {}
+        self.metrics[category].update(metrics)
+
+    def get(self, key: str, default: Any = None) -> Any:
+        """Get value from context by key."""
+        # First check direct attributes
+        if hasattr(self, key):
+            return getattr(self, key)
+
+        # Then check step_data if it exists
+        if hasattr(self, 'step_data') and key in self.step_data:
+            return self.step_data[key]
+
+        # Special mappings for expected keys
+        if key == 'file_specification_template':
+            return self.file_specifications
+        elif key == 'pathlib_cwd':
+            return self.pathlib_cwd
+        elif key == 'organized_files':
+            return self.organized_files
+
+        return default
+
+    def set(self, key: str, value: Any) -> None:
+        """Set value in context by key."""
+        # Special mappings for expected keys
+        if key == 'file_specification_template':
+            self.file_specifications = value
+        elif key == 'pathlib_cwd':
+            self.pathlib_cwd = value
+        elif key == 'organized_files':
+            self.organized_files = value
+        elif hasattr(self, key):
+            setattr(self, key, value)
+        else:
+            # Store in step_data
+            if not hasattr(self, 'step_data'):
+                self.step_data = {}
+            self.step_data[key] = value

synapse_sdk/plugins/categories/upload/actions/upload/factory.py

@@ -0,0 +1,143 @@
+from typing import Any, Dict
+
+from .strategies.base import (
+    DataUnitStrategy,
+    FileDiscoveryStrategy,
+    MetadataStrategy,
+    UploadStrategy,
+    ValidationStrategy,
+)
+
+
+class StrategyFactory:
+    """Factory for creating strategy instances based on configuration."""
+
+    def __init__(self):
+        self._validation_strategies = {}
+        self._file_discovery_strategies = {}
+        self._metadata_strategies = {}
+        self._upload_strategies = {}
+        self._data_unit_strategies = {}
+
+    def register_validation_strategy(self, name: str, strategy_class: type) -> None:
+        """Register a validation strategy class."""
+        self._validation_strategies[name] = strategy_class
+
+    def register_file_discovery_strategy(self, name: str, strategy_class: type) -> None:
+        """Register a file discovery strategy class."""
+        self._file_discovery_strategies[name] = strategy_class
+
+    def register_metadata_strategy(self, name: str, strategy_class: type) -> None:
+        """Register a metadata strategy class."""
+        self._metadata_strategies[name] = strategy_class
+
+    def register_upload_strategy(self, name: str, strategy_class: type) -> None:
+        """Register an upload strategy class."""
+        self._upload_strategies[name] = strategy_class
+
+    def register_data_unit_strategy(self, name: str, strategy_class: type) -> None:
+        """Register a data unit strategy class."""
+        self._data_unit_strategies[name] = strategy_class
+
+    def create_validation_strategy(self, params: Dict[str, Any], context=None) -> ValidationStrategy:
+        """Create validation strategy based on parameters."""
+        strategy_name = params.get('validation_strategy', 'default')
+
+        if strategy_name not in self._validation_strategies:
+            # Import default strategy if not registered
+            from .strategies.validation.default import DefaultValidationStrategy
+
+            self.register_validation_strategy('default', DefaultValidationStrategy)
+            strategy_name = 'default'
+
+        strategy_class = self._validation_strategies[strategy_name]
+        return strategy_class()
+
+    def create_file_discovery_strategy(self, params: Dict[str, Any], context=None) -> FileDiscoveryStrategy:
+        """Create file discovery strategy based on parameters."""
+        is_recursive = params.get('is_recursive', True)
+        strategy_name = 'recursive' if is_recursive else 'flat'
+
+        if strategy_name not in self._file_discovery_strategies:
+            # Import default strategies if not registered
+            if strategy_name == 'recursive':
+                from .strategies.file_discovery.recursive import RecursiveFileDiscoveryStrategy
+
+                self.register_file_discovery_strategy('recursive', RecursiveFileDiscoveryStrategy)
+            else:
+                from .strategies.file_discovery.flat import FlatFileDiscoveryStrategy
+
+                self.register_file_discovery_strategy('flat', FlatFileDiscoveryStrategy)
+
+        strategy_class = self._file_discovery_strategies[strategy_name]
+        return strategy_class()
+
+    def create_metadata_strategy(self, params: Dict[str, Any], context=None) -> MetadataStrategy:
+        """Create metadata strategy based on parameters."""
+        # Always use Excel strategy for metadata processing
+        # It will handle both specified paths and default meta.xlsx/meta.xls files
+        strategy_name = 'excel'
+
+        if strategy_name not in self._metadata_strategies:
+            from .strategies.metadata.excel import ExcelMetadataStrategy
+
+            self.register_metadata_strategy('excel', ExcelMetadataStrategy)
+
+        strategy_class = self._metadata_strategies[strategy_name]
+        return strategy_class()
+
+    def create_upload_strategy(self, params: Dict[str, Any], context=None) -> UploadStrategy:
+        """Create upload strategy based on parameters."""
+        if context is None:
+            raise ValueError('Upload strategies require context parameter')
+
+        use_async = params.get('use_async_upload', True)
+        strategy_name = 'async' if use_async else 'sync'
+
+        if strategy_name not in self._upload_strategies:
+            # Import default strategies if not registered
+            if strategy_name == 'async':
+                from .strategies.upload.async_upload import AsyncUploadStrategy
+
+                self.register_upload_strategy('async', AsyncUploadStrategy)
+            else:
+                from .strategies.upload.sync import SyncUploadStrategy
+
+                self.register_upload_strategy('sync', SyncUploadStrategy)
+
+        strategy_class = self._upload_strategies[strategy_name]
+        # Upload strategies always need context for client access
+        return strategy_class(context)
+
+    def create_data_unit_strategy(self, params: Dict[str, Any], context=None) -> DataUnitStrategy:
+        """Create data unit strategy based on parameters."""
+        if context is None:
+            raise ValueError('Data unit strategies require context parameter')
+
+        batch_size = params.get('creating_data_unit_batch_size', 1)
+        strategy_name = 'batch' if batch_size > 1 else 'single'
+
+        if strategy_name not in self._data_unit_strategies:
+            # Import default strategies if not registered
+            if strategy_name == 'batch':
+                from .strategies.data_unit.batch import BatchDataUnitStrategy
+
+                self.register_data_unit_strategy('batch', BatchDataUnitStrategy)
+            else:
+                from .strategies.data_unit.single import SingleDataUnitStrategy
+
+                self.register_data_unit_strategy('single', SingleDataUnitStrategy)
+
+        strategy_class = self._data_unit_strategies[strategy_name]
+        # Data unit strategies always need context for client access
+        return strategy_class(context)
+
+    def get_available_strategies(self) -> Dict[str, list]:
+        """Get all available strategy types and their registered names."""
+        return {
+            'validation': list(self._validation_strategies.keys()),
+            'file_discovery': list(self._file_discovery_strategies.keys()),
+            'metadata': list(self._metadata_strategies.keys()),
+            'upload': list(self._upload_strategies.keys()),
+            'data_unit': list(self._data_unit_strategies.keys()),
+        }

synapse_sdk/plugins/categories/upload/actions/upload/models.py

@@ -6,6 +6,7 @@ from pydantic_core import PydanticCustomError
 
 from synapse_sdk.clients.exceptions import ClientError
 from synapse_sdk.utils.pydantic.validators import non_blank
+from synapse_sdk.utils.storage import get_pathlib
 
 from .utils import ExcelSecurityConfig
 
@@ -106,44 +107,80 @@ class UploadParams(BaseModel):
             raise PydanticCustomError('client_error', 'Error occurred while checking project exists.')
         return value
 
-    @field_validator('excel_metadata_path', mode='before')
+    @field_validator('excel_metadata_path', mode='after')
     @classmethod
     def check_excel_metadata_path(cls, value, info: ValidationInfo) -> str | None:
         if not value:
             return value
 
-        excel_path = Path(value)
+        # Validate file extension
+        if not value.lower().endswith(('.xlsx', '.xls')):
+            raise PydanticCustomError('invalid_file_type', 'Excel metadata file must be .xlsx or .xls format.')
 
-        if not excel_path.exists():
-            raise PydanticCustomError('file_not_found', 'Excel metadata file not found.')
+        # Get storage and path from validation data
+        if not (hasattr(info, 'data') and 'storage' in info.data and 'path' in info.data):
+            # If we don't have storage/path data yet, just validate extension
+            return value
 
-        if excel_path.suffix.lower() not in ['.xlsx', '.xls']:
-            raise PydanticCustomError('invalid_file_type', 'Excel metadata file must be .xlsx or .xls format.')
+        if info.context is None:
+            raise PydanticCustomError('missing_context', 'Validation context is required.')
 
-        file_size = excel_path.stat().st_size
-        excel_config = ExcelSecurityConfig()
-        if file_size > excel_config.MAX_FILE_SIZE_BYTES:
-            max_size_mb = excel_config.MAX_FILE_SIZE_MB
-            raise PydanticCustomError(
-                'file_too_large',
-                'Excel metadata file is too large. Maximum size is {max_size_mb}MB.',
-                {'max_size_mb': max_size_mb},
-            )
+        action = info.context['action']
+        client = action.client
 
         try:
-            with open(excel_path, 'rb') as f:
-                header = f.read(8)
-                if not header:
-                    raise PydanticCustomError('invalid_file', 'Excel metadata file appears to be empty.')
-
-                if excel_path.suffix.lower() == '.xlsx':
-                    if not header.startswith(b'PK'):
-                        raise PydanticCustomError('invalid_file', 'Excel metadata file appears to be corrupted.')
-                elif excel_path.suffix.lower() == '.xls':
-                    if not (header.startswith(b'\xd0\xcf\x11\xe0') or header.startswith(b'\x09\x08')):
-                        raise PydanticCustomError('invalid_file', 'Excel metadata file appears to be corrupted.')
-
-        except (OSError, IOError):
-            raise PydanticCustomError('file_access_error', 'Cannot access Excel metadata file.')
+            # Get storage configuration
+            storage_id = info.data['storage']
+            storage = client.get_storage(storage_id)
+
+            # Skip file system validation if storage doesn't have provider (likely test environment)
+            if not isinstance(storage, dict) or 'provider' not in storage:
+                # Basic validation only - likely in test environment
+                return value
+
+            # Get the actual file system path using storage + path
+            base_path = get_pathlib(storage, info.data['path'])
+
+            # Support both absolute and relative paths
+            if Path(value).is_absolute():
+                excel_path = Path(value)
+            else:
+                excel_path = base_path / value
+
+            if not excel_path.exists():
+                raise PydanticCustomError('file_not_found', 'Excel metadata file not found.')
+
+            # Validate file size
+            file_size = excel_path.stat().st_size
+            excel_config = ExcelSecurityConfig()
+            if file_size > excel_config.MAX_FILE_SIZE_BYTES:
+                max_size_mb = excel_config.MAX_FILE_SIZE_MB
+                raise PydanticCustomError(
+                    'file_too_large',
+                    'Excel metadata file is too large. Maximum size is {max_size_mb}MB.',
+                    {'max_size_mb': max_size_mb},
+                )
+
+            # Validate file format
+            try:
+                with open(excel_path, 'rb') as f:
+                    header = f.read(8)
+                    if not header:
+                        raise PydanticCustomError('invalid_file', 'Excel metadata file appears to be empty.')
+
+                    if excel_path.suffix.lower() == '.xlsx':
+                        if not header.startswith(b'PK'):
+                            raise PydanticCustomError('invalid_file', 'Excel metadata file appears to be corrupted.')
+                    elif excel_path.suffix.lower() == '.xls':
+                        if not (header.startswith(b'\xd0\xcf\x11\xe0') or header.startswith(b'\x09\x08')):
+                            raise PydanticCustomError('invalid_file', 'Excel metadata file appears to be corrupted.')
+
+            except (OSError, IOError):
+                raise PydanticCustomError('file_access_error', 'Cannot access Excel metadata file.')
+
+        except ClientError:
+            raise PydanticCustomError('client_error', 'Error occurred while checking storage.')
+        except Exception as e:
+            raise PydanticCustomError('validation_error', f'Error validating Excel metadata file: {str(e)}')
 
         return value

synapse_sdk/plugins/categories/upload/actions/upload/orchestrator.py

@@ -0,0 +1,182 @@
+import traceback
+from typing import Any, Dict, List
+
+from .context import UploadContext
+from .registry import StepRegistry
+from .steps.base import BaseStep
+
+
+class UploadOrchestrator:
+    """Facade that orchestrates the upload workflow using strategies and steps."""
+
+    def __init__(self, context: UploadContext, step_registry: StepRegistry, strategies: Dict[str, Any]):
+        self.context = context
+        self.step_registry = step_registry
+        self.strategies = strategies
+        self.executed_steps: List[BaseStep] = []
+        self.current_step_index = 0
+
+    def execute(self) -> Dict[str, Any]:
+        """Execute the complete upload workflow."""
+        try:
+            self._log_workflow_start()
+            self._inject_strategies_into_context()
+
+            steps = self.step_registry.get_steps()
+            total_steps = len(steps)
+
+            for i, step in enumerate(steps):
+                self.current_step_index = i
+
+                try:
+                    result = step.safe_execute(self.context)
+                    self.context.update(result)
+
+                    if result.success:
+                        if not result.skipped:
+                            self.executed_steps.append(step)
+                        self._update_progress(i + 1, total_steps)
+                    else:
+                        # Step failed, initiate rollback
+                        self._log_step_failure(step, result.error)
+                        self._rollback()
+                        # Re-raise original exception if available, otherwise create new one
+                        if result.original_exception:
+                            raise result.original_exception
+                        else:
+                            raise Exception(f"Step '{step.name}' failed: {result.error}")
+
+                except Exception as e:
+                    self._log_step_exception(step, str(e))
+                    self._rollback()
+                    raise
+
+            self._log_workflow_complete()
+            return self.context.get_result()
+
+        except Exception as e:
+            self._log_workflow_error(str(e))
+            # Ensure rollback is called if not already done
+            if not hasattr(self, '_rollback_executed'):
+                self._rollback()
+            raise
+
+    def _inject_strategies_into_context(self) -> None:
+        """Inject strategies into context for steps to use."""
+        if not hasattr(self.context, 'strategies'):
+            self.context.strategies = {}
+        self.context.strategies.update(self.strategies)
+
+    def _rollback(self) -> None:
+        """Rollback executed steps in reverse order."""
+        if hasattr(self, '_rollback_executed'):
+            return  # Prevent multiple rollbacks
+
+        self._rollback_executed = True
+        self._log_rollback_start()
+
+        # Rollback in reverse order
+        for step in reversed(self.executed_steps):
+            try:
+                self._log_step_rollback(step)
+                step.rollback(self.context)
+            except Exception as e:
+                # Log rollback error but continue with other steps
+                self._log_rollback_error(step, str(e))
+
+        self._log_rollback_complete()
+
+    def _update_progress(self, current_step: int, total_steps: int) -> None:
+        """Update overall progress based on step completion."""
+        if total_steps == 0:
+            return
+
+        # Calculate progress based on step weights
+        completed_weight = 0.0
+        total_weight = self.step_registry.get_total_progress_weight()
+
+        for i, step in enumerate(self.executed_steps):
+            completed_weight += step.progress_weight
+
+        progress_percentage = (completed_weight / total_weight) * 100 if total_weight > 0 else 0
+
+        # Update context with progress information
+        self.context.update_metrics(
+            'workflow',
+            {
+                'current_step': current_step,
+                'total_steps': total_steps,
+                'progress_percentage': progress_percentage,
+                'completed_weight': completed_weight,
+                'total_weight': total_weight,
+            },
+        )
+
+    def _log_workflow_start(self) -> None:
+        """Log workflow start."""
+        steps = self.step_registry.get_steps()
+        step_names = [step.name for step in steps]
+        self.context.run.log_message(f'Starting upload workflow with {len(steps)} steps: {step_names}')
+
+    def _log_workflow_complete(self) -> None:
+        """Log workflow completion."""
+        self.context.run.log_message('Upload workflow completed successfully')
+
+    def _log_workflow_error(self, error: str) -> None:
+        """Log workflow error."""
+        self.context.run.log_message(f'Upload workflow failed: {error}')
+
+    def _log_step_failure(self, step: BaseStep, error: str) -> None:
+        """Log step failure."""
+        self.context.run.log_message(f"Step '{step.name}' failed: {error}")
+
+    def _log_step_exception(self, step: BaseStep, error: str) -> None:
+        """Log step exception."""
+        self.context.run.log_message(f"Exception in step '{step.name}': {error}")
+        # Log full traceback for debugging
+        self.context.run.log_message(f'Traceback: {traceback.format_exc()}')
+
+    def _log_rollback_start(self) -> None:
+        """Log rollback start."""
+        self.context.run.log_message(f'Starting rollback of {len(self.executed_steps)} executed steps')
+
+    def _log_rollback_complete(self) -> None:
+        """Log rollback completion."""
+        self.context.run.log_message('Rollback completed')
+
+    def _log_step_rollback(self, step: BaseStep) -> None:
+        """Log step rollback."""
+        self.context.run.log_message(f'Rolling back step: {step.name}')
+
+    def _log_rollback_error(self, step: BaseStep, error: str) -> None:
+        """Log rollback error."""
+        self.context.run.log_message(f"Error rolling back step '{step.name}': {error}")
+
+    def get_executed_steps(self) -> List[BaseStep]:
+        """Get list of successfully executed steps."""
+        return self.executed_steps.copy()
+
+    def get_current_step_index(self) -> int:
+        """Get current step index."""
+        return self.current_step_index
+
+    def get_total_steps(self) -> int:
+        """Get total number of steps."""
+        return len(self.step_registry.get_steps())
+
+    def is_rollback_executed(self) -> bool:
+        """Check if rollback has been executed."""
+        return hasattr(self, '_rollback_executed')
+
+    def get_workflow_summary(self) -> Dict[str, Any]:
+        """Get workflow execution summary."""
+        steps = self.step_registry.get_steps()
+        return {
+            'total_steps': len(steps),
+            'executed_steps': len(self.executed_steps),
+            'current_step_index': self.current_step_index,
+            'step_names': [step.name for step in steps],
+            'executed_step_names': [step.name for step in self.executed_steps],
+            'rollback_executed': self.is_rollback_executed(),
+            'strategies': list(self.strategies.keys()) if self.strategies else [],
+        }