feat(file-upload): Support saving multiple files at once. (drupal-graphql#1139)

Author: rthideaway

src/GraphQL/Response/FileUploadResponse.php

@@ -12,11 +12,11 @@
 class FileUploadResponse extends Response {
 
   /**
-   * The file entity in case of successful file upload.
+   * The file entities in case of successful file upload.
    *
-   * @var \Drupal\file\FileInterface|null
+   * @var \Drupal\file\FileInterface[]
    */
-  protected $fileEntity;
+  protected $fileEntities = [];
 
   /**
    * Sets file entity.
@@ -25,14 +25,37 @@ class FileUploadResponse extends Response {
    *   File entity.
    */
   public function setFileEntity(FileInterface $fileEntity): void {
-    $this->fileEntity = $fileEntity;
+    $this->fileEntities[] = $fileEntity;
   }
 
   /**
-   * Get the file entity if there is one.
+   * Sets file entities.
+   *
+   * @param \Drupal\file\FileInterface[] $fileEntities
+   *   File entities.
+   */
+  public function setFileEntities(array $fileEntities): void {
+    $this->fileEntities = $fileEntities;
+  }
+
+  /**
+   * Get the first file entity if there is one.
+   *
+   * @return \Drupal\file\FileInterface|null
+   *   First file entity or NULL.
    */
   public function getFileEntity(): ?FileInterface {
-    return $this->fileEntity;
+    return $this->fileEntities[0] ?? NULL;
+  }
+
+  /**
+   * Get the file entities.
+   *
+   * @return \Drupal\file\FileInterface[]
+   *   File entities.
+   */
+  public function getFileEntities(): array {
+    return $this->fileEntities;
   }
 
 }

src/GraphQL/Utility/FileUpload.php

@@ -281,6 +281,47 @@ public function saveFileUpload(UploadedFile $uploaded_file, array $settings): Fi
     }
   }
 
+  /**
+   * Validates uploaded files, saves them and returns a file upload response.
+   *
+   * @param \Symfony\Component\HttpFoundation\File\UploadedFile[] $uploaded_files
+   *   The file entities to upload.
+   * @param array $settings
+   *   File settings as specified in regular file field config. Contains keys:
+   *   - file_directory: Where to upload the file
+   *   - uri_scheme: Uri scheme to upload the file to (eg public://, private://)
+   *   - file_extensions: List of valid file extensions (eg [xml, pdf])
+   *   - max_filesize: Maximum allowed size of uploaded file.
+   *
+   * @return \Drupal\graphql\GraphQL\Response\FileUploadResponse
+   *   The file upload response containing file entities or list of violations.
+   */
+  public function saveMultipleFileUploads(array $uploaded_files, array $settings): FileUploadResponse {
+    $response = new FileUploadResponse();
+    foreach ($uploaded_files as $uploaded_file) {
+      if (!$uploaded_file instanceof UploadedFile) {
+        continue;
+      }
+      $file_upload_response = $this->saveFileUpload($uploaded_file, $settings);
+      $file_entity = $file_upload_response->getFileEntity();
+      if ($file_entity) {
+        $response->setFileEntity($file_entity);
+      }
+      else {
+        // If one file upload fails we need to delete any other uploaded files
+        // before that. Avoids file orphans that don't belong to any entity.
+        foreach ($response->getFileEntities() as $saved_file_entity) {
+          $saved_file_entity->delete();
+        }
+        // Reset list of file entities as this is a violation response.
+        $response->setFileEntities([]);
+        $response->mergeViolations($file_upload_response);
+        return $response;
+      }
+    }
+    return $response;
+  }
+
   /**
    * Validates the file.
    *

tests/src/Kernel/Framework/UploadFileServiceTest.php

@@ -28,25 +28,31 @@ class UploadFileServiceTest extends GraphQLTestBase {
   protected $uploadService;
 
   /**
-   * Path to temporary test file.
+   * Gets the file path of the source file.
    *
-   * @var string
+   * @param string $filename
+   *   Filename of the source file to be get the file path for.
+   *
+   * @return string
+   *   File path of the source file.
    */
-  protected $file;
+  protected function getSourceTestFilePath(string $filename): string {
+    $file_system = $this->container->get('file_system');
+    // Create dummy file, since symfony will test if it exists.
+    $filepath = $file_system->getTempDirectory() . '/' . $filename;
+    touch($filepath);
+    return $filepath;
+  }
 
   /**
    * {@inheritdoc}
    */
   protected function setUp() {
     parent::setUp();
     $this->installEntitySchema('file');
+    $this->installSchema('file', ['file_usage']);
 
     $this->uploadService = $this->container->get('graphql.file_upload');
-
-    $file_system = $this->container->get('file_system');
-    // Create dummy file, since symfony will test if it exists.
-    $this->file = $file_system->getTempDirectory() . '/graphql_upload_test.txt';
-    touch($this->file);
   }
 
   /**
@@ -119,12 +125,12 @@ public function testMissingSettings() {
    * Tests that the file must not be larger than the file size limit.
    */
   public function testSizeValidation() {
-    // Create a file with 4 bytes.
-    file_put_contents($this->file, 'test');
-
     // Create a Symfony dummy uploaded file in test mode.
     $uploadFile = $this->getUploadedFile(UPLOAD_ERR_OK, 4);
 
+    // Create a file with 4 bytes.
+    file_put_contents($uploadFile->getRealPath(), 'test');
+
     $file_upload_response = $this->uploadService->saveFileUpload($uploadFile, [
       'uri_scheme' => 'public',
       'file_directory' => 'test',
@@ -200,12 +206,12 @@ public function testLockReleased() {
       \Drupal::service('renderer')
     );
 
-    // Create a file with 4 bytes.
-    file_put_contents($this->file, 'test');
-
     // Create a Symfony dummy uploaded file in test mode.
     $uploadFile = $this->getUploadedFile(UPLOAD_ERR_OK, 4);
 
+    // Create a file with 4 bytes.
+    file_put_contents($uploadFile->getRealPath(), 'test');
+
     $upload_service->saveFileUpload($uploadFile, [
       'uri_scheme' => 'public',
       'file_directory' => 'test',
@@ -214,6 +220,63 @@ public function testLockReleased() {
     ]);
   }
 
+  /**
+   * Tests successful scenario with multiple file uploads.
+   */
+  public function testSuccessWithMultipleFileUploads() {
+    $uploadFiles = [
+      $this->getUploadedFile(UPLOAD_ERR_OK, 0, 'test1.txt', 'graphql_upload_test1.txt'),
+      $this->getUploadedFile(UPLOAD_ERR_OK, 0, 'test2.txt', 'graphql_upload_test2.txt'),
+      $this->getUploadedFile(UPLOAD_ERR_OK, 0, 'test3.txt', 'graphql_upload_test3.txt'),
+    ];
+
+    $file_upload_response = $this->uploadService->saveMultipleFileUploads($uploadFiles, [
+      'uri_scheme' => 'public',
+      'file_directory' => 'test',
+      'file_extensions' => 'txt',
+    ]);
+
+    // There must be no violations.
+    $violations = $file_upload_response->getViolations();
+    $this->assertEmpty($violations);
+
+    // There must be three file entities.
+    $file_entities = $file_upload_response->getFileEntities();
+    $this->assertCount(3, $file_entities);
+    foreach ($file_entities as $index => $file_entity) {
+      $this->assertSame('public://test/test' . ($index + 1) . '.txt', $file_entity->getFileUri());
+      $this->assertFileExists($file_entity->getFileUri());
+    }
+  }
+
+  /**
+   * Tests unsuccessful scenario with multiple file uploads.
+   */
+  public function testUnsuccessWithMultipleFileUploads() {
+    $uploadFiles = [
+      $this->getUploadedFile(UPLOAD_ERR_OK, 0, 'test1.txt', 'graphql_upload_test1.txt'),
+      $this->getUploadedFile(UPLOAD_ERR_OK, 0, 'test2.txt', 'graphql_upload_test2.txt'),
+      $this->getUploadedFile(UPLOAD_ERR_OK, 0, 'test3.jpg', 'graphql_upload_test3.jpg'),
+    ];
+
+    $file_upload_response = $this->uploadService->saveMultipleFileUploads($uploadFiles, [
+      'uri_scheme' => 'public',
+      'file_directory' => 'test',
+      'file_extensions' => 'txt',
+    ]);
+
+    // There must be violation regarding forbidden file extension.
+    $violations = $file_upload_response->getViolations();
+    $this->assertStringMatchesFormat(
+      'Only files with the following extensions are allowed: <em class="placeholder">txt</em>.',
+      $violations[0]['message']
+    );
+
+    // There must be no file entities.
+    $file_entities = $file_upload_response->getFileEntities();
+    $this->assertEmpty($file_entities);
+  }
+
   /**
    * Helper method to prepare the UploadedFile depending on core version.
    *
@@ -223,16 +286,18 @@ public function testLockReleased() {
   protected function getUploadedFile(
     int $error_status,
     int $size = 0,
-    string $name = 'test.txt'
+    string $dest_filename = 'test.txt',
+    string $source_filename = 'graphql_upload_test.txt'
   ): UploadedFile {
 
-    list($version) = explode('.', \Drupal::VERSION, 2);
+    $source_filepath = $this->getSourceTestFilePath($source_filename);
+    [$version] = explode('.', \Drupal::VERSION, 2);
     switch ($version) {
       case 8:
-        return new UploadedFile($this->file, $name, 'text/plain', $size, $error_status, TRUE);
+        return new UploadedFile($source_filepath, $dest_filename, 'text/plain', $size, $error_status, TRUE);
 
     }
-    return new UploadedFile($this->file, $name, 'text/plain', $error_status, TRUE);
+    return new UploadedFile($source_filepath, $dest_filename, 'text/plain', $error_status, TRUE);
   }
 
 }