Skip to content

Commit ec78c9d

Browse files
AgashAgash
authored
Merge pull request #1 from Agash/feat/native-aot
Feat/native aot
2 parents 8a16ef3 + 5964529 commit ec78c9d

354 files changed

Lines changed: 27413 additions & 1326 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/build.yml‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,37 @@ jobs:
3636
with:
3737
fetch-depth: 0 # Required for MinVer to determine the version from Git history
3838

39-
- name: Setup .NET 9 SDK
39+
- name: Setup .NET 10 SDK
4040
uses: actions/setup-dotnet@v4
4141
with:
42-
dotnet-version: '9.x' # Use the specific .NET 9 SDK
42+
dotnet-version: '10.x'
4343

4444
- name: Restore dependencies
4545
run: dotnet restore ObsWebSocket.sln
4646

4747
- name: Build Solution
4848
run: dotnet build ObsWebSocket.sln --configuration Release --no-restore
4949

50+
- name: Restore Example for AOT RID graph
51+
run: >
52+
dotnet restore ObsWebSocket.Example/ObsWebSocket.Example.csproj
53+
-p:TargetFramework=net10.0
54+
--runtime linux-x64
55+
-p:SelfContained=true
56+
-p:PublishAot=true
57+
58+
- name: Native AOT Smoke Publish (ObsWebSocket.Example)
59+
run: >
60+
dotnet publish ObsWebSocket.Example/ObsWebSocket.Example.csproj
61+
--configuration Release
62+
--framework net10.0
63+
--runtime linux-x64
64+
--self-contained true
65+
/p:PublishAot=true
66+
/p:ILLinkTreatWarningsAsErrors=true
67+
/p:IlcTreatWarningsAsErrors=true
68+
/p:WarningsNotAsErrors=IL2104%3BIL3053
69+
5070
- name: Run Unit Tests
5171
# Run tests specifically for the ObsWebSocket.Tests project
5272
# Exclude integration tests which require a live OBS instance

‎ObsWebSocket.Codegen.Tasks/GenerateObsWebSocketSourcesTask.cs‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
using Microsoft.Build.Framework;
2+
3+
namespace ObsWebSocket.Codegen.Tasks;
4+
5+
public sealed class GenerateObsWebSocketSourcesTask : Microsoft.Build.Utilities.Task
6+
{
7+
[Required]
8+
public string ProtocolPath { get; set; } = string.Empty;
9+
10+
[Required]
11+
public string OutputDirectory { get; set; } = string.Empty;
12+
13+
public bool DownloadIfMissing { get; set; }
14+
15+
public override bool Execute()
16+
{
17+
int exitCode = ProtocolCodegenRunner.GenerateAsync(
18+
protocolPath: ProtocolPath,
19+
outputDirectory: OutputDirectory,
20+
downloadIfMissing: DownloadIfMissing,
21+
cancellationToken: CancellationToken.None,
22+
logInfo: message => Log.LogMessage(MessageImportance.High, message),
23+
logWarning: message => Log.LogWarning(message),
24+
logError: message => Log.LogError(message)
25+
)
26+
.GetAwaiter()
27+
.GetResult();
28+
29+
return exitCode == 0 && !Log.HasLoggedErrors;
30+
}
31+
}

ObsWebSocket.SourceGenerators/Diagnostics.cs renamed to ObsWebSocket.Codegen.Tasks/Generation/Diagnostics.cs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
1-
using System.Diagnostics.CodeAnalysis;
21
using Microsoft.CodeAnalysis;
32

4-
namespace ObsWebSocket.SourceGenerators;
3+
namespace ObsWebSocket.Codegen.Tasks.Generation;
54

