Skip to content

feat(tasks): expose request ID field on Tasks #550

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

Merged
douglas-reid merged 1 commit into from
Sep 15, 2023
Merged

feat(tasks): expose request ID field on Tasks #550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions src/steamship/base/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,9 @@ class Task(GenericCamelModel, Generic[T]):
task_id: str = None # The id of this task
user_id: str = None # The user who requested this task
workspace_id: str = None # The workspace in which this task is executing
request_id: Optional[str] = Field(
default=None
) # The ID for the request that lead to the creation of this Task.

# Note: The Field object prevents this from being serialized into JSON (and causing a crash)
expect: Type = Field(
Expand Down
3 changes: 3 additions & 0 deletions tests/steamship_tests/base/test_task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ def test_background_task_call():
# When we background it, we get a task back instead
result_2_task = client.post("task/noop", expect=NoOpResult, as_background_task=True)
assert result_2_task is not None
assert result_2_task.request_id is not None
assert result_2_task.state == TaskState.waiting

result_2_task.wait()
Expand All @@ -52,6 +53,7 @@ def test_task_wait_milliseconds():
# When we background it, we get a task back instead
result_2_task = client.post("task/noop", expect=NoOpResult, task_delay_ms=1000)
assert result_2_task is not None
assert result_2_task.request_id is not None
assert result_2_task.state == TaskState.waiting

result_2_task.wait()
Expand All @@ -68,6 +70,7 @@ def test_task_update():
# We'll background this operation in order to transform it into a task we can manipulate
result_task = client.post("task/noop", expect=NoOpResult, as_background_task=True)
assert result_task is not None
assert result_task.request_id is not None
assert result_task.state == TaskState.waiting

result_task.wait()
Expand Down