Skip to content
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

Jump to bottom

workflows, remove deprecated functions #749

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
+38 −19
Open

workflows, remove deprecated functions #749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6b093c2
workflows, remove deprecated functions
famarting Oct 29, 2024
32e4735
revert changes to example
famarting Nov 6, 2024
e85e4dc
update warning messages
famarting Nov 11, 2024
686b441
Typos
elena-kolevska Nov 11, 2024
4d91df5
Merge branch 'main' into wf-remove-deprecated-functions
elena-kolevska Nov 11, 2024
b0d88dc
fixes linter
elena-kolevska Nov 20, 2024
057df51
Merge branch 'main' into wf-remove-deprecated-functions
elena-kolevska Nov 22, 2024
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
21 changes: 14 additions & 7 deletions dapr/aio/clients/grpc/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1409,6 +1409,7 @@ async def start_workflow(
send_raw_bytes: bool = False,
) -> StartWorkflowResponse:
"""Starts a workflow.
Deprecated: use dapr-ext-workflow instead
Copy link
Member

@berndverst berndverst Nov 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to these deprecation notice in the docstring, can you please emit a warning message (please do this the same way we do elsewhere in the SDK).

Nit please add the word SDK or package -- Use the dapr-ext-workflow package.

Copy link
Member

@berndverst berndverst Nov 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now we already have:

'The Workflow API is a Beta version and is subject to change.',

So maybe update this to say: This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow` package instead.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


Args:
workflow_component (str): the name of the workflow component
Expand All @@ -1430,7 +1431,7 @@ async def start_workflow(
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand Down Expand Up @@ -1470,6 +1471,7 @@ async def start_workflow(

async def get_workflow(self, instance_id: str, workflow_component: str) -> GetWorkflowResponse:
"""Gets information on a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1482,7 +1484,7 @@ async def get_workflow(self, instance_id: str, workflow_component: str) -> GetWo
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand Down Expand Up @@ -1511,6 +1513,7 @@ async def get_workflow(self, instance_id: str, workflow_component: str) -> GetWo

async def terminate_workflow(self, instance_id: str, workflow_component: str) -> DaprResponse:
"""Terminates a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance, e.g.
Expand All @@ -1523,7 +1526,7 @@ async def terminate_workflow(self, instance_id: str, workflow_component: str) ->
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand All @@ -1548,6 +1551,7 @@ async def raise_workflow_event(
send_raw_bytes: bool = False,
) -> DaprResponse:
"""Raises an event on a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1568,7 +1572,7 @@ async def raise_workflow_event(
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand Down Expand Up @@ -1611,6 +1615,7 @@ async def raise_workflow_event(

async def pause_workflow(self, instance_id: str, workflow_component: str) -> DaprResponse:
"""Pause a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1624,7 +1629,7 @@ async def pause_workflow(self, instance_id: str, workflow_component: str) -> Dap
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand All @@ -1643,6 +1648,7 @@ async def pause_workflow(self, instance_id: str, workflow_component: str) -> Dap

async def resume_workflow(self, instance_id: str, workflow_component: str) -> DaprResponse:
"""Resumes a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1655,7 +1661,7 @@ async def resume_workflow(self, instance_id: str, workflow_component: str) -> Da
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand All @@ -1674,6 +1680,7 @@ async def resume_workflow(self, instance_id: str, workflow_component: str) -> Da

async def purge_workflow(self, instance_id: str, workflow_component: str) -> DaprResponse:
"""Purges a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1686,7 +1693,7 @@ async def purge_workflow(self, instance_id: str, workflow_component: str) -> Dap
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand Down
21 changes: 14 additions & 7 deletions dapr/clients/grpc/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1413,6 +1413,7 @@ def start_workflow(
send_raw_bytes: bool = False,
) -> StartWorkflowResponse:
"""Starts a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
workflow_component (str): the name of the workflow component
Expand All @@ -1434,7 +1435,7 @@ def start_workflow(
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand Down Expand Up @@ -1470,6 +1471,7 @@ def start_workflow(

def get_workflow(self, instance_id: str, workflow_component: str) -> GetWorkflowResponse:
"""Gets information on a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1482,7 +1484,7 @@ def get_workflow(self, instance_id: str, workflow_component: str) -> GetWorkflow
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand Down Expand Up @@ -1511,6 +1513,7 @@ def get_workflow(self, instance_id: str, workflow_component: str) -> GetWorkflow

def terminate_workflow(self, instance_id: str, workflow_component: str) -> DaprResponse:
"""Terminates a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance, e.g.
Expand All @@ -1524,7 +1527,7 @@ def terminate_workflow(self, instance_id: str, workflow_component: str) -> DaprR
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand All @@ -1549,6 +1552,7 @@ def raise_workflow_event(
send_raw_bytes: bool = False,
) -> DaprResponse:
"""Raises an event on a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1568,7 +1572,7 @@ def raise_workflow_event(
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand Down Expand Up @@ -1613,6 +1617,7 @@ def raise_workflow_event(

def pause_workflow(self, instance_id: str, workflow_component: str) -> DaprResponse:
"""Pause a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1626,7 +1631,7 @@ def pause_workflow(self, instance_id: str, workflow_component: str) -> DaprRespo
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand All @@ -1645,6 +1650,7 @@ def pause_workflow(self, instance_id: str, workflow_component: str) -> DaprRespo

def resume_workflow(self, instance_id: str, workflow_component: str) -> DaprResponse:
"""Resumes a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1657,7 +1663,7 @@ def resume_workflow(self, instance_id: str, workflow_component: str) -> DaprResp
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand All @@ -1676,6 +1682,7 @@ def resume_workflow(self, instance_id: str, workflow_component: str) -> DaprResp

def purge_workflow(self, instance_id: str, workflow_component: str) -> DaprResponse:
"""Purges a workflow.
Deprecated: use dapr-ext-workflow instead

Args:
instance_id (str): the ID of the workflow instance,
Expand All @@ -1688,7 +1695,7 @@ def purge_workflow(self, instance_id: str, workflow_component: str) -> DaprRespo
"""
# Warnings and input validation
warn(
'The Workflow API is a Beta version and is subject to change.',
'This Workflow API (Beta) method is deprecated and will be removed in a future version. Use the dapr-ext-workflow package instead.',
UserWarning,
stacklevel=2,
)
Expand Down
6 changes: 3 additions & 3 deletions examples/demo_workflow/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

This document describes how to register a workflow and activities inside it and start running it.
It demonstrates the following APIs:
- **start_workflow**: Start an instance of a workflow
- **get_workflow**: Get information on a single workflow
- **schedule_new_workflow**: Start an instance of a workflow
- **get_workflow_state**: Get information on a single workflow
- **terminate_workflow**: Terminate or stop a particular instance of a workflow
- **raise_event**: Raise an event on a workflow
- **raise_workflow_event**: Raise an event on a workflow
- **pause_workflow**: Pauses or suspends a workflow instance that can later be resumed
- **resume_workflow**: Resumes a paused workflow instance
- **purge_workflow**: Removes all metadata related to a specific workflow instance from the state store
Expand Down
3 changes: 3 additions & 0 deletions examples/demo_workflow/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@ def act_for_child_wf(ctx: WorkflowActivityContext, inp):


def main():
# DEPRECATION NOTICE!
# The workflow methods in the DaprClient are deprecated, instead use the client provided in dapr-ext-workflow
# You can use the examples in https://github.com/dapr/python-sdk/tree/main/examples/workflow
with DaprClient() as d:
workflow_runtime = WorkflowRuntime()
workflow_runtime.register_workflow(hello_world_wf)
Expand Down
2 changes: 1 addition & 1 deletion examples/demo_workflow/demo_workflow/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
dapr-ext-workflow-dev>=0.0.1rc1.dev
dapr-ext-workflow-dev>=0.0.1rc1.dev
2 changes: 2 additions & 0 deletions ext/dapr-ext-workflow/tests/test_workflow_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,5 @@ def test_client_functions(self):

actual_resume_result = wfClient.resume_workflow(instance_id=mockInstanceId)
assert actual_resume_result == mock_resume_result

# TODO add purge support
2 changes: 1 addition & 1 deletion tests/clients/test_dapr_grpc_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -881,7 +881,7 @@ def test_unlock_input_validation(self):
# Tests for workflow
#

def test_workflow(self):
def test_workflow_deprecated(self):
dapr = DaprGrpcClient(f'{self.scheme}localhost:{self.grpc_port}')
# Sane parameters
workflow_name = 'test_workflow'
Expand Down