Merge pull request #1 from ara-framework/develop

marconi1992 · web-flow · commit 49ed1115534e · 2019-08-27T07:33:37.000-06:00
Latest changes
diff --git a/.eslintrc b/.eslintrc
@@ -1,5 +1,8 @@
 {
   "extends": [
     "airbnb-base"
-  ]
+  ],
+  "rules": {
+    "no-console": 0
+  }
 }
diff --git a/.gitignore b/.gitignore
@@ -32,15 +32,6 @@ lib
 npm-shrinkwrap.json
 yarn.lock
 package-lock.json
-© 2019 GitHub, Inc.
-Terms
-Privacy
-Security
-Status
-Help
-Contact GitHub
-Pricing
-API
-Training
-Blog
-About
+
+# Ara bins
+.ara
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ You can install the package from npm.
 npm i -g ara-cli
 ```
 
-##Usage
+## Usage
 
 ### Create Ara Project
 
@@ -21,11 +21,58 @@ ara new:project ara-demo
 ### Create Nova Microfrontend
 
 ```bash
-ara new:nova
+ara new:nova <project-folder>
 ```
 
-By default the scaffolding for nova uses a Vue.js template but you can use more passing the flah `-t, --template`
+By default the scaffolding for nova uses a Vue.js template but you can use more passing the flag `-t, --template`
+
+Supported templates:
+- vue
+- angular
+- svelte
+- preact
+- hyperapp
 
 ```bash
-ara new:nova -t angular
+ara new:nova -t angular <nova-folder>
+```
+
+### Run Hypernova (Nova) Lambda locally
+
+Run command:
+
+```shell
+ara run:lambda
+```
+
+Serve the client script locally using an S3 local server:
+
+```shell
+ara run:lambda --asset
+```
+
+### Run Nova Proxy
+
+Nova Proxy needs a configuration file:
+
+```json
+{
+  "locations": [
+    {
+      "path": "/",
+      "host": "http://localhost:8000",
+      "modifyResponse": true
+    }
+  ]
+}
+
+Before to run the command we need to set the `HYPERNOVA_BATCH` variable using the Nova service endpoint.
+
+```shell
+export HYPERNOVA_BATCH=http://localhost:3000/batch
+```
+
+The command uses a configuration file named `nova-proxy.json` in the folder where the command is running, otherwise you need to pass the `--config` parameter with a different path.
+```
+ara run:proxy --config ./nova-proxy.json
 ```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ara-cli",
-  "version": "0.1.0",
+  "version": "1.0.0-alpha.1",
   "description": "Ara Framework Command Line Interface",
   "keywords": [
     "ara",
@@ -21,10 +21,17 @@
     "lint": "eslint ."
   },
   "dependencies": {
+    "aws-sdk": "^2.509.0",
     "cac": "^6.5.2",
     "chalk": "^2.4.2",
+    "download": "^7.1.0",
+    "execa": "^2.0.4",
     "majo": "^0.7.1",
-    "sao": "^1.6.1"
+    "ora": "^3.4.0",
+    "s3rver": "^3.3.0",
+    "sao": "^1.6.1",
+    "serverless-offline": "^5.10.1",
+    "webpack": "^4.39.2"
   },
   "devDependencies": {
     "eslint": "^5.16.0",
diff --git a/src/generators/project/template/.ara/cluster/Dockerfile b/src/generators/project/template/.ara/cluster/Dockerfile
@@ -0,0 +1,3 @@
+FROM marconi1992/nova-cluster:1.1.0
+
+COPY views.json views.json
diff --git a/src/generators/project/template/.ara/cluster/views.json b/src/generators/project/template/.ara/cluster/views.json
@@ -0,0 +1 @@
+{}
diff --git a/src/generators/project/template/.ara/proxy/Dockerfile b/src/generators/project/template/.ara/proxy/Dockerfile
@@ -0,0 +1,5 @@
+FROM marconi1992/hypernova-proxy:1.0.2
+
+COPY config.json config.json
+
+ENV CONFIG_FILE=config.json
diff --git a/src/generators/project/template/.ara/proxy/config.json b/src/generators/project/template/.ara/proxy/config.json
@@ -0,0 +1,3 @@
+{
+  "locations": []
+}
diff --git a/src/generators/project/template/.gitignore b/src/generators/project/template/.gitignore
diff --git a/src/index.js b/src/index.js
@@ -1,10 +1,12 @@
 #!/usr/bin/env node
 const cli = require('cac')();
-
-const path = require('path');
 const sao = require('sao');
+const path = require('path');
 
 const generateProject = require('./generators/project');
+const runLambda = require('./run/lambda');
+const serveAsset = require('./run/asset');
+const runProxy = require('./run/proxy');
 
 cli.command('new:project <outDir>', 'New Project')
   .action(outDir => generateProject(outDir));
@@ -15,11 +17,32 @@ cli.command('new:nova <outDir>', 'New Micro-Frontend')
     const appPath = path.join(process.cwd(), outDir);
     const options = {
       outDir: appPath,
+      update: true,
       generator: `ara-framework/create-hypernova-${template}`,
     };
 
     return sao(options)
       .run();
   });
 
+cli.command('run:lambda', 'Run Hypernova lambda function')
+  .option('-h, --handler <handler>', 'Template Type.')
+  .option('--asset', 'Serves client-side entry point.')
+  .action(({ handler = 'handler', asset }) => {
+    const webpackfile = path.join(process.cwd(), 'webpack.config.js');
+    let webpackConf = require(webpackfile);// eslint-disable-line
+
+    webpackConf = Array.isArray(webpackConf) ? webpackConf : [webpackConf];
+
+    runLambda(handler, webpackConf);
+
+    if (asset) {
+      serveAsset(webpackConf);
+    }
+  });
+
+cli.command('run:proxy', 'Run Nova Proxy')
+  .option('--config [config]', 'Configuration file')
+  .action(({ config = './nova-proxy.json' }) => runProxy(config, path.join(__dirname, '../.ara')));
+
 cli.parse();
