clockworklabs/spacetimedb-csharp-sdk

The SpacetimeDB SDK for C# clients

spacetimedb-csharp-sdk's Issues

Don't lock the concurrent queue when enqueuing

Let's not lock on this because I don't think we have to. This is causing performance stutters in BitCraft:

Unable to Install spacetimedbsdk Package Using .NET CLI in Windows Powershell

Description:
When attempting to install the spacetimedbsdk package using the .NET CLI in Windows Powershell, I encountered an error indicating that there are no available versions for the package. The documented command to install the package did not work as expected.

Steps to Reproduce:

1. Open Windows Powershell.
2. Navigate to the project directory: (In my case: C:\Users\blitz\Desktop\spacetime-test\client)
3. Run the command: dotnet add package spacetimedbsdk

Expected Result:
The spacetimedbsdk package should be added to the project without any issues.

Actual Result:
Received the following error:
error: There are no versions available for the package 'spacetimedbsdk'.

Additional Information:
.NET CLI Version: Version 7.0.201 (dotnet --info > .NET SDK)
Operating System: Windows 11
Logs:

(base) PS C:\Users\blitz\Desktop\spacetime-test\client> dotnet add package spacetimedbsdk
Determining projects to restore...
Writing C:\Users\blitz\AppData\Local\Temp\tmpE925.tmp
info : X.509 certificate chain validation will use the default trust store selected by .NET.
info : X.509 certificate chain validation will use the default trust store selected by .NET.
info : Adding PackageReference for package 'spacetimedbsdk' into project 'C:\Users\blitz\Desktop\spacetime-test\client\client.csproj'.
info :   CACHE https://api.nuget.org/v3/registration5-gz-semver2/spacetimedbsdk/index.json
info :   CACHE https://api.nuget.org/v3/registration5-gz-semver2/spacetimedbsdk/index.json
error: There are no versions available for the package 'spacetimedbsdk'.

Switch from sending reducer call requests using json to using bsatn

Consider Incremental Generators for a better user experience

Incremental Generators could be used to automatically generate and update C# entities and reducers. A first time user experience for the SpacetimeDB C# SDK could be as simple as:

1. Create new project
2. Add reference to SpacetimeDB.ClientSDK nuget package
3. Configure database connectivity
4. Source generator runs and creates entities and reducers

Here is a proof of concept for the current (as of February 2024) SDK which could be an alternative to the FindReducerType approach:

using Microsoft.CodeAnalysis;
using System.Collections.Immutable;

namespace SpacetimeDBAutogen;

[Generator]
public class ReducerCacheGenerator : IIncrementalGenerator
{
    public void Initialize(IncrementalGeneratorInitializationContext initContext)
    {

        IncrementalValuesProvider<(string FunctionName, string MethodName)> reducerProvider = initContext.SyntaxProvider
            .ForAttributeWithMetadataName(
                "SpacetimeDB.ReducerCallbackAttribute", 
                predicate: (_, _) => true,
                transform: static (ctx, _) => {

                    var functionNameAttribute = ctx.Attributes
                        .Where(a=>a.AttributeClass.ToDisplayString() == "SpacetimeDB.ReducerCallbackAttribute")
                        .SelectMany(a => a.NamedArguments)
                        .Where(na => na.Key == "FunctionName")
                        .Select(na => na.Value)
                        .FirstOrDefault();

                    var displayString = ctx.TargetSymbol.ToDisplayString();
                    displayString = displayString.Substring(0, displayString.IndexOf('('));

                    return (functionNameAttribute.Value.ToString(), displayString);
                });

        IncrementalValueProvider<ImmutableArray<(string FunctionName, string MethodName)>> collected = reducerProvider.Collect();

        initContext.RegisterSourceOutput(collected, static (sourceProductionContext, reducers) =>
        {
            sourceProductionContext.AddSource("ReducerCache.g.cs", $$"""
namespace SpacetimeDB;

public static class SpacetimeDBClientReducers
{
    static SpacetimeDBClientReducers()
    {{{reducers
              .Aggregate("", (c, n) => c + "\n        SpacetimeDBClient.reducerEventCache.Add(\"" + n.FunctionName + "\", " + n.MethodName + ");")
     }}
    }
}

""");

        });

    }
}

Which outputs:

namespace SpacetimeDB;

public static class SpacetimeDBClientReducers
{
    static SpacetimeDBClientReducers()
    {
        SpacetimeDBClient.reducerEventCache.Add("set_name", SpacetimeDB.Types.Reducer.OnSetName);
        SpacetimeDBClient.reducerEventCache.Add("send_message", SpacetimeDB.Types.Reducer.OnSendMessage);
    }
}

Unique types should autogenerate as `FindBy` instead of `FilterBy`

Refactor SDK BSATN implementation

• Reuse as much code from the C# module SDK where possible
• Get rid of most reflection if we can
• This requires updating the C# autogen reducer functions