feat(useCookie): skip anonymous userToken if useCookie is false #236
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit fa4e239:
|
samouss
reviewed
Dec 15, 2020
ghost
requested review from
francoischalifour and
Haroenv
and removed request for
a team
Haroenv
reviewed
Dec 16, 2020
README.md
Outdated
| @@ -65,6 +65,7 @@ aa('setUserToken', 'USER_ID'); | |||
| | **`apiKey`** | `string` | None (required) | The search API key of your Algolia application | | |||
| | `userHasOptedOut` | `boolean` | `false` | Whether to exclude users from analytics | | |||
| | `region` | `'de' \| 'us'` | Automatic | The DNS server to target | | |||
| | `useCookie` | `boolean` | `true` | Whether to use cookie in browser environment. The anonymous user token will not be set if `false`. | | |||
There was a problem hiding this comment.
after this, I think we should release a version with useCookie as true
There was a problem hiding this comment.
You mean false as a breaking change? It's true by default.
There was a problem hiding this comment.
Yes, sorry I meant false in the future
There was a problem hiding this comment.
yeah it should be false in the next major version.
…js into feat/use-cookie
eunjae-lee
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds an option
useCookietoinitmethod.Its default value is
true, but it needs to befalsein the next major version to avoid the situation where our customers set cookies in end-users' browsers without knowing it.hasUserOptedOutvsuseCookieIf user denies to be tracked, for example, by clicking "deny" button on a cookie popup, then
userHasOptedOutshould be true, and search-insights won't send any event from the user. So this is per-user setting.On the other hand, if a website decides not to use anonymous user token in cookie at all, then they can set
useCookie: false. It means search-insights will not generate/store any anonymous user token in the cookie. So aa will not have any user token initially.setUserTokenmust be called explicitly. Once auserTokenis set, it will send events.