Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 fix isolatedModules support #2209

Merged
merged 2 commits into from
May 10, 2023
Merged

🐛 fix isolatedModules support #2209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
122a7a5
🐛 fix isolatedModules support
BenoitZugmeyer May 4, 2023
514fac0
add reference to upstream TypeScript issue
BenoitZugmeyer May 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 42 additions & 13 deletions packages/rum-core/src/domain/lifeCycle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,51 @@ export const enum LifeCycleEventType {
RAW_ERROR_COLLECTED,
}

// This is a workaround for an issue occurring when the Browser SDK is included in a TypeScript
// project configured with `isolatedModules: true`. Even if the const enum is declared in this
// module, we cannot use it directly to define the EventMap interface keys (TS error: "Cannot access
// ambient const enums when the '--isolatedModules' flag is provided.").
//
// Using a plain enum would fix the issue, but would also add 2KB to the minified bundle. By using
// this workaround, we can keep using a const enum without impacting the bundle size (since it is a
// "declare" statement, it will only be used during typecheck and completely ignored when building
// JavaScript).
//
// See issues:
// * https://github.com/DataDog/browser-sdk/issues/2208
// * https://github.com/microsoft/TypeScript/issues/54152
declare const LifeCycleEventTypeAsConst: {
PERFORMANCE_ENTRIES_COLLECTED: LifeCycleEventType.PERFORMANCE_ENTRIES_COLLECTED
AUTO_ACTION_COMPLETED: LifeCycleEventType.AUTO_ACTION_COMPLETED
VIEW_CREATED: LifeCycleEventType.VIEW_CREATED
VIEW_UPDATED: LifeCycleEventType.VIEW_UPDATED
VIEW_ENDED: LifeCycleEventType.VIEW_ENDED
REQUEST_STARTED: LifeCycleEventType.REQUEST_STARTED
REQUEST_COMPLETED: LifeCycleEventType.REQUEST_COMPLETED
SESSION_EXPIRED: LifeCycleEventType.SESSION_EXPIRED
SESSION_RENEWED: LifeCycleEventType.SESSION_RENEWED
PAGE_EXITED: LifeCycleEventType.PAGE_EXITED
RAW_RUM_EVENT_COLLECTED: LifeCycleEventType.RAW_RUM_EVENT_COLLECTED
RUM_EVENT_COLLECTED: LifeCycleEventType.RUM_EVENT_COLLECTED
RAW_ERROR_COLLECTED: LifeCycleEventType.RAW_ERROR_COLLECTED
}

// Note: this interface needs to be exported even if it is not used outside of this module, else TS
// fails to build the rum-core package with error TS4058
export interface LifeCycleEventMap {
[LifeCycleEventType.PERFORMANCE_ENTRIES_COLLECTED]: RumPerformanceEntry[]
[LifeCycleEventType.AUTO_ACTION_COMPLETED]: AutoAction
[LifeCycleEventType.VIEW_CREATED]: ViewCreatedEvent
[LifeCycleEventType.VIEW_UPDATED]: ViewEvent
[LifeCycleEventType.VIEW_ENDED]: ViewEndedEvent
[LifeCycleEventType.REQUEST_STARTED]: RequestStartEvent
[LifeCycleEventType.REQUEST_COMPLETED]: RequestCompleteEvent
[LifeCycleEventType.SESSION_EXPIRED]: void
[LifeCycleEventType.SESSION_RENEWED]: void
[LifeCycleEventType.PAGE_EXITED]: PageExitEvent
[LifeCycleEventType.RAW_RUM_EVENT_COLLECTED]: RawRumEventCollectedData
[LifeCycleEventType.RUM_EVENT_COLLECTED]: RumEvent & Context
[LifeCycleEventType.RAW_ERROR_COLLECTED]: {
[LifeCycleEventTypeAsConst.PERFORMANCE_ENTRIES_COLLECTED]: RumPerformanceEntry[]
[LifeCycleEventTypeAsConst.AUTO_ACTION_COMPLETED]: AutoAction
[LifeCycleEventTypeAsConst.VIEW_CREATED]: ViewCreatedEvent
[LifeCycleEventTypeAsConst.VIEW_UPDATED]: ViewEvent
[LifeCycleEventTypeAsConst.VIEW_ENDED]: ViewEndedEvent
[LifeCycleEventTypeAsConst.REQUEST_STARTED]: RequestStartEvent
[LifeCycleEventTypeAsConst.REQUEST_COMPLETED]: RequestCompleteEvent
[LifeCycleEventTypeAsConst.SESSION_EXPIRED]: void
[LifeCycleEventTypeAsConst.SESSION_RENEWED]: void
[LifeCycleEventTypeAsConst.PAGE_EXITED]: PageExitEvent
[LifeCycleEventTypeAsConst.RAW_RUM_EVENT_COLLECTED]: RawRumEventCollectedData
[LifeCycleEventTypeAsConst.RUM_EVENT_COLLECTED]: RumEvent & Context
[LifeCycleEventTypeAsConst.RAW_ERROR_COLLECTED]: {
error: RawError
savedCommonContext?: CommonContext
customerContext?: Context
Expand Down
24 changes: 23 additions & 1 deletion scripts/cli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ cmd_check_typescript_compatibility () {
cd test/app
rm -rf node_modules
yarn
check_typescript_isolated_modules_compatibility || fail 'typescript isolated modules compatibility broken'
check_typescript_3_compatibility || fail 'typescript@3.8.2 compatibility broken'
check_typescript_latest_compatibility || fail 'typescript@latest compatibility broken'
}
Expand All @@ -88,7 +89,7 @@ check_typescript_3_compatibility () {

check_typescript_latest_compatibility () {
# Add typescript options only supported in newer versions
perl -i -l -p -e 'print "\"exactOptionalPropertyTypes\": true," if $. == 3' tsconfig.json
insert_line_in_file tsconfig.json 3 '"exactOptionalPropertyTypes": true,'

yarn add --dev typescript@latest
local succeeded=true
Expand All @@ -102,6 +103,27 @@ check_typescript_latest_compatibility () {
$succeeded
}

check_typescript_isolated_modules_compatibility () {
insert_line_in_file tsconfig.json 3 '"isolatedModules": true,'

local succeeded=true
if ! yarn compat:tsc; then
succeeded=false
fi

# Revert all changes
git checkout .

$succeeded
}

insert_line_in_file () {
local file="$1"
local line_number="$2"
local line_content="$3"
perl -i -l -p -e "print '${line_content}' if \$. == ${line_number}" "$file"
}

cmd_check_server_side_rendering_compatibility () {
yarn build
cd test/app
Expand Down