Rename JsonRpcProxyFactory and related types #12588
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tortmayr
force-pushed
the
tortmayr/12368-deprecation
branch
2 times, most recently
from
57f9b9a
to
440a59d
Compare
tortmayr
changed the title
|
@tortmayr would you mind resolving the conflict on this one? |
tortmayr
force-pushed
the
tortmayr/12368-deprecation
branch
from
440a59d
to
5e7343f
Compare
tsmaeder
reviewed
Jun 12, 2023
CHANGELOG.md
Outdated
| @@ -11,7 +11,10 @@ | |||
| - [repo] with the upgrade to Inversify 6.0, a few initialization methods were adjusted. See also [this migration guide entry](https://github.com/eclipse-theia/theia/blob/master/doc/Migration.md#inversify-60). Additionally, other changes include: [#12425](https://github.com/eclipse-theia/theia/pull/12425) | |||
| - The type expected by the `PreferenceProxySchema` symbol has been changed from `PromiseLike<PreferenceSchema>` to `() => PromiseLike<PreferenceSchema>` | |||
| - The symbol `OnigasmPromise` has been changed to `OnigasmProvider` and injects a function of type `() => Promise<IOnigLib>` | |||
| - The symbol `PreferenceTransactionPrelude` has been changed to `PreferenceTransactionPreludeProvider ` and injects a function of type `() => Promise<unknown>` | |||
| - The symbol `PreferenceTransactionPrelude` has been changed to `PreferenceTransactionPreludeProvider` and injects a function of type `() => Promise<unknown>` | |||
| - [rpc] Replaced name suffixes classes and types that were still referencing the old rpc protocol. From `JsonRpc*` to `Rpc*`. | |||
There was a problem hiding this comment.
...name suffixes classes and types...
CHANGELOG.md
Outdated
| - The symbol `PreferenceTransactionPrelude` has been changed to `PreferenceTransactionPreludeProvider ` and injects a function of type `() => Promise<unknown>` | ||
| - The symbol `PreferenceTransactionPrelude` has been changed to `PreferenceTransactionPreludeProvider` and injects a function of type `() => Promise<unknown>` | ||
| - [rpc] Replaced name suffixes classes and types that were still referencing the old rpc protocol. From `JsonRpc*` to `Rpc*`. | ||
| - Old classes and types are still available but haven been deprecated and might get removed in future releases [#12588](https://github.com/eclipse-theia/theia/pull/12588) |
- Rename `JsonRpcProxyFactory` and related types to `RpcProxyFactory` (Rpc*). The naming scheme was a remainder of the old vscode jsonr-rpc based protocol. By simply using the `Rpc` suffix the class names are less misleading and protocol agnostic. - Keep deprecated declarations of the old `JsonRpc*` namespace. The components are heavily used by adopters so we should maintain this deprecated symbols for a while to enable graceful migration without hard API breaks. Naturally this is open for discussion, but judging from the files I had to touch in the core framework alone I think it's definitely a good idea to give adopters a grace period. Complementary website PR: eclipse-theia/theia-website#422 Fixes #12581 Contributed on behalf of STMicroelectronics
tortmayr
force-pushed
the
tortmayr/12368-deprecation
branch
from
5e7343f
to
da390fc
Compare
|
Thanks for the review. I have rebased and adapted the changelog. |
This was referenced Feb 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it does
JsonRpcProxyFactoryand related types toRpcProxyFactory(Rpc*). The naming scheme was a remainder of the old vscode jsonr-rpc based protocol.By simply using the
Rpcsuffix the class names are less misleading and protocol agnostic.JsonRpc*namespace. The components are heavily used by adopters so we should maintain this deprecated symbols for a while to enable graceful migration without hard API breaks.Naturally this is open for discussion, but judging from the files I had to touch in the core framework alone I think it's definitely
a good idea to give adopters a grace period.
Complementary website PR: eclipse-theia/theia-website#422
Fixes #12581
Contributed on behalf of STMicroelectronics
How to test
Nothing particular to test. Everything should work as expected
Review checklist
Reminder for reviewers