azure-sdk-for-cpp/sdk/core/azure-core/CHANGELOG.md

Release History

1.0.0-beta.8 (Unreleased)

Breaking Changes

• Simplified the Response<T> API surface to expose two public fields with direct access: T Value and a unique_ptr to an Azure::Core::Http::RawResponse.
• Removed from Azure::Core::Http::Request:
  • SetUploadChunkSize.
  • GetHTTPMessagePreBody.
  • GetUploadChunkSize.
• Removed from Azure::Core::Http::RawResponse:
  • SetHeader(std::string const& header)
  • SetHeader(uint8_t const* const first, uint8_t const* const last).
  • GetMajorVersion.
  • GetMinorVersion.
• Renamed Azure::Nullable<T>::GetValue() to Value().
• Changes to Azure::Core::Context:
  • Renamed Get() to GetValue().
  • Changed input parameter type of WithDeadline() to Azure::DateTime.
• Removed Azure::Core::PackageVersion.
• Removed from Azure::Core::Http::Policies namespace: HttpPolicyOrder, TransportPolicy, RetryPolicy, RequestIdPolicy, TelemetryPolicy, BearerTokenAuthenticationPolicy, LogPolicy.
• Renamed Azure::Core::Http::RawResponse::GetBodyStream() to ExtractBodyStream().
• Introduced Azure::Core::Context::Key class which takes place of std::string used for Azure::Core::Context keys previously.

1.0.0-beta.7 (2021-03-11)

New Features

• Added HttpPolicyOrder for adding custom Http policies to SDK clients.
• Added Azure::Core::Operation<T>::GetRawResponse().
• Added Azure::Core::PackageVersion.
• Added support for logging to console when AZURE_LOG_LEVEL environment variable is set.
• Added Azure::Core::Context::GetDeadline().

Breaking Changes

• Changes to Azure::Core namespace:
  • Removed Response<void>, ValueBase, and ContextValue.
  • Removed Context::operator[], Get() introduced instead.
  • Renamed Uuid::GetUuidString() to ToString().
  • Changed return type of Operation<T>::Poll() from std::unique_ptr<RawResponse> to RawResponse const&.
  • Moved GetApplicationContext() to Context::GetApplicationContext()
  • Moved the Base64Encode() and Base64Decode() functions to be static members of a Convert class.
  • Moved Logging namespace entities to Diagnostics::Logger class.
  • Moved AccessToken, TokenCredential, and AuthenticationException to Credentials namespace.
  • Moved Context to be the last parameter for consistency, instead of first in various azure-core types. For example:
    • BodyStream::Read(uint8_t* buffer, int64_t count, Context const& context)
    • BodyStream::ReadToEnd(BodyStream& body, Context const& context)
    • HttpPolicy::Send(Request& request, NextHttpPolicy policy, Context const& context)
    • Operation<T>::PollUntilDone(std::chrono::milliseconds period, Context& context)
    • TokenCredential::GetToken(Http::TokenRequestOptions const& tokenRequestOptions, Context const& context)
  • Moved from Azure::Core to Azure namespace:
    • Response<T>, ETag, and Nullable<T>.
    • Split RequestConditions into MatchConditions and ModifiedConditions.
    • Renamed DateTime::GetString() to ToString(), and removed DateTime::GetRfc3339String().
• Changes to Azure::Core::Http namespace:
  • Removed HttpPipeline, TransportKind, NullBodyStream, and LimitBodyStream.
  • Removed Request::StartTry().
  • Removed InvalidHeaderException and throw std::invalid_argument if the user provides invalid header arguments.
  • Renamed CurlTransportSSLOptions::NoRevoke to EnableCertificateRevocationListCheck.
  • Renamed Range to HttpRange.
  • Renamed TokenRequestOptions to TokenRequestContext, and moved it to Azure::Core::Credentials namespace.
  • Moved Url to Azure::Core namespace.
  • Request and RawResponse:
    • Renamed AddHeader() to SetHeader().
    • Introduced Azure::Core::CaseInsensitiveMap which is now used to store headers.
  • BodyStream and the types that derive from it:
    • Moved to Azure::Core::IO namespace.
    • Changed the static methods BodyStream::ReadToCount() and BodyStream::ReadToEnd() into instance methods.
    • Changed the constructor of FileBodyStream to accept a file name directly and take ownership of opening/closing the file, instead of accepting a file descriptor, offset, and length.
  • HTTP policies and their options:
    • Moved to Policies namespace.
    • Renamed TransportPolicyOptions to TransportOptions.
    • Renamed TelemetryPolicyOptions to TelemetryOptions.
    • Changed type of RetryOptions::StatusCodes from std::vector to std::set.
    • Renamed LoggingPolicy to LogPolicy, and introduced LogOptions as mandatory parameter for the constructor.
• Moved header files:
  • Renamed azure/core/credentials.hpp to azure/core/credentials/credentials.hpp.
  • Renamed azure/core/logger.hpp to azure/core/diagnostics/logger.hpp.
  • Renamed azure/core/http/body_stream.hpp to azure/core/io/body_stream.hpp.
  • Renamed azure/core/http/policy.hpp to azure/core/http/policies/policy.hpp.
  • Renamed azure/core/http/curl/curl.hpp to azure/core/http/curl_transport.hpp.
  • Renamed azure/core/http/winhttp/win_http_client.hpp to azure/core/http/win_http_transport.hpp.

Bug Fixes

• Make sure to rewind the body stream at the start of each request retry attempt, including the first.
• Connection pool resets when all connections are closed.
• Fix Azure::Context to support std::unique_ptr.
• Throw std::runtime_error from Response<T>::GetRawResponse() if the response was already extracted.

1.0.0-beta.6 (2021-02-09)

New Features

• Added support for HTTP conditional requests MatchConditions and RequestConditions.
• Added the Hash base class and MD5 hashing APIs to the Azure::Core::Cryptography namespace available from azure/core/cryptography/hash.hpp.

Breaking Changes

• Removed Context::CancelWhen().
• Removed LogClassification and related functionality, added LogLevel instead.

Bug Fixes

• Fixed computation of the token expiration time in BearerTokenAuthenticationPolicy.
• Fixed compilation dependency issue for MacOS when consuming the SDK from VcPkg.
• Fixed support for sending requests to endpoints with a custom port within the url on Windows when using the WinHttp transport.

1.0.0-beta.5 (2021-02-02)

New Features

• Added support for HTTP validators ETag.

Breaking Changes

• Make ToLower() and LocaleInvariantCaseInsensitiveEqual() internal by moving them from Azure::Core::Strings to Azure::Core::Internal::Strings.
• BearerTokenAuthenticationPolicy constructor takes TokenRequestOptions struct instead of scopes vector. TokenRequestOptions struct has scopes vector as data member.
• TokenCredential::GetToken() takes TokenRequestOptions instead of scopes vector.

Bug Fixes

• Fixed the parsing of the last chunk of a chunked response when using the curl transport adapter.
• Fixed reading the value from retry-after header in RetryPolicy.
• Fix link errors when producing a DLL and add UWP compilation support.
• Do not pass a placeholder user-agent string as a fallback when using WinHttp.
• Initialize local variables in implementation to fix warning within release builds on Linux.

1.0.0-beta.4 (2021-01-13)

New Features

• Added a WinHTTP-based HttpTransport called WinHttpTransport and use that as the default TransportPolicyOptions.Transport on Windows when sending and receiving requests and responses over the wire.
• Added Range type to Azure::Core::Http namespace.
• Added support for long-running operations with Operation<T>.
• Added support for setting a custom transport adapter by implementing the method std::shared_ptr<HttpTransport> ::AzureSdkGetCustomHttpTransport().
• Added interoperability between std::chrono::system_clock types and DateTime.
• Added default constructor to DateTime and support for dates since 0001.
• Added Base64 encoding and decoding utility APIs to the Azure::Core namespace available from azure/core/base64.hpp.
• Added Http::Response<void> template specialization.
• Added GetHeadersAsString() on the Azure::Core::Http::Request class.
• Added a platform.hpp header file for defining commonly used OS-specific #define constants.
• Added IsCancelled() on the Azure::Core::Context class.

Breaking Changes

• Removed DateTime::operator Duration(), DateTime::Duration typedef and DateTime::Now().
• Moved Azure::Core::BearerTokenAuthenticationPolicy, defined in azure/core/credentials.hpp to Azure::Core::Http namespace in azure/core/http/policy.hpp header.
• Changed type of Token::ExpiresOn to DateTime.
• Renamed exception OperationCanceledException to OperationCancelledException and ThrowIfCanceled() to ThrowIfCancelled() on the Context class.
• Moved Azure::Core::Version, defined in azure/core/version.hpp to the Azure::Core::Details namespace.
• Changed Azure::Core::AuthenticationException to derive from std::exception instead of std::runtime_error.
• Changed the BodyStream::Read API from being a pure virtual function to non-virtual.
• Removed CurlConnection, CurlConnectionPool, CurlSession, and CurlNetworkConnection by making headers meant as implementation, private.
• Removed option AllowBeast from CurlTransportSSLOptions in CurlTransportOptions.
• Changed default option NoRevoke from CurlTransportSSLOptions for the CurlTransportOptions to true. This disables the revocation list checking by default.

Bug Fixes

• Fixed the Curl transport adapter connection pooling when setting options.
• Fixed setting up the default transport adapter.
• Fixed linker error of missing pthread on Linux.
• Initialize class data members to avoid MSVC warning.
• Throw Azure::Core::Http::TransportException if curl_easy_init() returns a null handle.

Other changes and Improvements

• Added support for distributing the C++ SDK as a source package via vcpkg.

1.0.0-beta.3 (2020-11-11)

New Features

• Added strings.hpp with Azure::Core::Strings::LocaleInvariantCaseInsensitiveEqual and Azure::Core::Strings::ToLower.
• Added GetPort() to Url.
• Added TransportPolicyOptions.
• Added TelemetryPolicyOptions.
• Added RequestFailedException deriving from std::runtime_error.
• Added CurlTransportOptions for the CurlTransport.
• Added DateTime supporting dates since 1601.
• Added OperationCanceledException.
• Added Encode and Decode to Url.

Breaking Changes

• Removed azure.hpp.
• Removed macro AZURE_UNREFERENCED_PARAMETER.
• Bump CMake version from 3.12 to 3.13.
• Bump libcurl version from 7.4 to 7.44.
• Moved ClientSecretCredential and EnvironmentCredential to the Identity library.
• Url class changes:
  • AppendPath now does not encode the input by default.
  • Signature updated for SetHost, SetPath and AppendPath.
  • Removed SetFragment.
  • Renamed AppendQueries to AppendQueryParameters.
  • Renamed AppendQuery to AppendQueryParameter.
  • Renamed RemoveQuery to RemoveQueryParameter.
  • Renamed GetQuery to GetQueryParameters.

Bug Fixes

• Prevent pipeline of length zero to be created.
• Avoid re-using a connection when a request to upload data fails while using the CurlTransport.
• Add entropy to Uuid generation.

Other changes and Improvements

• Add high-level and simplified core.hpp file for simpler include experience for customers.
• Add code coverage using gcov with gcc.
• Update SDK-defined exception types to be classes instead of structs.
• Updated TransportException and InvalidHeaderException to derive from RequestFailedException.
• Vcpkg dependency version updated to 2020.11.
• Make libcurl network requests cancelable by Context::Cancel().
• Validate HTTP headers for invalid characters.
• Calling Cancel() from context now throws OperationCanceledException.

1.0.0-beta.2 (2020-10-09)

Breaking Changes

• Throw Azure::Http::TransportException if creating new connection fails.
• Response objects store Nullable<T>.

Bug Fixes

• Switched to a more stable wait on sockets to address connection timeouts.
• Replace Nullable(const T&) with Nullable(T) to avoid extra copy when initialized with an rvalue.

Other changes and Improvements

• Improved performance on windows when using libcurl.
• Pinned the version of package dependencies.
• Added NOTICE.txt for 3rd party dependencies.

1.0.0-beta.1 (2020-09-09)

• Initial release