fix: don't require API key for local tools (#1122)

Author: tushar-composio

python/composio/client/collections.py

@@ -1538,4 +1538,8 @@ class Logs(Collection[LogRecord]):
 
     def push(self, record: t.Dict) -> None:
         """Push logs to composio."""
+        # TODO: handle this better
+        if self.client._api_key is None:  # pylint: disable=protected-access
+            return
+
         self.client.http.post(url=str(self.endpoint), json=record)

python/composio/tools/env/base.py

@@ -159,26 +159,11 @@ def __init__(self, config: WorkspaceConfigType):
         super().__init__()
         self.id = generate_id()
         self.access_token = uuid4().hex.replace("-", "")
-        self.composio_api_key = _read_env_var(
-            name=ENV_COMPOSIO_API_KEY,
-            default=config.composio_api_key,
-        )
-        self.composio_base_url = _read_env_var(
-            name=ENV_COMPOSIO_BASE_URL,
-            default=config.composio_base_url,
-        )
-        self.github_access_token = config.github_access_token or os.environ.get(
-            ENV_GITHUB_ACCESS_TOKEN, "NO_VALUE"
-        )
+        self.persistent = config.persistent
         self.environment = {
             **(config.environment or {}),
-            ENV_COMPOSIO_API_KEY: self.composio_api_key,
-            ENV_COMPOSIO_BASE_URL: self.composio_base_url,
-            ENV_GITHUB_ACCESS_TOKEN: self.github_access_token,
-            f"_COMPOSIO_{ENV_GITHUB_ACCESS_TOKEN}": self.github_access_token,
             ENV_ACCESS_TOKEN: self.access_token,
         }
-        self.persistent = config.persistent
 
     def __str__(self) -> str:
         """String representation."""
@@ -220,6 +205,31 @@ def teardown(self) -> None:
 class RemoteWorkspace(Workspace):
     """Remote workspace client."""
 
+    def __init__(self, config: WorkspaceConfigType):
+        super().__init__(config)
+        self.composio_api_key = _read_env_var(
+            name=ENV_COMPOSIO_API_KEY,
+            default=config.composio_api_key,
+        )
+        self.composio_base_url = _read_env_var(
+            name=ENV_COMPOSIO_BASE_URL,
+            default=config.composio_base_url,
+        )
+        self.github_access_token = (
+            config.github_access_token
+            if config.github_access_token is not None
+            else os.environ.get(ENV_GITHUB_ACCESS_TOKEN, "NO_VALUE")
+        )
+        self.environment.update(
+            {
+                ENV_COMPOSIO_API_KEY: self.composio_api_key,
+                ENV_COMPOSIO_BASE_URL: self.composio_base_url,
+                ENV_GITHUB_ACCESS_TOKEN: self.github_access_token,
+                f"_COMPOSIO_{ENV_GITHUB_ACCESS_TOKEN}": self.github_access_token,
+                ENV_ACCESS_TOKEN: self.access_token,
+            }
+        )
+
     def _request(
         self,
         endpoint: str,

python/composio/tools/toolset.py

@@ -418,12 +418,20 @@ def workspace(self) -> Workspace:
 
         workspace_config = self._workspace_config or HostWorkspaceConfig()
         if workspace_config.composio_api_key is None:
-            workspace_config.composio_api_key = self.api_key
+            try:
+                workspace_config.composio_api_key = self.api_key
+            except ApiKeyNotProvidedError:
+                warnings.warn(
+                    "Running without a Composio API key", UserWarning, stacklevel=2
+                )
 
         if workspace_config.composio_base_url is None:
             workspace_config.composio_base_url = self._base_url
 
-        if workspace_config.github_access_token is None:
+        if (
+            workspace_config.github_access_token is None
+            and workspace_config.composio_api_key is not None
+        ):
             workspace_config.github_access_token = (
                 self._try_get_github_access_token_for_current_entity()
             )

python/tests/test_tools/test_env/test_base.py

@@ -9,16 +9,16 @@
 from composio.client.enums import Action, ActionType, AppType, TagType
 from composio.exceptions import ComposioSDKError
 from composio.tools.env.base import (
+    RemoteWorkspace,
     SessionFactory,
     Sessionable,
-    Workspace,
     WorkspaceConfigType,
 )
 from composio.tools.env.id import generate_id
 
 
-def test_workspace() -> None:
-    class TestWorkspace(Workspace):
+def test_remote_workspace() -> None:
+    class TestRemoteWorkspace(RemoteWorkspace):
         def check_for_missing_dependencies(
             self,
             apps: t.Optional[t.Sequence[AppType]] = None,
@@ -46,7 +46,7 @@ def teardown(self) -> None:
         ComposioSDKError,
         match="Please provide value for `COMPOSIO_API_KEY`",
     ):
-        _ = TestWorkspace(config=WorkspaceConfigType())
+        _ = TestRemoteWorkspace(config=WorkspaceConfigType())
 
 
 def test_sessionable() -> None:

python/tests/test_tools/test_toolset.py

@@ -154,17 +154,17 @@ def _patch(*_, **kwargs):
             )
 
 
-def test_api_key_missing() -> None:
+def test_api_key_missing(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setenv("COMPOSIO_API_KEY", "")
     toolset = ComposioToolSet()
-    toolset._api_key = None  # pylint: disable=protected-access
     with pytest.raises(
         ApiKeyNotProvidedError,
         match=(
             "API Key not provided, either provide API key or export it as "
             "`COMPOSIO_API_KEY` or run `composio login`"
         ),
     ):
-        _ = toolset.workspace
+        _ = toolset.execute_action(Action.HACKERNEWS_GET_FRONTPAGE, {})
 
 
 def test_processors(monkeypatch: pytest.MonkeyPatch) -> None: