[new release] cohttp, cohttp-top, cohttp-mirage, cohttp-lwt, cohttp-lwt-unix, cohttp-lwt-jsoo and cohttp-async (5.0.0) #20246
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
mseri
commented
Dec 15, 2021
|
This should be merged only once it is properly tested in the CI, and right now the CI is overloaded |
mseri
force-pushed
the
release-cohttp-v5.0.0
branch
from
4433a3b
to
492bb5d
Compare
…wt-unix, cohttp-lwt-jsoo and cohttp-async (5.0.0) CHANGES: - Cohttp.Header: new implementation (lyrm mirage/ocaml-cohttp#747) + New implementation of Header modules using an associative list instead of a map, with one major semantic change (function ```get```, see below), and some new functions (```clean_dup```, ```get_multi_concat```) + More Alcotest tests as well as fuzzing tests for this particular module. ### Purpose The new header implementation uses an associative list instead of a map to represent headers and is focused on predictability and intuitivity: except for some specific and documented functions, the headers are always kept in transmission order, which makes debugging easier and is also important for [RFC7230§3.2.2](https://tools.ietf.org/html/rfc7230#section-3.2.2) that states that multiple values of a header must be kept in order. Also, to get an intuitive function behaviour, no extra work to enforce RFCs is done by the basic functions. For example, RFC7230§3.2.2 requires that a sender does not send multiple values for a non list-value header. This particular rule could require the ```Header.add``` function to remove previous values of non-list-value headers, which means some changes of the headers would be out of control of the user. With the current implementation, an user has to actively call dedicated functions to enforce such RFCs (here ```Header.clean_dup```). ### Semantic changes Two functions have a semantic change : ```get``` and ```update```. #### get ```get``` was previously doing more than just returns the value associated to a key; it was also checking if the searched header could have multiple values: if not, the last value associated to the header was returned; otherwise, all the associated values were concatenated and returned. This semantics does not match the global idea behind the new header implementation, and would also be very inefficient. + The new ```get``` function only returns the last value associated to the searched header. + ```get_multi_concat``` function has been added to get a result similar to the previous ```get``` function. #### update ```update``` is a pretty new function (mirage/ocaml-cohttp#703) and changes are minor and related to ```get``` semantic changes. + ```update h k f``` is now modifying only the last occurrences of the header ```k``` instead of all its occurrences. + a new function ```update_all``` function has been added and work on all the occurrences of the updated header. ### New functions : + ```clean_dup``` enables the user to clean headers that follows the {{:https://tools.ietf.org/html/rfc7230#section-3.2.2} RFC7230§3.2.2} (no duplicate, except ```set-cookie```) + ```get_multi_concat``` has been added to get a result similar to the previous ```get``` function. - Cohttp.Header: performance improvement (mseri, anuragsoni mirage/ocaml-cohttp#778) **Breaking** the headers are no-longer lowercased when parsed, the headers key comparison is case insensitive instead. - cohttp-lwt-unix: Adopt ocaml-conduit 5.0.0 (smorimoto mirage/ocaml-cohttp#787) **Breaking** `Conduit_lwt_unix.connect`'s `ctx` param type chaged from `ctx` to `ctx Lazy.t` - cohttp-mirage: fix deprecated fmt usage (tmcgilchrist mirage/ocaml-cohttp#783) - lwt_jsoo: Use logs for the warnings and document it (mseri mirage/ocaml-cohttp#776) - lwt: Use logs to warn users about leaked bodies and document it (mseri mirage/ocaml-cohttp#771) - lwt, lwt_unix: Improve use of logs and the documentation, fix bug in the Debug.enable_debug function (mseri mirage/ocaml-cohttp#772) - lwt_jsoo: Fix exception on connection errors in chrome (mefyl mirage/ocaml-cohttp#761) - lwt_jsoo: Fix `Lwt.wakeup_exn` `Invalid_arg` exception when a js stack overflow happens in the XHR completion handler (mefyl mirage/ocaml-cohttp#762). - lwt_jsoo: Add test suite (mefyl mirage/ocaml-cohttp#764).
mseri
force-pushed
the
release-cohttp-v5.0.0
branch
from
492bb5d
to
0d8e76b
Compare
|
The constraints on zeit and h1_parser do not seem to be right. The same errors happen and they are still marked as compatible with this release |
|
I think that was run with the incorrect fix, let me restart the CI |
|
It’s not the CI, i already restarted it twice |
|
Oh, then it is quite suprising. I don't think there were breaking changes in the Headers for quite a while |
|
The CI is installing cohttp 5.0.0 even if there is a conflict for cohttp >= 5 |
|
Sadly there isn’t. See my comment on #20276 for example |
|
I have just seen your comments... I hope those constraints will be recognized in the future. |
|
I think it’s easier to disable them entirely (by simply removing the |
Signed-off-by: Marcello Seri <[email protected]>
|
I think this can be merged. Zeit can be fixed separately (issue opened here: #20319) |
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.
An OCaml library for HTTP clients and servers
CHANGES:
Cohttp.Header: new implementation (lyrm Associative list implementation for headers mirage/ocaml-cohttp#747)
get, see below), and some new functions (clean_dup,get_multi_concat)Purpose
The new header implementation uses an associative list instead of a map to represent headers and is focused on predictability and intuitivity: except for some specific and documented functions, the headers are always kept in transmission order, which makes debugging easier and is also important for RFC7230§3.2.2 that states that multiple values of a header must be kept in order.
Also, to get an intuitive function behaviour, no extra work to enforce RFCs is done by the basic functions. For example, RFC7230§3.2.2 requires that a sender does not send multiple values for a non list-value header. This particular rule could require the
Header.addfunction to remove previous values of non-list-value headers, which means some changes of the headers would be out of control of the user. With the current implementation, an user has to actively call dedicated functions to enforce such RFCs (hereHeader.clean_dup).Semantic changes
Two functions have a semantic change :
getandupdate.get
getwas previously doing more than just returns the value associated to a key; it was also checking if the searched header could have multiple values: if not, the last value associated to the header was returned; otherwise, all the associated values were concatenated and returned. This semantics does not match the global idea behind the new header implementation, and would also be very inefficient.getfunction only returns the last value associated to the searched header.get_multi_concatfunction has been added to get a result similar to the previousgetfunction.update
updateis a pretty new function (Improve Header.update mirage/ocaml-cohttp#703) and changes are minor and related togetsemantic changes.update h k fis now modifying only the last occurrences of the headerkinstead of all its occurrences.update_allfunction has been added and work on all the occurrences of the updated header.New functions :
clean_dupenables the user to clean headers that follows the {{:https://tools.ietf.org/html/rfc7230#section-3.2.2} RFC7230§3.2.2} (no duplicate, exceptset-cookie)get_multi_concathas been added to get a result similar to the previousgetfunction.Cohttp.Header: performance improvement (mseri, anuragsoni cohttp.headers: use faster comparison mirage/ocaml-cohttp#778)
Breaking the headers are no-longer lowercased when parsed, the headers key comparison is case insensitive instead.
cohttp-lwt-unix: Adopt ocaml-conduit 5.0.0 (smorimoto Adopt ocaml-conduit 5.0.0 mirage/ocaml-cohttp#787)
Breaking
Conduit_lwt_unix.connect'sctxparam type chaged fromctxtoctx Lazy.tcohttp-mirage: fix deprecated fmt usage (tmcgilchrist Fix deprecated Fmt usages. mirage/ocaml-cohttp#783)
lwt_jsoo: Use logs for the warnings and document it (mseri lwt_jsoo: use log instead of always printing the warnings on the console mirage/ocaml-cohttp#776)
lwt: Use logs to warn users about leaked bodies and document it (mseri lwt.client: log drain body warning instead of printing it to stderr mirage/ocaml-cohttp#771)
lwt, lwt_unix: Improve use of logs and the documentation, fix bug in the Debug.enable_debug function (mseri Revisit logs in cohttp-lwt mirage/ocaml-cohttp#772)
lwt_jsoo: Fix exception on connection errors in chrome (mefyl Fix exception on connection errors in chrome. mirage/ocaml-cohttp#761)
lwt_jsoo: Fix
Lwt.wakeup_exnInvalid_argexception when a jsstack overflow happens in the XHR completion handler (mefyl Fix Invalid_arg exception on stack overflow when waking up a request. mirage/ocaml-cohttp#762).
lwt_jsoo: Add test suite (mefyl Add cohttp-lwt-jsoo test suite. mirage/ocaml-cohttp#764).