Skip to content

Conversation

@Smartkras
Copy link
Contributor

Updated CHANGELOG and CMakeLists files for the release v1.17.0

Relates-To: OLPEDGE-2835

Copy link
Contributor

@andrey-kashcheev andrey-kashcheev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see previous changelogs for examples of how to form it as it is not equal to git log

@HalynaDumych HalynaDumych self-requested a review October 9, 2023 13:56
CHANGELOG.md Outdated
* Improved support of HTTP proxy on iOS.
* Cleaned up DNS cache on error in CURL (Android).
* Moved all jobs to Github Actions.
* Fixed cmake scripts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Fixed cmake scripts.
* Fixed the CMake scripts.
CHANGELOG.md Outdated
Comment on lines 9 to 10
* Improved logging in PendingUrlRequests.
* Added StreamLayerPartitions API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Improved logging in PendingUrlRequests.
* Added StreamLayerPartitions API.
* Improved logging in `PendingUrlRequests`.
* Added the `StreamLayerPartitions` API.
CHANGELOG.md Outdated
* Cleaned up DNS cache on error in CURL (Android).
* Moved all jobs to Github Actions.
* Fixed cmake scripts.
* Added possibility to specify DNS in network request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added possibility to specify DNS in network request.
* Added the possibility to specify DNS in network requests.
CHANGELOG.md Outdated
* Improved logging in PendingUrlRequests.
* Added StreamLayerPartitions API.
* Fixed the CMakeLists file.
* Fix to show more log info in prod build.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Fix to show more log info in prod build.
* Fixed the logging output. Now, more logging information is displayed in the production build.
CHANGELOG.md Outdated
* Fixed the CMakeLists file.
* Fix to show more log info in prod build.
* Censored credentials in debug log messages.
* Fixed the rapidjson include directory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Fixed the rapidjson include directory.
* Fixed the `rapidjson` include directory.
CHANGELOG.md Outdated
* Used custom token endpoint url from credentials.

**olp-cpp-sdk-dataservice-read**
* Changed the GetPartitions API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Changed the GetPartitions API.
* Changed the `GetPartitions` API.
@Smartkras
Copy link
Contributor Author

Please see previous changelogs for examples of how to form it as it is not equal to git log

It will not be equal to git log, because there will be changes in text. The list of changes is received from: v1.16.0...master

@codecov
Copy link

codecov bot commented Oct 10, 2023

Codecov Report

Merging #1437 (c77b8d4) into master (2fd2782) will not change coverage.
The diff coverage is n/a.

❗ Current head c77b8d4 differs from pull request most recent head 41e9c1e. Consider uploading reports for the commit 41e9c1e to get more accurate results

@@ Coverage Diff @@ ## master #1437 +/- ## ======================================= Coverage 80.04% 80.04% ======================================= Files 340 340 Lines 13215 13215 Branches 1417 1417 ======================================= Hits 10577 10577 Misses 2065 2065 Partials 573 573 

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

CHANGELOG.md Outdated
**Common**
* Improved support of HTTP proxy on iOS.
* Cleaned up DNS cache on error in cURL (Android).
* Fix the olp-cpp-sdk-core/CMakeLists.txt to include the externals include directory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Fix the olp-cpp-sdk-core/CMakeLists.txt to include the externals include directory.
* Updated the `olp-cpp-sdk-core/CMakeLists.txt` file to include the externals include directory.
CHANGELOG.md Outdated
* Added the possibility to specify DNS using `WithDNSServers` to `olp::http::NetworkSettings` API.
* Improved logging in `PendingUrlRequests`.
* Added the `CallApiStream` to `olp::client::OlpClient` API.
* Fixed the `boost` and `rapidjson` includes path resolution in olp-cpp-sdk-core/CMakeLists.txt.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Fixed the `boost` and `rapidjson` includes path resolution in olp-cpp-sdk-core/CMakeLists.txt.
* Fixed the `boost` and `rapidjson` includes path resolution in `olp-cpp-sdk-core/CMakeLists.txt`.

As this is a file (path) I think it should be formatted as code.

CHANGELOG.md Outdated
* Fixed the `rapidjson` include directory.

