Added support for data elements to reference other data elements.

adobe · Mar 17, 2018 · c5fbf32 · c5fbf32
1 parent 23a8f58
commit c5fbf32
Show file tree

Hide file tree

Showing 6 changed files with 204 additions and 37 deletions.
diff --git a/src/__tests__/createGetDataElementValue.test.js b/src/__tests__/createGetDataElementValue.test.js
@@ -16,14 +16,18 @@ var injectCreateGetDataElementValue = require('inject-loader!../createGetDataEle
 
 describe('function returned by createGetDataElementValue', function() {
   var logger;
+  var replaceTokens;
   var getInjectedCreateGetDataElementValue = function(mocks) {
     mocks = mocks || {};
     mocks['./logger'] = logger;
     return injectCreateGetDataElementValue(mocks);
   };
 
   beforeEach(function() {
-    logger = jasmine.createSpyObj('logger', ['log', 'error']);;
+    logger = jasmine.createSpyObj('logger', ['log', 'error']);
+    replaceTokens = function(settings) {
+      return settings;
+    };
   });
 
   it('returns a data element value using data element settings', function() {
@@ -43,8 +47,12 @@ describe('function returned by createGetDataElementValue', function() {
       };
     };
     var undefinedVarsReturnEmpty = false;
-    var getDataElementValue =
-      createGetDataElementValue(moduleProvider, getDataElementDefinition, undefinedVarsReturnEmpty);
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
     var value = getDataElementValue('testDataElement');
 
     expect(value).toBe('bar');
@@ -73,8 +81,12 @@ describe('function returned by createGetDataElementValue', function() {
       };
     };
     var undefinedVarsReturnEmpty = false;
-    var getDataElementValue =
-      createGetDataElementValue(moduleProvider, getDataElementDefinition, undefinedVarsReturnEmpty);
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
     getDataElementValue('testDataElement');
 
     expect(dataElementSafe.setValue).toHaveBeenCalledWith('testDataElement', 'visitor', 'bar');
@@ -100,8 +112,12 @@ describe('function returned by createGetDataElementValue', function() {
       };
     };
     var undefinedVarsReturnEmpty = false;
-    var getDataElementValue =
-      createGetDataElementValue(moduleProvider, getDataElementDefinition, undefinedVarsReturnEmpty);
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
     var value = getDataElementValue('testDataElement');
 
     expect(value).toBe('cleaned:bar');
@@ -126,8 +142,12 @@ describe('function returned by createGetDataElementValue', function() {
       };
     };
     var undefinedVarsReturnEmpty = false;
-    var getDataElementValue =
-      createGetDataElementValue(moduleProvider, getDataElementDefinition, undefinedVarsReturnEmpty);
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
     var value = getDataElementValue('testDataElement');
 
     expect(value).toBe('cleaned:bar');
@@ -151,8 +171,12 @@ describe('function returned by createGetDataElementValue', function() {
       };
     };
     var undefinedVarsReturnEmpty = true;
-    var getDataElementValue =
-      createGetDataElementValue(moduleProvider, getDataElementDefinition, undefinedVarsReturnEmpty);
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
     var value = getDataElementValue('testDataElement');
 
     expect(value).toBe('');
@@ -164,8 +188,12 @@ describe('function returned by createGetDataElementValue', function() {
     var moduleProvider = {};
     var getDataElementDefinition = function() {};
     var undefinedVarsReturnEmpty = false;
-    var getDataElementValue =
-      createGetDataElementValue(moduleProvider, getDataElementDefinition, undefinedVarsReturnEmpty);
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
     var value = getDataElementValue('testDataElement');
 
     expect(value).toBe(null);
@@ -192,8 +220,12 @@ describe('function returned by createGetDataElementValue', function() {
       };
     };
     var undefinedVarsReturnEmpty = false;
-    var getDataElementValue =
-      createGetDataElementValue(moduleProvider, getDataElementDefinition, undefinedVarsReturnEmpty);
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
     var value = getDataElementValue('testDataElement');
 
     expect(value).toBe('cachedValue');
@@ -222,8 +254,12 @@ describe('function returned by createGetDataElementValue', function() {
         };
       };
       var undefinedVarsReturnEmpty = false;
-      var getDataElementValue = createGetDataElementValue(moduleProvider,
-        getDataElementDefinition, undefinedVarsReturnEmpty);
+      var getDataElementValue = createGetDataElementValue(
+        moduleProvider,
+        getDataElementDefinition,
+        replaceTokens,
+        undefinedVarsReturnEmpty
+      );
       var value = getDataElementValue('testDataElement');
 
       expect(value).toBe('cachedValue');
@@ -245,8 +281,12 @@ describe('function returned by createGetDataElementValue', function() {
         };
       };
       var undefinedVarsReturnEmpty = false;
-      var getDataElementValue = createGetDataElementValue(moduleProvider,
-        getDataElementDefinition, undefinedVarsReturnEmpty);
+      var getDataElementValue = createGetDataElementValue(
+        moduleProvider,
+        getDataElementDefinition,
+        replaceTokens,
+        undefinedVarsReturnEmpty
+      );
       var value = getDataElementValue('testDataElement');
 
       expect(value).toBe('defaultValue');
@@ -268,8 +308,12 @@ describe('function returned by createGetDataElementValue', function() {
         };
       };
       var undefinedVarsReturnEmpty = false;
-      var getDataElementValue = createGetDataElementValue(moduleProvider,
-        getDataElementDefinition, undefinedVarsReturnEmpty);
+      var getDataElementValue = createGetDataElementValue(
+        moduleProvider,
+        getDataElementDefinition,
+        replaceTokens,
+        undefinedVarsReturnEmpty
+      );
       var value = getDataElementValue('testDataElement');
 
       expect(value).toBe('');
@@ -293,8 +337,12 @@ describe('function returned by createGetDataElementValue', function() {
         };
       };
       var undefinedVarsReturnEmpty = false;
-      var getDataElementValue = createGetDataElementValue(moduleProvider,
-        getDataElementDefinition, undefinedVarsReturnEmpty);
+      var getDataElementValue = createGetDataElementValue(
+        moduleProvider,
+        getDataElementDefinition,
+        replaceTokens,
+        undefinedVarsReturnEmpty
+      );
       var value = getDataElementValue('testDataElement');
 
       expect(value).toEqual(dataElementValue);
@@ -319,8 +367,12 @@ describe('function returned by createGetDataElementValue', function() {
       };
     };
     var undefinedVarsReturnEmpty = false;
-    var getDataElementValue = createGetDataElementValue(moduleProvider, 
-      getDataElementDefinition, undefinedVarsReturnEmpty);
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
     var value = getDataElementValue('testDataElement');
 
     expect(value).toBe('bar');
@@ -343,13 +395,52 @@ describe('function returned by createGetDataElementValue', function() {
       };
     };
     var undefinedVarsReturnEmpty = false;
-    var getDataElementValue = createGetDataElementValue(moduleProvider, 
-      getDataElementDefinition, undefinedVarsReturnEmpty);
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
     var value = getDataElementValue('testDataElement');
 
     expect(value).toBe('bar');
   });
 
+  it('replaces tokens in settings object', function() {
+    var createGetDataElementValue = getInjectedCreateGetDataElementValue();
+    var moduleProvider = {
+      getModuleExports: function() {
+        return function(settings) {
+          return settings.foo;
+        };
+      }
+    };
+    var getDataElementDefinition = function() {
+      return {
+        settings: {
+          foo: '%bar%'
+        }
+      };
+    };
+
+    var replaceTokens = function() {
+      return {
+        foo: 'valueOfBar'
+      };
+    };
+
+    var undefinedVarsReturnEmpty = false;
+    var getDataElementValue = createGetDataElementValue(
+      moduleProvider,
+      getDataElementDefinition,
+      replaceTokens,
+      undefinedVarsReturnEmpty
+    );
+    var value = getDataElementValue('testDataElement');
+
+    expect(value).toBe('valueOfBar');
+  });
+
   describe('error handling', function() {
     it('logs an error when retrieving data element module exports fails', function() {
       var createGetDataElementValue =  getInjectedCreateGetDataElementValue();
@@ -365,8 +456,12 @@ describe('function returned by createGetDataElementValue', function() {
         };
       };
       var undefinedVarsReturnEmpty = false;
-      var getDataElementValue = createGetDataElementValue(moduleProvider, 
-        getDataElementDefinition, undefinedVarsReturnEmpty);
+      var getDataElementValue = createGetDataElementValue(
+        moduleProvider,
+        getDataElementDefinition,
+        replaceTokens,
+        undefinedVarsReturnEmpty
+      );
       var value = getDataElementValue('testDataElement');
 
       expect(value).toBeUndefined();
@@ -392,8 +487,12 @@ describe('function returned by createGetDataElementValue', function() {
         };
       };
       var undefinedVarsReturnEmpty = false;
-      var getDataElementValue = createGetDataElementValue(moduleProvider, 
-        getDataElementDefinition, undefinedVarsReturnEmpty);
+      var getDataElementValue = createGetDataElementValue(
+        moduleProvider,
+        getDataElementDefinition,
+        replaceTokens,
+        undefinedVarsReturnEmpty
+      );
       var value = getDataElementValue('testDataElement');
 
       expect(value).toBeUndefined();
@@ -417,8 +516,12 @@ describe('function returned by createGetDataElementValue', function() {
         };
       };
       var undefinedVarsReturnEmpty = false;
-      var getDataElementValue = createGetDataElementValue(moduleProvider, 
-        getDataElementDefinition, undefinedVarsReturnEmpty);
+      var getDataElementValue = createGetDataElementValue(
+        moduleProvider,
+        getDataElementDefinition,
+        replaceTokens,
+        undefinedVarsReturnEmpty
+      );
       var value = getDataElementValue('testDataElement');
 
       expect(value).toBeUndefined();

diff --git a/src/__tests__/createReplaceTokens.test.js b/src/__tests__/createReplaceTokens.test.js
@@ -11,17 +11,23 @@
  ****************************************************************************************/
 
 'use strict';
-var createReplaceTokens = require('../createReplaceTokens');
+var injectCreateReplaceTokens = require('inject-loader!../createReplaceTokens');
 
 describe('function returned by replaceTokens', function() {
   var isVar;
   var getVar;
   var undefinedVarsReturnEmpty;
+  var logger;
+  var createReplaceTokens;
 
   beforeEach(function() {
+    logger = jasmine.createSpyObj('logger', ['error']);
     isVar = function() { return true; };
     getVar = function() { return null; };
     undefinedVarsReturnEmpty = false;
+    createReplaceTokens = injectCreateReplaceTokens({
+      './logger': logger
+    });
   });
 
   it('replaces nested tokens', function() {
@@ -101,4 +107,29 @@ describe('function returned by replaceTokens', function() {
     var fn = function() {};
     expect(replaceTokens(fn)).toBe(fn);
   });
+
+  it('handles recursive data element references', function() {
+    var replaceTokens;
+
+    var de1Settings = {
+      foo: '%de2%'
+    };
+
+    var de2Settings = {
+      foo: '%de1%'
+    };
+
+    getVar = function(variableName) {
+      var result = replaceTokens(variableName === 'de1' ? de1Settings : de2Settings);
+      return result.foo;
+    };
+
+    replaceTokens = createReplaceTokens(isVar, getVar, undefinedVarsReturnEmpty);
+
+    expect(replaceTokens(de1Settings)).toEqual({
+      foo: '%de1%'
+    });
+    expect(logger.error).toHaveBeenCalledWith('Data element circular reference detected: ' +
+      'de2 -> de1 -> de2 -> de1 -> de2 -> de1 -> de2 -> de1 -> de2 -> de1 -> de2');
+  });
 });
diff --git a/src/__tests__/index.test.js b/src/__tests__/index.test.js
@@ -96,6 +96,7 @@ describe('index', function() {
     expect(createGetDataElementValue).toHaveBeenCalledWith(
       moduleProvider,
       jasmine.any(Function),
+      jasmine.any(Function),
       true
     );
   });

diff --git a/src/createGetDataElementValue.js b/src/createGetDataElementValue.js
@@ -26,6 +26,7 @@ var isDataElementValuePresent = function(value) {
 module.exports = function(
   moduleProvider,
   getDataElementDefinition,
+  replaceTokens,
   undefinedVarsReturnEmpty
 ) {
   return function(name) {
@@ -53,7 +54,7 @@ module.exports = function(
     var value;
 
     try {
-      value = moduleExports(dataDef.settings);
+      value = moduleExports(replaceTokens(dataDef.settings));
     } catch (e) {
       logger.error(getErrorMessage(dataDef, name, e.message, e.stack));
       return;