Add UUID built-in convenience type to SpacetimeDB

Author: mamcx

Cargo.lock

@@ -299,7 +299,7 @@ unicode-ident = "1.0.12"
 unicode-normalization = "0.1.23"
 url = "2.3.1"
 urlencoding = "2.1.2"
-uuid = { version = "1.18.1", features = ["v4"] }
+uuid = { version = "1.18.1", default-features = false }
 v8 = "140.2"
 walkdir = "2.2.5"
 wasmbin = "0.6"

Cargo.toml

@@ -90,4 +90,20 @@ private BigInteger AsBigInt() =>
 
     /// <inheritdoc cref="object.ToString()" />
     public override string ToString() => AsBigInt().ToString();
+
+    public Guid ToGuid()
+    {
+        Span<byte> bytes = stackalloc byte[16];
+        if (BitConverter.IsLittleEndian)
+        {
+            BitConverter.TryWriteBytes(bytes, _lower);
+            BitConverter.TryWriteBytes(bytes[8..], _upper);
+        }
+        else
+        {
+            BitConverter.TryWriteBytes(bytes, _upper);
+            BitConverter.TryWriteBytes(bytes[8..], _lower);
+        }
+        return new Guid(bytes);
+    }
 }

crates/bindings-csharp/BSATN.Runtime/BSATN/U128.cs

@@ -365,7 +365,7 @@ public readonly TimeDuration TimeDurationSince(Timestamp earlier) =>
     public static Timestamp operator -(Timestamp point, TimeDuration interval) =>
         new Timestamp(checked(point.MicrosecondsSinceUnixEpoch - interval.Microseconds));
 
-    public int CompareTo(Timestamp that)
+    public readonly int CompareTo(Timestamp that)
     {
         return this.MicrosecondsSinceUnixEpoch.CompareTo(that.MicrosecondsSinceUnixEpoch);
     }
@@ -605,3 +605,226 @@ public AlgebraicType GetAlgebraicType(ITypeRegistrar registrar) =>
         // --- / customized ---
     }
 }
+
+/// <summary>
+/// A generator for monotonically increasing <see cref="Timestamp"/> s by millisecond increments.
+/// </summary>
+public sealed class ClockGenerator(Timestamp start)
+{
+    private long _microsSinceUnixEpoch = start.MicrosecondsSinceUnixEpoch;
+
+    /// <summary>
+    /// Returns the next <see cref="Timestamp"/> in the sequence, guaranteed to be
+    /// greater than the previous one returned by this method.
+    ///
+    /// UUIDv7 requires monotonic millisecond timestamps, so each tick
+    /// increases the timestamp by at least 1 millisecond (1_000 microseconds).
+    ///
+    /// # Exceptions
+    ///
+    /// If the internal timestamp overflows i64 microseconds.
+    /// </summary>
+    public Timestamp Tick()
+    {
+        checked
+        {
+            _microsSinceUnixEpoch += 1000;
+        }
+        return new Timestamp(_microsSinceUnixEpoch);
+    }
+
+    public static implicit operator ClockGenerator(Timestamp t) => new(t);
+}
+
+/// <summary>
+/// A universally unique identifier (UUID).
+///
+/// Wraps the native <see cref="Guid"/> type and provides methods
+/// to generate nil, random (v4), and time-ordered (v7) UUIDs.
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+public readonly record struct Uuid : IEquatable<Uuid>, IComparable, IComparable<Uuid>
+{
+    private readonly U128 value;
+    internal Uuid(U128 val) => value = val;
+    public static readonly Uuid NIL = new(FromGuid(Guid.Empty));
+
+    public static Uuid Nil() => NIL;
+
+    public static U128 FromGuid(Guid guid)
+    {
+        Span<byte> bytes = stackalloc byte[16];
+        guid.TryWriteBytes(bytes);
+        if (BitConverter.IsLittleEndian)
+        {
+            var lower = BitConverter.ToUInt64(bytes);
+            var upper = BitConverter.ToUInt64(bytes[8..]);
+            return new U128(upper, lower);
+        }
+        else
+        {
+            var upper = BitConverter.ToUInt64(bytes);
+            var lower = BitConverter.ToUInt64(bytes[8..]);
+            return new U128(upper, lower);
+        }
+    }
+
+    private static Guid GuidV4(ReadOnlySpan<byte> randomBytes)
+    {
+        if (randomBytes.Length != 16)
+        {
+            throw new ArgumentException("Must be 16 bytes", nameof(randomBytes));
+        }
+
+        Span<byte> bytes = stackalloc byte[16];
+        randomBytes.CopyTo(bytes);
+        bytes[6] = (byte)((bytes[6] & 0x0F) | 0x40); // version 4
+        bytes[8] = (byte)((bytes[8] & 0x3F) | 0x80); // variant RFC 4122
+
+        return new Guid(randomBytes);
+    }
+
+    /// <summary>
+    /// Create a UUIDv4 from explicit random bytes.
+    /// </summary>
+    /// <remarks>
+    /// This method assumes the provided bytes are already sufficiently random;
+    /// it will only set the appropriate bits for the UUID version and variant.
+    /// </remarks>
+    /// <example>
+    /// <code>
+    /// var randomBytes = new byte[16];
+    /// var uuid = Uuid.FromRandomBytesV4(randomBytes);
+    /// Console.WriteLine(uuid);
+    /// // Output: 00000000-0000-4000-8000-000000000000
+    /// </code>
+    /// </example>
+    public static Uuid FromRandomBytesV4(ReadOnlySpan<byte> randomBytes)
+    {
+        return new(FromGuid(GuidV4(randomBytes)));
+    }
+
+    /// <summary>
+    /// Create a UUIDv7 from a UNIX timestamp (milliseconds) and 10 random bytes.
+    /// </summary>
+    /// <remarks>
+    /// This method sets the variant field within the counter bytes without
+    /// shifting data around it. Callers using the counter as a monotonic
+    /// value should avoid storing significant data in the two least significant
+    /// bits of the third byte.
+    /// </remarks>
+    /// <example>
+    /// <code>
+    /// ulong millis = 1686000000000UL;
+    /// var randomBytes = new byte[10];
+    /// var uuid = Uuid.FromUnixMillisV7(millis, randomBytes);
+    /// Console.WriteLine(uuid);
+    /// // Output: 01888d6e-5c00-7000-8000-000000000000
+    /// </code>
+    /// </example>
+    public static Uuid FromUnixMillisV7(long millisSinceUnixEpoch, ReadOnlySpan<byte> randomBytes)
+    {
+        // TODO: Convert to ` CreateVersion7` from .NET 9 when we can.
+        if (millisSinceUnixEpoch < 0)
+        {
+            throw new ArgumentOutOfRangeException(nameof(millisSinceUnixEpoch), "Timestamp precedes Unix epoch");
+        }
+
+        // Generate random 16 bytes
+        var bytes = GuidV4(randomBytes).ToByteArray();
+
+        // Insert 48-bit timestamp (big endian)
+        bytes[0] = (byte)((millisSinceUnixEpoch >> 40) & 0xFF);
+        bytes[1] = (byte)((millisSinceUnixEpoch >> 32) & 0xFF);
+        bytes[2] = (byte)((millisSinceUnixEpoch >> 24) & 0xFF);
+        bytes[3] = (byte)((millisSinceUnixEpoch >> 16) & 0xFF);
+        bytes[4] = (byte)((millisSinceUnixEpoch >> 8) & 0xFF);
+        bytes[5] = (byte)(millisSinceUnixEpoch & 0xFF);
+
+        // Set version (0111) and variant (10xx)
+        bytes[6] = (byte)((bytes[6] & 0x0F) | 0x70);
+        bytes[8] = (byte)((bytes[8] & 0x3F) | 0x80);
+
+        return new Uuid(FromGuid(new Guid(bytes)));
+    }
+
+    /// <summary>
+    /// Generate a UUIDv7 using a monotonic <see cref="ClockGenerator"/>.
+    /// </summary>
+    /// <remarks>
+    /// This method sets the variant field within the counter bytes without
+    /// shifting data around it. Callers using the counter as a monotonic
+    /// value should avoid storing significant data in the two least significant
+    /// bits of the third byte.
+    /// </remarks>
+    /// <example>
+    /// <code>
+    /// var clock = new ClockGenerator(1686000000000UL);
+    /// var randomBytes = new byte[10];
+    /// var uuid = Uuid.FromClockV7(clock, randomBytes);
+    /// Console.WriteLine(uuid);
+    /// // Output: 0000647e-5181-7000-8000-000000000000
+    /// </code>
+    /// </example>
+    public static Uuid FromClockV7(ClockGenerator clock, ReadOnlySpan<byte> randomBytes)
+
+    {
+        var millis = clock.Tick().MicrosecondsSinceUnixEpoch / 1000;
+        return FromUnixMillisV7(millis, randomBytes);
+    }
+
+    /// <summary>
+    /// Parses a UUID from its string representation.
+    /// </summary>
+    /// <example>
+    /// <code>
+    /// var s = "01888d6e-5c00-7000-8000-000000000000";
+    /// var uuid = Uuid.Parse(s);
+    /// Console.WriteLine(uuid.ToString() == s); // True
+    /// </code>
+    /// </example>
+    public static Uuid Parse(string s) => new(FromGuid(Guid.Parse(s)));
+
+    /// <summary>
+    /// Converts this instance to a <see cref="Guid"/>.
+    /// </summary>
+    public Guid ToGuid() => value.ToGuid();
+
+    public override readonly string ToString() => ToGuid().ToString();
+
+    public readonly int CompareTo(Uuid other) => ToGuid().CompareTo(other.ToGuid());
+    /// <inheritdoc cref="IComparable.CompareTo(object)" />
+    public int CompareTo(object? value)
+    {
+        if (value is Uuid other)
+        {
+            return CompareTo(other);
+        }
+        else if (value is null)
+        {
+            return 1;
+        }
+        else
+        {
+            throw new ArgumentException("Argument must be a Uuid", nameof(value));
+        }
+    }
+    public static bool operator <(Uuid l, Uuid r) => l.CompareTo(r) < 0;
+    public static bool operator >(Uuid l, Uuid r) => l.CompareTo(r) > 0;
+
+
+    public readonly partial struct BSATN : IReadWrite<Uuid>
+    {
+        public Uuid Read(BinaryReader reader) => new(new SpacetimeDB.BSATN.U128Stdb().Read(reader));
+        public void Write(BinaryWriter writer, Uuid value) => new SpacetimeDB.BSATN.U128Stdb().Write(writer, value.value);
+        // --- / auto-generated ---
+
+        // --- customized ---
+        public AlgebraicType GetAlgebraicType(ITypeRegistrar registrar) =>
+            // Return a Product directly, not a Ref, because this is a special type.
+            new AlgebraicType.Product([
+                // Using this specific name here is important.
+                new("__uuid__", new AlgebraicType.U128(default))
+            ]);
+    }
+}

