Enums de Protocol Buffers: gestionar los valores numéricos desconocidos según el comportamiento del runtime

Qué es

Protocol Buffers documenta el comportamiento de los enums abiertos y cerrados, e indica que existen diferencias de implementación entre las bibliotecas de cada lenguaje. Un valor numérico desconocido puede conservarse como valor del campo en un enum abierto, o gestionarse mediante el almacenamiento de campos desconocidos en un enum cerrado. Por eso, la sintaxis o edición seleccionada y el runtime forman parte del análisis de compatibilidad. Comportamiento de los enums en Protocol Buffers

Por qué importa

Un agente de programación puede generar un switch exhaustivo a partir de los valores con nombre actuales y dar por hecho que los productores futuros no pueden enviar nada distinto. Conviene decidir qué debe hacer un consumidor antiguo ante un valor que no entiende: rechazarlo, conservarlo mientras retransmite el mensaje o seguir una rama conservadora que esté documentada.

Cómo aplicarlo

• Registra la sintaxis o edición del esquema, si el enum es abierto o cerrado y las versiones concretas del runtime de cada lenguaje que usa cada participante. Consulta el comportamiento específico de cada runtime en lugar de suponer que todas las APIs generadas son idénticas.
• Define el comportamiento de la aplicación ante un número desconocido. Mantén ese caso separado de un valor por defecto o no especificado conocido cuando tengan significados distintos.
• Plantea un mensaje de un esquema más reciente que contenga un valor de enum recién añadido. Decodifícalo con el consumidor antiguo e inspecciona tanto el estado visible para la aplicación como el tratamiento de campos desconocidos.
• Si el consumidor reenvía mensajes, vuelve a codificarlos y decodifícalos de nuevo con la implementación más reciente. Verifica si el valor y el orden relevante se conservan a lo largo del recorrido requerido.
• Añade pruebas explícitas para los campos enum repetidos y para las transformaciones a través de JSON cuando se den en el sistema real.

Trampas

Desconocido no significa autorizado ni válido para una operación determinada. Conserva la compatibilidad sin asignar en silencio a los valores nuevos un significado permisivo. La documentación de protobuf enumera desviaciones específicas de cada runtime, así que una explicación genérica no sustituye a la matriz real de productores y consumidores. Este artículo propone comprobaciones de interoperabilidad y no presenta ningún resultado de pruebas ejecutadas entre lenguajes ni garantiza que todos los datos desconocidos sobrevivan a cualquier transformación.