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

feat(intercom): upgrade intercom version from 1.4 to 2.10 #2976

Merged
merged 24 commits into from
Feb 2, 2024

Conversation

mihir-4116
Copy link
Contributor

@mihir-4116 mihir-4116 commented Jan 8, 2024

What are the changes introduced in this PR?

  • This PR encompasses a significant upgrade to our Intercom integration from version 1.4 to 2.10 along with the migration of Intercom to CDK

What is the related Linear task?

Resolves INT-177

Please explain the objectives of your changes below

  • Identify call

    • In the previous version (v1.4), user creation or update occurred via a single endpoint.
    • In v2.10, this approach has been deprecated. Now, the identify call follows a new flow:
      1. An intermediate call is made to search for the contact.
      2. If the contact is located, an update user call is made; otherwise, a create user call is initiated.
  • Track call
    The track call process remains unchanged across both versions. It continues to add events to the respective user.

  • Group call

    • In v1.4, the response included two transformed outputs:
      1. Creation or update of the company.
      2. Addition of the user to the company.

    • With v2.10, the flow has been adjusted:
      1. Initially, a contact lookup based on email is performed.
      2. If a contact is found, an additional intermediate call is made to create and update the company. The final
      payload, adding the user to the company, is then returned to the server.
      4. If no contact is found, the second intermediate API call is skipped, and the response for creating or updating
      the company is directly returned to the server.

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

  1. no changes in overall functionalities

Any new dependencies introduced with this change?

N/A

Any new generic utility introduced or modified. Please explain the changes.

N/A

Any technical or performance related pointers to consider with the change?

N/A

Developer checklist

  • [✅ ] My code follows the style guidelines of this project

  • [❌ ] No breaking changes are being introduced.

  • [ ✅] All related docs linked with the PR?

  • [ ✅] All changes manually tested?

  • [✅ ] Any documentation changes needed with this change?

  • [ ❌] Is the PR limited to 10 file changes?

  • [ ✅] Is the PR limited to one linear task?

  • [✅ ] Are relevant unit and component test-cases added?

Reviewer checklist

  • [✅ ] Is the type of change in the PR title appropriate as per the changes?

  • [✅ ] Verified that there are no credentials or confidential data exposed with the changes.

Copy link
Contributor

coderabbitai bot commented Jan 8, 2024

Important

Auto 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.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

codecov bot commented Jan 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1e6d540) 87.14% compared to head (702c477) 87.15%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2976      +/-   ##
===========================================
+ Coverage    87.14%   87.15%   +0.01%     
===========================================
  Files          530      529       -1     
  Lines        28812    28796      -16     
  Branches      6861     6865       +4     
===========================================
- Hits         25109    25098      -11     
+ Misses        3360     3355       -5     
  Partials       343      343              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@koladilip
Copy link
Contributor

Not full review

@mihir-4116 mihir-4116 requested a review from koladilip January 11, 2024 04:15
@mihir-4116 mihir-4116 requested a review from ItsSudip January 11, 2024 11:26
koladilip
koladilip previously approved these changes Jan 12, 2024
@mihir-4116 mihir-4116 requested a review from koladilip January 24, 2024 05:19
@devops-github-rudderstack
Copy link
Contributor

@devops-github-rudderstack
Copy link
Contributor

@devops-github-rudderstack
Copy link
Contributor

ItsSudip
ItsSudip previously approved these changes Jan 31, 2024
@devops-github-rudderstack
Copy link
Contributor

@devops-github-rudderstack
Copy link
Contributor

@mihir-4116 mihir-4116 requested a review from koladilip February 2, 2024 03:47
@devops-github-rudderstack
Copy link
Contributor

1 similar comment
@devops-github-rudderstack
Copy link
Contributor

@devops-github-rudderstack
Copy link
Contributor

@devops-github-rudderstack
Copy link
Contributor

Copy link

sonarqubecloud bot commented Feb 2, 2024

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

1 New issue
0 Security Hotspots
99.2% Coverage on New Code
0.2% Duplication on New Code

See analysis details on SonarCloud

Copy link
Contributor

@koladilip koladilip left a comment

Choose a reason for hiding this comment

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

We will refactor procWorkflow in next PR

@mihir-4116 mihir-4116 merged commit 717639b into develop Feb 2, 2024
14 checks passed
@mihir-4116 mihir-4116 deleted the feat.intercom branch February 2, 2024 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants