Add start stop button on ServiceDetails page #948

dalibormesaric · 2021-02-19T19:42:57Z

This PR adds Start/Stop button on ServiceDetails page to enable starting and stopping service on demand.

This is motivated by the following scenario:
I have several dotnet applications running locally, and I might want to debug one of them using visual studio (code). To do this now, I would need to stop tye, comment out the service I want to debug, run tye again, then run my application with debugger.

Alternative is to add the button on the Index page in every row.

Related to #876

Thanks to @dillenmeister for the initial idea.

dnfadmin · 2021-02-19T19:43:14Z

All CLA requirements met.

jkotalik · 2021-02-25T20:34:11Z

@glennc does this conflict with your changes?

glennc · 2021-03-08T19:43:35Z

For your specific scenario, you can have VS Code attach to the process Tye is already running. The only time that wouldn't work is if you are debugging something that runs in startup before steadystate hits. Is there some reason that doesn't work for you? Not that this is a bad idea or PR, I am still happy to have it added.

I was thinking of putting it on the main page for every row as you listed in your alternative (that's what my quick hackup of this does). I kind of like the idea of being able to do both, i.e. the button you have in your gif can stop the specific replica you have selected in the replica dropdown while the index page button would stop all replicas. Anyone have thoughts on that?

I haven't looked at the code for this yet, but I assume this PR would do anything my own would and I'm happy to work through it until it supersedes it.

dalibormesaric · 2021-03-09T16:16:54Z

Thanks for your feedback @glennc ! I would add to my scenario the case where you want to also modify the code, so you can run it outside tye, and test with all the other services still running with tye.

At the moment start/stop button does not respect replica dropdown, mostly since I haven't really used replica functionality.

I can definitely move the button to the index page (and keep it on the details page?) Use icons or just start/stop? Any preference on colors etc? I would really like to get this in, so just let me know what the next step would be.

dalibormesaric · 2021-03-16T19:25:23Z

Reopen after messing with master/main and merging in latest changes

dalibormesaric · 2021-03-25T19:07:26Z

How would you like to proceed with this @glennc @jkotalik ?

src/Microsoft.Tye.Hosting/TyeDashboardApi.cs

davidfowl · 2021-04-22T06:34:31Z

I don't want to feature creep here but now I'm thinking we should have both graceful and non-graceful shutdown

zaksnet · 2022-05-17T12:56:21Z

Hey guys!
How about a Rebuild - Restart Button? There are cases where watching for changes might not be desired and you want to manually rebuild and restart a service. Also, is this going to be reviewed added any time soon?

davidfowl · 2022-12-11T23:04:56Z

src/Microsoft.Tye.Hosting/TyeHost.cs

+                    services.AddScoped(sp =>
+                    {
+                        var server = sp.GetRequiredService<AspNetCore.Hosting.Server.IServer>();
+                        var addressFeature = server.Features.Get<AspNetCore.Hosting.Server.Features.IServerAddressesFeature>();
+                        string baseAddress = addressFeature.Addresses.First();
+                        return new System.Net.Http.HttpClient { BaseAddress = new Uri(baseAddress) };
+                    });


Feels slightly overkill to make requests to the API. We can just call the function, right?

I think I'll need some help here... how do I access ProcessRunner from razor page?

davidfowl · 2022-12-11T23:05:43Z

src/Microsoft.Tye.Hosting/TyeHost.cs

-            var api = new TyeDashboardApi();
-
-            app.UseEndpoints(endpoints =>
+            if (_logger != null && _replicaRegistry != null)


How would these be null?

Compiler shows null warnings

I am not sure if it makes a lot of difference to delay creation of _logger and _replicaRegistry to when StartAsync() is called. I would consider making them non-nullable and create/have them injected in the constructor, which would enable using them here without a null check.

mcrio · 2023-03-17T08:33:39Z

Thanks for all the work. Would be nice to have this feature merged. : )

karolz-ms

Thank you for your submission! I made a few suggestions, please take a look--thx!

karolz-ms · 2023-03-17T18:21:06Z

src/Microsoft.Tye.Hosting/TyeHost.cs

-            var api = new TyeDashboardApi();
-
-            app.UseEndpoints(endpoints =>
+            if (_logger != null && _replicaRegistry != null)


I am not sure if it makes a lot of difference to delay creation of _logger and _replicaRegistry to when StartAsync() is called. I would consider making them non-nullable and create/have them injected in the constructor, which would enable using them here without a null check.

karolz-ms · 2023-03-17T20:27:56Z

src/Microsoft.Tye.Hosting/TyeHost.cs

@@ -204,6 +204,13 @@ private IHost BuildWebApplication(Application application, HostOptions options,
                                    });
                            });
                    services.AddSingleton(application);
+                    services.AddScoped(sp =>


Not sure if this is necessary. You should be able to access HttpContext.Request from Razor pages/views: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/http-context?view=aspnetcore-7.0#access-httpcontext-from-razor-pages and build the URL to the start/stop API request from that.

karolz-ms · 2023-03-17T20:36:47Z

src/Microsoft.Tye.Hosting/Dashboard/Pages/ServiceDetails.razor

@@ -1,5 +1,6 @@
 @page "/services/{ServiceName}"
 @inject Application application
+@inject HttpClient Http


See my other comment regarding HttpClient injection. Can you try to see if you can get away with creating a HttpClient instance directly?

karolz-ms · 2023-03-17T20:45:02Z

src/Microsoft.Tye.Hosting/ProcessRunner.cs

@@ -178,7 +178,7 @@ private async Task BuildAndRunProjects(Application application)
            }
        }

-        private void LaunchService(Application application, Service service)
+        public void LaunchService(Application application, Service service)


Suggested change

public void LaunchService(Application application, Service service)

internal void LaunchService(Application application, Service service)

karolz-ms · 2023-03-17T20:45:17Z

src/Microsoft.Tye.Hosting/ProcessRunner.cs

@@ -460,7 +460,7 @@ async Task RunApplicationAsync(IEnumerable<(int ExternalPort, int Port, string?
            service.Items[typeof(ProcessInfo)] = processInfo;
        }

-        private Task KillRunningProcesses(IDictionary<string, Service> services)
+        public Task KillRunningProcesses(IDictionary<string, Service> services)


Suggested change

public Task KillRunningProcesses(IDictionary<string, Service> services)

internal Task KillRunningProcesses(IDictionary<string, Service> services)

karolz-ms · 2023-03-17T20:49:57Z

src/Microsoft.Tye.Hosting/TyeDashboardApi.cs

+            var app = context.RequestServices.GetRequiredService<Application>();
+
+            var name = (string?)context.Request.RouteValues["name"];
+            if (!string.IsNullOrEmpty(name) && app.Services.TryGetValue(name, out var service))


Again, if no service with given name is found, 404 and no redirect, please.

karolz-ms · 2023-03-17T20:50:40Z

src/Microsoft.Tye.Hosting/TyeDashboardApi.cs

+
+            context.Response.Redirect($"/services/{name}");
+
+            return;


Redundant return, please remove.

karolz-ms · 2023-03-17T20:55:45Z

Thanks for all the work. Would be nice to have this feature merged. : )

Yes, sorry, we (MS) are not developing Tye actively at this moment. I made a few suggestions, hope this helps.

Add start stop button on ServiceDetails page

4e1981b

dalibormesaric requested review from davidfowl, jkotalik, JunTaoLuo and rynowak as code owners February 19, 2021 19:42

Fix whitespace warnings

e473f59

gterdem mentioned this pull request Feb 24, 2021

Is there are way to set service dependencies #947

Open

Base automatically changed from master to main March 11, 2021 20:50

dalibormesaric closed this Mar 16, 2021

dalibormesaric deleted the master branch March 16, 2021 18:53

dalibormesaric added 2 commits March 16, 2021 20:10

Merge remote-tracking branch 'upstream/main' into main

5ff8ca7

Fix after merge

91ee730

dalibormesaric reopened this Mar 16, 2021

davidfowl reviewed Apr 7, 2021

View reviewed changes

src/Microsoft.Tye.Hosting/TyeDashboardApi.cs Outdated Show resolved Hide resolved

Make start and stop service endpoints POST

972e571

dalibormesaric requested a review from davidfowl May 13, 2021 07:47

davidfowl reviewed Dec 11, 2022

View reviewed changes

csteeg mentioned this pull request Dec 23, 2022

Add start/stop option to dashboard and command line option to disable auto-start #1495

Open

Merge branch 'dotnet:main' into master

2b13b59

dalibormesaric requested a review from philliphoff as a code owner January 2, 2023 10:26

Fix compiler warning

8cbfb05

karolz-ms suggested changes Mar 17, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add start stop button on ServiceDetails page #948

Add start stop button on ServiceDetails page #948

dalibormesaric commented Feb 19, 2021 •

edited

Loading

dnfadmin commented Feb 19, 2021 •

edited

Loading

jkotalik commented Feb 25, 2021

glennc commented Mar 8, 2021

dalibormesaric commented Mar 9, 2021

dalibormesaric commented Mar 16, 2021

dalibormesaric commented Mar 25, 2021

davidfowl commented Apr 22, 2021

zaksnet commented May 17, 2022 •

edited

Loading

davidfowl Dec 11, 2022

dalibormesaric Jan 2, 2023

davidfowl Dec 11, 2022

dalibormesaric Jan 2, 2023

karolz-ms Mar 17, 2023

mcrio commented Mar 17, 2023

karolz-ms left a comment

karolz-ms Mar 17, 2023

karolz-ms Mar 17, 2023

karolz-ms Mar 17, 2023

karolz-ms Mar 17, 2023

karolz-ms Mar 17, 2023

karolz-ms Mar 17, 2023

karolz-ms Mar 17, 2023

karolz-ms commented Mar 17, 2023

	public void LaunchService(Application application, Service service)
	internal void LaunchService(Application application, Service service)

	public Task KillRunningProcesses(IDictionary<string, Service> services)
	internal Task KillRunningProcesses(IDictionary<string, Service> services)

Add start stop button on ServiceDetails page #948

Are you sure you want to change the base?

Add start stop button on ServiceDetails page #948

Conversation

dalibormesaric commented Feb 19, 2021 • edited Loading

dnfadmin commented Feb 19, 2021 • edited Loading

jkotalik commented Feb 25, 2021

glennc commented Mar 8, 2021

dalibormesaric commented Mar 9, 2021

dalibormesaric commented Mar 16, 2021

dalibormesaric commented Mar 25, 2021

davidfowl commented Apr 22, 2021

zaksnet commented May 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcrio commented Mar 17, 2023

karolz-ms left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

karolz-ms commented Mar 17, 2023

dalibormesaric commented Feb 19, 2021 •

edited

Loading

dnfadmin commented Feb 19, 2021 •

edited

Loading

zaksnet commented May 17, 2022 •

edited

Loading