Merge pull request #37572 from nextcloud/bugfix/noid/help-discovering…

…-broken-initial-state-data fix(initial-state): Log an error when initial-state can not be JSON e…
nextcloud · Apr 4, 2023 · 59d0e77 · 59d0e77
2 parents 44cb46c + 131f481
commit 59d0e77
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 6 deletions.
diff --git a/lib/private/InitialStateService.php b/lib/private/InitialStateService.php
@@ -64,7 +64,11 @@ public function provideInitialState(string $appName, string $key, $data): void {
 			if (!isset($this->states[$appName])) {
 				$this->states[$appName] = [];
 			}
-			$this->states[$appName][$key] = json_encode($data);
+			try {
+				$this->states[$appName][$key] = json_encode($data, JSON_THROW_ON_ERROR);
+			} catch (\JsonException $e) {
+				$this->logger->error('Invalid '. $key . ' data provided to provideInitialState by ' . $appName, ['exception' => $e]);
+			}
 			return;
 		}
 

diff --git a/tests/lib/InitialStateServiceTest.php b/tests/lib/InitialStateServiceTest.php
@@ -27,6 +27,7 @@
 
 use OC\AppFramework\Bootstrap\Coordinator;
 use OCP\IServerContainer;
+use PHPUnit\Framework\MockObject\MockObject;
 use Psr\Log\LoggerInterface;
 use function json_encode;
 use JsonSerializable;
@@ -36,18 +37,22 @@
 class InitialStateServiceTest extends TestCase {
 	/** @var InitialStateService */
 	private $service;
+	/** @var MockObject|LoggerInterface|(LoggerInterface&MockObject)  */
+	protected $logger;
 
 	protected function setUp(): void {
 		parent::setUp();
 
+		$this->logger = $this->createMock(LoggerInterface::class);
+
 		$this->service = new InitialStateService(
-			$this->createMock(LoggerInterface::class),
+			$this->logger,
 			$this->createMock(Coordinator::class),
 			$this->createMock(IServerContainer::class)
 		);
 	}
 
-	public function staticData() {
+	public function staticData(): array {
 		return [
 			['string'],
 			[23],
@@ -63,7 +68,7 @@ public function jsonSerialize(): int {
 	/**
 	 * @dataProvider staticData
 	 */
-	public function testStaticData($value) {
+	public function testStaticData(mixed $value): void {
 		$this->service->provideInitialState('test', 'key', $value);
 		$data = $this->service->getInitialStates();
 
@@ -73,7 +78,23 @@ public function testStaticData($value) {
 		);
 	}
 
-	public function testStaticButInvalidData() {
+	public function testValidDataButFailsToJSONEncode(): void {
+		$this->logger->expects($this->once())
+			->method('error');
+
+		$this->service->provideInitialState('test', 'key', ['upload' => INF]);
+		$data = $this->service->getInitialStates();
+
+		$this->assertEquals(
+			[],
+			$data
+		);
+	}
+
+	public function testStaticButInvalidData(): void {
+		$this->logger->expects($this->once())
+			->method('warning');
+
 		$this->service->provideInitialState('test', 'key', new stdClass());
 		$data = $this->service->getInitialStates();
 
@@ -86,7 +107,7 @@ public function testStaticButInvalidData() {
 	/**
 	 * @dataProvider staticData
 	 */
-	public function testLazyData($value) {
+	public function testLazyData(mixed $value): void {
 		$this->service->provideLazyInitialState('test', 'key', function () use ($value) {
 			return $value;
 		});