Fixes #28: Be more accepting of valid json (#29)

consolidation · Feb 28, 2019 · 7e76331 · 7e76331
1 parent 8c2e940
commit 7e76331
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 56 deletions.
diff --git a/.scenarios.lock/phpunit5/composer.lock b/.scenarios.lock/phpunit5/composer.lock
diff --git a/composer.lock b/composer.lock
diff --git a/src/ProcessBase.php b/src/ProcessBase.php
@@ -171,21 +171,49 @@ public function getOutputAsJson()
         if (empty($output)) {
             throw new \InvalidArgumentException('Output is empty.');
         }
-        $output = preg_replace('#^[^{]*#', '', $output);
-        $output = preg_replace('#[^}]*$#', '', $output);
         if (Escape::isWindows()) {
             // Doubled double quotes were converted to \\".
             // Revert to double quote.
             $output = str_replace('\\"', '"', $output);
             // Revert of doubled backslashes.
             $output = preg_replace('#\\\\{2}#', '\\', $output);
         }
-        if (!$json = json_decode($output, true)) {
+        $output = $this->removeNonJsonJunk($output);
+        $json = json_decode($output, true);
+        if (!isset($json)) {
             throw new \InvalidArgumentException('Unable to decode output into JSON.');
         }
         return $json;
     }
 
+    /**
+     * Allow for a certain amount of resiliancy in the output received when
+     * json is expected.
+     *
+     * @param string $data
+     * @return string
+     */
+    protected function removeNonJsonJunk($data)
+    {
+        // Exit early if we have no output.
+        $data = trim($data);
+        if (empty($data)) {
+            return $data;
+        }
+        // If the data is a simple quoted string, or an array, then exit.
+        if ((($data[0] == '"') && ($data[strlen($data) - 1] == '"')) ||
+            (($data[0] == "[") && ($data[strlen($data) - 1] == "]"))
+        ) {
+            return $data;
+        }
+        // If the json is not a simple string or a simple array, then is must
+        // be an associative array. We will remove non-json garbage characters
+        // before and after the enclosing curley-braces.
+        $data = preg_replace('#^[^{]*#', '', $data);
+        $data = preg_replace('#[^}]*$#', '', $data);
+        return $data;
+    }
+
     /**
      * Return a realTime output object.
      *

diff --git a/tests/SiteProcessTest.php b/tests/SiteProcessTest.php
@@ -235,6 +235,21 @@ public function siteProcessJsonTestValues()
                 'Ignored leading data {"foo":"bar"} Ignored trailing data',
                 NULL,
             ],
+            [
+                '["a","b","c"]',
+                '["a", "b", "c"]',
+                NULL,
+            ],
+            [
+                '"string"',
+                '"string"',
+                NULL,
+            ],
+            [
+                '[]',
+                '[]',
+                NULL,
+            ],
         ];
     }
 
@@ -248,8 +263,8 @@ public function testSiteProcessJson(
         $data,
         $os)
     {
-        if (Escape::isWindows() != Escape::isWindows($os)) {
-          $this->markTestSkipped("OS isn't supported");
+        if (Escape::isWindows()) {
+          $this->markTestSkipped("Windows is not working yet. PRs welcome.");
         }
         $args = ['echo', $data];
         $processManager = ProcessManager::createDefault();