fix(publisher-gcs): ported changes from publisher-s3

packages/publisher/gcs/package.json

@@ -18,6 +18,7 @@
     "@electron-forge/publisher-base": "6.0.4",
     "@electron-forge/shared-types": "6.0.4",
     "@google-cloud/storage": "^6.9.0",
-    "debug": "^4.3.1"
+    "debug": "^4.3.1",
+    "google-auth-library": "^8.7.0"
   }
 }

packages/publisher/gcs/src/Config.ts

@@ -1,3 +1,5 @@
+import { PredefinedAcl } from '@google-cloud/storage';
+
 export interface PublisherGCSConfig {
   /**
    * The path to the file that is either:
@@ -36,12 +38,20 @@ export interface PublisherGCSConfig {
    * Defaults to the application `version` specified in the app's `package.json`.
    */
   folder?: string;
+  /**
+   * Apply a predefined set of access controls to this object.
+   */
+  predefinedAcl?: PredefinedAcl;
   /**
    * Whether to make uploaded artifacts public to the internet.
-   *
-   * Defaults to `false`.
+   * Alias for config.predefinedAcl = 'publicRead'.
    */
   public?: boolean;
+  /**
+   * Whether to make uploaded artifacts private.
+   * Alias for config.predefinedAcl = 'private'.
+   */
+  private?: boolean;
   /**
    * Custom function to provide the key to upload a given file to
    */

packages/publisher/gcs/src/PublisherGCS.ts

@@ -3,6 +3,7 @@ import path from 'path';
 import { PublisherBase, PublisherOptions } from '@electron-forge/publisher-base';
 import { Storage } from '@google-cloud/storage';
 import debug from 'debug';
+import { CredentialBody } from 'google-auth-library';
 
 import { PublisherGCSConfig } from './Config';
 
@@ -18,45 +19,37 @@ type GCSArtifact = {
 export default class PublisherGCS extends PublisherBase<PublisherGCSConfig> {
   name = 'gcs';
 
+  private GCSKeySafe = (key: string) => {
+    return key.replace(/@/g, '_').replace(/\//g, '_');
+  };
+
   async publish({ makeResults, setStatusLine }: PublisherOptions): Promise<void> {
-    const { config } = this;
     const artifacts: GCSArtifact[] = [];
 
-    if (!config.bucket) {
-      throw new Error('In order to publish to Google Cloud Storage you must set the "gcs.bucket" property in your Forge config.');
+    if (!this.config.bucket) {
+      throw new Error('In order to publish to Google Cloud Storage you must set the "bucket" property in your Forge config.');
     }
 
     for (const makeResult of makeResults) {
       artifacts.push(
         ...makeResult.artifacts.map((artifact) => ({
           path: artifact,
-          keyPrefix: config.folder || makeResult.packageJSON.version,
+          keyPrefix: this.config.folder || this.GCSKeySafe(makeResult.packageJSON.name),
           platform: makeResult.platform,
           arch: makeResult.arch,
         }))
       );
     }
 
-    const clientEmail = config.clientEmail || process.env.GOOGLE_CLOUD_CLIENT_EMAIL;
-    const privateKey = config.privateKey || process.env.GOOGLE_CLOUD_PRIVATE_KEY;
-
-    let credentials;
-    if (clientEmail && privateKey) {
-      credentials = {
-        client_email: clientEmail,
-        private_key: privateKey,
-      };
-    }
-
     const storage = new Storage({
-      keyFilename: config.keyFilename || process.env.GOOGLE_APPLICATION_CREDENTIALS,
-      credentials,
-      projectId: config.projectId || process.env.GOOGLE_CLOUD_PROJECT,
+      keyFilename: this.config.keyFilename,
+      credentials: this.generateCredentials(),
+      projectId: this.config.projectId,
     });
 
-    const bucket = storage.bucket(config.bucket);
+    const bucket = storage.bucket(this.config.bucket);
 
-    d('creating Google Cloud Storage client with options:', config);
+    d('creating Google Cloud Storage client with options:', this.config);
 
     let uploaded = 0;
     const updateStatusLine = () => setStatusLine(`Uploading distributable (${uploaded}/${artifacts.length})`);
@@ -69,7 +62,9 @@ export default class PublisherGCS extends PublisherBase<PublisherGCSConfig> {
         await bucket.upload(artifact.path, {
           gzip: true,
           destination: this.keyForArtifact(artifact),
-          public: config.public,
+          predefinedAcl: this.config.predefinedAcl,
+          public: this.config.public,
+          private: this.config.private,
         });
 
         uploaded += 1;
@@ -83,7 +78,20 @@ export default class PublisherGCS extends PublisherBase<PublisherGCSConfig> {
       return this.config.keyResolver(path.basename(artifact.path), artifact.platform, artifact.arch);
     }
 
-    return `${artifact.keyPrefix}/${path.basename(artifact.path)}`;
+    return `${artifact.keyPrefix}/${artifact.platform}/${artifact.arch}/${path.basename(artifact.path)}`;
+  }
+
+  generateCredentials(): CredentialBody | undefined {
+    const clientEmail = this.config.clientEmail;
+    const privateKey = this.config.privateKey;
+
+    if (clientEmail && privateKey) {
+      return {
+        client_email: clientEmail,
+        private_key: privateKey,
+      };
+    }
+    return undefined;
   }
 }
 

yarn.lock

@@ -6610,7 +6610,7 @@ globby@^11.0.2, globby@^11.0.3, globby@^11.0.4:
     merge2 "^1.4.1"
     slash "^3.0.0"
 
-google-auth-library@^8.0.1:
+google-auth-library@^8.0.1, google-auth-library@^8.7.0:
   version "8.7.0"
   resolved "https://registry.yarnpkg.com/google-auth-library/-/google-auth-library-8.7.0.tgz#e36e255baba4755ce38dded4c50f896cf8515e51"
   integrity sha512-1M0NG5VDIvJZEnstHbRdckLZESoJwguinwN8Dhae0j2ZKIQFIV63zxm6Fo6nM4xkgqUr2bbMtV5Dgo+Hy6oo0Q==