**olp-cpp-sdk-authentication**
* Added ability to use custom token endpoint URL from credentials in `Settings`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unclear. Does this mean that in Settings you can now use a custom URL; that URL comes from credentials?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Settings receives credentials in it's constructor, but token endpoint URL from that credentials was not used:
58f9566

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tomekpapiernik Credentials file may contain this URL, and after the file is parsed this URL will be used as a token provider URL. E.g. "here.token.endpoint.url=https://myurl.com/auth"

CHANGELOG.md Outdated
* Fix the olp-cpp-sdk-core/CMakeLists.txt to include the externals include directory.
* Added the possibility to specify DNS using `WithDNSServers` to `olp::http::NetworkSettings` API.
* Improved logging in `PendingUrlRequests`.
* Added the `CallApiStream` to `olp::client::OlpClient` API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When you write the SOMETHING you should specify what that something is. In this case you'd say
the CallApiStream THING.

If you don't want to call out what CallApiStream is, remove "the".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please explain in one sentence what this API for

CHANGELOG.md Outdated
* Added ability to use custom token endpoint URL from credentials in `Settings`.

**olp-cpp-sdk-dataservice-read**
* Added the `repository::GetPartitionsExtendedResponse` to support requests with more than 100 partitions in `GetPartitions` API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the CallApiStream comment.

CHANGELOG.md Outdated
* Fix the olp-cpp-sdk-core/CMakeLists.txt to include the externals include directory.
* Added the possibility to specify DNS using `WithDNSServers` to `olp::http::NetworkSettings` API.
* Improved logging in `PendingUrlRequests`.
* Added the `CallApiStream` to `olp::client::OlpClient` API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please explain in one sentence what this API for

CHANGELOG.md Outdated
* Cleaned up DNS cache on error in cURL (Android).
* Updated the `olp-cpp-sdk-core/CMakeLists.txt` to include the externals include directory.
* Added the possibility to specify DNS using `WithDNSServers` to `olp::http::NetworkSettings` API.
* Improved logging in `PendingUrlRequests`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Improved logging in `PendingUrlRequests`.
* Improved logging in `olp::client::PendingUrlRequests`.
CHANGELOG.md Outdated
* Updated the `olp-cpp-sdk-core/CMakeLists.txt` to include the externals include directory.
* Added the possibility to specify DNS using `WithDNSServers` to `olp::http::NetworkSettings` API.
* Improved logging in `PendingUrlRequests`.
* Added `CallApiStream` to `olp::client::OlpClient` API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please explain in one sentence what this API for

CHANGELOG.md Outdated
* Improved logging in `PendingUrlRequests`.
* Added `CallApiStream` to `olp::client::OlpClient` API.
* Fixed the `boost` and `rapidjson` includes path resolution in `olp-cpp-sdk-core/CMakeLists.txt`.
* Fixed the logging output. Now, more logging information is displayed in the production build.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understand it correctly this one is about just bumping the level from DEBUG to WARNING, and not about production builds

CHANGELOG.md Outdated
* Added `CallApiStream` to `olp::client::OlpClient` API.
* Fixed the `boost` and `rapidjson` includes path resolution in `olp-cpp-sdk-core/CMakeLists.txt`.
* Fixed the logging output. Now, more logging information is displayed in the production build.
* Censored credentials in debug log messages for the network logs on `DEBUG` log level.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Censored credentials in debug log messages for the network logs on `DEBUG` log level.
* Censored credentials in log messages for the network logs on `DEBUG` log level.
CHANGELOG.md Outdated
* Fixed the `rapidjson` include directory.

**olp-cpp-sdk-authentication**
* Added ability to use custom token endpoint URL from credentials in `Settings`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added ability to use custom token endpoint URL from credentials in `Settings`.
* Added ability to use custom token endpoint URL from credentials in `olp::authentication::Settings`.
CHANGELOG.md Outdated
* Fixed the `rapidjson` include directory.

**olp-cpp-sdk-authentication**
* Added ability to use custom token endpoint URL from credentials in `Settings`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tomekpapiernik Credentials file may contain this URL, and after the file is parsed this URL will be used as a token provider URL. E.g. "here.token.endpoint.url=https://myurl.com/auth"

