@knime/hub-features 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @knime/hub-features
 
+## 2.1.0
+
+### Minor Changes
+
+- 62b1106: Adjust editor execution instrumentation events
+
+### Patch Changes
+
+- a898ba3: Add `realName` and `avatarUrl` to `UserIdentity`
+
 ## 2.0.0
 
 ### Major Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Vue components & composables for shared hub features",
   "repository": {
     "type": "git",

package/src/analytics/schema/editor-event-functions.ts

@@ -943,11 +943,36 @@ export const applyAndExecuteNodeConfig = <T extends DefaultContext>(ctx: T) => (
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Node configuration applied and execution attempted",
+    event_display_name: "Node executed",
     interaction: {
       location: "node_configuration",
+      specification: "apply_and_execute",
+      trigger: "user",
+      type: "click",
+    },
+  } satisfies SchemaStaticFields & GeneratedStaticFields;
+
+  const event = { id: staticData.event_name, data: { ...staticData, payload: { ...toSnakeCaseDeep(eventData as Record<string, any>) } } };
+
+  return event;
+};
+
+/**
+ * Fired when the user clicks Execute in the node configuration panel
+ */
+export const executeNodeConfig = <T extends DefaultContext>(ctx: T) => (eventData: EventFunctionArgs<"executeNodeConfig">): AnalyticsEvent => {
+  const staticData = {
+    ...toSnakeCaseDeep(ctx),
+    unique_event_id: crypto.randomUUID(),
+    timestamp: new Date().toISOString(),
+    event_name: "node_executed",
+    event_source: "editor",
+    event_display_name: "Node executed",
+    interaction: {
+      location: "node_configuration",
+      specification: "execute",
       trigger: "user",
       type: "click",
     },
@@ -1194,9 +1219,9 @@ export const executeAllNodesCtxMenu = <T extends DefaultContext>(ctx: T) => (eve
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "All Nodes Executed",
+    event_display_name: "Node executed",
     interaction: {
       location: "canvas",
       specification: "execute_all",
@@ -1219,9 +1244,9 @@ export const executeAllNodesKeyboard = <T extends DefaultContext>(ctx: T) => (ev
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "All Nodes Executed",
+    event_display_name: "Node executed",
     interaction: {
       location: "global",
       specification: "execute_all",
@@ -1243,9 +1268,9 @@ export const executeAllNodesToolbar = <T extends DefaultContext>(ctx: T) => (eve
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "All Nodes Executed",
+    event_display_name: "Node executed",
     interaction: {
       location: "workflow_toolbar",
       specification: "execute_all",
@@ -1267,9 +1292,9 @@ export const executeSelectedNodesCtxMenu = <T extends DefaultContext>(ctx: T) =>
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Nodes Executed",
+    event_display_name: "Node executed",
     interaction: {
       location: "canvas",
       specification: "execute",
@@ -1292,9 +1317,9 @@ export const executeSelectedNodesKeyboard = <T extends DefaultContext>(ctx: T) =
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Nodes Executed",
+    event_display_name: "Node executed",
     interaction: {
       location: "global",
       specification: "execute",
@@ -1316,9 +1341,9 @@ export const executeSelectedNodesToolbar = <T extends DefaultContext>(ctx: T) =>
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Nodes Executed",
+    event_display_name: "Node executed",
     interaction: {
       location: "workflow_toolbar",
       specification: "execute",
@@ -1340,9 +1365,9 @@ export const executeNodeActionBar = <T extends DefaultContext>(ctx: T) => (event
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Node execution from node action bar",
+    event_display_name: "Node executed",
     interaction: {
       location: "canvas",
       specification: "execute",
@@ -1365,9 +1390,9 @@ export const executeNodeFromMonitor = <T extends DefaultContext>(ctx: T) => (eve
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Node execution from node monitor",
+    event_display_name: "Node executed",
     interaction: {
       location: "node_monitor",
       trigger: "user",
@@ -1388,9 +1413,9 @@ export const resumeLoopExecutionKeyboard = <T extends DefaultContext>(ctx: T) =>
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Node execution (resume loop)",
+    event_display_name: "Node executed",
     interaction: {
       location: "global",
       specification: "resume_loop",
@@ -1412,9 +1437,9 @@ export const resumeLoopExecutionActionBar = <T extends DefaultContext>(ctx: T) =
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Node execution (resume loop)",
+    event_display_name: "Node executed",
     interaction: {
       location: "canvas",
       specification: "resume_loop",
@@ -1437,9 +1462,9 @@ export const stepLoopExecutionKeyboard = <T extends DefaultContext>(ctx: T) => (
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Node execution (step loop)",
+    event_display_name: "Node executed",
     interaction: {
       location: "global",
       specification: "step_loop",
@@ -1461,9 +1486,9 @@ export const stepLoopExecutionActionBar = <T extends DefaultContext>(ctx: T) =>
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Node execution (step loop)",
+    event_display_name: "Node executed",
     interaction: {
       location: "canvas",
       specification: "step_loop",
@@ -1486,9 +1511,9 @@ export const resumeLoopExecutionCtxMenu = <T extends DefaultContext>(ctx: T) =>
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Node execution (resume loop)",
+    event_display_name: "Node executed",
     interaction: {
       location: "canvas",
       specification: "resume_loop",
@@ -1511,9 +1536,9 @@ export const stepLoopExecutionCtxMenu = <T extends DefaultContext>(ctx: T) => (e
     ...toSnakeCaseDeep(ctx),
     unique_event_id: crypto.randomUUID(),
     timestamp: new Date().toISOString(),
-    event_name: "execution_attempted",
+    event_name: "node_executed",
     event_source: "editor",
-    event_display_name: "Node execution (step loop)",
+    event_display_name: "Node executed",
     interaction: {
       location: "canvas",
       specification: "step_loop",

package/src/analytics/schema/schema.d.ts

@@ -618,11 +618,24 @@ export interface AnalyticsEventSchema {
       payload: HintIdPayload;
     };
     applyAndExecuteNodeConfig: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Node configuration applied and execution attempted";
+      event_display_name: "Node executed";
       interaction: {
         location: "node_configuration";
+        specification?: "apply_and_execute";
+        trigger: InteractionTrigger & "user";
+        type: InteractionType & "click";
+      };
+      payload: NodeExecutionPayload;
+    };
+    executeNodeConfig: {
+      event_name: "node_executed";
+      event_source: "editor";
+      event_display_name: "Node executed";
+      interaction: {
+        location: "node_configuration";
+        specification?: "execute";
         trigger: InteractionTrigger & "user";
         type: InteractionType & "click";
       };
@@ -812,9 +825,9 @@ export interface AnalyticsEventSchema {
       payload: NodeMigrationRequestedPayload;
     };
     executeAllNodesCtxMenu: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "All Nodes Executed";
+      event_display_name: "Node executed";
       interaction: {
         location: "canvas";
         specification?: "execute_all";
@@ -825,9 +838,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     executeAllNodesKeyboard: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "All Nodes Executed";
+      event_display_name: "Node executed";
       interaction: {
         location: "global";
         specification?: "execute_all";
@@ -837,9 +850,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     executeAllNodesToolbar: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "All Nodes Executed";
+      event_display_name: "Node executed";
       interaction: {
         location: "workflow_toolbar";
         specification?: "execute_all";
@@ -849,9 +862,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     executeSelectedNodesCtxMenu: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Nodes Executed";
+      event_display_name: "Node executed";
       interaction: {
         location: "canvas";
         specification?: "execute";
@@ -862,9 +875,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     executeSelectedNodesKeyboard: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Nodes Executed";
+      event_display_name: "Node executed";
       interaction: {
         location: "global";
         specification?: "execute";
@@ -874,9 +887,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     executeSelectedNodesToolbar: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Nodes Executed";
+      event_display_name: "Node executed";
       interaction: {
         location: "workflow_toolbar";
         specification?: "execute";
@@ -886,9 +899,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     executeNodeActionBar: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Node execution from node action bar";
+      event_display_name: "Node executed";
       interaction: {
         location: "canvas";
         specification?: "execute";
@@ -899,9 +912,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     executeNodeFromMonitor: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Node execution from node monitor";
+      event_display_name: "Node executed";
       interaction: {
         location: "node_monitor";
         trigger: InteractionTrigger & "user";
@@ -910,9 +923,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     resumeLoopExecutionKeyboard: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Node execution (resume loop)";
+      event_display_name: "Node executed";
       interaction: {
         location: "global";
         specification?: "resume_loop";
@@ -922,9 +935,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     resumeLoopExecutionActionBar: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Node execution (resume loop)";
+      event_display_name: "Node executed";
       interaction: {
         location: "canvas";
         specification?: "resume_loop";
@@ -935,9 +948,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     stepLoopExecutionKeyboard: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Node execution (step loop)";
+      event_display_name: "Node executed";
       interaction: {
         location: "global";
         specification?: "step_loop";
@@ -947,9 +960,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     stepLoopExecutionActionBar: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Node execution (step loop)";
+      event_display_name: "Node executed";
       interaction: {
         location: "canvas";
         specification?: "step_loop";
@@ -960,9 +973,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     resumeLoopExecutionCtxMenu: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Node execution (resume loop)";
+      event_display_name: "Node executed";
       interaction: {
         location: "canvas";
         specification?: "resume_loop";
@@ -973,9 +986,9 @@ export interface AnalyticsEventSchema {
       payload: NodeExecutionPayload;
     };
     stepLoopExecutionCtxMenu: {
-      event_name: "execution_attempted";
+      event_name: "node_executed";
       event_source: "editor";
-      event_display_name: "Node execution (step loop)";
+      event_display_name: "Node executed";
       interaction: {
         location: "canvas";
         specification?: "step_loop";

package/src/analytics/schema/schema.json

@@ -16,6 +16,7 @@
       "additionalProperties": false,
       "required": [
         "applyAndExecuteNodeConfig",
+        "executeNodeConfig",
         "kaiPromptedQA",
         "kaiPromptedBuild",
         "kaiPromptedQuickBuild",
@@ -3313,7 +3314,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -3321,7 +3322,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Node configuration applied and execution attempted"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -3332,6 +3333,74 @@
                   "type": "string",
                   "const": "node_configuration"
                 },
+                "specification": {
+                  "type": "string",
+                  "const": "apply_and_execute"
+                },
+                "trigger": {
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/InteractionTrigger"
+                    },
+                    {
+                      "const": "user"
+                    }
+                  ]
+                },
+                "type": {
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/InteractionType"
+                    },
+                    {
+                      "const": "click"
+                    }
+                  ]
+                }
+              }
+            },
+            "payload": {
+              "$ref": "#/definitions/NodeExecutionPayload"
+            }
+          }
+        },
+        "executeNodeConfig": {
+          "type": "object",
+          "additionalProperties": false,
+          "$comment": "Fired when the user clicks Execute in the node configuration panel",
+          "required": [
+            "event_name",
+            "event_source",
+            "event_display_name",
+            "interaction",
+            "payload"
+          ],
+          "properties": {
+            "event_name": {
+              "type": "string",
+              "const": "node_executed"
+            },
+            "event_source": {
+              "type": "string",
+              "const": "editor"
+            },
+            "event_display_name": {
+              "type": "string",
+              "const": "Node executed"
+            },
+            "interaction": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["location", "trigger", "type"],
+              "properties": {
+                "location": {
+                  "type": "string",
+                  "const": "node_configuration"
+                },
+                "specification": {
+                  "type": "string",
+                  "const": "execute"
+                },
                 "trigger": {
                   "allOf": [
                     {
@@ -4352,7 +4421,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4360,7 +4429,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "All Nodes Executed"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -4420,7 +4489,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4428,7 +4497,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "All Nodes Executed"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -4484,7 +4553,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4492,7 +4561,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "All Nodes Executed"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -4548,7 +4617,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4556,7 +4625,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Nodes Executed"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -4616,7 +4685,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4624,7 +4693,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Nodes Executed"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -4680,7 +4749,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4688,7 +4757,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Nodes Executed"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -4744,7 +4813,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4752,7 +4821,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Node execution from node action bar"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -4812,7 +4881,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4820,7 +4889,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Node execution from node monitor"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -4872,7 +4941,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4880,7 +4949,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Node execution (resume loop)"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -4936,7 +5005,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -4944,7 +5013,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Node execution (resume loop)"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -5004,7 +5073,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -5012,7 +5081,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Node execution (step loop)"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -5068,7 +5137,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -5076,7 +5145,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Node execution (step loop)"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -5136,7 +5205,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -5144,7 +5213,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Node execution (resume loop)"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",
@@ -5204,7 +5273,7 @@
           "properties": {
             "event_name": {
               "type": "string",
-              "const": "execution_attempted"
+              "const": "node_executed"
             },
             "event_source": {
               "type": "string",
@@ -5212,7 +5281,7 @@
             },
             "event_display_name": {
               "type": "string",
-              "const": "Node execution (step loop)"
+              "const": "Node executed"
             },
             "interaction": {
               "type": "object",

package/src/authUtils/types.ts

@@ -1,4 +1,9 @@
-export type UserIdentity = { id: string; name: string };
+export type UserIdentity = {
+  id: string;
+  name: string;
+  realName?: string;
+  avatarUrl?: string;
+};
 
 export type AuthRefresher = {
   /**