fix: Rename useConsentModel to browserConsentMode

ellisong · ellisong · commit 1c1646784412 · 2025-10-22T10:52:27.000-07:00
diff --git a/src/common/config/init-types.js b/src/common/config/init-types.js
@@ -84,7 +84,8 @@
  * @property {boolean} [spa.enabled] - Turn on/off the single page application feature (on by default). NOTE: the SPA feature is deprecated and under removal procedure.
  * @property {boolean} [spa.autoStart] - If true, the agent will automatically start the single page application feature. Otherwise, it will be in a deferred state until the `start` API method is called.
  * @property {boolean} [ssl] - If explicitly false, the agent will use HTTP instead of HTTPS. This setting should NOT be used.
- * @property {boolean} [useConsentModel] - If true, the agent will use the consent model for whether to allow or disallow data harvest.
+ * @property {Object} [browserConsentMode]
+ * @property {boolean} [enabled] - If true, the agent will use consent mode for whether to allow or disallow data harvest.
  * @property {Object} [user_actions]
  * @property {boolean} [user_actions.enabled] - Must be true to allow UserAction events to be captured.
  * @property {Array<string>} [user_actions.elementAttributes] - List of HTML Element properties to be captured with UserAction events' target elements. This may help to identify the source element being interacted with in the UI.
diff --git a/src/common/config/init.js b/src/common/config/init.js
@@ -134,7 +134,7 @@ const InitModelFn = () => {
     soft_navigations: { enabled: true, autoStart: true },
     spa: { enabled: true, autoStart: true },
     ssl: undefined,
-    useConsentModel: false,
+    browserConsentMode: { enabled: false },
     user_actions: { enabled: true, elementAttributes: ['id', 'className', 'tagName', 'type'] }
   }
 }
diff --git a/src/common/harvest/harvester.js b/src/common/harvest/harvester.js
@@ -56,7 +56,7 @@ export class Harvester {
    */
   triggerHarvestFor (aggregateInst, localOpts = {}) {
     if (aggregateInst.blocked) return false
-    if (this.agentRef.init.useConsentModel && !this.agentRef.runtime?.session?.state?.consent) return false
+    if (this.agentRef.init?.browserConsentMode?.enabled && !this.agentRef.runtime?.session?.state?.consent) return false
 
     const submitMethod = getSubmitMethod(localOpts)
     if (!submitMethod) return false
diff --git a/tests/assets/consent-mode-accept.html b/tests/assets/consent-mode-accept.html
@@ -5,7 +5,7 @@
 -->
 <html>
   <head>
-    <title>Consent Model Test</title>
+    <title>Consent Mode Test</title>
     {init} {config} {loader}
     <script>
       newrelic.consent(true)
diff --git a/tests/assets/consent-mode-reject.html b/tests/assets/consent-mode-reject.html
@@ -5,7 +5,7 @@
 -->
 <html>
   <head>
-    <title>Consent Model Test</title>
+    <title>Consent Mode Test</title>
     {init} {config} {loader}
     <script>
       newrelic.consent(false)
diff --git a/tests/assets/instrumented2.html b/tests/assets/instrumented2.html
@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<!--
+  Copyright 2020 New Relic Corporation.
+  PDX-License-Identifier: Apache-2.0
+-->
+<html>
+  <head>
+    <title>RUM Unit Test</title>
+    <script>
+      window.NREUM||(NREUM={});
+      NREUM.init = {
+        browserConsentMode: { enabled: true }
+      }
+    </script>
+    {config} {loader}
+  </head>
+  <body>Instrumented!</body>
+</html>
diff --git a/tests/dts/agentoptions.test-d.ts b/tests/dts/agentoptions.test-d.ts
@@ -117,7 +117,7 @@ const validOptions: AgentOptions = {
       autoStart: false
     },
     ssl: true,
-    useConsentModel: false,
+    browserConsentMode: { enabled: false },
     user_actions: {
       enabled: true,
       elementAttributes: ['id', 'className', 'tagName', 'type']
@@ -198,8 +198,4 @@ expectError<AgentOptions>({
 
 expectError<AgentOptions>({
   loaderType: 123 // should be a string
-})
-
-expectError<AgentOptions>({
-  useConsentModel: 'false' // should be a boolean
 })
diff --git a/tests/specs/consent-mode.e2e.js b/tests/specs/consent-mode.e2e.js
@@ -1,19 +1,19 @@
 import { testRumRequest, testTimingEventsRequest } from '../../tools/testing-server/utils/expect-tests'
 import { FEATURE_NAMES } from '../../src/loaders/features/features'
 
-describe('consent model', () => {
+describe('consent mode', () => {
   let rumCapture, pvtCapture
 
   const HARVEST_TIMEOUT = 10000
 
   const consentModeConfig = {
     init: {
-      useConsentModel: true
+      browserConsentMode: { enabled: true }
     }
   }
   const manualStartConfig = {
     init: {
-      useConsentModel: true,
+      browserConsentMode: { enabled: true },
       [FEATURE_NAMES.pageViewTiming]: { autoStart: false }
     }
   }
@@ -32,7 +32,7 @@ describe('consent model', () => {
     it('should harvest data for PVE feature if consent is given', async () => {
       const [rumHarvests] = await Promise.all([
         rumCapture.waitForResult({ totalCount: 1 }),
-        browser.url(await browser.testHandle.assetURL('consent-model-accept.html', consentModeConfig))
+        browser.url(await browser.testHandle.assetURL('consent-mode-accept.html', consentModeConfig))
       ])
 
       expect(rumHarvests.length).toBeGreaterThan(0)
@@ -41,7 +41,7 @@ describe('consent model', () => {
     it('should not harvest data if consent is not given', async () => {
       const [rumHarvests] = await Promise.all([
         rumCapture.waitForResult({ timeout: HARVEST_TIMEOUT }),
-        browser.url(await browser.testHandle.assetURL('consent-model-reject.html', consentModeConfig))
+        browser.url(await browser.testHandle.assetURL('consent-mode-reject.html', consentModeConfig))
       ])
 
       expect(rumHarvests.length).toEqual(0)
diff --git a/tests/unit/common/config/init.test.js b/tests/unit/common/config/init.test.js
@@ -131,7 +131,7 @@ test('init props exist and return expected defaults', () => {
     enabled: true,
     elementAttributes: ['id', 'className', 'tagName', 'type']
   })
-  expect(config.useConsentModel).toEqual(false)
+  expect(config.browserConsentMode.enabled).toEqual(false)
 })
 
 describe('property getters/setters used for validation', () => {

Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ const InitModelFn = () => {`
`134`	`134`	`soft_navigations: { enabled: true, autoStart: true },`
`135`	`135`	`spa: { enabled: true, autoStart: true },`
`136`	`136`	`ssl: undefined,`
`137`		`- useConsentModel: false,`
	`137`	`+ browserConsentMode: { enabled: false },`
`138`	`138`	`user_actions: { enabled: true, elementAttributes: ['id', 'className', 'tagName', 'type'] }`
`139`	`139`	`}`
`140`	`140`	`}`