Add UUID built-in convenience type to SpacetimeDB

Author: mamcx

Cargo.lock

@@ -302,7 +302,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

@@ -1,6 +1,7 @@
 namespace SpacetimeDB;
 
 using System.Diagnostics.CodeAnalysis;
+using System.Security.Cryptography;
 using CsCheck;
 using SpacetimeDB.BSATN;
 using Xunit;
@@ -861,4 +862,63 @@ public static void GeneratedEnumEqualsWorks()
             iter: 10_000
         );
     }
+
+    [Fact]
+    public static void UUidRoundTrip()
+    {
+        var u1 = Uuid.NIL;
+        var s = u1.ToString();
+        var u2 = Uuid.Parse(s);
+        Assert.Equal(u1, u2);
+        Assert.Equal(u1.ToGuid(), u2.ToGuid());
+        Assert.Equal(s, u2.ToString());
+    }
+
+    [Fact]
+    public static void UuidOrdered()
+    {
+        var u1 = new Uuid(new U128(1, 0));
+        var u2 = new Uuid(new U128(2, 0));
+
+        Assert.True(u1 < u2);
+        Assert.True(u2 > u1);
+        Assert.Equal(u1, u1);
+        Assert.NotEqual(u1, u2);
+
+        var clock = new ClockGenerator(new Timestamp());
+
+        var uuids = Enumerable
+            .Range(0, 1000)
+            .Select(_ =>
+            {
+                var bytes = new byte[10];
+                RandomNumberGenerator.Fill(bytes);
+                return Uuid.FromClockV7(clock, bytes);
+            })
+            .ToList();
+
+        for (var i = 0; i < uuids.Count - 1; i++)
+        {
+            var a = uuids[i];
+            var b = uuids[i + 1];
+
+            Assert.True(a < b, $"UUIDs are not ordered at {i}: {a} !< {b}");
+        }
+    }
+
+    [Fact]
+    public static void UuidVariant()
+    {
+        var u = Uuid.NIL;
+        Assert.Equal(Uuid.UuidVariant.Nil, u.GetVariant());
+
+        var randomBytes = new byte[16];
+        RandomNumberGenerator.Fill(randomBytes);
+        u = Uuid.FromRandomBytesV4(randomBytes);
+        Assert.Equal(Uuid.UuidVariant.V4, u.GetVariant());
+
+        var clock = new ClockGenerator(new Timestamp());
+        u = Uuid.FromClockV7(clock, randomBytes.AsSpan()[..10]);
+        Assert.Equal(Uuid.UuidVariant.V7, u.GetVariant()); // Version nibble
+    }
 }

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

@@ -3,6 +3,7 @@
 
 namespace SpacetimeDB;
 
+using System.Buffers.Binary;
 using System.Numerics;
 using System.Runtime.InteropServices;
 
@@ -33,6 +34,33 @@ public U128(ulong upper, ulong lower)
 
     internal ulong Upper => _upper;
 
+    /// Returns a <see cref="U128" /> from a big-endian byte array.
+    public static U128 FromBytesBigEndian(ReadOnlySpan<byte> bytes)
+    {
+        if (bytes.Length != Size)
+        {
+            throw new ArgumentException(
+                $"Byte array must be exactly {Size} bytes long.",
+                nameof(bytes)
+            );
+        }
+
+        var upper = BinaryPrimitives.ReadUInt64BigEndian(bytes.Slice(0, 8));
+        var lower = BinaryPrimitives.ReadUInt64BigEndian(bytes.Slice(8, 8));
+
+        return new U128(upper, lower);
+    }
+
+    public byte[] ToBytesBigEndian()
+    {
+        var bytes = new byte[Size];
+
+        BinaryPrimitives.WriteUInt64BigEndian(bytes.AsSpan(0, 8), _upper);
+        BinaryPrimitives.WriteUInt64BigEndian(bytes.AsSpan(8, 8), _lower);
+
+        return bytes;
+    }
+
     /// <inheritdoc cref="IComparable.CompareTo(object)" />
     public int CompareTo(object? value)
     {
@@ -90,4 +118,17 @@ private BigInteger AsBigInt() =>
 
     /// <inheritdoc cref="object.ToString()" />
     public override string ToString() => AsBigInt().ToString();
+
+    public Guid ToGuid()
+    {
+        var bytes = ToBytesBigEndian();
+        return new Guid(bytes);
+    }
+
+    public static U128 FromGuid(Guid guid)
+    {
+        Span<byte> bytes = stackalloc byte[16];
+        guid.TryWriteBytes(bytes);
+        return FromBytesBigEndian(bytes);
+    }
 }