-
Notifications
You must be signed in to change notification settings - Fork 80
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds a migration to remove _id from filter items #3490
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
24 changes: 24 additions & 0 deletions
24
app/api/migrations/migrations/34-remove-_id-from-filter-items/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
export default { | ||
delta: 34, | ||
|
||
name: 'remove-_id-from-filter-items', | ||
|
||
description: 'Removed _id from filter items in settings', | ||
|
||
async up(db) { | ||
process.stdout.write(`${this.name}...\r\n`); | ||
await db.collection('settings').updateMany( | ||
{ | ||
filters: { | ||
$exists: true, | ||
$ne: [], | ||
$elemMatch: { | ||
items: { $exists: true }, | ||
}, | ||
}, | ||
}, | ||
{ $unset: { 'filters.$[].items.$[]._id': 1 } }, | ||
{ multi: true } | ||
); | ||
}, | ||
}; |
31 changes: 31 additions & 0 deletions
31
.../migrations/34-remove-_id-from-filter-items/specs/34-remove-_id-from-filter-items.spec.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
import testingDB from 'api/utils/testing_db'; | ||
import migration from '../index.js'; | ||
import fixtures from './fixtures.js'; | ||
|
||
describe('migration remove-_id-from-filter-items', () => { | ||
beforeEach(async () => { | ||
spyOn(process.stdout, 'write'); | ||
await testingDB.clearAllAndLoad(fixtures); | ||
}); | ||
|
||
afterAll(async () => { | ||
await testingDB.disconnect(); | ||
}); | ||
|
||
it('should have a delta number', () => { | ||
expect(migration.delta).toBe(34); | ||
}); | ||
|
||
it('should remove _id field from filter items', async () => { | ||
await migration.up(testingDB.mongodb); | ||
const settings = await testingDB.mongodb | ||
.collection('settings') | ||
.find({}) | ||
.toArray(); | ||
|
||
const [item1, item2, item3] = settings[0].filters[0].items; | ||
expect(item1).not.toHaveProperty('_id'); | ||
expect(item2).not.toHaveProperty('_id'); | ||
expect(item3).not.toHaveProperty('_id'); | ||
}); | ||
}); |
21 changes: 21 additions & 0 deletions
21
app/api/migrations/migrations/34-remove-_id-from-filter-items/specs/fixtures.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
export default { | ||
settings: [ | ||
{ | ||
filters: [ | ||
{ | ||
items: [ | ||
{ | ||
_id: 'id1', | ||
}, | ||
{ | ||
_id: 'id2', | ||
}, | ||
{ | ||
_id: 'id3', | ||
}, | ||
], | ||
}, | ||
], | ||
}, | ||
], | ||
}; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The migration looks good, and I believe it works as expected.
Still, I am concerned that the fixtures only show a single scenario: "A collection whose settings have filters, and those filters have nested items with _id present".
There are many other scenarios that need to be tested that they are not affected:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have added a few test cases as suggested, you can check them out when you get time