acdream/tests/AcDream.App.Tests/Rendering/RetailPViewPassExecutorTests.cs

using System.Reflection;
using System.Reflection.Emit;
using AcDream.App.Composition;
using AcDream.App.Rendering;
using AcDream.App.Rendering.Sky;
using AcDream.App.Rendering.Walk;
using AcDream.App.Tests.Architecture;

namespace AcDream.App.Tests.Rendering;

public sealed class RetailPViewPassExecutorTests
{
    [Fact]
    public void Extracted_contracts_retain_no_window_callbacks_or_visibility_owner()
    {
        Assert.DoesNotContain(
            typeof(RetailPViewFrameInput).GetProperties(),
            property => typeof(Delegate).IsAssignableFrom(property.PropertyType));

        FieldInfo[] fields = typeof(RetailPViewPassExecutor).GetFields(
            BindingFlags.Instance | BindingFlags.NonPublic);
        Assert.DoesNotContain(fields, field => field.FieldType == typeof(GameWindow));
        Assert.DoesNotContain(fields, field => field.FieldType == typeof(CellVisibility));
        Assert.DoesNotContain(fields, field => field.FieldType == typeof(RetailPViewFrameInput));
        Assert.DoesNotContain(fields, field => field.FieldType == typeof(RetailPViewFrameResult));
        Assert.DoesNotContain(fields, field => field.FieldType == typeof(ClipFrameAssembly));
        Assert.DoesNotContain(
            fields,
            field => typeof(Delegate).IsAssignableFrom(field.FieldType));
    }

    [Fact]
    public void Concrete_executor_accumulates_walk_terrain_batch_timing()
    {
        // S3 chunk 3 fix round 1 (F3): the walk leaf no longer brackets
        // itself with Begin()/Complete() (that stopwatch-restart pair would
        // push one timing SAMPLE per batch, not one per frame) — it times
        // itself with a raw Stopwatch.GetTimestamp() delta and hands the
        // elapsed ticks to AccumulateWalkBatch, which only accumulates.
        MethodInfo landscape = typeof(RetailPViewPassExecutor).GetMethod(
            "DrawWalkLandCellBatch",
            BindingFlags.Instance | BindingFlags.NonPublic)!;
        IReadOnlyList<CompiledCall> landscapeCalls = CompiledCallGraph.Read(landscape);
        int terrainDraw = RequiredCallIndex(
            landscapeCalls,
            typeof(TerrainModernRenderer),
            nameof(TerrainModernRenderer.DrawLandCells));
        int accumulate = RequiredCallIndex(
            landscapeCalls,
            typeof(TerrainDrawDiagnosticsController),
            nameof(TerrainDrawDiagnosticsController.AccumulateWalkBatch));

        Assert.True(terrainDraw < accumulate);
        Assert.DoesNotContain(
            landscapeCalls,
            call => call.Target.DeclaringType == typeof(TerrainDrawDiagnosticsController)
                && call.Target.Name == nameof(TerrainDrawDiagnosticsController.Begin));
        Assert.DoesNotContain(
            landscapeCalls,
            call => call.Target.DeclaringType == typeof(TerrainDrawDiagnosticsController)
                && call.Target.Name == nameof(TerrainDrawDiagnosticsController.Complete));
    }

    [Fact]
    public void Concrete_executor_pushes_the_walk_terrain_frame_sample_at_replay_end()
    {
        // S3 chunk 3 fix round 1 (F3): DrawWalkDrivenStatics is the ONE call
        // site of driver.Replay in production — CompleteWalkTerrainFrame
        // must run immediately after it, so the frame's sample is pushed
        // exactly once, at "the end of the walk replay".
        MethodInfo drawWalkDrivenStatics = typeof(RetailPViewRenderer).GetMethod(
            "DrawWalkDrivenStatics",
            BindingFlags.Instance | BindingFlags.NonPublic)!;
        IReadOnlyList<CompiledCall> calls = CompiledCallGraph.Read(drawWalkDrivenStatics);
        int replay = RequiredCallIndex(
            calls,
            typeof(AcDream.App.Rendering.Walk.WalkFrameDriver),
            nameof(AcDream.App.Rendering.Walk.WalkFrameDriver.Replay));
        int completeWalkFrame = RequiredCallIndex(
            calls,
            typeof(RetailPViewPassExecutor),
            nameof(RetailPViewPassExecutor.CompleteWalkTerrainFrame));

        Assert.True(replay < completeWalkFrame);
    }

