vectorwave 0.1.4__tar.gz → 0.1.6__tar.gz

{vectorwave-0.1.4/src/vectorwave.egg-info → vectorwave-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vectorwave
-Version: 0.1.4
+Version: 0.1.6
 Summary: VectorWave: Seamless Auto-Vectorization Framework
 Author-email: junyeonggim <junyeonggim5@gmail.com>
 License-Expression: MIT
@@ -20,6 +20,7 @@ License-File: NOTICE
 Requires-Dist: weaviate-client>=4.0.0
 Requires-Dist: pydantic-settings>=2.0.0
 Requires-Dist: sentence-transformers
+Requires-Dist: requests
 Dynamic: license-file
 
 
@@ -395,7 +396,6 @@ def other_function():
     pass
 ```
 
-**Tag Merging and Validation Rules**
 
 1.  **Validation (Important):** Tags (global or function-specific) will **only** be saved to Weaviate if their key (e.g., `run_id`, `team`, `priority`) was first defined in the `.weaviate_properties` file (Step 1). Tags not defined in the schema are **ignored**, and a warning is logged at startup.
 
@@ -408,6 +408,34 @@ def other_function():
 
 -----
 
+### 🚀 Real-time Error Alerting (Webhook)
+
+Beyond just logging, `VectorWave` can send **real-time notifications via webhook** the instant an error occurs. This functionality is built directly into the tracer and can be activated simply by updating your `.env` file.
+
+**How it Works:**
+1.  An exception is raised within a function decorated by `@trace_span` or `@vectorize`.
+2.  The tracer catches the exception in its `except` block and immediately calls the `alerter` object.
+3.  The alerter reads the `.env` configuration and uses the `WebhookAlerter` to dispatch the error details to your specified URL.
+4.  The notification is optimized for **Discord Embeds**, sending a rich report including the error code, trace ID, captured attributes (`user_id`, etc.), and the full stack trace.
+
+**How to Enable:**
+Add the following two variables to your `test_ex/.env` file (or environment variables):
+
+```ini
+# .env file
+
+# 1. Set the alerter strategy to 'webhook'. (Default: "none")
+ALERTER_STRATEGY="webhook"
+
+# 2. Provide your webhook URL from Discord, Slack, etc.
+ALERTER_WEBHOOK_URL="[https://discord.com/api/webhooks/YOUR_HOOK_ID/](https://discord.com/api/webhooks/YOUR_HOOK_ID/)..."
+With just these two lines, running test_ex/example.py will now instantly send a Discord alert when the CustomValueError is raised.
+
+Extensibility (Strategy Pattern): The alerting system is built on a Strategy Pattern. You can easily extend it by implementing the BaseAlerter interface to support other channels like email, PagerDuty, or more.
+
+**Tag Merging and Validation Rules**
+```
+
 ## 🤝 Contributing
 
 Bug reports, feature requests, and code contributions are all welcome. For details, please see [CONTRIBUTING.md](https://www.google.com/search?q=httpsS://www.google.com/search%3Fq%3DCONTRIBUTING.md).

{vectorwave-0.1.4 → vectorwave-0.1.6}/Readme.md

@@ -371,7 +371,6 @@ def other_function():
     pass
 ```
 
-**Tag Merging and Validation Rules**
 
 1.  **Validation (Important):** Tags (global or function-specific) will **only** be saved to Weaviate if their key (e.g., `run_id`, `team`, `priority`) was first defined in the `.weaviate_properties` file (Step 1). Tags not defined in the schema are **ignored**, and a warning is logged at startup.
 
@@ -384,6 +383,34 @@ def other_function():
 
 -----
 
+### 🚀 Real-time Error Alerting (Webhook)
+
+Beyond just logging, `VectorWave` can send **real-time notifications via webhook** the instant an error occurs. This functionality is built directly into the tracer and can be activated simply by updating your `.env` file.
+
+**How it Works:**
+1.  An exception is raised within a function decorated by `@trace_span` or `@vectorize`.
+2.  The tracer catches the exception in its `except` block and immediately calls the `alerter` object.
+3.  The alerter reads the `.env` configuration and uses the `WebhookAlerter` to dispatch the error details to your specified URL.
+4.  The notification is optimized for **Discord Embeds**, sending a rich report including the error code, trace ID, captured attributes (`user_id`, etc.), and the full stack trace.
+
+**How to Enable:**
+Add the following two variables to your `test_ex/.env` file (or environment variables):
+
+```ini
+# .env file
+
+# 1. Set the alerter strategy to 'webhook'. (Default: "none")
+ALERTER_STRATEGY="webhook"
+
+# 2. Provide your webhook URL from Discord, Slack, etc.
+ALERTER_WEBHOOK_URL="[https://discord.com/api/webhooks/YOUR_HOOK_ID/](https://discord.com/api/webhooks/YOUR_HOOK_ID/)..."
+With just these two lines, running test_ex/example.py will now instantly send a Discord alert when the CustomValueError is raised.
+
+Extensibility (Strategy Pattern): The alerting system is built on a Strategy Pattern. You can easily extend it by implementing the BaseAlerter interface to support other channels like email, PagerDuty, or more.
+
+**Tag Merging and Validation Rules**
+```
+
 ## 🤝 Contributing
 
 Bug reports, feature requests, and code contributions are all welcome. For details, please see [CONTRIBUTING.md](https://www.google.com/search?q=httpsS://www.google.com/search%3Fq%3DCONTRIBUTING.md).

{vectorwave-0.1.4 → vectorwave-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vectorwave"
-version = "0.1.4"
+version = "0.1.6"
 authors = [
     { name = "junyeonggim", email = "junyeonggim5@gmail.com" },
 ]
@@ -26,7 +26,8 @@ classifiers = [
 dependencies = [
     "weaviate-client>=4.0.0",
     "pydantic-settings>=2.0.0",
-    "sentence-transformers"
+    "sentence-transformers",
+    "requests"
 ]
 
 [project.urls]

vectorwave-0.1.6/src/tests/conftest.py

@@ -0,0 +1,27 @@
+import pytest
+import os
+import logging
+
+CACHE_FILE_PATH = ".vectorwave_functions_cache.json"
+logger = logging.getLogger(__name__)
+
+
+def _delete_cache():
+    """Helper function to remove the cache file if it exists."""
+    if os.path.exists(CACHE_FILE_PATH):
+        try:
+            os.remove(CACHE_FILE_PATH)
+        except OSError as e:
+            print(f"\n[CacheFixture Error] Failed to remove {CACHE_FILE_PATH}: {e}")
+
+
+@pytest.fixture(autouse=True, scope="function")
+def atomic_function_cache():
+    # --- SETUP (Before Test) ---
+    _delete_cache()
+
+    # --- Run the test ---
+    yield
+
+    # --- TEARDOWN (After Test) ---
+    _delete_cache()

{vectorwave-0.1.4 → vectorwave-0.1.6}/src/tests/database/test_db.py

@@ -355,6 +355,9 @@ def test_create_execution_schema_new(mock_vectorizer_none, test_settings):
     assert "status" in passed_props_map
     assert "duration_ms" in passed_props_map
 
+    assert "return_value" in passed_props_map
+    assert passed_props_map["return_value"].dataType == wvc.DataType.TEXT
+
     assert collection == mock_new_collection
 
 

{vectorwave-0.1.4 → vectorwave-0.1.6}/src/tests/models/test_db_config.py

@@ -148,4 +148,39 @@ def test_get_settings_loads_global_custom_values(mock_env_get, mock_open_file, m
     assert settings.global_custom_values["run_id"] == "test-run-123"
 
     # "EXPERIMENT_ID" should not be included as os.environ.get returned None.
-    assert "experiment_id" not in settings.global_custom_values
+    assert "experiment_id" not in settings.global_custom_values
+
+@patch('os.path.exists', return_value=False)
+def test_get_settings_parses_sensitive_keys(mock_exists, monkeypatch):
+    """
+    Tests whether the SENSITIVE_FIELD_NAMES environment variable is correctly parsed
+    and converted into a lowercase set (sensitive_keys).
+    """
+    monkeypatch.setenv("SENSITIVE_FIELD_NAMES", "password, Token, api_key,, secret ")
+
+    get_weaviate_settings.cache_clear()
+
+    # 2. Act
+    settings = get_weaviate_settings()
+
+    # 3. Assert
+    assert isinstance(settings.sensitive_keys, set)
+    assert len(settings.sensitive_keys) == 4 # 이제 4개가 맞습니다.
+    assert settings.sensitive_keys == {"password", "token", "api_key", "secret"}
+
+
+# [MODIFIED] @patch('os.environ.get', return_value=None) 제거, monkeypatch 인자 추가
+@patch('os.path.exists', return_value=False)
+def test_get_settings_sensitive_keys_default(mock_exists, monkeypatch): # <-- FIX: monkeypatch 사용
+    """
+    Test when there is no SENSITIVE_FIELD_NAMES environment variable set default
+    """
+    get_weaviate_settings.cache_clear()
+    monkeypatch.delenv("SENSITIVE_FIELD_NAMES", raising=False)
+
+    # 2. Act
+    settings = get_weaviate_settings()
+
+    # 3. Assert: check default for 5
+    assert settings.sensitive_keys == {"password", "api_key", "token", "secret", "auth_token"}
+    assert len(settings.sensitive_keys) == 5

vectorwave-0.1.6/src/tests/monitoring/alert/test_alerter.py

@@ -0,0 +1,70 @@
+from unittest.mock import MagicMock, patch
+
+from vectorwave.monitoring.alert.factory import get_alerter
+from vectorwave.monitoring.alert.null_alerter import NullAlerter
+from vectorwave.monitoring.alert.webhook_alerter import WebhookAlerter
+from vectorwave.models.db_config import WeaviateSettings
+
+@patch('vectorwave.monitoring.alert.factory.get_weaviate_settings')
+def test_get_alerter_returns_null_alerter_by_default(mock_get_settings):
+    """
+    Case 1: When .env settings are missing or ALERTER_STRATEGY="none"
+    - Should return NullAlerter.
+    """
+    # 1. Arrange
+    # Clear lru_cache to bypass caching
+    get_alerter.cache_clear()
+
+    # Mock default settings (strategy="none")
+    mock_get_settings.return_value = WeaviateSettings()
+
+    # 2. Act
+    alerter = get_alerter()
+
+    # 3. Assert
+    assert isinstance(alerter, NullAlerter)
+
+@patch('vectorwave.monitoring.alert.factory.get_weaviate_settings')
+def test_get_alerter_returns_webhook_alerter_when_configured(mock_get_settings):
+    """
+    Case 2: When ALERTER_STRATEGY="webhook" and URL is provided
+    - Should return WebhookAlerter.
+    """
+    # 1. Arrange
+    get_alerter.cache_clear()
+
+    # Mock settings object with webhook strategy and URL
+    settings = WeaviateSettings(
+        ALERTER_STRATEGY="webhook",
+        ALERTER_WEBHOOK_URL="https://test.webhook.url/..."
+    )
+    mock_get_settings.return_value = settings
+
+    # 2. Act
+    alerter = get_alerter()
+
+    # 3. Assert
+    assert isinstance(alerter, WebhookAlerter)
+    assert alerter.url == "https://test.webhook.url/..."
+
+@patch('vectorwave.monitoring.alert.factory.get_weaviate_settings')
+def test_get_alerter_returns_null_alerter_if_webhook_url_missing(mock_get_settings):
+    """
+    Case 3: When ALERTER_STRATEGY="webhook" but URL is missing
+    - Should log a warning and return NullAlerter.
+    """
+    # 1. Arrange
+    get_alerter.cache_clear()
+
+    # Mock settings with missing URL
+    settings = WeaviateSettings(
+        ALERTER_STRATEGY="webhook",
+        ALERTER_WEBHOOK_URL=None # URL is missing
+    )
+    mock_get_settings.return_value = settings
+
+    # 2. Act
+    alerter = get_alerter()
+
+    # 3. Assert
+    assert isinstance(alerter, NullAlerter)

{vectorwave-0.1.4 → vectorwave-0.1.6}/src/tests/monitoring/test_async_trace.py

@@ -23,6 +23,7 @@ async def test_trace_root_and_span_async_success(mock_tracer_deps):
     - ContextVar (trace_id) must be correctly propagated across 'await' boundaries
     '''
     mock_batch = mock_tracer_deps["batch"]
+    mock_alerter = mock_tracer_deps["alerter"]
 
     @trace_span(attributes_to_capture=['x'])
     async def my_async_inner_span(x):
@@ -37,6 +38,7 @@ async def test_trace_root_and_span_async_success(mock_tracer_deps):
         return result
 
     mock_batch.reset_mock()
+    mock_alerter.reset_mock()
 
     # --- Execution ---
     result = await my_async_workflow_root()
@@ -47,6 +49,8 @@ async def test_trace_root_and_span_async_success(mock_tracer_deps):
     # 2 calls expected: 1 (inner_span) + 1 (workflow_root)
     assert mock_batch.add_object.call_count == 2
 
+    mock_alerter.notify.assert_not_called()
+
     call_args_list = mock_batch.add_object.call_args_list
     props_map = {
         call.kwargs["properties"]["function_name"]: call.kwargs["properties"]
@@ -80,9 +84,12 @@ async def test_trace_span_async_failure(mock_tracer_deps):
     Case 2: Async span failure test
     '''
     mock_batch = mock_tracer_deps["batch"]
+    mock_alerter = mock_tracer_deps["alerter"]
 
     class AsyncTestError(Exception):
-        pass
+        @property
+        def error_code(self):
+            return "ASYNC_TEST_FAILURE"
 
     @trace_span
     async def my_failing_async_span():
@@ -97,6 +104,20 @@ async def test_trace_span_async_failure(mock_tracer_deps):
     with pytest.raises(AsyncTestError, match="Async failure test"):
         await my_async_workflow_fail()
 
+    mock_alerter.notify.assert_called_once()
+    alert_props = mock_alerter.notify.call_args.args[0]
+
+    assert alert_props["status"] == "ERROR"
+    assert "AsyncTestError: Async failure test" in alert_props["error_message"]
+    assert alert_props["function_name"] == "my_failing_async_span"
+    assert alert_props["error_code"] == "ASYNC_TEST_FAILURE"
+
+    mock_batch.add_object.assert_called_once()
+    db_props = mock_batch.add_object.call_args.kwargs["properties"]
+
+    assert db_props == alert_props
+    assert db_props["span_id"] == alert_props["span_id"]
+
     # --- Verification (Log) ---
     # Check if the failed span log was recorded
     failing_span_props = None
@@ -116,6 +137,7 @@ async def test_span_without_root_async_does_nothing(mock_tracer_deps):
     Case 3: Async span called without a root (@trace_root) should not be logged
     '''
     mock_batch = mock_tracer_deps["batch"]
+    mock_alerter = mock_tracer_deps["alerter"]
 
     @trace_span
     async def my_lonely_async_span():
@@ -126,6 +148,7 @@ async def test_span_without_root_async_does_nothing(mock_tracer_deps):
 
     assert result == "lonely_result"
     mock_batch.add_object.assert_not_called()
+    mock_alerter.notify.assert_not_called()
 
 
 # ==================================