FE-1994: Pass whole EntityId around for Flow Runs instead of just the EntityUuid

apps/hash-api/src/ai/infer-entities-websocket.ts

@@ -14,7 +14,6 @@ import { handleInferEntitiesRequest } from "./infer-entities-websocket/handle-in
 
 import type { GraphApi, ImpureGraphContext } from "../graph/context-types";
 import type { User } from "../graph/knowledge/system-types/user";
-import type { EntityUuid } from "@blockprotocol/type-system";
 import type { FileStorageProvider } from "@local/hash-backend-utils/file-storage";
 import type { Logger } from "@local/hash-backend-utils/logger";
 import type {
@@ -89,7 +88,7 @@ const inferEntitiesMessageHandler = async ({
         for (const inputRequest of flowRun.inputRequests) {
           if (!inputRequest.resolvedAt) {
             const requestMessage: ExternalInputWebsocketRequestMessage = {
-              workflowId: flowRun.flowRunId,
+              flowRunEntityId: flowRun.flowRunEntityId,
               payload: inputRequest,
               type: "external-input-request",
             };
@@ -100,19 +99,21 @@ const inferEntitiesMessageHandler = async ({
       return;
     }
     case "external-input-response": {
-      const { workflowId, payload } = message;
+      const { flowRunEntityId, payload } = message;
 
       const flow = await getFlowRunEntityById({
         userAuthentication: { actorId: user.accountId },
-        flowRunId: workflowId as EntityUuid,
+        flowRunEntityId,
         graphApiClient,
       });
 
       if (!flow) {
         return;
       }
 
-      const handle = temporalClient.workflow.getHandle(workflowId);
+      const handle = temporalClient.workflow.getHandle(
+        flow.properties["https://hash.ai/@h/types/property-type/workflow-id/"],
+      );
       await handle.signal<[ExternalInputResponseSignal]>(
         externalInputResponseSignal,
         { ...payload, resolvedBy: user.accountId },
@@ -152,15 +153,15 @@ const isInferenceWebsocketClientMessage = (
       );
     case "cancel-inference-request":
       return (
-        typeof message.flowRunId === "string" &&
+        typeof message.flowRunEntityId === "string" &&
         typeof message.requestUuid === "string" &&
         hasValidOptionalCookie(message)
       );
     case "check-for-external-input-requests":
       return hasValidOptionalCookie(message);
     case "external-input-response":
       return (
-        typeof message.workflowId === "string" &&
+        typeof message.flowRunEntityId === "string" &&
         typeof message.payload === "object" &&
         message.payload !== null &&
         hasValidOptionalCookie(message)

apps/hash-api/src/ai/infer-entities-websocket/handle-cancel-infer-entities-request.ts

@@ -2,7 +2,6 @@ import { getFlowRunEntityById } from "@local/hash-backend-utils/flows";
 
 import type { GraphApi } from "../../graph/context-types";
 import type { User } from "../../graph/knowledge/system-types/user";
-import type { EntityUuid } from "@blockprotocol/type-system";
 import type { CancelInferEntitiesWebsocketRequestMessage } from "@local/hash-isomorphic-utils/ai-inference-types";
 import type { Client } from "@temporalio/client";
 
@@ -17,19 +16,21 @@ export const handleCancelInferEntitiesRequest = async ({
   message: Omit<CancelInferEntitiesWebsocketRequestMessage, "cookie">;
   user: User;
 }) => {
-  const { flowRunId } = message;
+  const { flowRunEntityId } = message;
 
   const flow = await getFlowRunEntityById({
     userAuthentication: { actorId: user.accountId },
-    flowRunId: flowRunId as EntityUuid,
+    flowRunEntityId,
     graphApiClient,
   });
 
   if (!flow) {
     return;
   }
 
-  const workflowHandle = temporalClient.workflow.getHandle(flowRunId);
+  const workflowHandle = temporalClient.workflow.getHandle(
+    flow.properties["https://hash.ai/@h/types/property-type/workflow-id/"],
+  );
 
   void workflowHandle.cancel();
 };

apps/hash-api/src/ai/infer-entities-websocket/handle-infer-entities-request.ts

@@ -7,6 +7,7 @@ import {
 import { FlowRunStatus } from "../../graphql/api-types.gen";
 
 import type { User } from "../../graph/knowledge/system-types/user";
+import type { EntityUuid } from "@blockprotocol/type-system";
 import type { DistributiveOmit } from "@local/advanced-types/distribute";
 import type { FileStorageProvider } from "@local/hash-backend-utils/file-storage";
 import type { GraphApi } from "@local/hash-graph-client";
@@ -95,6 +96,8 @@ export const handleInferEntitiesRequest = async ({
         },
         flowDefinitionId,
         flowInputs,
+        /* So that the run's entity id can be worked out from the request, as the browser plugin does. */
+        flowRunEntityUuid: requestUuid as EntityUuid,
         userAuthentication: { actorId: user.accountId },
         webId,
       },

apps/hash-api/src/graphql/resolvers/flows/cancel-flow.ts

@@ -7,7 +7,6 @@ import * as Error from "../../error";
 
 import type { MutationResetFlowArgs, ResolverFn } from "../../api-types.gen";
 import type { LoggedInGraphQLContext } from "../../context";
-import type { EntityUuid } from "@blockprotocol/type-system";
 
 export const cancelFlow: ResolverFn<
   Promise<boolean>,
@@ -16,19 +15,22 @@ export const cancelFlow: ResolverFn<
   MutationResetFlowArgs
 > = async (
   _,
-  { flowUuid },
+  { flowRunEntityId },
   { authentication, dataSources, provenance, temporal, user },
 ) => {
   const flow = await getFlowRunEntityById({
-    flowRunId: flowUuid as EntityUuid,
+    flowRunEntityId,
     graphApiClient: dataSources.graphApi,
     userAuthentication: authentication,
   });
 
   if (!flow) {
-    throw Error.notFound(`Flow with id ${flowUuid} not found`);
+    throw Error.notFound(`Flow with id ${flowRunEntityId} not found`);
   }
 
+  const workflowId =
+    flow.properties["https://hash.ai/@h/types/property-type/workflow-id/"];
+
   const userCanModify = await checkEntityPermission(
     { graphApi: dataSources.graphApi, provenance },
     authentication,
@@ -45,7 +47,7 @@ export const cancelFlow: ResolverFn<
   await temporal.workflowService.requestCancelWorkflowExecution({
     namespace: temporalNamespace,
     workflowExecution: {
-      workflowId: flowUuid,
+      workflowId,
     },
     reason: `Cancelled via GraphQL API by @${user.shortname}`,
     requestId: generateUuid(),

apps/hash-api/src/graphql/resolvers/flows/get-flow-run-by-id.ts

@@ -9,7 +9,6 @@ import type {
   ResolverFn,
 } from "../../api-types.gen";
 import type { GraphQLContext } from "../../context";
-import type { EntityUuid } from "@blockprotocol/type-system";
 import type { SparseFlowRun } from "@local/hash-isomorphic-utils/flows/types";
 
 export const getFlowRunByIdResolver: ResolverFn<
@@ -18,12 +17,12 @@ export const getFlowRunByIdResolver: ResolverFn<
   Pick<GraphQLContext, "authentication" | "dataSources" | "temporal">,
   QueryGetFlowRunByIdArgs
 > = async (_parent, args, context, info) => {
-  const { flowRunId } = args;
+  const { flowRunEntityId } = args;
 
   const includeDetails = wereDetailedFieldsRequested(info);
 
   const flowRun = await getFlowRunById({
-    flowRunId: flowRunId as EntityUuid,
+    flowRunEntityId,
     graphApiClient: context.dataSources.graphApi,
     includeDetails,
     storageProvider: context.dataSources.uploadProvider,
@@ -32,7 +31,7 @@ export const getFlowRunByIdResolver: ResolverFn<
   });
 
   if (!flowRun) {
-    throw Error.notFound(`Flow run with id ${flowRunId} not found`);
+    throw Error.notFound(`Flow run with id ${flowRunEntityId} not found`);
   }
 
   return flowRun;

apps/hash-api/src/graphql/resolvers/flows/reset-flow.ts

@@ -10,7 +10,6 @@ import * as Error from "../../error";
 
 import type { MutationResetFlowArgs, ResolverFn } from "../../api-types.gen";
 import type { LoggedInGraphQLContext } from "../../context";
-import type { EntityUuid } from "@blockprotocol/type-system";
 
 export const resetFlow: ResolverFn<
   Promise<boolean>,
@@ -19,19 +18,22 @@ export const resetFlow: ResolverFn<
   MutationResetFlowArgs
 > = async (
   _,
-  { flowUuid, checkpointId, eventId },
+  { flowRunEntityId, checkpointId, eventId },
   { authentication, dataSources, provenance, temporal },
 ) => {
   const flow = await getFlowRunEntityById({
-    flowRunId: flowUuid as EntityUuid,
+    flowRunEntityId,
     graphApiClient: dataSources.graphApi,
     userAuthentication: authentication,
   });
 
   if (!flow) {
-    throw Error.notFound(`Flow with id ${flowUuid} not found`);
+    throw Error.notFound(`Flow with id ${flowRunEntityId} not found`);
   }
 
+  const workflowId =
+    flow.properties["https://hash.ai/@h/types/property-type/workflow-id/"];
+
   const userCanModify = await checkEntityPermission(
     { graphApi: dataSources.graphApi, provenance },
     authentication,
@@ -48,7 +50,7 @@ export const resetFlow: ResolverFn<
   await temporal.workflowService.resetWorkflowExecution({
     namespace: temporalNamespace,
     workflowExecution: {
-      workflowId: flowUuid,
+      workflowId,
     },
     /**
      * If we don't set this, Temporal will replay signals sent after the cancellation point to the new workflow execution.

apps/hash-api/src/graphql/resolvers/flows/start-flow.ts

@@ -1,3 +1,4 @@
+import { entityIdFromComponents } from "@blockprotocol/type-system";
 import { generateUuid } from "@local/hash-isomorphic-utils/generate-uuid";
 
 import {
@@ -9,14 +10,14 @@ import { assertClientFlowInputs } from "./shared/assert-client-flow-inputs";
 import { getRunnableFlowDefinition } from "./shared/get-runnable-flow-definition";
 
 import type { LoggedInGraphQLContext } from "../../context";
-import type { EntityUuid } from "@blockprotocol/type-system";
+import type { EntityId, EntityUuid } from "@blockprotocol/type-system";
 import type {
   RunFlowWorkflowParams,
   RunFlowWorkflowResponse,
 } from "@local/hash-isomorphic-utils/flows/temporal-types";
 
 export const startFlow: ResolverFn<
-  Promise<EntityUuid>,
+  Promise<EntityId>,
   Record<string, never>,
   LoggedInGraphQLContext,
   MutationStartFlowArgs
@@ -45,7 +46,7 @@ export const startFlow: ResolverFn<
 
   const params: RunFlowWorkflowParams = {
     ...(flowType === "ai" ? { dataSources } : {}),
-    flowRunId: workflowId,
+    flowRunEntityUuid: workflowId,
     flowInputs,
     flowDefinitionId,
     userAuthentication: { actorId: user.accountId },
@@ -68,5 +69,5 @@ export const startFlow: ResolverFn<
     },
   });
 
-  return workflowId;
+  return entityIdFromComponents(webId, workflowId);
 };

apps/hash-api/src/graphql/resolvers/flows/submit-external-input-response.ts

@@ -8,7 +8,6 @@ import type {
   ResolverFn,
 } from "../../api-types.gen";
 import type { LoggedInGraphQLContext } from "../../context";
-import type { EntityUuid } from "@blockprotocol/type-system";
 
 export const submitExternalInputResponse: ResolverFn<
   Promise<boolean>,
@@ -17,20 +16,23 @@ export const submitExternalInputResponse: ResolverFn<
   MutationSubmitExternalInputResponseArgs
 > = async (
   _,
-  { response, flowUuid },
+  { response, flowRunEntityId },
   { authentication, dataSources, temporal },
 ) => {
   const flow = await getFlowRunEntityById({
-    flowRunId: flowUuid as EntityUuid,
+    flowRunEntityId,
     graphApiClient: dataSources.graphApi,
     userAuthentication: authentication,
   });
 
   if (!flow) {
-    throw Error.notFound(`Flow with id ${flowUuid} not found`);
+    throw Error.notFound(`Flow with id ${flowRunEntityId} not found`);
   }
 
-  const handle = temporal.workflow.getHandle(flowUuid);
+  const workflowId =
+    flow.properties["https://hash.ai/@h/types/property-type/workflow-id/"];
+
+  const handle = temporal.workflow.getHandle(workflowId);
 
   await handle.signal(externalInputResponseSignal, response);
 

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

@@ -17,18 +17,22 @@ export const startFlowMutation = gql`
 `;
 
 export const resetFlowMutation = gql`
-  mutation resetFlow($flowUuid: ID!, $checkpointId: ID!, $eventId: Int!) {
+  mutation resetFlow(
+    $flowRunEntityId: EntityId!
+    $checkpointId: ID!
+    $eventId: Int!
+  ) {
     resetFlow(
       checkpointId: $checkpointId
       eventId: $eventId
-      flowUuid: $flowUuid
+      flowRunEntityId: $flowRunEntityId
     )
   }
 `;
 
 export const cancelFlowMutation = gql`
-  mutation cancelFlow($flowUuid: ID!) {
-    cancelFlow(flowUuid: $flowUuid)
+  mutation cancelFlow($flowRunEntityId: EntityId!) {
+    cancelFlow(flowRunEntityId: $flowRunEntityId)
   }
 `;
 

apps/hash-frontend/src/pages/@/[shortname]/flows/[flow-def-id].page.tsx

@@ -18,7 +18,7 @@ const FlowDefinitionPage: NextPageWithLayout = () => {
     <FlowDefinitionsContextProvider
       selectedFlowDefinitionId={routeFlowDefinitionId}
     >
-      <FlowRunsContextProvider selectedFlowRunId={null}>
+      <FlowRunsContextProvider selectedFlowRunEntityId={null}>
         <FlowVisualizer />
       </FlowRunsContextProvider>
     </FlowDefinitionsContextProvider>

apps/hash-frontend/src/pages/@/[shortname]/shared/flow-visualizer.tsx

@@ -603,8 +603,8 @@ export const FlowVisualizer = () => {
       try {
         const { data } = await startFlow({ variables });
 
-        const flowRunId = data?.startFlow;
-        if (!flowRunId) {
+        const flowRunEntityId = data?.startFlow;
+        if (!flowRunEntityId) {
           throw new Error("Failed to start flow");
         }
 
@@ -616,7 +616,7 @@ export const FlowVisualizer = () => {
 
         const { shortname } = getOwner({ webId: variables.webId });
 
-        void push(generateWorkerRunPath({ shortname, flowRunId }));
+        void push(generateWorkerRunPath({ shortname, flowRunEntityId }));
       } finally {
         setStartFlowPending(false);
       }
@@ -646,7 +646,7 @@ export const FlowVisualizer = () => {
 
   const flowDefinitionStateKey = `${selectedFlowDefinition.name} ?? "loading`;
   const flowRunStateKey = `${flowDefinitionStateKey}-${
-    selectedFlowRun?.flowRunId ?? "definition"
+    selectedFlowRun?.flowRunEntityId ?? "definition"
   }`;
 
   const isRunnableFromHere = !unrunnableDefinitionIds.includes(
@@ -707,7 +707,7 @@ export const FlowVisualizer = () => {
           {selectedFlowRun ? (
             <FlowRunSidebar
               flowDefinitionId={selectedFlow.flowDefinitionId}
-              flowRunId={selectedFlowRun.flowRunId}
+              flowRunEntityId={selectedFlowRun.flowRunEntityId}
               flowScheduleId={selectedFlowRun.flowScheduleId ?? null}
               graph={graph}
               name={selectedFlowRun.name}

apps/hash-frontend/src/pages/@/[shortname]/shared/flow-visualizer/activity-log.tsx

@@ -251,7 +251,7 @@ const Checkpoint = ({ log }: { log: CheckpointLog }) => {
 
     void resetFlow({
       variables: {
-        flowUuid: selectedFlowRun.flowRunId,
+        flowRunEntityId: selectedFlowRun.flowRunEntityId,
         checkpointId: log.checkpointId,
         eventId: log.eventId,
       },