Deploy cmd

.eslintrc

@@ -1,5 +1,5 @@
 {
-  "extends": "airbnb-base",
+  "extends": ["airbnb-base", "prettier"],
   "env": {
     "node": true,
     "mocha": true
@@ -9,9 +9,7 @@
     "no-underscore-dangle": [
       "error",
       {
-        "allow": [
-          "_id"
-        ]
+        "allow": ["_id"]
       }
     ],
     "import/no-named-as-default": 0

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true
+}

package.json

@@ -48,21 +48,25 @@
     "babel-eslint": "10.1.0",
     "eslint": "6.8.0",
     "eslint-config-airbnb-base": "14.1.0",
+    "eslint-config-prettier": "6.11.0",
     "eslint-plugin-import": "2.20.1",
     "husky": "4.2.3",
     "npm-run-all": "4.1.5",
     "standard-version": "7.1.0"
   },
   "dependencies": {
     "@babel/polyfill": "7.8.7",
+    "aws-sdk": "2.713.0",
     "bson-objectid": "1.3.0",
     "del": "4.1.1",
+    "dotenv": "8.2.0",
     "execa": "1.0.0",
     "fs-exists-cached": "1.0.0",
     "fs-extra": "7.0.1",
     "hosted-git-info": "2.7.1",
     "inquirer": "6.2.2",
     "lodash": "4.17.15",
+    "s3-node-client": "4.4.4",
     "yargs": "12.0.5"
   }
 }

src/createCli.js

@@ -1,14 +1,8 @@
 import yargs from 'yargs';
 import prompt from './prompt';
+import deploy from './deploy';
 import { DEFAULT_STARTER } from './config';
 
-const promisify = (fn) => (...args) => {
-  Promise.resolve(fn(...args)).then(
-    () => process.exit(0),
-    // err => report.panic(err)
-  );
-};
-
 const createCli = (argv) => {
   const cli = yargs();
 
@@ -33,25 +27,41 @@ const createCli = (argv) => {
     .command({
       command: 'new',
       desc: 'Create new Graasp app.',
-      builder: (_) => _.option('s', {
-        alias: 'starter',
-        type: 'string',
-        default: DEFAULT_STARTER,
-        describe: `Set starter. Defaults to ${DEFAULT_STARTER}`,
-      }).option('f', {
-        alias: 'framework',
-        type: 'string',
-        describe: 'Set development framework (e.g. React, Angular)',
-      }).option('t', {
-        alias: 'type',
-        choices: ['app', 'lab'],
-        describe: 'Type of application (app or lab)',
-      }).option('p', {
-        alias: 'path',
-        type: 'string',
-        describe: 'Path where project directory will be set up.',
-      }),
-      handler: promisify(prompt),
+      builder: (_) =>
+        _.option('s', {
+          alias: 'starter',
+          type: 'string',
+          default: DEFAULT_STARTER,
+          describe: `Set starter. Defaults to ${DEFAULT_STARTER}`,
+        })
+          .option('f', {
+            alias: 'framework',
+            type: 'string',
+            describe: 'Set development framework (e.g. React, Angular)',
+          })
+          .option('t', {
+            alias: 'type',
+            choices: ['app', 'lab'],
+            describe: 'Type of application (app or lab)',
+          })
+          .option('p', {
+            alias: 'path',
+            type: 'string',
+            describe: 'Path where project directory will be set up.',
+          }),
+      handler: prompt,
+    })
+    .command({
+      command: 'deploy',
+      desc: 'Deploy the Graasp app',
+      builder: (_) =>
+        _.option('p', {
+          alias: 'path',
+          type: 'string',
+          default: '.',
+          describe: 'Path to the Graasp app that shall be deployed',
+        }),
+      handler: deploy,
     })
     .wrap(cli.terminalWidth())
     .demandCommand(1, 'Pass --help to see all available commands and options.')
@@ -61,5 +71,4 @@ const createCli = (argv) => {
     .parse(argv.slice(2));
 };
 
-
 export default createCli;

src/deploy.js

@@ -0,0 +1,86 @@
+import AWS from 'aws-sdk';
+import s3 from 's3-node-client';
+import dotenv from 'dotenv';
+
+const path = require('path');
+
+// default build directory
+const BUILD = 'build/';
+
+/**
+ * Returns an object with all variables loaded from a environment
+ * @param {string} environmentName is the suffix after .env.*
+ */
+
+const deploy = async (opts) => {
+  // const { path } = opts;
+
+  const usageMessage = console.log(
+    'usage: $0 [-e <path/to/file>] [-v <version string>] [-b <path/to/build>]',
+  );
+
+  console.log(`Exectued with path: ${opts.path}`);
+  console.log(usageMessage);
+
+  // fetch environment variables
+  dotenv.config({ path: path.resolve(process.cwd(), '.env.dev') });
+  /* eslint-disable no-unused-vars */
+  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);
+    }
+  });
+
+  const APP_PATH = `${REACT_APP_GRAASP_DEVELOPER_ID}/${REACT_APP_GRAASP_APP_ID}/${REACT_APP_VERSION}`;
+
+  const client = s3.createClient({ s3Client: new AWS.S3() });
+
+  const params = {
+    localDir: BUILD,
+    deleteRemoved: true, // default false, whether to remove s3 objects
+    // that have no corresponding local file.
+
+    s3Params: {
+      Bucket: BUCKET,
+      Prefix: APP_PATH,
+      // other options supported by putObject, except Body and ContentLength.
+      // See: http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property
+    },
+  };
+  const uploader = client.uploadDir(params);
+  uploader.on('error', function (err) {
+    console.error('unable to sync:', err.stack);
+  });
+  uploader.on('progress', function () {
+    console.log('progress', uploader.progressAmount, uploader.progressTotal);
+  });
+  uploader.on('end', function () {
+    console.log('done uploading');
+  });
+
+  console.log(
+    `published app to https://${REACT_APP_HOST}/${APP_PATH}/index.html`,
+  );
+
+  return true;
+};
+
+export default deploy;

