Merge support for COMPRESS extension #342

foxcpp · 2020-03-04T21:26:23Z

First round of changes for #322.

This PR does not include server-side change to the UNSELECT command required by #341 (needs rebase after #341 gets merged)

codecov · 2020-03-04T21:58:55Z

Codecov Report

Merging #342 into master will decrease coverage by 1.55%.
The diff coverage is 10.1%.

@@            Coverage Diff            @@
##           master    #342      +/-   ##
=========================================
- Coverage   73.65%   72.1%   -1.56%     
=========================================
  Files          32      33       +1     
  Lines        3519    3617      +98     
=========================================
+ Hits         2592    2608      +16     
- Misses        638     715      +77     
- Partials      289     294       +5

Impacted Files	Coverage Δ
client/cmd_selected.go	`73.59% <ø> (ø)`	⬆️
imap.go	`0% <ø> (ø)`	⬆️
client/client.go	`66.14% <ø> (+2.17%)`	⬆️
client/cmd_any.go	`39.28% <0%> (-18.61%)`	⬇️
server/cmd_auth.go	`72.14% <0%> (-7.39%)`	⬇️
mailbox.go	`79.46% <0%> (-2.95%)`	⬇️
deflate.go	`0% <0%> (ø)`
server/cmd_any.go	`46.42% <0%> (-30.05%)`	⬇️
server/server.go	`50.53% <0%> (-0.55%)`	⬇️
server/conn.go	`70.33% <38.46%> (-2.26%)`	⬇️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update af3db55...8ff7eb2. Read the comment docs.

foxcpp · 2020-03-04T22:15:17Z

On I18NLEVEL=1 vs 1+2 support: Client support for I18NLEVEL altogether is not very impressive according to DCS and nobody seems to care about I18NLEVEL=2.

foxcpp · 2020-03-07T18:01:50Z

@emersion What's your opinion on ID extension? Not worth merging?

emersion · 2020-03-10T17:20:56Z

server/cmd_noauth_test.go

@@ -30,7 +30,7 @@ func testServerTLS(t *testing.T) (s *server.Server, c net.Conn, scanner *bufio.S

 io.WriteString(c, "a001 CAPABILITY\r\n")
 scanner.Scan()
- if scanner.Text() != "* CAPABILITY IMAP4rev1 LITERAL+ SASL-IR STARTTLS LOGINDISABLED" {
+ if scanner.Text() != "* CAPABILITY IMAP4rev1 LITERAL+ SASL-IR SPECIAL-USE CHILDREN UNSELECT COMPRESS=DEFLATE APPENDLIMIT STARTTLS LOGINDISABLED" {


Maybe we can add constants for these? So that we only need to update them once when adding a new extension?

emersion · 2020-03-10T17:22:06Z

When this is merged, we need to create issues if the client or server side of an extension is missing.

emersion · 2020-03-10T17:22:28Z

What's your opinion on ID extension? Not worth merging?

Yeah, I'd prefer to leave it out if possible.

foxcpp · 2020-03-12T21:06:34Z

Not sure what is better for I18NLEVEL. Is just having a variable Server.EnableI18N enough or do we want to check backend I18N "awareness" using some interface like I18NSupported()

foxcpp · 2020-03-16T21:05:18Z

Oh, you know, lets get that merged and then I will continue working on it when I will have more time.

backend/appendlimit.go

client/cmd_auth.go

emersion · 2020-07-22T13:31:21Z

deflate.go

+//
+// It is used by COMPRESS extension implementation and it not a part of the
+// library API. Do not use it.
+func CreateDeflateConn(c net.Conn, level int) (net.Conn, error) {


Should we expose this to users? Or should we define this in an internal package?

Not seeing a reason to keep it public.

backend/appendlimit.go

emersion · 2020-08-28T18:02:50Z

17:39 @emersion foxcpp: sorry if we've already discussed about that, but do we want to unconditionally enable the SPECIAL-USE and CHILDREN extensions?
17:39 @emersion we don't want to advertise it if the backend doesn't properly sets those attrs

foxcpp · 2020-08-28T18:39:01Z

Advertising SPECIAL-USE without backend support is valid - it will just look like there MAY be special-use mailboxes but there are currently none. CREATE-SPECIAL-USE is a separate capability.
CHILDREN may be a problem though.

emersion · 2020-08-28T18:49:13Z

OK that makes sense

foxcpp · 2020-08-28T18:50:50Z

RFC 3348 seems to be pretty lax regarding attributes too:

The CHILDREN extension defines two new attributes that MAY be
returned within a LIST response.

So we probably can get away with it without bothering much.

emersion · 2020-11-01T20:08:39Z

All right. I rejiggered and pushed these commits:

emersion · 2020-11-01T20:11:42Z

Holding off this PR for now because merging it would break the API: some extensions might get added twice (built-in + external).

foxcpp · 2020-11-02T07:27:39Z

What is the effect of adding an external extension when it is already supported directly? Can we add a compatibility hack that would just ignore the external extension in this case?

emersion · 2020-11-02T09:23:45Z

I wonder if it's better to let external extensions overwrite built-in extensions (and de-dup our caps), or make if it's better to make EnableExtension a no-op if already enabled (might break the API?).

foxcpp · 2020-11-02T10:08:07Z

I wonder if it's better to let external extensions overwrite built-in extensions (and de-dup our caps)

The idea with some builtin extensions is that they are builtin because their support requires special changes to go-imap 'core' source code. If we let external extensions override such changes we need to have a whole bunch of if all around go-imap to disable corresponding changes and let the external extension do its thing (possibly incorrectly).

Along the way, we considered phasing out the extension interface altogether or reworking it completely for go-imap v2. I don't remember us arriving at some consensus regarding this though.

or make if it's better to make EnableExtension a no-op if already enabled (might break the API?)

It will break API with some extensions so some careful judgement is needed to figure out what we can merge into v1. Some breakage may be acceptable, for example merging https://github.com/foxcpp/go-imap-namespace is probably okay - it will prevent backends from advertising custom namespaces but I do not expect this to be used often and it is unlikely to cause any real breakage e.g. for clients.

CrawX · 2020-11-03T22:49:32Z

Even after merging emersion/go-imap-compress#6, COMPRESS doesn't work for me because the reader thread reads compressed data without the deflater in place which messes up the connection state completely. I found a workaround (see this and this. With these two additional changes, COMPRESS seems to actually work for me :) Does it make sense to try to get them merged? I feel like #342 might also address this race condition issue.

In any case, please include the raw-string fix from emersion/go-imap-compress#6.

emersion · 2020-11-07T15:00:16Z

OK, so for v1, you think it's best to ignore EnableExtension calls if we already have that extension enabled? This sounds like a reasonable workaround.

emersion · 2020-11-07T15:01:21Z

@CrawX That's weird because e.g. STARTTLS works correctly... In any case it's unrelated to this PR, so please open a separate issue about it.

emersion · 2021-09-07T16:24:25Z

Merged UNSELECT and APPENDLIMIT. Not sure COMPRESS is worth the complexity…

emersion · 2024-04-14T10:28:52Z

Superseded by #606

foxcpp mentioned this pull request Mar 4, 2020

Implement UTF8=ACCEPT capability #16

Closed

foxcpp linked an issue Mar 4, 2020 that may be closed by this pull request

Implement IMAP Child Mailbox Extension #30

Closed

emersion reviewed Mar 10, 2020

View reviewed changes

foxcpp marked this pull request as ready for review March 16, 2020 21:05

foxcpp mentioned this pull request Jul 8, 2020

Error when selecting should unselect #366

Merged

emersion reviewed Jul 22, 2020

View reviewed changes

backend/appendlimit.go Outdated Show resolved Hide resolved

emersion reviewed Jul 22, 2020

View reviewed changes

client/cmd_auth.go Outdated Show resolved Hide resolved

emersion reviewed Jul 22, 2020

View reviewed changes

backend/appendlimit.go Outdated Show resolved Hide resolved

foxcpp mentioned this pull request Jul 27, 2020

IMAP4rev2 #375

Closed

foxcpp mentioned this pull request Aug 24, 2020

Backend extensions #385

Closed

foxcpp force-pushed the merge-extensions branch from be45b1e to a48b2ea Compare August 24, 2020 13:34

foxcpp mentioned this pull request Oct 30, 2020

K9-Mail Compatibility: list special-use type error #357

Closed

emersion force-pushed the merge-extensions branch 5 times, most recently from 7339790 to 2d90431 Compare November 1, 2020 20:07

CrawX mentioned this pull request Nov 4, 2020

Enable imap COMPRESS CrawX/go-imap-assassin#1

Draft

emersion force-pushed the merge-extensions branch from 2d90431 to aad5f77 Compare September 7, 2021 16:23

Merge support for COMPRESS extension

e5b9306

emersion force-pushed the merge-extensions branch from aad5f77 to e5b9306 Compare September 7, 2021 16:23

emersion changed the title ~~Merge support for small extensions~~ Merge support for COMPRESS extension Sep 7, 2021

emersion changed the base branch from master to v1 April 14, 2023 10:27

emersion closed this Apr 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge support for COMPRESS extension #342

Merge support for COMPRESS extension #342

foxcpp commented Mar 4, 2020 •

edited by emersion

Loading

codecov bot commented Mar 4, 2020 •

edited

Loading

foxcpp commented Mar 4, 2020

foxcpp commented Mar 7, 2020

emersion Mar 10, 2020

emersion commented Mar 10, 2020

emersion commented Mar 10, 2020

foxcpp commented Mar 12, 2020

foxcpp commented Mar 16, 2020

emersion Jul 22, 2020

foxcpp Jul 22, 2020

foxcpp Jul 27, 2020

emersion commented Aug 28, 2020

foxcpp commented Aug 28, 2020

emersion commented Aug 28, 2020

foxcpp commented Aug 28, 2020

emersion commented Nov 1, 2020

emersion commented Nov 1, 2020

foxcpp commented Nov 2, 2020

emersion commented Nov 2, 2020

foxcpp commented Nov 2, 2020 •

edited

Loading

CrawX commented Nov 3, 2020

emersion commented Nov 7, 2020

emersion commented Nov 7, 2020

emersion commented Sep 7, 2021

emersion commented Apr 14, 2024

Merge support for COMPRESS extension #342

Merge support for COMPRESS extension #342

Conversation

foxcpp commented Mar 4, 2020 • edited by emersion Loading

codecov bot commented Mar 4, 2020 • edited Loading

Codecov Report

foxcpp commented Mar 4, 2020

foxcpp commented Mar 7, 2020

emersion Mar 10, 2020

Choose a reason for hiding this comment

emersion commented Mar 10, 2020

emersion commented Mar 10, 2020

foxcpp commented Mar 12, 2020

foxcpp commented Mar 16, 2020

emersion Jul 22, 2020

Choose a reason for hiding this comment

foxcpp Jul 22, 2020

Choose a reason for hiding this comment

foxcpp Jul 27, 2020

Choose a reason for hiding this comment

emersion commented Aug 28, 2020

foxcpp commented Aug 28, 2020

emersion commented Aug 28, 2020

foxcpp commented Aug 28, 2020

emersion commented Nov 1, 2020

emersion commented Nov 1, 2020

foxcpp commented Nov 2, 2020

emersion commented Nov 2, 2020

foxcpp commented Nov 2, 2020 • edited Loading

CrawX commented Nov 3, 2020

emersion commented Nov 7, 2020

emersion commented Nov 7, 2020

emersion commented Sep 7, 2021

emersion commented Apr 14, 2024

foxcpp commented Mar 4, 2020 •

edited by emersion

Loading

codecov bot commented Mar 4, 2020 •

edited

Loading

foxcpp commented Nov 2, 2020 •

edited

Loading