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 with XState #1019

Open
wants to merge 64 commits into
base: feature/svelte
Choose a base branch
from
Open

Workflows with XState #1019

wants to merge 64 commits into from

Conversation

FyreByrd
Copy link

Uses the XState library to create FSM instances that model the desired workflow behavior.

Features:

  • Persistence: Each instance has an associated DB record (in WorkflowInstances) that stores enough information to restore to the current state.
  • User Tasks: Each instance updates the UserTasks table with the appropriate information.
  • Product Transitions: Each instance updates the ProductTransitions table with the appropriate information.
  • Tasks: The appropriate actions are provided based on the user in the /tasks/[product_id] and are handled by the FSM.
  • Admin: A barebones table of instances is provided in /admin/workflows.
    • Clicking on an entry will take a user to a visualization in /admin/workflows/[product_id]
    • While in the visualization, a user can select a state node and then press a button in a menu to jump the machine state to the selected state

Future Priorities:

  • Hook actions into backend
  • Authentication
  • Republish and Rebuild workflows
  • Workflow instance filtering/sorting in /admin/workflows
  • Improve visualization (and visualization efficiency)

FyreByrd and others added 30 commits September 18, 2024 18:14
@FyreByrd
Define simple workflow with xstate
20d71af
@FyreByrd
Move workflow definition to common
8c0b33c
@FyreByrd
Move workflow to common/public
a0359ca
@FyreByrd
Change to full state names
a7f75e0
@FyreByrd
Use workflow in tasks/id/server
551d040 
Send task name and actions to corresponding page.svelte

Handle form submission and redirect to /tasks
@FyreByrd
Filter form based on workflow state
b606476 
Based on workflow state:
- Select form title
- Select form instructions
- Select specific fields
- Conditionally return reviewers
- Conditionally return productArtifacts and filter by artifact type
@7dev7urandom @FyreByrd
Fix task link
7868c38
@FyreByrd
Add table for workflow instances
912c6c9
@FyreByrd
Add workflow instances to paraglide
9652c71
@FyreByrd
Don't drop columns for upcoming feature
8245ed9
@FyreByrd
Basic workflow pages, open inspector
2e0dc33
@FyreByrd
Basic workflow pages, open inspector
6dbc98d
@FyreByrd
Switch to Svelvet for visualization
ebf651e
@FyreByrd
Jump to arbitrary state from visualizer
a9d918b
@7dev7urandom @FyreByrd
Style and todos
9ef1946
@FyreByrd
Improved instance management menu
782ba2b 
- Show some product information
- Jump state is now a button in the menu rather than a contextmenu event
@FyreByrd
Retrieve snapshot from db
7dfab70 
there are no records in db currently, so can't test this yet.
@FyreByrd
Add more states to flow
a0fb661
@FyreByrd
Dynamic number of input anchors on visualization
ebce6f9
@FyreByrd
Add Email Reviewers state
3e943c7
@FyreByrd
Force based graph layout
e9413a1
@FyreByrd
Support nodes with fixed position
3f30715
@FyreByrd
Create fixed nodes, show graph before finished
fcf3434
@FyreByrd
Show workflow diagram ASAP
b72cf67
@FyreByrd
Create product function
e6f8dcc 
The frontend is not hooked into this yet.
@FyreByrd
Create database entry for instance
8413cea 
Does not work yet. Resolving import issues.
@FyreByrd
Move workflow to server-only
e116d71
@FyreByrd
Display comment in task list page
7e58204
@FyreByrd
Create snapshots on transitions
bd9cf0e
@FyreByrd
Update UserTasks from state machine
89b32db
@FyreByrd FyreByrd marked this pull request as ready for review September 24, 2024 21:05
7dev7urandom
7dev7urandom requested changes Sep 25, 2024
View reviewed changes
Copy link

@7dev7urandom 7dev7urandom left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks pretty good; well done.

Here's a first-look review. I haven't reviewed the default-workflow.ts stuff at all, and I haven't tested anything, but here's some comments I have looking through it rather quickly. Some questions are probably somewhat ignorant because I'm not entirely clear what your goal is, but I think they'll be helpful.

One larger thing: you're handling the state machines with a lot of functional programming. You have a lot of functions that take WorkflowMachine or WorkflowContext as (often the first) argument, which makes me wonder if it could be done in a more object-oriented way, making things more intuitive to write.

source/SIL.AppBuilder.Portal/common/public/workflow.ts Outdated Show resolved Hide resolved
source/SIL.AppBuilder.Portal/common/public/workflow.ts Outdated Show resolved Hide resolved
source/SIL.AppBuilder.Portal/common/public/workflow.ts Outdated Show resolved Hide resolved
source/SIL.AppBuilder.Portal/common/workflow/db.ts Outdated Show resolved Hide resolved
source/SIL.AppBuilder.Portal/common/workflow/db.ts Outdated Show resolved Hide resolved
source/SIL.AppBuilder.Portal/src/lib/springyGraph.ts Outdated Show resolved Hide resolved
source/SIL.AppBuilder.Portal/common/databaseProxy/Products.ts Outdated Show resolved Hide resolved
source/SIL.AppBuilder.Portal/src/routes/(authenticated)/tasks/[product_id]/+page.server.ts Outdated Show resolved Hide resolved
@FyreByrd FyreByrd marked this pull request as draft September 25, 2024 20:44
@FyreByrd
Copy link
Author

I have created a wrapper class for DefaultWorkflow and have updated all the rest of the code in accordance with that change.
I have also fixed a few small things that I noticed while working on that change (they are related to workflow, so still valid for the PR).

@FyreByrd FyreByrd marked this pull request as ready for review September 27, 2024 17:47
7dev7urandom
7dev7urandom requested changes Sep 30, 2024
View reviewed changes
Copy link

@7dev7urandom 7dev7urandom left a comment

Choose a reason for hiding this comment

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

Wow, it does look a lot better and easier to use. Let me know what you think of my feedback.

source/SIL.AppBuilder.Portal/common/workflow/index.ts Outdated Show resolved Hide resolved
source/SIL.AppBuilder.Portal/common/public/workflow.ts Outdated Show resolved Hide resolved
source/SIL.AppBuilder.Portal/common/workflow/index.ts Show resolved Hide resolved
@FyreByrd
Change Workflow construction methods
3dd3423 
- constructor is now private
- create and restore are static functions that return a Workflow instance
- getSnapshot is also static now
- updated parameters of the modified functions
7dev7urandom
7dev7urandom approved these changes Sep 30, 2024
View reviewed changes
Copy link

@7dev7urandom 7dev7urandom left a comment

Choose a reason for hiding this comment

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

Looks good to me, let's try it out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@7dev7urandom 7dev7urandom 7dev7urandom approved these changes

@chrisvire chrisvire Awaiting requested review from chrisvire

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@FyreByrd @7dev7urandom