Skip to content
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

dotnet watch run shouldn't disable the browser refresh logic injection on Linux #28519

Closed
wants to merge 2 commits into from
Closed

dotnet watch run shouldn't disable the browser refresh logic injection on Linux #28519

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1ae728
`dotnet watch run` shouldn't disable the browser refresh logic inject…
eugeneogongo Oct 31, 2020
d748804
Apply suggestions from code review
pranavkm Jan 14, 2021
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
41 changes: 20 additions & 21 deletions src/Tools/dotnet-watch/src/LaunchBrowserFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ public sealed class LaunchBrowserFilter : IWatchFilter, IAsyncDisposable
private readonly bool _suppressBrowserRefresh;
private readonly string _browserPath;

private bool _canLaunchBrowser;
private bool _attemptedBrowserLaunch;
private Process _browserProcess;
private bool _browserLaunched;
private BrowserRefreshServer _refreshServer;
private IReporter _reporter;
private string _launchPath;
Expand Down Expand Up @@ -59,7 +58,6 @@ public async ValueTask ProcessAsync(DotNetWatchContext context, CancellationToke
if (CanLaunchBrowser(context, out var launchPath))
{
context.Reporter.Verbose("dotnet-watch is configured to launch a browser on ASP.NET Core application startup.");
_canLaunchBrowser = true;
_launchPath = launchPath;
_cancellationToken = cancellationToken;

Expand All @@ -81,14 +79,10 @@ public async ValueTask ProcessAsync(DotNetWatchContext context, CancellationToke
}
}
}

if (_canLaunchBrowser)
else if (!_suppressBrowserRefresh)
{
if (context.Iteration > 0)
{
// We've detected a change. Notify the browser.
await SendMessage(WaitMessage, cancellationToken);
}
// We've detected a change. Notify the browser.
await SendMessage(WaitMessage, cancellationToken);
}
}

Expand Down Expand Up @@ -117,18 +111,30 @@ private void OnOutput(object sender, DataReceivedEventArgs eventArgs)
var process = (Process)sender;
process.OutputDataReceived -= OnOutput;

if (!_browserLaunched)
if (!_attemptedBrowserLaunch)
{
_attemptedBrowserLaunch = true;

_reporter.Verbose("Launching browser.");

try
{
LaunchBrowser(launchUrl);
_browserLaunched = true;
}
catch (Exception ex)
{
_reporter.Output($"Unable to launch browser: {ex}");
_canLaunchBrowser = false;
_reporter.Verbose($"An exception occurred when attempting to launch a browser: {ex}");
_browserProcess = null;
}

if (_browserProcess is null || _browserProcess.HasExited)
{
// dotnet-watch, by default, relies on URL file association to launch browsers. On Windows and MacOS, this works fairly well
// where URLs are associated with the default browser. On Linux, this is a bit murky.
// From emperical observation, it's noted that failing to launch a browser results in either Process.Start returning a null-value
// or for the process to have immediately exited.
// We can use this to provide a helpful message.
_reporter.Output($"Unable to launch the browser. Navigate to {launchUrl}");
Copy link
Member

Choose a reason for hiding this comment

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

If there was an exception, won't they get "Unable to launch browser" twice, does that matter.

Copy link
Contributor

Choose a reason for hiding this comment

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

One is with verbose logging enabled, which isn't common and normally filtered out. @pranavkm maybe change the first log though to remove the duplication?

Copy link
Member

Choose a reason for hiding this comment

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

@pranavkm does this still need to be addressed?

}
}
else
Expand Down Expand Up @@ -175,13 +181,6 @@ private static bool CanLaunchBrowser(DotNetWatchContext context, out string laun
return false;
}

if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows) && !RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
{
// Launching a browser requires file associations that are not available in all operating systems.
reporter.Verbose("Browser refresh is only supported in Windows and MacOS.");
return false;
}

var dotnetCommand = context.ProcessSpec.Arguments.FirstOrDefault();
if (!string.Equals(dotnetCommand, "run", StringComparison.Ordinal))
{
Expand Down