Skip to content

Latest commit

 

History

History
679 lines (512 loc) · 53.5 KB

CHANGELOG.md

File metadata and controls

679 lines (512 loc) · 53.5 KB
Raw

v1.19.0 (13/05/2024)

Common

  • Added Promote to the olp::cache::KeyValueCache API to explicitly promote the key in the LRU (Least Recently Used) cache.
  • Fixed the CMake configuration for MSVC build.
  • Updated code snippets and documentation to reflect recent changes in the API.

olp-cpp-sdk-authentication

  • Changed olp::authentication::AuthenticationClientImpl::SignInClient to retry based on the configuration in olp::client::RetrySettings instead of returning an error immediately in case of transient errors.
  • Fixed parsing of server time returned in the response header when there are time zone differences.

olp-cpp-sdk-core

  • Added system_error explicitly to /olp/core/porting/shared_mutex.h to support GCC 13.2.
  • Changed olp::http::NetworkCurl to log the location of the certificate used.
  • Changed olp::client::HRN::ToString() and olp::client::HRN::ToCatalogHRNString() implementations to avoid streams.
  • Changed the olp::http::Md5LookupGetBySubject signature to support OpenSSL v3.x.

olp-cpp-sdk-dataservice-read

  • Decreased the number of memory reallocations for instances when only the tile keys are required by the caller.

v1.18.1 (07/03/2024)

Common

  • Hotfix Updated olp::cache::DefaultCache::Open to take into account various ways the cache path could be specified.

v1.18.0 (06/03/2024)

Common

  • Updated the code to support the latest versions of popular compilers.
  • Updated olp::http::NetworkCurl class to use 4x more opened connections than requests to avoid issues with connection caching.
  • Extended olp::client::RetrySettings with connection_timeout and transfer_timeout.
  • Implemented performance improvements.
  • Updated the minimal required version of cURL for SSL blob support to 7.77.0.
  • Added support for background downloads for iOS.
  • Fixed possible data race in olp::cache::DefaultCache when the cache size is being checked.
  • Added OLP_SDK_ENABLE_OFFLINE_MODE CMake option to enforce full offline mode for the SDK.
  • Changed olp::cache::DiskCache::Open to return olp::cache::OpenResult::Postponed when the protected can't be initialized at the given moment due to restrictions like missing permissions.
  • Changed olp::cache::DefaultCache::Open to scan the cache path for unexpected directories and report them as errors.

olp-cpp-sdk-authentication

  • The credentials file is parsed correctly when it has unexpected line endings which can occur when copying the file between different operating systems.

olp-cpp-sdk-dataservice-read

  • Fixed possible crash in olp::dataservice::read::PartitionsCacheRepository that occurred when the stream closed before parsing started.
  • Changed the olp::dataservice::read::repository::PartitionsSaxHandler to be cancellable.
  • Extended olp::dataservice::read::VersionedLayerClient with Protect(..) and Release(..) methods to protect and release multiple partitions at once.
  • Added more checks for the results of cache-related operations.
  • Updated olp::dataservice::read::VersionedLayerClient::Release to take the list of tiles from the request into account and assume that they will be released.
  • Introduced performance improvements.

v1.17.0 (11/10/2023)

Common

  • Improved support of HTTP proxy on iOS.
  • Cleaned up DNS cache on error in cURL (Android).
  • Updated olp-cpp-sdk-core/CMakeLists.txt to include the externals include directory.
  • Added the possibility to specify DNS using WithDNSServers to the olp::http::NetworkSettings API.
  • Improved logging in olp::client::PendingUrlRequests.
  • Added CallApiStream to the olp::client::OlpClient API that uses the SAX parser and JSON byte stream to parse the layer partitions while they are downloading.
  • Fixed the boost and rapidjson includes path resolution in olp-cpp-sdk-core/CMakeLists.txt.
  • Changed the log level to WARNING for the error message when the max number of HTTP requests has been reached in olp::http::OLPNetworkIOS::Send.
  • Added a status code for failed HTTP requests in olp::dataservice::read::repository::PrefetchTilesRepository.
  • Censored credentials in log messages for the network logs on the DEBUG log level.
  • Fixed the rapidjson include directory.

olp-cpp-sdk-authentication

  • Added the ability to use a custom token endpoint URL from credentials in olp::authentication::Settings.

olp-cpp-sdk-dataservice-read

  • Added support of requests with more than 100 partitions in the olp::dataservice::read::repository::PartitionsRepository API.
  • Added default copy and move constructors and operators to the model namespace classes.

olp-cpp-sdk-dataservice-write

  • Added default copy and move constructors and operators to the model namespace classes.

v1.16.0 (13/06/2023)

Common

  • Added olp::http::CertificateSettings struct to store custom certificate settings.
  • Added olp::http::NetworkInitializationSettings struct containing olp::http::CertificateSettings to be passed to olp::http::CreateDefaultNetwork(..).
  • Deprecated olp::http::CreateDefaultNetwork(). It will be removed by 05.2024. Use added olp::http::CreateDefaultNetwork(..) that take olp::http::NetworkInitializationSettings instead.
  • Added olp::client::CreateDefaultNetworkRequestHandler(..) that take olp::http::NetworkInitializationSettings as an argument.
  • Extended olp::cache::CacheSettings with extend_permissions option.
  • Extended olp::http::NetworkSettings with GetMaxConnectionLifetime() and WithMaxConnectionLifetime(..).
  • Deprecated GetRetries() and WithRetries(..) in olp::http::NetworkSettings. They will be removed by 04.2024.
  • Extended olp::http::NetworkSettings with GetConnectionTimeoutDuration(), WithConnectionTimeout(std::chrono::milliseconds timeout), GetTransferTimeoutDuration() and WithTransferTimeout(std::chrono::milliseconds timeout).
  • Deprecated GetConnectionTimeout(), WithConnectionTimeout(int timeout), GetTransferTimeout() and WithTransferTimeout(int timeout) in olp::http::NetworkSettings. They will be removed by 04.2024. Use methods that accept std::chrono::milliseconds instead.
  • Required TLS 1.2 or later for network connection.
  • Fixed CMake configuration failure when CMAKE_BUILD_TYPE CMake parameter is not set.

olp-cpp-sdk-authentication

  • Removed deprecated olp::authentication::AuthenticationError. Use client::ApiError instead.
  • Removed deprecated olp::authentication::AuthenticationClient::SignInGoogle.
  • Removed deprecated std::string olp::authentication::TokenProvider::operator()(). Use the operator with CancellationContext instead.
  • Removed deprecated olp::authentication::TokenResult::GetHttpStatus(). Use TokenResponse::GetError().GetHttpStatusCode() instead.
  • Removed deprecated olp::authentication::TokenResult::GetErrorResponse(). Use TokenResponse::GetError().GetMessage() instead.
  • Removed deprecated provider and cancel from olp::authentication::AuthenticationSettings. Use token_provider instead.
  • Used thread safe time formatting functions in AutoRefreshingToken.

v1.15.4 (13/03/2023)

Common

  • Changed the log level from FATAL to ERROR in case of errors during opening cache.
  • Changed network layer implementation based on cURL to handle certificates lookup.
  • Improved documentation.
  • Improved olp::utils::Dir::Size to filter only files on Windows.
  • Added a limit of attempts for cache compaction.
  • Added libssl to the list of network libraries.

olp-cpp-sdk-dataservice-read

  • Changed the log level of repetitive log messages from INFO to DEBUG.

v1.15.3 (19/12/2022)

Common

  • Fixed open behavior on the No space left errors in the protected cache. Now, the cache will be opened in the Read-Only mode if the No space left error occurs while opening cache in the Read-Write mode.

v1.15.2 (04/11/2022)

Common

  • Extended olp::client::ApiResponse with an optional payload.
  • Added support for non-copiable response types in olp::client::ApiResponse.
  • Updated the README and GettingStartedGuide documentation.
  • Added performance improvements.
  • Enabled preprocessing for generating Doxygen documentation.
  • Added the service name in the base client's URL when olp::client::ApiLookupSettings::catalog_endpoint_provider is set.
  • Fixed olp::utils::Dir::Size to traverse through all nested directories.

olp-cpp-sdk-dataservice-read

  • Extended olp::dataservice::read::DataResponse and olp::dataservice::read::DataResponseCallback with olp::client::NetworkStatistics as a payload.
  • Changed olp::dataservice::read::repository::NamedMutex to be cancellation-aware: when the request is canceled, you will not be able to lock the internal mutex.

olp-cpp-sdk-authentication

  • Changed the internal static std::regex object to local instead of the global one. The local object prevents getting the std::bad_cast exception on some compilers.
  • Improved documentation.

v1.15.1 (16/06/2022)

olp-cpp-sdk-dataservice-read

  • Hotfix Reverted pull requests #1332, and #1338 as they introduced a regression which was not caught by our test suite.

v1.15.0 (13/06/2022)

Common

  • Added a new CMake option: OLP_SDK_ENABLE_ANDROID_CURL. The flag enables network layer implementation based on cURL for Android.
  • Added custom certificates lookup method based on MD5 for Android cURL network layer to bypass the discrepancy between OpenSSL 1.1.1 expecting SHA1 while certificates are beeing encoded using MD5.
  • Added HTTPS proxy support for the cURL network implementation.
  • Increased required minimal version for cURL from 7.47.0 to 7.52.0 due to the HTTPS proxy support.
  • Fixed the falsely returned errors from olp::client::OlpClient::CallApi. The olp::client::OlpClient::CallApi now propagates the correct errors from the olp::authentication::TokenProvider.
  • Replaced usage of std::stol with std::stoll for LRU expiration time evaluation.
  • The olp::utils::Dir::IsReadOnly now checks whether the target directory is present and returns false in case it is missing.
  • Changed the initial permissions on the newly created directories with olp::utils::Dir::Create from 0777 to 0774.
  • Added various performance optimizations for olp::cache::DefaultCache to speed up olp::cache::DefaultCache::Contains.
  • Improved various log messages.

olp-cpp-sdk-dataservice-read

  • Added the olp::dataservice::read::VersionedLayerClient::QuadTreeIndex API. Use this API to query the partitions for the specified tiles provided by olp::dataservice::read::TileRequest.
  • The olp::dataservice::read::PartitionsCacheRepository::FindQuadTree now reads the data from the cache starting from the lowest level first, which improves performance as the quadtrees are usually loaded 4 levels lower then the requested tile.
  • The olp::dataservice::read::CatalogClient::GetCatalog now forms correct URL when custom olp::client::CatalogEndpointProvider is used.
  • Fixed the broken chain of cancellation contexts inside olp::dataservice::read::VersionedLayerClient::PrefetchTiles method. The ongoing prefetch request can now be cancelled much faster, which avoids waiting for the ongoing sub-tasks to finish until the entire operation is cancelled.

olp-cpp-sdk-authentication

  • Added optional device_id field to the olp::authentication::AuthenticationClient::SignInProperties. This field can be used for the OAuth rate limiting per device supported by the HERE OAuth service.

v1.14.0 (08/02/2022)

Common

  • Work In Progress Added the LMDB library as a dependency. The library is currently not used and turned off by default in CMake.
  • Added proper handling of the SSLException error to the Android implementation of olp::http::Network. Now, the error is mapped to olp::http::ErrorCode::IO_ERROR and subsequently handled as a retriable error.
  • Added proper handling of the NSURLErrorCannotConnectToHost error to the iOS implementation of olp::http::Network. Now, the error is mapped to olp::http::ErrorCode::IO_ERROR and subsequently handled as a retryable error.
  • Added the olp::cache::KeyGenerator class. Use this class to access, insert, or remove cache entries without using the Data SDK client.
  • Removed the retry code from the Android implementation of olp::http::Network. The olp::client::OlpClient class handles all retries.
  • Changed logging from stdout to stderr for the POSIX environment.
  • Moved the commonly used internal ExecuteOrSchedule method to TaskScheduler.h.
  • Work-in-progress: Added the olp::thread::ExecutionContext, olp::thread::Continuation, and olp::thread::TaskContinuation classes. They are designed to support the task continuation feature, which enables the SDK APIs to use the task scheduler more efficiently and avoid blocking the executor by pending network requests.
  • Extend the olp::utils::Base64Encode API to suport the encoding of URLs.
  • Fixed various compiler warnings.
  • Added a new CMake option: OLP_SDK_USE_LIBCRYPTO. The flag disables the libcrypto dependency.

olp-cpp-sdk-authentication

  • Added olp::core::RetrySettings to olp::authentication::AuthenticationSettings. Now, you can configure olp::authentication::AuthenticationClient to use the provided retry settings for all online requests.
  • Added a new operator to olp::authentication::TokenProvider. It accepts olp::client::CancelationContext as input and returns olp::authentication::TokenResponse. Now, authentication requests can be cancelled, and clients can forward proper error messages during authentication to the caller.
  • Added a new token_provider parameter to olp::client::AuthenticationSettings. The new token provider accepts olp::client::CancelationContext and returns the olp::client::OauthTokenResponse response. Now, the olp::client::OlpClient::CallApi calls can be cancelled during authentication.
  • Deprecated the olp::authentication::TokenProvider::operator()() method together with the olp::authentication::AuthenticationSettings::provider member. They will be removed by 10.2022.
  • Deprecated the olp::authentication::TokenResult::GetHttpStatus and olp::authentication::TokenResult::GetErrorResponse methods. They will be removed by 10.2022.
  • Fixed the falsely returned cancellation error code that occurred when a request timed out. It happened on all olp::authentication::AuthenticationClient APIs. Now, the correct error is returned.
  • Moved the deprecated olp::authentication::AutoRefreshingToken, olp::authentication::TokenEndpoint, and olp::authentication::TokenRequest classes from the public includes to the source. They are no longer available.
  • Added the endpoint_url variable and a new constructor to olp::authentication::AuthenticationCredentials.
  • Switched the SignUpHereUser and SignOut APIs in the olp::authentication::AuthenticationClient functionality to TaskContext.

olp-cpp-sdk-dataservice-read

  • Changed the olp::dataservice-read::CatalogClient::GetLatestVersion API. Now, if you use the CacheOnly fetch option and specify the cached and start versions, the latest version is resolved. The resolved version is stored in the cache. For the OnlineIfNotFound fetch option, the online version is always requested and updated in the cache if needed.
  • Changed the default olp::dataservice::read::CatalogVersionRequest::start_version_ from 0 to -1 as 0 is a valid catalog version while -1 is not.
  • Added the olp::dataservice::read::CatalogClient::GetCompatibleVersions API. Use it to query the available catalog versions that are compatible with the dependencies provided by olp::dataservice::read::CompatibleVersionsRequest.

olp-cpp-sdk-dataservice-write

  • Improved Doxygen documentation in various places.

v1.13.0 (27/09/2021)

Common

  • Added a new olp::client::EqualJitterBackdownStrategy backdown strategy. You can use it to define the waiting time between retries in olp::client::RetrySettings.
  • Changed the open behavior for the protected cache. Now, it tries to open the cache in the r/w mode if it has enough filesystem permissions, and the user did not explicitly instruct to open the cache in the r/o mode via olp::cache::CacheSettings::openOptions.
  • Changed the olp::cache::DefaultCache::Open method. Now, it returns olp::cache::DefaultCache::StorageOpenResult::ProtectedCacheCorrupted if you try to open a broken database, specifically more than 4 L0 levelDB storage files, and you need to compact the database manually before you try to open it again.
  • Added a bool operator to the olp::client::ApiResponse class, which is a shortcut for olp::client::ApiResponse::IsSuccessful(). Use this operator to check whether your response was successful.
  • Removed the arbitrary 2-second delay on shutdown inside NetworkAndroid.cpp, which implements the abstract olp::http::Network interface for the Android platform.
  • Modified the olp::client::OlpClient request. Previously, if the authentication request failed for any reason, and the token provider returned an empty token string, data requests were still sent with an empty token that failed with a 401 status. Now, the olp::client::OlpClient request is not sent if the bearer token is empty.
  • Fixed the wrong reset of the olp::http::NetworkWinHttp request after an error.
  • Fixed the compilation of the olp::utils::Dir class when compiled with enabled Unicode Character Set on Windows.
  • Fixed the olp::Dir::FileExist() method when compiled on Windows. Instead of checking the FILE_ATTRIBUTE_NORMAL attribute, it now checks that the attributes are unequal to INVALID_FILE_ATTRIBUTES to assume a file is present on the filesystem.

olp-cpp-sdk-authentication

  • Improved usage of local and server time. When the local time is off, and the backend returns a wrong timestamp error, the server time is parsed from the Date response header field. Additionally, the server time is incremented locally between retries by adding the time elapsed between a request and response.
  • Set the authentication component APIs to use server time if the use_system_time option is set to false.

olp-cpp-sdk-dataservice-read

  • Removed the request repetition that occurred when the same blob request returned an error while multiple threads were waiting for the blob. Now, the returned error is shared with all waiting threads.

v1.12.0 (03/06/2021)

Common

  • Changed the olp::cache::DiskCache implementation. Now, it passes the provided olp::cache::CacheSettings::enforce_immediate_flush flag to leveldb::WriteOptions::sync.
  • Added a new CMake option: OLP_SDK_ENABLE_DEFAULT_CACHE. The flag disables the LevelDB and Snappy dependencies and the default cache implementation. The olp::cache::KeyValueCache interface is still available for the user to implement his cache.
  • Added a new custom LevelDB environment implementation. It overrides the random access file API disabling the excessive memory mapping, which led to huge memory spikes on mobile platforms.
  • Changed the cache olp::cache::DefaultCache::Remove and olp::cache::DefaultCache::RemoveKeysWithPrefix APIs to consider protected keys, which means that the keys and values are not removed when protected.
  • Fixed the crash that occurred inside olp::cache::DefaultCache::Compact when there was no disk cache present.
  • Fixed the race condition in iOS networking. The race condition caused a rare crash during concurrent access to urlSessions in the createTaskWithProxy:andId: method inside OLPHttpClient.mm.
  • Work In Progress Added the olp::cache::DefaultCache::StorageOpenResult::ProtectedCacheCorrupted status. It is returned by olp::cache::DefaultCache::Open() when the protected cache fails to open.
  • Fixed the issue that occurred when provided olp::cache::OpenOptions in olp::cache::CacheSettings were ignored by the mutable cache.
  • Changed the log level of a few repetitive and unimportant log messages from INFO to DEBUG.
  • Broke the cycling dependency in the Android network implementation HttpClient.java.
  • Extended the olp::client::DefaultRetryCondition to consider IO_ERROR, OFFLINE_ERROR, TIMEOUT_ERROR, NETWORK_OVERLOAD_ERROR errors returned by the network layer upon send as retriable.
  • Changed the size estimation routine for the mutable cache. In a scenario when the max_disk_storage is not set, we get the cache size from leveldb::DB::GetApproximateSize instead of traversing the whole database.
  • Fixed the cache opening sequence. Now, when the mutable cache fails to open - the error is returned.
  • Added handling of the NSURLErrorDataNotAllowed error on iOS as OFFLINE_ERROR.
  • Added handling of the NSURLErrorNetworkConnectionLost error on iOS as IO_ERROR.

olp-cpp-sdk-authentication

  • Fixed the usage of the same nonce for authentication retry requests. Now, all authentication requests generate a new unique nonce.
  • Work In Progress Added the SignInApple API. Use it to sign in to the HERE platform with Apple ID.

olp-cpp-sdk-dataservice-read

  • Reduced quadtree index requests in the olp::dataservice::read::VersionedLayerClient::PrefetchTiles and olp::dataservice::read::VolatileLayerClient::PrefetchTiles APIs.
  • Added merging for the exact concurrent quadtree index requests in the olp::dataservice::read::VersionedLayerClient::PrefetchTiles and olp::dataservice::read::VolatileLayerClient::PrefetchTiles APIs.
  • Added a new API to olp::dataservice::read::VersionedLayerClient::Protect and olp::dataservice::read::VersionedLayerClient::Release for partitions. It works the same way as the API for tiles.
  • Added the olp::dataservice::read::repository::NamedMutexStorage class. It is designed to store olp::dataservice::read::repository::NamedMutex instances. It helps to eliminate global static variables.
  • Added the olp::client::ErrorCode::CacheIO error. The error occurs when the cache fails to store the download data. It is implemented only for the olp::dataservice::read::VersionedLayerClient::PrefetchTiles and olp::dataservice::read::VolatileLayerClient::PrefetchPartitions APIs.

v1.11.0 (08/02/2021)

Common

  • Added API to the olp::cache::DefaultCache to get or set the size of the mutable cache. Now you can increase or decrease the disk cache size during runtime. Please note that when setting a smaller size then the current size, the eviction of data will be triggered which can take some time.
  • Added API to the olp::cache::DefaultCache to get size of protected cache.
  • Fixed incorrect olp::thread::ThreadedTaskScheduler behaviour to copy tasks instead of moving them.
  • Fixed the incorrect reset of the olp::client::CancelationContext in the olp::client::TaskContext that could lead to resource leaking and unexpected network requests cancelation.
  • Updated the lookup API endpoint for here-dev partitions from in.here.com to sit.here.com.

olp-cpp-sdk-dataservice-read

  • Fixed the data races inside prefetch operation that could lead to double callback or no callback at all.
  • Fixed prefetch cancelation behavior for both olp::dataservice::read::VersionedLayerClient and olp::dataservice::read::VolatileLayerClient. When canceled before this fix user will not know the status for each tile, in particular, that were canceled and only received the status for the tiles which succeeded or which failed with an arbitrary error.

v1.10.0 (14/12/2020)

Common

  • Ported the std::shared_mutex class from the C++17 Standard Library to use it in C++11/14 code.
  • Added the logging status of the network requests on the iOS platform. Now, you can see an HTTP return code for each completed request in logs.
  • Fixed the proxy warning message on the Android platform.
  • Added the Open and Close APIs to olp::cache::DefaultCache. You can use them to open or close individual caches.
  • olp::client::ApiLookupClient now caches the olp::client::OlpClient instances internally. It enables the merging of the same URL requests inside the olp::client::OlpClient instance.
  • Added merging of the same requests to the olp::client::OlpClient class. Internally, it merges the same requests by a URL when the payload is empty.
  • Removed the unnecessary sleep, which forced all requests to be at least 100 ms, from olp::http::NetworkCurl. 2-second sleep can still occur when there are no used handles.
  • Added downloaded size and time of execution to logs for completed requests in olp::http::NetworkCurl. Now, upon completion, you can see how much data was downloaded and how long the request took.

olp-cpp-sdk-authentication

  • Added the GetMyAccount API to olp::authentication::AuthenticationClient. It can retrieve user information based on a valid access token previously requested by the user upon sign-in.
  • Added the olp::authentication::Crypto class. It exposes the SHA256 and HMAC-SHA256 algorithms used by the module internally.

olp-cpp-sdk-dataservice-read

  • Fixed the data race inside the olp::client::TaskSink class. The data race occurred when a task added another task while the destruction was ongoing and then crashed.
  • Adapted olp::dataservice::read::StreamLayerClient and olp::dataservice::read::CatalogClient to use olp::client::TaskSink.
  • Fixed the expiration duration of the latest version. The user-provided expiration duration was not propagated to the cache.
  • Merged the same concurrent GetPartitions requests in the olp::dataservice::read::VersionedLayerClient.
  • Various changes in logging; decreased the level of messages to reduce the output.

v1.9.0 (12/10/2020)

Common

  • The default logger now adds a timestamp to logs.
  • Fixed a crash in the olp::cache::DefaultCache::Put method that occurred when the input value was null.
  • Fixed the HTTP response error that occurred when the request was canceled during the network shutdown on Windows.
  • olp::thread::TaskScheduler now supports tasks with priorities. Tasks with higher priority are executed first.
  • Fixed the issue that occurred when the JSON parsers produced valid empty objects.

olp-cpp-sdk-dataservice-read

  • Fixed the behavior of the GetAggregatedData and PrefetchTiles APIs for both olp::dataservice::read::VersionedLayerClient and olp::dataservice::read::VolatileLayerClient. When the aggregated parent tile is far away, i.e. more then max. depth 4, other APIs could not find it (for example, level 14 tile aggregated on level 1). Now, the aggregated tile can be found and used by other APIs.
  • PrefetchTilesRequest, TileRequest, and DataRequest now support priorities.
  • Fixed the crash that occurred when the client was destroyed during an ongoing prefetch operation.
  • Changed the behavior of olp::dataservice::read::CatalogClient::GetLatestVersion and olp::dataservice::read::VersionedLayerClient. Now, if you do not specify a version, the SDK tries to get it from the network by default. Also, in the cache, the latest version now does not expire after five minutes.
  • Added new API olp::dataservice::read::VersionedLayerClient::PrefetchPartitions which allows you to prefetch generic partitions which are not tile based.

olp-cpp-sdk-dataservice-write

  • Fixed the uploading of encoded data to the HERE Blob Service. The missing Content-Encoding header is now added when the layer is configured as compressed. This applies to olp::dataservice::write::VersionedLayerClient, olp::dataservice::write::VolatileLayerClient and olp::dataservice::write::IndexLayerClient.
  • Fix the bug in the olp::dataservice::write::StreamLayerClient::PublishData when the TraceId provided by the user is ignored for data bigger than 20 MB.
  • Work In Progress Enhanced olp::dataservice::write::VersionedLayerClient. The PublishToBatch and CancelBatch methods now use olp::thread::TaskScheduler instead of network threads for asynchronous operations.
  • Work In Progress Enhanced olp::dataservice::write::VolatileLayerClient. The PublishPartitionData method now uses olp::thread::TaskScheduler instead of network threads for asynchronous operations.

v1.8.0 (25/08/2020)

Common

  • Work In Progress Added the ApiKey support. Now, you can generate API keys on the platform and use them for reading.
  • Added the ApiLookup client. Now, you can specify a custom lookup server or provide a custom endpoint for the services (for example, a dedicated proxy).
  • Added the cache protection API. Now, you can mark keys as protected from eviction.
  • Adapted HRN members to the coding style, made all HRN class members private, and added getters to access them.
  • Added the KeyValueCache::Contains API that you can use to check if a key is in the cache.
  • Fixed the CMake scripts issue that occurred when a path contained whitespaces.
  • Fixed the DefaultCache behavior that occurred when it was opened in the read-only mode.
  • Modified the DefaultRetryCondition. It now retries after 429 errors.
  • Removed the deprecated backdown_policy parameter from OlpClientSettings.

olp-cpp-sdk-authentication

  • Deprecated the SignInGoogle API. It will be removed by 12.2020.
  • Fixed the bug in DecisionAPI (decision_ was uninitialized).

olp-cpp-sdk-dataservice-read

  • Added the IsCached API for partition and tile keys.
  • Added the Protect/Release functionality. Now, you can protect specific partitions and tiles from eviction. For example, you may want a specific region to always be present in the cache.
  • Breaking Change Removed the deprecated WithVersion and GetVersion methods from DataRequest, PrefetchTilesRequest, and PartitionsRequest.
  • Enhanced prefetch. Now, you can request quadtrees in parallel.
  • Breaking Change Removed the deprecated constructor of the VersionedLayerClient class.
  • Added the prefetch status callback. You can use it to receive the following prefetch progress information: the number of tiles prefetched, the total number of tiles requested, and total bytes transferred.
  • Added an experimental option to the prefetch API that you can use to prefetch a list of tiles as aggregated.

olp-cpp-sdk-dataservice-write

  • Breaking Change Removed the deprecated CancelAll methods from dataservice::write::VersionedLayerClient, dataservice::write::VolatileLayerClient, and dataservice::write::IndexLayerClient
  • Breaking Change Removed the deprecated CreateDefaultCache method from StreamLayerClient.h.
  • Work In Progress Enhanced olp::dataservice::write::VersionedLayerClient. The StartBatch and CompleteBatch methods now use olp::thread::TaskScheduler instead of network threads for asynchronous operations.
  • Fixed the duplicate requests used to configure the service in StreamLayerClient.
  • Fixed the upload issue in the stream layer that occurred when the layer compression was enabled on the platform at the same time as the ingest service was used.

v1.7.0 (16/06/2020)

Common

  • Changed the product name from HERE OLP SDK for C++ to HERE Data SDK for C++.
  • Fixed formatting to be compliant with the coding style.
  • Fixed the issue with olp::client::TaskContext. Now, it does not trigger cancellation after a successful operation.
  • Added the default_cache_expiration to olp::client::OlpClientSettings. Now, you can control how long the downloaded data is considered valid. Once the data is expired, you cannot retrieve it, and it is gradually removed from the cache when new data is added.
  • Added the OLP_SDK_DISABLE_DEBUG_LOGGING CMake option. When enabled, the SDK does not print any TRACE or DEBUG level log messages.
  • Added the compression setting to olp::cache::CacheSettings. You can now pass the flag to the underlying database engine to enable or disable the data compression.
  • Added the Compact API to olp::cache::DefaultCache. It is used to optimize the underlying mutable cache storage. Compaction also starts automatically once the database size reaches the maximum in a separate thread.
  • Changed the olp::cache::DefaultCache read operation. As a result, the number of memory allocation decreased, and performance increased.
  • Added support for the HTTP OPTIONS request in olp::http::Network.
  • The LRU eviction now evicts expired elements first. The eviction time decreased.
  • Removed the retry code from olp::http::NetworkCurl. Now, retries are performed by olp::client::OlpClient.
  • Added a prewarm helper method to olp::client::OlpClientSettingsFactory. This method can be used to perform DNS prefetch and TLS preconnect for certain URLs that are widely used by the clients. For example, accounts and lookup.
  • Enabled certificate validation in olp::http::NetworkCurl.

olp-cpp-sdk-authentication

  • The olp::authentication::TokenProvider class now handles the concurrent by blocking all requesters until the already triggered request completes. It verifies that only one token is requested at the same time.
  • The IntrospectApp and Authorize APIs now use ExponentialBackdownStrategy internally in case of a 5xx HTTP status code.
  • olp::authentication::AuthenticationError class is deprecated and will be replaced by olp::client::ApiError. It will be removed by 12.2020.
  • Switched the SignInClient method in the olp::authentication::AuthenticationClient functionality to TaskContext.
  • Added a fallback mechanism for SignInClient. Now, when the system time is wrong, the server time is used.
  • Changed the olp::authentication::ActionResult class. Permissions are now represented by the olp::authentication::Permission class.
  • The use_system_time flag in olp::authentication::Settings is now enabled by default. Now, system time is used for token requests by default.

olp-cpp-sdk-dataservice-read

  • The module now resolves all service APIs for a specific HRN in a single request.
  • Reduced the number of logs produced by the component.
  • Merged the same concurrent Lookup API requests into a single HTTP request.
  • Merged the same concurrent GetBlob and GetVolatileBlob API requests into a single HTTP request.
  • Merged the same concurrent QuadTreeIndex API requests into a single HTTP request.
  • Work In Progress Added a new ListVersions API to olp::dataservice::read::CatalogClient. You can use it to get information on catalog versions.
  • Work In Progress Added a new GetAggregatedData API to olp::dataservice::read::VersionedLayerClient. You can use it to retrieve tile data (if it exists) or the nearest parent tile data. Use this API for tile-tree structures where children tile data is aggregated and stored in parent tiles.

v1.6.0 (05/05/2020)

Common

  • Added the LRU functionality to the mutable disk cache. LRU is enabled by default. You can disable it using eviction_policy in CacheSettings.
  • Completed the network statistics implementation. It's available in Network::GetStatistics. Now, you can get accumulated statistics on how many bytes are processed during each operation.
  • Added the missing CORE_API export macros.
  • Updated various classes according to the Google coding style.
  • Added information on backward compatibility.
  • Fixed various compiler warnings.
  • Minor documentation changes.
  • Fixed the Android bug that made network responses incomplete.

olp-cpp-sdk-authentication

  • Added the use_system_time flag to olp::authentication::Settings. You can use it when retrieving tokens to tell olp::authentication::TokenProvider to work with the system time instead of the server time.
  • Added the olp::authentication::AuthenticationClient::Authorize method. You can use it to collect all permissions associated with the authenticated user or application.
  • olp::authentication::TokenProvider now uses the pimpl idiom. Now, when you copy an instance of this class, it does not create a new request.
  • Deprecated the olp::authentication:AutoRefreshingToken class. It will be removed by 10.2020.
  • Breaking Change Removed the deprecated constructor of the AuthenticationClient class and the following deprecated methods: SetNetworkProxySettings, SetNetwork, and SetTaskScheduler.
  • The deprecation of the olp::authentication::TokenEndpoint and olp::authentication::TokenRequest classes is extended until 10.2020.

olp-cpp-sdk-dataservice-read

  • Optimized memory overhead for prefetch.
  • Removed the ambiguous PrefetchTilesRequest::WithTileKeys method that takes an rvalue reference.

v1.5.0 (07/04/2020)

Common

  • Moved the DefaultCache implementation to pimpl.
  • Fixed various compiler warnings.
  • CMake now uses the official Boost Github repository instead of downloading and unpacking the archive.
  • Method OlpClientSettingsFactory::CreateDefaultCache now returns nullptr if it failes to open one of the user-defined disk caches.
  • Work In Progress Added API to retrieve network statistics. It is not fully implemented yet, and users should not use it.

olp-cpp-sdk-authentication

  • Added a new use_system_time flag to olp::authentication::AuthenticationSettings. You can use it to tell the authentication module to work with system time instead of server time when retrieving tokens.

olp-cpp-sdk-dataservice-read

  • Added a stream layer read example. For more information, see our documentation.
  • Added the RemoveFromCache method to VolatileLayerClient. Now, you can remove specific partitions or tiles from the mutable cache.
  • Added a new PrefetchTiles method to VolatileLayerClient. Now, you can prefetch volatile tiles in the same way as versioned tiles.

v1.4.0 (24/03/2020)

Common

  • Breaking Change Removed the deprecated disk_path property. Use the disk_path_mutable property instead.
  • The DefaultCache constructor is now explicit and takes CacheSettings by value.
  • Fixed data that was not validated during reading from LevelDB when the olp::cache::OpenOptions::CheckCrc property was provided.
  • Various improvements in olp::http::NetworkCurl implementation. Some legacy features were removed.
  • Added the SetDefaultHeaders method to olp::http::Network. Now, you can set default HTTP headers for each request made by Network. User agents set with default headers and user agents passed with network requests are concatenated into one header.
  • Reduced compiler warnings about deprecated methods and classes.

olp-cpp-sdk-authentication

  • Removed the deprecated AuthenticationClient::SignInClient method.

olp-cpp-sdk-dataservice-read

  • Added the RemoveFromCache method to VersionedLayerClient. Now, you can remove specific partitions or tiles from the mutable cache.
  • VersionedLayerClient now triggers an error when the request is passed with FetchOption::CacheWithUpdate. It makes no sense to update data when it is available in a cache for VersionedLayerClient since the version is locked.
  • Now, when you pass a request to VersionedLayerClient or VolatileLayerClient with FetchOption::OnlineOnly, data is not stored in a cache. It is designed for a use case when you are not interested in storing data in a cache.

olp-cpp-sdk-dataservice-write

  • Deprecated the olp::dataservice::write::StreamLayerClient::CreateDefaultCache method. It will be removed by 06.2020.

v1.3.0 (10/03/2020)

Common

  • Response headers are now stored in olp::client::HttpResponse. olp::client::OlpClient::CallApi() collects and adds headers to the response.
  • X-Correlation-ID is now extracted from the HTTP response headers and used for subsequent requests in olp::dataservice::read::StreamLayerClient.
  • Added a new backdown strategy to olp::client::RetrySettings. The default implementation is olp::client::ExponentialBackdownStrategy that restricts the maximum wait time during failed retries of network requests in the olp::network::client::OlpClient class (both synchronous and asynchronous versions). The accumulated wait time during retries should not be longer than the RetrySettings.timeout property.
  • Added curl_global_init() and curl_global_cleanup() to the olp::http::NetworkCurl class (Linux default implementation). For more information, see the olp::client::OlpClientSettingsFactory::CreateDefaultNetworkRequestHandler() function.
  • Fixed MSVC, Clang, and GCC warnings. Now, when you build with -Wall -Wextra, you should not face any hidden warnings, as the codebase is protected by a pre-release verification job.
  • Fixed the possible thread concurrency problem in the olp::client::OlpClient class that resulted in a crash in some situations.
  • Reduced data copy in the JSON serializers to increase performance.

olp-cpp-sdk-authentication

  • Added a new API to olp::authentication::AuthenticationClient that you can use to perform a generic federated authentication with a custom request body.
  • Added the olp::authentication::AuthenticationClient::IntrospectApp() method that you can use to retrieve information about the application associated with a particular access token.
  • Added a new olp::authentication::AuthenticationClient constructor using olp::authentication::AuthenticationSettings to setup network and task scheduler. It is a part of an ongoing authentication refactoring. Switch to this constructor instead of using the individual setters.

olp-cpp-sdk-dataservice-read

  • olp::dataservice::read::PartitionsRequest now supports a list of partition IDs. This way, when you use olp::dataservice::read::VersionedLayerClient and olp::dataservice::read::VolatileLayerClient, you can also request certain partitions instead of the entire layer metadata.
  • Added the Seek method to olp::dataservice::read::StreamLayerClient. This method can be used to start reading messages from a stream layer at any given position.
  • Added the Poll method to olp::dataservice::read::StreamLayerClient. This method reads messages from a stream layer and commits successfully consumed messages before handing them over to you.
  • Added the olp::dataservice::read::TileRequest class and corresponding GetData overload to olp::dataservice::read::VersionedLayerClient. Now, you can get data using a tile key. Internally, the metadata retrieval is optimized by using a quadtree request and saves bandwidth on subsequent GetData calls.
  • Added additional fields to the olp::dataservice::read::PartitionsRequest class. Now, you can access the following additional metadata fields: data size, compressed data size, checksum, and CRC.
  • Deprecated the WithVersion and the GetVersion methods in the olp::dataservice::read::DataRequest, olp::dataservice::read::PartitionsRequest and olp::dataservice::read::PrefetchTilesRequest classes. olp::dataservice::read::VersionedLayerClient now locks the catalog version either to the value provided on the constructor or by requesting the latest catalog version from the backend. This ensures that consistent data is provided for the instance lifecycle.
  • Fixed cache keys by appending 'partition' and 'partitions' to key values in olp::dataservice::read::VolatileLayerClient.
  • Fixed the infinite loop in the olp::dataservice::read::VersionedLayerClient::PrefetchTiles() method when min/max levels are not specified.

v1.2.0 (04/02/2020)

Common

  • Added a protected read-only cache. For details, see olp::cache::CacheSettings.
  • Added a protected read-only cache usage example.
  • Added ARM platform support for Embedded Linux with GCC 5.4 (32/64 bit).
  • Added the ErrorCodeToString function to olp/core/http/NetworkTypes.h.
  • Improved the olp::http::NetworkCurl logging.
  • Changed the IsNull function in the olp::client::HRN class to handle realms according to platform changes.
  • Added the bool operator to the olp::client::HRN class. You can now use the operator to check whether all the service type fields in the olp::client::HRN class are not empty.
  • Fixed a possible data race in the olp::client::Condition class.
  • Added the MoveResult method to the olp::client::ApiResponse class. The method returns an rvalue reference to the result.
  • CMake now requires RapidJSON v1.1.0.
  • Various CMake cleanups.
  • Improved error handling in Android HttpClient.
  • Fixed the linking error when SDK was statically linked inside a shared library with CMAKE_POSITION_INDEPENDENT_CODE=ON.
  • The retry policy now handles server errors automatically.

olp-cpp-sdk-authentication

  • Added a possibility to parse credentials from a file or stream in olp::authentication::AuthenticationCredentials. Now, to get credentials for the AuthenticationCredentials class, you can use the credentials.properties file that is provided by the platform.
  • Deprecated the olp::authentication::TokenEndpoint class. It will be removed by 04.2020.
  • Deprecated the olp::authentication::TokenRequest class. It will be removed by 04.2020.
  • Deprecated various methods in olp::authentication::AuthenticationClient.
  • Authentication now gets the current timestamp from the platform and uses it to request the OAuth2 token that prevents replay attacks. As a fallback, the system time is used.

olp-cpp-sdk-dataservice-read

  • The olp::dataservice::read::QueryApi, olp::dataservice::read::MetadataApi, olp::dataservice::read::LookupApi, and olp::dataservice::read::BlobApi classes are now blocking and use the new synchronous CallApi method in OlpClient.
  • The GetData method of the versioned and volatile layer now triggers the olp::client::ErrorCode::PreconditionFailed error if both a partition ID and data handle are passed in the data request.
  • Work-in-progress: Added reading support for streamed data using the new olp::dataservice::read::StreamLayerClient. Currently, you can only subscribe, unsubscribe, and get data from a stream layer message.

olp-cpp-sdk-dataservice-write

  • Enhanced olp::dataservice::write::StreamLayerClient to use olp::thread::TaskScheduler for asynchronous operations instead of network threads.
  • Removed the unused olp::dataservice::write::ThreadSafeQueue class.
  • Deprecated the CancelAll methods in all layers. Use the CancelPendingRequests methods instead.

v1.1.0 (11/12/2019)

Common

  • The deprecated olp::client::CancellationToken::cancel() method was removed. Use olp::client::CancellationToken::Cancel() instead.
  • The curl network implementation was fixed and can now compile on 32 bits architecture.
  • The disk_path field in olp::cache::CacheSettings is deprecated. Use the disk_path_mutable field instead.
  • A new synchronous CallApi method was added to olp::client::OlpClient.
  • pipe and pipe2 symbols detection are enhanced in curl.cmake.

olp-cpp-sdk-authentication

  • The SignInClient method in olp::authentication::AuthenticationClient is deprecated in favor of the newly introduced SignInClient method with a different signature.
  • The scope support was added to OAuth2 through olp::authentication::SignInProperties. You can now access the project bound resources using the olp::authentication::SignInProperties::scope field.
  • The error_id field was added to the ErrorResponse structure. You can use it to get the errorId string from the authentication error response.

olp-cpp-sdk-dataservice-read

  • The deprecated GetCatalogMetadataVersion method was removed from the olp::dataservice::read::CatalogClient.

olp-cpp-sdk-dataservice-write

  • Legacy and unused code were removed.

v1.0.0 (03/12/2019)

Common

  • A new CMake flag OLP_SDK_BOOST_THROW_EXCEPTION_EXTERNAL was introduced to compile the SDK without exceptions. The user needs to provide the custom boost::throw_exception function.
  • olp::client::HttpResponse now holds std::stringstream instead of std::string. This removes expensive copies.
  • The CMake minimum version increased to 3.9.
  • The cancel method in CancellationToken is deprecated in favor of the newly introduced Cancel method.
  • Network logs improved for all platforms.
  • Various bug fixes and improvements.
  • The Network limit is now implemented for all platforms. When the limit is reached, the Network::Send method returns olp::http::ErrorCode::NETWORK_OVERLOAD_ERROR, and client users receive olp::client::ErrorCode::SlowDown as a response.
  • Android network client can now be used when Java VM is embedded in a native application.

olp-cpp-sdk-dataservice-read

  • The VersionedLayerClient and VolatileLayerClient classes are now movable and non-copyable.
  • The TaskContext and PendingRequests classes moved to the core component, and are now public.
  • The GetCatalogMetadataVersion method in CatalogClient is deprecated. The GetLatestVersion method should be used instead.
  • All deprecated methods marked in v0.8.0 are now removed.
  • A new optional parameter for a catalog version was added to PrefetchTileRequest. It is used by VersionedLayerClient::PrefetchTiles(). If not provided, the latest catalog version is queried from OLP instead.

olp-cpp-sdk-dataservice-write

  • Missing DATASERVICE_WRITE_API was added to various classes.

v0.8.0-beta (31/10/2019)

Common

  • Project renamed to here-olp-sdk-cpp.
  • Project structure was changed, functional, integration, performance tests introduced.
  • Local OLP server that mimics OLP added.
  • OLP_SDK_DEPRECATED macro is added to deprecate API.
  • Breaking Change SendOutcome::IsSuccessful typo fixed.
  • Missing dependencies for the iOS build as a shared library added.
  • KeyValueCache instance was added to OlpClientSetting.
  • Boost download source was changed.
  • Added Condition class helping repositories sync wait on the OLP response.
  • Updated read example and documentation to reflect recent changes in API.

olp-cpp-sdk-authentication

  • Breaking Change olp::authentication::Settings requires olp::authentication::AuthenticationCredentials.

olp-cpp-sdk-dataservice-read

  • Added new class VersionedLayerClient that is used to access versioned layers in OLP. Class implements GetData, GetPartitions, PrefetchTiles methods from CatalogClient.
  • Added new class VolatileLayerClient that is used to access volatile layers in OLP. Class implements GetPartitions, GetData methods from CatalogClient.
  • GetData, GetPartitions, PrefetchTiles methods in CatalogClient deprecated.
  • Breaking Change CatalogClient constructor changed. OlpClientSettings must be passed by value, KeyValueCache is now part of OlpClientSettings.
  • Moved all responses and callbacks aliases to Types.h.

olp-cpp-sdk-dataservice-write

  • StreamLayerClientSettings class introduced.
  • Breaking Change StreamLayerClient constructor changed.
  • Breaking Change StreamLayerClient::Flush changed. Now taking FlushRequest as input and a FlushCallback to be triggered after the flush.
  • Breaking Change StreamLayerClient::Enable, StreamLayerClient::Disable removed.
  • VersionedLayerClient::CancelAll added, used to cancel all current running requests.
  • [CMake] Definition to export symbols added when the component is built as a shared library.
  • VolatileLayerClient, VersionedLayerClient, IndexLayerClient now cancel pending requests when destroyed.

v0.7.0-beta (09/09/2019)

Common

  • Introduced new abstract olp::thread::TaskScheduler to be used for async context; provided default thread pool implementation.
  • Added UserAgent HTTP header to mark all triggered requests.
  • Added China Lookup API URLs.
  • Introduced new HTTP abstraction layer olp::http::Network without singleton usage. Platform dependent implementations adapted and aligned with coding style.
  • olp::network::Network with according implementations and helper classes removed.
  • Changed olp::client::CancellationContext to shared pimpl so we can remove the std::shared_ptr wrapper when using it across multiple requests.
  • Improved logging in core components.

olp-edge-sdk-cpp-authentication

  • Breaking Change - Use new HTTP layer as input parameter for all requests. This is a mandatory parameter and users must provide it.
  • Breaking Change - Use new olp::thread::TaskScheduler; provided as input parameter.
  • Removed usage of raw std::thread and switched to olp::thread::TaskScheduler. If the olp::thread::TaskScheduler instance is not provided, all tasks are executed in the calling thread.

olp-edge-sdk-cpp-dataservice-read

  • Breaking Change - Use new HTTP layer as input parameter for all requests. This is a mandatory parameter and users must provide it.
  • Breaking Change - Use new olp::thread::TaskScheduler; provided as input parameter.
  • Removed usage of raw std::thread and switched to olp::thread::TaskScheduler. If the olp::thread::TaskScheduler instance is not provided, all tasks are executed in the calling thread.
  • Improved logging.

olp-edge-sdk-cpp-dataservice-write

  • Breaking Change - Use new HTTP layer as input parameter for all requests. This is a mandatory parameter and users must provide it.
  • Breaking Change - olp::dataservice::write::StreamLayerClient uses new olp::thread::TaskScheduler as input parameter for async context. If the olp::thread::TaskScheduler instance is not provided, all tasks are executed in the calling thread.

v0.6.0-beta (03/06/2019)

Initial open source release as a work in progress beta.
Not all OLP features are implemented, API breaks very likely with following commits and releases.

olp-edge-sdk-cpp-authentication

  • Sign up new user with e-mail and password.
  • Sign up new user with Facebook, Google, ArcGIS credentials.
  • Accept terms and log out user.
  • AAA OAuth2 with registered user credentials.

olp-edge-sdk-cpp-dataservice-read

  • Read from Catalog (configuration, layers).
  • Read from Versioned Layer (partitions metadata, partition data).
  • Read from Volatile Layer (partitions metadata, partition data).
  • Cache results on disk for later use.

olp-edge-sdk-cpp-dataservice-write

  • Write to Versioned Layer (initialize publication, upload data and metadata, submit publication).
  • Write to Volatile Layer (initialize publication, upload metadata, submit publication, upload data).
  • Write to Stream Layer (publish data, queue data for asyncronous publish, publish SDII messages, batch write).
  • Write to Index Layer (publish index, delete index, update index).