    [Fact]
    public void Frame_composition_constructs_one_walk_executor()
    {
        MethodInfo compose = typeof(FrameRootCompositionPhase).GetMethod(
            "ComposeCore",
            BindingFlags.Instance | BindingFlags.NonPublic)!;
        IReadOnlyList<CompiledCall> calls = CompiledCallGraph.Read(compose);

        int executor = RequiredCallIndex(
            calls,
            typeof(RetailPViewPassExecutor),
            ".ctor");
        int renderer = RequiredCallIndex(
            calls,
            typeof(WorldScenePViewRenderer),
            ".ctor");

        Assert.True(executor < renderer);
        Assert.Single(
            calls,
            call => call.Target.DeclaringType == typeof(RetailPViewPassExecutor)
                && call.Target.Name == ".ctor");
        Assert.Single(
            calls,
            call => call.Target.DeclaringType == typeof(WorldScenePViewRenderer)
                && call.Target.Name == ".ctor");
    }

    /// <summary>
    /// S3 chunk 1 fix round 2 (§11.6 H1): the weather MESH draw + its OC
    /// print moved OUT of <see cref="RetailPViewPassExecutor.DrawWeatherOnce"/>
    /// entirely — S3 chunk 4 (O3) relocated the print to
    /// <c>WalkFrameDriver.OnWeatherTurn</c>, fired at Collect time by
    /// <c>RetailFrameWalk.DrawLandscape</c> (see the real transcript pins in
    /// <c>WalkFrameDriverTranscriptTests</c>: <c>Collect_OutdoorRoot_...</c>
    /// and <c>Collect_InteriorRoot_...</c>). This method now draws the
    /// weather MESH and the rain PARTICLES only — the former per-outside-
    /// view-slice loop that used to run before this call (the walk's own
    /// screen-space terrain-clip writer + <c>ClearClipRouting</c> + the old
    /// <c>DrawLandscapeSliceLate</c> leaf) is deleted outright (§10.2): retail
    /// draws the weather mesh and its
    /// rain particles ONCE, unclipped, never once per doorway aperture.
    /// MUTATION: re-inlining a
    /// <c>WalkTranscriptDump.PrintObjectCellTurn</c> call back into this
    /// method makes the <c>Assert.DoesNotContain</c> below fail; deleting
    /// either the mesh or the particle call makes the matching
    /// <c>Assert.Single</c> fail (zero matches instead of one).
    /// </summary>
    [Fact]
    public void DrawWeatherOnce_DrawsTheWeatherMeshAndParticlesButNeverPrints()
    {
        MethodInfo method = typeof(RetailPViewPassExecutor).GetMethod(
            nameof(RetailPViewPassExecutor.DrawWeatherOnce),
            BindingFlags.Instance | BindingFlags.Public)!;
        IReadOnlyList<CompiledCall> calls = CompiledCallGraph.Read(method);

        Assert.Single(
            calls,
            call => call.Target.DeclaringType == typeof(SkyRenderer)
                && call.Target.Name == nameof(SkyRenderer.RenderWeather));
        Assert.Single(
            calls,
            call => call.Target.DeclaringType == typeof(ParticleRenderer)
                && call.Target.Name == nameof(ParticleRenderer.Draw));
        Assert.DoesNotContain(
            calls,
            call => call.Target.DeclaringType == typeof(WalkTranscriptDump));
    }

    /// <summary>
    /// S3 chunk 4 (§10.2): the former per-outside-view-slice loop
    /// (the walk's own screen-space terrain-clip writer +
    /// <c>ClearClipRouting</c> + the old <c>DrawLandscapeSliceLate</c> leaf,
    /// one call per active landscape view) is deleted — <c>DrawLandscapeDynamicsPhase</c> now calls
    /// <see cref="RetailPViewPassExecutor.DrawWeatherOnce"/> exactly once,
    /// conditional on <see cref="AcDream.App.Rendering.Walk.WalkFrameDriver.WeatherTurnFired"/>
    /// (see <see cref="DrawLandscapeDynamicsPhase_GatesDrawWeatherOnceOnWalkDriverWeatherTurnFired"/>
    /// — the L1 pin), with no loop of any kind around it. This
    /// <c>Assert.Single</c> alone proved insufficient at fix round 1 (K1):
    /// it counts DISTINCT call-site offsets, so it stays green even with a
    /// <c>foreach</c> wrapped around the one call site (the exact round-1
    /// regression this file's review caught) — see
    /// <see cref="DrawLandscapeDynamicsPhase_DrawWeatherOnceCallSiteHasNoEnclosingBackwardBranch"/>
    /// for the pin that actually rules that out. Kept as a cheap first-line
    /// check: MUTATION: adding a second, textually distinct call site (e.g.
    /// a duplicated call, not a loop) makes <c>Assert.Single</c> fail.
    /// </summary>
    [Fact]
    public void DrawLandscapeDynamicsPhase_CallsDrawWeatherOnceExactlyOnce()
    {
        MethodInfo method = typeof(RetailPViewRenderer).GetMethod(
            "DrawLandscapeDynamicsPhase",
            BindingFlags.Instance | BindingFlags.NonPublic)!;
        IReadOnlyList<CompiledCall> calls = CompiledCallGraph.Read(method);

        Assert.Single(
            calls,
            call => call.Target.DeclaringType == typeof(RetailPViewPassExecutor)
                && call.Target.Name == nameof(RetailPViewPassExecutor.DrawWeatherOnce));
    }

    /// <summary>
    /// S3 chunk 4 fix round 1 (K1, blocking): the real loop-shape pin.
    /// <see cref="DrawLandscapeDynamicsPhase_CallsDrawWeatherOnceExactlyOnce"/>'s
    /// <c>Assert.Single</c> over call-site offsets still passes when the ONE
    /// call site sits inside a <c>foreach</c> — an IL-offset ORDER pin has
    /// now failed three times to be discriminating for this exact class of
    /// regression, so this asks the LOOP-SHAPE question directly: does any
    /// BACKWARD branch (a branch whose target offset is lower than its own
    /// offset — the shape every C# loop compiles to, whether
    /// <c>for</c>/<c>foreach</c>/<c>while</c>) enclose the
    /// <c>DrawWeatherOnce</c> call's own IL offset? A call sitting strictly
    /// between a backward branch's target and its own offset is inside that
    /// loop's body and can run more than once per method invocation; a call
    /// outside every backward branch's span cannot. MUTATION: wrap the call
    /// in <c>foreach (var slice in clipAssembly.OutsideViewSlices)</c> —
    /// the compiled <c>foreach</c> emits a backward branch (the
    /// condition-check jump back to the loop body) whose span now contains
    /// the call's offset, so this test fails; restore the single
    /// unconditional call to make it pass again. Note for reviewers (added
    /// at S3 landing hygiene, H4, matching <see cref="DrawWalkSky_RenderSkyCallSiteHasNoEnclosingBackwardBranch"/>'s
    /// own note): <see cref="CompiledCallGraph.ReadBranches"/> reads only
    /// <c>br</c>/<c>brtrue</c>/<c>brfalse</c>-family single-target branches —
    /// it does not decode a compiled <c>switch</c> jump table, but no C# loop
    /// construct (<c>for</c>/<c>foreach</c>/<c>while</c>/<c>do</c>) ever
    /// compiles to one, so this pin's blind spot is not a loop shape it
    /// could miss.
    /// </summary>
    [Fact]
    public void DrawLandscapeDynamicsPhase_DrawWeatherOnceCallSiteHasNoEnclosingBackwardBranch()
    {
        MethodInfo method = typeof(RetailPViewRenderer).GetMethod(
            "DrawLandscapeDynamicsPhase",
            BindingFlags.Instance | BindingFlags.NonPublic)!;
        IReadOnlyList<CompiledCall> calls = CompiledCallGraph.Read(method);
        int callIndex = RequiredCallIndex(
            calls,
            typeof(RetailPViewPassExecutor),
            nameof(RetailPViewPassExecutor.DrawWeatherOnce));
        int callOffset = calls[callIndex].Offset;

        IReadOnlyList<CompiledBranch> branches = CompiledCallGraph.ReadBranches(method);
        Assert.DoesNotContain(
            branches,
            branch => branch.TargetOffset < branch.Offset
                && branch.TargetOffset <= callOffset
                && callOffset < branch.Offset);
    }

