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

Verify Unity compatibility in the shared C# codegen #1576

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

RReverser
Copy link
Contributor

Description of Changes

So far, the codegen tests verified that [SpacetimeDB.Type] and [SpacetimeDB.Table] markers result in expected generated methods, and that the generated code is valid and can be compiled successfully.

They did this by combining snapshot testing with a C# module example that has those attributes applied to a variety of types.

This works well enough, but now that C# codegen is split into two parts - BSATN.Codegen and Codegen - and the former is also used for C# clients like Unity, we want to make sure they work independently.

We also want to validate that the shared part that handles only the [SpacetimeDB.Type] attributes generates code compatible with Unity limitations - that is, it must be limited to .NET Standard 2.1 APIs and C# 9 syntax.

In this PR, I'm doing just that - creating two separate project fixtures. client one has limited .NET and C# versions, and only runs the BSATN.Codegen generator for the [Type] markers, whereas the server one does everything the old test did and tests modules with types, tables and reducers.

In the process I also simplified the way test projects are built by using a programmatic MSBuild API instead of manually building and collecting necessary DLLs into a compilation object. This brings test fixtures much closer to real-world projects, simplifies test maintainability, while still allowing to do all the low-level checks like those for codegen caching.

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

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

Describe any testing you've done, and any testing you'd like your reviewers to do,
so that you're confident that all the changes work as expected!

  • dotnet test
  • Write a test you want a reviewer to do here, so they can check it off when they're satisfied.

@RReverser RReverser added the no runtime change This change does not affect the final binaries label Aug 8, 2024
@RReverser RReverser force-pushed the ingvar/more-codegen-testing branch from b5f7553 to 7df7b5c Compare August 8, 2024 20:26
@RReverser RReverser changed the title Verify Unity compatibility in BSATN.Codegen tests Verify Unity compatibility in the shared C# codegen Aug 8, 2024
@bfops bfops added the release-any To be landed in any release window label Aug 12, 2024
@bfops
Copy link
Collaborator

bfops commented Aug 13, 2024

FYI @RReverser this is giving cryptic failures on the C# SDK tests, idk if that's expected.
Edit: Nvm that's not related to this PR.

@RReverser RReverser enabled auto-merge August 13, 2024 18:55
@RReverser RReverser force-pushed the ingvar/more-codegen-testing branch from 7df7b5c to 2a35d76 Compare August 13, 2024 20:02
@RReverser
Copy link
Contributor Author

Edit: Nvm that's not related to this PR.

@bfops So is this one good to go then?

Copy link
Contributor

@kazimuth kazimuth left a comment

Choose a reason for hiding this comment

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

This makes sense, good to split the tests apart. The microsoft plumbing seems so much more pleasant than the proc-macro plumbing in Rust. I have no particular comments on the implementation, unfortunately.

@RReverser RReverser added this pull request to the merge queue Aug 15, 2024
Merged via the queue into master with commit 16ecf99 Aug 15, 2024
8 checks passed
@RReverser RReverser deleted the ingvar/more-codegen-testing branch August 15, 2024 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no runtime change This change does not affect the final binaries release-any To be landed in any release window
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants