Sipariş servisi OrderPlaced event’i yayınlıyor. Fatura, stok ve bildirim servisleri bu event’i dinliyor.

Sipariş ekibi bir refactoring yapıyor. amount alanının adını totalAmount olarak değiştiriyor. Daha açıklayıcı.

Deploy ediyorlar.

Fatura servisi her event’te null tutar ile fatura oluşturmaya başlıyor. Bildirim servisi exception fırlatıp mesajları tekrar denemeye başlıyor.

Sipariş ekibinin kendi testleri ise yeşil.

Event’ler bir API sözleşmesidir

REST API’lerde breaking change kavramı artık oldukça iyi anlaşılıyor. Ama event’ler genellikle aynı özenle ele alınmıyor.

Oysa yayınlanan bir event de bir sözleşme. Üstelik REST’ten daha zor yönetilen bir sözleşme. Çünkü yayıncı, event’i kimlerin dinlediğini her zaman bilmez.

Bir de zaman boyutu var. Kafka gibi sistemlerde event’ler günlerce, bazen yıllarca saklanır. Yeni bir consumer, aylar önce yazılmış event’leri de okuyabilir. Event şeması değiştiğinde, eski ve yeni formattaki event’ler aynı topic’te yan yana durur.

Uyumluluk yönleri

Geriye uyumluluk (backward): Yeni şemayı kullanan consumer, eski şemayla yazılmış event’leri okuyabilir.

İleriye uyumluluk (forward): Eski şemayı kullanan consumer, yeni şemayla yazılmış event’leri okuyabilir.

Tam uyumluluk (full): İkisi birden.

Producer ve consumer’lar farklı zamanlarda deploy edildiği için, genellikle her iki yönde de uyumluluk gerekir.

Güvenli değişiklikler

Pratikte uyumluluğu koruyan değişiklikler sınırlı:

  • Varsayılan değeri olan yeni bir opsiyonel alan eklemek
  • Opsiyonel bir alanı kaldırmak, consumer’lar ona bağımlı değilse

Uyumluluğu bozan değişiklikler:

  • Bir alanı yeniden adlandırmak
  • Bir alanın tipini değiştirmek
  • Zorunlu yeni bir alan eklemek
  • Bir alanın anlamını değiştirmek

Son madde özellikle sinsi. amount alanı önceden KDV hariç tutarı tutuyordu, artık KDV dahil tutarı tutuyor. Şema aynı, tip aynı, hiçbir kontrol hatayı yakalamaz. Ama bütün consumer’ların hesapları yanlış.

Schema registry

Confluent Schema Registry veya Apicurio gibi araçlar, event şemalarını merkezi bir yerde tutar ve yeni bir şema versiyonu kaydedilirken uyumluluk kurallarını kontrol eder.

Avro, Protobuf veya JSON Schema ile tanımlanan bir şema, uyumluluğu bozan bir değişiklik içeriyorsa kayıt reddedilir. Producer, uyumsuz bir event’i yayınlamaya başlamadan önce hata alır.

Avro ve Protobuf’un ikili formatları ayrıca alan adlarını her mesajda taşımadığı için daha küçük mesajlar üretir. Ama JSON kadar okunabilir değildir ve araç desteği gerektirir.

Kırıcı değişiklik gerektiğinde

Bazen bir event’in yapısı gerçekten değişmelidir.

Bu durumda mevcut event’i değiştirmek yerine yeni bir event tipi veya yeni bir topic oluşturmak daha güvenli:

orders.order-placed.v1
orders.order-placed.v2

Producer bir süre her iki versiyonu da yayınlar. Consumer’lar kendi hızlarında yeni versiyona geçer. Eski versiyonu dinleyen kalmadığında, yayınlanması durdurulur.

API versiyonlamadaki expand and contract yaklaşımının event dünyasındaki karşılığı.

Tolerant reader

Consumer tarafında da sorumluluk var. Bilmediği alanları görmezden gelmek, opsiyonel alanların yokluğunu tolere etmek ve enum’larda bilinmeyen değerlerle başa çıkabilmek, şema evrimini çok daha kolay hale getirir.

Event’ler servisler arasındaki bağımlılığı azaltmak için kullanılıyor.

Ama şemaları dikkatsizce değiştirildiğinde, servisleri senkron API çağrılarından bile daha sıkı ve daha görünmez şekilde birbirine bağlıyor.