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

Pubcommon id and shared id submodules: merge into one submodule #6808

Merged
merged 10 commits into from
Jun 7, 2021

Conversation

NothingIsMatter
Copy link
Contributor

Type of change

  • [ x] Feature

Description of change

Merge pubcid and sharedid

Other information

Issue - #6640

@lgtm-com
Copy link

lgtm-com bot commented May 21, 2021

This pull request fixes 1 alert when merging 2ee857b into 22ad110 - view on LGTM.com

fixed alerts:

  • 1 for Useless conditional

@patmmccann
Copy link
Collaborator

patmmccann commented May 21, 2021

@NothingIsMatter prebid 5 was updated just now, can you repull the branch / merge conflicts?

@patmmccann patmmccann requested a review from smenzer May 21, 2021 19:35
@jdwieland8282
Copy link
Member

@patmmccann, @NothingIsMatter is in the EU, is this something that needs to be addressed today, or can it wait until Monday?

@patmmccann
Copy link
Collaborator

It can definitely wait, the 5.0 release is two weeks out

@lgtm-com
Copy link

lgtm-com bot commented May 24, 2021

This pull request fixes 1 alert when merging 9e1bfee into 6957925 - view on LGTM.com

fixed alerts:

  • 1 for Useless conditional

@patmmccann patmmccann changed the title merge pubcid and sharedid Pubcommon id and shared id submodules: merge into one submodule May 25, 2021
Copy link
Contributor

@mmoschovas mmoschovas left a comment

Choose a reason for hiding this comment

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

Few things to take a look at here. Also it seems as though perhaps some of the files were overlooked in this update. The previous change consisted of 31 files whereas this update has only modified 25. Just doing a quick comparison, I can see that openx and ix adapters no longer have the update to remove the sharedId references. I would suggest going over this again to make sure all necessary updates are included in this version as well

* @param {SubmoduleParams} [config]
* @param {ConsentData|undefined} consentData
* @param {Object} storedId existing id
* @returns {IdResponse|undefined}
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like the extendId function comments are included but the pubCommonId function itself was not placed in here. Was this intentional? The domainOverride function was also not included as it was in the last PR

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, that wasn`t intentional, will remove it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

modules/sharedIdSystem.js Outdated Show resolved Hide resolved
@@ -1,77 +0,0 @@
import {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this module test being removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

According to #6640:

remove the following sharedid files

modules/sharedIdSystem.js
test/spec/modules/sharedIdSystem_spec.js
modules/sharedIdSystem.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

@NothingIsMatter
Copy link
Contributor Author

@mmoschovas added comments, updated the branch

@lgtm-com
Copy link

lgtm-com bot commented May 25, 2021

This pull request fixes 1 alert when merging e30ad8a into 6957925 - view on LGTM.com

fixed alerts:

  • 1 for Useless conditional

@lgtm-com
Copy link

lgtm-com bot commented May 25, 2021

This pull request fixes 1 alert when merging 62d6193 into 6957925 - view on LGTM.com

fixed alerts:

  • 1 for Useless conditional

@lgtm-com
Copy link

lgtm-com bot commented May 25, 2021

This pull request fixes 1 alert when merging ec41a92 into 6957925 - view on LGTM.com

fixed alerts:

  • 1 for Useless conditional

@mmoschovas
Copy link
Contributor

@NothingIsMatter I think there has been some confusion here most likely due to the nature of the ticket but quite possibly because of my comments. I just want to make sure there is a shared understanding here:

  1. There are two pubCommon files - pubCommonId and pubCommonIdSystem. My understanding as per Prebid docs is that pubCommonIdSystem is currently used and pubCommonId is deprecated. Meaning that the purpose of this PR is to basically transfer code to sharedIdSystem and its corresponding unit tests from the pubCommonIdSystem. It seems the test here have been taken from the pubCommonId file. It looks as though perhaps there was never a designated test for the pubCommonIdSystem, so these tests will need to be created under sharedIdSystem_spec since I dont see one existing currently

  2. In terms of the comments and references, I am not seeing this having been fully updated. For clarification, I am referring to areas of the code such as the following. Effectively the pubCommonId module has been renamed to sharedId and this should be reflected in these areas as to be consistent; otherwise, this can become very confusing.

* This module adds PubCommonId to the User ID module 
* The {@link module:modules/userId} module is required 
* @module modules/pubCommonIdSystem 
* @requires module:modules/userId
...
export const pubCommonIdSubmodule = {
...
...
submodule('userId', pubCommonIdSubmodule);
  1. I just wanted to make sure you saw my previous note regarding some adapters that were not included in this PR that were in the previous PR. i.e. ix and openx (looks like there are a few more though). Just want to confirm that these adapters are being updated if their 5.0 branch code still includes the sharedId reference

@NothingIsMatter
Copy link
Contributor Author

@NothingIsMatter I think there has been some confusion here most likely due to the nature of the ticket but quite possibly because of my comments. I just want to make sure there is a shared understanding here:

  1. There are two pubCommon files - pubCommonId and pubCommonIdSystem. My understanding as per Prebid docs is that pubCommonIdSystem is currently used and pubCommonId is deprecated. Meaning that the purpose of this PR is to basically transfer code to sharedIdSystem and its corresponding unit tests from the pubCommonIdSystem. It seems the test here have been taken from the pubCommonId file. It looks as though perhaps there was never a designated test for the pubCommonIdSystem, so these tests will need to be created under sharedIdSystem_spec since I dont see one existing currently
  2. In terms of the comments and references, I am not seeing this having been fully updated. For clarification, I am referring to areas of the code such as the following. Effectively the pubCommonId module has been renamed to sharedId and this should be reflected in these areas as to be consistent; otherwise, this can become very confusing.
* This module adds PubCommonId to the User ID module 
* The {@link module:modules/userId} module is required 
* @module modules/pubCommonIdSystem 
* @requires module:modules/userId
...
export const pubCommonIdSubmodule = {
...
...
submodule('userId', pubCommonIdSubmodule);
  1. I just wanted to make sure you saw my previous note regarding some adapters that were not included in this PR that were in the previous PR. i.e. ix and openx (looks like there are a few more though). Just want to confirm that these adapters are being updated if their 5.0 branch code still includes the sharedId reference
  1. I did PR according to Merge Pubcommon and SharedId user id sub adapters.  #6640, it doesn`t contains any info regarding pubCommonId.js, hence i did not change it at all, also according to issue, I renamed PubcommonIdSystem_spec to sharedIdSystem_spec without changing it, but as you said its relates to pubCommonId, not to pubCommonIdSystem, probably need some input here from @jdwieland8282
  2. Ok, I will change it
  3. Yes, probably I missed some of the changes, will fix it too.

@lgtm-com
Copy link

lgtm-com bot commented May 26, 2021

This pull request fixes 1 alert when merging 6d4096d into 6957925 - view on LGTM.com

fixed alerts:

  • 1 for Useless conditional

@jdwieland8282
Copy link
Member

@mmoschovas mind re reviewing we've made the requested changes.

@mmoschovas
Copy link
Contributor

@jdwieland8282 are the unit tests going to be updated as well? It still looks like the spec file is testing the deprecated pubCommonId file

@@ -25,7 +25,6 @@ import {
import {server} from 'test/mocks/xhr.js';
import find from 'core-js-pure/features/array/find.js';
import {unifiedIdSubmodule} from 'modules/unifiedIdSystem.js';
import {pubCommonIdSubmodule} from 'modules/pubCommonIdSystem.js';
Copy link
Contributor

Choose a reason for hiding this comment

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

@mmoschovas pubCommonIdSystem.js is removed from the tests.

Copy link
Contributor

Choose a reason for hiding this comment

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

@SKOCHERI I'm referring to test/spec/modules/sharedIdSystem_spec.js which is using the pubCommonId.js functions not sharedIdSystem.js

Copy link
Contributor

Choose a reason for hiding this comment

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

@mmoschovas The test/spec/modules/sharedIdSystem_spec.js is updated. Can you review it?

@lgtm-com
Copy link

lgtm-com bot commented Jun 3, 2021

This pull request fixes 1 alert when merging 8ca32a1 into fe175cd - view on LGTM.com

fixed alerts:

  • 1 for Useless conditional

Copy link
Contributor

@mmoschovas mmoschovas left a comment

Choose a reason for hiding this comment

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

LGTM

@mmoschovas mmoschovas added the needs 2nd review Core module updates require two approvals from the core team label Jun 4, 2021
@patmmccann
Copy link
Collaborator

@NothingIsMatter merge conflict showed up

Copy link
Collaborator

@smenzer smenzer left a comment

Choose a reason for hiding this comment

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

LGTM

@patmmccann patmmccann merged commit 013698f into prebid:prebid-5.0 Jun 7, 2021
@lgtm-com
Copy link

lgtm-com bot commented Jun 7, 2021

This pull request fixes 1 alert when merging 0c7e5f6 into 61c494a - view on LGTM.com

fixed alerts:

  • 1 for Useless conditional

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature major needs 2nd review Core module updates require two approvals from the core team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants