Add `/track/open` #2683

devkiran · 2025-07-25T06:56:20Z

Summary by CodeRabbit

New Features
- Introduced a new API endpoint to track "open" events for deep links, providing a unique click ID and resolved URL in the response.
- Added support for CORS, including preflight (OPTIONS) requests.
Tests
- Added comprehensive tests for the new tracking endpoint, covering successful event tracking, error handling, CORS headers, and response validation.

vercel · 2025-07-25T06:56:23Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
dub	✅ Ready (Inspect)	Visit Preview	Jul 25, 2025 6:12pm

coderabbitai · 2025-07-25T06:56:26Z

Walkthrough

A new API endpoint for tracking "open" events via POST requests was implemented, featuring input validation, caching, click event recording, error handling, and CORS support including OPTIONS preflight handling. Corresponding integration tests were added to verify correct behavior, including response structure, error cases, and CORS compliance for both POST and OPTIONS requests.

Changes

File(s)	Change Summary
apps/web/app/(ee)/api/track/open/route.ts	Added new API route handling POST and OPTIONS requests for tracking "open" events, with input validation, caching, click event recording, error handling, and CORS support.
apps/web/tests/tracks/track-open.test.ts	Added integration tests for `/track/open` endpoint covering success cases, repeated requests, error handling for missing links, CORS headers validation, and response format checks.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐇
A click, a track, a link set free,
Through open doors of API.
With tests that hop and CORS that sing,
The data flows on rabbit wing.
New routes appear, the code is neat—
This shipping sprint is quite a feat!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3682d38 and 9586034.

📒 Files selected for processing (1)

apps/web/tests/tracks/track-open.test.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

apps/web/tests/tracks/track-open.test.ts

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch deep-link-track-open

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
- Explain this complex logic.
- 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 explain this code block.
- @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

@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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 01ea8e2 and 9591f02.

📒 Files selected for processing (2)

apps/web/app/(ee)/api/track/open/route.ts (1 hunks)
apps/web/tests/tracks/track-open.test.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: build

🔇 Additional comments (14)

apps/web/app/(ee)/api/track/open/route.ts (9)

1-24: Well-structured imports and CORS configuration.

The imports are well-organized and the CORS headers are properly configured for cross-origin requests. The wildcard origin (*) is appropriate for a public tracking endpoint.

21-29: Schema definitions look good with proper validation.

The Zod schemas provide good input validation with string trimming and proper response type checking.

38-47: Redis cache key generation and clickId logic is well implemented.

The parallel cache retrieval using mget is efficient, and the clickId generation/reuse logic is sound. Using nanoid(16) provides good uniqueness for click tracking.

49-65: Link retrieval and caching implementation is robust.

The error handling for non-existent links is appropriate, and the asynchronous cache setting using waitUntil is a good performance optimization.

67-72: Workspace validation is essential for security.

Good security check to ensure links belong to a workspace before processing. This prevents tracking of orphaned or malicious links.

74-87: Click recording logic with proper rate limiting bypass.

The conditional click recording only for new clickIds is efficient and prevents duplicate tracking. The skipRatelimit: true and shouldCacheClickId: true parameters are appropriate for this tracking endpoint.

89-98: Response handling and error management is well implemented.

The response schema validation ensures type safety, and the error handling with CORS headers is properly implemented.

100-105: OPTIONS handler correctly implements CORS preflight support.

The OPTIONS handler properly returns a 204 status with CORS headers as required for preflight requests.

36-36: No action needed: VERCEL detection is correct and consistent

The check process.env.VERCEL === "1" is used throughout the codebase (e.g. in apps/web/app/providers.tsx, all tracking routes, cron jobs, middleware, etc.) to distinguish Vercel deployments from local development. This aligns with Vercel’s built-in VERCEL variable (set to "1" at runtime), so the IP handling logic in apps/web/app/(ee)/api/track/open/route.ts is already correct.
apps/web/tests/tracks/track-open.test.ts (5)

5-16: Helper function provides good response validation.

The expectValidClickResponse helper function properly validates the response structure and status code.

22-35: Basic tracking test is well-structured.

The test properly validates the core functionality of the /track/open endpoint.

79-95: CORS OPTIONS test is comprehensive and correct.

The test properly validates all expected CORS headers for the OPTIONS preflight request.

110-121: ClickId format validation is properly implemented.

The regex validation ensures the clickId follows the expected 16-character alphanumeric format matching the nanoid(16) implementation.

37-57: Fix endpoint path inconsistency in clickId reuse test.

The test is checking clickId consistency between endpoints, but there's a path mismatch that could cause confusion.
     const response1 = await http.post<{ clickId: string }>({
-      path: "/track/click",
+      path: "/track/open",
       headers: E2E_TRACK_CLICK_HEADERS,
       body: {
         domain: E2E_LINK.domain,
         key: E2E_LINK.key,
       },
     });
If the intention is to test cross-endpoint clickId consistency, please add a comment explaining this behavior.

Likely an incorrect or invalid review comment.

apps/web/tests/tracks/track-open.test.ts

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

steven-tey · 2025-07-25T18:50:18Z

@CodeRabbit final review

coderabbitai · 2025-07-25T18:51:34Z

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

I'll conduct a comprehensive final review of the /track/open endpoint implementation. Let me examine the code to provide thorough feedback.

🏁 Script executed:

#!/bin/bash
# Read the main route implementation
echo "=== Route Implementation ==="
cat apps/web/app/\(ee\)/api/track/open/route.ts

echo -e "\n=== Test Implementation ==="
cat apps/web/tests/tracks/track-open.test.ts

