devforgeai 1.0.4 → 1.0.6

package/src/claude/scripts/devforgeai_cli/feedback/skip_tracker.py

@@ -0,0 +1,177 @@
+"""
+Skip tracking system for feedback collection.
+
+This module provides atomic operations for tracking consecutive skips,
+with thread-safe operations and resetting on positive feedback.
+"""
+
+import os
+import threading
+from pathlib import Path
+from typing import Optional, Dict
+from datetime import datetime
+
+
+class SkipTracker:
+    """Tracks consecutive skips for feedback collection.
+
+    Provides thread-safe atomic operations for incrementing skip counters,
+    checking limits, and resetting based on positive feedback.
+    """
+
+    # Default log path for skip tracking
+    DEFAULT_SKIP_LOG_PATH = Path("devforgeai/logs/feedback-skips.log")
+    # Default rating threshold for "positive" feedback
+    DEFAULT_RATING_THRESHOLD = 4
+
+    def __init__(self, skip_log_path: Optional[Path] = None):
+        """Initialize the skip tracker.
+
+        Args:
+            skip_log_path: Path to skip tracking log file.
+                          Defaults to devforgeai/logs/feedback-skips.log
+        """
+        if skip_log_path is None:
+            skip_log_path = self.DEFAULT_SKIP_LOG_PATH
+
+        self.skip_log_path = skip_log_path
+        self._skip_counters: Dict[str, int] = {}
+        self._lock = threading.Lock()
+        self._load_existing_counters()
+
+    def _load_existing_counters(self) -> None:
+        """Load skip counters from log file if it exists."""
+        if self.skip_log_path.exists():
+            try:
+                with open(self.skip_log_path, 'r') as f:
+                    for line in f:
+                        line = line.strip()
+                        if not line or line.startswith("#"):
+                            continue
+                        parts = line.split(":")
+                        if len(parts) >= 3:
+                            # Format: timestamp:operation:count
+                            operation = parts[1].strip()
+                            try:
+                                count = int(parts[2].split(",")[0].strip())
+                                self._skip_counters[operation] = count
+                            except (ValueError, IndexError):
+                                pass
+            except (IOError, OSError):
+                # File read error - continue with empty counters
+                pass
+
+    def _ensure_log_directory(self) -> None:
+        """Ensure the logs directory exists."""
+        self.skip_log_path.parent.mkdir(parents=True, exist_ok=True)
+
+    def _log_skip_operation(self, operation: str, count: int, action: str) -> None:
+        """Log a skip operation to the tracking file.
+
+        Args:
+            operation: Name of the operation.
+            count: Current skip count.
+            action: Action performed (skip, reset, block).
+        """
+        self._ensure_log_directory()
+        timestamp = datetime.now().isoformat()
+        try:
+            with open(self.skip_log_path, 'a') as f:
+                f.write(f"{timestamp}: {operation}: {count}, action={action}\n")
+        except (IOError, OSError):
+            # Silently fail if log write fails
+            pass
+
+    def increment_skip(self, operation: str) -> int:
+        """Increment skip counter for an operation (thread-safe).
+
+        Args:
+            operation: Name of the operation that was skipped.
+
+        Returns:
+            Updated skip count for the operation.
+        """
+        with self._lock:
+            current = self._skip_counters.get(operation, 0)
+            current += 1
+            self._skip_counters[operation] = current
+            self._log_skip_operation(operation, current, "skip")
+            return current
+
+    def get_skip_count(self, operation: str) -> int:
+        """Get current skip count for an operation (thread-safe).
+
+        Args:
+            operation: Name of the operation.
+
+        Returns:
+            Current skip count (0 if never skipped).
+        """
+        with self._lock:
+            return self._skip_counters.get(operation, 0)
+
+    def reset_skip_counter(self, operation: str) -> None:
+        """Reset skip counter for an operation (thread-safe).
+
+        Args:
+            operation: Name of the operation.
+        """
+        with self._lock:
+            if operation in self._skip_counters:
+                self._skip_counters[operation] = 0
+                self._log_skip_operation(operation, 0, "reset")
+
+    def check_skip_limit(self, operation: str, max_consecutive_skips: int) -> bool:
+        """Check if skip limit has been reached (thread-safe).
+
+        Args:
+            operation: Name of the operation.
+            max_consecutive_skips: Maximum allowed consecutive skips.
+                                   0 = unlimited.
+
+        Returns:
+            True if limit reached (should block), False otherwise.
+                Returns False if max_consecutive_skips is 0 (unlimited).
+        """
+        if max_consecutive_skips == 0:
+            # Unlimited skips
+            return False
+
+        with self._lock:
+            count = self._skip_counters.get(operation, 0)
+            if count >= max_consecutive_skips:
+                self._log_skip_operation(operation, count, "block")
+                return True
+            return False
+
+    def reset_on_positive(self, operation: str, rating: int, rating_threshold: Optional[int] = None) -> None:
+        """Reset skip counter if positive feedback received (thread-safe).
+
+        Args:
+            operation: Name of the operation.
+            rating: User's feedback rating/score.
+            rating_threshold: Rating value above which is considered positive.
+                            Defaults to DEFAULT_RATING_THRESHOLD.
+        """
+        if rating_threshold is None:
+            rating_threshold = self.DEFAULT_RATING_THRESHOLD
+
+        if rating >= rating_threshold:
+            self.reset_skip_counter(operation)
+
+    def get_all_counters(self) -> Dict[str, int]:
+        """Get copy of all skip counters (thread-safe).
+
+        Returns:
+            Dictionary of operation -> skip count.
+        """
+        with self._lock:
+            return self._skip_counters.copy()
+
+    def clear_all_counters(self) -> None:
+        """Clear all skip counters (thread-safe).
+
+        Used for testing and reset scenarios.
+        """
+        with self._lock:
+            self._skip_counters.clear()

package/src/claude/scripts/devforgeai_cli/feedback/skip_tracking.py

@@ -0,0 +1,221 @@
+"""
+Skip tracking functionality.
+
+Tracks when users skip feedback and triggers suggestions after 3+ consecutive skips.
+"""
+
+import yaml
+import os
+import logging
+from pathlib import Path
+from typing import Optional, Callable
+
+
+# Configure logging
+logger = logging.getLogger(__name__)
+
+
+# ============================================================================
+# CONFIG FILE I/O (Private)
+# ============================================================================
+
+def _get_config_file(config_dir: Optional[Path] = None) -> Path:
+    """
+    Get feedback config file path.
+
+    Args:
+        config_dir: Config directory (default: devforgeai/config)
+
+    Returns:
+        Path to feedback-preferences.yaml (per STORY-009 specification)
+    """
+    if config_dir is None:
+        config_dir = Path.cwd() / 'devforgeai' / 'config'
+
+    config_dir.mkdir(parents=True, exist_ok=True)
+    return config_dir / 'feedback-preferences.yaml'
+
+
+def _load_config(config_file: Path) -> dict:
+    """
+    Load config from YAML file.
+
+    Args:
+        config_file: Path to config file
+
+    Returns:
+        Config dictionary (defaults to empty skip_counts if missing)
+    """
+    if not config_file.exists():
+        return {'skip_counts': {}}
+
+    with open(config_file, 'r') as f:
+        config = yaml.safe_load(f)
+
+    return config or {'skip_counts': {}}
+
+
+def _save_config(config: dict, config_file: Path) -> None:
+    """
+    Save config to YAML file with proper permissions.
+
+    Sets file permissions to mode 600 (user-readable/writable only).
+
+    Args:
+        config: Config dictionary
+        config_file: Path to config file
+    """
+    with open(config_file, 'w') as f:
+        yaml.safe_dump(config, f, default_flow_style=False)
+
+    # Set file permissions to 600 (user read/write only)
+    try:
+        os.chmod(config_file, 0o600)
+        logger.debug(f"Set config file permissions to 600: {config_file}")
+    except OSError as e:
+        logger.warning(f"Could not set config file permissions: {e}")
+
+
+def validate_config_permissions(config_file: Path) -> bool:
+    """
+    Validate that config file has appropriate permissions (mode 600).
+
+    Args:
+        config_file: Path to config file
+
+    Returns:
+        True if permissions are 600, False otherwise
+    """
+    if not config_file.exists():
+        return True  # File doesn't exist yet
+
+    try:
+        file_stat = config_file.stat()
+        # Extract permission bits
+        permissions = file_stat.st_mode & 0o777
+        is_valid = permissions == 0o600
+
+        if not is_valid:
+            logger.warning(
+                f"Config file has insecure permissions: "
+                f"{oct(permissions)} (should be 0o600)"
+            )
+
+        return is_valid
+    except OSError as e:
+        logger.warning(f"Could not validate config file permissions: {e}")
+        return False
+
+
+def _apply_config_modification(config_file: Path, modifier_fn: Callable[[dict], dict]) -> None:
+    """
+    Apply modification to config atomically (DRY helper).
+
+    Encapsulates read-modify-write pattern to reduce duplication.
+
+    Args:
+        config_file: Path to config file
+        modifier_fn: Function that receives config dict and returns modified dict
+    """
+    config = _load_config(config_file)
+    modified_config = modifier_fn(config)
+    _save_config(modified_config, config_file)
+
+
+# ============================================================================
+# SKIP COUNTER OPERATIONS (Public)
+# ============================================================================
+
+def increment_skip(operation_type: str, config_dir: Optional[Path] = None) -> int:
+    """
+    Increment skip count for operation type.
+
+    Args:
+        operation_type: Operation type (e.g., 'skill_invocation', 'subagent_invocation')
+        config_dir: Config directory
+
+    Returns:
+        New skip count
+    """
+    config_file = _get_config_file(config_dir)
+
+    def modify_config(config):
+        if 'skip_counts' not in config:
+            config['skip_counts'] = {}
+
+        current_count = config['skip_counts'].get(operation_type, 0)
+        new_count = current_count + 1
+        config['skip_counts'][operation_type] = new_count
+        return config
+
+    _apply_config_modification(config_file, modify_config)
+
+    # Reload to get updated count
+    config = _load_config(config_file)
+    return config['skip_counts'][operation_type]
+
+
+def get_skip_count(operation_type: str, config_dir: Optional[Path] = None) -> int:
+    """
+    Get current skip count for operation type.
+
+    Args:
+        operation_type: Operation type (e.g., 'skill_invocation', 'subagent_invocation')
+        config_dir: Config directory
+
+    Returns:
+        Current skip count
+    """
+    config_file = _get_config_file(config_dir)
+    config = _load_config(config_file)
+    return config.get('skip_counts', {}).get(operation_type, 0)
+
+
+def reset_skip_count(operation_type: str, config_dir: Optional[Path] = None) -> None:
+    """
+    Reset skip count for operation type to 0.
+
+    Args:
+        operation_type: Operation type (e.g., 'skill_invocation', 'subagent_invocation')
+        config_dir: Config directory
+    """
+    config_file = _get_config_file(config_dir)
+
+    def modify_config(config):
+        if 'skip_counts' not in config:
+            config['skip_counts'] = {}
+
+        config['skip_counts'][operation_type] = 0
+        return config
+
+    _apply_config_modification(config_file, modify_config)
+
+
+def check_skip_threshold(operation_type: str, threshold: int = 3, config_dir: Optional[Path] = None) -> bool:
+    """
+    Check if operation type has reached skip threshold.
+
+    Args:
+        operation_type: Operation type (e.g., 'skill_invocation', 'subagent_invocation')
+        threshold: Skip threshold (default: 3)
+        config_dir: Config directory
+
+    Returns:
+        True if threshold reached, False otherwise
+    """
+    count = get_skip_count(operation_type, config_dir)
+    return count >= threshold
+
+
+# ============================================================================
+# PUBLIC API (Export for external use)
+# ============================================================================
+
+__all__ = [
+    'increment_skip',
+    'get_skip_count',
+    'reset_skip_count',
+    'check_skip_threshold',
+    'validate_config_permissions',
+]
+