FFWEB-2709: Refresh export cache functionality (#149)

Add button which refresh export cache.

Author: Rayn93

CHANGELOG.md

@@ -1,13 +1,17 @@
 # Changelog
 ## Unreleased
+### Add
+- Add refresh export cache button
 ### Fix
 - Fix problem with autowire EntityRepository and SalesChannelRepository for Shopware 6.4
+
 ## [v4.2.4] - 2023.04.26
 ### Fix
 - Fix problem with ff-template in search result page
 - Fix some inaccuracies in read.me file
 - Remove deprecations for EntityRepository and SalesChannelRepository
 - Fix type for custom_fields and filter_attributes in FeedPreprocessorEntryDefinition
+
 ## [v4.2.3] - 2023.04.13
 ### Fix
 - SSR

README.md

@@ -335,6 +335,12 @@ Export can be done for:
 `Create Export` Send a message to a bus which then might be consumed automatically by an admin worker (if enabled)
 or by CLI worker. More information about messaging you can find in official Shopware [documentation](https://developer.shopware.com/docs/guides/hosting/infrastructure/message-queue)
 
+![Admin Panel Refresh export cache](docs/assets/admin-panel-refresh-cache-export.png "Admin Panel Refresh export cache")
+If you use the export cache feature ([read more](#export-settings)) you could also refresh your export cache by clicking on `Refresh cache Export`
+button. This feature will be useful if:
+ - your export cache is old or incomplete
+ - you did some database changes programmatically
+ - you want to decrease export time (export with cache is faster)
 
 ## Web Components Integration
 

docs/assets/admin-panel-refresh-cache-export.png

@@ -6,7 +6,9 @@
 
 use Omikron\FactFinder\Shopware6\Command\DataExportCommand;
 use Omikron\FactFinder\Shopware6\Message\FeedExport;
+use Omikron\FactFinder\Shopware6\Message\RefreshExportCache;
 use Omikron\FactFinder\Shopware6\MessageQueue\FeedExportHandler;
+use Omikron\FactFinder\Shopware6\MessageQueue\RefreshExportCacheHandler;
 use Shopware\Core\Framework\Routing\Annotation\RouteScope;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -20,16 +22,21 @@ class UiFeedExportController extends AbstractController
 {
     private FeedExportHandler $feedExportHandler;
     private DataExportCommand $dataExportCommand;
+    private RefreshExportCacheHandler $refreshCacheHandler;
 
     /**
      * UiFeedExportController constructor.
      *
      * @param FeedExportHandler $feedExportHandler
      */
-    public function __construct(FeedExportHandler $feedExportHandler, DataExportCommand $dataExportCommand)
-    {
-        $this->feedExportHandler = $feedExportHandler;
-        $this->dataExportCommand = $dataExportCommand;
+    public function __construct(
+        FeedExportHandler $feedExportHandler,
+        DataExportCommand $dataExportCommand,
+        RefreshExportCacheHandler $refreshCacheHandler
+    ) {
+        $this->feedExportHandler   = $feedExportHandler;
+        $this->dataExportCommand   = $dataExportCommand;
+        $this->refreshCacheHandler = $refreshCacheHandler;
     }
 
     /**
@@ -61,4 +68,23 @@ public function getTypeEntityMap(): JsonResponse
     {
         return new JsonResponse($this->dataExportCommand->getTypeEntityMap());
     }
+
+    /**
+     * @Route("/api/_action/fact-finder/refresh-export-cache", name="api.action.fact_finder.refresh-export-cache", methods={"GET"}, defaults={"XmlHttpRequest"=true})
+     *
+     * @param Request $request
+     *
+     * @return JsonResponse
+     *
+     * @throws \Exception
+     */
+    public function refreshExportCacheAction(Request $request): JsonResponse
+    {
+        $this->refreshCacheHandler->handle(new RefreshExportCache(
+            $request->query->get('salesChannelValue'),
+            $request->query->get('salesChannelLanguageValue')
+        ));
+
+        return new JsonResponse();
+    }
 }

src/Api/UiFeedExportController.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\FactFinder\Shopware6\Message;
+
+final class RefreshExportCache
+{
+    private ?string $salesChannelId;
+    private ?string $salesChannelLanguageId;
+
+    public function __construct(string $salesChannelId = null, string $salesChannelLanguageId = null)
+    {
+        $this->salesChannelId         = $salesChannelId;
+        $this->salesChannelLanguageId = $salesChannelLanguageId;
+    }
+
+    public function getSalesChannelId(): ?string
+    {
+        return $this->salesChannelId;
+    }
+
+    public function getSalesChannelLanguageId(): ?string
+    {
+        return $this->salesChannelLanguageId;
+    }
+}

src/Message/RefreshExportCache.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Omikron\FactFinder\Shopware6\MessageQueue;
+
+use Omikron\FactFinder\Shopware6\Command\RunPreprocessorCommand;
+use Omikron\FactFinder\Shopware6\Message\RefreshExportCache;
+use Shopware\Core\Framework\MessageQueue\Handler\AbstractMessageHandler;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\NullOutput;
+use Symfony\Component\HttpKernel\KernelInterface;
+
+class RefreshExportCacheHandler extends AbstractMessageHandler
+{
+    private Application $application;
+
+    public function __construct(KernelInterface $kernel)
+    {
+        $this->application = new Application($kernel);
+        $this->application->setAutoExit(false);
+    }
+
+    /**
+     * @param RefreshExportCache $message
+     *
+     * @throws \Exception
+     */
+    public function handle($message): void
+    {
+        $input = new ArrayInput([
+            'command'                                                    => 'factfinder:data:pre-process',
+            RunPreprocessorCommand::SALES_CHANNEL_ARGUMENT               => $message->getSalesChannelId(),
+            RunPreprocessorCommand::SALES_CHANNEL_LANGUAGE_ARGUMENT      => $message->getSalesChannelLanguageId(),
+        ]);
+        $input->setInteractive(false);
+        $output = new NullOutput();
+        $this->application->run($input, $output);
+    }
+
+    public static function getHandledMessages(): iterable
+    {
+        return [RefreshExportCache::class];
+    }
+}

src/MessageQueue/RefreshExportCacheHandler.php

@@ -14,3 +14,7 @@
   text-align: center;
   justify-content: center;
 }
+
+.margint10 {
+  margin-top: 10px;
+}

src/Resources/app/administration/src/module/sw-cms/elements/shared/shared.scss

@@ -13,7 +13,7 @@
         },
         "factfinderWebComponentsRecordList": {
           "label": "FACT-Finder® Web Components Record List"
-        },
+        }
       }
     },
     "elements": {

src/Resources/app/administration/src/module/sw-cms/snippet/de-DE.json

@@ -13,7 +13,7 @@
         },
         "factfinderWebComponentsRecordList": {
           "label": "FACT-Finder® Web Components Record List"
-        },
+        }
       }
     },
     "elements": {

src/Resources/app/administration/src/module/sw-cms/snippet/en-GB.json

@@ -5,19 +5,24 @@ const { Component, Mixin } = Shopware;
 Component.register('ui-feed-export-form', {
     template,
 
+    inject: ['systemConfigApiService'],
+
     data() {
         return {
             salesChannelValue: null,
             salesChannelLanguageValue: null,
             exportTypeValue: null,
             typeSelectOptions: [],
+            isCacheDisable: false,
+            isLoadingCache: false,
         }
     },
 
     mixins: [
         Mixin.getByName('notification')
     ],
     mounted () {
+        this.getPluginConfig()
         this.getExportTypeValues()
     },
     filters: {
@@ -28,6 +33,10 @@ Component.register('ui-feed-export-form', {
         }
     },
     methods: {
+         async getPluginConfig() {
+             const config = await this.systemConfigApiService.getValues('OmikronFactFinder.config');
+             this.isCacheDisable = config['OmikronFactFinder.config.enableExportCache'];
+        },
         getExportTypeValues() {
             const httpClient = Shopware.Service('syncService').httpClient;
             const url = '_action/fact-finder/get-export-type-options';
@@ -56,6 +65,16 @@ Component.register('ui-feed-export-form', {
                 message: this.$tc('ui-feed-export.component.export_form.alert_error.text')
             })
         },
+        successRefreshCacheWindow() {
+            this.createNotificationSuccess({
+                message: this.$tc('ui-feed-export.component.export_form.refresh_cache_success.text')
+            })
+        },
+        errorRefreshCacheWindow() {
+            this.createNotificationError({
+                message: this.$tc('ui-feed-export.component.export_form.refresh_cache_error.text')
+            })
+        },
         getFeedExportFile(url) {
             const httpClient = Shopware.Service('syncService').httpClient;
             const basicHeaders = {
@@ -80,6 +99,33 @@ Component.register('ui-feed-export-form', {
                         this.errorFeedGenerationWindow();
                     }
                 });
+        },
+        refreshExportCache(url) {
+            this.isLoadingCache = true;
+            const httpClient = Shopware.Service('syncService').httpClient;
+            const basicHeaders = {
+                Authorization: `Bearer ${Shopware.Context.api.authToken.access}`,
+                'Content-Type': 'application/json'
+            };
+            const params = {
+                salesChannelValue: this.salesChannelValue,
+                salesChannelLanguageValue: this.salesChannelLanguageValue
+            };
+
+            httpClient
+                .get(url, {
+                    headers: basicHeaders,
+                    params: params
+                })
+                .then((response) => {
+                    if (response.status === 200) {
+                        this.successRefreshCacheWindow();
+                    } else {
+                        this.errorRefreshCacheWindow();
+                    }
+
+                    this.isLoadingCache = false;
+                });
         }
     }
 });

src/Resources/app/administration/src/module/ui-feed-export/component/ui-feed-export-form/index.js

@@ -32,5 +32,17 @@
 
       {{ $tc('ui-feed-export.component.export_form.button.title') }}
     </sw-button>
+
+    <sw-button @click="refreshExportCache('_action/fact-finder/refresh-export-cache')"
+               v-if="isCacheDisable"
+               :isLoading="isLoadingCache"
+               :disabled="isLoadingCache"
+               variant="success"
+               block="true"
+               size="large"
+               class="margint10">
+
+      {{ $tc('ui-feed-export.component.export_form.cache_button.title') }}
+    </sw-button>
   </sw-card>
 </sw-card-view>

src/Resources/app/administration/src/module/ui-feed-export/component/ui-feed-export-form/ui-feed-export-form.html.twig

@@ -12,11 +12,20 @@
         "button": {
           "title": "Create Export"
         },
+        "cache_button": {
+          "title": "Refresh cache Export"
+        },
         "alert_success": {
           "text": "Integration process has been started"
         },
         "alert_error": {
           "text": "An error occurred during integration process"
+        },
+        "refresh_cache_success": {
+          "text": "Export cache has been refreshed"
+        },
+        "refresh_cache_error": {
+          "text": "An error occurred during refresh export cache"
         }
       }
     }

src/Resources/app/administration/src/module/ui-feed-export/snippet/de-DE.json

@@ -12,6 +12,9 @@
         "button": {
           "title": "Create Export"
         },
+        "cache_button": {
+          "title": "Refresh cache Export"
+        },
         "alert_success": {
           "text": "Integration process has been started"
         },
@@ -20,6 +23,12 @@
         },
         "export_type": {
           "label": "Select export type"
+        },
+        "refresh_cache_success": {
+          "text": "Export cache has been refreshed"
+        },
+        "refresh_cache_error": {
+          "text": "An error occurred during refresh export cache"
         }
       }
     }

src/Resources/app/administration/src/module/ui-feed-export/snippet/en-GB.json

@@ -140,6 +140,9 @@
         <service id="Omikron\FactFinder\Shopware6\MessageQueue\FeedExportHandler">
             <tag name="messenger.message_handler" />
         </service>
+        <service id="Omikron\FactFinder\Shopware6\MessageQueue\RefreshExportCacheHandler">
+            <tag name="messenger.message_handler" />
+        </service>
         <service id="Omikron\FactFinder\Shopware6\Export\ExportBrands">
             <argument type="service" id="product_manufacturer.repository" />
         </service>