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.

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

drop support for userId configs with the usersync config object, pe… #5427

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion modules/britepoolIdSystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ BritePool User ID Module. For assistance setting up your module please contact u
Individual params may be set for the BritePool User ID Submodule. At least one identifier must be set in the params.
```
pbjs.setConfig({
usersync: {
userSync: {
userIds: [{
name: 'britepoolId',
storage: {
Expand Down
2 changes: 1 addition & 1 deletion modules/sharedIdSystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ex: $ gulp build --modules=userId,sharedIdSystem
Individual params may be set for the Shared ID User ID Submodule.
```
pbjs.setConfig({
usersync: {
userSync: {
userIds: [{
name: 'sharedId',
params: {
Expand Down
4 changes: 2 additions & 2 deletions modules/userId/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -570,8 +570,8 @@ export function init(config) {
}
// listen for config userSyncs to be set
config.getConfig(conf => {
// Note: support for both 'userSync' and 'usersync' will be deprecated with Prebid.js 3.0
const userSync = conf.userSync || conf.usersync;
// Note: support for 'usersync' was dropped as part of Prebid.js 4.0
const userSync = conf.userSync;
smenzer marked this conversation as resolved.
Show resolved Hide resolved
if (userSync && userSync.userIds) {
configRegistry = userSync.userIds;
syncDelay = utils.isNumber(userSync.syncDelay) ? userSync.syncDelay : DEFAULT_SYNC_DELAY;
Expand Down
4 changes: 2 additions & 2 deletions modules/userId/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ pbjs.setConfig({
Example showing `localStorage` for user id data for some submodules
```
pbjs.setConfig({
usersync: {
userSync: {
userIds: [{
name: "unifiedId",
params: {
Expand Down Expand Up @@ -137,7 +137,7 @@ pbjs.setConfig({
Example showing how to configure a `value` object to pass directly to bid adapters
```
pbjs.setConfig({
usersync: {
userSync: {
userIds: [{
name: "pubCommonId",
value: {
Expand Down
2 changes: 1 addition & 1 deletion modules/userIdTargeting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ pbjs.setConfig({

// your existing userIds config

usersync: {
userSync: {
userIds: [{...}, ...]
},

Expand Down
2 changes: 1 addition & 1 deletion test/spec/modules/userId_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ describe('User ID', function() {
it('does not delay auction if there are no ids to fetch', function() {
coreStorage.getCookie.withArgs('MOCKID').returns('123456778');
config.setConfig({
usersync: {
userSync: {
auctionDelay: 33,
syncDelay: 77,
userIds: [{
Expand Down