fix: fix broken targetTime control for long loading time

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 2.11.1
+* 目標時刻を指定したリプレイ実行がローディングなどにかかる時間の影響を受けている問題を修正
+
 ## 2.11.0
 * @akashic/akashic-engine@3.9.0 に追従
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akashic/game-driver",
-  "version": "2.11.0",
+  "version": "2.11.1",
   "description": "The driver module for the games using Akashic Engine",
   "main": "index.js",
   "typings": "lib/index.d.ts",

src/GameLoop.ts

@@ -47,14 +47,25 @@ export class GameLoop {
 
 	/**
 	 * 時刻。
-	 * 実時間ではなく、プレイ開始日時と経過フレーム数から計算される仮想的な時間であることに注意。
+	 * 実時間ではなく、プレイ開始日時と経過フレーム数から計算される仮想的な時間である。
 	 * この時間情報を元にタイムスタンプイベントの消化待ちを行う。
+	 *
+	 * _crrentTickTime と異なり、ローカルティックを消化している間も進行する。
 	 */
 	_currentTime: number;
 
+	/**
+	 * ゲーム内時刻。
+	 * 実時間ではなく、プレイ開始日時と非ローカルティックの消化状況から計算される仮想的な時間である。
+	 * この時間情報を元に目標時刻への到達判定を行う。
+	 *
+	 * _currentTime と異なり、ローカルティックを消化している間は進行しない。
+	 */
+	_currentTickTime: number;
+
 	/**
 	 * 1フレーム分の時間。FPSの逆数。
-	 * _currentTime の計算に用いる。
+	 * _currentTime, _currentTickTime の計算に用いる。
 	 */
 	_frameTime: number;
 
@@ -127,6 +138,7 @@ export class GameLoop {
 
 	constructor(param: GameLoopParameterObejct) {
 		this._currentTime = param.startedAt;
+		this._currentTickTime = this._currentTime;
 		this._frameTime = 1000 / param.game.fps;
 
 		if (param.errorHandler) {
@@ -215,6 +227,7 @@ export class GameLoop {
 			this._stopSkipping();
 		this._tickBuffer.setCurrentAge(startPoint.frame);
 		this._currentTime = startPoint.timestamp || startPoint.data.timestamp || 0;  // data.timestamp は後方互換性のために存在。現在は使っていない。
+		this._currentTickTime = this._currentTime;
 		this._waitingNextTick = false; // 現在ageを変えた後、さらに後続のTickが足りないかどうかは_onFrameで判断する。
 		this._foundLatestTick = false; // 同上。
 		this._lastRequestedStartPointAge = -1;  // 現在ageを変えた時はリセットしておく(場合によっては不要だが、安全のため)。
@@ -403,7 +416,7 @@ export class GameLoop {
 	_doLocalTick(): void {
 		const game = this._game;
 		const pevs = this._eventBuffer.readLocalEvents();
-		this._currentTime += this._frameTime;
+		this._currentTime += this._frameTime; // ここでは _currenTickTime は進まないことに注意 (ローカルティック消化では進まない)
 		if (pevs) {
 			game.tick(false, Math.floor(this._omittedTickDuration / this._frameTime), pevs);
 		} else {
@@ -423,12 +436,12 @@ export class GameLoop {
 		} else {
 			const givenTargetTime = this._targetTimeFunc();
 			const targetTime = givenTargetTime + this._realTargetTimeOffset;
-			const prevTime = this._currentTime;
+			const prevTickTime = this._currentTickTime;
 			this._onFrameForTimedReplay(targetTime, frameArg);
 			// 目標時刻到達判定: 進めなくなり、あと1フレームで目標時刻を過ぎるタイミングを到達として通知する。
 			// 時間進行を進めていっても目標時刻 "以上" に進むことはないので「過ぎた」タイミングは使えない点に注意。
 			// (また、それでもなお (prevTime <= targetTime) の条件はなくせない点にも注意。巻き戻す時は (prevTime > targetTime) になる)
-			if ((prevTime === this._currentTime) && (prevTime <= targetTime) && (targetTime <= prevTime + this._frameTime))
+			if ((prevTickTime === this._currentTickTime) && (prevTickTime <= targetTime) && this._isImmediateBeforeOf(targetTime))
 				this.rawTargetTimeReachedTrigger.fire(givenTargetTime);
 		}
 	}
@@ -444,12 +457,12 @@ export class GameLoop {
 	_onFrameForTimedReplay(targetTime: number, frameArg: ClockFrameTriggerParameterObject): void {
 		let sceneChanged = false;
 		const game = this._game;
-		const timeGap = targetTime - this._currentTime;
+		const timeGap = targetTime - this._currentTickTime;
 		const frameGap = (timeGap / this._frameTime);
 
 		if ((frameGap > this._jumpTryThreshold || frameGap < 0) &&
 		    (!this._waitingStartPoint) &&
-		    (this._lastRequestedStartPointTime < this._currentTime)) {
+		    (this._lastRequestedStartPointTime < this._currentTickTime)) {
 			// スナップショットを要求だけして続行する(スナップショットが来るまで進める限りは進む)。
 			this._waitingStartPoint = true;
 			this._lastRequestedStartPointTime = targetTime;
@@ -482,7 +495,7 @@ export class GameLoop {
 				}
 				if (this._omitInterpolatedTickOnReplay && this._sceneLocalMode === "interpolate-local") {
 					if (this._foundLatestTick) {
-						// 最新のティックが存在しない場合は現在時刻を目標時刻に合わせる。
+						// これ以上新しいティックが存在しない場合は現在時刻を目標時刻に合わせる。
 						// (_doLocalTick() により現在時刻が this._frameTime 進むのでその直前まで進める)
 						this._currentTime = targetTime - this._frameTime;
 					}
@@ -494,42 +507,37 @@ export class GameLoop {
 				break;
 			}
 
-			let nextTickTime = this._tickBuffer.readNextTickTime();
-			if (nextTickTime == null)
-				nextTickTime = nextFrameTime;
-			if (targetTime < nextFrameTime) {
-				// 次フレームに進むと目標時刻を超過する＝次フレーム時刻までは進めない＝補間ティックは必要ない。
-				if (nextTickTime <= targetTime) {
-					// 特殊ケース: 目標時刻より手前に次ティックがあるので、目標時刻までは進んで次ティックは消化してしまう。
-					// (この処理がないと、特にリプレイで「最後のティックの0.1フレーム時間前」などに来たときに進めなくなってしまう。)
-					nextFrameTime = targetTime;
+			const nextTickTime = this._tickBuffer.readNextTickTime() ?? (this._currentTickTime + this._frameTime);
+
+			if (targetTime <= nextTickTime && targetTime <= nextFrameTime) {
+				// 次ティックを消化すると目標時刻に到達・超過する: 次ティックは消化できない
+				// 次フレーム時刻も目標時刻に到達・超過する: ローカルティック補完も要らない
+				break;
+
+			} else if (nextFrameTime < nextTickTime) {
+				// 次フレーム時刻ではまだ次ティックを消化できない: ローカルティック補完するか、次ティック時刻まで一気に進む
+				if (this._omitInterpolatedTickOnReplay && this._skipping) {
+					// スキップ中、ティック補間不要なら即座に次ティック時刻(かその手前の目標時刻)まで進める。
+					// (_onFrameNormal()の対応箇所と異なり、ここでは「次ティック時刻の "次フレーム時刻"」に切り上げないことに注意。
+					//  時間ベースリプレイでは目標時刻 "以後" には進めないという制約がある。これを単純な実装で守るべく切り上げを断念している)
+					if (targetTime <= nextTickTime) {
+						// 次ティック時刻まで進めると目標時刻を超えてしまう: 目標時刻直前まで動いて抜ける(目標時刻直前までは来ないと目標時刻到達通知が永久にできない)
+						this._omittedTickDuration += targetTime - this._currentTickTime;
+						this._currentTime = Math.floor(targetTime / this._frameTime) * this._frameTime;
+						break;
+					}
+					nextFrameTime = nextTickTime;
+					this._omittedTickDuration += nextTickTime - this._currentTickTime;
 				} else {
-					break;
-				}
-			} else {
-				if (nextFrameTime < nextTickTime) {
-					if (this._omitInterpolatedTickOnReplay && this._skipping) {
-						// スキップ中、ティック補間不要なら即座に次ティック時刻(かその手前の目標時刻)まで進める。
-						// (_onFrameNormal()の対応箇所と異なり、ここでは「次ティック時刻の "次フレーム時刻"」に切り上げないことに注意。
-						//  時間ベースリプレイでは目標時刻 "以後" には進めないという制約がある。これを単純な実装で守るべく切り上げを断念している)
-						if (targetTime <= nextTickTime) {
-							// 次ティック時刻まで進めると目標時刻を超えてしまう: 目標時刻直前まで動いて抜ける(目標時刻直前までは来ないと目標時刻到達通知が永久にできない)
-							this._omittedTickDuration += targetTime - this._currentTime;
-							this._currentTime = Math.floor(targetTime / this._frameTime) * this._frameTime;
-							break;
-						}
-						nextFrameTime = nextTickTime;
-						this._omittedTickDuration += nextTickTime - this._currentTime;
-					} else {
-						if (this._sceneLocalMode === "interpolate-local") {
-							this._doLocalTick();
-						}
-						continue;
+					if (this._sceneLocalMode === "interpolate-local") {
+						this._doLocalTick();
 					}
+					continue;
 				}
 			}
 
 			this._currentTime = nextFrameTime;
+			this._currentTickTime = nextTickTime;
 			const tick = this._tickBuffer.consume();
 			let consumedAge = -1;
 			this._events.length = 0;
@@ -567,7 +575,7 @@ export class GameLoop {
 			}
 		}
 
-		if (this._skipping && (targetTime - this._currentTime < this._frameTime)) {
+		if (this._skipping && (targetTime - this._currentTime < this._frameTime) && this._isImmediateBeforeOf(targetTime)) {
 			this._stopSkipping();
 			// スキップ状態が解除された (≒等倍に戻った) タイミングで改めてすべてのティックを取得し直す
 			this._tickBuffer.dropAll();
@@ -668,7 +676,7 @@ export class GameLoop {
 			// ここでは常に (ageGap > 0) であることに注意。(0の時にskipに入ってもすぐ戻ってしまう)
 			const isTargetNear =
 				(currentAge === 0) && // 余計な関数呼び出しを避けるためにチェック
-				this._tickBuffer.isKnownLatestTickTimeNear(this._skipThresholdTime, this._currentTime, this._frameTime);
+				this._tickBuffer.isKnownLatestTickTimeNear(this._skipThresholdTime, this._currentTickTime, this._frameTime);
 			this._startSkipping(isTargetNear);
 		}
 
@@ -678,13 +686,13 @@ export class GameLoop {
 		for (; consumedFrame < loopCount; ++consumedFrame) {
 			// ティック時刻確認
 			let nextFrameTime = this._currentTime + this._frameTime;
-			const nextTickTime = this._tickBuffer.readNextTickTime();
-			if (nextTickTime != null && nextFrameTime < nextTickTime) {
+			const explicitNextTickTime = this._tickBuffer.readNextTickTime();
+			if (explicitNextTickTime != null && nextFrameTime < explicitNextTickTime) {
 				if (this._loopMode === LoopMode.Realtime || (this._omitInterpolatedTickOnReplay && this._skipping)) {
 					// リアルタイムモード(と早送り中のリプレイでティック補間しない場合)ではティック時刻を気にせず続行するが、
 					// リプレイモードに切り替えた時に矛盾しないよう時刻を補正する(当該ティック時刻まで待った扱いにする)。
-					nextFrameTime = Math.ceil(nextTickTime / this._frameTime) * this._frameTime;
-					this._omittedTickDuration += nextFrameTime - this._currentTime;
+					nextFrameTime = Math.ceil(explicitNextTickTime / this._frameTime) * this._frameTime;
+					this._omittedTickDuration += nextFrameTime - this._currentTickTime;
 				} else {
 					if (this._sceneLocalMode === "interpolate-local") {
 						this._doLocalTick();
@@ -695,6 +703,7 @@ export class GameLoop {
 			}
 
 			this._currentTime = nextFrameTime;
+			this._currentTickTime = explicitNextTickTime ?? (this._currentTickTime + this._frameTime);
 			const tick = this._tickBuffer.consume();
 			let consumedAge = -1;
 			this._events.length = 0;
@@ -786,8 +795,8 @@ export class GameLoop {
 				// 要求した時点と今で目標時刻(targetTime)が変わっている。得られたStartPointでは目標時刻より未来に飛んでしまう。
 				return;
 			}
-			const currentTime = this._currentTime;
-			if (currentTime <= targetTime && startPoint.timestamp < currentTime + (this._jumpIgnoreThreshold * this._frameTime)) {
+			const currentTickTime = this._currentTickTime;
+			if (currentTickTime <= targetTime && startPoint.timestamp < currentTickTime + (this._jumpIgnoreThreshold * this._frameTime)) {
 				// 今の目標時刻(targetTime)は過去でない一方、得られたStartPointは至近未来または過去のもの → 飛ぶ価値なし。
 				return;
 			}
@@ -865,5 +874,14 @@ export class GameLoop {
 		this._waitingNextTick = false;
 		this._clock.rawFrameTrigger.remove(this._onPollingTick, this);
 	}
+
+	_isImmediateBeforeOf(targetTime: number): boolean {
+		// 目標時刻への到達判定。次ティックがない場合は _foundLatestTick に委ねる、
+		// すなわち既存全ティックを消化した時は到達とみなす点に注意。あまり直観的でないが、こうでないと永久に
+		// rawTargetTimeReachedTrigger を fire できない可能性があり、後方互換性に影響がありうる。
+		return this._tickBuffer.hasNextTick() ?
+			(targetTime < (this._tickBuffer.readNextTickTime() ?? (this._currentTickTime + this._frameTime))) :
+			this._foundLatestTick;
+	}
 }
 

src/TickBuffer.ts

@@ -257,7 +257,7 @@ export class TickBuffer {
 	 */
 	isKnownLatestTickTimeNear(timeThreshold: number, baseTime: number, frameTime: number): boolean {
 		// TODO コード整理して baseTime と frameTime の引数をなくす。
-		// 両者は GameLoop#_frameTime, _currentTime にそれぞれ対応している。このクラスがそれらを管理する方が自然。
+		// 両者は GameLoop#_frameTime, _currentTickTime にそれぞれ対応している。このクラスがそれらを管理する方が自然。
 		return this._calcKnownLatestTickTimeDelta(timeThreshold, baseTime, frameTime) < timeThreshold;
 	}
 

src/__tests__/GameLoop.spec.ts

@@ -1035,4 +1035,72 @@ describe("GameLoop", function () {
 		});
 		self.reset(zerothSp);
 	});
+
+	it("does not count loading time for target time handling", function (done: jest.DoneCallback) {
+		const startedAt = 100;
+
+		// 30FPS の 6 フレーム分 + 1。age 5 のティック時間ぴったり + 1。
+		// 目標時刻はその直前まで進む (直前までしか進まない) ので、+1 しないと age 5 は消化できないことに注意。
+		const targetTime = 201;
+
+		const zerothSp: amf.StartPoint = {
+			frame: 0,
+			timestamp: startedAt,
+			data: {
+				seed: 42,
+				startedAt
+			}
+		};
+		const amflow = new MemoryAmflowClient({
+			playId: "dummyPlayId",
+			tickList: [0, 10, []],
+			startPoints: [zerothSp]
+		});
+		const platform = new mockpf.Platform({ amflow });
+		const game = prepareGame({
+			title: FixtureGame.LocalTickGame,
+			playerId: "dummyPlayerId",
+			scriptLoadDelay: 2000
+		});
+		const eventBuffer = new EventBuffer({ amflow, game });
+		const self = new GameLoop({
+			amflow,
+			platform,
+			game,
+			eventBuffer,
+			executionMode: ExecutionMode.Passive,
+			configuration: {
+				loopMode: LoopMode.Replay,
+				targetTimeFunc: () => targetTime,
+				omitInterpolatedTickOnReplay: true
+			},
+			startedAt
+		});
+
+		let timer: any = null;
+		game.onResetTrigger.add(() => {
+			game.vars.onUpdate = () => {  // LocalTickGame が毎 update コールしてくる関数
+				if (game.age === 5) {
+					// 本題: ここに到達できれば OK 。このテストではスクリプト (main.js) のロードを 2000ms 遅延させているので、
+					// ロード時間を含めて時間を測っていた場合 1 tick も消化しないまま目標時刻到達扱いになりここに来れない。
+					clearInterval(timer);
+					self.stop();
+					done();
+				}
+			};
+		});
+
+		self.start();
+		const looper = self._clock._looper as mockpf.Looper;
+		timer = setInterval(() => {
+			looper.fun(self._frameTime);
+		}, 1);
+
+		self.rawTargetTimeReachedTrigger.add(game._onRawTargetTimeReached, game);
+		game.handlerSet.setEventFilterFuncs({
+			addFilter: eventBuffer.addFilter.bind(eventBuffer),
+			removeFilter: eventBuffer.removeFilter.bind(eventBuffer)
+		});
+		self.reset(zerothSp);
+	}, 7000); // scriptLoadDelay が実時間で遅らせるのでデフォルトに加えて 2 秒猶予
 });

src/__tests__/helpers/MockResourceFactory.ts

@@ -307,8 +307,10 @@ class ScriptAsset extends pci.ScriptAsset {
 					return;
 				}
 				this._content = data;
-				if (!this.destroyed())
-					loader._onAssetLoad(this);
+				setTimeout(() => {
+					if (!this.destroyed())
+						loader._onAssetLoad(this);
+				}, this.resourceFactory._scriptLoadDelay);
 			});
 		}
 	}
@@ -341,15 +343,24 @@ export class AudioPlayer extends pci.AudioPlayer {
 	}
 }
 
+export interface ResourceFactoryParameterObject {
+	/**
+	 * スクリプトアセットの読み込みを遅延する時間。ミリ秒。(ロード待ち時間関係の動作確認用)
+	 */
+	scriptLoadDelay?: number;
+}
+
 export class ResourceFactory extends pci.ResourceFactory {
 	scriptContents: {[key: string]: string};
 
 	_necessaryRetryCount: number;
+	_scriptLoadDelay: number;
 
-	constructor() {
+	constructor(param?: ResourceFactoryParameterObject) {
 		super();
 		this.scriptContents = {};
 		this._necessaryRetryCount = 0;
+		this._scriptLoadDelay = param?.scriptLoadDelay ?? 0;
 	}
 
 	// func が呼び出されている間だけ this._necessaryRetryCount を変更する。

src/__tests__/helpers/prepareGame.ts

@@ -25,6 +25,7 @@ export interface PrepareGameParameterObject {
 	title: FixtureGame;
 	playerId?: string;
 	player?: g.Player;
+	scriptLoadDelay?: number;
 }
 
 export function prepareGame(param: PrepareGameParameterObject): MockGame {
@@ -47,7 +48,7 @@ export function prepareGame(param: PrepareGameParameterObject): MockGame {
 		engineModule: g,
 		configuration: configuration,
 		handlerSet: new GameHandlerSet({ isSnapshotSaver: false }),
-		resourceFactory: new mockrf.ResourceFactory(),
+		resourceFactory: new mockrf.ResourceFactory({ scriptLoadDelay: param.scriptLoadDelay }),
 		assetBase: assetBase,
 		selfId: param.playerId,
 		player: param.player ? param.player : { id: param.playerId }