feat(backend): added utm data to PG #2152
Conversation
WalkthroughThe recent updates enhance session tracking by implementing UTM parameter updates across various components. A new method extracts UTM data from URLs, updates session records, and integrates these changes into the session management infrastructure. This ensures accurate tracking of marketing efforts, enhancing data-driven decision-making. Changes
Tip New Features and ImprovementsReview SettingsIntroduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments. AST-based InstructionsCodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation. Community-driven AST-based RulesWe are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information. New Static Analysis ToolsWe are continually expanding our support for static analysis tools. We have added support for Tone SettingsUsers can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:
Revamped Settings PageWe have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to Miscellaneous
Warning Review ran into problemsProblems (1)
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[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| func GetURLQueryParams(rawURL string) (map[string]string, error) { | ||
| rawURL = strings.Replace(rawURL, "\t", "", -1) | ||
| u, err := url.Parse(rawURL) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| params := make(map[string]string) | ||
| for key, values := range u.Query() { | ||
| params[key] = values[0] | ||
| } | ||
| return params, nil | ||
| } |
There was a problem hiding this comment.
Consider supporting multiple values for the same query parameter.
- params[key] = values[0]
+ params[key] = strings.Join(values, ",")This change will concatenate all values for a parameter separated by commas, which might be useful if multiple values are expected.
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.
| func GetURLQueryParams(rawURL string) (map[string]string, error) { | |
| rawURL = strings.Replace(rawURL, "\t", "", -1) | |
| u, err := url.Parse(rawURL) | |
| if err != nil { | |
| return nil, err | |
| } | |
| params := make(map[string]string) | |
| for key, values := range u.Query() { | |
| params[key] = values[0] | |
| } | |
| return params, nil | |
| } | |
| func GetURLQueryParams(rawURL string) (map[string]string, error) { | |
| rawURL = strings.Replace(rawURL, "\t", "", -1) | |
| u, err := url.Parse(rawURL) | |
| if err != nil { | |
| return nil, err | |
| } | |
| params := make(map[string]string) | |
| for key, values := range u.Query() { | |
| params[key] = strings.Join(values, ",") | |
| } | |
| return params, nil | |
| } |
| @@ -180,6 +180,7 @@ func (s *saverImpl) handleMessage(msg Message) error { | |||
| return err | |||
| } | |||
| s.sessions.UpdateReferrer(session.SessionID, m.Referrer) | |||
| s.sessions.UpdateUTM(session.SessionID, m.URL) | |||
There was a problem hiding this comment.
Add error handling for the UpdateUTM method call.
- s.sessions.UpdateUTM(session.SessionID, m.URL)
+ if err := s.sessions.UpdateUTM(session.SessionID, m.URL); err != nil {
+ s.log.Error(sessCtx, "UTM update failed for session %d, error: %s", session.SessionID, err)
+ return err
+ }This ensures that any errors during UTM updates are logged and handled appropriately.
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.
| s.sessions.UpdateUTM(session.SessionID, m.URL) | |
| if err := s.sessions.UpdateUTM(session.SessionID, m.URL); err != nil { | |
| s.log.Error(sessCtx, "UTM update failed for session %d, error: %s", session.SessionID, err) | |
| return err | |
| } |
| func (s *sessionsImpl) UpdateUTM(sessionID uint64, pageUrl string) error { | ||
| params, err := url.GetURLQueryParams(pageUrl) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| utmSource := params["utm_source"] | ||
| utmMedium := params["utm_medium"] | ||
| utmCampaign := params["utm_campaign"] | ||
| if utmSource == "" && utmMedium == "" && utmCampaign == "" { | ||
| return nil | ||
| } | ||
| s.updates.SetUTM(sessionID, utmSource, utmMedium, utmCampaign) | ||
| return nil | ||
| } |
There was a problem hiding this comment.
Handle cases where only some UTM parameters are present.
- if utmSource == "" && utmMedium == "" && utmCampaign == "" {
+ if utmSource != "" || utmMedium != "" || utmCampaign != "" {
+ s.updates.SetUTM(sessionID, utmSource, utmMedium, utmCampaign)
+ }This change ensures that UTM parameters are updated even if only some of them are present, rather than requiring all to be non-empty.
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.
| func (s *sessionsImpl) UpdateUTM(sessionID uint64, pageUrl string) error { | |
| params, err := url.GetURLQueryParams(pageUrl) | |
| if err != nil { | |
| return err | |
| } | |
| utmSource := params["utm_source"] | |
| utmMedium := params["utm_medium"] | |
| utmCampaign := params["utm_campaign"] | |
| if utmSource == "" && utmMedium == "" && utmCampaign == "" { | |
| return nil | |
| } | |
| s.updates.SetUTM(sessionID, utmSource, utmMedium, utmCampaign) | |
| return nil | |
| } | |
| func (s *sessionsImpl) UpdateUTM(sessionID uint64, pageUrl string) error { | |
| params, err := url.GetURLQueryParams(pageUrl) | |
| if err != nil { | |
| return err | |
| } | |
| utmSource := params["utm_source"] | |
| utmMedium := params["utm_medium"] | |
| utmCampaign := params["utm_campaign"] | |
| if utmSource != "" || utmMedium != "" || utmCampaign != "" { | |
| s.updates.SetUTM(sessionID, utmSource, utmMedium, utmCampaign) | |
| } | |
| return nil | |
| } |
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- ee/backend/pkg/db/clickhouse/connector.go (2 hunks)
Additional comments not posted (2)
ee/backend/pkg/db/clickhouse/connector.go (2)
118-118: Ensure the new UTM fields are correctly integrated into the SQL query.The addition of
utm_source,utm_medium, andutm_campaignto thesessionstable's INSERT statement aligns with the PR's objectives to track UTM parameters. Ensure that these fields are properly indexed if performance becomes a concern.
318-320: UTM parameters correctly appended to session data.#!/bin/bash # Description: Verify that UTM parameters are being stored correctly in the database. # Test: Query the database to check if UTM parameters are present and correctly associated with sessions. echo "SELECT session_id, utm_source, utm_medium, utm_campaign FROM experimental.sessions WHERE session_id = <some_session_id>;"The UTM parameters are correctly appended to the session data. It's recommended to verify that these parameters are being stored correctly in the database.
No description provided.