AP-25000: Make the 'internal view data' available to python

To the execution-function via the execution-context and the view's data
service via the view-context.

AP-25000 (Agent Chat View to output data - base version)

Author: hornm-knime

org.knime.python3.nodes/src/main/java/org/knime/python3/nodes/CloseablePythonNodeProxy.java

@@ -550,6 +550,11 @@ public PythonToolResult execute_tool(final PurePythonTablePortObject toolTable,
                 return m_toolExecutor.executeTool(toolTable, parameters, inputs, executionHints);
             }
 
+            @Override
+            public String get_internal_view_data() {
+                return ((DelegatingNodeModel)getNode().getNodeModel()).getInternalViewData();
+            }
+
         };
 
         // Configure before execution whether the gateway should be left open, otherwise an exception thrown in Python
@@ -919,7 +924,8 @@ private void throwIfFailure() throws InvalidSettingsException {
 
     @Override
     public DataServiceProxy getDataServiceProxy(final JsonNodeSettings settings, final PortObject[] portObjects,
-        final PortMapProvider portMapProvider, final CredentialsProviderProxy credentialsProvider) {
+        final String internalViewData, final PortMapProvider portMapProvider,
+        final CredentialsProviderProxy credentialsProvider) {
 
         loadValidatedSettings(settings);
 
@@ -932,7 +938,7 @@ public DataServiceProxy getDataServiceProxy(final JsonNodeSettings settings, fin
         var fileStoreSwitcher = FileStoreSwitcher.create(nnc);
         var exec = fileStoreSwitcher.createExecutionContext();
         var toolExecutor = new ToolExecutor(exec, nnc, m_tableManager);
-        var context = new DefaultViewContext(toolExecutor, portMapProvider, credentialsProvider);
+        var context = new DefaultViewContext(toolExecutor, portMapProvider, credentialsProvider, internalViewData);
 
         var fileStoresByKey = new HashMap<String, FileStore>();
         final var knimeToPythonConversionContext =

org.knime.python3.nodes/src/main/java/org/knime/python3/nodes/DefaultViewContext.java

@@ -73,11 +73,14 @@ final class DefaultViewContext implements PythonNodeViewProxy.PythonViewContext
 
     private final CredentialsProviderProxy m_credentialsProvider;
 
+    private final String m_internalViewData;
+
     DefaultViewContext(final ToolExecutor toolExecutor, final PortMapProvider portMapProvider,
-        final CredentialsProviderProxy credentialsProvider) {
+        final CredentialsProviderProxy credentialsProvider, final String internalViewData) {
         m_toolExecutor = toolExecutor;
         m_portMapProvider = portMapProvider;
         m_credentialsProvider = credentialsProvider;
+        m_internalViewData = internalViewData;
     }
 
     @Override
@@ -108,4 +111,8 @@ public PythonToolResult execute_tool(final PurePythonTablePortObject toolTable,
         return m_toolExecutor.executeTool(toolTable, parameters, inputs, executionHints);
     }
 
-}
+    @Override
+    public String get_internal_view_data() {
+        return m_internalViewData;
+    }
+}

org.knime.python3.nodes/src/main/java/org/knime/python3/nodes/extension/ExtensionNodeSetFactory.java

@@ -298,7 +298,7 @@ public NodeView createNodeView(final DelegatingNodeModel nodeModel) {
                     .canBeUsedInReport(nodeModel::canViewBeUsedInReport) //
                     .build();
             } else {
-                // The view is a static HTML file - we need a data service
+                // The view is a static HTML file - we need data services
                 Supplier<JsonRpcRequestHandler> dataServiceSupplier = () -> {
                     return new JsonRpcRequestHandler() {
 
@@ -311,7 +311,8 @@ public String handleRequest(final String jsonRpcRequest) {
                             if (m_nodeViewProxy == null) {
                                 m_nodeViewProxy = m_proxyProvider.getNodeViewProxy();
                                 m_dataServiceProxy = m_nodeViewProxy.getDataServiceProxy(nodeModel.getSettings(),
-                                    nodeModel.getInternalPortObjects(), nodeModel, nodeModel);
+                                    nodeModel.getInternalPortObjects(), nodeModel.getInternalViewData(), nodeModel,
+                                    nodeModel);
                             }
                             return m_dataServiceProxy.handleJsonRpcRequest(jsonRpcRequest);
                         }

org.knime.python3.nodes/src/main/java/org/knime/python3/nodes/proxy/NodeViewProxy.java

@@ -50,6 +50,8 @@
 
 import org.knime.core.node.port.PortObject;
 import org.knime.core.util.asynclose.AsynchronousCloseable;
+import org.knime.python3.nodes.DelegatingNodeModel;
+import org.knime.python3.nodes.proxy.PythonNodeViewProxy.PythonViewContext;
 import org.knime.python3.nodes.proxy.model.NodeModelProxy.CredentialsProviderProxy;
 import org.knime.python3.nodes.proxy.model.NodeModelProxy.PortMapProvider;
 import org.knime.python3.nodes.settings.JsonNodeSettings;
@@ -83,12 +85,16 @@ interface ViewEnvironment extends PortMapProvider, CredentialsProviderProxy {
      *
      * @param settings of the node
      * @param portObjects provided as input to the node
+     * @param internalViewData the internal view data of the node (see {@link DelegatingNodeModel#getInternalViewData()}
+     *            which is being made available to the python-side via the {@link PythonViewContext}; {@code null} if
+     *            there is no view data
      * @param portMapProvider provides the map from port groups to their indices
      * @param credentialsProvider provides access to credentials
      *
      * @return a data service that is powered by a remote proxy
      */
     DataServiceProxy getDataServiceProxy(JsonNodeSettings settings, final PortObject[] portObjects,
-        final PortMapProvider portMapProvider, final CredentialsProviderProxy credentialsProvider);
+        String internalViewData, final PortMapProvider portMapProvider,
+        final CredentialsProviderProxy credentialsProvider);
 
 }

org.knime.python3.nodes/src/main/java/org/knime/python3/nodes/proxy/PythonNodeModelProxy.java

@@ -55,6 +55,7 @@
 import org.knime.core.data.filestore.FileStore;
 import org.knime.core.table.schema.AnnotatedColumnarSchema;
 import org.knime.python3.arrow.PythonArrowDataSink;
+import org.knime.python3.nodes.DelegatingNodeModel;
 import org.knime.python3.nodes.LogCallback;
 import org.knime.python3.nodes.callback.AuthCallback;
 import org.knime.python3.nodes.ports.PythonPortObjects.PythonPortObject;
@@ -346,6 +347,10 @@ interface PythonExecutionContext extends PythonConfigurationContext, PythonToolC
          */
         String get_knime_home_dir(); // NOSONAR
 
+        /**
+         * @return the internal view data of the node (see {@link DelegatingNodeModel#getInternalViewData()}
+         */
+        String get_internal_view_data(); // NOSONAR
 
     }
 

org.knime.python3.nodes/src/main/java/org/knime/python3/nodes/proxy/PythonNodeViewProxy.java

@@ -51,6 +51,7 @@
 import java.io.IOException;
 
 import org.knime.python3.arrow.PythonArrowDataSink;
+import org.knime.python3.nodes.DelegatingNodeModel;
 import org.knime.python3.nodes.LogCallback;
 import org.knime.python3.nodes.callback.AuthCallback;
 import org.knime.python3.nodes.callback.FilestoreCallback;
@@ -122,6 +123,11 @@ default public String get_preferred_value_types_as_json(final String tableSchema
      */
     interface PythonViewContext extends PythonBaseContext, PythonToolContext {
 
+        /**
+         * @return the internal view data of the node (see {@link DelegatingNodeModel#getInternalViewData()}
+         */
+        String get_internal_view_data();
+
     }
 
 }

org.knime.python3.nodes/src/main/python/_node_backend_launcher.py

@@ -474,6 +474,9 @@ def __init__(self, java_ctx, flow_variables, type_registry: "_PortTypeRegistry")
     def get_input_port_map(self) -> Dict[str, List[int]]:
         return self._java_ctx.get_input_port_map()
 
+    def get_internal_view_data(self) -> str:
+        return self._java_ctx.get_internal_view_data()
+
 
 class _PortTypeRegistry:
     # One global dictionary for all connections

org.knime.python3.nodes/src/main/python/knime/extension/nodes.py

@@ -890,6 +890,13 @@ def get_knime_home_dir(self) -> str:
         """
         return self._java_ctx.get_knime_home_dir()
 
+    def get_internal_view_data(self) -> str:
+        """
+        Returns the internal view data for this node. I.e. data that updated when a node is
+        re-executed (~widget re-execution) and persisted with the node's 'internals'.
+        """
+        return self._java_ctx.get_internal_view_data()
+
 
 class PythonNode(ABC):
     """