CHANGELOG.md Outdated
* Added ability to use custom token endpoint URL from credentials in `Settings`.

**olp-cpp-sdk-dataservice-read**
* Added `repository::GetPartitionsExtendedResponse` to support requests with more than 100 partitions in `GetPartitions` API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this in olp::dataservice::read::VersionedLayerClient? Add it, as it is not clear what GetParitions API

CHANGELOG.md Outdated

**olp-cpp-sdk-dataservice-read**
* Added `repository::GetPartitionsExtendedResponse` to support requests with more than 100 partitions in `GetPartitions` API.
* Fix the incorrect parse error condition in `PartitionsRepository::ParsePartitionsStream`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again: streaming was not released - this change is not what changed from the latest release

CHANGELOG.md Outdated
* Added default copy and move constructors and copy and move operators to `model` namespace classes.

**olp-cpp-sdk-dataservice-write**
* Added default copy and move constructors and copy and move operators to `model` namespace classes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added default copy and move constructors and copy and move operators to `model` namespace classes.
* Added default copy and move constructors and operators to the `model` namespace classes.
CHANGELOG.md Outdated
Comment on lines 20 to 21
* Added support for requests with more than 100 partitions in `olp::dataservice::read::repository::PartitionsRepository` API.
* Added default copy and move constructors and copy and move operators to `model` namespace classes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added support for requests with more than 100 partitions in `olp::dataservice::read::repository::PartitionsRepository` API.
* Added default copy and move constructors and copy and move operators to `model` namespace classes.
* Added support for 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.
CHANGELOG.md Outdated
* Fixed the `rapidjson` include directory.

**olp-cpp-sdk-authentication**
* Added ability to use custom token endpoint URL from credentials in `olp::authentication::Settings`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added ability to use custom token endpoint URL from credentials in `olp::authentication::Settings`.
* Added the ability to use a custom token endpoint URL from credentials in `olp::authentication::Settings`.
CHANGELOG.md Outdated
* Fixed the `boost` and `rapidjson` includes path resolution in `olp-cpp-sdk-core/CMakeLists.txt`.
* Changed log level to `WARNING` for error message when max number of `HTTP` requests has been reached in `olp::http::SendOutcome OLPNetworkIOS`.
* Add status code for failed `HTTP` requests in `olp::dataservice::read::repository::PrefetchTilesRepository`.
* Censored credentials in log messages for the network logs on `DEBUG` log level.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Censored credentials in log messages for the network logs on `DEBUG` log level.
* Censored credentials in log messages for the network logs on the `DEBUG` log level.
CHANGELOG.md Outdated
* Added `CallApiStream` to `olp::client::OlpClient` API, which is using a `SAX` parser and a `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 log level to `WARNING` for error message when max number of `HTTP` requests has been reached in `olp::http::SendOutcome OLPNetworkIOS`.
* Add status code for failed `HTTP` requests in `olp::dataservice::read::repository::PrefetchTilesRepository`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Add status code for failed `HTTP` requests in `olp::dataservice::read::repository::PrefetchTilesRepository`.
* Added a status code for failed `HTTP` requests in `olp::dataservice::read::repository::PrefetchTilesRepository`.
CHANGELOG.md Outdated
* Improved logging in `olp::client::PendingUrlRequests`.
* Added `CallApiStream` to `olp::client::OlpClient` API, which is using a `SAX` parser and a `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 log level to `WARNING` for error message when max number of `HTTP` requests has been reached in `olp::http::SendOutcome OLPNetworkIOS`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Changed log level to `WARNING` for error message when max number of `HTTP` requests has been reached in `olp::http::SendOutcome OLPNetworkIOS`.
* Changed the log level to `WARNING` in the error message that is returned when the maximum number of `HTTP` requests is reached in `olp::http::SendOutcome OLPNetworkIOS`.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Log level is the way the message is shown, not something in the message.

