PAIR: Support for Generic TechLab Version #12146

[therevoltingx]

Documentation PR

prebid/prebid.github.io#5785

Storage or Cookie

localStorage.setItem(
  'pairId',
  btoa(JSON.stringify(['my-pair-id']))
);

Clean Room Configuration

{
    userSync: {
      userIds: [{
        name: 'openPairId',
        inserter: 'some-domain.com',
        matcher: 'another-domain.com',
        params: {
          liveramp: {
            storageKey: '_lr_pairId'
          },
          habu: {
            storageKey: '_habu_pairId'
          }
       },
    }]
  }
}

Bid Request

{
  "ext": {
    "eids": [
      source: "pair-protocol.com",
      mm: 3,
      inserter: 'some-domain.com',
      matcher: 'another-domain.com',  
      "uids": [
        {
          "id": "0x1234", // using clean room A
          "atype": 3
        },
        {
          "id": "0x456", // using clean room B
          "atype": 3
        }
      ]
    ]
  }
}

[dgirardi]

I think this requires some more logic to be converted into an EID - the userId module expects a string either from decode, or from eids.openPairId.getValue(id) eids.pairId.getValue(id) (because that's what referenced in decode - see other comment below)

From my testing (putting some random data in local storage), this does not generate any EID.

[therevoltingx]

Seems that other modules return a hash in this format, including the original pairId and a few other examples:

Prebid.js/modules/pairIdSystem.js

Line 101 in 2f713dd

return {'id': ids};

Prebid.js/modules/pubProvidedIdSystem.js

Line 56 in 2f713dd

return {id: res};

Prebid.js/modules/sharedIdSystem.js

Line 141 in 2f713dd

return {id: newId, callback: getIdCallback(newId, pixelUrl)};

Prebid.js/modules/publinkIdSystem.js

Line 155 in 2f713dd

return {id: localValue};

I think your test was failing because I was not properly exporting the correct module. Do you mind testing again?

[dgirardi]

Yes, the return value should be an object with id and/or callback. I was referring to the contents of id. But I did miss that it can also be an array of strings, which seems to be true in your case if the test fixtures are realistic.

You're likely correct that the problem was just the module identifier.

The id returned from here is passed through decode and used to generate the EID. If you want to test it without setting up the entire system, you could do something like

const id = {id: ['test-pair-id7', 'test-pair-id8', 'test-pair-id9']} 
// if the above is the return value from `getId`, then the corresponding EIDs are
const eids = createEidsArray(openPairIdSubmodule.decode(id.id), new Map(Object.entries(openPairIdSubmodule.eids)))

With createEidsArray from here

[dgirardi]

I also recommend merging or rebasing with master, there's been quite a few changes to userId since this PR's parent.

[dgirardi]

This should be openPairId - if it's meant to be distinct from the other module - or if they're meant to be mutually exclusive (clashes are not a problem), the EID configuration in this should also use pairId.

[therevoltingx]

@dgirardi I've gone ahead and rebased and addressed your comments. Please review again.

[patmmccann]

@therevoltingx your unit tests are failing; this isnt yet ready for review

[therevoltingx]

@patmmccann my unit tests are passing on my end:

gulp test --modules=openPairIdSystem --file ./test/spec/modules/pairIdSystem_spec.js

What is failing for you?

[therevoltingx]

gulp test seems to fail. do i need to add the submodule manually somewhere, seems to be a problem with loading the submodule within the spec

[patmmccann]

If you click details next to the red x below, it has details on the failed tests

[patmmccann]

gulp test seems to fail. do i need to add the submodule manually somewhere, seems to be a problem with loading the submodule within the spec

Submodules.json

[therevoltingx]

@patmmccann ok i have rebased with latest master and also tests are passing now!

[patmmccann]

can you add changes to .submodules.json?

[patmmccann]

please add coverage on the eid you expect getting formed

[therevoltingx]

@patmmccann ok i've added a test for createEidsArray this is similar to what i saw in other ID modules. If this is not the test you were looking for please link me to a similar test in user module.

Thanks.