feat: add CSEK to download

Author: thiyaguk09

src/bucket.ts

@@ -1325,7 +1325,7 @@ class Bucket extends ServiceObject<Bucket, BucketMetadata> {
    *     **Note**: For configuring a raw-formatted rule object to be passed as `action`
    *               please refer to the [examples]{@link https://cloud.google.com/storage/docs/managing-lifecycles#configexamples}.
    * @param {object} rule.condition Condition a bucket must meet before the
-   *     action occurson the bucket. Refer to followitn supported [conditions]{@link https://cloud.google.com/storage/docs/lifecycle#conditions}.
+   *     action occurs on the bucket. Refer to following supported [conditions]{@link https://cloud.google.com/storage/docs/lifecycle#conditions}.
    * @param {string} [rule.storageClass] When using the `setStorageClass`
    *     action, provide this option to dictate which storage class the object
    *     should update to.
@@ -1950,7 +1950,7 @@ class Bucket extends ServiceObject<Bucket, BucketMetadata> {
    * myBucket.createNotification('my-topic', callback);
    *
    * //-
-   * // Configure the nofiication by providing Notification metadata.
+   * // Configure the notification by providing Notification metadata.
    * //-
    * const metadata = {
    *   objectNamePrefix: 'prefix-'
@@ -3071,7 +3071,7 @@ class Bucket extends ServiceObject<Bucket, BucketMetadata> {
    * @property {boolean} [virtualHostedStyle=false] Use virtual hosted-style
    *     URLs ('https://mybucket.storage.googleapis.com/...') instead of path-style
    *     ('https://storage.googleapis.com/mybucket/...'). Virtual hosted-style URLs
-   *     should generally be preferred instaed of path-style URL.
+   *     should generally be preferred instead of path-style URL.
    *     Currently defaults to `false` for path-style, although this may change in a
    *     future major-version release.
    * @property {string} [cname] The cname for this bucket, i.e.,
@@ -3118,7 +3118,7 @@ class Bucket extends ServiceObject<Bucket, BucketMetadata> {
    * @param {boolean} [config.virtualHostedStyle=false] Use virtual hosted-style
    *     URLs ('https://mybucket.storage.googleapis.com/...') instead of path-style
    *     ('https://storage.googleapis.com/mybucket/...'). Virtual hosted-style URLs
-   *     should generally be preferred instaed of path-style URL.
+   *     should generally be preferred instead of path-style URL.
    *     Currently defaults to `false` for path-style, although this may change in a
    *     future major-version release.
    * @param {string} [config.cname] The cname for this bucket, i.e.,
@@ -3222,7 +3222,7 @@ class Bucket extends ServiceObject<Bucket, BucketMetadata> {
    * @throws {Error} if a metageneration is not provided.
    *
    * @param {number|string} metageneration The bucket's metageneration. This is
-   *     accesssible from calling {@link File#getMetadata}.
+   *     accessible from calling {@link File#getMetadata}.
    * @param {BucketLockCallback} [callback] Callback function.
    * @returns {Promise<BucketLockResponse>}
    *

src/file.ts

@@ -403,6 +403,7 @@ export type DownloadCallback = (
 
 export interface DownloadOptions extends CreateReadStreamOptions {
   destination?: string;
+  encryptionKey?: string | Buffer;
 }
 
 interface CopyQuery {
@@ -2309,6 +2310,11 @@ class File extends ServiceObject<File, FileMetadata> {
     const destination = options.destination;
     delete options.destination;
 
+    if (options.encryptionKey) {
+      this.setEncryptionKey(options.encryptionKey);
+      delete options.encryptionKey;
+    }
+
     const fileStream = this.createReadStream(options);
     let receivedData = false;
 
@@ -2976,7 +2982,7 @@ class File extends ServiceObject<File, FileMetadata> {
    * @param {boolean} [config.virtualHostedStyle=false] Use virtual hosted-style
    *     URLs (e.g. 'https://mybucket.storage.googleapis.com/...') instead of path-style
    *     (e.g. 'https://storage.googleapis.com/mybucket/...'). Virtual hosted-style URLs
-   *     should generally be preferred instaed of path-style URL.
+   *     should generally be preferred instead of path-style URL.
    *     Currently defaults to `false` for path-style, although this may change in a
    *     future major-version release.
    * @param {string} [config.cname] The cname for this bucket, i.e.,

src/storage.ts

@@ -896,7 +896,7 @@ export class Storage extends Service {
    *     For more information, see {@link https://cloud.google.com/storage/docs/locations| Bucket Locations}.
    * @property {boolean} [dra=false] Specify the storage class as Durable Reduced
    *     Availability.
-   * @property {boolean} [enableObjectRetention=false] Specifiy whether or not object retention should be enabled on this bucket.
+   * @property {boolean} [enableObjectRetention=false] Specify whether or not object retention should be enabled on this bucket.
    * @property {object} [hierarchicalNamespace.enabled=false] Specify whether or not to enable hierarchical namespace on this bucket.
    * @property {string} [location] Specify the bucket's location. If specifying
    *     a dual-region, the `customPlacementConfig` property should be set in conjunction.

src/transfer-manager.ts

@@ -416,7 +416,7 @@ export class TransferManager {
    * @typedef {object} UploadManyFilesOptions
    * @property {number} [concurrencyLimit] The number of concurrently executing promises
    * to use when uploading the files.
-   * @property {Function} [customDestinationBuilder] A fuction that will take the current path of a local file
+   * @property {Function} [customDestinationBuilder] A function that will take the current path of a local file
    * and return a string representing a custom path to be used to upload the file to GCS.
    * @property {boolean} [skipIfExists] Do not upload the file if it already exists in
    * the bucket. This will set the precondition ifGenerationMatch = 0.
@@ -744,7 +744,7 @@ export class TransferManager {
    * @property {number} [concurrencyLimit] The number of concurrently executing promises
    * to use when uploading the file.
    * @property {number} [chunkSizeBytes] The size in bytes of each chunk to be uploaded.
-   * @property {string} [uploadName] Name of the file when saving to GCS. If ommitted the name is taken from the file path.
+   * @property {string} [uploadName] Name of the file when saving to GCS. If omitted the name is taken from the file path.
    * @property {number} [maxQueueSize] The number of chunks to be uploaded to hold in memory concurrently. If not specified
    * defaults to the specified concurrency limit.
    * @property {string} [uploadId] If specified attempts to resume a previous upload.
@@ -757,14 +757,14 @@ export class TransferManager {
    *
    */
   /**
-   * Upload a large file in chunks utilizing parallel upload opertions. If the upload fails, an uploadId and
+   * Upload a large file in chunks utilizing parallel upload operations. If the upload fails, an uploadId and
    * map containing all the successfully uploaded parts will be returned to the caller. These arguments can be used to
    * resume the upload.
    *
    * @param {string} [filePath] The path of the file to be uploaded
    * @param {UploadFileInChunksOptions} [options] Configuration options.
    * @param {MultiPartHelperGenerator} [generator] A function that will return a type that implements the MPU interface. Most users will not need to use this.
-   * @returns {Promise<void>} If successful a promise resolving to void, otherwise a error containing the message, uploadid, and parts map.
+   * @returns {Promise<void>} If successful a promise resolving to void, otherwise a error containing the message, uploadId, and parts map.
    *
    * @example
    * ```

src/util.ts

@@ -148,7 +148,7 @@ export function convertObjKeysToSnakeCase(obj: object): object {
  * @param {boolean} includeTime flag to include hours, minutes, seconds in output.
  * @param {string} dateDelimiter delimiter between date components.
  * @param {string} timeDelimiter delimiter between time components.
- * @returns {string} UTC ISO format of provided date obect.
+ * @returns {string} UTC ISO format of provided date object.
  */
 export function formatAsUTCISO(
   dateTimeToFormat: Date,
@@ -252,7 +252,7 @@ export class PassThroughShim extends PassThrough {
       this.emit('writing');
       this.shouldEmitWriting = false;
     }
-    // Per the nodejs documention, callback must be invoked on the next tick
+    // Per the nodejs documentation, callback must be invoked on the next tick
     process.nextTick(() => {
       super._write(chunk, encoding, callback);
     });

system-test/storage.ts

@@ -435,9 +435,9 @@ describe('storage', function () {
           resumable: false,
         });
         const [metadata] = await file.getMetadata();
-        const encyrptionAlgorithm =
+        const encryptionAlgorithm =
           metadata.customerEncryption?.encryptionAlgorithm;
-        assert.strictEqual(encyrptionAlgorithm, 'AES256');
+        assert.strictEqual(encryptionAlgorithm, 'AES256');
       });
 
       it('should set custom encryption in a resumable upload', async () => {
@@ -447,9 +447,9 @@ describe('storage', function () {
           resumable: true,
         });
         const [metadata] = await file.getMetadata();
-        const encyrptionAlgorithm =
+        const encryptionAlgorithm =
           metadata.customerEncryption?.encryptionAlgorithm;
-        assert.strictEqual(encyrptionAlgorithm, 'AES256');
+        assert.strictEqual(encryptionAlgorithm, 'AES256');
       });
 
       it('should make a file public during the upload', async () => {
@@ -2778,7 +2778,7 @@ describe('storage', function () {
         });
       });
 
-      it('should download from the encrytped file', async () => {
+      it('should download from the encrypted file', async () => {
         const [contents] = await file.download();
         assert.strictEqual(contents.toString(), 'secret data');
       });

test/bucket.ts

@@ -197,7 +197,7 @@ describe('Bucket', () => {
     retryOptions: {
       autoRetry: true,
       maxRetries: 3,
-      retryDelayMultipier: 2,
+      retryDelayMultiplier: 2,
       totalTimeout: 600,
       maxRetryDelay: 60,
       retryableErrorFn: (err: HTTPError) => {
@@ -2631,7 +2631,7 @@ describe('Bucket', () => {
       bucket.setStorageClass('hyphenated-class', OPTIONS, CALLBACK);
     });
 
-    it('should call setMetdata correctly', () => {
+    it('should call setMetadata correctly', () => {
       bucket.setMetadata = (
         metadata: BucketMetadata,
         options: {},

test/file.ts

@@ -237,7 +237,7 @@ describe('File', () => {
       retryOptions: {
         autoRetry: true,
         maxRetries: 3,
-        retryDelayMultipier: 2,
+        retryDelayMultiplier: 2,
         totalTimeout: 600,
         maxRetryDelay: 60,
         retryableErrorFn: (err: HTTPError) => {
@@ -282,7 +282,7 @@ describe('File', () => {
       assert.strictEqual(file.storage, BUCKET.storage);
     });
 
-    it('should set instanceRetryValue to the storage insance retryOptions.autoRetry value', () => {
+    it('should set instanceRetryValue to the storage instance retryOptions.autoRetry value', () => {
       assert.strictEqual(
         file.instanceRetryValue,
         STORAGE.retryOptions.autoRetry
@@ -1815,7 +1815,7 @@ describe('File', () => {
           autoRetry: true,
           maxRetries: 3,
           maxRetryDelay: 60,
-          retryDelayMultipier: 2,
+          retryDelayMultiplier: 2,
           totalTimeout: 600,
         },
         preconditionOpts: {
@@ -1860,8 +1860,8 @@ describe('File', () => {
             options.retryOptions.maxRetryDelay
           );
           assert.strictEqual(
-            opts.retryOptions.retryDelayMultipier,
-            options.retryOptions.retryDelayMultipier
+            opts.retryOptions.retryDelayMultiplier,
+            options.retryOptions.retryDelayMultiplier
           );
           assert.strictEqual(
             opts.retryOptions.totalTimeout,
@@ -1898,7 +1898,7 @@ describe('File', () => {
           autoRetry: true,
           maxRetries: 3,
           maxRetryDelay: 60,
-          retryDelayMultipier: 2,
+          retryDelayMultiplier: 2,
           totalTimeout: 600,
         },
       };
@@ -1939,8 +1939,8 @@ describe('File', () => {
             options.retryOptions.maxRetryDelay
           );
           assert.strictEqual(
-            opts.retryOptions.retryDelayMultipier,
-            options.retryOptions.retryDelayMultipier
+            opts.retryOptions.retryDelayMultiplier,
+            options.retryOptions.retryDelayMultiplier
           );
           assert.strictEqual(
             opts.retryOptions.totalTimeout,
@@ -1996,11 +1996,11 @@ describe('File', () => {
         'Cannot provide an `offset` without providing a `uri`'
       );
 
-      const opitons = {
+      const options = {
         offset: 1,
         isPartialUpload: true,
       };
-      const writable = file.createWriteStream(opitons);
+      const writable = file.createWriteStream(options);
 
       writable.on('error', (err: RangeError) => {
         assert.deepEqual(err, error);
@@ -2490,6 +2490,7 @@ describe('File', () => {
 
   describe('download', () => {
     let fileReadStream: Readable;
+    let originalSetEncryptionKey: Function;
 
     beforeEach(() => {
       fileReadStream = new Readable();
@@ -2502,6 +2503,13 @@ describe('File', () => {
       file.createReadStream = () => {
         return fileReadStream;
       };
+
+      originalSetEncryptionKey = file.setEncryptionKey;
+      file.setEncryptionKey = sinon.stub();
+    });
+
+    afterEach(() => {
+      file.setEncryptionKey = originalSetEncryptionKey;
     });
 
     it('should accept just a callback', done => {
@@ -2532,6 +2540,31 @@ describe('File', () => {
       file.download(readOptions, assert.ifError);
     });
 
+    it('should call setEncryptionKey with the provided key and not pass it to createReadStream', done => {
+      const encryptionKey = Buffer.from('encryption-key');
+      const downloadOptions = {
+        encryptionKey: encryptionKey,
+        userProject: 'user-project-id',
+      };
+
+      file.createReadStream = (options: {}) => {
+        assert.deepStrictEqual(options, {userProject: 'user-project-id'});
+        return fileReadStream;
+      };
+
+      file.download(downloadOptions, (err: Error) => {
+        assert.ifError(err);
+        // Verify that setEncryptionKey was called with the correct key
+        assert.ok(
+          (file.setEncryptionKey as sinon.SinonStub).calledWith(encryptionKey)
+        );
+        done();
+      });
+
+      fileReadStream.push('some data');
+      fileReadStream.push(null);
+    });
+
     it('should only execute callback once', done => {
       Object.assign(fileReadStream, {
         _read(this: Readable) {
@@ -2886,7 +2919,7 @@ describe('File', () => {
       );
     });
 
-    it('should add ACL condtion', done => {
+    it('should add ACL condition', done => {
       file.generateSignedPostPolicyV2(
         {
           expires: Date.now() + 2000,
@@ -3118,7 +3151,7 @@ describe('File', () => {
         );
       });
 
-      it('should throw if prexif condition is not an array', () => {
+      it('should throw if prefix condition is not an array', () => {
         assert.throws(() => {
           file.generateSignedPostPolicyV2(
             {
@@ -4525,7 +4558,7 @@ describe('File', () => {
       }
     }
 
-    describe('retry mulipart upload', () => {
+    describe('retry multipart upload', () => {
       it('should save a string with no errors', async () => {
         const options = {resumable: false};
         file.createWriteStream = () => {

test/hmacKey.ts

@@ -60,7 +60,7 @@ describe('HmacKey', () => {
         retryOptions: {
           autoRetry: true,
           maxRetries: 3,
-          retryDelayMultipier: 2,
+          retryDelayMultiplier: 2,
           totalTimeout: 600,
           maxRetryDelay: 60,
           retryableErrorFn: (err: HTTPError) => {

test/index.ts

@@ -500,7 +500,7 @@ describe('Storage', () => {
         );
       });
 
-      it('should be overriden by apiEndpoint', () => {
+      it('should be overridden by apiEndpoint', () => {
         const storage = new Storage({
           projectId: PROJECT_ID,
           apiEndpoint: 'https://some.api.com',