✨ [RUM-4014] DD_LOGS: add handling stack in beforeSend context

[thomas-lebeau]

Motivation

Create a stack trace and expose it in the beforeSend's domainContext argument.
It allow customers to initialise the browser SDK with something like:

const SERVICE_REGEX = /(?:browser-sdk-test-playground\/module-federation\/|webpack:\/\/)(?<service>\w*)\//;
  
DD_LOGS.init({
  beforeSend: (event, context) => {
    const service =
      context?.handlingStack?.match(SERVICE_REGEX)?.groups?.service;

    if (service) {
      event.service = service; //TODO: this is not yet implemented
    }
    return true;
  },
});

Changes

• support the following APIs
  • console.*()
  • logger.*()
  • fetch console errors?
  • xhr console errors?
• moved isAuthorized to a new file to avoid cyclic dependencies

Testing

• Local
• Staging
• Unit
• End to end

---

I have gone over the contributing documentation.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.63%. Comparing base (81981c0) to head (ef8878c).
Report is 8 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2786   +/-   ##
=======================================
  Coverage   93.63%   93.63%           
=======================================
  Files         243      244    +1     
  Lines        7112     7121    +9     
  Branches     1583     1588    +5     
=======================================
+ Hits         6659     6668    +9     
  Misses        453      453           

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

[cit-pr-commenter]

Bundles Sizes Evolution

📦 Bundle Name	Base Size	Local Size	𝚫	𝚫%	Status
Rum	158.74 KiB	158.74 KiB	0 B	0.00%	✅
Logs	57.67 KiB	57.90 KiB	244 B	+0.41%	✅
Rum Slim	105.21 KiB	105.21 KiB	0 B	0.00%	✅
Worker	25.21 KiB	25.21 KiB	0 B	0.00%	✅

🚀 CPU Performance

Action Name	Base Average Cpu Time (ms)	Local Average Cpu Time (ms)	𝚫
addglobalcontext	0.002	0.002	0.000
addaction	0.038	0.040	0.002
adderror	0.035	0.037	0.003
addtiming	0.001	0.001	-0.000
startview	1.270	1.206	-0.064
startstopsessionreplayrecording	0.942	1.211	0.269
logmessage	0.006	0.029	0.023

🧠 Memory Performance

Action Name	Base Consumption Memory (bytes)	Local Consumption Memory (bytes)	𝚫 (bytes)
addglobalcontext	19.68 KiB	18.52 KiB	-1186 B
addaction	69.82 KiB	69.25 KiB	-577 B
adderror	86.51 KiB	84.04 KiB	-2536 B
addtiming	17.55 KiB	16.64 KiB	-932 B
startview	312.30 KiB	316.66 KiB	4.36 KiB
startstopsessionreplayrecording	12.19 KiB	12.43 KiB	245 B
logmessage	67.54 KiB	69.47 KiB	1.94 KiB

[thomas-lebeau]

♻️ refactor: this file contains function and types that have been moved here untouched to avoid cyclic dependency

[BenoitZugmeyer]

💬 suggestion: ‏Maybe it could be interesting to use .bind to avoid duplicating so much code? Something like:

class Logger {
  constructor(...) {
    ...
    this.ok = logImplementation.bind(this, StatusType.ok)
  }
}

This could be a minor breaking change though (ex: if a customer has a class that extends Logger and calls super.ok())

Else, I would suggest to always create the handlingstack, as it would reduce a bit the amount of boilerplate.

[thomas-lebeau]

always create the handlingstack

Indeed, this would save ~660 Bytes as per my calculations. However generating a stack trace could be expensive, especially if used a lot.

Another solution is to skip 3 frame instead of 2 for logs. Customers can always increase the stack size if needed.

wdyt?

[thomas-lebeau]

Apply the prototype trick we talked during the daily. +240B vs +909B before 🎉
Thank you @BenoitZugmeyer for the suggestion

[thomas-lebeau]

/to-staging

[dd-devflow]

🚂 Branch Integration: starting soon, median merge time is 10m

Commit ef8878c0d6 will soon be integrated into staging-24.

Use /to-staging -c to cancel this operation!

[dd-devflow]

🚂 Branch Integration: This commit was successfully integrated

Commit ef8878c0d6 has been merged into staging-24 in merge commit c724037f68.

Check out the triggered pipeline on Gitlab 🦊