├── .npmrc ├── .eslintignore ├── .prettierignore ├── .npmignore ├── COPYRIGHT ├── prettier.config.js ├── CONTRIBUTING.md ├── .gitignore ├── package.json ├── .eslintrc.js ├── serverless.js ├── README.md ├── CODE_OF_CONDUCT.md ├── LICENSE └── utils.js /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | coverage 2 | dist 3 | node_modules -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | coverage 2 | dist 3 | node_modules -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | components 2 | examples 3 | .idea 4 | .serverless 5 | coverage 6 | .env* 7 | env.js 8 | tmp 9 | test 10 | -------------------------------------------------------------------------------- /COPYRIGHT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2019 Serverless, Inc. https://serverless.com 2 | 3 | Serverless Components may be freely distributed under the Apache 2.0 license. 4 | -------------------------------------------------------------------------------- /prettier.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | arrowParens: 'always', 3 | printWidth: 100, 4 | semi: false, 5 | singleQuote: true, 6 | tabWidth: 2, 7 | trailingComma: 'none' 8 | } 9 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | When contributing to this repository, please first discuss the change you wish to make via issue, 4 | email, or any other method with the owners of this repository before making a change. 5 | 6 | Please note we have a [code of conduct](./CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | *.sublime-project 3 | *.sublime-workspace 4 | *.log 5 | .serverless 6 | v8-compile-cache-* 7 | jest/* 8 | coverage 9 | .serverless_plugins 10 | testProjects/*/package-lock.json 11 | testProjects/*/yarn.lock 12 | .serverlessUnzipped 13 | node_modules 14 | .vscode/ 15 | .eslintcache 16 | dist 17 | .idea 18 | build/ 19 | .env* 20 | env.js 21 | package-lock.json 22 | test -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@serverless/template", 3 | "version": "1.1.3", 4 | "main": "./serverless.js", 5 | "publishConfig": { 6 | "access": "public" 7 | }, 8 | "scripts": { 9 | "test": "echo \"Error: no test specified\" && exit 1", 10 | "lint": "eslint . --fix --cache" 11 | }, 12 | "author": "Serverless, Inc.", 13 | "license": "Apache-2.0", 14 | "dependencies": { 15 | "@serverless/component-metrics": "^1.0.8", 16 | "@serverless/core": "^1.0.0", 17 | "graphlib": "^2.1.7", 18 | "traverse": "^0.6.6" 19 | }, 20 | "devDependencies": { 21 | "babel-eslint": "9.0.0", 22 | "eslint": "5.6.0", 23 | "eslint-config-prettier": "^3.6.0", 24 | "eslint-plugin-import": "^2.14.0", 25 | "eslint-plugin-prettier": "^3.0.1", 26 | "prettier": "^1.15.3" 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | root: true, 3 | extends: ['prettier'], 4 | plugins: ['import', 'prettier'], 5 | env: { 6 | es6: true, 7 | jest: true, 8 | node: true 9 | }, 10 | parser: 'babel-eslint', 11 | parserOptions: { 12 | ecmaVersion: 2018, 13 | sourceType: 'module', 14 | ecmaFeatures: { 15 | jsx: true 16 | } 17 | }, 18 | globals: { 19 | on: true // for the Socket file 20 | }, 21 | rules: { 22 | 'array-bracket-spacing': [ 23 | 'error', 24 | 'never', 25 | { 26 | objectsInArrays: false, 27 | arraysInArrays: false 28 | } 29 | ], 30 | 'arrow-parens': ['error', 'always'], 31 | 'arrow-spacing': ['error', { before: true, after: true }], 32 | 'comma-dangle': ['error', 'never'], 33 | curly: 'error', 34 | 'eol-last': 'error', 35 | 'func-names': 'off', 36 | 'id-length': [ 37 | 'error', 38 | { 39 | min: 2, 40 | max: 50, 41 | properties: 'never', 42 | exceptions: ['e', 'i', 'n', 't', 'x', 'y', 'z', '_', '$'] 43 | } 44 | ], 45 | 'no-alert': 'error', 46 | 'no-console': 'error', 47 | 'no-const-assign': 'error', 48 | 'no-else-return': 'error', 49 | 'no-empty': 'off', 50 | 'no-shadow': 'error', 51 | 'no-undef': 'error', 52 | 'no-unused-vars': 'error', 53 | 'no-use-before-define': 'error', 54 | 'no-useless-constructor': 'error', 55 | 'object-curly-newline': 'off', 56 | 'object-shorthand': 'off', 57 | 'prefer-const': 'error', 58 | 'prefer-destructuring': ['error', { object: true, array: false }], 59 | quotes: [ 60 | 'error', 61 | 'single', 62 | { 63 | allowTemplateLiterals: true, 64 | avoidEscape: true 65 | } 66 | ], 67 | semi: ['error', 'never'], 68 | 'spaced-comment': 'error', 69 | strict: ['error', 'never'], 70 | 'prettier/prettier': 'error' 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /serverless.js: -------------------------------------------------------------------------------- 1 | const { Component } = require('@serverless/core') 2 | const { 3 | getTemplate, 4 | resolveTemplate, 5 | getAllComponents, 6 | downloadComponents, 7 | setDependencies, 8 | createGraph, 9 | executeGraph, 10 | syncState, 11 | getOutputs, 12 | createCustomMethodHandler 13 | } = require('./utils') 14 | 15 | class Template extends Component { 16 | constructor(id, context) { 17 | const defaultFunction = super(id, context) 18 | 19 | return new Proxy(defaultFunction, { 20 | get: (obj, prop) => { 21 | // This handles the weird case when `then` is called on the `defaultFunction` 22 | if (prop === 'then') { 23 | return obj[prop] 24 | } 25 | 26 | if (obj.hasOwnProperty(prop)) { 27 | return obj[prop] 28 | } 29 | 30 | // Return a function that will invoke the custom method on requested components 31 | return createCustomMethodHandler(obj, prop) 32 | } 33 | }) 34 | } 35 | 36 | async default(inputs = {}) { 37 | this.context.status('Deploying') 38 | 39 | const template = await getTemplate(inputs) 40 | 41 | this.context.debug(`Resolving the template's static variables.`) 42 | 43 | const resolvedTemplate = resolveTemplate(template) 44 | 45 | this.context.debug('Collecting components from the template.') 46 | 47 | const allComponents = await getAllComponents(resolvedTemplate) 48 | 49 | this.context.debug('Downloading any NPM components found in the template.') 50 | 51 | const allComponentsDownloaded = await downloadComponents(allComponents) 52 | 53 | this.context.debug(`Analyzing the template's components dependencies.`) 54 | 55 | const allComponentsWithDependencies = setDependencies(allComponentsDownloaded) 56 | 57 | this.context.debug(`Creating the template's components graph.`) 58 | 59 | const graph = createGraph(allComponentsWithDependencies) 60 | 61 | this.context.debug('Syncing template state.') 62 | 63 | await syncState(allComponentsWithDependencies, this) 64 | 65 | this.context.debug(`Executing the template's components graph.`) 66 | 67 | const allComponentsWithOutputs = await executeGraph(allComponentsWithDependencies, graph, this) 68 | 69 | const outputs = getOutputs(allComponentsWithOutputs) 70 | 71 | return outputs 72 | } 73 | 74 | async remove() { 75 | this.context.status('Removing') 76 | 77 | this.context.debug('Flushing template state and removing all components.') 78 | await syncState({}, this) 79 | 80 | // todo should we return the removed components outputs here?! 81 | return {} 82 | } 83 | } 84 | 85 | module.exports = Template 86 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Template 2 | 3 | This component is used behind the scenes to deploy your YAML templates. It is loaded by the serverless CLI and executed just as any other component. 4 | However, there's a lot you can do with this component programmatically. See the sections below for some examples. 5 | 6 | ### Programmatic usage and custom environments 7 | 8 | To deploy to multiple environments you must utilize the programmatic API, via `serverless.js` file. 9 | 10 | `serverless.js` 11 | 12 | ```js 13 | const { Component } = require('@serverless/core') 14 | 15 | class Deploy extends Component { 16 | async default(inputs = {}) { 17 | const { env } = inputs 18 | 19 | const template = await this.load('@serverless/template', env) 20 | return await template({ template: __dirname + '/serverless.yml' }) 21 | } 22 | 23 | async remove(inputs = {}) { 24 | const { env } = inputs 25 | 26 | const template = await this.load('@serverless/template', env) 27 | await template.remove(inputs) 28 | } 29 | } 30 | 31 | module.exports = Deploy 32 | ``` 33 | 34 | `serverless.yml` 35 | 36 | ```yml 37 | name: test 38 | 39 | lambda: 40 | component: '@serverless/function' 41 | inputs: 42 | name: my-function 43 | description: My Serverless Function 44 | memory: 128 45 | timeout: 20 46 | code: './code' 47 | hanlder": 'handler.handler' 48 | region: us-east-1 49 | runtime: nodejs10.x 50 | ``` 51 | 52 | Invoking `sls --env=dev` will result in state files in `.serverless/` being prefixed with the value of your `env`: 53 | `Deploy.dev.json`, etc. That way you can deploy unlimited environments, add pre/post processing, load whatever `.env` you need, etc. 54 | 55 | ### Running custom methods on a template 56 | 57 | A template itself does not contain any methods so custom methods are executed on the specific template aliases. 58 | 59 | `sls install --component lambda` will load the `lambda` alias from your template, instantiate the corresponding component, and execute the `install` method passing in the inputs you specify via CLI parameters. 60 | Inputs from the template itself are not passed as they can not be interpreted/resolved without running the entire template. 61 | 62 | You can pass as many `--component` parameters as you need. 63 | 64 | ### Running custom methods programmatically 65 | 66 | `serverless.js` 67 | 68 | ```js 69 | const { Component } = require('@serverless/core') 70 | 71 | class Deploy extends Component { 72 | /* ...skipped default method for brevity ... */ 73 | 74 | async install(inputs = {}) { 75 | const template = await this.load('@serverless/template') 76 | await template.install({ template: __dirname + '/serverless.yml', ...inputs }) 77 | } 78 | } 79 | 80 | module.exports = Deploy 81 | ``` 82 | 83 | When invoking methods on a `template` instance, you always need to pass in a path to the template file or a template object. 84 | 85 | Running `sls install --component lambda --debug` - this will load the template, find the `lambda` alias, and invoke the `install` method on the instance of the component. 86 | 87 | ### Couldn't find what you were looking for? 88 | 89 | Visit our github and file an issue with as much info as possible about your problem. 90 | If you think you've found a bug - please do post a complete reproduction repo. It will help us and our contributors to help you much faster. 91 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting our team at **hello@serverless.com**. As an alternative 59 | feel free to reach out to any of us personally. All 60 | complaints will be reviewed and investigated and will result in a response that 61 | is deemed necessary and appropriate to the circumstances. The project team is 62 | obligated to maintain confidentiality with regard to the reporter of an incident. 63 | Further details of specific enforcement policies may be posted separately. 64 | 65 | Project maintainers who do not follow or enforce the Code of Conduct in good 66 | faith may face temporary or permanent repercussions as determined by other 67 | members of the project's leadership. 68 | 69 | ## Attribution 70 | 71 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 72 | available at [http://contributor-covenant.org/version/1/4][version] 73 | 74 | [homepage]: http://contributor-covenant.org 75 | [version]: http://contributor-covenant.org/version/1/4/ 76 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | https://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | Copyright 2018 Serverless, Inc. 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | https://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | -------------------------------------------------------------------------------- /utils.js: -------------------------------------------------------------------------------- 1 | const { resolve, join } = require('path') 2 | const { pick, isEmpty, path, uniq } = require('ramda') 3 | const { Graph, alg } = require('graphlib') 4 | const traverse = require('traverse') 5 | const { utils } = require('@serverless/core') 6 | const newMetric = require('@serverless/component-metrics') 7 | 8 | const getComponentMetric = async (componentPath, componentMethod = 'default', instance) => { 9 | const metric = newMetric() 10 | metric.componentMethod(componentMethod) 11 | metric.componentContext(instance.context.instance.name || 'cli_declarative') 12 | metric.componentContextVersion(instance.context.instance.version || '1.0.0') 13 | metric.componentError(null) 14 | 15 | let componentName = componentPath 16 | let componentVersion 17 | const componentPackageJsonPath = join(componentPath, 'package.json') 18 | 19 | // if package.json exists, read it to get name & version 20 | if (await utils.fileExists(componentPackageJsonPath)) { 21 | const componentPackageJson = await utils.readFile(componentPackageJsonPath) 22 | componentName = componentPackageJson.name || componentPath 23 | componentVersion = componentPackageJson.version 24 | } 25 | 26 | metric.componentName(componentName) 27 | 28 | if (componentVersion) { 29 | metric.componentVersion(componentVersion) 30 | } 31 | 32 | // we only publish after the method is run 33 | // to check whether there was an error 34 | return metric 35 | } 36 | 37 | const getOutputs = (allComponents) => { 38 | const outputs = {} 39 | 40 | for (const alias in allComponents) { 41 | outputs[alias] = allComponents[alias].outputs 42 | } 43 | 44 | return outputs 45 | } 46 | 47 | const resolveObject = (object, context) => { 48 | const regex = /\${(\w*:?[\w\d.-]+)}/g 49 | 50 | const resolvedObject = traverse(object).forEach(function(value) { 51 | const matches = typeof value === 'string' ? value.match(regex) : null 52 | if (matches) { 53 | let newValue = value 54 | for (const match of matches) { 55 | const referencedPropertyPath = match.substring(2, match.length - 1).split('.') 56 | const referencedPropertyValue = path(referencedPropertyPath, context) 57 | 58 | if (referencedPropertyValue === undefined) { 59 | throw Error(`invalid reference ${match}`) 60 | } 61 | 62 | if (match === value) { 63 | newValue = referencedPropertyValue 64 | } else if (typeof referencedPropertyValue === 'string') { 65 | newValue = newValue.replace(match, referencedPropertyValue) 66 | } else { 67 | throw Error(`the referenced substring is not a string`) 68 | } 69 | } 70 | this.update(newValue) 71 | } 72 | }) 73 | 74 | return resolvedObject 75 | } 76 | 77 | const validateGraph = (graph) => { 78 | const isAcyclic = alg.isAcyclic(graph) 79 | if (!isAcyclic) { 80 | const cycles = alg.findCycles(graph) 81 | let msg = ['Your template has circular dependencies:'] 82 | cycles.forEach((cycle, index) => { 83 | let fromAToB = cycle.join(' --> ') 84 | fromAToB = `${(index += 1)}. ${fromAToB}` 85 | const fromBToA = cycle.reverse().join(' <-- ') 86 | const padLength = fromAToB.length + 4 87 | msg.push(fromAToB.padStart(padLength)) 88 | msg.push(fromBToA.padStart(padLength)) 89 | }, cycles) 90 | msg = msg.join('\n') 91 | throw new Error(msg) 92 | } 93 | } 94 | 95 | const getTemplate = async (inputs) => { 96 | const template = inputs.template || {} 97 | 98 | if (typeof template === 'string') { 99 | if ( 100 | (!utils.isJsonPath(template) && !utils.isYamlPath(template)) || 101 | !(await utils.fileExists(template)) 102 | ) { 103 | throw Error('the referenced template path does not exist') 104 | } 105 | 106 | return utils.readFile(template) 107 | } else if (typeof template !== 'object') { 108 | throw Error('the template input could either be an object, or a string path to a template file') 109 | } 110 | return template 111 | } 112 | 113 | const resolveTemplate = (template) => { 114 | const regex = /\${(\w*:?[\w\d.-]+)}/g 115 | let variableResolved = false 116 | const resolvedTemplate = traverse(template).forEach(function(value) { 117 | const matches = typeof value === 'string' ? value.match(regex) : null 118 | if (matches) { 119 | let newValue = value 120 | for (const match of matches) { 121 | const referencedPropertyPath = match.substring(2, match.length - 1).split('.') 122 | const referencedTopLevelProperty = referencedPropertyPath[0] 123 | if (/\${env\.(\w*:?[\w\d.-]+)}/g.test(match)) { 124 | newValue = process.env[referencedPropertyPath[1]] 125 | variableResolved = true 126 | } else { 127 | if (!template[referencedTopLevelProperty]) { 128 | throw Error(`invalid reference ${match}`) 129 | } 130 | 131 | if (!template[referencedTopLevelProperty].component) { 132 | variableResolved = true 133 | const referencedPropertyValue = path(referencedPropertyPath, template) 134 | 135 | if (referencedPropertyValue === undefined) { 136 | throw Error(`invalid reference ${match}`) 137 | } 138 | 139 | if (match === value) { 140 | newValue = referencedPropertyValue 141 | } else if (typeof referencedPropertyValue === 'string') { 142 | newValue = newValue.replace(match, referencedPropertyValue) 143 | } else { 144 | throw Error(`the referenced substring is not a string`) 145 | } 146 | } 147 | } 148 | } 149 | this.update(newValue) 150 | } 151 | }) 152 | if (variableResolved) { 153 | return resolveTemplate(resolvedTemplate) 154 | } 155 | return resolvedTemplate 156 | } 157 | 158 | const getAllComponents = async (obj = {}) => { 159 | const allComponents = {} 160 | 161 | for (const key in obj) { 162 | if (obj[key] && obj[key].component) { 163 | // local components start with a . 164 | if (obj[key].component[0] === '.') { 165 | // todo should local component paths be relative to cwd? 166 | const localComponentPath = resolve(process.cwd(), obj[key].component, 'serverless.js') 167 | if (!(await utils.fileExists(localComponentPath))) { 168 | throw Error(`No serverless.js file found in ${obj[key].component}`) 169 | } 170 | } 171 | allComponents[key] = { 172 | path: obj[key].component, 173 | inputs: obj[key].inputs || {} 174 | } 175 | } 176 | } 177 | 178 | return allComponents 179 | } 180 | 181 | const downloadComponents = async (allComponents) => { 182 | // npm components property does not start with a period. 183 | // ie. local components component property is ./abc or ../abc 184 | const aliasesToDownload = Object.keys(allComponents).filter( 185 | (alias) => allComponents[alias].path[0] !== '.' 186 | ) 187 | const componentsToDownload = pick(aliasesToDownload, allComponents) 188 | 189 | // using uniq to remove any duplicates in case 190 | // the user is using multiple instances of the same 191 | // component, so that it would be downloaded only once 192 | const componentsList = uniq(aliasesToDownload.map((alias) => componentsToDownload[alias].path)) 193 | 194 | const componentsPaths = await utils.download(componentsList) 195 | 196 | const downloadedComponents = {} 197 | for (const alias in componentsToDownload) { 198 | const npmPackageName = componentsToDownload[alias].path 199 | downloadedComponents[alias] = { 200 | ...componentsToDownload[alias], 201 | path: componentsPaths[npmPackageName] 202 | } 203 | } 204 | 205 | allComponents = { ...allComponents, ...downloadedComponents } 206 | 207 | return allComponents 208 | } 209 | 210 | const setDependencies = (allComponents) => { 211 | const regex = /\${(\w*:?[\w\d.-]+)}/g 212 | 213 | for (const alias in allComponents) { 214 | const dependencies = traverse(allComponents[alias].inputs).reduce(function(accum, value) { 215 | const matches = typeof value === 'string' ? value.match(regex) : null 216 | if (matches) { 217 | for (const match of matches) { 218 | const referencedComponent = match.substring(2, match.length - 1).split('.')[0] 219 | 220 | if (!allComponents[referencedComponent]) { 221 | throw Error(`the referenced component in expression ${match} does not exist`) 222 | } 223 | 224 | if (!accum.includes(referencedComponent)) { 225 | accum.push(referencedComponent) 226 | } 227 | } 228 | } 229 | return accum 230 | }, []) 231 | 232 | allComponents[alias].dependencies = dependencies 233 | } 234 | 235 | return allComponents 236 | } 237 | 238 | const createGraph = (allComponents) => { 239 | const graph = new Graph() 240 | 241 | for (const alias in allComponents) { 242 | graph.setNode(alias, allComponents[alias]) 243 | } 244 | 245 | for (const alias in allComponents) { 246 | const { dependencies } = allComponents[alias] 247 | if (!isEmpty(dependencies)) { 248 | for (const dependency of dependencies) { 249 | graph.setEdge(alias, dependency) 250 | } 251 | } 252 | } 253 | 254 | validateGraph(graph) 255 | 256 | return graph 257 | } 258 | 259 | const executeGraph = async (allComponents, graph, instance) => { 260 | const leaves = graph.sinks() 261 | 262 | if (isEmpty(leaves)) { 263 | return allComponents 264 | } 265 | 266 | const promises = [] 267 | 268 | for (const alias of leaves) { 269 | const componentData = graph.node(alias) 270 | 271 | const fn = async () => { 272 | const component = await instance.load(componentData.path, alias) 273 | const availableOutputs = getOutputs(allComponents) 274 | const inputs = resolveObject(allComponents[alias].inputs, availableOutputs) 275 | instance.context.status('Deploying', alias) 276 | 277 | const metric = await getComponentMetric(componentData.path, 'default', instance) 278 | 279 | try { 280 | allComponents[alias].outputs = (await component(inputs)) || {} 281 | } catch (e) { 282 | // on error, publish error metric 283 | metric.componentError(e.message) 284 | await metric.publish() 285 | throw e 286 | } 287 | 288 | await metric.publish() 289 | } 290 | 291 | promises.push(fn()) 292 | } 293 | 294 | await Promise.all(promises) 295 | 296 | for (const alias of leaves) { 297 | graph.removeNode(alias) 298 | } 299 | 300 | return executeGraph(allComponents, graph, instance) 301 | } 302 | 303 | const syncState = async (allComponents, instance) => { 304 | const promises = [] 305 | 306 | for (const alias in instance.state.components || {}) { 307 | if (!allComponents[alias]) { 308 | const fn = async () => { 309 | const component = await instance.load(instance.state.components[alias], alias) 310 | instance.context.status('Removing', alias) 311 | 312 | const metric = await getComponentMetric( 313 | instance.state.components[alias], 314 | 'remove', 315 | instance 316 | ) 317 | 318 | try { 319 | await component.remove() 320 | } catch (e) { 321 | // on error, publish error metric 322 | metric.componentError(e.message) 323 | await metric.publish() 324 | throw e 325 | } 326 | await metric.publish() 327 | } 328 | 329 | promises.push(fn()) 330 | } 331 | } 332 | 333 | await Promise.all(promises) 334 | 335 | instance.state.components = {} 336 | 337 | for (const alias in allComponents) { 338 | instance.state.components[alias] = allComponents[alias].path 339 | } 340 | 341 | await instance.save() 342 | } 343 | 344 | const createCustomMethodHandler = (instance, method) => { 345 | return async ({ component, template, ...inputs }) => { 346 | let components = Array.isArray(component) ? component : [component] 347 | components = components.filter(Boolean) 348 | 349 | if (!components.length) { 350 | throw Error(`"component" input is required to run custom methods`) 351 | } 352 | 353 | instance.context.debug( 354 | `Attempting to run method "${method}" on template aliases: ${components.join(', ')}` 355 | ) 356 | 357 | // Make sure the template is an object 358 | const templateObject = await getTemplate({ template }) 359 | 360 | // Load template components 361 | const templateComponents = await getAllComponents(templateObject) 362 | 363 | // Get only the requested components ("component" input) 364 | const componentsToRun = Object.keys(templateComponents) 365 | .filter((alias) => components.includes(alias)) 366 | .reduce((acc, item) => { 367 | acc.push({ alias: item, path: templateComponents[item].path }) 368 | return acc 369 | }, []) 370 | 371 | // Verify all the components have the requested method implemented 372 | instance.context.debug(`Verifying presence of method "${method}" in requested components...`) 373 | for (let i = 0; i < componentsToRun.length; i++) { 374 | const item = componentsToRun[i] 375 | const cmp = await instance.load(item.path, item.alias) 376 | if (typeof cmp[method] !== 'function') { 377 | throw Error(`method "${method}" not found in "${item.path}"`) 378 | } 379 | // Store the loaded component so we don't have to load it again 380 | componentsToRun[i].component = cmp 381 | } 382 | 383 | // Run custom method and return output 384 | const outputs = {} 385 | for (let i = 0; i < componentsToRun.length; i++) { 386 | const cmp = componentsToRun[i] 387 | instance.context.debug(`Running method "${method}" on "${cmp.path}"...`) 388 | outputs[cmp.alias] = await cmp.component[method](inputs) 389 | } 390 | 391 | return outputs 392 | } 393 | } 394 | 395 | module.exports = { 396 | getTemplate, 397 | resolveTemplate, 398 | getAllComponents, 399 | downloadComponents, 400 | setDependencies, 401 | createGraph, 402 | executeGraph, 403 | syncState, 404 | getOutputs, 405 | createCustomMethodHandler 406 | } 407 | --------------------------------------------------------------------------------