CHANGELOG.md Outdated
* Updated the `olp-cpp-sdk-core/CMakeLists.txt` to include the externals include directory.
* Added the possibility to specify DNS using `WithDNSServers` to `olp::http::NetworkSettings` API.
* Improved logging in `olp::client::PendingUrlRequests`.
* Added `CallApiStream` to `olp::client::OlpClient` API, which is using a `SAX` parser and a `JSON` byte stream to parse the layer partitions while they are downloading.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added `CallApiStream` to `olp::client::OlpClient` API, which is using a `SAX` parser and a `JSON` byte stream to parse the layer partitions while they are downloading.
* 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.
CHANGELOG.md Outdated
* Improved support of HTTP proxy on iOS.
* Cleaned up DNS cache on error in cURL (Android).
* Updated the `olp-cpp-sdk-core/CMakeLists.txt` to include the externals include directory.
* Added the possibility to specify DNS using `WithDNSServers` to `olp::http::NetworkSettings` API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added the possibility to specify DNS using `WithDNSServers` to `olp::http::NetworkSettings` API.
* Added the possibility to specify DNS using `WithDNSServers` to the `olp::http::NetworkSettings` API.
CHANGELOG.md Outdated
@@ -1,3 +1,28 @@
## v1.17.0 (09/10/2023)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the date

CHANGELOG.md Outdated
* 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 max number of `HTTP` requests has been reached in `olp::http::SendOutcome OLPNetworkIOS`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Changed the log level to `WARNING` for the error message when max number of `HTTP` requests has been reached in `olp::http::SendOutcome OLPNetworkIOS`.
* Changed the log level to `WARNING` for the error message when max number of `HTTP` requests has been reached in `olp::http::OLPNetworkIOS::Send`.
CHANGELOG.md Outdated
* 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 max number of `HTTP` requests has been reached in `olp::http::OLPNetworkIOS::Send`.
Copy link
Contributor

@HalynaDumych HalynaDumych Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Changed the log level to `WARNING` for the error message when max number of `HTTP` requests has been reached in `olp::http::OLPNetworkIOS::Send`.
* 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`.
CHANGELOG.md Outdated
* 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 max number of `HTTP` requests has been reached in `olp::http::OLPNetworkIOS::Send`.
* Add a status code for failed `HTTP` requests in `olp::dataservice::read::repository::PrefetchTilesRepository`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Add a status code for failed `HTTP` requests in `olp::dataservice::read::repository::PrefetchTilesRepository`.
* Added a status code for failed `HTTP` requests in `olp::dataservice::read::repository::PrefetchTilesRepository`.
CHANGELOG.md Outdated
* Added the ability to use a custom token endpoint URL from credentials in `olp::authentication::Settings`.

**olp-cpp-sdk-dataservice-read**
* Added support for requests with more than 100 partitions in the `olp::dataservice::read::repository::PartitionsRepository` API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added support for requests with more than 100 partitions in the `olp::dataservice::read::repository::PartitionsRepository` API.
* Added support of requests with more than 100 partitions in the `olp::dataservice::read::repository::PartitionsRepository` API.
CHANGELOG.md Outdated
**Common**
* Improved support of HTTP proxy on iOS.
* Cleaned up DNS cache on error in cURL (Android).
* Updated the `olp-cpp-sdk-core/CMakeLists.txt` to include the externals include directory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Updated the `olp-cpp-sdk-core/CMakeLists.txt` to include the externals include directory.
* Updated `olp-cpp-sdk-core/CMakeLists.txt` to include the externals include directory.
CHANGELOG.md Outdated
Comment on lines 21 to 24
* Added default copy and move constructors and copy and move operators to the `model` namespace classes.

**olp-cpp-sdk-dataservice-write**
* Added default copy and move constructors and copy and move operators to the `model` namespace classes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added default copy and move constructors and copy and move operators to the `model` namespace classes.
**olp-cpp-sdk-dataservice-write**
* Added default copy and move constructors and copy and move operators to the `model` namespace classes.
* 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.
Updated CHANGELOG and CMakeLists files for the release v1.17.0 Relates-To: OLPEDGE-2835 Signed-off-by: Yevhen Krasilnyk <ext-yevhen.krasilnyk@here.com>
@Smartkras Smartkras merged commit 939c55a into master Oct 11, 2023
@Smartkras Smartkras deleted the release_1_17_0 branch October 11, 2023 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants