feat: max-848 Prebid: setup development harness. max-849: Prebid: Make prebid RTB ORTB request to /bid (#1)

harness](https://mobkoi.atlassian.net/browse/MAX-848)

Set up a local development environment for testing and iterating on
Prebid customization changes.

Sub-tasks:

Install Prebid.js dependencies.

Create a custom Prebid.js Adapter (mobkoiBidAdapter) and build a custom
Prebid.js package to serve locally (the custom Prebid.js package is
available to serve to a local webpage).

Initialize Ad Service Bid endpoint, ensuring it can serve dummy bid
objects to the client.

Initialize Ad Server Ad endpoint to serve dummy ads/creatives that
display on the sample website.

Set up a sample website for end-to-end testing, including page load,
Prebid.js, Ad Service Bid endpoint, returning bids to the front-end, Ad
Server Ad endpoint, and loading ads on the page.

/bid](https://mobkoi.atlassian.net/browse/MAX-849)

Update Prebid.js to create ORTB-formatted bid requests for the /bid
endpoint.

Sub-tasks:

Modify Prebid request formatting to ORTB.

Validate bid responses from /bid with ORTB formatting.

Integrate the new ORTB bid request structure in the /bid endpoint base
on the data provided by Prebid.js.

Create unit tests.

feat: max-852: Prebid: Log bid win to adserver (#3)

> Related PRs https://github.com/mobkoi/adserver/pull/6

adserver](https://mobkoi.atlassian.net/browse/MAX-852)

Implement logging of bid wins directly to the ad server.

Sub-tasks:

Capture winning bid events in the Prebid.js custom adapter in various
steps of biding process.

feat: max-853: Prebid: Log bid loss to adserver (#4)

adserver](https://mobkoi.atlassian.net/browse/MAX-853)

Implement logging of failed bid events for monitoring purposes.

Sub-tasks:

Initialise a Prebid custom analytic adapter.

Capture bid failure events within Prebid.js during various steps of the
bidding process

Initialise the endpoint for receiving bid loss signals.

Logs will log into Grafana, but this will be done in a separate ticket

feat: max-876: Prebid: Analytic Adapter Log debug info to adserver (#5)

> Related PR: https://github.com/mobkoi/adserver/pull/10

adserver](https://mobkoi.atlassian.net/browse/MAX-876)

Add logging for debugging information to assist with monitoring and
troubleshooting.

Sub-tasks

Record events at different stages of bid processing on the client side
via the custom analytic adapter

Save event messages locally on the client.

Tag each message with one of three levels: info, warn, or debug.

feat: writing unit tests for mobkoi adapters (#6)

Co-authored-by: nvkftw <kevin.gallet@mobkoi.com>

updated doc description

added the missing mobkoiBidAdapter md

small fix for our unit test

added intergration with mobkoi getuid and setuid endpoint

double encoded the setuid callback

added mobkoiIdSystem module

got a working smartadserver sync url from provided example

got a working equativ url

before rollback to ajax call for equativ intergration

WIP testing droping pixel in iframe

feat: max-970: Prebid.js Bidder Adapter: Retrieve Adapter Parameters from Bid Configuration Object (#8)

Configuration Object](https://mobkoi.atlassian.net/browse/MAX-970)

At this stage, we are only focused on bid win events, so there is no
need for analytics adapter integration yet. To streamline the
publisher's configuration for our custom bid adapter integration, we
retrieve adapter parameters directly from the bid configuration object
instead of using "bidderConfiguration."

updated bid adapter doc

wip equativ pixel in an iframe

approvated concept cookie sync work on client side

code tidy up for the working cookie solution

removed the need for cookieName param

matches the backend endpoint name changes

feat: max-956: We need the placement ID from Tag and HB Connector to be past to the AdServer (#9)

the AdServer](https://mobkoi.atlassian.net/browse/MAX-956)

removed unexpected code

transfer the user id to ortb2 request body and set the field to null if not avaiable

fixed a minor bug

enabed consent string

added unit tests for mobkoi ID system module

fixed a minor bug

removed the code that wrapping URL in URL objects. It just make things complicated

fixed the publisher ID in macro issue

clean up branch for offical PR

pass the expiration value when setting storage using the storage manager

updated id system module md

pass expire setting to storage

Author: zeeye

modules/mobkoiIdSystem.js

@@ -0,0 +1,144 @@
+/**
+ * This module adds mobkoiId support to the User ID module
+ * The {@link module:modules/userId} module is required.
+ * @module modules/mobkoiIdSystem
+ * @requires module:modules/userId
+ */
+
+import { submodule } from '../src/hook.js';
+import { getCoreStorageManager } from '../src/storageManager.js';
+import { logError, logInfo, deepAccess, insertUserSyncIframe } from '../src/utils.js';
+
+const GVL_ID = 898;
+const MODULE_NAME = 'mobkoiId';
+export const PROD_AD_SERVER_BASE_URL = 'https://adserver.maximus.mobkoi.com';
+export const EQUATIV_BASE_URL = 'https://sync.smartadserver.com';
+export const EQUATIV_NETWORK_ID = '5290';
+/**
+ * !IMPORTANT: This value must match the value in mobkoiAnalyticsAdapter.js
+ * The name of the parameter that the publisher can use to specify the ad server endpoint.
+ */
+const PARAM_NAME_AD_SERVER_BASE_URL = 'adServerBaseUrl';
+
+export const storage = getCoreStorageManager(MODULE_NAME);
+
+export const mobkoiIdSubmodule = {
+  name: MODULE_NAME,
+
+  decode(value) {
+    return value ? { [MODULE_NAME]: value } : undefined;
+  },
+
+  gvlid: GVL_ID,
+
+  getId(userSyncOptions, gdprConsent) {
+    logInfo('Getting Equativ SAS ID.');
+
+    if (!storage.cookiesAreEnabled()) {
+      logError('Cookies are not enabled. Module will not work.');
+      return {
+        id: null
+      };
+    }
+
+    const storageName = userSyncOptions && userSyncOptions.storage && userSyncOptions.storage.name;
+    if (!storageName) {
+      logError('Storage name is not defined. Module will not work.');
+      return {
+        id: null
+      };
+    }
+
+    const existingId = storage.getCookie(storageName);
+
+    if (existingId) {
+      logInfo(`Found "${storageName}" from local cookie: "${existingId}"`);
+      return { id: existingId };
+    }
+
+    logInfo(`Cannot found "${storageName}" in local cookie with name.`);
+    return {
+      callback: () => {
+        return new Promise((resolve, _reject) => {
+          utils.requestEquativSasId(
+            userSyncOptions,
+            gdprConsent,
+            (sasId) => {
+              if (!sasId) {
+                logError('Equativ SAS ID is empty');
+                resolve({ id: null });
+                return;
+              }
+
+              logInfo(`Fetched Equativ SAS ID: "${sasId}"`);
+              storage.setCookie(storageName, sasId, userSyncOptions.storage.expires);
+              logInfo(`Stored Equativ SAS ID in local cookie with name: "${storageName}"`);
+              resolve({ id: sasId });
+            }
+          );
+        });
+      }
+    };
+  },
+};
+
+submodule('userId', mobkoiIdSubmodule);
+
+export const utils = {
+  requestEquativSasId(syncUserOptions, gdprConsent, onCompleteCallback) {
+    logInfo('Start requesting Equativ SAS ID');
+    const adServerBaseUrl = deepAccess(
+      syncUserOptions,
+      `params.${PARAM_NAME_AD_SERVER_BASE_URL}`) || PROD_AD_SERVER_BASE_URL;
+
+    const equativPixelUrl = utils.buildEquativPixelUrl(syncUserOptions, gdprConsent);
+    logInfo('Equativ SAS ID request URL:', equativPixelUrl);
+
+    const url = adServerBaseUrl + '/pixeliframe?' +
+      'pixelUrl=' + encodeURIComponent(equativPixelUrl) +
+      '&cookieName=sas_uid';
+
+    /**
+     * Listen for messages from the iframe
+     */
+    window.addEventListener('message', function(event) {
+      switch (event.data.type) {
+        case 'MOBKOI_PIXEL_SYNC_COMPLETE':
+          const sasUid = event.data.syncData;
+          logInfo('Parent window Sync completed. SAS ID:', sasUid);
+          onCompleteCallback(sasUid);
+          break;
+        case 'MOBKOI_PIXEL_SYNC_ERROR':
+          logError('Parent window Sync failed:', event.data.error);
+          onCompleteCallback(null);
+          break;
+      }
+    });
+
+    insertUserSyncIframe(url, () => {
+      logInfo('insertUserSyncIframe loaded');
+    });
+
+    // Return the URL for testing purposes
+    return url;
+  },
+
+  /**
+   * Build a pixel URL that will be placed in an iframe to fetch the Equativ SAS ID
+   */
+  buildEquativPixelUrl(syncUserOptions, gdprConsent) {
+    logInfo('Generating Equativ SAS ID request URL');
+    const adServerBaseUrl =
+      deepAccess(
+        syncUserOptions,
+        `params.${PARAM_NAME_AD_SERVER_BASE_URL}`) || PROD_AD_SERVER_BASE_URL;
+
+    const gdprConsentString = gdprConsent && gdprConsent.gdprApplies ? gdprConsent.consentString : '';
+    const smartServerUrl = EQUATIV_BASE_URL + '/getuid?' +
+      `url=` + encodeURIComponent(`${adServerBaseUrl}/getPixel?value=`) + '[sas_uid]' +
+      `&gdpr_consent=${gdprConsentString}` +
+      `&nwid=${EQUATIV_NETWORK_ID}`;
+
+    return smartServerUrl;
+  }
+};

modules/mobkoiIdSystem.md

@@ -0,0 +1,38 @@
+## Mobkoi User ID Submodule
+
+For assistance setting up your module please contact us at platformteam@mobkoi.com.
+
+### Prebid Params
+
+Individual params may be set for the IDx Submodule.
+```
+pbjs.setConfig({
+    userSync: {
+        userIds: [{
+            name: 'mobkoiId',
+            storage: {
+                name : 'mobkoi_uid',
+                type : 'cookie',
+                expires : 30
+            }
+        }]
+    }
+});
+```
+## Parameter Descriptions for the `userSync` Configuration Section
+The below parameters apply only to the Mobkoi integration.
+
+| Param under usersync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | ID of the module - `"mobkoiId"` | `"mobkoiId"` |
+| storage.name | Required | String | The name of the cookie local storage where the user ID will be stored.	 | `"mobkoi_uid"` |
+| storage.type | Required | String | Must be "`cookie`". This is where the results of the user ID will be stored.	| `"cookie"` |
+| storage.expires | Required | Integer | How long (in days) the user ID information will be stored. | `30` |
+
+## Serving the Custom Build Locally
+
+To serve the custom build locally, use the following command:
+
+```sh
+gulp serve-fast --modules=consentManagementTcf,tcfControl,mobkoiBidAdapter,mobkoiIdSystem,userId
+```