drop support for userId configs with the usersync config object (#5427

) * drop support for userId configs with the `usersync` config object, per deprecation notice * changes on drop support (#1) * Update userIdTargeting.md * Update userId.md * Update userId_spec.js * Update britepoolIdSystem.md * Update sharedIdSystem.md Co-authored-by: Patrick McCann <patmmccann@gmail.com>
prebid · Jul 21, 2020 · d99e637 · d99e637
1 parent 13a347a
commit d99e637
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/modules/britepoolIdSystem.md b/modules/britepoolIdSystem.md
@@ -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: {

diff --git a/modules/sharedIdSystem.md b/modules/sharedIdSystem.md
@@ -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: {

diff --git a/modules/userId/index.js b/modules/userId/index.js
@@ -576,8 +576,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;
     if (userSync && userSync.userIds) {
       configRegistry = userSync.userIds;
       syncDelay = utils.isNumber(userSync.syncDelay) ? userSync.syncDelay : DEFAULT_SYNC_DELAY;

diff --git a/modules/userId/userId.md b/modules/userId/userId.md
@@ -79,7 +79,7 @@ pbjs.setConfig({
 Example showing `localStorage` for user id data for some submodules
 ```
 pbjs.setConfig({
-    usersync: {
+    userSync: {
         userIds: [{
             name: "unifiedId",
             params: {
@@ -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: {

diff --git a/modules/userIdTargeting.md b/modules/userIdTargeting.md
@@ -8,7 +8,7 @@ pbjs.setConfig({
 
 	// your existing userIds config
 
-	usersync: {
+	userSync: {
 		userIds: [{...}, ...]
 	},
 

diff --git a/test/spec/modules/userId_spec.js b/test/spec/modules/userId_spec.js
@@ -656,7 +656,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: [{