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

Minor attribute cleanups for C# module #1753

Merged
merged 2 commits into from
Sep 27, 2024
Merged

Conversation

RReverser
Copy link
Member

Description of Changes

A follow-up to #1719:

  • Hide ColumnAttrs and base ColumnAttribute classes into SpacetimeDB.Internal since they shouldn't be accessed by user.
  • Remove legacy PrimaryKeyIdentity alias as ColumnAttrs is no longer part of the public API.
  • Extend ParseAs helper to support abstract classes by accepting an explicit type.
  • Reuse ParseAs in couple of places instead of manual parsing.
  • Combine attributes by table early during parsing to reduce number of stored elements that need to be cached and iterated over.
  • Stringify ColumnAttrs as variant name again.

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!

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

A follow-up to #1719:

 - Hide `ColumnAttrs` and base `ColumnAttribute` classes into `SpacetimeDB.Internal` since they shouldn't be accessed by user.
 - Remove legacy `PrimaryKeyIdentity` alias as `ColumnAttrs` is no longer part of the public API.
 - Extend `ParseAs` helper to support abstract classes by accepting an explicit type.
 - Reuse `ParseAs` in couple of places instead of manual parsing.
 - Combine attributes by table early during parsing to reduce number of stored elements that need to be cached and iterated over.
 - Stringify ColumnAttrs as variant name again.
@RReverser RReverser requested a review from lcodes September 27, 2024 14:05

[Flags]
public enum ColumnAttrs : byte
namespace SpacetimeDB
{
Copy link
Contributor

Choose a reason for hiding this comment

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

Don't think the toplevel ns needs {}; namespace Internal {} is fine to use with namespace SpacetimeDB; afaik

Copy link
Member Author

Choose a reason for hiding this comment

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

It's necessary here because you can't mix file-scoped and regular namespace syntax, C# will complain. Idk why they made it so, but 🤷‍♂️

@RReverser RReverser added this pull request to the merge queue Sep 27, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 27, 2024
@RReverser RReverser enabled auto-merge September 27, 2024 15:33
@RReverser RReverser added this pull request to the merge queue Sep 27, 2024
Merged via the queue into master with commit 6ba91bb Sep 27, 2024
8 checks passed
@RReverser RReverser deleted the ingvar/cleanup-attrs branch September 27, 2024 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants