migration-script-runner / msr-core / 0f77c825-49cc-4295-bac5-acf672508335

100%

Build Type

push

circleci

Committed by Vova Lavrynovych

Commit Message

 #26: Add beforeMigrate file-based setup script with enhanced logging

Added support for beforeMigrate.ts/js file that executes before migration scanning. This allows users to load production snapshots, create extensions, or perform environment-specific setup before migrations run.

Core Implementation:
- Added config.beforeMigrateName (configurable, default: 'beforeMigrate')
- Created IMigrationService.getBeforeMigrateScript() method
- Implemented MigrationScriptExecutor.executeBeforeMigrate() with detailed logging
- Executes BEFORE migration scanning (allows database reset/erase)
- Uses IRunnableScript interface but NOT saved to schema version table
- Can be disabled by setting config.beforeMigrateName = null

Enhanced Logging:
- Detection phase logging with file path
- Execution start/completion with duration timing
- Conditional result logging (only when result exists)
- Clear "not found" message when script doesn't exist

Tests:
- Added 8 comprehensive beforeMigrate tests (353 tests total)
- Test file existence, execution, errors, disabling, and logging
- Improved test code quality with shared TEST_MIGRATION_CONTENT constant
- Fixed test fixtures to use proper IRunnableScript interface
- Maintained 100% coverage (572 statements, 282 branches, 141 functions, 532 lines)

Documentation:
- Updated getting-started.md with beforeMigrate examples and use cases
- Updated configuration.md with beforeMigrateName configuration details
- Updated api/index.md with new Config property and MigrationService method
- Added comprehensive section to writing-migrations.md guide
- Updated v0.2-to-v0.3.md migration guide with beforeMigrate feature

Run Details

282 of 282 branches covered (100.0%)

Branch coverage included in aggregate %.

26 of 26 new or added lines in 3 files covered. (100.0%)

531 of 531 relevant lines covered (100.0%)

988.32 hits per line