From e7954559abb3ab57b75cb694e5897f784fe8d21c Mon Sep 17 00:00:00 2001
From: Himanshu Mishra <himanshu@orkohunter.net>
Date: Sat, 9 Jan 2021 16:29:42 +0100
Subject: [PATCH] TechDocs/GCS: Remove projectId since it is not needed

I initially thought the GCS Nodejs client would make use of it, since it asked for it in the contructor. However, we may not need them at all. Buckets are gloablly unique anyway.
---
 .../__mocks__/@google-cloud/storage.ts         |  3 ---
 .../src/stages/publish/googleStorage.test.ts   |  5 ++---
 .../src/stages/publish/googleStorage.ts        |  4 ----
 .../src/stages/publish/publish.test.ts         |  1 -
 plugins/techdocs/config.d.ts                   | 18 ++++++------------
 5 files changed, 8 insertions(+), 23 deletions(-)

diff --git a/packages/techdocs-common/__mocks__/@google-cloud/storage.ts b/packages/techdocs-common/__mocks__/@google-cloud/storage.ts
index e95cee11d0..b84018c089 100644
--- a/packages/techdocs-common/__mocks__/@google-cloud/storage.ts
+++ b/packages/techdocs-common/__mocks__/@google-cloud/storage.ts
@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 type storageOptions = {
-  projectId?: string;
   keyFilename?: string;
 };
 
@@ -39,11 +38,9 @@ class Bucket {
 }
 
 export class Storage {
-  private readonly projectId;
   private readonly keyFilename;
 
   constructor(options: storageOptions) {
-    this.projectId = options.projectId;
     this.keyFilename = options.keyFilename;
   }
 
diff --git a/packages/techdocs-common/src/stages/publish/googleStorage.test.ts b/packages/techdocs-common/src/stages/publish/googleStorage.test.ts
index 43375b72d0..f8fb00647c 100644
--- a/packages/techdocs-common/src/stages/publish/googleStorage.test.ts
+++ b/packages/techdocs-common/src/stages/publish/googleStorage.test.ts
@@ -37,7 +37,7 @@ jest.spyOn(logger, 'info').mockReturnValue(logger);
 
 let publisher: PublisherBase;
 
-beforeEach(() => {
+beforeEach(async () => {
   const mockConfig = new ConfigReader({
     techdocs: {
       requestUrl: 'http://localhost:7000',
@@ -45,14 +45,13 @@ beforeEach(() => {
         type: 'googleGcs',
         googleGcs: {
           credentials: '{}',
-          projectId: 'gcp-project-id',
           bucketName: 'bucketName',
         },
       },
     },
   });
 
-  publisher = GoogleGCSPublish.fromConfig(mockConfig, logger);
+  publisher = await GoogleGCSPublish.fromConfig(mockConfig, logger);
 });
 
 describe('GoogleGCSPublish', () => {
diff --git a/packages/techdocs-common/src/stages/publish/googleStorage.ts b/packages/techdocs-common/src/stages/publish/googleStorage.ts
index 20c1e96df9..ffed59b8ba 100644
--- a/packages/techdocs-common/src/stages/publish/googleStorage.ts
+++ b/packages/techdocs-common/src/stages/publish/googleStorage.ts
@@ -56,15 +56,11 @@ export class GoogleGCSPublish implements PublisherBase {
         );
       }
     }
-    const projectId = config.getOptionalString(
-      'techdocs.publisher.googleGcs.projectId',
-    );
 
     const storageClient = new Storage({
       ...(credentials && {
         credentials: credentialsJson,
       }),
-      ...(projectId && { projectId }),
     });
 
     // Check if the defined bucket exists. Being able to connect means the configuration is good
diff --git a/packages/techdocs-common/src/stages/publish/publish.test.ts b/packages/techdocs-common/src/stages/publish/publish.test.ts
index d7cc257b89..89f2c0ffdd 100644
--- a/packages/techdocs-common/src/stages/publish/publish.test.ts
+++ b/packages/techdocs-common/src/stages/publish/publish.test.ts
@@ -69,7 +69,6 @@ describe('Publisher', () => {
           type: 'googleGcs',
           googleGcs: {
             credentials: '{}',
-            projectId: 'gcp-project-id',
             bucketName: 'bucketName',
           },
         },
diff --git a/plugins/techdocs/config.d.ts b/plugins/techdocs/config.d.ts
index f1846a1e0e..49f9d396cb 100644
--- a/plugins/techdocs/config.d.ts
+++ b/plugins/techdocs/config.d.ts
@@ -122,6 +122,12 @@ export interface Config {
            * googleGcs required when 'type' is set to googleGcs
            */
           googleGcs?: {
+            /**
+             * Cloud Storage Bucket Name
+             * attr: 'bucketName' - accepts a string value
+             * @visibility secret
+             */
+            bucketName: string;
             /**
              * (Optional) API key used to write to a storage bucket.
              * If not set, environment variables will be used to authenticate.
@@ -130,18 +136,6 @@ export interface Config {
              * @visibility secret
              */
             credentials?: string;
-            /**
-             * GCP Project ID where the Cloud Storage Bucket is hosted.
-             * attr: 'projectId' - accepts a string value
-             * @visibility secret
-             */
-            projectId?: string;
-            /**
-             * Cloud Storage Bucket Name
-             * attr: 'bucketName' - accepts a string value
-             * @visibility secret
-             */
-            bucketName: string;
           };
         };
   };