dbos 0.18.0__tar.gz → 0.19.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. {dbos-0.18.0 → dbos-0.19.0}/PKG-INFO +21 -16
  2. {dbos-0.18.0 → dbos-0.19.0}/README.md +20 -15
  3. {dbos-0.18.0 → dbos-0.19.0}/dbos/_context.py +11 -2
  4. {dbos-0.18.0 → dbos-0.19.0}/dbos/_core.py +30 -8
  5. {dbos-0.18.0 → dbos-0.19.0}/dbos/_db_wizard.py +48 -10
  6. {dbos-0.18.0 → dbos-0.19.0}/dbos/_dbos.py +1 -1
  7. {dbos-0.18.0 → dbos-0.19.0}/dbos/_dbos_config.py +52 -7
  8. {dbos-0.18.0 → dbos-0.19.0}/dbos/_error.py +11 -0
  9. {dbos-0.18.0 → dbos-0.19.0}/dbos/_kafka.py +17 -1
  10. dbos-0.19.0/dbos/_migrations/versions/04ca4f231047_workflow_queues_executor_id.py +34 -0
  11. {dbos-0.18.0 → dbos-0.19.0}/dbos/_queue.py +20 -0
  12. {dbos-0.18.0 → dbos-0.19.0}/dbos/_schemas/system_database.py +1 -0
  13. {dbos-0.18.0 → dbos-0.19.0}/dbos/_sys_db.py +100 -47
  14. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/dbos-config.yaml.dbos +0 -4
  15. dbos-0.19.0/dbos/_workflow_commands.py +172 -0
  16. {dbos-0.18.0 → dbos-0.19.0}/dbos/cli.py +100 -1
  17. {dbos-0.18.0 → dbos-0.19.0}/dbos/dbos-config.schema.json +2 -11
  18. {dbos-0.18.0 → dbos-0.19.0}/pyproject.toml +1 -1
  19. {dbos-0.18.0 → dbos-0.19.0}/tests/classdefs.py +0 -3
  20. {dbos-0.18.0 → dbos-0.19.0}/tests/more_classdefs.py +1 -6
  21. dbos-0.19.0/tests/queuedworkflow.py +67 -0
  22. {dbos-0.18.0 → dbos-0.19.0}/tests/test_classdecorators.py +1 -0
  23. {dbos-0.18.0 → dbos-0.19.0}/tests/test_config.py +73 -12
  24. {dbos-0.18.0 → dbos-0.19.0}/tests/test_dbos.py +20 -3
  25. {dbos-0.18.0 → dbos-0.19.0}/tests/test_failures.py +92 -2
  26. {dbos-0.18.0 → dbos-0.19.0}/tests/test_kafka.py +37 -1
  27. {dbos-0.18.0 → dbos-0.19.0}/tests/test_queue.py +263 -2
  28. dbos-0.19.0/tests/test_workflow_cmds.py +216 -0
  29. {dbos-0.18.0 → dbos-0.19.0}/LICENSE +0 -0
  30. {dbos-0.18.0 → dbos-0.19.0}/dbos/__init__.py +0 -0
  31. {dbos-0.18.0 → dbos-0.19.0}/dbos/_admin_server.py +0 -0
  32. {dbos-0.18.0 → dbos-0.19.0}/dbos/_app_db.py +0 -0
  33. {dbos-0.18.0 → dbos-0.19.0}/dbos/_classproperty.py +0 -0
  34. {dbos-0.18.0 → dbos-0.19.0}/dbos/_cloudutils/authentication.py +0 -0
  35. {dbos-0.18.0 → dbos-0.19.0}/dbos/_cloudutils/cloudutils.py +0 -0
  36. {dbos-0.18.0 → dbos-0.19.0}/dbos/_cloudutils/databases.py +0 -0
  37. {dbos-0.18.0 → dbos-0.19.0}/dbos/_croniter.py +0 -0
  38. {dbos-0.18.0 → dbos-0.19.0}/dbos/_fastapi.py +0 -0
  39. {dbos-0.18.0 → dbos-0.19.0}/dbos/_flask.py +0 -0
  40. {dbos-0.18.0 → dbos-0.19.0}/dbos/_kafka_message.py +0 -0
  41. {dbos-0.18.0 → dbos-0.19.0}/dbos/_logger.py +0 -0
  42. {dbos-0.18.0 → dbos-0.19.0}/dbos/_migrations/env.py +0 -0
  43. {dbos-0.18.0 → dbos-0.19.0}/dbos/_migrations/script.py.mako +0 -0
  44. {dbos-0.18.0 → dbos-0.19.0}/dbos/_migrations/versions/50f3227f0b4b_fix_job_queue.py +0 -0
  45. {dbos-0.18.0 → dbos-0.19.0}/dbos/_migrations/versions/5c361fc04708_added_system_tables.py +0 -0
  46. {dbos-0.18.0 → dbos-0.19.0}/dbos/_migrations/versions/a3b18ad34abe_added_triggers.py +0 -0
  47. {dbos-0.18.0 → dbos-0.19.0}/dbos/_migrations/versions/d76646551a6b_job_queue_limiter.py +0 -0
  48. {dbos-0.18.0 → dbos-0.19.0}/dbos/_migrations/versions/d76646551a6c_workflow_queue.py +0 -0
  49. {dbos-0.18.0 → dbos-0.19.0}/dbos/_migrations/versions/eab0cc1d9a14_job_queue.py +0 -0
  50. {dbos-0.18.0 → dbos-0.19.0}/dbos/_outcome.py +0 -0
  51. {dbos-0.18.0 → dbos-0.19.0}/dbos/_recovery.py +0 -0
  52. {dbos-0.18.0 → dbos-0.19.0}/dbos/_registrations.py +0 -0
  53. {dbos-0.18.0 → dbos-0.19.0}/dbos/_request.py +0 -0
  54. {dbos-0.18.0 → dbos-0.19.0}/dbos/_roles.py +0 -0
  55. {dbos-0.18.0 → dbos-0.19.0}/dbos/_scheduler.py +0 -0
  56. {dbos-0.18.0 → dbos-0.19.0}/dbos/_schemas/__init__.py +0 -0
  57. {dbos-0.18.0 → dbos-0.19.0}/dbos/_schemas/application_database.py +0 -0
  58. {dbos-0.18.0 → dbos-0.19.0}/dbos/_serialization.py +0 -0
  59. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/README.md +0 -0
  60. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/__package/__init__.py +0 -0
  61. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/__package/main.py +0 -0
  62. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/__package/schema.py +0 -0
  63. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/alembic.ini +0 -0
  64. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/migrations/env.py.dbos +0 -0
  65. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/migrations/script.py.mako +0 -0
  66. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/migrations/versions/2024_07_31_180642_init.py +0 -0
  67. {dbos-0.18.0 → dbos-0.19.0}/dbos/_templates/hello/start_postgres_docker.py +0 -0
  68. {dbos-0.18.0 → dbos-0.19.0}/dbos/_tracer.py +0 -0
  69. {dbos-0.18.0 → dbos-0.19.0}/dbos/py.typed +0 -0
  70. {dbos-0.18.0 → dbos-0.19.0}/tests/__init__.py +0 -0
  71. {dbos-0.18.0 → dbos-0.19.0}/tests/atexit_no_ctor.py +0 -0
  72. {dbos-0.18.0 → dbos-0.19.0}/tests/atexit_no_launch.py +0 -0
  73. {dbos-0.18.0 → dbos-0.19.0}/tests/conftest.py +0 -0
  74. {dbos-0.18.0 → dbos-0.19.0}/tests/test_admin_server.py +0 -0
  75. {dbos-0.18.0 → dbos-0.19.0}/tests/test_async.py +0 -0
  76. {dbos-0.18.0 → dbos-0.19.0}/tests/test_concurrency.py +0 -0
  77. {dbos-0.18.0 → dbos-0.19.0}/tests/test_croniter.py +0 -0
  78. {dbos-0.18.0 → dbos-0.19.0}/tests/test_fastapi.py +0 -0
  79. {dbos-0.18.0 → dbos-0.19.0}/tests/test_fastapi_roles.py +0 -0
  80. {dbos-0.18.0 → dbos-0.19.0}/tests/test_flask.py +0 -0
  81. {dbos-0.18.0 → dbos-0.19.0}/tests/test_outcome.py +0 -0
  82. {dbos-0.18.0 → dbos-0.19.0}/tests/test_package.py +0 -0
  83. {dbos-0.18.0 → dbos-0.19.0}/tests/test_scheduler.py +0 -0
  84. {dbos-0.18.0 → dbos-0.19.0}/tests/test_schema_migration.py +0 -0
  85. {dbos-0.18.0 → dbos-0.19.0}/tests/test_singleton.py +0 -0
  86. {dbos-0.18.0 → dbos-0.19.0}/tests/test_spans.py +0 -0
  87. {dbos-0.18.0 → dbos-0.19.0}/version/__init__.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: dbos
