improve efficiency of object type detection #537
Merged
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
This was referenced Oct 5, 2022
peetucket
commented
Oct 5, 2022
| @@ -148,9 +148,11 @@ def self.with_metadata(cocina_object, lock, created: nil, modified: nil) | |||
| end | |||
|
|
|||
| def self.type_for(dyn) | |||
| dyn.with_indifferent_access.fetch('type') | |||
| rescue KeyError | |||
There was a problem hiding this comment.
at least one full copy of the hash is made in memory here, which is not necessary
There was a problem hiding this comment.
Can you drop a comment in the code to this effect around here?
There was a problem hiding this comment.
i'd be happy to leave a code comment, though if this change is merged, the part of the code that makes the copy of the hash will be gone, so I'm not sure what the comment would say
There was a problem hiding this comment.
I think something like
# Intentionally checking both string- and symbol-type keys in the hash via `#[]` instead of `#with_indifferent_access` (and/or `#fetch`) in order to be more memory-efficientwould be good, though I don't love my wording. Why? Lest we outsmart ourselves, or Rubocop tries the same, later on.
There was a problem hiding this comment.
I like that idea. Added the comment. thanks
mjgiarlo
approved these changes
Oct 5, 2022
peetucket
force-pushed
the
object-type-detection
branch
from
0350658 to
43090e7
Compare
|
Thanks, @peetucket! |
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.
Why was this change made? 🤔
Part of sul-dlss/common-accessioning#1005, which is timeouts on a large object.
Experimentation as shown in that ticket has demonstrated that for very large cocina objects (which in DSA are manipulated as in memory hashes), the detection of object type may not be very efficient due to the use of both the rails method
with_indifferent_access(this makes a full copy of the giant hash in memory and returns a new object) andfetch(also possibly makes a copy of the hash based on console output). Neither of these are really necessary, we can simply inspect the hash directly for the key and raise as needed.While I did not characterize the actual performance/memory improvements achieved by this refactor (may only be a few seconds even for very large object), this method is also well tested, so seems low risk.
How was this change tested? 🤨
Existing specs (which cover this method well).