🎁 Adding DerivativeRodeoService#cleanup_derivatives ♻️ #271
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Apologies in advance, this commit conflates two things, but I'll explain. This commit is in service of completing the DerivativeService interface; namely the `#cleanup_derivatives` method. Originally, I was thinking I would only delete the derivatives generated by this service. So I began refactoring to reduce knowledge. That refactor meant extracting `#named_derivatives_and_generators`, and as a matter of hygiene and legibility, I moved the method closer to the configuration. The hope being that if one thing changes the other might. This then involved rethinking the `#create_derivatives` and `#cleanup_derivatives` to use this new method. I was looking for symmetry in method implementation (e.g. loop over the named derivatives and either create them or delete them). However, as I looked at the other reference implementations I noticed that I could get all of the derivatives by calling `Hyrax::DerivativePath.derivatives_for_reference` ([see code][1]). I spent a bit of time thinking, as the comments indicate, as to which approach to take: delete all derivatives OR only those that would be created by the present configuration. It makes sense to me to delete all of them, in part due to the implementation details of finding the correct `valid?` derivative service but also the fact that any `valid?` service is subject to configuration, which might change over time, and thus leave orphaned derivatives dangling in the file system. Closes #270 Related to: - notch8/derivative_rodeo#56 [1]:https://github.com/samvera/hyrax/blob/b28d8ff35d2fb708483d2ce0c4e687450b7f5aef/app/services/hyrax/derivative_path.rb#L14-L18
jeremyf
force-pushed
the
handling-derivative-cleanup
branch
from
f93b284 to
2536e37
Compare
kirkkwang
approved these changes
Jul 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Apologies in advance, this commit conflates two things, but I'll explain.
This commit is in service of completing the DerivativeService interface; namely the
#cleanup_derivativesmethod.Originally, I was thinking I would only delete the derivatives generated by this service. So I began refactoring to reduce duplicated knowledge. That refactor meant extracting
#named_derivatives_and_generators, and as a matter of hygiene and legibility, I moved the method closer to the configuration. The hope being that if one thing changes the other might.This then involved rethinking the
#create_derivativesand#cleanup_derivativesto use this new method. I was looking for symmetry in method implementation (e.g. loop over the named derivatives and either create them or delete them).However, as I looked at the other reference implementations I noticed that I could get all of the derivatives by calling
Hyrax::DerivativePath.derivatives_for_reference(see code). I spent a bit of time thinking, as the comments indicate, as to which approach to take: delete all derivatives OR only those that would be created by the present configuration.It makes sense to me to delete all of them, in part due to the implementation details of finding the correct
valid?derivative service but also the fact that anyvalid?service is subject to configuration, which might change over time, and thus leave orphaned derivatives dangling in the file system.Closes #270
Related to: