Merge pull request #19 from toptal/devx-3856-switch-to-postgres

Switch to PostgreSQL

.env.example

@@ -3,10 +3,6 @@
 NUR_API_HOST=localhost
 NUR_API_PORT=8080
 
-CHROMA_HOST=localhost
-CHROMA_PORT=8000
-CHROMA_DATABASE=default_database
-
 CONFLUENCE_BASE_URL="https://<namespace>.atlassian.net/"
 CONFLUENCE_USER="[email protected]"
 CONFLUENCE_API_TOKEN="???"
@@ -23,3 +19,14 @@ SLACK_CHANNEL_ID_KNOWLEDGE_GAP_DISCUSSIONS="???"
 # "*" means that any value would be accepted.
 SLACK_ALLOW_ENTERPRISE_ID="*"
 SLACK_ALLOW_TEAM_ID="*"
+
+# DB configuration
+DB_USER = 'postgres'
+DB_PASSWORD = 'postgres'
+DB_HOST = 'localhost'
+DB_PORT = '5432'
+DB_NAME = 'top_assist'
+
+CHROMA_HOST=localhost
+CHROMA_PORT=8000
+CHROMA_DATABASE=default_database

.envrc

@@ -1 +1 @@
-dotenv
+dotenv

README.md

@@ -118,48 +118,52 @@ The version that `asdf` will use for the current project is declared in `.tool-v
 2. Follow the instructions in the files to fill in the values
 
 
-### Run Nur via shell
+### Run Top-Assist
 
 ````
-git clone https://github.com/MDGrey33/Nur.git
-cd Nur
+git clone https://github.com/toptal/top-assist
+cd top-assist
 poetry install
-poetry run python main.py
+PYTHONPATH=. poetry run python main.py
 ````
 
-`poetry run python ./main.py` (for the menu operations)
+`PYTHONPATH=. poetry run python main.py` (for the menu operations)
 
-`poetry run python ./api/endpoint.py` (API / uvicorn web server)
+`PYTHONPATH=. poetry run python api/endpoint.py` (API / uvicorn web server)
 
 Refer to the ./documentation/slack_app_manifest_installation_guide.md for slack bot setup
 
-`poetry run python ./slack/bot.py` (slack bot stream listener)
+`PYTHONPATH=. poetry run python slack/bot.py` (slack bot stream listener)
 
-### Run Nur via Docker
+### Run DBs
 
-We will use docker compose to build 3 containers of Nur. Each one is used to run a separate part of the app:
-* `nur-manager` will create a container allowing us to use `main.py` functionality. It is meant to be interactive (read further for details).
-* `nur-web` starts the web application.
-* `nur-slack` starts the slack integration script.
+Top Assist uses two databases: `postgresql` and `chroma`.  
+Please be sure that you set all the required environment variables in the `.env` file in `# Database` section.
+To run the databases, you can use docker-compose
 
-First off, run the composer script:
 ```
-git clone https://github.com/MDGrey33/Nur.git
-cd Nur
 docker composer up
+poetry run alembic upgrade head     # to setup PostgreSQL database
 ```
 
-Upon successful completion, you have three containers running, all of them sharing a common volume mounted at `/content` within the containers.
 
-`nur-web` and `nur-slack` should be fully operational already. If you wish to run commands in Nur's cli interface, you will need to attach a shell to the `nur-manager` container in interactive mode, and enter the management environment:
+### DB Migrations
 
+1) Import the model in `alembic/env.py` and run:
 ```
-./bin/manage
+poetry run alembic revision --autogenerate -m "Add my new model"
 ```
+Alembic will detect the changes in the models/tables and create a new migration file.  
+Be aware that it can remove empty indexes/fields.  
+If you need to have control over the migration you can remove the `--autogenerate` flag and write the migration manually.  
 
-If the above works, you should see Nur's manager command prompt - the same thing you should see when running `./main.py` locally.
 
-Bear in mind that the Dockerized version uses a shared volume named `nur_shared_content`. This is bootstrapped during the first installation, but will persist until it is manually removed.
+2) Apply the migration:  
+`poetry run alembic upgrade head`
+
+3) To rollback last N migrations run:  
+`poetry run alembic downgrade -N`
+
 
 ## Network traffic
 

alembic.ini

@@ -0,0 +1,117 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# 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 alembic/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:alembic/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
+
+# Custom: Replaced in alembic/env.py
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[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

alembic/README.md

@@ -0,0 +1,8 @@
+### Alembic documentation
+https://alembic.sqlalchemy.org/en/latest/
+
+### Cookbook
+https://alembic.sqlalchemy.org/en/latest/cookbook.html#rudimental-schema-level-multi-tenancy-for-postgresql-databases
+
+Notes:
+- we set `DB_URL` in `.env` file and rewrite it in `alembic/env.py` file (`alembic.ini` file is not used of security reasons)

alembic/env.py

@@ -0,0 +1,81 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+from configuration import DB_URL
+from models.base import Base
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Custom: Change DB URL to the one in the configuration
+config.set_main_option("sqlalchemy.url", DB_URL)
+
+# 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
+target_metadata = Base.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()

alembic/script.py.mako

@@ -0,0 +1,26 @@
+"""${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
+${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"}

alembic/versions/2024_04_12_1354-713caec2649e_initial_migration.py

@@ -0,0 +1,30 @@
+"""Initial migration
+
+Revision ID: 713caec2649e
+Revises: 
+Create Date: 2024-04-12 13:54:12.213839
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = '713caec2649e'
+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! ###
+    pass
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+    # ### end Alembic commands ###