Matching arrays returned from sequelize with Jest - arrays

Question

I'm testing a Node.js application, in which addresses are stored in a Postgresql database using Sequelize. In order to test the 'getAll()' function, I wrote a test that does the following (see below):
1. create two addresses, and store them ('create' function of Sequelize)
2. call the getAll() function
3. (try to) assert that the returned array contains the created addresses, using expect.arrayContaining()
I tested the same setup without Sequelize in between (adding numbers/objects to an array and match a subset in the same way I did here), which works fine.
it("Should get all addresses", async () => {
const address_1 = await Address.create({
street: VALID_STREET,
number: VALID_NUMBER,
city: VALID_CITY,
country: VALID_COUNTRY
});
const address_2 = await Address.create({
street: "street 2",
number: "2",
city: "City 2",
country: "Country 2"
});
const allAddresses = await controller._getAll();
expect(allAddresses).toEqual(
expect.arrayContaining([address_1, address_2])
);
});
I expected the test to succeed, but it fails, giving me this errormessage that contains the two exact same arrays, except for the 'ArrayContaining' part.
expect(received).toEqual(expected) // deep equality
Expected: ArrayContaining [{"city": "A city", "country": "Belgium", "createdAt": 2019-08-21T14:05:23.063Z, "fullAddress": "valid street 123 A, A city, Belgium", "id": 296, "number": "123 A", "postalCode": null, "street": "valid street", "updatedAt": 2019-08-21T14:05:23.063Z}, {"city": "City 2", "country": "Country 2", "createdAt": 2019-08-21T14:05:23.066Z, "fullAddress": "street 2 2, City 2, Country 2", "id": 297, "number": "2", "postalCode": null, "street": "street 2", "updatedAt": 2019-08-21T14:05:23.066Z}]
Received: [{"city": "A city", "country": "Belgium", "createdAt": 2019-08-21T14:05:23.063Z, "fullAddress": "valid street 123 A, A city, Belgium", "id": 296, "number": "123 A", "postalCode": null, "street": "valid street", "updatedAt": 2019-08-21T14:05:23.063Z}, {"city": "City 2", "country": "Country 2", "createdAt": 2019-08-21T14:05:23.066Z, "fullAddress": "street 2 2, City 2, Country 2", "id": 297, "number": "2", "postalCode": null, "street": "street 2", "updatedAt": 2019-08-21T14:05:23.066Z}]
So, does anyone know how to fix this? Is this a Sequelize problem, or am I missing something here?
EDIT:
For people running into the same problem, I do have a workaround, which is to use the array.some() function, but this seems to be too verbose and I feel like the expect.arrayContaining() function should be used for this purpose.
expect(
allAddresses.some(address => {
address.id === address_2.id &&
address.street === address_2.street &&
address.number === address_2.number &&
address.city === address_2.city &&
address.country === address_2.country;
})
);

Answer 1

I think it's not a good idea to compare the whole Models (lot's of stuff you don't care about in there). Try to compare the dataValues instead. Make sure you don't use raw: true in your findAll call because then you don't have the dataValues property.
const allAddresses = await controller._getAll();
const addressesPlain = allAddresses.map(address => address.dataValues);
expect([address_1.dataValues, address_2.dataValues]).toEqual(addressesPlain);
If you're interested in the small test case I wrote: https://pastr.io/view/QKNmua

Answer 2

Another way to do it using arrayContaining matcher, not any better just a little more explicit IMO:
const allAddresses = await controller._getAll();
const addressesPlain = allAddresses.map(address => address.dataValues);
expect(addressesPlain).toEqual(expect.arrayContaining([address_1.dataValues, address_2.dataValues]);
I've found that searching for a single item in an array to be a little confusing using jest's matchers as well so for just checking that a single object is in an array this has been useful:
expect(addressesPlain).toContainEqual(address_1.dataValues)
toContainEqual, as their docs state, "recursively checks the equality of all fields, rather than checking for object identity." while toContain does check for objectIdentity which will fail with the above check.