C# / .NET Kompendium PLEN
.NET / C# / Entity Framework Core

Migracje EF Core w pracy zespołowej

Problem - konflikty migracji przy pracy wielu osób

Gdy kilka osób w zespole równolegle zmienia model danych, każda generuje własną migrację - klasyczny scenariusz konfliktu:

Deweloper A: dodaje kolumnę "Status" do Order      → migracja 20240115_AddOrderStatus
Deweloper B: dodaje kolumnę "DiscountCode" do Order → migracja 20240115_AddDiscountCode

Obie migracje bazują na tym samym modelu "przed zmianą" - gdy obie trafią do głównej gałęzi (np. przez merge), EF Core może się "pogubić" w kolejności, a snapshot modelu (ModelSnapshot.cs) będzie w konflikcie.

ModelSnapshot.cs - źródło konfliktów w Git

EF Core przechowuje pełny snapshot aktualnego modelu w wygenerowanym pliku AppDbContextModelSnapshot.cs - to jest plik, który będzie miał konflikt merge przy równoległych migracjach, bo obie osoby modyfikują ten sam wygenerowany plik.

// AppDbContextModelSnapshot.cs (fragment, WYGENEROWANY, nie edytuj ręcznie)
[DbContext(typeof(AppDbContext))]
partial class AppDbContextModelSnapshot : ModelSnapshot
{
    protected override void BuildModel(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity("MyApp.Order", b =>
        {
            b.Property<int>("Id");
            b.Property<string>("Status"); // dodane przez Dewelopera A
            b.Property<string>("DiscountCode"); // dodane przez Dewelopera B - KONFLIKT MERGE
        });
    }
}

Praktyczne rozwiązanie konfliktu

Krok 1: Po merge/rebase, jeśli jest konflikt w ModelSnapshot.cs - NIE próbuj ręcznie scalać tego pliku (jest generowany, ręczna edycja jest bardzo podatna na błędy).

Krok 2: Usuń lokalnie migracje, które jeszcze nie trafiły do bazy produkcyjnej/współdzielonej:

dotnet ef migrations remove  # usuwa OSTATNIĄ migrację (jeśli jeszcze nie zaaplikowana)

Krok 3: Wygeneruj migrację na nowo, na podstawie już scalonego modelu (zawierającego zmiany OBU deweloperów):

dotnet ef migrations add AddOrderStatusAndDiscountCode

Teraz EF Core generuje jedną, spójną migrację, bazującą na modelu zawierającym zmiany obu osób naraz - ModelSnapshot.cs jest odtwarzany bez konfliktu, bo to nowy, czysty plik po merge.

Zasada zespołowa - komunikacja przed migracją

Praktyczna rekomendacja, którą wiele zespołów stosuje: zanim wygenerujesz migrację, pociągnij (git pull) najnowsze zmiany z głównej gałęzi, żeby Twoja migracja bazowała na najświeższym modelu, a nie na przestarzałej wersji z rana.

Kolejność stosowania migracji - __EFMigrationsHistory

EF Core śledzi, które migracje zostały już zastosowane do konkretnej bazy, w specjalnej tabeli:

SELECT * FROM __EFMigrationsHistory ORDER BY MigrationId;

Jeśli dwie migracje z różnych brancherów mają kolidujące nazwy plików/timestampy, dotnet ef database update może próbować zastosować je w nieoczekiwanej kolejności - stąd zasada "usuń niezaaplikowaną migrację i wygeneruj ją na nowo po scaleniu kodu" jest bezpieczniejsza niż próba ręcznego scalania.

Migracje "puste" (data seeding, operacje niereprezentowane w modelu)

Czasem potrzebujesz migracji, która nie zmienia struktury tabel, tylko np. wypełnia dane:

dotnet ef migrations add SeedDefaultStatuses --  # pusta migracja
protected override void Up(MigrationBuilder migrationBuilder)
{
    migrationBuilder.InsertData(
        table: "OrderStatuses",
        columns: new[] { "Id", "Name" },
        values: new object[] { 1, "Pending" });
}

Rozdzielenie środowisk - dotnet ef database update w CI/CD

W praktyce zespołowej migracje nie są stosowane ręcznie na produkcji przez developera - typowy pipeline CI/CD:

# Fragment pipeline (pseudo-YAML)
steps:
  - run: dotnet ef database update --connection "$PROD_CONNECTION_STRING"
    # stosowane AUTOMATYCZNIE przy deploy, po code review i testach

To minimalizuje ryzyko "zapomniałem zaktualizować bazę produkcyjną" albo zastosowania migracji w złym środowisku przez przypadek.

Podsumowanie - checklist dla pracy zespołowej

  1. Zawsze git pull najnowszy model przed wygenerowaniem nowej migracji
  2. Konflikt w ModelSnapshot.cs? Usuń niezaaplikowaną lokalną migrację, wygeneruj ponownie po merge
  3. Nigdy nie edytuj ręcznie wygenerowanych plików migracji/snapshotu
  4. Migracje stosowane automatycznie przez CI/CD, nie ręcznie na produkcji
  5. Dla danych seedowanych używaj dedykowanych, "pustych" migracji z InsertData
Postaw mi kawę