chore(web): refactor onboarding create workflow from blueprint logic #5233
Conversation
| const workflowIdentifier = slugify(blueprintName, { | ||
| lower: true, | ||
| strict: true, | ||
| }); |
There was a problem hiding this comment.
create workflow identifier from the name
| strict: true, | ||
| }); | ||
|
|
||
| return await getTemplateById(workflowIdentifier); |
There was a problem hiding this comment.
return the workflow if exist, otherwise error will be thrown
| return await createTemplateFromBlueprint({ | ||
| blueprint: { ...blueprintData, name: blueprintName }, | ||
| params: { __source: TemplateCreationSourceEnum.ONBOARDING_GET_STARTED }, | ||
| }); |
There was a problem hiding this comment.
when the workflow doesn't exist, create a new one based on the blueprint
There was a problem hiding this comment.
❔ question: What should happen if this fails?
There was a problem hiding this comment.
if this fails, then the mutation will fail and in the result, we will show the error toast
| function buildWorkflowEditorUrl(workflow: INotificationTemplate, step?: OnboardingWorkflowRouteEnum) { | ||
| const workflowRoute = parseUrl(ROUTES.WORKFLOWS_EDIT_TEMPLATEID, { templateId: workflow._id! }); | ||
| if (step === OnboardingWorkflowRouteEnum.TEST_WORKFLOW) { | ||
| return `${window.location.origin}${workflowRoute}/${OnboardingWorkflowRouteEnum.TEST_WORKFLOW}`; | ||
| } | ||
|
|
||
| const stepUuid = workflow.steps.find((el) => el.name?.toLowerCase() === step?.toLowerCase())?.uuid; | ||
| if (step && stepUuid) { | ||
| return `${window.location.origin}${workflowRoute}/${step}/${stepUuid}`; | ||
| } | ||
|
|
||
| return `${window.location.origin}${workflowRoute}`; | ||
| } |
There was a problem hiding this comment.
This function builds the URL to the Workflow Editor. When:
- step is TEST_WORKFLOW the URL point to the Test Workflow page with sidebar opened:
http://localhost:4200/workflows/edit/65d91b93b0bb8c7b5e68a9ab/test-workflow - if the workflow has the step redirect him to the step editor:
http://localhost:4200/workflows/edit/65d91b93b0bb8c7b5e68a9ab/in-app/65d91b93b0bb8c7b5e68a9ab - otherwise redirect to the Workflow Editor:
http://localhost:4200/workflows/edit/65d91b93b0bb8c7b5e68a9ab
There was a problem hiding this comment.
Thanks a ton for the fix and refactor! I'll test once you have the doc available.
Side note: while I appreciate the PR comments, I'd much rather see those in code. They add more value there IMO, especially if code needs clarification to its purpose or reasoning behind it. PR comments are great too, but I think should be reserved for reserved for temporary notes related to the review or dev process since they'll be gone in a few days.
| return await createTemplateFromBlueprint({ | ||
| blueprint: { ...blueprintData, name: blueprintName }, | ||
| params: { __source: TemplateCreationSourceEnum.ONBOARDING_GET_STARTED }, | ||
| }); |
There was a problem hiding this comment.
❔ question: What should happen if this fails?
apps/web/src/pages/get-started/components/OpenWorkflowButton.tsx
Outdated
Show resolved
Hide resolved
apps/web/src/pages/get-started/components/OpenWorkflowButton.tsx
Outdated
Show resolved
Hide resolved
@antonjoel82 The PR comments have a different purpose and this is something that we established as a team. We don't have a practice of putting the comments in the code, but we can discuss that topic on the tech summit if you would like to bring it. |
What change does this PR introduce?
Onboarding Improvements: refactor the logic that creates the workflow from the blueprint.
Why was this change needed?
Other information (Screenshots)
Screen.Recording.2024-02-23.at.23.26.25.mov