@sex-pomelo/sex-pomelo/History.md

[![NPM version][npm-image-pomelo]][npm-url-pomelo] [![NPM version][npm-image-down]][npm-url-pomelo]

# 2.4.2 / 2025-07-16

* [x] optimize logger info filename length;

# 2.4.1 / 2025-07-14

* [x] fix `BaseGameHandler` constructor error;
* [x] fix monitor, server comp extern error;

# 2.4.0 / 2025-07-12

* [x] update deps
* [x] i18n 组件规范化，
* [x] typeing

**Break change**

* route string only support `[a-zA-Z0-9.]`

## i18n 支持 i18n-ally 扩展

1. change `.vscode/settings.json`
   ``` json
   {
	"i18n-ally.localesPaths": [ "app/locale" ],
	"i18n-ally.sourceLanguage": "en-US",
	"i18n-ally.keystyle": "flat",
	"i18n-ally.enabledParsers": [ "js" ],
	"i18n-ally.supportedLanguages": [ "zh-CN", "es-US" ]
   }
   ```
1. 增加文件 `.vscode/i18n-ally-custom-framework.yml`
   ```yml
	# .vscode/i18n-ally-custom-framework.yml

	languageIds:
	  - javascript
	  - javascriptreact

	usageMatchRegex:
	  - "[^\\w\\d]tr\\s*\\([\\s]*['\"`]({key})['\"`]"
	  - "[^\\w\\d]tr1\\s*\\([\\s]*[^,]*,[\\s]*['\"`]({key})['\"`]"

	scopeRangeRegex: "useTranslation\\(\\s*\\[?\\s*['\"`](.*?)['\"`]"

	monopoly: true
   ```



# 2.3.0 /2021-11-26
=================
* Compatible ```Node 16```

**Break change**
* Update the route compression component. The original component will scan all handlers and generate dictionaries, which will lead to unexpected interface leakage and security problems.
Now it is updated that only manually set routes will be exposed and compressed. Change to set the route that can be compressed through dictionary.json.

**Feature**
* Add ```i18n``` built in components

---- chinese

**Break change**
### 1. 更新路由压缩组件
原有组件会扫描所有 handler，生成字典，这样会导致接口意外暴漏，导致安全问题。
现在更新为只有手动设置的路由才会暴漏并压缩。改动为通过 dictionary.json 设置可以压缩的路由。

dictionary.json
``` js
{
    "route":{
        "chat":[
            "ChatHandler.send"
        ],
        "connector" :[
            "entryHandler.enter"
        ],
        "gate" :[
            "gateHandler.queryEntry"
        ]
    },
    "notify": [
        "onChat",
        "onAdd",
        "onLeave"
    ]
}

```
 * 保留 通过 ```useDict```，开启路由压缩功能
 * ```route```, 设置每类服务器需要压缩的路由
   - key，服务类型，支持通用匹配 如果connector 和 gate 暴露的路由一样，可以写成 "gate|connector"
   - val，需要压缩的路由数组
 * ```notify```,同原有通知路由

**Feature**
### 2. 增加```i18n```内置组件
通过 ```pomelo.i18n```开启，配置参数如下
``` json
{
"path": "app/locale", // set locale path，optional, default <root>/locale
"locale": ["en-US","zh-CN"], // use locale, optional
"default": "en-US"             // default locale, required
}
```

``` js
app.configure('production|development' ,'!master',function() {
    app.load( pomelo.i18n,{
          path: 'app/locale',          // set locale path，optional, default <root>/locale
          locale: ['en-US','zh-CN'],   // use locale, optional
          default: 'en-US'             // default locale, required
        }
    });
});
```

通过config配置
``` config.js

components: [
	{
		name: '__i18n__', // 使用内置组件，按照格式 __<内置组件名字>__
		serverType: 'gate',
		cfg: { 
			path: 'app/locale',
			locale: ["en-US","zh-CN"],
			default: i18n,
			localeFiledName: 'lang'
		}
	},
]
```
 * 在config.js 模式，使用内置组件，组件的名称需要按照格式 [ ```__<内置组件名字>__``` ]


# 2.x
## 2.2.28 /2021-05-08
=================
* hybridsocket, add Get client real IP through X-Forwarded-For (Take only one).
* Update `commander` dep.

---- chinese
* hybridsocket，增加通过 X-Forwarded-For 获取真实IP（用于前端有代理如nginx时的情况）。
* 升级 commander 包版本.
* 其它一些小修改

2.2.27 / 2020-11-27
=================
* Use clifflite replace cliff( node14 cliff has (**`warning`** ).
* connector add cfg `useAsyncSend`, if true async send data package.
* `new Buffer` change to `Buffer.from`,`Buffer.alloc` 
* update deps
  - sex-pomelo-protocol, Message encode performance improvement(Opt-in for performance and spec compliance `npm install --save @sex-pomelo/pomelo-coderx`)
* hybrifsocket/tcpsocket Performance improvement( packageHeadBuffer )


2.2.26 / 2020-09-28
=================
 **New features**
 * app.configure(...) add exclude type. If the server type string starts with ! At first, this configuration is used by all servers except type
	``` js
	app.configure('development', '!connector|gate', function(){
		// executed for development env and not connector，not gate server type
	});
	```
* Implement [App helper class](https://github.com/sex-pomelo/sex-pomelo/wiki/App-helper-Class). You can simplify the writing of app.js in a configuration way.
  - Configuration control load `plugin`,`configs`,`components`,`filters`,`route`.
  - Reduce unnecessary JS requires.
  - More developer-friendly.
  - Routing dynamic loading, [ **only load new serverType and route function** ].
``` js
const pomelo = require('@sex-pomelo/sex-pomelo');
const { BaseApp } = require('@sex-pomelo/sex-pomelo/base');