65
/// <summary>
76
/// Contains DiagnosticDescriptor constants for reporting errors and warnings during source generation.
87
/// </summary>
9-
[SuppressMessage(
10-
"StyleCop.CSharp.OrderingRules",
11-
"SA1202:Elements must be ordered by access",
12-
Justification = "Constants grouped logically."
13-
)]
148
internal static class Diagnostics
159
{
1610
private const string Category = "ObsWebSocketGenerator";

ObsWebSocket.SourceGenerators/Emitter.DtoGeneration.cs renamed to ObsWebSocket.Codegen.Tasks/Generation/Emitter.DtoGeneration.cs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
using System.Collections.Concurrent;
1+
using System.Collections.Concurrent;
22
using System.Text;
33
using Microsoft.CodeAnalysis;
44
using Microsoft.CodeAnalysis.Text;
55

6-
namespace ObsWebSocket.SourceGenerators;
6+
namespace ObsWebSocket.Codegen.Tasks.Generation;
77

88
/// <summary>
99
/// Contains logic for generating Data Transfer Object (DTO) records, including handling nested records.
@@ -374,6 +374,7 @@ ProtocolDefinition protocol
374374
mainBuilder.AppendLine("using System.Text.Json;");
375375
mainBuilder.AppendLine("using System.Text.Json.Serialization;");
376376
mainBuilder.AppendLine("using System.Diagnostics.CodeAnalysis;");
377+
mainBuilder.AppendLine("using MessagePack;");
377378
mainBuilder.AppendLine($"using {GeneratedCommonNamespace};");
378379
if (!isNestedType)
379380
{
@@ -445,6 +446,7 @@ ProtocolDefinition protocol
445446
mainBuilder.AppendLine("#pragma warning disable CS8618");
446447

447448
// --- Record Definition Start ---
449+
mainBuilder.AppendLine("[MessagePackObject]");
448450
mainBuilder.AppendLine($"public sealed partial record {recordName}");
449451
mainBuilder.AppendLine("{");
450452
List<PropertyGenInfo> propertyInfos = [];
@@ -545,6 +547,7 @@ ProtocolDefinition protocol
545547
}
546548

547549
mainBuilder.AppendLine($" [JsonPropertyName(\"{originalName}\")]");
550+
mainBuilder.AppendLine($" [Key(\"{originalName}\")]");
548551
mainBuilder.Append(" public ");
549552
if (isConsideredRequired)
550553
{

ObsWebSocket.SourceGenerators/Emitter.Helpers.cs renamed to ObsWebSocket.Codegen.Tasks/Generation/Emitter.Helpers.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
using System.Text;
1+
using System.Text;
22
using System.Text.Json;
33
using System.Text.RegularExpressions;
44
using Microsoft.CodeAnalysis;
55

6-
namespace ObsWebSocket.SourceGenerators;
6+
namespace ObsWebSocket.Codegen.Tasks.Generation;
77

88
/// <summary>
99
/// Contains helper methods, constants, and internal data structures for the Emitter class.
@@ -238,7 +238,7 @@ string parentDtoName
238238
// Map specifically named 'Object' field to Stub record
239239
// Use the fully qualified name to avoid potential namespace conflicts
240240
return ($"{GeneratedCommonNamespace}.SceneItemTransformStub?", false);
241-
// Add other specific 'Object' mappings here if needed in the future
241+
// Add other specific 'Object' mappings here if needed in the future
242242
}
243243
// If not handled above, it falls through to the general 'Object'/'Any' handling below
244244
}

ObsWebSocket.SourceGenerators/Emitter.Hierarchy.cs renamed to ObsWebSocket.Codegen.Tasks/Generation/Emitter.Hierarchy.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
using Microsoft.CodeAnalysis;
1+
using Microsoft.CodeAnalysis;
22

3-
namespace ObsWebSocket.SourceGenerators;
3+
namespace ObsWebSocket.Codegen.Tasks.Generation;
44

55
/// <summary>
66
/// Contains logic for building the object hierarchy from dot-notated field definitions.
@@ -88,7 +88,7 @@ SourceProductionContext context
8888
currentNode = newNode;
8989
}
9090
}
91-
NextFieldPass1:
91+
NextFieldPass1:
9292
;
9393
}
9494

‎ObsWebSocket.Codegen.Tasks/Generation/Emitter.JsonContext.cs‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
using System.Text;
2+
using Microsoft.CodeAnalysis;
3+
using Microsoft.CodeAnalysis.Text;
4+
5+
namespace ObsWebSocket.Codegen.Tasks.Generation;
6+
7+
/// <summary>
8+
/// Contains emitter logic for generating a System.Text.Json source generation context.
9+
/// </summary>
10+
internal static partial class Emitter
11+
{
12+
/// <summary>
13+
/// Generates a JsonSerializerContext containing all fixed and generated protocol types.
14+
/// </summary>
15+
public static void GenerateJsonSerializerContext(
16+
SourceProductionContext context,
17+
ProtocolDefinition protocol
18+
)
19+
{
20+
try
21+
{
22+
StringBuilder builder = BuildSourceHeader("// Serialization Context: ObsWebSocketJsonContext");
23+
24+
_ = builder.AppendLine("using System.Collections.Generic;");
25+
_ = builder.AppendLine("using System.Text.Json;");
26+
_ = builder.AppendLine("using System.Text.Json.Serialization;");
27+
_ = builder.AppendLine("using ObsWebSocket.Core.Protocol;");
28+
_ = builder.AppendLine("using ObsWebSocket.Core.Protocol.Common;");
29+
_ = builder.AppendLine("using ObsWebSocket.Core.Protocol.Events;");
30+
_ = builder.AppendLine("using ObsWebSocket.Core.Protocol.Requests;");
31+
_ = builder.AppendLine("using ObsWebSocket.Core.Protocol.Responses;");
32+
_ = builder.AppendLine();
33+
_ = builder.AppendLine("namespace ObsWebSocket.Core.Serialization;");
34+
_ = builder.AppendLine();
35+
_ = builder.AppendLine("[JsonSourceGenerationOptions(");
36+
_ = builder.AppendLine(" PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,");
37+
_ = builder.AppendLine(" DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingDefault)]");
38+
39+
// Fixed protocol wrapper and payload types.
40+
_ = builder.AppendLine("[JsonSerializable(typeof(OutgoingMessage<RequestPayload>))]");
41+
_ = builder.AppendLine("[JsonSerializable(typeof(OutgoingMessage<IdentifyPayload>))]");
42+
_ = builder.AppendLine("[JsonSerializable(typeof(OutgoingMessage<ReidentifyPayload>))]");
43+
_ = builder.AppendLine("[JsonSerializable(typeof(OutgoingMessage<RequestBatchPayload>))]");
44+
_ = builder.AppendLine("[JsonSerializable(typeof(IncomingMessage<JsonElement>))]");
45+
_ = builder.AppendLine("[JsonSerializable(typeof(RequestResponsePayload<JsonElement>))]");
46+
_ = builder.AppendLine("[JsonSerializable(typeof(RequestBatchResponsePayload<JsonElement>))]");
47+
_ = builder.AppendLine("[JsonSerializable(typeof(EventPayloadBase<JsonElement>))]");
48+
_ = builder.AppendLine("[JsonSerializable(typeof(HelloPayload))]");
49+
_ = builder.AppendLine("[JsonSerializable(typeof(IdentifiedPayload))]");
50+
_ = builder.AppendLine("[JsonSerializable(typeof(RequestStatus))]");
51+
52+
// Handwritten stub types.
53+
_ = builder.AppendLine("[JsonSerializable(typeof(SceneStub))]");
54+
_ = builder.AppendLine("[JsonSerializable(typeof(SceneItemStub))]");
55+
_ = builder.AppendLine("[JsonSerializable(typeof(SceneItemTransformStub))]");
56+
_ = builder.AppendLine("[JsonSerializable(typeof(FilterStub))]");
57+
_ = builder.AppendLine("[JsonSerializable(typeof(InputStub))]");
58+
_ = builder.AppendLine("[JsonSerializable(typeof(TransitionStub))]");
59+
_ = builder.AppendLine("[JsonSerializable(typeof(OutputStub))]");
60+
_ = builder.AppendLine("[JsonSerializable(typeof(MonitorStub))]");
61+
_ = builder.AppendLine("[JsonSerializable(typeof(PropertyItemStub))]");
62+
63+
// Common collection payload helpers.
64+
_ = builder.AppendLine("[JsonSerializable(typeof(List<JsonElement>))]");
65+
_ = builder.AppendLine("[JsonSerializable(typeof(Dictionary<string, bool>))]");
66+
_ = builder.AppendLine("[JsonSerializable(typeof(Dictionary<string, JsonElement>))]");
67+
_ = builder.AppendLine(
68+
"[JsonSerializable(typeof(List<RequestResponsePayload<JsonElement>>))]"
69+
);
70+
71+
// Generated request/response/event DTOs.
72+
if (protocol.Requests is not null)
73+
{
74+
foreach (RequestDefinition request in protocol.Requests)
75+
{
76+
string baseName = SanitizeIdentifier(request.RequestType);
77+
if (request.RequestFields?.Count > 0)
78+
{
79+
_ = builder.AppendLine(
80+
$"[JsonSerializable(typeof({GeneratedRequestsNamespace}.{baseName}RequestData))]"
81+
);
82+
}
83+
84+
if (request.ResponseFields?.Count > 0)
85+
{
86+
_ = builder.AppendLine(
87+
$"[JsonSerializable(typeof({GeneratedResponsesNamespace}.{baseName}ResponseData))]"
88+
);
89+
}
90+
}
91+
}
92+
93+
if (protocol.Events is not null)
94+
{
95+
foreach (OBSEvent eventDef in protocol.Events)
96+
{
97+
if (eventDef.DataFields?.Count > 0)
98+
{
99+
string payloadType = SanitizeIdentifier(eventDef.EventType) + "Payload";
100+
_ = builder.AppendLine(
101+
$"[JsonSerializable(typeof({GeneratedEventsNamespace}.{payloadType}))]"
102+
);
103+
}
104+
}
105+
}
106+
107+
foreach (string nestedTypeName in s_generatedNestedTypes.Keys.OrderBy(k => k))
108+
{
109+
_ = builder.AppendLine(
110+
$"[JsonSerializable(typeof({NestedTypesNamespace}.{nestedTypeName}))]"
111+
);
112+
}
113+
114+
_ = builder.AppendLine("internal sealed partial class ObsWebSocketJsonContext : JsonSerializerContext");
115+
_ = builder.AppendLine("{");
116+
_ = builder.AppendLine("}");
117+
118+
context.AddSource(
119+
"ObsWebSocketJsonContext.g.cs",
120+
SourceText.From(builder.ToString(), Encoding.UTF8)
121+
);
122+
}
123+
catch (Exception ex)
124+
{
125+
context.ReportDiagnostic(
126+
Diagnostic.Create(
127+
Diagnostics.IdentifierGenerationError,
128+
Location.None,
129+
"ObsWebSocketJsonContext",
130+
"JsonSerializerContext generation",
131+
ex.ToString()
132+
)
133+
);
134+
}
135+
}
136+
}

0 commit comments

Comments
 (0)