Deploy cmd

.eslintrc

@@ -12,6 +12,7 @@
         "allow": ["_id"]
       }
     ],
-    "import/no-named-as-default": 0
+    "no-console": "off",
+    "import/no-named-as-default": "off"
   }
 }

package.json

@@ -58,6 +58,7 @@
     "@babel/polyfill": "7.8.7",
     "aws-sdk": "2.713.0",
     "bson-objectid": "1.3.0",
+    "cli-progress": "3.8.2",
     "del": "4.1.1",
     "dotenv": "8.2.0",
     "execa": "1.0.0",

src/config.js

@@ -14,3 +14,8 @@ export const AWS_SECRET_ACCESS_KEY_LENGTH = 40;
 
 // file names
 export const GRAASP_IGNORE_FILE = '.graaspignore';
+
+// deploy settings
+export const DEFAULT_BUILD_DIR = 'build/';
+export const DEFAULT_APP_VERSION = 'latest';
+export const DEFAULT_ENV = '.env.dev';

src/createCli.js

@@ -1,7 +1,12 @@
 import yargs from 'yargs';
 import prompt from './prompt';
 import deploy from './deploy';
-import { DEFAULT_STARTER } from './config';
+import {
+  DEFAULT_STARTER,
+  DEFAULT_BUILD_DIR,
+  DEFAULT_APP_VERSION,
+  DEFAULT_ENV,
+} from './config';
 
 const createCli = (argv) => {
   const cli = yargs();
@@ -53,14 +58,26 @@ const createCli = (argv) => {
     })
     .command({
       command: 'deploy',
-      desc: 'Deploy the Graasp app',
+      desc: 'Deploy a Graasp app to AWS',
       builder: (_) =>
-        _.option('p', {
-          alias: 'path',
+        _.option('t', {
+          alias: 'tag',
           type: 'string',
-          default: '.',
-          describe: 'Path to the Graasp app that shall be deployed',
-        }),
+          default: DEFAULT_APP_VERSION,
+          describe: 'Tag the deployment with a version',
+        })
+          .option('e', {
+            alias: 'env',
+            type: 'string',
+            default: DEFAULT_ENV,
+            describe: 'Environment used to load variables from',
+          })
+          .option('b', {
+            alias: 'build',
+            type: 'string',
+            default: DEFAULT_BUILD_DIR,
+            describe: 'Path to the build directory that is deployed',
+          }),
       handler: deploy,
     })
     .wrap(cli.terminalWidth())

src/deploy.js

@@ -1,51 +1,109 @@
 import AWS from 'aws-sdk';
 import s3 from 's3-node-client';
 import dotenv from 'dotenv';
+import fs from 'fs';
+import cliProgress from 'cli-progress';
 
-const path = require('path');
+const validateTag = (tag) => {
+  // Both compilation hints because of backslashes used in RegExp but unecessary by conception in JS Strings
+  // prettier-ignore
+  // eslint-disable-next-line no-useless-escape
+  const pattern = new RegExp('v\\d+(\.\\d+){0,2}$');
+  if (tag === 'latest' || pattern.test(tag)) {
+    console.log(`info: validated tag ${tag}`);
+    return true;
+  }
+  console.error(`error: unable to validate version '${tag}'`);
+  return false;
+};
 
-// default build directory
-const BUILD = 'build/';
+const validateEnv = (env) => {
+  if (fs.existsSync(env)) {
+    console.log(`info: validated environment file ${env}`);
+    return true;
+  }
+  console.log(`error: environment file '${env}' does not exist`);
+  return false;
+};
 
-/**
- * Returns an object with all variables loaded from a environment
- * @param {string} environmentName is the suffix after .env.*
- */
+const validateBuild = (build) => {
+  if (fs.existsSync(build)) {
+    console.log(`info: validated build directory ${build}`);
+    return true;
+  }
+  console.log(`error: build directory '${build}' does not exist`);
+  return false;
+};
 
-const deploy = async (opts) => {
-  // const { path } = opts;
+const isDefined = (variable) => {
+  return typeof variable !== 'undefined';
+};
 
-  const usageMessage = console.log(
-    'usage: $0 [-e <path/to/file>] [-v <version string>] [-b <path/to/build>]',
-  );
+const deploy = async (opts) => {
+  const { tag, env, build } = opts;
 
-  console.log(`Exectued with path: ${opts.path}`);
-  console.log(usageMessage);
+  // Validate command options
+  if (!validateTag(tag) || !validateEnv(env) || !validateBuild(build)) {
+    console.error('Abort...');
+    return false;
+  }
 
   // fetch environment variables
-  dotenv.config({ path: path.resolve(process.cwd(), '.env.dev') });
-  /* eslint-disable no-unused-vars */
+  // dotenv.config({ path: path.resolve(process.cwd(), '.env.dev') });
+  dotenv.config({ path: env });
   const {
     REACT_APP_GRAASP_DEVELOPER_ID,
     REACT_APP_GRAASP_APP_ID,
-    REACT_APP_GRAASP_DOMAIN,
     REACT_APP_HOST,
     REACT_APP_VERSION,
-    REACT_APP_BASE,
-    NODE_ENV,
     BUCKET,
-    AWS_DEFAULT_REGION,
     AWS_ACCESS_KEY_ID,
     AWS_SECRET_ACCESS_KEY,
     DISTRIBUTION,
   } = process.env;
-  /* eslint-enable no-unused-vars */
 
-  AWS.config.getCredentials(function (err) {
-    if (err) console.error(err.stack);
-    // credentials not loaded
-    else {
-      console.log('Access key:', AWS.config.credentials.accessKeyId);
+  // ensure the correct app variables are defined
+  if (
+    !isDefined(REACT_APP_HOST) ||
+    !isDefined(REACT_APP_GRAASP_DEVELOPER_ID) ||
+    !isDefined(REACT_APP_GRAASP_APP_ID)
+  ) {
+    console.error(
+      'error: environment variables REACT_APP_GRAASP_APP_ID, REACT_APP_GRAASP_DEVELOPER_ID and/or REACT_APP_HOST are not defined',
+    );
+    console.error(
+      'error: you can specify them through a .env file in the app root folder',
+    );
+    console.error('error: or through another file specified with the -e flag');
+    return false;
+  }
+
+  // ensure the correct aws credentials are defined
+  if (
+    !isDefined(BUCKET) ||
+    !isDefined(AWS_ACCESS_KEY_ID) ||
+    !isDefined(AWS_SECRET_ACCESS_KEY)
+  ) {
+    console.error(
+      'error: environment variables BUCKET, AWS_ACCESS_KEY_ID and/or AWS_SECRET_ACCESS_KEY are not defined',
+    );
+    console.error(
+      'error: make sure you setup your credentials file correctly using the scripts/setup.sh script',
+    );
+    console.error(
+      'error: and contact your favourite Graasp engineer if you keep running into trouble',
+    );
+  }
+
+  console.log(
+    `info: publishing app ${REACT_APP_GRAASP_APP_ID} version ${REACT_APP_VERSION}`,
+  );
+
+  // configure the deployment
+  AWS.config.getCredentials((err) => {
+    if (err) {
+      // credentials not loaded
+      console.error(err.stack);
     }
   });
 
@@ -54,7 +112,7 @@ const deploy = async (opts) => {
   const client = s3.createClient({ s3Client: new AWS.S3() });
 
   const params = {
-    localDir: BUILD,
+    localDir: build,
     deleteRemoved: true, // default false, whether to remove s3 objects
     // that have no corresponding local file.
 
@@ -65,21 +123,56 @@ const deploy = async (opts) => {
       // See: http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property
     },
   };
+  const progressBar = new cliProgress.SingleBar(
+    {},
+    cliProgress.Presets.shades_classic,
+  );
   const uploader = client.uploadDir(params);
-  uploader.on('error', function (err) {
+  uploader.on('error', (err) => {
     console.error('unable to sync:', err.stack);
   });
-  uploader.on('progress', function () {
-    console.log('progress', uploader.progressAmount, uploader.progressTotal);
+  uploader.on('progress', () => {
+    progressBar.start(uploader.progressTotal, 0);
+    progressBar.update(uploader.progressAmount);
   });
-  uploader.on('end', function () {
-    console.log('done uploading');
+  uploader.on('end', () => {
+    progressBar.stop();
+    // TODO: insert here code that should be executed once the upload is done
+    //       e.g. invalidate cache
   });
 
   console.log(
-    `published app to https://${REACT_APP_HOST}/${APP_PATH}/index.html`,
+    `info: published app to https://${REACT_APP_HOST}/${APP_PATH}/index.html`,
   );
 
+  // ensure the correct distribution variables are defined
+  if (!isDefined(DISTRIBUTION)) {
+    console.error('error: environment variable DISTRIBUTION is not defined');
+    console.error(
+      'error: contact your favourite Graasp engineer if you keep running into trouble',
+    );
+    return false;
+  }
+
+  // invalidate cloudfront distribution
+  const pathsToInvalidate = [`/${APP_PATH}/*`];
+  const invalidationParams = {
+    DistributionId: DISTRIBUTION,
+    InvalidationBatch: {
+      CallerReference: new Date().toString(),
+      Paths: {
+        Quantity: pathsToInvalidate.length,
+        Items: pathsToInvalidate,
+      },
+    },
+  };
+  const cloudfront = new AWS.CloudFront();
+  cloudfront.createInvalidation(invalidationParams, (err, data) => {
+    if (err) console.log(err, err.stack);
+    // an error occurred
+    else console.log(data); // successful response
+  });
+
   return true;
 };