plan-flow-skill 1.0.0

package/rules/patterns/plans-templates.mdc

@@ -0,0 +1,237 @@
+---
+description: "Templates for implementation plans"
+alwaysApply: false
+---
+
+# Plan Templates
+
+This document contains templates for creating implementation plans. For patterns and rules, see `.cursor/rules/patterns/plans-patterns.mdc`.
+
+---
+
+## Plan Template
+
+Use this template when creating new implementation plans:
+
+```markdown
+# Plan: [Feature Name]
+
+## Overview
+
+[Brief description of the feature and its purpose]
+
+**Based on Discovery**: `flow/discovery/discovery_<feature>_v1.md` (or "Discovery skipped")
+
+## Goals
+
+- [Goal 1]
+- [Goal 2]
+- [Goal 3]
+
+## Non-Goals
+
+- [What this plan explicitly does NOT cover]
+
+## Requirements Summary
+
+### Functional Requirements
+
+- [FR-1]: [Description]
+- [FR-2]: [Description]
+
+### Non-Functional Requirements
+
+- [NFR-1]: [Description]
+
+### Constraints
+
+- [C-1]: [Description]
+
+## Risks
+
+| Risk     | Impact          | Mitigation           |
+| -------- | --------------- | -------------------- |
+| [Risk 1] | High/Medium/Low | [Mitigation strategy]|
+
+## Phases
+
+### Phase 1: [Phase Name]
+
+**Scope**: [What this phase covers]
+**Complexity**: X/10
+
+- [ ] Task 1
+- [ ] Task 2
+
+**Build Verification**: Run `npm run build`
+
+### Phase 2: [Phase Name]
+
+**Scope**: [What this phase covers]
+**Complexity**: X/10
+
+- [ ] Task 1
+- [ ] Task 2
+
+**Build Verification**: Run `npm run build`
+
+### Phase N: Tests (Final)
+
+**Scope**: Write comprehensive tests
+**Complexity**: X/10
+
+- [ ] Unit tests for logic hooks
+- [ ] Unit tests for utilities
+- [ ] Integration tests
+
+**Build Verification**: Run `npm run build && npm run test`
+
+## Key Changes
+
+1. **[Category]**: [Description of change]
+2. **[Category]**: [Description of change]
+3. **[Category]**: [Description of change]
+```
+
+---
+
+## Phase Templates
+
+### Types and Schemas Phase
+
+```markdown
+### Phase 1: Types and Schemas
+
+**Scope**: Define all TypeScript types and Zod schemas needed for the feature.
+**Complexity**: 3/10
+
+- [ ] Create type definitions in `/src/types/`
+- [ ] Create Zod validation schemas in `/src/types/rest-inputs.ts`
+
+**Build Verification**: Run `npm run build`
+```
+
+### Backend Implementation Phase
+
+```markdown
+### Phase 2: Backend Implementation
+
+**Scope**: Implement API routes and commands.
+**Complexity**: 7/10
+
+- [ ] Create command in `/src/commands/`
+- [ ] Create API route in `/src/app/api/`
+- [ ] Add database operations if needed
+
+**Build Verification**: Run `npm run build`
+```
+
+### Store and State Management Phase
+
+```markdown
+### Phase 3: Store and State Management
+
+**Scope**: Implement Zustand stores for state management.
+**Complexity**: 5/10
+
+- [ ] Create or extend store in `/src/stores/`
+- [ ] Add actions and selectors
+
+**Build Verification**: Run `npm run build`
+```
+
+### UI Components Phase
+
+```markdown
+### Phase 4: UI Components
+
+**Scope**: Build the user interface components.
+**Complexity**: 6/10
+
+- [ ] Create logic hook (`useFeatureLogic.internal.ts`)
+- [ ] Create view component (`index.tsx`)
+- [ ] Follow view/logic separation pattern
+
+**Build Verification**: Run `npm run build`
+```
+
+### Integration Phase
+
+```markdown
+### Phase 5: Integration
+
+**Scope**: Connect all pieces and verify functionality.
+**Complexity**: 4/10
+
+- [ ] Integrate components with pages
+- [ ] Connect to API endpoints
+- [ ] Verify end-to-end flow
+
+**Build Verification**: Run `npm run build`
+```
+
+### Tests Phase (Always Last)
+
+```markdown
+### Phase N: Tests (Final)
+
+**Scope**: Write comprehensive tests for all new code.
+**Complexity**: 5/10
+
+- [ ] Unit tests for logic hooks (`*.client.test.ts`)
+- [ ] Unit tests for utility functions
+- [ ] Integration tests for API routes
+- [ ] Command tests
+
+**Build Verification**: Run `npm run build && npm run test`
+```
+
+---
+
+## Key Changes Examples
+
+```markdown
+## Key Changes
+
+1. **New API Endpoint**: Added `/api/v1/agents/workflow` for workflow management
+2. **Database Schema**: New `workflow_steps` table with foreign key to `agents`
+3. **Store Update**: Extended `agentStore` with workflow state management
+4. **Component Addition**: New `WorkflowEditor` component in `/src/components/agent/`
+5. **Type Definitions**: Added `WorkflowStep` and `WorkflowConfig` types in `/src/types/workflow.ts`
+```
+
+---
+
+## Complexity Summary Example
+
+```markdown
+## Complexity Summary
+
+| Phase | Complexity | Description               |
+| ----- | ---------- | ------------------------- |
+| 1     | 3/10       | Types and schemas         |
+| 2     | 7/10       | Backend implementation    |
+| 3     | 5/10       | Store and state           |
+| 4     | 6/10       | UI components             |
+| 5     | 4/10       | Integration               |
+| 6     | 5/10       | Tests                     |
+
+**Total Phases**: 6
+**Average Complexity**: 5/10
+**Highest Complexity**: Phase 2 at 7/10
+```
+
+---
+
+## Execution Strategy Example
+
+```markdown
+## Execution Strategy
+
+Based on complexity scores (per `.cursor/rules/core/complexity-scoring.mdc`):
+
+- **Phases 1-2**: Execute separately (Phase 2 is 7/10)
+- **Phases 3-4**: Can be aggregated (combined complexity: 11, but cautious)
+- **Phase 5**: Can aggregate with Phase 6 if simple
+- **Phase 6**: Tests - always execute separately
+```

