プラグインのライフサイクルとエンティティProxy再生成/スキーマ更新タイミングの調整

[kiy0taka]

概要(Overview・Refs Issue)

プラグイン削除時にスキーマ更新するためにProxyの再生成も合わせて実行タイミングを変更

方針(Policy)

以下のようなEntity拡張Traitを含むプラグインがあるとき、本体側ではProxyの再生成とスキーマの更新を行う必要があります。

/**
 * @EntityExtension("Eccube\Entity\Customer")
 */
trait HogeTrait
{
    /**
     * @ORM\Column(name="hoge", type="string")
     */
    public $hoge;
}

少なくともプラグインが有効のときには、以下の状態になる必要があります。

• ProxyでこのTraitが利用されている
• スキーマが更新されdtb_productテーブルにhogeカラムが追加されている

プラグインが無効のときは、プラグインに含まれるすべての機能が無効になっている必要があるため、Traitも利用されないようにするべきです。しかしプラグインによって作られたデータは、プラグインを無効化したあとで再度有効化する場合を考えると、残しておく必要があります。

これらを踏まえて、プラグインのライフサイクル内でのTraitとスキーマの関係は以下のようにしました。

処理	Plugin	Trait	カラム
インストール	無効	利用されない	追加	Proxyは再生成されない スキーマは更新される
有効化	有効	利用される	追加済	Proxyが再生成されプラグインのTraitが有効になる スキーマはインストール時に更新済み
無効化	無効	利用されない	追加済	Proxyが再生されプラグインのTraitが無効になる スキーマは残ったまま
削除	-	利用されない	削除	プラグインで拡張したスキーマが破棄される

テスト（Test)

• PluginServiceWithEntityExtensionTest でプラグインのインストール/有効化/無効化/削除の振る舞いをテストしています。スキーマ更新については他のテストに影響がでるため、モックを使用しています。

相談（Discussion）

• プラグインインストール時Traitを適用せずにスキーマ更新するために、app/proxy/entityではなく一時ディレクトリにProxyを生成してからアノテーションを読み込んでいますが、Traitから直接アノテーションを読み込んでメタデータを自力でマージしたほうが良いのかも。