diff --git a/src/run/asset.js b/src/run/asset.js
@@ -0,0 +1,70 @@
+/* eslint-disable global-require, import/no-unresolved */
+const chalk = require('chalk');
+const fs = require('fs');
+const path = require('path');
+
+const corsConfig = require.resolve('s3rver/example/cors.xml');
+const defaultBucket = 'assets';
+
+module.exports = (webpackConf) => {
+  const [clientConf] = webpackConf.filter(conf => conf.target === 'web');
+
+  if (!clientConf) {
+    throw Error('Missing webpack configuration with target set as "web"');
+  }
+
+  const webpack = require('webpack');
+  const S3rver = require('s3rver');
+  const AWS = require('aws-sdk');
+
+  const compiler = webpack({
+    ...clientConf,
+    mode: 'development',
+    stats: 'verbose',
+  });
+
+  const s3rver = new S3rver({
+    directory: path.join(process.cwd(), '.ara/s3'),
+    configureBuckets: [
+      {
+        name: defaultBucket,
+        configs: [fs.readFileSync(corsConfig)],
+      },
+    ],
+  });
+
+  s3rver.run((err, { address, port } = {}) => {
+    if (err) {
+      console.error(err);
+    } else {
+      console.log(chalk.green(`S3 server listening on http://${address}:${port}`));
+
+      const outputPath = (clientConf.output && clientConf.output.path) || path.join(process.pwd(), 'dist');
+      const fileName = (clientConf.output && clientConf.output.fileName) || 'client.js';
+
+      const s3 = new AWS.S3({
+        accessKeyId: 'S3RVER',
+        secretAccessKey: 'S3RVER',
+        region: 'local',
+        s3ForcePathStyle: true,
+        endpoint: new AWS.Endpoint(`http://${address}:${port}`),
+      });
+
+      compiler.watch({}, (error) => {
+        if (error) {
+          throw error;
+        }
+
+        return s3.putObject({
+          Key: fileName,
+          Bucket: defaultBucket,
+          ACL: 'public-read',
+          ContentType: 'text/javascript',
+          Body: fs.readFileSync(path.join(outputPath, fileName)),
+        }).promise()
+          .catch(e => console.error(e))
+          .then(() => console.log(chalk.green(`Client script in "${defaultBucket}" bucket`)));
+      });
+    }
+  });
+};
diff --git a/src/run/lambda.js b/src/run/lambda.js
@@ -0,0 +1,93 @@
+/* eslint-disable global-require, import/no-unresolved, no-underscore-dangle */
+const path = require('path');
+const chalk = require('chalk');
+
+module.exports = (handler, webpackConf) => {
+  console.log(chalk.green('Running nova:lambda'));
+
+  const webpack = require('webpack');
+  const ServerlessOffline = require('serverless-offline/src/ServerlessOffline');
+
+  const [serverConf] = webpackConf.filter(conf => conf.target === 'node');
+
+  if (!serverConf) {
+    throw Error('Missing webpack configuration with target set as "node"');
+  }
+
+  const compiler = webpack({
+    ...serverConf,
+    output: {
+      ...(serverConf.output || {}),
+      libraryTarget: 'commonjs',
+    },
+    mode: 'development',
+  });
+
+  const outputPath = (serverConf.output && serverConf.output.path) || path.join(process.pwd(), 'dist');
+  let fileName = (serverConf.output && serverConf.output.fileName) || 'server.js';
+  fileName = fileName.split('.').shift();
+
+  const handlerPath = `${path.relative(process.cwd(), outputPath)}/${fileName}`;
+
+  let isWatching = false;
+  const serverless = {
+    version: '1.48.1',
+    service: {
+      service: 'hypernova-lambda',
+      provider: {
+        runtime: 'nodejs8.10',
+      },
+      functions: {
+        batch: {
+          handler: `${handlerPath}.${handler}`,
+          events: [
+            {
+              http: {
+                path: 'batch',
+                method: 'POST',
+              },
+            },
+          ],
+        },
+      },
+    },
+    cli: {
+      log: (...args) => console.log(chalk.yellow(...args)),
+    },
+    config: {
+      servicePath: process.cwd(),
+    },
+  };
+
+  serverless.service.getFunction = (key) => {
+    const fun = serverless.service.functions[key];
+
+    if (!fun) {
+      return null;
+    }
+    return {
+      ...fun,
+      name: key,
+    };
+  };
+
+  compiler.watch({}, (error) => {
+    if (error) {
+      throw error;
+    }
+
+    if (isWatching) {
+      console.log(chalk.yellow('Lambda code compiled.'));
+      return Promise.resolve();
+    }
+
+    const slsOffline = new ServerlessOffline(serverless, { stage: 'ara', region: 'local' });
+
+    isWatching = true;
+
+    return Promise.resolve(slsOffline._buildServer())
+      .then(server => server.start());
+  });
+
+  return compiler;
+};
diff --git a/src/run/proxy.js b/src/run/proxy.js

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": [`
`3`	`3`	`"airbnb-base"`
`4`		`- ]`
	`4`	`+ ],`
	`5`	`+ "rules": {`
	`6`	`+ "no-console": 0`
	`7`	`+ }`
`5`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+FROM marconi1992/nova-cluster:1.1.0`
	`2`	`+`
	`3`	`+COPY views.json views.json`