mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-06-11 08:42:11 +00:00
First-class iMessage support via Photon's managed Spectrum platform. Targeted as a successor to the BlueBubbles adapter — Photon allocates the iMessage line, handles delivery, and abuse-prevention so users don't have to run their own Mac relay. Free tier uses Photon's shared line pool. Architecture: - Inbound: signed JSON webhooks (X-Spectrum-Signature, HMAC-SHA256) delivered to a local aiohttp listener. Dedupes on message.id, rejects deliveries with >5min timestamp drift. - Outbound: small supervised Node sidecar that runs the spectrum-ts SDK. Photon does not currently expose a public HTTP send-message endpoint; the sidecar is the only way to call Space.send() today. When Photon ships an HTTP send endpoint we collapse the sidecar into _sidecar_send and drop the Node dep — every other layer of the plugin stays the same. - Setup: 'hermes photon login' runs the RFC 8628 device-code flow; 'hermes photon setup' creates a Spectrum-enabled project, creates a shared user (free tier), installs the sidecar's npm deps. - Webhook management: 'hermes photon webhook register|list|delete'. - Credentials persisted under credential_pool.photon / credential_pool.photon_project in ~/.hermes/auth.json. Plugin path (not built-in) — per current policy (May 2026), all new platforms ship under plugins/platforms/. Registers itself via ctx.register_platform() + ctx.register_cli_command(), zero edits to core gateway code. Tests cover: - HMAC-SHA256 signature verification (happy path, tampered body, wrong secret, drift, missing v0 prefix, empty inputs, non-integer timestamp) - Inbound dispatch for text DMs, group ids (any;+;...), and attachment metadata markers - Deduplication window - check_requirements gating when Node is absent - Device-code flow: request, header-based token return, body-fallback token return, access_denied propagation - Project/user/webhook API clients with mocked httpx Known limitations (current Photon API): - Attachments are metadata only — no download URL yet - Outbound attachment send not wired (sidecar can add easily) - Reactions / message effects not exposed yet Docs: website/docs/user-guide/messaging/photon.md + sidebar entry.
139 lines
4.8 KiB
Python
139 lines
4.8 KiB
Python
"""Inbound dispatch + dedup tests for PhotonAdapter.
|
|
|
|
These tests bypass the aiohttp server — they call ``_dispatch_inbound``
|
|
and ``_is_duplicate`` directly. That keeps them fast and means we can
|
|
exercise the message-shape parsing logic without binding ports.
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
from typing import List
|
|
|
|
import pytest
|
|
|
|
from gateway.config import Platform, PlatformConfig
|
|
from gateway.platforms.base import MessageEvent, MessageType
|
|
from plugins.platforms.photon.adapter import PhotonAdapter
|
|
|
|
|
|
def _make_adapter(monkeypatch: pytest.MonkeyPatch) -> PhotonAdapter:
|
|
# Avoid touching real auth.json / env.
|
|
monkeypatch.setenv("PHOTON_PROJECT_ID", "test-project-id")
|
|
monkeypatch.setenv("PHOTON_PROJECT_SECRET", "test-project-secret")
|
|
monkeypatch.delenv("PHOTON_WEBHOOK_SECRET", raising=False)
|
|
cfg = PlatformConfig(enabled=True, token="", extra={})
|
|
return PhotonAdapter(cfg)
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_text_dm(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
adapter = _make_adapter(monkeypatch)
|
|
captured: List[MessageEvent] = []
|
|
|
|
async def fake_handle(event: MessageEvent) -> None:
|
|
captured.append(event)
|
|
|
|
adapter.handle_message = fake_handle # type: ignore[assignment]
|
|
|
|
payload = {
|
|
"event": "messages",
|
|
"space": {"id": "any;-;+15551234567", "platform": "iMessage"},
|
|
"message": {
|
|
"id": "spc-msg-abc",
|
|
"platform": "iMessage",
|
|
"direction": "inbound",
|
|
"timestamp": "2026-05-14T19:06:32.000Z",
|
|
"sender": {"id": "+15551234567", "platform": "iMessage"},
|
|
"space": {"id": "any;-;+15551234567", "platform": "iMessage"},
|
|
"content": {"type": "text", "text": "hello world"},
|
|
},
|
|
}
|
|
await adapter._dispatch_inbound(payload)
|
|
|
|
assert len(captured) == 1
|
|
event = captured[0]
|
|
assert event.text == "hello world"
|
|
assert event.message_type == MessageType.TEXT
|
|
assert event.message_id == "spc-msg-abc"
|
|
src = event.source
|
|
assert src is not None
|
|
assert src.platform == Platform("photon")
|
|
assert src.chat_id == "any;-;+15551234567"
|
|
assert src.chat_type == "dm"
|
|
assert src.user_id == "+15551234567"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_group_id_detected(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
adapter = _make_adapter(monkeypatch)
|
|
captured: List[MessageEvent] = []
|
|
|
|
async def fake_handle(event: MessageEvent) -> None:
|
|
captured.append(event)
|
|
|
|
adapter.handle_message = fake_handle # type: ignore[assignment]
|
|
|
|
payload = {
|
|
"event": "messages",
|
|
"space": {"id": "any;+;group-guid-xyz", "platform": "iMessage"},
|
|
"message": {
|
|
"id": "spc-msg-grp",
|
|
"timestamp": "2026-05-14T19:06:32.000Z",
|
|
"sender": {"id": "+15551234567"},
|
|
"space": {"id": "any;+;group-guid-xyz"},
|
|
"content": {"type": "text", "text": "hi group"},
|
|
},
|
|
}
|
|
await adapter._dispatch_inbound(payload)
|
|
assert captured[0].source.chat_type == "group"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_dispatch_attachment_surfaces_marker(
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
adapter = _make_adapter(monkeypatch)
|
|
captured: List[MessageEvent] = []
|
|
|
|
async def fake_handle(event: MessageEvent) -> None:
|
|
captured.append(event)
|
|
|
|
adapter.handle_message = fake_handle # type: ignore[assignment]
|
|
|
|
payload = {
|
|
"event": "messages",
|
|
"message": {
|
|
"id": "spc-msg-att",
|
|
"timestamp": "2026-05-14T19:06:32.000Z",
|
|
"sender": {"id": "+15551234567"},
|
|
"space": {"id": "any;-;+15551234567"},
|
|
"content": {
|
|
"type": "attachment",
|
|
"name": "IMG_4127.HEIC",
|
|
"mimeType": "image/heic",
|
|
"size": 12345,
|
|
},
|
|
},
|
|
}
|
|
await adapter._dispatch_inbound(payload)
|
|
assert len(captured) == 1
|
|
event = captured[0]
|
|
# Attachment carries metadata marker; mime → MessageType.PHOTO.
|
|
assert "Photon attachment received" in event.text
|
|
assert "IMG_4127.HEIC" in event.text
|
|
assert event.message_type == MessageType.PHOTO
|
|
|
|
|
|
def test_is_duplicate_window(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
adapter = _make_adapter(monkeypatch)
|
|
assert adapter._is_duplicate("id-1") is False
|
|
assert adapter._is_duplicate("id-1") is True
|
|
assert adapter._is_duplicate("id-2") is False
|
|
assert adapter._is_duplicate("id-1") is True # still dup
|
|
|
|
|
|
def test_check_requirements_without_node(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
# If no node binary on PATH the adapter should refuse to start.
|
|
from plugins.platforms.photon import adapter as adapter_mod
|
|
|
|
monkeypatch.setattr(adapter_mod.shutil, "which", lambda _name: None)
|
|
assert adapter_mod.check_requirements() is False
|