@wikia/tracking-opt-in v13.0.1

tracking-opt-in

FANDOM's gdpr opt-in dialog prompt.

Installation

Using yarn:

yarn add @wikia/tracking-opt-in

Access npmjs

Access the npmjs.com UI through vault key vault read secret/app/npmjs.

Usage

The library exports one function that can be invoked to kickoff the process of showing the modal, or calling the appropriate callbacks if the user has already accepted or rejected tracking. The library is built using webpack's libraryTarget: "umd" option, so it should be usable in any of our projects.

Integration Test

• An integration test can be run for any client by adding a additional build to their pipeline: Pipeline Syntax
• If you do not integrate with with Jenkins you can ping a url http://jenkins:8080/view/CAKE/view/tracking-opt-in/job/external%20test/buildWithParameters?token=tracking-opt-in-external-test&testUrl=<url>&slackChannel=<slack channel>&projectName=<your app>
• Params
  • token = tracking-opt-in-external-test (no need to change)
  • testUrl = publicly accessible url where the selenium tests will target
  • projectName = A unique per app name to organize each integration test
  • testIE = (Optional - defaults to true) Enable ie11 tests

Examples

As es6 module:

import main from '@wikia/tracking-opt-in'
...
const optIn = main(options)

As script tag:

<script src="..."></script>
...
<script>
var optIn = trackingOptIn.main(options)
</script>

Invocation of the exported function returns an instance of ConsentManagementPlatform. See below for the available functions.

Options

The following options are accepted:

• beaconCookieName - The name of the beacon cookie that will be added to tracking calls
• cookieName - The name of the cookie used for the user's tracking consent status. Should only be changed for development purposes. defaults to tracking-opt-in-status.
• cookieExpiration - How long the consent cookie should last when the user accepts consent. Defaults to 50 years.
• cookieRejectExpiration - How long the reject cookie should last when the user rejects. Defaults to 1 days.
• country - Override the country code for determining the country the user is visiting from. Defaults to reading from the Geo cookie that should be available in all of our web apps.
• countriesRequiringPrompt - Array of country codes that require tracking opt-in. See GeoManager for the defaults.
• disableConsentQueue - If true then CMP will return fully opted-out consent string before user accept or reject the modal without queuing the commands
• enabledVendorPurposes - Array of purpose IDs to be allowed on opt-in. See the IAB CMP specification for details. Defaults to all standard purposes.
• enabledVendors - Array of vendor IDs to be allowed on opt-in. See the IAB CMP specification for details. Defaults to a list of all of Fandom's vendors who are partnered with IAB.
• isSubjectToCcpa - Used to opt-out of sale users who are below 16 y.o.
• isSubjectToCoppa - Same as isSubjectToCcpa. Takes precendence over isSubjectToCcpa. Left for backwards compatibility.
• language - Override the language used to display the dialog text. Defaults to window.navigator.language if available, otherwise to en.
• preventScrollOn - Prevent scrolling on the specified element when the dialog is shown. Can be either an element or query selector passed to document.querySelector. Defaults to 'body', set to null to prevent this behavior.
• queryParam - The name of the query param to forcefully set the accepted status. Defaults to tracking-opt-in-status and accepts the string values true or false (e.g http://starwars.wikia.com/?tracking-opt-in-status=true)
• track - Whether to track impressions and user consent/rejections. Defaults to true.
• zIndex - Useful if elements on the app are appearing above the overlay/modal. Defaults to 1000.
• onAcceptTracking - The callback fired when:
  • the user's geo does not require tracking consent
  • the user accepts non-IAB vendor tracking
  • the user has already accepted tracking (subsequent page load)
• onRejectTracking - The callback fired when:
  • the user rejects non-IAB vendor tracking
  • the user has already rejected tracking (subsequent page load)
• isCurse - Optional boolean that generates a different privacy link on curse products

Notes

• onAcceptTracking and onRejectTracking are the key options that should be overridden by each app to either initialize their respective trackers or to somehow react to the user's rejection of tracking.
• As of v2.0.0, accepting or rejecting vendor tracking should not affect any GA or internal tracking unrelated to advertising.
• Country codes are in ISO 3166-1 format.

ConsentManagementPlatform class

Calling the exported function returns an instance of the ConsentManagementPlatform class. The class has the following functions:

• hasUserConsented() - Returns true if the user has accepted non-IAB vendor tracking (or does not need to based on their geo), false if they have explicitly rejected tracking, and undefined if the user has neither accepted nor rejected tracking.
• geoRequiresTrackingConsent() - Returns true if the user's geo requires consent, false otherwise.
• reset() - Clears the opt-in cookie and runs through the rendering rules again.
• clear() - Clears the opt-in cookie
• render() - Runs through the rendering rules and either renders the opt-in prompt or calls the appropriate onAcceptTracking/onRejectTracking callbacks.

Local Development

Installation

$> yarn install

Running demo site

$> yarn start:dev

Open up http://localhost:3000. Webpack HMR should update the app as you develop.

The main entry point is src/index.js.

Running Tests

To run a single pass over the tests:

$> yarn test

To run the tests in watch mode so that changes re-run the tests:

$> yarn test:watch

Selenium Testing

FANDOM uses BrowserStack to assist our automated testing efforts.

To run the selenium tests locally first run yarn start:prod in one terminal then, in a separate terminal, run BROWSERSTACK_KEY=<browser-stack> BROWSERSTACK_USERNAME=<username> USE_TUNNEL=true yarn test:selenium