Skip to content

Fix regression where tooltip node descriptions in the graph stopped showing #3639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Keavon merged 3 commits into from
Jan 16, 2026
Merged

Fix regression where tooltip node descriptions in the graph stopped showing #3639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a69934
Fix tooltips
adamgerhant Jan 15, 2026
63ca382
Convert DefinitionIdentifier to string in JavaScript
adamgerhant Jan 15, 2026
296a4b4
Code review
Keavon Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions editor/src/messages/frontend/frontend_message.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ use super::utility_types::{DocumentDetails, MouseCursorIcon, OpenDocument};
use crate::messages::app_window::app_window_message_handler::AppWindowPlatform;
use crate::messages::input_mapper::utility_types::misc::ActionShortcut;
use crate::messages::layout::utility_types::widget_prelude::*;
use crate::messages::portfolio::document::node_graph::document_node_definitions::DefinitionIdentifier;
use crate::messages::portfolio::document::node_graph::utility_types::{
BoxSelection, ContextMenuInformation, FrontendClickTargets, FrontendGraphInput, FrontendGraphOutput, FrontendNode, FrontendNodeType, NodeGraphErrorDiagnostic, Transform,
};
Expand Down Expand Up @@ -61,7 +60,7 @@ pub enum FrontendMessage {
// Send prefix: Send global, static data to the frontend that is never updated
SendUIMetadata {
#[serde(rename = "nodeDescriptions")]
node_descriptions: Vec<(DefinitionIdentifier, String)>,
node_descriptions: Vec<(String, String)>,
#[serde(rename = "nodeTypes")]
node_types: Vec<FrontendNodeType>,
},
Expand Down
41 changes: 20 additions & 21 deletions editor/src/messages/portfolio/document/node_graph/document_node_definitions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,29 +80,23 @@ impl DefinitionIdentifier {
}),
}
}

pub fn serialized(&self) -> String {
match self {
DefinitionIdentifier::ProtoNode(id) => format!("PROTONODE:{}", id.as_str()),
DefinitionIdentifier::Network(data) => format!("NETWORK:{}", data),
}
}
}

