From 04c05e4f9aae1395ef6b7d33cbe1581efe5c42cc Mon Sep 17 00:00:00 2001 From: swve Date: Thu, 11 Jul 2024 19:57:12 +0200 Subject: [PATCH] feat: init alembic + add init revision --- apps/api/alembic.ini | 116 ++++++++++++++++++ apps/api/migrations/env.py | 110 +++++++++++++++++ apps/api/migrations/script.py.mako | 27 ++++ .../df2981bf24dd_initial_migration.py | 51 ++++++++ apps/api/poetry.lock | 40 +++++- apps/api/pyproject.toml | 1 + apps/api/src/db/courses/activities.py | 11 +- 7 files changed, 348 insertions(+), 8 deletions(-) create mode 100644 apps/api/alembic.ini create mode 100644 apps/api/migrations/env.py create mode 100644 apps/api/migrations/script.py.mako create mode 100644 apps/api/migrations/versions/df2981bf24dd_initial_migration.py diff --git a/apps/api/alembic.ini b/apps/api/alembic.ini new file mode 100644 index 00000000..58e115a0 --- /dev/null +++ b/apps/api/alembic.ini @@ -0,0 +1,116 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +# Use forward slashes (/) also on windows to provide an os agnostic path +script_location = migrations + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python>=3.9 or backports.zoneinfo library. +# Any required deps can installed by adding `alembic[tz]` to the pip requirements +# string value is passed to ZoneInfo() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; This defaults +# to migrations/versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "version_path_separator" below. +# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep. +# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas. +# Valid values for version_path_separator are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = postgresql://learnhouse:learnhouse@localhost:5432/learnhouse + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# lint with attempts to fix using "ruff" - use the exec runner, execute a binary +# hooks = ruff +# ruff.type = exec +# ruff.executable = %(here)s/.venv/bin/ruff +# ruff.options = --fix REVISION_SCRIPT_FILENAME + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/apps/api/migrations/env.py b/apps/api/migrations/env.py new file mode 100644 index 00000000..41302d3d --- /dev/null +++ b/apps/api/migrations/env.py @@ -0,0 +1,110 @@ +import importlib +from logging.config import fileConfig +import os + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from sqlmodel import SQLModel +from alembic import context + +from config.config import get_learnhouse_config + +# LearnHouse config + +lh_config = get_learnhouse_config() + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata + +# IMPORTING ALL SCHEMAS +base_dir = 'src/db' +base_module_path = 'src.db' + +# Recursively walk through the base directory +for root, dirs, files in os.walk(base_dir): + # Filter out __init__.py and non-Python files + module_files = [f for f in files if f.endswith('.py') and f != '__init__.py'] + # Calculate the module's base path from its directory structure + path_diff = os.path.relpath(root, base_dir) + if path_diff == '.': + # Root of the base_dir, no additional path to add + current_module_base = base_module_path + else: + # Convert directory path to a module path + current_module_base = f"{base_module_path}.{path_diff.replace(os.sep, '.')}" + + # Dynamically import each module + for file_name in module_files: + module_name = file_name[:-3] # Remove the '.py' extension + full_module_path = f"{current_module_base}.{module_name}" + importlib.import_module(full_module_path) + +# IMPORTING ALL SCHEMAS + +target_metadata = SQLModel.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline() -> None: + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section, {}), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure(connection=connection, target_metadata=target_metadata) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/apps/api/migrations/script.py.mako b/apps/api/migrations/script.py.mako new file mode 100644 index 00000000..6ce33510 --- /dev/null +++ b/apps/api/migrations/script.py.mako @@ -0,0 +1,27 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +import sqlmodel +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} + + +def upgrade() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/apps/api/migrations/versions/df2981bf24dd_initial_migration.py b/apps/api/migrations/versions/df2981bf24dd_initial_migration.py new file mode 100644 index 00000000..e27b5c33 --- /dev/null +++ b/apps/api/migrations/versions/df2981bf24dd_initial_migration.py @@ -0,0 +1,51 @@ +"""Initial Migration + +Revision ID: df2981bf24dd +Revises: +Create Date: 2024-07-11 19:33:37.993767 + +""" +from typing import Sequence, Union + +from alembic import op +from grpc import server +import sqlalchemy as sa +import sqlmodel + + +# revision identifiers, used by Alembic. +revision: str = 'df2981bf24dd' +down_revision: Union[str, None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('activity', sa.Column('published', sa.Boolean(), nullable=False, server_default=sa.true())) + op.drop_column('activity', 'published_version') + op.drop_column('activity', 'version') + + op.drop_column('assignmentusersubmission', 'assignment_user_uuid') + + op.drop_constraint('trail_org_id_fkey', 'trail', type_='foreignkey') + op.create_foreign_key('trail_org_id_fkey', 'trail', 'organization', ['org_id'], ['id'], ondelete='CASCADE') + op.drop_constraint('trail_user_id_fkey', 'trail', type_='foreignkey') + op.create_foreign_key('trail_user_id_fkey', 'trail', 'user', ['user_id'], ['id'], ondelete='CASCADE') + + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_constraint('trail_org_id_fkey', 'trail', type_='foreignkey') + op.create_foreign_key('trail_org_id_fkey', 'trail', 'organization', ['org_id'], ['id']) + op.drop_constraint('trail_user_id_fkey', 'trail', type_='foreignkey') + op.create_foreign_key('trail_user_id_fkey', 'trail', 'user', ['user_id'], ['id']) + + op.add_column('assignmentusersubmission', sa.Column('assignment_user_uuid', sa.VARCHAR(), autoincrement=False, nullable=False)) + + op.add_column('activity', sa.Column('version', sa.INTEGER(), autoincrement=False, nullable=False , server_default=sa.text('1'))) + op.add_column('activity', sa.Column('published_version', sa.INTEGER(), autoincrement=False, nullable=False , server_default=sa.text('1')) ) + op.drop_column('activity', 'published') + # ### end Alembic commands ### diff --git a/apps/api/poetry.lock b/apps/api/poetry.lock index deb41715..5aae9088 100644 --- a/apps/api/poetry.lock +++ b/apps/api/poetry.lock @@ -109,6 +109,25 @@ files = [ [package.dependencies] frozenlist = ">=1.1.0" +[[package]] +name = "alembic" +version = "1.13.2" +description = "A database migration tool for SQLAlchemy." +optional = false +python-versions = ">=3.8" +files = [ + {file = "alembic-1.13.2-py3-none-any.whl", hash = "sha256:6b8733129a6224a9a711e17c99b08462dbf7cc9670ba8f2e2ae9af860ceb1953"}, + {file = "alembic-1.13.2.tar.gz", hash = "sha256:1ff0ae32975f4fd96028c39ed9bb3c867fe3af956bd7bb37343b54c9fe7445ef"}, +] + +[package.dependencies] +Mako = "*" +SQLAlchemy = ">=1.3.0" +typing-extensions = ">=4" + +[package.extras] +tz = ["backports.zoneinfo"] + [[package]] name = "anyio" version = "4.4.0" @@ -1419,6 +1438,25 @@ files = [ pydantic = ">=1,<3" requests = ">=2,<3" +[[package]] +name = "mako" +version = "1.3.5" +description = "A super-fast templating language that borrows the best ideas from the existing templating languages." +optional = false +python-versions = ">=3.8" +files = [ + {file = "Mako-1.3.5-py3-none-any.whl", hash = "sha256:260f1dbc3a519453a9c856dedfe4beb4e50bd5a26d96386cb6c80856556bb91a"}, + {file = "Mako-1.3.5.tar.gz", hash = "sha256:48dbc20568c1d276a2698b36d968fa76161bf127194907ea6fc594fa81f943bc"}, +] + +[package.dependencies] +MarkupSafe = ">=0.9.2" + +[package.extras] +babel = ["Babel"] +lingua = ["lingua"] +testing = ["pytest"] + [[package]] name = "markdown-it-py" version = "3.0.0" @@ -3833,4 +3871,4 @@ test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", [metadata] lock-version = "2.0" python-versions = "^3.12" -content-hash = "2ede6d1fb6efc6ff9e32b19be61139c9bb9fca4a9c84ac290a8278ea7812aed8" +content-hash = "76c4defc807fe83375766ac085982a2edf16e57b2d092a4494021f00a0424a4c" diff --git a/apps/api/pyproject.toml b/apps/api/pyproject.toml index 1ea47def..0632d60b 100644 --- a/apps/api/pyproject.toml +++ b/apps/api/pyproject.toml @@ -38,6 +38,7 @@ tiktoken = "^0.7.0" uvicorn = "0.30.1" typer = "^0.12.3" chromadb = "^0.5.3" +alembic = "^1.13.2" [build-system] build-backend = "poetry.core.masonry.api" diff --git a/apps/api/src/db/courses/activities.py b/apps/api/src/db/courses/activities.py index 3db42b2a..8e40e21a 100644 --- a/apps/api/src/db/courses/activities.py +++ b/apps/api/src/db/courses/activities.py @@ -8,7 +8,7 @@ class ActivityTypeEnum(str, Enum): TYPE_VIDEO = "TYPE_VIDEO" TYPE_DOCUMENT = "TYPE_DOCUMENT" TYPE_DYNAMIC = "TYPE_DYNAMIC" - TYPE_ASSESSMENT = "TYPE_ASSESSMENT" + TYPE_ASSIGNMENT = "TYPE_ASSIGNMENT" TYPE_CUSTOM = "TYPE_CUSTOM" @@ -21,8 +21,8 @@ class ActivitySubTypeEnum(str, Enum): # Document SUBTYPE_DOCUMENT_PDF = "SUBTYPE_DOCUMENT_PDF" SUBTYPE_DOCUMENT_DOC = "SUBTYPE_DOCUMENT_DOC" - # Assessment - SUBTYPE_ASSESSMENT_QUIZ = "SUBTYPE_ASSESSMENT_QUIZ" + # Assignment + SUBTYPE_ASSIGNMENT_ANY = "SUBTYPE_ASSIGNMENT_ANY" # Custom SUBTYPE_CUSTOM = "SUBTYPE_CUSTOM" @@ -32,8 +32,7 @@ class ActivityBase(SQLModel): activity_type: ActivityTypeEnum = ActivityTypeEnum.TYPE_CUSTOM activity_sub_type: ActivitySubTypeEnum = ActivitySubTypeEnum.SUBTYPE_CUSTOM content: dict = Field(default={}, sa_column=Column(JSON)) - published_version: int - version: int + published: bool = False class Activity(ActivityBase, table=True): @@ -57,8 +56,6 @@ class ActivityCreate(ActivityBase): class ActivityUpdate(ActivityBase): name: Optional[str] - activity_type: Optional[ActivityTypeEnum] - activity_sub_type: Optional[ActivitySubTypeEnum] content: dict = Field(default={}, sa_column=Column(JSON)) published_version: Optional[int] version: Optional[int]