simplified code now, using generic file writing service

Author: lachiebol

Annotations/AnnotationGenerator.php

@@ -20,10 +20,10 @@
 use Piwik\API\NoDefaultValue;
 use Piwik\API\Proxy;
 use Piwik\API\Request;
-use Piwik\Filesystem;
 use Piwik\Http;
 use Piwik\Piwik;
 use Piwik\Plugin\Manager;
+use Piwik\Plugins\OpenApiDocs\Artifact\ArtifactWriter;
 use Piwik\Plugins\OpenApiDocs\OpenApiDocs;
 use Piwik\Plugins\OpenApiDocs\Specs\PathResolver;
 use Piwik\SettingsPiwik;
@@ -79,6 +79,11 @@ class AnnotationGenerator
      */
     protected $pathResolver;
 
+    /**
+     * @var ArtifactWriter
+     */
+    protected $artifactWriter;
+
     /**
      * @var array[]
      */
@@ -89,10 +94,14 @@ class AnnotationGenerator
      */
     protected $missingImportantDataWarnings;
 
-    public function __construct(DocumentationGenerator $generator, ?PathResolver $pathResolver = null)
-    {
+    public function __construct(
+        DocumentationGenerator $generator,
+        ?PathResolver $pathResolver = null,
+        ?ArtifactWriter $artifactWriter = null
+    ) {
         $this->generator = $generator;
         $this->pathResolver = $pathResolver ?? new PathResolver();
+        $this->artifactWriter = $artifactWriter ?? new ArtifactWriter();
         $this->missingImportantDataWarnings = [];
         $this->currentPluginDir = Manager::getInstance()::getPluginDirectory('OpenApiDocs');
     }
@@ -1029,10 +1038,7 @@ protected function getCachedExampleResponseFile(string $pluginName, string $meth
 
     protected function writeFile(string $filePath, string $contents)
     {
-        $directory = dirname($filePath);
-        Filesystem::mkdir($directory);
-
-        return file_put_contents($filePath, $contents);
+        return $this->artifactWriter->writeFile($filePath, $contents);
     }
 
     /**

Annotations/ApiMethodInfoExtractor.php

@@ -14,8 +14,8 @@
 use Piwik\Exception\PluginNotFoundException;
 use Piwik\API\Proxy;
 use Piwik\API\Request;
-use Piwik\Filesystem;
 use Piwik\Plugin\Manager;
+use Piwik\Plugins\OpenApiDocs\Artifact\ArtifactWriter;
 use Piwik\Plugins\OpenApiDocs\Specs\PathResolver;
 use Piwik\Validators\BaseValidator;
 use Piwik\Validators\NotEmpty;
@@ -27,9 +27,15 @@ class ApiMethodInfoExtractor
      */
     private $pathResolver;
 
-    public function __construct(?PathResolver $pathResolver = null)
+    /**
+     * @var ArtifactWriter
+     */
+    private $artifactWriter;
+
+    public function __construct(?PathResolver $pathResolver = null, ?ArtifactWriter $artifactWriter = null)
     {
         $this->pathResolver = $pathResolver ?? new PathResolver();
+        $this->artifactWriter = $artifactWriter ?? new ArtifactWriter();
     }
 
     /**
@@ -73,8 +79,7 @@ public function extractMethodInfo(string $pluginName, bool $writeToFile = false)
 
         if ($writeToFile) {
             $pluginSpecPath = $this->pathResolver->getApiMethodInfoFilePath($fileBaseName);
-            Filesystem::mkdir(dirname($pluginSpecPath));
-            file_put_contents($pluginSpecPath, $methodInfoString);
+            $this->artifactWriter->writeFile($pluginSpecPath, $methodInfoString);
         }
 
         return $methodInfoString;

Artifact/ArtifactWriter.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\OpenApiDocs\Artifact;
+
+use Piwik\Filesystem;
+
+class ArtifactWriter
+{
+    /**
+     * @return false|int
+     */
+    public function writeFile(string $filePath, string $contents)
+    {
+        Filesystem::mkdir(dirname($filePath));
+
+        return file_put_contents($filePath, $contents);
+    }
+}

Specs/SpecGenerator.php

@@ -13,10 +13,10 @@
 use Matomo\Dependencies\OpenApiDocs\OpenApi\Generator;
 use Piwik\Container\StaticContainer;
 use Piwik\Exception\PluginNotFoundException;
-use Piwik\Filesystem;
 use Piwik\Log\LoggerInterface;
 use Piwik\Log\NullLogger;
 use Piwik\Plugin\Manager;
+use Piwik\Plugins\OpenApiDocs\Artifact\ArtifactWriter;
 use Piwik\Plugins\OpenApiDocs\OpenApiDocs;
 use Piwik\SettingsPiwik;
 use Piwik\Validators\BaseValidator;
@@ -29,9 +29,15 @@ class SpecGenerator
      */
     private $specPathResolver;
 
-    public function __construct(?PathResolver $specPathResolver = null)
+    /**
+     * @var ArtifactWriter
+     */
+    private $artifactWriter;
+
+    public function __construct(?PathResolver $specPathResolver = null, ?ArtifactWriter $artifactWriter = null)
     {
         $this->specPathResolver = $specPathResolver ?? new PathResolver();
+        $this->artifactWriter = $artifactWriter ?? new ArtifactWriter();
 
         // Set the constant for the current instance's URL
         if (!defined('LOCAL_MATOMO_SERVER_URL')) {
@@ -126,35 +132,9 @@ public function generateSpec(array $pluginNames, string $format = 'json', string
         $specContents = $lowercaseFormat === 'yaml' ? $openapi->toYaml() : $openapi->toJson();
         if ($writeToFile) {
             $pluginSpecPath = $this->specPathResolver->getSpecFilePath($specFileBaseName, $version, $lowercaseFormat);
-            $this->writeSpecFile($pluginSpecPath, $specContents);
+            $this->artifactWriter->writeFile($pluginSpecPath, $specContents);
         }
 
         return $specContents;
     }
-
-    private function writeSpecFile(string $pluginSpecPath, string $specContents): void
-    {
-        $directory = dirname($pluginSpecPath);
-        Filesystem::mkdir($directory);
-
-        if (!is_dir($directory) || !is_writable($directory)) {
-            throw new \RuntimeException('OpenAPI spec output directory is not writable: ' . $directory);
-        }
-
-        $temporaryFile = tempnam($directory, 'openapi_spec_');
-        if ($temporaryFile === false) {
-            throw new \RuntimeException('Could not create temporary file for OpenAPI spec output in ' . $directory);
-        }
-
-        $bytesWritten = @file_put_contents($temporaryFile, $specContents, LOCK_EX);
-        if ($bytesWritten === false) {
-            @unlink($temporaryFile);
-            throw new \RuntimeException('Could not write OpenAPI spec file to temporary path ' . $temporaryFile);
-        }
-
-        if (!@rename($temporaryFile, $pluginSpecPath)) {
-            @unlink($temporaryFile);
-            throw new \RuntimeException('Could not move OpenAPI spec file into place at ' . $pluginSpecPath);
-        }
-    }
 }

tests/Unit/Artifact/ArtifactWriterTest.php

@@ -0,0 +1,66 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\OpenApiDocs\tests\Unit\Artifact;
+
+require_once PIWIK_INCLUDE_PATH . '/plugins/OpenApiDocs/vendor/autoload.php';
+
+use PHPUnit\Framework\TestCase;
+use Piwik\Plugins\OpenApiDocs\Artifact\ArtifactWriter;
+
+/**
+ * @group OpenApiDocs
+ * @group OpenApiDocs_Unit
+ * @group OpenApiDocs_ArtifactWriterTest
+ */
+class ArtifactWriterTest extends TestCase
+{
+    private $temporaryDirectory;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->temporaryDirectory = sys_get_temp_dir() . '/openapidocs_artifact_writer_' . uniqid('', true);
+    }
+
+    protected function tearDown(): void
+    {
+        if (is_dir($this->temporaryDirectory)) {
+            $files = scandir($this->temporaryDirectory);
+            if (is_array($files)) {
+                foreach ($files as $file) {
+                    if ($file === '.' || $file === '..') {
+                        continue;
+                    }
+
+                    @unlink($this->temporaryDirectory . '/' . $file);
+                }
+            }
+
+            @rmdir($this->temporaryDirectory . '/nested');
+            @rmdir($this->temporaryDirectory);
+        }
+
+        parent::tearDown();
+    }
+
+    public function testWriteFileCreatesDirectoryAndWritesContents(): void
+    {
+        $writer = new ArtifactWriter();
+        $filePath = $this->temporaryDirectory . '/nested/example.json';
+
+        $result = $writer->writeFile($filePath, '{"status":"ok"}');
+
+        $this->assertIsInt($result);
+        $this->assertSame('{"status":"ok"}', file_get_contents($filePath));
+    }
+}