asyncPopulate and custom object types

Description: I my application I use js-money package which allows to manage money easily. So, when I try to create a factory and Money object as factory attribute it returns me a plain object instead of Money

Steps

1. Define a factory
2. Invoke factory.build and pass in balance property Money instance
3. Output result.balance.constructor

Actual result Shows Object and all Money methods are lost

Expected result: Shows Money

Reproduction code:

const { factory, ObjectAdapter } = require('factory-girl');
const Money = require('js-money');

factory.setAdapter(new ObjectAdapter());

factory.define('Account', Object, {
  name: factory.seq('name'),
  balance: new Money(10, Money.USD)
});

async function run() {
  const account = await factory.build('Account');
  console.log(account.balance.constructor);
}

run();

Workaround:

The workaround is to use a function for custom object types:

factory.define('Account', Object, {
  name: factory.seq('name'),
  balance: () => new Money(10, Money.USD)
});

But this increases boilerplate and may become an issue when you want to pass result of one factory as properties into another factory.

Possible solution:

1. Copy only plain objects, constructor of which is Object
2. Allow to pass an option/hook in FactoryGirl class that makes a decision which objects may be copied

[simonexmachina]

I’ve pushed v5.0.0-beta.1, which doesn’t traverse into objects unless they’re instances of Object, so Dates and other types are preserved. Please give this version a go and let me know if this causes any other issues. It’s likely to cause some edge cases for a few people, but a few people have encountered issues with this, and I think the new behaviour is less unexpected.

[oliviertassinari]

I have been upgrading our test suite to v5.0.0-beta.1 in order to fix the date issue. It’s working great 👍.