@datadog/mobile-react-navigation 1.4.0 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/commonjs/rum/instrumentation/DdRumReactNavigationTracking.js +5 -2
- package/lib/commonjs/rum/instrumentation/DdRumReactNavigationTracking.js.map +1 -1
- package/lib/module/rum/instrumentation/DdRumReactNavigationTracking.js +5 -2
- package/lib/module/rum/instrumentation/DdRumReactNavigationTracking.js.map +1 -1
- package/lib/typescript/core/src/DdSdkReactNativeConfiguration.d.ts +5 -0
- package/lib/typescript/core/src/index.d.ts +1 -1
- package/lib/typescript/core/src/nativeModulesTypes.d.ts +5 -0
- package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{domain → distributedTracing}/distributedTracing.d.ts +1 -1
- package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{domain → distributedTracing}/firstPartyHosts.d.ts +1 -1
- package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{implementation → requestProxy/XHRProxy}/DatadogRumResource/ResourceReporter.d.ts +1 -1
- package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{implementation → requestProxy/XHRProxy}/DatadogRumResource/internalDevResourceBlocklist.d.ts +1 -1
- package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{implementation → requestProxy/XHRProxy}/URLHostParser.d.ts +1 -1
- package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{implementation → requestProxy/XHRProxy}/XHRProxy.d.ts +2 -2
- package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{domain → requestProxy}/interfaces/RumResource.d.ts +1 -1
- package/lib/typescript/core/src/sdk/DdSdk.d.ts +3 -0
- package/lib/typescript/core/src/trace/DdTrace.d.ts +3 -0
- package/lib/typescript/core/src/types.d.ts +2 -1
- package/lib/typescript/core/src/version.d.ts +1 -1
- package/package.json +3 -3
- package/src/__tests__/rum/instrumentation/DdRumReactNavigationTracking.test.tsx +62 -7
- package/src/__tests__/rum/instrumentation/__utils__/Navigators/NavigatorsV5.tsx +47 -1
- package/src/__tests__/rum/instrumentation/__utils__/Navigators/NavigatorsV6.tsx +47 -1
- package/src/rum/instrumentation/DdRumReactNavigationTracking.tsx +6 -1
- package/lib/typescript/core/src/foundation.d.ts +0 -5
- /package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{domain → distributedTracing}/distributedTracingHeaders.d.ts +0 -0
- /package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{implementation → requestProxy/XHRProxy}/DatadogRumResource/resourceTiming.d.ts +0 -0
- /package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{implementation → requestProxy/XHRProxy}/responseSize.d.ts +0 -0
- /package/lib/typescript/core/src/rum/instrumentation/resourceTracking/{domain → requestProxy}/interfaces/RequestProxy.d.ts +0 -0
|
@@ -63,8 +63,11 @@ class DdRumReactNavigationTracking {
|
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
if (this.appStateSubscription) {
|
|
66
|
-
this.appStateSubscription.remove();
|
|
67
|
-
|
|
66
|
+
this.appStateSubscription.remove(); // The next if check is important as users can call `stopTrackingViews` before `startTrackingViews`
|
|
67
|
+
// see https://github.com/DataDog/dd-sdk-reactnative/issues/422
|
|
68
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
69
|
+
// @ts-ignore
|
|
70
|
+
} else if (_reactNative.AppState.removeEventListener) {
|
|
68
71
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
69
72
|
// @ts-ignore
|
|
70
73
|
_reactNative.AppState.removeEventListener('change', DdRumReactNavigationTracking.appStateListener);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["DdRumReactNavigationTracking.tsx"],"names":["DdRumReactNavigationTracking","startTrackingViews","navigationRef","viewNamePredicate","_route","trackedName","InternalLog","log","NULL_NAVIGATION_REF_ERROR_MESSAGE","SdkVerbosity","ERROR","registeredContainer","NAVIGATION_REF_IN_USE_ERROR_MESSAGE","listener","resolveNavigationStateChangeListener","handleRouteNavigation","getCurrentRoute","addListener","backHandler","BackHandler","addEventListener","onBackPress","appStateSubscription","AppState","appStateListener","stopTrackingViews","removeListener","navigationStateChangeListener","remove","removeEventListener","route","appStateStatus","undefined","ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE","WARN","key","predicate","screenName","name","DdRum","stopView","startView","canGoBack","isAppExitingOnBackPress","currentRoute"],"mappings":";;;;;;;AAMA;;AAEA;;;;AAqBA;AACA;AACA;AACO,MAAMA,4BAAN,CAAmC;AAuCtC;AACJ;AACA;AACA;AAC6B,SAAlBC,kBAAkB,CACrBC,aADqB,EAErBC,iBAAoC,GAAG,UACnCC,MADmC,EAEnCC,WAFmC,EAGrC;AACE,WAAOA,WAAP;AACH,GAPoB,EAQjB;AACJ,QAAIH,aAAa,IAAI,IAArB,EAA2B;AACvBI,qCAAYC,GAAZ,CACIP,4BAA4B,CAACQ,iCADjC,EAEIC,gCAAaC,KAFjB;;AAIA;AACH;;AAED,QACIV,4BAA4B,CAACW,mBAA7B,IAAoD,IAApD,IACA,KAAKA,mBAAL,KAA6BT,aAFjC,EAGE;AACEI,qCAAYC,GAAZ,CACIP,4BAA4B,CAACY,mCADjC,EAEIH,gCAAaC,KAFjB;AAIH,KARD,MAQO,IAAIV,4BAA4B,CAACW,mBAA7B,IAAoD,IAAxD,EAA8D;AACjEX,MAAAA,4BAA4B,CAACG,iBAA7B,GAAiDA,iBAAjD;AACA,YAAMU,QAAQ,GAAGb,4BAA4B,CAACc,oCAA7B,EAAjB;AACAd,MAAAA,4BAA4B,CAACe,qBAA7B,CACIb,aAAa,CAACc,eAAd,EADJ;AAGAd,MAAAA,aAAa,CAACe,WAAd,CAA0B,OAA1B,EAAmCJ,QAAnC;AACAb,MAAAA,4BAA4B,CAACW,mBAA7B,GAAmDT,aAAnD;AACAF,MAAAA,4BAA4B,CAACkB,WAA7B,GAA2CC,yBAAYC,gBAAZ,CACvC,mBADuC,EAEvCpB,4BAA4B,CAACqB,WAFU,CAA3C;AAIA,WAAKC,oBAAL,GAA4BC,sBAASH,gBAAT,CACxB,QADwB,EAExBpB,4BAA4B,CAACwB,gBAFL,CAA5B;AAIH;AACJ;AAED;AACJ;AACA;AACA;;;AAC4B,SAAjBC,iBAAiB,CACpBvB,aADoB,EAEhB;AACJ,QAAIA,aAAa,IAAI,IAArB,EAA2B;AAAA;;AACvBA,MAAAA,aAAa,CAACwB,cAAd,CACI,OADJ,EAEI1B,4BAA4B,CAAC2B,6BAFjC;AAIA,+BAAA3B,4BAA4B,CAACkB,WAA7B,gFAA0CU,MAA1C;AACA5B,MAAAA,4BAA4B,CAACkB,WAA7B,GAA2C,IAA3C;AACAlB,MAAAA,4BAA4B,CAACW,mBAA7B,GAAmD,IAAnD;;AACAX,MAAAA,4BAA4B,CAACG,iBAA7B,GAAiD,UAC7CC,MAD6C,EAE7CC,WAF6C,EAG/C;AACE,eAAOA,WAAP;AACH,OALD;AAMH,KAfG,CAiBJ;AACA;;;AACA,QAAI,KAAKiB,oBAAT,EAA+B;AAC3B,WAAKA,oBAAL,CAA0BM,MAA1B;AACH,KAFD,MAEO;AACH;AACA;AACAL,4BAASM,mBAAT,CACI,QADJ,EAEI7B,4BAA4B,CAACwB,gBAFjC;AAIH;AACJ;;AAEmC,SAArBT,qBAAqB,CAChCe,KADgC,EAEhCC,cAA0C,GAAGC,SAFb,EAGlC;AACE,QAAIF,KAAK,KAAKE,SAAV,IAAuBF,KAAK,KAAK,IAArC,EAA2C;AACvCxB,qCAAYC,GAAZ,CACIP,4BAA4B,CAACiC,0CADjC,EAEIxB,gCAAayB,IAFjB,EADuC,CAKvC;;;AACA;AACH;;AACD,UAAMC,GAAG,GAAGL,KAAK,CAACK,GAAlB;AAEA,UAAMC,SAAS,GAAGpC,4BAA4B,CAACG,iBAA/C;AACA,UAAMkC,UAAU,GAAGD,SAAS,CAACN,KAAD,EAAQA,KAAK,CAACQ,IAAd,CAA5B;;AAEA,QAAIH,GAAG,IAAI,IAAP,IAAeE,UAAU,IAAI,IAAjC,EAAuC;AACnC,UAAIN,cAAc,KAAK,YAAvB,EAAqC;AACjCQ,iCAAMC,QAAN,CAAeL,GAAf;AACH,OAFD,MAEO,IACHJ,cAAc,KAAK,QAAnB,IACAA,cAAc,KAAKC,SAFhB,EAGL;AACE;AACA;AACAO,iCAAME,SAAN,CAAgBN,GAAhB,EAAqBE,UAArB;AACH;AACJ;AACJ;;AAEkD,SAApCvB,oCAAoC,GAAuB;AACtE,QACId,4BAA4B,CAAC2B,6BAA7B,IAA8D,IADlE,EAEE;AACE3B,MAAAA,4BAA4B,CAAC2B,6BAA7B,GAA6D,MAAM;AAAA;;AAC/D,cAAMG,KAAK,6BAAG9B,4BAA4B,CAACW,mBAAhC,2DAAG,uBAAkDK,eAAlD,EAAd;;AAEA,YAAIc,KAAK,KAAKE,SAAd,EAAyB;AACrB1B,yCAAYC,GAAZ,CACIP,4BAA4B,CAACiC,0CADjC,EAEIxB,gCAAayB,IAFjB;;AAIA;AACH;;AAEDlC,QAAAA,4BAA4B,CAACe,qBAA7B,CAAmDe,KAAnD;AACH,OAZD;AAaH;;AACD,WAAO9B,4BAA4B,CAAC2B,6BAApC;AACH;;AA9KqC;;;;gBAA7B3B,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B,gDAYL,gG;;gBAZKA,4B,uCAcL,+C;;gBAdKA,4B,yCAgBL,6K;;gBAhBKA,4B,6BAkBwB,MAAe;AAC5C,MAAIA,4BAA4B,CAACW,mBAA7B,KAAqD,IAAzD,EAA+D;AAC3D,WAAO,KAAP;AACH;;AACD,MAAIX,4BAA4B,CAACW,mBAA7B,CAAiD+B,SAAjD,EAAJ,EAAkE;AAC9D,WAAO,KAAP;AACH;;AACD,SAAO,IAAP;AACH,C;;gBA1BQ1C,4B,iBA4BY,MAAM;AACvB,MAAIA,4BAA4B,CAAC2C,uBAA7B,EAAJ,EAA4D;AACxD3C,IAAAA,4BAA4B,CAACyB,iBAA7B,CACIzB,4BAA4B,CAACW,mBADjC;AAGH,GALsB,CAMvB;AACA;;;AACA,SAAO,KAAP;AACH,C;;gBArCQX,4B,sBAiLL+B,cADgD,IAE/C;AAAA;;AACD,QAAMa,YAAY,6BAAG5C,4BAA4B,CAACW,mBAAhC,2DAAG,uBAAkDK,eAAlD,EAArB;;AACA,MAAI4B,YAAY,KAAKZ,SAAjB,IAA8BY,YAAY,KAAK,IAAnD,EAAyD;AACrDtC,mCAAYC,GAAZ,CACK,4EAA2EwB,cAAe,gDAD/F,EAEItB,gCAAaC,KAFjB;;AAIA;AACH;;AAEDV,EAAAA,4BAA4B,CAACe,qBAA7B,CACI6B,YADJ,EAEIb,cAFJ;AAIH,C","sourcesContent":["/*\n * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.\n * This product includes software developed at Datadog (https://www.datadoghq.com/).\n * Copyright 2016-Present Datadog, Inc.\n */\n\nimport { DdRum, SdkVerbosity, InternalLog } from '@datadog/mobile-react-native';\nimport type { AppStateStatus, NativeEventSubscription } from 'react-native';\nimport { AppState, BackHandler } from 'react-native';\n\nimport type {\n NavigationContainerRef,\n Route,\n NavigationListener\n} from './react-navigation';\n\n// AppStateStatus can have values:\n// 'active' - The app is running in the foreground\n// 'background' - The app is running in the background. The user is either in another app or on the home screen\n// 'inactive' [iOS] - This is a transition state that currently never happens for typical React Native apps.\n// 'unknown' [iOS] - Initial value until the current app state is determined\n// 'extension' [iOS] - The app is running as an app extension\ndeclare type AppStateListener = (appStateStatus: AppStateStatus) => void | null;\n\nexport type ViewNamePredicate = (\n route: Route<string, any | undefined>,\n trackedName: string\n) => string | null;\n\n/**\n * Provides RUM integration for the [ReactNavigation](https://reactnavigation.org/) API.\n */\nexport class DdRumReactNavigationTracking {\n private static registeredContainer: NavigationContainerRef | null;\n\n private static navigationStateChangeListener: NavigationListener;\n\n private static viewNamePredicate: ViewNamePredicate;\n\n private static backHandler: NativeEventSubscription | null;\n\n private static appStateSubscription?: NativeEventSubscription;\n\n static ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE =\n 'A navigation change was detected but the RUM ViewEvent was dropped as the route was undefined.';\n static NULL_NAVIGATION_REF_ERROR_MESSAGE =\n 'Cannot track views with a null navigationRef.';\n static NAVIGATION_REF_IN_USE_ERROR_MESSAGE =\n 'Cannot track new navigation container while another one is still tracked. Please call `DdRumReactNavigationTracking.stopTrackingViews` on the previous container reference.';\n\n static isAppExitingOnBackPress = (): boolean => {\n if (DdRumReactNavigationTracking.registeredContainer === null) {\n return false;\n }\n if (DdRumReactNavigationTracking.registeredContainer.canGoBack()) {\n return false;\n }\n return true;\n };\n\n static onBackPress = () => {\n if (DdRumReactNavigationTracking.isAppExitingOnBackPress()) {\n DdRumReactNavigationTracking.stopTrackingViews(\n DdRumReactNavigationTracking.registeredContainer\n );\n }\n // We always return false so we make sure the react-navigation callback is called.\n // See https://reactnative.dev/docs/backhandler\n return false;\n };\n\n /**\n * Starts tracking the NavigationContainer and sends a RUM View event every time the navigation route changed.\n * @param navigationRef the reference to the real NavigationContainer.\n */\n static startTrackingViews(\n navigationRef: NavigationContainerRef | null,\n viewNamePredicate: ViewNamePredicate = function (\n _route: Route<string, any | undefined>,\n trackedName: string\n ) {\n return trackedName;\n }\n ): void {\n if (navigationRef == null) {\n InternalLog.log(\n DdRumReactNavigationTracking.NULL_NAVIGATION_REF_ERROR_MESSAGE,\n SdkVerbosity.ERROR\n );\n return;\n }\n\n if (\n DdRumReactNavigationTracking.registeredContainer != null &&\n this.registeredContainer !== navigationRef\n ) {\n InternalLog.log(\n DdRumReactNavigationTracking.NAVIGATION_REF_IN_USE_ERROR_MESSAGE,\n SdkVerbosity.ERROR\n );\n } else if (DdRumReactNavigationTracking.registeredContainer == null) {\n DdRumReactNavigationTracking.viewNamePredicate = viewNamePredicate;\n const listener = DdRumReactNavigationTracking.resolveNavigationStateChangeListener();\n DdRumReactNavigationTracking.handleRouteNavigation(\n navigationRef.getCurrentRoute()\n );\n navigationRef.addListener('state', listener);\n DdRumReactNavigationTracking.registeredContainer = navigationRef;\n DdRumReactNavigationTracking.backHandler = BackHandler.addEventListener(\n 'hardwareBackPress',\n DdRumReactNavigationTracking.onBackPress\n );\n this.appStateSubscription = AppState.addEventListener(\n 'change',\n DdRumReactNavigationTracking.appStateListener\n );\n }\n }\n\n /**\n * Stops tracking the NavigationContainer.\n * @param navigationRef the reference to the real NavigationContainer.\n */\n static stopTrackingViews(\n navigationRef: NavigationContainerRef | null\n ): void {\n if (navigationRef != null) {\n navigationRef.removeListener(\n 'state',\n DdRumReactNavigationTracking.navigationStateChangeListener\n );\n DdRumReactNavigationTracking.backHandler?.remove();\n DdRumReactNavigationTracking.backHandler = null;\n DdRumReactNavigationTracking.registeredContainer = null;\n DdRumReactNavigationTracking.viewNamePredicate = function (\n _route: Route<string, any | undefined>,\n trackedName: string\n ) {\n return trackedName;\n };\n }\n\n // For versions of React Native below 0.65, addEventListener does not return a subscription.\n // We have to call AppState.removeEventListener instead.\n if (this.appStateSubscription) {\n this.appStateSubscription.remove();\n } else {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n AppState.removeEventListener(\n 'change',\n DdRumReactNavigationTracking.appStateListener\n );\n }\n }\n\n private static handleRouteNavigation(\n route: Route<string, any | undefined> | undefined,\n appStateStatus: AppStateStatus | undefined = undefined\n ) {\n if (route === undefined || route === null) {\n InternalLog.log(\n DdRumReactNavigationTracking.ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE,\n SdkVerbosity.WARN\n );\n // RUMM-1400 in some cases the route seem to be undefined\n return;\n }\n const key = route.key;\n\n const predicate = DdRumReactNavigationTracking.viewNamePredicate;\n const screenName = predicate(route, route.name);\n\n if (key != null && screenName != null) {\n if (appStateStatus === 'background') {\n DdRum.stopView(key);\n } else if (\n appStateStatus === 'active' ||\n appStateStatus === undefined\n ) {\n // case when app goes into foreground,\n // in that case navigation listener won't be called\n DdRum.startView(key, screenName);\n }\n }\n }\n\n private static resolveNavigationStateChangeListener(): NavigationListener {\n if (\n DdRumReactNavigationTracking.navigationStateChangeListener == null\n ) {\n DdRumReactNavigationTracking.navigationStateChangeListener = () => {\n const route = DdRumReactNavigationTracking.registeredContainer?.getCurrentRoute();\n\n if (route === undefined) {\n InternalLog.log(\n DdRumReactNavigationTracking.ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE,\n SdkVerbosity.WARN\n );\n return;\n }\n\n DdRumReactNavigationTracking.handleRouteNavigation(route);\n };\n }\n return DdRumReactNavigationTracking.navigationStateChangeListener;\n }\n\n private static appStateListener: AppStateListener = (\n appStateStatus: AppStateStatus\n ) => {\n const currentRoute = DdRumReactNavigationTracking.registeredContainer?.getCurrentRoute();\n if (currentRoute === undefined || currentRoute === null) {\n InternalLog.log(\n `We could not determine the route when changing the application state to: ${appStateStatus}. No RUM View event will be sent in this case.`,\n SdkVerbosity.ERROR\n );\n return;\n }\n\n DdRumReactNavigationTracking.handleRouteNavigation(\n currentRoute,\n appStateStatus\n );\n };\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["DdRumReactNavigationTracking.tsx"],"names":["DdRumReactNavigationTracking","startTrackingViews","navigationRef","viewNamePredicate","_route","trackedName","InternalLog","log","NULL_NAVIGATION_REF_ERROR_MESSAGE","SdkVerbosity","ERROR","registeredContainer","NAVIGATION_REF_IN_USE_ERROR_MESSAGE","listener","resolveNavigationStateChangeListener","handleRouteNavigation","getCurrentRoute","addListener","backHandler","BackHandler","addEventListener","onBackPress","appStateSubscription","AppState","appStateListener","stopTrackingViews","removeListener","navigationStateChangeListener","remove","removeEventListener","route","appStateStatus","undefined","ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE","WARN","key","predicate","screenName","name","DdRum","stopView","startView","canGoBack","isAppExitingOnBackPress","currentRoute"],"mappings":";;;;;;;AAMA;;AAEA;;;;AAqBA;AACA;AACA;AACO,MAAMA,4BAAN,CAAmC;AAuCtC;AACJ;AACA;AACA;AAC6B,SAAlBC,kBAAkB,CACrBC,aADqB,EAErBC,iBAAoC,GAAG,UACnCC,MADmC,EAEnCC,WAFmC,EAGrC;AACE,WAAOA,WAAP;AACH,GAPoB,EAQjB;AACJ,QAAIH,aAAa,IAAI,IAArB,EAA2B;AACvBI,qCAAYC,GAAZ,CACIP,4BAA4B,CAACQ,iCADjC,EAEIC,gCAAaC,KAFjB;;AAIA;AACH;;AAED,QACIV,4BAA4B,CAACW,mBAA7B,IAAoD,IAApD,IACA,KAAKA,mBAAL,KAA6BT,aAFjC,EAGE;AACEI,qCAAYC,GAAZ,CACIP,4BAA4B,CAACY,mCADjC,EAEIH,gCAAaC,KAFjB;AAIH,KARD,MAQO,IAAIV,4BAA4B,CAACW,mBAA7B,IAAoD,IAAxD,EAA8D;AACjEX,MAAAA,4BAA4B,CAACG,iBAA7B,GAAiDA,iBAAjD;AACA,YAAMU,QAAQ,GAAGb,4BAA4B,CAACc,oCAA7B,EAAjB;AACAd,MAAAA,4BAA4B,CAACe,qBAA7B,CACIb,aAAa,CAACc,eAAd,EADJ;AAGAd,MAAAA,aAAa,CAACe,WAAd,CAA0B,OAA1B,EAAmCJ,QAAnC;AACAb,MAAAA,4BAA4B,CAACW,mBAA7B,GAAmDT,aAAnD;AACAF,MAAAA,4BAA4B,CAACkB,WAA7B,GAA2CC,yBAAYC,gBAAZ,CACvC,mBADuC,EAEvCpB,4BAA4B,CAACqB,WAFU,CAA3C;AAIA,WAAKC,oBAAL,GAA4BC,sBAASH,gBAAT,CACxB,QADwB,EAExBpB,4BAA4B,CAACwB,gBAFL,CAA5B;AAIH;AACJ;AAED;AACJ;AACA;AACA;;;AAC4B,SAAjBC,iBAAiB,CACpBvB,aADoB,EAEhB;AACJ,QAAIA,aAAa,IAAI,IAArB,EAA2B;AAAA;;AACvBA,MAAAA,aAAa,CAACwB,cAAd,CACI,OADJ,EAEI1B,4BAA4B,CAAC2B,6BAFjC;AAIA,+BAAA3B,4BAA4B,CAACkB,WAA7B,gFAA0CU,MAA1C;AACA5B,MAAAA,4BAA4B,CAACkB,WAA7B,GAA2C,IAA3C;AACAlB,MAAAA,4BAA4B,CAACW,mBAA7B,GAAmD,IAAnD;;AACAX,MAAAA,4BAA4B,CAACG,iBAA7B,GAAiD,UAC7CC,MAD6C,EAE7CC,WAF6C,EAG/C;AACE,eAAOA,WAAP;AACH,OALD;AAMH,KAfG,CAiBJ;AACA;;;AACA,QAAI,KAAKiB,oBAAT,EAA+B;AAC3B,WAAKA,oBAAL,CAA0BM,MAA1B,GAD2B,CAG3B;AACA;AACA;AACA;AACH,KAPD,MAOO,IAAIL,sBAASM,mBAAb,EAAkC;AACrC;AACA;AACAN,4BAASM,mBAAT,CACI,QADJ,EAEI7B,4BAA4B,CAACwB,gBAFjC;AAIH;AACJ;;AAEmC,SAArBT,qBAAqB,CAChCe,KADgC,EAEhCC,cAA0C,GAAGC,SAFb,EAGlC;AACE,QAAIF,KAAK,KAAKE,SAAV,IAAuBF,KAAK,KAAK,IAArC,EAA2C;AACvCxB,qCAAYC,GAAZ,CACIP,4BAA4B,CAACiC,0CADjC,EAEIxB,gCAAayB,IAFjB,EADuC,CAKvC;;;AACA;AACH;;AACD,UAAMC,GAAG,GAAGL,KAAK,CAACK,GAAlB;AAEA,UAAMC,SAAS,GAAGpC,4BAA4B,CAACG,iBAA/C;AACA,UAAMkC,UAAU,GAAGD,SAAS,CAACN,KAAD,EAAQA,KAAK,CAACQ,IAAd,CAA5B;;AAEA,QAAIH,GAAG,IAAI,IAAP,IAAeE,UAAU,IAAI,IAAjC,EAAuC;AACnC,UAAIN,cAAc,KAAK,YAAvB,EAAqC;AACjCQ,iCAAMC,QAAN,CAAeL,GAAf;AACH,OAFD,MAEO,IACHJ,cAAc,KAAK,QAAnB,IACAA,cAAc,KAAKC,SAFhB,EAGL;AACE;AACA;AACAO,iCAAME,SAAN,CAAgBN,GAAhB,EAAqBE,UAArB;AACH;AACJ;AACJ;;AAEkD,SAApCvB,oCAAoC,GAAuB;AACtE,QACId,4BAA4B,CAAC2B,6BAA7B,IAA8D,IADlE,EAEE;AACE3B,MAAAA,4BAA4B,CAAC2B,6BAA7B,GAA6D,MAAM;AAAA;;AAC/D,cAAMG,KAAK,6BAAG9B,4BAA4B,CAACW,mBAAhC,2DAAG,uBAAkDK,eAAlD,EAAd;;AAEA,YAAIc,KAAK,KAAKE,SAAd,EAAyB;AACrB1B,yCAAYC,GAAZ,CACIP,4BAA4B,CAACiC,0CADjC,EAEIxB,gCAAayB,IAFjB;;AAIA;AACH;;AAEDlC,QAAAA,4BAA4B,CAACe,qBAA7B,CAAmDe,KAAnD;AACH,OAZD;AAaH;;AACD,WAAO9B,4BAA4B,CAAC2B,6BAApC;AACH;;AAnLqC;;;;gBAA7B3B,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B,gDAYL,gG;;gBAZKA,4B,uCAcL,+C;;gBAdKA,4B,yCAgBL,6K;;gBAhBKA,4B,6BAkBwB,MAAe;AAC5C,MAAIA,4BAA4B,CAACW,mBAA7B,KAAqD,IAAzD,EAA+D;AAC3D,WAAO,KAAP;AACH;;AACD,MAAIX,4BAA4B,CAACW,mBAA7B,CAAiD+B,SAAjD,EAAJ,EAAkE;AAC9D,WAAO,KAAP;AACH;;AACD,SAAO,IAAP;AACH,C;;gBA1BQ1C,4B,iBA4BY,MAAM;AACvB,MAAIA,4BAA4B,CAAC2C,uBAA7B,EAAJ,EAA4D;AACxD3C,IAAAA,4BAA4B,CAACyB,iBAA7B,CACIzB,4BAA4B,CAACW,mBADjC;AAGH,GALsB,CAMvB;AACA;;;AACA,SAAO,KAAP;AACH,C;;gBArCQX,4B,sBAsLL+B,cADgD,IAE/C;AAAA;;AACD,QAAMa,YAAY,6BAAG5C,4BAA4B,CAACW,mBAAhC,2DAAG,uBAAkDK,eAAlD,EAArB;;AACA,MAAI4B,YAAY,KAAKZ,SAAjB,IAA8BY,YAAY,KAAK,IAAnD,EAAyD;AACrDtC,mCAAYC,GAAZ,CACK,4EAA2EwB,cAAe,gDAD/F,EAEItB,gCAAaC,KAFjB;;AAIA;AACH;;AAEDV,EAAAA,4BAA4B,CAACe,qBAA7B,CACI6B,YADJ,EAEIb,cAFJ;AAIH,C","sourcesContent":["/*\n * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.\n * This product includes software developed at Datadog (https://www.datadoghq.com/).\n * Copyright 2016-Present Datadog, Inc.\n */\n\nimport { DdRum, SdkVerbosity, InternalLog } from '@datadog/mobile-react-native';\nimport type { AppStateStatus, NativeEventSubscription } from 'react-native';\nimport { AppState, BackHandler } from 'react-native';\n\nimport type {\n NavigationContainerRef,\n Route,\n NavigationListener\n} from './react-navigation';\n\n// AppStateStatus can have values:\n// 'active' - The app is running in the foreground\n// 'background' - The app is running in the background. The user is either in another app or on the home screen\n// 'inactive' [iOS] - This is a transition state that currently never happens for typical React Native apps.\n// 'unknown' [iOS] - Initial value until the current app state is determined\n// 'extension' [iOS] - The app is running as an app extension\ndeclare type AppStateListener = (appStateStatus: AppStateStatus) => void | null;\n\nexport type ViewNamePredicate = (\n route: Route<string, any | undefined>,\n trackedName: string\n) => string | null;\n\n/**\n * Provides RUM integration for the [ReactNavigation](https://reactnavigation.org/) API.\n */\nexport class DdRumReactNavigationTracking {\n private static registeredContainer: NavigationContainerRef | null;\n\n private static navigationStateChangeListener: NavigationListener;\n\n private static viewNamePredicate: ViewNamePredicate;\n\n private static backHandler: NativeEventSubscription | null;\n\n private static appStateSubscription?: NativeEventSubscription;\n\n static ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE =\n 'A navigation change was detected but the RUM ViewEvent was dropped as the route was undefined.';\n static NULL_NAVIGATION_REF_ERROR_MESSAGE =\n 'Cannot track views with a null navigationRef.';\n static NAVIGATION_REF_IN_USE_ERROR_MESSAGE =\n 'Cannot track new navigation container while another one is still tracked. Please call `DdRumReactNavigationTracking.stopTrackingViews` on the previous container reference.';\n\n static isAppExitingOnBackPress = (): boolean => {\n if (DdRumReactNavigationTracking.registeredContainer === null) {\n return false;\n }\n if (DdRumReactNavigationTracking.registeredContainer.canGoBack()) {\n return false;\n }\n return true;\n };\n\n static onBackPress = () => {\n if (DdRumReactNavigationTracking.isAppExitingOnBackPress()) {\n DdRumReactNavigationTracking.stopTrackingViews(\n DdRumReactNavigationTracking.registeredContainer\n );\n }\n // We always return false so we make sure the react-navigation callback is called.\n // See https://reactnative.dev/docs/backhandler\n return false;\n };\n\n /**\n * Starts tracking the NavigationContainer and sends a RUM View event every time the navigation route changed.\n * @param navigationRef the reference to the real NavigationContainer.\n */\n static startTrackingViews(\n navigationRef: NavigationContainerRef | null,\n viewNamePredicate: ViewNamePredicate = function (\n _route: Route<string, any | undefined>,\n trackedName: string\n ) {\n return trackedName;\n }\n ): void {\n if (navigationRef == null) {\n InternalLog.log(\n DdRumReactNavigationTracking.NULL_NAVIGATION_REF_ERROR_MESSAGE,\n SdkVerbosity.ERROR\n );\n return;\n }\n\n if (\n DdRumReactNavigationTracking.registeredContainer != null &&\n this.registeredContainer !== navigationRef\n ) {\n InternalLog.log(\n DdRumReactNavigationTracking.NAVIGATION_REF_IN_USE_ERROR_MESSAGE,\n SdkVerbosity.ERROR\n );\n } else if (DdRumReactNavigationTracking.registeredContainer == null) {\n DdRumReactNavigationTracking.viewNamePredicate = viewNamePredicate;\n const listener = DdRumReactNavigationTracking.resolveNavigationStateChangeListener();\n DdRumReactNavigationTracking.handleRouteNavigation(\n navigationRef.getCurrentRoute()\n );\n navigationRef.addListener('state', listener);\n DdRumReactNavigationTracking.registeredContainer = navigationRef;\n DdRumReactNavigationTracking.backHandler = BackHandler.addEventListener(\n 'hardwareBackPress',\n DdRumReactNavigationTracking.onBackPress\n );\n this.appStateSubscription = AppState.addEventListener(\n 'change',\n DdRumReactNavigationTracking.appStateListener\n );\n }\n }\n\n /**\n * Stops tracking the NavigationContainer.\n * @param navigationRef the reference to the real NavigationContainer.\n */\n static stopTrackingViews(\n navigationRef: NavigationContainerRef | null\n ): void {\n if (navigationRef != null) {\n navigationRef.removeListener(\n 'state',\n DdRumReactNavigationTracking.navigationStateChangeListener\n );\n DdRumReactNavigationTracking.backHandler?.remove();\n DdRumReactNavigationTracking.backHandler = null;\n DdRumReactNavigationTracking.registeredContainer = null;\n DdRumReactNavigationTracking.viewNamePredicate = function (\n _route: Route<string, any | undefined>,\n trackedName: string\n ) {\n return trackedName;\n };\n }\n\n // For versions of React Native below 0.65, addEventListener does not return a subscription.\n // We have to call AppState.removeEventListener instead.\n if (this.appStateSubscription) {\n this.appStateSubscription.remove();\n\n // The next if check is important as users can call `stopTrackingViews` before `startTrackingViews`\n // see https://github.com/DataDog/dd-sdk-reactnative/issues/422\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n } else if (AppState.removeEventListener) {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n AppState.removeEventListener(\n 'change',\n DdRumReactNavigationTracking.appStateListener\n );\n }\n }\n\n private static handleRouteNavigation(\n route: Route<string, any | undefined> | undefined,\n appStateStatus: AppStateStatus | undefined = undefined\n ) {\n if (route === undefined || route === null) {\n InternalLog.log(\n DdRumReactNavigationTracking.ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE,\n SdkVerbosity.WARN\n );\n // RUMM-1400 in some cases the route seem to be undefined\n return;\n }\n const key = route.key;\n\n const predicate = DdRumReactNavigationTracking.viewNamePredicate;\n const screenName = predicate(route, route.name);\n\n if (key != null && screenName != null) {\n if (appStateStatus === 'background') {\n DdRum.stopView(key);\n } else if (\n appStateStatus === 'active' ||\n appStateStatus === undefined\n ) {\n // case when app goes into foreground,\n // in that case navigation listener won't be called\n DdRum.startView(key, screenName);\n }\n }\n }\n\n private static resolveNavigationStateChangeListener(): NavigationListener {\n if (\n DdRumReactNavigationTracking.navigationStateChangeListener == null\n ) {\n DdRumReactNavigationTracking.navigationStateChangeListener = () => {\n const route = DdRumReactNavigationTracking.registeredContainer?.getCurrentRoute();\n\n if (route === undefined) {\n InternalLog.log(\n DdRumReactNavigationTracking.ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE,\n SdkVerbosity.WARN\n );\n return;\n }\n\n DdRumReactNavigationTracking.handleRouteNavigation(route);\n };\n }\n return DdRumReactNavigationTracking.navigationStateChangeListener;\n }\n\n private static appStateListener: AppStateListener = (\n appStateStatus: AppStateStatus\n ) => {\n const currentRoute = DdRumReactNavigationTracking.registeredContainer?.getCurrentRoute();\n if (currentRoute === undefined || currentRoute === null) {\n InternalLog.log(\n `We could not determine the route when changing the application state to: ${appStateStatus}. No RUM View event will be sent in this case.`,\n SdkVerbosity.ERROR\n );\n return;\n }\n\n DdRumReactNavigationTracking.handleRouteNavigation(\n currentRoute,\n appStateStatus\n );\n };\n}\n"]}
|
|
@@ -59,8 +59,11 @@ export class DdRumReactNavigationTracking {
|
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
if (this.appStateSubscription) {
|
|
62
|
-
this.appStateSubscription.remove();
|
|
63
|
-
|
|
62
|
+
this.appStateSubscription.remove(); // The next if check is important as users can call `stopTrackingViews` before `startTrackingViews`
|
|
63
|
+
// see https://github.com/DataDog/dd-sdk-reactnative/issues/422
|
|
64
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
65
|
+
// @ts-ignore
|
|
66
|
+
} else if (AppState.removeEventListener) {
|
|
64
67
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
65
68
|
// @ts-ignore
|
|
66
69
|
AppState.removeEventListener('change', DdRumReactNavigationTracking.appStateListener);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["DdRumReactNavigationTracking.tsx"],"names":["DdRum","SdkVerbosity","InternalLog","AppState","BackHandler","DdRumReactNavigationTracking","startTrackingViews","navigationRef","viewNamePredicate","_route","trackedName","log","NULL_NAVIGATION_REF_ERROR_MESSAGE","ERROR","registeredContainer","NAVIGATION_REF_IN_USE_ERROR_MESSAGE","listener","resolveNavigationStateChangeListener","handleRouteNavigation","getCurrentRoute","addListener","backHandler","addEventListener","onBackPress","appStateSubscription","appStateListener","stopTrackingViews","removeListener","navigationStateChangeListener","remove","removeEventListener","route","appStateStatus","undefined","ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE","WARN","key","predicate","screenName","name","stopView","startView","canGoBack","isAppExitingOnBackPress","currentRoute"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AAEA,SAASA,KAAT,EAAgBC,YAAhB,EAA8BC,WAA9B,QAAiD,8BAAjD;AAEA,SAASC,QAAT,EAAmBC,WAAnB,QAAsC,cAAtC;;AAqBA;AACA;AACA;AACA,OAAO,MAAMC,4BAAN,CAAmC;AAuCtC;AACJ;AACA;AACA;AAC6B,SAAlBC,kBAAkB,CACrBC,aADqB,EAErBC,iBAAoC,GAAG,UACnCC,MADmC,EAEnCC,WAFmC,EAGrC;AACE,WAAOA,WAAP;AACH,GAPoB,EAQjB;AACJ,QAAIH,aAAa,IAAI,IAArB,EAA2B;AACvBL,MAAAA,WAAW,CAACS,GAAZ,CACIN,4BAA4B,CAACO,iCADjC,EAEIX,YAAY,CAACY,KAFjB;AAIA;AACH;;AAED,QACIR,4BAA4B,CAACS,mBAA7B,IAAoD,IAApD,IACA,KAAKA,mBAAL,KAA6BP,aAFjC,EAGE;AACEL,MAAAA,WAAW,CAACS,GAAZ,CACIN,4BAA4B,CAACU,mCADjC,EAEId,YAAY,CAACY,KAFjB;AAIH,KARD,MAQO,IAAIR,4BAA4B,CAACS,mBAA7B,IAAoD,IAAxD,EAA8D;AACjET,MAAAA,4BAA4B,CAACG,iBAA7B,GAAiDA,iBAAjD;AACA,YAAMQ,QAAQ,GAAGX,4BAA4B,CAACY,oCAA7B,EAAjB;AACAZ,MAAAA,4BAA4B,CAACa,qBAA7B,CACIX,aAAa,CAACY,eAAd,EADJ;AAGAZ,MAAAA,aAAa,CAACa,WAAd,CAA0B,OAA1B,EAAmCJ,QAAnC;AACAX,MAAAA,4BAA4B,CAACS,mBAA7B,GAAmDP,aAAnD;AACAF,MAAAA,4BAA4B,CAACgB,WAA7B,GAA2CjB,WAAW,CAACkB,gBAAZ,CACvC,mBADuC,EAEvCjB,4BAA4B,CAACkB,WAFU,CAA3C;AAIA,WAAKC,oBAAL,GAA4BrB,QAAQ,CAACmB,gBAAT,CACxB,QADwB,EAExBjB,4BAA4B,CAACoB,gBAFL,CAA5B;AAIH;AACJ;AAED;AACJ;AACA;AACA;;;AAC4B,SAAjBC,iBAAiB,CACpBnB,aADoB,EAEhB;AACJ,QAAIA,aAAa,IAAI,IAArB,EAA2B;AAAA;;AACvBA,MAAAA,aAAa,CAACoB,cAAd,CACI,OADJ,EAEItB,4BAA4B,CAACuB,6BAFjC;AAIA,+BAAAvB,4BAA4B,CAACgB,WAA7B,gFAA0CQ,MAA1C;AACAxB,MAAAA,4BAA4B,CAACgB,WAA7B,GAA2C,IAA3C;AACAhB,MAAAA,4BAA4B,CAACS,mBAA7B,GAAmD,IAAnD;;AACAT,MAAAA,4BAA4B,CAACG,iBAA7B,GAAiD,UAC7CC,MAD6C,EAE7CC,WAF6C,EAG/C;AACE,eAAOA,WAAP;AACH,OALD;AAMH,KAfG,CAiBJ;AACA;;;AACA,QAAI,KAAKc,oBAAT,EAA+B;AAC3B,WAAKA,oBAAL,CAA0BK,MAA1B;AACH,KAFD,MAEO;AACH;AACA;AACA1B,MAAAA,QAAQ,CAAC2B,mBAAT,CACI,QADJ,EAEIzB,4BAA4B,CAACoB,gBAFjC;AAIH;AACJ;;AAEmC,SAArBP,qBAAqB,CAChCa,KADgC,EAEhCC,cAA0C,GAAGC,SAFb,EAGlC;AACE,QAAIF,KAAK,KAAKE,SAAV,IAAuBF,KAAK,KAAK,IAArC,EAA2C;AACvC7B,MAAAA,WAAW,CAACS,GAAZ,CACIN,4BAA4B,CAAC6B,0CADjC,EAEIjC,YAAY,CAACkC,IAFjB,EADuC,CAKvC;;AACA;AACH;;AACD,UAAMC,GAAG,GAAGL,KAAK,CAACK,GAAlB;AAEA,UAAMC,SAAS,GAAGhC,4BAA4B,CAACG,iBAA/C;AACA,UAAM8B,UAAU,GAAGD,SAAS,CAACN,KAAD,EAAQA,KAAK,CAACQ,IAAd,CAA5B;;AAEA,QAAIH,GAAG,IAAI,IAAP,IAAeE,UAAU,IAAI,IAAjC,EAAuC;AACnC,UAAIN,cAAc,KAAK,YAAvB,EAAqC;AACjChC,QAAAA,KAAK,CAACwC,QAAN,CAAeJ,GAAf;AACH,OAFD,MAEO,IACHJ,cAAc,KAAK,QAAnB,IACAA,cAAc,KAAKC,SAFhB,EAGL;AACE;AACA;AACAjC,QAAAA,KAAK,CAACyC,SAAN,CAAgBL,GAAhB,EAAqBE,UAArB;AACH;AACJ;AACJ;;AAEkD,SAApCrB,oCAAoC,GAAuB;AACtE,QACIZ,4BAA4B,CAACuB,6BAA7B,IAA8D,IADlE,EAEE;AACEvB,MAAAA,4BAA4B,CAACuB,6BAA7B,GAA6D,MAAM;AAAA;;AAC/D,cAAMG,KAAK,6BAAG1B,4BAA4B,CAACS,mBAAhC,2DAAG,uBAAkDK,eAAlD,EAAd;;AAEA,YAAIY,KAAK,KAAKE,SAAd,EAAyB;AACrB/B,UAAAA,WAAW,CAACS,GAAZ,CACIN,4BAA4B,CAAC6B,0CADjC,EAEIjC,YAAY,CAACkC,IAFjB;AAIA;AACH;;AAED9B,QAAAA,4BAA4B,CAACa,qBAA7B,CAAmDa,KAAnD;AACH,OAZD;AAaH;;AACD,WAAO1B,4BAA4B,CAACuB,6BAApC;AACH;;AA9KqC;;gBAA7BvB,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B,gDAYL,gG;;gBAZKA,4B,uCAcL,+C;;gBAdKA,4B,yCAgBL,6K;;gBAhBKA,4B,6BAkBwB,MAAe;AAC5C,MAAIA,4BAA4B,CAACS,mBAA7B,KAAqD,IAAzD,EAA+D;AAC3D,WAAO,KAAP;AACH;;AACD,MAAIT,4BAA4B,CAACS,mBAA7B,CAAiD4B,SAAjD,EAAJ,EAAkE;AAC9D,WAAO,KAAP;AACH;;AACD,SAAO,IAAP;AACH,C;;gBA1BQrC,4B,iBA4BY,MAAM;AACvB,MAAIA,4BAA4B,CAACsC,uBAA7B,EAAJ,EAA4D;AACxDtC,IAAAA,4BAA4B,CAACqB,iBAA7B,CACIrB,4BAA4B,CAACS,mBADjC;AAGH,GALsB,CAMvB;AACA;;;AACA,SAAO,KAAP;AACH,C;;gBArCQT,4B,sBAiLL2B,cADgD,IAE/C;AAAA;;AACD,QAAMY,YAAY,6BAAGvC,4BAA4B,CAACS,mBAAhC,2DAAG,uBAAkDK,eAAlD,EAArB;;AACA,MAAIyB,YAAY,KAAKX,SAAjB,IAA8BW,YAAY,KAAK,IAAnD,EAAyD;AACrD1C,IAAAA,WAAW,CAACS,GAAZ,CACK,4EAA2EqB,cAAe,gDAD/F,EAEI/B,YAAY,CAACY,KAFjB;AAIA;AACH;;AAEDR,EAAAA,4BAA4B,CAACa,qBAA7B,CACI0B,YADJ,EAEIZ,cAFJ;AAIH,C","sourcesContent":["/*\n * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.\n * This product includes software developed at Datadog (https://www.datadoghq.com/).\n * Copyright 2016-Present Datadog, Inc.\n */\n\nimport { DdRum, SdkVerbosity, InternalLog } from '@datadog/mobile-react-native';\nimport type { AppStateStatus, NativeEventSubscription } from 'react-native';\nimport { AppState, BackHandler } from 'react-native';\n\nimport type {\n NavigationContainerRef,\n Route,\n NavigationListener\n} from './react-navigation';\n\n// AppStateStatus can have values:\n// 'active' - The app is running in the foreground\n// 'background' - The app is running in the background. The user is either in another app or on the home screen\n// 'inactive' [iOS] - This is a transition state that currently never happens for typical React Native apps.\n// 'unknown' [iOS] - Initial value until the current app state is determined\n// 'extension' [iOS] - The app is running as an app extension\ndeclare type AppStateListener = (appStateStatus: AppStateStatus) => void | null;\n\nexport type ViewNamePredicate = (\n route: Route<string, any | undefined>,\n trackedName: string\n) => string | null;\n\n/**\n * Provides RUM integration for the [ReactNavigation](https://reactnavigation.org/) API.\n */\nexport class DdRumReactNavigationTracking {\n private static registeredContainer: NavigationContainerRef | null;\n\n private static navigationStateChangeListener: NavigationListener;\n\n private static viewNamePredicate: ViewNamePredicate;\n\n private static backHandler: NativeEventSubscription | null;\n\n private static appStateSubscription?: NativeEventSubscription;\n\n static ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE =\n 'A navigation change was detected but the RUM ViewEvent was dropped as the route was undefined.';\n static NULL_NAVIGATION_REF_ERROR_MESSAGE =\n 'Cannot track views with a null navigationRef.';\n static NAVIGATION_REF_IN_USE_ERROR_MESSAGE =\n 'Cannot track new navigation container while another one is still tracked. Please call `DdRumReactNavigationTracking.stopTrackingViews` on the previous container reference.';\n\n static isAppExitingOnBackPress = (): boolean => {\n if (DdRumReactNavigationTracking.registeredContainer === null) {\n return false;\n }\n if (DdRumReactNavigationTracking.registeredContainer.canGoBack()) {\n return false;\n }\n return true;\n };\n\n static onBackPress = () => {\n if (DdRumReactNavigationTracking.isAppExitingOnBackPress()) {\n DdRumReactNavigationTracking.stopTrackingViews(\n DdRumReactNavigationTracking.registeredContainer\n );\n }\n // We always return false so we make sure the react-navigation callback is called.\n // See https://reactnative.dev/docs/backhandler\n return false;\n };\n\n /**\n * Starts tracking the NavigationContainer and sends a RUM View event every time the navigation route changed.\n * @param navigationRef the reference to the real NavigationContainer.\n */\n static startTrackingViews(\n navigationRef: NavigationContainerRef | null,\n viewNamePredicate: ViewNamePredicate = function (\n _route: Route<string, any | undefined>,\n trackedName: string\n ) {\n return trackedName;\n }\n ): void {\n if (navigationRef == null) {\n InternalLog.log(\n DdRumReactNavigationTracking.NULL_NAVIGATION_REF_ERROR_MESSAGE,\n SdkVerbosity.ERROR\n );\n return;\n }\n\n if (\n DdRumReactNavigationTracking.registeredContainer != null &&\n this.registeredContainer !== navigationRef\n ) {\n InternalLog.log(\n DdRumReactNavigationTracking.NAVIGATION_REF_IN_USE_ERROR_MESSAGE,\n SdkVerbosity.ERROR\n );\n } else if (DdRumReactNavigationTracking.registeredContainer == null) {\n DdRumReactNavigationTracking.viewNamePredicate = viewNamePredicate;\n const listener = DdRumReactNavigationTracking.resolveNavigationStateChangeListener();\n DdRumReactNavigationTracking.handleRouteNavigation(\n navigationRef.getCurrentRoute()\n );\n navigationRef.addListener('state', listener);\n DdRumReactNavigationTracking.registeredContainer = navigationRef;\n DdRumReactNavigationTracking.backHandler = BackHandler.addEventListener(\n 'hardwareBackPress',\n DdRumReactNavigationTracking.onBackPress\n );\n this.appStateSubscription = AppState.addEventListener(\n 'change',\n DdRumReactNavigationTracking.appStateListener\n );\n }\n }\n\n /**\n * Stops tracking the NavigationContainer.\n * @param navigationRef the reference to the real NavigationContainer.\n */\n static stopTrackingViews(\n navigationRef: NavigationContainerRef | null\n ): void {\n if (navigationRef != null) {\n navigationRef.removeListener(\n 'state',\n DdRumReactNavigationTracking.navigationStateChangeListener\n );\n DdRumReactNavigationTracking.backHandler?.remove();\n DdRumReactNavigationTracking.backHandler = null;\n DdRumReactNavigationTracking.registeredContainer = null;\n DdRumReactNavigationTracking.viewNamePredicate = function (\n _route: Route<string, any | undefined>,\n trackedName: string\n ) {\n return trackedName;\n };\n }\n\n // For versions of React Native below 0.65, addEventListener does not return a subscription.\n // We have to call AppState.removeEventListener instead.\n if (this.appStateSubscription) {\n this.appStateSubscription.remove();\n } else {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n AppState.removeEventListener(\n 'change',\n DdRumReactNavigationTracking.appStateListener\n );\n }\n }\n\n private static handleRouteNavigation(\n route: Route<string, any | undefined> | undefined,\n appStateStatus: AppStateStatus | undefined = undefined\n ) {\n if (route === undefined || route === null) {\n InternalLog.log(\n DdRumReactNavigationTracking.ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE,\n SdkVerbosity.WARN\n );\n // RUMM-1400 in some cases the route seem to be undefined\n return;\n }\n const key = route.key;\n\n const predicate = DdRumReactNavigationTracking.viewNamePredicate;\n const screenName = predicate(route, route.name);\n\n if (key != null && screenName != null) {\n if (appStateStatus === 'background') {\n DdRum.stopView(key);\n } else if (\n appStateStatus === 'active' ||\n appStateStatus === undefined\n ) {\n // case when app goes into foreground,\n // in that case navigation listener won't be called\n DdRum.startView(key, screenName);\n }\n }\n }\n\n private static resolveNavigationStateChangeListener(): NavigationListener {\n if (\n DdRumReactNavigationTracking.navigationStateChangeListener == null\n ) {\n DdRumReactNavigationTracking.navigationStateChangeListener = () => {\n const route = DdRumReactNavigationTracking.registeredContainer?.getCurrentRoute();\n\n if (route === undefined) {\n InternalLog.log(\n DdRumReactNavigationTracking.ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE,\n SdkVerbosity.WARN\n );\n return;\n }\n\n DdRumReactNavigationTracking.handleRouteNavigation(route);\n };\n }\n return DdRumReactNavigationTracking.navigationStateChangeListener;\n }\n\n private static appStateListener: AppStateListener = (\n appStateStatus: AppStateStatus\n ) => {\n const currentRoute = DdRumReactNavigationTracking.registeredContainer?.getCurrentRoute();\n if (currentRoute === undefined || currentRoute === null) {\n InternalLog.log(\n `We could not determine the route when changing the application state to: ${appStateStatus}. No RUM View event will be sent in this case.`,\n SdkVerbosity.ERROR\n );\n return;\n }\n\n DdRumReactNavigationTracking.handleRouteNavigation(\n currentRoute,\n appStateStatus\n );\n };\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["DdRumReactNavigationTracking.tsx"],"names":["DdRum","SdkVerbosity","InternalLog","AppState","BackHandler","DdRumReactNavigationTracking","startTrackingViews","navigationRef","viewNamePredicate","_route","trackedName","log","NULL_NAVIGATION_REF_ERROR_MESSAGE","ERROR","registeredContainer","NAVIGATION_REF_IN_USE_ERROR_MESSAGE","listener","resolveNavigationStateChangeListener","handleRouteNavigation","getCurrentRoute","addListener","backHandler","addEventListener","onBackPress","appStateSubscription","appStateListener","stopTrackingViews","removeListener","navigationStateChangeListener","remove","removeEventListener","route","appStateStatus","undefined","ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE","WARN","key","predicate","screenName","name","stopView","startView","canGoBack","isAppExitingOnBackPress","currentRoute"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AAEA,SAASA,KAAT,EAAgBC,YAAhB,EAA8BC,WAA9B,QAAiD,8BAAjD;AAEA,SAASC,QAAT,EAAmBC,WAAnB,QAAsC,cAAtC;;AAqBA;AACA;AACA;AACA,OAAO,MAAMC,4BAAN,CAAmC;AAuCtC;AACJ;AACA;AACA;AAC6B,SAAlBC,kBAAkB,CACrBC,aADqB,EAErBC,iBAAoC,GAAG,UACnCC,MADmC,EAEnCC,WAFmC,EAGrC;AACE,WAAOA,WAAP;AACH,GAPoB,EAQjB;AACJ,QAAIH,aAAa,IAAI,IAArB,EAA2B;AACvBL,MAAAA,WAAW,CAACS,GAAZ,CACIN,4BAA4B,CAACO,iCADjC,EAEIX,YAAY,CAACY,KAFjB;AAIA;AACH;;AAED,QACIR,4BAA4B,CAACS,mBAA7B,IAAoD,IAApD,IACA,KAAKA,mBAAL,KAA6BP,aAFjC,EAGE;AACEL,MAAAA,WAAW,CAACS,GAAZ,CACIN,4BAA4B,CAACU,mCADjC,EAEId,YAAY,CAACY,KAFjB;AAIH,KARD,MAQO,IAAIR,4BAA4B,CAACS,mBAA7B,IAAoD,IAAxD,EAA8D;AACjET,MAAAA,4BAA4B,CAACG,iBAA7B,GAAiDA,iBAAjD;AACA,YAAMQ,QAAQ,GAAGX,4BAA4B,CAACY,oCAA7B,EAAjB;AACAZ,MAAAA,4BAA4B,CAACa,qBAA7B,CACIX,aAAa,CAACY,eAAd,EADJ;AAGAZ,MAAAA,aAAa,CAACa,WAAd,CAA0B,OAA1B,EAAmCJ,QAAnC;AACAX,MAAAA,4BAA4B,CAACS,mBAA7B,GAAmDP,aAAnD;AACAF,MAAAA,4BAA4B,CAACgB,WAA7B,GAA2CjB,WAAW,CAACkB,gBAAZ,CACvC,mBADuC,EAEvCjB,4BAA4B,CAACkB,WAFU,CAA3C;AAIA,WAAKC,oBAAL,GAA4BrB,QAAQ,CAACmB,gBAAT,CACxB,QADwB,EAExBjB,4BAA4B,CAACoB,gBAFL,CAA5B;AAIH;AACJ;AAED;AACJ;AACA;AACA;;;AAC4B,SAAjBC,iBAAiB,CACpBnB,aADoB,EAEhB;AACJ,QAAIA,aAAa,IAAI,IAArB,EAA2B;AAAA;;AACvBA,MAAAA,aAAa,CAACoB,cAAd,CACI,OADJ,EAEItB,4BAA4B,CAACuB,6BAFjC;AAIA,+BAAAvB,4BAA4B,CAACgB,WAA7B,gFAA0CQ,MAA1C;AACAxB,MAAAA,4BAA4B,CAACgB,WAA7B,GAA2C,IAA3C;AACAhB,MAAAA,4BAA4B,CAACS,mBAA7B,GAAmD,IAAnD;;AACAT,MAAAA,4BAA4B,CAACG,iBAA7B,GAAiD,UAC7CC,MAD6C,EAE7CC,WAF6C,EAG/C;AACE,eAAOA,WAAP;AACH,OALD;AAMH,KAfG,CAiBJ;AACA;;;AACA,QAAI,KAAKc,oBAAT,EAA+B;AAC3B,WAAKA,oBAAL,CAA0BK,MAA1B,GAD2B,CAG3B;AACA;AACA;AACA;AACH,KAPD,MAOO,IAAI1B,QAAQ,CAAC2B,mBAAb,EAAkC;AACrC;AACA;AACA3B,MAAAA,QAAQ,CAAC2B,mBAAT,CACI,QADJ,EAEIzB,4BAA4B,CAACoB,gBAFjC;AAIH;AACJ;;AAEmC,SAArBP,qBAAqB,CAChCa,KADgC,EAEhCC,cAA0C,GAAGC,SAFb,EAGlC;AACE,QAAIF,KAAK,KAAKE,SAAV,IAAuBF,KAAK,KAAK,IAArC,EAA2C;AACvC7B,MAAAA,WAAW,CAACS,GAAZ,CACIN,4BAA4B,CAAC6B,0CADjC,EAEIjC,YAAY,CAACkC,IAFjB,EADuC,CAKvC;;AACA;AACH;;AACD,UAAMC,GAAG,GAAGL,KAAK,CAACK,GAAlB;AAEA,UAAMC,SAAS,GAAGhC,4BAA4B,CAACG,iBAA/C;AACA,UAAM8B,UAAU,GAAGD,SAAS,CAACN,KAAD,EAAQA,KAAK,CAACQ,IAAd,CAA5B;;AAEA,QAAIH,GAAG,IAAI,IAAP,IAAeE,UAAU,IAAI,IAAjC,EAAuC;AACnC,UAAIN,cAAc,KAAK,YAAvB,EAAqC;AACjChC,QAAAA,KAAK,CAACwC,QAAN,CAAeJ,GAAf;AACH,OAFD,MAEO,IACHJ,cAAc,KAAK,QAAnB,IACAA,cAAc,KAAKC,SAFhB,EAGL;AACE;AACA;AACAjC,QAAAA,KAAK,CAACyC,SAAN,CAAgBL,GAAhB,EAAqBE,UAArB;AACH;AACJ;AACJ;;AAEkD,SAApCrB,oCAAoC,GAAuB;AACtE,QACIZ,4BAA4B,CAACuB,6BAA7B,IAA8D,IADlE,EAEE;AACEvB,MAAAA,4BAA4B,CAACuB,6BAA7B,GAA6D,MAAM;AAAA;;AAC/D,cAAMG,KAAK,6BAAG1B,4BAA4B,CAACS,mBAAhC,2DAAG,uBAAkDK,eAAlD,EAAd;;AAEA,YAAIY,KAAK,KAAKE,SAAd,EAAyB;AACrB/B,UAAAA,WAAW,CAACS,GAAZ,CACIN,4BAA4B,CAAC6B,0CADjC,EAEIjC,YAAY,CAACkC,IAFjB;AAIA;AACH;;AAED9B,QAAAA,4BAA4B,CAACa,qBAA7B,CAAmDa,KAAnD;AACH,OAZD;AAaH;;AACD,WAAO1B,4BAA4B,CAACuB,6BAApC;AACH;;AAnLqC;;gBAA7BvB,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B;;gBAAAA,4B,gDAYL,gG;;gBAZKA,4B,uCAcL,+C;;gBAdKA,4B,yCAgBL,6K;;gBAhBKA,4B,6BAkBwB,MAAe;AAC5C,MAAIA,4BAA4B,CAACS,mBAA7B,KAAqD,IAAzD,EAA+D;AAC3D,WAAO,KAAP;AACH;;AACD,MAAIT,4BAA4B,CAACS,mBAA7B,CAAiD4B,SAAjD,EAAJ,EAAkE;AAC9D,WAAO,KAAP;AACH;;AACD,SAAO,IAAP;AACH,C;;gBA1BQrC,4B,iBA4BY,MAAM;AACvB,MAAIA,4BAA4B,CAACsC,uBAA7B,EAAJ,EAA4D;AACxDtC,IAAAA,4BAA4B,CAACqB,iBAA7B,CACIrB,4BAA4B,CAACS,mBADjC;AAGH,GALsB,CAMvB;AACA;;;AACA,SAAO,KAAP;AACH,C;;gBArCQT,4B,sBAsLL2B,cADgD,IAE/C;AAAA;;AACD,QAAMY,YAAY,6BAAGvC,4BAA4B,CAACS,mBAAhC,2DAAG,uBAAkDK,eAAlD,EAArB;;AACA,MAAIyB,YAAY,KAAKX,SAAjB,IAA8BW,YAAY,KAAK,IAAnD,EAAyD;AACrD1C,IAAAA,WAAW,CAACS,GAAZ,CACK,4EAA2EqB,cAAe,gDAD/F,EAEI/B,YAAY,CAACY,KAFjB;AAIA;AACH;;AAEDR,EAAAA,4BAA4B,CAACa,qBAA7B,CACI0B,YADJ,EAEIZ,cAFJ;AAIH,C","sourcesContent":["/*\n * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.\n * This product includes software developed at Datadog (https://www.datadoghq.com/).\n * Copyright 2016-Present Datadog, Inc.\n */\n\nimport { DdRum, SdkVerbosity, InternalLog } from '@datadog/mobile-react-native';\nimport type { AppStateStatus, NativeEventSubscription } from 'react-native';\nimport { AppState, BackHandler } from 'react-native';\n\nimport type {\n NavigationContainerRef,\n Route,\n NavigationListener\n} from './react-navigation';\n\n// AppStateStatus can have values:\n// 'active' - The app is running in the foreground\n// 'background' - The app is running in the background. The user is either in another app or on the home screen\n// 'inactive' [iOS] - This is a transition state that currently never happens for typical React Native apps.\n// 'unknown' [iOS] - Initial value until the current app state is determined\n// 'extension' [iOS] - The app is running as an app extension\ndeclare type AppStateListener = (appStateStatus: AppStateStatus) => void | null;\n\nexport type ViewNamePredicate = (\n route: Route<string, any | undefined>,\n trackedName: string\n) => string | null;\n\n/**\n * Provides RUM integration for the [ReactNavigation](https://reactnavigation.org/) API.\n */\nexport class DdRumReactNavigationTracking {\n private static registeredContainer: NavigationContainerRef | null;\n\n private static navigationStateChangeListener: NavigationListener;\n\n private static viewNamePredicate: ViewNamePredicate;\n\n private static backHandler: NativeEventSubscription | null;\n\n private static appStateSubscription?: NativeEventSubscription;\n\n static ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE =\n 'A navigation change was detected but the RUM ViewEvent was dropped as the route was undefined.';\n static NULL_NAVIGATION_REF_ERROR_MESSAGE =\n 'Cannot track views with a null navigationRef.';\n static NAVIGATION_REF_IN_USE_ERROR_MESSAGE =\n 'Cannot track new navigation container while another one is still tracked. Please call `DdRumReactNavigationTracking.stopTrackingViews` on the previous container reference.';\n\n static isAppExitingOnBackPress = (): boolean => {\n if (DdRumReactNavigationTracking.registeredContainer === null) {\n return false;\n }\n if (DdRumReactNavigationTracking.registeredContainer.canGoBack()) {\n return false;\n }\n return true;\n };\n\n static onBackPress = () => {\n if (DdRumReactNavigationTracking.isAppExitingOnBackPress()) {\n DdRumReactNavigationTracking.stopTrackingViews(\n DdRumReactNavigationTracking.registeredContainer\n );\n }\n // We always return false so we make sure the react-navigation callback is called.\n // See https://reactnative.dev/docs/backhandler\n return false;\n };\n\n /**\n * Starts tracking the NavigationContainer and sends a RUM View event every time the navigation route changed.\n * @param navigationRef the reference to the real NavigationContainer.\n */\n static startTrackingViews(\n navigationRef: NavigationContainerRef | null,\n viewNamePredicate: ViewNamePredicate = function (\n _route: Route<string, any | undefined>,\n trackedName: string\n ) {\n return trackedName;\n }\n ): void {\n if (navigationRef == null) {\n InternalLog.log(\n DdRumReactNavigationTracking.NULL_NAVIGATION_REF_ERROR_MESSAGE,\n SdkVerbosity.ERROR\n );\n return;\n }\n\n if (\n DdRumReactNavigationTracking.registeredContainer != null &&\n this.registeredContainer !== navigationRef\n ) {\n InternalLog.log(\n DdRumReactNavigationTracking.NAVIGATION_REF_IN_USE_ERROR_MESSAGE,\n SdkVerbosity.ERROR\n );\n } else if (DdRumReactNavigationTracking.registeredContainer == null) {\n DdRumReactNavigationTracking.viewNamePredicate = viewNamePredicate;\n const listener = DdRumReactNavigationTracking.resolveNavigationStateChangeListener();\n DdRumReactNavigationTracking.handleRouteNavigation(\n navigationRef.getCurrentRoute()\n );\n navigationRef.addListener('state', listener);\n DdRumReactNavigationTracking.registeredContainer = navigationRef;\n DdRumReactNavigationTracking.backHandler = BackHandler.addEventListener(\n 'hardwareBackPress',\n DdRumReactNavigationTracking.onBackPress\n );\n this.appStateSubscription = AppState.addEventListener(\n 'change',\n DdRumReactNavigationTracking.appStateListener\n );\n }\n }\n\n /**\n * Stops tracking the NavigationContainer.\n * @param navigationRef the reference to the real NavigationContainer.\n */\n static stopTrackingViews(\n navigationRef: NavigationContainerRef | null\n ): void {\n if (navigationRef != null) {\n navigationRef.removeListener(\n 'state',\n DdRumReactNavigationTracking.navigationStateChangeListener\n );\n DdRumReactNavigationTracking.backHandler?.remove();\n DdRumReactNavigationTracking.backHandler = null;\n DdRumReactNavigationTracking.registeredContainer = null;\n DdRumReactNavigationTracking.viewNamePredicate = function (\n _route: Route<string, any | undefined>,\n trackedName: string\n ) {\n return trackedName;\n };\n }\n\n // For versions of React Native below 0.65, addEventListener does not return a subscription.\n // We have to call AppState.removeEventListener instead.\n if (this.appStateSubscription) {\n this.appStateSubscription.remove();\n\n // The next if check is important as users can call `stopTrackingViews` before `startTrackingViews`\n // see https://github.com/DataDog/dd-sdk-reactnative/issues/422\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n } else if (AppState.removeEventListener) {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n AppState.removeEventListener(\n 'change',\n DdRumReactNavigationTracking.appStateListener\n );\n }\n }\n\n private static handleRouteNavigation(\n route: Route<string, any | undefined> | undefined,\n appStateStatus: AppStateStatus | undefined = undefined\n ) {\n if (route === undefined || route === null) {\n InternalLog.log(\n DdRumReactNavigationTracking.ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE,\n SdkVerbosity.WARN\n );\n // RUMM-1400 in some cases the route seem to be undefined\n return;\n }\n const key = route.key;\n\n const predicate = DdRumReactNavigationTracking.viewNamePredicate;\n const screenName = predicate(route, route.name);\n\n if (key != null && screenName != null) {\n if (appStateStatus === 'background') {\n DdRum.stopView(key);\n } else if (\n appStateStatus === 'active' ||\n appStateStatus === undefined\n ) {\n // case when app goes into foreground,\n // in that case navigation listener won't be called\n DdRum.startView(key, screenName);\n }\n }\n }\n\n private static resolveNavigationStateChangeListener(): NavigationListener {\n if (\n DdRumReactNavigationTracking.navigationStateChangeListener == null\n ) {\n DdRumReactNavigationTracking.navigationStateChangeListener = () => {\n const route = DdRumReactNavigationTracking.registeredContainer?.getCurrentRoute();\n\n if (route === undefined) {\n InternalLog.log(\n DdRumReactNavigationTracking.ROUTE_UNDEFINED_NAVIGATION_WARNING_MESSAGE,\n SdkVerbosity.WARN\n );\n return;\n }\n\n DdRumReactNavigationTracking.handleRouteNavigation(route);\n };\n }\n return DdRumReactNavigationTracking.navigationStateChangeListener;\n }\n\n private static appStateListener: AppStateListener = (\n appStateStatus: AppStateStatus\n ) => {\n const currentRoute = DdRumReactNavigationTracking.registeredContainer?.getCurrentRoute();\n if (currentRoute === undefined || currentRoute === null) {\n InternalLog.log(\n `We could not determine the route when changing the application state to: ${appStateStatus}. No RUM View event will be sent in this case.`,\n SdkVerbosity.ERROR\n );\n return;\n }\n\n DdRumReactNavigationTracking.handleRouteNavigation(\n currentRoute,\n appStateStatus\n );\n };\n}\n"]}
|
|
@@ -126,6 +126,10 @@ export declare class DdSdkReactNativeConfiguration {
|
|
|
126
126
|
* Sets the preferred frequency for collecting mobile vitals.
|
|
127
127
|
*/
|
|
128
128
|
vitalsUpdateFrequency: VitalsUpdateFrequency;
|
|
129
|
+
/**
|
|
130
|
+
* Enables tracking of frustration signals (error taps). Defaults to `true`.
|
|
131
|
+
*/
|
|
132
|
+
trackFrustrations: boolean;
|
|
129
133
|
logEventMapper: LogEventMapper | null;
|
|
130
134
|
errorEventMapper: ErrorEventMapper | null;
|
|
131
135
|
resourceEventMapper: ResourceEventMapper | null;
|
|
@@ -191,6 +195,7 @@ export declare type PartialInitializationConfiguration = {
|
|
|
191
195
|
readonly nativeCrashReportEnabled?: boolean;
|
|
192
196
|
readonly telemetrySampleRate?: number;
|
|
193
197
|
readonly vitalsUpdateFrequency?: VitalsUpdateFrequency;
|
|
198
|
+
readonly trackFrustrations?: boolean;
|
|
194
199
|
};
|
|
195
200
|
export declare const buildConfigurationFromPartialConfiguration: (features: AutoInstrumentationConfiguration, configuration: PartialInitializationConfiguration) => DdSdkReactNativeConfiguration;
|
|
196
201
|
export declare class DatadogProviderConfiguration extends DdSdkReactNativeConfiguration {
|
|
@@ -4,9 +4,9 @@ import { InternalLog } from './InternalLog';
|
|
|
4
4
|
import { ProxyConfiguration, ProxyType } from './ProxyConfiguration';
|
|
5
5
|
import { SdkVerbosity } from './SdkVerbosity';
|
|
6
6
|
import { TrackingConsent } from './TrackingConsent';
|
|
7
|
-
import { DdTrace } from './foundation';
|
|
8
7
|
import { DdLogs } from './logs/DdLogs';
|
|
9
8
|
import { DdRum } from './rum/DdRum';
|
|
10
9
|
import { RumActionType, ErrorSource, PropagatorType } from './rum/types';
|
|
11
10
|
import { DatadogProvider } from './sdk/DatadogProvider/DatadogProvider';
|
|
11
|
+
import { DdTrace } from './trace/DdTrace';
|
|
12
12
|
export { DatadogProvider, DatadogProviderConfiguration, InitializationMode, DdLogs, DdTrace, DdRum, RumActionType, ErrorSource, DdSdkReactNativeConfiguration, DdSdkReactNative, InternalLog, ProxyConfiguration, ProxyType, TrackingConsent, SdkVerbosity, VitalsUpdateFrequency, PropagatorType };
|
|
@@ -48,6 +48,11 @@ export declare type DdNativeSdkType = {
|
|
|
48
48
|
* @param kind error kind
|
|
49
49
|
*/
|
|
50
50
|
telemetryError(message: string, stack: string, kind: string): Promise<void>;
|
|
51
|
+
/**
|
|
52
|
+
* Send webview telemetry logs
|
|
53
|
+
* @param message event description
|
|
54
|
+
*/
|
|
55
|
+
consumeWebviewEvent(message: string): Promise<void>;
|
|
51
56
|
};
|
|
52
57
|
/**
|
|
53
58
|
* The entry point to use Datadog's Logs feature.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { PropagatorType } from '../../../types';
|
|
2
|
+
import type { RegexMap } from '../requestProxy/interfaces/RequestProxy';
|
|
2
3
|
import type { Hostname } from './firstPartyHosts';
|
|
3
|
-
import type { RegexMap } from './interfaces/RequestProxy';
|
|
4
4
|
export declare type DdRumResourceTracingAttributes = {
|
|
5
5
|
tracingStrategy: 'KEEP';
|
|
6
6
|
traceId: TraceId;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { FirstPartyHost, PropagatorType } from '../../../types';
|
|
2
|
-
import type { RegexMap } from '
|
|
2
|
+
import type { RegexMap } from '../requestProxy/interfaces/RequestProxy';
|
|
3
3
|
export declare type Hostname = {
|
|
4
4
|
_type: 'Hostname';
|
|
5
5
|
} & string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { RUMResource } from '../../
|
|
1
|
+
import type { RUMResource } from '../../interfaces/RumResource';
|
|
2
2
|
declare type ResourceMapper = (resource: RUMResource) => RUMResource | null;
|
|
3
3
|
export declare class ResourceReporter {
|
|
4
4
|
private mappers;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { RequestProxyOptions } from '../
|
|
2
|
-
import { RequestProxy } from '../
|
|
1
|
+
import type { RequestProxyOptions } from '../interfaces/RequestProxy';
|
|
2
|
+
import { RequestProxy } from '../interfaces/RequestProxy';
|
|
3
3
|
import type { ResourceReporter } from './DatadogRumResource/ResourceReporter';
|
|
4
4
|
interface XHRProxyProviders {
|
|
5
5
|
xhrType: typeof XMLHttpRequest;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ResourceKind } from '../../../../types';
|
|
2
|
-
import type { DdRumResourceTracingAttributes } from '
|
|
2
|
+
import type { DdRumResourceTracingAttributes } from '../../distributedTracing/distributedTracing';
|
|
3
3
|
export interface RUMResource {
|
|
4
4
|
key: string;
|
|
5
5
|
request: {
|
|
@@ -14,13 +14,14 @@ export declare class DdSdkConfiguration {
|
|
|
14
14
|
readonly additionalConfig: object;
|
|
15
15
|
readonly telemetrySampleRate: number;
|
|
16
16
|
readonly vitalsUpdateFrequency: string;
|
|
17
|
+
readonly trackFrustrations: boolean;
|
|
17
18
|
readonly configurationForTelemetry: {
|
|
18
19
|
initializationType: string;
|
|
19
20
|
trackErrors: boolean;
|
|
20
21
|
trackInteractions: boolean;
|
|
21
22
|
trackNetworkRequests: boolean;
|
|
22
23
|
};
|
|
23
|
-
constructor(clientToken: string, env: string, applicationId: string, nativeCrashReportEnabled: boolean, nativeLongTaskThresholdMs: number, longTaskThresholdMs: number, sampleRate: number, site: string, trackingConsent: string, additionalConfig: object, telemetrySampleRate: number, vitalsUpdateFrequency: string, configurationForTelemetry: {
|
|
24
|
+
constructor(clientToken: string, env: string, applicationId: string, nativeCrashReportEnabled: boolean, nativeLongTaskThresholdMs: number, longTaskThresholdMs: number, sampleRate: number, site: string, trackingConsent: string, additionalConfig: object, telemetrySampleRate: number, vitalsUpdateFrequency: string, trackFrustrations: boolean, configurationForTelemetry: {
|
|
24
25
|
initializationType: string;
|
|
25
26
|
trackErrors: boolean;
|
|
26
27
|
trackInteractions: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "1.
|
|
1
|
+
export declare const version = "1.5.1";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@datadog/mobile-react-navigation",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.1",
|
|
4
4
|
"description": "A client-side React Native module to interact with Datadog",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"datadog",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"prepare": "rm -rf lib && yarn bob build"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@datadog/mobile-react-native": "^1.
|
|
39
|
+
"@datadog/mobile-react-native": "^1.5.1",
|
|
40
40
|
"@react-navigation/native-v5": "npm:@react-navigation/native@5.9.8",
|
|
41
41
|
"@react-navigation/native-v6": "npm:@react-navigation/native@6.1.2",
|
|
42
42
|
"@react-navigation/stack-v5": "npm:@react-navigation/stack@5.14.2",
|
|
@@ -77,5 +77,5 @@
|
|
|
77
77
|
]
|
|
78
78
|
]
|
|
79
79
|
},
|
|
80
|
-
"gitHead": "
|
|
80
|
+
"gitHead": "429c794a983fa4e3a369091f892792d8bc23812b"
|
|
81
81
|
}
|
|
@@ -20,12 +20,14 @@ import { AppStateMock } from './__utils__/AppStateMock';
|
|
|
20
20
|
import {
|
|
21
21
|
FakeNavigator1 as FakeNavigator1v5,
|
|
22
22
|
FakeNavigator2 as FakeNavigator2v5,
|
|
23
|
-
FakeNestedNavigator as FakeNestedNavigatorv5
|
|
23
|
+
FakeNestedNavigator as FakeNestedNavigatorv5,
|
|
24
|
+
FakeTogglableNavigator as FakeTogglableNavigatorv5
|
|
24
25
|
} from './__utils__/Navigators/NavigatorsV5';
|
|
25
26
|
import {
|
|
26
27
|
FakeNavigator1 as FakeNavigator1v6,
|
|
27
28
|
FakeNavigator2 as FakeNavigator2v6,
|
|
28
|
-
FakeNestedNavigator as FakeNestedNavigatorv6
|
|
29
|
+
FakeNestedNavigator as FakeNestedNavigatorv6,
|
|
30
|
+
FakeTogglableNavigator as FakeTogglableNavigatorv6
|
|
29
31
|
} from './__utils__/Navigators/NavigatorsV6';
|
|
30
32
|
|
|
31
33
|
// TODO: inject this as a global
|
|
@@ -53,7 +55,8 @@ jest.mock('@datadog/mobile-react-native', () => {
|
|
|
53
55
|
DdRum: {
|
|
54
56
|
// eslint-disable-next-line @typescript-eslint/no-empty-function
|
|
55
57
|
startView: jest.fn().mockImplementation(() => {}),
|
|
56
|
-
stopView: jest.fn().mockImplementation(() => {})
|
|
58
|
+
stopView: jest.fn().mockImplementation(() => {}),
|
|
59
|
+
addError: jest.fn().mockImplementation(() => {})
|
|
57
60
|
},
|
|
58
61
|
SdkVerbosity: {
|
|
59
62
|
DEBUG: 'debug',
|
|
@@ -91,7 +94,8 @@ describe.each([
|
|
|
91
94
|
{
|
|
92
95
|
FakeNavigator1: FakeNavigator1v5,
|
|
93
96
|
FakeNavigator2: FakeNavigator2v5,
|
|
94
|
-
FakeNestedNavigator: FakeNestedNavigatorv5
|
|
97
|
+
FakeNestedNavigator: FakeNestedNavigatorv5,
|
|
98
|
+
FakeTogglableNavigator: FakeTogglableNavigatorv5
|
|
95
99
|
}
|
|
96
100
|
],
|
|
97
101
|
[
|
|
@@ -99,12 +103,21 @@ describe.each([
|
|
|
99
103
|
{
|
|
100
104
|
FakeNavigator1: FakeNavigator1v6,
|
|
101
105
|
FakeNavigator2: FakeNavigator2v6,
|
|
102
|
-
FakeNestedNavigator: FakeNestedNavigatorv6
|
|
106
|
+
FakeNestedNavigator: FakeNestedNavigatorv6,
|
|
107
|
+
FakeTogglableNavigator: FakeTogglableNavigatorv6
|
|
103
108
|
}
|
|
104
109
|
]
|
|
105
110
|
])(
|
|
106
111
|
'DdRumReactNavigationTracking on react-navigation v%s',
|
|
107
|
-
(
|
|
112
|
+
(
|
|
113
|
+
version,
|
|
114
|
+
{
|
|
115
|
+
FakeNavigator1,
|
|
116
|
+
FakeNavigator2,
|
|
117
|
+
FakeNestedNavigator,
|
|
118
|
+
FakeTogglableNavigator
|
|
119
|
+
}
|
|
120
|
+
) => {
|
|
108
121
|
describe('startTrackingViews', () => {
|
|
109
122
|
it('sends a related RUM ViewEvent when switching screens { navigationContainer listener attached }', async () => {
|
|
110
123
|
// GIVEN
|
|
@@ -378,11 +391,14 @@ describe.each([
|
|
|
378
391
|
// @ts-ignore
|
|
379
392
|
appStateMock.addEventListener
|
|
380
393
|
);
|
|
381
|
-
// @ts-ignore
|
|
382
394
|
if (appStateMock.removeEventListener) {
|
|
395
|
+
// @ts-ignore
|
|
383
396
|
AppState.removeEventListener = jest.fn(
|
|
384
397
|
appStateMock.removeEventListener
|
|
385
398
|
);
|
|
399
|
+
} else {
|
|
400
|
+
// @ts-ignore
|
|
401
|
+
delete AppState.removeEventListener;
|
|
386
402
|
}
|
|
387
403
|
});
|
|
388
404
|
it('registers and unregisters AppState', async () => {
|
|
@@ -496,9 +512,48 @@ describe.each([
|
|
|
496
512
|
// THEN
|
|
497
513
|
expect(DdRum.stopView).not.toHaveBeenCalled();
|
|
498
514
|
});
|
|
515
|
+
|
|
516
|
+
it('does not crash when stopTrackingViews is called before startTrackingViews', async () => {
|
|
517
|
+
// GIVEN
|
|
518
|
+
const navigationRef = createRef<any>();
|
|
519
|
+
render(<FakeNavigator1 navigationRef={navigationRef} />);
|
|
520
|
+
|
|
521
|
+
DdRumReactNavigationTracking.stopTrackingViews(
|
|
522
|
+
navigationRef.current
|
|
523
|
+
);
|
|
524
|
+
DdRumReactNavigationTracking.startTrackingViews(
|
|
525
|
+
navigationRef.current
|
|
526
|
+
);
|
|
527
|
+
|
|
528
|
+
// WHEN
|
|
529
|
+
appStateMock.changeValue('background');
|
|
530
|
+
|
|
531
|
+
// THEN
|
|
532
|
+
expect(DdRum.stopView).toHaveBeenCalled();
|
|
533
|
+
});
|
|
499
534
|
}
|
|
500
535
|
);
|
|
501
536
|
|
|
537
|
+
describe('Togglable navigators', () => {
|
|
538
|
+
it('does not send an error when a navigator is toggled and tracking is stopped', async () => {
|
|
539
|
+
const navigationRef = createRef<any>();
|
|
540
|
+
const { findByText } = render(
|
|
541
|
+
<FakeTogglableNavigator navigationRef={navigationRef} />
|
|
542
|
+
);
|
|
543
|
+
|
|
544
|
+
const hideNavButton = await findByText('display nav 2');
|
|
545
|
+
fireEvent(hideNavButton, 'press');
|
|
546
|
+
|
|
547
|
+
expect(DdRum.startView).toHaveBeenCalledTimes(1);
|
|
548
|
+
|
|
549
|
+
const switchNav = await findByText('display nav 1');
|
|
550
|
+
fireEvent(switchNav, 'press');
|
|
551
|
+
expect(DdRum.startView).toHaveBeenCalledTimes(2);
|
|
552
|
+
|
|
553
|
+
expect(InternalLog.log).not.toHaveBeenCalled();
|
|
554
|
+
});
|
|
555
|
+
});
|
|
556
|
+
|
|
502
557
|
describe('Android back handler', () => {
|
|
503
558
|
it('does not send an error when the app closes with Android back button', async () => {
|
|
504
559
|
// GIVEN
|
|
@@ -8,7 +8,9 @@ import type { NavigationContainerRef } from '@react-navigation/native-v5';
|
|
|
8
8
|
import { NavigationContainer } from '@react-navigation/native-v5';
|
|
9
9
|
import { createStackNavigator } from '@react-navigation/stack-v5';
|
|
10
10
|
import { View, Text, Button } from 'react-native';
|
|
11
|
-
import React from 'react';
|
|
11
|
+
import React, { useEffect, useState } from 'react';
|
|
12
|
+
|
|
13
|
+
import { DdRumReactNavigationTracking } from '../../../../../rum/instrumentation/DdRumReactNavigationTracking';
|
|
12
14
|
|
|
13
15
|
const { Screen, Navigator } = createStackNavigator();
|
|
14
16
|
|
|
@@ -103,3 +105,47 @@ export function FakeNestedNavigator(props: {
|
|
|
103
105
|
</NavigationContainer>
|
|
104
106
|
);
|
|
105
107
|
}
|
|
108
|
+
|
|
109
|
+
export function FakeTogglableNavigator(props: {
|
|
110
|
+
navigationRef: React.RefObject<NavigationContainerRef>;
|
|
111
|
+
}) {
|
|
112
|
+
const [showNavigator, setShowNavigator] = useState(true);
|
|
113
|
+
const FakeToggleScreen = (screenProps: any) => {
|
|
114
|
+
return (
|
|
115
|
+
<Button
|
|
116
|
+
title={screenProps.route.params.text || 'no text provided'}
|
|
117
|
+
onPress={() => setShowNavigator(s => !s)}
|
|
118
|
+
/>
|
|
119
|
+
);
|
|
120
|
+
};
|
|
121
|
+
|
|
122
|
+
const navigationRef = props.navigationRef;
|
|
123
|
+
|
|
124
|
+
useEffect(() => {
|
|
125
|
+
DdRumReactNavigationTracking.stopTrackingViews(navigationRef.current);
|
|
126
|
+
}, [showNavigator]);
|
|
127
|
+
|
|
128
|
+
return showNavigator ? (
|
|
129
|
+
<NavigationContainer
|
|
130
|
+
ref={navigationRef}
|
|
131
|
+
onReady={() => {
|
|
132
|
+
DdRumReactNavigationTracking.startTrackingViews(
|
|
133
|
+
navigationRef.current
|
|
134
|
+
);
|
|
135
|
+
}}
|
|
136
|
+
>
|
|
137
|
+
<Navigator>
|
|
138
|
+
<Screen
|
|
139
|
+
name="Profile1"
|
|
140
|
+
component={FakeToggleScreen}
|
|
141
|
+
initialParams={{ text: 'display nav 2' }}
|
|
142
|
+
/>
|
|
143
|
+
</Navigator>
|
|
144
|
+
</NavigationContainer>
|
|
145
|
+
) : (
|
|
146
|
+
<Button
|
|
147
|
+
title="display nav 1"
|
|
148
|
+
onPress={() => setShowNavigator(s => !s)}
|
|
149
|
+
/>
|
|
150
|
+
);
|
|
151
|
+
}
|
|
@@ -8,7 +8,9 @@ import type { NavigationContainerRef } from '@react-navigation/native-v6';
|
|
|
8
8
|
import { NavigationContainer } from '@react-navigation/native-v6';
|
|
9
9
|
import { createStackNavigator } from '@react-navigation/stack-v6';
|
|
10
10
|
import { View, Text, Button } from 'react-native';
|
|
11
|
-
import React from 'react';
|
|
11
|
+
import React, { useEffect, useState } from 'react';
|
|
12
|
+
|
|
13
|
+
import { DdRumReactNavigationTracking } from '../../../../../rum/instrumentation/DdRumReactNavigationTracking';
|
|
12
14
|
|
|
13
15
|
const { Screen, Navigator } = createStackNavigator();
|
|
14
16
|
|
|
@@ -103,3 +105,47 @@ export function FakeNestedNavigator(props: {
|
|
|
103
105
|
</NavigationContainer>
|
|
104
106
|
);
|
|
105
107
|
}
|
|
108
|
+
|
|
109
|
+
export function FakeTogglableNavigator(props: {
|
|
110
|
+
navigationRef: React.RefObject<NavigationContainerRef<unknown>>;
|
|
111
|
+
}) {
|
|
112
|
+
const [showNavigator, setShowNavigator] = useState(true);
|
|
113
|
+
const FakeToggleScreen = (screenProps: any) => {
|
|
114
|
+
return (
|
|
115
|
+
<Button
|
|
116
|
+
title={screenProps.route.params.text || 'no text provided'}
|
|
117
|
+
onPress={() => setShowNavigator(s => !s)}
|
|
118
|
+
/>
|
|
119
|
+
);
|
|
120
|
+
};
|
|
121
|
+
|
|
122
|
+
const navigationRef = props.navigationRef;
|
|
123
|
+
|
|
124
|
+
useEffect(() => {
|
|
125
|
+
DdRumReactNavigationTracking.stopTrackingViews(navigationRef.current);
|
|
126
|
+
}, [showNavigator]);
|
|
127
|
+
|
|
128
|
+
return showNavigator ? (
|
|
129
|
+
<NavigationContainer
|
|
130
|
+
ref={navigationRef}
|
|
131
|
+
onReady={() => {
|
|
132
|
+
DdRumReactNavigationTracking.startTrackingViews(
|
|
133
|
+
navigationRef.current
|
|
134
|
+
);
|
|
135
|
+
}}
|
|
136
|
+
>
|
|
137
|
+
<Navigator>
|
|
138
|
+
<Screen
|
|
139
|
+
name="Profile1"
|
|
140
|
+
component={FakeToggleScreen}
|
|
141
|
+
initialParams={{ text: 'display nav 2' }}
|
|
142
|
+
/>
|
|
143
|
+
</Navigator>
|
|
144
|
+
</NavigationContainer>
|
|
145
|
+
) : (
|
|
146
|
+
<Button
|
|
147
|
+
title="display nav 1"
|
|
148
|
+
onPress={() => setShowNavigator(s => !s)}
|
|
149
|
+
/>
|
|
150
|
+
);
|
|
151
|
+
}
|
|
@@ -144,7 +144,12 @@ export class DdRumReactNavigationTracking {
|
|
|
144
144
|
// We have to call AppState.removeEventListener instead.
|
|
145
145
|
if (this.appStateSubscription) {
|
|
146
146
|
this.appStateSubscription.remove();
|
|
147
|
-
|
|
147
|
+
|
|
148
|
+
// The next if check is important as users can call `stopTrackingViews` before `startTrackingViews`
|
|
149
|
+
// see https://github.com/DataDog/dd-sdk-reactnative/issues/422
|
|
150
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
151
|
+
// @ts-ignore
|
|
152
|
+
} else if (AppState.removeEventListener) {
|
|
148
153
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
149
154
|
// @ts-ignore
|
|
150
155
|
AppState.removeEventListener(
|
|
File without changes
|
|
File without changes
|
|
File without changes
|