    /// <summary>
    /// S3 chunk 4 fix round 2 (L1, BLOCKING). Round 1's three-lens review
    /// found that neither existing pin above actually looks at the
    /// production CONDITION gating <c>DrawWeatherOnce</c>: restoring the
    /// pre-fix gate <c>if (clipAssembly.OutsideViewSlices.Length != 0)</c> —
    /// the exact regression K2 was supposed to close — leaves both green,
    /// because both only ask "is the call site shaped correctly", never
    /// "does the call site read <c>WalkFrameDriver.WeatherTurnFired</c>".
    /// This pin reads the compiled condition directly: with <c>c</c> the
    /// index of the <c>DrawWeatherOnce</c> call, (a) <c>calls[c-1]</c> must
    /// be the <c>WeatherTurnFired</c> getter — the LAST call before the draw
    /// — and (b) exactly one branch must sit strictly between that getter
    /// call and the draw call, be a <c>brfalse</c>/<c>brfalse.s</c>, and
    /// jump FORWARD past the draw call — the compiled shape of
    /// <c>if (walkDriver.WeatherTurnFired) passes.DrawWeatherOnce(ctx);</c>
    /// and nothing else (an inverted test, an unconditional call, or a
    /// different condition entirely all fail one of the two checks).
    /// MUTATION M1 (restores the pre-fix regression): change the gate back
    /// to <c>if (clipAssembly.OutsideViewSlices.Length != 0)</c> — check (a)
    /// fails because <c>calls[c-1]</c> is no longer the
    /// <c>WeatherTurnFired</c> getter. MUTATION M2 (drops the gate
    /// entirely): make the call unconditional — check (b) fails because no
    /// branch sits between the getter call and the draw call (in fact the
    /// getter call itself disappears with the gate, so check (a) fails
    /// first). MUTATION M3 (inverts the condition): change the gate to
    /// <c>if (!walkDriver.WeatherTurnFired)</c> — <c>calls[c-1]</c> is still
    /// the getter (check (a) passes), but the compiler emits a
    /// <c>brtrue</c>/<c>brtrue.s</c> to skip the draw instead of a
    /// <c>brfalse</c>/<c>brfalse.s</c>, so check (b)'s opcode filter finds
    /// nothing and <c>Assert.Single</c> fails on zero matches.
    /// </summary>
    [Fact]
    public void DrawLandscapeDynamicsPhase_GatesDrawWeatherOnceOnWalkDriverWeatherTurnFired()
    {
        MethodInfo method = typeof(RetailPViewRenderer).GetMethod(
            "DrawLandscapeDynamicsPhase",
            BindingFlags.Instance | BindingFlags.NonPublic)!;
        IReadOnlyList<CompiledCall> calls = CompiledCallGraph.Read(method);
        int callIndex = RequiredCallIndex(
            calls,
            typeof(RetailPViewPassExecutor),
            nameof(RetailPViewPassExecutor.DrawWeatherOnce));
        Assert.True(callIndex > 0, "Expected a call before DrawWeatherOnce — the gate condition.");

        CompiledCall condition = calls[callIndex - 1];
        Assert.Equal(typeof(AcDream.App.Rendering.Walk.WalkFrameDriver), condition.Target.DeclaringType);
        Assert.Equal("get_WeatherTurnFired", condition.Target.Name);

        int conditionOffset = condition.Offset;
        int drawOffset = calls[callIndex].Offset;
        IReadOnlyList<CompiledBranch> branches = CompiledCallGraph.ReadBranches(method);
        Assert.Single(
            branches,
            branch => branch.Offset > conditionOffset
                && branch.Offset < drawOffset
                && (branch.OpCode == OpCodes.Brfalse || branch.OpCode == OpCodes.Brfalse_S)
                && branch.TargetOffset > drawOffset);
    }

