[Generator] Allow to have a way to attach to the generator. #19565

mandel-macaque · 2023-12-04T00:10:36Z

As soon as we moved to have a build of the generator that used dotnet we opened the door to a number of developer life improvements. The very first one of those is the poissibility to attach the dotnet debugger to the bgen process and that way be able to debug.

In order to do that, this PR has changed two small things:

Added code in the main method of the generator that will block the tool until a debugger is attached.
Changed the csproj to add the previously mentioned code only when the enviroment variable XAMMACIOS_DEBUGGER is set. This way the code does not reach our customers.

A README has been added explaining how to debug the processes via Visual Studio. Any other IDE that support the dotnet debugger can be used this way.

src/bgen/bgen.csproj

src/bgen/BindingTouch.cs

rolfbjarne · 2023-12-04T07:20:15Z

src/bgen/README.md

+## Debugging
+
+
+One of the main problems when adding changes to the generator was that before the generator was moved to dotnet, we could not attach the dotnet debugger to it. 


You could however start debugging in VSMac just fine though. That should still work if you have the correct version of .NET installed I believe.

Yes, you can, but it is a lot more work. You have to install the right version, generate the rsp files, and then call from vsmac.

I initially started by doing it like that and it got very annoying.

You can either install the right .NET version (make print-dotnet-pkg-urls -C builds will give you the url) or delete global.json (I tend to go for the latter, works well enough for small fixes).

That's already done for legacy targets:

Should be easy enough to add the .NET ones in the csproj (and that would be committed, so no need to do it again).

stephen-hawley · 2023-12-04T15:34:58Z

src/bgen/BindingTouch.cs

+			// block the generator until a debugger has attached to it
+			// our customers won't find any use for this.
+			var process = Process.GetCurrentProcess ();
+			Console.WriteLine ($"Waiting for debugger to attach: ({ process.Id}) {process.ProcessName}");


nit: ({ process.Id}) -> ({process.Id})

hmm funny that the autformat did not pick that up :/

Because it's behind an #if ... that evaluates to false.

stephen-hawley · 2023-12-04T15:39:38Z

src/bgen/README.md

+the Attach to Process option. In the dialog that will appear, you will need to select the dotnet process that is running the generator. In this case, the process
+is the one with the PID 55644. Once you have selected the process, you can click on the Attach button.
+
+Because the generator is called several times, one per platform, you can attach to the different processes in case the issue you are trying to debug


Should the "Waiting for debugger to attach" message include the args so that it would be easier to differentiate instances?

Good idea, that way it is easier to debug. A simple string.join of the arg should be better than nothing.

As soon as we moved to have a build of the generator that used dotnet we opened the door to a number of developer life improvements. The very first one of those is the poissibility to attach the dotnet debugger to the bgen process and that way be able to debug. In order to do that, this PR has changed two small things: 1. Added code in the main method of the generator that will block the tool until a debugger is attached. 2. Changed the csproj to add the previously mentioned code only when the enviroment variable XAMMACIOS_DEBUGGER is set. This way the code does not reach our customers. A README has been added explaining how to debug the processes via Visual Studio.

Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>

This broke the support. This reverts commit a25def8.

vs-mobiletools-engineering-service2 · 2023-12-06T17:38:54Z

💻 [CI Build] Windows Integration Tests passed 💻

✅ All Windows Integration Tests passed.

Pipeline on Agent
Hash: 4c5b835b49cbbcb8a02d2ac99f09bdad64d4528a [PR build]

vs-mobiletools-engineering-service2 · 2023-12-06T17:43:44Z

📚 [PR Build] Artifacts 📚

Packages generated

View packages

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2023-12-06T17:52:46Z

💻 [CI Build] Tests on macOS M1 - Mac Big Sur (11.5) passed 💻

✅ All tests on macOS M1 - Mac Big Sur (11.5) passed.

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2023-12-06T17:57:50Z

💻 [CI Build] Tests on macOS M1 - Mac Ventura (13.0) passed 💻

✅ All tests on macOS M1 - Mac Ventura (13.0) passed.

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2023-12-06T18:09:10Z

✅ API diff for current PR / commit

Legacy Xamarin (No breaking changes)

~~iOS~~ (no change detected)
~~tvOS~~ (no change detected)
~~watchOS~~ (no change detected)
~~macOS~~ (no change detected)

NET (empty diffs)

~~iOS~~: (empty diff detected)
~~tvOS~~: (empty diff detected)
~~MacCatalyst~~: (empty diff detected)
~~macOS~~: (empty diff detected)

✅ API diff vs stable

Legacy Xamarin (No breaking changes)

iOS: vsdrops gist (No breaking changes)
tvOS: vsdrops gist (No breaking changes)
watchOS: vsdrops gist (No breaking changes)
macOS: vsdrops gist (No breaking changes)

.NET (No breaking changes)

iOS: vsdrops gist (No breaking changes)
tvOS: vsdrops gist (No breaking changes)
MacCatalyst: vsdrops gist (No breaking changes)
macOS: vsdrops gist (No breaking changes)
Microsoft.iOS vs Microsoft.MacCatalyst: vsdrops gist

Legacy Xamarin (stable) vs .NET

iOS: vsdrops gist
tvOS: vsdrops gist
macOS: vsdrops gist

