feat: Add a script for uploading browser bundles to CDN

Author: tonyo

package.json

@@ -19,6 +19,7 @@
     "packages/utils"
   ],
   "devDependencies": {
+    "@google-cloud/storage": "^1.7.0",
     "@types/chai": "^4.1.3",
     "@types/jest": "^22.2.3",
     "@types/mocha": "^5.2.0",

packages/raven-js/Gruntfile.js

@@ -158,6 +158,12 @@ module.exports = function(grunt) {
   });
 
   var awsConfigPath = path.join(os.homedir(), '.aws', 'raven-js.json');
+  var gcsConfigPath =
+    process.env.GRUNT_GOOGLE_APPLICATION_CREDENTIALS ||
+    path.join(os.homedir(), '.gcs', 'js-sdk.json');
+  var gcsConfig = grunt.file.exists(gcsConfigPath)
+    ? grunt.file.readJSON(gcsConfigPath)
+    : {};
   var gruntConfig = {
     pkg: grunt.file.readJSON('package.json'),
     aws: grunt.file.exists(awsConfigPath) ? grunt.file.readJSON(awsConfigPath) : {},
@@ -230,6 +236,25 @@ module.exports = function(grunt) {
         ]
       }
     },
+    gcs: {
+      options: {
+        credentials: gcsConfig,
+        project: process.env.GRUNT_GOOGLE_PROJECT_ID || gcsConfig.project_id,
+        // Normally there's no info about bucket name in a GCS service account
+        // file, but we can add it for convenience
+        bucket: process.env.GRUNT_GOOGLE_BUCKET_NAME || gcsConfig.bucket_name,
+        gzip: true,
+        headers: {
+          cacheControl: 'public, max-age=300' // FIXME: increase after testing
+        },
+        metadata: {}
+      },
+      dist: {
+        cwd: 'build',
+        src: '**/*',
+        dest: '<%= pkg.release || "unreleased" %>/'
+      }
+    },
 
     copy: {
       dist: {
@@ -309,6 +334,7 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-browserify');
   grunt.loadNpmTasks('grunt-release');
   grunt.loadNpmTasks('grunt-s3');
+  grunt.loadNpmTasks('grunt-google-cloud');
   grunt.loadNpmTasks('grunt-gitinfo');
   grunt.loadNpmTasks('grunt-sri');
 
@@ -329,6 +355,8 @@ module.exports = function(grunt) {
   );
   grunt.registerTask('dist', ['build', 'copy:dist', 'sri:dist', 'copy:distRoot']);
   grunt.registerTask('publish', ['build', 's3']);
+  grunt.registerTask('publish-gcs', ['build', 'gcs']);
   grunt.registerTask('cdn', ['version', 's3']);
+  grunt.registerTask('cdn-gcs', ['version', 'gcs']);
   grunt.registerTask('test:ci', ['config:ci', 'build.test']);
 };

packages/raven-js/package.json

@@ -46,6 +46,7 @@
     "grunt-contrib-copy": "^0.8.2",
     "grunt-contrib-uglify": "^0.11.0",
     "grunt-gitinfo": "^0.1.7",
+    "grunt-google-cloud": "^1.0.7",
     "grunt-release": "^0.13.0",
     "grunt-s3": "0.2.0-alpha.3",
     "grunt-sri": "mattrobenolt/grunt-sri#pretty",

scripts/browser-upload-cdn.js

@@ -0,0 +1,94 @@
+'use strict';
+
+const Storage = require('@google-cloud/storage');
+const path = require('path');
+const os = require('os');
+const fs = require('fs');
+
+const bundleFilesRegex = /^bundle.*\.js.*$/;
+const rootDir = path.dirname(__dirname);
+const browserDir = path.join(rootDir, 'packages', 'browser');
+const browserBuildDir = path.join(browserDir, 'build');
+
+/** Return full paths of files to upload */
+function findFiles() {
+  const bundleFiles = fs
+    .readdirSync(browserBuildDir)
+    .filter(filename => filename.match(bundleFilesRegex))
+    .map(filename => path.join(browserBuildDir, filename));
+  return bundleFiles;
+}
+
+/** Upload sentry-browser bundles to a GCS bucket */
+async function uploadFiles() {
+  const gcsConfigPath =
+    process.env.BROWSER_GOOGLE_APPLICATION_CREDENTIALS ||
+    path.join(os.homedir(), '.gcs', 'sentry-browser-sdk.json');
+  console.log(`Reading GCS configuration from "${gcsConfigPath}"...`);
+
+  const gcsConfig = fs.existsSync(gcsConfigPath)
+    ? JSON.parse(fs.readFileSync(gcsConfigPath))
+    : undefined;
+
+  if (!gcsConfig) {
+    console.error(
+      'Google Storage configuration (service account key) not found.\n' +
+        `Place it at ${gcsConfigPath} or use the environment variable ` +
+        '(BROWSER_GOOGLE_APPLICATION_CREDENTIALS) to specify the path.',
+    );
+    process.exit(1);
+  }
+
+  const projectId =
+    process.env.BROWSER_GOOGLE_PROJECT_ID || gcsConfig.project_id;
+  if (!projectId) {
+    console.error('Google project ID not found.');
+    process.exit(1);
+  }
+
+  const bucketName =
+    process.env.BROWSER_GOOGLE_BUCKET_NAME || gcsConfig.bucket_name;
+  if (!bucketName) {
+    console.error('Bucket name not found in the configuration.');
+    process.exit(1);
+  }
+
+  const bundleFiles = findFiles();
+  if (!bundleFiles.length) {
+    console.error('Error: no files to upload!');
+    process.exit(1);
+  }
+
+  const browserPackageJson = path.join(browserDir, 'package.json');
+  const version =
+    JSON.parse(fs.readFileSync(browserPackageJson)).version || 'unreleased';
+
+  const storage = new Storage({
+    projectId,
+  });
+
+  const bucket = storage.bucket(bucketName);
+  // TODO increase after some testing is done
+  const cacheAge = 300;
+
+  await Promise.all(
+    bundleFiles.map(async filepath => {
+      const destination = path.join(version, path.basename(filepath));
+      const options = {
+        gzip: true,
+        destination: destination,
+        metadata: {
+          cacheControl: `public, max-age=${cacheAge}`,
+        },
+      };
+      await bucket.upload(filepath, options);
+      console.log(`Uploaded "${destination}"`);
+    }),
+  );
+  console.log('Upload complete.');
+}
+
+uploadFiles().catch(error => {
+  console.error('Error occurred:', error);
+  process.exit(1);
+});