feat(experiments): add on finish actions, support email

[aryanrawlani28]

Problem

Based on / fixes: #13106.

Changes

• Add new field: finish_actions
• Add optional config-based setup for sending emails of results once experiment ends
• Add new html template for results of experiment

View:

Edit:

Email sample:

Email sample, where the experiment fails:

Notes

• Emails: Content reference taken from
  • https://posthog.com/docs/experiments/testing-and-launching
  • https://posthog.com/product-engineers/ab-testing-guide-for-engineers
• Emails: I've tried to keep it the structure like -> Intro & About experiment, Brief about results, Next steps
• For the input config, I tried iterating over the input design to see if I can get something better with a selectable targetting criteria. I ended up with something like this:

  • 

  • Which I felt was too many CTAs in one line (+ add targetting criteria + remove targetting criteria + remove action), so I think current design makes more sense & is simpler.

Approach

Base Model

For the base data model, I wanted to keep the post-actions a bit generic, so we can add-on anything, if needed, in future.
Example:

finish_actions: [
    {
        action: 'SEND_EMAIL',
        value: {
            ALL: ['devs@posthog.com'], // People to notify, regardless of the outcome
            SUCCESS: ['pms@posthog.com'],
            FAILURE: ['tpms@posthog.com'],
        },
    },
]

Why's

Q. Why a config based, and not directly sending to all project memebers?

• Might help avoiding polluting everybody's inbox? Only certain people might have a usecase for this.
• Case of failures, we might want to avoid sending it to everyone?

Q. Why three different cases for sending emails to?

I think it'd be useful to have something like this, since the usecases for each of them might be actionable for different personas within an organization.

• ALL: The person or team managing experiments, for direct actionable insights.
• SUCCESS: If the experiment is a success, I'd like to auto-send it, for example, to our DevRel or PM team, who might use this data and communicate upcoming changes or prepare release notes respectively. Or maybe my direct reports would appreciate that something they worked on, was a success.
• FAILURE: If failed, maybe TPMs (Project team) or PSMs (Partner Success team) can help improve our future experiments, by talking to customers first-hand and seeing what went wrong?

Conclusion

Of course, we could always send it to an initial member (i.e experiment creator) who could then forward it as and when needed. Or we could have a config-based setup like this.

Does this work well for both Cloud and self-hosted?

todo

Testing

todo

Todos

• For the email contents, should we add a graph, if yes, what kind would make sense for the users
• Testcases, testing
• email output review for all cases
• Self-review

Any feedback is appreciated, these are my initial thoughts :)

I'll need help in thinking about the email contents - I've added small amount so far of what I think might be helpful, but the wording and additional content, if any, is pending.

[coderabbitai]

Important

Auto Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[neilkakkar]

Thanks @aryanrawlani28 for the contribution! I'll try to get a review in by next week, this is a big one with lots of potential pitfalls 😅

[posthog-bot]

This PR hasn't seen activity in a week! Should it be merged, closed, or further worked on? If you want to keep it open, post a comment or remove the stale label – otherwise this will be closed in another week.

[posthog-bot]

This PR was closed due to lack of activity. Feel free to reopen if it's still relevant.