✨ [RUM-10223] Add locale and timezone data to view event #3598

mormubis · 2025-06-05T10:27:43Z

Motivation

Adding locale and time_zone out of the box for all customers.

Changes

Pulling changes in the git submodule from DataDog/rum-events-format#272.

Add device fields to viewCollection.

Test instructions

Checkout this branch
Run yarn dev
Go to http://localhost:8080/
Verify that the View Page event contains the device field populated with locale, locales and time_zone

Checklist

Tested locally
Tested on staging
Added unit tests for this change.
Added e2e/integration tests for this change.

codecov-commenter · 2025-06-05T10:30:31Z

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 92.43%. Comparing base (a4f17b2) to head (55d0f00).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/core/src/tools/utils/timezone.ts	80.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3598      +/-   ##
==========================================
- Coverage   92.44%   92.43%   -0.01%     
==========================================
  Files         322      323       +1     
  Lines        8127     8132       +5     
  Branches     1838     1838              
==========================================
+ Hits         7513     7517       +4     
- Misses        614      615       +1

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

cit-pr-commenter · 2025-06-05T10:37:48Z

Bundles Sizes Evolution

📦 Bundle Name	Local Size	𝚫	𝚫%	Status
Rum	147.48 KiB	147.48 KiB	N/A%	✅
Rum Recorder	18.02 KiB	18.02 KiB	N/A%	✅
Rum Profiler	4.63 KiB	4.63 KiB	N/A%	✅
Logs	51.86 KiB	51.86 KiB	N/A%	✅
Flagging	935 B	935 B	N/A%	✅
Rum Slim	107.07 KiB	107.07 KiB	N/A%	✅
Worker	23.59 KiB	23.59 KiB	N/A%	✅

🚀 CPU Performance

Action Name	Base Average Cpu Time (ms)	Local Average Cpu Time (ms)	𝚫
addglobalcontext	N/A	0.007	0.007
addaction	N/A	0.020	0.020
addtiming	N/A	0.004	0.004
adderror	N/A	0.019	0.019
startstopsessionreplayrecording	N/A	0.001	0.001
startview	N/A	0.005	0.005
logmessage	N/A	0.022	0.022

🧠 Memory Performance

Action Name	Base Consumption Memory (bytes)	Local Consumption Memory (bytes)	𝚫 (bytes)
addglobalcontext	NaN KiB	28.19 KiB	NaN KiB
addaction	NaN KiB	55.29 KiB	NaN KiB
addtiming	NaN KiB	26.23 KiB	NaN KiB
adderror	NaN KiB	57.78 KiB	NaN KiB
startstopsessionreplayrecording	NaN KiB	24.95 KiB	NaN KiB
startview	NaN KiB	430.47 KiB	NaN KiB
logmessage	NaN KiB	62.74 KiB	NaN KiB

🔗 RealWorld

packages/core/src/tools/utils/polyfills.ts

packages/rum-core/src/domain/view/viewCollection.ts

BenoitZugmeyer · 2025-06-17T06:36:28Z

packages/rum-core/src/rawRumEvent.types.ts

@@ -137,6 +137,11 @@ export interface RawRumViewEvent {
      start_session_replay_recording_manually: boolean
    }
  }
+  device?: {
+    locale?: string
+    locales?: string[] | readonly string[]


suggestion: mentioning both types seems superfluous

Suggested change

locales?: string[] | readonly string[]

locales?: string[]

navigator.languages is just readonly string[] and cannot be assigned to mutable array.

At the same time, if we want to test it out, it's fine to have a regular array ['a', 'b'] vs ['a', 'b'] as const.

What do you think?

I see! Yeah, I think we could just keep readonly string[] then

Co-authored-by: Thomas Lebeau <[email protected]>

Co-authored-by: Benoît <[email protected]>

mormubis · 2025-06-17T08:09:30Z

/to-staging

dd-devflow · 2025-06-17T08:09:34Z

View all feedbacks in Devflow UI.

2025-06-17 08:09:33 UTC ℹ️ Start processing command /to-staging

2025-06-17 08:09:39 UTC ℹ️ Branch Integration: starting soon, merge expected in approximately 19m53s (p90)

Commit 5e35369be2 will soon be integrated into staging-25.

2025-06-17 08:12:13 UTC 🚨 Branch Integration: an error occurred while merging 5e35369be2 into staging-25

Gitlab pipeline didn't start on its own and we were unable to create it... Please retry.

Error: POST https://gitlab.ddbuild.io/api/v4/projects/DataDog/browser-sdk/pipeline: 400 {message: {base: [Reference not found]}} (type: ErrorResponse, retryable: true)

mormubis · 2025-06-17T08:50:30Z

/to-staging

dd-devflow · 2025-06-17T08:50:33Z

View all feedbacks in Devflow UI.

2025-06-17 08:50:32 UTC ℹ️ Start processing command /to-staging

2025-06-17 08:50:41 UTC ℹ️ Branch Integration: starting soon, merge expected in approximately 19m53s (p90)

Commit 5e35369be2 will soon be integrated into staging-25.

2025-06-17 09:10:31 UTC ℹ️ Branch Integration: This commit was successfully integrated

Commit 5e35369be2 has been merged into staging-25 in merge commit bea48bbdca.

Check out the triggered pipeline on Gitlab 🦊

If you need to revert this integration, you can use the following command: /code revert-integration -b staging-25

Integrated commit sha: 5e35369 Co-authored-by: mormubis <[email protected]>

BenoitZugmeyer · 2025-06-18T08:49:09Z

packages/rum-core/src/rawRumEvent.types.ts

@@ -137,6 +137,11 @@ export interface RawRumViewEvent {
      start_session_replay_recording_manually: boolean
    }
  }
+  device?: {
+    locale?: string
+    locales?: string[] | readonly string[]


I see! Yeah, I think we could just keep readonly string[] then

rgaignault

LGTM 👍

mormubis changed the title ~~adlrb/rum 10223 locale ootb~~ ✨ [RUM-10223] Add locale and timezone data to view event Jun 5, 2025

mormubis force-pushed the adlrb/rum-10223-locale-ootb branch 2 times, most recently from 41ef52c to c220cd0 Compare June 16, 2025 09:30

mormubis marked this pull request as ready for review June 16, 2025 13:50

mormubis requested a review from a team as a code owner June 16, 2025 13:50

thomas-lebeau reviewed Jun 17, 2025

View reviewed changes

packages/core/src/tools/utils/polyfills.ts Outdated Show resolved Hide resolved

packages/core/src/tools/utils/polyfills.ts Outdated Show resolved Hide resolved

packages/core/src/tools/utils/polyfills.ts Outdated Show resolved Hide resolved

BenoitZugmeyer reviewed Jun 17, 2025

View reviewed changes

mormubis and others added 14 commits June 17, 2025 10:07

feat: add locale and timezone information to the view collection

cfa3618

fix: add device info to the right place

d959396

fix: types for raw rum event

6dc8e45

test: update submodule

16bdd7a

refactor: update types

9650842

refactor: update types

0c89925

refactor: update types

050ff58

refactor: update format branch

4b6505f

fix: types regeneration

3262aeb

fix: dedupe types

2e3395e

refactor: add guards to access timezone

22fa1d4

Update packages/core/src/tools/utils/polyfills.ts

02a8906

Co-authored-by: Thomas Lebeau <[email protected]>

Update packages/rum-core/src/domain/view/viewCollection.ts

44ea7fc

Co-authored-by: Benoît <[email protected]>

fix: pr feedback - moving code to its own file

5e35369

mormubis force-pushed the adlrb/rum-10223-locale-ootb branch from 7713b14 to 5e35369 Compare June 17, 2025 08:07

fix: pr feedback - remove documentation

a474f01

dd-mergequeue bot added a commit that referenced this pull request Jun 17, 2025

Integrate adlrb/rum-10223-locale-ootb (#3598) into staging-25

bea48bb

Integrated commit sha: 5e35369 Co-authored-by: mormubis <[email protected]>

dd-devflow bot added the staging-25 label Jun 17, 2025

revert: types

3aa8325

mormubis requested review from BenoitZugmeyer and thomas-lebeau June 17, 2025 13:07

BenoitZugmeyer approved these changes Jun 18, 2025

View reviewed changes

rgaignault approved these changes Jun 18, 2025

View reviewed changes

fix: pr feedback - remove unused type

55d0f00

thomas-lebeau approved these changes Jun 18, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ [RUM-10223] Add locale and timezone data to view event #3598

✨ [RUM-10223] Add locale and timezone data to view event #3598

Uh oh!

mormubis commented Jun 5, 2025 •

edited

Loading

Uh oh!

codecov-commenter commented Jun 5, 2025 •

edited

Loading

Uh oh!

cit-pr-commenter bot commented Jun 5, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BenoitZugmeyer Jun 17, 2025

Uh oh!

mormubis Jun 17, 2025

Uh oh!

BenoitZugmeyer Jun 18, 2025

Uh oh!

mormubis commented Jun 17, 2025

Uh oh!

dd-devflow bot commented Jun 17, 2025 •

edited

Loading

Uh oh!

mormubis commented Jun 17, 2025

Uh oh!

dd-devflow bot commented Jun 17, 2025 •

edited

Loading

Uh oh!

BenoitZugmeyer Jun 18, 2025

Uh oh!

rgaignault left a comment

Uh oh!

Uh oh!

✨ [RUM-10223] Add locale and timezone data to view event #3598

Are you sure you want to change the base?

✨ [RUM-10223] Add locale and timezone data to view event #3598

Uh oh!

Conversation

mormubis commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Changes

Test instructions

Checklist

Uh oh!

codecov-commenter commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cit-pr-commenter bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundles Sizes Evolution

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BenoitZugmeyer Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

mormubis Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

BenoitZugmeyer Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

mormubis commented Jun 17, 2025

Uh oh!

dd-devflow bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mormubis commented Jun 17, 2025

Uh oh!

dd-devflow bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BenoitZugmeyer Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

rgaignault left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mormubis commented Jun 5, 2025 •

edited

Loading

codecov-commenter commented Jun 5, 2025 •

edited

Loading

cit-pr-commenter bot commented Jun 5, 2025 •

edited

Loading

dd-devflow bot commented Jun 17, 2025 •

edited

Loading

dd-devflow bot commented Jun 17, 2025 •

edited

Loading