Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.41 KB

architecture.md

File metadata and controls

53 lines (35 loc) · 2.41 KB

Metaflowbot Event Lifecycle

MFBServer listens to events from Slack via MFBSlackClientV2and converts then to internal event representation. These events are matched with rules to and based on the matched rules an action is invoked.

In the above event lifecycle, the metaflowbot uses Slack as a stateful store for storing context about threads. When the Bot detects a state_change event, its stores its contents in the MFBState Object.

Core Objects

  • MFBServer is present in metaflowbot.server. This class is the server that parses messages from slack events, applies rules and invokes actions based on the matched rules.

  • MFBSlackClientV2 is present in metaflowbot.slack_client. This class provides a wrapper over slack APIs.

  • MFBRules is present in metaflowbot.rules. This class helps match rules with events.

  • MFBState is present in metaflowbot.state. This class helps hold state about the open threads and conversations with users. It is used by MFBServer.

  • metaflowbot.actions is the subpackage that holds all the actions of the bot. Ways to create new subpackages can be found here.

Event Lifecycle Psuedo Code

while server runs forever: # metaflowbot.server.MFBServer.loop_forever()
    foreach event from slack: # metaflowbot.slack_client.MFBSlackClientV2.rtm_events()
        convert events to MFBot Compatible events: # metaflowbot.server._make_events(event)
            if event matches rules: # metaflowbot.rules.MFBRules.match(event,rule)
                apply action matches by rule # metaflowbot.server.actions
                # Calls MFBServer._take_action
                # Every action is invoked as a seperate python process.

Rule

  • A basic rule looks like the following:
- name: Generic help fallback # Name of the rule
  event_type: user_message # Type of event the rule needs to filter
  message: help(.*)|how to(.*) # pattern to use when filtering the message
  action:
    op: new-thread # Operation in metaflowbot.actions.<action_name>
    create-thread: false # Arguement for the action to be invoked.

Events

new_thread

When a completely new thread is created

user_message

When a user messages on a thread