Fix/1210 recipe filtering resulting in non-contiguous arrays

CHANGELOG.md

@@ -11,6 +11,8 @@
   [#1202](https://github.com/nextcloud/cookbook/pull/1202) @christianlupus
 - Fix XPath to allow for microdata parsing with multiple adjacent schema objects in HTML code
   [#1220](https://github.com/nextcloud/cookbook/pull/1220) @christianlupus
+- Fix filters for array-valued entries in recipes
+  [#1222](https://github.com/nextcloud/cookbook/pull/1222) @christianlupus
 
 ### Maintenance
 - Use the pre-built database images for MySQL and PostgreSQL tests

lib/Helper/Filter/JSON/FixIngredientsFilter.php

@@ -52,8 +52,8 @@ public function apply(array &$json): bool {
 			$t = $this->textCleaner->cleanUp($t, false);
 			return $t;
 		}, $ingredients);
-		$ingredients = array_values($ingredients);
 		$ingredients = array_filter($ingredients, fn ($t) => ($t));
+		$ingredients = array_values($ingredients);
 
 		$changed = $ingredients !== $json[self::INGREDIENTS];
 		$json[self::INGREDIENTS] = $ingredients;

lib/Helper/Filter/JSON/FixInstructionsFilter.php

@@ -113,6 +113,8 @@ public function apply(array &$json): bool {
 			return $x;
 		}, $instructions);
 		$instructions = array_filter($instructions);
+		ksort($instructions);
+		$instructions = array_values($instructions);
 
 		$changed = $instructions !== $json[self::INSTRUCTIONS];
 		$json[self::INSTRUCTIONS] = $instructions;

lib/Helper/Filter/JSON/FixToolsFilter.php

@@ -18,7 +18,7 @@
  * If there is already an array present, the entries are cleaned up to prevent malicious chars to be present.
  */
 class FixToolsFilter extends AbstractJSONFilter {
-	private const TOOLS = 'tools';
+	private const TOOLS = 'tool';
 
 	/** @var IL10N */
 	private $l;
@@ -53,6 +53,8 @@ public function apply(array &$json): bool {
 			return $t;
 		}, $tools);
 		$tools = array_filter($tools, fn ($t) => ($t));
+		ksort($tools);
+		$tools = array_values($tools);
 
 		$changed = $tools !== $json[self::TOOLS];
 		$json[self::TOOLS] = $tools;

tests/Integration/Helper/Filter/JSON/FixToolsFilterTest.php

@@ -47,11 +47,11 @@ public function dp() {
 	/** @dataProvider dp */
 	public function testApply($startVal, $expectedVal, $changed) {
 		$recipe = $this->stub;
-		$recipe['tools'] = $startVal;
+		$recipe['tool'] = $startVal;
 
 		$ret = $this->dut->apply($recipe);
 
-		$this->stub['tools'] = $expectedVal;
+		$this->stub['tool'] = $expectedVal;
 		$this->assertEquals($changed, $ret);
 		$this->assertEquals($this->stub, $recipe);
 	}

tests/Unit/Helper/Filter/JSON/FixIngredientsFilterTest.php

@@ -50,6 +50,7 @@ public function dp() {
 		return [
 			[['a','b','c'], ['a','b','c'], false],
 			[[' a  ',''], ['a'], true],
+			[[' a  ','', 'b'], ['a', 'b'], true],
 		];
 	}
 

tests/Unit/Helper/Filter/JSON/FixInstructionsFilterTest.php

@@ -159,6 +159,10 @@ public function dpParseInstructions() {
 				],
 			], ['a', 'b', 'c'], true
 		];
+
+		yield 'Issue1210' => [
+			['a', '', 'b'], ['a', 'b'], true
+		];
 	}
 
 	/** @dataProvider dpParseInstructions */

tests/Unit/Helper/Filter/JSON/FixToolsFilterTest.php

@@ -42,34 +42,35 @@ public function testNonExisting() {
 		$recipe = $this->stub;
 		$this->assertTrue($this->dut->apply($recipe));
 
-		$this->stub['tools'] = [];
+		$this->stub['tool'] = [];
 		$this->assertEquals($this->stub, $recipe);
 	}
 
 	public function dp() {
 		return [
 			[['a','b','c'], ['a','b','c'], false],
 			[[' a  ',''], ['a'], true],
+			[[' a  ','', 'b'], ['a', 'b'], true],
 		];
 	}
 
 	/** @dataProvider dp */
 	public function testApply($startVal, $expectedVal, $changed) {
 		$recipe = $this->stub;
-		$recipe['tools'] = $startVal;
+		$recipe['tool'] = $startVal;
 
 		$this->textCleanupHelper->method('cleanUp')->willReturnArgument(0);
 
 		$ret = $this->dut->apply($recipe);
 
-		$this->stub['tools'] = $expectedVal;
+		$this->stub['tool'] = $expectedVal;
 		$this->assertEquals($changed, $ret);
 		$this->assertEquals($this->stub, $recipe);
 	}
 
 	public function testApplyString() {
 		$recipe = $this->stub;
-		$recipe['tools'] = 'some text';
+		$recipe['tool'] = 'some text';
 
 		$this->textCleanupHelper->method('cleanUp')->willReturnArgument(0);
 		$this->expectException(InvalidRecipeException::class);