3
- Version: 0.18.0
3
+ Version: 0.19.0
4
4
  Summary: Ultra-lightweight durable execution in Python
5
5
  Author-Email: "DBOS, Inc." <contact@dbos.dev>
6
6
  License: MIT
@@ -28,14 +28,14 @@ Description-Content-Type: text/markdown
28
28
 
29
29
  <div align="center">
30
30
 
31
- # DBOS Transact: Ultra-Lightweight Durable Execution
31
+ # DBOS Transact: A Lightweight Durable Execution Library Built on Postgres
32
32
 
33
33
  #### [Documentation](https://docs.dbos.dev/) &nbsp;&nbsp;•&nbsp;&nbsp; [Examples](https://docs.dbos.dev/examples) &nbsp;&nbsp;•&nbsp;&nbsp; [Github](https://github.com/dbos-inc) &nbsp;&nbsp;•&nbsp;&nbsp; [Discord](https://discord.com/invite/jsmC6pXGgX)
34
34
  </div>
35
35
 
36
36
  ---
37
37
 
38
- DBOS Transact is a Python library providing **ultra-lightweight durable execution**.
38
+ DBOS Transact is a Python library for **ultra-lightweight durable execution**.
39
39
  For example:
40
40
 
41
41
  ```python
@@ -55,18 +55,23 @@ def workflow()
55
55
 
56
56
  Durable execution means your program is **resilient to any failure**.
57
57
  If it is ever interrupted or crashes, all your workflows will automatically resume from the last completed step.
58
- If you want to see durable execution in action, check out [this demo app](https://demo-widget-store.cloud.dbos.dev/) (source code [here](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python/widget-store)).
59
- No matter how many times you try to crash it, it always resumes from exactly where it left off!
58
+ Durable execution helps solve many common problems:
60
59
 
61
- Under the hood, DBOS Transact works by storing your program's execution state (which workflows are currently executing and which steps they've completed) in a Postgres database.
62
- So all you need to use it is a Postgres database to connect to&mdash;there's no need for a "workflow server."
63
- This approach is also incredibly fast, for example [25x faster than AWS Step Functions](https://www.dbos.dev/blog/dbos-vs-aws-step-functions-benchmark).
60
+ - Orchestrating long-running or business-critical workflows so they seamlessly recover from any failure.
61
+ - Running reliable background jobs with no timeouts.
62
+ - Processing incoming events (e.g. from Kafka) exactly once.
63
+ - Running a fault-tolerant distributed task queue.
64
+ - Running a reliable cron scheduler.
65
+ - Operating an AI agent, or anything that connects to an unreliable or non-deterministic API.
64
66
 
65
- Some more cool features include:
67
+ What’s unique about DBOS's implementation of durable execution is that it’s implemented in a **lightweight library** that’s **totally backed by Postgres**.
68
+ To use DBOS, just `pip install` it and annotate your program with DBOS decorators.
69
+ Under the hood, those decorators store your program's execution state (which workflows are currently executing and which steps they've completed) in a Postgres database.
70
+ If your program crashes or is interrupted, they automatically recover its workflows from their stored state.
71
+ So all you need to use DBOS is Postgres&mdash;there are no other dependencies you have to manage, no separate workflow server.
66
72
 
67
- - Scheduled jobs&mdash;run your workflows exactly-once per time interval.
68
- - Exactly-once event processing&mdash;use workflows to process incoming events (for example, from a Kafka topic) exactly-once.
69
- - Observability&mdash;all workflows automatically emit [OpenTelemetry](https://opentelemetry.io/) traces.
73
+ One big advantage of this approach is that you can add DBOS to **any** Python application&mdash;**it’s just a library**.
74
+ You can use DBOS to add reliable background jobs or cron scheduling or queues to your app with no external dependencies except Postgres.
70
75
 
71
76
  ## Getting Started
72
77
 
@@ -77,7 +82,7 @@ pip install dbos
77
82
  dbos init --config
78
83
  ```
79
84
 
80
- Then, try it out with this simple program (requires Postgres):
85
+ Then, try it out with this simple program:
81
86
 
82
87
  ```python
83
88
  from fastapi import FastAPI
@@ -107,14 +112,14 @@ def fastapi_endpoint():
107
112
  dbos_workflow()
108
113
  ```
109
114
 
110
- Save the program into `main.py`, edit `dbos-config.yaml` to configure your Postgres connection settings, and start it with `fastapi run`.
115
+ Save the program into `main.py` and start it with `fastapi run`.
111
116
  Visit `localhost:8000` in your browser to start the workflow.
112
117
  When prompted, press `Control + \` to force quit your application.
113
118
  It should crash midway through the workflow, having completed step one but not step two.
114
119
  Then, restart your app with `fastapi run`.
115
120
  It should resume the workflow from where it left off, completing step two without re-executing step one.
116
121
 
117
- To learn how to build more complex workflows, see our [programming guide](https://docs.dbos.dev/python/programming-guide) or [examples](https://docs.dbos.dev/examples).
122
+ To learn how to build more complex workflows, see the [programming guide](https://docs.dbos.dev/python/programming-guide) or [examples](https://docs.dbos.dev/examples).
118
123
 
119
124
  ## Documentation
120
125
 
@@ -125,7 +130,7 @@ To learn how to build more complex workflows, see our [programming guide](https:
125
130
 
126
131
  - [**AI-Powered Slackbot**](https://docs.dbos.dev/python/examples/rag-slackbot) &mdash; A Slackbot that answers questions about previous Slack conversations, using DBOS to durably orchestrate its RAG pipeline.
127
132
  - [**Widget Store**](https://docs.dbos.dev/python/examples/widget-store) &mdash; An online storefront that uses DBOS durable workflows to be resilient to any failure.
128
- - [**Earthquake Tracker**](https://docs.dbos.dev/python/examples/earthquake-tracker) &mdash; A real-time earthquake dashboard that uses DBOS to stream data from the USGS into Postgres, then visualizes it with Streamlit.
133
+ - [**Scheduled Reminders**](https://docs.dbos.dev/python/examples/scheduled-reminders) &mdash; In just three lines of code, schedule an email to send days, weeks, or months in the future.
129
134
 
130
135
  More examples [here](https://docs.dbos.dev/examples)!
131
136
 
@@ -1,14 +1,14 @@
1
1
 
2
2
  <div align="center">
3
3
 
4
- # DBOS Transact: Ultra-Lightweight Durable Execution
4
+ # DBOS Transact: A Lightweight Durable Execution Library Built on Postgres
5
5
 
6
6
  #### [Documentation](https://docs.dbos.dev/) &nbsp;&nbsp;•&nbsp;&nbsp; [Examples](https://docs.dbos.dev/examples) &nbsp;&nbsp;•&nbsp;&nbsp; [Github](https://github.com/dbos-inc) &nbsp;&nbsp;•&nbsp;&nbsp; [Discord](https://discord.com/invite/jsmC6pXGgX)
7
7
  </div>
8
8
 
9
9
  ---
10
10
 
11
- DBOS Transact is a Python library providing **ultra-lightweight durable execution**.
11
+ DBOS Transact is a Python library for **ultra-lightweight durable execution**.
12
12
  For example:
13
13
 
14
14
  ```python
@@ -28,18 +28,23 @@ def workflow()
28
28
 
29
29
  Durable execution means your program is **resilient to any failure**.
30
30
  If it is ever interrupted or crashes, all your workflows will automatically resume from the last completed step.
31
- If you want to see durable execution in action, check out [this demo app](https://demo-widget-store.cloud.dbos.dev/) (source code [here](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python/widget-store)).
32
- No matter how many times you try to crash it, it always resumes from exactly where it left off!
31
+ Durable execution helps solve many common problems:
33
32
 
34
- Under the hood, DBOS Transact works by storing your program's execution state (which workflows are currently executing and which steps they've completed) in a Postgres database.
35
- So all you need to use it is a Postgres database to connect to&mdash;there's no need for a "workflow server."
36
- This approach is also incredibly fast, for example [25x faster than AWS Step Functions](https://www.dbos.dev/blog/dbos-vs-aws-step-functions-benchmark).
33
+ - Orchestrating long-running or business-critical workflows so they seamlessly recover from any failure.
34
+ - Running reliable background jobs with no timeouts.
35
+ - Processing incoming events (e.g. from Kafka) exactly once.
36
+ - Running a fault-tolerant distributed task queue.
37
+ - Running a reliable cron scheduler.
38
+ - Operating an AI agent, or anything that connects to an unreliable or non-deterministic API.
37
39
 
38
- Some more cool features include:
40
+ What’s unique about DBOS's implementation of durable execution is that it’s implemented in a **lightweight library** that’s **totally backed by Postgres**.
41
+ To use DBOS, just `pip install` it and annotate your program with DBOS decorators.
42
+ Under the hood, those decorators store your program's execution state (which workflows are currently executing and which steps they've completed) in a Postgres database.
43
+ If your program crashes or is interrupted, they automatically recover its workflows from their stored state.
44
+ So all you need to use DBOS is Postgres&mdash;there are no other dependencies you have to manage, no separate workflow server.
39
45
 
40
- - Scheduled jobs&mdash;run your workflows exactly-once per time interval.
41
- - Exactly-once event processing&mdash;use workflows to process incoming events (for example, from a Kafka topic) exactly-once.
42
- - Observability&mdash;all workflows automatically emit [OpenTelemetry](https://opentelemetry.io/) traces.
46
+ One big advantage of this approach is that you can add DBOS to **any** Python application&mdash;**it’s just a library**.
47
+ You can use DBOS to add reliable background jobs or cron scheduling or queues to your app with no external dependencies except Postgres.
43
48
 
44
49
  ## Getting Started
45
50
 
@@ -50,7 +55,7 @@ pip install dbos
50
55
  dbos init --config
51
56
  ```
52
57
 
53
- Then, try it out with this simple program (requires Postgres):
58
+ Then, try it out with this simple program:
54
59
 
55
60
  ```python
56
61
  from fastapi import FastAPI
@@ -80,14 +85,14 @@ def fastapi_endpoint():
80
85
  dbos_workflow()
81
86
  ```
82
87
 
83
- Save the program into `main.py`, edit `dbos-config.yaml` to configure your Postgres connection settings, and start it with `fastapi run`.
88
+ Save the program into `main.py` and start it with `fastapi run`.
84
89
  Visit `localhost:8000` in your browser to start the workflow.
85
90
  When prompted, press `Control + \` to force quit your application.
86
91
  It should crash midway through the workflow, having completed step one but not step two.
87
92
  Then, restart your app with `fastapi run`.
88
93
  It should resume the workflow from where it left off, completing step two without re-executing step one.
89
94
 
90
- To learn how to build more complex workflows, see our [programming guide](https://docs.dbos.dev/python/programming-guide) or [examples](https://docs.dbos.dev/examples).
95
+ To learn how to build more complex workflows, see the [programming guide](https://docs.dbos.dev/python/programming-guide) or [examples](https://docs.dbos.dev/examples).
91
96
 
92
97
  ## Documentation
93
98
 
@@ -98,7 +103,7 @@ To learn how to build more complex workflows, see our [programming guide](https:
98
103
 
99
104
  - [**AI-Powered Slackbot**](https://docs.dbos.dev/python/examples/rag-slackbot) &mdash; A Slackbot that answers questions about previous Slack conversations, using DBOS to durably orchestrate its RAG pipeline.
100
105
  - [**Widget Store**](https://docs.dbos.dev/python/examples/widget-store) &mdash; An online storefront that uses DBOS durable workflows to be resilient to any failure.
101
- - [**Earthquake Tracker**](https://docs.dbos.dev/python/examples/earthquake-tracker) &mdash; A real-time earthquake dashboard that uses DBOS to stream data from the USGS into Postgres, then visualizes it with Streamlit.
106
+ - [**Scheduled Reminders**](https://docs.dbos.dev/python/examples/scheduled-reminders) &mdash; In just three lines of code, schedule an email to send days, weeks, or months in the future.
102
107
 
103
108
  More examples [here](https://docs.dbos.dev/examples)!
104
109
 
@@ -57,6 +57,7 @@ class DBOSContext:
57
57
  self.request: Optional["Request"] = None
58
58
 
59
59
  self.id_assigned_for_next_workflow: str = ""
60
+ self.is_within_set_workflow_id_block: bool = False
60
61
 
61
62
  self.parent_workflow_id: str = ""
62
63
  self.parent_workflow_fid: int = -1
@@ -78,6 +79,7 @@ class DBOSContext:
78
79
  rv.logger = self.logger
79
80
  rv.id_assigned_for_next_workflow = self.id_assigned_for_next_workflow
80
81
  self.id_assigned_for_next_workflow = ""
82
+ rv.is_within_set_workflow_id_block = self.is_within_set_workflow_id_block
81
83
  rv.parent_workflow_id = self.workflow_id
82
84
  rv.parent_workflow_fid = self.function_id
83
85
  rv.in_recovery = self.in_recovery
@@ -95,6 +97,10 @@ class DBOSContext:
95
97
  if len(self.id_assigned_for_next_workflow) > 0:
96
98
  wfid = self.id_assigned_for_next_workflow
97
99
  else:
100
+ if self.is_within_set_workflow_id_block:
101
+ self.logger.warning(
102
+ f"Multiple workflows started in the same SetWorkflowID block. Only the first workflow is assigned the specified workflow ID; subsequent workflows will use a generated workflow ID."
103
+ )
98
104
  wfid = str(uuid.uuid4())
99
105
  return wfid
100
106
 
@@ -286,7 +292,7 @@ class DBOSContextSwap:
286
292
 
287
293
  class SetWorkflowID:
288
294
  """
289
- Set the workflow ID to be used for the enclosed workflow invocation.
295
+ Set the workflow ID to be used for the enclosed workflow invocation. Note: Only the first workflow will be started with the specified workflow ID within a `with SetWorkflowID` block.
290
296
 
291
297
  Typical Usage
292
298
  ```
@@ -311,7 +317,9 @@ class SetWorkflowID:
311
317
  if ctx is None:
312
318
  self.created_ctx = True
313
319
  _set_local_dbos_context(DBOSContext())
314
- assert_current_dbos_context().id_assigned_for_next_workflow = self.wfid
320
+ ctx = assert_current_dbos_context()
321
+ ctx.id_assigned_for_next_workflow = self.wfid
322
+ ctx.is_within_set_workflow_id_block = True
315
323
  return self
316
324
 
317
325
  def __exit__(
@@ -321,6 +329,7 @@ class SetWorkflowID:
321
329
  traceback: Optional[TracebackType],
322
330
  ) -> Literal[False]:
323
331
  # Code to clean up the basic context if we created it
332
+ assert_current_dbos_context().is_within_set_workflow_id_block = False
324
333
  if self.created_ctx:
325
334
  _clear_local_dbos_context()
326
335
  return False # Did not handle
@@ -84,7 +84,7 @@ if TYPE_CHECKING:
84
84
  IsolationLevel,
85
85
  )
86
86
 
87
- from sqlalchemy.exc import DBAPIError
87
+ from sqlalchemy.exc import DBAPIError, InvalidRequestError
88
88
 
89
89
  P = ParamSpec("P") # A generic type for workflow parameters
90
90
  R = TypeVar("R", covariant=True) # A generic type for workflow return values
@@ -180,21 +180,24 @@ def _init_workflow(
180
180
  if class_name is not None:
181
181
  inputs = {"args": inputs["args"][1:], "kwargs": inputs["kwargs"]}
182
182
 
183
+ wf_status = status["status"]
183
184
  if temp_wf_type != "transaction" or queue is not None:
184
185
  # Synchronously record the status and inputs for workflows and single-step workflows
185
186
  # We also have to do this for single-step workflows because of the foreign key constraint on the operation outputs table
186
187
  # TODO: Make this transactional (and with the queue step below)
187
- dbos._sys_db.update_workflow_status(
188
+ wf_status = dbos._sys_db.update_workflow_status(
188
189
  status, False, ctx.in_recovery, max_recovery_attempts=max_recovery_attempts
189
190
  )
191
+ # TODO: Modify the inputs if they were changed by `update_workflow_inputs`
190
192
  dbos._sys_db.update_workflow_inputs(wfid, _serialization.serialize_args(inputs))
191
193
  else:
192
194
  # Buffer the inputs for single-transaction workflows, but don't buffer the status
193
195
  dbos._sys_db.buffer_workflow_inputs(wfid, _serialization.serialize_args(inputs))
194
196
 
195
- if queue is not None:
197
+ if queue is not None and wf_status == WorkflowStatusString.ENQUEUED.value:
196
198
  dbos._sys_db.enqueue(wfid, queue)
197
199
 
200
+ status["status"] = wf_status
198
201
  return status
199
202
 
200
203
 
@@ -413,7 +416,16 @@ def start_workflow(
413
416
  max_recovery_attempts=fi.max_recovery_attempts,
414
417
  )
415
418
 
416
- if not execute_workflow:
419
+ wf_status = status["status"]
420
+
421
+ if (
422
+ not execute_workflow
423
+ or wf_status == WorkflowStatusString.ERROR.value
424
+ or wf_status == WorkflowStatusString.SUCCESS.value
425
+ ):
426
+ dbos.logger.debug(
427
+ f"Workflow {new_wf_id} already completed with status {wf_status}. Directly returning a workflow handle."
428
+ )
417
429
  return WorkflowHandlePolling(new_wf_id, dbos)
418
430
 
419
431
  if fself is not None:
@@ -486,7 +498,7 @@ def workflow_wrapper(
486
498
  temp_wf_type=get_temp_workflow_type(func),
487
499
  max_recovery_attempts=max_recovery_attempts,
488
500
  )
489
-
501
+ # TODO: maybe modify the parameters if they've been changed by `_init_workflow`
490
502
  dbos.logger.debug(
491
503
  f"Running workflow, id: {ctx.workflow_id}, name: {get_dbos_func_name(func)}"
492
504
  )
@@ -545,6 +557,7 @@ def decorate_transaction(
545
557
  max_retry_wait_seconds = 2.0
546
558
  while True:
547
559
  has_recorded_error = False
560
+ txn_error: Optional[Exception] = None
548
561
  try:
549
562
  with session.begin():
550
563
  # This must be the first statement in the transaction!
@@ -608,15 +621,24 @@ def decorate_transaction(
608
621
  max_retry_wait_seconds,
609
622
  )
610
623
  continue
624
+ txn_error = dbapi_error
625
+ raise
626
+ except InvalidRequestError as invalid_request_error:
627
+ dbos.logger.error(
628
+ f"InvalidRequestError in transaction {func.__qualname__} \033[1m Hint: Do not call commit() or rollback() within a DBOS transaction.\033[0m"
629
+ )
630
+ txn_error = invalid_request_error
611
631
  raise
612
632
  except Exception as error:
633
+ txn_error = error
634
+ raise
635
+ finally:
613
636
  # Don't record the error if it was already recorded
614
- if not has_recorded_error:
637
+ if txn_error and not has_recorded_error:
615
638
  txn_output["error"] = (
616
- _serialization.serialize_exception(error)
639
+ _serialization.serialize_exception(txn_error)
617
640
  )
618
641
  dbos._app_db.record_transaction_error(txn_output)
619
- raise
620
642
  return output
621
643
 
622
644
  if inspect.iscoroutinefunction(func):
@@ -1,5 +1,7 @@
1
+ import json
2
+ import os
1
3
  import time
2
- from typing import TYPE_CHECKING, Optional
4
+ from typing import TYPE_CHECKING, Optional, TypedDict
3
5
 
4
6
  import docker # type: ignore
5
7
  import typer
@@ -15,8 +17,18 @@ from ._cloudutils.databases import choose_database, get_user_db_credentials
15
17
  from ._error import DBOSInitializationError
16
18
  from ._logger import dbos_logger
17
19
 
20
+ DB_CONNECTION_PATH = os.path.join(".dbos", "db_connection")
18
21
 
19
- def db_connect(config: "ConfigFile", config_file_path: str) -> "ConfigFile":
22
+
23
+ class DatabaseConnection(TypedDict):
24
+ hostname: Optional[str]
25
+ port: Optional[int]
26
+ username: Optional[str]
27
+ password: Optional[str]
28
+ local_suffix: Optional[bool]
29
+
30
+
31
+ def db_wizard(config: "ConfigFile", config_file_path: str) -> "ConfigFile":
20
32
  # 1. Check the connectivity to the database. Return if successful. If cannot connect, continue to the following steps.
21
33
  db_connection_error = _check_db_connectivity(config)
22
34
  if db_connection_error is None:
@@ -82,17 +94,20 @@ def db_connect(config: "ConfigFile", config_file_path: str) -> "ConfigFile":
82
94
  f"Could not connect to the database. Exception: {db_connection_error}"
83
95
  )
84
96
 
85
- # 6. Save the config to the config file and return the updated config.
86
- # TODO: make the config file prettier
87
- with open(config_file_path, "w") as file:
88
- file.write(yaml.dump(config))
89
-
97
+ # 6. Save the config to the database connection file
98
+ updated_connection = DatabaseConnection(
99
+ hostname=config["database"]["hostname"],
100
+ port=config["database"]["port"],
101
+ username=config["database"]["username"],
102
+ password=config["database"]["password"],
103
+ local_suffix=config["database"]["local_suffix"],
104
+ )
105
+ save_db_connection(updated_connection)
90
106
  return config
91
107
 
92
108
 
93
109
  def _start_docker_postgres(config: "ConfigFile") -> bool:
94
110
  print("Starting a Postgres Docker container...")
95
- config["database"]["password"] = "dbos"
96
111
  client = docker.from_env()
97
112
  pg_data = "/var/lib/postgresql/data"
98
113
  container_name = "dbos-db"
@@ -122,7 +137,7 @@ def _start_docker_postgres(config: "ConfigFile") -> bool:
122
137
  continue
123
138
  print("[green]Postgres Docker container started successfully![/green]")
124
139
  break
125
- except Exception as e:
140
+ except:
126
141
  attempts -= 1
127
142
  time.sleep(1)
128
143
 
@@ -151,7 +166,7 @@ def _check_db_connectivity(config: "ConfigFile") -> Optional[Exception]:
151
166
  host=config["database"]["hostname"],
152
167
  port=config["database"]["port"],
153
168
  database="postgres",
154
- query={"connect_timeout": "2"},
169
+ query={"connect_timeout": "1"},
155
170
  )
156
171
  postgres_db_engine = create_engine(postgres_db_url)
157
172
  try:
@@ -168,3 +183,26 @@ def _check_db_connectivity(config: "ConfigFile") -> Optional[Exception]:
168
183
  postgres_db_engine.dispose()
169
184
 
170
185
  return None
186
+
187
+
188
+ def load_db_connection() -> DatabaseConnection:
189
+ try:
190
+ with open(DB_CONNECTION_PATH, "r") as f:
191
+ data = json.load(f)
192
+ return DatabaseConnection(
193
+ hostname=data.get("hostname", None),
194
+ port=data.get("port", None),
195
+ username=data.get("username", None),
196
+ password=data.get("password", None),
197
+ local_suffix=data.get("local_suffix", None),
198
+ )
199
+ except:
200
+ return DatabaseConnection(
201
+ hostname=None, port=None, username=None, password=None, local_suffix=None
202
+ )
203
+
204
+
205
+ def save_db_connection(connection: DatabaseConnection) -> None:
206
+ os.makedirs(".dbos", exist_ok=True)
207
+ with open(DB_CONNECTION_PATH, "w") as f:
208
+ json.dump(connection, f)
@@ -83,7 +83,7 @@ from ._context import (
83
83
  )
84
84
  from ._dbos_config import ConfigFile, load_config, set_env_vars
85
85
  from ._error import DBOSException, DBOSNonExistentWorkflowError
86
- from ._logger import add_otlp_to_all_loggers, dbos_logger, init_logger
86
+ from ._logger import add_otlp_to_all_loggers, dbos_logger
87
87
  from ._sys_db import SystemDatabase
88
88
 
89
89
  # Most DBOS functions are just any callable F, so decorators / wrappers work on F
@@ -6,12 +6,15 @@ from typing import Any, Dict, List, Optional, TypedDict, cast
6
6
 
7
7
  import yaml
8
8
  from jsonschema import ValidationError, validate
9
+ from rich import print
9
10
  from sqlalchemy import URL
10
11
 
11
- from ._db_wizard import db_connect
12
+ from ._db_wizard import db_wizard, load_db_connection
12
13
  from ._error import DBOSInitializationError
13
14
  from ._logger import config_logger, dbos_logger, init_logger
14
15
 
16
+ DBOS_CONFIG_PATH = "dbos-config.yaml"
17
+
15
18
 
16
19
  class RuntimeConfig(TypedDict, total=False):
17
20
  start: List[str]
@@ -23,7 +26,7 @@ class DatabaseConfig(TypedDict, total=False):
23
26
  hostname: str
24
27
  port: int
25
28
  username: str
26
- password: Optional[str]
29
+ password: str
27
30
  connectionTimeoutMillis: Optional[int]
28
31
  app_db_name: str
29
32
  sys_db_name: Optional[str]
@@ -93,7 +96,7 @@ def _substitute_env_vars(content: str) -> str:
93
96
  return re.sub(regex, replace_func, content)
94
97
 
95
98
 
96
- def get_dbos_database_url(config_file_path: str = "dbos-config.yaml") -> str:
99
+ def get_dbos_database_url(config_file_path: str = DBOS_CONFIG_PATH) -> str:
97
100
  """
98
101
  Retrieve application database URL from configuration `.yaml` file.
99
102
 
@@ -119,7 +122,9 @@ def get_dbos_database_url(config_file_path: str = "dbos-config.yaml") -> str:
119
122
  return db_url.render_as_string(hide_password=False)
120
123
 
121
124
 
122
- def load_config(config_file_path: str = "dbos-config.yaml") -> ConfigFile:
125
+ def load_config(
126
+ config_file_path: str = DBOS_CONFIG_PATH, *, use_db_wizard: bool = True
127
+ ) -> ConfigFile:
123
128
  """
124
129
  Load the DBOS `ConfigFile` from the specified path (typically `dbos-config.yaml`).
125
130
 
@@ -151,6 +156,9 @@ def load_config(config_file_path: str = "dbos-config.yaml") -> ConfigFile:
151
156
  except ValidationError as e:
152
157
  raise DBOSInitializationError(f"Validation error: {e}")
153
158
 
159
+ if "database" not in data:
160
+ data["database"] = {}
161
+
154
162
  if "name" not in data:
155
163
  raise DBOSInitializationError(
156
164
  f"dbos-config.yaml must specify an application name"
@@ -169,8 +177,6 @@ def load_config(config_file_path: str = "dbos-config.yaml") -> ConfigFile:
169
177
  if "runtimeConfig" not in data or "start" not in data["runtimeConfig"]:
170
178
  raise DBOSInitializationError(f"dbos-config.yaml must specify a start command")
171
179
 
172
- data = cast(ConfigFile, data)
173
-
174
180
  if not _is_valid_app_name(data["name"]):
175
181
  raise DBOSInitializationError(
176
182
  f'Invalid app name {data["name"]}. App names must be between 3 and 30 characters long and contain only lowercase letters, numbers, dashes, and underscores.'
@@ -179,10 +185,49 @@ def load_config(config_file_path: str = "dbos-config.yaml") -> ConfigFile:
179
185
  if "app_db_name" not in data["database"]:
180
186
  data["database"]["app_db_name"] = _app_name_to_db_name(data["name"])
181
187
 
188
+ # Load the DB connection file. Use its values for missing fields from dbos-config.yaml. Use defaults otherwise.
189
+ data = cast(ConfigFile, data)
190
+ db_connection = load_db_connection()
191
+ if data["database"].get("hostname"):
192
+ print(
193
+ "[bold blue]Loading database connection parameters from dbos-config.yaml[/bold blue]"
194
+ )
195
+ elif db_connection.get("hostname"):
196
+ print(
197
+ "[bold blue]Loading database connection parameters from .dbos/db_connection[/bold blue]"
198
+ )
199
+ else:
200
+ print(
201
+ "[bold blue]Using default database connection parameters (localhost)[/bold blue]"
202
+ )
203
+
204
+ data["database"]["hostname"] = (
205
+ data["database"].get("hostname") or db_connection.get("hostname") or "localhost"
206
+ )
207
+ data["database"]["port"] = (
208
+ data["database"].get("port") or db_connection.get("port") or 5432
209
+ )
210
+ data["database"]["username"] = (
211
+ data["database"].get("username") or db_connection.get("username") or "postgres"
212
+ )
213
+ data["database"]["password"] = (
214
+ data["database"].get("password")
215
+ or db_connection.get("password")
216
+ or os.environ.get("PGPASSWORD")
217
+ or "dbos"
218
+ )
219
+ data["database"]["local_suffix"] = (
220
+ data["database"].get("local_suffix")
221
+ or db_connection.get("local_suffix")
222
+ or False
223
+ )
224
+
225
+ # Configure the DBOS logger
182
226
  config_logger(data)
183
227
 
184
228
  # Check the connectivity to the database and make sure it's properly configured
185
- data = db_connect(data, config_file_path)
229
+ if use_db_wizard:
230
+ data = db_wizard(data, config_file_path)
186
231
 
187
232
  if "local_suffix" in data["database"] and data["database"]["local_suffix"]:
188
233
  data["database"]["app_db_name"] = f"{data['database']['app_db_name']}_local"
@@ -35,6 +35,7 @@ class DBOSErrorCode(Enum):
35
35
  DeadLetterQueueError = 6
36
36
  MaxStepRetriesExceeded = 7
37
37
  NotAuthorized = 8
38
+ ConflictingWorkflowError = 9
38
39
 
39
40
 
40
41
  class DBOSWorkflowConflictIDError(DBOSException):
@@ -47,6 +48,16 @@ class DBOSWorkflowConflictIDError(DBOSException):
47
48
  )
48
49
 
49
50
 
51
+ class DBOSConflictingWorkflowError(DBOSException):
52
+ """Exception raised different workflows started with the same workflow ID."""
53
+
54
+ def __init__(self, workflow_id: str, message: Optional[str] = None):
55
+ super().__init__(
56
+ f"Conflicting workflow invocation with the same ID ({workflow_id}): {message}",
57
+ dbos_error_code=DBOSErrorCode.ConflictingWorkflowError.value,
58
+ )
59
+
60
+
50
61
  class DBOSRecoveryError(DBOSException):
51
62
  """Exception raised when a workflow recovery fails."""
52
63
 
@@ -1,3 +1,4 @@
1
+ import re
1
2
  import threading
2
3
  from typing import TYPE_CHECKING, Any, Callable, NoReturn
3
4
 
@@ -19,6 +20,14 @@ _kafka_queue: Queue
19
20
  _in_order_kafka_queues: dict[str, Queue] = {}
20
21
 
21
22
 
23
+ def safe_group_name(method_name: str, topics: list[str]) -> str:
24
+ safe_group_id = "-".join(
25
+ re.sub(r"[^a-zA-Z0-9\-]", "", str(r)) for r in [method_name, *topics]
26
+ )
27
+
28
+ return f"dbos-kafka-group-{safe_group_id}"[:255]
29
+
30
+
22
31
  def _kafka_consumer_loop(
23
32
  func: _KafkaConsumerWorkflow,
24
33
  config: dict[str, Any],
@@ -34,6 +43,12 @@ def _kafka_consumer_loop(
34
43
  if "auto.offset.reset" not in config:
35
44
  config["auto.offset.reset"] = "earliest"
36
45
 
46
+ if config.get("group.id") is None:
47
+ config["group.id"] = safe_group_name(func.__qualname__, topics)
48
+ dbos_logger.warning(
49
+ f"Consumer group ID not found. Using generated group.id {config['group.id']}"
50
+ )
51
+
37
52
  consumer = Consumer(config)
38
53
  try:
39
54
  consumer.subscribe(topics)
@@ -71,8 +86,9 @@ def _kafka_consumer_loop(
71
86
  topic=cmsg.topic(),
72
87
  value=cmsg.value(),
73
88
  )
89
+ groupID = config.get("group.id")
74
90
  with SetWorkflowID(
75
- f"kafka-unique-id-{msg.topic}-{msg.partition}-{msg.offset}"
91
+ f"kafka-unique-id-{msg.topic}-{msg.partition}-{groupID}-{msg.offset}"
76
92
  ):
77
93
  if in_order:
78
94
  assert msg.topic is not None
@@ -0,0 +1,34 @@
1
+ """workflow_queues_executor_id
2
+
3
+ Revision ID: 04ca4f231047
4
+ Revises: d76646551a6c
5
+ Create Date: 2025-01-15 15:05:08.043190
6
+
7
+ """
8
+
9
+ from typing import Sequence, Union
10
+
11
+ import sqlalchemy as sa
12
+ from alembic import op
13
+
14
+ # revision identifiers, used by Alembic.
15
+ revision: str = "04ca4f231047"
16
+ down_revision: Union[str, None] = "d76646551a6c"
17
+ branch_labels: Union[str, Sequence[str], None] = None
18
+ depends_on: Union[str, Sequence[str], None] = None
19
+
20
+
21
+ def upgrade() -> None:
22
+ op.add_column(
23
+ "workflow_queue",
24
+ sa.Column(
25
+ "executor_id",
26
+ sa.Text(),
27
+ nullable=True,
28
+ ),
29
+ schema="dbos",
30
+ )
31
+
32
+
33
+ def downgrade() -> None:
34
+ op.drop_column("workflow_queue", "executor_id", schema="dbos")