feat: move woocommerce logs directory to private cloud storage

carlalexander · carlalexander · commit d9f3512c736d · 2024-08-11T18:27:03.000-04:00
diff --git a/src/Subscriber/Compatibility/WooCommerceSubscriber.php b/src/Subscriber/Compatibility/WooCommerceSubscriber.php
@@ -13,6 +13,8 @@
 
 namespace Ymir\Plugin\Subscriber\Compatibility;
 
+use Ymir\Plugin\CloudStorage\PrivateCloudStorageStreamWrapper;
+use Ymir\Plugin\CloudStorage\PublicCloudStorageStreamWrapper;
 use Ymir\Plugin\EventManagement\SubscriberInterface;
 use Ymir\Plugin\Support\Collection;
 
@@ -61,11 +63,22 @@ public static function getSubscribedEvents(): array
             'transient_woocommerce_blocks_asset_api_script_data' => 'fixAssetUrlPathsInCachedScriptData',
             'transient_woocommerce_blocks_asset_api_script_data_ssl' => 'fixAssetUrlPathsInCachedScriptData',
             'woocommerce_csv_importer_check_import_file_path' => 'disableCheckImportFilePath',
+            'woocommerce_log_directory' => 'changeLogDirectory',
             'woocommerce_product_csv_importer_check_import_file_path' => 'disableCheckImportFilePath',
             'woocommerce_resize_images' => 'disableImageResizeWithImageProcessing',
         ];
     }
 
+    /**
+     * Change the log directory to point to the private cloud storage.
+     */
+    public function changeLogDirectory($logDirectory)
+    {
+        return is_string($logDirectory) && str_starts_with($logDirectory, PublicCloudStorageStreamWrapper::getProtocol())
+             ? sprintf('%s:///wc-logs/', PrivateCloudStorageStreamWrapper::getProtocol())
+             : $logDirectory;
+    }
+
     /**
      * Disable "check import file path" so that imports work with S3 storage.
      */
diff --git a/tests/Unit/Subscriber/Compatibility/WooCommerceSubscriberTest.php b/tests/Unit/Subscriber/Compatibility/WooCommerceSubscriberTest.php
@@ -13,6 +13,8 @@
 
 namespace Ymir\Plugin\Tests\Unit\Subscriber\Compatibility;
 
+use Ymir\Plugin\CloudStorage\PrivateCloudStorageStreamWrapper;
+use Ymir\Plugin\CloudStorage\PublicCloudStorageStreamWrapper;
 use Ymir\Plugin\Subscriber\Compatibility\WooCommerceSubscriber;
 use Ymir\Plugin\Tests\Mock\EventManagerMockTrait;
 use Ymir\Plugin\Tests\Mock\FunctionMockTrait;
@@ -26,6 +28,25 @@ class WooCommerceSubscriberTest extends TestCase
     use EventManagerMockTrait;
     use FunctionMockTrait;
 
+    public function testChangeLogDirectoryWhenLogDirectoryIsAStringThatDoesntStartWithThePublicCloudStorageProtocol()
+    {
+        $logDirectory = '/var/logs';
+
+        $this->assertSame($logDirectory, (new WooCommerceSubscriber('https://foo.com'))->changeLogDirectory($logDirectory));
+    }
+
+    public function testChangeLogDirectoryWhenLogDirectoryIsAStringThatStartsWithThePublicCloudStorageProtocol()
+    {
+        $this->assertSame(sprintf('%s:///wc-logs/', PrivateCloudStorageStreamWrapper::getProtocol()), (new WooCommerceSubscriber('https://foo.com'))->changeLogDirectory(sprintf('%s:///uploads', PublicCloudStorageStreamWrapper::getProtocol())));
+    }
+
+    public function testChangeLogDirectoryWhenLogDirectoryIsntAString()
+    {
+        $logDirectory = 42;
+
+        $this->assertSame($logDirectory, (new WooCommerceSubscriber('https://foo.com'))->changeLogDirectory($logDirectory));
+    }
+
     public function testDisableCheckImportFilePath()
     {
         $this->assertFalse((new WooCommerceSubscriber('https://foo.com'))->disableCheckImportFilePath());
@@ -135,6 +156,7 @@ public function testGetSubscribedEvents()
             'transient_woocommerce_blocks_asset_api_script_data' => 'fixAssetUrlPathsInCachedScriptData',
             'transient_woocommerce_blocks_asset_api_script_data_ssl' => 'fixAssetUrlPathsInCachedScriptData',
             'woocommerce_csv_importer_check_import_file_path' => 'disableCheckImportFilePath',
+            'woocommerce_log_directory' => 'changeLogDirectory',
             'woocommerce_product_csv_importer_check_import_file_path' => 'disableCheckImportFilePath',
             'woocommerce_resize_images' => 'disableImageResizeWithImageProcessing',
         ];
