How fbsamples/messenger-bot-samples works
Project Type and Purpose
• This is a catalog of standalone Messenger‐Platform bot samples (account-linking, chat-extensions, chat_plugin_autodetect, customer-care-csat, gui-webview).
• Each sample is a Node.js/Express microservice demonstrating best practices (webhooks, API helpers, optional DB, optional client UI, real-time sockets, webview, etc.).
File Structure
• Top-level: multiple directories, one per sample.
• Each sample has:
– an Express entry point (app.js or index.js + bin/www)
– routes (webhooks, index, resource-specific)
– messenger-api-helpers (send/receive, thread setup)
– models and optional stores (data access, e.g. Knex migrations/seeds for chat-extensions)
– public assets or client folder (React components for gui-webview, static CSS/images)
– views (Jade/EJS templates for account linking or webview fallbacks)
– test folders, config files, build scripts (webpack in gui-webview).
README
• Describes: “Example bots to demonstrate best practices for the Messenger Platform.”
• No single unified architecture—rather, a family of patterns.
Main Components (per sample)
a. HTTP Server (Express)
b. Messenger-API-Helpers module (wraps Graph API calls)
c. Webhook Controller (routes/webhooks.js): receives events from Facebook
d. Business Logic (models, stores, FBA logic in customer-care-csat)
e. Persistent Storage (in chat-extensions: Knex + migrations/seeds; other samples may use in-memory stores)
f. Frontend/UI (views for webviews, static public files, React SPA in gui-webview)
g. Real-Time Layer (chat-extensions sockets using socket.io)
h. External Service: Facebook Messenger Platform (Graph API, Webhook callbacks)
Relationships & Data Flow
1. User interacts in Messenger → Facebook Messenger Platform
2. Platform POSTs webhook to your Express Webhook endpoint
3. Webhook Controller invokes business logic (models/stores)
4. Business logic may read/write to DB or in-memory store
5. Business logic calls Messenger-API-Helpers → Facebook Graph API → back to user
6. For samples with a client (gui-webview):
• User taps webview link in Messenger → loads React app from Express static public folder
• Client may make REST calls or rely on postMessage / webview controls via messenger-api-helpers
7. For chat-extensions real-time: server also maintains WebSocket channel to push updates to client
Architectural Patterns & Principles
• MVC-style separation: routes/controllers → models/stores → views/UI
• Layered approach:
– Transport layer (Express HTTP, WebSockets)
– Business layer (models, stores, FBA payload logic)
– Integration layer (Messenger-API-Helpers)
• Optional data persistence: relational via Knex or simple in-memory store
• Client-Server SPA in gui-webview: webpack bundle, React components
• Configuration via environment or sample.config.js