💥 [RUMF-730] prefer object and type alias over enum in APIs

[bcaudan]

Motivation

make APIs easier to use with TypeScript by avoiding to import our enums

before

import { datadogRum, Datacenter } from '@datadog/browser-rum'

datadogRum.init({
  ...
  datacenter: Datacenter.US
  ...
})

after

import { datadogRum } from '@datadog/browser-rum'

datadogRum.init({
  ...
  datacenter: 'us'
  ...
})

Changes

replace enum usage in APIs by object and type alias

before

export enum Datacenter {	
  US = 'us',	  
  EU = 'eu',	  
}

after

export const Datacenter = {
  US: 'us',	  
  EU: 'eu',	  
} as const

export type Datacenter = (typeof Datacenter)[keyof typeof Datacenter]

Testing

ci

---

I have gone over the contributing documentation.

[codecov-io]

Codecov Report

Merging #630 (ffee4af) into bcaudan/v2 (cdf9af0) will decrease coverage by 0.07%.
The diff coverage is 100.00%.

@@              Coverage Diff               @@
##           bcaudan/v2     #630      +/-   ##
==============================================
- Coverage       87.33%   87.25%   -0.08%     
==============================================
  Files              54       54              
  Lines            2440     2425      -15     
  Branches          512      508       -4     
==============================================
- Hits             2131     2116      -15     
  Misses            309      309              

Impacted Files	Coverage Δ
packages/logs/src/boot/logs.entry.ts	100.00% <ø> (ø)
packages/core/src/boot/init.ts	68.57% <100.00%> (-1.70%)	⬇️
packages/core/src/tools/error.ts	100.00% <100.00%> (ø)
packages/logs/src/domain/logger.ts	95.23% <100.00%> (-0.69%)	⬇️
packages/rum/src/boot/rum.entry.ts	92.06% <100.00%> (ø)
...omain/rumEventsCollection/error/errorCollection.ts	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cdf9af0...ffee4af. Read the comment docs.

[BenoitZugmeyer]

IMO it would be simpler to completely remove enum (ErrorSource, StatusType, HandlerType...) and use the string instead. Or, we could also use plain constants like:

const SOURCE_AGENT = 'agent' as const

This would result in a smaller code output, and avoid having two "types" for the same values (ex: ErrorSource and Source, HandlerType and Handler...)

WDYT?

[BenoitZugmeyer]

LGTM!

[aleksandrlat]

Oh no why did you remove types? We need to duplicate type on our own now :(

[bcaudan]

discussion moved to #654