vrr/SurfSense
2
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2025-09-04 11:39:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

fix: ruff linting for alembic version files

Browse source
This commit is contained in:
Utkarsh-Patel-13 2025-07-24 15:21:54 -07:00
parent f589d51c36
commit 7b52af5e77
13 changed files with 307 additions and 213 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
.pre-commit-config.yaml
View file

@ -31,6 +31,7 @@ repos:
.*\.env\.template| .*\.env\.template|
.*/tests/.*| .*/tests/.*|
.*test.*\.py| .*test.*\.py|
test_.*\.py|
.github/workflows/.*\.yml| .github/workflows/.*\.yml|
.github/workflows/.*\.yaml| .github/workflows/.*\.yaml|
.*pnpm-lock\.yaml| .*pnpm-lock\.yaml|
@ -44,20 +45,22 @@ repos:
rev: v0.12.5 rev: v0.12.5
hooks: hooks:
- id: ruff - id: ruff
name: ruff-lint name: ruff-check
files: ^surfsense_backend/ files: ^surfsense_backend/
args: [--fix, --exit-non-zero-on-fix] exclude: ^surfsense_backend/(test_.*\.py|.*test.*\.py)
args: [--fix]
- id: ruff-format - id: ruff-format
name: ruff-format name: ruff-format
files: ^surfsense_backend/ files: ^surfsense_backend/
exclude: ^surfsense_backend/(test_.*\.py|.*test.*\.py)
- repo: https://github.com/PyCQA/bandit - repo: https://github.com/PyCQA/bandit
rev: 1.8.6 rev: 1.8.6
hooks: hooks:
- id: bandit - id: bandit
files: ^surfsense_backend/ files: ^surfsense_backend/
args: ['-f', 'json'] args: ['-f', 'json', '--severity-level', 'high', '--confidence-level', 'high']
exclude: ^surfsense_backend/(tests/|alembic/) exclude: ^surfsense_backend/(tests/|test_.*\.py|.*test.*\.py|alembic/)
# Frontend/Extension Hooks (TypeScript/JavaScript) # Frontend/Extension Hooks (TypeScript/JavaScript)
- repo: https://github.com/pre-commit/mirrors-prettier - repo: https://github.com/pre-commit/mirrors-prettier

104
surfsense_backend/alembic/versions/10_update_chattype_enum_to_qna_report_structure.py
View file

@ -20,87 +20,101 @@ CHAT_TYPE_ENUM = "chattype"
def upgrade() -> None: def upgrade() -> None:
"""Upgrade schema - replace ChatType enum values with new QNA/REPORT structure.""" """Upgrade schema - replace ChatType enum values with new QNA/REPORT structure."""
# Old enum name for temporary storage # Old enum name for temporary storage
old_enum_name = f"{CHAT_TYPE_ENUM}_old" old_enum_name = f"{CHAT_TYPE_ENUM}_old"
# New enum values # New enum values
new_values = ( new_values = ("QNA", "REPORT_GENERAL", "REPORT_DEEP", "REPORT_DEEPER")
"QNA",
"REPORT_GENERAL",
"REPORT_DEEP",
"REPORT_DEEPER"
)
new_values_sql = ", ".join([f"'{v}'" for v in new_values]) new_values_sql = ", ".join([f"'{v}'" for v in new_values])
# Table and column info # Table and column info
table_name = "chats" table_name = "chats"
column_name = "type" column_name = "type"
# Step 1: Rename the current enum type # Step 1: Rename the current enum type
op.execute(f"ALTER TYPE {CHAT_TYPE_ENUM} RENAME TO {old_enum_name}") op.execute(f"ALTER TYPE {CHAT_TYPE_ENUM} RENAME TO {old_enum_name}")
# Step 2: Create the new enum type with new values # Step 2: Create the new enum type with new values
op.execute(f"CREATE TYPE {CHAT_TYPE_ENUM} AS ENUM({new_values_sql})") op.execute(f"CREATE TYPE {CHAT_TYPE_ENUM} AS ENUM({new_values_sql})")
# Step 3: Add a temporary column with the new type # Step 3: Add a temporary column with the new type
op.execute(f"ALTER TABLE {table_name} ADD COLUMN {column_name}_new {CHAT_TYPE_ENUM}") op.execute(
f"ALTER TABLE {table_name} ADD COLUMN {column_name}_new {CHAT_TYPE_ENUM}"
)
# Step 4: Update the temporary column with mapped values # Step 4: Update the temporary column with mapped values
op.execute(f"UPDATE {table_name} SET {column_name}_new = 'QNA' WHERE {column_name}::text = 'GENERAL'") op.execute(
op.execute(f"UPDATE {table_name} SET {column_name}_new = 'REPORT_DEEP' WHERE {column_name}::text = 'DEEP'") f"UPDATE {table_name} SET {column_name}_new = 'QNA' WHERE {column_name}::text = 'GENERAL'"
op.execute(f"UPDATE {table_name} SET {column_name}_new = 'REPORT_DEEPER' WHERE {column_name}::text = 'DEEPER'") )
op.execute(f"UPDATE {table_name} SET {column_name}_new = 'REPORT_DEEPER' WHERE {column_name}::text = 'DEEPEST'") op.execute(
f"UPDATE {table_name} SET {column_name}_new = 'REPORT_DEEP' WHERE {column_name}::text = 'DEEP'"
)
op.execute(
f"UPDATE {table_name} SET {column_name}_new = 'REPORT_DEEPER' WHERE {column_name}::text = 'DEEPER'"
)
op.execute(
f"UPDATE {table_name} SET {column_name}_new = 'REPORT_DEEPER' WHERE {column_name}::text = 'DEEPEST'"
)
# Step 5: Drop the old column # Step 5: Drop the old column
op.execute(f"ALTER TABLE {table_name} DROP COLUMN {column_name}") op.execute(f"ALTER TABLE {table_name} DROP COLUMN {column_name}")
# Step 6: Rename the new column to the original name # Step 6: Rename the new column to the original name
op.execute(f"ALTER TABLE {table_name} RENAME COLUMN {column_name}_new TO {column_name}") op.execute(
f"ALTER TABLE {table_name} RENAME COLUMN {column_name}_new TO {column_name}"
)
# Step 7: Drop the old enum type # Step 7: Drop the old enum type
op.execute(f"DROP TYPE {old_enum_name}") op.execute(f"DROP TYPE {old_enum_name}")
def downgrade() -> None: def downgrade() -> None:
"""Downgrade schema - revert ChatType enum to old GENERAL/DEEP/DEEPER/DEEPEST structure.""" """Downgrade schema - revert ChatType enum to old GENERAL/DEEP/DEEPER/DEEPEST structure."""
# Old enum name for temporary storage # Old enum name for temporary storage
old_enum_name = f"{CHAT_TYPE_ENUM}_old" old_enum_name = f"{CHAT_TYPE_ENUM}_old"
# Original enum values # Original enum values
original_values = ( original_values = ("GENERAL", "DEEP", "DEEPER", "DEEPEST")
"GENERAL",
"DEEP",
"DEEPER",
"DEEPEST"
)
original_values_sql = ", ".join([f"'{v}'" for v in original_values]) original_values_sql = ", ".join([f"'{v}'" for v in original_values])
# Table and column info # Table and column info
table_name = "chats" table_name = "chats"
column_name = "type" column_name = "type"
# Step 1: Rename the current enum type # Step 1: Rename the current enum type
op.execute(f"ALTER TYPE {CHAT_TYPE_ENUM} RENAME TO {old_enum_name}") op.execute(f"ALTER TYPE {CHAT_TYPE_ENUM} RENAME TO {old_enum_name}")
# Step 2: Create the new enum type with original values # Step 2: Create the new enum type with original values
op.execute(f"CREATE TYPE {CHAT_TYPE_ENUM} AS ENUM({original_values_sql})") op.execute(f"CREATE TYPE {CHAT_TYPE_ENUM} AS ENUM({original_values_sql})")
# Step 3: Add a temporary column with the original type # Step 3: Add a temporary column with the original type
op.execute(f"ALTER TABLE {table_name} ADD COLUMN {column_name}_new {CHAT_TYPE_ENUM}") op.execute(
f"ALTER TABLE {table_name} ADD COLUMN {column_name}_new {CHAT_TYPE_ENUM}"
)
# Step 4: Update the temporary column with mapped values back to old values # Step 4: Update the temporary column with mapped values back to old values
op.execute(f"UPDATE {table_name} SET {column_name}_new = 'GENERAL' WHERE {column_name}::text = 'QNA'") op.execute(
op.execute(f"UPDATE {table_name} SET {column_name}_new = 'GENERAL' WHERE {column_name}::text = 'REPORT_GENERAL'") f"UPDATE {table_name} SET {column_name}_new = 'GENERAL' WHERE {column_name}::text = 'QNA'"
op.execute(f"UPDATE {table_name} SET {column_name}_new = 'DEEP' WHERE {column_name}::text = 'REPORT_DEEP'") )
op.execute(f"UPDATE {table_name} SET {column_name}_new = 'DEEPER' WHERE {column_name}::text = 'REPORT_DEEPER'") op.execute(
f"UPDATE {table_name} SET {column_name}_new = 'GENERAL' WHERE {column_name}::text = 'REPORT_GENERAL'"
)
op.execute(
f"UPDATE {table_name} SET {column_name}_new = 'DEEP' WHERE {column_name}::text = 'REPORT_DEEP'"
)
op.execute(
f"UPDATE {table_name} SET {column_name}_new = 'DEEPER' WHERE {column_name}::text = 'REPORT_DEEPER'"
)
# Step 5: Drop the old column # Step 5: Drop the old column
op.execute(f"ALTER TABLE {table_name} DROP COLUMN {column_name}") op.execute(f"ALTER TABLE {table_name} DROP COLUMN {column_name}")
# Step 6: Rename the new column to the original name # Step 6: Rename the new column to the original name
op.execute(f"ALTER TABLE {table_name} RENAME COLUMN {column_name}_new TO {column_name}") op.execute(
f"ALTER TABLE {table_name} RENAME COLUMN {column_name}_new TO {column_name}"
)
# Step 7: Drop the old enum type # Step 7: Drop the old enum type
op.execute(f"DROP TYPE {old_enum_name}") op.execute(f"DROP TYPE {old_enum_name}")

87
surfsense_backend/alembic/versions/11_add_llm_config_table_and_relationships.py
View file

@ -19,7 +19,7 @@ depends_on: str | Sequence[str] | None = None
def upgrade() -> None: def upgrade() -> None:
"""Upgrade schema - add LiteLLMProvider enum, LLMConfig table and user LLM preferences.""" """Upgrade schema - add LiteLLMProvider enum, LLMConfig table and user LLM preferences."""
# Check if enum type exists and create if it doesn't # Check if enum type exists and create if it doesn't
op.execute(""" op.execute("""
DO $$ DO $$
@ -29,7 +29,7 @@ def upgrade() -> None:
END IF; END IF;
END$$; END$$;
""") """)
# Create llm_configs table using raw SQL to avoid enum creation conflicts # Create llm_configs table using raw SQL to avoid enum creation conflicts
op.execute(""" op.execute("""
CREATE TABLE llm_configs ( CREATE TABLE llm_configs (
@ -45,41 +45,70 @@ def upgrade() -> None:
user_id UUID NOT NULL REFERENCES "user"(id) ON DELETE CASCADE user_id UUID NOT NULL REFERENCES "user"(id) ON DELETE CASCADE
) )
""") """)
# Create indexes # Create indexes
op.create_index(op.f('ix_llm_configs_id'), 'llm_configs', ['id'], unique=False) op.create_index(op.f("ix_llm_configs_id"), "llm_configs", ["id"], unique=False)
op.create_index(op.f('ix_llm_configs_created_at'), 'llm_configs', ['created_at'], unique=False) op.create_index(
op.create_index(op.f('ix_llm_configs_name'), 'llm_configs', ['name'], unique=False) op.f("ix_llm_configs_created_at"), "llm_configs", ["created_at"], unique=False
)
op.create_index(op.f("ix_llm_configs_name"), "llm_configs", ["name"], unique=False)
# Add LLM preference columns to user table # Add LLM preference columns to user table
op.add_column('user', sa.Column('long_context_llm_id', sa.Integer(), nullable=True)) op.add_column("user", sa.Column("long_context_llm_id", sa.Integer(), nullable=True))
op.add_column('user', sa.Column('fast_llm_id', sa.Integer(), nullable=True)) op.add_column("user", sa.Column("fast_llm_id", sa.Integer(), nullable=True))
op.add_column('user', sa.Column('strategic_llm_id', sa.Integer(), nullable=True)) op.add_column("user", sa.Column("strategic_llm_id", sa.Integer(), nullable=True))
# Create foreign key constraints for LLM preferences # Create foreign key constraints for LLM preferences
op.create_foreign_key(op.f('fk_user_long_context_llm_id_llm_configs'), 'user', 'llm_configs', ['long_context_llm_id'], ['id'], ondelete='SET NULL') op.create_foreign_key(
op.create_foreign_key(op.f('fk_user_fast_llm_id_llm_configs'), 'user', 'llm_configs', ['fast_llm_id'], ['id'], ondelete='SET NULL') op.f("fk_user_long_context_llm_id_llm_configs"),
op.create_foreign_key(op.f('fk_user_strategic_llm_id_llm_configs'), 'user', 'llm_configs', ['strategic_llm_id'], ['id'], ondelete='SET NULL') "user",
"llm_configs",
["long_context_llm_id"],
["id"],
ondelete="SET NULL",
)
op.create_foreign_key(
op.f("fk_user_fast_llm_id_llm_configs"),
"user",
"llm_configs",
["fast_llm_id"],
["id"],
ondelete="SET NULL",
)
op.create_foreign_key(
op.f("fk_user_strategic_llm_id_llm_configs"),
"user",
"llm_configs",
["strategic_llm_id"],
["id"],
ondelete="SET NULL",
)
def downgrade() -> None: def downgrade() -> None:
"""Downgrade schema - remove LLMConfig table and user LLM preferences.""" """Downgrade schema - remove LLMConfig table and user LLM preferences."""
# Drop foreign key constraints # Drop foreign key constraints
op.drop_constraint(op.f('fk_user_strategic_llm_id_llm_configs'), 'user', type_='foreignkey') op.drop_constraint(
op.drop_constraint(op.f('fk_user_fast_llm_id_llm_configs'), 'user', type_='foreignkey') op.f("fk_user_strategic_llm_id_llm_configs"), "user", type_="foreignkey"
op.drop_constraint(op.f('fk_user_long_context_llm_id_llm_configs'), 'user', type_='foreignkey') )
op.drop_constraint(
op.f("fk_user_fast_llm_id_llm_configs"), "user", type_="foreignkey"
)
op.drop_constraint(
op.f("fk_user_long_context_llm_id_llm_configs"), "user", type_="foreignkey"
)
# Drop LLM preference columns from user table # Drop LLM preference columns from user table
op.drop_column('user', 'strategic_llm_id') op.drop_column("user", "strategic_llm_id")
op.drop_column('user', 'fast_llm_id') op.drop_column("user", "fast_llm_id")
op.drop_column('user', 'long_context_llm_id') op.drop_column("user", "long_context_llm_id")
# Drop indexes and table # Drop indexes and table
op.drop_index(op.f('ix_llm_configs_name'), table_name='llm_configs') op.drop_index(op.f("ix_llm_configs_name"), table_name="llm_configs")
op.drop_index(op.f('ix_llm_configs_created_at'), table_name='llm_configs') op.drop_index(op.f("ix_llm_configs_created_at"), table_name="llm_configs")
op.drop_index(op.f('ix_llm_configs_id'), table_name='llm_configs') op.drop_index(op.f("ix_llm_configs_id"), table_name="llm_configs")
op.drop_table('llm_configs') op.drop_table("llm_configs")
# Drop LiteLLMProvider enum # Drop LiteLLMProvider enum
op.execute("DROP TYPE IF EXISTS litellmprovider") op.execute("DROP TYPE IF EXISTS litellmprovider")

40
surfsense_backend/alembic/versions/12_add_logs_table.py
View file

@ -17,17 +17,17 @@ depends_on: str | Sequence[str] | None = None
def upgrade() -> None: def upgrade() -> None:
"""Upgrade schema - add LogLevel and LogStatus enums and logs table.""" """Upgrade schema - add LogLevel and LogStatus enums and logs table."""
# Create LogLevel enum # Create LogLevel enum
op.execute(""" op.execute("""
CREATE TYPE loglevel AS ENUM ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL') CREATE TYPE loglevel AS ENUM ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL')
""") """)
# Create LogStatus enum # Create LogStatus enum
op.execute(""" op.execute("""
CREATE TYPE logstatus AS ENUM ('IN_PROGRESS', 'SUCCESS', 'FAILED') CREATE TYPE logstatus AS ENUM ('IN_PROGRESS', 'SUCCESS', 'FAILED')
""") """)
# Create logs table # Create logs table
op.execute(""" op.execute("""
CREATE TABLE logs ( CREATE TABLE logs (
@ -41,28 +41,28 @@ def upgrade() -> None:
search_space_id INTEGER NOT NULL REFERENCES searchspaces(id) ON DELETE CASCADE search_space_id INTEGER NOT NULL REFERENCES searchspaces(id) ON DELETE CASCADE
) )
""") """)
# Create indexes # Create indexes
op.create_index(op.f('ix_logs_id'), 'logs', ['id'], unique=False) op.create_index(op.f("ix_logs_id"), "logs", ["id"], unique=False)
op.create_index(op.f('ix_logs_created_at'), 'logs', ['created_at'], unique=False) op.create_index(op.f("ix_logs_created_at"), "logs", ["created_at"], unique=False)
op.create_index(op.f('ix_logs_level'), 'logs', ['level'], unique=False) op.create_index(op.f("ix_logs_level"), "logs", ["level"], unique=False)
op.create_index(op.f('ix_logs_status'), 'logs', ['status'], unique=False) op.create_index(op.f("ix_logs_status"), "logs", ["status"], unique=False)
op.create_index(op.f('ix_logs_source'), 'logs', ['source'], unique=False) op.create_index(op.f("ix_logs_source"), "logs", ["source"], unique=False)
def downgrade() -> None: def downgrade() -> None:
"""Downgrade schema - remove logs table and enums.""" """Downgrade schema - remove logs table and enums."""
# Drop indexes # Drop indexes
op.drop_index(op.f('ix_logs_source'), table_name='logs') op.drop_index(op.f("ix_logs_source"), table_name="logs")
op.drop_index(op.f('ix_logs_status'), table_name='logs') op.drop_index(op.f("ix_logs_status"), table_name="logs")
op.drop_index(op.f('ix_logs_level'), table_name='logs') op.drop_index(op.f("ix_logs_level"), table_name="logs")
op.drop_index(op.f('ix_logs_created_at'), table_name='logs') op.drop_index(op.f("ix_logs_created_at"), table_name="logs")
op.drop_index(op.f('ix_logs_id'), table_name='logs') op.drop_index(op.f("ix_logs_id"), table_name="logs")
# Drop logs table # Drop logs table
op.drop_table('logs') op.drop_table("logs")
# Drop enums # Drop enums
op.execute("DROP TYPE IF EXISTS logstatus") op.execute("DROP TYPE IF EXISTS logstatus")
op.execute("DROP TYPE IF EXISTS loglevel") op.execute("DROP TYPE IF EXISTS loglevel")

21
surfsense_backend/alembic/versions/2_add_linear_connector_enum.py
View file

