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

feat(195): Create Architecture for Collection Versioning #204

Merged
merged 7 commits into from
Jan 31, 2025
Merged

feat(195): Create Architecture for Collection Versioning #204

merged 7 commits into from
Jan 31, 2025

Conversation

SoulKa
Copy link
Collaborator

@SoulKa SoulKa commented Jan 24, 2025 •
edited
Loading

Changes

  • Create ADR in docs/ on how to deal with breaking changes in persistence and how to have backwards compatibility
  • Create base class for collection item mapping between versions
  • Refactor parts of the InfoFile loading to automatically migrate from potentially old versions
  • Create new InfoFile schema version 1.0.1 to demonstrate the migration process

Testing

If relevant, mention your manual testing here. If possible, include screenshots.

Checklist

  • Issue has been linked to this PR
  • Code has been reviewed by person creating the PR
  • Automated tests have been written, if possible
  • Manual testing has been performed
  • Documentation has been updated, if necessary
  • Changes have been reviewed by second person

@SoulKa SoulKa added enhancement New feature or request backend Backend related task architecture Architectural task labels Jan 24, 2025
@SoulKa SoulKa linked an issue Jan 24, 2025 that may be closed by this pull request
Create Architecture for Collection Versioning #195
Closed
@SoulKa SoulKa force-pushed the feature/195-create-architecture-for-collection-versioning branch from d152d31 to d8d0021 Compare January 24, 2025 21:50
@SoulKa SoulKa marked this pull request as draft January 25, 2025 14:25
@SoulKa SoulKa force-pushed the feature/195-create-architecture-for-collection-versioning branch from 5eb6fa8 to e352d6c Compare January 25, 2025 15:26
@SoulKa SoulKa marked this pull request as ready for review January 25, 2025 15:26
@SoulKa SoulKa force-pushed the feature/195-create-architecture-for-collection-versioning branch from e352d6c to bd0d541 Compare January 29, 2025 13:08
@kwerber kwerber self-requested a review January 29, 2025 15:15
kwerber
kwerber requested changes Jan 29, 2025
View reviewed changes
Copy link
Collaborator

@kwerber kwerber left a comment

Choose a reason for hiding this comment

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

I have commented some minor suggestions but the concept and code look good to me.

src/main/persistence/service/info-files/v1-0-0.ts Outdated Show resolved Hide resolved
docs/architecture/01_collection_schema_versioning.md Outdated Show resolved Hide resolved
src/main/persistence/service/info-files/v1-0-0.ts Outdated Show resolved Hide resolved
docs/architecture/01_collection_schema_versioning.md Outdated Show resolved Hide resolved
@SoulKa SoulKa force-pushed the feature/195-create-architecture-for-collection-versioning branch from bda0bde to fcbca7f Compare January 29, 2025 20:51
@SoulKa SoulKa force-pushed the feature/195-create-architecture-for-collection-versioning branch from fcbca7f to 360701f Compare January 31, 2025 12:44
@SoulKa SoulKa merged commit 6c7b135 into main Jan 31, 2025
2 checks passed
@SoulKa SoulKa deleted the feature/195-create-architecture-for-collection-versioning branch January 31, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kwerber kwerber kwerber approved these changes

Assignees
No one assigned
Labels
architecture Architectural task backend Backend related task enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create Architecture for Collection Versioning
2 participants
@SoulKa @kwerber