Seeding relationships elegantly

[maximelebastard]

Hi guys

I'm trying to write a simple seeder for a common Organization > Team > User pattern and I wonder what is the more elegant way to handle relationships.

For most cases I don't want to include relationships into factories as it would make factories too tied to the seeding logic and kind of pointless imo

But it looks tricky to define relationships after having created the model because of transactions.

This would be the best to me but it does not work

import factory from '@adonisjs/lucid/factories'
import Organization from '#models/organization'
import { UserFactory } from './user_factory.js'
import { TeamFactory } from './team_factory.js'

export const OrgWithContentFactory = factory
  .define(Organization, async ({ faker }) => {
    const org = await Organization.create({
      label: faker.company.name(),
    })
    const users = await org.related('users').createMany(await UserFactory.createMany(3))
    const teams = await org.related('teams').createMany(await TeamFactory.createMany(3))

    for (const user of users) {
      await user.related('teams').attach([faker.helpers.arrayElement(users).id])
    }

    return org
  })
  .build()

is getting

/* ... */
  knex:query ROLLBACK trx13 +2ms
  knex:bindings undefined trx13 +2ms
  knex:tx trx13: releasing connection +1ms
  knex:client releasing connection to pool: __knexUid1 +2ms
  knex:tx trx13: Transaction completed: ROLLBACK +0ms
  knex:tx trx13 error running transaction query +0ms
❯ error     database/seeders/organizations_users_team_seeder
  Transaction query already complete, run with DEBUG=knex:tx for more info

So I refetch the model everytime, but it looks odd

import factory from '@adonisjs/lucid/factories'
import Organization from '#models/organization'
import { UserFactory } from './user_factory.js'
import { TeamFactory } from './team_factory.js'
import User from '#models/user'

export const OrgWithContentFactory = factory
  .define(Organization, async ({ faker }) => {
    const org = await Organization.create({
      label: faker.company.name(),
    })
    const users = await org.related('users').createMany(await UserFactory.createMany(3))
    const teams = await org.related('teams').createMany(await TeamFactory.createMany(3))

    for (const user of users) {
      const u = await User.findOrFail(user.id)
      await u.related('teams').attach([faker.helpers.arrayElement(users).id])
    }

    return org
  })
  .build()

Do you have any opinion about this ?

[maximelebastard]

For any passers-by, my transaction issue was due to a wrong usage of the Factories. I created a model instead of returning arguments, which messes up the transactions.

This code is wrong

import factory from '@adonisjs/lucid/factories'
import User from '#models/user'

export const UserFactory = factory
  .define(User, async ({ faker }) => {
    return User.create({
      fullName: faker.person.fullName(),
      email: faker.internet.email(),
      password: 'password',
    })
  })
  .build()

but these two are ok and working fine

export const UserFactory = factory
  .define(User, async ({ faker }) => ({
    fullName: faker.person.fullName(),
    email: faker.internet.email(),
    password: 'password',
  }))
  .build()


export const UserFactory = factory
  .define(User, () => { })
  .newUp((attributes) => {
    return User.create({
      fullName: faker.person.fullName(),
      email: faker.internet.email(),
      password: 'password',
    })
  })