impl From<Value> for DefinitionIdentifier {
fn from(value: Value) -> Self {
match value {
Value::Object(mut map) => {
let ty = map.remove("type").unwrap().as_str().unwrap().to_owned();
let s = value.as_str().expect("DefinitionIdentifier value must be a string");

match ty.as_ref() {
"Network" => {
let data = map.remove("data").unwrap().as_str().unwrap().to_owned();
DefinitionIdentifier::Network(data)
}
"ProtoNode" => {
let value = map.remove("data").unwrap();
let proto: ProtoNodeIdentifier = serde_json::from_value(value).unwrap();
DefinitionIdentifier::ProtoNode(proto)
}
_ => panic!("Unknown `DefinitionIdentifier` type: {:?}", ty),
}
}

_ => panic!("Expected a JSON object to convert to `DefinitionIdentifier`"),
match s.split_once(':') {
Some(("PROTONODE", data)) => DefinitionIdentifier::ProtoNode(ProtoNodeIdentifier::with_owned_string(data.to_string())),
Some(("NETWORK", data)) => DefinitionIdentifier::Network(data.to_string()),
other => panic!("Unknown `DefinitionIdentifier` type. Found `{other:?}`."),
}
}
}
Expand Down Expand Up @@ -2621,7 +2615,7 @@ pub fn collect_node_types() -> Vec<FrontendNodeType> {
name = identifier.implementation_name_from_identifier()
}
FrontendNodeType {
identifier: identifier.clone(),
identifier: identifier.serialized(),
name,
category: definition.category.to_string(),
input_types,
Expand All @@ -2630,10 +2624,15 @@ pub fn collect_node_types() -> Vec<FrontendNodeType> {
.collect()
}

pub fn collect_node_descriptions() -> Vec<(DefinitionIdentifier, String)> {
pub fn collect_node_descriptions() -> Vec<(String, String)> {
DOCUMENT_NODE_TYPES
.iter()
.map(|(identifier, definition)| (identifier.clone(), if definition.description != "TODO" { definition.description.to_string() } else { String::new() }))
.map(|(identifier, definition)| {
(
identifier.serialized(),
if definition.description != "TODO" { definition.description.to_string() } else { String::new() },
)
})
.collect()
}

Expand Down
10 changes: 3 additions & 7 deletions editor/src/messages/portfolio/document/node_graph/node_graph_message_handler.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2599,7 +2599,7 @@ impl NodeGraphMessageHandler {
.node_metadata(&node_id, breadcrumb_network_path)
.is_some_and(|node_metadata| node_metadata.persistent_metadata.is_layer()),
can_be_layer: network_interface.is_eligible_to_be_layer(&node_id, breadcrumb_network_path),
reference: network_interface.reference(&node_id, breadcrumb_network_path),
reference: network_interface.reference(&node_id, breadcrumb_network_path).map(|reference| reference.serialized()),
display_name: network_interface.display_name(&node_id, breadcrumb_network_path),
implementation_name: network_interface.implementation_name(&node_id, breadcrumb_network_path),
primary_input,
Expand Down Expand Up @@ -2715,16 +2715,12 @@ impl NodeGraphMessageHandler {
}
});

let Some(reference) = network_interface.reference(&node_id, &[]) else {
log::error!("Could not get reference for layer {node_id} in update_layer_panel");
continue;
};

let clippable = layer.can_be_clipped(network_interface.document_metadata());

let data = LayerPanelEntry {
id: node_id,
reference,
implementation_name: network_interface.implementation_name(&node_id, &[]),
icon_name: network_interface.is_artboard(&node_id, &[]).then(|| "Artboard".to_string()),
alias: network_interface.display_name(&node_id, &[]),
in_selected_network: selection_network_path.is_empty(),
children_allowed,
Expand Down
5 changes: 2 additions & 3 deletions editor/src/messages/portfolio/document/node_graph/utility_types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
use super::document_node_definitions::DefinitionIdentifier;
use glam::{DVec2, IVec2};
use graph_craft::document::NodeId;
use graph_craft::document::value::TaggedValue;
Expand Down Expand Up @@ -79,7 +78,7 @@ pub struct FrontendNode {
pub is_layer: bool,
#[serde(rename = "canBeLayer")]
pub can_be_layer: bool,
pub reference: Option<DefinitionIdentifier>,
pub reference: Option<String>,
#[serde(rename = "displayName")]
pub display_name: String,
#[serde(rename = "implementationName")]
Expand All @@ -104,7 +103,7 @@ pub struct FrontendNode {

#[derive(Clone, Debug, Eq, PartialEq, serde::Serialize, serde::Deserialize, specta::Type)]
pub struct FrontendNodeType {
pub identifier: DefinitionIdentifier,
pub identifier: String,
pub name: String,
pub category: String,
#[serde(rename = "inputTypes")]
Expand Down
6 changes: 4 additions & 2 deletions editor/src/messages/portfolio/document/utility_types/nodes.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
use super::document_metadata::{DocumentMetadata, LayerNodeIdentifier};
use super::network_interface::NodeNetworkInterface;
use crate::messages::portfolio::document::node_graph::document_node_definitions::DefinitionIdentifier;
use crate::messages::tool::common_functionality::graph_modification_utils;
use glam::DVec2;
use graph_craft::document::{NodeId, NodeNetwork};
Expand Down Expand Up @@ -35,7 +34,10 @@ impl serde::Serialize for JsRawBuffer {
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, PartialEq, Eq, specta::Type)]
pub struct LayerPanelEntry {
pub id: NodeId,
pub reference: DefinitionIdentifier,
#[serde(rename = "implementationName")]
pub implementation_name: String,
#[serde(rename = "iconName")]
pub icon_name: Option<String>,
pub alias: String,
#[serde(rename = "inSelectedNetwork")]
pub in_selected_network: bool,
Expand Down
6 changes: 3 additions & 3 deletions frontend/src/components/floating-menus/NodeCatalog.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<script lang="ts">
import { createEventDispatcher, getContext, onMount } from "svelte";

import type { DefinitionIdentifier, FrontendNodeType } from "@graphite/messages";
import type { FrontendNodeType } from "@graphite/messages";
import type { NodeGraphState } from "@graphite/state-providers/node-graph";

import LayoutCol from "@graphite/components/layout/LayoutCol.svelte";
import TextButton from "@graphite/components/widgets/buttons/TextButton.svelte";
import TextInput from "@graphite/components/widgets/inputs/TextInput.svelte";
import TextLabel from "@graphite/components/widgets/labels/TextLabel.svelte";

const dispatch = createEventDispatcher<{ selectNodeType: DefinitionIdentifier }>();
const dispatch = createEventDispatcher<{ selectNodeType: string }>();
const nodeGraph = getContext<NodeGraphState>("nodeGraph");

// Content
Expand Down Expand Up @@ -125,7 +125,7 @@
{disabled}
label={nodeType.name}
tooltipLabel={nodeType.name}
tooltipDescription={$nodeGraph.nodeDescriptions.get(nodeType.identifier)}
tooltipDescription={nodeType.identifier ? $nodeGraph.nodeDescriptions.get(nodeType.identifier) : undefined}
action={() => dispatch("selectNodeType", nodeType.identifier)}
/>
{/each}
Expand Down
6 changes: 3 additions & 3 deletions frontend/src/components/panels/Layers.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,15 +644,15 @@
{@html $nodeGraph.thumbnails.get(listing.entry.id)}
{/if}
</div>
{#if listing.entry.reference.type === "Network" && listing.entry.reference.data === "Artboard"}
<IconLabel icon="Artboard" class="layer-type-icon" tooltipLabel="Artboard" />
{#if listing.entry.iconName}
<IconLabel icon={listing.entry.iconName} class="layer-type-icon" tooltipLabel="Artboard" />
{/if}
<LayoutRow class="layer-name" on:dblclick={() => onEditLayerName(listing)}>
<input
data-text-input
type="text"
value={listing.entry.alias}
placeholder={listing.entry.reference.data}
placeholder={listing.entry.implementationName}
disabled={!listing.editingName}
on:blur={() => onEditLayerNameDeselect(listing)}
on:keydown={(e) => e.key === "Escape" && onEditLayerNameDeselect(listing)}
Expand Down
8 changes: 4 additions & 4 deletions frontend/src/components/views/Graph.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import { fade } from "svelte/transition";

import type { Editor } from "@graphite/editor";
import type { DefinitionIdentifier, FrontendGraphInput, FrontendGraphOutput, FrontendNode } from "@graphite/messages";
import type { FrontendGraphInput, FrontendGraphOutput, FrontendNode } from "@graphite/messages";
import type { NodeGraphState } from "@graphite/state-providers/node-graph";

import NodeCatalog from "@graphite/components/floating-menus/NodeCatalog.svelte";
Expand Down Expand Up @@ -100,7 +100,7 @@
return sparse;
}

function createNode(identifier: DefinitionIdentifier) {
function createNode(identifier: string) {
if ($nodeGraph.contextMenuInformation === undefined) return;

editor.handle.createNode(identifier, $nodeGraph.contextMenuInformation.contextMenuCoordinates.x, $nodeGraph.contextMenuInformation.contextMenuCoordinates.y);
Expand Down Expand Up @@ -481,7 +481,7 @@
{@const layerAreaWidth = $nodeGraph.layerWidths.get(node.id) || 8}
{@const layerChainWidth = $nodeGraph.chainWidths.get(node.id) || 0}
{@const hasLeftInputWire = $nodeGraph.hasLeftInputWire.get(node.id) || false}
{@const description = (node.reference && $nodeGraph.nodeDescriptions.get(node.reference)) || undefined}
{@const description = node.reference ? $nodeGraph.nodeDescriptions.get(node.reference) : undefined}
<div
class="layer"
class:selected={$nodeGraph.selected.includes(node.id)}
Expand Down Expand Up @@ -634,7 +634,7 @@
.map(([_, node], nodeIndex) => ({ node, nodeIndex })) as { node, nodeIndex } (nodeIndex)}
{@const exposedInputsOutputs = zipWithUndefined(node.exposedInputs, node.exposedOutputs)}
{@const clipPathId = String(Math.random()).substring(2)}
{@const description = (node.reference && $nodeGraph.nodeDescriptions.get(node.reference)) || undefined}
{@const description = node.reference ? $nodeGraph.nodeDescriptions.get(node.reference) : undefined}
<div
class="node"
class:selected={$nodeGraph.selected.includes(node.id)}
Expand Down
10 changes: 6 additions & 4 deletions frontend/src/messages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export class UpdateNodeGraphTransform extends JsMessage {

export class SendUIMetadata extends JsMessage {
@Transform(({ obj }) => new Map(obj.nodeDescriptions))
readonly nodeDescriptions!: Map<DefinitionIdentifier, string>;
readonly nodeDescriptions!: Map<string, string>;

readonly nodeTypes!: FrontendNodeType[];
}
Expand Down Expand Up @@ -220,7 +220,7 @@ export class FrontendNode {

readonly canBeLayer!: boolean;

readonly reference!: DefinitionIdentifier | undefined;
readonly reference!: string | undefined;

readonly displayName!: string;

Expand Down Expand Up @@ -251,7 +251,7 @@ export class FrontendNode {
}

export class FrontendNodeType {
readonly identifier!: DefinitionIdentifier;
readonly identifier!: string;

readonly name!: string;

Expand Down Expand Up @@ -834,7 +834,9 @@ export class UpdateDocumentLayerDetails extends JsMessage {
export class LayerPanelEntry {
id!: bigint;

reference!: DefinitionIdentifier;
implementationName!: string;

iconName!: IconName | undefined;

alias!: string;

Expand Down
3 changes: 1 addition & 2 deletions frontend/src/state-providers/node-graph.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import {
type FrontendNode,
type FrontendNodeType,
type WirePath,
type DefinitionIdentifier,
ClearAllNodeGraphWires,
SendUIMetadata,
UpdateBox,
Expand Down Expand Up @@ -45,7 +44,7 @@ export function createNodeGraphState(editor: Editor) {
/// The index is the exposed input index. The exports have a first key value of u32::MAX.
wires: new Map<bigint, Map<number, WirePath>>(),
wirePathInProgress: undefined as WirePath | undefined,
nodeDescriptions: new Map<DefinitionIdentifier, string>(),
nodeDescriptions: new Map<string, string>(),
nodeTypes: [] as FrontendNodeType[],
thumbnails: new Map<bigint, string>(),
selected: [] as bigint[],
Expand Down