feat: add withAll and withAllRecursive methods (#94)

Co-authored-by: Cue <[email protected]>

Author: M3psipax

src/query/Query.ts

@@ -179,6 +179,30 @@ export class Query<M extends Model = Model> {
     return this
   }
 
+  /**
+   * Set to eager load all top-level relationships. Constraint is set for all relationships.
+   */
+  withAll(callback: EagerLoadConstraint = () => {}): Query<M> {
+    const fields = this.model.$fields()
+
+    for (const name in fields) {
+      fields[name] instanceof Relation && this.with(name, callback)
+    }
+
+    return this
+  }
+
+  /**
+   * Set to eager load all relationships recursively.
+   */
+  withAllRecursive(depth: number = 3): Query<M> {
+    this.withAll((query) => {
+      depth > 0 && query.withAllRecursive(depth - 1)
+    })
+
+    return this
+  }
+
   /**
    * Get raw elements from the store.
    */

src/repository/Repository.ts

@@ -147,6 +147,20 @@ export class Repository<M extends Model = Model> {
     return this.query().with(name, callback)
   }
 
+  /**
+   * Set to eager load all top-level relationships. Constraint is set for all relationships.
+   */
+  withAll(callback?: EagerLoadConstraint): Query<M> {
+    return this.query().withAll(callback)
+  }
+
+  /**
+   * Set to eager load all top-level relationships. Constraint is set for all relationships.
+   */
+  withAllRecursive(depth?: number): Query<M> {
+    return this.query().withAllRecursive(depth)
+  }
+
   /**
    * Get all models from the store.
    */

test/feature/relations/eager_loads/eager_loads_all.spec.ts

@@ -0,0 +1,66 @@
+import {
+  assertInstanceOf,
+  assertModel,
+  createStore,
+  fillState
+} from 'test/Helpers'
+import { Model, Attr, Str, HasMany, BelongsTo } from '@/index'
+
+describe('feature/relations/eager_loads_all', () => {
+  class User extends Model {
+    static entity = 'users'
+
+    @Attr() id!: number
+    @Str('') name!: string
+  }
+
+  class Post extends Model {
+    static entity = 'posts'
+
+    @Attr() id!: number
+    @Attr() userId!: number
+    @Str('') title!: string
+
+    @BelongsTo(() => User, 'userId')
+    author!: User | null
+
+    @HasMany(() => Comment, 'postId')
+    comments!: Comment[]
+  }
+
+  class Comment extends Model {
+    static entity = 'comments'
+
+    @Attr() id!: number
+    @Attr() postId!: number
+    @Str('') content!: string
+  }
+
+  it('eager loads all top level relations', () => {
+    const store = createStore()
+
+    fillState(store, {
+      users: {
+        1: { id: 1, name: 'John Doe' }
+      },
+      posts: {
+        1: { id: 1, userId: 1, title: 'Title 01' }
+      },
+      comments: {
+        1: { id: 1, postId: 1, content: 'Content 01' }
+      }
+    })
+
+    const post = store.$repo(Post).withAll().first()!
+
+    expect(post.author).toBeInstanceOf(User)
+    assertInstanceOf(post.comments, Comment)
+    assertModel(post, {
+      id: 1,
+      userId: 1,
+      title: 'Title 01',
+      author: { id: 1, name: 'John Doe' },
+      comments: [{ id: 1, postId: 1, content: 'Content 01' }]
+    })
+  })
+})

test/feature/relations/eager_loads/eager_loads_recursive.spec.ts

@@ -0,0 +1,69 @@
+import { assertModel, createStore, fillState } from 'test/Helpers'
+import { Model, Attr, Str, BelongsTo, HasOne } from '@/index'
+
+describe('feature/relations/eager_loads_recursive', () => {
+  class User extends Model {
+    static entity = 'users'
+
+    @Attr() id!: number
+    @Str('') name!: string
+
+    @HasOne(() => Phone, 'userId')
+    phone!: Phone
+  }
+
+  class Phone extends Model {
+    static entity = 'phones'
+
+    @Attr() id!: number
+    @Attr() userId!: number
+    @Str('') number!: string
+
+    @BelongsTo(() => User, 'userId')
+    user!: User
+  }
+
+  it('eager loads all relations recursively', () => {
+    const store = createStore()
+
+    fillState(store, {
+      users: {
+        1: { id: 1, name: 'John Doe' }
+      },
+      phones: {
+        1: { id: 1, userId: 1, number: '123-4567-8912' }
+      }
+    })
+
+    const user = store.$repo(User).withAllRecursive().first()!
+
+    expect(user.phone.user).toBeInstanceOf(User)
+    expect(user.phone.user.phone).toBeInstanceOf(Phone)
+    expect(user.phone.user.phone.user).toBeInstanceOf(User)
+    assertModel(user.phone.user.phone.user, {
+      id: 1,
+      name: 'John Doe'
+    })
+  })
+
+  it('eager loads all relations with a given recursion limit', () => {
+    const store = createStore()
+
+    fillState(store, {
+      users: {
+        1: { id: 1, name: 'John Doe' }
+      },
+      phones: {
+        1: { id: 1, userId: 1, number: '123-4567-8912' }
+      }
+    })
+
+    const user = store.$repo(User).withAllRecursive(1).first()!
+
+    expect(user.phone.user).toBeInstanceOf(User)
+    assertModel(user.phone.user, {
+      id: 1,
+      name: 'John Doe'
+    })
+  })
+})