Skip to content

Automate browser based workflows with AI

fix(SKY-12271): Email Inbox review follow-ups (#7309)

Suchintan448f069034f4
diff --git a/skyvern-frontend/src/routes/workflows/editor/nodes/EmailInboxNode/EmailInboxEditor.tsx b/skyvern-frontend/src/routes/workflows/editor/nodes/EmailInboxNode/EmailInboxEditor.tsx
index 5f43ef2cc..68c3520c4 100644
--- a/skyvern-frontend/src/routes/workflows/editor/nodes/EmailInboxNode/EmailInboxEditor.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/nodes/EmailInboxNode/EmailInboxEditor.tsx
@@ -27,6 +27,7 @@ import {
import { GOOGLE_GMAIL_REQUIRED_SCOPES } from "@/util/googleScopes";
import { helpTooltips } from "../../helpContent";
+import { containsJinjaReference } from "../../jinjaReferences";
import { useUpdate } from "../../useUpdate";
import { getAvailableOutputParameterKeys } from "../../workflowEditorUtils";
import { type AppNode } from "..";
@@ -50,6 +51,11 @@ function parsePositiveInteger(value: string, fallback: number): number {
return Number.isNaN(parsed) ? fallback : parsed;
}
+function getTemplateParameterKey(value: string): string | null {
+ const match = /^\s*\{\{\s*([A-Za-z_]\w*)\s*\}\}\s*$/.exec(value);
+ return match?.[1] ?? null;
+}
+
function FieldLabel({
field,
label,
@@ -96,6 +102,26 @@ function EmailInboxEditorBody({
update({ emailClient, credentialId: "" });
};
+ const updateCredentialId = (credentialId: string) => {
+ const parameterKey = getTemplateParameterKey(credentialId);
+ const previousParameterKey = getTemplateParameterKey(data.credentialId);
+ const previousParameterKeyIsUsedElsewhere = previousParameterKey
+ ? [data.folder, data.prompt, data.sender, data.subject].some((value) =>
+ containsJinjaReference(value, previousParameterKey),
+ )
+ : false;
+ const parameterKeys = previousParameterKeyIsUsedElsewhere
+ ? [...data.parameterKeys]
+ : data.parameterKeys.filter((key) => key !== previousParameterKey);
+ if (parameterKey && !parameterKeys.includes(parameterKey)) {
+ parameterKeys.push(parameterKey);
+ }
+ update({
+ credentialId,
+ parameterKeys,
+ });
+ };
+
return (
<div data-testid="email-inbox-block-form" className="space-y-4">
<div className="space-y-3">
@@ -137,14 +163,14 @@ function EmailInboxEditorBody({
<GoogleOAuthCredentialSelector
nodeId={blockId}
value={data.credentialId}
- onChange={(next) => update({ credentialId: next })}
+ onChange={updateCredentialId}
requiredScopes={GOOGLE_GMAIL_REQUIRED_SCOPES}
/>
) : (
<MicrosoftOAuthCredentialSelector
nodeId={blockId}
value={data.credentialId}
- onChange={(next) => update({ credentialId: next })}
+ onChange={updateCredentialId}
requiredScopes={MICROSOFT_MAIL_REQUIRED_SCOPES}
/>
)}
diff --git a/skyvern-frontend/src/routes/workflows/editor/panels/BlockConfigForm/EmailInboxBlockForm.test.tsx b/skyvern-frontend/src/routes/workflows/editor/panels/BlockConfigForm/EmailInboxBlockForm.test.tsx
index c1c70a23d..0f6697181 100644
--- a/skyvern-frontend/src/routes/workflows/editor/panels/BlockConfigForm/EmailInboxBlockForm.test.tsx
+++ b/skyvern-frontend/src/routes/workflows/editor/panels/BlockConfigForm/EmailInboxBlockForm.test.tsx
@@ -41,7 +41,16 @@ vi.mock("@/components/WorkflowBlockInputTextarea", () => ({
}));
vi.mock("@/routes/workflows/components/GoogleOAuthCredentialSelector", () => ({
- GoogleOAuthCredentialSelector: () => <div />,
+ GoogleOAuthCredentialSelector: ({
+ onChange,
+ }: {
+ onChange: (next: string) => void;
+ }) => (
+ <button
+ data-testid="gmail-template-change"
+ onClick={() => onChange("{{ gmail_credential_id }}")}
+ />
+ ),
}));
vi.mock(
@@ -81,6 +90,7 @@ vi.mock("../../nodes/TaskNode/ParametersMultiSelect", () => ({
}
>
<option value="microsoft_credential_id">microsoft_credential_id</option>
+ <option value="gmail_credential_id">gmail_credential_id</option>
</select>
),
}));
@@ -126,4 +136,94 @@ describe("EmailInboxBlockForm", () => {
parameterKeys: ["microsoft_credential_id"],
});
});
+
+ test("tracks the parameter key used by a Gmail credential template", () => {
+ mockNodes.set("email-1", {
+ id: "email-1",
+ type: "emailInbox",
+ data: {
+ ...emailInboxNodeDefaultData,
+ emailClient: "gmail",
+ },
+ });
+ render(<EmailInboxBlockForm blockId="email-1" />);
+
+ fireEvent.click(screen.getByTestId("gmail-template-change"));
+
+ expect(updateNodeData).toHaveBeenCalledWith("email-1", {
+ credentialId: "{{ gmail_credential_id }}",
+ parameterKeys: ["gmail_credential_id"],
+ });
+ });
+
+ test("replaces a stale credential parameter key", () => {
+ mockNodes.set("email-1", {
+ id: "email-1",
+ type: "emailInbox",
+ data: {
+ ...emailInboxNodeDefaultData,
+ emailClient: "gmail",
+ credentialId: "{{ microsoft_credential_id }}",
+ parameterKeys: ["microsoft_credential_id", "other_parameter"],
+ },
+ });
+ render(<EmailInboxBlockForm blockId="email-1" />);
+
+ fireEvent.click(screen.getByTestId("gmail-template-change"));
+
+ expect(updateNodeData).toHaveBeenCalledWith("email-1", {
+ credentialId: "{{ gmail_credential_id }}",
+ parameterKeys: ["other_parameter", "gmail_credential_id"],
+ });
+ });
+
+ test("preserves the previous credential key when another field uses it", () => {
+ mockNodes.set("email-1", {
+ id: "email-1",
+ type: "emailInbox",
+ data: {
+ ...emailInboxNodeDefaultData,
+ emailClient: "gmail",
+ credentialId: "{{ microsoft_credential_id }}",
+ folder: "{{ microsoft_credential_id }}",
+ parameterKeys: ["microsoft_credential_id"],
+ },
+ });
+ render(<EmailInboxBlockForm blockId="email-1" />);
+
+ fireEvent.click(screen.getByTestId("gmail-template-change"));
+
+ expect(updateNodeData).toHaveBeenCalledWith("email-1", {
+ credentialId: "{{ gmail_credential_id }}",
+ parameterKeys: ["microsoft_credential_id", "gmail_credential_id"],
+ });
+ });
+
+ test.each([
+ "{{ microsoft_credential_id.id }}",
+ "{{ microsoft_credential_id | default('INBOX') }}",
+ ])(
+ "preserves the previous credential key for a suffixed reference: %s",
+ (folder) => {
+ mockNodes.set("email-1", {
+ id: "email-1",
+ type: "emailInbox",
+ data: {
+ ...emailInboxNodeDefaultData,
+ emailClient: "gmail",
+ credentialId: "{{ microsoft_credential_id }}",
+ folder,
+ parameterKeys: ["microsoft_credential_id"],
+ },
+ });
+ render(<EmailInboxBlockForm blockId="email-1" />);
+
+ fireEvent.click(screen.getByTestId("gmail-template-change"));
+
+ expect(updateNodeData).toHaveBeenCalledWith("email-1", {
+ credentialId: "{{ gmail_credential_id }}",
+ parameterKeys: ["microsoft_credential_id", "gmail_credential_id"],
+ });
+ },
+ );
});
diff --git a/skyvern/forge/sdk/services/microsoft_oauth_service.py b/skyvern/forge/sdk/services/microsoft_oauth_service.py
index c58929729..50399dba0 100644
--- a/skyvern/forge/sdk/services/microsoft_oauth_service.py
+++ b/skyvern/forge/sdk/services/microsoft_oauth_service.py
@@ -412,15 +412,25 @@ async def refresh_and_rotate(
and new_refresh_token
and new_refresh_token != credential_secrets.refresh_token
):
- encrypted_refresh_token = await encryptor.encrypt(new_refresh_token, EncryptMethod.AES)
- now = datetime.datetime.now(datetime.UTC).replace(tzinfo=None)
- await app.DATABASE.microsoft_oauth.update_active_refresh_token(
- organization_id=organization_id,
- credential_id=credential_id,
- encrypted_refresh_token=encrypted_refresh_token,
- encrypted_method=EncryptMethod.AES,
- now=now,
- )
+ try:
+ encrypted_refresh_token = await encryptor.encrypt(new_refresh_token, EncryptMethod.AES)
+ now = datetime.datetime.now(datetime.UTC).replace(tzinfo=None)
+ await app.DATABASE.microsoft_oauth.update_active_refresh_token(
+ organization_id=organization_id,
+ credential_id=credential_id,
+ encrypted_refresh_token=encrypted_refresh_token,
+ encrypted_method=EncryptMethod.AES,
+ now=now,
+ )
+ except Exception as exc:
+ LOG.exception(
+ "Failed to persist rotated Microsoft refresh token",
+ organization_id=organization_id,
+ credential_id=credential_id,
+ )
+ raise MicrosoftOAuthError(
+ "Failed to persist rotated Microsoft refresh token; reconnect the Microsoft account"
+ ) from exc
return access_token
diff --git a/skyvern/services/email/inbox.py b/skyvern/services/email/inbox.py
index dc762db5c..8bc8b7793 100644
--- a/skyvern/services/email/inbox.py
+++ b/skyvern/services/email/inbox.py
@@ -1,11 +1,14 @@
import httpx
-from pydantic import BaseModel
+import structlog
+from pydantic import BaseModel, ValidationError
from skyvern.forge import app
from skyvern.forge.prompts import prompt_engine
from skyvern.services.email import gmail, outlook
from skyvern.services.email.types import EmailMessage
+LOG = structlog.get_logger()
+
_BODY_LIMIT = 4000
@@ -66,5 +69,22 @@ async def match_email(*, criteria: str, email: EmailMessage, organization_id: st
prompt_name="match-email",
organization_id=organization_id,
)
- result = EmailMatchResult.model_validate(resp)
+ if not isinstance(resp, dict):
+ LOG.warning(
+ "Failed to match email with LLM",
+ email_id=email.id,
+ organization_id=organization_id,
+ response_type=type(resp).__name__,
+ )
+ return False
+ try:
+ result = EmailMatchResult.model_validate(resp)
+ except ValidationError:
+ LOG.warning(
+ "Failed to match email with LLM",
+ email_id=email.id,
+ organization_id=organization_id,
+ exc_info=True,
+ )
+ return False
return result.matches
diff --git a/tests/unit/test_email_inbox_block.py b/tests/unit/test_email_inbox_block.py
index 60f31f2ec..3a893d243 100644
--- a/tests/unit/test_email_inbox_block.py
+++ b/tests/unit/test_email_inbox_block.py
@@ -175,6 +175,44 @@ async def test_execute_filters_with_prompt_preserving_order(monkeypatch: pytest.
assert [email["id"] for email in result.output_parameter_value["emails"]] == ["msg_2"]
+async def test_execute_excludes_malformed_llm_output_and_continues(monkeypatch: pytest.MonkeyPatch) -> None:
+ monkeypatch.setattr(
+ app.AGENT_FUNCTION, "get_google_workspace_credentials", AsyncMock(return_value=SimpleNamespace(token="AT"))
+ )
+ monkeypatch.setattr(email, "list_folder_messages", AsyncMock(return_value=_messages()))
+ responses = iter([{"reasoning": "missing matches"}, {"reasoning": "matches", "matches": True}])
+
+ async def match_llm(**_kwargs: Any) -> dict[str, Any]:
+ return next(responses)
+
+ monkeypatch.setattr(email.inbox.app, "SECONDARY_LLM_API_HANDLER", match_llm)
+
+ result = await _execute_block_for_test(_make_block(prompt="Find the second email"))
+
+ assert result.success is True
+ assert result.output_parameter_value is not None
+ assert result.output_parameter_value["candidate_count"] == 2
+ assert result.output_parameter_value["matched_count"] == 1
+ assert [message["id"] for message in result.output_parameter_value["emails"]] == ["msg_2"]
+
+
+async def test_execute_propagates_llm_failure(monkeypatch: pytest.MonkeyPatch) -> None:
+ monkeypatch.setattr(
+ app.AGENT_FUNCTION, "get_google_workspace_credentials", AsyncMock(return_value=SimpleNamespace(token="AT"))
+ )
+ monkeypatch.setattr(email, "list_folder_messages", AsyncMock(return_value=_messages()))
+
+ async def fail_llm(**_kwargs: Any) -> dict[str, Any]:
+ raise RuntimeError("LLM unavailable")
+
+ monkeypatch.setattr(email.inbox.app, "SECONDARY_LLM_API_HANDLER", fail_llm)
+
+ with pytest.raises(RuntimeError, match="LLM unavailable"):
+ await _execute_block_for_test(_make_block(prompt="Find invoices"))
+
+
@pytest.mark.asyncio
async def test_execute_missing_credential_fails() -> None:
result = await _execute_block_for_test(_make_block(credential_id=None))
diff --git a/tests/unit/test_email_service.py b/tests/unit/test_email_service.py
index 22e960de1..a44d3f33e 100644
--- a/tests/unit/test_email_service.py
+++ b/tests/unit/test_email_service.py
@@ -24,6 +24,22 @@ async def test_match_email_propagates_llm_failure(monkeypatch: pytest.MonkeyPatc
)
+async def test_match_email_excludes_non_dict_llm_output(monkeypatch: pytest.MonkeyPatch) -> None:
+ async def malformed_llm(**_kwargs: Any) -> str:
+ return "not an object"
+
+ monkeypatch.setattr(email.inbox.app, "SECONDARY_LLM_API_HANDLER", malformed_llm)
+
+ matches = await email.match_email(
+ criteria="invoice",
+ email=email.EmailMessage(id="msg-1", subject="Invoice"),
+ organization_id="org-1",
+ )
+
+ assert matches is False
+
+
def _mock_response(status_code: int, *, json: dict[str, Any] | None = None) -> httpx.Response:
return httpx.Response(status_code, json=json or {})
diff --git a/tests/unit/test_microsoft_oauth_service.py b/tests/unit/test_microsoft_oauth_service.py
index 5697f6150..f1d656778 100644
--- a/tests/unit/test_microsoft_oauth_service.py
+++ b/tests/unit/test_microsoft_oauth_service.py
@@ -198,7 +198,21 @@ async def test_exchange_code_for_tokens_requires_refresh_token(monkeypatch: pyte
@pytest.mark.asyncio
-async def test_refresh_access_token_posts_form_and_ignores_rotation(monkeypatch: pytest.MonkeyPatch) -> None:
+ ("scopes", "expected_scopes"),
+ [
+ (["Mail.Read"], ["Mail.Read", "offline_access"]),
+ (
+ ["Mail.Read", "https://graph.microsoft.com/offline_access"],
+ ["Mail.Read", "https://graph.microsoft.com/offline_access"],
+ ),
+ ],
+)
+async def test_refresh_access_token_posts_form_and_ignores_rotation(
+ monkeypatch: pytest.MonkeyPatch,
+ scopes: list[str],
+ expected_scopes: list[str],
+) -> None:
monkeypatch.setattr(microsoft_oauth_service.settings, "MICROSOFT_OAUTH_CLIENT_ID", "cid", raising=False)
monkeypatch.setattr(microsoft_oauth_service.settings, "MICROSOFT_OAUTH_CLIENT_SECRET", "secret", raising=False)
captured: dict[str, str] = {}
@@ -217,14 +231,14 @@ async def test_refresh_access_token_posts_form_and_ignores_rotation(monkeypatch:
_install_microsoft_transport(monkeypatch, handler)
- result = await microsoft_oauth_service.refresh_access_token("rt-1", scopes=["Mail.Read"])
+ result = await microsoft_oauth_service.refresh_access_token("rt-1", scopes=scopes)
assert result["access_token"] == "at-refreshed"
assert result["refresh_token"] == "rt-rotated"
form = {k: v[0] for k, v in parse_qs(captured["body"]).items()}
assert form["grant_type"] == "refresh_token"
assert form["refresh_token"] == "rt-1"
- assert form["scope"].split() == ["Mail.Read", "offline_access"]
+ assert form["scope"].split() == expected_scopes
@pytest.mark.asyncio
@@ -289,7 +303,8 @@ async def test_refresh_and_rotate_propagates_rotated_token_persist_failure(
SimpleNamespace(encrypt=AsyncMock(return_value="encrypted-rt-rotated")),
)
- with pytest.raises(RuntimeError, match="database unavailable"):
+ message = "Failed to persist rotated Microsoft refresh token; reconnect the Microsoft account"
+ with pytest.raises(microsoft_oauth_service.MicrosoftOAuthError, match=message):
await microsoft_oauth_service.refresh_and_rotate(
organization_id="org-1",
credential_id="cred-1",