dbos 0.9.0a1__tar.gz → 0.10.0__tar.gz

{dbos-0.9.0a1 → dbos-0.10.0}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.1
 Name: dbos
-Version: 0.9.0a1
+Version: 0.10.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>=3.2.3
 Description-Content-Type: text/markdown
 
 

{dbos-0.9.0a1 → dbos-0.10.0}/dbos/dbos-config.schema.json

@@ -59,6 +59,10 @@
             "type": "string",
             "description": "If using SSL/TLS to securely connect to a database, path to an SSL root certificate file"
           },
+          "local_suffix": {
+            "type": "boolean",
+            "description": "Whether to suffix app_db_name with '_local'. Set to true when doing local development using a DBOS Cloud database."
+          },
           "app_db_client": {
             "type": "string",
             "description": "Specify the database client to use to connect to the application database",
@@ -140,6 +144,10 @@
           "start": {
             "type": "array",
             "description": "Specify commands to run to start your application (Python only)"
+          },
+          "admin_port": {
+            "type": "number",
+            "description": "The port number of the admin server (Default: 3001)"
           }
         }
       },

{dbos-0.9.0a1 → dbos-0.10.0}/dbos/dbos.py

@@ -277,6 +277,7 @@ class DBOS:
         self.fastapi: Optional["FastAPI"] = fastapi
         self.flask: Optional["Flask"] = flask
         self._executor_field: Optional[ThreadPoolExecutor] = None
+        self._background_threads: List[threading.Thread] = []
 
         # If using FastAPI, set up middleware and lifecycle events
         if self.fastapi is not None:
@@ -348,27 +349,48 @@ class DBOS:
             self._executor_field = ThreadPoolExecutor(max_workers=64)
             self._sys_db_field = SystemDatabase(self.config)
             self._app_db_field = ApplicationDatabase(self.config)
-            self._admin_server_field = AdminServer(dbos=self)
+            admin_port = self.config["runtimeConfig"].get("admin_port")
+            if admin_port is None:
+                admin_port = 3001
+            self._admin_server_field = AdminServer(dbos=self, port=admin_port)
 
             if not os.environ.get("DBOS__VMID"):
                 workflow_ids = self._sys_db.get_pending_workflows("local")
                 self._executor.submit(_startup_recovery_thread, self, workflow_ids)
 
             # Listen to notifications
-            self._executor.submit(self._sys_db._notification_listener)
+            notification_listener_thread = threading.Thread(
+                target=self._sys_db._notification_listener,
+                daemon=True,
+            )
+            notification_listener_thread.start()
+            self._background_threads.append(notification_listener_thread)
 
             # Start flush workflow buffers thread
-            self._executor.submit(self._sys_db.flush_workflow_buffers)
+            flush_workflow_buffers_thread = threading.Thread(
+                target=self._sys_db.flush_workflow_buffers,
+                daemon=True,
+            )
+            flush_workflow_buffers_thread.start()
+            self._background_threads.append(flush_workflow_buffers_thread)
 
             # Start the queue thread
             evt = threading.Event()
             self.stop_events.append(evt)
-            self._executor.submit(queue_thread, evt, self)
+            bg_queue_thread = threading.Thread(
+                target=queue_thread, args=(evt, self), daemon=True
+            )
+            bg_queue_thread.start()
+            self._background_threads.append(bg_queue_thread)
 
             # Grab any pollers that were deferred and start them
             for evt, func, args, kwargs in self._registry.pollers:
                 self.stop_events.append(evt)
-                self._executor.submit(func, *args, **kwargs)
+                poller_thread = threading.Thread(
+                    target=func, args=args, kwargs=kwargs, daemon=True
+                )
+                poller_thread.start()
+                self._background_threads.append(poller_thread)
             self._registry.pollers = []
 
             dbos_logger.info("DBOS launched")
@@ -400,6 +422,8 @@ class DBOS:
         if self._executor_field is not None:
             self._executor_field.shutdown(cancel_futures=True)
             self._executor_field = None
+        for bg_thread in self._background_threads:
+            bg_thread.join()
 
     @classmethod
     def register_instance(cls, inst: object) -> None:
