dify_plugin 0.4.2b1__tar.gz → 0.4.2b2__tar.gz

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dify_plugin
-Version: 0.4.2b1
+Version: 0.4.2b2
 Summary: Dify Plugin SDK
 Keywords: dify,plugin,sdk
 Author-Email: langgenius <hello@dify.ai>

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/dify_plugin/config/integration_config.py

@@ -52,4 +52,4 @@ class IntegrationConfig(BaseSettings):
 
         return v
 
-    model_config = SettingsConfigDict(env_file=".env")
+    model_config = SettingsConfigDict(env_file=".env", extra="allow")

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/dify_plugin/core/entities/plugin/request.py

@@ -58,6 +58,7 @@ class EndpointActions(StrEnum):
 class OAuthActions(StrEnum):
     GetAuthorizationUrl = "get_authorization_url"
     GetCredentials = "get_credentials"
+    RefreshCredentials = "refresh_credentials"
 
 
 class DynamicParameterActions(StrEnum):
@@ -260,6 +261,15 @@ class OAuthGetCredentialsRequest(PluginAccessRequest):
     raw_http_request: str
 
 
+class OAuthRefreshCredentialsRequest(PluginAccessRequest):
+    type: PluginInvokeType = PluginInvokeType.OAuth
+    action: OAuthActions = OAuthActions.RefreshCredentials
+    provider: str
+    redirect_uri: str
+    system_credentials: Mapping[str, Any]
+    credentials: Mapping[str, Any]
+
+
 class DynamicParameterFetchParameterOptionsRequest(BaseModel):
     type: PluginInvokeType = PluginInvokeType.DynamicParameter
     action: DynamicParameterActions = DynamicParameterActions.FetchParameterOptions

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/dify_plugin/core/plugin_executor.py

