Fix IMAP search issues #1611
Merged
Fix IMAP search issues #1611
Conversation
This file contains hidden or 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
The code had several issues with existing IMAP UID search: * net-imap <= v0.3 returns `nil` when the server returns nothing. (>= v0.4 returns an empty array when the server returns nothing.) * net-imap v0.4.8 and v0.4.9 return a _frozen_ `SearchResult`. `SearchResult` inherits from `Array`, but because it's frozen, mutating it with `reverse!` results in an exception. See ruby/net-imap#262. (v0.4.10 and above doesn't freeze SearchResult.) * newer net-imap (>= 0.5) will support servers that send `ESEARCH` results, but those will be returned as an `ESearchResult` struct (probably frozen). `IMAP4rev1` servers shouldn't return `ESEARCH` unless the client has activated that extension, but `IMAP4rev2` servers will _always_ return `ESEARCH`. * RFC3501 says nothing about sorting the UIDs that come back from `UID SEARCH`. Almost all servers do return sorted UIDs, most of the time. But it isn't 100% reliable. The fix is simple: * use `#to_a` to convert both `nil` and `ESearchResult` into an array. * use `#sort` to ensure the UIDs are sorted. This also returns a new array, without mutating the original (which may be frozen).
Contributor
Author
|
Any thoughts? Would you like me to add some tests to simulate the potential return values?
|
eval
approved these changes
Jun 3, 2024
Collaborator
|
Looks mergeable to me 👍🏻 |
Collaborator
|
Thanks for the extensive writeup! |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The code had several issues with existing IMAP UID search:
nilwhen the server returns nothing. (>= v0.4 returns an empty array when the server returns nothing.)SearchResult.SearchResultinherits fromArray, but because it's frozen, mutating it withreverse!results in an exception. See Frozen SearchResult breaks IMAP.find with what: :last option ruby/net-imap#262. (v0.4.10 and above doesn't freeze SearchResult.)ESEARCHresults, but those will be returned as anESearchResultstruct (probably frozen).IMAP4rev1servers shouldn't returnESEARCHunless the client has activated that extension, butIMAP4rev2servers will always returnESEARCH.UID SEARCH. Almost all servers do return sorted UIDs, most of the time. But it isn't 100% reliable.The fix is simple:
#to_ato convert bothnilandESearchResultinto an array of UIDs.#sortto ensure the UIDs are sorted. This also returns a new array, without mutating the original (which may be frozen).