BUG: Preserve execution warnings when a filter is cancelled

Abierto Apto para principiantes
#1,987 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 6 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
78/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
cpp
Área
backend

Línea de trabajo

Lee src/simplnx/Filter/IFilter.cpp, especialmente la rama de cancelación en IFilter::execute, y los fixtures existentes en test/FilterTest.cpp. Añade una prueba de regresión usando las advertencias de preflight y de ejecución descritas; después, actualiza el resultado de cancelación para conservar ambas listas de advertencias y los valores de salida de preflight, preservando los errores de ejecución. Compila simplnx_test y ejecuta el caso de CTest especificado; se considera terminado cuando estén presentes el error de cancelación y ambas advertencias.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
C++
Estrellas
18
Forks
15
Merge medio
4 d 23 h
PR fusionados (30 d)
42

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de BlueQuartzSoftware/simplnx

Todos los issues de BlueQuartzSoftware/simplnx

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.