add AMFlowStore/AMFlowClient putStartPoint Trigger

[kamakiri01]

このpull requestが解決する内容

概要

• AmflowStore を interface にし、既存の AmflowStore 実装を MemoryAMFlowStore にリネームします。
• AMFlowClientManager#createAMFlowStore で生成していた AmflowStore をやめ、外部から factory を渡せるように変更します。
• AmflowStore#onPutStartPoint を追加します。

PRコメントで議論後方針を修正しました。

• AMFlowStore#putStartPointTrigger を追加し、これを基点に発火する AMFlowClient#onPutStartPoint を追加します。

機能追加のためマイナーバージョンが上がります。

破壊的な変更を含んでいるか?

• なし

[kamakiri01]

プレイ中の一意な識別子として frame: number を使う想定です。
devtoolに一覧を出すためにはstartPoint全体を送る必要はなく、識別子だけで良いだろうという意図ですが、他の方針もあると思います。コメント頂ければと思います。

[xnv]

細かい情報は個別に GET する API を作って問い合わせればいいので、さほど慎重にならなくてよさそうです。ただまあ { frame, timeStamp } ぐらい送ってもいいかなと思います。(手動ティックだと frame がほとんど情報にならないので)　オブジェクトにしておけば後でプロパティが増えても影響が小さいというのもあり。

[kamakiri01]

interface StartPointHeader {
	frame: number;
	timestamp: number;
}

を型定義してこれを送るようにします。

[xnv]

周囲に合わせるなら putStartPointTrigger かと思います。逆にここで初めて公開する名前なので、ここで onSendTick, onPutStartPoint などと改名してしまってもよさそうです。(〜Trigger は初期の pdi-browser に合わせたもの、 on〜 は AEv3 に合わせたもの、 on〜Trigger は前例がない認識)

[kamakiri01]

確かに、on~ に揃えます。

[yu-ogi]

通常の使い方だと利用されることがないので、できれば以下辺りで簡単なテストを追加しておきたいです。

headless-driver/packages/headless-driver/src/__tests__/play.spec.ts

Lines 443 to 461 in aa1f46b

	// Play を resume した後に sendTick できる
	activeAMFlow.sendTick([1]);
	// Play を resume した後に sendEvent できる
	passiveAMFlow.sendEvent([0, 1, "dummy-player-id"]);
	// Play を resume した後に putStartPoint できる
	activeAMFlow.putStartPoint(
	{
	frame: 10,
	timestamp: 1000,
	data: "hoge"
	},
	(e) => {
	if (e) {
	reject(e);
	return;
	}
	resolve();
	}
	);

イメージ:

let startPoint;
activeAMFlow.onPutStartPoint.add((s) => { startPoint = s; });

// Play を resume した後に putStartPoint できる 
activeAMFlow.putStartPoint(
...
 	(e) => { 
 		if (e) { 
 			reject(e); 
 			return; 
 		} 
		expect(startPoint).toEqual(...);
 		resolve(); 
 	} 

[yu-ogi]

PullRequest のタイトルと説明を修正内容に合わせてください。

[yu-ogi]

• 機能追加なのでマイナーバージョンの更新でお願いします。
• PullRequestの説明にある

AMFlowStore#putStartPoint Trigger を追加し、これを基点に発火する AMFlowStore#onPutStartPoint を追加します。

はそれぞれ

• AMFlowStore#putStartPointTrigger
• AMFlowClient#onPutStartPoint

が正しいかと思います。

[yu-ogi]

LGTM です。ご対応ありがとうございます。