Simplify Database Configuration (#136)

Make `app_db_name` optional and remove it from the template. If it's not
specified, use the app name (suitably transformed) as `app_db_name`.

Author: kraftp

dbos/cli.py

@@ -17,6 +17,7 @@
 
 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/dbos-config.schema.json

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

dbos/dbos_config.py

@@ -167,13 +167,34 @@ 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"
 
     # Return data as ConfigFile type
     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/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:

tests/test_config.py

@@ -27,7 +27,7 @@ def conditional_mock_open(*args, **kwargs):
 
 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