Rails Veritabanı Değişikliklerinde Görsel Kontrol: Migflow Nasıl Yardımcı Olur?

Üç ay önce, 800 binden fazla satırı olan bir tabloda null: false özelliğine sahip yeni bir sütun ekleyen bir göçü (migration) production ortamına gönderdim. Üretim sistemi çöktü ve en kötüsü, bu sorunu yakalayabilecek hiçbir otomatik kontrole sahip olmamamızdı.

GitHub PR’ında karşılaştığım Ruby DSL kodunu okurken, tablonun geçmişteki ve gelecekteki durumunu zihnimde canlandırmaya çalıştım. Bu, çoğu Rails ekibinin hâlâ kullandığı inceleme yöntemi: PR’ı inceleyen kişinin yeterince konsantre olup sorunu fark etmesini ummak.

İşte bu yüzden Migflow’u geliştirdim. Artık Rails göçlerini sadece kod olarak değil, görsel olarak da inceleyebiliyoruz.

Rails göçlerinde ne sorun yaşanıyor?

Rails göçleri güçlü bir araç olsa da, bunların incelenme şekli neredeyse on yıldır aynı kalmış durumda. PR açtığınızda karşınıza change metodu ve içindeki add_column komutları çıkar. Bu kod, tablonun mevcut halini, gelecekteki halini ve potansiyel riskleri anlamaya çalışırken zihinsel bir egzersize dönüşür.

Görsel bir bağlam yok. Önceki ve sonraki durumlar arasındaki farklar net değil. Göçün, tablonun tarihçesi içindeki yerini anlamak neredeyse imkansız. Kod, bir dönüşümü tanımlıyor ama neyin dönüştürüldüğünü gösteremiyor.

Küçük projelerde bu sorun olmayabilir. Ancak yüzlerce göçü ve onlarca tablosu olan üretim uygulamalarında, bu durumun ciddi sorunlara yol açma ihtimali çok yüksek.

Migflow neler sunuyor?

Migflow, Rails uygulamalarına kolayca entegre edilebilen bir motor. Gem’i ekleyip, rotalarınıza bağladığınızda, db/migrate/ klasöründeki ve db/schema.rb dosyasındaki tüm göçleri otomatik olarak analiz ediyor. Veritabanına bağlanmaya, arka plan işlemlerine ya da ek altyapılara ihtiyaç duymuyor.

İşte Migflow’un sunduğu ana özellikler:

• Basit İngilizce özetlerle göç kronolojisi: Ruby kodu okumak yerine, her göçün ne yaptığını doğal dilde anlayan bir liste görüyorsunuz. Örneğin, "users tablosuna email_verified (boolean, varsayılan: false) sütunu eklendi" gibi bir açıklama, PR incelemesi sırasında çok daha anlaşılır oluyor.

• Önce ve sonra durumunu gösteren schema farkları: Herhangi bir göç için, schema dosyasının (schema.rb) önceki ve sonraki durumunu karşılaştıran bir birleşik fark gösteriliyor. Bu, normal PR incelemelerinde eksik olan kritik bir bağlam.

• Etkileşimli ERD (Entity-Relationship Diagram) panosu: En gurur duyduğum özelliklerden biri de bu. Tüm tabloların, sütunların ve yabancı anahtarların görsel bir grafiğini sunuyor. Göç geçmişini adım adım takip ederken, şemadaki değişiklikleri canlı olarak izleyebiliyorsunuz. Yeni bir tablo eklendiğinde yeşil renkte gösteriliyor, bir sütun kaldırıldığında kırmızıyla vurgulanıyor. Tüm şemanın zaman içinde nasıl evrildiğini görmek mümkün.

• Yaygın hatalara yönelik otomatik uyarılar: Migflow, altı yaygın sorunu otomatik olarak kontrol ediyor:
• Yabancı anahtarı olan sütunda indeks eksikliği
• _id uzantılı sütunda yabancı anahtar kısıtlamasının olmaması
• :limit özelliği olmayan string sütunlar
• Zaman damgası (timestamps) bulunmayan tablolar
• remove_column, drop_table ya da rename_column gibi tehlikeli işlemler
• Varsayılan değeri olmayan null: false sütunlar (üretimde benim karşılaştığım sorun tam olarak buydu)

• Her göç için risk puanı: Her göç, denetim kurallarından kaç tanesini tetiklediğine bağlı olarak bir risk puanı alıyor. PR’ınızdaki hangi göçlerin daha fazla dikkat gerektirdiğini tek bakışta anlayabiliyorsunuz.

• CI entegrasyonu için Rake görevi: Migflow’un risk puanını CI hattına entegre ederek, belirlediğiniz bir eşik değerini aşan göçlerin otomatik olarak build’i kırmasını sağlayabiliyorsunuz. Bu sayede, göç kalitesi artık sadece PR inceleyen kişiye bağlı kalmıyor; otomatik ve tekrarlanabilir bir kontrole dönüşüyor.

Neden Migflow benzersiz?

Rails ekosisteminde göç güvenliği için kullanılan birçok harika araç bulunuyor. Örneğin, strong_migrations oldukça etkili — göçleri çalıştırırken tehlikeli işlemleri engelliyor. Eğer hâlâ kullanmıyorsanız, muhtemelen kullanmaya başlamalısınız.

Ancak strong_migrations ve Migflow farklı aşamalarda devreye giriyor:

• strong_migrations, göçün çalıştırılması sırasında koruma sağlıyor.
• Migflow ise göçün incelenmesi sırasında görsel bağlam sunuyor.

Biri çalışma zamanı için bir güvenlik ağı, diğeri ise PR incelemesi sırasında şemanın neyi nasıl değiştirdiğini anlamak için bir araç. Birbirlerini tamamlıyorlar. Eğer halihazırda strong_migrations kullanıyorsanız, Migflow sayesinde PR incelemesi sırasında sorunları daha erken yakalayabiliyorsunuz — deployment’dan önce.

Ayrıca, Migflow’un sunduğu bazı özellikler ekosistemde başka hiçbir araçta bulunmuyor:

• Zaman içinde değişen ERD: Göç geçmişinden adım adım ilerleyerek, şemanın her bir değişiklikle nasıl güncellendiğini görsel olarak izleyebiliyorsunuz. Başka hiçbir araç, geçmişteki herhangi bir noktada şemanın neye benzediğini görsel olarak göstermiyor.

• Veritabanına erişim gerektirmeyen inceleme: Migflow, dosyalardan veri okuduğu için, PR incelemesi yapan herkes (hatta frontend geliştiriciler) staging ya da production erişimine ihtiyaç duymuyor.

• Kurumsal kalite kontrolü: CI entegrasyonu sayesinde, göç inceleme kalitesi, o gün PR’ı inceleyen kişiye bağlı kalmıyor. Eşik değer, kıdemli bir DBA’dan yeni başlayan bir geliştiriciye kadar herkes için aynı oluyor.

Migflow kimler için ideal?

Eğer yalnız çalışıyorsanız ve uygulamanız küçükse, Migflow’a ihtiyacınız olmayabilir. Şemanızı biliyorsunuz, tablolar küçük ve kötü bir göçün riski düşük.

Ancak aşağıdaki durumlardan herhangi biri sizin için tanıdık geliyorsa, Migflow üretimde yaşanabilecek bir kesintiyi önleyebilir:

• Ekibinizde birkaç geliştirici göçleri itiyor ve şemanın tamamını kimse hatırlamıyor
• Daha önce göç kaynaklı bir kesinti yaşadınız ve post-mortem raporunuza "daha dikkatli olalım" gibi notlar düştünüz
• Göç PR’ları genellikle "bana göre sorun yok" şeklinde onaylanıyor çünkü PR’daki farklar yeterli bağlamı sağlamıyor
• CI hattında göç kalitesini otomatik olarak kontrol etmek istiyorsunuz, ancak özel araçlar geliştirmek yerine hazır bir çözüm arıyorsunuz

Hızlı başlangıç

Migflow’u uygulamaya eklemek ve rotalarınıza bağlamak için sadece birkaç adım gerekiyor. Veritabanı kurulumuna, yapılandırma dosyalarına ya da çalışan bir servise ihtiyaç duymuyor. Sadece göç dosyalarınızı ve schema dosyasını okuyor ve çalışıyor.

# Gemfile

# Migflow'u ekleyin
gem 'migflow'

# config/routes.rb

# Migflow'u rotalara bağlayın
mount Migflow::Engine, at: '/migflow'

Migflow, Rails ekosistemine görsel bir inceleme katmanı ekleyerek, göçlerin sadece kod olarak değil, anlayabileceğimiz ve takip edebileceğimiz bir şekilde yönetilmesini sağlıyor. Gelecekteki göçlerinizi daha güvenli ve şeffaf bir şekilde planlamak için artık bakış açınızı genişletebilirsiniz.