fix(types): support metadata override in file.copy() (#1406)

* fix(types): support metadata override in file.copy() * lint Co-authored-by: Sameena Shaffeeullah <[email protected]>
googleapis · Feb 26, 2021 · dda6d30 · dda6d30
1 parent 65f3ee5
commit dda6d30
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/src/file.ts b/src/file.ts
@@ -305,6 +305,7 @@ export interface FileOptions {
 
 export interface CopyOptions {
   destinationKmsKeyName?: string;
+  metadata?: Metadata;
   predefinedAcl?: string;
   token?: string;
   userProject?: string;
@@ -861,6 +862,7 @@ class File extends ServiceObject<File> {
    *     `projects/my-project/locations/location/keyRings/my-kr/cryptoKeys/my-key`,
    *     that will be used to encrypt the object. Overwrites the object
    * metadata's `kms_key_name` value, if any.
+   * @property {Metadata} [metadata] Metadata to specify on the copied file.
    * @property {string} [predefinedAcl] Set the ACL for the new file.
    * @property {string} [token] A previously-returned `rewriteToken` from an
    *     unfinished rewrite request.

diff --git a/system-test/storage.ts b/system-test/storage.ts
@@ -2810,6 +2810,27 @@ describe('storage', () => {
       await Promise.all([file.delete, copiedFile.delete()]);
     });
 
+    it('should copy an existing file and overwrite metadata', async () => {
+      const opts = {
+        destination: 'CloudLogo',
+        metadata: {
+          metadata: {
+            originalProperty: 'true',
+          },
+        },
+      };
+      const [file] = await bucket.upload(FILES.logo.path, opts);
+      const copyOpts = {metadata: {newProperty: 'true'}};
+      const [copiedFile] = await file.copy('CloudLogoCopy', copyOpts);
+      const [metadata] = await copiedFile.getMetadata();
+      assert.strictEqual(
+        typeof metadata.metadata.originalProperty,
+        'undefined'
+      );
+      assert.strictEqual(metadata.metadata.newProperty, 'true');
+      await Promise.all([file.delete, copiedFile.delete()]);
+    });
+
     it('should respect predefined Acl at file#copy', async () => {
       const opts = {destination: 'CloudLogo'};
       const [file] = await bucket.upload(FILES.logo.path, opts);