improve error handling (#11)

* improve error handling

* reformatting

Author: nick-zh

docker/dev/php/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:7.4-cli-alpine3.12
+FROM php:7.4-cli-alpine3.15
 
 ARG HOST_USER_ID
 ARG HOST_USER

src/Exception/SchemaRegistryException.php

@@ -8,4 +8,5 @@ class SchemaRegistryException extends \Exception
 {
     public const FILE_PATH_EXCEPTION_MESSAGE = 'Unable to get file path';
     public const FILE_NOT_READABLE_EXCEPTION_MESSAGE = 'Unable to read file: %s';
+    public const FILE_INVALID = 'Unable to json_decode file properly: %s';
 }

src/Merger/SchemaMerger.php

@@ -157,7 +157,7 @@ public function exportSchema(
         bool $optimizeSubSchemaNamespaces = false
     ): void {
         $rootSchemaDefinition = $this->transformExportSchemaDefinition(
-            json_decode($rootSchemaTemplate->getSchemaDefinition(), true)
+            json_decode($rootSchemaTemplate->getSchemaDefinition(), true, JSON_THROW_ON_ERROR)
         );
 
         $prefix = '';
@@ -205,8 +205,8 @@ public function transformExportSchemaDefinition(array $schemaDefinition): array
      */
     private function excludeNamespacesForEmbeddedSchema(string $definition, string $embeddedDefinition): string
     {
-        $decodedRootDefinition = json_decode($definition, true);
-        $decodedEmbeddedDefinition = json_decode($embeddedDefinition, true);
+        $decodedRootDefinition = json_decode($definition, true, JSON_THROW_ON_ERROR);
+        $decodedEmbeddedDefinition = json_decode($embeddedDefinition, true, JSON_THROW_ON_ERROR);
 
         if (
             isset($decodedRootDefinition['namespace']) && isset($decodedEmbeddedDefinition['namespace']) &&

src/Registry/SchemaRegistry.php

@@ -129,7 +129,12 @@ private function registerSchemaFile(\SplFileInfo $fileInfo): void
             );
         }
 
-        $schemaData = json_decode($fileContent, true);
+        $schemaData = json_decode($fileContent, true, JSON_THROW_ON_ERROR);
+
+        if (null === $schemaData) {
+            throw new SchemaRegistryException(sprintf(SchemaRegistryException::FILE_INVALID, $fileName));
+        }
+
         $template = (new SchemaTemplate())
             ->withFilename($fileInfo->getBasename())
             ->withSchemaDefinition($fileContent)

src/Schema/SchemaTemplate.php

@@ -127,7 +127,7 @@ public function withFilename(string $filename): SchemaTemplateInterface
      */
     public function isPrimitive(): bool
     {
-        $fields = json_decode($this->getSchemaDefinition(), true);
+        $fields = json_decode($this->getSchemaDefinition(), true, JSON_THROW_ON_ERROR);
 
         if (true === isset($fields['type'])) {
             return array_key_exists($fields['type'], self::AVRO_PRIMITIVE_TYPES);

tests/Integration/Registry/SchemaRegistryTest.php

@@ -120,4 +120,27 @@ public function testRegisterSchemaFileThatIsNotReadable()
             unlink('testfile');
         }
     }
+
+    public function testRegisterSchemaWithInvalidContent()
+    {
+        touch('testfile');
+
+        $fileInfo = new SplFileInfo('testfile');
+
+        $registry = new SchemaRegistry();
+
+        self::expectException(SchemaRegistryException::class);
+        self::expectExceptionMessage(
+            sprintf(SchemaRegistryException::FILE_INVALID, $fileInfo->getRealPath())
+        );
+
+        $reflection = new ReflectionClass(SchemaRegistry::class);
+        $method = $reflection->getMethod('registerSchemaFile');
+        $method->setAccessible(true);
+        try {
+            $method->invokeArgs($registry, [$fileInfo]);
+        } finally {
+            unlink('testfile');
+        }
+    }
 }