feat: add support for recursively merging attributes from factories

adonis-typings/factory.ts

@@ -150,6 +150,11 @@ declare module '@ioc:Adonis/Lucid/Factory' {
      */
     relation: RelationshipsContract
 
+    /**
+     * Merge attributes with the relationship and its children
+     */
+    merge(attributes: any): this
+
     /**
      * Define custom pivot attributes for many to many
      * relationship
@@ -236,6 +241,12 @@ declare module '@ioc:Adonis/Lucid/Factory' {
      */
     merge(attributes: OneOrMany<ExtractFactoryAttributes<FactoryModel>>): this
 
+    /**
+     * Merge custom set of attributes with the correct factory builder
+     * model and all of its relationships as well
+     */
+    mergeRecursive(attributes: any): this
+
     /**
      * Define custom runtime context. This method is usually called by
      * the relationships to ensure a single context is used by the

src/Factory/FactoryBuilder.ts

@@ -61,6 +61,11 @@ export class FactoryBuilder implements FactoryBuilderContract<FactoryModelContra
    */
   private attributes: any = {}
 
+  /**
+   * Custom attributes to pass to relationship merge methods
+   */
+  private recursiveAttributes: any = {}
+
   /**
    * States to apply. One state can be applied only once and hence
    * a set is used.
@@ -114,7 +119,15 @@ export class FactoryBuilder implements FactoryBuilderContract<FactoryModelContra
    * Returns attributes to merge for a given index
    */
   private getMergeAttributes(index: number) {
-    return Array.isArray(this.attributes) ? this.attributes[index] : this.attributes
+    const attributes = Array.isArray(this.attributes) ? this.attributes[index] : this.attributes
+    const recursiveAttributes = Array.isArray(this.recursiveAttributes)
+      ? this.recursiveAttributes[index]
+      : this.recursiveAttributes
+
+    return {
+      ...recursiveAttributes,
+      ...attributes,
+    }
   }
 
   /**
@@ -200,12 +213,18 @@ export class FactoryBuilder implements FactoryBuilderContract<FactoryModelContra
   private async makeRelations(modelInstance: LucidRow, ctx: FactoryContextContract) {
     for (let { name, count, callback } of this.withBelongsToRelations) {
       const relation = this.factory.getRelation(name)
-      await relation.useCtx(ctx).make(modelInstance, callback, count)
+      await relation
+        .useCtx(ctx)
+        .merge(this.recursiveAttributes)
+        .make(modelInstance, callback, count)
     }
 
     for (let { name, count, callback } of this.withRelations) {
       const relation = this.factory.getRelation(name)
-      await relation.useCtx(ctx).make(modelInstance, callback, count)
+      await relation
+        .useCtx(ctx)
+        .merge(this.recursiveAttributes)
+        .make(modelInstance, callback, count)
     }
   }
 
@@ -221,7 +240,10 @@ export class FactoryBuilder implements FactoryBuilderContract<FactoryModelContra
 
     for (let { name, count, callback } of relationships) {
       const relation = this.factory.getRelation(name)
-      await relation.useCtx(ctx).create(modelInstance, callback, count)
+      await relation
+        .useCtx(ctx)
+        .merge(this.recursiveAttributes)
+        .create(modelInstance, callback, count)
     }
   }
 
@@ -329,6 +351,15 @@ export class FactoryBuilder implements FactoryBuilderContract<FactoryModelContra
     return this
   }
 
+  /**
+   * Merge custom set of attributes with the correct factory builder
+   * model and all of its relationships as well
+   */
+  public mergeRecursive(attributes: any): this {
+    this.recursiveAttributes = attributes
+    return this
+  }
+
   /**
    * Define pivot attributes when persisting a many to many
    * relationship. Results in a noop, when not called

src/Factory/FactoryModel.ts

@@ -235,6 +235,9 @@ export class FactoryModel<Model extends LucidModel> implements FactoryModelContr
       merge(attributes) {
         return this.query().merge(attributes)
       },
+      mergeRecursive(attributes) {
+        return this.query().mergeRecursive(attributes)
+      },
       useCtx(ctx) {
         return this.query().useCtx(ctx)
       },

src/Factory/Relations/Base.ts

@@ -21,6 +21,7 @@ import {
  */
 export abstract class BaseRelation {
   protected ctx: FactoryContextContract
+  private attributes: any = {}
 
   constructor(
     private factory: () => FactoryBuilderQueryContract<FactoryModelContract<LucidModel>>
@@ -35,10 +36,18 @@ export abstract class BaseRelation {
       callback(builder)
     }
 
-    builder.useCtx(this.ctx)
+    builder.useCtx(this.ctx).mergeRecursive(this.attributes)
     return builder
   }
 
+  /**
+   * Merge attributes with the relationship and its children
+   */
+  public merge(attributes: any) {
+    this.attributes = attributes
+    return this
+  }
+
   /**
    * Use custom ctx. This must always be called by the factory, otherwise
    * `make` and `create` calls will fail.

test-helpers/index.ts

@@ -157,6 +157,7 @@ export async function setup(destroyDb: boolean = true) {
     await db.schema.createTable('users', (table) => {
       table.increments()
       table.integer('country_id')
+      table.integer('tenant_id').nullable()
       table.string('username').unique()
       table.string('email').unique()
       table.integer('points').defaultTo(0)
@@ -232,6 +233,7 @@ export async function setup(destroyDb: boolean = true) {
     await db.schema.createTable('posts', (table) => {
       table.increments()
       table.integer('user_id')
+      table.integer('tenant_id').nullable()
       table.string('title').notNullable()
       table.boolean('is_published').defaultTo(false)
       table.timestamps()
@@ -242,6 +244,7 @@ export async function setup(destroyDb: boolean = true) {
   if (!hasComments) {
     await db.schema.createTable('comments', (table) => {
       table.increments()
+      table.integer('tenant_id').nullable()
       table.integer('post_id')
       table.string('body')
       table.timestamps()