dbos 0.10.0a2__tar.gz → 0.11.0__tar.gz

{dbos-0.10.0a2 → dbos-0.11.0}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.1
 Name: dbos
-Version: 0.10.0a2
+Version: 0.11.0
 Summary: Ultra-lightweight durable execution in Python
 Author-Email: "DBOS, Inc." <contact@dbos.dev>
 License: MIT
 Requires-Python: >=3.9
 Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: jsonschema>=4.23.0
-Requires-Dist: alembic>=1.13.2
+Requires-Dist: alembic>=1.13.3
 Requires-Dist: typing-extensions>=4.12.2; python_version < "3.10"
-Requires-Dist: typer>=0.12.3
-Requires-Dist: jsonpickle>=3.2.2
-Requires-Dist: opentelemetry-api>=1.26.0
-Requires-Dist: opentelemetry-sdk>=1.26.0
-Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.26.0
+Requires-Dist: typer>=0.12.5
+Requires-Dist: jsonpickle>=3.3.0
+Requires-Dist: opentelemetry-api>=1.27.0
+Requires-Dist: opentelemetry-sdk>=1.27.0
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.27.0
 Requires-Dist: python-dateutil>=2.9.0.post0
-Requires-Dist: fastapi[standard]>=0.112.1
+Requires-Dist: fastapi[standard]>=0.115.2
 Requires-Dist: psutil>=6.0.0
 Requires-Dist: tomlkit>=0.13.2
-Requires-Dist: psycopg>=3.2.1
+Requires-Dist: psycopg[binary]>=3.1
 Description-Content-Type: text/markdown
 
 

{dbos-0.10.0a2 → dbos-0.11.0}/dbos/cli.py

@@ -17,6 +17,7 @@ from typing_extensions import Annotated
 
 from dbos import load_config
 from dbos.application_database import ApplicationDatabase
+from dbos.dbos_config import is_valid_app_name
 from dbos.system_database import SystemDatabase
 
 app = typer.Typer()
@@ -125,11 +126,9 @@ def copy_template(src_dir: str, project_name: str, config_mode: bool) -> None:
     dst_dir = path.abspath(".")
 
     package_name = project_name.replace("-", "_")
-    db_name = package_name if not package_name[0].isdigit() else f"_{package_name}"
     ctx = {
         "project_name": project_name,
         "package_name": package_name,
-        "db_name": db_name,
         "migration_command": "alembic upgrade head",
     }
 
@@ -167,14 +166,6 @@ def get_project_name() -> typing.Union[str, None]:
     return name
 
 
-def is_valid_app_name(name: str) -> bool:
-    name_len = len(name)
-    if name_len < 3 or name_len > 30:
-        return False
-    match = re.match("^[a-z0-9-_]+$", name)
-    return True if match != None else False
-
-
 @app.command()
 def init(
     project_name: Annotated[

{dbos-0.10.0a2 → dbos-0.11.0}/dbos/dbos-config.schema.json

@@ -86,8 +86,7 @@
           "hostname",
           "port",
           "username",
-          "password",
-          "app_db_name"
+          "password"
         ]
       },
       "telemetry": {

{dbos-0.10.0a2 → dbos-0.11.0}/dbos/dbos_config.py

@@ -167,6 +167,14 @@ def load_config(config_file_path: str = "dbos-config.yaml") -> ConfigFile:
 
     data = cast(ConfigFile, data)
 
+    if not is_valid_app_name(data["name"]):
+        raise DBOSInitializationError(
+            f'Invalid app name {data["name"]}.  App names must be between 3 and 30 characters and contain only alphanumeric characters, dashes, and underscores.'
+        )
+
+    if "app_db_name" not in data["database"]:
+        data["database"]["app_db_name"] = app_name_to_db_name(data["name"])
+
     if "local_suffix" in data["database"] and data["database"]["local_suffix"]:
         data["database"]["app_db_name"] = f"{data['database']['app_db_name']}_local"
 
@@ -174,6 +182,19 @@ def load_config(config_file_path: str = "dbos-config.yaml") -> ConfigFile:
     return data  # type: ignore
 
 
+def is_valid_app_name(name: str) -> bool:
+    name_len = len(name)
+    if name_len < 3 or name_len > 30:
+        return False
+    match = re.match("^[a-z0-9-_]+$", name)
+    return True if match != None else False
+
+
+def app_name_to_db_name(app_name: str) -> str:
+    name = app_name.replace("-", "_")
+    return name if not name[0].isdigit() else f"_{name}"
+
+
 def set_env_vars(config: ConfigFile) -> None:
     for env, value in config.get("env", {}).items():
         if value is not None:

{dbos-0.10.0a2 → dbos-0.11.0}/dbos/system_database.py

@@ -1,5 +1,6 @@
 import datetime
 import os
+import re
 import threading
 import time
 from enum import Enum
@@ -203,9 +204,13 @@ class SystemDatabase:
         )
         alembic_cfg = Config()
         alembic_cfg.set_main_option("script_location", migration_dir)
