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.

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

Ensure Dapr workflows classes and interfaces have proper packages and visibility #1175

Open
artur-ciocanu opened this issue Dec 7, 2024 · 2 comments · May be fixed by #1176
Open

Ensure Dapr workflows classes and interfaces have proper packages and visibility #1175

artur-ciocanu opened this issue Dec 7, 2024 · 2 comments · May be fixed by #1176

Comments

@artur-ciocanu
Copy link
Contributor

artur-ciocanu commented Dec 7, 2024

Describe the proposal

Currently a few Dapr worflows related classes are "poorly" named and do not reflect the intent of the class. Also some classes are exposed to the public API, while it shouldn't.

Here are a few of the offenders:

  • Workflow abstract class - ideally it should be an interface and have "default" methods, for everything that is currently used
  • WorkflowActivity interface - it should be moved outside of runtime package, since it is part of the programming model
  • OrchestratorWrapper and ActivityWrapper - these should be renamed to WorkflowWrapper and WorkflowActivityWrapper respectively
  • WorkflowActivityContext - this should be an interface just like WorkflowContext and moved outside of runtime since it is part of the programming model.
  • DaprWorkflowContextImpl - should be renamed to DaprWorkflowContext and moved to runtime package since this is an internal implementation.

By implementing this proposal we will ensure that the classes that the developers have to interact with aka are part of the programming model are available in io.dapr.workflows while all the rest are pushed to runtime and also have proper names.

@artur-ciocanu
Copy link
Contributor Author

@artursouza and @cicoyle before trying to work on this, could you please let me know if you agree with my proposal. Thank you!

CC: @salaboy

@salaboy
Copy link
Contributor

salaboy commented Dec 9, 2024

100% to do these changes before we move things out of beta.
@artursouza @cicoyle can you please review and add comments?

artur-ciocanu added a commit to artur-ciocanu/java-sdk that referenced this issue Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants