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.

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

Reduce noisy C# compilation errors #2067

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

RReverser
Copy link
Member

Description of Changes

When source generator processes code that misuses SpacetimeDB APIs, has wrong signatures, uses types incompatible with BSATN etc, it reports diagnostics but still emits new source code. In some cases, this improves autocomplete and diagnostics, since types and methods are still there even while code is not 100% valid yet, but in other cases the output code is so broken that .NET attempting to compile it will only produce even more noisy errors, which drown out the custom actionable diagnostic we emitted earlier in the pipeline.

This PR fixes couple of such cases by either fixing up or skipping particularly problematic entries during the codegen phase.

You can see the difference in the crates/bindings-csharp/Codegen.Tests/fixtures/diag/snapshots/ExtraCompilationErrors.verified.txt snapshot, which captures all the .NET
compilation errors that didn't come from our own source generator - there is a lot less noise after this PR.

API and ABI breaking changes

If this is an API or ABI breaking change, please apply the
corresponding GitHub label.

Expected complexity level and risk

1
How complicated do you think these changes are? Grade on a scale from 1 to 5,
where 1 is a trivial change, and 5 is a deep-reaching and complex change.

This complexity rating applies not only to the complexity apparent in the diff,
but also to its interactions with existing and future code.

If you answered more than a 2, explain what is complex about the PR,
and what other components it interacts with in potentially concerning ways.

Testing

dotnet test snapshot tests

@RReverser RReverser added the enhancement New feature or request label Dec 17, 2024
@RReverser RReverser marked this pull request as ready for review December 17, 2024 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant