feat: auto select components created by mgmt fns

If you create a bunch of components via a management function, (say, via a template func), we will now replace the selection with them when the components are created.
systeminit · Dec 19, 2024 · c79c600 · c79c600
1 parent 8aff0d2
commit c79c600
Show file tree

Hide file tree

Showing 8 changed files with 131 additions and 66 deletions.
diff --git a/app/web/src/components/ManagementRunPrototype.vue b/app/web/src/components/ManagementRunPrototype.vue
@@ -40,7 +40,6 @@
 <script lang="ts" setup>
 import { ref, computed, onMounted, watch } from "vue";
 import clsx from "clsx";
-import { useToast } from "vue-toastification";
 import {
   DropdownMenu,
   DropdownMenuItem,
@@ -69,7 +68,6 @@ import FuncRunTabDropdown from "./FuncRunTabDropdown.vue";
 const funcStore = useFuncStore();
 const viewStore = useViewsStore();
 const router = useRouter();
-const toast = useToast();
 const managementRunsStore = useManagementRunsStore();
 const viewsStore = useViewsStore();
 
@@ -129,27 +127,7 @@ const runPrototype = async (viewId: ViewId) => {
   );
 
   if (result.result.success) {
-    // TODO(WENDY) - for template functions, select the returned componentIds
-    // modelingEventBus.emit("setSelection", componentIds);
-
     lastExecution.value = result.result.data;
-    if (result.result.data.message) {
-      const toastOptions = {
-        pauseOnHover: true,
-        timeout: 5000,
-      };
-      if (result.result.data.status === "ok") {
-        toast.success(
-          `${props.prototype.label}: ${result.result.data.message}`,
-          toastOptions,
-        );
-      } else {
-        toast.warning(
-          `${props.prototype.label}: ${result.result.data.message}`,
-          toastOptions,
-        );
-      }
-    }
   }
 };
 

diff --git a/app/web/src/components/ModelingView/ModelingRightClickMenu.vue b/app/web/src/components/ModelingView/ModelingRightClickMenu.vue
@@ -43,7 +43,6 @@ import { storeToRefs } from "pinia";
 import { computed, ref } from "vue";
 // import plur from "plur";
 import { RouteLocationRaw } from "vue-router";
-import { useToast } from "vue-toastification";
 import { IRect } from "konva/lib/types";
 import { ComponentType } from "@/api/sdf/dal/schema";
 import { useComponentsStore } from "@/store/components.store";
@@ -68,7 +67,6 @@ import {
 
 const contextMenuRef = ref<InstanceType<typeof DropdownMenu>>();
 
-const toast = useToast();
 const changeSetsStore = useChangeSetsStore();
 const componentsStore = useComponentsStore();
 const funcStore = useFuncStore();
@@ -519,29 +517,11 @@ const runManagementFunc = async (prototype: MgmtPrototype) => {
   if (!selectedComponent.value) return;
   if (!viewStore.selectedViewId) return;
 
-  const result = await funcStore.RUN_MGMT_PROTOTYPE(
+  await funcStore.RUN_MGMT_PROTOTYPE(
     prototype.managementPrototypeId,
     selectedComponent.value.def.id,
     viewStore.selectedViewId,
   );
-
-  if (result.result.success && result.result.data.message) {
-    const toastOptions = {
-      pauseOnHover: true,
-      timeout: 5000,
-    };
-    if (result.result.data.status === "ok") {
-      toast.success(
-        `${prototype.label}: ${result.result.data.message}`,
-        toastOptions,
-      );
-    } else {
-      toast.warning(
-        `${prototype.label}: ${result.result.data.message}`,
-        toastOptions,
-      );
-    }
-  }
 };
 
 function triggerCopySelection() {

diff --git a/app/web/src/store/func/funcs.store.ts b/app/web/src/store/func/funcs.store.ts
@@ -2,6 +2,7 @@ import * as _ from "lodash-es";
 import { defineStore } from "pinia";
 import { addStoreHooks, ApiRequest, URLPattern } from "@si/vue-lib/pinia";
 import { ulid } from "ulid";
+import { useToast } from "vue-toastification";
 import { Visibility } from "@/api/sdf/dal/visibility";
 import {
   FuncArgument,
@@ -41,6 +42,7 @@ import { useRealtimeStore } from "../realtime/realtime.store";
 
 import { FuncRunId } from "../func_runs.store";
 import { useViewsStore } from "../views.store";
+import { useComponentsStore } from "../components.store";
 
 type FuncExecutionState =
   | "Create"
@@ -83,6 +85,7 @@ export type MgmtPrototype = {
 export type MgmtPrototypeResult = {
   message?: string;
   status: "ok" | "error";
+  createdComponentIds?: ComponentId[];
 };
 
 export function actionBindingsForVariant(
@@ -207,6 +210,7 @@ export const useFuncStore = () => {
         executingPrompt: false,
         // So we can ignore websocket update originated by this client
         clientUlid: ulid(),
+        pendingManagementRunRequestUlid: undefined as string | undefined,
       }),
       getters: {
         selectedFuncSummary(state): FuncSummary | undefined {
@@ -231,7 +235,7 @@ export const useFuncStore = () => {
 
           const variant =
             useAssetStore().variantFromListById[
-              viewStore.selectedComponent?.def.schemaVariantId || ""
+            viewStore.selectedComponent?.def.schemaVariantId || ""
             ];
           if (!variant) return [];
           variant.funcIds.forEach((funcId) => {
@@ -260,7 +264,7 @@ export const useFuncStore = () => {
             return [];
           const variant =
             useAssetStore().variantFromListById[
-              viewStore.selectedComponent?.def.schemaVariantId || ""
+            viewStore.selectedComponent?.def.schemaVariantId || ""
             ];
           if (!variant) return [];
           const summaries: Record<FuncId, FuncSummary> = {};
@@ -318,6 +322,9 @@ export const useFuncStore = () => {
               { componentId },
               { viewId },
             ]),
+            optimistic: (requestUlid) => {
+              this.pendingManagementRunRequestUlid = requestUlid;
+            },
           });
         },
 
@@ -431,7 +438,7 @@ export const useFuncStore = () => {
               clientUlid: this.clientUlid,
             },
             optimistic: () => {
-              if (isHead) return () => {};
+              if (isHead) return () => { };
 
               const current = _.cloneDeep(this.funcsById[func.funcId]);
               const editing = this.funcsById[func.funcId];
@@ -481,7 +488,7 @@ export const useFuncStore = () => {
                           if (
                             b.attributePrototypeId &&
                             b.attributePrototypeId ===
-                              binding.attributePrototypeId
+                            binding.attributePrototypeId
                           )
                             return true;
                         }
@@ -498,7 +505,7 @@ export const useFuncStore = () => {
                           if (
                             b.managementPrototypeId &&
                             b.managementPrototypeId ===
-                              binding.managementPrototypeId
+                            binding.managementPrototypeId
                           )
                             return true;
                         }
@@ -931,7 +938,7 @@ export const useFuncStore = () => {
                 if (data.funcId === this.selectedFuncId) {
                   if (
                     typeof this.funcCodeById[this.selectedFuncId] ===
-                      "undefined" ||
+                    "undefined" ||
                     changeSetsStore.headSelected
                   ) {
                     this.FETCH_CODE(this.selectedFuncId);
@@ -940,6 +947,35 @@ export const useFuncStore = () => {
               }
             },
           },
+          {
+            eventType: "ManagementOperationsComplete",
+            callback: (
+              { requestUlid, status, message, createdComponentIds, funcName },
+              _metadata,
+            ) => {
+              if (
+                requestUlid &&
+                requestUlid === this.pendingManagementRunRequestUlid &&
+                createdComponentIds?.length
+              ) {
+                viewStore.setSelectedComponentId(createdComponentIds);
+                this.pendingManagementRunRequestUlid = undefined;
+              }
+
+              const toast = useToast();
+              const toastOptions = {
+                timeout: 5000,
+              };
+              const toastMessage = message?.length
+                ? `Ran ${funcName}: ${message}`
+                : `Ran ${funcName}`;
+              if (status === "ok") {
+                toast.success(toastMessage, toastOptions);
+              } else {
+                toast.warning(toastMessage, toastOptions);
+              }
+            },
+          },
         ]);
         return () => {
           realtimeStore.unsubscribe(this.$id);

diff --git a/app/web/src/store/realtime/realtime_events.ts b/app/web/src/store/realtime/realtime_events.ts
@@ -215,12 +215,21 @@ export type WsEventPayloadMap = {
         fromComponentId: string;
         toComponentId: string;
       };
+
   ManagementFuncExecuted: {
     managerComponentId: string;
     prototypeId: string;
     funcRunId: FuncRunId;
     changeSetId: string;
   };
+  ManagementOperationsComplete: {
+    requestUlid?: string;
+    funcName: string;
+    status: "ok" | "error";
+    message?: string;
+    createdComponentIds?: ComponentId[];
+  };
+
   ModuleImported: SchemaVariant[];
   WorkspaceImportBeginApprovalProcess: {
     workspacePk: WorkspacePk;

diff --git a/lib/dal/src/management/mod.rs b/lib/dal/src/management/mod.rs
@@ -1010,7 +1010,7 @@ impl<'a> ManagementOperator<'a> {
         Ok(())
     }
 
-    pub async fn operate(&mut self) -> ManagementResult<()> {
+    pub async fn operate(&mut self) -> ManagementResult<Option<Vec<ComponentId>>> {
         let mut pending_operations = self.creates().await?;
         let mut component_graph = DependencyGraph::new();
         pending_operations.extend(self.updates().await?);
@@ -1029,6 +1029,9 @@ impl<'a> ManagementOperator<'a> {
             component_graph.id_depends_on(pending_parent.child_component_id, parent_id);
         }
 
+        let created_component_ids = (!self.created_components.is_empty())
+            .then_some(self.created_components.iter().copied().collect());
+
         self.send_component_ws_events(component_graph).await?;
 
         // Now, the rest of the pending ops can be executed, which need to have
@@ -1061,7 +1064,7 @@ impl<'a> ManagementOperator<'a> {
 
         self.actions().await?;
 
-        Ok(())
+        Ok(created_component_ids)
     }
 }
 

diff --git a/lib/dal/src/management/prototype.rs b/lib/dal/src/management/prototype.rs
@@ -8,7 +8,7 @@ use std::{
 use serde::{Deserialize, Serialize};
 use si_events::FuncRunId;
 use thiserror::Error;
-use veritech_client::ManagementResultSuccess;
+use veritech_client::{ManagementFuncStatus, ManagementResultSuccess};
 
 use crate::{
     cached_module::{CachedModule, CachedModuleError},
@@ -24,7 +24,7 @@ use crate::{
     Component, ComponentError, ComponentId, DalContext, EdgeWeightKind,
     EdgeWeightKindDiscriminants, FuncId, HelperError, NodeWeightDiscriminants, Schema, SchemaError,
     SchemaId, SchemaVariant, SchemaVariantError, SchemaVariantId, TransactionsError,
-    WorkspaceSnapshotError, WsEvent, WsEventError, WsEventResult,
+    WorkspaceSnapshotError, WsEvent, WsEventError, WsEventResult, WsPayload,
 };
 
 use super::ManagementGeometry;
@@ -660,6 +660,16 @@ pub struct ManagementFuncExecutedPayload {
     func_run_id: FuncRunId,
 }
 
+#[derive(Clone, Deserialize, Serialize, Debug, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+pub struct ManagementOperationsCompletePayload {
+    request_ulid: Option<ulid::Ulid>,
+    func_name: String,
+    status: ManagementFuncStatus,
+    message: Option<String>,
+    created_component_ids: Option<Vec<ComponentId>>,
+}
+
 impl WsEvent {
     pub async fn management_func_executed(
         ctx: &DalContext,
@@ -669,12 +679,33 @@ impl WsEvent {
     ) -> WsEventResult<Self> {
         WsEvent::new(
             ctx,
-            crate::WsPayload::ManagementFuncExecuted(ManagementFuncExecutedPayload {
+            WsPayload::ManagementFuncExecuted(ManagementFuncExecutedPayload {
                 prototype_id,
                 manager_component_id,
                 func_run_id,
             }),
         )
         .await
     }
+
+    pub async fn management_operations_complete(
+        ctx: &DalContext,
+        request_ulid: Option<ulid::Ulid>,
+        func_name: String,
+        message: Option<String>,
+        status: ManagementFuncStatus,
+        created_component_ids: Option<Vec<ComponentId>>,
+    ) -> WsEventResult<Self> {
+        WsEvent::new(
+            ctx,
+            WsPayload::ManagementOperationsComplete(ManagementOperationsCompletePayload {
+                request_ulid,
+                func_name,
+                status,
+                message,
+                created_component_ids,
+            }),
+        )
+        .await
+    }
 }
diff --git a/lib/dal/src/ws_event.rs b/lib/dal/src/ws_event.rs
@@ -25,7 +25,9 @@ use crate::func::runner::FuncRunLogUpdatedPayload;
 use crate::func::{
     FuncWsEventCodeSaved, FuncWsEventFuncSummary, FuncWsEventGenerating, FuncWsEventPayload,
 };
-use crate::management::prototype::ManagementFuncExecutedPayload;
+use crate::management::prototype::{
+    ManagementFuncExecutedPayload, ManagementOperationsCompletePayload,
+};
 use crate::pkg::{
     ImportWorkspaceVotePayload, WorkspaceActorPayload, WorkspaceImportApprovalActorPayload,
 };
@@ -113,6 +115,7 @@ pub enum WsPayload {
     InferredEdgeRemove(InferredEdgeRemovePayload),
     InferredEdgeUpsert(InferredEdgeUpsertPayload),
     ManagementFuncExecuted(ManagementFuncExecutedPayload),
+    ManagementOperationsComplete(ManagementOperationsCompletePayload),
     ModuleImported(Vec<si_frontend_types::SchemaVariant>),
     Online(OnlinePayload),
     PromptUpdated(PromptUpdatedPayload),