@@ -23,6 +23,7 @@ from dify_plugin.core.entities.plugin.request import (
     ModelValidateProviderCredentialsRequest,
     OAuthGetAuthorizationUrlRequest,
     OAuthGetCredentialsRequest,
+    OAuthRefreshCredentialsRequest,
     ToolGetRuntimeParametersRequest,
     ToolInvokeRequest,
     ToolValidateCredentialsRequest,
@@ -349,8 +350,23 @@ class PluginExecutor:
         bytes_data = binascii.unhexlify(data.raw_http_request)
         request = parse_raw_request(bytes_data)
 
+        credentials = provider_instance.oauth_get_credentials(data.redirect_uri, data.system_credentials, request)
+
+        return {
+            "metadata": credentials.metadata or {},
+            "credentials": credentials.credentials,
+            "expires_at": credentials.expires_at,
+        }
+
+    def refresh_oauth_credentials(self, session: Session, data: OAuthRefreshCredentialsRequest):
+        provider_instance = self._get_oauth_provider_instance(data.provider)
+        credentials = provider_instance.oauth_refresh_credentials(
+            data.redirect_uri, data.system_credentials, data.credentials
+        )
+
         return {
-            "credentials": provider_instance.oauth_get_credentials(data.redirect_uri, data.system_credentials, request),
+            "credentials": credentials.credentials,
+            "expires_at": credentials.expires_at,
         }
 
     def _get_dynamic_parameter_action(

dify_plugin-0.4.2b2/dify_plugin/entities/oauth.py

@@ -0,0 +1,35 @@
+from collections.abc import Mapping, Sequence
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from dify_plugin.core.documentation.schema_doc import docs
+from dify_plugin.entities.provider_config import ProviderConfig
+
+
+@docs(
+    name="OAuthSchema",
+    description="The schema of the OAuth",
+)
+class OAuthSchema(BaseModel):
+    client_schema: Sequence[ProviderConfig] = Field(default_factory=list, description="The schema of the OAuth client")
+    credentials_schema: Sequence[ProviderConfig] = Field(
+        default_factory=list, description="The schema of the OAuth credentials"
+    )
+
+
+class OAuthCredentials(BaseModel):
+    metadata: Mapping[str, Any] = Field(default_factory=dict, description="The metadata like avatar_url, name, etc.")
+    credentials: Mapping[str, Any] = Field(..., description="The credentials of the OAuth")
+    expires_at: int = Field(
+        default=-1, description="The timestamp of the credentials expiration, -1 means never expires"
+    )
+
+
+class ToolOAuthCredentials(BaseModel):
+    credentials: Mapping[str, Any] = Field(..., description="The credentials of the tool")
+    expires_at: int | None = Field(
+        default=-1,
+        description="""The expiration timestamp (in seconds since Unix epoch, UTC) of the credentials.
+        Set to -1 or None if the credentials do not expire.""",
+    )

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/dify_plugin/errors/tool.py

@@ -1,2 +1,6 @@
 class ToolProviderCredentialValidationError(Exception):
     pass
+
+
+class ToolProviderOAuthError(Exception):
+    pass

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/dify_plugin/integration/run.py

@@ -147,6 +147,12 @@ class PluginRunner:
         os.close(self.stdin_pipe_read)
 
     def _read_async(self, fd: int) -> bytes:
+        import select
+
+        ready, _, _ = select.select([fd], [], [], 0.1)
+        if not ready:
+            return b""
+
         # read data from stdin using os.read in 64KB chunks.
         # the OS buffer for stdin is usually 64KB, so using a larger value doesn't make sense.
         b = os.read(fd, 65536)
@@ -155,6 +161,8 @@ class PluginRunner:
         return b
 
     def _message_reader(self, pipe: int):
+        import time
+
         # create a scanner to read the message line by line
         """Read messages line by line from the pipe."""
         buffer = b""
@@ -166,6 +174,7 @@ class PluginRunner:
                     break
 
                 if not data:
+                    time.sleep(0.01)
                     continue
 
                 buffer += data

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/dify_plugin/interfaces/tool/__init__.py

@@ -8,11 +8,13 @@ from werkzeug import Request
 from dify_plugin.core.runtime import Session
 from dify_plugin.entities import ParameterOption
 from dify_plugin.entities.invoke_message import InvokeMessage
+from dify_plugin.entities.oauth import ToolOAuthCredentials
 from dify_plugin.entities.provider_config import LogMetadata
 from dify_plugin.entities.tool import ToolInvokeMessage, ToolParameter, ToolRuntime, ToolSelector
 from dify_plugin.file.constants import DIFY_FILE_IDENTITY, DIFY_TOOL_SELECTOR_IDENTITY
 from dify_plugin.file.entities import FileType
 from dify_plugin.file.file import File
+from dify_plugin.protocol.oauth import OAuthCredentials
 
 T = TypeVar("T", bound=InvokeMessage)
 
@@ -234,24 +236,70 @@ class ToolProvider:
 
     def _validate_credentials(self, credentials: dict):
         raise NotImplementedError(
-            "This plugin should implement `_validate_credentials` method to enable credentials validation"
+            "The tool you are using does not support credentials validation, "
+            "please implement `_validate_credentials` method"
         )
 
     def oauth_get_authorization_url(self, redirect_uri: str, system_credentials: Mapping[str, Any]) -> str:
+        """
+        Get the authorization url
+
+        :param redirect_uri: redirect uri
+        :param system_credentials: system credentials
+        :return: authorization url
+        """
         return self._oauth_get_authorization_url(redirect_uri, system_credentials)
 
     def _oauth_get_authorization_url(self, redirect_uri: str, system_credentials: Mapping[str, Any]) -> str:
-        raise NotImplementedError("This method should be implemented by a subclass")
+        raise NotImplementedError(
+            "The tool you are using does not support OAuth, please implement `_oauth_get_authorization_url` method"
+        )
 
     def oauth_get_credentials(
         self, redirect_uri: str, system_credentials: Mapping[str, Any], request: Request
-    ) -> Mapping[str, Any]:
-        return self._oauth_get_credentials(redirect_uri, system_credentials, request)
+    ) -> OAuthCredentials:
+        """
+        Get the credentials
+
+        :param redirect_uri: redirect uri
+        :param system_credentials: system credentials
+        :param request: raw http request
+        :return: credentials
+        """
+        tool_oauth_credentials = self._oauth_get_credentials(redirect_uri, system_credentials, request)
+        return OAuthCredentials(
+            credentials=tool_oauth_credentials.credentials, expires_at=tool_oauth_credentials.expires_at
+        )
 
     def _oauth_get_credentials(
         self, redirect_uri: str, system_credentials: Mapping[str, Any], request: Request
-    ) -> Mapping[str, Any]:
-        raise NotImplementedError("This method should be implemented by a subclass")
+    ) -> ToolOAuthCredentials:
+        raise NotImplementedError(
+            "The tool you are using does not support OAuth, please implement `_oauth_get_credentials` method"
+        )
+
+    def oauth_refresh_credentials(
+        self, redirect_uri: str, system_credentials: Mapping[str, Any], credentials: Mapping[str, Any]
+    ) -> OAuthCredentials:
+        """
+        Refresh the credentials
+
+        :param redirect_uri: redirect uri
+        :param system_credentials: system credentials
+        :param credentials: credentials
+        :return: refreshed credentials
+        """
+        tool_oauth_credentials = self._oauth_refresh_credentials(redirect_uri, system_credentials, credentials)
+        return OAuthCredentials(
+            credentials=tool_oauth_credentials.credentials, expires_at=tool_oauth_credentials.expires_at
+        )
+
+    def _oauth_refresh_credentials(
+        self, redirect_uri: str, system_credentials: Mapping[str, Any], credentials: Mapping[str, Any]
+    ) -> ToolOAuthCredentials:
+        raise NotImplementedError(
+            "The tool you are using does not support OAuth, please implement `_oauth_refresh_credentials` method"
+        )
 
 
 class Tool(ToolLike[ToolInvokeMessage]):

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/dify_plugin/plugin.py

