BUG: Preserve execution warnings when a filter is cancelled

Aperta Adatta ai principianti
#1,987 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 6 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
cpp
Ambito
backend

Direzione di ricerca

Leggi src/simplnx/Filter/IFilter.cpp, in particolare il ramo di annullamento in IFilter::execute, e i fixture esistenti in test/FilterTest.cpp. Aggiungi un test di regressione usando gli avvisi di preflight e di esecuzione descritti, quindi aggiorna il risultato dell’annullamento in modo da conservare entrambi gli elenchi di avvisi e i valori di output del preflight, preservando gli errori di esecuzione. Compila simplnx_test ed esegui il caso CTest specificato; il lavoro è completo quando sono presenti l’errore di annullamento e entrambi gli avvisi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug

Problem

When a filter requests cancellation during execution and returns a valid result with a warning, IFilter::execute reports cancellation and loses the execution warning. The result should contain the cancellation error and warnings from both preflight and execution.

This occurred in a Windows MSVC Release test linked against simplnx 44875faf4e349cf2004fc69fcef3ab1f308aa995. The affected IFilter.cpp is identical at the develop base 8cad1e818a6517eb933a85d1654bb4415a6396d6.

Steps to Reproduce

  1. Use a filter that returns one warning from preflight and a different warning from execution.
  2. Have the filter set the caller's cancellation flag immediately before it returns the valid execution result.
  3. Call the public IFilter::execute entry point. It returns cancellation error -1 and only the preflight warning.

Cause

The cancellation branch returns before the normal merge of the preflight and execution results. Its merge uses only the preflight result and the cancellation error. Cancellation branch in IFilter::execute

if(shouldCancel && executeImplResult.valid())
{
  return ExecuteResult{MergeResults(std::move(preflightActionsResult), MakeErrorResult(-1, "Filter cancelled")), std::move(preflightResult.outputValues)};
}

Verification Unit Test

Add the following to test/FilterTest.cpp. It uses the existing BackstopFilterBase and k_PreflightWarningCode. Build simplnx_test, then run ctest -C Release -j 1 -R "^IFilter: Cancellation preserves execution warnings$" --output-on-failure --no-tests=error from the configured build directory.

namespace
{
class CancelAfterWarningFilter : public BackstopFilterBase<CancelAfterWarningFilter>
{
public:
  static inline constexpr StringLiteral k_FilterName = "CancelAfterWarningFilter";
  static inline constexpr StringLiteral k_FilterUuid = "784f2751-bc9d-4d53-b610-1d36e26bb5f4";
  static inline constexpr int32 k_ExecutionWarningCode = -9980;

  std::atomic_bool* cancelFlag = nullptr;

protected:
  PreflightResult preflightImpl(const DataStructure&, const Arguments&, const MessageHandler&, const std::atomic_bool&, const ExecutionContext&) const override
  {
    Result<OutputActions> result;
    result.warnings().push_back(Warning{k_PreflightWarningCode, "The controlled preflight warning"});
    return {std::move(result)};
  }

  Result<> executeImpl(DataStructure&, const Arguments&, const PipelineFilter*, const MessageHandler&, const std::atomic_bool&, const ExecutionContext&) const override
  {
    cancelFlag->store(true);
    return MakeWarningVoidResult(k_ExecutionWarningCode, "The controlled execution warning");
  }
};
} // namespace

TEST_CASE("IFilter: Cancellation preserves execution warnings", "[simplnx][IFilter]")
{
  std::atomic_bool shouldCancel = false;
  CancelAfterWarningFilter filter;
  filter.cancelFlag = &shouldCancel;
  DataStructure dataStructure;
  const Arguments args;

  const auto execution = filter.execute(dataStructure, args, nullptr, {}, shouldCancel);
  REQUIRE(shouldCancel.load());
  REQUIRE(execution.result.invalid());
  REQUIRE(execution.result.errors().front().code == -1);
  const auto& warnings = execution.result.warnings();
  REQUIRE_FALSE(warnings.empty());
  CHECK(warnings.front().code == k_PreflightWarningCode);
  REQUIRE(warnings.size() == 2);
  CHECK(warnings[1].code == CancelAfterWarningFilter::k_ExecutionWarningCode);
}

The test was compiled with the existing Catch2 fixtures and run through CTest in an isolated test harness. The cancellation code and preflight warning checks passed. The warning count failed with 1 == 2. The existing test that checks execution-error precedence over cancellation passed in the same harness.

Proposed Fix

In IFilter::execute, combine the preflight and execution results before adding the cancellation error. Preserve both warning lists and the preflight output values. If execution already returned an error, keep that error as the reported failure.

Notes

This is the shared wrapper follow-up identified in the simplnx #1888 review. It applies to any filter that returns warnings when cancellation is set during execution.

Lingua principale
C++
Stelle
18
Fork
15
Merge medio
4g 23h
PR unite (30g)
42

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di BlueQuartzSoftware/simplnx

Tutte le issue di BlueQuartzSoftware/simplnx

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.