neoris/openvidu-meet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

backend: add testing guidelines to migrations README

Browse Source
This commit is contained in:
juancarmore 2026-02-23 13:49:32 +01:00
parent a25569b4f7
commit f1b9f1c6e3
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
meet-ce/backend/src/migrations/README.md
View File

@ -143,6 +143,23 @@ export const roomMigrations: SchemaMigrationMap<MeetRoomDocument> = new Map([
3. Verify documents in MongoDB have correct version
4. Test API to ensure new field appears correctly
### Step 7: Update Migration Tests
Every schema migration must be covered by both unit and integration tests:
1. **Unit tests (one per transform function)**
- Add/update a unit test for each migration transform (e.g., `v2 -> v3`).
- Validate only that transform logic in isolation (no DB startup required).
2. **Integration tests (legacy -> current version)**
- Add/update one integration test case per supported legacy schema version.
- Insert legacy documents directly in MongoDB, run `runMigrations()`, and assert final document shape matches the **current** schema version.
- Do not assert intermediate schema states in integration tests.
3. **When current version increases**
- Keep previous legacy version cases and add the new required ones.
- Update shared final-state assertions/helpers to the new current schema.
---
## Migration Tracking