Merge branch 'master' of https://github.com/TheWizardofGauze/hd2api

Author: TheWizardofGauze

.github/workflows/dotnet.yml

@@ -29,3 +29,10 @@ jobs:
         run: dotnet format --no-restore --verify-no-changes --exclude-diagnostics IL2026 IL3050
       - name: Check tests
         run: dotnet test --no-build --verbosity normal
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          retention-days: 5
+          name: openapi-schemas
+          path: docs/openapi/

.github/workflows/fly.yml

@@ -1,8 +1,12 @@
 name: Fly Deploy
 on:
-  push:
-    branches:
-      - master
+  release:
+    types: [ published ]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to use (e.g. v1.2.3)'
+        required: true
 jobs:
   deploy:
     environment: Fly
@@ -11,9 +15,28 @@ jobs:
     concurrency: deploy-group    # optional: ensure only one action runs at a time
     steps:
       - uses: actions/checkout@v4
+
       - uses: superfly/flyctl-actions/setup-flyctl@master
+
       - name: Initial static JSON schema submodule
         run: git submodule update --init ./src/Helldivers-2-Models/json
-      - run: flyctl deploy --remote-only
+
+      - name: Set Version
+        id: set_version
+        run: |
+          if [[ -n "${{ github.event.inputs.version }}" ]]; then
+            VERSION="${{ github.event.inputs.version }}"
+          else
+            VERSION="${GITHUB_REF##*/}"
+          fi
+          
+          VERSION_WITHOUT_V="${VERSION#v}"
+          
+          echo "VERSION=$VERSION"
+          echo "VERSION_WITHOUT_V=$VERSION_WITHOUT_V"
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "version-without-v=$VERSION_WITHOUT_V" >> $GITHUB_OUTPUT
+
+      - run: flyctl deploy --remote-only --build-arg VERSION=${{ steps.set_version.outputs.version-without-v }}
         env:
           FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}

.github/workflows/sync.yml

@@ -0,0 +1,81 @@
+name: Validate sync
+
+permissions:
+  contents: read
+  pull-requests: write
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch: 
+
+jobs:
+  validate-sync:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '9.0.x'
+
+      - name: Download JSON submodule
+        run: git submodule update --init ./src/Helldivers-2-Models/json
+
+      - name: Run sync and capture logs
+        id: run_sync
+        shell: bash
+        continue-on-error: true
+        run: |
+          set -o pipefail
+          dotnet build
+          dotnet run --project ./src/Helldivers-2-CI/Helldivers-2-CI.csproj 2>&1 | tee sync.log
+
+      - name: Upload artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: sync-artifacts
+          path: |
+            v1/*.json
+            v2/*.json
+            sync.log
+
+      - name: Capture error log
+        id: sync_log
+        if: ${{ steps.run_sync.outcome == 'failure' && github.event_name == 'pull_request' }}
+        run: |
+          # open a multi-line output called "log"
+          echo "log<<EOF" >> $GITHUB_OUTPUT
+          cat sync.log       >> $GITHUB_OUTPUT
+          echo "EOF"         >> $GITHUB_OUTPUT
+
+      - name: Comment on PR on failure
+        if: ${{ steps.run_sync.outcome == 'failure' && github.event_name == 'pull_request' }}
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            ⚠️ **Sync validation failed** (run #${{ github.run_number }} exited with ${{ steps.run_sync.outcome }})
+
+            <details>
+              <summary>Error log</summary>
+  
+              ```text
+              ${{ steps.sync_log.outputs.log }}
+              ```
+            </details>
+
+            **Artifacts** (JSON + log) here:  
+            ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+
+      - name: Fail job on error
+        if: ${{ steps.run_sync.outcome == 'failure' }}
+        run: exit 1

Helldivers-2.sln

@@ -41,6 +41,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Workflows", "Workflows", "{
 		.github\workflows\dotnet.yml = .github\workflows\dotnet.yml
 		.github\workflows\fly.yml = .github\workflows\fly.yml
 		.github\workflows\pages.yml = .github\workflows\pages.yml
+		.github\workflows\sync.yml = .github\workflows\sync.yml
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Templates", "Templates", "{FD5B9284-4689-48BE-B520-633C7269F97C}"
@@ -56,6 +57,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "OpenApi", "OpenApi", "{1A2C
 		docs\openapi\Helldivers-2-API_arrowhead.json = docs\openapi\Helldivers-2-API_arrowhead.json
 	EndProjectSection
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Helldivers-2-CI", "src\Helldivers-2-CI\Helldivers-2-CI.csproj", "{DD942DB1-162A-4915-B10E-C049ED478297}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -82,6 +85,10 @@ Global
 		{32AE19FB-7D9E-4AC7-A0A5-80DED3680369}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{32AE19FB-7D9E-4AC7-A0A5-80DED3680369}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{32AE19FB-7D9E-4AC7-A0A5-80DED3680369}.Release|Any CPU.Build.0 = Release|Any CPU
+		{DD942DB1-162A-4915-B10E-C049ED478297}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{DD942DB1-162A-4915-B10E-C049ED478297}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{DD942DB1-162A-4915-B10E-C049ED478297}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{DD942DB1-162A-4915-B10E-C049ED478297}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

src/Helldivers-2-API/Controllers/ArrowHeadController.cs

@@ -75,4 +75,18 @@ public static async Task<IResult> Assignments(HttpContext context, ArrowHeadStor
 
         return Results.Bytes(assignments, contentType: "application/json");
     }
+
+    /// <summary>
+    /// Fetches THE specific <see cref="SpaceStation" /> (749875195).
+    /// </summary>
+    [ProducesResponseType<List<Assignment>>(StatusCodes.Status200OK)]
+    [ProducesResponseType(StatusCodes.Status503ServiceUnavailable)]
+    public static async Task<IResult> SpaceStation(HttpContext context, ArrowHeadStore store, [FromRoute] long index)
+    {
+        var spaceStation = await store.GetSpaceStation(index, context.RequestAborted);
+        if (spaceStation is { } bytes)
+            return Results.Bytes(bytes, contentType: "application/json");
+
+        return Results.NotFound();
+    }
 }

src/Helldivers-2-API/Controllers/V2/DispatchController.cs

@@ -0,0 +1,36 @@
+using Helldivers.Core.Contracts.Collections;
+using Helldivers.Models.V2;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Helldivers.API.Controllers.V2;
+
+/// <summary>
+/// Contains API endpoints for <see cref="Dispatch" />.
+/// </summary>
+public static class DispatchController
+{
+    /// <summary>
+    /// Fetches a list of all available <see cref="Dispatch" /> information available.
+    /// </summary>
+    [ProducesResponseType<List<Dispatch>>(StatusCodes.Status200OK)]
+    public static async Task<IResult> Index(HttpContext context, IStore<Dispatch, int> store)
+    {
+        var dispatches = await store.AllAsync(context.RequestAborted);
+
+        return Results.Ok(dispatches);
+    }
+
+
+    /// <summary>
+    /// Fetches a specific <see cref="Dispatch" /> identified by <paramref name="index" />.
+    /// </summary>
+    [ProducesResponseType<Dispatch>(StatusCodes.Status200OK)]
+    public static async Task<IResult> Show(HttpContext context, IStore<Dispatch, int> store, [FromRoute] int index)
+    {
+        var dispatch = await store.GetAsync(index, context.RequestAborted);
+        if (dispatch is null)
+            return Results.NotFound();
+
+        return Results.Ok(dispatch);
+    }
+}

…Controllers/V1/SpaceStationController.cs …Controllers/V2/SpaceStationController.cssrc/Helldivers-2-API/Controllers/V1/SpaceStationController.cs renamed to src/Helldivers-2-API/Controllers/V2/SpaceStationController.cs src/Helldivers-2-API/Controllers/V1/SpaceStationController.cs renamed to src/Helldivers-2-API/Controllers/V2/SpaceStationController.cs

@@ -1,8 +1,8 @@
 using Helldivers.Core.Contracts.Collections;
-using Helldivers.Models.V1;
+using Helldivers.Models.V2;
 using Microsoft.AspNetCore.Mvc;
 
-namespace Helldivers.API.Controllers.V1;
+namespace Helldivers.API.Controllers.V2;
 
 /// <summary>
 /// Contains API endpoints for <see cref="SpaceStation" />.
@@ -13,8 +13,9 @@ public static class SpaceStationController
     /// Fetches a list of all available <see cref="SpaceStation" /> information available.
     /// </summary>
     [ProducesResponseType<List<SpaceStation>>(StatusCodes.Status200OK)]
-    public static async Task<IResult> Index(HttpContext context, IStore<SpaceStation, int> store)
+    public static async Task<IResult> Index(HttpContext context, IStore<SpaceStation, long> store)
     {
+        // TODO: check implementation.
         var stations = await store.AllAsync(context.RequestAborted);
 
         return Results.Ok(stations);
@@ -24,7 +25,7 @@ public static async Task<IResult> Index(HttpContext context, IStore<SpaceStation
     /// Fetches a specific <see cref="SpaceStation" /> identified by <paramref name="index" />.
     /// </summary>
     [ProducesResponseType<SpaceStation>(StatusCodes.Status200OK)]
-    public static async Task<IResult> Show(HttpContext context, IStore<SpaceStation, int> store, [FromRoute] int index)
+    public static async Task<IResult> Show(HttpContext context, IStore<SpaceStation, long> store, [FromRoute] long index)
     {
         var station = await store.GetAsync(index, context.RequestAborted);
 

src/Helldivers-2-API/Dockerfile

@@ -7,6 +7,7 @@ RUN apk add --upgrade --no-cache build-base clang zlib-dev
 ARG BUILD_CONFIGURATION=Release
 ARG BUILD_RUNTIME=linux-musl-x64
 ARG OPENAPI=false
+ARG VERSION=0.0.0
 
 WORKDIR /
 COPY ./docs/openapi /docs/openapi
@@ -26,15 +27,15 @@ WORKDIR "/src/Helldivers-2-API"
 RUN if [[ "${OPENAPI}" = 'true' ]]; \
   then \
     echo "OPENAPI is set to ${OPENAPI}, running OpenAPI generators" \
-    && dotnet build "Helldivers-2-API.csproj" --no-restore -c Debug \
+    && dotnet build "Helldivers-2-API.csproj" /p:Version="$VERSION" --no-restore -c Debug \
     && mkdir -p wwwroot \
     && cp /docs/openapi/* wwwroot/ \
   ; fi
 RUN dotnet build "Helldivers-2-API.csproj" --no-restore -r $BUILD_RUNTIME -c $BUILD_CONFIGURATION -o /app/build
 
 FROM build AS publish
 ARG BUILD_CONFIGURATION=Release
-RUN dotnet publish "Helldivers-2-API.csproj" --no-restore --self-contained -r $BUILD_RUNTIME -c $BUILD_CONFIGURATION -o /app/publish
+RUN dotnet publish "Helldivers-2-API.csproj" /p:Version="$VERSION" --no-restore --self-contained -r $BUILD_RUNTIME -c $BUILD_CONFIGURATION -o /app/publish
 
 FROM base AS final
 WORKDIR /app

src/Helldivers-2-API/Helldivers-2-API.csproj

@@ -36,12 +36,12 @@
 
     <!-- Only include swagger dependencies in DEBUG builds -->
     <ItemGroup Condition="'$(Configuration)' == 'Debug'">
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
-        <PackageReference Include="Microsoft.Extensions.ApiDescription.Server" Version="9.0.0">
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.6" />
+        <PackageReference Include="Microsoft.Extensions.ApiDescription.Server" Version="9.0.6">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="NSwag.AspNetCore" Version="14.1.0" />
+        <PackageReference Include="NSwag.AspNetCore" Version="14.4.0" />
     </ItemGroup>
 
 </Project>

src/Helldivers-2-API/Middlewares/EtagMiddleware.cs

@@ -0,0 +1,42 @@
+using Helldivers.Sync.Hosted;
+using System.Globalization;
+
+namespace Helldivers.API.Middlewares;
+
+/// <summary>
+/// Automatically appends the `Etag` header to responses.
+/// </summary>
+public sealed class EtagMiddleware(ArrowHeadSyncService arrowHead) : IMiddleware
+{
+    /// <inheritdoc />
+    public async Task InvokeAsync(HttpContext context, RequestDelegate next)
+    {
+        if (arrowHead.LastUpdated is { } lastUpdated)
+        {
+            var key = $"{lastUpdated.Subtract(DateTime.UnixEpoch).TotalMilliseconds:0}";
+            context.Response.Headers.ETag = key;
+
+            var isModifiedSince = context.Request.Headers.IfModifiedSince.Any(value =>
+            {
+                if (DateTime.TryParseExact(value, "R", CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal,
+                        out var date))
+                {
+                    if (date >= lastUpdated)
+                    {
+                        return false;
+                    }
+                }
+
+                return true;
+            }) || context.Request.Headers.IfModifiedSince.Count == 0;
+
+            if (isModifiedSince is false)
+            {
+                context.Response.StatusCode = StatusCodes.Status304NotModified;
+                return;
+            }
+        }
+
+        await next(context);
+    }
+}