Method refresh

packages/core/src/EntityManager.ts:970–1020

* Refreshes the persistent state of an entity from the database, overriding any local changes that have not yet been * persisted. Returns the same entity instance (same object reference), but re-hydrated. If the entity is no longer * in database, the method returns `null`.

(
    entity: Entity,
    options: FindOneOptions<Entity, Hint, Fields, Excludes> = {},
  )

   * in database, the method returns `null`.
   */
  async refresh<
    Entity extends object,
    Naked extends FromEntityType<Entity> = FromEntityType<Entity>,
    Hint extends string = never,
    Fields extends string = never,
    Excludes extends string = never,
  >(
    entity: Entity,
    options: FindOneOptions<Entity, Hint, Fields, Excludes> = {},
  ): Promise<MergeLoaded<Entity, Naked, Hint, Fields, Excludes, true> | null> {
    const fork = this.fork({ keepTransactionContext: true });
    const wrapped = helper(entity);
    const reloaded = await fork.findOne(wrapped.__meta.class, entity, {
      schema: wrapped.__schema,
      ...options,
      flushMode: FlushMode.COMMIT,
    });

    const em = this.getContext();

    if (!reloaded) {
      em.#unitOfWork.unsetIdentity(entity);
      return null;
    }

    let found = false;

    for (const e of fork.#unitOfWork.getIdentityMap()) {
      const ref = em.getReference(e.constructor, helper(e).getPrimaryKey());
      const data = helper(e).serialize({ ignoreSerializers: true, includeHidden: true, convertCustomTypes: false });
      em.config
        .getHydrator(this.metadata)
        .hydrate(ref, helper(ref).__meta, data, em.#entityFactory, 'full', false, false);
      Utils.merge(helper(ref).__originalEntityData, this.#comparator.prepareEntity(e as Entity));
      found ||= ref === entity;
    }

    if (!found) {
      const data = helper(reloaded).serialize({
        ignoreSerializers: true,
        includeHidden: true,
        convertCustomTypes: false,
      }) as object;
      em.config
        .getHydrator(this.metadata)
        .hydrate(entity, wrapped.__meta, data, em.#entityFactory, 'full', false, false);
      Utils.merge(wrapped.__originalEntityData, this.#comparator.prepareEntity(reloaded as Entity));
    }

    return entity as any;
  }

  /**
   * Finds first entity matching your `where` query.