purreal 0.1.0__tar.gz

purreal-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,70 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[test]"
+    
+    - name: Run tests with coverage
+      run: |
+        pytest --cov=purreal --cov-report=xml --cov-report=term-missing
+    
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  lint:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+        cache: 'pip'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+    
+    - name: Run black
+      run: black --check purreal tests
+    
+    - name: Run ruff
+      run: ruff check purreal tests
+    
+    - name: Run mypy
+      run: mypy purreal --ignore-missing-imports
+      continue-on-error: true

purreal-0.1.0/.gitignore

@@ -0,0 +1,175 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+**/*.ipynb
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

purreal-0.1.0/KNOWN_ISSUES.md

@@ -0,0 +1,141 @@
+# Known Issues
+
+## Critical: Burst Load > max_connections Causes Timeouts
+
+**Status:** Identified, Not Fixed  
+**Severity:** High  
+**Affects:** v0.1.0  
+
+### Description
+
+When burst load exceeds `max_connections` (e.g., 100 concurrent requests with 50 max connections), exactly `max_connections` tasks succeed and the rest timeout after `acquisition_timeout`.
+
+### Symptoms
+
+```
+Burst: 100 concurrent queries, max_connections=50
+Result: 50 succeed, 50 timeout after 30s
+```
+
+**Debug output:**
+```
+POOL DEBUG: Task Task-xxx TIMEOUT acquiring connection after 30.00s
+```
+
+### Root Cause
+
+Waiter notification mechanism has a race condition when many tasks are waiting. Connections are released but waiting tasks are not properly notified, causing them to timeout instead of acquiring the released connections.
+
+**Location:** `purreal/pooler.py` lines 526-531
+```python
+# Notify one waiter if any exist *after* pool state is updated
+if self._connection_waiters:
+    waiter_to_notify = self._connection_waiters.popleft()
+    if not waiter_to_notify.done():
+        waiter_to_notify.set_result(None)
+```
+
+### Workaround
+
+**Option 1: Size pool for peak load**
+```python
+pool = SurrealDBConnectionPool(
+    max_connections=100,  # Set to peak burst size
+    ...
+)
+```
+
+**Option 2: Limit concurrent requests**
+```python
+# Use semaphore to limit concurrency
+semaphore = asyncio.Semaphore(50)  # Match max_connections
+
+async def rate_limited_query():
+    async with semaphore:
+        async with pool.acquire() as conn:
+            await conn.query(...)
+```
+
+**Option 3: Batch requests**
+```python
+# Instead of 100 concurrent
+for batch in chunks(requests, 50):
+    await asyncio.gather(*batch)
+```
+
+### Impact
+
+- ✅ **Sustained load:** Works fine (continuous workers)
+- ✅ **Moderate bursts:** OK if burst ≤ max_connections
+- ❌ **Large bursts:** Fails if burst > max_connections
+- ✅ **Sequential batches:** Works fine
+
+### Scenarios Affected
+
+1. API endpoints receiving sudden traffic spikes > pool size
+2. Background job processing with large queue dumps
+3. Load testing with concurrency > max_connections
+
+### Scenarios NOT Affected
+
+1. Web servers with gradual ramp-up
+2. Continuous background workers
+3. RPC services with connection limits
+4. Applications using semaphores for rate limiting
+
+### Recommended Configuration
+
+```python
+# For production, set max_connections to expected peak + 20%
+expected_peak = 100
+pool = SurrealDBConnectionPool(
+    max_connections=int(expected_peak * 1.2),  # 120
+    acquisition_timeout=15.0,  # Reduce timeout
+    ...
+)
+```
+
+### Fix Plan
+
+1. Investigate waiter notification timing
+2. Consider notifying ALL waiters instead of one
+3. Add tests for burst > max_connections
+4. Validate fix with burst_size=200, max_connections=50
+
+### Testing
+
+To reproduce:
+```bash
+# This will fail
+python -c "
+from purreal import SurrealDBConnectionPool
+import asyncio
+
+async def test():
+    pool = SurrealDBConnectionPool(
+        uri='ws://localhost:8000/rpc',
+        credentials={'username': 'root', 'password': 'root'},
+        namespace='test',
+        database='test',
+        max_connections=50,
+        acquisition_timeout=30.0,
+    )
+    await pool.initialize()
+    
+    async def query(i):
+        async with pool.acquire() as conn:
+            await conn.query('RETURN 1')
+    
+    # 100 concurrent (2x pool size) - 50 will timeout
+    tasks = [query(i) for i in range(100)]
+    await asyncio.gather(*tasks, return_exceptions=True)
+    await pool.close()
+
+asyncio.run(test())
+"
+```
+
+---
+
+**Reported:** 2025-11-09  
+**Tracked:** https://github.com/dyleeeeeeee/purreal/issues/XXX