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

docs: Adds ADR on the migration to UUID7 #1370

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

nathanbogale
Copy link
Contributor

Related Issue(s)

Resolves #1369

Description of Changes

This PR introduces a new Architecture Decision Record (ADR) documenting our decision to transition from ULIDs to UUIDv7 for time-ordered identifiers, while using UUIDv4 for non-time-ordered identifiers. The ADR outlines the rationale, implementation guidelines, and migration strategy for this architectural change.

Breaking Changes

While the ADR itself doesn't introduce breaking changes, the implementation of this decision will require:

  • Gradual migration of existing ULID implementations to UUIDv7
  • Updates to database schemas using UUID types
  • Changes to API contracts and documentation
  • Updates to identifier generation logic in various services

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules

@nathanbogale nathanbogale added the review me PR is ready for review label Dec 10, 2024
@nathanbogale nathanbogale requested a review from stevenj December 10, 2024 16:38
Copy link
Contributor

Test Report | ${\color{lightgreen}Pass: 334/334}$ | ${\color{red}Fail: 0/334}$ |

@nathanbogale nathanbogale changed the title doc(docs): Adds ADR on the migration to UUID7 docs(doc): Adds ADR on the migration to UUID7 Dec 11, 2024
@nathanbogale nathanbogale changed the title docs(doc): Adds ADR on the migration to UUID7 docs: Adds ADR on the migration to UUID7 Dec 11, 2024
Copy link
Contributor

Test Report | ${\color{lightgreen}Pass: 334/334}$ | ${\color{red}Fail: 0/334}$ |

Copy link
Contributor

Test Report | ${\color{lightgreen}Pass: 334/334}$ | ${\color{red}Fail: 0/334}$ |

Copy link
Contributor

@Mr-Leshiy Mr-Leshiy left a comment

Choose a reason for hiding this comment

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

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review me PR is ready for review
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

🛠️ [TASK] : Migrate from ULID to UUIDv7 for Time-Ordered Identifiers
3 participants