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

Retain failed transfers for 12 weeks / 84 days #1025

Merged
merged 4 commits into from
Dec 6, 2024

Conversation

stevenmccullaghmadetech
Copy link
Contributor

What

Retain failed transfers for 12 weeks / 84 days as per spec.

Why

Required by specifications. Facilitates data retention and the ability to initiate a retry.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Internal change (non-breaking change with no effect on the functionality affecting end users)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the Changelog with details of my change in the UNRELEASED section if this change will affect end users

Alex-Nita
Alex-Nita previously approved these changes Dec 5, 2024
CHANGELOG.md Outdated
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
* When a transfer fails, the transfer should remain available in the db for at least 12 weeks, as per spec.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd propose to change the description to 84 days (e.g. "at least 84 days, as per spec") to be consistent with the TTL format (P84D). This way it will be less confusing for the users of the adaptor.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see what you mean, but I also want to reflect what's said in the spec. So I'm changing it to:
"When a transfer fails, the transfer should remain available in the db for at least 12 weeks (84 days), as per spec."
I think this helps to clarify for both spec and devs.

OPERATING.md Outdated
@@ -266,7 +266,7 @@ The adaptor's database records:
* metadata about the transfer process

The supplier MUST configure the `GP2GP_MONGO_TTL` variable to remove the database records
after a reasonable time period.
after a reasonable time period. The specs say 12 weeks, so this is our suggestion.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd propose to change the description to 84 days (e.g. "The specs say 84 days...") to be consistent with the TTL format (P84D). This way it will be less confusing for the users of the adaptor.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same.

Copy link

github-actions bot commented Dec 6, 2024

Looks good. No mutations were possible for these changes.
See https://pitest.org

Copy link

sonarqubecloud bot commented Dec 6, 2024

@stevenmccullaghmadetech stevenmccullaghmadetech merged commit 06d0ad4 into main Dec 6, 2024
15 checks passed
@stevenmccullaghmadetech stevenmccullaghmadetech deleted the NIAD-3243 branch December 6, 2024 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants