Merge pull request #25 from irvinlim/0.4.0

irvinlim · web-flow · commit fd2cc0401eae · 2018-01-29T04:13:14.000+08:00
0.4.0
diff --git a/.babelrc b/.babelrc
@@ -19,6 +19,7 @@
                 "commentEnd": "\n "
             }
         ],
+        "transform-es2015-modules-commonjs",
         "transform-es2017-object-entries",
         "transform-object-rest-spread",
         "transform-es2015-destructuring",
diff --git a/README.md b/README.md
@@ -4,9 +4,9 @@
 
 [![Travis CI](https://img.shields.io/travis/irvinlim/es2017-lambda-boilerplate.svg)](https://travis-ci.org/irvinlim/es2017-lambda-boilerplate) ![](https://codebuild.ap-southeast-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiNlhFcld3M3VSMFM0MEkzUlBMQk1FdDU1c1RGc2dnVlpNaDdFZHlzSnQydDVJNm9RVFhxbXA3NkYxK3QwUVd4eVZyUTRiejZ1UGhRTFJYMTJJSzNLT2ZBPSIsIml2UGFyYW1ldGVyU3BlYyI6ImRFMWxLcHo2LzJmb3YycGEiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master) [![David](https://img.shields.io/david/irvinlim/es2017-lambda-boilerplate.svg)](https://david-dm.org/irvinlim/es2017-lambda-boilerplate) [![David](https://img.shields.io/david/dev/irvinlim/es2017-lambda-boilerplate.svg)](https://david-dm.org/irvinlim/es2017-lambda-boilerplate?type=dev) [![Greenkeeper badge](https://badges.greenkeeper.io/irvinlim/es2017-lambda-boilerplate.svg)](https://greenkeeper.io/) [![GitHub](https://img.shields.io/github/release/irvinlim/es2017-lambda-boilerplate.svg)](https://github.com/irvinlim/es2017-lambda-boilerplate/releases) [![The MIT License](https://img.shields.io/badge/license-MIT-orange.svg)](http://opensource.org/licenses/MIT)
 
-This is a boilerplate for [AWS Lambda](https://aws.amazon.com/lambda/) Node.js 6.10.0 functions, which allows you to use the latest JavaScript [ES2017/ES8 features](https://hackernoon.com/es8-was-released-and-here-are-its-main-new-features-ee9c394adf66). The boilerplate also allows you to test your function in a Docker container (thanks to [docker-lambda](https://github.com/lambci/docker-lambda)), and also includes common configurations for CI/CD, for both [Travis CI](https://travis-ci.org/) and [AWS CodeBuild](https://aws.amazon.com/codebuild/) + [AWS CloudFormation](https://aws.amazon.com/cloudformation/).
+This is a boilerplate for [AWS Lambda](https://aws.amazon.com/lambda/) Node.js 6.10.0 functions, which allows you to use the latest JavaScript [ES2016](http://2ality.com/2016/01/ecmascript-2016.html), [ES2017](http://2ality.com/2016/02/ecmascript-2017.html) and [ES2018](http://2ality.com/2017/02/ecmascript-2018.html) features. The boilerplate also allows you to test your function in a Docker container (thanks to [docker-lambda](https://github.com/lambci/docker-lambda)), and also includes common configurations for CI/CD, for both [Travis CI](https://travis-ci.org/) and [AWS CodeBuild](https://aws.amazon.com/codebuild/) + [AWS CloudFormation](https://aws.amazon.com/cloudformation/).
 
-## ES2017 features
+## Latest JavaScript features
 
 This boilerplate adds support for the following most commonly used JavaScript features that are not natively supported on Node.js 6.10:
 
@@ -19,8 +19,8 @@ This boilerplate adds support for the following most commonly used JavaScript fe
 | [`Object.values`](http://node.green/#ES2017-features-Object-static-methods-Object-values), [`Object.entries`](http://node.green/#ES2017-features-Object-static-methods-Object-entries) | :white_check_mark: |
 | [Trailing commas in function syntax](http://node.green/#ES2017-features-trailing-commas-in-function-syntax)                                                                            | :white_check_mark: |
 | [`async`/`await`](http://node.green/#ES2017-features-async-functions)                                                                                                                  | :white_check_mark: |
-| **ESNEXT**                                                                                                                                                                             |                    |
-| [Object rest/spread properties](http://node.green/#ESNEXT-candidate--stage-3--object-rest-spread-properties)                                                                           | :white_check_mark: |
+| **ES2018/ES9**                                                                                                                                                                         |                    |
+| [Object rest/spread properties](http://node.green/#ES2018-features-object-rest-spread-properties)                                                                                      | :white_check_mark: |
 
 _Note: Most ES2015/ES6 are earlier features are supported._
 
@@ -84,7 +84,7 @@ To modify the build process, you can update the CodeBuild configuration file at
 If you are new to AWS CI/CD tools, you can follow the official [AWS tutorial](http://docs.aws.amazon.com/lambda/latest/dg/build-pipeline.html) to set up a build pipeline using CodePipeline. Take note of the following:
 
 * Set up a S3 bucket for uploading CodeBuild artifacts to.
-  * If the CodeBuild build fails, you may need to set the `S3_BUCKET` environment variable within CodeBuild directly.
+    * If the CodeBuild build fails, you may need to set the `S3_BUCKET` environment variable within CodeBuild directly.
 * Ensure that the IAM roles have the necessary permissions to access required resources, including the S3 bucket.
 * The CloudFormation template filename under CodePipeline settings should be `template.yml`.
 
@@ -115,7 +115,7 @@ Remember to add more permissions as required if you need to access the SDK in yo
 
 ## Why?
 
-### Latest ES2017/ES2016 features
+### Reduce callback hell with `async`/`await`
 
 The highest version of Node.js supported on AWS Lambda is 6.10.0, which supports only features up to ES2015/ES6. Newer features in ES2017, such as `async`/`await`, are incredibly useful when performing network requests, such as when used with the [AWS SDK](https://github.com/aws/aws-sdk-js):
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "es2017-lambda-boilerplate",
     "description": "An ES2017 boilerplate for AWS Lambda (Node.js 6.10)",
-    "version": "0.3.1",
+    "version": "0.4.0",
     "license": "MIT",
     "repository": {
         "type": "git",
@@ -14,6 +14,7 @@
         "babel-plugin-add-header-comment": "^1.0.3",
         "babel-plugin-array-includes": "^2.0.3",
         "babel-plugin-transform-es2015-destructuring": "^6.23.0",
+        "babel-plugin-transform-es2015-modules-commonjs": "^6.26.0",
         "babel-plugin-transform-es2017-object-entries": "0.0.4",
         "babel-plugin-transform-object-rest-spread": "^6.26.0",
         "babel-preset-env": "^1.6.1",
@@ -36,7 +37,7 @@
         "deploy": "npm run package && npm run deploy:run",
         "deploy:run": "babel-node ./bin/deploy.js",
         "package": "npm run build && npm run package:pack",
-        "package:pack": "rm -f artifact.zip && cd dist/ && zip -r ../artifact.zip *",
+        "package:pack": "rm -f artifact.zip && cd dist/ && zip -r ../artifact.zip * -x package.json package-lock.json",
         "spec": "npm run spec:snapshot && npm run spec:functional",
         "spec:snapshot": "jest spec/snapshot",
         "spec:functional": "jest spec/functional",
diff --git a/spec/functional/__fixtures__/es2018-object-rest-spread-properties/object-rest.js b/spec/functional/__fixtures__/es2018-object-rest-spread-properties/object-rest.js
diff --git a/spec/functional/__fixtures__/es2018-object-rest-spread-properties/object-spread.js b/spec/functional/__fixtures__/es2018-object-rest-spread-properties/object-spread.js
diff --git a/spec/functional/es2018-object-rest-spread-properties.test.js b/spec/functional/es2018-object-rest-spread-properties.test.js
@@ -0,0 +1,22 @@
+/**
+ * Functional tests for object rest/spread properties
+ *
+ * @see http://node.green/#ES2018-features-object-rest-spread-properties
+ */
+
+const runTest = require('./utils/runner');
+const path = filename => `es2018-object-rest-spread-properties/${filename}.js`;
+
+/**
+ * @see http://node.green/#ES2018-features-object-rest-spread-properties-object-rest-properties
+ */
+it('object rest properties', function() {
+    expect(runTest(path('object-rest'))).toEqual(true);
+});
+
+/**
+ * @see http://node.green/#ES2018-features-object-rest-spread-properties-object-spread-properties
+ */
+it('object spread properties', function() {
+    expect(runTest(path('object-spread'))).toEqual(true);
+});
diff --git a/spec/functional/esnext-object-rest-spread-properties.test.js b/spec/functional/esnext-object-rest-spread-properties.test.js
diff --git a/spec/snapshot/__snapshots__/es2018-object-rest-spread.test.js.snap b/spec/snapshot/__snapshots__/es2018-object-rest-spread.test.js.snap
diff --git a/spec/snapshot/es2016-array-includes.test.js b/spec/snapshot/es2016-array-includes.test.js
@@ -1,4 +1,4 @@
-const { transform } = require('./__utils__');
+const { transform } = require('./utils');
 
 it('array literal expression', () => {
     const code = transform('[1, 2, 3].includes(1)');
diff --git a/spec/snapshot/es2016-exponentiation.test.js b/spec/snapshot/es2016-exponentiation.test.js
@@ -1,4 +1,4 @@
-const { transform } = require('./__utils__');
+const { transform } = require('./utils');
 
 it('expression with primitives', () => {
     const code = transform('2 ** 10');
diff --git a/spec/snapshot/es2017-async-await.test.js b/spec/snapshot/es2017-async-await.test.js
@@ -1,4 +1,4 @@
-const { transform } = require('./__utils__');
+const { transform } = require('./utils');
 
 it('async named function', () => {
     const code = transform(`
diff --git a/spec/snapshot/es2017-object-entries.test.js b/spec/snapshot/es2017-object-entries.test.js
@@ -1,4 +1,4 @@
-const { transform } = require('./__utils__');
+const { transform } = require('./utils');
 
 it('object literal', () => {
     const code = transform('Object.entries({ a: 1, b: 2 });');
diff --git a/spec/snapshot/es2017-object-values.test.js b/spec/snapshot/es2017-object-values.test.js
@@ -1,4 +1,4 @@
-const { transform } = require('./__utils__');
+const { transform } = require('./utils');
 
 it('object literal', () => {
     const code = transform('Object.values({ a: 1, b: 2 });');
diff --git a/spec/snapshot/es2017-trailing-function-commas.test.js b/spec/snapshot/es2017-trailing-function-commas.test.js
@@ -1,4 +1,4 @@
-const { transform } = require('./__utils__');
+const { transform } = require('./utils');
 
 // Trailing commas in function expression signature
 
diff --git a/spec/snapshot/es2018-object-rest-spread.test.js b/spec/snapshot/es2018-object-rest-spread.test.js
@@ -1,4 +1,4 @@
-const { transform } = require('./__utils__');
+const { transform } = require('./utils');
 
 it('object spread properties', () => {
     const code = transform('var x = { a: 1, b: 2 }; var y = { a: 3, ...x };');
diff --git a/spec/snapshot/utils/index.js b/spec/snapshot/utils/index.js
diff --git a/src/main.js b/src/main.js
@@ -21,6 +21,8 @@ export default (event, context) => {
             return restApiExample(event.data, context);
         case 'aws-sdk-example':
             return awsSdkExample(event.data, context);
+        case 'integration-test-example':
+            return integrationTestExample(event.data, context);
     }
 };
 
@@ -43,6 +45,36 @@ const restApiExample = async (data, context) => {
 const awsSdkExample = async (data, context) => {
     const EC2 = new AWS.EC2();
 
+    // return [
+    //     AWS.config.accessKeyId,
+    //     process.env.AWS_ACCESS_KEY_ID,
+    //     AWS.config.secretAccessKey,
+    //     process.env.AWS_SECRET_ACCESS_KEY,
+    // ];
+
     // Sample EC2 call.
     return await EC2.describeInstances().promise();
 };
+
+// Sample function used for integration testing against each ES2016/7 feature
+// purportedly supported by the boilerplate.
+const integrationTestExample = (data, context) => {
+    let value;
+
+    switch (data.function) {
+        case 'Object.values':
+            return Object.values(data.value);
+        case 'Object.entries':
+            return Object.entries(data.value);
+        case 'Array.prototype.includes':
+            return data.value.includes(data.value2);
+        case 'Exponentiation':
+            return data.value ** data.value2;
+        case 'Object spread properties':
+            const { value } = data;
+            return value;
+        case 'Object rest properties':
+            const { child, ...rest } = data.value;
+            return rest;
+    }
+};
diff --git a/test/integration.test.js b/test/integration.test.js
@@ -0,0 +1,117 @@
+/**
+ * Runs integration tests for each ES2017/ES2016 feature that
+ * is purportedly supported by the boilerplate.
+ * The difference between this and the specification tests is
+ * that while specification tests ensure that the Babel config
+ * is correct, integration tests ensure that the rest of the
+ * Javascript boilerplate code for the Lambda is working as expected
+ * and does not crash/fail to transpile.
+ *
+ * NOTE: You should remove this in your actual production code.
+ * This is only for testing the boilerplate.
+ */
+
+import run from './util/runner';
+
+it('should call Object.entries correctly', function() {
+    const event = {
+        type: 'integration-test-example',
+        data: {
+            function: 'Object.entries',
+            value: {
+                hello: 'world',
+                number: 100,
+                isTrue: true,
+            },
+        },
+    };
+
+    const result = run(event);
+
+    expect(result).toEqual([
+        ['hello', 'world'],
+        ['number', 100],
+        ['isTrue', true],
+    ]);
+});
+
+it('should call Object.values correctly', function() {
+    const event = {
+        type: 'integration-test-example',
+        data: {
+            function: 'Object.values',
+            value: {
+                hello: 'world',
+                number: 100,
+                isTrue: true,
+            },
+        },
+    };
+
+    const result = run(event);
+
+    expect(result).toEqual(['world', 100, true]);
+});
+
+it('should call Array.prototype.includes correctly', function() {
+    const event = {
+        type: 'integration-test-example',
+        data: {
+            function: 'Array.prototype.includes',
+            value: [1, 5, 70, 3, 54],
+            value2: 3,
+        },
+    };
+
+    const result = run(event);
+
+    expect(result).toEqual(true);
+});
+
+it('should call Exponentiation correctly', function() {
+    const event = {
+        type: 'integration-test-example',
+        data: {
+            function: 'Exponentiation',
+            value: 2,
+            value2: 10,
+        },
+    };
+
+    const result = run(event);
+
+    expect(result).toEqual(1024);
+});
+
+it('should call Object spread properties correctly', function() {
+    const event = {
+        type: 'integration-test-example',
+        data: {
+            function: 'Object spread properties',
+            value: {
+                hello: 'world',
+            },
+        },
+    };
+
+    const result = run(event);
+
+    expect(result).toEqual({ hello: 'world' });
+});
+
+it('should call Object rest properties correctly', function() {
+    const event = {
+        type: 'integration-test-example',
+        data: {
+            function: 'Object rest properties',
+            value: {
+                child: 'first',
+                otherChild: 'second',
+            },
+        },
+    };
+
+    const result = run(event);
+
+    expect(result).toEqual({ otherChild: 'second' });
+});
diff --git a/test/util/runner.js b/test/util/runner.js
@@ -19,10 +19,12 @@ function run(event) {
             // Pass an event to the Lambda function.
             event,
             // Pass AWS credentials from environment.
-            addEnvVars: {
-                AWS_ACCESS_KEY_ID: process.env.AWS_ACCESS_KEY_ID,
-                AWS_SECRET_ACCESS_KEY: process.env.AWS_SECRET_ACCESS_KEY,
-            },
+            dockerArgs: [
+                '-e',
+                `AWS_ACCESS_KEY_ID=${process.env.AWS_ACCESS_KEY_ID}`,
+                '-e',
+                `AWS_SECRET_ACCESS_KEY=${process.env.AWS_SECRET_ACCESS_KEY}`,
+            ],
         });
     } catch (err) {
         // Throw errors back to test runner.

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`"commentEnd": "\n "`
`20`	`20`	`}`
`21`	`21`	`],`
	`22`	`+ "transform-es2015-modules-commonjs",`
`22`	`23`	`"transform-es2017-object-entries",`
`23`	`24`	`"transform-object-rest-spread",`
`24`	`25`	`"transform-es2015-destructuring",`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-const { transform } = require('./__utils__');`
	`1`	`+const { transform } = require('./utils');`
`2`	`2`
`3`	`3`	`it('array literal expression', () => {`
`4`	`4`	`const code = transform('[1, 2, 3].includes(1)');`