-
Notifications
You must be signed in to change notification settings - Fork 0
feat(workflow): 이메일 커넥터 데모 (목 드라이버) + 전체 루프 e2e #56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
41 changes: 41 additions & 0 deletions
41
docs/superpowers/specs/2026-08-04-workflow-email-connector-demo-design.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Maestro Workflow 이메일 커넥터 데모 설계 (목 드라이버) | ||
|
|
||
| - 날짜: 2026-08-04 | ||
| - 상태: 확정 (사용자: 목 드라이버 데모 먼저 — IMAP/Gmail은 드라이버 교체로 후속) | ||
| - 범위: `workflow/examples/` + `workflow/tests/` (공개 계약만 사용하는 참조 클라이언트) | ||
|
|
||
| ## 0. 목표 | ||
|
|
||
| 비전 §4(d)의 이메일 업무 루프 전체를 실서버로 증명한다: | ||
| 받은편지함 → email-triage 요청(체인 루트) → 운영자 승인 → email-reply | ||
| 요청(체인 연결, 초안 payload) → 운영자 승인 → **발송 실행(드라이버)** → ack. | ||
| Workflow 서버는 무변경 — 커넥터는 기존 계약(actor 등록·요청·WS 구독·ack)만 쓴다. | ||
|
|
||
| ## 1. 구조 | ||
|
|
||
| - `workflow/examples/email-connector/lib.mjs`: | ||
| `runEmailConnector({ serverUrl, serverToken, actorId, driver, log, decisionTimeoutMs })` | ||
| → 처리 요약 `{ chains, sent, skipped }` 반환. 드라이버 인터페이스: | ||
| `listUnprocessed()` / `send({ to, subject, body })` / `markProcessed(id)`. | ||
| - `mockInbox.mjs`: 가짜 메일 2통 + 발송 기록(`sent[]`)을 가진 목 드라이버. | ||
| - `connector.mjs`: CLI 래퍼 (`node connector.mjs` — env로 서버/토큰 지정). | ||
| - 결정 수신: actor 토큰 WS 구독(WORKFLOW_AUTH → 자기 WORKFLOW_DECIDED)을 | ||
| 1차로, 폴링(GET .../decision)을 보조로 사용 — 스펙 2026-08-04(actor WS)의 | ||
| "WS는 알림, 폴링이 보장" 원칙 그대로. | ||
| - 반려(reject/revise) 시: 해당 메일은 발송하지 않고 `skipped`로 기록(체인에 | ||
| 결정 사유가 남는다). 데모 범위에서 재초안 루프는 생략. | ||
|
|
||
| ## 2. e2e 테스트 (`workflow/tests/email-connector-demo.test.mjs`) | ||
|
|
||
| 실서버(엄격 모드)를 띄우고 커넥터를 병행 실행, 테스트가 운영자 역할로 | ||
| pending 요청을 폴링·승인한다. 단언: | ||
|
|
||
| - 메일 2통 → 체인 2개, 각 체인 = [email-triage, email-reply] (chain API 검증) | ||
| - 승인 완료 후 목 드라이버 `sent`에 답장 2건, 수신자/제목 일치 | ||
| - 결정 2×2건 모두 ack 상태(delivery.status)로 종결 | ||
| - 반려 시나리오 1건: triage 반려 → reply 미생성·발송 0건·skipped 기록 | ||
|
|
||
| ## 3. 비범위 | ||
|
|
||
| 실제 IMAP/Gmail 드라이버(후속 — 인터페이스 동일), 재초안 반복 루프, | ||
| 대시보드 체인 시각화. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # 이메일 커넥터 (참조 클라이언트, 목 드라이버) | ||
|
|
||
| 비전 §4(d)의 이메일 업무 루프 데모: 받은편지함 → `email-triage`(체인 루트) | ||
| → 승인 → `email-reply`(체인) → 승인 → 발송(드라이버) → ack. | ||
| Workflow 공개 계약만 사용하며, 서버 코드는 무변경이다. | ||
|
|
||
| ## 실행 | ||
|
|
||
| npm run server # 터미널 1 (workflow/) | ||
| node examples/email-connector/connector.mjs # 터미널 2 | ||
|
|
||
| 엄격 모드면 두 터미널 모두 `MAESTRO_WORKFLOW_SERVER_TOKEN`을 지정한다. | ||
| 대시보드(레인)에서 ✉/↩ 프리셋 카드를 승인·반려하면 커넥터가 WS로 결정을 | ||
| 받아 발송을 시뮬레이션하고 요약을 출력한다. | ||
|
|
||
| ## 실제 이메일 연결 (후속) | ||
|
|
||
| `mockInbox.mjs`와 같은 인터페이스(`listUnprocessed` / `send` / | ||
| `markProcessed`)로 IMAP 또는 Gmail API 드라이버를 구현해 `connector.mjs`에서 | ||
| 교체하면 된다 — 커넥터 본체(`lib.mjs`)는 수정 불필요. 이메일 자격증명은 | ||
| 커넥터 프로세스에만 머물고 Workflow 서버에는 절대 전달되지 않는다. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| #!/usr/bin/env node | ||
| // 이메일 커넥터 CLI (목 드라이버). 실행 전 workflow 서버가 떠 있어야 한다. | ||
| // MAESTRO_WORKFLOW_SERVER_TOKEN=<서버토큰> node connector.mjs | ||
| // 서버 토큰은 actor 등록에만 쓰이고, 이후는 발급받은 actor 토큰으로만 통신한다. | ||
| import { runEmailConnector } from './lib.mjs'; | ||
| import { createMockInboxDriver } from './mockInbox.mjs'; | ||
|
|
||
| const serverUrl = process.env.MAESTRO_WORKFLOW_SERVER_URL || 'http://127.0.0.1:8090'; | ||
| const serverToken = process.env.MAESTRO_WORKFLOW_SERVER_TOKEN || ''; | ||
|
|
||
| const driver = createMockInboxDriver(); | ||
| const summary = await runEmailConnector({ | ||
| serverUrl, | ||
| serverToken, | ||
| driver, | ||
| log: console.log, | ||
| }); | ||
|
|
||
| console.log('\n── 처리 요약 ──'); | ||
| console.log(JSON.stringify(summary, null, 2)); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| // 이메일 커넥터 참조 클라이언트 (스펙 2026-08-04 데모 §1). | ||
| // Workflow 공개 계약만 사용한다: actor 등록 → 요청 생성(체인) → WS 구독(1차)/폴링(보조) → ack. | ||
| // 발송 실행은 드라이버 몫 — Workflow는 record-only 그대로다. | ||
| import WebSocket from 'ws'; | ||
|
|
||
| export async function runEmailConnector({ | ||
| serverUrl, | ||
| serverToken, | ||
| actorId = 'agent_email', | ||
| driver, | ||
| log = () => {}, | ||
| decisionTimeoutMs = 60000, | ||
| }) { | ||
| if (!driver) { | ||
| throw new Error('driver가 필요합니다 (listUnprocessed/send/markProcessed)'); | ||
| } | ||
|
|
||
| const httpJson = async (path, { method = 'GET', token = '', body = null } = {}) => { | ||
| const res = await fetch(`${serverUrl}${path}`, { | ||
| method, | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| ...(token ? { Authorization: `Bearer ${token}` } : {}), | ||
| }, | ||
| body: body ? JSON.stringify(body) : undefined, | ||
| }); | ||
| const parsed = await res.json().catch(() => ({})); | ||
| if (!res.ok) { | ||
| throw new Error(parsed.error || `HTTP ${res.status} ${path}`); | ||
| } | ||
| return parsed; | ||
| }; | ||
|
|
||
| // 1. actor 등록 (서버 토큰) → actor 토큰 확보 | ||
| const registration = await httpJson('/api/actors/register', { | ||
| method: 'POST', | ||
| token: serverToken, | ||
| body: { actorId }, | ||
| }); | ||
| const actorToken = registration.actorToken; | ||
|
|
||
| // 2. WS 구독 — 자기 결정(WORKFLOW_DECIDED)만 수신 (actor 스코프) | ||
| const decisionWaiters = new Map(); // requestId → resolve | ||
| const receivedDecisions = new Map(); // requestId → { item, request } | ||
| const ws = new WebSocket(serverUrl.replace(/^http/, 'ws')); | ||
| await new Promise((resolve, reject) => { | ||
| ws.on('open', () => { | ||
| ws.send(JSON.stringify({ type: 'WORKFLOW_AUTH', token: actorToken })); | ||
| }); | ||
| ws.on('message', (raw) => { | ||
| const data = JSON.parse(raw.toString()); | ||
| if (data.type === 'WORKFLOW_AUTH_OK') { | ||
| resolve(); | ||
| return; | ||
| } | ||
| if (data.type === 'WORKFLOW_DECIDED' && data.request) { | ||
| receivedDecisions.set(data.request.requestId, { item: data.item, request: data.request }); | ||
| const waiter = decisionWaiters.get(data.request.requestId); | ||
| if (waiter) waiter({ item: data.item, request: data.request }); | ||
| } | ||
| }); | ||
| ws.on('error', reject); | ||
| }); | ||
|
|
||
| // WS가 1차, 폴링이 보장 (재연결·놓침 복구용 보조 경로) | ||
| const awaitDecision = async (requestId) => { | ||
| if (receivedDecisions.has(requestId)) { | ||
| return receivedDecisions.get(requestId); | ||
| } | ||
| return new Promise((resolve, reject) => { | ||
| const deadline = setTimeout(() => { | ||
| clearInterval(poller); | ||
| decisionWaiters.delete(requestId); | ||
| reject(new Error(`결정 대기 시간 초과: ${requestId}`)); | ||
| }, decisionTimeoutMs); | ||
| const settle = (decision) => { | ||
| clearTimeout(deadline); | ||
| clearInterval(poller); | ||
| decisionWaiters.delete(requestId); | ||
| resolve(decision); | ||
| }; | ||
| decisionWaiters.set(requestId, settle); | ||
| const poller = setInterval(async () => { | ||
| try { | ||
| const status = await httpJson(`/api/decision-requests/${encodeURIComponent(requestId)}/decision`, { token: actorToken }); | ||
| if (status.item) { | ||
| settle({ item: status.item, request: { requestId } }); | ||
| } | ||
| } catch { | ||
| // 폴링 실패는 다음 주기에 재시도 | ||
| } | ||
| }, 1500); | ||
| }); | ||
| }; | ||
|
|
||
| const createRequest = (payload) => httpJson('/api/decision-requests', { | ||
| method: 'POST', | ||
| token: actorToken, | ||
| body: payload, | ||
| }); | ||
|
|
||
| const ackDecision = (decisionId) => httpJson(`/api/decisions/${encodeURIComponent(decisionId)}/ack`, { | ||
| method: 'POST', | ||
| token: actorToken, | ||
| }); | ||
|
|
||
| // 3. 메일별 체인 처리: triage(루트) → 승인 시 reply(체인) → 승인 시 발송 | ||
| const summary = { chains: [], sent: [], skipped: [] }; | ||
|
|
||
| try { | ||
| for (const mail of driver.listUnprocessed()) { | ||
| log(`📥 처리 시작: ${mail.subject} (${mail.from})`); | ||
| const triage = await createRequest({ | ||
| subjectType: 'email-triage', | ||
| subject: { | ||
| title: `메일 분류: ${mail.subject}`, | ||
| summary: mail.body, | ||
| payload: { from: mail.from, subject: mail.subject, proposedAction: mail.proposedAction }, | ||
| }, | ||
| }); | ||
| const triageDecision = await awaitDecision(triage.item.requestId); | ||
| await ackDecision(triageDecision.item.decisionId); | ||
|
|
||
| if (triageDecision.item.decision !== 'approve') { | ||
| summary.skipped.push({ mailId: mail.id, stage: 'triage', decision: triageDecision.item.decision }); | ||
| driver.markProcessed(mail.id); | ||
| log(`⏭ 분류 단계에서 중단(${triageDecision.item.decision}): ${mail.subject}`); | ||
| continue; | ||
| } | ||
|
|
||
| const reply = await createRequest({ | ||
| subjectType: 'email-reply', | ||
| parentRequestId: triage.item.requestId, | ||
| subject: { | ||
| title: `답장 승인: ${mail.subject}`, | ||
| summary: mail.draftReply, | ||
| payload: { to: mail.from, subject: `Re: ${mail.subject}`, draft: mail.draftReply }, | ||
| }, | ||
| }); | ||
| const replyDecision = await awaitDecision(reply.item.requestId); | ||
| await ackDecision(replyDecision.item.decisionId); | ||
|
|
||
| if (replyDecision.item.decision === 'approve') { | ||
| driver.send({ to: mail.from, subject: `Re: ${mail.subject}`, body: mail.draftReply }); | ||
| summary.sent.push({ mailId: mail.id, to: mail.from }); | ||
| log(`📤 발송 완료: Re: ${mail.subject} → ${mail.from}`); | ||
| } else { | ||
| summary.skipped.push({ mailId: mail.id, stage: 'reply', decision: replyDecision.item.decision }); | ||
| log(`⏭ 답장 반려(${replyDecision.item.decision}): ${mail.subject}`); | ||
| } | ||
|
|
||
| driver.markProcessed(mail.id); | ||
| summary.chains.push({ | ||
| mailId: mail.id, | ||
| triageRequestId: triage.item.requestId, | ||
| replyRequestId: reply.item.requestId, | ||
| }); | ||
| } | ||
| } finally { | ||
| ws.close(); | ||
| } | ||
|
|
||
| return summary; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| // 목 받은편지함 드라이버 (스펙 2026-08-04 데모 §1): 자격증명 없이 전체 루프를 증명한다. | ||
| // 실제 IMAP/Gmail 드라이버는 이 인터페이스(listUnprocessed/send/markProcessed)만 맞추면 된다. | ||
|
|
||
| export function createMockInboxDriver(seedMails = null) { | ||
| const mails = seedMails || [ | ||
| { | ||
| id: 'mail-1', | ||
| from: 'client@corp.com', | ||
| subject: '견적 회신 요청', | ||
| body: '지난주 논의한 범위로 견적 부탁드립니다.', | ||
| proposedAction: '표준 견적 템플릿으로 회신', | ||
| draftReply: '안녕하세요, 요청하신 견적을 첨부와 같이 회신드립니다. 감사합니다.', | ||
| }, | ||
| { | ||
| id: 'mail-2', | ||
| from: 'partner@vendor.io', | ||
| subject: '미팅 일정 조율', | ||
| body: '다음 주 수요일 오후 가능하신가요?', | ||
| proposedAction: '수요일 15시로 수락 회신', | ||
| draftReply: '안녕하세요, 수요일 15시 좋습니다. 초대장 보내주시면 참석하겠습니다.', | ||
| }, | ||
| ]; | ||
| const processed = new Set(); | ||
| const sent = []; | ||
|
|
||
| return { | ||
| sent, | ||
| listUnprocessed() { | ||
| return mails.filter((mail) => !processed.has(mail.id)); | ||
| }, | ||
| send({ to, subject, body }) { | ||
| sent.push({ to, subject, body }); | ||
| }, | ||
| markProcessed(mailId) { | ||
| processed.add(mailId); | ||
| }, | ||
| }; | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example is advertised as accepting an IMAP/Gmail driver by replacing the mock with the same interface, but this loop treats
listUnprocessed()as a synchronous iterable. Real mail drivers will typically returnPromise<Mail[]>; with such a driver this throws before processing any mail, and the latersend/markProcessedcalls are also not awaited, so failures can be reported as sent/processed. Await the driver methods, or use an async iterator, so the documented driver swap works.Useful? React with 👍 / 👎.