feat: support REMOTE_INSTALL_URL config for remote installing and debugging (#136)

* support REMOTE_INSTALL_URL

* nit

* nit

* passing remote_install_host and remote_install_port to TCPReaderWriter

* fix the host and port parsing approach without yarl

* extract method for parsing the host and port

* nit

* nit

* nit

* nit

* improve _get_remote_install_host_and_port method

* fix style

* fix style

Author: bowenliang123

python/dify_plugin/config/config.py

@@ -24,6 +24,7 @@ class DifyPluginEnv(BaseSettings):
         description="Installation method, local or network",
     )
 
+    REMOTE_INSTALL_URL: Optional[str] = Field(description="Remote installation URL")
     REMOTE_INSTALL_HOST: str = Field(default="localhost", description="Remote installation host")
     REMOTE_INSTALL_PORT: int = Field(default=5003, description="Remote installation port")
     REMOTE_INSTALL_KEY: Optional[str] = Field(default=None, description="Remote installation key")

python/dify_plugin/plugin.py

@@ -5,6 +5,7 @@
 from typing import Any, Optional
 
 from pydantic import RootModel
+from yarl import URL
 
 from dify_plugin.config.config import DifyPluginEnv, InstallMethod
 from dify_plugin.config.logger_format import plugin_logger_handler
@@ -81,9 +82,12 @@ def _launch_remote_stream(self, config: DifyPluginEnv) -> tuple[RequestReader, O
         if not config.REMOTE_INSTALL_KEY:
             raise ValueError("Missing remote install key")
 
+        install_host, install_port = self._get_remote_install_host_and_port(config)
+        logging.debug(f"Remote installing to {install_host}:{install_port}")
+
         tcp_stream = TCPReaderWriter(
-            config.REMOTE_INSTALL_HOST,
-            config.REMOTE_INSTALL_PORT,
+            install_host,
+            install_port,
             config.REMOTE_INSTALL_KEY,
             on_connected=lambda: self._initialize_tcp_stream(tcp_stream),
         )
@@ -385,3 +389,33 @@ def _execute_request(
                     session_id=session_id,
                     data=writer.stream_object(data=response),
                 )
+
+    @staticmethod
+    def _get_remote_install_host_and_port(config: DifyPluginEnv) -> tuple[str, int]:
+        """
+        Get host and port for remote installation
+        :param config: Dify plugin env config
+        :return: host and port
+        """
+        install_url = config.REMOTE_INSTALL_URL
+        if install_url:
+            if ":" in install_url:
+                url = URL(install_url)
+                if url.host and url.port:
+                    # for the url with protocol prefix
+                    host = url.host
+                    port = url.port
+                else:
+                    # for "host:port" format
+                    split = install_url.split(":")
+                    host = split[0]
+                    port = int(split[1])
+            else:
+                raise ValueError(
+                    f'Invalid remote install URL {install_url}, which should be in the format of "host:port"'
+                )
+        else:
+            host = config.REMOTE_INSTALL_HOST
+            port = config.REMOTE_INSTALL_PORT
+
+        return host, port