Add flag to allow backwards seeks in tests

peppy · peppy · commit e7788325c967 · 2024-03-02T02:42:55.000+08:00
diff --git a/osu.Game.Rulesets.Mania.Tests/TestSceneTimingBasedNoteColouring.cs b/osu.Game.Rulesets.Mania.Tests/TestSceneTimingBasedNoteColouring.cs
@@ -34,16 +34,21 @@ public partial class TestSceneTimingBasedNoteColouring : OsuTestScene
         [SetUpSteps]
         public void SetUpSteps()
         {
-            AddStep("setup hierarchy", () => Child = new Container
+            AddStep("setup hierarchy", () =>
             {
-                Clock = new FramedClock(clock = new ManualClock()),
-                RelativeSizeAxes = Axes.Both,
-                Anchor = Anchor.Centre,
-                Origin = Anchor.Centre,
-                Children = new[]
+                Child = new Container
                 {
-                    drawableRuleset = (DrawableManiaRuleset)Ruleset.Value.CreateInstance().CreateDrawableRulesetWith(createTestBeatmap())
-                }
+                    Clock = new FramedClock(clock = new ManualClock()),
+                    RelativeSizeAxes = Axes.Both,
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre,
+                    Children = new[]
+                    {
+                        drawableRuleset = (DrawableManiaRuleset)Ruleset.Value.CreateInstance().CreateDrawableRulesetWith(createTestBeatmap())
+                    }
+                };
+
+                drawableRuleset.AllowBackwardsSeeks = true;
             });
             AddStep("retrieve config bindable", () =>
             {
diff --git a/osu.Game.Tests/NonVisual/FirstAvailableHitWindowsTest.cs b/osu.Game.Tests/NonVisual/FirstAvailableHitWindowsTest.cs
@@ -100,6 +100,7 @@ public override event Action<JudgementResult> RevertResult
             public override Container FrameStableComponents { get; }
             public override IFrameStableClock FrameStableClock { get; }
             internal override bool FrameStablePlayback { get; set; }
+            public override bool AllowBackwardsSeeks { get; set; }
             public override IReadOnlyList<Mod> Mods { get; }
 
             public override double GameplayStartTime { get; }
diff --git a/osu.Game.Tests/Visual/Gameplay/TestSceneCompletionCancellation.cs b/osu.Game.Tests/Visual/Gameplay/TestSceneCompletionCancellation.cs
@@ -29,6 +29,8 @@ public partial class TestSceneCompletionCancellation : OsuPlayerTestScene
 
         protected override bool AllowFail => false;
 
+        protected override bool AllowBackwardsSeeks => true;
+
         [SetUpSteps]
         public override void SetUpSteps()
         {
diff --git a/osu.Game.Tests/Visual/Gameplay/TestSceneFrameStabilityContainer.cs b/osu.Game.Tests/Visual/Gameplay/TestSceneFrameStabilityContainer.cs
@@ -131,6 +131,9 @@ public void TestRatePreservedWhenTimeNotProgressing()
 
         private void createStabilityContainer(double gameplayStartTime = double.MinValue) => AddStep("create container", () =>
             mainContainer.Child = new FrameStabilityContainer(gameplayStartTime)
+                {
+                    AllowBackwardsSeeks = true,
+                }
                 .WithChild(consumer = new ClockConsumingChild()));
 
         private void seekManualTo(double time) => AddStep($"seek manual clock to {time}", () => manualClock.CurrentTime = time);
diff --git a/osu.Game.Tests/Visual/Gameplay/TestSceneGameplaySamplePlayback.cs b/osu.Game.Tests/Visual/Gameplay/TestSceneGameplaySamplePlayback.cs
@@ -16,6 +16,8 @@ namespace osu.Game.Tests.Visual.Gameplay
 {
     public partial class TestSceneGameplaySamplePlayback : PlayerTestScene
     {
+        protected override bool AllowBackwardsSeeks => true;
+
         [Test]
         public void TestAllSamplesStopDuringSeek()
         {
diff --git a/osu.Game.Tests/Visual/Gameplay/TestSceneGameplaySampleTriggerSource.cs b/osu.Game.Tests/Visual/Gameplay/TestSceneGameplaySampleTriggerSource.cs
@@ -28,6 +28,8 @@ namespace osu.Game.Tests.Visual.Gameplay
 {
     public partial class TestSceneGameplaySampleTriggerSource : PlayerTestScene
     {
+        protected override bool AllowBackwardsSeeks => true;
+
         private TestGameplaySampleTriggerSource sampleTriggerSource = null!;
         protected override Ruleset CreatePlayerRuleset() => new OsuRuleset();
 
diff --git a/osu.Game.Tests/Visual/Gameplay/TestSceneHitErrorMeter.cs b/osu.Game.Tests/Visual/Gameplay/TestSceneHitErrorMeter.cs
@@ -288,6 +288,7 @@ public override event Action<JudgementResult> RevertResult
             public override Container FrameStableComponents { get; }
             public override IFrameStableClock FrameStableClock { get; }
             internal override bool FrameStablePlayback { get; set; }
+            public override bool AllowBackwardsSeeks { get; set; }
             public override IReadOnlyList<Mod> Mods { get; }
 
             public override double GameplayStartTime { get; }
diff --git a/osu.Game.Tests/Visual/Gameplay/TestScenePoolingRuleset.cs b/osu.Game.Tests/Visual/Gameplay/TestScenePoolingRuleset.cs
@@ -269,6 +269,7 @@ private void createTest(IBeatmap beatmap, int poolSize, Func<IFrameBasedClock> c
 
                 drawableRuleset = (TestDrawablePoolingRuleset)ruleset.CreateDrawableRulesetWith(CreateWorkingBeatmap(beatmap).GetPlayableBeatmap(ruleset.RulesetInfo));
                 drawableRuleset.FrameStablePlayback = true;
+                drawableRuleset.AllowBackwardsSeeks = true;
                 drawableRuleset.PoolSize = poolSize;
 
                 Child = new Container
diff --git a/osu.Game.Tests/Visual/Gameplay/TestSceneStoryboardWithOutro.cs b/osu.Game.Tests/Visual/Gameplay/TestSceneStoryboardWithOutro.cs
@@ -31,6 +31,8 @@ public partial class TestSceneStoryboardWithOutro : PlayerTestScene
     {
         protected override bool HasCustomSteps => true;
 
+        protected override bool AllowBackwardsSeeks => true;
+
         protected new OutroPlayer Player => (OutroPlayer)base.Player;
 
         private double currentBeatmapDuration;
diff --git a/osu.Game/Rulesets/UI/DrawableRuleset.cs b/osu.Game/Rulesets/UI/DrawableRuleset.cs
@@ -81,6 +81,19 @@ public abstract partial class DrawableRuleset<TObject> : DrawableRuleset, IProvi
 
         public override IFrameStableClock FrameStableClock => frameStabilityContainer;
 
+        private bool allowBackwardsSeeks;
+
+        public override bool AllowBackwardsSeeks
+        {
+            get => allowBackwardsSeeks;
+            set
+            {
+                allowBackwardsSeeks = value;
+                if (frameStabilityContainer != null)
+                    frameStabilityContainer.AllowBackwardsSeeks = value;
+            }
+        }
+
         private bool frameStablePlayback = true;
 
         internal override bool FrameStablePlayback
@@ -178,6 +191,7 @@ private void load(CancellationToken? cancellationToken)
             InternalChild = frameStabilityContainer = new FrameStabilityContainer(GameplayStartTime)
             {
                 FrameStablePlayback = FrameStablePlayback,
+                AllowBackwardsSeeks = AllowBackwardsSeeks,
                 Children = new Drawable[]
                 {
                     FrameStableComponents,
@@ -463,6 +477,12 @@ public abstract partial class DrawableRuleset : CompositeDrawable
         /// </summary>
         internal abstract bool FrameStablePlayback { get; set; }
 
+        /// <summary>
+        /// When a replay is not attached, we usually block any backwards seeks.
+        /// This will bypass the check. Should only be used for tests.
+        /// </summary>
+        public abstract bool AllowBackwardsSeeks { get; set; }
+
         /// <summary>
         /// The mods which are to be applied.
         /// </summary>
diff --git a/osu.Game/Rulesets/UI/FrameStabilityContainer.cs b/osu.Game/Rulesets/UI/FrameStabilityContainer.cs
@@ -6,7 +6,6 @@
 using osu.Framework.Allocation;
 using osu.Framework.Audio;
 using osu.Framework.Bindables;
-using osu.Framework.Development;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Logging;
@@ -26,6 +25,8 @@ public sealed partial class FrameStabilityContainer : Container, IHasReplayHandl
     {
         public ReplayInputHandler? ReplayInputHandler { get; set; }
 
+        public bool AllowBackwardsSeeks { get; set; }
+
         /// <summary>
         /// The number of CPU milliseconds to spend at most during seek catch-up.
         /// </summary>
@@ -157,7 +158,7 @@ private void updateClock()
             //
             // It basically says that "while we're running in frame stable mode, and don't have a replay attached,
             // time should never go backwards". If it does, we stop running gameplay until it returns to normal.
-            if (!hasReplayAttached && FrameStablePlayback && proposedTime > referenceClock.CurrentTime && !DebugUtils.IsNUnitRunning)
+            if (!hasReplayAttached && FrameStablePlayback && proposedTime > referenceClock.CurrentTime && !AllowBackwardsSeeks)
             {
                 Logger.Log($"Denying backwards seek during gameplay (reference: {referenceClock.CurrentTime:N2} stable: {proposedTime:N2})");
                 state = PlaybackState.NotValid;
diff --git a/osu.Game/Tests/Visual/PlayerTestScene.cs b/osu.Game/Tests/Visual/PlayerTestScene.cs
@@ -70,10 +70,20 @@ protected void CreateTest([CanBeNull] Action action = null)
 
             AddStep($"Load player for {CreatePlayerRuleset().Description}", LoadPlayer);
             AddUntilStep("player loaded", () => Player.IsLoaded && Player.Alpha == 1);
+
+            if (AllowBackwardsSeeks)
+            {
+                AddStep("allow backwards seeking", () =>
+                {
+                    Player.DrawableRuleset.AllowBackwardsSeeks = AllowBackwardsSeeks;
+                });
+            }
         }
 
         protected virtual bool AllowFail => false;
 
+        protected virtual bool AllowBackwardsSeeks => false;
+
         protected virtual bool Autoplay => false;
 
         protected void LoadPlayer() => LoadPlayer(Array.Empty<Mod>());
@@ -126,6 +136,6 @@ protected override void Dispose(bool isDisposing)
 
         protected sealed override Ruleset CreateRuleset() => CreatePlayerRuleset();
 
-        protected virtual TestPlayer CreatePlayer(Ruleset ruleset) => new TestPlayer(false, false);
+        protected virtual TestPlayer CreatePlayer(Ruleset ruleset) => new TestPlayer(false, false, AllowBackwardsSeeks);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ public partial class TestSceneCompletionCancellation : OsuPlayerTestScene`
`29`	`29`
`30`	`30`	`protected override bool AllowFail => false;`
`31`	`31`
	`32`	`+ protected override bool AllowBackwardsSeeks => true;`
	`33`	`+`
`32`	`34`	`[SetUpSteps]`
`33`	`35`	`public override void SetUpSteps()`
`34`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@ namespace osu.Game.Tests.Visual.Gameplay`
`16`	`16`	`{`
`17`	`17`	`public partial class TestSceneGameplaySamplePlayback : PlayerTestScene`
`18`	`18`	`{`
	`19`	`+ protected override bool AllowBackwardsSeeks => true;`
	`20`	`+`
`19`	`21`	`[Test]`
`20`	`22`	`public void TestAllSamplesStopDuringSeek()`
`21`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@ namespace osu.Game.Tests.Visual.Gameplay`
`28`	`28`	`{`
`29`	`29`	`public partial class TestSceneGameplaySampleTriggerSource : PlayerTestScene`
`30`	`30`	`{`
	`31`	`+ protected override bool AllowBackwardsSeeks => true;`
	`32`	`+`
`31`	`33`	`private TestGameplaySampleTriggerSource sampleTriggerSource = null!;`
`32`	`34`	`protected override Ruleset CreatePlayerRuleset() => new OsuRuleset();`
`33`	`35`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@ public partial class TestSceneStoryboardWithOutro : PlayerTestScene`
`31`	`31`	`{`
`32`	`32`	`protected override bool HasCustomSteps => true;`
`33`	`33`
	`34`	`+ protected override bool AllowBackwardsSeeks => true;`
	`35`	`+`
`34`	`36`	`protected new OutroPlayer Player => (OutroPlayer)base.Player;`
`35`	`37`
`36`	`38`	`private double currentBeatmapDuration;`