Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation note about protocol specific options to Mint.HTTP.connect/4 #457

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

PragTob
Copy link
Contributor

@PragTob PragTob commented Nov 11, 2024

Most outside documenation (Finch, Req) links just to Mint.HTTP.connect/4 for documentation. That makes it somewhat hard to find both the case insesntitive header options as well as the not validating target options.

Not sure it's worth duplicating them there, so I figured I'd just point to them - even if HTTP2 has no custom options as of now.

That's, of course, debatable. So, happy about feedback/improvements :)

Thank you!

Most outside documenation (Finch, Req) links just to
`Mint.HTTP.connect/4` for documentation. That makes it somewhat
hard to find both the case insesntitive header options as well
as the not validating target options.

Not sure it's worth duplicating them there, so I figured I'd just
point to them - even if HTTP2 has no custom options as of now.

That's, of course, debatable.
@PragTob
Copy link
Contributor Author

PragTob commented Nov 11, 2024

IMG_20180407_163943-ANIMATION

@coveralls
Copy link

Pull Request Test Coverage Report for Build ab90dfc65916ad8000a11146ae5d1f0d11eeea45-PR-457

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 87.423%

Totals Coverage Status
Change from base Build 8516bcda190a644a5fe960b13869107ff76ee9b3: 0.0%
Covered Lines: 1279
Relevant Lines: 1463

💛 - Coveralls

@PragTob
Copy link
Contributor Author

PragTob commented Nov 11, 2024

Huh looks like some integration tests started failing over night:


  1) test nghttp2.org SSL - select HTTP2 (Mint.IntegrationTest)
Error:      test/mint/integration_test.exs:26
     receive_stream timeout
     code: assert {:ok, _conn, responses} = receive_stream(conn)
     stacktrace:
       test/mint/integration_test.exs:31: (test)



  2) test TCP - nghttp2.org (HTTP2.IntegrationTest)
Error:      test/mint/http2/integration_test.exs:35
     Assertion failed, no matching message after 10000ms
     The process mailbox is empty.
     code: assert_receive message
     stacktrace:
       (mint 1.6.2) test/support/mint/http2/test_helpers.ex:10: Mint.HTTP2.TestHelpers.receive_stream/2
       test/mint/http2/integration_test.exs:46: (test)

....

  3) test nghttp2.org SSL - select HTTP1 (Mint.IntegrationTest)
Error:      test/mint/integration_test.exs:11
     receive_stream timeout
     code: assert {:ok, _conn, responses} = receive_stream(conn)
     stacktrace:
       test/mint/integration_test.exs:16: (test)

..........

  4) test nghttp2.org/httpbin GET / (HTTP2.IntegrationTest)
Error:      test/mint/http2/integration_test.exs:245
     Assertion failed, no matching message after 10000ms
     The process mailbox is empty.
     code: assert_receive message
     stacktrace:
       (mint 1.6.2) test/support/mint/http2/test_helpers.ex:10: Mint.HTTP2.TestHelpers.receive_stream/2
       test/mint/http2/integration_test.exs:248: (test)

...

(obvs. unrelated to the PR or rhat'd be some real magic)

@whatyouhide
Copy link
Contributor

No worries about the tests. This is great. Thanks @PragTob 💟

@whatyouhide whatyouhide merged commit c16125a into elixir-mint:main Nov 11, 2024
0 of 3 checks passed
@PragTob PragTob deleted the connection-docs-ref branch November 11, 2024 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants