fix: Intercom setting anonymous user a common user id #36017
Conversation
WalkthroughThe changes involve modifications to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant bootIntercom
participant Intercom
User->>bootIntercom: Provide user data
bootIntercom->>bootIntercom: Extract name, email, username
bootIntercom->>Intercom: Send user data (if not anonymous)
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- app/client/src/utils/bootIntercom.ts (2 hunks)
Additional comments not posted (1)
app/client/src/utils/bootIntercom.ts (1)
Line range hint
28-36: Consistency maintained inupdateIntercomProperties.This function remains unchanged and continues to update Intercom properties appropriately. It's good to see consistency maintained across the functions, ensuring that user data handling aligns with the new privacy standards set in
bootIntercom.The code changes are approved.
| let name: string | undefined = user?.name; | ||
| let email: string | undefined = user?.email; | ||
| let username = | ||
| user?.username === ANONYMOUS_USERNAME ? undefined : user?.username; | ||
| if (!cloudHosting && username) { | ||
| // We are hiding their information when self-hosted |
There was a problem hiding this comment.
Well done on enhancing user privacy!
The changes made to handle username and email more securely are commendable. It's good to see that anonymous users are not assigned a common user_id, aligning with the PR's objectives.
However, I noticed a small area for improvement:
- The conditional logic inside the
if (!cloudHosting && username)block could be simplified for better readability. Consider extracting this logic into a separate function to handle user data sanitization.
The code changes are approved.
Consider refactoring the user data sanitization into a separate function for clarity:
+ function sanitizeUserData(user: User | undefined) {
+ let username = user?.username === ANONYMOUS_USERNAME ? undefined : user?.username;
+ let email = user?.email;
+ if (!cloudHosting && username) {
+ username = sha256(username);
+ email = undefined;
+ }
+ return { username, email };
+ }
export default function bootIntercom(user?: User) {
if (intercomAppID && window.Intercom) {
const { username, email } = sanitizeUserData(user);
...
}
}Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| let name: string | undefined = user?.name; | |
| let email: string | undefined = user?.email; | |
| let username = | |
| user?.username === ANONYMOUS_USERNAME ? undefined : user?.username; | |
| if (!cloudHosting && username) { | |
| // We are hiding their information when self-hosted | |
| function sanitizeUserData(user: User | undefined) { | |
| let username = user?.username === ANONYMOUS_USERNAME ? undefined : user?.username; | |
| let email = user?.email; | |
| if (!cloudHosting && username) { | |
| username = sha256(username); | |
| email = undefined; | |
| } | |
| return { username, email }; | |
| } | |
| let name: string | undefined = user?.name; | |
| let email: string | undefined = user?.email; | |
| let username = | |
| user?.username === ANONYMOUS_USERNAME ? undefined : user?.username; | |
| if (!cloudHosting && username) { | |
| // We are hiding their information when self-hosted |
) ## Description Avoids setting the `user_id` field in intercom when the user is not logged in Fixes https://github.com/appsmithorg/appsmith-ee/issues/5003 ## Automation /ok-to-test tags="@tag.Sanity" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!IMPORTANT] > 🟣 🟣 🟣 Your tests are running. > Tests running at: <https://github.com/appsmithorg/appsmith/actions/runs/10631847104> > Commit: 1eaad31 > Workflow: `PR Automation test suite` > Tags: `@tag.Sanity` > Spec: `` > <hr>Fri, 30 Aug 2024 11:26:34 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced user information handling for improved privacy in the application. - Anonymous users will no longer have their usernames processed, ensuring greater data protection. - **Bug Fixes** - Refined logic for extracting user information to prevent exposure of sensitive data. - **Documentation** - Updated comments and documentation to reflect changes in user data handling and privacy measures. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Description
Avoids setting the
user_idfield in intercom when the user is not logged inFixes https://github.com/appsmithorg/appsmith-ee/issues/5003
Automation
/ok-to-test tags="@tag.Sanity"
🔍 Cypress test results
Tip
🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10631847104
Commit: 1eaad31
Cypress dashboard.
Tags:
@tag.SanitySpec:
Fri, 30 Aug 2024 11:52:03 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit
New Features
Bug Fixes
Documentation