Best way to deal with migration merge conflicts?

[adlrwbr]

Hello!

Sometimes team members will modify the DB schema on separate branches, resulting in conflicting journal.json and xxxx_snapshot.json. Editing these files by hand is quite tedious. What's the best practice? Btw, I'm using drizzle-kit to generate migration files.

[lxia1220]

imo simplest way is create migration file in merge CI

https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#managing-a-merge-queue

btw there are so many possibilities with migration merge conflicts, customize it for your team environment

[adlrwbr]

@lxia1220 is right that there are many possible solutions, but for those who find this on Google, here's a manual fix I often perform:

Situation: You merge dev into your PR branch, but both your branch (HEAD) and dev created migrations numbered 0007.

Conflict:

Changes to be committed:
        new file:   db/migrations/0007_daffy_morg.sql
Unmerged paths:
  (use "git add <file>..." to mark resolution)
        both added:      db/migrations/meta/0007_snapshot.json
        both modified:   db/migrations/meta/_journal.json

Typical Solution: Regenerate your migrations

Steps:

1. Visit xxxx_snapshot.json and delete YOUR changes (HEAD). Accept changes from dev.
2. Visit _journal.json and again, delete YOUR changes (HEAD). Accept changes from dev. Note the deleted "tag".
3. Remove your migration file referenced by the now-deleted "tag".
4. npm run drizzle-kit generate

[alanhamlett]

Currently my process to solve this:

1. abort the rebase from conflicting main branch
2. revert my local changes to db/migrations/ folder
3. stash my local branch code changes
4. pull main branch & rebase changes into my local dev branch without conflicts this time
5. run drizzle-kit push to make my local db match main branch
6. un-stash my local code changes
7. run drizzle-kit generate to re-generate my local schema migration
8. run drizzle-kit migrate to apply my local schema changes
9. create a PR to get my changes into main branch
10. if anyone merges schema changes to main before my PR is merged, repeat steps above starting at 1

Depending on your team size and PR frequency, you might have to do this multiple times.