NovatiqidSystem UserId Module: Fix async json response (prebid#9601)

* Novatiq snowflake userId submodule

Novatiq snowflake userId submodule initial release

* change request updates

added novatiq info /modules/userId/userId.md
added novatiq info /modules/userId/eids.md
added novatiq eids /modules/userId/eids.js
added novatiq module in /modules/.submodules.json
removed unnecessary value from getId response

* Update novatiqIdSystem_spec.js

removed unnecessary srcid value

* Update novatiqIdSystem.md

Novatiq ID System: updated novatiq snowflake ID description

* use the sharedId if available and configured

* updated docs

* test changes

* defensive code not required

* Use the prebid storage manager instead of using native functions

* doc changes

* trailing spaces

* Allow configuration of the sync URL and to allow callbacks for specific custom partner integrations

* update documentation

* attempt to fix firefox test timeout

* include the AIB Vendor Id

* fix async response

---------

Co-authored-by: novatiq <[email protected]>

Author: 2 people

modules/novatiqIdSystem.js

@@ -35,6 +35,16 @@ export const novatiqIdSubmodule = {
         snowflake: novatiqId
       }
     };
+
+    if (novatiqId.syncResponse !== undefined) {
+      responseObj.novatiq.ext = {};
+      responseObj.novatiq.ext.syncResponse = novatiqId.syncResponse;
+    }
+
+    if (typeof config != 'undefined' && typeof config.params !== 'undefined' && typeof config.params.removeAdditionalInfo !== 'undefined' && config.params.removeAdditionalInfo === true) {
+      delete responseObj.novatiq.snowflake.syncResponse;
+    }
+
     return responseObj;
   },
 
@@ -120,7 +130,7 @@ export const novatiqIdSubmodule = {
   getNovatiqId(urlParams) {
     // standard uuid format
     let uuidFormat = [1e7] + -1e3 + -4e3 + -8e3 + -1e11;
-    if (urlParams.useStandardUuid == false) {
+    if (urlParams.useStandardUuid === false) {
       // novatiq standard uuid(like) format
       uuidFormat = uuidFormat + 1e3;
     }

modules/userId/eids.js

@@ -250,10 +250,13 @@ export const USER_IDS_CONFIG = {
   // Novatiq Snowflake
   'novatiq': {
     getValue: function(data) {
-      return data.snowflake
+      if (data.snowflake.id === undefined) {
+        return data.snowflake;
+      }
+
+      return data.snowflake.id;
     },
     source: 'novatiq.com',
-    atype: 1
   },
 
   'uid2': {

test/spec/modules/novatiqIdSystem_spec.js

@@ -138,16 +138,31 @@ describe('novatiqIdSystem', function () {
   });
 
   describe('decode', function() {
-    it('should log message if novatiqId has wrong format', function() {
+    it('should return the same novatiqId as passed in if not async', function() {
       const novatiqId = '81b001ec-8914-488c-a96e-8c220d4ee08895ef';
       const response = novatiqIdSubmodule.decode(novatiqId);
       expect(response.novatiq.snowflake).to.have.length(40);
     });
 
-    it('should log message if novatiqId has wrong format', function() {
-      const novatiqId = '81b001ec-8914-488c-a96e-8c220d4ee08895ef';
+    it('should change the result format if async', function() {
+      let novatiqId = {};
+      novatiqId.id = '81b001ec-8914-488c-a96e-8c220d4ee08895ef';
+      novatiqId.syncResponse = 2;
       const response = novatiqIdSubmodule.decode(novatiqId);
-      expect(response.novatiq.snowflake).should.be.not.empty;
+      expect(response.novatiq.ext.syncResponse).should.be.not.empty;
+      expect(response.novatiq.snowflake.id).should.be.not.empty;
+      expect(response.novatiq.snowflake.syncResponse).should.be.not.empty;
+    });
+
+    it('should remove syncResponse if removeAdditionalInfo true', function() {
+      let novatiqId = {};
+      novatiqId.id = '81b001ec-8914-488c-a96e-8c220d4ee08895ef';
+      novatiqId.syncResponse = 2;
+      var config = {params: {removeAdditionalInfo: true}};
+      const response = novatiqIdSubmodule.decode(novatiqId, config);
+      expect(response.novatiq.ext.syncResponse).should.be.not.empty;
+      expect(response.novatiq.snowflake.id).should.be.not.empty;
+      should.equal(response.novatiq.snowflake.syncResponse, undefined);
     });
   });
 })