yf-fpm-server/CHANGELOG.md

yf fast-platform api server

# 2.7.0 (2021-05-19)
Modify:
- `Logger`
  
  Make it more flexiable, eg: define where the log output!

# 2.6.2 (2019-04-22)
Add:
- `SSL`
  - command:

    ```bash
    $ openssl genrsa -out privatekey.pem 1024
    $ openssl req -new -key privatekey.pem -out certrequest.csr 
    $ openssl x509 -req -in certrequest.csr -signkey privatekey.pem -out certificate.pem
    ```
    
# 2.5.3 (2019-03-25)
Add:
- Extend the `config.*.json` to the config Object, the `*` is the `NODE_ENV` of the `process.ENV`; 
  - Such as `process.ENV.NODE_ENV === 'DEV'` the `config.dev.json` file will be loaded and assign to the config object.
  - The `*` must be lowercase.
  - The `*` default value is `DEV`.


# 2.5.1 (2019-03-04)

Add:
- Add `disableBodyParser` config.
  
  use `new Fpm({ disableBodyParser: ['/notify']})` to disable the `/notify` post handler

  add a middleware:
  ```javascript
    app.use(async(ctx, next) => {
      delete ctx.disableBodyParser;
      const disableBodyParser = this.get('disableBodyParser');
      if(disableBodyParser){
        let urls;
        if(_.isArray(disableBodyParser)){
          urls = disableBodyParser;
        }else if(_.isString(disableBodyParser)){
          urls = disableBodyParser.split(',');
        }
        const urlPath = ctx.request.url ;
        _.map(urls, url => {
          if(_.endsWith(urlPath, url)){
            ctx.disableBodyParser = true;
          }
        })
      }
      await next()
    })
  ```
- Support https

Simple Config:
```javascript
{
  ssl: {
    key: 'ssl/server.key',  // the key filepath
    cert: 'ssl/server.crt', // the crt filepath
    port: 9443,             // the https port
  },
}
```

How to make a ssl key/cert?

[Here](https://www.cnblogs.com/liyulong1982/p/6106129.html)

# 2.5.0 (2018-11-12)

Add:
- `package-lock.json`
- `fpm.getEnv(envKey, defaultValue)` get the process.env key-values

Remove:
- yarn.lock

# 2.4.12 (2018-06-08) 

Add:
- `fpm.getPluginRef(pname)` get the origin ref of the plugin by the plugin name, ex: `getPluginRef('mysql')` or `getPluginRef('fpm-plugin-mysql')`

- `fpm._webhook_events` record the webhook events
  contains: { topic!String, message!Object, at!timestamp}

- Use `curl` to perform webhook
  Webhook Url: `/webhook/:upstream/:type/:data`
  Publish Topic: `#webhook/${upstream}/${type}`
  `$ curl -H "Content-Type:application/json" -X POST --data '{"id":10}' http://localhost:9999/webhook/test/foo/bar `

# 2.4.11 (2018-06-07)
BugFix:
- `publish(topic, data)`

# 2.4.10 (2018-06-07)
Modify:
- `async execute(method, args, v, ctx)` The `v` Change To Be Optional
- add `fpm._publish_topics`, it save all the topics published by the biz functions
- `publish(topic, data)` , It May Throw An Exception When The TOPIC Published By Other Function

# 2.4.9 (2018-05-31)
BugFix:
- masterkey lost from 
  before: `let sign = (args) => {` ; after: `let sign = (args, apps) => {`
  

# 2.4.7 (2018-05-31)
Add:
- `execShell(shellPath:String!, params:[]?) => Promise`
  Add an execShell method For Run `.sh` or `.bat` files. 
 
  *The ShellPath Should Be An Abstract Path*
BugFix:
- `Digest already called` AT File `yf-fpm-server/lib/utils/kit.js:25:7`
  https://github.com/nodejs/node-v0.x-archive/issues/1415

# 2.4.2 (2018-05-28)
Update:
- `loadPlugin`
  - Add Field `package` For Each Plugin, It links this origin reference of the plugin module
  - Add Field `isBound` For Each Plugin, It means plugin invoke `bind()` ok

Files:
- Move `loadPlugin` from `bin\app.js` to `utils\plugin.js`

# 2.4.1 (2018-05-26)
Add 3 Field For Plugin:
- info: `packageInfo` 
  The package.json For The Plugin
- npm:`https://www.npmjs.com/package/${packageInfo.name}`
  The HomePage For The Plugin In `npmjs.com`
- registry: `http://registry.npmjs.org/${packageInfo.name}` 
  The Registry Info Of The Plugin

Remove:
- remove `deletedir`

Update:
- format all error code & errno

# 2.4.0 (2018-05-25)
update:
- koa@2.5.x

# 2.3.1 (2018-05-25)
Add:
- default config `server.hostname` & `server.domain`
  ```javascript
  server:{
    hostname: '0.0.0.0',
    domain: 'localhost',
    port: 9999
  }
  ```
- Return A Promise In `fpm.run()`, it will be called after the server startup
  ```javascript
  app.run()
    .then(fpm => {
      fpm.logger.info('ready ...')
    })
  ```

# 2.3.0 (2018-05-19)

ADD:
- fpm._counter : count the api calls
- fpm._project_info: the project package.json

Exception Code: from `900` ~ `999`

Update:
- yf-fpm-nodejs-client@1.0.15

Remove:
- gulp
- jquery
- materialize-css
- log
- moment
- md5
- ncp
- koa-multer

# 2.2.25 (2018-05-14)

Remove: 
- views/
- public/ 
- admin.js

TODO:
- implement a fpm-plugin-admin

# 2.2.24 (2018-05-13)

ADD:
- Add Action Before Api Invoke
`ctx.fpm.runAction('CALL_API', ctx.fpm, ctx, { method, param, v })`
- Attach An Argument `ctx` At Function `core(method, args, v, fpm, ctx)`
- Attach An Argument `ctx` At Each Handler `handler(args, ctx, [])`
  - The Last Argument should be replaced by the output of before_*_hook, It always be an Array
- Attach An Argument `ctx` At `hook.runHook('before_' + method, args, v, ctx)`


# 2.2.24 (2018-04-28)

TODO:
- Add Ip Filter In File `permission.js`ss

# 2.2.24 (2018-04-25)

Remove

- The `BEFORE_MODULES_ADDED` & `AFTER_MODULES_ADDED` Action Hook Points May Invoke Multi Times; `fpm.addBizModules(biz:Biz)` can be called many times

- In The Middleware `response.js`;  Support More Type Of Result Not Only `Object`
  ```javascript
  ctx.success = (result, msg) => {
    data.message = msg || ''
    if(_.isPlainObject(result)){
      if(_.has(result, data)){
        data.data = result.data
        return
      }
    }    
    data.data = result   
  }
  ```

Add

- `extendModule(name:String!, module:Object/Function!, version:String?)` for plugin in `DEV` mode
- `getPlugins()` show all loaded plugins
- `isPluginInstalled(name:String!)`

Remove 

- example\runner.js 

# 2.2.21 (2017-07-15)

Add

- Fpm
  - Admin
    - login

# 2.2.5 (2017-07-01)

Add

- Fpm
  - `createRouter`
  - `bindRouter(router)`

# 2.2.4 (2017-04-08)

Remove

- upload router
- upload dir
- remove `qiniu` dep

Plugin

- qiniu upload plugin
- memory upload plugin

# 2.2.3 (2017-04-05)

Feature

- Support file middleware `qiniu`

# 2.2.3 (2017-03-29)

Feature

- Support upload use `koa-multer`


# 2.2.2 (2017-03-28)

Feature

- upload 

# 2.2.2 (2017-03-05)

Feature

- Support Pub/Sub

# 2.2.1 (2017-03-05)

Remove

- concat analyse.js to auth.js

Change

- Use `Reg.test()` To Validate The App Root

# 2.2.0 (2017-03-02)

Feature

- plugin inject config to FPM.config

```javascript
extendConfig(c){
  config = _.assign(config, c || {})
}
```

Remove

- util.job,util.logger

Files Change

- Add example dir with app.js 

# 2.1.8 (2017-03-01)

- check config.json when FPM.INIT()

BreakChange:

- cancel config middleware

# 2.1.7 (2017-02-21)

Feature:

- Support Plugin
- update koa2-cors modules

- Add getConfig() from config.json static config file

- add more hook points
[ INIT, BEFORE_ROUTER_ADDED, AFTER_ROUTER_ADDED, BEFORE_MODULES_ADDED, AFTER_MODULES_ADDED, BEFORE_SERVER_START, AFTER_SERVER_START]

- add execute method for fpm class

# 2.1.6 (2017-02-05)

Feature:

- support post json data
- update Koa Modules

# 2.1.5 (2017-02-05)


FixBugs:

- server error TypeError: args.hasOwnProperty is not a function

```bash
server error TypeError: args.hasOwnProperty is not a function
    at checkArgs (F:/FPM/yf-fpm-server/src/middleware/compare.js:55:16)
    at compare (F:/FPM/yf-fpm-server/src/middleware/compare.js:9:21)
    at _callee$ (F:/FPM/yf-fpm-server/src/middleware/compare.js:107:23)
    at tryCatch (F:\FPM\yf-fpm-server\node_modules\.0.10.1@regenerator-runtime\runtime.js:64:40)
    at GeneratorFunctionPrototype.invoke [as _invoke] (F:\FPM\yf-fpm-server\node_modules\.0.10.1@regenerator-runtime\runtime.js:355:22)
```

Bug: /src/middleware/compare.js:55:16

before:

```javascript
if(!args.hasOwnProperty(a))
```

after:

```javascript
if(!_.has(args, a))
```