SURF-766 Add additionalLabels and additionalProperties config to apoc.create.virtual.fromNode

Extend the config map of apoc.create.virtual.fromNode to support additionalLabels (LIST<STRING>) and additionalProperties (MAP), allowing users to annotate virtual nodes with extra labels and properties at creation time without requiring write mode.

https://linear.app/neo4j/issue/SURF-766/apoc-add-a-virtual-label-to-a-result-node-to-highlight-eg-potential

Author: neo-harshg

core/src/main/java/apoc/create/Create.java

@@ -417,9 +417,33 @@ public Node virtualFromNodeFunction(
             @Name(value = "node", description = "The node to generate a virtual node from.") Node node,
             @Name(value = "propertyNames", description = "The properties to copy to the virtual node.")
                     List<String> propertyNames,
-            @Name(value = "config", defaultValue = "{}", description = "{ wrapNodeIds = false :: BOOLEAN }")
+            @Name(
+                            value = "config",
+                            defaultValue = "{}",
+                            description =
+                                    "{ wrapNodeIds = false :: BOOLEAN, additionalLabels = [] :: LIST<STRING>, additionalProperties = {} :: MAP }")
                     Map<String, Object> config) {
-        return new VirtualNode(node, propertyNames, Util.toBoolean(config.get("wrapNodeIds")));
+        VirtualNode virtualNode = new VirtualNode(node, propertyNames, Util.toBoolean(config.get("wrapNodeIds")));
+
+        Object labelsValue = config.get("additionalLabels");
+        if (labelsValue instanceof List<?> labels) {
+            for (Object l : labels) {
+                if (l instanceof String labelName) {
+                    virtualNode.addLabel(Label.label(labelName));
+                }
+            }
+        }
+
+        Object propsValue = config.get("additionalProperties");
+        if (propsValue instanceof Map<?, ?> props) {
+            props.forEach((key, value) -> {
+                if (key instanceof String propertyName) {
+                    virtualNode.setProperty(propertyName, value);
+                }
+            });
+        }
+
+        return virtualNode;
     }
 
     @Procedure("apoc.create.vNodes")

core/src/test/java/apoc/create/CreateTest.java

@@ -484,6 +484,101 @@ void testVirtualFromNodeFunctionWithWrapping() {
                 });
     }
 
+    @Test
+    void testVirtualFromNodeWithAdditionalLabels() {
+        testCall(
+                db,
+                """
+                        CREATE (n:Person{name:'Vincent', born: 1974} )
+                        RETURN apoc.create.virtual.fromNode(n, ['name'], { additionalLabels: ['Suspect', 'Highlighted'] }) AS node
+                        """,
+                (row) -> {
+                    Node node = (Node) row.get("node");
+
+                    assertTrue(node.hasLabel(label("Person")));
+                    assertTrue(node.hasLabel(label("Suspect")));
+                    assertTrue(node.hasLabel(label("Highlighted")));
+                    assertEquals("Vincent", node.getProperty("name"));
+                    assertNull(node.getProperty("born"));
+                });
+    }
+
+    @Test
+    void testVirtualFromNodeWithAdditionalProperties() {
+        testCall(
+                db,
+                """
+                        CREATE (n:Person{name:'Vincent', born: 1974} )
+                        RETURN apoc.create.virtual.fromNode(n, ['name'], { additionalProperties: { flagged: true, score: 42 } }) AS node
+                        """,
+                (row) -> {
+                    Node node = (Node) row.get("node");
+
+                    assertTrue(node.hasLabel(label("Person")));
+                    assertEquals("Vincent", node.getProperty("name"));
+                    assertEquals(true, node.getProperty("flagged"));
+                    assertEquals(42L, node.getProperty("score"));
+                    assertNull(node.getProperty("born"));
+                });
+    }
+
+    @Test
+    void testVirtualFromNodeWithAdditionalLabelsAndProperties() {
+        testCall(
+                db,
+                """
+                        CREATE (n:Person{name:'Vincent', born: 1974} )
+                        RETURN apoc.create.virtual.fromNode(n, ['name'], {
+                            wrapNodeIds: true,
+                            additionalLabels: ['Fraud'],
+                            additionalProperties: { risk: 'high' }
+                        }) AS node
+                        """,
+                (row) -> {
+                    Node node = (Node) row.get("node");
+
+                    assertTrue(node.hasLabel(label("Person")));
+                    assertTrue(node.hasLabel(label("Fraud")));
+                    assertTrue(node.getId() >= 0);
+                    assertEquals("Vincent", node.getProperty("name"));
+                    assertEquals("high", node.getProperty("risk"));
+                    assertNull(node.getProperty("born"));
+                });
+    }
+
+    @Test
+    void testVirtualFromNodeWithEmptyAdditionalLabelsAndProperties() {
+        testCall(
+                db,
+                """
+                        CREATE (n:Person{name:'Vincent', born: 1974} )
+                        RETURN apoc.create.virtual.fromNode(n, ['name'], { additionalLabels: [], additionalProperties: {} }) AS node
+                        """,
+                (row) -> {
+                    Node node = (Node) row.get("node");
+
+                    assertTrue(node.hasLabel(label("Person")));
+                    assertEquals(1, Iterables.count(node.getLabels()));
+                    assertEquals("Vincent", node.getProperty("name"));
+                    assertNull(node.getProperty("born"));
+                });
+    }
+
+    @Test
+    void testVirtualFromNodeAdditionalPropertyDoesNotOverwriteCopied() {
+        testCall(
+                db,
+                """
+                        CREATE (n:Person{name:'Vincent', born: 1974} )
+                        RETURN apoc.create.virtual.fromNode(n, ['name'], { additionalProperties: { name: 'Override' } }) AS node
+                        """,
+                (row) -> {
+                    Node node = (Node) row.get("node");
+
+                    assertEquals("Override", node.getProperty("name"));
+                });
+    }
+
     @Test
     void testVirtualFromNodeShouldNotEditOriginalOne() {
         db.executeTransactionally("CREATE (n:Person {name:'toUpdate'})");

core/src/test/resources/functions/common/functions.json

@@ -1360,7 +1360,7 @@
       },
       {
         "name": "config",
-        "description": "{ wrapNodeIds = false :: BOOLEAN }",
+        "description": "{ wrapNodeIds = false :: BOOLEAN, additionalLabels = [] :: LIST<STRING>, additionalProperties = {} :: MAP }",
         "isDeprecated": false,
         "default": "DefaultParameterValue{value={}, type=MAP}",
         "type": "MAP"