diff --git a/account-parent/functions/account-created-function/.gitignore b/account-parent/functions/account-created-function/.gitignore new file mode 100644 index 0000000..7d845af --- /dev/null +++ b/account-parent/functions/account-created-function/.gitignore @@ -0,0 +1,39 @@ +# Logs +logs +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules +jspm_packages + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history + +deployment.yaml diff --git a/account-parent/functions/account-created-function/LICENSE b/account-parent/functions/account-created-function/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/account-parent/functions/account-created-function/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/account-parent/functions/account-created-function/README.md b/account-parent/functions/account-created-function/README.md new file mode 100644 index 0000000..a097e20 --- /dev/null +++ b/account-parent/functions/account-created-function/README.md @@ -0,0 +1,53 @@ +# Account Created Function + +Node.js source code and deployment scripts for an _AWS Lambda_ function. This function is referenced in an [_Event Stream Processing Microservices_](https://github.com/kbastani/event-stream-processing-microservices/tree/master) example project as a git sub-module. + +The lambda function is triggered from events sourced from the [account-worker](https://github.com/kbastani/event-stream-processing-microservices/tree/master/account-parent) application. The lambda function uses an _Amazon API Gateway_ trigger that is invoked from a _Spring Cloud Stream_ application. + +**Function Details**: + +This lambda function responds to an [AccountEvent](https://github.com/kbastani/event-stream-processing-microservices/blob/master/account-parent/account-web/src/main/java/demo/event/AccountEvent.java) that applies a state change to an [Account](https://github.com/kbastani/event-stream-processing-microservices/blob/master/account-parent/account-web/src/main/java/demo/account/Account.java) resource. + +- **context**: [accounts](https://github.com/kbastani/event-stream-processing-microservices/tree/master/account-parent) +- **function**: account-created +- **source_state**: `ACCOUNT_CREATED` +- **target_state**: `ACCOUNT_PENDING` +- **event_type**: `ACCOUNT_CREATED` +- **event_format**: [application/hal+json](http://stateless.co/hal_specification.html) + +**Description**: + +This event handler is triggered in response to an _Account_ resource transitioning from an `ACCOUNT_CREATED` status to an `ACCOUNT_PENDING` status. The function should apply the `ACCOUNT_PENDING` status to the _Account_ API resource that is linked within the payload of the supplied _AccountEvent_ resource. + +This AWS lambda function is a backing service to the [account-worker](https://github.com/kbastani/event-stream-processing-microservices/tree/master/account-parent/account-worker) application. A service binding should inject the _AWS Lambda_ resource address and credentials into the _account-worker_ container as environment variables. + +![Account microservice](http://i.imgur.com/WZTR4lQ.png) + +The lambda function uses a Node.js module named [Traverson](https://github.com/basti1302/traverson), which is a REST client implementation for [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS). The reference architecture uses [Spring HATEOAS](http://projects.spring.io/spring-hateoas/) to describe REST API resources with embedded links. The links embedded in each API resource allows the code in the lambda function to be completely stateless. + +The lambda function only needs to import the _Traverson_ dependency to interact with API resources managed by the [account-web](https://github.com/kbastani/event-stream-processing-microservices/tree/master/account-parent/account-web) microservice. + +```javascript +// Lambda Function Handler (Node.js) +exports.handler = (event, context, callback) => { + // Loads the traverson client module + var traverson = require('traverson'); + + // Apply the confirm command to the Account resource + traverson + .from(event._links.account.href) + .follow('$._links.self.href', + '$._links.commands.href', + '$._links.confirm.href') + .get(function(error, response) { + // Return the account result + callback(error, response); + }); +}; +``` + +## Deployment + +A shell script is provided in `./deploy.sh`. This script uses the AWS CLI to create a deployment package using an [AWS CloudFormation Template](https://aws.amazon.com/cloudformation/aws-cloudformation-templates/) defined in `./account-created.yaml`. To deploy the lambda function, you must have the AWS CLI installed and configured to an IAM user with sufficient permissions to execute the script. + +The script will create a deployment package for the lambda function and upload it as a zip file to an S3 bucket. The bucket name is an argument to the the deployment script. diff --git a/account-parent/functions/account-created-function/deploy.sh b/account-parent/functions/account-created-function/deploy.sh new file mode 100755 index 0000000..2a6537b --- /dev/null +++ b/account-parent/functions/account-created-function/deploy.sh @@ -0,0 +1,71 @@ +#!/bin/bash + +ls ./node_modules &> /dev/null || echo "Installing node_modules..."; npm install --silent &> /dev/null; echo "" + +function error_exit { + msg="$1" + if [ -z "$1" ] + then + exit 1 + else + echo -e "" + echo -e "\x1B[31m$msg\x1B[0m" + exit 1 + fi +} + +function print_help { + echo -e "Usage: $ ./deploy.sh bucket_name" +} + +if [ "$1" = 'help' ] + then + print_help + exit 1 +fi + +if [ $# -eq 0 ] + then + echo -e "An Amazon S3 bucket name is required as an argument" + print_help + error_exit "Deployment failed..." +fi + +if [ -z "$1" ] + then + echo -e "The supplied S3 bucket name is not valid" + print_help + error_exit "Deployment failed..." +fi + +bucket_name="$1" + +function package { + # Create a CloudFormation package for this AWS Lambda function + echo -e "Packacking deployment..." + echo "" + + aws cloudformation package \ + --template-file package.yaml \ + --output-template-file deployment.yaml \ + --s3-bucket $bucket_name || error_exit "Packaging failed: Could not access the S3 bucket..." + + echo "" + + deploy +} + +function deploy { + # Deploy the CloudFormation package + echo -e "Deploying package from s3://$bucket_name..." + echo "" + + aws cloudformation deploy \ + --template-file deployment.yaml \ + --stack-name account-created || error_exit "Deployment failed..." + + # Remove the deployment package + rm ./deployment.yaml +} + +package diff --git a/account-parent/functions/account-created-function/index.js b/account-parent/functions/account-created-function/index.js new file mode 100755 index 0000000..326ddf7 --- /dev/null +++ b/account-parent/functions/account-created-function/index.js @@ -0,0 +1,112 @@ +// Lambda Function Handler (Node.js) +exports.handler = (event, context, callback) => { + accountCreated(event, callback); +}; + +// Link traversals +var links = { + account: '$._links.self.href' +}; + +// DSL for creating a resource flow +var flow = { + tasks: [], + callback: {}, + steps: { + then: function(step) { + flow.tasks.push(step); + return flow.steps; + }, + start: function(traversal, callback) { + flow.callback = callback; + flow.next({ + traversal: traversal + }); + } + }, + next: function(context) { + flow.tasks.shift()(context); + } +}; + +// Handle the account created event +function accountCreated(event, callback) { + // Loads the traverson client module + var traverson = require('traverson'); + var JsonHalAdapter = require('traverson-hal'); + traverson.registerMediaType(JsonHalAdapter.mediaType, JsonHalAdapter); + + // Get the account resource href from event + var accountUrl = event._links.account.href; + + // Apply the pending status to the attached account + var traversal = traverson.from(accountUrl) + .json() + .withRequestOptions({ + headers: { + "Accept": 'application/hal+json', + "Content-Type": 'application/hal+json' + } + }); + + // Execute account pending workflow + flow.steps + .then(getAccount) + .then(setPending) + .start(traversal, callback); +} + +// Gets the account and sends it to the next step +function getAccount(context) { + console.log("Getting account..."); + + // Fetch account resource + var fetchResource = function(error, account, traversal) { + if (error) return done(error); + + if (account.status != "ACCOUNT_CREATED") { + done("Pending account failed, account state invalid: " + + account.status); + } else { + // Trigger the setPending step + flow.next({ + account: account, + traversal: traversal + }); + } + }; + + // Follow the account resource + context.traversal + .follow(links.account) + .getResource(fetchResource); +} + +// Sets the account status to pending for the next step +function setPending(context) { + console.log("Updating account..."); + + var updateAccount = function(error, account, traversal) { + if (error) return done(error); + + if (account.status == "ACCOUNT_PENDING") { + // Complete the flow + flow.callback(null, account); + } else { + done("Account update failed: status could not be updated to pending"); + } + }; + + // Set account to pending + context.account.status = "ACCOUNT_PENDING"; + + // Update the account resource + context.traversal + .continue() + .put(context.account, updateAccount); +} + +// Something went wrong, notify the callback handler +function done(error) { + flow.callback(error); +} diff --git a/account-parent/functions/account-created-function/package.json b/account-parent/functions/account-created-function/package.json new file mode 100644 index 0000000..22667d4 --- /dev/null +++ b/account-parent/functions/account-created-function/package.json @@ -0,0 +1,22 @@ +{ + "name": "account-created-function", + "version": "1.0.0", + "description": "Account created AWS Lambda function", + "main": "index.js", + "dependencies": { + "traverson": "^3.2.0", + "traverson-hal": "^4.1.1" + }, + "devDependencies": {}, + "scripts": {}, + "repository": { + "type": "git", + "url": "git+https://github.com/kbastani/account-created-function.git" + }, + "author": "kbastani", + "license": "ISC", + "bugs": { + "url": "https://github.com/kbastani/account-created-function/issues" + }, + "homepage": "https://github.com/kbastani/account-created-function#readme" +} diff --git a/account-parent/functions/account-created-function/package.yaml b/account-parent/functions/account-created-function/package.yaml new file mode 100644 index 0000000..ebf62d0 --- /dev/null +++ b/account-parent/functions/account-created-function/package.yaml @@ -0,0 +1,20 @@ +AWSTemplateFormatVersion: '2010-09-09' +Transform: 'AWS::Serverless-2016-10-31' +Description: Account created handler +Resources: + accountCreated: + Type: 'AWS::Serverless::Function' + Properties: + Handler: index.handler + Runtime: nodejs4.3 + CodeUri: . + Description: Responds to an account creation event + MemorySize: 128 + Timeout: 10 + Role: 'arn:aws:iam::194021864310:role/service-role/public' + Events: + Api1: + Type: Api + Properties: + Path: /accountCreated + Method: ANY diff --git a/account-parent/functions/create-account-function b/account-parent/functions/create-account-function deleted file mode 160000 index ed63620..0000000 --- a/account-parent/functions/create-account-function +++ /dev/null @@ -1 +0,0 @@ -Subproject commit ed636207ce45d2015ef48dc449ad659f0db4f54e