feat: middleware koa-health and koa-openapi

zzswang · zzswang · commit 7a5fe8c24f23 · 2019-06-06T17:39:46.000+08:00
diff --git a/packages/fastman/package.json b/packages/fastman/package.json
@@ -3,7 +3,7 @@
   "version": "0.3.1",
   "description": "A tool to export and import postman collection file",
   "repository": {
-    "url": "undefined/undefined",
+    "url": "36node/sketch",
     "type": "git"
   },
   "license": "MIT",
diff --git a/packages/fetch/package.json b/packages/fetch/package.json
@@ -20,6 +20,7 @@
   "browser": "dist/browser.mjs",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
+  "typings": "typings/index.d.ts",
   "scripts": {
     "build": "sketch build src/{browser,index}.js",
     "test": "NODE_ENV=test sketch test --env=node"
diff --git a/packages/koa-health/LICENSE b/packages/koa-health/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 36node <zzswang@36node.com> (https://github.com/36node)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/packages/koa-health/README.md b/packages/koa-health/README.md
@@ -0,0 +1,39 @@
+# @36node/koa-health
+
+[![version][0]][1] [![downloads][2]][3]
+
+## Install
+
+```bash
+yarn add module
+```
+
+## Usage
+
+```js
+import module from "module";
+
+module();
+//=> foo
+```
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## Author
+
+**module** © [36node](https://github.com/36node), Released under the [MIT](./LICENSE) License.
+
+Authored and maintained by 36node with help from contributors ([list](https://github.com/36node/module/contributors)).
+
+> [github.com/zzswang](https://github.com/zzswang) · GitHub [@36node](https://github.com/36node)
+
+[0]: https://img.shields.io/npm/v/@36node/koa-health.svg?style=flat
+[1]: https://npmjs.com/package/@36node/koa-health
+[2]: https://img.shields.io/npm/dm/@36node/koa-health.svg?style=flat
+[3]: https://npmjs.com/package/@36node/koa-health
diff --git a/packages/koa-health/package.json b/packages/koa-health/package.json
@@ -0,0 +1,30 @@
+{
+  "name": "@36node/koa-health",
+  "version": "0.0.0",
+  "description": "koa health middleware for 36node team.",
+  "repository": {
+    "url": "36node/sketch",
+    "type": "git"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "template": "module",
+  "files": [
+    "bin",
+    "dist",
+    "typings"
+  ],
+  "config-overrides-path": "../cli/config-overrides",
+  "browser": "dist/browser.mjs",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "typings": "typings/index.d.ts",
+  "scripts": {
+    "build": "sketch build",
+    "test": "sketch test --env=node"
+  },
+  "dependencies": {},
+  "gitHead": "9c3f6d6834be075aa49460dd9c5e277f2a7573ad"
+}
diff --git a/packages/koa-health/src/index.js b/packages/koa-health/src/index.js
@@ -0,0 +1,39 @@
+import { escape } from "./lib/regex";
+
+/**
+ * health 中间件
+ * @param {Object} options 生成 health 中间件的参数
+ * @param {String} options.url 路径，默认 /health
+ * @param {String} options.version the version of api
+ */
+export default function({ url = "/health", version }) {
+  const regex = new RegExp(`${escape(url)}$`);
+  return (ctx, next) => {
+    if (ctx.url.match(regex)) {
+      ctx.body = {
+        version,
+        status: "OK",
+        load: 0.9,
+        check: [
+          {
+            name: "mysql",
+            status: "WARNING",
+            reason:
+              "db schema version (0.9.0) conflict with service api version (1.0.0)",
+          },
+          {
+            name: "mongo",
+            status: "OK",
+          },
+          {
+            name: "sms-service",
+            status: "ERROR",
+            reason: "connection timeout",
+          },
+        ],
+      };
+    } else {
+      return next();
+    }
+  };
+}
diff --git a/packages/koa-health/src/index.test.js b/packages/koa-health/src/index.test.js
@@ -0,0 +1,5 @@
+import health from "./index";
+
+test("health", () => {
+  expect(health()).toHaveBeenCalledWith();
+});
diff --git a/packages/koa-health/src/lib/regex.js b/packages/koa-health/src/lib/regex.js
@@ -0,0 +1,3 @@
+export const escape = function(string) {
+  return string.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
+};
diff --git a/packages/koa-health/typings/index.d.ts b/packages/koa-health/typings/index.d.ts
@@ -0,0 +1,16 @@
+import Koa = require("koa");
+
+declare module "@36node/koa-health" {
+  interface Options {
+    url: string;
+    version: string;
+  }
+
+  /**
+   * health 中间件
+   * @param {Object} options 生成 health 中间件的参数
+   * @param {String} options.url 路径，默认 /health
+   * @param {String} options.version the version of api
+   */
+  export function health(options: Options): Function;
+}
diff --git a/packages/koa-openapi/LICENSE b/packages/koa-openapi/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 36node <zzswang@36node.com> (https://github.com/36node)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/packages/koa-openapi/README.md b/packages/koa-openapi/README.md
@@ -0,0 +1,39 @@
+# @36node/koa-openapi
+
+[![version][0]][1] [![downloads][2]][3]
+
+## Install
+
+```bash
+yarn add module
+```
+
+## Usage
+
+```js
+import module from "module";
+
+module();
+//=> foo
+```
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## Author
+
+**module** © [36node](https://github.com/36node), Released under the [MIT](./LICENSE) License.
+
+Authored and maintained by 36node with help from contributors ([list](https://github.com/36node/module/contributors)).
+
+> [github.com/zzswang](https://github.com/zzswang) · GitHub [@36node](https://github.com/36node)
+
+[0]: https://img.shields.io/npm/v/@36node/koa-openapi.svg?style=flat
+[1]: https://npmjs.com/package/@36node/koa-openapi
+[2]: https://img.shields.io/npm/dm/@36node/koa-openapi.svg?style=flat
+[3]: https://npmjs.com/package/@36node/koa-openapi
diff --git a/packages/koa-openapi/package.json b/packages/koa-openapi/package.json
@@ -0,0 +1,30 @@
+{
+  "name": "@36node/koa-openapi",
+  "version": "0.0.0",
+  "description": "koa openapi middleware for 36node team.",
+  "repository": {
+    "url": "36node/sketch",
+    "type": "git"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "template": "module",
+  "files": [
+    "bin",
+    "dist",
+    "typings"
+  ],
+  "config-overrides-path": "../cli/config-overrides",
+  "browser": "dist/browser.mjs",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "typings": "typings/index.d.ts",
+  "scripts": {
+    "build": "sketch build",
+    "test": "sketch test --env=node"
+  },
+  "dependencies": {},
+  "gitHead": "9c3f6d6834be075aa49460dd9c5e277f2a7573ad"
+}
diff --git a/packages/koa-openapi/src/index.js b/packages/koa-openapi/src/index.js
@@ -0,0 +1,26 @@
+import { escape } from "./lib/regex";
+
+/**
+ * koa openapi 中间件
+ * @param {Object} options 生成 openapi 中间件的参数
+ * @param {String} options.url 路径，默认 /openapi
+ * @param {String} options.version the version of api
+ */
+export default function({ url = "/openapi", file }) {
+  if (!url) throw new Error("url is required for openapi middleware");
+  if (!file)
+    throw new Error(
+      "file is required for openapi middleware, could be stream or block"
+    );
+
+  const regex = new RegExp(escape(url));
+
+  return (ctx, next) => {
+    if (ctx.url.match(regex)) {
+      ctx.type = "text/yaml";
+      ctx.body = file;
+    } else {
+      return next();
+    }
+  };
+}
diff --git a/packages/koa-openapi/src/index.test.js b/packages/koa-openapi/src/index.test.js
@@ -0,0 +1,5 @@
+import openapi from "./index";
+
+test("openapi", () => {
+  expect(openapi()).toHaveBeenCalledWith();
+});
diff --git a/packages/koa-openapi/src/lib/regex.js b/packages/koa-openapi/src/lib/regex.js
@@ -0,0 +1,3 @@
+export const escape = function(string) {
+  return string.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
+};
diff --git a/packages/koa-openapi/typings/index.d.ts b/packages/koa-openapi/typings/index.d.ts
@@ -0,0 +1,16 @@
+import Koa = require("koa");
+
+declare module "@36node/koa-openapi" {
+  interface Options {
+    url: string;
+    file: string;
+  }
+
+  /**
+   * openapi 中间件
+   * @param {Object} options 生成 openapi 中间件的参数
+   * @param {String} options.url 路径，默认 /openapi
+   * @param {String} options.file openapi.yml文件路径
+   */
+  export function openapi(options: Options): Function;
+}
diff --git a/packages/tpl-module/typings/index.d.ts b/packages/tpl-module/typings/index.d.ts
@@ -0,0 +1,9 @@
+import Koa = require("koa");
+
+declare module "@36node/template-module" {
+  export function doAdd(a: Number, b: Number): Number;
+  export function doSubtract(a: Number, b: Number): Number;
+  export function doMultiply(a: Number, b: Number): Number;
+  export function doDivide(a: Number, b: Number): Number;
+  export function foo(): void;
+}
diff --git a/packages/tpl-service/package.json b/packages/tpl-service/package.json
@@ -78,6 +78,8 @@
   "dependencies": {
     "@36node/mongoose-helper": "^0.2.1",
     "@36node/query-normalizr": "^0.4.0",
+    "@36node/koa-health": "^0.0.0",
+    "@36node/koa-openapi": "^0.0.0",
     "@koa/cors": "^3.0.0",
     "@types/jest": "^24.0.12",
     "dotenv": "^7.0.0",
diff --git a/packages/tpl-service/src/app.js b/packages/tpl-service/src/app.js
@@ -14,8 +14,10 @@ import { queryNormalizr } from "@36node/query-normalizr";
 
 import logger from "./lib/log";
 import { BASE, NODE_ENV } from "./config";
-import openapi from "./middleware/openapi";
+import health from "@36node/koa-health";
+import openapi from "@36node/koa-openapi";
 import petsService from "./services/pet";
+import pkg from "../package.json";
 
 const app = new Koa2();
 const router = new Router({ prefix: BASE });
@@ -42,7 +44,8 @@ if (NODE_ENV !== "production") {
  */
 app
   .use(helmet())
-  .use(openapi(`${BASE}/openapi.yml`, openapiFile))
+  .use(health({ url: `${BASE}/health`, version: pkg.version }))
+  .use(openapi({ url: `${BASE}/openapi.yml`, file: openapiFile }))
   .use(cors({ exposeHeaders: ["Link", "X-Total-Count"] }))
   .use(jwt({ secret: publicKey }))
   .use(body())

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export const escape = function(string) {`
	`2`	`+ return string.replace(/[-/\\^$*+?.()\|[\]{}]/g, "\\$&");`
	`3`	`+};`