@ -4,23 +4,24 @@ Revision ID: 2
Revises: e55302644c51 Revises: e55302644c51
""" """
from collections.abc import Sequence from collections.abc import Sequence
from alembic import op from alembic import op
# revision identifiers, used by Alembic. # revision identifiers, used by Alembic.
revision: str = '2' revision: str = "2"
down_revision: str | None = 'e55302644c51' down_revision: str | None = "e55302644c51"
branch_labels: str | Sequence[str] | None = None branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None depends_on: str | Sequence[str] | None = None
def upgrade() -> None: def upgrade() -> None:
# ### commands auto generated by Alembic - please adjust! ### # ### commands auto generated by Alembic - please adjust! ###
# Manually add the command to add the enum value # Manually add the command to add the enum value
op.execute("ALTER TYPE searchsourceconnectortype ADD VALUE 'LINEAR_CONNECTOR'") op.execute("ALTER TYPE searchsourceconnectortype ADD VALUE 'LINEAR_CONNECTOR'")
# Pass for the rest, as autogenerate didn't run to add other schema details # Pass for the rest, as autogenerate didn't run to add other schema details
pass pass
# ### end Alembic commands ### # ### end Alembic commands ###
@ -28,10 +29,14 @@ def upgrade() -> None:
def downgrade() -> None: def downgrade() -> None:
# ### commands auto generated by Alembic - please adjust! ### # ### commands auto generated by Alembic - please adjust! ###
# Downgrading removal of an enum value requires recreating the type # Downgrading removal of an enum value requires recreating the type
op.execute("ALTER TYPE searchsourceconnectortype RENAME TO searchsourceconnectortype_old") op.execute(
op.execute("CREATE TYPE searchsourceconnectortype AS ENUM('SERPER_API', 'TAVILY_API', 'SLACK_CONNECTOR', 'NOTION_CONNECTOR', 'GITHUB_CONNECTOR')") "ALTER TYPE searchsourceconnectortype RENAME TO searchsourceconnectortype_old"
)
op.execute(
"CREATE TYPE searchsourceconnectortype AS ENUM('SERPER_API', 'TAVILY_API', 'SLACK_CONNECTOR', 'NOTION_CONNECTOR', 'GITHUB_CONNECTOR')"
)
op.execute( op.execute(
"ALTER TABLE search_source_connectors ALTER COLUMN connector_type TYPE searchsourceconnectortype USING " "ALTER TABLE search_source_connectors ALTER COLUMN connector_type TYPE searchsourceconnectortype USING "
"connector_type::text::searchsourceconnectortype" "connector_type::text::searchsourceconnectortype"
@ -39,4 +44,4 @@ def downgrade() -> None:
op.execute("DROP TYPE searchsourceconnectortype_old") op.execute("DROP TYPE searchsourceconnectortype_old")
pass pass
# ### end Alembic commands ### # ### end Alembic commands ###

38
surfsense_backend/alembic/versions/3_add_linear_connector_to_documenttype_.py
View file

@ -4,24 +4,26 @@ Revision ID: 3
Revises: 2 Revises: 2
""" """
from collections.abc import Sequence from collections.abc import Sequence
from alembic import op from alembic import op
# revision identifiers, used by Alembic. # revision identifiers, used by Alembic.
revision: str = '3' revision: str = "3"
down_revision: str | None = '2' down_revision: str | None = "2"
branch_labels: str | Sequence[str] | None = None branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None depends_on: str | Sequence[str] | None = None
# Define the ENUM type name and the new value # Define the ENUM type name and the new value
ENUM_NAME = 'documenttype' # Make sure this matches the name in your DB (usually lowercase class name) ENUM_NAME = "documenttype" # Make sure this matches the name in your DB (usually lowercase class name)
NEW_VALUE = 'LINEAR_CONNECTOR' NEW_VALUE = "LINEAR_CONNECTOR"
def upgrade() -> None: def upgrade() -> None:
"""Upgrade schema.""" """Upgrade schema."""
op.execute(f"ALTER TYPE {ENUM_NAME} ADD VALUE '{NEW_VALUE}'") op.execute(f"ALTER TYPE {ENUM_NAME} ADD VALUE '{NEW_VALUE}'")
# Warning: This will delete all rows with the new value # Warning: This will delete all rows with the new value
def downgrade() -> None: def downgrade() -> None:
@ -32,19 +34,19 @@ def downgrade() -> None:
# Enum values *before* LINEAR_CONNECTOR was added # Enum values *before* LINEAR_CONNECTOR was added
old_values = ( old_values = (
'EXTENSION', "EXTENSION",
'CRAWLED_URL', "CRAWLED_URL",
'FILE', "FILE",
'SLACK_CONNECTOR', "SLACK_CONNECTOR",
'NOTION_CONNECTOR', "NOTION_CONNECTOR",
'YOUTUBE_VIDEO', "YOUTUBE_VIDEO",
'GITHUB_CONNECTOR' "GITHUB_CONNECTOR",
) )
old_values_sql = ", ".join([f"'{v}'" for v in old_values]) old_values_sql = ", ".join([f"'{v}'" for v in old_values])
# Table and column names (adjust if different) # Table and column names (adjust if different)
table_name = 'documents' table_name = "documents"
column_name = 'document_type' column_name = "document_type"
# 1. Rename the current enum type # 1. Rename the current enum type
op.execute(f"ALTER TYPE {ENUM_NAME} RENAME TO {old_enum_name}") op.execute(f"ALTER TYPE {ENUM_NAME} RENAME TO {old_enum_name}")
@ -52,10 +54,8 @@ def downgrade() -> None:
# 2. Create the new enum type with the old values # 2. Create the new enum type with the old values
op.execute(f"CREATE TYPE {ENUM_NAME} AS ENUM({old_values_sql})") op.execute(f"CREATE TYPE {ENUM_NAME} AS ENUM({old_values_sql})")
# 3. Update the table: # 3. Update the table:
op.execute( op.execute(f"DELETE FROM {table_name} WHERE {column_name}::text = '{NEW_VALUE}'")
f"DELETE FROM {table_name} WHERE {column_name}::text = '{NEW_VALUE}'"
)
# 4. Alter the column to use the new enum type (casting old values) # 4. Alter the column to use the new enum type (casting old values)
op.execute( op.execute(
@ -65,4 +65,4 @@ def downgrade() -> None:
# 5. Drop the old enum type # 5. Drop the old enum type
op.execute(f"DROP TYPE {old_enum_name}") op.execute(f"DROP TYPE {old_enum_name}")
# ### end Alembic commands ### # ### end Alembic commands ###

21
surfsense_backend/alembic/versions/4_add_linkup_api_enum.py
View file

@ -4,23 +4,24 @@ Revision ID: 4
Revises: 3 Revises: 3
""" """
from collections.abc import Sequence from collections.abc import Sequence
from alembic import op from alembic import op
# revision identifiers, used by Alembic. # revision identifiers, used by Alembic.
revision: str = '4' revision: str = "4"
down_revision: str | None = '3' down_revision: str | None = "3"
branch_labels: str | Sequence[str] | None = None branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None depends_on: str | Sequence[str] | None = None
def upgrade() -> None: def upgrade() -> None:
# ### commands auto generated by Alembic - please adjust! ### # ### commands auto generated by Alembic - please adjust! ###
# Manually add the command to add the enum value # Manually add the command to add the enum value
op.execute("ALTER TYPE searchsourceconnectortype ADD VALUE 'LINKUP_API'") op.execute("ALTER TYPE searchsourceconnectortype ADD VALUE 'LINKUP_API'")
# Pass for the rest, as autogenerate didn't run to add other schema details # Pass for the rest, as autogenerate didn't run to add other schema details
pass pass
# ### end Alembic commands ### # ### end Alembic commands ###
@ -28,10 +29,14 @@ def upgrade() -> None:
def downgrade() -> None: def downgrade() -> None:
# ### commands auto generated by Alembic - please adjust! ### # ### commands auto generated by Alembic - please adjust! ###
# Downgrading removal of an enum value requires recreating the type # Downgrading removal of an enum value requires recreating the type
op.execute("ALTER TYPE searchsourceconnectortype RENAME TO searchsourceconnectortype_old") op.execute(
op.execute("CREATE TYPE searchsourceconnectortype AS ENUM('SERPER_API', 'TAVILY_API', 'SLACK_CONNECTOR', 'NOTION_CONNECTOR', 'GITHUB_CONNECTOR', 'LINEAR_CONNECTOR')") "ALTER TYPE searchsourceconnectortype RENAME TO searchsourceconnectortype_old"
)
op.execute(
"CREATE TYPE searchsourceconnectortype AS ENUM('SERPER_API', 'TAVILY_API', 'SLACK_CONNECTOR', 'NOTION_CONNECTOR', 'GITHUB_CONNECTOR', 'LINEAR_CONNECTOR')"
)
op.execute( op.execute(
"ALTER TABLE search_source_connectors ALTER COLUMN connector_type TYPE searchsourceconnectortype USING " "ALTER TABLE search_source_connectors ALTER COLUMN connector_type TYPE searchsourceconnectortype USING "
"connector_type::text::searchsourceconnectortype" "connector_type::text::searchsourceconnectortype"
@ -39,4 +44,4 @@ def downgrade() -> None:
op.execute("DROP TYPE searchsourceconnectortype_old") op.execute("DROP TYPE searchsourceconnectortype_old")
pass pass
# ### end Alembic commands ### # ### end Alembic commands ###

79
surfsense_backend/alembic/versions/5_remove_title_char_limit.py
View file

@ -4,6 +4,7 @@ Revision ID: 5
Revises: 4 Revises: 4
""" """
from collections.abc import Sequence from collections.abc import Sequence
import sqlalchemy as sa import sqlalchemy as sa
@ -11,47 +12,65 @@ import sqlalchemy as sa
from alembic import op from alembic import op
# revision identifiers, used by Alembic. # revision identifiers, used by Alembic.
revision: str = '5' revision: str = "5"
down_revision: str | None = '4' down_revision: str | None = "4"
branch_labels: str | Sequence[str] | None = None branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None depends_on: str | Sequence[str] | None = None
def upgrade() -> None: def upgrade() -> None:
# Alter Chat table # Alter Chat table
op.alter_column('chats', 'title', op.alter_column(
existing_type=sa.String(200), "chats",
type_=sa.String(), "title",
existing_nullable=False) existing_type=sa.String(200),
type_=sa.String(),
existing_nullable=False,
)
# Alter Document table # Alter Document table
op.alter_column('documents', 'title', op.alter_column(
existing_type=sa.String(200), "documents",
type_=sa.String(), "title",
existing_nullable=False) existing_type=sa.String(200),
type_=sa.String(),
existing_nullable=False,
)
# Alter Podcast table # Alter Podcast table
op.alter_column('podcasts', 'title', op.alter_column(
existing_type=sa.String(200), "podcasts",
type_=sa.String(), "title",
existing_nullable=False) existing_type=sa.String(200),
type_=sa.String(),
existing_nullable=False,
)
def downgrade() -> None: def downgrade() -> None:
# Revert Chat table # Revert Chat table
op.alter_column('chats', 'title', op.alter_column(
existing_type=sa.String(), "chats",
type_=sa.String(200), "title",
existing_nullable=False) existing_type=sa.String(),
type_=sa.String(200),
existing_nullable=False,
)
# Revert Document table # Revert Document table
op.alter_column('documents', 'title', op.alter_column(
existing_type=sa.String(), "documents",
type_=sa.String(200), "title",
existing_nullable=False) existing_type=sa.String(),
type_=sa.String(200),
existing_nullable=False,
)
# Revert Podcast table # Revert Podcast table
op.alter_column('podcasts', 'title', op.alter_column(
existing_type=sa.String(), "podcasts",
type_=sa.String(200), "title",
existing_nullable=False) existing_type=sa.String(),
type_=sa.String(200),
existing_nullable=False,
)

35
surfsense_backend/alembic/versions/6_change_podcast_content_to_transcript.py
View file

@ -4,6 +4,7 @@ Revision ID: 6
Revises: 5 Revises: 5
""" """
from collections.abc import Sequence from collections.abc import Sequence
import sqlalchemy as sa import sqlalchemy as sa
@ -12,8 +13,8 @@ from sqlalchemy.dialects.postgresql import JSON
from alembic import op from alembic import op
# revision identifiers, used by Alembic. # revision identifiers, used by Alembic.
revision: str = '6' revision: str = "6"
down_revision: str | None = '5' down_revision: str | None = "5"
branch_labels: str | Sequence[str] | None = None branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None depends_on: str | Sequence[str] | None = None
@ -21,23 +22,33 @@ depends_on: str | Sequence[str] | None = None
def upgrade() -> None: def upgrade() -> None:
# Drop the old column and create a new one with the new name and type # Drop the old column and create a new one with the new name and type
# We need to do this because PostgreSQL doesn't support direct column renames with type changes # We need to do this because PostgreSQL doesn't support direct column renames with type changes
op.add_column('podcasts', sa.Column('podcast_transcript', JSON, nullable=False, server_default='{}')) op.add_column(
"podcasts",
sa.Column("podcast_transcript", JSON, nullable=False, server_default="{}"),
)
# Copy data from old column to new column # Copy data from old column to new column
# Convert text to JSON by storing it as a JSON string value # Convert text to JSON by storing it as a JSON string value
op.execute("UPDATE podcasts SET podcast_transcript = jsonb_build_object('text', podcast_content) WHERE podcast_content != ''") op.execute(
"UPDATE podcasts SET podcast_transcript = jsonb_build_object('text', podcast_content) WHERE podcast_content != ''"
)
# Drop the old column # Drop the old column
op.drop_column('podcasts', 'podcast_content') op.drop_column("podcasts", "podcast_content")
def downgrade() -> None: def downgrade() -> None:
# Add back the original column # Add back the original column
op.add_column('podcasts', sa.Column('podcast_content', sa.Text(), nullable=False, server_default='')) op.add_column(
"podcasts",
sa.Column("podcast_content", sa.Text(), nullable=False, server_default=""),
)
# Copy data from JSON column back to text column # Copy data from JSON column back to text column
# Extract the 'text' field if it exists, otherwise use empty string # Extract the 'text' field if it exists, otherwise use empty string
op.execute("UPDATE podcasts SET podcast_content = COALESCE((podcast_transcript->>'text'), '')") op.execute(
"UPDATE podcasts SET podcast_content = COALESCE((podcast_transcript->>'text'), '')"
)
# Drop the new column # Drop the new column
op.drop_column('podcasts', 'podcast_transcript') op.drop_column("podcasts", "podcast_transcript")

12
surfsense_backend/alembic/versions/7_remove_is_generated_column.py
View file

@ -4,6 +4,7 @@ Revision ID: 7
Revises: 6 Revises: 6
""" """
from collections.abc import Sequence from collections.abc import Sequence
import sqlalchemy as sa import sqlalchemy as sa
@ -11,17 +12,20 @@ import sqlalchemy as sa
from alembic import op from alembic import op
# revision identifiers, used by Alembic. # revision identifiers, used by Alembic.
revision: str = '7' revision: str = "7"
down_revision: str | None = '6' down_revision: str | None = "6"
branch_labels: str | Sequence[str] | None = None branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None depends_on: str | Sequence[str] | None = None
def upgrade() -> None: def upgrade() -> None:
# Drop the is_generated column # Drop the is_generated column
op.drop_column('podcasts', 'is_generated') op.drop_column("podcasts", "is_generated")
def downgrade() -> None: def downgrade() -> None:
# Add back the is_generated column with its original constraints # Add back the is_generated column with its original constraints
op.add_column('podcasts', sa.Column('is_generated', sa.Boolean(), nullable=False, server_default='false')) op.add_column(
"podcasts",
sa.Column("is_generated", sa.Boolean(), nullable=False, server_default="false"),
)

35
surfsense_backend/alembic/versions/8_add_content_hash_to_documents.py
View file

@ -3,6 +3,7 @@
Revision ID: 8 Revision ID: 8
Revises: 7 Revises: 7
""" """
from collections.abc import Sequence from collections.abc import Sequence
import sqlalchemy as sa import sqlalchemy as sa
@ -10,16 +11,16 @@ import sqlalchemy as sa
from alembic import op from alembic import op
# revision identifiers, used by Alembic. # revision identifiers, used by Alembic.
revision: str = '8' revision: str = "8"
down_revision: str | None = '7' down_revision: str | None = "7"
branch_labels: str | Sequence[str] | None = None branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None depends_on: str | Sequence[str] | None = None
def upgrade() -> None: def upgrade() -> None:
# Add content_hash column as nullable first to handle existing data # Add content_hash column as nullable first to handle existing data
op.add_column('documents', sa.Column('content_hash', sa.String(), nullable=True)) op.add_column("documents", sa.Column("content_hash", sa.String(), nullable=True))
# Update existing documents to generate content hashes # Update existing documents to generate content hashes
# Using SHA-256 hash of the content column with proper UTF-8 encoding # Using SHA-256 hash of the content column with proper UTF-8 encoding
op.execute(""" op.execute("""
@ -27,7 +28,7 @@ def upgrade() -> None:
SET content_hash = encode(sha256(convert_to(content, 'UTF8')), 'hex') SET content_hash = encode(sha256(convert_to(content, 'UTF8')), 'hex')
WHERE content_hash IS NULL WHERE content_hash IS NULL
""") """)
# Handle duplicate content hashes by keeping only the oldest document for each hash # Handle duplicate content hashes by keeping only the oldest document for each hash
# Delete newer documents with duplicate content hashes # Delete newer documents with duplicate content hashes
op.execute(""" op.execute("""
@ -38,19 +39,23 @@ def upgrade() -> None:
GROUP BY content_hash GROUP BY content_hash
) )
""") """)
# Now alter the column to match the model: nullable=False, index=True, unique=True # Now alter the column to match the model: nullable=False, index=True, unique=True
op.alter_column('documents', 'content_hash', op.alter_column(
existing_type=sa.String(), "documents", "content_hash", existing_type=sa.String(), nullable=False
nullable=False) )
op.create_index(op.f('ix_documents_content_hash'), 'documents', ['content_hash'], unique=False) op.create_index(
op.create_unique_constraint(op.f('uq_documents_content_hash'), 'documents', ['content_hash']) op.f("ix_documents_content_hash"), "documents", ["content_hash"], unique=False
)
op.create_unique_constraint(
op.f("uq_documents_content_hash"), "documents", ["content_hash"]
)
def downgrade() -> None: def downgrade() -> None:
# Remove constraints and index first # Remove constraints and index first
op.drop_constraint(op.f('uq_documents_content_hash'), 'documents', type_='unique') op.drop_constraint(op.f("uq_documents_content_hash"), "documents", type_="unique")
op.drop_index(op.f('ix_documents_content_hash'), table_name='documents') op.drop_index(op.f("ix_documents_content_hash"), table_name="documents")
# Remove content_hash column from documents table # Remove content_hash column from documents table
op.drop_column('documents', 'content_hash') op.drop_column("documents", "content_hash")

1
surfsense_backend/alembic/versions/9_add_discord_connector_enum_and_documenttype.py
View file

@ -83,7 +83,6 @@ def downgrade() -> None:
# 4. Drop the old connector enum type # 4. Drop the old connector enum type
op.execute(f"DROP TYPE {old_connector_enum_name}") op.execute(f"DROP TYPE {old_connector_enum_name}")
# Document Enum Downgrade Steps # Document Enum Downgrade Steps
# 1. Rename the current document enum type # 1. Rename the current document enum type
op.execute(f"ALTER TYPE {DOCUMENT_ENUM} RENAME TO {old_document_enum_name}") op.execute(f"ALTER TYPE {DOCUMENT_ENUM} RENAME TO {old_document_enum_name}")

36
surfsense_backend/alembic/versions/e55302644c51_add_github_connector_to_documenttype_.py
View file

@ -4,24 +4,26 @@ Revision ID: e55302644c51
Revises: 1 Revises: 1
""" """
from collections.abc import Sequence from collections.abc import Sequence
from alembic import op from alembic import op
# revision identifiers, used by Alembic. # revision identifiers, used by Alembic.
revision: str = 'e55302644c51' revision: str = "e55302644c51"
down_revision: str | None = '1' down_revision: str | None = "1"
branch_labels: str | Sequence[str] | None = None branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None depends_on: str | Sequence[str] | None = None
# Define the ENUM type name and the new value # Define the ENUM type name and the new value
ENUM_NAME = 'documenttype' # Make sure this matches the name in your DB (usually lowercase class name) ENUM_NAME = "documenttype" # Make sure this matches the name in your DB (usually lowercase class name)
NEW_VALUE = 'GITHUB_CONNECTOR' NEW_VALUE = "GITHUB_CONNECTOR"
def upgrade() -> None: def upgrade() -> None:
"""Upgrade schema.""" """Upgrade schema."""
op.execute(f"ALTER TYPE {ENUM_NAME} ADD VALUE '{NEW_VALUE}'") op.execute(f"ALTER TYPE {ENUM_NAME} ADD VALUE '{NEW_VALUE}'")
# Warning: This will delete all rows with the new value # Warning: This will delete all rows with the new value
def downgrade() -> None: def downgrade() -> None:
@ -32,18 +34,18 @@ def downgrade() -> None:
# Enum values *before* GITHUB_CONNECTOR was added # Enum values *before* GITHUB_CONNECTOR was added
old_values = ( old_values = (
'EXTENSION', "EXTENSION",
'CRAWLED_URL', "CRAWLED_URL",
'FILE', "FILE",
'SLACK_CONNECTOR', "SLACK_CONNECTOR",
'NOTION_CONNECTOR', "NOTION_CONNECTOR",
'YOUTUBE_VIDEO' "YOUTUBE_VIDEO",
) )
old_values_sql = ", ".join([f"'{v}'" for v in old_values]) old_values_sql = ", ".join([f"'{v}'" for v in old_values])
# Table and column names (adjust if different) # Table and column names (adjust if different)
table_name = 'documents' table_name = "documents"
column_name = 'document_type' column_name = "document_type"
# 1. Rename the current enum type # 1. Rename the current enum type
op.execute(f"ALTER TYPE {ENUM_NAME} RENAME TO {old_enum_name}") op.execute(f"ALTER TYPE {ENUM_NAME} RENAME TO {old_enum_name}")
@ -51,10 +53,8 @@ def downgrade() -> None:
# 2. Create the new enum type with the old values # 2. Create the new enum type with the old values
op.execute(f"CREATE TYPE {ENUM_NAME} AS ENUM({old_values_sql})") op.execute(f"CREATE TYPE {ENUM_NAME} AS ENUM({old_values_sql})")
# 3. Update the table: # 3. Update the table:
op.execute( op.execute(f"DELETE FROM {table_name} WHERE {column_name}::text = '{NEW_VALUE}'")
f"DELETE FROM {table_name} WHERE {column_name}::text = '{NEW_VALUE}'"
)
# 4. Alter the column to use the new enum type (casting old values) # 4. Alter the column to use the new enum type (casting old values)
op.execute( op.execute(
@ -64,4 +64,4 @@ def downgrade() -> None:
# 5. Drop the old enum type # 5. Drop the old enum type
op.execute(f"DROP TYPE {old_enum_name}") op.execute(f"DROP TYPE {old_enum_name}")
# ### end Alembic commands ### # ### end Alembic commands ###