scriptoriumadmin/fabro
1
0
Fork 0
mirror of https://github.com/fabro-sh/fabro.git synced 2026-10-06 02:48:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: move implementation sequence to top of ChatService trait spec

Browse source 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Marshall Yount 2026-06-13 07:37:21 -07:00
parent 57199bde93
commit 5cfe75665e
1 changed files with 28 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
docs/superpowers/specs/2026-06-13-chat-service-trait-and-providers.md
View file

@ -21,6 +21,34 @@ do not require changes to `fabro-server`'s core wiring.
> to least architecturally significant. Inline links throughout the spec (`→ Decision N`) point
> to the relevant entry.
## Implementation Sequence
This design is delivered as four stacked PRs, each independently reviewable and testable.
Each PR has its own implementation plan.
**PR 1 — `fabro-chat`: trait and shared types**
Create `lib/crates/fabro-chat/` with the `ChatService` and `ChatEventContext` traits, shared
types (`AnswerSubmission`, `ChatProviderKind`, `WebhookOutcome`), and test-support helpers
(`MockChatEventContext`, `assert_chat_service_contract`). No wiring, no behavior change — just
the contract. Reviewers can approve the API surface before any implementation lands.
**PR 2 — Slack refactor**
Move `SlackService` from `server.rs` into `fabro-slack` and implement `ChatService` on it.
Rewire `AppState` to hold `Vec<Arc<dyn ChatService>>`, implement `ChatEventContext` for
`AppState`, replace `start_optional_slack_service` with `start_chat_services`, and add the
`POST /api/v1/webhooks/:provider/*rest` dispatch route. All existing Slack behavior passes
unchanged — this PR has zero user-visible effect.
**PR 3 — Mattermost**
Add `fabro-mattermost` (all eight modules), `MattermostIntegrationSettings` /
`Principal::Mattermost` type additions, the two new vault secrets, server wiring, and the
docs page. First PR that ships new user-facing functionality.
**PR 4 — MS Teams stub**
Add `fabro-teams` (two modules), `TeamsIntegrationSettings` / `Principal::Teams`, one vault
secret, server wiring, and the stub docs page. Closes the loop on trait validation for
pure-inbound-HTTP providers.
## Design Principles
- Mirror the existing `SandboxProvider` pattern: shared trait crate, concrete implementations
@ -595,34 +623,6 @@ Against `docker run --name mattermost-preview -p 8065:8065 mattermost/mattermost
- Updated: `docs/public/administration/server-configuration.mdx` — add Mattermost and Teams sections and new secrets to the secrets table
- Updated: `.env.example` — add `FABRO_MATTERMOST_TOKEN`, `FABRO_MATTERMOST_WEBHOOK_SECRET`, `FABRO_TEAMS_WEBHOOK_SECRET` (commented out)
## Implementation Sequence
This design is delivered as four stacked PRs, each independently reviewable and testable.
Each PR has its own implementation plan.
**PR 1 — `fabro-chat`: trait and shared types**
Create `lib/crates/fabro-chat/` with the `ChatService` and `ChatEventContext` traits, shared
types (`AnswerSubmission`, `ChatProviderKind`, `WebhookOutcome`), and test-support helpers
(`MockChatEventContext`, `assert_chat_service_contract`). No wiring, no behavior change — just
the contract. Reviewers can approve the API surface before any implementation lands.
**PR 2 — Slack refactor**
Move `SlackService` from `server.rs` into `fabro-slack` and implement `ChatService` on it.
Rewire `AppState` to hold `Vec<Arc<dyn ChatService>>`, implement `ChatEventContext` for
`AppState`, replace `start_optional_slack_service` with `start_chat_services`, and add the
`POST /api/v1/webhooks/:provider/*rest` dispatch route. All existing Slack behavior passes
unchanged — this PR has zero user-visible effect.
**PR 3 — Mattermost**
Add `fabro-mattermost` (all eight modules), `MattermostIntegrationSettings` /
`Principal::Mattermost` type additions, the two new vault secrets, server wiring, and the
docs page. First PR that ships new user-facing functionality.
**PR 4 — MS Teams stub**
Add `fabro-teams` (two modules), `TeamsIntegrationSettings` / `Principal::Teams`, one vault
secret, server wiring, and the stub docs page. Closes the loop on trait validation for
pure-inbound-HTTP providers.
## Out of Scope
- Full MS Teams implementation (Adaptive Cards, JWT validation, Bot Framework activity routing).