Skip to content

@W-17594891 Update Wording of Interface In DNT hook#2182

Merged
jeremy-jung1 merged 6 commits intodnt-ui-branchfrom
unify-interface-wording
Jan 16, 2025
Merged

@W-17594891 Update Wording of Interface In DNT hook#2182
jeremy-jung1 merged 6 commits intodnt-ui-branchfrom
unify-interface-wording

Conversation

@jeremy-jung1
Copy link
Collaborator

@jeremy-jung1 jeremy-jung1 commented Jan 4, 2025

Ticket

Description

Mentioning of doNotTrack in the wording of the properties returned by useDNT have been consolidated into 'Dnt', to mirror the acronym wording in 'defaultDnt'. This is to use a more consistent wording in the Dnt feature.

Properties that were previously released have been noted for deprecation but were kept in the interface to avoid breaking changes, as discussed offline.

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • Breaking change (could cause existing functionality to not work as expected)
  • Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

  • Removing a public function or component or prop
  • Adding a required argument to a function
  • Changing the data type of a function parameter or return value
  • Adding a new peer dependency to package.json

Changes

  • (change1) Updated names

How to Test-Drive This PR

  • (step1) Go to https://aaa-jeremy-chicken-soup.mobify-storefront-staging.com/
  • (step2) Clear site data
  • (step3) See that DNT notification pops up, click 'Decline'
  • (step4) Go to application -> cookies. See that dw_dnt is 1
  • (step5) Keep the developer tool open, go to New Arrivals -> Play Station. Then go to Network tab of the developer tool and type in cquotient in the search. See that no API calls have been made.
  • (step6) Clear site data and refresh. Select 'Accept' in the DNT notification
  • (step7) refresh, and see that cquotient API calls are now made

Checklists

General

  • Changes are covered by test cases
  • CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

  • There are no changes to UI

or...

Localization

  • Changes include a UI text update in the Retail React App (which requires translation)

@jeremy-jung1 jeremy-jung1 requested a review from a team as a code owner January 4, 2025 23:08
@jeremy-jung1 jeremy-jung1 changed the title Update wording Update Wording of Interface In DNT hook Jan 14, 2025
/** @deprecated - Deprecated since version 3.1.0. Use selectedDoNotTrackValue instead. */
selectedDnt,
effectiveDnt,
/** @deprecated - Deprecated since version 3.1.0. Use selectedDnt instead. */
Copy link
Contributor

Choose a reason for hiding this comment

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

Please move this block to jsdoc comment so it will be generated into the typedoc when we merge.

/** @deprecated - Deprecated since version 3.1.0. Use selectedDnt instead. */
dntStatus,
updateDNT
/** @deprecated - Deprecated since version 3.1.0. Use updateDnt instead. */
Copy link
Contributor

Choose a reason for hiding this comment

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

same as above

updateDNT
/** @deprecated - Deprecated since version 3.1.0. Use updateDnt instead. */
updateDNT,
updateDnt
Copy link
Contributor

Choose a reason for hiding this comment

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

which one are we deprecating again? updateDNT is a defined func, if we remove it, what does updateDnt equal to?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

They are the same thing. We are deprecating updateDNT and dntStatus

Copy link
Contributor

@alexvuong alexvuong left a comment

Choose a reason for hiding this comment

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

Left a few comments

@jeremy-jung1 jeremy-jung1 changed the title Update Wording of Interface In DNT hook @W-17594891 Update Wording of Interface In DNT hook Jan 16, 2025
@jeremy-jung1 jeremy-jung1 merged commit a2723ae into dnt-ui-branch Jan 16, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants