Skip to content

ChangeLog.md

Latest commit

 

History

History
382 lines (341 loc) · 20.7 KB

ChangeLog.md

File metadata and controls

382 lines (341 loc) · 20.7 KB

ChangeLog

1.3.3

  • Fix Curl::Easy#put_data= with non-String to_s payloads so upload length calculation does not read non-String objects as Ruby strings.
  • Guard Curl::Easy#clone against curl_easy_duphandle allocation failure so clone raises NoMemError instead of dereferencing a NULL handle.
  • Guard Curl::Multi lifecycle during active perform calls so closing a multi handle from callbacks or perform blocks raises instead of freeing an in-use libcurl multi handle.
  • Reject adding an active Curl::Easy handle to a second Curl::Multi before setup mutates request state.
  • Restore one-shot request state for HEAD, PATCH, and PUT requests after success or callback/error unwinds so later requests do not inherit stale method/body options.
  • Validate Curl::Easy#put_data= before mutating libcurl upload options, preventing failed setup paths from leaving stale upload callbacks installed.
  • Preserve CURLOPT_RESOLVE values set through Easy#set across repeated performs, and allow resolve/FTP command entries that convert to strings.
  • Fix older build fallback paths for curl_multi_wait and no-GVL select.
  • Add regression coverage for multi lifecycle guards, active easy reuse, request state cleanup, upload setup rollback, resolve persistence, and string-convertible resolve/FTP command entries.

1.3.2

  • Fix Curl::PostField GC marking so block-backed content fields remain valid across GC and compaction.
  • Fix upload read/seek callbacks to preserve Ruby exceptions, avoid unsafe unwinds through libcurl, and reject reads larger than libcurl's supplied buffer.
  • Fix multipart POST/PATCH/PUT cleanup so partially built native forms are freed when form construction raises.
  • Restore Curl::Easy#last_error after Easy#close by reattaching the libcurl error buffer to the reinitialized handle.
  • Fix Curl::Easy#clone with put_data so upload callbacks and upload state belong to the clone instead of the original handle.
  • Add regression coverage for native callback, multipart cleanup, clone upload, close/error-buffer, and PostField GC safety.

1.3.1

  • Fix Ruby 4.x compatibility in Curl::Multi

1.3.0

Breaking Changes

  • Curl::Multi#close now permanently closes the multi handle. Code that previously called close and then reused the same Curl::Multi instance must now allocate a new multi handle instead. Curl::Multi.autoclose continues to use the internal reusable cleanup path for implicit autoclose and fiber-scheduler reuse.
  • Callback exceptions raised during Multi#perform and scheduler-driven Easy#perform are now deferred until in-flight sibling transfers finish draining, and queued replacement work is no longer started once a deferred callback exception is pending. Applications that relied on immediate aborts or that enqueue new work from completion callbacks after a sibling failure may observe different control flow.
  • post_body= and raw CURLOPT_POSTFIELDS assignments now snapshot the assigned Ruby string instead of aliasing later mutations to the caller's buffer. In addition, easy.setopt(Curl::CURLOPT_POSTFIELDS, nil) now clears the request body without implicitly switching the request back to GET; callers that relied on the old method-reset behavior must now set the method explicitly.
  • close and reset are now blocked while progress, debug, and upload-read callbacks are active, matching the existing restriction for body and header callbacks. Code that performed cleanup directly inside those callbacks must move that work outside the callback.

Changes

  • Improve Ruby 4.x and newer libcurl compatibility by addressing typed-data conversion and deprecation issues in the extension build.
  • Fix post_body, CURLOPT_POSTFIELDS, multipart form reuse, and resolve cleanup so request buffers and per-request native state stay valid across setup, mutation, and reset.
  • Tighten Curl::Easy and Curl::Multi lifecycle cleanup to reduce leaks and stale handle references, including explicit clearing of idle easy.multi back-references when a multi is closed.
  • Rework deferred callback exception handling for Easy and Multi so callback failures are re-raised on the originating request after sibling work drains, queued replacement work does not start once a deferred exception is pending, and deferred implicit-multi cleanup stays thread-affine.
  • Preserve the original callback exception for frozen Curl::Easy handles instead of raising FrozenError.
  • Improve Fiber scheduler integration so scheduler-driven Easy#perform reuses the shared multi correctly, keeps yielding timers/perform blocks while deferred completions drain, and wakes the originating waiter when deferred callback errors surface.
  • Add leak-trace tooling plus broader regression coverage for cleanup, callback, scheduler, GC.compact, and test-server stale-lock edge cases; CI now runs the valgrind suite on Linux Ruby 4.0.

