fiftyone.pipeline.cloudrequestengine 4.5.46 → 4.5.48

package/cloudRequestEngine.js

@@ -422,10 +422,16 @@ class CloudRequestEngine extends Engine {
    */
   addQueryData (flowData, queryData, allEvidence, evidence) {
     for (const [evidenceKey, evidenceValue] of Object.entries(evidence)) {
-      // Get the key parts
-      const evidenceKeyParts = evidenceKey.split('.');
-      const prefix = evidenceKeyParts[0];
-      const suffix = evidenceKeyParts[1];
+      // Split the key at its first dot only. The prefix is the part before
+      // it and the name sent to the cloud is everything after it, so a name
+      // that itself contains a dot, such as id.usage, is sent whole.
+      const separatorIndex = evidenceKey.indexOf('.');
+      const prefix = separatorIndex >= 0
+        ? evidenceKey.substring(0, separatorIndex)
+        : evidenceKey;
+      const suffix = separatorIndex >= 0
+        ? evidenceKey.substring(separatorIndex + 1)
+        : evidenceKey;
 
       // Check and add the evidence to the query parameters.
       if ((suffix in queryData) === false) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.pipeline.cloudrequestengine",
-  "version": "4.5.46",
+  "version": "4.5.48",
   "description": "Cloud request engine for the 51Degrees Pipeline API",
   "keywords": [
     "51degrees",

package/tests/cloudRequestEngine.test.js

@@ -208,3 +208,60 @@ each([
     const result = engine.getContent(data);
     expect(result['User-Agent']).toBe(expectedValue);
   });
+
+/**
+ * Test that an evidence name which itself contains a dot keeps every part
+ * after the prefix. The cloud service reads the 51Did usage from id.usage,
+ * so evidence named query.id.usage must be sent as id.usage and not cut
+ * down to id, otherwise the service never creates a 51Did.
+ */
+each([
+  ['query.id.usage', 'standard', 'id.usage'],
+  ['header.id.usage', 'standard', 'id.usage'],
+  ['query.id.email', 'someone@example.com', 'id.email'],
+  ['server.client-ip', '81.2.69.142', 'client-ip'],
+  ['query.user-agent', 'iPhone', 'user-agent']
+])
+  .test('get content keeps the full name - %s', (key, value, expectedName) => {
+    const client = new MockRequestClient();
+    const engine = new CloudRequestEngine({
+      resourceKey: testResourceKey,
+      requestClient: client
+    });
+
+    const pipeline = new PipelineBuilder()
+      .add(engine)
+      .build();
+
+    const data = pipeline.createFlowData();
+    data.evidence.add(key, value);
+
+    const result = engine.getContent(data);
+    expect(result).toStrictEqual({ [expectedName]: value });
+  });
+
+/**
+ * Test that two dotted names which share their first part after the prefix
+ * are sent as two separate parameters rather than one overwriting the other.
+ */
+test('get content keeps dotted names apart', () => {
+  const client = new MockRequestClient();
+  const engine = new CloudRequestEngine({
+    resourceKey: testResourceKey,
+    requestClient: client
+  });
+
+  const pipeline = new PipelineBuilder()
+    .add(engine)
+    .build();
+
+  const data = pipeline.createFlowData();
+  data.evidence.add('query.id.usage', 'standard');
+  data.evidence.add('query.id.email', 'someone@example.com');
+
+  const result = engine.getContent(data);
+  expect(result).toStrictEqual({
+    'id.usage': 'standard',
+    'id.email': 'someone@example.com'
+  });
+});

package/tests/integration.test.js

@@ -106,3 +106,46 @@ test('post with sequence evidence', done => {
     done();
   });
 });
+
+/**
+ * Verify that a server using the engine gets a 51Did on its first call.
+ * The engine sends the end user's User-Agent as evidence and never as its
+ * own HTTP User-Agent header, so the cloud service does not treat the call
+ * as a browser page that still has snippets to run. The usage is sent as
+ * query.id.usage, whose name contains a dot and must reach the service
+ * whole. This is an integration test that uses the live cloud service. It
+ * is skipped when the resource key does not include the fodid product.
+ */
+test('51Did on the first call', async () => {
+  if (myResourceKey === '!!YOUR_RESOURCE_KEY!!') {
+    fail('You need to supply a resource key in the ' +
+        '_51DEGREES_RESOURCE_KEY environment variable.');
+  }
+  const cloud = new CloudRequestEngine({ resourceKey: myResourceKey });
+  const pipeline = new PipelineBuilder()
+    .add(cloud)
+    .build();
+  await cloud.ready();
+  // The product name keeps the case the service gives it, such as FODid.
+  const fodidProduct = Object.entries(cloud.flowElementProperties)
+    .find(([name]) => name.toLowerCase() === 'fodid');
+  if (!fodidProduct || !fodidProduct[1].idprobglobal) {
+    console.warn('The resource key does not include ' +
+      'fodid.idprobglobal, so the 51Did check was skipped.');
+    return;
+  }
+
+  const data = pipeline.createFlowData();
+  data.evidence.add('header.user-agent', 'Mozilla/5.0 (Windows NT 10.0; ' +
+    'Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) ' +
+    'Chrome/120.0.0.0 Safari/537.36');
+  data.evidence.add('server.client-ip', '81.2.69.142');
+  data.evidence.add('query.id.usage', 'standard');
+  await data.process();
+
+  const fodid = JSON.parse(data.cloud.cloud).fodid;
+  expect(fodid).toBeDefined();
+  expect(fodid.idprobglobalnullreason).toBeUndefined();
+  expect(typeof fodid.idprobglobal).toBe('string');
+  expect(fodid.idprobglobal.length).toBeGreaterThan(0);
+});

package/tests/requestClient.test.js

@@ -212,3 +212,35 @@ test('post - data', done => {
     },
     done);
 });
+
+// The cloud service treats a request whose own User-Agent header names a
+// browser as a browser page, and such a page gets no 51Did until it has run
+// its snippets. The end user's User-Agent must therefore only travel as the
+// user-agent parameter in the body and never as the HTTP User-Agent header.
+each([
+  ['post', (client, url, data) => client.post(url, data)],
+  ['get', (client, url) => client.get(url)]
+])
+  .test('%s - end user User-Agent is not sent as the header', (name, send, done) => {
+    const browserUserAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) ' +
+      'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 ' +
+      'Safari/537.36';
+    const port = POST_PORT;
+    let header;
+    server.addListener('request', (req, res) => {
+      header = req.headers['user-agent'];
+      res.writeHead(200);
+      res.end('{}');
+    });
+    server.listen(port, () => {
+      send(
+        new RequestClient(),
+        `http://localhost:${port}`,
+        { 'user-agent': browserUserAgent })
+        .then(() => {
+          expect(header === undefined || !header.includes('Mozilla'))
+            .toBe(true);
+        })
+        .then(() => done(), done);
+    });
+  });