feat: support cross-bucket copy and move operations

Author: RomainLanz

drivers/gcs/driver.ts

@@ -23,6 +23,7 @@ import { DriveFile } from '../../src/driver_file.js'
 import { DriveDirectory } from '../../src/drive_directory.js'
 import type {
   WriteOptions,
+  CopyMoveOptions,
   ObjectMetaData,
   DriverContract,
   SignedURLOptions,
@@ -381,58 +382,75 @@ export class GCSDriver implements DriverContract {
   /**
    * Copies the source file to the destination. Both paths must
    * be within the root location.
+   *
+   * Use the "bucket" option to copy the file to a different bucket.
    */
-  async copy(source: string, destination: string, options?: WriteOptions): Promise<void> {
+  async copy(source: string, destination: string, options?: CopyMoveOptions): Promise<void> {
+    const { bucket: destinationBucket, ...writeOptions } = options || {}
+    const targetBucket = destinationBucket || this.options.bucket
+
     debug(
       'copying file from %s:%s to %s:%s',
       this.options.bucket,
       source,
-      this.options.bucket,
+      targetBucket,
       destination
     )
-    const bucket = this.#storage.bucket(this.options.bucket)
-    options = options || {}
+
+    const sourceBucket = this.#storage.bucket(this.options.bucket)
 
     /**
      * Copy visibility from the source file to the
      * desintation when no inline visibility is
      * defined and not using usingUniformAcl
      */
-    if (!options.visibility && !this.#usingUniformAcl) {
-      const [isFilePublic] = await bucket.file(source).isPublic()
-      options.visibility = isFilePublic ? 'public' : 'private'
+    if (!writeOptions.visibility && !this.#usingUniformAcl) {
+      const [isFilePublic] = await sourceBucket.file(source).isPublic()
+      writeOptions.visibility = isFilePublic ? 'public' : 'private'
     }
 
-    await bucket.file(source).copy(destination, this.#getSaveOptions(options))
+    const target = destinationBucket
+      ? this.#storage.bucket(destinationBucket).file(destination)
+      : destination
+
+    await sourceBucket.file(source).copy(target, this.#getSaveOptions(writeOptions))
   }
 
   /**
    * Moves the source file to the destination. Both paths must
    * be within the root location.
+   *
+   * Use the "bucket" option to move the file to a different bucket.
    */
-  async move(source: string, destination: string, options?: WriteOptions): Promise<void> {
+  async move(source: string, destination: string, options?: CopyMoveOptions): Promise<void> {
+    const { bucket: destinationBucket, ...writeOptions } = options || {}
+    const targetBucket = destinationBucket || this.options.bucket
+
     debug(
       'moving file from %s:%s to %s:%s',
       this.options.bucket,
       source,
-      this.options.bucket,
+      targetBucket,
       destination
     )
 
-    const bucket = this.#storage.bucket(this.options.bucket)
-    options = options || {}
+    const sourceBucket = this.#storage.bucket(this.options.bucket)
 
     /**
      * Copy visibility from the source file to the
      * desintation when no inline visibility is
      * defined and not using usingUniformAcl
      */
-    if (!options.visibility && !this.#usingUniformAcl) {
-      const [isFilePublic] = await bucket.file(source).isPublic()
-      options.visibility = isFilePublic ? 'public' : 'private'
+    if (!writeOptions.visibility && !this.#usingUniformAcl) {
+      const [isFilePublic] = await sourceBucket.file(source).isPublic()
+      writeOptions.visibility = isFilePublic ? 'public' : 'private'
     }
 
-    await bucket.file(source).move(destination, this.#getSaveOptions(options))
+    const target = destinationBucket
+      ? this.#storage.bucket(destinationBucket).file(destination)
+      : destination
+
+    await sourceBucket.file(source).move(target, this.#getSaveOptions(writeOptions))
   }
 
   /**

drivers/s3/driver.ts

@@ -39,6 +39,7 @@ import { DriveFile } from '../../src/driver_file.js'
 import { DriveDirectory } from '../../src/drive_directory.js'
 import type {
   WriteOptions,
+  CopyMoveOptions,
   DriverContract,
   ObjectMetaData,
   ObjectVisibility,
@@ -583,47 +584,54 @@ export class S3Driver implements DriverContract {
   /**
    * Copies the source file to the destination. Both paths must
    * be within the root location.
+   *
+   * Use the "bucket" option to copy the file to a different bucket.
    */
-  async copy(source: string, destination: string, options?: WriteOptions): Promise<void> {
+  async copy(source: string, destination: string, options?: CopyMoveOptions): Promise<void> {
+    const { bucket: destinationBucket, ...writeOptions } = options || {}
+    const targetBucket = destinationBucket || this.options.bucket
+
     debug(
       'copying file from %s:%s to %s:%s',
       this.options.bucket,
       source,
-      this.options.bucket,
+      targetBucket,
       destination
     )
 
-    options = options || {}
-
     /**
      * Copy visibility from the source file to the
      * destination when no inline visibility is
      * defined
      */
-    if (!options.visibility && this.#supportsACL) {
-      options.visibility = await this.getVisibility(source)
+    if (!writeOptions.visibility && this.#supportsACL) {
+      writeOptions.visibility = await this.getVisibility(source)
     }
 
     await this.#client.send(
       this.createCopyObjectCommand(this.#client, {
-        ...this.#getSaveOptions(destination, options),
+        ...this.#getSaveOptions(destination, writeOptions),
         Key: destination,
         CopySource: `/${this.options.bucket}/${source}`,
-        Bucket: this.options.bucket,
+        Bucket: targetBucket,
       })
     )
   }
 
   /**
    * Moves the source file to the destination. Both paths must
    * be within the root location.
+   *
+   * Use the "bucket" option to move the file to a different bucket.
    */
-  async move(source: string, destination: string, options?: WriteOptions): Promise<void> {
+  async move(source: string, destination: string, options?: CopyMoveOptions): Promise<void> {
+    const targetBucket = options?.bucket || this.options.bucket
+
     debug(
       'moving file from %s:%s to %s:%s',
       this.options.bucket,
       source,
-      this.options.bucket,
+      targetBucket,
       destination
     )
 

src/disk.ts

@@ -22,6 +22,7 @@ import type {
   DriverContract,
   ObjectVisibility,
   SignedURLOptions,
+  CopyMoveOptions,
 } from './types.js'
 
 /**
@@ -169,13 +170,13 @@ export class Disk {
   }
 
   /**
-   * Copies file from the "source" to the "destination" within the
-   * same bucket or the root location of local filesystem.
+   * Copies file from the "source" to the "destination". Use the "bucket"
+   * option to copy the file to a different bucket.
    *
    * Use "copyFromFs" method to copy files from local filesystem to
    * a cloud provider
    */
-  async copy(source: string, destination: string, options?: WriteOptions): Promise<void> {
+  async copy(source: string, destination: string, options?: CopyMoveOptions): Promise<void> {
     source = this.#normalizer.normalize(source)
     destination = this.#normalizer.normalize(destination)
     try {
@@ -193,13 +194,13 @@ export class Disk {
   }
 
   /**
-   * Moves file from the "source" to the "destination" within the
-   * same bucket or the root location of local filesystem.
+   * Moves file from the "source" to the "destination". Use the "bucket"
+   * option to move the file to a different bucket.
    *
    * Use "moveFromFs" method to move files from local filesystem to
    * a cloud provider
    */
-  async move(source: string, destination: string, options?: WriteOptions): Promise<void> {
+  async move(source: string, destination: string, options?: CopyMoveOptions): Promise<void> {
     source = this.#normalizer.normalize(source)
     destination = this.#normalizer.normalize(destination)
     try {

src/types.ts

@@ -42,6 +42,13 @@ export type WriteOptions = {
   [key: string]: any
 }
 
+/**
+ * Options accepted by the copy and move operations.
+ */
+export type CopyMoveOptions = WriteOptions & {
+  bucket?: string
+}
+
 /**
  * Options accepted during the creation of a signed URL.
  */
@@ -155,15 +162,19 @@ export interface DriverContract {
    * Copy the file from within the disk root location. Both
    * the "source" and "destination" will be the key names
    * and not absolute paths.
+   *
+   * Use the "bucket" option to copy the file to a different bucket.
    */
-  copy(source: string, destination: string, options?: WriteOptions): Promise<void>
+  copy(source: string, destination: string, options?: CopyMoveOptions): Promise<void>
 
   /**
    * Move the file from within the disk root location. Both
    * the "source" and "destination" will be the key names
    * and not absolute paths.
+   *
+   * Use the "bucket" option to move the file to a different bucket.
    */
-  move(source: string, destination: string, options?: WriteOptions): Promise<void>
+  move(source: string, destination: string, options?: CopyMoveOptions): Promise<void>
 
   /**
    * Delete the file for the given key. Should not throw

tests/drivers/gcs/copy.spec.ts

@@ -109,4 +109,22 @@ test.group('GCS Driver | copy', (group) => {
     const existsResponse = await noUniformedAclBucket.file(source).exists()
     assert.isTrue(existsResponse[0])
   })
+
+  test('copy file with explicit bucket option', async ({ assert }) => {
+    const source = `${string.random(6)}.txt`
+    const destination = `${string.random(6)}.txt`
+    const contents = 'Hello world'
+
+    const fdgcs = new GCSDriver({
+      visibility: 'public',
+      bucket: GCS_BUCKET,
+      credentials: GCS_KEY,
+      usingUniformAcl: true,
+    })
+    await fdgcs.put(source, contents)
+    await fdgcs.copy(source, destination, { bucket: GCS_BUCKET })
+
+    assert.equal(await fdgcs.get(destination), contents)
+    assert.isTrue((await bucket.file(source).exists())[0])
+  })
 })

tests/drivers/gcs/move.spec.ts

@@ -114,4 +114,22 @@ test.group('GCS Driver | move', (group) => {
     const existsResponse = await noUniformedAclBucket.file(source).exists()
     assert.isFalse(existsResponse[0])
   })
+
+  test('move file with explicit bucket option', async ({ assert }) => {
+    const source = `${string.random(10)}.txt`
+    const destination = `${string.random(10)}.txt`
+    const contents = 'Hello world'
+
+    const fdgcs = new GCSDriver({
+      visibility: 'public',
+      bucket: GCS_BUCKET,
+      credentials: GCS_KEY,
+      usingUniformAcl: true,
+    })
+    await fdgcs.put(source, contents)
+    await fdgcs.move(source, destination, { bucket: GCS_BUCKET })
+
+    assert.equal(await fdgcs.get(destination), contents)
+    assert.isFalse((await bucket.file(source).exists())[0])
+  })
 })

tests/drivers/s3/copy.spec.ts

@@ -9,7 +9,7 @@
 
 import { test } from '@japa/runner'
 import string from '@poppinss/utils/string'
-import { S3Client } from '@aws-sdk/client-s3'
+import { S3Client, type CopyObjectCommandInput } from '@aws-sdk/client-s3'
 
 import { S3Driver } from '../../../drivers/s3/driver.js'
 import {
@@ -136,4 +136,51 @@ test.group('S3 Driver | copy', (group) => {
 
     assert.isTrue(await s3fs.exists(source))
   }).skip(!SUPPORTS_ACL, 'Service does not support ACL. Hence, we cannot control file visibility')
+
+  test('copy file with explicit bucket option', async ({ assert }) => {
+    const source = `${string.random(6)}.txt`
+    const destination = `${string.random(6)}.txt`
+    const contents = 'Hello world'
+
+    const s3fs = new S3Driver({
+      visibility: 'public',
+      client: client,
+      bucket: S3_BUCKET,
+      supportsACL: SUPPORTS_ACL,
+    })
+    await s3fs.put(source, contents)
+    await s3fs.copy(source, destination, { bucket: S3_BUCKET })
+
+    assert.equal(await s3fs.get(destination), contents)
+    assert.isTrue(await s3fs.exists(source))
+  })
+
+  test('copy command receives the correct destination bucket', async ({ assert }) => {
+    let capturedOptions: CopyObjectCommandInput | undefined
+
+    class TestS3Driver extends S3Driver {
+      protected createCopyObjectCommand(_client: S3Client, options: CopyObjectCommandInput) {
+        capturedOptions = options
+        return super.createCopyObjectCommand(_client, options)
+      }
+    }
+
+    const source = `${string.random(6)}.txt`
+    const destination = `${string.random(6)}.txt`
+    const contents = 'Hello world'
+
+    const s3fs = new TestS3Driver({
+      visibility: 'public',
+      client: client,
+      bucket: S3_BUCKET,
+      supportsACL: SUPPORTS_ACL,
+    })
+
+    await s3fs.put(source, contents)
+    await s3fs.copy(source, destination, { bucket: 'other-bucket' }).catch(() => {})
+
+    assert.isDefined(capturedOptions)
+    assert.equal(capturedOptions!.Bucket, 'other-bucket')
+    assert.equal(capturedOptions!.CopySource, `/${S3_BUCKET}/${source}`)
+  })
 })