Merge pull request #6 from microsoft/service_alignment_updates

Update polyfill to align with prototype service updates.

Polyfill/.gitignore

@@ -0,0 +1,5 @@
+.vs/
+Release/
+bin/
+node_modules/
+obj/

Polyfill/Parakeet Polyfill.njsproj

@@ -31,6 +31,7 @@
     </Content>
   </ItemGroup>
   <ItemGroup>
+    <TypeScriptCompile Include="lib\Geo.ts" />
     <TypeScriptCompile Include="lib\InterestGroups.ts" />
     <TypeScriptCompile Include="lib\AdInterests.ts" />
     <TypeScriptCompile Include="lib\AdProperties.ts" />

Polyfill/Parakeet.Polyfill.ts

@@ -16,6 +16,7 @@ import {
 import { AdProperties } from './lib/AdProperties';
 import { AdTargeting } from './lib/AdTargeting';
 import { AdRequestConfig } from './lib/AdRequestConfig';
+import { Geo } from './lib/Geo';
 
 // Imports for joining interest groups.
 import { AdInterests } from './lib/AdInterests';
@@ -38,6 +39,11 @@ declare global {
     new(other?: AdTargeting): AdTargeting;
   };
 
+  var Geo: {
+    prototype: Geo;
+    new(other?: Geo): Geo;
+  };
+
   var AdRequestConfig: {
     prototype: AdRequestConfig;
     new(other?: AdRequestConfig): AdRequestConfig;
@@ -66,6 +72,10 @@ if (!globalThis.AdTargeting) {
   globalThis.AdTargeting = AdTargeting;
 }
 
+if (!globalThis.Geo) {
+  globalThis.Geo = Geo;
+}
+
 if (!globalThis.AdRequestConfig) {
   globalThis.AdRequestConfig = AdRequestConfig;
 }

Polyfill/Readme.md

@@ -54,6 +54,7 @@ flow:
         - [AdRequestConfig](#adrequestconfig)
         - [AdTargeting](#adtargeting)
         - [AnonymizedSignals](#anonymizedsignals)
+        - [Geo](#geo)
       - [Methods](#methods)
         - [Navigator.createAdRequest](#navigatorcreateadrequest)
         - [Navigator.joinParakeetInterestGroup](#navigatorjoinparakeetinterestgroup)
@@ -184,7 +185,20 @@ export class AdTargeting {
   // contextual signals made available at the time of the request.
   interests?: string[];
   // Geolocation information the requesting site may be aware of.
-  geolocation?: number[];
+  geolocation?: Geo;
+}
+```
+
+###### Geo
+Intended to represent the geolocation data for the desired ad. This is built to
+follow the [OpenRTB](https://developers.google.com/authorized-buyers/rtb/openrtb-guide#geo)
+Geo data format.
+```typescript
+export class Geo {
+  // Latitude from -90.0 to +90.0, where negative is south.
+  lat?: number;
+  // Longitude from -180.0 to +180.0, where negative is west.
+  lon?: number;
 }
 ```
 
@@ -376,10 +390,10 @@ navigator.createAdRequest({
          "Lawn Mowers",
          "Shoes"
       ],
-      "geolocation": [
-         47.6397316,
-         -122.1419026
-      ]
+      "geolocation": {
+        "lat": 47.6397316,
+        "lon": -122.1419026
+      }
    },
    "anonymizedProxiedSignals": [
       "coarse-geolocation",

Polyfill/lib/AdRequestConfig.ts

@@ -68,16 +68,9 @@ export class AdRequestConfig {
   }
 
   toRequestBody(): string {
-    let json = JSON.stringify(this);
-    // Modify our properties to match the service expectations.
-    json = json.replace('proxiedAnonymizingOrigin', 'proxied-anonymizing-origin');
-    json = json.replace('adProperties', 'ad-properties');
-    json = json.replace('publisherCode', 'publisher-code');
-    json = json.replace('publisherAdUnit', 'publisher-ad-unit');
-    json = json.replace('anonymizedProxiedSignals', 'anonymized-proxied-signals');
-    json = json.replace('fallbackSource', 'fallback-source');
-
-    return json;
+    // Currently no special processing is required so we can simply stringify
+    // this object and return as-is.
+    return JSON.stringify(this);
   }
 
   // Stores any joined AdInterests, not setable by callers and will be

Polyfill/lib/AdTargeting.ts

@@ -1,5 +1,7 @@
 // Copyright (C) Microsoft Corporation. All rights reserved.
 
+import { Geo } from './Geo';
+
 export class AdTargeting {
   /**
   * A list of interests specific to a given ad request. These may include
@@ -9,18 +11,18 @@ export class AdTargeting {
   /**
   * Geolocation information the requesting site may be aware of.
   */
-  geolocation?: number[];
+  geolocation?: Geo;
 
   constructor(other?: AdTargeting) {
     if (other) {
       this.interests = Array.isArray(other.interests) ? other.interests.slice() : [];
-      this.geolocation = Array.isArray(other.geolocation) ? other.geolocation.slice() : [];
+      this.geolocation = new Geo(other.geolocation);
     } else {
       this.interests = [];
-      this.geolocation = [];
+      this.geolocation = new Geo();
     }
   }
 }
 
 AdTargeting.prototype.interests = [];
-AdTargeting.prototype.geolocation = [];
+AdTargeting.prototype.geolocation = Geo.prototype;

Polyfill/lib/Geo.ts

@@ -0,0 +1,27 @@
+// Copyright (C) Microsoft Corporation. All rights reserved.
+
+// Representations of relevant Geo fields. This should reflect the OpenRTB
+// schema: https://developers.google.com/authorized-buyers/rtb/openrtb-guide#geo
+export class Geo {
+  /**
+   * Latitude from -90.0 to +90.0, where negative is south.
+   */
+  lat?: number;
+  /**
+   * Longitude from -180.0 to +180.0, where negative is west.
+   */
+  lon?: number;
+
+  constructor(other?: Geo) {
+    if (other) {
+      this.lat = other.lat;
+      this.lon = other.lon;
+    } else {
+      this.lat = undefined;
+      this.lon = undefined;
+    }
+  }
+}
+
+Geo.prototype.lat = undefined;
+Geo.prototype.lon = undefined;

Polyfill/lib/InterestGroups.ts

@@ -92,14 +92,47 @@ export function GetInterestGroups() {
     throw new TypeError("Error retrieving stored interests. Clear localStorage.");
   }
 
+  // We want to generate a format for PARAKEET to be able to process per-reader.
+  // e.g.
+  // reader1: {
+  //   interests: {
+  //     origin1: [interest1, interest2, ...],
+  //     origin2: [interest1, interestA, ...],
+  //   }
+  // },
+  // reader2: {
+  // ...
+
+  let joinedInterests: { [x: string]: { [x: string]: { [x: string]: string[]; }; }; } = {};
   const currentTimeInSeconds = (new Date().getTime() / 1000);
   Object.keys(storedInterests).forEach(function (namespacedInterestGroup) {
     Object.keys(storedInterests[namespacedInterestGroup]["interests"]).forEach(function (interest: string) {
-      if (storedInterests[namespacedInterestGroup]["interests"][interest].expiration <= currentTimeInSeconds) {
-        storedInterests[namespacedInterestGroup]["interests"][interest] = {};
+      // If this specific interest is not yet expired we can add it to our list.
+      if (storedInterests[namespacedInterestGroup]["interests"][interest].expiration > currentTimeInSeconds) {
+        // Make sure to add this for each reader specified.
+        Object.keys(storedInterests[namespacedInterestGroup]["interests"][interest].readers).forEach(function (reader) {
+          const readerName = storedInterests[namespacedInterestGroup]["interests"][interest].readers[reader];
+          // Ensure our root reader node exists.
+          if (!joinedInterests[readerName]) {
+            joinedInterests[readerName] = {};
+          }
+
+          // Ensure we have an 'interests' index to look/add to.
+          if (!joinedInterests[readerName]["interests"]) {
+            joinedInterests[readerName]["interests"] = {};
+          }
+
+          // This may be the first time we're seeing this specific origin, so ensure it is available.
+          if (!joinedInterests[readerName]["interests"][namespacedInterestGroup]) {
+            joinedInterests[readerName]["interests"][namespacedInterestGroup] = [];
+          }
+
+          // Now add this interest within the origin (namespace) for the given reader.
+          joinedInterests[readerName]["interests"][namespacedInterestGroup].push(interest);
+        });
       }
     });
   });
 
-  return storedInterests;
+  return joinedInterests;
 }