feat: add file validation configuration

verdaccio · Aug 3, 2019 · bcd46c5 · bcd46c5
1 parent da6f19e
commit bcd46c5
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 14 deletions.
diff --git a/plugins/verdaccio-google-cloud/README.md b/plugins/verdaccio-google-cloud/README.md
@@ -26,6 +26,9 @@ store:
    ## google cloud recomend this file only for development
    ## this field is not mandatory
    keyFilename: /path/project-01.json || env (GOOGLE_CLOUD_VERDACCIO_KEY)
+   ## default validation is, it can be overrided by 
+   ## https://cloud.google.com/nodejs/docs/reference/storage/1.6.x/File.html#createWriteStream
+   # validation: crc32c
 ```
 Define `env` whether you want load the value from environment variables.
 

diff --git a/plugins/verdaccio-google-cloud/src/storage.js b/plugins/verdaccio-google-cloud/src/storage.js
@@ -13,6 +13,7 @@ import type { ConfigGoogleStorage } from '../types';
 export const noSuchFile: string = 'ENOENT';
 export const fileExist: string = 'EEXISTS';
 export const pkgFileName = 'package.json';
+export const defaultValidation = 'crc32c';
 
 declare type StorageType = Package | void;
 
@@ -91,7 +92,9 @@ class GoogleCloudStorageHandler implements ILocalPackageManager {
     this.logger.debug({ name: file.name }, 'gcloud: deleting @{name} from storage');
     try {
       file
-        .delete()
+        .delete({
+          validation: this.config.validation || defaultValidation
+        })
         .then(data => {
           const apiResponse = data[0];
           this.logger.debug({ name: file.name }, 'gcloud: @{name} was deleted successfully from storage');
@@ -111,16 +114,20 @@ class GoogleCloudStorageHandler implements ILocalPackageManager {
     // remove all files from storage
     const file = this._getBucket().file(`${this.name}`);
     this.logger.debug({ name: file.name }, 'gcloud: removing the package @{name} from storage');
-    file.delete().then(
-      () => {
-        this.logger.debug({ name: file.name }, 'gcloud: package @{name} was deleted successfully from storage');
-        callback(null);
-      },
-      err => {
-        this.logger.error({ name: file.name, err: err.message }, 'gcloud: delete @{name} package has failed err: @{err}');
-        callback(fSError(err.message, 500));
-      }
-    );
+    file
+      .delete({
+        validation: this.config.validation || defaultValidation
+      })
+      .then(
+        () => {
+          this.logger.debug({ name: file.name }, 'gcloud: package @{name} was deleted successfully from storage');
+          callback(null);
+        },
+        err => {
+          this.logger.error({ name: file.name, err: err.message }, 'gcloud: delete @{name} package has failed err: @{err}');
+          callback(fSError(err.message, 500));
+        }
+      );
   }
 
   createPackage(name: string, metadata: Object, cb: Function): void {
@@ -159,7 +166,9 @@ class GoogleCloudStorageHandler implements ILocalPackageManager {
     return new Promise(async (resolve, reject) => {
       const file = this._buildFilePath(name, pkgFileName);
       try {
-        await file.save(this._convertToString(metadata));
+        await file.save(this._convertToString(metadata), {
+          validation: this.config.validation || defaultValidation
+        });
         resolve(null);
       } catch (err) {
         reject(fSError(err.message, 500));
@@ -224,7 +233,9 @@ class GoogleCloudStorageHandler implements ILocalPackageManager {
           } else {
             const file = this._getBucket().file(`${this.name}/${name}`);
             this.logger.info({ url: file.name }, 'gcloud: the @{url} is being uploaded to the storage');
-            const fileStream = file.createWriteStream();
+            const fileStream = file.createWriteStream({
+              validation: this.config.validation || defaultValidation
+            });
             uploadStream.done = () => {
               uploadStream.on('end', () => {
                 fileStream.on('response', () => {

diff --git a/plugins/verdaccio-google-cloud/types/index.js b/plugins/verdaccio-google-cloud/types/index.js
@@ -8,7 +8,9 @@ export type ConfigGoogleStorage = {
   // https://cloud.google.com/datastore/docs/reference/data/rest/v1/Key
   kind: string,
   // for local development
-  keyFilename?: string
+  keyFilename?: string,
+  // disable bucket validation
+  validation?: boolean | string
 };
 
 export type GoogleCloudOptions = {