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.

Sign up for GitHub

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

Jump to bottom

[WEB-2103]: chore: Intercom integration #5295

Merged
merged 6 commits into from
Aug 5, 2024
Merged

[WEB-2103]: chore: Intercom integration #5295

merged 6 commits into from
Aug 5, 2024

Conversation

gurusainath
Copy link
Collaborator

@gurusainath gurusainath commented Aug 5, 2024 •
edited by coderabbitai bot
Loading

Summary

  • Replaced crisp with intercom

Summary by CodeRabbit

  • New Features

    • Introduced Intercom integration for enhanced user communication and support.
    • Added configuration management for Intercom settings in the admin interface.
    • Dynamic rendering of the Intercom button based on configuration settings in the sidebar help section.

  • Bug Fixes

    • Removed unnecessary console log statements to improve code clarity.

  • Chores

    • Updated Next.js routing to redirect /signin to the home page for better navigation.
    • Added new constants for user authentication and settings management.

  • Documentation

    • Enhanced documentation for hooks related to page management for improved developer experience.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 5, 2024 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The recent updates enhance the application by integrating Intercom configuration management alongside telemetry settings. Key components have been modified or introduced, facilitating a dynamic user experience through improved interactivity. The changes include new hooks, expanded configuration options, and a refined structure for handling user engagement via the Intercom service. Overall, these updates streamline functionality and maintainability across various components while enhancing user interface interactions.

Changes

File Path Summary
admin/app/general/form.tsx Enhanced intercom configuration logic based on telemetry settings; introduced updateInstanceConfigurations method.
admin/app/general/intercom.tsx New IntercomConfig component created for managing Intercom settings, utilizing MobX and SWR for state management and data fetching.
admin/app/general/page.tsx Removed a console log statement for cleaner code.
admin/core/components/login/... Removed console log for csrfToken in the sign-in form.
apiserver/plane/license/api/views/... Enhanced get method to include Intercom configuration settings.
apiserver/plane/license/management/... Added new Intercom-related settings to configuration management.
apiserver/plane/utils/constants.py Added new string constants related to user authentication.
packages/types/src/instance/... Updated IInstanceConfig interface with new properties for Intercom integration.
web/app/layout.tsx Updated apple touch icon link for better display.
web/app/provider.tsx Replaced CrispWrapper with IntercomProvider for user interaction handling.
web/core/components/workspace/... Enhanced SidebarHelpSection to conditionally render Intercom button based on configuration.
web/core/hooks/store/index.ts Restructured exported hooks, emphasizing project management and issue tracking.
web/core/hooks/store/pages/index.ts New file consolidating hooks related to page management for improved modularity.
web/core/lib/intercom-provider.tsx New IntercomProvider component for integrating Intercom messaging service.
web/next.config.js Added redirect rule from /signin to /.
web/package.json Added dependency on @intercom/messenger-js-sdk for messaging capabilities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant IntercomConfig
    participant GeneralConfigurationForm
    participant IntercomProvider

    User->>GeneralConfigurationForm: Submit settings
    GeneralConfigurationForm->>IntercomConfig: Update intercom settings
    IntercomConfig-->>IntercomProvider: Initialize Intercom with user data
    IntercomProvider->>User: Engage user with Intercom
Loading

🐇 In a field of bright green grass,
A rabbit hops, with joy to amass,
New changes come, oh what delight,
With Intercom's chat, we'll take flight!
So here we cheer, with a happy cheer,
For features new, we hold so dear! 🌼

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.

@gurusainath gurusainath marked this pull request as ready for review August 5, 2024 08:03
@sriramveeraghanta sriramveeraghanta merged commit 0619f1b into preview Aug 5, 2024
18 of 21 checks passed
@sriramveeraghanta sriramveeraghanta deleted the fix-intercom-integration branch August 5, 2024 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sriramveeraghanta sriramveeraghanta sriramveeraghanta approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gurusainath @sriramveeraghanta