echo -e "\n=== Check for similar tracking endpoints for consistency ==="
find apps/web -name "*.ts" -path "*/api/track/*" -type f | head -5

echo -e "\n=== Look for existing validation patterns ==="
rg -A 3 -B 1 "trackOpenSchema|trackSchema" --type ts

Length of output: 7508

Let me examine the other tracking endpoints for consistency and check for any patterns that should be followed.

🏁 Script executed:

#!/bin/bash
echo "=== Compare with track/click endpoint structure ==="
head -50 apps/web/app/\(ee\)/api/track/click/route.ts

echo -e "\n=== Check validation schema patterns across tracking endpoints ==="
rg -A 5 -B 2 "Schema.*=.*z\.object" apps/web/app/\(ee\)/api/track/ --type ts

echo -e "\n=== Check trigger values used in other endpoints ==="
rg "trigger.*:" apps/web/app/\(ee\)/api/track/ --type ts

echo -e "\n=== Check if deep link specific logic exists elsewhere ==="
rg -i "deeplink|deep.link" apps/web --type ts | head -10

Length of output: 5598

@steven-tey Here's my comprehensive final review of the /track/open endpoint:

✅ Overall Assessment: High Quality Implementation

The implementation is well-structured, secure, and follows most of the established patterns in the codebase. The test coverage is comprehensive and the functionality is solid.

🔍 Key Strengths

Robust Architecture: Proper caching strategy, error handling, and CORS support
Security: Correct IP detection, input validation, and workspace verification
Performance: Efficient Redis caching and non-blocking operations with waitUntil
Testing: Comprehensive test suite covering success cases, edge cases, CORS, and error scenarios
Deep Link Integration: Appropriate use of "deeplink" trigger, consistent with the codebase's deep link functionality

🔧 Minor Consistency Issues

For better alignment with existing tracking endpoints, consider these improvements:

Schema Naming:

// Current
const trackOpenRequestSchema = z.object({...})

// Should be (to match trackClickSchema pattern)
const trackOpenSchema = z.object({...})

Validation Messages (to match /track/click):

const trackOpenSchema = z.object({
  domain: z.string({ required_error: "domain is required." }).trim(),
  key: z.string({ required_error: "key is required." }).trim(),
});

Response Schema: The trackOpenResponseSchema validation might be unnecessary overhead since it's only used for internal type safety.

🎯 Implementation Highlights

Unique Trigger: The "deeplink" trigger is appropriately unique to this endpoint
Efficient Caching: Smart reuse of cached click IDs prevents duplicate tracking
Error Handling: Clear, actionable error messages with proper HTTP status codes
Test Quality: Excellent test coverage including CORS validation and clickId format verification

📋 Final Verdict

This is a solid, production-ready implementation. The minor consistency issues mentioned above are optional improvements that don't affect functionality. The code demonstrates good understanding of the existing patterns and adds valuable deep link tracking capabilities.

Ready for merge! 🚀

devkiran added 2 commits July 25, 2025 12:04

add /track/open

4e36f1a

add tests

9591f02

devkiran requested a review from steven-tey July 25, 2025 06:57

coderabbitai bot reviewed Jul 25, 2025

View reviewed changes

apps/web/tests/tracks/track-open.test.ts Show resolved Hide resolved

apps/web/tests/tracks/track-open.test.ts Show resolved Hide resolved

vercel bot deployed to Preview July 25, 2025 07:00 View deployment

devkiran and others added 2 commits July 25, 2025 15:52

Update route.ts

f4850ee

Update apps/web/tests/tracks/track-open.test.ts

a526d89

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

vercel bot deployed to Preview July 25, 2025 10:32 View deployment

steven-tey added 2 commits July 25, 2025 10:31

Merge branch 'main' into deep-link-track-open

7c20029

update request/response schemas

3682d38

vercel bot deployed to Preview July 25, 2025 17:57 View deployment

fix tests

9586034

vercel bot deployed to Preview July 25, 2025 18:12 View deployment

steven-tey approved these changes Jul 25, 2025

View reviewed changes

steven-tey merged commit 18c67dd into main Jul 25, 2025
8 checks passed

steven-tey deleted the deep-link-track-open branch July 25, 2025 18:55

coderabbitai bot mentioned this pull request Jul 25, 2025

improve track open to receive deepLink instead of domain+key #2685

Merged

coderabbitai bot mentioned this pull request Aug 13, 2025

FEAT: iOS Deferred Deep Linking #2746

Merged

coderabbitai bot mentioned this pull request Aug 21, 2025

Add publishableKey support + /track/**/client #2737

Merged

coderabbitai bot mentioned this pull request Oct 7, 2025

Use identityHash for recordClickCache #2943

Merged

coderabbitai bot mentioned this pull request Nov 6, 2025

Refactor to @axiomhq/nextjs #3069

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `/track/open` #2683

Add `/track/open` #2683

Uh oh!

devkiran commented Jul 25, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jul 25, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 25, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

steven-tey commented Jul 25, 2025

Uh oh!

coderabbitai bot commented Jul 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add /track/open #2683

Add /track/open #2683

Uh oh!

Conversation

devkiran commented Jul 25, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

steven-tey commented Jul 25, 2025

Uh oh!

coderabbitai bot commented Jul 25, 2025

✅ Overall Assessment: High Quality Implementation

🔍 Key Strengths

🔧 Minor Consistency Issues

🎯 Implementation Highlights

📋 Final Verdict

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add `/track/open` #2683

Add `/track/open` #2683

devkiran commented Jul 25, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jul 25, 2025 •

edited

Loading

coderabbitai bot commented Jul 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)