1.2.2

  • Add Curl::Easy#http_version getter/setter along with HTTP/2 TLS/prior-knowledge constants so clients can force a specific HTTP protocol.
  • Fix rare Multi#perform segfault with GC.compact by recovering the Easy when CURLINFO_PRIVATE is stale and pruning unknown handles.
  • Store ruby_curl_easy* in CURLOPT_PRIVATE and use it for all libcurl callbacks (write/header/progress/debug) so GC.compact can’t invalidate stored VALUE pointers.
  • Pass ruby_curl_easy as libcurl userdata for default body/header handlers so GC.compact can’t invalidate stored VALUE pointers.
  • Safer GC: detach Easy from Multi during free to avoid dangling references.
  • add work around for libcurl 8.16.0 max redirects regression

1.2.1

  • Clarify cookie behavior in README and RDoc:
    • Differentiate between manual cookies header and the libcurl cookie engine
    • Add cookielist= helper and examples for manipulating engine cookies (ALL/SESS/FLUSH/RELOAD)
    • Note that cookies = '' clears the manual Cookie header; nil has no effect
  • Add support for CURLOPT_REQUEST_TARGET (libcurl ≥ 7.55), including easy.request_target= setter, tests, and README usage notes
  • Clarify that instance easy.http_post does not accept a URL argument; use Curl::Easy.http_post(url, ...) or set easy.url first
  • Use after free fix

