Skip to content

Ensure launchDevTools always returns success or a valid error #621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 1, 2019
Merged

Ensure launchDevTools always returns success or a valid error #621

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
439ed85
Ensure launchDevTools always returns success or a valid error
DanTup May 1, 2019
49a8c74
Include stack in the error
DanTup May 1, 2019
fa75399
Add a note about the format of the response
DanTup May 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 50 additions & 33 deletions packages/devtools_server/lib/src/server.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ const argMachine = 'machine';
const argPort = 'port';
const launchDevToolsService = 'launchDevTools';

const errorLaunchingBrowserCode = 500;

final argParser = new ArgParser()
..addFlag(
argHelp,
Expand Down Expand Up @@ -200,41 +202,56 @@ Future<void> registerLaunchDevToolsService(
final VmService service = await _connectToVmService(vmServiceUri);

service.registerServiceCallback(launchDevToolsService, (params) async {
final uriParams = <String, dynamic>{};

// Copy over queryParams passed by the client
if (params != null) {
params['queryParams']?.forEach((key, value) => uriParams[key] = value);
}
try {
final uriParams = <String, dynamic>{};

// Copy over queryParams passed by the client
if (params != null) {
params['queryParams']
?.forEach((key, value) => uriParams[key] = value);
}

// Add the URI to the VM service
uriParams['uri'] = vmServiceUri.toString();

final devToolsUri = Uri.parse(devToolsUrl);
final uriToLaunch = devToolsUri.replace(
// If path is empty, we generate 'http://foo:8000?uri=' (missing `/`) and
// ChromeOS fails to detect that it's a port that's tunneled, and will
// quietly replace the IP with "penguin.linux.test". This is not valid
// for us since the server isn't bound to the containers IP (it's bound
// to the containers loopback IP).
path: devToolsUri.path.isEmpty ? '/' : devToolsUri.path,
queryParameters: uriParams,
);

// Add the URI to the VM service
uriParams['uri'] = vmServiceUri.toString();

final devToolsUri = Uri.parse(devToolsUrl);
final uriToLaunch = devToolsUri.replace(
// If path is empty, we generate 'http://foo:8000?uri=' (missing `/`) and
// ChromeOS fails to detect that it's a port that's tunneled, and will
// quietly replace the IP with "penguin.linux.test". This is not valid
// for us since the server isn't bound to the containers IP (it's bound
// to the containers loopback IP).
path: devToolsUri.path.isEmpty ? '/' : devToolsUri.path,
queryParameters: uriParams,
);

// TODO(dantup): When ChromeOS has support for tunneling all ports we
// can change this to always use the native browser for ChromeOS
// and may wish to handle this inside `browser_launcher`.
// https://crbug.com/848063
final useNativeBrowser = _isChromeOS &&
_isAccessibleToChromeOSNativeBrowser(Uri.parse(devToolsUrl)) &&
_isAccessibleToChromeOSNativeBrowser(vmServiceUri);
if (useNativeBrowser) {
await Process.start('x-www-browser', [uriToLaunch.toString()]);
} else {
await Chrome.start([uriToLaunch.toString()]);
// TODO(dantup): When ChromeOS has support for tunneling all ports we
// can change this to always use the native browser for ChromeOS
// and may wish to handle this inside `browser_launcher`.
// https://crbug.com/848063
final useNativeBrowser = _isChromeOS &&
_isAccessibleToChromeOSNativeBrowser(Uri.parse(devToolsUrl)) &&
_isAccessibleToChromeOSNativeBrowser(vmServiceUri);
if (useNativeBrowser) {
await Process.start('x-www-browser', [uriToLaunch.toString()]);
} else {
await Chrome.start([uriToLaunch.toString()]);
}

return {'result': Success().toJson()};
} catch (e, s) {
// Note: It's critical that we return responses in exactly the right format
// or the VM will unregister the service. The objects must match JSON-RPC
// however a successful response must also have a "type" field in its result.
// Otherwise, we can return an error object (instead of result) that includes
// code + message.
return {
Copy link
Contributor

@jacob314 jacob314 May 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a comment explaining why this exact format is used.

Copy link
Contributor Author

@DanTup DanTup May 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

'error': {
'code': errorLaunchingBrowserCode,
'message': 'Failed to launch browser: $e\n$s',
},
};
}

return {'result': Success().toJson()};
});

await service.registerService(launchDevToolsService, 'DevTools Server');
Expand Down