    /// <summary>
    /// S3 landing hygiene (H5): strengthens the L1 pin above against a
    /// conjoined gate the post-hoc three-lens review found it does not
    /// reject. L1's check (b) only looks at branches STRICTLY BETWEEN the
    /// <c>WeatherTurnFired</c> getter call and the <c>DrawWeatherOnce</c>
    /// call — so <c>if (clipAssembly.OutsideViewSlices.Length != 0 &amp;&amp;
    /// walkDriver.WeatherTurnFired) passes.DrawWeatherOnce(ctx);</c> still
    /// passes it: the compiler evaluates <c>OutsideViewSlices.Length != 0</c>
    /// FIRST, so ITS OWN <c>brfalse</c> lands BEFORE the getter call's
    /// offset — outside L1's window — while <c>calls[c-1]</c> is still the
    /// getter (the added condition reads <c>OutsideViewSlices</c>, a
    /// property getter, then <c>.Length</c>, a non-call <c>ldlen</c>, so no
    /// OTHER call intervenes before the getter). This pin widens the window
    /// to start at the call immediately before the whole gate —
    /// <see cref="RetailPViewPassExecutor.DrawUnattachedSceneParticles"/>,
    /// the outdoor-emitters call the method's own comment names as the last
    /// call before the gate — and counts EVERY branch in that wider window
    /// with <c>Assert.Single</c>: production has exactly one, the forward
    /// <c>brfalse</c>/<c>brfalse.s</c> right after the getter. A conjoined
    /// gate's extra, earlier condition adds a second branch this wider
    /// window catches but L1's narrower one cannot.
    /// MUTATION: change the gate to <c>if
    /// (clipAssembly.OutsideViewSlices.Length != 0 &amp;&amp;
    /// walkDriver.WeatherTurnFired)</c> — the branch count in the window
    /// goes from 1 to 2 and <c>Assert.Single</c> fails (see the commit body
    /// for the exact recorded failure text).
    /// </summary>
    [Fact]
    public void DrawLandscapeDynamicsPhase_ExactlyOneBranchGuardsDrawWeatherOnce()
    {
        MethodInfo method = typeof(RetailPViewRenderer).GetMethod(
            "DrawLandscapeDynamicsPhase",
            BindingFlags.Instance | BindingFlags.NonPublic)!;
        IReadOnlyList<CompiledCall> calls = CompiledCallGraph.Read(method);
        int particlesIndex = RequiredCallIndex(
            calls,
            typeof(RetailPViewPassExecutor),
            nameof(RetailPViewPassExecutor.DrawUnattachedSceneParticles));
        int drawIndex = RequiredCallIndex(
            calls,
            typeof(RetailPViewPassExecutor),
            nameof(RetailPViewPassExecutor.DrawWeatherOnce));
        int particlesOffset = calls[particlesIndex].Offset;
        int drawOffset = calls[drawIndex].Offset;

        IReadOnlyList<CompiledBranch> branches = CompiledCallGraph.ReadBranches(method);
        CompiledBranch onlyGuard = Assert.Single(
            branches,
            branch => branch.Offset > particlesOffset && branch.Offset < drawOffset);

        Assert.True(
            onlyGuard.OpCode == OpCodes.Brfalse || onlyGuard.OpCode == OpCodes.Brfalse_S,
            $"Expected the sole branch between DrawUnattachedSceneParticles and "
            + $"DrawWeatherOnce to be a brfalse, was {onlyGuard.OpCode}.");
        Assert.True(
            onlyGuard.TargetOffset > drawOffset,
            "Expected the guard branch to skip forward past DrawWeatherOnce.");
    }

