✨ Add support for VANISHED responses #329
Draft
+776
−21
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
|
Note that this PR is based on #330. |
nevans
force-pushed
the
vanished
branch
2 times, most recently
from
01f70d2
to
6649519
Compare
nevans
force-pushed
the
vanished
branch
3 times, most recently
from
0d7d6b6
to
c7b54bf
Compare
For new data structs, I'd prefer frozen by default and I don't want to support the entire Struct API. Data is perfect, but it's not available until ruby 3.2. So this adds a DataLite class that closely matches ruby 3.2's Data class, and it can be a drop-in replacement for Data. Net::IMAP::Data is an alias for Net::IMAP::DataLite, so when we remove our implementation, the constant will resolve to ruby's ::Data. Ideally, we wouldn't define this on newer ruby versions at all, but that breaks the YAML serialization for our test fixtures. The tests (and some of the implementation) have been copied from the polyfill-data gem and updated so that they use "Data" as it is resolved inside the "Net::IMAP" namespace. Copyright notices have been added to the appropriate files to satisfy the MIT license terms. Co-authored-by: Jim Gay <[email protected]>
This updates the parser to handle the VANISHED response, and adds a new response data class: VanishedData. VanishedData was originally written as a plain class and then converted to Data. I'm keeping most of the tests that I wrote prior to converting it to Data, but I probably wouldn't have written many of them if I had used Data in the first place.
Both the `QRESYNC` and `UIDONLY` extensions replace `EXPUNGE` responses with `VANISHED` responses. This updates the #expunge and #uid_expunge commands to return VanishedData, rather than a (misleading) empty array.
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.
VANISHEDresponses are required by two different extensions:QRESYNCandUIDONLY.VanishedData, which wrapsSequenceSetand theEARLIERmodifier.VANISHEDresponse =>VanishedData#expungeand#uid_expungeto returnVANISHED(without theEARLIERmodifier) responses, when they are present.Although neither extension is completely supported yet, they can both be (partially) used in a way that doesn't crash... so I think this is a reasonable chunk to extract into its own PR, rather than wait for a PR for either of them to be 100% ready.