-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Describe the outbox pattern #4257
Conversation
Learn Build status updates of commit e4477ba:
|
File | Status | Preview URL | Details |
---|---|---|---|
docs/patterns/outbox.md | Details |
docs/patterns/outbox.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading.
- Line 1, Column 1: [Warning: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. A freshness date is required for this content set. Add a date in format MM/DD/YYYY.
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID.
- Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results.
- Line 111, Column 26: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 118, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 119, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
- Line 1, Column 1: [Suggestion: products-missing]
Missing required attribute: 'products'. Specify at least one valid value from the Product taxonomy.
- Line 1, Column 1: [Suggestion: categories-missing]
Missing required attribute: 'categories'. Specify at least one valid value from the Azure Categories taxonomy.
- Line 111, Column 26: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' will be broken in isolated environments. Replace with a relative link.
- Line 118, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' will be broken in isolated environments. Replace with a relative link.
- Line 119, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quick first review
docs/patterns/outbox.md
Outdated
## Solution | ||
|
||
The solution to this problem is to split the execution of the message handling logic into two parts: | ||
- compute the side effects |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure it is good to use a term like "side effects". I think some developers would not intuitively understand the intent.
@MicrosoftDocs/cloud-architecture-content-team-pr-reviewers - Please review the proposed changes. If/when you want to move forward with the content, add a sign-off. #label:"aq-pr-triaged" |
Co-authored-by: Udi Dahan <udidahan@users.noreply.github.com>
Learn Build status updates of commit 4429de8:
|
File | Status | Preview URL | Details |
---|---|---|---|
docs/patterns/outbox.md | Details |
docs/patterns/outbox.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading.
- Line 1, Column 1: [Warning: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. A freshness date is required for this content set. Add a date in format MM/DD/YYYY.
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID.
- Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results.
- Line 111, Column 26: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 118, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 119, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
- Line 1, Column 1: [Suggestion: products-missing]
Missing required attribute: 'products'. Specify at least one valid value from the Product taxonomy.
- Line 1, Column 1: [Suggestion: categories-missing]
Missing required attribute: 'categories'. Specify at least one valid value from the Azure Categories taxonomy.
- Line 111, Column 26: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' will be broken in isolated environments. Replace with a relative link.
- Line 118, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' will be broken in isolated environments. Replace with a relative link.
- Line 119, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
@ckittel could you also give this a look to see that it's heading in the right direction? Thanks. |
@udidahan - I'll add this to the queue to review. Thanks! |
Much appreciated @ckittel |
Yeah, I feel like it is. If this is going to be a new contribution, I request that you work with Rob Bagby to get this into our contribution process. November is already full, so likely couldn't happen until December. Please send him an email (CC myself) to get this as a formal work item so we can collaborate in December or January. Otherwise, we won't have any cycles to allocate to making this article happen. |
@SzymonPobiega @udidahan - Is this PR still in progress? Should it be reassigned or closed? |
@ShannonLeavitt still WIP. I intend to finish it next week. |
And as requested, we'd like this to come in through the contribution pipeline so that we can get proper allocation of reviewers on our side. So when it is ready, @SzymonPobiega, please work directly with Rob. |
Learn Build status updates of commit fd1459e:
|
File | Status | Preview URL | Details |
---|---|---|---|
docs/patterns/outbox.md | Details |
docs/patterns/outbox.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading.
- Line 1, Column 1: [Warning: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. A freshness date is required for this content set. Add a date in format MM/DD/YYYY.
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID.
- Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results.
- Line 128, Column 11: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/databases/guide/transactional-outbox-cosmos' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 135, Column 26: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 140, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 141, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
- Line 1, Column 1: [Suggestion: products-missing]
Missing required attribute: 'products'. Specify at least one valid value from the Product taxonomy.
- Line 1, Column 1: [Suggestion: categories-missing]
Missing required attribute: 'categories'. Specify at least one valid value from the Azure Categories taxonomy.
- Line 128, Column 11: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/databases/guide/transactional-outbox-cosmos' will be broken in isolated environments. Replace with a relative link.
- Line 135, Column 26: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' will be broken in isolated environments. Replace with a relative link.
- Line 140, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' will be broken in isolated environments. Replace with a relative link.
- Line 141, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
@SzymonPobiega - I'm building out the publishing calendar for 2024 in the Cloud Design Patterns, can you please share your timeline with me on this? cc: @udidahan |
Hope all is okay @SzymonPobiega and @udidahan. If we don't have a clear timeline on this by the end of the week here, I'm going to need to close this as we can't keep having a placeholder for this in our backlog holding capacity from other projects. |
Hey @ckittel . Sorry for dropping the ball on this, I had a bit of hard time recently. I'll try to review @tmasternak 's comments tomorrow and read the whole document one more time to see if I can improve it more. So I guess I can realistically commit to be done with it by the end of the month (January). |
Co-authored-by: Tomasz Masternak <tomasz.masternak@particular.net>
Learn Build status updates of commit 62c1cf3:
|
File | Status | Preview URL | Details |
---|---|---|---|
docs/patterns/outbox.md | Details |
docs/patterns/outbox.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading.
- Line 1, Column 1: [Warning: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. A freshness date is required for this content set. Add a date in format MM/DD/YYYY.
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID.
- Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results.
- Line 131, Column 11: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/databases/guide/transactional-outbox-cosmos' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 138, Column 26: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 143, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 144, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 1, Column 1: [Suggestion: products-missing]
Missing required attribute: 'products'. Specify at least one valid value from the Product taxonomy.
- Line 1, Column 1: [Suggestion: categories-missing]
Missing required attribute: 'categories'. Specify at least one valid value from the Azure Categories taxonomy.
- Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
- Line 131, Column 11: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/databases/guide/transactional-outbox-cosmos' will be broken in isolated environments. Replace with a relative link.
- Line 138, Column 26: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' will be broken in isolated environments. Replace with a relative link.
- Line 143, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' will be broken in isolated environments. Replace with a relative link.
- Line 144, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
@ckittel I think it is now ready for the next phase. |
Learn Build status updates of commit ed43b14:
|
File | Status | Preview URL | Details |
---|---|---|---|
docs/patterns/outbox.md | Details |
docs/patterns/outbox.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading.
- Line 1, Column 1: [Warning: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. A freshness date is required for this content set. Add a date in format MM/DD/YYYY.
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID.
- Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results.
- Line 133, Column 11: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/databases/guide/transactional-outbox-cosmos' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 140, Column 26: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 146, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 147, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
- Line 1, Column 1: [Suggestion: products-missing]
Missing required attribute: 'products'. Specify at least one valid value from the Product taxonomy.
- Line 1, Column 1: [Suggestion: categories-missing]
Missing required attribute: 'categories'. Specify at least one valid value from the Azure Categories taxonomy.
- Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
- Line 133, Column 11: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/databases/guide/transactional-outbox-cosmos' will be broken in isolated environments. Replace with a relative link.
- Line 140, Column 26: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/best-practices/transactional-outbox-cosmos' will be broken in isolated environments. Replace with a relative link.
- Line 146, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/event-sourcing' will be broken in isolated environments. Replace with a relative link.
- Line 147, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/azure/architecture/patterns/retry' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
@ckittel - Can this content move to the next phase? Let us know if you need help pulling these commits into the private repo. |
@ShannonLeavitt We do not yet have it scheduled and as such not ready to move it into the |
#please-close I'm sorry, our capacity is stretched too thin at this point. I still have a pointer to this PR in case we get additional capacity to come back to this. |
Before selecting the "Create pull request" button:
Enter a meaningful title above^, using a prefix if necessary and keywords "New" or "Update" indicating the nature of changes.
Describe the summary, scope, and intent of this PR:
Adds description of the outbox messaging pattern
AFTER YOUR PR HAS BEEN CREATED, expand this section for tips and additional instructions.
These are common guidelines for contributions across the repos managed by the Cloud Architecture Content Team (CACT). Some repositories may have additional specific requirements that are not listed here.
Guidance for all contributors
Additional guidance for private repos and internal contributors
@MicrosoftDocs/cloud-architecture-content-team-pr-reviewers
in your PR and someone will get back to you. After CACT review is complete, aCACT #sign-off
will be added.@MicrosoftDocs/cloud-architecture-content-team-pr-reviewers