AOS-295: CMS6 large document report visibility

Author: HeyImPhil

_config/extensions.yml

@@ -1,7 +1,5 @@
 ---
 Name: forager-bifrost-extensions
-Only:
-  envvarset: SEARCH_INDEX_FILES
 ---
 SilverStripe\Assets\File:
   extensions:

src/Extensions/FileExtension.php

@@ -7,6 +7,8 @@
 use SilverStripe\Assets\Image;
 use SilverStripe\Core\Convert;
 use SilverStripe\Core\Extension;
+use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Constants\SearchFile;
 
 /**
@@ -33,6 +35,12 @@ class FileExtension extends Extension
      */
     public function updateSearchAttributes(array &$attributes = []): void
     {
+        $fileClass = Injector::inst()->get(File::class);
+
+        if (!$fileClass->hasExtension(SearchServiceExtension::class)) {
+            return;
+        }
+
         if (!isset($attributes['_attachment'])) {
             return;
         }
@@ -60,6 +68,12 @@ public function getBase64String(): ?string
 
     public function onBeforeWrite(): void
     {
+        $fileClass = Injector::inst()->get(File::class);
+
+        if (!$fileClass->hasExtension(SearchServiceExtension::class)) {
+            return;
+        }
+
         $file = $this->getOwner();
 
         // Marks images and folders with zero content to exclude them from report generation

src/Extensions/FileFormExtension.php

@@ -6,6 +6,8 @@
 use SilverStripe\Assets\Image;
 use SilverStripe\Control\RequestHandler;
 use SilverStripe\Core\Extension;
+use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Constants\SearchFile;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\Form;
@@ -27,6 +29,12 @@ public function updateForm(
         string $name = FormFactory::DEFAULT_NAME,
         array $context = []
     ): void {
+        $fileClass = Injector::inst()->get(File::class);
+
+        if (!$fileClass->hasExtension(SearchServiceExtension::class)) {
+            return;
+        }
+
         /** @var FieldList $fields */
         $fields = $form->Fields()->fieldByName('Editor.Details');
         $file = $context['Record'] ?? null;
@@ -79,7 +87,7 @@ private function createLargeFileWarning(File $file): ?LiteralField
                     _t(
                         self::class . '.LARGE_FILE_WARNING',
                         'Text contained within this {size} file cannot be indexed for search. '
-                            . 'The file size limit for text extraction is {limit}.',
+                        . 'The file size limit for text extraction is {limit}.',
                         [
                             'size' => $file->getSize(),
                             'limit' => SearchFile::sizeLimit(),

src/Reports/LargeDocumentReport.php

@@ -3,6 +3,8 @@
 namespace SilverStripe\ForagerBifrost\Reports;
 
 use SilverStripe\Assets\File;
+use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Constants\SearchFile;
 use SilverStripe\Model\List\SS_List;
 use SilverStripe\Reports\Report;
@@ -21,6 +23,10 @@ class LargeDocumentReport extends Report
 
     public function description(): string
     {
+        if (!$this->isReportActive()) {
+            return 'This report requires the SEARCH_INDEX_FILES environment variable and file extension.';
+        }
+
         return sprintf(
             $this->description,
             SearchFile::sizeLimit()
@@ -44,4 +50,22 @@ public function sourceRecords(array $params = []): SS_List
             ->sort(['Created' => 'DESC']);
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function canView($member = null): bool
+    {
+        return $this->isReportActive();
+    }
+
+    /**
+     * This report can only be active if the required extension is enabled
+     */
+    private function isReportActive(): bool
+    {
+        $fileClass = Injector::inst()->get(File::class);
+
+        return $fileClass->has_extension(SearchServiceExtension::class);
+    }
+
 }

tests/Extensions/FileExtensionTest.php

@@ -102,7 +102,6 @@ protected function setUp(): void
         parent::setUp();
 
         TestAssetStore::activate('SearchFileTest');
-        Environment::setEnv('SEARCH_INDEX_FILES', 1);
     }
 
     protected function tearDown(): void

tests/Reports/LargeDocumentReportTest.php

@@ -34,6 +34,25 @@ public function testDescription(): void
             'Documents excluded for content ingestion in Silverstripe Search which exceeds 15 MB',
             $report->description()
         );
+
+        // Removing extension should result in a new description
+        $this->removeFileExtension();
+        $this->assertEquals(
+            'This report requires the SEARCH_INDEX_FILES environment variable and file extension.',
+            $report->description()
+        );
+
+    }
+
+    public function testCanView(): void
+    {
+        $report = new LargeDocumentReport();
+
+        $this->assertTrue($report->canView());
+
+        // When the extension is not present on the File then the report should not be viewable
+        $this->removeFileExtension();
+        $this->assertfalse($report->canView());
     }
 
     public function testColumns(): void
@@ -70,12 +89,16 @@ public function testSourceRecords(): void
         $this->assertEquals($file21MbId, $files->first()->ID);
     }
 
+    protected function removeFileExtension(): void
+    {
+        File::remove_extension(SearchServiceExtension::class);
+    }
+
     protected function setUp(): void
     {
         parent::setUp();
 
         TestAssetStore::activate('SearchFileTest');
-        Environment::setEnv('SEARCH_INDEX_FILES', 1);
     }
 
     protected function tearDown(): void