feat(docs): post on Durable Execution.
#816
Conversation
destifo
requested review from
zifeo,
michael-0acf4,
Natoandro,
Yohe-Am and
j03-dev
zifeo
changed the title
Durable Execution.Durable Execution.
|
@coderabbitai review |
1 similar comment
|
@coderabbitai review |
WalkthroughThe recent updates include significant modifications to the Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant OrderWorkflow
participant PaymentService
participant InventoryService
participant DeliveryService
Developer->>OrderWorkflow: Start Order Workflow
OrderWorkflow->>PaymentService: Process Payment
PaymentService-->>OrderWorkflow: Payment Confirmation
OrderWorkflow->>InventoryService: Check Inventory
InventoryService-->>OrderWorkflow: Inventory Status
OrderWorkflow->>DeliveryService: Deliver Order
DeliveryService-->>OrderWorkflow: Delivery Confirmation
OrderWorkflow-->>Developer: Complete Order Process
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range, codebase verification and nitpick comments (9)
website/blog/2024-08-13-durable-execution/index.mdx (9)
24-24: Fix Compound Adjective.Consider using a hyphen for "real-world" as it modifies the noun.
- **ADD Real World Example Here** + **ADD Real-World Example Here**Tools
LanguageTool
[uncategorized] ~24-~24: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...workloads that run in the system. ADD Real World Example Here Having multiple componen...(EN_COMPOUND_ADJECTIVE_INTERNAL)
30-30: Correct Abbreviation Format.The abbreviation "i.e." should have periods.
- i.e using message queues comes + i.e. using message queues comesTools
LanguageTool
[uncategorized] ~30-~30: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...st part, it can have some shortcomings. i.e using message queues comes with the ove...(I_E)
37-37: Correct Verb Usage.Use "roll back" as a verb.
- rollback the effects + roll back the effectsTools
LanguageTool
[grammar] ~37-~37: Please verify that the plural noun “components” is in agreement with the quantifier “one”. Did you mean to use the singular form?
Context: ...ransactions which span across more than one components in to a series of local transactions. E...(ONE_PLURAL)
[grammar] ~37-~37: The word “rollback” is a noun. The verb is spelled with a space.
Context: ... a series of compensating actions which rollback the effects that came from the precedin...(NOUN_VERB_CONFUSION)
[uncategorized] ~37-~37: This expression is usually spelled with a hyphen.
Context: ...attern aims to achieve consistency in a microservices based system. As the events are designed to b...(BASED_HYPHEN)
[uncategorized] ~37-~37: This expression is usually spelled with a hyphen.
Context: ...t can be challenging to implement timer/timeout based workflows, including designing and impl...(BASED_HYPHEN)
37-37: Use Hyphen for Compound Adjective.Use a hyphen in "microservices-based."
- microservices based system + microservices-based systemTools
LanguageTool
[grammar] ~37-~37: Please verify that the plural noun “components” is in agreement with the quantifier “one”. Did you mean to use the singular form?
Context: ...ransactions which span across more than one components in to a series of local transactions. E...(ONE_PLURAL)
[grammar] ~37-~37: The word “rollback” is a noun. The verb is spelled with a space.
Context: ... a series of compensating actions which rollback the effects that came from the precedin...(NOUN_VERB_CONFUSION)
[uncategorized] ~37-~37: This expression is usually spelled with a hyphen.
Context: ...attern aims to achieve consistency in a microservices based system. As the events are designed to b...(BASED_HYPHEN)
[uncategorized] ~37-~37: This expression is usually spelled with a hyphen.
Context: ...t can be challenging to implement timer/timeout based workflows, including designing and impl...(BASED_HYPHEN)
37-37: Use Hyphen for Compound Adjective.Use a hyphen in "timeout-based."
- timeout based workflows + timeout-based workflowsTools
LanguageTool
[grammar] ~37-~37: Please verify that the plural noun “components” is in agreement with the quantifier “one”. Did you mean to use the singular form?
Context: ...ransactions which span across more than one components in to a series of local transactions. E...(ONE_PLURAL)
[grammar] ~37-~37: The word “rollback” is a noun. The verb is spelled with a space.
Context: ... a series of compensating actions which rollback the effects that came from the precedin...(NOUN_VERB_CONFUSION)
[uncategorized] ~37-~37: This expression is usually spelled with a hyphen.
Context: ...attern aims to achieve consistency in a microservices based system. As the events are designed to b...(BASED_HYPHEN)
[uncategorized] ~37-~37: This expression is usually spelled with a hyphen.
Context: ...t can be challenging to implement timer/timeout based workflows, including designing and impl...(BASED_HYPHEN)
41-41: Add Missing Comma.Add a comma for clarity.
- a task and these tasks + a task, and these tasksTools
LanguageTool
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...flow. A step in a workflow represents a task and these tasks are represented as stat...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~41-~41: It seems that the correct verb form here is “offer”.
Context: ...persisted state. Stateful orchestrators offers great value in fault tolerance, consist...(AGREEMENT_SENT_START_2)
[uncategorized] ~41-~41: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e of distributed computing. Some of the well known services which provide this solution as...(EN_COMPOUND_ADJECTIVE_INTERNAL)
41-41: Correct Verb Agreement.Use "offer" instead of "offers."
- orchestrators offers great value + orchestrators offer great valueTools
LanguageTool
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...flow. A step in a workflow represents a task and these tasks are represented as stat...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~41-~41: It seems that the correct verb form here is “offer”.
Context: ...persisted state. Stateful orchestrators offers great value in fault tolerance, consist...(AGREEMENT_SENT_START_2)
[uncategorized] ~41-~41: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e of distributed computing. Some of the well known services which provide this solution as...(EN_COMPOUND_ADJECTIVE_INTERNAL)
41-41: Use Hyphen for Compound Adjective.Use a hyphen in "well-known."
- well known services + well-known servicesTools
LanguageTool
[uncategorized] ~41-~41: Possible missing comma found.
Context: ...flow. A step in a workflow represents a task and these tasks are represented as stat...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~41-~41: It seems that the correct verb form here is “offer”.
Context: ...persisted state. Stateful orchestrators offers great value in fault tolerance, consist...(AGREEMENT_SENT_START_2)
[uncategorized] ~41-~41: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e of distributed computing. Some of the well known services which provide this solution as...(EN_COMPOUND_ADJECTIVE_INTERNAL)
48-48: Vary Sentence Beginnings.Avoid starting three consecutive sentences with "Durable execution."
Consider rephrasing for variety.
Tools
LanguageTool
[style] ~48-~48: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...spite failures or system interruptions. Durable execution enforces for every task, its ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~48-~48: The singular determiner ‘this’ may not agree with the plural noun ‘constraints’. Did you mean “these”?
Context: ...luding local variables to be persisted. This constraints or rather features of durab...(THIS_NNS)
|
@coderabbitai review |
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (5)
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx (5)
6-6: Grammar improvement: Add a comma before "and".Use a comma before “and” if it connects two independent clauses.
Apply this diff to improve the grammar:
- ...completes successfully and that failures are properly handled... + ...completes successfully, and that failures are properly handled...Tools
LanguageTool
[uncategorized] ~6-~6: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...p in the workflow completes successfully and that failures are properly handled, you...(COMMA_COMPOUND_SENTENCE_2)
27-27: Grammar improvement: Add hyphens to "Event-Driven".The adjective “Event-Driven” is spelled with a hyphen.
Apply this diff to improve the grammar:
- #### Advantages of Event Driven Architecture + #### Advantages of Event-Driven Architecture - #### Challenges of Event Driven Architecture + #### Challenges of Event-Driven ArchitectureAlso applies to: 35-35
Tools
LanguageTool
[uncategorized] ~27-~27: The adjective “Event-Driven” is spelled with a hyphen.
Context: ...ibkRL1w.png) #### Advantages of Event Driven Architecture - Improved Scalability - ...(DRIVEN_HYPHEN)
46-46: Grammar improvement: Correct "rollback" to "roll back".The word “rollback” is a noun. The verb is spelled with a space.
Apply this diff to improve the grammar:
- ...a series of compensating actions rollback the effects of preceding transactions... + ...a series of compensating actions roll back the effects of preceding transactions...Tools
LanguageTool
[grammar] ~46-~46: The word “rollback” is a noun. The verb is spelled with a space.
Context: ...plete, a series of compensating actions rollback the effects of preceding transactions. ...(NOUN_VERB_CONFUSION)
76-76: Grammar improvement: Add a subject to the sentence.To form a complete sentence, be sure to include a subject.
Apply this diff to improve the grammar:
- Might be challenging to implement initially. + It might be challenging to implement initially.Tools
LanguageTool
[style] ~76-~76: To form a complete sentence, be sure to include a subject.
Context: ... the sequence fails. #### Drawbacks - Might be challenging to implement initially. ...(MISSING_IT_THERE)
100-100: Grammar improvement: Reword the sentence to avoid repetition.Three successive sentences begin with the same word. Consider rewording the sentence.
Apply this diff to improve the grammar:
- Durable execution ensures that for every task, its inputs, outputs, call stack, and local variables are persisted. + It ensures that for every task, its inputs, outputs, call stack, and local variables are persisted.Tools
LanguageTool
[style] ~100-~100: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tion despite failures or interruptions. Durable execution ensures that for every task, ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx
Outdated
Show resolved
Hide resolved
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx
Outdated
Show resolved
Hide resolved
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx
Outdated
Show resolved
Hide resolved
|
@coderabbitai review |
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range, codebase verification and nitpick comments (3)
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx (3)
6-6: Improve sentence structure for better readability.Consider rephrasing the sentence for better readability:
-In this age of cloud development and microservices architecture, problems start to arise with the increased workloads that run in the system. +In this age of cloud development and microservices architecture, problems arise as workloads increase within the system.Tools
LanguageTool
[uncategorized] ~6-~6: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...p in the workflow completes successfully and that failures are properly handled, you...(COMMA_COMPOUND_SENTENCE_2)
91-91: Improve sentence variety.Consider rephrasing the sentences to avoid repetitive beginnings:
-Durable execution refers to the ability of a system to preserve the state of an application and persist execution despite failures or interruptions. Durable execution ensures that for every task, its inputs, outputs, call stack, and local variables are persisted. +Durable execution refers to the ability of a system to preserve the state of an application and persist execution despite failures or interruptions. It ensures that for every task, its inputs, outputs, call stack, and local variables are persisted.Tools
LanguageTool
[style] ~91-~91: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tion despite failures or interruptions. Durable execution ensures that for every task, ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
388-388: Improve sentence variety.Consider rephrasing the sentences to avoid repetitive phrasing:
-Before deploying the above typegraph, you need to start the temporal server and the worker. You need to have [temporal](https://learn.temporal.io/getting_started/typescript/dev_environment/#set-up-a-local-temporal-service-for-development-with-temporal-cli) installed on your machine. +Before deploying the above typegraph, start the temporal server and the worker. Ensure you have [temporal](https://learn.temporal.io/getting_started/typescript/dev_environment/#set-up-a-local-temporal-service-for-development-with-temporal-cli) installed on your machine.Tools
LanguageTool
[style] ~388-~388: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...fore deploying the above typegraph, you need to start the temporal server and the worke...(REP_NEED_TO_VB)
[style] ~388-~388: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...the temporal server and the worker. You need to have [temporal](https://learn.temporal....(REP_NEED_TO_VB)
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx
Outdated
Show resolved
Hide resolved
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx
Outdated
Show resolved
Hide resolved
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx
Outdated
Show resolved
Hide resolved
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx
Outdated
Show resolved
Hide resolved
website/blog/2024-08-13-distributed-execution-flow-paradigms/index.mdx
Outdated
Show resolved
Hide resolved
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #816 +/- ##
=======================================
Coverage 69.05% 69.05%
=======================================
Files 144 144
Lines 16704 16704
Branches 1481 1480 -1
=======================================
Hits 11535 11535
Misses 5143 5143
Partials 26 26 ☔ View full report in Codecov by Sentry. |
A blog about durable execution
Migration notes
...
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Improvements
Documentation