Skip to content

inject augur and version into engine connection args #3771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MoralCode wants to merge 4 commits into
base: main
Choose a base branch
from
Open

inject augur and version into engine connection args #3771

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc625c7
inject augur and version into engine connection args
MoralCode Mar 16, 2026
e4f9fbd
remove import of version from CLI due to issues finding the module
MoralCode Mar 16, 2026
1c51481
adjust names to indicate the source better for debugging
MoralCode Mar 16, 2026
2f11f27
all the augur imports are too risky
MoralCode Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion augur/api/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ def get_server_cache(cache_manager) -> Cache:

logger = AugurLogger("server").get_logger()
url = get_database_string()
engine = create_database_engine(url, poolclass=StaticPool)
engine = create_database_engine(url, poolclass=StaticPool, connect_args={"application_name": f"augur v{augur_code_version} api"})
db_session = DatabaseSession(logger, engine)
augur_config = AugurConfig(logger, db_session)

Expand Down
2 changes: 1 addition & 1 deletion augur/application/cli/db.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ def run_psql_command_in_database(target_type, target):
database_name = db_config["database_name"]

db_conn_string = f"postgresql+psycopg2://{db_config['user']}:{db_config['password']}@{db_config['host']}:{db_config['port']}/{db_config['database_name']}"
engine = s.create_engine(db_conn_string)
engine = s.create_engine(db_conn_string, connect_args={"application_name": f"augur cli"})

check_call(
[
Expand Down
6 changes: 4 additions & 2 deletions augur/application/db/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

from augur.application.db.engine import create_database_engine, get_database_string

from metadata import __version__

engine = None
Session = None

Expand All @@ -12,7 +14,7 @@ def get_engine():

if engine is None:
url = get_database_string()
engine = create_database_engine(url=url, poolclass=StaticPool)
engine = create_database_engine(url=url, poolclass=StaticPool, connect_args={"application_name": f"augur v{__version__}"})
Session = sessionmaker(bind=engine)

return engine
Expand Down Expand Up @@ -42,7 +44,7 @@ def get_session():
def temporary_database_engine():

url = get_database_string()
temporary_database_engine = create_database_engine(url=url, poolclass=StaticPool)
temporary_database_engine = create_database_engine(url=url, poolclass=StaticPool, connect_args={"application_name": f"augur v{__version__} temporary"})
Copy link
Copy Markdown

@github-actions github-actions bot Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pylint] reported by reviewdog 🐶
W0621: Redefining name 'temporary_database_engine' from outer scope (line 44) (redefined-outer-name)

Copy link
Copy Markdown

@github-actions github-actions bot Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pylint] reported by reviewdog 🐶
W0621: Redefining name 'temporary_database_engine' from outer scope (line 42) (redefined-outer-name)

Copy link
Copy Markdown

@github-actions github-actions bot Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[pylint] reported by reviewdog 🐶
E0602: Undefined variable 'version' (undefined-variable)

Copy link
Copy Markdown
Collaborator

@shlokgilda shlokgilda Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is __version__ defined or imported anywhere in this file? I don't see it. Wouldn't this raise a NameError at runtime?

Copy link
Copy Markdown
Collaborator Author

@MoralCode MoralCode Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh that should probably be removed if it hasn't already. I gave up importing the version except where already available because its in the metadata.py, outside the module structure and therefore hard to properly import

Copy link
Copy Markdown
Collaborator

@shlokgilda shlokgilda Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah! Probably should remove this


try:
yield temporary_database_engine
Expand Down
5 changes: 3 additions & 2 deletions conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from augur.application.db.session import DatabaseSession
from augur.application.config import AugurConfig
from augur.application.db.engine import get_database_string, create_database_engine, parse_database_string, execute_sql_file

from metadata import __version__

logger = logging.getLogger(__name__)

Expand Down Expand Up @@ -104,7 +104,8 @@ def generate_db_from_template(template_name):
create_database(conn, cursor, test_db_name, template_name)

# create engine to connect to db
engine = create_database_engine(test_db_string, poolclass=StaticPool)
engine = create_database_engine(test_db_string, poolclass=StaticPool, connect_args={"application_name": f"augur tests v{__version__}"})


yield engine

Expand Down
Loading