Frozen SearchResult breaks IMAP.find with what: :last option #262
Comments
This was backward incompatible with existing usage of search results: * Fixes #262
|
Thanks for reporting this. I should have realized that freezing by default wouldn't be backward compatible! That's fixed by #263. I'm hoping that using the subclass is still okay though. I'd prefer not to add a config option (e.g: |
This was backward incompatible with existing usage of search results: * Fixes #262
|
Honestly, I'm not convinced that the |
I would prefer that too. But backward compatibility is more important, especially since there were no deprecation warnings.
Yes, today or tomorrow. 🙂 |
|
@stanley90 It's been released. Let me know if |
Works, thanks! |
|
💯 |
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).
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).
PR #236 introduced the
SearchResultclass, which is actually a frozen Array.However, this breaks the
what: :lastoption in themailgem hereFrozenError: can't modify frozen Net::IMAP::SearchResultThe text was updated successfully, but these errors were encountered: