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.

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

98828 Add initial RUM implementation - form 10-10d #33772

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
6 changes: 5 additions & 1 deletion src/applications/ivc-champva/10-10D/containers/App.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ import {
DowntimeNotification,
externalServices,
} from '@department-of-veterans-affairs/platform-monitoring/DowntimeNotification';
import { VaBreadcrumbs } from '@department-of-veterans-affairs/component-library/dist/react-bindings';
import PropTypes from 'prop-types';
import RoutedSavableApp from 'platform/forms/save-in-progress/RoutedSavableApp';
import { VaBreadcrumbs } from '@department-of-veterans-affairs/component-library/dist/react-bindings';
import { Toggler } from 'platform/utilities/feature-toggles';
import formConfig from '../config/form';
import WIP from '../../shared/components/WIP';
import { useBrowserMonitoring } from '../helpers/useBrowserMonitoring';
Comment on lines +6 to +12
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reordered, nothing important here.

import { addStyleToShadowDomOnPages } from '../../shared/utilities';

const breadcrumbList = [
Expand Down Expand Up @@ -38,6 +39,9 @@ export default function App({ location, children }) {
);
});

// Add Datadog RUM to the app
useBrowserMonitoring();

return (
<div className="vads-l-grid-container desktop-lg:vads-u-padding-x--0">
<Toggler toggleName={Toggler.TOGGLE_NAMES.form1010d}>
Expand Down
Copy link
Contributor Author

@michaelclement michaelclement Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adds RUM initialization function (modified from EZR form example).

Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import { useEffect, useMemo } from 'react';
import { useSelector } from 'react-redux';
import { datadogRum } from '@datadog/browser-rum';

import environment from '@department-of-veterans-affairs/platform-utilities/environment';
import { makeSelectFeatureToggles } from '../selectors/feature-toggles';

const initializeRealUserMonitoring = () => {
// Prevent RUM from re-initializing the SDK OR running on local/CI environments.
if (
!environment.BASE_URL.includes('localhost') &&
!window.DD_RUM?.getInitConfiguration()
) {
datadogRum.init({
applicationId: 'cca24a05-9ea0-49ea-aaa9-0d1e04a17ba0',
clientToken: 'puba5e0866f8008f60a6bc8b09ae555dd92',
site: 'ddog-gov.com',
service: '10-10d',
env: environment.vspEnvironment(),
sessionSampleRate: 100,
sessionReplaySampleRate: 100,
Comment on lines +20 to +21
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Defaulting to 100% because we need to test in staging. Once we decide to start using in prod, this will have to change to a significantly reduced percentage.

trackUserInteractions: true,
trackFrustrations: true,
trackResources: true,
trackLongTasks: true,
defaultPrivacyLevel: 'mask-user-input',
});

// If sessionReplaySampleRate > 0, we need to manually start the recording
datadogRum.startSessionReplayRecording();
}
};

const useBrowserMonitoring = () => {
// Retrieve feature flag values to control behavior
const selectFeatureToggles = useMemo(makeSelectFeatureToggles, []);
const featureToggles = useSelector(selectFeatureToggles);
const { isBrowserMonitoringEnabled, isLoadingFeatureFlags } = featureToggles;

useEffect(
() => {
if (isLoadingFeatureFlags) return;
if (isBrowserMonitoringEnabled) {
initializeRealUserMonitoring();
} else {
delete window.DD_RUM;
}
},
[isBrowserMonitoringEnabled, isLoadingFeatureFlags],
);
};

export { useBrowserMonitoring };
Comment on lines +34 to +53
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on existing RUM config examples in vets-website. Uses memoized feature toggle info when initializing RUM.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Helper used later with useMemo to get relevant feature toggle state

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { createSelector } from 'reselect';
import { toggleValues } from '@department-of-veterans-affairs/platform-site-wide/selectors';
import FEATURE_FLAG_NAMES from '@department-of-veterans-affairs/platform-utilities/featureFlagNames';

const selectFeatureToggles = createSelector(
state => ({
isLoadingFeatureFlags: state?.featureToggles?.loading,
isBrowserMonitoringEnabled: toggleValues(state)[
FEATURE_FLAG_NAMES.form1010dBrowserMonitoringEnabled
],
}),
toggles => toggles,
);

const makeSelectFeatureToggles = () => selectFeatureToggles;

export { makeSelectFeatureToggles };
Comment on lines +1 to +17
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on existing RUM config examples in vets-website. Creates a redux selector so these extra bits of state can be derived rather than directly stored.

Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { expect } from 'chai';
import { makeSelectFeatureToggles } from '../../../selectors/feature-toggles';

describe('ezr FeatureToggles selector', () => {
const state = {
featureToggles: {
/* eslint-disable camelcase */
michaelclement marked this conversation as resolved.
Show resolved Hide resolved
form1010d_browser_monitoring_enabled: true,
loading: false,
},
};

describe('when `makeSelectFeatureToggles` executes', () => {
it('should return feature toggles', () => {
const selectFeatureToggles = makeSelectFeatureToggles();
expect(selectFeatureToggles(state)).to.eql({
isLoadingFeatureFlags: false,
isBrowserMonitoringEnabled: true,
});
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
"findARepresentativeEnableFrontend": "find_a_representative_enable_frontend",
"findARepresentativeFlagResultsEnabled": "find_a_representative_flag_results_enabled",
"form1010d": "form1010d",
"form1010dBrowserMonitoringEnabled": "form1010d_browser_monitoring_enabled",
"form107959c": "form107959c",
"form107959a": "form107959a",
"form107959f2": "form107959f2",
Expand Down
Loading