feat(server): visualization with lcjs (#45)

* refactor: 🚚 server folder structure

* feat: visualization with lcjs

* build(server): add eslint and prettier

* build(server): add lint and format to npm scripts

* fix(server): complex array formatter causing gen2 gc

* build(server): exclude configs from publish

.editorconfig

@@ -3,11 +3,15 @@ root = true
 # All files
 [*]
 indent_style = space
+charset = utf-8
 
 # Xml files
 [*.xml]
 indent_size = 2
 
+[*.{js,ts}]
+indent_size = 2
+
 # C# files
 [*.cs]
 

src/Qynit.PulseGen.Server/.eslintrc.cjs

@@ -0,0 +1,8 @@
+/* eslint-env node */
+module.exports = {
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  root: true,
+  ignorePatterns: ["**/wwwroot/**/*", "Pages/**/*.js"],
+};

src/Qynit.PulseGen.Server/.gitignore

@@ -0,0 +1,3 @@
+## Ignore bundled JS files
+**/*.razor.js
+**/*.razor.js.map

src/Qynit.PulseGen.Server/.prettierignore

@@ -0,0 +1,16 @@
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Oo]ut/
+[Ll]og/
+[Ll]ogs/

src/Qynit.PulseGen.Server/.prettierrc.json

@@ -0,0 +1 @@
+{}

src/Qynit.PulseGen.Server/App.razor

@@ -0,0 +1,12 @@
+<Router AppAssembly="@typeof(App).Assembly">
+    <Found Context="routeData">
+        <RouteView RouteData="@routeData" DefaultLayout="@typeof(MainLayout)" />
+        <FocusOnNavigate RouteData="@routeData" Selector="h1" />
+    </Found>
+    <NotFound>
+        <PageTitle>Not found</PageTitle>
+        <LayoutView Layout="@typeof(MainLayout)">
+            <p role="alert">Sorry, there's nothing at this address.</p>
+        </LayoutView>
+    </NotFound>
+</Router>

src/Qynit.PulseGen.Server/ArcUnsafe.cs

@@ -0,0 +1,55 @@
+namespace Qynit.PulseGen.Server;
+
+public static class ArcUnsafe
+{
+    public static ArcUnsafe<T> Wrap<T>(T disposable) where T : IDisposable
+    {
+        return new ArcUnsafe<T>(disposable);
+    }
+}
+
+public readonly struct ArcUnsafe<T> : IDisposable where T : IDisposable
+{
+    private readonly RefCountBox _refCountBox;
+    public T Target { get; }
+
+    public ArcUnsafe(T disposable)
+    {
+        _refCountBox = new RefCountBox();
+        Target = disposable;
+    }
+
+    public ArcUnsafe<T> Clone()
+    {
+        _refCountBox.Acquire();
+        return this;
+    }
+
+    public void Dispose()
+    {
+        var refCount = _refCountBox.Release();
+        if (refCount == 0)
+        {
+            Target.Dispose();
+        }
+    }
+
+    private class RefCountBox
+    {
+        private int _referenceCount;
+        public int Acquire()
+        {
+            return Interlocked.Increment(ref _referenceCount);
+        }
+
+        public int Release()
+        {
+            return Interlocked.Decrement(ref _referenceCount);
+        }
+
+        public RefCountBox()
+        {
+            Acquire();
+        }
+    }
+}

src/Qynit.PulseGen.Server/ComplexArrayFormatter.cs

@@ -1,4 +1,4 @@
-using System.Runtime.InteropServices;
+using System.Runtime.InteropServices;
 
 using MessagePack;
 using MessagePack.Formatters;
@@ -21,10 +21,39 @@ public void Serialize(ref MessagePackWriter writer, PooledComplexArray<double> v
         }
 
         writer.WriteArrayHeader(2);
-        var nBytes = sizeof(double) * value.Length;
-        writer.WriteBinHeader(nBytes);
-        writer.WriteRaw(MemoryMarshal.AsBytes(value.DataI));
-        writer.WriteBinHeader(nBytes);
-        writer.WriteRaw(MemoryMarshal.AsBytes(value.DataQ));
+        var bytesI = MemoryMarshal.AsBytes(value.DataI);
+        var bytesQ = MemoryMarshal.AsBytes(value.DataQ);
+        var length = bytesI.Length;
+        if (length <= ushort.MaxValue)
+        {
+            writer.Write(bytesI);
+            writer.Write(bytesQ);
+        }
+        else
+        {
+            WriteBinHeader(ref writer, length);
+            writer.WriteRaw(bytesI);
+            WriteBinHeader(ref writer, length);
+            writer.WriteRaw(bytesQ);
+        }
+    }
+
+    private static void WriteBinHeader(ref MessagePackWriter writer, int length)
+    {
+        var span = writer.GetSpan(5);
+        span[0] = MessagePackCode.Bin32;
+        WriteBigEndian(length, span[1..]);
+        writer.Advance(5);
+    }
+
+    private static void WriteBigEndian(int value, Span<byte> span)
+    {
+        unchecked
+        {
+            span[3] = (byte)value;
+            span[2] = (byte)(value >> 8);
+            span[1] = (byte)(value >> 16);
+            span[0] = (byte)(value >> 24);
+        }
     }
 }

src/Qynit.PulseGen.Server/DisposableExtensions.cs

@@ -0,0 +1,9 @@
+namespace Qynit.PulseGen.Server;
+
+internal static class DisposableExtensions
+{
+    public static ArcUnsafe<T> ToArc<T>(this T disposable) where T : IDisposable
+    {
+        return new ArcUnsafe<T>(disposable);
+    }
+}

src/Qynit.PulseGen.Server/Hubs/IPlotClient.cs

@@ -0,0 +1,6 @@
+namespace Qynit.PulseGen.Server.Hubs;
+
+public interface IPlotClient
+{
+    Task ReceiveNames(IEnumerable<string> names);
+}

src/Qynit.PulseGen.Server/Hubs/PlotHub.cs

@@ -0,0 +1,8 @@
+using Microsoft.AspNetCore.SignalR;
+
+namespace Qynit.PulseGen.Server.Hubs;
+
+public class PlotHub : Hub<IPlotClient>
+{
+    public const string Uri = "/plot/hub";
+}

src/Qynit.PulseGen.Server/MainLayout.razor

@@ -0,0 +1,5 @@
+@inherits LayoutComponentBase
+
+<PageTitle>PulseGen Viewer</PageTitle>
+
+<main> @Body </main>

src/Qynit.PulseGen.Server/ChannelInfo.cs → src/Qynit.PulseGen.Server/Models/ChannelInfo.cs

@@ -1,6 +1,6 @@
 using MessagePack;
 
-namespace Qynit.PulseGen.Server;
+namespace Qynit.PulseGen.Server.Models;
 
 [MessagePackObject]
 public sealed record ChannelInfo(

src/Qynit.PulseGen.Server/HannShapeInfo.cs → src/Qynit.PulseGen.Server/Models/HannShapeInfo.cs

@@ -1,6 +1,6 @@
 using MessagePack;
 
-namespace Qynit.PulseGen.Server;
+namespace Qynit.PulseGen.Server.Models;
 
 [MessagePackObject]
 public sealed record HannShapeInfo : ShapeInfo

src/Qynit.PulseGen.Server/Models/InstructionDto.cs

@@ -0,0 +1,11 @@
+using MessagePack;
+
+namespace Qynit.PulseGen.Server.Models;
+
+[Union(0, typeof(PlayDto))]
+[Union(1, typeof(ShiftPhaseDto))]
+[Union(2, typeof(SetPhaseDto))]
+[Union(3, typeof(ShiftFrequencyDto))]
+[Union(4, typeof(SetFrequencyDto))]
+[Union(5, typeof(SwapPhaseDto))]
+public abstract record InstructionDto;

src/Qynit.PulseGen.Server/InterpolatedShapeInfo.cs → src/Qynit.PulseGen.Server/Models/InterpolatedShapeInfo.cs

@@ -1,6 +1,6 @@
 using MessagePack;
 
-namespace Qynit.PulseGen.Server;
+namespace Qynit.PulseGen.Server.Models;
 
 [MessagePackObject]
 public sealed record InterpolatedShapeInfo(

src/Qynit.PulseGen.Server/Play.cs → src/Qynit.PulseGen.Server/Models/PlayDto.cs

@@ -1,9 +1,9 @@
 using MessagePack;
 
-namespace Qynit.PulseGen.Server;
+namespace Qynit.PulseGen.Server.Models;
 
 [MessagePackObject]
-public sealed record Play(
+public sealed record PlayDto(
     [property: Key(0)] double Time,
     [property: Key(1)] int ChannelId,
     [property: Key(2)] int ShapeId,
@@ -12,4 +12,4 @@ public sealed record Play(
     [property: Key(5)] double FrequencyShift,
     [property: Key(6)] double PhaseShift,
     [property: Key(7)] double Amplitude,
-    [property: Key(8)] double DragCoefficient) : Instruction;
+    [property: Key(8)] double DragCoefficient) : InstructionDto;

src/Qynit.PulseGen.Server/PulseGenRequest.cs → src/Qynit.PulseGen.Server/Models/PulseGenRequest.cs

@@ -1,9 +1,9 @@
 using MessagePack;
 
-namespace Qynit.PulseGen.Server;
+namespace Qynit.PulseGen.Server.Models;
 
 [MessagePackObject]
 public sealed record PulseGenRequest(
     [property: Key(0)] IList<ChannelInfo> ChannelTable,
     [property: Key(1)] IList<ShapeInfo> ShapeTable,
-    [property: Key(2)] IEnumerable<Instruction> Instructions);
+    [property: Key(2)] IEnumerable<InstructionDto> Instructions);

src/Qynit.PulseGen.Server/Models/PulseGenResponse.cs

@@ -0,0 +1,28 @@
+using MessagePack;
+
+namespace Qynit.PulseGen.Server.Models;
+
+[MessagePackObject]
+public sealed class PulseGenResponse : IDisposable
+{
+    [Key(0)]
+    public IList<PooledComplexArray<double>> Waveforms { get; set; } = null!;
+
+    private readonly List<ArcUnsafe<PooledComplexArray<double>>> _disposables = null!;
+
+    public PulseGenResponse() { }
+
+    public PulseGenResponse(List<ArcUnsafe<PooledComplexArray<double>>> waveforms)
+    {
+        _disposables = waveforms;
+        Waveforms = _disposables.Select(x => x.Target).ToList();
+    }
+
+    public void Dispose()
+    {
+        foreach (var disposable in _disposables)
+        {
+            disposable.Dispose();
+        }
+    }
+}

src/Qynit.PulseGen.Server/ScheduleElementDto.cs → src/Qynit.PulseGen.Server/Models/ScheduleElementDto.cs

@@ -4,7 +4,7 @@
 
 using MessagePack;
 
-namespace Qynit.PulseGen.Server;
+namespace Qynit.PulseGen.Server.Models;
 
 
 [Union(0, typeof(PlayElementDto))]
@@ -66,7 +66,7 @@ public override ScheduleElement GetScheduleElement(ScheduleRequest request)
     {
         var shapes = request.ShapeTable;
         Debug.Assert(shapes is not null);
-        var pulseShape = (ShapeId == -1) ? null : shapes[ShapeId].GetPulseShape();
+        var pulseShape = ShapeId == -1 ? null : shapes[ShapeId].GetPulseShape();
         var envelope = new Envelope(pulseShape, Width, Plateau);
         return new PlayElement(ChannelId, envelope, Frequency, Phase, Amplitude, DragCoefficient)
         {
@@ -336,15 +336,3 @@ public override ScheduleElement GetScheduleElement(ScheduleRequest request)
         return result;
     }
 }
-
-
-[MessagePackObject]
-public sealed class ScheduleRequest
-{
-    [Key(0)]
-    public IList<ChannelInfo>? ChannelTable { get; init; }
-    [Key(1)]
-    public IList<ShapeInfo>? ShapeTable { get; init; }
-    [Key(2)]
-    public ScheduleElementDto? Schedule { get; init; }
-}

src/Qynit.PulseGen.Server/Models/ScheduleRequest.cs

@@ -0,0 +1,14 @@
+using MessagePack;
+
+namespace Qynit.PulseGen.Server.Models;
+
+[MessagePackObject]
+public sealed class ScheduleRequest
+{
+    [Key(0)]
+    public IList<ChannelInfo>? ChannelTable { get; init; }
+    [Key(1)]
+    public IList<ShapeInfo>? ShapeTable { get; init; }
+    [Key(2)]
+    public ScheduleElementDto? Schedule { get; init; }
+}

src/Qynit.PulseGen.Server/Models/SetFrequencyDto.cs

@@ -0,0 +1,9 @@
+using MessagePack;
+
+namespace Qynit.PulseGen.Server.Models;
+
+[MessagePackObject]
+public sealed record SetFrequencyDto(
+    [property: Key(0)] double Time,
+    [property: Key(1)] int ChannelId,
+    [property: Key(2)] double Frequency) : InstructionDto;