Skip to content

Commit 782d980

Browse files
committed
feat docs: update changelog for 2.14
Tests: протестировано CI, на прод не влияет commit_hash:0081310e8c8df73b4b164ab08f2a3cac939c80b6
1 parent 89f25c1 commit 782d980

File tree

8 files changed

+52
-23
lines changed

8 files changed

+52
-23
lines changed

core/include/userver/components/statistics_storage.hpp

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,18 @@ USERVER_NAMESPACE_BEGIN
1212

1313
namespace components {
1414

15-
// clang-format off
16-
1715
/// @ingroup userver_components
1816
///
19-
/// @brief Component that keeps a utils::statistics::Storage storage for
20-
/// metrics.
17+
/// @brief Component that keeps a @ref utils::statistics::Storage storage for metrics.
2118
///
22-
/// Returned references to utils::statistics::Storage live for a lifetime
19+
/// Returned references to @ref utils::statistics::Storage live for a lifetime
2320
/// of the component and are safe for concurrent use.
2421
///
2522
/// The component does **not** have any options for service config.
2623
///
2724
/// ## Static configuration example:
2825
///
2926
/// @snippet components/common_component_list_test.cpp Sample statistics storage component config
30-
31-
// clang-format on
3227
class StatisticsStorage final : public RawComponentBase {
3328
public:
3429
/// @ingroup userver_component_names
@@ -70,9 +65,9 @@ inline constexpr auto kConfigFileMode<StatisticsStorage> = ConfigFileMode::kNotR
7065

7166
namespace utils::statistics {
7267

73-
/// @brief Add a writer function to @ref Storage from @ref StatisticsStorage.
74-
/// It automatically calls @ref Storage::RegisterWriter just after the component
75-
/// construction and @ref Entry::Unregister just before the component
68+
/// @brief Add a writer function to @ref Storage from @ref components::StatisticsStorage.
69+
/// It automatically calls @ref utils::statistics::Storage::RegisterWriter() just after the component
70+
/// construction and @ref utils::statistics::Entry::Unregister() just before the component
7671
/// destructor.
7772
///
7873
/// @see @ref Storage::RegisterWriter.

libraries/s3api/include/userver/s3api/clients/s3api.hpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,37 +191,37 @@ class Client {
191191
/// Performs a CreateMultipartUpload S3 Action.
192192
/// Returns result with `upload ID` which is used to associate all of the parts in the specific multipart upload.
193193
/// You specify this `upload ID` in each of your subsequent upload part requests
194-
/// For details see @ref https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
194+
/// For details see https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
195195
virtual multipart_upload::InitiateMultipartUploadResult CreateMultipartUpload(
196196
const multipart_upload::CreateMultipartUploadRequest& request
197197
) const = 0;
198198

199199
/// @brief Upload a part in a multipart upload sequence.
200200
/// Performs an UploadPart S3 Action.
201201
/// Returns ETag value which you must include in the subsequent request to complete the multipart upload.
202-
/// For details see @ref https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
202+
/// For details see https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
203203
virtual multipart_upload::UploadPartResult UploadPart(const multipart_upload::UploadPartRequest& request) const = 0;
204204

205205
/// @brief Complete a multipart upload by assembling previously uploaded parts.
206206
/// Performs a CompleteMultipartUpload S3 Action.
207-
/// For details see @ref https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
207+
/// For details see https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
208208
virtual multipart_upload::CompleteMultipartUploadResult CompleteMultipartUpload(
209209
const multipart_upload::CompleteMultipartUploadRequest& request
210210
) const = 0;
211211

212212
/// @brief Abort a multipart upload sequence.
213213
/// Performs an AbortMultipartUpload S3 Action.
214-
/// For details see @ref https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
214+
/// For details see https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
215215
virtual void AbortMultipartUpload(const multipart_upload::AbortMultipartUploadRequest& request) const = 0;
216216

217217
/// @brief List the parts that have been uploaded for a specific multipart upload.
218218
/// Performs a ListParts S3 Action.
219-
/// For details see @ref https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
219+
/// For details see https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
220220
virtual multipart_upload::ListPartsResult ListParts(const multipart_upload::ListPartsRequest& request) const = 0;
221221

222222
/// @brief List in-progress multipart uploads in a bucket
223223
/// Performs a ListMultipartUploads S3 Action.
224-
/// For details see @ref https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
224+
/// For details see https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
225225
virtual multipart_upload::ListMultipartUploadsResult ListMultipartUploads(
226226
const multipart_upload::ListMultipartUploadsRequest& request
227227
) const = 0;

libraries/s3api/src/s3api/s3api_methods.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ constexpr std::string_view kEncodingTypeValueUrl = "url";
4848

4949
constexpr std::string_view kS3AwsXmlNamespace = "http://s3.amazonaws.com/doc/2006-03-01/";
5050

51-
// see @ref https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
51+
// see https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
5252
const unsigned kMaxUploadsListLimit = 1000u;
5353

5454
} // namespace

mongo/include/userver/storages/mongo/transaction.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class TransactionImpl;
2525
///
2626
/// ## Usage example:
2727
///
28-
/// @snippet mongo/src/storages/mongo/transaction_mongotest.cpp [transaction]
28+
/// @snippet mongo/src/storages/mongo/transaction_mongotest.cpp transaction
2929
///
3030
/// @note Transactions require MongoDB replica sets or sharded clusters.
3131
/// @note Operations within a transaction are automatically retried according

redis/src/storages/redis/client_cluster_redistest.cpp

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,16 @@ UTEST_F(RedisClusterClientTest, TransactionDistinctShards) {
192192
UASSERT_THROW(transaction->Exec(kDefaultCc).Get(), storages::redis::RequestFailedException);
193193
}
194194

195+
UTEST_F(RedisClusterClientTest, Generic) {
196+
auto client = GetClient();
197+
const storages::redis::CommandControl command_control{};
198+
constexpr size_t kKeyIndex = 0;
199+
/// [Sample generic command usage]
200+
client->GenericCommand<void>("set", {"key0", "foo"}, kKeyIndex, command_control).Wait();
201+
EXPECT_EQ(client->GenericCommand<std::string>("get", {"key0"}, kKeyIndex, command_control).Get(), "foo");
202+
/// [Sample generic command usage]
203+
}
204+
195205
// Must abort in debug builds
196206
#ifdef NDEBUG
197207
UTEST_F(RedisClusterClientTest, NotStartedTransactionNoExec) {

scripts/docs/doxygen.conf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1168,6 +1168,7 @@ EXAMPLE_PATH = samples \
11681168
ydb/functional_tests \
11691169
otlp/src \
11701170
otlp/tests \
1171+
libraries/multi-index-lru/src \
11711172
libraries/easy/samples
11721173

11731174
# If the value of the EXAMPLE_PATH tag contains directories, you can use the

scripts/docs/en/userver/build/options.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ The exact format of setting cmake options varies depending on the method of buil
8383
| `USERVER_FEATURE_GRPC_REFLECTION` | Provide reflection service for gRPC | `${USERVER_BUILD_ALL_COMPONENTS}` |
8484
| `USERVER_FEATURE_S3API` | Provide S3 client for gRPC | `${USERVER_BUILD_ALL_COMPONENTS}` |
8585
| `USERVER_FEATURE_EASY` | Provide library for easy prototyping | `${USERVER_BUILD_ALL_COMPONENTS}` |
86+
| `USERVER_FEATURE_MULTI_INDEX_LRU` | Provide library for Multi Index LRU containers | `${USERVER_BUILD_ALL_COMPONENTS}` |
87+
8688

8789
### CMake options for building everything
8890

scripts/docs/en/userver/roadmap_and_changelog.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,33 @@ Changelog news also go to the
3939

4040
* Added a @ref ugrpc::RichStatus builder for creating rich gRPC error statuses with
4141
structured details following Google's error model
42+
* Added a @ref utils::statistics::RegisterWriterScope for safe and easy registration of statistics.
43+
* No more need to call `CacheUpdateTrait::StartPeriodicUpdates()` from your caching components.
4244
* Implemented a Multi Index LRU container, thanks to [hzhdlrp](https://github.com/hzhdlrp).
4345
* Statement name is now logged when using @ref storages::postgres::Portal.
46+
* Monitor port is now opened before all the components and handlers are started, leading to more control and
47+
information on service start.
4448
* @ref storages::postgres::DistLockComponentBase now can be configured at runtime via @ref POSTGRES_DISTLOCK_SETTINGS.
4549
* Added @ref utils::TaskBuilder
4650
*@ref scripts/docs/en/userver/libraries/s3api.md now has @ref QUALITY_TIERS "Platinum Tier".
4751
* Kafka is now more accurate in computing message time spent in @ref kafka::ConsumerComponent queue.
4852
* @ref utils::statistics::RecentPeriod is does not lose precision under heavy contention.
49-
* Added functionality to @ref scripts/docs/en/userver/dump_coroutines.md
53+
* Added functionality to @ref scripts/docs/en/userver/dump_coroutines.md
5054
* Added DeadlockDetector that can be enabled via `coro_pool.deadlock_detector` option
5155
in @ref components::ManagerControllerComponent.
5256
* Added @ref storages::mongo::Transaction
5357
* Added @ref server::middlewares::Cors
58+
* Added @ref utils::FromStringNoThrow
59+
* Fixed unnecessary lock in TaskContext desctructor when there are no plugins. Many thanks to
60+
[Ivan Trofimov](https://github.com/itrofimow) for the PR
61+
* @ref formats::yaml::Value now checks for key uniqueness in mappings.
62+
* @ref scripts/docs/en/userver/gdb_debugging.md "Stack monitor usage" is not automatically disabled under GDB.
63+
* Disabled phdr cache if ASAN is enabled. Many thanks to
64+
[Yury Bogomolov](https://github.com/ybogo) for the PR
65+
* Allowed using mapped enums in @ref storages::postgres::ParameterStore. Many thanks to Aleksey Popov for the patch and
66+
help!
67+
* Fixed error in [uservice-dynconf](https://github.com/userver-framework/uservice-dynconf) schema. Many thanks to
68+
[Repin Daniil](https://github.com/Repin-Daniil) for the PR!
5469
* @ref components::ComponentContext::RegisterScope() now can be used to register some resource that will be
5570
called after the component is successfully created (including all
5671
class descendants) and destroyed right before calling the destructor of the most derived component. This is a low
@@ -77,15 +92,19 @@ Changelog news also go to the
7792
* Added multipart methods support for testsuite @ref pytest_userver.plugins.s3api "s3api plugin".
7893
* @ref utils::FromString() now reports if input sequence of chars to convert contains '\0' character.
7994
* Improved diagnostics for PostgreSQL composite types related errors, including nested composite types.
95+
* Fixed typo in third party. Many thanks to [shuric80](https://github.com/shuric80) for the PR!
96+
* Fixed typo in Docker badge link for upastebin. Many thanks to [Гуща Иван](https://github.com/Ivan160927777)
97+
for the PR!
8098
* A lot of updates for different sections of documentation, including @ref utils::FixedArray,
81-
@ref ‎scripts/docs/en/userver/deadline_propagation.md, @ref clients::http::Request,
82-
@ref ‎scripts/docs/en/userver/gdb_debugging.md.
99+
@ref scripts/docs/en/userver/deadline_propagation.md, @ref clients::http::Request,
100+
@ref scripts/docs/en/userver/gdb_debugging.md, @ref scripts/docs/en/userver/long_transactions.md,
101+
@ref scripts/docs/en/userver/mongodb.md, @ref scripts/docs/en/userver/congestion_control.md
83102

84103

85104
Plugins are renamed to middlewares and @ref components::HttpClient was split into @ref components::HttpClient
86105
and @ref components::HttpClientCore.
87106

88-
**Migration guide**:
107+
#### Migration guide from v2.13 to v2.14
89108

90109
1. Instead of `.Append<components::HttpClient>()` use `.AppendComponentList(clients::http::ComponentList())` in
91110
your component list (see @ref clients::http::ComponentList "docs").
@@ -208,6 +227,8 @@ Plugins are renamed to middlewares and @ref components::HttpClient was split int
208227
+ http-client-middleware-with-dynamic-config:
209228
+ enabled: false
210229
```
230+
7. Remove calls to `CacheUpdateTrait::StopPeriodicUpdates()`. Remove calls to `CacheUpdateTrait::StartPeriodicUpdates()`
231+
or replace them with @ref CacheUpdateTrait::EarlyStartPeriodicUpdates() if early update is required.
211232

212233

213234
### Release v2.13
@@ -275,7 +296,7 @@ Plugins are renamed to middlewares and @ref components::HttpClient was split int
275296
* Clarified ownership of buckets in @ref utils::statistics::Histogram.
276297
* Added mirrors to the videos at @ref scripts/docs/en/userver/publications.md.
277298
* Redis now provides much more information in logs.
278-
* Added troubleshooting info on `SIGUSR1` to @ref scripts/docs/en/userver/faq.md .
299+
* Added troubleshooting info on `SIGUSR1` to @ref scripts/docs/en/userver/faq.md .
279300

280301

281302
### Release v2.12

0 commit comments

Comments
 (0)