Merge branch 'master' of https://github.com/Code2Life/http-adapter

Code2Life · Code2Life · commit 9a72a7585f8c · 2019-04-29T17:09:08.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -69,4 +69,6 @@ docs
 
 test-result
 
-cli/http-adapter*.js
+cli/http-adapter*.js
+
+junit.xml
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -11,7 +11,7 @@
       "env": {
         "NODE_ENV": "development",
         "DEBUG": "server:*",
-        "CONF_PATH": "./conf-dev"
+        "CONF_PATH": "./conf"
       },
       "runtimeArgs": [
           "-r",
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -9,6 +9,7 @@
     "kubectl",
     "protobuf",
     "quotemark",
+    "stringify",
     "tmpl",
     "webhook",
     "woff"
diff --git a/README.md b/README.md
@@ -4,8 +4,9 @@
   <a href="https://circleci.com/gh/code2life/http-adapter/tree/master"><img src="https://circleci.com/gh/Code2Life/http-adapter.svg?style=svg" alt="Build Status"></a>
   <a href="https://codecov.io/gh/code2life/http-adapter/"><img src="https://img.shields.io/codecov/c/github/code2life/http-adapter/master.svg" alt="Coverage Status"></a>
   <a href="https://www.codacy.com/app/Code2Life/http-adapter?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Code2Life/http-adapter&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/e93d8415d1074997abc36c2918f079e3" alt="Codacy Badge"></a>
-  <a href="https://codebeat.co/projects/github-com-code2life-http-adapter-master"><img alt="codebeat badge" src="https://codebeat.co/badges/a2025aec-3af4-484e-8b2a-a0a597f69867" /></a>
+  <a href="https://codebeat.co/projects/github-com-code2life-http-adapter-master"><img alt="codebeat badge" src="https://codebeat.co/badges/190e8cb0-520f-46b1-8129-68197cf17248" /></a>
   <a href="https://www.npmjs.com/package/node-adapter"><img src="https://img.shields.io/npm/v/node-adapter.svg" alt="Version"></a>
+  <a href="https://hub.docker.com/r/code2life/http-adapter"><img src="https://img.shields.io/docker/cloud/build/code2life/http-adapter.svg" alt="Version"></a>
   <a href="https://www.npmjs.com/package/node-adapter"><img src="https://img.shields.io/github/license/Code2Life/http-adapter.svg" alt="License"></a>
 </p>
 
diff --git a/conf/_demo/context.yaml b/conf/_demo/context.yaml
@@ -9,9 +9,10 @@ mixin:
 initContext:
   libraries:
     lodash: _
+    os: os
   constants:
     token: 'global token from application context'
-    webhookSiteURL: https://webhook.site/8bd70130-f663-4c2f-ada4-42a65f6abbf6
+    httpPostTestURL: http://httpbin.org/post
   initFunctions: 
     init: functions/init.ts
   functions: 
diff --git a/conf/_demo/functions/init.ts b/conf/_demo/functions/init.ts
@@ -0,0 +1,13 @@
+type OSEnv = {
+  home: string;
+  host: string;
+};
+
+function initializeApp () {
+  let osEnv = {} as OSEnv;
+  osEnv.home = this.os.homedir();
+  osEnv.host = this.os.hostname();
+  console.log(`initialized: ${JSON.stringify(osEnv)}`);
+}
+
+export default initializeApp;
diff --git a/conf/_demo/functions/log.ts b/conf/_demo/functions/log.ts
@@ -0,0 +1,3 @@
+(msg) => {
+  console.log(msg);
+};
diff --git a/conf/_demo/functions/relay-interceptor.ts b/conf/_demo/functions/relay-interceptor.ts
@@ -0,0 +1,14 @@
+import { Context } from 'koa';
+import { AxiosRequestConfig } from 'axios';
+import { DynamicRuntime } from '../types';
+
+/**
+ *
+ * @param {AxiosConfig} axiosConf
+ * @param {KoaContext} context
+ */
+async function relayInterceptor(this: DynamicRuntime, axiosConf: AxiosRequestConfig, ctx: Context) {
+  this.log(`relay interceptor from config: ${ctx.hostname}, ${JSON.stringify(axiosConf)}`);
+}
+
+export default relayInterceptor;
diff --git a/conf/_demo/functions/response-interceptor.js b/conf/_demo/functions/response-interceptor.js
@@ -0,0 +1,10 @@
+// import { ResponseObj } from '../types' ;
+// import { Context} from 'koa';
+
+/**
+ * @param respObj, statusCode, headers, body
+ * @param ctx, Koa2 request context
+ */
+async (respObj, ctx) => {
+  this.log(`response interceptor from config: ${ctx.reqId}`);
+}
diff --git a/conf/_demo/routes/get-user.yaml b/conf/_demo/routes/get-user.yaml
@@ -7,20 +7,20 @@ extract:
     validate: val => val && val.indexOf('gzip') !== -1
   # bodyHandlers
 relay:
-- name: webhook.site
-  location: ${this.webhookSiteURL}
+- name: demoPost
+  location: ${this.httpPostTestURL}
   method: post
   headers:
-    original-acceipt-encoding: ${this.accept}    
+    original-accept-encoding: ${this.accept}    
     token-from-context: ${this.token}
   body: |-
-    { id: "${ctx.request.params.userId}" }
+    { id: "${ctx.params.userId}", data: "demo" }
   interceptors:
-    relay-interceptor: function/relay-interceptor.ts
+    relay-interceptor: functions/relay-interceptor.ts
 response:
   policy: 'afterRelay'
   headers:
     request-id: ${ctx.reqId}
   body: templates/response-body.tmpl
   interceptors:
-    response-interceptor: function/response-interceptor.js
+    response-interceptor: functions/response-interceptor.js
diff --git a/conf/_demo/templates/response-body.tmpl b/conf/_demo/templates/response-body.tmpl
@@ -0,0 +1,4 @@
+{
+  relayResult: ${JSON.stringify(ctx.relayResultMap.get('demoPost').data, null, 2)},
+  relayStatusCode: "${ctx.relayResultMap.get('demoPost').status}"
+}
diff --git a/conf/_demo/types.ts b/conf/_demo/types.ts
@@ -0,0 +1,10 @@
+
+export type DynamicRuntime = {
+  log: (any) => any;
+};
+
+export type ResponseObj = {
+  statusCode: number;
+  headers: any;
+  body: any;
+};
diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "description": "A lightweight and extensible HTTP adapter, editable HTTP server, Webhook transformation, request relay platform. based on koa",
   "main": "src/main.ts",
   "scripts": {
-    "start": "node -r ts-node/register src/main.ts",
+    "start": "node dist/main.js",
     "test": "cross-env JEST_JUNIT_OUTPUT=test-result/result.xml jest --verbose --detectOpenHandles",
     "test_prod": "cross-env JEST_JUNIT_OUTPUT=test-result/result.xml jest --verbose --bail --ci --runInBand --reporters=default --reporters=jest-junit --detectOpenHandles --coverage",
     "dev": "cross-env CONF_PATH=./conf-dev DEBUG=server:* nodemon -r ts-node/register src/main.ts",
diff --git a/src/compiler/func-resolver.ts b/src/compiler/func-resolver.ts
@@ -40,7 +40,7 @@ export class FunctionResolver {
       console.error(`syntax error in function: ${key}, ${compiledFunc}, ${syntaxErr.message}`);
       throw new Error(`syntax error - ${key} - ${syntaxErr.message}`);
     }
-    ctxRunEnv.setPropertyToRunTime(prefix + key, tmpFunction.bind(ctxRunEnv));
+    ctxRunEnv.setPropertyToRunTime(prefix + key, tmpFunction.bind(ctxRunEnv.getRunTimeEnv()));
   }
 
   private static loadSingleFuncFromAST(ast: ts.Node) {
diff --git a/src/compiler/tmpl-resolver.ts b/src/compiler/tmpl-resolver.ts
@@ -26,7 +26,7 @@ export class TemplateResolver {
     let funcStr = `return \`${tmpl}\`;`;
     let func = new Function(constants.TEMPLATE_FUNC_PARAM, funcStr);
     func.prototype.name = prefix + key;
-    func.bind(ctxRunEnv);
+    func = func.bind(ctxRunEnv.getRunTimeEnv());
     ctxRunEnv.setPropertyToRunTime(prefix + key, func);
   }
 }
diff --git a/src/executor/relay.ts b/src/executor/relay.ts
@@ -56,7 +56,7 @@ export class RelayStage extends Executor<void, RouteConfig> {
         let interceptorFunc = (<FuncSet>runtime)[constants.RELAY_INTERCEPTOR_FUNC_PREFIX + routeName + confIndex + interceptor];
         if (typeof interceptorFunc === 'function') {
           try {
-            axiosConf = await interceptorFunc(axiosConf, ctx);
+            await interceptorFunc(axiosConf, ctx);
           } catch (ex) {
             ex.message = `${ctx.reqId}: Error when executing interceptor ${interceptor} for ${routeName} - ${confIndex}: ${ex.message}`;
             throw ex;
diff --git a/src/executor/response.ts b/src/executor/response.ts
@@ -31,7 +31,7 @@ export class ResponseStage extends Executor<void, RouteConfig> {
 
     // send response back
     ctx.response.status = responseObj.statusCode;
-    ctx.headers = responseObj.headers;
+    Object.keys(responseObj.headers).length > 0 && ctx.set(responseObj.headers);
     ctx.body = responseObj.body;
     debug(`${ctx.reqId}: finish response composing`);
   }
@@ -59,11 +59,8 @@ export class ResponseStage extends Executor<void, RouteConfig> {
       let interceptorFunc = (<FuncSet>runtime)[constants.RESP_INTERCEPTOR_FUNC_PREFIX + routeName + interceptor];
       if (typeof interceptorFunc === 'function') {
         try {
-          const result = await interceptorFunc(responseObj, ctx);
-          if (!result || !result.statusCode) {
-            throw new Error('empty or invalid response Object got, please check return statement in interceptor');
-          }
-          responseObj = result;
+          await interceptorFunc(responseObj, ctx);
+          return responseObj;
         } catch (ex) {
           ex.message = `${ctx.reqId}: Error when executing interceptor ${interceptor} for ${routeName}: ${ex.message}`;
           throw ex;
diff --git a/src/main.ts b/src/main.ts
@@ -13,7 +13,7 @@ const { app, metricsInterval } = Application;
  * Get port from environment
  */
 
-const port = normalizePort(process.env.NODE_PORT || '3000');
+const port = normalizePort(process.env.PORT || process.env.NODE_PORT || '3000');
 // app.set('port', port);
 
 /**
diff --git a/src/storage/conf-normalizer.ts b/src/storage/conf-normalizer.ts
@@ -78,52 +78,62 @@ export class ConfNormalizer {
   }
 
   public static async loadRelatedTmplAndFuncFiles(confObj: ApplicationConfig) {
-    // todo load extra template files
-    await this.loadCodeInConf(confObj.initContext.initFunctions, confObj);
-    await this.loadCodeInConf(confObj.initContext.functions, confObj);
+    await this.loadCodeOrTmplInConf(confObj.initContext.initFunctions, confObj);
+    await this.loadCodeOrTmplInConf(confObj.initContext.functions, confObj);
 
     for (let route of confObj.routes) {
       for (let handler of route.extract.headerHandlers) {
         if (handler.validate) {
-          handler.validate = await this.loadCodeInConf(handler.validate, confObj) as string;
+          handler.validate = await this.loadCodeOrTmplInConf(handler.validate, confObj) as string;
         }
       }
       for (let handler of route.extract.bodyHandlers) {
         if (handler.validate) {
-          handler.validate = await this.loadCodeInConf(handler.validate, confObj) as string;
+          handler.validate = await this.loadCodeOrTmplInConf(handler.validate, confObj) as string;
         }
       }
       for (let relayReq of route.relay) {
+        relayReq.body = await this.loadCodeOrTmplInConf(relayReq.body || '', confObj, true) as string;
+        if (!relayReq.headers) {
+          relayReq.headers = {};
+        }
+        await this.loadCodeOrTmplInConf(relayReq.headers, confObj, true);
+        relayReq.location = await this.loadCodeOrTmplInConf(relayReq.location, confObj, true) as string;
         if (relayReq.interceptors) {
-          await this.loadCodeInConf(relayReq.interceptors, confObj);
+          await this.loadCodeOrTmplInConf(relayReq.interceptors, confObj);
         }
       }
+      if (!route.response.headers) {
+        route.response.headers = {};
+      }
+      await this.loadCodeOrTmplInConf(route.response.headers, confObj, true);
+      route.response.body = await this.loadCodeOrTmplInConf(route.response.body || '', confObj, true) as string;
       if (route.response.interceptors) {
-        await this.loadCodeInConf(route.response.interceptors, confObj);
+        await this.loadCodeOrTmplInConf(route.response.interceptors, confObj);
       }
     }
     return confObj;
   }
 
-  private static async loadCodeInConf(target: KVPair | string, confObj: ApplicationConfig) {
+  private static async loadCodeOrTmplInConf(target: KVPair | string, confObj: ApplicationConfig, isTemplate = false) {
     if (typeof target === 'string') {
-      return await this.loadSingleFuncOrTmplCode(target, confObj);
+      return await this.loadSingleFuncOrTmplCode(target, confObj, isTemplate);
     } else {
       for (let funcName in target) {
         let funcStr = target[funcName].trim();
-        target[funcName] = await this.loadSingleFuncOrTmplCode(funcStr, confObj);
+        target[funcName] = await this.loadSingleFuncOrTmplCode(funcStr, confObj, isTemplate);
       }
     }
     return target;
   }
 
-  private static async loadSingleFuncOrTmplCode(target: string, confObj: ApplicationConfig) {
+  private static async loadSingleFuncOrTmplCode(target: string, confObj: ApplicationConfig, isTemplate: boolean) {
     let content = target;
     // load content data from files
     if (target && (target.endsWith('.js') || target.endsWith('.ts') || target.endsWith('.tmpl'))) {
       content = await ConfigManager.storage.loadSeparateContent(target, confObj);
     }
-    if (target.endsWith('.tmpl')) {
+    if (isTemplate) {
       return content;
     }
     // parse TS/JS function using TS Compiler
diff --git a/src/storage/storage.ts b/src/storage/storage.ts
@@ -29,9 +29,6 @@ export abstract class ConfStorage {
 
   abstract initialize(): Promise<void>;
 
-  // some storage types such as db need disconnect manually, make sure no resource leak
-  abstract dispose(): Promise<void>;
-
   abstract listAllConfigurations(): Promise<ApplicationConfig[]>;
 
   abstract findConfigurationByName(appName: string): Promise<ApplicationConfig>;
@@ -44,6 +41,8 @@ export abstract class ConfStorage {
 
   abstract loadSeparateContent(targetFile: string, confObj: ApplicationConfig): Promise<string>;
 
+  // some storage types such as db need disconnect manually, make sure no resource leak
+  abstract dispose(): Promise<void>;
   // abstract exportConf();
 
   // abstract importConf();
diff --git a/tsconfig.json b/tsconfig.json
@@ -4,6 +4,7 @@
     "resolveJsonModule": true,
     "module": "commonjs",
     "esModuleInterop": true,
+    "declaration": true,
     "target": "ES2017",
     "noImplicitAny": true,
     "moduleResolution": "node",

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+(msg) => {`
	`2`	`+ console.log(msg);`
	`3`	`+};`