1.2.0

  • Fix on_redirect callback being triggered when follow_location=false and max_redirects=0
  • Add support for CURLOPT_NOPROXY option (#441)
  • Fix Curl.spnego? to check for both CURL_VERSION_SPNEGO and CURL_VERSION_GSSNEGOTIATE (#227)
  • Add Fiber scheduler awareness for Curl::Multi: prefer scheduler-friendly socket-action path and rb_thread_fd_select when available (non-Windows)
    • Add compile-time CURB_SOCKET_DEBUG flag to enable optional socket-action debug logging in curb_multi.c (default off; set CURB_SOCKET_DEBUG=1 when running extconf)
  • When using request method HEAD ensure CURLOPT_NOBODY is set to 1 automatically
  • Compiler checks run in parallel when building the extension JOBS=n to adjust concurrency of configure checks and build concurrency
  • CI tests now run on Windows and MacOS

1.1.0

  • Add support for CURLOPT_RESOLVE

      require 'resolv'
  uri = URI.parse("https://google.com/")
  resolved_ip = Resolv.getaddress(uri.host)   # perform DNS lookup once
  mapping = "#{uri.host}:#{uri.port}:#{resolved_ip}"

  http = Curl::Easy.new("https://google.com/")
  http.setopt(Curl::CURLOPT_RESOLVE, [mapping])

  http.get

  assert_match(/GET/, http.body)

  • allow configuration curl multi MAX_HOST_CONNECTIONS (#460)

    https://curl.se/libcurl/c/CURLMOPT_MAX_HOST_CONNECTIONS.html

1.0.9

  • Fix for proxy headers see #457
  • Add CI for Ruby 2.7, Ruby 3.3 and 3.4

1.0.8

  • PUT and PATCH requests now behave like POST requests with multipart form data supporting http_post, http_put, and http_patch with PostField arguments

1.0.7

  • Clean up easy handle after failing to add to a multi handle

  • With newer versions of libcurl we can use curl_easy_escape instead of curl_escape, this should improve character encoding support

  • When available use curl_multi_wait for greater system compatibility, users of libcurl 7.28.0 and later should benefit from this change

  • Improve easy handle cloning to deep copy related lists, headers, cookies , proxy_headers, ftp_commands and resolve list.

  • FTP: Document correct way to perform NLST/LIST (don’t use ftp_commands for data-transfer commands). Add README section for HTTP proxy tunnel usage and examples, including full LIST snippets. Map the following libcurl options through Easy#set:

    • :dirlistonly -> CURLOPT_DIRLISTONLY
    • :ftp_use_epsv -> CURLOPT_FTP_USE_EPSV
    • :ftp_use_eprt -> CURLOPT_FTP_USE_EPRT
    • :ftp_skip_pasv_ip -> CURLOPT_FTP_SKIP_PASV_IP Also expand ftp_commands RDoc with guidance to avoid LIST/NLST/PASV/EPSV there. Add a basic regression test in tests/tc_ftp_options.rb ensuring these options can be set without raising.

  • Updating test suite and internal tools for ruby 3.4

  • CURLOPT_COOKIELIST support see examples:

easy.setopt(Curl::CURLOPT_COOKIELIST, "Set-Cookie: c1=v1; domain=localhost; expires=#{expires.httpdate};")
easy.setopt(Curl::CURLOPT_COOKIELIST, [ ['.localhost', 'TRUE', '/', 'FALSE', 0, 'session', '42'].join("\t"),
                                        ['.localhost', 'TRUE', '/', 'FALSE', 0, 'session2', '84'].join("\t"), '', ].join("\n") )
  • Add :on_missing to callbacks supported by Curl::Multi.http

1.0.6

  • Fix for PUT request length calculation
    • see: #451
  • Fix a double quote issue when evaluating cert's path
    • see: #454

1.0.5

  • Add shorter response_code alias -> code 
      Curl.get("https://github.com/taf2/curb").code # -> 200

1.0.4

  • Improve exception handling from callback functions to ensure correct error line number is reported
  • Resolve many compiler warnings

1.0.3

  • Adjust how we handle exceptions to handle more cases

1.0.2

  • Address alloc function T_DATA see: https://bugs.ruby-lang.org/issues/18007
  • Add CURLOPT_PROXY_SSL_VERIFYHOST support
  • Fix for exception handling in non standard callback functions on_redirect, on_complete
  • Fix missing response code when using Curl::Multi.http with a block
  • Fix to ensure redirect handler is called even when follow location is true

1.0.1

  • Fix nested Curl.get/post inside of a block 
      r1 = Curl.get("http://example.com/1") {|http|
    r2 = Curl.get("http://example.com/2") {|h|
    }
  }
  r1.body # previously was r2's body... this is now fixed
  • Restore compatibility with older libcurl installs
  • Correctly set empty headers e.g. http.headers['Accept'] = '' # to remove the header from the request

1.0.0

  • Add Ruby 3.1 to tests
  • Support curlopt_protocols and curlopt_redir_protocols.
  • Improved error handling via last_error tracking
  • Added support for CURLOPT_RANGE

0.9.11

  • Fixes for haproxy protocol via CURLOPT_HAPROXYPROTOCOL
  • Ensure dev environments don't use older versions of rake when working on curb (not a production dependency)
  • Many readmen updates - more windows support documentation
  • Support added for CURLOPT_STDERR

0.9.8

Fixes

  • Fix build with curl 7.62.0
  • Support building against Ruby 1.8 to help people migrate to the future and beyond

Enhancements

  • Improve timeout= to allow Floating point values which will automatically switch to timeout_ms
  • Add SOCKS5_HOSTNAME support
  • Added Curl::Multi.autoclose and Curl::Multi#close to improve connection handling. In past releases connection clean up only ever happens when GC runs. Now in this release you can explicitly control connections via multi.close or have it always close your connections with Curl::Multi.autoclose=true

Breaking Changes

  • Request handling reduces C (lines of code), and might resolve segfault when mixing curb with ruby timeout
  • Timeout change for anyone who expected 0.9 to equal 0 or infinity

0.9.7

Breaking Changes

Fixes

Enhancements

0.9.4

Fixes

Enhancements

  • Add PATCH support?
  • Add support for CURLOPT_PATH_AS_IS
  • Add .cookielist method to Curb::Easy
  • Improved Windows compatibility

0.9.3

Fixes

  • Correctly check for constants that may not be present in older versions of Curl

0.9.2

  • Breaking change - Change base class for exceptions from Exception to StandardError

Fixes

Enhancements

  • Implement setting of CURLOPT_MAXCONNECTS
  • Implement setting of CURLOPT_FORBID_REUSE
  • Ability to specify specific allowed TLS versions when connecting
  • Add support for HTTP/2.0 and multiplexing
  • Experimenting with adding multi handle cleanup after every request, normally would be cleaned up with GC

0.9.1

Fixes

  • Fix regression in timeout/timeout_ms handling

0.9.0

Fixes

  • Remove CURLAUTH_ANY as the default for authentication setting, as too many services in the world don't respond correctly with a 401 but instead 403 so the option rarely works as we'd hope
  • Use the memory address as the key to correctly keep a hash of active easy handles alive in the multi handle -- should resolve existing reports of memory leaks as well as crashes under some conditions

0.8.9

Fixes

Enhancements

  • Add Curl::HTTP_2_0, and Curl.http2?
  • Support CURLOPT_UNIX_SOCKET_PATH in Curl::Easy
  • Add timeout_ms/connect_timeout_ms options
  • Add on_redirect callback handling to .http

0.8.8

Fixes

0.8.7

Breaking Changes

Fixes

  • Restore support for older, pre-7.17 versions of curl (fixes CentOS 5 compatibility)
  • Improve Ruby 2.2.x support (use rb_thread_fd_select instead of rb_thread_select)

Enhancements

  • Add SOCKS4A support
  • Allow custom ssl cipher lists
  • Add install instructions for Windows
  • Make it possible easily reset the Thread current handle (Curl.reset)

0.8.6

Breaking Changes

Fixes

  • Add support for the new error CURLM_ADDED_ALREADY introduced at curl 7.33.0
  • Add conditionals for new URLM_ADDED_ALREADY error
  • Curl#urlalize - CGI.escape for param values
  • Use correct HTTP verb for DELETE requests (was delete, and some servers are apparently case sensitive)
  • Typo in ext/curb_errors.c: BadBasswordError -> BadPasswordError
  • Status method now returns the last status in the response header

Enhancements

  • Support Ruby 2.2.0
  • Support CURLOPT_TCP_NODELAY in Curl::Easy
  • Raise an exception if curb doesn't know how to handle a CURLOPT
  • Expose license via gemspec
  • Implement seek function for multi-pass authentication uploads

0.8.5

Fixes

  • Guard against a curl without GSSAPI delegation compiled in
  • Added extconf.rb entry for appconnect
  • Reset handle before each call when using "super simple API"

Enhancements

  • Added support for app_connect_time from libcurl
  • Alias body_str to body and header_str to head

0.8.4

Fixes

Enhancements

  • Make "super simple API" more efficient by storing Curl::Easy instance in Thread.current
  • GSSAPI: Add required flags for GSSAPI delegation support
  • GSSAPI: Allow setting of the new delegation flag
  • GSSAPI: Implement support for libcurl SPNEGO flags in curb

0.8.3

Fixes

0.8.2

Fixes

  • Clang compatibility

Enhancements

  • Allow string data with simpler interface e.g. Curl.post('...', 'data')

0.8.1

Fixes

  • Error installing on Ubuntu
  • Protect callbacks from reset/close
  • Curl::Multi not actually performing HTTP requests in cases when the :max_connects >= number of requests
  • Build error when compiled with -Werror=format-security
  • postalize parameter escaping

Enhancements

  • Support CURLINFO_REDIRECT_URL
  • Support CURLOPT_RESUME_FROM in Curl::Easy
  • Add .status to Curl::Easy instances
  • Support CURLOPT_FAILONERROR
  • Add even easier interface: Curl.get / Curl.post / e.t.c

0.8.0

  • Breaking change - on_failure only fires for 5xx responses

Fixes

  • Error in README section for HTTP POST file upload.

Enhancements

  • Add a default for resolve_mode to CURL_IPRESOLVE_WHATEVER e.g. :auto
  • Add on_redirect and on_missing callbacks for 3xx/4xx responses
  • Allow http_post(array_of_fields) when using multipart form posts

0.7.18

Fixes

  • Check for obsolete, since it appears to be gone from later versions of libcurl per issue #100
  • Regression in PUT requests with NULL bytes (caused by RSTRING_PTR => StringValueCStr change)

0.7.17

Fixes

  • Restore compatibility with 0.7.16 (e.g. suport for building without CURLOPT_SEEKDATA, etc)
  • Use rb_thread_blocking_region when available in place of rb_thread_select for ruby 1.9.x
  • Copy-paste mistake which made it impossible to set CURLOPT_SSL_VERIFYHOST to 2
  • Copy-paste mistake that caused CURLOPT_SSL_VERIFYPEER to be overwritten by the value of use_netrc setting

Enhancements

  • Warn on exceptions in success/failure/complete callbacks
  • Use StringValueCStr more instead of the less safe RSTRING_PTR
  • Defaulting CURLOPT_SSL_VERIFYHOST to 2 to make it consistent with cURLs default value

0.7.16

  • Add better support for timeouts - issue 48
  • Improve stability, avoid bus errors when raising in callbacks
  • Allow Content-Length header when sending a PUT request
  • Better handling of cacert
  • Support CURLOPT_IPRESOLVE
  • Allow PostField.file#to_s
  • Minor refactoring to how PostField.file handles strings
  • Accept symbol and any object that responds_to?(:to_s) for easy.http(:verb)
  • Free memory sooner after a request finishes instead of waiting for garbage collection
  • Fix crash when sending nil for the http_put body
  • Fix inspect for Curl::Easy, thanks Hongli Lai
  • Fix unit test assertions for Curl::Multi, thanks Hongli Lai

0.7.7

  • Curl::Multi perform is more robust process callbacks before exiting the loop - issue 24. Thanks to igrigorik and ramsingla
  • improve Curl::Multi idle callback robustness, trigger callbacks more often - issue 24. Thanks to igrigorik and ramsingla

0.7.6

  • fix bug in http_* when http_delete or http("verb") raises an exception
  • add support for autoreferrer e.g. if follow_location=true it will pass that along

0.7.5

  • minor fix for no signal instead of INT2FIX Check boolean value

0.7.4

  • add support to set the http version e.g. easy.version = Curl::HTTP_1_1
  • add support to disable libcurls internal use of signals.

0.7.3

  • Support rubinius
  • allow Multi.download to be called without a block
  • add additional Multi.download examples

0.7.2

  • Start tracking high level changes
  • Add Curl::Easy#close - hard close an easy handle
  • Add Curl::Easy#reset - reset all settings but keep connections alive
  • Maintain persistent connections for single easy handles