Added code to support pre configured variables, #PG-3109

matomo-org · Nov 27, 2023 · 9b5f70d · 9b5f70d
1 parent bb04c30
commit 9b5f70d
Show file tree

Hide file tree

Showing 35 changed files with 120 additions and 59 deletions.
diff --git a/Context/BaseContext.php b/Context/BaseContext.php
@@ -160,6 +160,23 @@ protected function generatePublicContainer($container, $release)
         return $containerJs;
     }
 
+    public function getPreConfiguredVariablesJSCodeResponse($context)
+    {
+        $response = ['keys' => [], 'values' => []];
+        $preConfiguredVariables = $this->variablesProvider->getPreConfiguredVariables();
+        foreach ($preConfiguredVariables as $variable) {
+            if (method_exists($variable, 'getDataLayerVariableJs')) {
+                $response['keys'][] = '{{' . $variable->getId() . '}}';
+                $response['values'][] = $variable->getDataLayerVariableJs();
+            } else if (method_exists($variable, 'loadTemplate')) {
+                $response['keys'][] = '{{' . $variable->getId() . '}}';
+                $response['values'][] = '(function(){' . $variable->loadTemplate($context, $variable, true) . '})()';
+            }
+        }
+
+        return $response;
+    }
+
     private function parametersToVariableJs($container, $entity)
     {
         if (!empty($entity['name'])) {

diff --git a/Context/BaseContext/TemplateLocator.php b/Context/BaseContext/TemplateLocator.php
@@ -93,4 +93,16 @@ public function loadVariableTemplate($variable, $contextId)
         }
     }
 
+    public function updateVariableTemplate($methodName, $template)
+    {
+        $this->templateFunctions[$methodName] = $template;
+    }
+
+    public function getVariableTemplate($methodName)
+    {
+        if ($this->templateFunctions[$methodName]) {
+            return $this->templateFunctions[$methodName];
+        }
+    }
+
 }
diff --git a/Context/WebContext.php b/Context/WebContext.php
@@ -89,6 +89,7 @@ public function generate($container)
         }
 
         $baseJs = $this->javaScriptTagManagerLoader->getJavaScriptContent();
+        $preconfiguredVariablesResponse = $this->getPreConfiguredVariablesJSCodeResponse(self::ID);
 
         foreach ($environments as $environment) {
             $environmentId = $environment['id'];
@@ -144,6 +145,10 @@ public function generate($container)
             foreach ($containerJs['variables'] as &$variable) {
                 $variable['Variable'] = $this->templateLocator->loadVariableTemplate($variable, self::ID);
                 $variable['parameters'] = $this->addVariableTemplateToParameters($variable['parameters']);
+                if (!empty($variable['parameters']['jsFunction']) && strpos($variable['parameters']['jsFunction'], '{{')!==FALSE) {
+                    $variable['parameters']['jsFunction'] = str_replace($preconfiguredVariablesResponse['keys'], $preconfiguredVariablesResponse['values'], $variable['parameters']['jsFunction']);
+                    $this->templateLocator->updateVariableTemplate($variable['Variable'], str_replace($preconfiguredVariablesResponse['keys'], $preconfiguredVariablesResponse['values'], $this->templateLocator->getVariableTemplate($variable['Variable'])));
+                }
 
                 if (!$isPreviewRelease) {
                     $variable['name'] = $variable['type'];

diff --git a/Template/Variable/PreConfigured/BaseDataLayerVariable.php b/Template/Variable/PreConfigured/BaseDataLayerVariable.php
@@ -21,6 +21,14 @@ public function loadTemplate($context, $entity)
         }
     }
 
+    public function getDataLayerVariableJs()
+    {
+        $dataLayerVariableName = $this->getDataLayerVariableName();
+        if ($dataLayerVariableName) {
+            return "TagManager.dataLayer.get('$dataLayerVariableName')";
+        }
+    }
+
     protected function makeDataLayerTemplateMethod($dataLayerKey)
     {
         $js = 'return parameters.container.dataLayer.get("' . $dataLayerKey . '")';

diff --git a/Template/Variable/PreConfigured/BasePreConfiguredVariable.php b/Template/Variable/PreConfigured/BasePreConfiguredVariable.php
@@ -25,7 +25,7 @@ final public function getParameters()
         return [];
     }
 
-    protected function makeReturnTemplateMethod($js)
+    protected function makeReturnTemplateMethod($js, $skipTemplate = false)
     {
         $js = trim($js);
         if (!Common::stringEndsWith($js, ';')) {
@@ -35,6 +35,10 @@ protected function makeReturnTemplateMethod($js)
             $js = 'return ' . $js;
         }
 
+        if ($skipTemplate) {
+            return $js;
+        }
+
         return '(function () { return function (parameters, TagManager) { this.get = function () { ' . $js . '   }; } })();';
     }
 

diff --git a/Template/Variable/PreConfigured/BrowserLanguageVariable.php b/Template/Variable/PreConfigured/BrowserLanguageVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_DEVICE;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('navigator.language');
+                return $this->makeReturnTemplateMethod('navigator.language', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/ContainerIdVariable.php b/Template/Variable/PreConfigured/ContainerIdVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_CONTAINER_INFO;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.container.id');
+                return $this->makeReturnTemplateMethod('parameters.container.id', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/ContainerRevisionVariable.php b/Template/Variable/PreConfigured/ContainerRevisionVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_CONTAINER_INFO;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.container.revision');
+                return $this->makeReturnTemplateMethod('parameters.container.revision', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/ContainerVersionVariable.php b/Template/Variable/PreConfigured/ContainerVersionVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_CONTAINER_INFO;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.container.versionName');
+                return $this->makeReturnTemplateMethod('parameters.container.versionName', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/DnsLookupTimeVariable.php b/Template/Variable/PreConfigured/DnsLookupTimeVariable.php
@@ -16,11 +16,11 @@ public function getCategory()
         return self::CATEGORY_PERFORMANCE;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod("TagManager.window.getPerformanceTiming('domainLookupEnd') - TagManager.window.getPerformanceTiming('domainLookupStart')");
+                return $this->makeReturnTemplateMethod("TagManager.window.getPerformanceTiming('domainLookupEnd') - TagManager.window.getPerformanceTiming('domainLookupStart')", $skipTemplate);
         }
     }
 }
diff --git a/Template/Variable/PreConfigured/EnvironmentVariable.php b/Template/Variable/PreConfigured/EnvironmentVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_CONTAINER_INFO;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.container.environment');
+                return $this->makeReturnTemplateMethod('parameters.container.environment', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/IsoDateVariable.php b/Template/Variable/PreConfigured/IsoDateVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_DATE;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('new Date().toISOString()');
+                return $this->makeReturnTemplateMethod('new Date().toISOString()', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/LocalDateVariable.php b/Template/Variable/PreConfigured/LocalDateVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_DATE;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('new Date().toDateString()');
+                return $this->makeReturnTemplateMethod('new Date().toDateString()', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/LocalHourVariable.php b/Template/Variable/PreConfigured/LocalHourVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_DATE;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('new Date().getHours()');
+                return $this->makeReturnTemplateMethod('new Date().getHours()', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/LocalTimeVariable.php b/Template/Variable/PreConfigured/LocalTimeVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_DATE;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('new Date().toTimeString()');
+                return $this->makeReturnTemplateMethod('new Date().toTimeString()', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/PageHashVariable.php b/Template/Variable/PreConfigured/PageHashVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_PAGE_VARIABLES;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('String(parameters.window.location.hash).replace("#", "")');
+                return $this->makeReturnTemplateMethod('String(parameters.window.location.hash).replace("#", "")', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/PageHostnameVariable.php b/Template/Variable/PreConfigured/PageHostnameVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_PAGE_VARIABLES;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.window.location.hostname');
+                return $this->makeReturnTemplateMethod('parameters.window.location.hostname', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/PageLoadTimeTotal.php b/Template/Variable/PreConfigured/PageLoadTimeTotal.php
@@ -16,11 +16,11 @@ public function getCategory()
         return self::CATEGORY_PERFORMANCE;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod("TagManager.window.getPerformanceTiming('loadEventEnd') - TagManager.window.getPerformanceTiming('navigationStart')");
+                return $this->makeReturnTemplateMethod("TagManager.window.getPerformanceTiming('loadEventEnd') - TagManager.window.getPerformanceTiming('navigationStart')", $skipTemplate);
         }
     }
 }
diff --git a/Template/Variable/PreConfigured/PageOriginVariable.php b/Template/Variable/PreConfigured/PageOriginVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_PAGE_VARIABLES;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.window.location.origin');
+                return $this->makeReturnTemplateMethod('parameters.window.location.origin', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/PagePathVariable.php b/Template/Variable/PreConfigured/PagePathVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_PAGE_VARIABLES;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.window.location.pathname');
+                return $this->makeReturnTemplateMethod('parameters.window.location.pathname', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/PageRenderTimeVariable.php b/Template/Variable/PreConfigured/PageRenderTimeVariable.php
@@ -16,11 +16,11 @@ public function getCategory()
         return self::CATEGORY_PERFORMANCE;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod("TagManager.window.getPerformanceTiming('domComplete') - TagManager.window.getPerformanceTiming('domLoading')");
+                return $this->makeReturnTemplateMethod("TagManager.window.getPerformanceTiming('domComplete') - TagManager.window.getPerformanceTiming('domLoading')", $skipTemplate);
         }
     }
 }
diff --git a/Template/Variable/PreConfigured/PageTitleVariable.php b/Template/Variable/PreConfigured/PageTitleVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_PAGE_VARIABLES;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.document.title');
+                return $this->makeReturnTemplateMethod('parameters.document.title', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/PageUrlVariable.php b/Template/Variable/PreConfigured/PageUrlVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_PAGE_VARIABLES;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.window.location.href');
+                return $this->makeReturnTemplateMethod('parameters.window.location.href', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/PreviewModeVariable.php b/Template/Variable/PreConfigured/PreviewModeVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_CONTAINER_INFO;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.container.environment === "preview" ? "1" : "0"');
+                return $this->makeReturnTemplateMethod('parameters.container.environment === "preview" ? "1" : "0"', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/RandomNumberVariable.php b/Template/Variable/PreConfigured/RandomNumberVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_UTILITIES;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('Math.floor(Math.random() * 20000000000)');
+                return $this->makeReturnTemplateMethod('Math.floor(Math.random() * 20000000000)', $skipTemplate);
         }
     }
 

diff --git a/Template/Variable/PreConfigured/ReferrerVariable.php b/Template/Variable/PreConfigured/ReferrerVariable.php
@@ -17,11 +17,11 @@ public function getCategory()
         return self::CATEGORY_PAGE_VARIABLES;
     }
 
-    public function loadTemplate($context, $entity)
+    public function loadTemplate($context, $entity, $skipTemplate = false)
     {
         switch ($context) {
             case WebContext::ID:
-                return $this->makeReturnTemplateMethod('parameters.document.referrer');
+                return $this->makeReturnTemplateMethod('parameters.document.referrer', $skipTemplate);
         }
     }