    /// <summary>
    /// S3 chunk 4 fix round 2 (L8): the identical loop-shape question K1
    /// asked of <see cref="RetailPViewPassExecutor.DrawWeatherOnce"/>'s call
    /// site, applied to <see cref="RetailPViewPassExecutor.DrawWalkSky"/>'s
    /// own <see cref="SkyRenderer.RenderSky"/> call — retail draws the sky
    /// dome exactly once per frame too (K4's own doc comment on
    /// <c>DrawWalkSky</c>), so nothing may wrap this call in a loop either.
    /// Note for reviewers: <see cref="CompiledCallGraph.ReadBranches"/> reads
    /// only <c>br</c>/<c>brtrue</c>/<c>brfalse</c>-family single-target
    /// branches — it does not decode a compiled <c>switch</c> jump table,
    /// but no C# loop construct (<c>for</c>/<c>foreach</c>/<c>while</c>/
    /// <c>do</c>) ever compiles to one, so this pin's blind spot is not a
    /// loop shape it could miss. MUTATION: wrapping the call in
    /// <c>for (int i = 0; i &lt; 2; i++) { _sky?.RenderSky(...); }</c> makes
    /// this fail; restoring the single unconditional call makes it pass
    /// again.
    /// </summary>
    [Fact]
    public void DrawWalkSky_RenderSkyCallSiteHasNoEnclosingBackwardBranch()
    {
        MethodInfo method = typeof(RetailPViewPassExecutor).GetMethod(
            "DrawWalkSky",
            BindingFlags.Instance | BindingFlags.NonPublic)!;
        IReadOnlyList<CompiledCall> calls = CompiledCallGraph.Read(method);
        int callIndex = RequiredCallIndex(
            calls,
            typeof(SkyRenderer),
            nameof(SkyRenderer.RenderSky));
        int callOffset = calls[callIndex].Offset;

        IReadOnlyList<CompiledBranch> branches = CompiledCallGraph.ReadBranches(method);
        Assert.DoesNotContain(
            branches,
            branch => branch.TargetOffset < branch.Offset
                && branch.TargetOffset <= callOffset
                && callOffset < branch.Offset);
    }

    /// <summary>
    /// S3 chunk 1 fix round 2 (§11.6 H1): <see
    /// cref="RetailPViewPassExecutor.ShouldDrawWeatherOnce"/> is
    /// <see cref="DrawWeatherOnce_DrawsTheWeatherMeshAndPrintsExactlyOnce"/>'s
    /// gate, extracted as a pure predicate so this suite can pin "no OC line
    /// while the player stands indoors" without a live GL/DAT
    /// <see cref="SkyRenderer"/> — combined with the two structural tests
    /// above (moved out of the loop; drawn/printed exactly once per call),
    /// this proves both halves of the spec's pin: an outdoor root (or an
    /// interior root with several exit-view slices) prints exactly one OC
    /// line, and an indoor player prints none. Retail's own check:
    /// <c>SmartBox::is_player_outside</c> @0x00451e80,
    /// <c>(player objcell_id &amp; 0xFFFF) &lt; 0x100</c>. MUTATION: negating
    /// the <c>&lt; 0x100</c> comparison (or dropping either bool AND) makes
    /// one of the four rows below fail.
    /// </summary>
    [Theory]
    [InlineData(true, true, 0xF4180003u, true)]    // outdoor root, player outside a land cell -> draws
    [InlineData(true, true, 0xA9B40100u, false)]   // player indoors (local id >= 0x100) -> no draw
    [InlineData(false, true, 0xF4180003u, false)]  // RenderSky off -> no draw
    [InlineData(true, false, 0xF4180003u, false)]  // RenderWeather off -> no draw
    public void ShouldDrawWeatherOnce_MatchesRetailIsPlayerOutsideGate(
        bool renderSky, bool renderWeather, uint playerCellId, bool expected)
    {
        Assert.Equal(
            expected,
            RetailPViewPassExecutor.ShouldDrawWeatherOnce(renderSky, renderWeather, playerCellId));
    }

    private static int RequiredCallIndex(
        IReadOnlyList<CompiledCall> calls,
        Type declaringType,
        string methodName)
    {
        int index = CompiledCallGraph.IndexOf(calls, declaringType, methodName);
        Assert.True(
            index >= 0,
            $"Expected call to {declaringType.Name}.{methodName}.");
        return index;
    }
}