[BUG] Breaking public API by removing error_occurred from BenchmarkReporter::Run

Abierto
  • ¿Algo no está bien?
#1,603 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
cpp
Área
backend-api-design

Línea de trabajo

Comience revisando el commit y el PR referenciados; después, inspeccione la declaración pública de BenchmarkReporter::Run, donde error_occurred y error_message fueron reemplazados por skipped y skip_message. Confirme el impacto en la compatibilidad para las aplicaciones que utilizan el campo eliminado y verifique el comportamiento resultante de la API pública en las versiones compatibles.

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

Descripción

Describe the bug
The commit https://github.com/google/benchmark/commit/adb0d3d0bf5841bddc2bcc025baad93dbc7fa39f in PR https://github.com/google/benchmark/pull/1564 removed member error_occurred from BenchmarkReporter::Run struct.

@@ -1685,8 +1720,8 @@ class BENCHMARK_EXPORT BenchmarkReporter {
     std::string aggregate_name;
     StatisticUnit aggregate_unit;
     std::string report_label;  // Empty if not set by benchmark.
-    bool error_occurred;
-    std::string error_message;
+    internal::Skipped skipped;
+    std::string skip_message;
 
     IterationCount iterations;
     int64_t threads;

This is a API breaking change that was introduced without any deprecation warning. Updating the application code to use skipped will cause a build-break for when compiled against older version of GoogleBenchmark. There are no macros to detect the version of benchmark library.

System

  • all

To reproduce
NA

Expected behavior
All code using error_occurred should compile. A deprecation warning should be emitted a few releases prior to removing the public field from a struct.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.

Lenguaje dominante
C++
Estrellas
10.5k
Forks
1.8k
Merge medio
1 d 15 h
PR fusionados (30 d)
28

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 google/benchmark

Todos los issues de google/benchmark

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.