feat: add sharded migration helpers MONGOSH-2139 #2542
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds migration management functionality to the MongoDB shell API by implementing sh.enableMigrations() and sh.disableMigrations() helper methods, and enhancing sh.status() to display migration status for collections.
- Adds two new helper methods that internally use the
setAllowMigrationsadmin command - Enhances
sh.status()to include anallowMigrationsfield for each collection - Includes comprehensive test coverage for both unit and integration scenarios
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/shell-api/src/shard.ts | Implements the core migration helper methods and private _setAllowMigrations function |
| packages/shell-api/src/shard.spec.ts | Adds comprehensive unit and integration tests for the new migration functionality |
| packages/shell-api/src/helpers.ts | Enhances getPrintableShardStatus to include allowMigrations field in collection output |
| packages/i18n/src/locales/en_US.ts | Adds documentation entries for the new migration helper methods |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| } | ||
|
|
||
| collRes.allowMigrations = | ||
| coll.permitMigrations !== false && coll.allowMigrations !== false; |
There was a problem hiding this comment.
The logic for determining allowMigrations uses both permitMigrations and allowMigrations fields with double negation. This could be simplified and made more explicit by using positive logic: (coll.permitMigrations !== false) && (coll.allowMigrations !== false) or better yet, explicit boolean conversion with default values to make the intent clearer.
| coll.permitMigrations !== false && coll.allowMigrations !== false; | |
| (coll.permitMigrations ?? true) && (coll.allowMigrations ?? true); |
Copilot uses AI. Check for mistakes.
|
The test failures seem to be pre-existing, so going to go ahead and merge this. |
This resolves MONGOSH-2139 by adding an extra field -
allowMigrationsfor each collection insh.status(). Additionally, adds two helpers -sh.enableMigrations(ns)andsh.disableMigrations(ns)that internally call thesetAllowMigrationsadmin command.