BE-619: Split entity queries and entity counting

apps/hash-api/src/graph/knowledge/primitive/entity.ts

@@ -19,6 +19,7 @@ import {
   HashLinkEntity,
   queryEntities,
   queryEntitySubgraph,
+  summarizeEntities,
 } from "@local/hash-graph-sdk/entity";
 import { getActorGroupRole } from "@local/hash-graph-sdk/principal/actor-group";
 import {
@@ -58,7 +59,6 @@ import type {
 import type { Subtype } from "@local/advanced-types/subtype";
 import type {
   AllFilter,
-  CountEntitiesParams,
   DiffEntityResult,
   Filter,
   HasPermissionForEntitiesParams,
@@ -160,12 +160,6 @@ export const createEntity = async <
   return entity;
 };
 
-export const countEntities: ImpureGraphFunction<
-  CountEntitiesParams,
-  Promise<number>
-> = async ({ graphApi }, { actorId }, params) =>
-  graphApi.countEntities(actorId, params).then(({ data }) => data);
-
 type GetLatestEntityByIdFunction<
   Properties extends TypeIdsAndPropertiesForEntity =
     TypeIdsAndPropertiesForEntity,
@@ -315,15 +309,18 @@ export const canUserReadEntity: ImpureGraphFunction<
     });
   }
 
-  const count = await countEntities(context, authentication, {
+  const { count } = await summarizeEntities(context, authentication, {
     filter: {
       all: allFilter,
     },
     temporalAxes: currentTimeInstantTemporalAxes,
     includeDrafts: !!draftId || includeDrafts,
+    includeCount: true,
   });
 
-  if (count === 0) {
+  // Deny on a missing/zero count rather than failing open: a permission gate must not
+  // grant access when the count is absent (`count` is typed optional on the response).
+  if (!count) {
     throw new Error(
       `Entity with entityId ${entityId} doesn't exist or cannot be accessed by requesting user.`,
     );

apps/hash-api/src/graphql/resolvers/index.ts

@@ -37,7 +37,7 @@ import {
   addEntityViewerResolver,
   archiveEntitiesResolver,
   archiveEntityResolver,
-  countEntitiesResolver,
+  summarizeEntitiesResolver,
   createEntityResolver,
   isEntityPublicResolver,
   queryEntitiesResolver,
@@ -157,7 +157,7 @@ export const resolvers: Omit<Resolvers, "Query" | "Mutation"> & {
         "`getEntityAuthorizationRelationships` is not implemented",
       );
     }),
-    countEntities: loggedInAndSignedUpMiddleware(countEntitiesResolver),
+    summarizeEntities: loggedInAndSignedUpMiddleware(summarizeEntitiesResolver),
     queryEntities: loggedInAndSignedUpMiddleware(queryEntitiesResolver),
     queryEntitySubgraph: loggedInAndSignedUpMiddleware(
       queryEntitySubgraphResolver,

apps/hash-api/src/graphql/resolvers/knowledge/entity/entity.ts

@@ -9,6 +9,7 @@ import {
   queryEntitySubgraph,
   serializeQueryEntitiesResponse,
   serializeQueryEntitySubgraphResponse,
+  summarizeEntities,
 } from "@local/hash-graph-sdk/entity";
 import {
   createPolicy,
@@ -19,7 +20,6 @@ import {
 import {
   canUserReadEntity,
   checkEntityPermission,
-  countEntities,
   createEntityWithLinks,
   getLatestEntityById,
   updateEntity,
@@ -42,7 +42,7 @@ import type {
   MutationUpdateEntitiesArgs,
   MutationUpdateEntityArgs,
   Query,
-  QueryCountEntitiesArgs,
+  QuerySummarizeEntitiesArgs,
   QueryIsEntityPublicArgs,
   QueryQueryEntitiesArgs,
   QueryQueryEntitySubgraphArgs,
@@ -105,13 +105,13 @@ export const createEntityResolver: ResolverFn<
   return entity;
 };
 
-export const countEntitiesResolver: ResolverFn<
-  Query["countEntities"],
+export const summarizeEntitiesResolver: ResolverFn<
+  Query["summarizeEntities"],
   Record<string, never>,
   GraphQLContext,
-  QueryCountEntitiesArgs
+  QuerySummarizeEntitiesArgs
 > = async (_, { request }, graphQLContext) =>
-  countEntities(
+  summarizeEntities(
     graphQLContextToImpureGraphContext(graphQLContext),
     graphQLContext.authentication,
     request,

apps/hash-frontend/src/graphql/queries/knowledge/entity.queries.ts

@@ -31,9 +31,9 @@ export const queryEntitySubgraphQuery = gql`
   }
 `;
 
-export const countEntitiesQuery = gql`
-  query countEntities($request: CountEntitiesParams!) {
-    countEntities(request: $request)
+export const summarizeEntitiesQuery = gql`
+  query summarizeEntities($request: SummarizeEntitiesParams!) {
+    summarizeEntities(request: $request)
   }
 `;
 

apps/hash-frontend/src/pages/index.page/waitlisted.tsx

@@ -15,7 +15,7 @@ import {
 import { isSelfHostedInstance } from "@local/hash-isomorphic-utils/instance";
 import { systemEntityTypes } from "@local/hash-isomorphic-utils/ontology-type-ids";
 
-import { countEntitiesQuery } from "../../graphql/queries/knowledge/entity.queries";
+import { summarizeEntitiesQuery } from "../../graphql/queries/knowledge/entity.queries";
 import {
   getWaitlistPositionQuery,
   submitEarlyAccessFormMutation,
@@ -30,8 +30,8 @@ import { UsesCard } from "./shared/uses-card";
 import { EarlyAccessFormModal } from "./waitlisted/early-access-modal";
 
 import type {
-  CountEntitiesQuery,
-  CountEntitiesQueryVariables,
+  SummarizeEntitiesQuery,
+  SummarizeEntitiesQueryVariables,
   GetWaitlistPositionQuery,
   SubmitEarlyAccessFormMutation,
   SubmitEarlyAccessFormMutationVariables,
@@ -65,8 +65,8 @@ export const Waitlisted = () => {
     "closed" | "open" | "submitted"
   >("closed");
 
-  useQuery<CountEntitiesQuery, CountEntitiesQueryVariables>(
-    countEntitiesQuery,
+  useQuery<SummarizeEntitiesQuery, SummarizeEntitiesQueryVariables>(
+    summarizeEntitiesQuery,
     {
       variables: {
         request: {
@@ -75,11 +75,12 @@ export const Waitlisted = () => {
           ),
           includeDrafts: false,
           temporalAxes: currentTimeInstantTemporalAxes,
+          includeCount: true,
         },
       },
       fetchPolicy: "cache-and-network",
       onCompleted: (data) => {
-        if (data.countEntities > 0) {
+        if ((data.summarizeEntities.count ?? 0) > 0) {
           setEarlyAccessFormState("submitted");
         }
       },

apps/hash-frontend/src/pages/shared/entities-visualizer/shared/use-available-types.ts

@@ -4,16 +4,16 @@ import { useMemo } from "react";
 import { extractBaseUrl } from "@blockprotocol/type-system";
 import { currentTimeInstantTemporalAxes } from "@local/hash-isomorphic-utils/graph-queries";
 
-import { queryEntitySubgraphQuery } from "../../../../graphql/queries/knowledge/entity.queries";
+import { summarizeEntitiesQuery } from "../../../../graphql/queries/knowledge/entity.queries";
 import { useEntityTypesContextRequired } from "../../../../shared/entity-types-context/hooks/use-entity-types-context-required";
 import { usePropertyTypes } from "../../../../shared/property-types-context";
 import { useDataTypesContext } from "../../data-types-context";
 import { buildEntitiesFilter } from "./build-filter";
 import { deriveFilterableProperties } from "./property-filters/derive-filterable-properties";
 
 import type {
-  QueryEntitySubgraphQuery,
-  QueryEntitySubgraphQueryVariables,
+  SummarizeEntitiesQuery,
+  SummarizeEntitiesQueryVariables,
 } from "../../../../graphql/api-types.gen";
 import type { EntitiesFilterState } from "./filter-state";
 import type { FilterMetadataForProperty } from "./property-filters/property-filter";
@@ -78,21 +78,18 @@ export const useAvailableTypes = ({
   );
 
   const { data, loading } = useQuery<
-    QueryEntitySubgraphQuery,
-    QueryEntitySubgraphQueryVariables
-  >(queryEntitySubgraphQuery, {
+    SummarizeEntitiesQuery,
+    SummarizeEntitiesQueryVariables
+  >(summarizeEntitiesQuery, {
     skip: !shouldFetchAvailableTypes,
     fetchPolicy: "cache-and-network",
     variables: {
       request: {
-        limit: 1,
         filter,
         includeTypeIds: true,
         includeTypeTitles: true,
         temporalAxes: currentTimeInstantTemporalAxes,
         includeDrafts: false,
-        includePermissions: false,
-        traversalPaths: [],
       },
     },
   });
@@ -105,8 +102,8 @@ export const useAvailableTypes = ({
       return { availableEntityTypes: [], propertyFilterData: [] };
     }
 
-    const typeIds = data?.queryEntitySubgraph.typeIds ?? {};
-    const typeTitles = data?.queryEntitySubgraph.typeTitles ?? {};
+    const typeIds = data?.summarizeEntities.typeIds ?? {};
+    const typeTitles = data?.summarizeEntities.typeTitles ?? {};
 
     const availableTypes = Object.entries(typeIds)
       .map(([entityTypeId, count]) => {

apps/hash-frontend/src/pages/shared/entities-visualizer/use-entities-visualizer-data.tsx

@@ -10,19 +10,19 @@ import {
 import { currentTimeInstantTemporalAxes } from "@local/hash-isomorphic-utils/graph-queries";
 
 import {
-  countEntitiesQuery,
   queryEntitySubgraphQuery,
+  summarizeEntitiesQuery,
 } from "../../../graphql/queries/knowledge/entity.queries";
 import { apolloClient } from "../../../lib/apollo-client";
 import { buildEntitiesFilter } from "./shared/build-filter";
 import { traversalPathsForView } from "./shared/traversal-paths";
 import { useEntitiesTableData } from "./use-entities-table-data";
 
 import type {
-  CountEntitiesQuery,
-  CountEntitiesQueryVariables,
   QueryEntitySubgraphQuery,
   QueryEntitySubgraphQueryVariables,
+  SummarizeEntitiesQuery,
+  SummarizeEntitiesQueryVariables,
 } from "../../../graphql/api-types.gen";
 import type { VisualizerView } from "../visualizer-views";
 import type {
@@ -128,15 +128,16 @@ export const useEntitiesVisualizerData = (params: {
     [conversions, cursor, filter, limit, sort, view],
   );
 
-  const { data: countData } = useQuery<
-    CountEntitiesQuery,
-    CountEntitiesQueryVariables
-  >(countEntitiesQuery, {
+  const { data: summaryData } = useQuery<
+    SummarizeEntitiesQuery,
+    SummarizeEntitiesQueryVariables
+  >(summarizeEntitiesQuery, {
     variables: {
       request: {
         filter,
         temporalAxes: currentTimeInstantTemporalAxes,
         includeDrafts: false,
+        includeCount: true,
       },
     },
   });
@@ -203,12 +204,12 @@ export const useEntitiesVisualizerData = (params: {
       refetch,
       subgraph,
       tableData,
-      totalResultCount: countData?.countEntities ?? null,
+      totalResultCount: summaryData?.summarizeEntities.count ?? null,
       updateTableData,
     }),
     [
       data?.queryEntitySubgraph,
-      countData?.countEntities,
+      summaryData?.summarizeEntities,
       entities,
       hadCachedContent,
       loading,

apps/hash-frontend/src/shared/draft-entities-count-context.tsx

@@ -3,13 +3,13 @@ import { createContext, useContext, useMemo } from "react";
 
 import { currentTimeInstantTemporalAxes } from "@local/hash-isomorphic-utils/graph-queries";
 
-import { countEntitiesQuery } from "../graphql/queries/knowledge/entity.queries";
+import { summarizeEntitiesQuery } from "../graphql/queries/knowledge/entity.queries";
 import { useAuthInfo } from "../pages/shared/auth-info-context";
 import { usePollInterval } from "./use-poll-interval";
 
 import type {
-  CountEntitiesQuery,
-  CountEntitiesQueryVariables,
+  SummarizeEntitiesQuery,
+  SummarizeEntitiesQueryVariables,
 } from "../graphql/api-types.gen";
 import type { FunctionComponent, PropsWithChildren } from "react";
 
@@ -43,8 +43,8 @@ export const DraftEntitiesCountContextProvider: FunctionComponent<
     data: draftEntitiesData,
     refetch,
     loading,
-  } = useQuery<CountEntitiesQuery, CountEntitiesQueryVariables>(
-    countEntitiesQuery,
+  } = useQuery<SummarizeEntitiesQuery, SummarizeEntitiesQueryVariables>(
+    summarizeEntitiesQuery,
     {
       variables: {
         request: {
@@ -62,6 +62,7 @@ export const DraftEntitiesCountContextProvider: FunctionComponent<
           },
           temporalAxes: currentTimeInstantTemporalAxes,
           includeDrafts: true,
+          includeCount: true,
         },
       },
       pollInterval,
@@ -72,7 +73,7 @@ export const DraftEntitiesCountContextProvider: FunctionComponent<
 
   const value = useMemo<DraftEntitiesCountContextValue>(
     () => ({
-      count: draftEntitiesData?.countEntities ?? undefined,
+      count: draftEntitiesData?.summarizeEntities.count ?? undefined,
       loading,
       refetch: async () => {
         await refetch();

apps/hash-frontend/src/shared/generate-sidebar-entities-query-variables.tsx

@@ -3,7 +3,7 @@ import {
   ignoreNoisySystemTypesFilter,
 } from "@local/hash-isomorphic-utils/graph-queries";
 
-import type { QueryEntitiesQueryVariables } from "../graphql/api-types.gen";
+import type { SummarizeEntitiesQueryVariables } from "../graphql/api-types.gen";
 import type { WebId } from "@blockprotocol/type-system";
 
 /**
@@ -14,17 +14,13 @@ export const generateSidebarEntitiesQueryVariables = ({
   webId,
 }: {
   webId: WebId;
-}): QueryEntitiesQueryVariables => {
+}): SummarizeEntitiesQueryVariables => {
   return {
     request: {
       /**
-       * We only make this request to get the count of entities by typeId to filter types in the sidebar,
-       * to only those for which the active workspace has at least one entity.
-       *
-       * We don't actually need a single entity but the Graph rejects requests with a limit of 0.
-       * We currently can't use countEntities as it just returns a total number, with no count by typeId.
+       * We only request the per-typeId counts, to filter the sidebar types to those for
+       * which the active workspace has at least one entity.
        */
-      limit: 1,
       includeTypeIds: true,
       filter: {
         all: [
@@ -39,7 +35,6 @@ export const generateSidebarEntitiesQueryVariables = ({
       },
       temporalAxes: currentTimeInstantTemporalAxes,
       includeDrafts: false,
-      includePermissions: false,
     },
   };
 };