@@ -322,6 +322,12 @@ class Plugin(IOServer, Router):
             and data.get("action") == OAuthActions.GetCredentials.value,
         )
 
+        self.register_route(
+            self.plugin_executer.refresh_oauth_credentials,
+            lambda data: data.get("type") == PluginInvokeType.OAuth.value
+            and data.get("action") == OAuthActions.RefreshCredentials.value,
+        )
+
     def _execute_request(
         self,
         session_id: str,

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/dify_plugin/protocol/oauth.py

@@ -3,6 +3,8 @@ from typing import Any, Protocol
 
 from werkzeug import Request
 
+from dify_plugin.entities.oauth import OAuthCredentials
+
 
 class OAuthProviderProtocol(Protocol):
     def oauth_get_authorization_url(self, redirect_uri: str, system_credentials: Mapping[str, Any]) -> str:
@@ -19,7 +21,7 @@ class OAuthProviderProtocol(Protocol):
         redirect_uri: str,
         system_credentials: Mapping[str, Any],
         request: Request,
-    ) -> Mapping[str, Any]:
+    ) -> OAuthCredentials:
         """
         Get the credentials
         :param redirect_uri: redirect uri
@@ -28,3 +30,18 @@ class OAuthProviderProtocol(Protocol):
         :return: credentials
         """
         ...
+
+    def oauth_refresh_credentials(
+        self,
+        redirect_uri: str,
+        system_credentials: Mapping[str, Any],
+        credentials: Mapping[str, Any],
+    ) -> OAuthCredentials:
+        """
+        Refresh the credentials
+        :param redirect_uri: redirect uri
+        :param system_credentials: system credentials
+        :param credentials: credentials
+        :return: credentials
+        """
+        ...

{dify_plugin-0.4.2b1 → dify_plugin-0.4.2b2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dify_plugin"
-version = "0.4.2b1"
+version = "0.4.2b2"
 description = "Dify Plugin SDK"
 authors = [
     { name = "langgenius", email = "hello@dify.ai" },

dify_plugin-0.4.2b1/dify_plugin/entities/oauth.py

@@ -1,17 +0,0 @@
-from collections.abc import Sequence
-
-from pydantic import BaseModel, Field
-
-from dify_plugin.core.documentation.schema_doc import docs
-from dify_plugin.entities.provider_config import ProviderConfig
-
-
-@docs(
-    name="OAuthSchema",
-    description="The schema of the OAuth",
-)
-class OAuthSchema(BaseModel):
-    client_schema: Sequence[ProviderConfig] = Field(default_factory=list, description="The schema of the OAuth client")
-    credentials_schema: Sequence[ProviderConfig] = Field(
-        default_factory=list, description="The schema of the OAuth credentials"
-    )