ℹ️ Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent
Hash: 4c5b835b49cbbcb8a02d2ac99f09bdad64d4528a [PR build]

vs-mobiletools-engineering-service2 · 2023-12-06T20:24:37Z

🔥 [CI Build] Test results 🔥

Test results

❌ Tests failed on VSTS: simulator tests

0 tests crashed, 2 tests failed, 233 tests passed.

Failures

❌ monotouch tests

2 tests failed, 39 tests passed.

monotouch-test/Mac [dotnet]/Release (NativeAOT, x64) [dotnet]: Failed (Test run failed.
Tests run: 2772 Passed: 2673 Inconclusive: 3 Failed: 1 Ignored: 98)
monotouch-test/Mac [dotnet]/Release (NativeAOT) [dotnet]: Failed (Test run failed.
Tests run: 2772 Passed: 2673 Inconclusive: 3 Failed: 1 Ignored: 98)

Html Report (VSDrops) Download

Successes

✅ bcl: All 69 tests passed. Html Report (VSDrops) Download
✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests: All 1 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 7 tests passed. Html Report (VSDrops) Download
✅ framework: All 8 tests passed. Html Report (VSDrops) Download
✅ generator: All 2 tests passed. Html Report (VSDrops) Download
✅ interdependent_binding_projects: All 7 tests passed. Html Report (VSDrops) Download
✅ install_source: All 1 tests passed. Html Report (VSDrops) Download
✅ introspection: All 8 tests passed. Html Report (VSDrops) Download
✅ linker: All 65 tests passed. Html Report (VSDrops) Download
✅ mac_binding_project: All 1 tests passed. Html Report (VSDrops) Download
✅ mmp: All 2 tests passed. Html Report (VSDrops) Download
✅ mononative: All 6 tests passed. Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. Html Report (VSDrops) Download
✅ mtouch: All 1 tests passed. Html Report (VSDrops) Download
✅ xammac: All 3 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 8 tests passed. Html Report (VSDrops) Download
✅ xtro: All 2 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: 4c5b835b49cbbcb8a02d2ac99f09bdad64d4528a [PR build]

This comment has been minimized.

Sign in to view

mcumming approved these changes Dec 4, 2023

View reviewed changes

This comment has been minimized.

Sign in to view

rolfbjarne reviewed Dec 4, 2023

View reviewed changes

This comment has been minimized.

Sign in to view

stephen-hawley reviewed Dec 4, 2023

View reviewed changes

mandel-macaque and others added 5 commits December 4, 2023 17:14

Update BindingTouch.cs

a25def8

Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>

less verbose msbuild.

ebc7287

Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>

Revert "Update BindingTouch.cs"

277ebc1

This broke the support. This reverts commit a25def8.

Add args to cwl.

4c5b835

mandel-macaque force-pushed the debugger-generator branch from 5621ff1 to 4c5b835 Compare December 6, 2023 16:18

mandel-macaque merged commit 1173c01 into xamarin:main Dec 11, 2023
69 of 72 checks passed

mandel-macaque deleted the debugger-generator branch December 11, 2023 16:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Generator] Allow to have a way to attach to the generator. #19565

[Generator] Allow to have a way to attach to the generator. #19565

mandel-macaque commented Dec 4, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rolfbjarne Dec 4, 2023

mandel-macaque Dec 4, 2023

rolfbjarne Dec 4, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

stephen-hawley Dec 4, 2023

mandel-macaque Dec 4, 2023

rolfbjarne Dec 5, 2023

stephen-hawley Dec 4, 2023

mandel-macaque Dec 4, 2023

vs-mobiletools-engineering-service2 commented Dec 6, 2023

vs-mobiletools-engineering-service2 commented Dec 6, 2023

vs-mobiletools-engineering-service2 commented Dec 6, 2023

vs-mobiletools-engineering-service2 commented Dec 6, 2023

vs-mobiletools-engineering-service2 commented Dec 6, 2023

vs-mobiletools-engineering-service2 commented Dec 6, 2023

		## Debugging


		One of the main problems when adding changes to the generator was that before the generator was moved to dotnet, we could not attach the dotnet debugger to it.

[Generator] Allow to have a way to attach to the generator. #19565

[Generator] Allow to have a way to attach to the generator. #19565

Conversation

mandel-macaque commented Dec 4, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

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

vs-mobiletools-engineering-service2 commented Dec 6, 2023

💻 [CI Build] Windows Integration Tests passed 💻

vs-mobiletools-engineering-service2 commented Dec 6, 2023

📚 [PR Build] Artifacts 📚

Packages generated

vs-mobiletools-engineering-service2 commented Dec 6, 2023

💻 [CI Build] Tests on macOS M1 - Mac Big Sur (11.5) passed 💻

vs-mobiletools-engineering-service2 commented Dec 6, 2023

💻 [CI Build] Tests on macOS M1 - Mac Ventura (13.0) passed 💻

vs-mobiletools-engineering-service2 commented Dec 6, 2023

✅ API diff for current PR / commit

✅ API diff vs stable

ℹ️ Generator diff

vs-mobiletools-engineering-service2 commented Dec 6, 2023

🔥 [CI Build] Test results 🔥

Test results

Failures

❌ monotouch tests

Successes