crates/bindings-csharp/BSATN.Runtime/Builtins.cs

@@ -175,7 +175,8 @@ or SpecialType.System_Int64
                     SpecialType.System_String or SpecialType.System_Boolean => true,
                     SpecialType.None => type.ToString()
                         is "SpacetimeDB.ConnectionId"
-                            or "SpacetimeDB.Identity",
+                            or "SpacetimeDB.Identity"
+                            or "SpacetimeDB.Uuid",
                     _ => false,
                 }
             )
@@ -1464,25 +1465,67 @@ internal ReducerContext(Identity identity, ConnectionId? connectionId, Random ra
                                 Timestamp = time;
                                 SenderAuth = AuthCtx.BuildFromSystemTables(connectionId, identity);
                             }
+
+                            /// <summary>
+                            /// Create a new UUIDv4 using the built-in RNG.
+                            /// </summary>
+                            /// <remarks>
+                            /// This method fills 16 random bytes using the context RNG,
+                            /// sets version and variant bits for UUIDv4, and returns the result.
+                            /// </remarks>
+                            /// <example>
+                            /// <code>
+                            /// var uuid = ctx.NewUuidV4();
+                            /// Console.WriteLine(uuid);
+                            /// </code>
+                            /// </example>
+                            public Uuid NewUuidV4()
+                            {
+                                var bytes = new byte[16];
+                                Rng.NextBytes(bytes);
+                                return Uuid.FromRandomBytesV4(bytes);
+                            }
+                            
+                            /// <summary>
+                            /// Create a new UUIDv7 using the provided <see cref="ClockGenerator"/>.
+                            /// </summary>
+                            /// <remarks>
+                            /// To preserve monotonicity guarantees, do not call this from multiple
+                            /// threads or contexts sharing the same <see cref="ClockGenerator"/>.
+                            /// Use a dedicated instance per logical context.
+                            /// </remarks>
+                            /// <example>
+                            /// <code>
+                            /// var clock = new ClockGenerator(ctx.Timestamp);
+                            /// var uuid = ctx.NewUuidV7(clock);
+                            /// Console.WriteLine(uuid);
+                            /// </code>
+                            /// </example>
+                            public Uuid NewUuidV7(ClockGenerator clock)
+                            {
+                                var bytes = new byte[10];
+                                Rng.NextBytes(bytes);
+                                return Uuid.FromClockV7(clock, bytes);
+                            }
                         }
-                        
-                        public sealed record ViewContext : DbContext<Internal.LocalReadOnly>, Internal.IViewContext 
+
+                        public sealed record ViewContext : DbContext<Internal.LocalReadOnly>, Internal.IViewContext
                         {
                             public Identity Sender { get; }
-                        
+
                             internal ViewContext(Identity sender, Internal.LocalReadOnly db)
                                 : base(db)
                             {
                                 Sender = sender;
                             }
                         }
 
-                        public sealed record AnonymousViewContext : DbContext<Internal.LocalReadOnly>, Internal.IAnonymousViewContext 
+                        public sealed record AnonymousViewContext : DbContext<Internal.LocalReadOnly>, Internal.IAnonymousViewContext
                         {
                             internal AnonymousViewContext(Internal.LocalReadOnly db)
                                 : base(db) { }
                         }
-                    
+
                         namespace Internal.TableHandles {
                             {{string.Join("\n", tableAccessors.Select(v => v.tableAccessor))}}
                         }

crates/bindings-csharp/Codegen/Module.cs

@@ -0,0 +1,24 @@
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.5.2.0
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Runtime", "Runtime.csproj", "{63C91D0B-0AE3-D1C8-1700-0E3CE3A0F7C2}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{63C91D0B-0AE3-D1C8-1700-0E3CE3A0F7C2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{63C91D0B-0AE3-D1C8-1700-0E3CE3A0F7C2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{63C91D0B-0AE3-D1C8-1700-0E3CE3A0F7C2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{63C91D0B-0AE3-D1C8-1700-0E3CE3A0F7C2}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {503F8EC9-458A-466F-941E-DF180F6F3CE1}
+	EndGlobalSection
+EndGlobal