src/deploy.sh

@@ -0,0 +1,125 @@
+#!/bin/bash
+
+# fail the build on any failed command
+set -e
+
+usage() {
+  echo "usage: $0 [-e <path/to/file>] [-v <version string>] [-b <path/to/build>]" 1>&2
+  exit 1
+}
+
+# default build directory
+BUILD="build/"
+
+# default version
+REACT_APP_VERSION="latest"
+
+# validates versioning e.g. v0.1.0
+validate_version() {
+  # regex matching version numbers
+  rx='^v([0-9]+\.){0,2}(\*|[0-9]+)$'
+  if [[ $1 =~ $rx ]]; then
+    echo "info: validated version $1"
+    REACT_APP_VERSION=$1
+  else
+    echo "error: unable to validate version '$1'" 1>&2
+    echo "format is '${rx}'"
+    exit 1
+  fi
+}
+
+
+# validates that build directory exists
+validate_build() {
+  if [ -d $1 ]; then
+    echo "info: validated build directory $1"
+    BUILD=$1
+  else
+    echo "error: build directory '$1' does not exist" 1>&2
+    exit 1
+  fi
+}
+
+# validates that environment file exists
+validate_env() {
+  if [ -f $1 ]; then
+    echo "info: validated environment file $1"
+    source ${1}
+  else
+    echo "error: environment file '$1' does not exist" 1>&2
+    exit 1
+  fi
+}
+
+# parse command line arguments
+while getopts "e:v:b:" opt; do
+  case ${opt} in
+    e)
+      e=${OPTARG}
+      validate_env ${e}
+      ;;
+    b)
+      b=${OPTARG}
+      validate_build ${b}
+      ;;
+    v)
+      v=${OPTARG}
+      validate_version ${v}
+      ;;
+    \?)
+      echo "error: invalid option '-$OPTARG'" 1>&2
+      exit 1
+      ;;
+  esac
+done
+
+# ensure the correct variables are defined
+if \
+  [ -z "${REACT_APP_HOST}" ] || \
+  [ -z "${REACT_APP_GRAASP_DEVELOPER_ID}" ] || \
+  [ -z "${REACT_APP_GRAASP_APP_ID}" ]; then
+  echo "error: environment variables REACT_APP_GRAASP_APP_ID, REACT_APP_GRAASP_DEVELOPER_ID and/or REACT_APP_HOST are not defined" 1>&2
+  echo "error: you can specify them through a .env file in the app root folder" 1>&2
+  echo "error: or through another file specified with the -e flag" 1>&2
+  exit 1
+fi
+
+# ensure the correct aws credentials are defined
+if \
+  [ -z "${BUCKET}" ] || \
+  [ -z "${AWS_ACCESS_KEY_ID}" ] || \
+  [ -z "${AWS_SECRET_ACCESS_KEY}" ]; then
+  echo "error: environment variables BUCKET, AWS_ACCESS_KEY_ID and/or AWS_SECRET_ACCESS_KEY are not defined" 1>&2
+  echo "error: make sure you setup your credentials file correctly using the scripts/setup.sh script" 1>&2
+  echo "error: and contact your favourite Graasp engineer if you keep running into trouble" 1>&2
+  exit 1
+fi
+
+export AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
+export AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}
+
+echo "info: publishing app ${REACT_APP_GRAASP_APP_ID} version ${REACT_APP_VERSION}"
+
+APP_DIR=${BUCKET}/${REACT_APP_GRAASP_DEVELOPER_ID}/${REACT_APP_GRAASP_APP_ID}/${REACT_APP_VERSION}/
+
+# make sure you do not use the word PATH as a variable because it overrides the PATH environment variable
+APP_PATH=${REACT_APP_GRAASP_DEVELOPER_ID}/${REACT_APP_GRAASP_APP_ID}/${REACT_APP_VERSION}
+
+# sync s3 bucket
+aws s3 sync ${BUILD} s3://${APP_DIR} --delete
+
+# todo: allow cache invalidations per app once it is supported by cloudfront
+# see: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html
+
+# ensure the correct distribution variables are defined
+if \
+  [ -z "${DISTRIBUTION}" ]; then
+  echo "error: environment variable DISTRIBUTION is not defined" 1>&2
+  echo "error: contact your favourite Graasp engineer if you keep running into trouble" 1>&2
+  exit 1
+fi
+
+# invalidate cloudfront distribution
+aws cloudfront create-invalidation --distribution-id ${DISTRIBUTION} --paths /${APP_PATH}/*
+
+echo "published app to https://${REACT_APP_HOST}/${APP_PATH}/index.html"

src/utils.js

@@ -1,5 +1,7 @@
 import execa from 'execa';
 
+// TODO: this is not optimal naming since it may cause confusion with 'spawn()' from 'child_process' module;
+
 // use execa to spawn a better child process
 /* eslint-disable-next-line import/prefer-default-export */
 export const spawn = (cmd, opts = { stdio: 'inherit' }) => {