Skip to content
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

Add support for Segment events #1669 #1672

Merged
merged 17 commits into from
Aug 16, 2024

Conversation

jwalsh-vori
Copy link
Contributor

Added support for Twilio Segment

New Segment Block added to Forge. Includes the following:

  • Credentials
  • Identify User, including Traits
  • Alias User
  • Track Event, including Properties
  • Track Bot View ( Page ), including Properties
  • Generate UUID for User IDs

Tested integration with Segment, verified working. Uses Segment's NodeJS analytics library to support non-browser based platforms, such as WhatsApp

Copy link

vercel bot commented Jul 31, 2024

@jwalsh-famkit is attempting to deploy a commit to the Typebot Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Jul 31, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

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
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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

CodeRabbit Configuration 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.

Copy link
Contributor Author

@jwalsh-vori jwalsh-vori left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good to be merged

@baptisteArno baptisteArno linked an issue Aug 3, 2024 that may be closed by this pull request
@baptisteArno
Copy link
Owner

Thanks so much for this. I'm currently off and will be able to review it on 13th of August

@jwalsh-vori
Copy link
Contributor Author

Thanks so much for this. I'm currently off and will be able to review it on 13th of August

No worries, enjoy your time off!

apps/docs/editor/blocks/integrations/segment.mdx Outdated Show resolved Hide resolved
packages/forge/blocks/segment/actions/genuuid.ts Outdated Show resolved Hide resolved
packages/forge/blocks/segment/actions/identify.ts Outdated Show resolved Hide resolved
packages/forge/blocks/segment/actions/identify.ts Outdated Show resolved Hide resolved
packages/forge/blocks/segment/actions/page.ts Outdated Show resolved Hide resolved
packages/prisma/postgresql/schema.prisma Outdated Show resolved Hide resolved
packages/forge/blocks/segment/package.json Outdated Show resolved Hide resolved
@baptisteArno
Copy link
Owner

Thanks for this ❤️ just some minor suggestions for you

@jwalsh-vori
Copy link
Contributor Author

@baptisteArno updates made, ready for merging

Copy link
Owner

@baptisteArno baptisteArno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you review all the actions and make sure that:

  • Helper text is only applied when it helps the user finding the information. If you want to provide a longer description of the field, use moreInfoTooltip instead. But generally the fields are self explanatory.
  • Add await analytics.closeAndFlush() at the end of each run function to make sure all events are saved
  • Reflect the name found in the Segment spec (i.e. https://segment.com/docs/connections/spec/track/). Typebot should not rename anything to avoid confusion. So for example you'd have to rename "Event name" to "Name".

apps/docs/editor/blocks/integrations/segment.mdx Outdated Show resolved Hide resolved
packages/forge/blocks/segment/actions/alias.ts Outdated Show resolved Hide resolved
packages/forge/blocks/segment/actions/trackPage.ts Outdated Show resolved Hide resolved
packages/forge/blocks/segment/actions/trackEvent.ts Outdated Show resolved Hide resolved
packages/forge/blocks/segment/actions/trackEvent.ts Outdated Show resolved Hide resolved
packages/prisma/postgresql/schema.prisma Outdated Show resolved Hide resolved
Copy link
Owner

@baptisteArno baptisteArno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned, can you remove all the helperText as well? I find that most of them are just redundant, they don't provide help.

@jwalsh-vori
Copy link
Contributor Author

jwalsh-vori commented Aug 14, 2024

As mentioned, can you remove all the helperText as well? I find that most of them are just redundant, they don't provide help.

Yes, removed most of them, thanks. I left the one in Alias because I think it's helpful to distinguish between the two IDs

Copy link
Contributor Author

@jwalsh-vori jwalsh-vori left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see, I get it now, thanks!

@jwalsh-vori
Copy link
Contributor Author

@baptisteArno thank you for all the help. This is my first time contributing to an OS project, it's a fun learning!

Can you let me know if there are any other changes needed, please? Thank you!

@baptisteArno
Copy link
Owner

Looks good to me 🔥

@baptisteArno baptisteArno merged commit 29ab812 into baptisteArno:main Aug 16, 2024
1 of 4 checks passed
@baptisteArno
Copy link
Owner

Thank you so much for this. Will announce this publicly on Discord and Twitter soon :)

@jwalsh-vori
Copy link
Contributor Author

jwalsh-vori commented Aug 16, 2024

Thank you so much for this. Will announce this publicly on Discord and Twitter soon :)

Happy to help, love Typebot and would love to help grow it further. thanks for your patience on this!

@jwalsh-vori jwalsh-vori deleted the FEAT_SEGMENT_BLOCK branch August 16, 2024 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for Segment events
3 participants