-        alembic_cfg.set_main_option(
-            "sqlalchemy.url", self.engine.url.render_as_string(hide_password=False)
+        # Alembic requires the % in URL-escaped parameters to itself be escaped to %%.
+        escaped_conn_string = re.sub(
+            r"%(?=[0-9A-Fa-f]{2})",
+            "%%",
+            self.engine.url.render_as_string(hide_password=False),
         )
+        alembic_cfg.set_main_option("sqlalchemy.url", escaped_conn_string)
         command.upgrade(alembic_cfg, "head")
 
         self.notification_conn: Optional[psycopg.connection.Connection] = None
@@ -793,7 +798,7 @@ class SystemDatabase:
                 self.notification_conn.execute("LISTEN dbos_workflow_events_channel")
 
                 while self._run_background_processes:
-                    gen = self.notification_conn.notifies(timeout=60)
+                    gen = self.notification_conn.notifies()
                     for notify in gen:
                         channel = notify.channel
                         dbos_logger.debug(

{dbos-0.10.0a2 → dbos-0.11.0}/dbos/templates/hello/dbos-config.yaml.dbos

@@ -13,7 +13,6 @@ database:
   port: 5432
   username: postgres
   password: ${PGPASSWORD}
-  app_db_name: ${db_name}
   migrate:
     - ${migration_command}
 telemetry:

{dbos-0.10.0a2 → dbos-0.11.0}/dbos/templates/hello/migrations/env.py.dbos

@@ -1,3 +1,4 @@
+import re
 from logging.config import fileConfig
 
 from alembic import context
@@ -15,7 +16,13 @@ if config.config_file_name is not None:
     fileConfig(config.config_file_name)
 
 # programmatically set the sqlalchemy.url field from DBOS Config
-config.set_main_option("sqlalchemy.url", get_dbos_database_url())
+# Alembic requires the % in URL-escaped parameters to itself be escaped to %%.
+escaped_conn_string = re.sub(
+    r"%(?=[0-9A-Fa-f]{2})",
+    "%%",
+    get_dbos_database_url(),
+)
+config.set_main_option("sqlalchemy.url", escaped_conn_string)
 
 # add your model's MetaData object here
 # for 'autogenerate' support

{dbos-0.10.0a2 → dbos-0.11.0}/pyproject.toml

@@ -8,22 +8,22 @@ authors = [
 dependencies = [
     "pyyaml>=6.0.2",
     "jsonschema>=4.23.0",
-    "alembic>=1.13.2",
+    "alembic>=1.13.3",
     "typing-extensions>=4.12.2; python_version < \"3.10\"",
-    "typer>=0.12.3",
-    "jsonpickle>=3.2.2",
-    "opentelemetry-api>=1.26.0",
-    "opentelemetry-sdk>=1.26.0",
-    "opentelemetry-exporter-otlp-proto-http>=1.26.0",
+    "typer>=0.12.5",
+    "jsonpickle>=3.3.0",
+    "opentelemetry-api>=1.27.0",
+    "opentelemetry-sdk>=1.27.0",
+    "opentelemetry-exporter-otlp-proto-http>=1.27.0",
     "python-dateutil>=2.9.0.post0",
-    "fastapi[standard]>=0.112.1",
+    "fastapi[standard]>=0.115.2",
     "psutil>=6.0.0",
     "tomlkit>=0.13.2",
-    "psycopg>=3.2.1",
+    "psycopg[binary]>=3.1",
 ]
 requires-python = ">=3.9"
 readme = "README.md"
-version = "0.10.0a2"
+version = "0.11.0"
 
 [project.license]
 text = "MIT"
@@ -46,26 +46,26 @@ version_format = "version:format_version"
 
 [tool.pdm.dev-dependencies]
 dev = [
-    "pytest>=8.3.2",
-    "mypy>=1.11.1",
+    "pytest>=8.3.3",
+    "mypy>=1.12.0",
     "pytest-mock>=3.14.0",
     "types-PyYAML>=6.0.12.20240808",
     "types-jsonschema>=4.23.0.20240813",
-    "black>=24.8.0",
-    "pre-commit>=3.8.0",
+    "black>=24.10.0",
+    "pre-commit>=4.0.1",
     "isort>=5.13.2",
     "types-psutil>=6.0.0.20240621",
     "requests>=2.32.3",
-    "types-requests>=2.32.0.20240712",
-    "httpx>=0.27.0",
-    "pytz>=2024.1",
+    "types-requests>=2.32.0.20240914",
+    "httpx>=0.27.2",
+    "pytz>=2024.2",
     "GitPython>=3.1.43",
-    "confluent-kafka>=2.5.3",
+    "confluent-kafka>=2.6.0",
     "types-confluent-kafka>=1.2.2",
     "flask>=3.0.3",
     "pytest-order>=1.3.0",
     "pyjwt>=2.9.0",
-    "pdm-backend>=2.3.3",
+    "pdm-backend>=2.4.2",
 ]
 
 [tool.black]

{dbos-0.10.0a2 → dbos-0.11.0}/tests/test_config.py

@@ -27,7 +27,7 @@ def generate_mock_open(filename, mock_data):
 
 def test_valid_config(mocker):
     mock_config = """
-        name: "some app"
+        name: "some-app"
         language: "python"
         runtimeConfig:
             start:
@@ -51,7 +51,7 @@ def test_valid_config(mocker):
     )
 
     configFile = load_config(mock_filename)
-    assert configFile["name"] == "some app"
+    assert configFile["name"] == "some-app"
     assert configFile["language"] == "python"
     assert configFile["database"]["hostname"] == "some host"
     assert configFile["database"]["port"] == 1234
@@ -68,11 +68,34 @@ def test_valid_config(mocker):
     assert "bob" not in os.environ
 
 
-def test_config_missing_params(mocker):
+def test_valid_config_without_appdbname(mocker):
     mock_config = """
-        name: "some app"
+        name: "some-app"
+        language: "python"
+        runtimeConfig:
+            start:
+                - "python3 main.py"
+            admin_port: 8001
         database:
           hostname: 'some host'
+          port: 1234
+          username: 'some user'
+          password: ${PGPASSWORD}
+          connectionTimeoutMillis: 3000
+    """
+    os.environ["BARBAR"] = "FOOFOO"
+    mocker.patch(
+        "builtins.open", side_effect=generate_mock_open(mock_filename, mock_config)
+    )
+
+    configFile = load_config(mock_filename)
+    assert configFile["database"]["app_db_name"] == "some_app"
+
+
+def test_config_missing_params(mocker):
+    mock_config = """
+        name: "some-app"
+        database:
           port: 1234
           username: 'some user'
           password: abc123
@@ -85,12 +108,12 @@ def test_config_missing_params(mocker):
     with pytest.raises(DBOSInitializationError) as exc_info:
         load_config(mock_filename)
 
-    assert "'app_db_name' is a required property" in str(exc_info.value)
+    assert "'hostname' is a required property" in str(exc_info.value)
 
 
 def test_config_extra_params(mocker):
     mock_config = """
-        name: "some app"
+        name: "some-app"
         database:
           hostname: 'some host'
           port: 1234
@@ -136,7 +159,7 @@ def test_config_missing_name(mocker):
 
 def test_config_missing_language(mocker):
     mock_config = """
-        name: "some app"
+        name: "some-app"
         database:
           hostname: 'some host'
           port: 1234
@@ -157,7 +180,7 @@ def test_config_missing_language(mocker):
 
 def test_config_bad_language(mocker):
     mock_config = """
-        name: "some app"
+        name: "some-app"
         language: typescript
         database:
           hostname: 'some host'
@@ -177,10 +200,35 @@ def test_config_bad_language(mocker):
     assert "invalid language" in str(exc_info.value)
 
 
-def test_config_no_start(mocker):
+def test_config_bad_name(mocker):
     mock_config = """
         name: "some app"
         language: python
+        runtimeConfig:
+            start:
+                - "python3 main.py"
+        database:
+          hostname: 'some host'
+          port: 1234
+          username: 'some user'
+          password: abc123
+          app_db_name: 'some db'
+          connectionTimeoutMillis: 3000
+    """
+    mocker.patch(
+        "builtins.open", side_effect=generate_mock_open(mock_filename, mock_config)
+    )
+
+    with pytest.raises(DBOSInitializationError) as exc_info:
+        load_config(mock_filename)
+
+    assert "Invalid app name" in str(exc_info.value)
+
+
+def test_config_no_start(mocker):
+    mock_config = """
+        name: "some-app"
+        language: python
         database:
           hostname: 'some host'
           port: 1234
@@ -201,7 +249,7 @@ def test_config_no_start(mocker):
 
 def test_local_config(mocker):
     mock_config = """
-        name: "some app"
+        name: "some-app"
         language: "python"
         runtimeConfig:
             start:
@@ -222,7 +270,7 @@ def test_local_config(mocker):
     )
 
     configFile = load_config(mock_filename)
-    assert configFile["name"] == "some app"
+    assert configFile["name"] == "some-app"
     assert configFile["database"]["local_suffix"] == True
     assert configFile["language"] == "python"
     assert configFile["database"]["hostname"] == "some host"
@@ -231,3 +279,36 @@ def test_local_config(mocker):
     assert configFile["database"]["password"] == os.environ["PGPASSWORD"]
     assert configFile["database"]["app_db_name"] == "some_db_local"
     assert configFile["database"]["connectionTimeoutMillis"] == 3000
+
+
+def test_local_config_without_name(mocker):
+    mock_config = """
+        name: "some-app"
+        language: "python"
+        runtimeConfig:
+            start:
+                - "python3 main.py"
+            admin_port: 8001
+        database:
+          hostname: 'some host'
+          port: 1234
+          username: 'some user'
+          password: ${PGPASSWORD}
+          connectionTimeoutMillis: 3000
+          local_suffix: true
+    """
+    os.environ["BARBAR"] = "FOOFOO"
+    mocker.patch(
+        "builtins.open", side_effect=generate_mock_open(mock_filename, mock_config)
+    )
+
+    configFile = load_config(mock_filename)
+    assert configFile["name"] == "some-app"
+    assert configFile["database"]["local_suffix"] == True
+    assert configFile["language"] == "python"
+    assert configFile["database"]["hostname"] == "some host"
+    assert configFile["database"]["port"] == 1234
+    assert configFile["database"]["username"] == "some user"
+    assert configFile["database"]["password"] == os.environ["PGPASSWORD"]
+    assert configFile["database"]["app_db_name"] == "some_app_local"
+    assert configFile["database"]["connectionTimeoutMillis"] == 3000

{dbos-0.10.0a2 → dbos-0.11.0}/tests/test_schema_migration.py

@@ -1,4 +1,5 @@
 import os
+import re
 
 import pytest
 import sqlalchemy as sa
@@ -94,5 +95,10 @@ def rollback_system_db(sysdb_url: str) -> None:
     )
     alembic_cfg = Config()
     alembic_cfg.set_main_option("script_location", migration_dir)
-    alembic_cfg.set_main_option("sqlalchemy.url", sysdb_url)
+    escaped_conn_string = re.sub(
+        r"%(?=[0-9A-Fa-f]{2})",
+        "%%",
+        sysdb_url,
+    )
+    alembic_cfg.set_main_option("sqlalchemy.url", escaped_conn_string)
     command.downgrade(alembic_cfg, "base")  # Rollback all migrations