Agent Zero AI framework
Hide OAuth dummy API keys until connected
Alessandroca4c9306c130
diff --git a/plugins/_oauth/AGENTS.md b/plugins/_oauth/AGENTS.mdindex 9aafa56f6..0719993b1 100644--- a/plugins/_oauth/AGENTS.md+++ b/plugins/_oauth/AGENTS.md@@ -27,6 +27,7 @@- OAuth account surfaces in settings, discovery, and onboarding must use the provider registry/status summary rather than Codex-only frontend state.- OAuth settings model slots must keep provider choice editable per slot, list only connected OAuth account providers, and persist the selected provider IDs into `chat_model.provider` and `utility_model.provider`.- `helpers/providers/registry.py` is the source of truth for connectable OAuth providers.+- OAuth provider config must not expose the dummy `oauth` API key in `conf/model_providers.yaml`; the dummy key is a runtime-only shim supplied by the `get_api_key` extension after the account provider reports connected.- Usage-plan metadata belongs only to connectable providers. Do not add metadata-only subscription families for providers this plugin cannot connect.- API handlers should remain provider-aware. Missing or blank `provider_id` defaults to Codex only for existing backward compatibility; falsey non-string IDs must not silently default.- Codex success contracts must preserve legacy fields such as `account_id` while allowing newer fields such as `account_label`.diff --git a/plugins/_oauth/README.md b/plugins/_oauth/README.mdindex b757274ec..f343acfe4 100644--- a/plugins/_oauth/README.md+++ b/plugins/_oauth/README.md@@ -8,6 +8,8 @@ The settings UI groups providers as account-backed connections. More than one acEach model slot has its own provider selector. The selector lists connected OAuth accounts only, so Main and Utility can use different account-backed providers when more than one account is connected.+OAuth-backed model providers do not require users to enter API keys. Agent Zero supplies a local dummy key only at runtime after the selected account provider is connected, so unconnected providers stay blank in API-key surfaces.+## Providers### Codex/ChatGPT (`codex_oauth`)diff --git a/plugins/_oauth/conf/model_providers.yaml b/plugins/_oauth/conf/model_providers.yamlindex 8af6bf491..a9f5f36a6 100644--- a/plugins/_oauth/conf/model_providers.yaml+++ b/plugins/_oauth/conf/model_providers.yaml@@ -7,7 +7,6 @@ chat:endpoint_url: "/models"kwargs:api_base: "http://127.0.0.1/oauth/codex/v1"- api_key: "oauth"github_copilot_oauth:name: GitHub Copilot Accountlitellm_provider: openai@@ -16,7 +15,6 @@ chat:endpoint_url: "/models"kwargs:api_base: "http://127.0.0.1/oauth/github-copilot/v1"- api_key: "oauth"gemini_api_oauth:name: Google Gemini API Accountlitellm_provider: openai@@ -25,7 +23,6 @@ chat:endpoint_url: "/models"kwargs:api_base: "http://127.0.0.1/oauth/gemini-api/v1"- api_key: "oauth"xai_grok_oauth:name: xAI Grok Accountlitellm_provider: openai@@ -34,4 +31,3 @@ chat:endpoint_url: "/models"kwargs:api_base: "http://127.0.0.1/oauth/xai-grok/v1"- api_key: "oauth"diff --git a/plugins/_oauth/extensions/python/_functions/models/get_api_key/end/_20_oauth_account_dummy_key.py b/plugins/_oauth/extensions/python/_functions/models/get_api_key/end/_20_oauth_account_dummy_key.pyindex f90703faa..35680303a 100644--- a/plugins/_oauth/extensions/python/_functions/models/get_api_key/end/_20_oauth_account_dummy_key.py+++ b/plugins/_oauth/extensions/python/_functions/models/get_api_key/end/_20_oauth_account_dummy_key.py@@ -1,7 +1,7 @@from __future__ import annotationsfrom helpers.extension import Extension-from plugins._oauth.helpers.providers import DUMMY_API_KEY, oauth_provider_ids+from plugins._oauth.helpers.providers import DUMMY_API_KEY, get_provider, oauth_provider_idsclass OAuthAccountDummyKey(Extension):@@ -22,5 +22,15 @@ class OAuthAccountDummyKey(Extension):returnresult = str(data.get("result") or "").strip()- if not result or result == "None":+ if (not result or result == "None") and oauth_provider_is_connected(service):data["result"] = DUMMY_API_KEY+++def oauth_provider_is_connected(provider_id: str) -> bool:+ try:+ status = get_provider(provider_id).status()+ except Exception:+ return False+ if not isinstance(status, dict):+ return False+ return bool(status.get("connected"))diff --git a/tests/test_oauth_codex.py b/tests/test_oauth_codex.pyindex 9391ec16d..4a2fb31e6 100644--- a/tests/test_oauth_codex.py+++ b/tests/test_oauth_codex.py@@ -15,8 +15,8 @@ import yamlsys.path.insert(0, str(Path(__file__).resolve().parents[1]))from plugins._oauth.helpers import codexfrom plugins._oauth.helpers import routes-from plugins._oauth.extensions.python._functions.models.get_api_key.end._20_oauth_account_dummy_key import (- OAuthAccountDummyKey,+from plugins._oauth.extensions.python._functions.models.get_api_key.end import (+ _20_oauth_account_dummy_key as oauth_dummy_key,)@@ -686,10 +686,20 @@ def test_provider_config_uses_container_local_agent_zero_origin():assert "50001" not in json.dumps(codex_provider)-def test_codex_provider_reports_dummy_api_key_when_missing():+def test_codex_provider_leaves_api_key_empty_until_connected(monkeypatch):+ monkeypatch.setattr(oauth_dummy_key, "oauth_provider_is_connected", lambda _provider_id: False)data = {"args": ("codex_oauth",), "kwargs": {}, "result": "None"}- OAuthAccountDummyKey(agent=None).execute(data=data)+ oauth_dummy_key.OAuthAccountDummyKey(agent=None).execute(data=data)++ assert data["result"] == "None"+++def test_codex_provider_reports_dummy_api_key_when_connected(monkeypatch):+ monkeypatch.setattr(oauth_dummy_key, "oauth_provider_is_connected", lambda _provider_id: True)+ data = {"args": ("codex_oauth",), "kwargs": {}, "result": "None"}++ oauth_dummy_key.OAuthAccountDummyKey(agent=None).execute(data=data)assert data["result"] == "oauth"@@ -697,6 +707,6 @@ def test_codex_provider_reports_dummy_api_key_when_missing():def test_codex_provider_preserves_configured_api_key():data = {"args": ("codex_oauth",), "kwargs": {}, "result": "configured"}- OAuthAccountDummyKey(agent=None).execute(data=data)+ oauth_dummy_key.OAuthAccountDummyKey(agent=None).execute(data=data)assert data["result"] == "configured"diff --git a/tests/test_oauth_providers.py b/tests/test_oauth_providers.pyindex 5015a593f..baf1da369 100644--- a/tests/test_oauth_providers.py+++ b/tests/test_oauth_providers.py@@ -55,8 +55,8 @@ from plugins._oauth.api import poll_device_login as poll_device_login_apifrom plugins._oauth.api import start_device_login as start_device_login_apifrom plugins._oauth.api import start_login as start_login_apifrom plugins._oauth.api.models import Models-from plugins._oauth.extensions.python._functions.models.get_api_key.end._20_oauth_account_dummy_key import (- OAuthAccountDummyKey,+from plugins._oauth.extensions.python._functions.models.get_api_key.end import (+ _20_oauth_account_dummy_key as oauth_dummy_key,)from plugins._oauth.helpers import statefrom plugins._oauth.helpers.providers import base as provider_base@@ -665,10 +665,25 @@ def test_poll_device_login_unknown_provider_returns_structured_error():[CODEX_PROVIDER_ID, GITHUB_COPILOT_PROVIDER_ID, GEMINI_API_PROVIDER_ID, XAI_GROK_PROVIDER_ID],)@pytest.mark.parametrize("initial", [None, "None"])-def test_oauth_providers_report_dummy_api_key_when_missing(provider_id, initial):+def test_oauth_providers_leave_api_key_empty_until_connected(monkeypatch, provider_id, initial):+ monkeypatch.setattr(oauth_dummy_key, "oauth_provider_is_connected", lambda _provider_id: False)data = {"args": (provider_id,), "kwargs": {}, "result": initial}- OAuthAccountDummyKey(agent=None).execute(data=data)+ oauth_dummy_key.OAuthAccountDummyKey(agent=None).execute(data=data)++ assert data["result"] == initial+++ "provider_id",+ [CODEX_PROVIDER_ID, GITHUB_COPILOT_PROVIDER_ID, GEMINI_API_PROVIDER_ID, XAI_GROK_PROVIDER_ID],+)[email protected]("initial", [None, "None"])+def test_oauth_providers_report_dummy_api_key_when_connected(monkeypatch, provider_id, initial):+ monkeypatch.setattr(oauth_dummy_key, "oauth_provider_is_connected", lambda _provider_id: True)+ data = {"args": (provider_id,), "kwargs": {}, "result": initial}++ oauth_dummy_key.OAuthAccountDummyKey(agent=None).execute(data=data)assert data["result"] == DUMMY_API_KEY@@ -677,12 +692,13 @@ def test_oauth_providers_report_dummy_api_key_when_missing(provider_id, initial)"provider_id",[CODEX_PROVIDER_ID, GITHUB_COPILOT_PROVIDER_ID, GEMINI_API_PROVIDER_ID, XAI_GROK_PROVIDER_ID],)-def test_oauth_providers_report_dummy_api_key_when_result_missing(provider_id):+def test_oauth_providers_leave_missing_result_unset_when_disconnected(monkeypatch, provider_id):+ monkeypatch.setattr(oauth_dummy_key, "oauth_provider_is_connected", lambda _provider_id: False)data = {"args": (provider_id,), "kwargs": {}}- OAuthAccountDummyKey(agent=None).execute(data=data)+ oauth_dummy_key.OAuthAccountDummyKey(agent=None).execute(data=data)- assert data["result"] == DUMMY_API_KEY+ assert "result" not in data@pytest.mark.parametrize(@@ -692,7 +708,7 @@ def test_oauth_providers_report_dummy_api_key_when_result_missing(provider_id):def test_oauth_providers_preserve_configured_api_key(provider_id):data = {"args": (provider_id,), "kwargs": {}, "result": "configured"}- OAuthAccountDummyKey(agent=None).execute(data=data)+ oauth_dummy_key.OAuthAccountDummyKey(agent=None).execute(data=data)assert data["result"] == "configured"@@ -708,10 +724,10 @@ def test_model_provider_config_contains_all_oauth_providers():GEMINI_API_PROVIDER_ID,XAI_GROK_PROVIDER_ID,}- assert chat[CODEX_PROVIDER_ID]["kwargs"]["api_key"] == DUMMY_API_KEY- assert chat[GITHUB_COPILOT_PROVIDER_ID]["kwargs"]["api_key"] == DUMMY_API_KEY- assert chat[GEMINI_API_PROVIDER_ID]["kwargs"]["api_key"] == DUMMY_API_KEY- assert chat[XAI_GROK_PROVIDER_ID]["kwargs"]["api_key"] == DUMMY_API_KEY+ assert "api_key" not in chat[CODEX_PROVIDER_ID]["kwargs"]+ assert "api_key" not in chat[GITHUB_COPILOT_PROVIDER_ID]["kwargs"]+ assert "api_key" not in chat[GEMINI_API_PROVIDER_ID]["kwargs"]+ assert "api_key" not in chat[XAI_GROK_PROVIDER_ID]["kwargs"]assert chat[CODEX_PROVIDER_ID]["kwargs"]["api_base"] == "http://127.0.0.1/oauth/codex/v1"assert (chat[GITHUB_COPILOT_PROVIDER_ID]["kwargs"]["api_base"]