skybase 0.1.93 → 0.1.95

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.1.94](https://github.com/kongnet/skybase/compare/v0.1.93...v0.1.94) (2023-04-25)
+
+
+### :bug:
+
+* 一些提示修改成en ([a9da814](https://github.com/kongnet/skybase/commit/a9da814c939f37cab35dadb46456519e84868024))
+
+
+
+## [0.1.93](https://github.com/kongnet/skybase/compare/v0.1.92...v0.1.93) (2022-09-01)
+
+
+
+
 ## [0.1.92](https://github.com/kongnet/skybase/compare/v0.1.91...v0.1.92) (2022-08-31)
 
 

package/lib/middleware/sky-api-register.js

@@ -12,7 +12,7 @@ Mock.Random.extend($.Mock)
 const mockFn = {
   noMock () {
     return function (ctx) {
-      ctx.ok('controller未定义 & mock未定义')
+      ctx.ok('base:controller or mock not defined') //'controller未定义 & mock未定义'
     }
   },
   mockRouter (mockModels) {
@@ -55,11 +55,12 @@ const routerLog = (result, name, apiPath, ms) => {
           : `:"${item[1]}"`
       }
     )
-    let resultKey = resultValue.replace(/"([a-zA-Z0-9_\$\.]+)" *:/g, function (
-      ...item
-    ) {
-      return `"${$.c.dimy(item[1])}":`
-    })
+    let resultKey = resultValue.replace(
+      /"([a-zA-Z0-9_\$\.]+)" *:/g,
+      function (...item) {
+        return `"${$.c.dimy(item[1])}":`
+      }
+    )
     resultKey = resultKey.slice(0, 1000)
     $.log(
       '[router处理]=>',
@@ -147,7 +148,7 @@ const limitReqAction = (action, apiPath) => {
         ctx.body = {
           code: 402,
           data: diff,
-          msg: '访问过快请稍后再试！'
+          msg: 'base:request limit, pls try later' //'访问过快请稍后再试！'
         }
 
         routerLog(ctx.body, name || desc, apiPath, Date.now() - start)
@@ -178,7 +179,7 @@ const limitReqAction = (action, apiPath) => {
       ctx.body = {
         code: 406,
         data: {},
-        msg: `${apiPath}的Control不存在,请在api定义中定义mock对象`
+        msg: `${apiPath} base:Control not exist, pls defined mock Object in Api` //`${apiPath}的Control不存在,请在api定义中定义mock对象`
       }
     }
 
@@ -256,9 +257,10 @@ const checkApi = (apiDir, apiPath = '') => {
       } else {
         const ap = require(dir)
         for (const [p, opt] of Object.entries(ap)) {
-          const path = (p.indexOf('/') === 0
-            ? p
-            : `${apiPath}/${files[i].split('.')[0]}/${p}`
+          const path = (
+            p.indexOf('/') === 0
+              ? p
+              : `${apiPath}/${files[i].split('.')[0]}/${p}`
           )
             .split('/')
             .filter(v => !!v)

package/lib/middleware/sky-body-parse.js

@@ -1,4 +1,3 @@
-
 // NOTICE: 经过body格式格式化一下内容才可对象化
 const $ = require('meeko')
 const { bodyParse } = require('../../skyconfig')
@@ -17,7 +16,7 @@ module.exports = async (ctx, next) => {
     $.err('用户输入错误e.message', e.stack)
     switch (e.type) {
       case 'entity.too.large':
-        ctx.throwCode(413, 'request entity too large')
+        ctx.throwCode(413, 'base:request entity too large')
         break
       default:
         ctx.throwCode(400, e.message)

package/lib/middleware/sky-check-param.js

@@ -60,8 +60,8 @@ const checkCache = (ctx, method, url) => {
 
 // 快速检查是否可以不执行具体方法
 const preCheck = (ctx, method, url, apiPath) => {
-  if (!['get', 'post'].includes(method)) {
-    ctx.throwCode(ctx.status, '只支持get/post/all方式')
+  if (!['get', 'post', 'all'].includes(method)) {
+    ctx.throwCode(ctx.status, 'base:only get/post/all method') //'只支持get/post/all方式'
     return { succ: false, continue: false }
   }
   if (checkRedirect(ctx, apiPath)) {
@@ -89,7 +89,7 @@ const preCheck = (ctx, method, url, apiPath) => {
       ]
   }
   if (!apiSetting) {
-    ctx.throwCode(404, '接口不存在')
+    ctx.throwCode(404, 'base:interface does not exist') //'接口不存在'
     return { succ: false, continue: false }
   }
 
@@ -97,7 +97,7 @@ const preCheck = (ctx, method, url, apiPath) => {
   if (method !== needMethod && needMethod !== 'all') {
     // 允许get和post都接入
     $.err(`方法类型不对，应为${needMethod}，不能为${method}`)
-    ctx.throwCode(405, '方法类型不对')
+    ctx.throwCode(405, 'base:method type error') //'方法类型不对'
     return { succ: false, continue: false }
   }
 
@@ -108,12 +108,12 @@ module.exports = async (ctx, next) => {
   const method = ctx.method.toLowerCase()
   const url = ctx.request.url
   const apiPath = url.split('?')[0]
-  const { continue: canContinue, succ, needMethod, apiSetting } = preCheck(
-    ctx,
-    method,
-    url,
-    apiPath
-  )
+  const {
+    continue: canContinue,
+    succ,
+    needMethod,
+    apiSetting
+  } = preCheck(ctx, method, url, apiPath)
   if (!canContinue) {
     apiCheckLog(apiPath, ctx.body, method, null, ctx)
     return succ ? 1 : 0

package/lib/middleware/sky-check-token.js

@@ -12,7 +12,7 @@ module.exports = async (ctx, next) => {
       const data = await checkToken(token)
       if (!data && needToken) {
         $.log(token + ' 非法用户')
-        return ctx.throwCode(401, '请登录!')
+        return ctx.throwCode(401, 'base:pls login!') //'请登录!'
       }
       ctx.checkedToken = data
       if (data && ctx.checkedData) {
@@ -20,12 +20,13 @@ module.exports = async (ctx, next) => {
       }
     } else {
       $.log('接口需要token')
-      return ctx.throwCode(401, '需要token,或需登录')
+      return ctx.throwCode(401, 'base:need token or no login') //'需要token,或需登录'
     }
-  } else { // 兼容微服务
+  } else {
+    // 兼容微服务
     ctx.checkedToken = { headers: ctx.request.headers }
   }
-  next && await next()
+  next && (await next())
 }
 
 // // 删除原先的登录凭证
@@ -62,7 +63,9 @@ async function checkToken (token, tokenPre = 'userlogin') {
     keyStr = keyStr.trim()
     let o = JSON.parse(await redis.get(keyStr))
     $.log(keyStr, o)
-    if (o === null) { return 0 }
+    if (o === null) {
+      return 0
+    }
     if (o.id) {
       let ot = await redis.get(Config.tokenName + ':id:' + o.id)
       if (ot !== token) {

package/lib/middleware/sky-output.js

@@ -2,32 +2,32 @@
  * 记录api运行前后的状态，并封装到response中
  * */
 
-const $G = global.$G = global.$G || {}
+const $G = (global.$G = global.$G || {})
 const $ = require('meeko')
 
 // 是否停止接收新的网络请求。如果设为 true ，来了新请求，还是会先判断参数是否正确，是否登录，然后返回 503
 $G.stopNewRequest = false
 
 // 拦截最后的返回
-const interceptLastReturn = (ctx) => {
+const interceptLastReturn = ctx => {
   switch (ctx.status) {
     case 200:
       break
     case 204:
-      ctx.throwCode(204, 'sys:无内容返回')
+      ctx.throwCode(204, 'base:no content') //'sys:无内容返回'
       break
     case 405:
-      ctx.throwCode(405, 'sys:无访问api权限')
+      ctx.throwCode(405, 'base:api no rights') //'sys:无访问api权限'
       break
     case 404:
       // ctx.throwCode.call(ctx, 404, 'sys:无此api或api发生错误', '', ctx)
-      ctx.throwCode(404, 'sys:无此api或api发生错误')
+      ctx.throwCode(404, 'base:api not found or api error') //'sys:无此api或api发生错误'
       break
     case 401:
-      ctx.throwCode(401, 'sys:无权限')
+      ctx.throwCode(401, 'base:no rights') //'sys:无权限'
       break
     default:
-      ctx.throwCode(ctx.status, 'sys:服务端未知错误')
+      ctx.throwCode(ctx.status, 'base:unknown error') //'sys:服务端未知错误'
   }
 }
 
@@ -36,7 +36,7 @@ module.exports = async (ctx, next) => {
   const start = Date.now()
   try {
     if ($G.stopNewRequest) {
-      ctx.throwCode(503, '服务端暂时停止服务，请稍后再试')
+      ctx.throwCode(503, 'base:server stop respone,pls try later') //'服务端暂时停止服务，请稍后再试'
     } else {
       await next()
     }
@@ -44,13 +44,16 @@ module.exports = async (ctx, next) => {
     $.err(e.stack)
     switch (true) {
       case e.message.indexOf('ETIMEDOUT') > -1:
-        ctx.throwCode(599, '服务端超时')
+        ctx.throwCode(599, 'base:server timeout') //'服务端超时'
         break
       case e.message.indexOf('ENOENT') > -1:
-        ctx.throwCode(598, '服务端找不到路径')
+        ctx.throwCode(598, 'base:not found path') //'服务端找不到路径'
         break
-      case e.message === 'request entity too large':
-        ctx.throwCode(413, `请求体过大：${e.length} / ${e.limit} 字节`)
+      case e.message === 'base:request entity too large':
+        ctx.throwCode(
+          413,
+          `base:request entity too large: ${e.length} / ${e.limit} bytes`
+        ) //`请求体过大：${e.length} / ${e.limit} 字节`
         break
       default:
         ctx.throwCode(500, e.message, e)

package/lib/sky.js

@@ -1,11 +1,29 @@
 #!/usr/bin/env node
 'use strict'
+const os = require('os')
+
+const networkInterfaces = os.networkInterfaces()
+let localIP = Object.keys(networkInterfaces).map((ifname, index) => {
+  const iface = networkInterfaces[ifname]
+  const arr = iface.map(x => {
+    if (
+      x?.family === 'IPv4' &&
+      !x?.internal &&
+      x?.mac !== '00:00:00:00:00:00'
+    ) {
+      return x.address
+    }
+  })
+  return arr.filter(Boolean)
+})
+
 const $G = (global.$G = global.$G || {})
 // global.Promise = require('bluebird')
 
 const skyExt = require('./sky_extend')
 const path = require('path')
 const http = require('http')
+const https = require('https')
 
 // 全局对象
 const $ = (global.$ = require('meeko'))
@@ -54,9 +72,17 @@ const getPort = async (port, beforeListenPort) => {
   return portTemp
 }
 
-const createWebServer = async (port, afterCreateServer) => {
-  const server = http.createServer(app.callback())
-  if(afterCreateServer){
+const createWebServer = async (port, afterCreateServer, httpsOption) => {
+  let option = {}
+  let server
+  if (httpsOption) {
+    option = httpsOption
+    server = https.createServer(option, app.callback())
+  } else {
+    server = http.createServer(app.callback())
+  }
+
+  if (afterCreateServer) {
     await afterCreateServer(server)
   }
 
@@ -84,7 +110,7 @@ async function init (option, cbFun) {
   const {
     name,
     port,
-
+    https,
     beforeMount,
     beforeLoadMiddlewares,
     afterLoadMiddlewares,
@@ -157,12 +183,15 @@ async function init (option, cbFun) {
 
       // 侦听端口
       const portFinal = await getPort(port, beforeListenPort)
-      $G.server = await createWebServer(portFinal, afterCreateServer)
-
+      $G.server = await createWebServer(portFinal, afterCreateServer, https)
       $.log(
         $.c.g('✔'),
-        `${$.c.y(name)} WebServer [${$.c.y('0.0.0.0')}] Listen at`,
-        `${$.c.y(portFinal)}`
+        `${$.c.y(name)} WebServer [${$.c.y('0.0.0.0')}] [${localIP
+          .flat(1)
+          .join(',')}] Listen at`,
+        `${$.c.y(portFinal)} ${
+          https ? 'https' : 'http'
+        }://127.0.0.1:${portFinal}/`
       )
       skyExt.artTxt(name, 'Graceful')
     }

package/lib/sky_extend.js

@@ -4,21 +4,21 @@ const figlet = require('figlet')
 
 const deconstructionCode = (errCode, errMsg, data) => {
   if (errCode instanceof Array) {
-    [errCode, errMsg, data] = errCode
+    ;[errCode, errMsg, data] = errCode
   } else if (errCode && Object === errCode.constructor) {
-    ({ data, msg: errMsg, code: errCode } = errCode)
+    ;({ data, msg: errMsg, code: errCode } = errCode)
   }
 
   if (!errCode && errCode !== 0) {
     errCode = 500
-    errMsg = errMsg || '未配置errCode'
+    errMsg = errMsg || 'base:unset errCode' //'未配置errCode'
   } else {
     const olderrCode = errCode
     errCode = parseInt(errCode)
     if (isNaN(errCode)) {
       console.log('【errCode配置不正确】', olderrCode)
       errCode = 500
-      errMsg = errMsg || 'errCode配置不正确'
+      errMsg = errMsg || 'base: errCode setting Incorrect' //'errCode配置不正确'
     }
   }
 
@@ -26,7 +26,6 @@ const deconstructionCode = (errCode, errMsg, data) => {
 }
 
 const appContext = {
-
   /**
    * 向body写入统一的数据格式
    *
@@ -43,9 +42,8 @@ const appContext = {
    * */
 
   throwCode: function (errCode, errMsg, data) {
-    this.type = 'json';
-
-    ({ errCode, errMsg, data } = deconstructionCode(errCode, errMsg, data))
+    this.type = 'json'
+    ;({ errCode, errMsg, data } = deconstructionCode(errCode, errMsg, data))
 
     // ps. 这里不 JSON.stringify ，就会在中间件：bodyParseFn 解析body的时候报错，
     // 那里同时处理输入和输出的数据，没法区分是输入的错还是输出的错
@@ -59,8 +57,13 @@ const appContext = {
 
       return this.body
     } catch (e) {
-      console.error(this.request.url, { code: 500, msg: '输出的数据无法解析' }, this.method.toLowerCase(), data)
-      this.throwCode(500, '输出的数据无法解析')
+      console.error(
+        this.request.url,
+        { code: 500, msg: '输出的数据无法解析' },
+        this.method.toLowerCase(),
+        data
+      )
+      this.throwCode(500, 'output data parse error') //'输出的数据无法解析'
     }
   },
   ok: function (data, msg) {
@@ -87,7 +90,8 @@ const errStackFn = e => {
 process.on('uncaughtException', errStackFn)
 process.on('unhandledRejection', errStackFn)
 
-const artTxt = (s = 'SKY', font = 'Star Wars') => $.log($.c.c(figlet.textSync(s, { font })))
+const artTxt = (s = 'SKY', font = 'Star Wars') =>
+  $.log($.c.c(figlet.textSync(s, { font })))
 const artStage = s => {
   const len = s.length + 4
   const char = '─'.times(len)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skybase",
-  "version": "0.1.93",
+  "version": "0.1.95",
   "description": "sky框架",
   "main": "index.js",
   "directories": {