fix: one_signal: Encode external_id in endpoint #3140
Conversation
|
Important Auto Review SkippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the To trigger a single review, invoke the WalkthroughThe recent updates focus on ensuring proper URL formatting for API requests within the OneSignal integration. Specifically, the changes involve encoding special characters in user identifiers, such as email addresses, within URLs. This includes using Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
@coderabbitai review |
|
Test report for this run is available at: https://test-integrations-dev.s3.amazonaws.com/integrations-test-reports/rudder-transformer/3140/test-report.html |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #3140 +/- ##
===========================================
+ Coverage 84.59% 84.85% +0.25%
===========================================
Files 493 494 +1
Lines 27308 27274 -34
Branches 6576 6554 -22
===========================================
+ Hits 23101 23143 +42
+ Misses 3754 3707 -47
+ Partials 453 424 -29 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (3)
- src/v0/destinations/one_signal/transform.js (2 hunks)
- test/integrations/destinations/one_signal/processor/data.ts (5 hunks)
- test/integrations/destinations/one_signal/router/data.ts (1 hunks)
Additional comments: 3
src/v0/destinations/one_signal/transform.js (2)
- 125-125: The change correctly implements URL encoding for
externalUserIdin the track response builder usingencodeURIComponent. This ensures special characters inexternalUserIdare properly encoded, preventing errors in API requests to OneSignal.- 166-166: Similarly, the URL encoding for
externalUserIdin the group response builder is correctly implemented. This modification is crucial for maintaining the integrity of API requests, especially whenexternalUserIdcontains special characters.test/integrations/destinations/one_signal/router/data.ts (1)
- 202-202: The encoding of the '@' symbol as '%40' in the
external_user_idwithin the endpoint URL in the test data is correctly implemented. This change is essential for ensuring the test accurately reflects the conditions under which the code fix operates, specifically testing the URL encoding of special characters inexternal_user_id.
|
|
@saikumarrs We might need to check for breaking change for this |
Why do you think this is a breaking change? |
anantjain45823
deleted the
fix.one_signal_encode_external_id_in_endpoint
branch
What are the changes introduced in this PR?
We are not encoding the external_id (like @ / + symbols) in endpoint ( for rack and group calls ) resulting in the root cause of a bug where one_signal throws an error “No users with external_id found”
What is the related Linear task?
Resolves INT-1696
Please explain the objectives of your changes below
Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here
Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?
N/A
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
@coderabbitai review
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.
Summary by CodeRabbit
externalUserIdin OneSignal API requests to ensure compatibility.