package/rules/patterns/pytest-patterns.mdc

@@ -0,0 +1,467 @@
+---
+description: "Patterns and conventions for writing pytest tests in Python"
+alwaysApply: false
+---
+
+# Pytest Testing Patterns
+
+Patterns and conventions for writing pytest tests in Python codebases, ensuring consistency, maintainability, and comprehensive coverage.
+
+---
+
+## File Naming Conventions
+
+| Pattern | Purpose |
+| ------- | ------- |
+| `test_*.py` | Test modules (preferred) |
+| `*_test.py` | Alternative test module naming |
+| `conftest.py` | Shared fixtures for a directory |
+
+**Directory Structure**:
+
+```
+src/
+├── mymodule/
+│   ├── __init__.py
+│   ├── service.py
+│   └── utils.py
+tests/
+├── conftest.py           # Root fixtures
+├── test_service.py       # Tests for service.py
+├── test_utils.py         # Tests for utils.py
+└── integration/
+    ├── conftest.py       # Integration-specific fixtures
+    └── test_api.py
+```
+
+---
+
+## Test Structure
+
+Use descriptive function names and organize with classes when grouping:
+
+```python
+import pytest
+from mymodule.service import UserService
+from mymodule.errors import NotFoundError
+
+
+class TestUserService:
+    """Tests for UserService class."""
+
+    def test_get_user_returns_user_when_exists(self, mock_db):
+        """Should return user data when user exists in database."""
+        # Arrange
+        mock_db.find_user.return_value = {"id": "user-1", "name": "Test User"}
+        service = UserService(mock_db)
+
+        # Act
+        result = service.get_user("user-1")
+
+        # Assert
+        assert result["id"] == "user-1"
+        assert result["name"] == "Test User"
+        mock_db.find_user.assert_called_once_with("user-1")
+
+    def test_get_user_raises_not_found_when_missing(self, mock_db):
+        """Should raise NotFoundError when user doesn't exist."""
+        mock_db.find_user.return_value = None
+        service = UserService(mock_db)
+
+        with pytest.raises(NotFoundError) as exc_info:
+            service.get_user("nonexistent")
+
+        assert "user-1" in str(exc_info.value)
+```
+
+---
+
+## Fixtures
+
+Use fixtures for reusable test setup:
+
+```python
+# conftest.py - Shared fixtures
+import pytest
+from unittest.mock import Mock, MagicMock, AsyncMock
+
+
+@pytest.fixture
+def mock_db():
+    """Provides a mocked database connection."""
+    db = Mock()
+    db.find_user = Mock()
+    db.create_user = Mock()
+    db.update_user = Mock()
+    return db
+
+
+@pytest.fixture
+def mock_user():
+    """Provides a mock user object."""
+    return {
+        "id": "user-1",
+        "email": "test@example.com",
+        "name": "Test User",
+        "created_at": "2024-01-01T00:00:00Z",
+    }
+
+
+@pytest.fixture
+def mock_chat(mock_user):
+    """Provides a mock chat with users."""
+    return {
+        "id": "chat-1",
+        "name": "Test Chat",
+        "tenant_id": "tenant-1",
+        "users": [mock_user],
+    }
+
+
+@pytest.fixture
+async def mock_async_client():
+    """Provides an async HTTP client mock."""
+    client = AsyncMock()
+    client.get = AsyncMock()
+    client.post = AsyncMock()
+    return client
+```
+
+---
+
+## Factory Fixtures
+
+Create parameterized factory fixtures for flexibility:
+
+```python
+@pytest.fixture
+def create_mock_user():
+    """Factory fixture for creating mock users with custom attributes."""
+    def _create_user(**overrides):
+        defaults = {
+            "id": "user-1",
+            "email": "test@example.com",
+            "name": "Test User",
+            "active": True,
+            "created_at": "2024-01-01T00:00:00Z",
+        }
+        return {**defaults, **overrides}
+    return _create_user
+
+
+@pytest.fixture
+def create_mock_message(create_mock_user):
+    """Factory fixture for creating mock messages."""
+    def _create_message(**overrides):
+        defaults = {
+            "id": "msg-1",
+            "chat_id": "chat-1",
+            "user": create_mock_user(),
+            "content": "Test message",
+            "role": "user",
+        }
+        return {**defaults, **overrides}
+    return _create_message
+
+
+# Usage in tests
+def test_message_creation(create_mock_message):
+    message = create_mock_message(content="Custom content", role="assistant")
+    assert message["content"] == "Custom content"
+    assert message["role"] == "assistant"
+```
+
+---
+
+## Mocking
+
+### Basic Mocking with unittest.mock
+
+```python
+from unittest.mock import Mock, MagicMock, patch, AsyncMock
+
+
+class TestStreamService:
+    def test_stream_response_success(self):
+        """Should stream response from engine."""
+        mock_engine = Mock()
+        mock_engine.stream_response.return_value = iter(["chunk1", "chunk2"])
+        
+        service = StreamService(mock_engine)
+        result = list(service.stream("Hello"))
+        
+        assert result == ["chunk1", "chunk2"]
+        mock_engine.stream_response.assert_called_once_with("Hello")
+
+    @patch("mymodule.service.JupiterEngineAPI")
+    def test_with_patched_dependency(self, MockEngineAPI):
+        """Should use patched engine API."""
+        mock_instance = MockEngineAPI.return_value
+        mock_instance.get_agent.return_value = {"id": "agent-1"}
+        
+        service = AgentService()
+        result = service.get_agent("agent-1")
+        
+        assert result["id"] == "agent-1"
+```
+
+### Async Mocking
+
+```python
+import pytest
+from unittest.mock import AsyncMock, patch
+
+
+class TestAsyncOperations:
+    @pytest.mark.asyncio
+    async def test_async_fetch_data(self):
+        """Should fetch data asynchronously."""
+        mock_client = AsyncMock()
+        mock_client.get.return_value = {"data": "test"}
+        
+        service = AsyncService(mock_client)
+        result = await service.fetch_data("endpoint")
+        
+        assert result["data"] == "test"
+        mock_client.get.assert_awaited_once_with("endpoint")
+
+    @pytest.mark.asyncio
+    @patch("mymodule.service.aiohttp.ClientSession")
+    async def test_with_patched_async_client(self, MockSession):
+        """Should work with patched async client."""
+        mock_session = AsyncMock()
+        mock_response = AsyncMock()
+        mock_response.json.return_value = {"status": "ok"}
+        mock_session.get.return_value.__aenter__.return_value = mock_response
+        MockSession.return_value.__aenter__.return_value = mock_session
+        
+        result = await fetch_external_data()
+        assert result["status"] == "ok"
+```
+
+---
+
+## Parametrized Tests
+
+Use `@pytest.mark.parametrize` for testing multiple cases:
+
+```python
+import pytest
+
+
+class TestValidator:
+    @pytest.mark.parametrize("email,expected", [
+        ("test@example.com", True),
+        ("user@domain.org", True),
+        ("invalid-email", False),
+        ("@no-local-part.com", False),
+        ("no-domain@", False),
+        ("", False),
+    ])
+    def test_email_validation(self, email, expected):
+        """Should correctly validate email addresses."""
+        result = validate_email(email)
+        assert result == expected
+
+    @pytest.mark.parametrize("input_data,error_type", [
+        ({"chat_id": None}, ValueError),
+        ({"messages": []}, EmptyMessagesError),
+        ({"tenant_id": ""}, InvalidTenantError),
+    ])
+    def test_input_validation_errors(self, input_data, error_type):
+        """Should raise appropriate errors for invalid inputs."""
+        with pytest.raises(error_type):
+            validate_input(input_data)
+```
+
+---
+
+## Testing Exceptions
+
+```python
+import pytest
+from mymodule.errors import NotFoundError, ForbiddenError
+
+
+class TestErrorHandling:
+    def test_raises_not_found_error(self, mock_db):
+        """Should raise NotFoundError when resource doesn't exist."""
+        mock_db.find.return_value = None
+        service = MyService(mock_db)
+
+        with pytest.raises(NotFoundError) as exc_info:
+            service.get_item("nonexistent")
+
+        assert exc_info.value.resource_id == "nonexistent"
+        assert "not found" in str(exc_info.value).lower()
+
+    def test_raises_forbidden_with_details(self, mock_db):
+        """Should raise ForbiddenError with proper details."""
+        mock_db.check_permission.return_value = False
+        service = MyService(mock_db)
+
+        with pytest.raises(ForbiddenError) as exc_info:
+            service.access_resource("resource-1", user_id="user-1")
+
+        error = exc_info.value
+        assert error.reason == "INSUFFICIENT_PERMISSIONS"
+        assert error.user_id == "user-1"
+```
+
+---
+
+## Testing Context Managers
+
+```python
+from contextlib import contextmanager
+from unittest.mock import Mock
+
+
+class TestContextManager:
+    def test_database_transaction(self, mock_db):
+        """Should properly manage database transaction."""
+        mock_db.begin_transaction = Mock()
+        mock_db.commit = Mock()
+        mock_db.rollback = Mock()
+
+        with database_transaction(mock_db) as tx:
+            tx.execute("INSERT INTO users ...")
+
+        mock_db.begin_transaction.assert_called_once()
+        mock_db.commit.assert_called_once()
+        mock_db.rollback.assert_not_called()
+
+    def test_transaction_rollback_on_error(self, mock_db):
+        """Should rollback transaction on error."""
+        mock_db.begin_transaction = Mock()
+        mock_db.commit = Mock()
+        mock_db.rollback = Mock()
+
+        with pytest.raises(ValueError):
+            with database_transaction(mock_db) as tx:
+                raise ValueError("Simulated error")
+
+        mock_db.rollback.assert_called_once()
+        mock_db.commit.assert_not_called()
+```
+
+---
+
+## Async Testing
+
+```python
+import pytest
+import asyncio
+
+
+class TestAsyncService:
+    @pytest.mark.asyncio
+    async def test_async_operation_success(self, mock_async_client):
+        """Should complete async operation successfully."""
+        mock_async_client.post.return_value = {"status": "success"}
+        
+        service = AsyncService(mock_async_client)
+        result = await service.create_resource({"name": "test"})
+        
+        assert result["status"] == "success"
+
+    @pytest.mark.asyncio
+    async def test_concurrent_operations(self):
+        """Should handle concurrent operations correctly."""
+        async def mock_operation(delay, value):
+            await asyncio.sleep(delay)
+            return value
+
+        results = await asyncio.gather(
+            mock_operation(0.1, "first"),
+            mock_operation(0.05, "second"),
+            mock_operation(0.15, "third"),
+        )
+
+        assert results == ["first", "second", "third"]
+
+    @pytest.mark.asyncio
+    async def test_async_timeout(self, mock_async_client):
+        """Should handle timeout correctly."""
+        mock_async_client.get.side_effect = asyncio.TimeoutError()
+        
+        service = AsyncService(mock_async_client)
+        
+        with pytest.raises(ServiceTimeoutError):
+            await service.fetch_with_timeout("endpoint", timeout=1.0)
+```
+
+---
+
+## Test Naming
+
+- Use descriptive names that explain the expected behavior
+- Describe the outcome in the function name
+- Include context about the scenario
+
+```python
+# Good
+def test_raises_not_found_error_when_chat_missing(self):
+def test_extracts_text_from_multipart_message(self):
+
+# Bad
+def test_1(self):
+def test_chat(self):
+```
+
+---
+
+## Forbidden Patterns
+
+### DON'T Share State Between Tests
+
+```python
+# BAD - Shared mutable state
+class TestService:
+    shared_data = []  # Dangerous!
+
+    def test_one(self):
+        self.shared_data.append("item")
+
+    def test_two(self):
+        # Depends on test_one running first
+        assert len(self.shared_data) == 1
+
+# GOOD - Fresh fixtures
+@pytest.fixture
+def data_list():
+    return []
+
+def test_one(data_list):
+    data_list.append("item")
+    assert len(data_list) == 1
+
+def test_two(data_list):
+    assert len(data_list) == 0  # Fresh list
+```
+
+### DON'T Write Tests That Always Pass
+
+```python
+# BAD - No real assertion
+def test_something():
+    some_function()
+    assert True
+
+# GOOD - Meaningful assertion
+def test_returns_expected_data():
+    result = some_function()
+    assert result.data == expected_data
+```
+
+---
+
+## Summary
+
+Following these testing patterns ensures:
+
+- **Consistency**: Same patterns across the codebase
+- **Maintainability**: Tests are easy to understand and update
+- **Reliability**: Tests are isolated and deterministic
+- **Coverage**: Edge cases and errors are tested
+- **Speed**: Tests run efficiently with proper mocking