Expose targeting resolved_ids in resolved event (#213)

Author: zapo

lib/core/events/cache-refresh.test.ts

@@ -8,6 +8,7 @@ const mock_configs = {
 } as ResolvedConfig;
 
 const mock_response: TargetingResponse = {
+  resolved_ids: ["resolved-id"],
   ortb2: {
     user: {
       eids: [
@@ -33,6 +34,7 @@ describe("sendTargetingUpdateEvent", () => {
 
     expect(event.detail.instance).toBe("my-node");
     expect(event.detail.resolved).toBe(true);
+    expect(event.detail.resolvedIDs).toEqual(["resolved-id"]);
     expect(event.detail.ortb2).toEqual(mock_response.ortb2);
     expect([...event.detail.provenance]).toEqual(["matcher-a", "matcher-b"]);
   });
@@ -68,4 +70,22 @@ describe("sendTargetingUpdateEvent", () => {
 
     expect(event.detail.resolved).toBe(false); // false if no eids
   });
+
+  it("doesnt expose resolvedID when absent ", async () => {
+    mock_response.ortb2.user = {};
+
+    const eventPromise = new Promise<CustomEvent>((resolve) => {
+      window.addEventListener("optable-targeting:change", (event) => {
+        resolve(event as CustomEvent);
+      });
+    });
+
+    const { resolved_ids: _ignore, ...response } = mock_response;
+
+    sendTargetingUpdateEvent(mock_configs, response);
+
+    const event = await eventPromise;
+
+    expect(event.detail.resolvedIDs).toEqual([]);
+  });
 });

lib/core/events/cache-refresh.ts

@@ -11,6 +11,7 @@ function sendTargetingUpdateEvent(config: ResolvedConfig, response: TargetingRes
       detail: {
         instance: config.node || config.host,
         resolved: !!response.ortb2?.user?.eids?.length,
+        resolvedIDs: response.resolved_ids ?? [],
         ortb2: response.ortb2,
         provenance: new Set(matchers),
       },

lib/edge/targeting.ts

@@ -30,6 +30,8 @@ type TargetingResponse = {
   audience?: AudienceIdentifiers[];
   user?: UserIdentifiers[];
   ortb2: { user: ortb2.User };
+  // Identifiers that matched and were used to generate the targeting response.
+  resolved_ids?: string[];
 };
 
 async function Targeting(config: ResolvedConfig, req: TargetingRequest): Promise<TargetingResponse> {