Build queue for --watch

[james-allan-lloyd]

Use a queue for build requests in --watch mode so that duplicate builds can be removed, and optionally use a solution to build multiple projects to avoid dependencies being built simultaneously and causing file locking races.

Example config (albeit the simplest approach):

name: tye-build-fix
solution: tye-build-fix.sln
services:
- name: frontend
  project: frontend/frontend.csproj
- name: backend
  project: backend/backend.csproj
# both projects depend on SharedLibrary/SharedLibrary.csproj

note-1: I'm new to C# but experienced in other languages. It's very possible that I am not doing things in a canonical C# way.
note-2: to work around a bug in msbuild when using the -target commandline arg, I had to upgrade msbuild past version 16.10 (I'm using 16.11.0.36601 specifically).

Resolves #580
Resolves #1187

[dnfadmin]

All CLA requirements met.

[dbreshears]

This resolves #1187

[davidfowl]

Why is there a delay here?

[james-allan-lloyd]

I had the idea of having a quiet time where we wait to see if more files will be saved, then schedule the builds at once... it would be better to have it waiting 100ms (or a more sensible duration) after the last WaitToReadAsync(). Unsure what would happen if it was removed; might still need to yield to let duplicate project build requests enter the queue?

[philliphoff]

@james-allan-lloyd Sorry for it taking so long to be able to get to this. I hope you don't take offense to the changes I've made; feel free to suggest others. I'd appreciate if you could take the latest code for a spin and see if it continues to work in the way you expect.

[philliphoff]

@ravipal This is another one to review, when you have a chance. (Comment added since the PR's been open a while and the original notification would've been long ago.)

[james-allan-lloyd]

@james-allan-lloyd Sorry for it taking so long to be able to get to this. I hope you don't take offense to the changes I've made; feel free to suggest others. I'd appreciate if you could take the latest code for a spin and see if it continues to work in the way you expect.

No worries, I'll get back to you soon on it.

[philliphoff]

Moving forward with this PR in order to make progress toward 0.11; we'll deal with any fallout, if any, as separate PRs.

[james-allan-lloyd]

Hi guys, I only just now got to checking out the changes and they work for me (4 or so projects depending on a 2 shared libraries).

One small caveat; when using the solution build, it doesn't like nested targets (I'm using dotnet msbuild version 17.0.0+c9eb9dd64). This appears to be the default now when doing dotnet sln add... I worked around it by commenting out the GlobalSection(NestedProjects) section in the solution file, but maybe there's a way to get the nested name from the file?

To be clear, my day to day work project looks a bit like this:

• api-services
  • serviceA
    • serviceA.csproj
  • serviceB
    • serviceB.csproj
• tye.yaml
• MySolution.sln

I need to invoke msbuild like this to build a targeted project:

dotnet msbuild -target:api-services\serviceA

[a-shoemaker]

Note for #1438, this code is not replacing "special characters" with an _ in the targets.

https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-build-specific-targets-in-solutions-by-using-msbuild-exe?view=vs-2022
(I believe that documentation has a bit of a bug in itself, that last "in the specified target name" should be "in the specified project name" to not be confused with the target name portion of -targets argument.)