Releasing version 3.1.2.0

[kazu-yamamoto]

I would like to discuss what features should be implemented in version 4. Please speak up.

I would like to have:

• using Strict and StrictData by default

[eborden]

@kazu-yamamoto I've opened the v4 project https://github.com/haskell/network/projects/3

There is a column for "Proposed" where we can stack items that we think should be in. That can serve as an initial brainstorm. Then we can spend some time triaging that list.

I actually added Strict to the Q4 milestones. I wasn't thinking an epoch change for that. However I could be convinced.

[kazu-yamamoto]

@eborden Do you have any idea to implement #151? If you explain the guideline on how to address this issue, I can try.

Or should we release version 4 without fixing #151?

[eborden]

@eborden Do you have any idea to implement #151? If you explain the guideline on how to address this issue, I can try.

I'll spend some time formulating something. Even a domain specific exception like newtype NetworkException = NetworkException String would be an improvement over the current situation, but there is likely a lot more granularity that can provide utility.

Or should we release version 4 without fixing #151?

@kazu-yamamoto I'm attempting to round up the current unreleased changes (see unreleased in the CHANGELOG.md). Here is what I have:

• Defined openSocket in terms of AddrInfo
  5b0987197fe2ed7beddd7b2096522d624e71151e
• Improved FreeBSD portability for Control Messages and tests
  #452
• Support sendMsg and recvMsg
  #433
  #445
  #451
  • Added sendMsg and recvMsg APIs
  • Redefined SocketOption as pattern synonym
• Implement total Show functions for SockAddr
  #441
• Improve portability changing u_int32_t to uint32_t.
  #442
• Removed obsolete CPP statements.
  d1f4ee60ce6a4a85abb79532f64d4a4e71e2b1ce
• Loads of improved test coverage.
  cbd67cc50a37770432eb978ac8b8eb6da3664817
  fcc2d86d53a6bec793f6a979a9e8fdf7fe3f4c22
  6db96969b3e8974abbfd50a7f073baa57376fd5e

As far as I'm aware, the only breaking change is the transformation of SocketOption to a pattern synonym. Is there something else that I'm missing?

[kazu-yamamoto]

@eborden First of all, no rush. I can wait for your work.

New SocketOption maintains backward compatibility except CustomSockOpt. This means that most network code can compile with network v4 without modification.

CustomSockOpt was removed since I don't know how to express pattern for the tuple. If we can express the pattern, we can provide perfect backward compatibility.

[kazu-yamamoto]

@eborden Nice work for changelog. Thanks.

I think we should describe new extensible APIs: getSockOpt and setSockOpt. Some users have been waiting for them.

[eborden]

@kazu-yamamoto I might also debate whether removing CustomSockOpt represents an Epoch change or a Major change (Epoch.Major.Minor.Bug). The community style for Epoch would signal a major departure in design. Really we are just opening SocketOption to improved extensibility with a slight break in the original design for extension. As well this break is type checkable. I'd argue that is a Major break, not an Epoch break. That looks like 3.2.0.0, not 4.0.0.0 if we do not include exception redesign.

[kazu-yamamoto]

v3.2 sounds good to me.

At least, we can get back CustomSockOpt if we define SocketOption using a tuple. If we do so, we can keep v3.1.

[eborden]

That is a solid design tradeoff for backwards compatibility.

[eborden]

I'd support a deprecated pragma if PVP 1.1 was official, but as of today deprecation is still considered a breaking change.

haskell/pvp#12

[kazu-yamamoto]

@eborden Could you confirm that master maintains backward compatibility with 3.1?

If so, we can go forward step by step:

• Releasing master as v3.1.2.0
• Releasing v3.1.3 when new error handling is completed

Let's drop Strict stuff for a while. It's likely v4 issue.

[kazu-yamamoto]

• can't install on docker + nix-2.3 (nixos-19.09) #439 should be fixed in v3.1.2.0
• gracefulClose stops servers due to a lot of TCP states #438 should be fixed in v3.1.2.0

[eborden]

@kazu-yamamoto I created a project to track progress on 3.1.2.0.

https://github.com/haskell/network/projects/4

[kazu-yamamoto]

@eborden After #471 is merged, let's release v3.1.2.0. Please don't forget to update CHANGELOG.md . :-)

[eborden]

Sounds good!

[kazu-yamamoto]

@eborden Now it's your turn. Let's release v3.1.2.0.

[eborden]

👍 I'll give the changelog a once over and get it released this evening.

[kazu-yamamoto]

@eborden Gentle ping.

[eborden]

@kazu-yamamoto I've updated https://github.com/haskell/network/blob/master/CHANGELOG.md to include 3.1.2.0. Many changes were not previously represented there. Please let me know if you see anything I missed or needs further clarification. After you have approved I'll packaged everything up and release.

[kazu-yamamoto]

@eborden LGTM. Let's go.

[eborden]

• The tag is in place.
• Candidate is up.

[kazu-yamamoto]

Please don't forget to make 3.1.1.0 and 3.1.1.1 deprecated due to the bug of gracefulClose.

[eborden]

• Candidate published
• Older versions deprecated
• Cafe message sent