fix(pinia-orm): Hooks should update cache & hydration (#1113)

- Add working shared hydration cache
- Hooks which are updating data are rehydrated to use casts

Author: CodeDredd

packages/pinia-orm/src/cache/SharedHydratedDatakCache.ts

@@ -1,3 +1,3 @@
 import type { Model } from '../model/Model'
 
-export const cache = <M extends Model = Model>() => new Map<string, M>()
+export const cache = new Map<string, Model>()

packages/pinia-orm/src/model/Model.ts

@@ -800,11 +800,13 @@ export class Model {
    * Get primary key value for the model. If the model has the composite key,
    * it will return an array of ids.
    */
-  $getKey(record?: Element): string | number | (string | number)[] | null {
+  $getKey(record?: Element, concatCompositeKey = false): string | number | (string | number)[] | null {
     record = record ?? this
 
-    if (this.$hasCompositeKey())
-      return this.$getCompositeKey(record)
+    if (this.$hasCompositeKey()) {
+      const compositeKey = this.$getCompositeKey(record)
+      return concatCompositeKey ? compositeKey?.join('') ?? null : compositeKey
+    }
 
     const id = record[this.$getKeyName() as string]
 

packages/pinia-orm/src/query/Query.ts

@@ -339,6 +339,7 @@ export class Query<M extends Model = Model> {
    * Set the relationships that should be eager loaded.
    */
   with(name: string, callback: EagerLoadConstraint = () => {}): this {
+    this.getNewHydrated = true
     this.eagerLoad[name] = callback
 
     return this
@@ -645,8 +646,9 @@ export class Query<M extends Model = Model> {
    * Revive single model from the given schema.
    */
   reviveOne(schema: Element): Item<M> {
-    const id = this.model.$getIndexId(schema)
+    this.getNewHydrated = false
 
+    const id = this.model.$getIndexId(schema)
     const item = this.commit('get')[id] ?? null
 
     if (!item)
@@ -711,13 +713,17 @@ export class Query<M extends Model = Model> {
    * Create and persist model with default values.
    */
   new(persist = true): M | null {
-    const model = this.hydrate({}, { operation: persist ? 'get' : 'set' })
+    let model = this.hydrate({}, { operation: persist ? 'set' : 'get' })
     const isCreating = model.$self().creating(model)
     const isSaving = model.$self().saving(model)
     if (isCreating === false || isSaving === false)
       return null
 
+    if (model.$isDirty())
+      model = this.hydrate(model.$getAttributes(), { operation: persist ? 'set' : 'get' })
+
     if (persist) {
+      this.hydratedDataCache.set(this.model.$entity() + model.$getKey(undefined, true), this.hydrate(model.$getAttributes(), { operation: 'get' }))
       model.$self().created(model)
       model.$self().saved(model)
       this.commit('insert', this.compile(model))
@@ -780,7 +786,7 @@ export class Query<M extends Model = Model> {
     for (const id in elements) {
       const record = elements[id]
       const existing = currentData[id]
-      const model = existing
+      let model = existing
         ? this.hydrate({ ...existing, ...record }, { operation: 'set', action: 'update' })
         : this.hydrate(record, { operation: 'set', action: 'save' })
 
@@ -789,6 +795,9 @@ export class Query<M extends Model = Model> {
       if (isSaving === false || isUpdatingOrCreating === false)
         continue
 
+      if (model.$isDirty())
+        model = this.hydrate(model.$getAttributes(), { operation: 'set', action: existing ? 'update' : 'save' })
+
       afterSavingHooks.push(() => model.$self().saved(model, record))
       afterSavingHooks.push(() => existing ? model.$self().updated(model, record) : model.$self().created(model, record))
       newData[id] = model.$getAttributes()
@@ -1017,8 +1026,7 @@ export class Query<M extends Model = Model> {
    * an update event trigger in vue if the object is used.
    */
   protected getHydratedModel(record: Element, options?: ModelOptions): M {
-    const modelKey = this.model.$getKeyName()
-    const id = (!isArray(modelKey) ? [modelKey] : modelKey).map(key => record[key]).join('')
+    const id = this.model.$getKey(record, true)
     const savedHydratedModel = id && this.hydratedDataCache.get(this.model.$entity() + id)
 
     if (

packages/pinia-orm/src/repository/Repository.ts

@@ -66,7 +66,7 @@ export class Repository<M extends Model = Model> {
   constructor(database: Database, pinia?: Pinia) {
     this.database = database
     this.pinia = pinia
-    this.hydratedDataCache = hydratedDataCache<M>()
+    this.hydratedDataCache = hydratedDataCache as Map<string, M>
   }
 
   /**

packages/pinia-orm/tests/feature/hooks/creating.spec.ts

@@ -49,6 +49,7 @@ describe('feature/hooks/creating', () => {
       { id: 2, name: 'John Doe 2', age: 40 },
     ])
 
+    expect(useRepo(User).hydratedDataCache.size).toBe(2)
     expect(creatingMethod).toHaveBeenCalledTimes(2)
     expect(updatingMethod).toHaveBeenCalledTimes(0)
     expect(savingMethod).toHaveBeenCalledTimes(2)

packages/pinia-orm/tests/feature/hooks/retrieved.spec.ts

@@ -1,4 +1,4 @@
-import { describe, expect, it, vi } from 'vitest'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
 
 import { Model, useRepo } from '../../../src'
 import { Num, Str } from '../../../src/decorators'
@@ -7,6 +7,10 @@ import {
 } from '../../helpers'
 
 describe('feature/hooks/retrieved', () => {
+  beforeEach(() => {
+    Model.clearRegistries()
+  })
+
   it('is not triggered when trying to retrieve a non existing record', () => {
     class User extends Model {
       static entity = 'users'
@@ -42,7 +46,7 @@ describe('feature/hooks/retrieved', () => {
       @Num(0) age!: number
 
       static retrieved() {
-        // Doing retrieved stuff
+        console.warn('retrieved')
       }
     }
 
@@ -69,7 +73,7 @@ describe('feature/hooks/retrieved', () => {
       @Num(0) age!: number
 
       static retrieved() {
-        // Doing retrieved stuff
+        console.warn('retrieved')
       }
     }
 

packages/pinia-orm/tests/feature/repository/new.spec.ts

@@ -1,8 +1,9 @@
 import { describe, expect, it } from 'vitest'
 
 import { Model, useRepo } from '../../../src'
-import { Attr, Bool, Num, Str, Uid } from '../../../src/decorators'
+import { Attr, Bool, Cast, Num, Str, Uid } from '../../../src/decorators'
 import { assertState, mockUid } from '../../helpers'
+import { ArrayCast } from '../../../src/model/casts/ArrayCast'
 
 describe('feature/repository/new', () => {
   it('inserts with a models default values', () => {
@@ -28,6 +29,37 @@ describe('feature/repository/new', () => {
     })
   })
 
+  it('it trigger casts on hooks', () => {
+    class User extends Model {
+      static entity = 'users'
+
+      @Uid() declare id: string
+
+      @Cast(() => ArrayCast) @Attr('{}') declare items: string[]
+      @Str('John Doe') declare name: string
+      @Num(21) declare age: number
+      @Bool(true) declare active: boolean
+
+      static creating(model: User) {
+        model.items = ['t', 's']
+      }
+    }
+
+    mockUid(['uid1'])
+
+    const userRepo = useRepo(User)
+
+    userRepo.new()
+
+    assertState({
+      users: {
+        uid1: { id: 'uid1', name: 'John Doe', items: '["t","s"]', age: 21, active: true },
+      },
+    })
+
+    expect(userRepo.hydratedDataCache.get('usersuid1')?.items).toBeInstanceOf(Array)
+  })
+
   it('throws if a primary key is not capable of being generated', () => {
     class User extends Model {
       static entity = 'users'

packages/pinia-orm/tests/setup.ts

@@ -2,7 +2,7 @@ import { createPinia, setActivePinia } from 'pinia'
 import { beforeAll, beforeEach, vi } from 'vitest'
 import { Vue2, createApp, install, isVue2 } from 'vue-demi'
 
-import { Model, createORM } from '../src'
+import { Model, createORM, useRepo } from '../src'
 
 vi.mock('nanoid/non-secure', () => ({
   nanoid: vi.fn(),
@@ -36,4 +36,5 @@ beforeEach(() => {
   app.use(pinia)
   setActivePinia(pinia)
   Model.clearBootedModels()
+  useRepo(Model).hydratedDataCache.clear()
 })