Merge remote-tracking branch 'origin/main' into feat/trigger

api/pyproject.toml

@@ -5,7 +5,6 @@ requires-python = ">=3.11,<3.13"
 
 dependencies = [
     "arize-phoenix-otel~=0.9.2",
-    "authlib==1.6.4",
     "azure-identity==1.16.1",
     "beautifulsoup4==4.12.2",
     "boto3==1.35.99",
@@ -34,7 +33,6 @@ dependencies = [
     "json-repair>=0.41.1",
     "langfuse~=2.51.3",
     "langsmith~=0.1.77",
-    "mailchimp-transactional~=1.0.50",
     "markdown~=3.5.1",
     "numpy~=1.26.4",
     "openpyxl~=3.1.5",
@@ -59,7 +57,6 @@ dependencies = [
     "opentelemetry-semantic-conventions==0.48b0",
     "opentelemetry-util-http==0.48b0",
     "pandas[excel,output-formatting,performance]~=2.2.2",
-    "pandoc~=2.4",
     "psycogreen~=1.0.2",
     "psycopg2-binary~=2.9.6",
     "pycryptodome==3.19.1",

api/tests/test_containers_integration_tests/tasks/test_mail_invite_member_task.py

@@ -0,0 +1,543 @@
+"""
+Integration tests for mail_invite_member_task using testcontainers.
+
+This module provides integration tests for the invite member email task
+using TestContainers infrastructure. The tests ensure that the task properly sends
+invitation emails with internationalization support, handles error scenarios,
+and integrates correctly with the database and Redis for token management.
+
+All tests use the testcontainers infrastructure to ensure proper database isolation
+and realistic testing scenarios with actual PostgreSQL and Redis instances.
+"""
+
+import json
+import uuid
+from datetime import UTC, datetime
+from unittest.mock import MagicMock, patch
+
+import pytest
+from faker import Faker
+
+from extensions.ext_redis import redis_client
+from libs.email_i18n import EmailType
+from models.account import Account, AccountStatus, Tenant, TenantAccountJoin, TenantAccountRole
+from tasks.mail_invite_member_task import send_invite_member_mail_task
+
+
+class TestMailInviteMemberTask:
+    """
+    Integration tests for send_invite_member_mail_task using testcontainers.
+
+    This test class covers the core functionality of the invite member email task:
+    - Email sending with proper internationalization
+    - Template context generation and URL construction
+    - Error handling for failure scenarios
+    - Integration with Redis for token validation
+    - Mail service initialization checks
+    - Real database integration with actual invitation flow
+
+    All tests use the testcontainers infrastructure to ensure proper database isolation
+    and realistic testing environment with actual database and Redis interactions.
+    """
+
+    @pytest.fixture(autouse=True)
+    def cleanup_database(self, db_session_with_containers):
+        """Clean up database before each test to ensure isolation."""
+        # Clear all test data
+        db_session_with_containers.query(TenantAccountJoin).delete()
+        db_session_with_containers.query(Tenant).delete()
+        db_session_with_containers.query(Account).delete()
+        db_session_with_containers.commit()
+
+        # Clear Redis cache
+        redis_client.flushdb()
+
+    @pytest.fixture
+    def mock_external_service_dependencies(self):
+        """Mock setup for external service dependencies."""
+        with (
+            patch("tasks.mail_invite_member_task.mail") as mock_mail,
+            patch("tasks.mail_invite_member_task.get_email_i18n_service") as mock_email_service,
+            patch("tasks.mail_invite_member_task.dify_config") as mock_config,
+        ):
+            # Setup mail service mock
+            mock_mail.is_inited.return_value = True
+
+            # Setup email service mock
+            mock_email_service_instance = MagicMock()
+            mock_email_service_instance.send_email.return_value = None
+            mock_email_service.return_value = mock_email_service_instance
+
+            # Setup config mock
+            mock_config.CONSOLE_WEB_URL = "https://console.dify.ai"
+
+            yield {
+                "mail": mock_mail,
+                "email_service": mock_email_service_instance,
+                "config": mock_config,
+            }
+
+    def _create_test_account_and_tenant(self, db_session_with_containers):
+        """
+        Helper method to create a test account and tenant for testing.
+
+        Args:
+            db_session_with_containers: Database session from testcontainers infrastructure
+
+        Returns:
+            tuple: (Account, Tenant) created instances
+        """
+        fake = Faker()
+
+        # Create account
+        account = Account(
+            email=fake.email(),
+            name=fake.name(),
+            password=fake.password(),
+            interface_language="en-US",
+            status=AccountStatus.ACTIVE.value,
+            created_at=datetime.now(UTC),
+            updated_at=datetime.now(UTC),
+        )
+        db_session_with_containers.add(account)
+        db_session_with_containers.commit()
+        db_session_with_containers.refresh(account)
+
+        # Create tenant
+        tenant = Tenant(
+            name=fake.company(),
+            created_at=datetime.now(UTC),
+            updated_at=datetime.now(UTC),
+        )
+        db_session_with_containers.add(tenant)
+        db_session_with_containers.commit()
+        db_session_with_containers.refresh(tenant)
+
+        # Create tenant member relationship
+        tenant_join = TenantAccountJoin(
+            tenant_id=tenant.id,
+            account_id=account.id,
+            role=TenantAccountRole.OWNER.value,
+            created_at=datetime.now(UTC),
+        )
+        db_session_with_containers.add(tenant_join)
+        db_session_with_containers.commit()
+
+        return account, tenant
+
+    def _create_invitation_token(self, tenant, account):
+        """
+        Helper method to create a valid invitation token in Redis.
+
+        Args:
+            tenant: Tenant instance
+            account: Account instance
+
+        Returns:
+            str: Generated invitation token
+        """
+        token = str(uuid.uuid4())
+        invitation_data = {
+            "account_id": account.id,
+            "email": account.email,
+            "workspace_id": tenant.id,
+        }
+        cache_key = f"member_invite:token:{token}"
+        redis_client.setex(cache_key, 24 * 60 * 60, json.dumps(invitation_data))  # 24 hours
+        return token
+
+    def _create_pending_account_for_invitation(self, db_session_with_containers, email, tenant):
+        """
+        Helper method to create a pending account for invitation testing.
+
+        Args:
+            db_session_with_containers: Database session
+            email: Email address for the account
+            tenant: Tenant instance
+
+        Returns:
+            Account: Created pending account
+        """
+        account = Account(
+            email=email,
+            name=email.split("@")[0],
+            password="",
+            interface_language="en-US",
+            status=AccountStatus.PENDING.value,
+            created_at=datetime.now(UTC),
+            updated_at=datetime.now(UTC),
+        )
+        db_session_with_containers.add(account)
+        db_session_with_containers.commit()
+        db_session_with_containers.refresh(account)
+
+        # Create tenant member relationship
+        tenant_join = TenantAccountJoin(
+            tenant_id=tenant.id,
+            account_id=account.id,
+            role=TenantAccountRole.NORMAL.value,
+            created_at=datetime.now(UTC),
+        )
+        db_session_with_containers.add(tenant_join)
+        db_session_with_containers.commit()
+
+        return account
+
+    def test_send_invite_member_mail_success(self, db_session_with_containers, mock_external_service_dependencies):
+        """
+        Test successful invitation email sending with all parameters.
+
+        This test verifies:
+        - Email service is called with correct parameters
+        - Template context includes all required fields
+        - URL is constructed correctly with token
+        - Performance logging is recorded
+        - No exceptions are raised
+        """
+        # Arrange: Create test data
+        inviter, tenant = self._create_test_account_and_tenant(db_session_with_containers)
+        invitee_email = "test@example.com"
+        language = "en-US"
+        token = self._create_invitation_token(tenant, inviter)
+        inviter_name = inviter.name
+        workspace_name = tenant.name
+
+        # Act: Execute the task
+        send_invite_member_mail_task(
+            language=language,
+            to=invitee_email,
+            token=token,
+            inviter_name=inviter_name,
+            workspace_name=workspace_name,
+        )
+
+        # Assert: Verify email service was called correctly
+        mock_email_service = mock_external_service_dependencies["email_service"]
+        mock_email_service.send_email.assert_called_once()
+
+        # Verify call arguments
+        call_args = mock_email_service.send_email.call_args
+        assert call_args[1]["email_type"] == EmailType.INVITE_MEMBER
+        assert call_args[1]["language_code"] == language
+        assert call_args[1]["to"] == invitee_email
+
+        # Verify template context
+        template_context = call_args[1]["template_context"]
+        assert template_context["to"] == invitee_email
+        assert template_context["inviter_name"] == inviter_name
+        assert template_context["workspace_name"] == workspace_name
+        assert template_context["url"] == f"https://console.dify.ai/activate?token={token}"
+
+    def test_send_invite_member_mail_different_languages(
+        self, db_session_with_containers, mock_external_service_dependencies
+    ):
+        """
+        Test invitation email sending with different language codes.
+
+        This test verifies:
+        - Email service handles different language codes correctly
+        - Template context is passed correctly for each language
+        - No language-specific errors occur
+        """
+        # Arrange: Create test data
+        inviter, tenant = self._create_test_account_and_tenant(db_session_with_containers)
+        token = self._create_invitation_token(tenant, inviter)
+
+        test_languages = ["en-US", "zh-CN", "ja-JP", "fr-FR", "de-DE", "es-ES"]
+
+        for language in test_languages:
+            # Act: Execute the task with different language
+            send_invite_member_mail_task(
+                language=language,
+                to="test@example.com",
+                token=token,
+                inviter_name=inviter.name,
+                workspace_name=tenant.name,
+            )
+
+            # Assert: Verify language code was passed correctly
+            mock_email_service = mock_external_service_dependencies["email_service"]
+            call_args = mock_email_service.send_email.call_args
+            assert call_args[1]["language_code"] == language
+
+    def test_send_invite_member_mail_mail_not_initialized(
+        self, db_session_with_containers, mock_external_service_dependencies
+    ):
+        """
+        Test behavior when mail service is not initialized.
+
+        This test verifies:
+        - Task returns early when mail is not initialized
+        - Email service is not called
+        - No exceptions are raised
+        """
+        # Arrange: Setup mail service as not initialized
+        mock_mail = mock_external_service_dependencies["mail"]
+        mock_mail.is_inited.return_value = False
+
+        # Act: Execute the task
+        result = send_invite_member_mail_task(
+            language="en-US",
+            to="test@example.com",
+            token="test-token",
+            inviter_name="Test User",
+            workspace_name="Test Workspace",
+        )
+
+        # Assert: Verify early return
+        assert result is None
+        mock_email_service = mock_external_service_dependencies["email_service"]
+        mock_email_service.send_email.assert_not_called()
+
+    def test_send_invite_member_mail_email_service_exception(
+        self, db_session_with_containers, mock_external_service_dependencies
+    ):
+        """
+        Test error handling when email service raises an exception.
+
+        This test verifies:
+        - Exception is caught and logged
+        - Task completes without raising exception
+        - Error logging is performed
+        """
+        # Arrange: Setup email service to raise exception
+        mock_email_service = mock_external_service_dependencies["email_service"]
+        mock_email_service.send_email.side_effect = Exception("Email service failed")
+
+        # Act & Assert: Execute task and verify exception is handled
+        with patch("tasks.mail_invite_member_task.logger") as mock_logger:
+            send_invite_member_mail_task(
+                language="en-US",
+                to="test@example.com",
+                token="test-token",
+                inviter_name="Test User",
+                workspace_name="Test Workspace",
+            )
+
+            # Verify error was logged
+            mock_logger.exception.assert_called_once()
+            error_call = mock_logger.exception.call_args[0][0]
+            assert "Send invite member mail to %s failed" in error_call
+
+    def test_send_invite_member_mail_template_context_validation(
+        self, db_session_with_containers, mock_external_service_dependencies
+    ):
+        """
+        Test template context contains all required fields for email rendering.
+
+        This test verifies:
+        - All required template context fields are present
+        - Field values match expected data
+        - URL construction is correct
+        - No missing or None values in context
+        """
+        # Arrange: Create test data with specific values
+        inviter, tenant = self._create_test_account_and_tenant(db_session_with_containers)
+        token = "test-token-123"
+        invitee_email = "invitee@example.com"
+        inviter_name = "John Doe"
+        workspace_name = "Acme Corp"
+
+        # Act: Execute the task
+        send_invite_member_mail_task(
+            language="en-US",
+            to=invitee_email,
+            token=token,
+            inviter_name=inviter_name,
+            workspace_name=workspace_name,
+        )
+
+        # Assert: Verify template context
+        mock_email_service = mock_external_service_dependencies["email_service"]
+        call_args = mock_email_service.send_email.call_args
+        template_context = call_args[1]["template_context"]
+
+        # Verify all required fields are present
+        required_fields = ["to", "inviter_name", "workspace_name", "url"]
+        for field in required_fields:
+            assert field in template_context
+            assert template_context[field] is not None
+            assert template_context[field] != ""
+
+        # Verify specific values
+        assert template_context["to"] == invitee_email
+        assert template_context["inviter_name"] == inviter_name
+        assert template_context["workspace_name"] == workspace_name
+        assert template_context["url"] == f"https://console.dify.ai/activate?token={token}"
+
+    def test_send_invite_member_mail_integration_with_redis_token(
+        self, db_session_with_containers, mock_external_service_dependencies
+    ):
+        """
+        Test integration with Redis token validation.
+
+        This test verifies:
+        - Task works with real Redis token data
+        - Token validation can be performed after email sending
+        - Redis data integrity is maintained
+        """
+        # Arrange: Create test data and store token in Redis
+        inviter, tenant = self._create_test_account_and_tenant(db_session_with_containers)
+        token = self._create_invitation_token(tenant, inviter)
+
+        # Verify token exists in Redis before sending email
+        cache_key = f"member_invite:token:{token}"
+        assert redis_client.exists(cache_key) == 1
+
+        # Act: Execute the task
+        send_invite_member_mail_task(
+            language="en-US",
+            to=inviter.email,
+            token=token,
+            inviter_name=inviter.name,
+            workspace_name=tenant.name,
+        )
+
+        # Assert: Verify token still exists after email sending
+        assert redis_client.exists(cache_key) == 1
+
+        # Verify token data integrity
+        token_data = redis_client.get(cache_key)
+        assert token_data is not None
+        invitation_data = json.loads(token_data)
+        assert invitation_data["account_id"] == inviter.id
+        assert invitation_data["email"] == inviter.email
+        assert invitation_data["workspace_id"] == tenant.id
+
+    def test_send_invite_member_mail_with_special_characters(
+        self, db_session_with_containers, mock_external_service_dependencies
+    ):
+        """
+        Test email sending with special characters in names and workspace names.
+
+        This test verifies:
+        - Special characters are handled correctly in template context
+        - Email service receives properly formatted data
+        - No encoding issues occur
+        """
+        # Arrange: Create test data with special characters
+        inviter, tenant = self._create_test_account_and_tenant(db_session_with_containers)
+        token = self._create_invitation_token(tenant, inviter)
+
+        special_cases = [
+            ("John O'Connor", "Acme & Co."),
+            ("José María", "Café & Restaurant"),
+            ("李小明", "北京科技有限公司"),
+            ("François & Marie", "L'École Internationale"),
+            ("Александр", "ООО Технологии"),
+            ("محمد أحمد", "شركة التقنية المتقدمة"),
+        ]
+
+        for inviter_name, workspace_name in special_cases:
+            # Act: Execute the task
+            send_invite_member_mail_task(
+                language="en-US",
+                to="test@example.com",
+                token=token,
+                inviter_name=inviter_name,
+                workspace_name=workspace_name,
+            )
+
+            # Assert: Verify special characters are preserved
+            mock_email_service = mock_external_service_dependencies["email_service"]
+            call_args = mock_email_service.send_email.call_args
+            template_context = call_args[1]["template_context"]
+
+            assert template_context["inviter_name"] == inviter_name
+            assert template_context["workspace_name"] == workspace_name
+
+    def test_send_invite_member_mail_real_database_integration(
+        self, db_session_with_containers, mock_external_service_dependencies
+    ):
+        """
+        Test real database integration with actual invitation flow.
+
+        This test verifies:
+        - Task works with real database entities
+        - Account and tenant relationships are properly maintained
+        - Database state is consistent after email sending
+        - Real invitation data flow is tested
+        """
+        # Arrange: Create real database entities
+        inviter, tenant = self._create_test_account_and_tenant(db_session_with_containers)
+        invitee_email = "newmember@example.com"
+
+        # Create a pending account for invitation (simulating real invitation flow)
+        pending_account = self._create_pending_account_for_invitation(db_session_with_containers, invitee_email, tenant)
+
+        # Create invitation token with real account data
+        token = self._create_invitation_token(tenant, pending_account)
+
+        # Act: Execute the task with real data
+        send_invite_member_mail_task(
+            language="en-US",
+            to=invitee_email,
+            token=token,
+            inviter_name=inviter.name,
+            workspace_name=tenant.name,
+        )
+
+        # Assert: Verify email service was called with real data
+        mock_email_service = mock_external_service_dependencies["email_service"]
+        mock_email_service.send_email.assert_called_once()
+
+        # Verify database state is maintained
+        db_session_with_containers.refresh(pending_account)
+        db_session_with_containers.refresh(tenant)
+
+        assert pending_account.status == AccountStatus.PENDING.value
+        assert pending_account.email == invitee_email
+        assert tenant.name is not None
+
+        # Verify tenant relationship exists
+        tenant_join = (
+            db_session_with_containers.query(TenantAccountJoin)
+            .filter_by(tenant_id=tenant.id, account_id=pending_account.id)
+            .first()
+        )
+        assert tenant_join is not None
+        assert tenant_join.role == TenantAccountRole.NORMAL.value
+
+    def test_send_invite_member_mail_token_lifecycle_management(
+        self, db_session_with_containers, mock_external_service_dependencies
+    ):
+        """
+        Test token lifecycle management and validation.
+
+        This test verifies:
+        - Token is properly stored in Redis with correct TTL
+        - Token data structure is correct
+        - Token can be retrieved and validated after email sending
+        - Token expiration is handled correctly
+        """
+        # Arrange: Create test data
+        inviter, tenant = self._create_test_account_and_tenant(db_session_with_containers)
+        token = self._create_invitation_token(tenant, inviter)
+
+        # Act: Execute the task
+        send_invite_member_mail_task(
+            language="en-US",
+            to=inviter.email,
+            token=token,
+            inviter_name=inviter.name,
+            workspace_name=tenant.name,
+        )
+
+        # Assert: Verify token lifecycle
+        cache_key = f"member_invite:token:{token}"
+
+        # Token should still exist
+        assert redis_client.exists(cache_key) == 1
+
+        # Token should have correct TTL (approximately 24 hours)
+        ttl = redis_client.ttl(cache_key)
+        assert 23 * 60 * 60 <= ttl <= 24 * 60 * 60  # Allow some tolerance
+
+        # Token data should be valid
+        token_data = redis_client.get(cache_key)
+        assert token_data is not None
+
+        invitation_data = json.loads(token_data)
+        assert invitation_data["account_id"] == inviter.id
+        assert invitation_data["email"] == inviter.email
+        assert invitation_data["workspace_id"] == tenant.id

api/uv.lock

@@ -1294,7 +1294,6 @@ version = "1.9.1"
 source = { virtual = "." }
 dependencies = [
     { name = "arize-phoenix-otel" },
-    { name = "authlib" },
     { name = "azure-identity" },
     { name = "beautifulsoup4" },
     { name = "boto3" },
@@ -1326,7 +1325,6 @@ dependencies = [
     { name = "json-repair" },
     { name = "langfuse" },
     { name = "langsmith" },
-    { name = "mailchimp-transactional" },
     { name = "markdown" },
     { name = "numpy" },
     { name = "openpyxl" },
@@ -1350,7 +1348,6 @@ dependencies = [
     { name = "opik" },
     { name = "packaging" },
     { name = "pandas", extra = ["excel", "output-formatting", "performance"] },
-    { name = "pandoc" },
     { name = "psycogreen" },
     { name = "psycopg2-binary" },
     { name = "pycryptodome" },
@@ -1488,7 +1485,6 @@ vdb = [
 [package.metadata]
 requires-dist = [
     { name = "arize-phoenix-otel", specifier = "~=0.9.2" },
-    { name = "authlib", specifier = "==1.6.4" },
     { name = "azure-identity", specifier = "==1.16.1" },
     { name = "beautifulsoup4", specifier = "==4.12.2" },
     { name = "boto3", specifier = "==1.35.99" },
@@ -1520,7 +1516,6 @@ requires-dist = [
     { name = "json-repair", specifier = ">=0.41.1" },
     { name = "langfuse", specifier = "~=2.51.3" },
     { name = "langsmith", specifier = "~=0.1.77" },
-    { name = "mailchimp-transactional", specifier = "~=1.0.50" },
     { name = "markdown", specifier = "~=3.5.1" },
     { name = "numpy", specifier = "~=1.26.4" },
     { name = "openpyxl", specifier = "~=3.1.5" },
@@ -1544,7 +1539,6 @@ requires-dist = [
     { name = "opik", specifier = "~=1.7.25" },
     { name = "packaging", specifier = "~=23.2" },
     { name = "pandas", extras = ["excel", "output-formatting", "performance"], specifier = "~=2.2.2" },
-    { name = "pandoc", specifier = "~=2.4" },
     { name = "psycogreen", specifier = "~=1.0.2" },
     { name = "psycopg2-binary", specifier = "~=2.9.6" },
     { name = "pycryptodome", specifier = "==3.19.1" },
@@ -3185,21 +3179,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/6c/e1/0686c91738f3e6c2e1a243e0fdd4371667c4d2e5009b0a3605806c2aa020/lz4-4.4.4-cp312-cp312-win_arm64.whl", hash = "sha256:2f4f2965c98ab254feddf6b5072854a6935adab7bc81412ec4fe238f07b85f62", size = 89736, upload-time = "2025-04-01T22:55:40.5Z" },
 ]
 
-[[package]]
-name = "mailchimp-transactional"
-version = "1.0.56"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
-    { name = "certifi" },
-    { name = "python-dateutil" },
-    { name = "requests" },
-    { name = "six" },
-    { name = "urllib3" },
-]
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/5f/bc/cb60d02c00996839bbd87444a97d0ba5ac271b1a324001562afb8f685251/mailchimp_transactional-1.0.56-py3-none-any.whl", hash = "sha256:a76ea88b90a2d47d8b5134586aabbd3a96c459f6066d8886748ab59e50de36eb", size = 31660, upload-time = "2024-02-01T18:39:19.717Z" },
-]
-
 [[package]]
 name = "mako"
 version = "1.3.10"
@@ -4231,16 +4210,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/ec/f8/46141ba8c9d7064dc5008bfb4a6ae5bd3c30e4c61c28b5c5ed485bf358ba/pandas_stubs-2.2.3.250527-py3-none-any.whl", hash = "sha256:cd0a49a95b8c5f944e605be711042a4dd8550e2c559b43d70ba2c4b524b66163", size = 159683, upload-time = "2025-05-27T15:24:28.4Z" },
 ]
 
-[[package]]
-name = "pandoc"
-version = "2.4"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
-    { name = "plumbum" },
-    { name = "ply" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/10/9a/e3186e760c57ee5f1c27ea5cea577a0ff9abfca51eefcb4d9a4cd39aff2e/pandoc-2.4.tar.gz", hash = "sha256:ecd1f8cbb7f4180c6b5db4a17a7c1a74df519995f5f186ef81ce72a9cbd0dd9a", size = 34635, upload-time = "2024-08-07T14:33:58.016Z" }
-
 [[package]]
 name = "pathspec"
 version = "0.12.1"
@@ -4347,18 +4316,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/54/20/4d324d65cc6d9205fabedc306948156824eb9f0ee1633355a8f7ec5c66bf/pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746", size = 20538, upload-time = "2025-05-15T12:30:06.134Z" },
 ]
 
-[[package]]
-name = "plumbum"
-version = "1.9.0"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
-    { name = "pywin32", marker = "platform_python_implementation != 'PyPy' and sys_platform == 'win32'" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/f0/5d/49ba324ad4ae5b1a4caefafbce7a1648540129344481f2ed4ef6bb68d451/plumbum-1.9.0.tar.gz", hash = "sha256:e640062b72642c3873bd5bdc3effed75ba4d3c70ef6b6a7b907357a84d909219", size = 319083, upload-time = "2024-10-05T05:59:27.059Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/4f/9d/d03542c93bb3d448406731b80f39c3d5601282f778328c22c77d270f4ed4/plumbum-1.9.0-py3-none-any.whl", hash = "sha256:9fd0d3b0e8d86e4b581af36edf3f3bbe9d1ae15b45b8caab28de1bcb27aaa7f5", size = 127970, upload-time = "2024-10-05T05:59:25.102Z" },
-]
-
 [[package]]
 name = "ply"
 version = "3.11"

web/app/components/app/configuration/config-var/config-modal/index.tsx

@@ -32,6 +32,19 @@ import { TransferMethod } from '@/types/app'
 import type { FileEntity } from '@/app/components/base/file-uploader/types'
 
 const TEXT_MAX_LENGTH = 256
+const CHECKBOX_DEFAULT_TRUE_VALUE = 'true'
+const CHECKBOX_DEFAULT_FALSE_VALUE = 'false'
+
+const getCheckboxDefaultSelectValue = (value: InputVar['default']) => {
+  if (typeof value === 'boolean')
+    return value ? CHECKBOX_DEFAULT_TRUE_VALUE : CHECKBOX_DEFAULT_FALSE_VALUE
+  if (typeof value === 'string')
+    return value.toLowerCase() === CHECKBOX_DEFAULT_TRUE_VALUE ? CHECKBOX_DEFAULT_TRUE_VALUE : CHECKBOX_DEFAULT_FALSE_VALUE
+  return CHECKBOX_DEFAULT_FALSE_VALUE
+}
+
+const parseCheckboxSelectValue = (value: string) =>
+  value === CHECKBOX_DEFAULT_TRUE_VALUE
 
 export type IConfigModalProps = {
   isCreate?: boolean
@@ -198,6 +211,8 @@ const ConfigModal: FC<IConfigModalProps> = ({
     handlePayloadChange('variable')(e.target.value)
   }, [handlePayloadChange, t])
 
+  const checkboxDefaultSelectValue = useMemo(() => getCheckboxDefaultSelectValue(tempPayload.default), [tempPayload.default])
+
   const handleConfirm = () => {
     const moreInfo = tempPayload.variable === payload?.variable
       ? undefined
@@ -324,6 +339,23 @@ const ConfigModal: FC<IConfigModalProps> = ({
             </Field>
           )}
 
+          {type === InputVarType.checkbox && (
+            <Field title={t('appDebug.variableConfig.defaultValue')}>
+              <SimpleSelect
+                className="w-full"
+                optionWrapClassName="max-h-[140px] overflow-y-auto"
+                items={[
+                  { value: CHECKBOX_DEFAULT_TRUE_VALUE, name: t('appDebug.variableConfig.startChecked') },
+                  { value: CHECKBOX_DEFAULT_FALSE_VALUE, name: t('appDebug.variableConfig.noDefaultSelected') },
+                ]}
+                defaultValue={checkboxDefaultSelectValue}
+                onSelect={item => handlePayloadChange('default')(parseCheckboxSelectValue(String(item.value)))}
+                placeholder={t('appDebug.variableConfig.selectDefaultValue')}
+                allowSearch={false}
+              />
+            </Field>
+          )}
+
           {type === InputVarType.select && (
             <>
               <Field title={t('appDebug.variableConfig.options')}>

web/app/components/base/chat/chat-with-history/hooks.tsx

@@ -235,13 +235,15 @@ export const useChatWithHistory = (installedAppInfo?: InstalledApp) => {
         }
       }
 
-      if(item.checkbox) {
+      if (item.checkbox) {
+        const preset = initInputs[item.checkbox.variable] === true
         return {
           ...item.checkbox,
-          default: false,
+          default: preset || item.default || item.checkbox.default,
           type: 'checkbox',
         }
       }
+
       if (item.select) {
         const isInputInOptions = item.select.options.includes(initInputs[item.select.variable])
         return {

web/app/components/base/chat/embedded-chatbot/hooks.tsx

@@ -195,13 +195,16 @@ export const useEmbeddedChatbot = () => {
           type: 'number',
         }
       }
+
       if (item.checkbox) {
+        const preset = initInputs[item.checkbox.variable] === true
         return {
           ...item.checkbox,
-          default: false,
+          default: preset || item.default || item.checkbox.default,
           type: 'checkbox',
         }
       }
+
       if (item.select) {
         const isInputInOptions = item.select.options.includes(initInputs[item.select.variable])
         return {

web/app/components/share/text-generation/result/index.tsx

@@ -126,8 +126,8 @@ const Result: FC<IResultProps> = ({
 
     let hasEmptyInput = ''
     const requiredVars = prompt_variables?.filter(({ key, name, required, type }) => {
-      if(type === 'boolean')
-        return false // boolean input is not required
+      if(type === 'boolean' || type === 'checkbox')
+        return false // boolean/checkbox input is not required
       const res = (!key || !key.trim()) || (!name || !name.trim()) || (required || required === undefined || required === null)
       return res
     }) || [] // compatible with old version

web/app/components/share/text-generation/run-once/index.tsx

@@ -51,6 +51,8 @@ const RunOnce: FC<IRunOnceProps> = ({
     promptConfig.prompt_variables.forEach((item) => {
       if (item.type === 'string' || item.type === 'paragraph')
         newInputs[item.key] = ''
+      else if (item.type === 'checkbox')
+        newInputs[item.key] = false
       else
         newInputs[item.key] = undefined
     })
@@ -77,6 +79,8 @@ const RunOnce: FC<IRunOnceProps> = ({
         newInputs[item.key] = item.default || ''
       else if (item.type === 'number')
         newInputs[item.key] = item.default
+      else if (item.type === 'checkbox')
+        newInputs[item.key] = item.default || false
       else if (item.type === 'file')
         newInputs[item.key] = item.default
       else if (item.type === 'file-list')
@@ -96,7 +100,7 @@ const RunOnce: FC<IRunOnceProps> = ({
           {(inputs === null || inputs === undefined || Object.keys(inputs).length === 0) || !isInitialized ? null
             : promptConfig.prompt_variables.map(item => (
               <div className='mt-4 w-full' key={item.key}>
-                {item.type !== 'boolean' && (
+                {item.type !== 'checkbox' && (
                   <label className='system-md-semibold flex h-6 items-center text-text-secondary'>{item.name}</label>
                 )}
                 <div className='mt-1'>
@@ -134,7 +138,7 @@ const RunOnce: FC<IRunOnceProps> = ({
                       onChange={(e: ChangeEvent<HTMLInputElement>) => { handleInputsChange({ ...inputsRef.current, [item.key]: e.target.value }) }}
                     />
                   )}
-                  {item.type === 'boolean' && (
+                  {item.type === 'checkbox' && (
                     <BoolInput
                       name={item.name || item.key}
                       value={!!inputs[item.key]}

web/utils/model-config.ts

@@ -61,6 +61,17 @@ export const userInputsFormToPromptVariables = (useInputs: UserInputFormItem[] |
         default: content.default,
       })
     }
+    else if (type === 'boolean') {
+      promptVariables.push({
+        key: content.variable,
+        name: content.label,
+        required: content.required,
+        type: 'checkbox',
+        options: [],
+        hide: content.hide,
+        default: content.default,
+      })
+    }
     else if (type === 'select') {
       promptVariables.push({
         key: content.variable,