apache / apache/pulsar-client-cpp

[C++] pulsar-client-cpp stability enhancements and code cleanup

Abierto
#112 4 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
C++
Estrellas
71
Forks
90
Merge medio
2 h 33 min
PR fusionados (30 d)
3

Descripción

Howdy! My company is investing heavily into event driven workflows, and we're utilizing Pulsar to accomplish this end. We're primarily a C++ shop, and I'm a Principal Engineer and in charge of the integration of Pulsar into our system, and experienced in C++. I've made a few bug fixes to the C++ client already, and in doing so I've noticed that it could use a bit of love to bring greater consistency to the design and fix up some low-hanging fruit. We've integrated Pulsar into our own build system, and it required a lot of changes to pass our build (which uses many more warnings and runs tests with ASAN). We've found that enforcing a more strict set of warnings helps to keep a c++ codebase healthy and stable, and I'd like to upstream these changes for the benefit of everyone, and to make continued maintenance easier.

Would anyone be opposed to me undertaking some general cleanup of the C++ client?

My proposed TODO list:

- Enable many more warnings (`-Wall`, `-Wvla`, `-Wformat-security`, etc)
- Enforce warnings as errors to prevent changes being submitted with warnings
- Fix all the subsequent warnings that will be generated
- Fix compatibility with boost 1.41 (the documentation claims it should be compatible, but it's not, and that happens to be the version we're stuck on).
- Use consistent format for `#include`s of local files (some have a `/lib` prefix, others don't)
- Run the tests via ASAN or Valgrind, if available (not sure how easy this will be yet...)
- Update syntax to take advantage of more C++11 features (like `std::make_shared`, move semantics, etc)

I'll obviously split this stuff up into a series of smaller changes. I'm hopeful that by doing this I'll gain more experience working with Pulsar and could potentially contribute more significant improvements in the future, i.e. performance enhancements and helping to keep feature parity between the C++ and Java clients.

Thanks!

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

La propuesta abarca la compilación del cliente C++, las advertencias, la compatibilidad con Boost 1.41, el formato de los includes, las pruebas y las actualizaciones de C++11, pero no especifica archivos ni pruebas concretos. Empieza revisando la configuración de compilación actual y la configuración de pruebas, y después divide la lista TODO en un cambio acotado con archivos afectados y criterios de verificación explícitos.

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

Evaluación

Stack tecnológico
cpp
Área
backend, build-system, testing
Tipo de issue
Refactorización
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.