Deprecate DTDConnectionInfo and replace with a class that can handle separate private/exposed URIs #8291
Conversation
…separate private/exposed URIs This replaces `DTDConnectionInfo` with `DTDInfo` (unsure if a better name?) and marks the former as deprecated. The new class has two URIs: - `localUri` which is the URI used for backend services on the same machine as the DTD process (this is usually a `localhost` URI) - `exposedUri` which is the URI that can be used from the frontend where the user is (this may or may not be the same as localUri depending on whether they're in a remote/web IDE session) The DevTools web API returns the exposed URI (since it will be used by frontend tools) and other places that used the URI for connecting directly use the local one. On its own, this change doesn't do anything, the intention is to roll this into the SDK and update the DevTools server code in dartdev/DDS to accept an additional optional URI which will then provide these back to the server code here (for the web API handler and extension search code). This is work towards fixing some of the issues in Dart-Code/Dart-Code#5158.
|
@kenzieschmoll is this something that would be included in the release notes? (it doesn't really affect the DevTools app - at least not without other fixes - only devtools_shared users). While I left the old typedef and made it deprecated, these changes are still breaking for any code that calls any of these methods (such as the handlers) that have had their signatures changed (this means that rolling the new devtools_shared into the SDK will also require some code changes, which I will start preparing a CL for). |
|
Obviously it can't be landed yet, but I prepared the change for the SDK that will be needed to roll this change into the SDK: https://dart-review.googlesource.com/c/sdk/+/383400 It does not add support for passing a second URI yet, it's just the minimum changes to the APIs that would keep things working as-is with this change (I don't want to complicate rolling a new devtools_shared into the SDK further). I'll add the additional flag for passing another URI in another change after this is done. |
|
Please merge with master to resolve the CI failures. |
|
Great, thanks! |
|
auto label is removed for flutter/devtools/8291, due to - The status or check suite devtools_shared test has failed. Please fix the issues identified (or deflake) before re-applying this label. |
auto-submit
bot
removed
the
autosubmit
|
These failures look legit - we switched to using |
|
When a new devtools_shared is released, we'll need to apply the changes in https://dart-review.googlesource.com/c/sdk/+/383400 while rolling it in to the SDK. |
|
devtools_shared 10.1.0 has been published, and you can use the |
|
Great, thanks! |
|
I commented on the commit, but note that it appears the latest version of Or, consider retracting the latest version of devtools_shared and re-publishing as breaking, if still inside that window |
|
10.1.0 was retracted. Republishing as 11.0.0: #8313 |
Awesome thanks! |
This replaces
DTDConnectionInfowithDTDInfo(unsure if a better name?) and marks the former as deprecated.The new class has two URIs:
localUriwhich is the URI used for backend services on the same machine as the DTD process (this is usually alocalhostURI)exposedUriwhich is the URI that can be used from the frontend where the user is (this may or may not be the same as localUri depending on whether they're in a remote/web IDE session)The DevTools web API returns the exposed URI (since it will be used by frontend tools) and other places that used the URI for connecting directly use the local one.
On its own, this change doesn't do anything, the intention is to roll this into the SDK and update the DevTools server code in dartdev/DDS to accept an additional optional URI which will then provide these back to the server code here (for the web API handler and extension search code).
This is work towards fixing some of the issues in Dart-Code/Dart-Code#5158.