Add CondStore by alex-yxw · Pull Request #87 · yahoo/imapnio

alex-yxw · 2020-02-26T19:10:41Z

Description

a. added the UNCHANGEDSINCE STORE modifier.
b. added the MODIFIED response code that is used with an OK response
to the STORE command. (It can also be used in a NO response.)
c. added the CHANGEDSINCE FETCH modifier.
d. added a new MODSEQ search criterion.
e. defined an additional CONDSTORE parameter to SELECT/EXAMINE
commands.
f. added VANISHED UID FETCH modifier

Motivation and Context

Store command can send additional UNCHANGEDSINCE parameter, Store response can be parsed with MODIFIED response code, , Fetch command can send additional CHANGEDSINCE and Vanished parameter, Search command can send with MODSEQ parameter, and Select/Examine command can send additional CONDSTORE parameter, when CONDSTORE is supported. To support client to send that parameter added new classes.

How Has This Been Tested?

Added unit tests to verify

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Major release (change is NOT backward compatible with prior release)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

alex-yxw · 2020-02-26T19:11:17Z

@fansu @jui8wang

core/src/main/java/com/yahoo/imapnio/async/data/ExtensionMailboxInfo.java

core/src/main/java/com/yahoo/imapnio/async/data/MessageNumberSet.java

core/src/main/java/com/yahoo/imapnio/async/request/ExamineFolderCommand.java

core/src/main/java/com/yahoo/imapnio/async/request/ImapArgumentFormatter.java

core/src/main/java/com/yahoo/imapnio/async/request/OpenFolderActionCommand.java

core/src/main/java/com/yahoo/imapnio/async/response/ImapResponseMapper.java

core/src/main/java/com/yahoo/imapnio/async/request/ImapArgumentFormatter.java

core/src/main/java/com/yahoo/imapnio/async/response/ImapResponseMapper.java

core/src/main/java/com/yahoo/imapnio/async/data/ExtendedModifiedSinceTerm.java

core/src/main/java/com/yahoo/imapnio/async/response/ImapResponseMapper.java

core/src/main/java/com/yahoo/imapnio/async/data/ExtensionMailboxInfo.java

core/src/main/java/com/yahoo/imapnio/async/response/ImapResponseMapper.java

checkstyle_suppressions.xml

nituyahoo

some comments, not fully reviewed let us discuss first

core/src/main/java/com/yahoo/imapnio/async/data/ExtensionMailboxInfo.java

nituyahoo · 2020-03-06T20:49:05Z

core/src/main/java/com/yahoo/imapnio/async/data/ExtensionMailboxInfo.java

+            if (handled) {
+                resps[i] = null;
+            } else {
+                ir.reset(); // default back the parsing index


what happens if nomodseq and mailboxid is specified multiple times?

We won't, based on RFC, we should always have one NoModSeq to indicate whether we support CondStore or not. Also, you can only have one MailBox Id for each folder. You can confirm with Ray about this.

nituyahoo · 2020-03-06T20:50:39Z

core/src/main/java/com/yahoo/imapnio/async/data/MessageNumberSet.java

+     * @return the array of MessageNumberSet
+     * @throws ImapAsyncClientException will not throw
+     */
+    public static MessageNumberSet[] buildMessageNumberSets(@Nullable final String msgNumbers) throws ImapAsyncClientException {


isn't this parsing available in the imap client by sun?

No, that is the reason why Ray created MessageNumberSet.java.

nituyahoo · 2020-03-06T20:53:34Z

core/src/main/java/com/yahoo/imapnio/async/data/MessageNumberSet.java

+        int i = 0; // msgset index
+        try {
+            for (final String element : msgSetStrs) {
+                if (element.contains(":")) {


can there we whitespace?

No, extra space is not allowed. I add test cases for that.

nituyahoo · 2020-03-06T21:11:27Z

core/src/main/java/com/yahoo/imapnio/async/request/ImapArgumentFormatter.java

+                s.append(RECENT);
+            } else if (sf[0] == Flags.Flag.SEEN) {
+                s.append(SEEN);
+            }


what if sf[0] does not match any of the above?

please discuss

Based on RFC, we currently only support above system flags; otherwise, it will count as user flag.

nituyahoo · 2020-03-06T21:11:48Z

core/src/main/java/com/yahoo/imapnio/async/request/ImapArgumentFormatter.java

+            }
+        } else { // user flag == 1
+            s.append(uf[0]);
+        }


what if sf and uf is not specified?

Based on getUserFlags(), it will try to find it in the HashMap. If it doesn't create the flag, it will add the flag into user flag. Since there is only one flag and the flag can only be user flag or system flag. As long as it is not system flag, it will count as user flag. You can check buildFlagString() created by Ray inside the same file to confirm the implementation flow.

nituyahoo · 2020-03-06T23:39:52Z

core/src/main/java/com/yahoo/imapnio/async/request/UidFetchCommand.java

+     * @param items the data items
+     * @param changedSince changed since the given modification sequence
+     */
+    public UidFetchCommand(@Nonnull final MessageNumberSet[] msgsets, @Nonnull final String items, @Nonnull final Long changedSince) {


why does uid fetch need message number set

Based on rfc, we need a way to store message numbers or uids, so we use MessageNumberSet to store them and send it via uid fetch command.

nituyahoo · 2020-03-06T23:40:03Z

core/src/main/java/com/yahoo/imapnio/async/request/UidStoreFlagsCommand.java

+     * @param action whether to replace, add or remove the flags
+     * @param unchangedSince unchanged since the given modification sequence
+     */
+    public UidStoreFlagsCommand(@Nonnull final MessageNumberSet[] msgsets, @Nonnull final Flags flags, @Nonnull final FlagsAction action,


why does uid store require msg set

Based on rfc, we need a way to store message numbers or uids, so we use MessageNumberSet to store them and send it via uid store command.

nituyahoo · 2020-03-06T23:41:43Z

core/src/main/java/com/yahoo/imapnio/async/response/ImapResponseMapper.java

+     * @throws ImapAsyncClientException when target class to covert to is not supported
+     */
+    @Nonnull
+    public <T> T readValue(@Nonnull final IMAPResponse[] content, @Nonnull final Class<T> valueType, @Nonnull final FetchItem[] extensionItems)


why only fetch result?

Currently, only fetch command can have extension items. Therefore, only fetch result can have extension items as well.

nvsnvikram · 2021-11-16T18:00:59Z

Sorry, I didn't know about this pull request. Can you rebase and let me know? I will try to take a look soon. @fansu and @jui8wang , please do a final review and let me know.

More test cases for MessageNumberSet null out mailboxinfo, try catch outside for string message number set, stringbuilder for formatter, constant mapper with parsing exception, fix version and developer name Update UT for exception, follow mailbox pattern Fix exception throw java docs for UT Fix javadoc check style for UT Address Fan's comment Undo style fix Update checkstyle_suppressions.xml Update version Remove reduant null and add test cases for null Update FailureType typo Update version Add new test cases for parsing bad string to cover branch. Remove constant length for condstore string Remove constant string length for unchange since Update version

nvsnvikram · 2021-11-30T03:07:49Z

core/src/main/java/com/yahoo/imapnio/async/data/ExtendedModifiedSinceTerm.java

+public final class ExtendedModifiedSinceTerm extends SearchTerm {
+
+    /** The name of the metadata item. */
+    private final Flags entryName;


Do we know any servers that support modified since for specific flags?

I have tried the following example from RFC 4551 and it works for yahoo mail and gmail:
Example 15:
C: a SEARCH MODSEQ "/flags/\draft" all 620162338

@YuanxinWang , Are you sure? Yahoo/Aol does not even support CONDSTORE. Supporting individual flag modseq would be quite hard even for Gmail. Let me know if you want to do a hangout and show me what you tried.

tolikbotov · 2023-08-31T08:05:47Z

Hello. Are there any plans to merge this?

jui8wang requested changes Feb 27, 2020

View reviewed changes

alex-yxw force-pushed the condstore branch from 975e272 to ef451df Compare February 28, 2020 00:38

alex-yxw requested a review from jui8wang February 28, 2020 00:39

jui8wang requested changes Feb 28, 2020

View reviewed changes

core/src/main/java/com/yahoo/imapnio/async/response/ImapResponseMapper.java Outdated Show resolved Hide resolved

alex-yxw force-pushed the condstore branch from 882bab1 to 1836795 Compare February 28, 2020 22:20

alex-yxw requested a review from jui8wang February 28, 2020 22:25

jui8wang reviewed Mar 2, 2020

View reviewed changes

alex-yxw force-pushed the condstore branch from c04a053 to fd63377 Compare March 3, 2020 20:12

alex-yxw requested a review from jui8wang March 3, 2020 20:18

jui8wang approved these changes Mar 3, 2020

View reviewed changes

alex-yxw force-pushed the condstore branch from e7d2f6f to 5a61f15 Compare March 3, 2020 23:49

alex-yxw requested a review from jui8wang March 3, 2020 23:50

alex-yxw force-pushed the condstore branch from 1c6596b to 6514ecf Compare March 4, 2020 00:06

jui8wang approved these changes Mar 4, 2020

View reviewed changes

fansu self-requested a review March 4, 2020 19:19

fansu reviewed Mar 4, 2020

View reviewed changes

checkstyle_suppressions.xml Outdated Show resolved Hide resolved

fansu approved these changes Mar 4, 2020

View reviewed changes

alex-yxw force-pushed the condstore branch 5 times, most recently from 3989ee1 to 962b00e Compare March 7, 2020 00:44

nituyahoo reviewed Mar 9, 2020

View reviewed changes

alex-yxw force-pushed the condstore branch 5 times, most recently from 1fdecff to 92c6795 Compare March 19, 2020 17:02

alex-yxw force-pushed the condstore branch from 1b45eb9 to bf82ba9 Compare March 19, 2020 17:05

alex-yxw force-pushed the condstore branch 2 times, most recently from d895c13 to e3f6740 Compare April 17, 2020 02:38

alex-yxw requested a review from nituyahoo April 17, 2020 14:31

alex-yxw force-pushed the condstore branch from e3f6740 to d5a39f4 Compare April 17, 2020 19:10

alex-yxw force-pushed the condstore branch from cd5891d to 4746c49 Compare November 22, 2021 23:21

update version

ada9ffd

alex-yxw force-pushed the condstore branch from 4746c49 to ada9ffd Compare November 29, 2021 14:11

nvsnvikram reviewed Nov 30, 2021

View reviewed changes

Conversation

alex-yxw commented Feb 26, 2020

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

alex-yxw commented Feb 26, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nituyahoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alex-yxw Mar 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alex-yxw Mar 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nvsnvikram commented Nov 16, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

alex-yxw Mar 18, 2020 •

edited

Loading

alex-yxw Mar 18, 2020 •

edited

Loading