Function getLatestEntityById

apps/hash-api/src/graph/knowledge/primitive/entity.ts:192–260

(
  ...args: Parameters<GetLatestEntityByIdFunction<Properties>>
)

 *   fault
 */
export const getLatestEntityById = async <
  Properties extends TypeIdsAndPropertiesForEntity =
    TypeIdsAndPropertiesForEntity,
>(
  ...args: Parameters<GetLatestEntityByIdFunction<Properties>>
): ReturnType<GetLatestEntityByIdFunction<Properties>> => {
  const [context, authentication, { entityId }] = args;

  const [webId, entityUuid, draftId] = splitEntityId(entityId);

  const allFilter: AllFilter["all"] = [
    {
      equal: [{ path: ["uuid"] }, { parameter: entityUuid }],
    },
    {
      equal: [{ path: ["webId"] }, { parameter: webId }],
    },
    { equal: [{ path: ["archived"] }, { parameter: false }] },
  ];

  if (draftId) {
    /**
     * If the requested entityId includes a draftId, we know we're looking for a specific draft
     */
    allFilter.push({
      equal: [{ path: ["draftId"] }, { parameter: draftId }],
    });
  } else {
    /**
     * If the entityId does NOT contain a draftId, EXCLUDE any draft versions of the entity.
     * Otherwise, a request for an entityId unqualified by a draftId might return a live version
     * and one or more draft versions, which is currently an error in the function.
     *
     * We could alternatively handle this and prioritise a specific version, e.g.
     * - the live version
     * - the latest version by the time the edition was created, whether that is a draft or live
     * ...whether the prioritisation is fixed behavior or varied by parameter.
     */
    allFilter.push({
      not: { exists: { path: ["draftId"] } },
    });
  }

  const {
    entities: [entity, ...unexpectedEntities],
  } = await queryEntities<Properties>(context, authentication, {
    filter: {
      all: allFilter,
    },
    temporalAxes: currentTimeInstantTemporalAxes,
    includeDrafts: !!draftId,
    includePermissions: false,
  });

  if (unexpectedEntities.length > 0) {
    const errorMessage = `Latest entity with entityId ${entityId} returned more than one result with ids: ${unexpectedEntities
      .map((unexpectedEntity) => unexpectedEntity.metadata.recordId.entityId)
      .join(", ")}`;