Merge pull request #281 from j0k3r/fix/find-replace-string-validation

Ensure `find_string` & `replace_string` size are equal
j0k3r · Jan 7, 2022 · 06b388b · 06b388b
2 parents e1a7b3d + dababcf
commit 06b388b
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 5 deletions.
diff --git a/src/SiteConfig/ConfigBuilder.php b/src/SiteConfig/ConfigBuilder.php
@@ -332,11 +332,6 @@ public function mergeConfig(SiteConfig $currentConfig, SiteConfig $newConfig)
         //      replace_string: <img
         // To fix that issue, we combine find & replace as key & value in one array, we merge them and then rebuild find & replace string in the current config
 
-        // in case of bad configuration
-        if (\count($currentConfig->find_string) !== \count($currentConfig->replace_string)) {
-            return $currentConfig;
-        }
-
         $findReplaceCurrentConfig = array_combine($currentConfig->find_string, $currentConfig->replace_string);
         $findReplaceNewConfig = array_combine($newConfig->find_string, $newConfig->replace_string);
         $findReplaceMerged = array_merge((array) $findReplaceCurrentConfig, (array) $findReplaceNewConfig);
@@ -412,6 +407,14 @@ public function parseLines(array $lines)
             }
         }
 
+        // in case of bad configuration
+        if (\count($config->find_string) !== \count($config->replace_string)) {
+            $this->logger->warning('find_string & replace_string size mismatch, check the site config to fix it', ['find_string' => $config->find_string, 'replace_string' => $config->replace_string]);
+
+            $config->find_string = [];
+            $config->replace_string = [];
+        }
+
         return $config;
     }
 

diff --git a/tests/SiteConfig/ConfigBuilderTest.php b/tests/SiteConfig/ConfigBuilderTest.php
@@ -274,4 +274,26 @@ public function testMergeConfigMultipleTimes(): void
         $this->assertCount(2, $config4->find_string);
         $this->assertCount(2, $config4->replace_string);
     }
+
+    public function testCleanupFindReplaceString(): void
+    {
+        $logger = new Logger('foo');
+        $handler = new TestHandler();
+        $logger->pushHandler($handler);
+
+        $configBuilder = new ConfigBuilder(['site_config' => [__DIR__]]);
+        $configBuilder->setLogger($logger);
+
+        $configActual = $configBuilder->parseLines([
+            'find_string: src="/assets/img/highlight_ph.png"',
+        ]);
+
+        $this->assertCount(0, $configActual->find_string);
+        $this->assertCount(0, $configActual->replace_string);
+
+        $records = $handler->getRecords();
+
+        $this->assertSame('find_string & replace_string size mismatch, check the site config to fix it', $records[0]['message']);
+        $this->assertCount(2, $records[0]['context']);
+    }
 }