From 8ab9e3570c351376e76d33837bbde2a02a10e47b Mon Sep 17 00:00:00 2001 From: vince-fugnitto Date: Fri, 12 May 2023 15:28:27 -0400 Subject: [PATCH] docs: add `msgpackr` resolution note The commit adds a `yarn resolution` note in our migration documentation for `msgpackr` as recent versions cause `maximum callstack exceeded` errors. Signed-off-by: vince-fugnitto --- doc/Migration.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/Migration.md b/doc/Migration.md index a89cc0a9f2db7..0f832c6a28066 100644 --- a/doc/Migration.md +++ b/doc/Migration.md @@ -9,6 +9,30 @@ Please see the latest version (`master`) for the most up-to-date information. Pl ### General +_msgpackr_: + +If you're experiencing [`maximum callstack exceeded`](https://github.com/eclipse-theia/theia/issues/12499) errors you may need to downgrade the version of `msgpackr` pulled using a [yarn resolution](https://classic.yarnpkg.com/lang/en/docs/selective-version-resolutions/). + +``` +rpc-message-encoder.ts:151 Uncaught (in promise) Error: Error during encoding: 'Maximum call stack size exceeded' + at MsgPackMessageEncoder.encode (rpc-message-encoder.ts:151:23) + at MsgPackMessageEncoder.request (rpc-message-encoder.ts:137:14) + at RpcProtocol.sendRequest (rpc-protocol.ts:161:22) + at proxy-handler.ts:74:45 +``` + +For the best results follow the version used and tested by the framework. + +For example: + +```json +"resolutions": { + "**/msgpackr": "1.8.3" +} +``` + +_socket.io-parser_: + Prior to [`v1.31.1`](https://github.com/eclipse-theia/theia/releases/tag/v1.31.1), a [resolution](https://classic.yarnpkg.com/lang/en/docs/selective-version-resolutions/) might be necessary to work-around a recently discovered [critical vulnerability](https://security.snyk.io/vuln/SNYK-JS-SOCKETIOPARSER-3091012) in one of our runtime dependencies [socket.io-parser](https://github.com/socketio/socket.io-parser). For example: