├── LICENSE ├── NOTICE ├── README.md ├── index.d.ts ├── index.js ├── middleware.js ├── package.json └── serverless+.png /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://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 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | serverlessplus 2 | Copyright © 2019 chenhengqi. All Rights Reserved. 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![](serverless+.png) 2 | 3 | # Serverless + JavaScript 4 | 5 | ## 简介 6 | 7 | `serverlessplus` 是一个简单易用的工具，它可以帮助你将现有的 `express` / `koa` / `restify` 等框架构建的应用借助 [API 网关](https://cloud.tencent.com/product/apigateway) 迁移到 [腾讯云无服务云函数](https://cloud.tencent.com/product/scf)（Tencent Cloud Serverless Cloud Function）上。 8 | 9 | ## 开始使用 10 | 11 | ```shell 12 | $ npm install serverlessplus 13 | ``` 14 | 15 | 假设有如下 `express` 应用： 16 | ```js 17 | // app.js 18 | 'use strict'; 19 | 20 | const express = require('express'); 21 | const app = express(); 22 | 23 | app.get('/', (request, response) => { 24 | response.end('hello world'); 25 | }); 26 | 27 | app.litsen(8000); 28 | ``` 29 | 30 | 可以通过如下简单修改，迁移到 `serverless` 平台上： 31 | ```js 32 | // app.js 33 | 'use strict'; 34 | 35 | const express = require('express'); 36 | const app = express(); 37 | 38 | app.get('/', (request, response) => { 39 | response.end('hello world'); 40 | }); 41 | 42 | // comment out `listen` 43 | // exports your `app` 44 | 45 | // app.litsen(8000); 46 | module.exports = app; 47 | ``` 48 | 49 | 将服务到入口文件修改为如下内容： 50 | ```js 51 | // index.js 52 | 'use strict'; 53 | 54 | const app = require('./app'); 55 | const serverlessplus = require('serverlessplus'); 56 | 57 | const options = { 58 | binaryMIMETypes: [ 59 | 'image/gif', 60 | 'image/png', 61 | 'image/jpeg', 62 | ], 63 | framework: 'express', 64 | }; 65 | 66 | const proxy = serverlessplus.createProxy(app, options); 67 | 68 | exports.main_handler = (event, context) => { 69 | return proxy.serveRequest(event, context); 70 | } 71 | ``` 72 | 73 | ## 示例 74 | 75 | - [express 示例](https://github.com/serverlessplus/express-example) 76 | - [koa 示例](https://github.com/serverlessplus/koa-example) 77 | - [restify 示例](https://github.com/serverlessplus/restify-example) 78 | 79 | ## 支持的框架 80 | 81 | - [express](https://expressjs.com) 82 | - [koa](https://koajs.com) 83 | - [restify](http://restify.com) 84 | - ... 85 | 86 | ## 路线图 87 | 88 | - 更多 Web 框架的支持 89 | - 对小程序云开发的支持 90 | 91 | `serverlessplus` 处于活跃开发中，`API` 可能在未来的版本中发生变更，我们十分欢迎来自社区的贡献，你可以通过 pull request 或者 issue 来参与。 92 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | import * as Koa2Application from 'koa'; 2 | import { Application as ExpressApplication } from 'express'; 3 | import { Server as RestifyServer } from 'restify'; 4 | import { RequestOptions as HttpRequestOptions, IncomingMessage as HttpIncomingMessage, Server as HttpServer } from "http"; 5 | 6 | type ServerApplication = Koa2Application | ExpressApplication | RestifyServer; 7 | 8 | interface ProxyOptions { 9 | framework: 'express' | 'koa' | 'koa2' | 'restify', 10 | binaryMIMETypes?: ReadonlyArray 11 | } 12 | 13 | interface APIGatewayRequestIdentity { 14 | secretId?: string 15 | } 16 | 17 | interface APIGatewayProxyRequestContext { 18 | serviceId: string, 19 | path: string, 20 | httpMethod: string, 21 | requestId: string, 22 | stage: string, 23 | identity: APIGatewayRequestIdentity, 24 | sourceIp: string, 25 | websocketEnable?: boolean 26 | } 27 | 28 | interface APIGatewayProxyRequestEvent { 29 | path: string, 30 | queryString: { [key: string]: string }, 31 | httpMethod: string, 32 | headers: { [key: string]: string }, 33 | queryStringParameters?: { [key: string]: string }, 34 | pathParameters?: { [key: string]: string }, 35 | headerParameters?: { [key: string]: string }, 36 | stageVariables?: { [key: string]: string }, 37 | requestContext: APIGatewayProxyRequestContext, 38 | body: string, 39 | isBase64Encoded?: boolean 40 | } 41 | 42 | interface APIGatewayProxyResponse { 43 | statusCode: number, 44 | headers: { [key: string]: string }, 45 | body: string, 46 | isBase64Encoded?: boolean 47 | } 48 | 49 | declare class Proxy { 50 | constructor(server: HttpServer, options: ProxyOptions); 51 | start(): Promise; 52 | getRemoteIP(event: APIGatewayProxyRequestEvent): string | null; 53 | buildRequestOptions(event: APIGatewayProxyRequestEvent, context: APIGatewayProxyRequestContext): HttpRequestOptions; 54 | isBinaryContentType(contentType: string): boolean; 55 | sendResponse(error: Error, response: HttpIncomingMessage, context: APIGatewayProxyRequestContext): void; 56 | serveRequest(event: APIGatewayProxyRequestEvent, context: APIGatewayProxyRequestContext): Promise; 57 | } 58 | 59 | export declare function createProxy(app: ServerApplication, options: ProxyOptions): Proxy; 60 | 61 | export type Handler = (event: APIGatewayProxyRequestEvent, context: APIGatewayProxyRequestContext) => void; 62 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const http = require('http'); 2 | const url = require('url'); 3 | 4 | class Proxy { 5 | constructor(server, options) { 6 | this.server = server; 7 | this.server.on('error', (error) => { 8 | if (error.code === 'EADDRINUSE') { 9 | this.start(); 10 | } else { 11 | console.log(error); 12 | } 13 | }); 14 | this.options = options || {}; 15 | this.start(); 16 | } 17 | 18 | async start() { 19 | // communicate via a unix socket 20 | const sock = `/tmp/plus-${Math.random().toString(36).slice(2)}.sock`; 21 | this.sock = sock; 22 | await this.server.listen(sock); 23 | } 24 | 25 | getRemoteIP(event) { 26 | // if requests come from console 27 | // `event.requestContext` would be null 28 | if (event.requestContext) { 29 | return event.requestContext.sourceIp || null; 30 | } 31 | return null; 32 | } 33 | 34 | buildRequestOptions(event, context) { 35 | const headers = event.headers || {}; 36 | // encodeURIComponent is required 37 | // or you may encounter error like 38 | // `TypeError: The header content contains invalid characters` 39 | const { body, ...restEventParams } = event; 40 | headers['X-APIGateway-Event'] = encodeURIComponent(JSON.stringify(restEventParams)); 41 | headers['X-APIGateway-Context'] = encodeURIComponent(JSON.stringify(context)); 42 | const ip = this.getRemoteIP(event); 43 | if (ip != null) { 44 | headers['X-Forwarded-For'] = ip; 45 | } 46 | if (event.body) { 47 | // it seems API Gateway has some bugs 48 | // `headers['content-length']` and `event.body.length` are not matched 49 | headers['content-length'] = Buffer.byteLength(Buffer.from(event.body, 'utf8')); 50 | } 51 | const method = event.httpMethod || 'GET'; 52 | const path = url.format({ 53 | pathname: event.path, 54 | query: event.queryString, 55 | }); 56 | const socketPath = this.sock; 57 | return { 58 | method, 59 | path, 60 | headers, 61 | socketPath, 62 | }; 63 | } 64 | 65 | isBinaryContentType(contentType) { 66 | const binaryMIMETypes = this.options.binaryMIMETypes || []; 67 | return binaryMIMETypes.includes(contentType); 68 | } 69 | 70 | sendResponse(error, response, context) { 71 | if (error != null) { 72 | context.succeed({ 73 | isBase64Encoded: false, 74 | statusCode: 500, 75 | headers: {}, 76 | body: '', 77 | }); 78 | return; 79 | } 80 | const buffer = []; 81 | response.on('data', (chunk) => { 82 | buffer.push(chunk); 83 | }); 84 | response.on('end', () => { 85 | const headers = response.headers || {}; 86 | headers['x-powered-by'] = 'serverlessplus'; 87 | // set content type to empty string if not specify explicitly 88 | // otherwise API Gateway would set it to `application/json` 89 | headers['Content-Type'] = headers['content-type'] || ''; 90 | // if response has `Set-Cookie` header, we can only send the first one 91 | // due to the bugs in API Gateway, it does NOT follow the HTTP specification 92 | if ('set-cookie' in headers && Array.isArray(headers['set-cookie'])) { 93 | headers['set-cookie'] = headers['set-cookie'][0]; 94 | } 95 | const isBinaryContentType = this.isBinaryContentType(headers['Content-Type']); 96 | const payload = Buffer.concat(buffer).toString(isBinaryContentType ? 'base64' : 'utf8'); 97 | context.succeed({ 98 | isBase64Encoded: isBinaryContentType, 99 | statusCode: response.statusCode, 100 | headers, 101 | body: payload, 102 | }); 103 | }); 104 | } 105 | 106 | async serveRequest(event, context) { 107 | // restify.Server wraps http.Server 108 | if (this.options.framework === 'restify') { 109 | if (!this.server.server.listening) { 110 | await this.start(); 111 | } 112 | } else if (!this.server.listening) { 113 | await this.start(); 114 | } 115 | 116 | const options = this.buildRequestOptions(event, context); 117 | const request = http.request(options, (response) => this.sendResponse(null, response, context)); 118 | request.on('error', (error) => { 119 | console.log('>>>', error); 120 | this.sendResponse(error, null, context); 121 | }); 122 | if (event.body) { 123 | request.write(Buffer.from(event.body, 'utf8')); 124 | } 125 | request.end(); 126 | // return a promise that never resolves 127 | return new Promise((resolve, reject) => { }); 128 | } 129 | } 130 | 131 | function createProxy(app, options) { 132 | const createOptions = options || {}; 133 | let framework = createOptions.framework || ''; 134 | framework = framework.toLowerCase(); 135 | switch (framework) { 136 | case 'express': 137 | return new Proxy(http.createServer(app), createOptions); 138 | case 'koa': 139 | case 'koa2': 140 | return new Proxy(http.createServer(app.callback()), createOptions); 141 | case 'restify': 142 | return new Proxy(app, createOptions); 143 | default: 144 | // if (typeof app.listen === 'function') { 145 | // return new Proxy(app, createOptions); 146 | // } 147 | throw new Error('please specify `framework` field in options'); 148 | } 149 | } 150 | 151 | exports.createProxy = createProxy; 152 | -------------------------------------------------------------------------------- /middleware.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | exports.getEventAndContext = async (request, response, next) => { 4 | if (typeof response === 'function') { 5 | // for koa 6 | let next = response; 7 | request['payload'] = {}; 8 | if (request.headers['x-apigateway-event']) { 9 | let event = JSON.parse(decodeURIComponent(request.headers['x-apigateway-event'])); 10 | request['payload']['event'] = event; 11 | } 12 | if (request.headers['x-apigateway-context']) { 13 | let context = JSON.parse(decodeURIComponent(request.headers['x-apigateway-context'])); 14 | request['payload']['context'] = context; 15 | } 16 | await next(); 17 | } else { 18 | // for express 19 | request['payload'] = {}; 20 | if (request.headers['x-apigateway-event']) { 21 | let event = JSON.parse(decodeURIComponent(request.headers['x-apigateway-event'])); 22 | request['payload']['event'] = event; 23 | } 24 | if (request.headers['x-apigateway-context']) { 25 | let context = JSON.parse(decodeURIComponent(request.headers['x-apigateway-context'])); 26 | request['payload']['context'] = context; 27 | } 28 | next(); 29 | } 30 | }; 31 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "serverlessplus", 3 | "version": "0.0.9", 4 | "description": "serverless your express/koa/restify app", 5 | "main": "index.js", 6 | "files": [ 7 | "index.js", 8 | "middleware.js" 9 | ], 10 | "scripts": { 11 | "test": "echo \"Error: no test specified\" && exit 1" 12 | }, 13 | "repository": { 14 | "type": "git", 15 | "url": "git+https://github.com/serverlessplus/js.git" 16 | }, 17 | "keywords": [ 18 | "serverless", 19 | "express", 20 | "koa", 21 | "restify", 22 | "scf", 23 | "tencent cloud" 24 | ], 25 | "author": "chenhengqi", 26 | "license": "Apache-2.0", 27 | "bugs": { 28 | "url": "https://github.com/serverlessplus/js/issues" 29 | }, 30 | "homepage": "https://github.com/serverlessplus/js#readme", 31 | "devDependencies": { 32 | "@types/express": "^4.17.0", 33 | "@types/koa": "^2.0.49", 34 | "@types/restify": "^7.2.12" 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /serverless+.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverlessplus/js/a3613d78e976908d0a5896ccbe48db7e5782c53a/serverless+.png --------------------------------------------------------------------------------