@@ -829,7 +853,7 @@ class DBOSConfiguredInstance:
 
 # Apps that import DBOS probably don't exit.  If they do, let's see if
 #   it looks like startup was abandoned or a call was forgotten...
-def log_exit_info() -> None:
+def dbos_exit_hook() -> None:
     if _dbos_global_registry is None:
         # Probably used as or for a support module
         return
@@ -843,7 +867,9 @@ def log_exit_info() -> None:
         print("DBOS exiting; DBOS exists but launch() was not called")
         dbos_logger.warning("DBOS exiting; DBOS exists but launch() was not called")
         return
+    # If we get here, we're exiting normally
+    _dbos_global_instance.destroy()
 
 
 # Register the exit hook
-atexit.register(log_exit_info)
+atexit.register(dbos_exit_hook)

{dbos-0.9.0a1 → dbos-0.10.0}/dbos/dbos_config.py

@@ -2,7 +2,7 @@ import json
 import os
 import re
 from importlib import resources
-from typing import Any, Dict, List, Optional, TypedDict
+from typing import Any, Dict, List, Optional, TypedDict, cast
 
 import yaml
 from jsonschema import ValidationError, validate
@@ -14,6 +14,7 @@ from dbos.logger import dbos_logger
 
 class RuntimeConfig(TypedDict, total=False):
     start: List[str]
+    admin_port: Optional[int]
 
 
 class DatabaseConfig(TypedDict, total=False):
@@ -26,6 +27,7 @@ class DatabaseConfig(TypedDict, total=False):
     sys_db_name: Optional[str]
     ssl: Optional[bool]
     ssl_ca: Optional[str]
+    local_suffix: Optional[bool]
     app_db_client: Optional[str]
     migrate: Optional[List[str]]
     rollback: Optional[List[str]]
@@ -163,6 +165,11 @@ def load_config(config_file_path: str = "dbos-config.yaml") -> ConfigFile:
     if "runtimeConfig" not in data or "start" not in data["runtimeConfig"]:
         raise DBOSInitializationError(f"dbos-config.yaml must specify a start command")
 
+    data = cast(ConfigFile, data)
+
+    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
 

{dbos-0.9.0a1 → dbos-0.10.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>=3.2.3",
 ]
 requires-python = ">=3.9"
 readme = "README.md"
-version = "0.9.0a1"
+version = "0.10.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.9.0a1 → dbos-0.10.0}/tests/test_admin_server.py

@@ -123,3 +123,39 @@ def test_admin_recovery(dbos: DBOS) -> None:
             time.sleep(1)
             print(f"Attempt {attempt + 1} failed. Retrying in 1 second...")
     assert succeeded, "Workflow did not recover"
+
+
+def test_admin_diff_port(cleanup_test_databases: None) -> None:
+    # Initialize singleton
+    DBOS.destroy()  # In case of other tests leaving it
+
+    config_string = """name: test-app
+language: python
+database:
+  hostname: localhost
+  port: 5432
+  username: postgres
+  password: ${PGPASSWORD}
+  app_db_name: dbostestpy
+runtimeConfig:
+  start:
+    - python3 main.py
+  admin_port: 8001
+"""
+    # Write the config to a text file for the moment
+    with open("dbos-config.yaml", "w") as file:
+        file.write(config_string)
+
+    try:
+        # Initialize DBOS
+        DBOS()
+        DBOS.launch()
+
+        # Test GET /dbos-healthz
+        response = requests.get("http://localhost:8001/dbos-healthz", timeout=5)
+        assert response.status_code == 200
+        assert response.text == "healthy"
+    finally:
+        # Clean up after the test
+        DBOS.destroy()
+        os.remove("dbos-config.yaml")

{dbos-0.9.0a1 → dbos-0.10.0}/tests/test_config.py

@@ -32,6 +32,7 @@ def test_valid_config(mocker):
         runtimeConfig:
             start:
                 - "python3 main.py"
+            admin_port: 8001
         database:
           hostname: 'some host'
           port: 1234
@@ -196,3 +197,37 @@ def test_config_no_start(mocker):
         load_config(mock_filename)
 
     assert "start command" in str(exc_info.value)
+
+
+def test_local_config(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}
+          app_db_name: 'some_db'
+          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_db_local"
+    assert configFile["database"]["connectionTimeoutMillis"] == 3000