Skip to content
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 4 commits into from
Mar 8, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 }
);
},
};
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);
Copy link
Member

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:

  • Collections that don't have filters
  • Collections that have filters and don't have nested items
  • Collections that have filters with nested items and no _id present in there.

Copy link
Contributor Author

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

});

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');
});
});
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',
},
],
},
],
},
],
};