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

chore: add deprecation note for DNT #4020

Merged
merged 7 commits into from
Jun 4, 2024
+8 −5
Merged

chore: add deprecation note for DNT #4020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1b9a3ad
add deprecation note
samisayegh May 28, 2024
f6e7894
improve message
samisayegh May 28, 2024
6ba3e3f
Merge branch 'master' into LENS-1891
samisayegh May 31, 2024
69187df
remove doNotTrack from analytics configuration action
samisayegh May 31, 2024
a21b1a6
only apply DNT when analytics mode is not next
samisayegh May 31, 2024
18db089
Merge branch 'master' into LENS-1891
samisayegh Jun 3, 2024
6035d3e
Apply suggestions from code review
louis-bompart Jun 4, 2024
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
3 changes: 2 additions & 1 deletion packages/headless/src/app/engine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,8 @@ function getUpdateAnalyticsConfigurationPayload(
apiBaseUrl,
};

if (doNotTrack()) {
// TODO KIT-2844
if (payloadWithURL.analyticsMode !== 'next' && doNotTrack()) {
logger.info('Analytics disabled since doNotTrack is active.');
return {
...payloadWithURL,
Expand Down
4 changes: 0 additions & 4 deletions packages/headless/src/features/configuration/configuration-actions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import {
} from '@coveo/bueno';
import {createAction} from '@reduxjs/toolkit';
import {IRuntimeEnvironment} from 'coveo.analytics';
import {doNotTrack} from '../../utils/utils';
import {
nonEmptyString,
validatePayload,
Expand Down Expand Up @@ -207,9 +206,6 @@ const analyticsConfigurationSchema: SchemaDefinition<
export const updateAnalyticsConfiguration = createAction(
'configuration/updateAnalyticsConfiguration',
(payload: UpdateAnalyticsConfigurationActionCreatorPayload) => {
if (doNotTrack()) {
payload.enabled = false;
}
return validatePayload(payload, analyticsConfigurationSchema);
}
);
Expand Down
6 changes: 6 additions & 0 deletions packages/headless/src/utils/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,15 @@ export function getObjectHash<T>(obj: T) {
}

const doNotTrackValues = new Set(['1', 1, 'yes', true]);
// TODO KIT-2844

/**
* Logic copied from coveo.analytics.
*
* @deprecated Starting with Event Protocol, Coveo will no longer respect the DNT standard.
* Instead, we will provide implementers with documentation on privacy best-practices, letting
* them decide which standards to respect.
* For more context behind the decision, see: https://coveord.atlassian.net/browse/LENS-1502
*/
export function doNotTrack() {
if (typeof navigator === 'undefined' || typeof window === 'undefined') {
Expand Down
Loading