class MyApp extends BaseApp{
	constructor(){
		super( pomelo );
	}

	preLoadCfg(){
	}

	preStart(){
		const { app } = this;

		// app configure
		app.configure('production|development', function() {
			app.enable('systemMonitor');
		});
	}

	postStart() {

	}

};

new MyApp();
```
--- 
**Other Change**
 * fix test script error.
	- remove grunt dep, Direct use mocha command run test.
	- change `npm run test`, use `test.sh`, run all test script.
 * remove third library `async` dependence, use ES6 async replace
 * fix Distributed startup failure [#778](https://github.com/NetEase/pomelo/issues/778). `TypeError: Cannot read property 'get' of undefined`

2.2.25 / 2020-09-28
=================
 * log4js config file, first read it by env folder;
 * Add script to package.json( can run ```npm start``` )
	- npm start
	- npm stop
	- npm run dev


2.2.24 / 2020-09-24
=================
 * Application add function **getCfgPath** using,get config file by run env.
   ``` js
    let robPath = app.getCfgPath('robot.json');
    console.log( robPath);
     
    // output:
    // <app root>/config/robot.json             -- for production env
    // <app root>/config/development/robot.json -- for development env
   ```
 * Remove mkdirp dep.  use fs.mkdir replace
 * modify the Pomelo read configuration file, first read it by folder
 * Start Env non (development and production) , console process without exiting

2.2.18 / 2020-02-20
=================
 * Fix sshrun bug;

2.2.17 / 2020-02-15
=================
 * Fix connector.js loadInit err. 

2.2.16 / 2020-02-16
=================
 * use sex-pomelo-admin 1.0.5, now windows can enable systemInfo module

2.2.15 / 2020-01-29
=================
 * Increased development experience, more IntelliSense;
 * Can use es6 class write handler,remote,filter,component...
``` javascript
const GameHandler = require('@sex-pomelo/sex-pomelo/base').GameHandler;

class EntryHandler extends GameHandler{

	/** If you have some init ,you should do it here,
	   rember call super(app) first.
	*/
	// constructor(app){
	// 	super(app);
	// }

	/**
	 * New client entry.
	 *
	 * @param  {Object}   msg     request message
	 * @param  {Object}   session current session object
	 * @param  {Function} next    next step callback
	 * @return {Void}
	 */
	entry(msg, session, next) {
    let serID = this.app.serverId;
		next(null, {code: 200, msg: `game server is ok. [${serID}]`});
	};

	/**
	 * Publish route for mqtt connector.
	 *
	 * @param  {Object}   msg     request message
	 * @param  {Object}   session current session object
	 * @param  {Function} next    next step callback
	 * @return {Void}
	 */
	publish(msg, session, next) {
		var result = {
			topic: 'publish',
			payload: JSON.stringify({code: 200, msg: 'publish message is ok.'})
		};
		next(null, result);
	}

	/**
	 * Subscribe route for mqtt connector.
	 *
	 * @param  {Object}   msg     request message
	 * @param  {Object}   session current session object
	 * @param  {Function} next    next step callback
	 * @return {Void}
	 */
	subscribe(msg, session, next) {
		var result = {
			topic: 'subscribe',
			payload: JSON.stringify({code: 200, msg: 'subscribe message is ok.'})
		};
		next(null, result);
	};
}

module.exports = function(app) {
  return new EntryHandler(app);
};
```


2.2.14 / 2020-01-25
=================
 * [#1150](https://github.com/NetEase/pomelo/pull/1150)

2.2.13 / 2019-12-23
=================
 * support node12



2.2.12 / 2019-08-22
=================
  * upgrade ws, sex-pomelo-admin
  * add IntelliSense ( pomelo.SexPomeloApplication )
```
const pomelo = require('@sex-pomelo/sex-pomelo');  ///// <----- add

module.exports = function(app) {
    return new Handler(app);
};

/**
 * 
 * @param {pomelo.SexPomeloApplication} app       ///// <----- add
 */
let Handler = function(app) {
  ....
}

```

2.2.11 / 2019-08-16
=================
  * upgrade log4js to 5.0.0 ( sex-pomelo-logger dep it)


2.2.10 / 2019-07-16
=================
  * Fix template error 


2.2.9 / 2018-12-09
=================
  * Suggest use **nodejs > 8.x**,maybe can use 4.x,6.x;
  * use sex-pomelo-logger(0.1.9) replace pomelo-logger
  * ***notice:*** The log4js.json format has change( see [log4js Configuration Change](https://log4js-node.github.io/log4js-node/migration-guide.html) ) . Because log4js issue, the appenders more than 12, there will be a warning.


2.2.7 / 2018-12-09
=================
  * Suggest use **nodejs > 8.x**,maybe can use 4.x,6.x;
  * use sex-pomelo-protocol(0.1.7) replace pomelo-protocol( message,package encode/decode 性能提升至少1倍)

2.2.6 / 2018-11-15
=================
  * mqtt update to 2.18.8
  * 使用 sex-pomelo-admin 替换 pomelo-admin ( mqtt-connection update to 4.0.0)
  * 使用 sex-pomelo-rpc 替换 pomelo-rpc ( mqtt-connection update to 4.0.0)