From 5c8ebb00c20d83f76f6ca01c37041f8b319f9140 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Jare=C5=A1?= Date: Wed, 22 May 2024 11:52:14 +0200 Subject: [PATCH] Add 3.4.0 href to changelog (#2894) --- .markdownlint.json | 3 +++ docs/Changelog.md | 2 +- docs/testingplatform/idataconsumer.md | 2 ++ 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.markdownlint.json b/.markdownlint.json index e70a5096b..80834d3de 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -7,6 +7,9 @@ "MD024": { "siblings_only": true }, + "MD033": { + "allowed_elements": ["a"] + }, "MD046": { "style": "fenced" }, diff --git a/docs/Changelog.md b/docs/Changelog.md index 83ec29125..edb3101d9 100644 --- a/docs/Changelog.md +++ b/docs/Changelog.md @@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) -## [3.4.0] - WIP +## [3.4.0] - WIP See full log [here](https://github.com/microsoft/testfx/compare/v3.3.1...HEAD) diff --git a/docs/testingplatform/idataconsumer.md b/docs/testingplatform/idataconsumer.md index 6100bb55a..b2926f496 100644 --- a/docs/testingplatform/idataconsumer.md +++ b/docs/testingplatform/idataconsumer.md @@ -90,6 +90,8 @@ Finally, the api takes a `CancellationToken` which the extension is expected to > [!IMPORTANT] > It's crucial to process the payload directly within the `ConsumeAsync` method. The [IMessageBus](imessagebus.md) can manage both synchronous and asynchronous processing, coordinating the execution with the [testing framework](itestframework.md). Although the consumption process is entirely asynchronous and doesn't block the [IMessageBus.Push](imessagebus.md) at the time of writing, this is an implementation detail that may change in the future due to feature requirements. However, we aim to maintain this interface's simplicity and ensure that this method is always called once, eliminating the need for complex synchronization. Additionally, we automatically manage the scalability of the consumers. + + > [!WARNING] > When using `IDataConsumer` in conjunction with [ITestHostProcessLifetimeHandler](itestsessionlifetimehandler.md) within a [composite extension point](compositeextensionfactory.md), **it's crucial to disregard any data received post the execution of [ITestSessionLifetimeHandler.OnTestSessionFinishingAsync](itestsessionlifetimehandler.md)**. The `OnTestSessionFinishingAsync` is the final opportunity to process accumulated data and transmit new information to the [IMessageBus](imessagebus.md), hence, any data consumed beyond this point will not be *utilizable* by the extension.