arifaydin.devenglish

bloga dön

modulix: kodda ve veritabanında modülleri tek komutla açıp kapatmak

Aynı ürünü farklı müşterilere farklı özelliklerle teslim etmenin dağınık olmayan bir yolu: yorum etiketleriyle işaretlenen modüller, şablonlar, yedekler ve veritabanı şeması senkronizasyonu.

Bir ürünü tek bir müşteriye satarken her şey basittir. İkinci müşteri “fatura modülü bizde olmasın, ama stok modülü olsun” dediği anda işler karışmaya başlar. Genelde üç yoldan birine gidilir:

  1. Her müşteriye ayrı branch. İlk hafta iyi gider, sonra her düzeltmeyi beş branch’e taşımak bir iş hâline gelir.
  2. Kodun her yerine if (features.billing) serpiştirmek. Kapalı modülün kodu yine de teslim edilir, veritabanında tabloları yine durur.
  3. Elle silip teslim etmek. Bir kere yapılır, ikinci kere kimse nasıl yapıldığını hatırlamaz.

modulix bu üçüne de girmeden, modülleri kaynak kodun içinde işaretleyip tek komutla açıp kapatmak için yazdığım açık kaynak bir CLI. npm’de modulix adıyla duruyor.

fikir: yorum satırı olarak etiket

modulix hiçbir dile özel söz dizimi eklemez. Bir modüle ait kodu, o dilin kendi yorum biçimiyle başlangıç ve bitiş etiketi arasına alırsınız:

// @auth users-table
const authService = new AuthService();
setupAuthListeners(authService);
// @!auth users-table

@auth users-table blok başlar, @!auth users-table blok biter. auth modülün adı, users-table bloğun adı. Etiketler yorum olduğu için kod, modulix hiç yokmuş gibi derlenir ve çalışır.

Aynı yaklaşım HTML’de, CSS’te ve SQL’de de geçerli:

<!-- @billing invoice-panel -->
<div class="billing-container">
  <h3>Faturalar</h3>
</div>
<!-- @!billing invoice-panel -->
-- @auth users-schema
CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    username VARCHAR(50)
);
-- @!auth users-schema

Şu an JavaScript, TypeScript, PHP, HTML, CSS/SCSS/LESS, Go, C# ve SQL dosyaları destekleniyor. Bir dosyanın tamamı bir modüle aitse ilk satıra @@modül blok yazmak yeterli: modül kapandığında dosya silinir, açıldığında geri gelir.

akış: işaretle, şablonu kaydet, senkronla

Bir projede modulix’i kullanmak dört adım:

npm install -g modulix   # global CLI, kısa adı: mdl
mdl init                 # projede .modulix/config.json oluşturur
mdl config set includes add .php
mdl config set excludes add node_modules

Sonra modülleri tanımlayıp kodun o anki hâlini bir şablon olarak kaydedersiniz:

mdl modules add          # örn. auth, billing
mdl templates add base-template

Şablon önemli: modül kapatıldığında o modülün blokları kaynak koddan gerçekten silinir. Tekrar açtığınızda içerik şablondan geri yazılır. Yani kapalı modülün kodu teslim edilen projede hiç bulunmaz, ama kaybolmaz da.

mdl modules disable billing
mdl modules sync         # kapalı modüllerin bloklarını temizler, açıkları şablondan doldurur

veritabanı da aynı kurala uyar

Kodu temizleyip tabloyu bırakmak yarım iştir. modulix, şablondaki SQL şemasını (örneğin schema.sql) açık modüllere göre filtreleyip veritabanına uygulayabilir. MySQL ve PostgreSQL destekleniyor:

mdl config set db                 # bağlantı bilgileri için sihirbaz
mdl db sync base-template         # filtrelenmiş şemayı uygular

Bu komut mevcut şemayı düşürüp filtrelenmiş yapıyı içe aktardığı için, canlı veride çalıştırmadan önce yedek almak şart. Bunun için ayrı komutlar var:

mdl db backup create v1-db-backup
mdl db backup swap v1-db-backup   # gerekirse geri dön

geri dönüş yolu: kod yedekleri

Senkronizasyon dosyaları değiştirdiği için modulix dosya sisteminin anlık görüntüsünü de alabiliyor:

mdl backup create initial-state
mdl backup status initial-state   # eklenen, değişen, silinen dosyalar
mdl backup swap initial-state     # çalışma alanını o ana geri döndür

status komutu, bir sync işleminin tam olarak neyi değiştirdiğini gösterir; senkrondan önce yedek alıp sonra buna bakmak iyi bir alışkanlık.

nerede işe yarar, nerede yaramaz

modulix şu durumlarda iyi sonuç verir:

  • Aynı ürünü farklı paketlerle (temel, pro, kurumsal) teslim ediyorsanız,
  • Bir müşteriye kapalı modülün kodunu hiç vermemeniz gerekiyorsa,
  • Monorepo’da istemci ve sunucu klasörlerini aynı modül listesine göre senkron tutmak istiyorsanız (mdl config set folder).

Çalışma anında açılıp kapanan özellikler (feature flag, A/B testi) için doğru araç değildir. modulix teslimattan önce, derleme zamanında karar verir. Kullanıcıya göre anlık değişen bir özellik için hâlâ bir flag sistemi gerekir.

deneyin

npm install -g modulix
mdl init

Kaynak kodu ve ayrıntılı örnek senaryo GitHub’da. Hata, öneri ya da yeni bir dil desteği isteği için issue açabilirsiniz.