ログイン履歴機能のマイグレーションを追加 #5010

chihiro-adachi · 2021-04-12T08:27:55Z

概要(Overview・Refs Issue)

#4978 ログイン履歴機能のマイグレーションを追加

方針(Policy)

管理画面セキュリティ対策プラグインから移行できるよう、プラグインが保持しているデータのマイグレーションを行う

以下の手順で、導入済みのプラグインから本体機能へマイグレーションすることができる。

// featureブランチをマージ
git merge origin/4.1-feature

// スキーマ更新、マイグレーション実行
bin/console doctrine:schema:update --dump-sql -f
bin/console doctrine:migration:migrate

// プラグインの無効化
bin/console eccube:plugin:disable --code=AdminSecurity4

実装に関する補足(Appendix)

以下のテーブル・ファイルへ移行する

プラグイン	本体	備考
plg_admin_record_config	.env	ECCUBE_ADMIN_DENY_HOSTSに出力
plg_admin_record	dtb_login_history

テスト（Test)

マイグレーションを実行し、データ移行されることを確認(PostgreSQL)

相談（Discussion）

マイナーバージョン互換性保持のための制限事項チェックリスト

既存機能の仕様変更
フックポイントの呼び出しタイミングの変更
フックポイントのパラメータの削除・データ型の変更
twigファイルに渡しているパラメータの削除・データ型の変更
Serviceクラスの公開関数の、引数の削除・データ型の変更
入出力ファイル(CSVなど)のフォーマット変更

レビュワー確認項目

動作確認
コードレビュー
E2E/Unit テスト確認(テストの追加・変更が必要かどうか)
互換性が保持されているか
セキュリティ上の問題がないか

okazy · 2021-04-15T01:37:34Z

up（プラグイン -> 本体機能）のみ実装
down（本体機能 -> プラグイン）は「schema:update -> migration」の流れなので工夫が必要
手順を工夫すれば可能なので、念の為 down も実装する。

chihiro-adachi · 2021-04-15T01:50:40Z

@okazy
down実装しました。
.envのECCUBE_ADMIN_DENY_HOSTS に関しては残っていても問題は発生しないと思われるため対応していません。

matsuoshi · 2021-04-21T06:05:59Z

@chihiro-adachi もとのプラグイン側で拒否IPアドレスを複数、改行区切りで入力していた場合、マイグレーション実行後の .env ファイルは以下のようになりました

ECCUBE_ADMIN_DENY_HOSTS='["1.1.1.1\r\n2.2.2.2"]'

結果、管理画面アクセス時にエラーが起きるようです

Invalid JSON in env var "ECCUBE_ADMIN_DENY_HOSTS": Syntax error

なお、 .env の内容が以下のようであればエラーは起きませんでした

ECCUBE_ADMIN_DENY_HOSTS='["1.1.1.1\\r\\n2.2.2.2"]'
# または
ECCUBE_ADMIN_DENY_HOSTS='["1.1.1.1","2.2.2.2"]'

codecov-commenter · 2021-04-22T02:20:55Z

Codecov Report

Merging #5010 (b057295) into 4.1 (49ec600) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              4.1    #5010      +/-   ##
==========================================
- Coverage   68.16%   68.15%   -0.01%     
==========================================
  Files         457      457              
  Lines       24980    24980              
==========================================
- Hits        17027    17026       -1     
- Misses       7953     7954       +1

Flag	Coverage Δ
tests	`68.15% <ø> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/Eccube/Entity/TaxRule.php	`85.18% <0.00%> (-1.24%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 49ec600...b057295. Read the comment docs.

chihiro-adachi · 2021-04-22T02:23:11Z

@matsuoshi
ありがとうございます。修正しました。

matsuoshi · 2021-04-23T03:31:40Z

@chihiro-adachi ありがとうございます！動作確認しまして、問題ないと思います。

okazy · 2021-08-30T02:40:36Z

機能自体の検証手順

git clone https://github.com/EC-CUBE/ec-cube.git ec-cube_migration
cd ec-cube_migration
php ../composer.phar install
vi .env
bin/console eccube:install --no-interaction
bin/console s:run --env=dev

管理画面から認証キーの設定
ログイン履歴プラグインのインストール、有効化

ログイン履歴追加

移行前のデータ

plg_admin_record

1,,testlogin,0,127.0.0.1,2021-08-30 02:47:30 +00:00,2021-08-30 02:47:30 +00:00
2,1,admin,0,127.0.0.1,2021-08-30 02:47:42 +00:00,2021-08-30 02:47:42 +00:00
3,1,admin,1,127.0.0.1,2021-08-30 02:47:45 +00:00,2021-08-30 02:47:45 +00:00

プラグイン一覧からプラグインの無効化
EC-CUBE をアップデート

git checkout composer.json composer.lock
hub checkout https://github.com/EC-CUBE/ec-cube/pull/5010
php ../composer.phar install --no-plugins --no-scripts
bin/console cache:clear --no-warmup
bin/console eccube:composer:require-already-installed
bin/console doctrine:schema:update --force --dump-sql
bin/console doctrine:migrations:migrate
bin/console s:run --env=dev

dtb_login_history

1,0,,testlogin,127.0.0.1,2021-08-30 02:47:30 +00:00,2021-08-30 02:47:30 +00:00,loginhistory
2,0,1,admin,127.0.0.1,2021-08-30 02:47:42 +00:00,2021-08-30 02:47:42 +00:00,loginhistory
3,1,1,admin,127.0.0.1,2021-08-30 02:47:45 +00:00,2021-08-30 02:47:45 +00:00,loginhistory

4.0.6-p1 -> 4.1 の検証手順

git clone https://github.com/EC-CUBE/ec-cube.git ec-cube_migration2
cd ec-cube_migration2
git checkout refs/tags/4.0.6-p1 -b 4.0.6-p1
php ../composer.phar install
vi .env
bin/console eccube:install --no-interaction
bin/console s:run --env=dev

管理画面から認証キーの設定
ログイン履歴プラグインのインストール、有効化

ログイン履歴追加

移行前のデータ

plg_admin_record

1,1,admin,1,127.0.0.1,2021-08-30 03:10:32 +00:00,2021-08-30 03:10:32 +00:00
2,1,admin,0,127.0.0.1,2021-08-30 03:10:41 +00:00,2021-08-30 03:10:41 +00:00
3,,hogehoge,0,127.0.0.1,2021-08-30 03:10:48 +00:00,2021-08-30 03:10:48 +00:00

プラグイン一覧からプラグインの無効化

EC-CUBE をアップデート

git checkout composer.json composer.lock
hub checkout https://github.com/EC-CUBE/ec-cube/pull/5010
git merge origin/4.1
composer install --no-plugins --no-scripts
bin/console cache:clear --no-warmup
vi .env
# ECCUBE_PACKAGE_API_URL=https://package-api-c2.ec-cube.net
## エラー
bin/console eccube:composer:require-already-installed

bin/console doctrine:schema:update --force --dump-sql
bin/console doctrine:migrations:migrate
bin/console s:run --env=dev

dtb_login_history

1,1,1,admin,127.0.0.1,2021-08-30 03:10:32 +00:00,2021-08-30 03:10:32 +00:00,loginhistory
2,0,1,admin,127.0.0.1,2021-08-30 03:10:41 +00:00,2021-08-30 03:10:41 +00:00,loginhistory
3,0,,hogehoge,127.0.0.1,2021-08-30 03:10:48 +00:00,2021-08-30 03:10:48 +00:00,loginhistory
4,1,1,admin,127.0.0.1,2021-08-30 03:24:40 +00:00,2021-08-30 03:24:40 +00:00,loginhistory

4.0.6-p1 -> 4.1 の検証手順（拒否リスト、down）

git clone https://github.com/EC-CUBE/ec-cube.git ec-cube_migration2
cd ec-cube_migration2
git checkout refs/tags/4.0.6-p1 -b 4.0.6-p1
php ../composer.phar install
vi .env
bin/console eccube:install --no-interaction
bin/console s:run --env=dev

管理画面から認証キーの設定
ログイン履歴プラグインのインストール、有効化

ログイン履歴追加

移行前のデータ

プラグイン一覧からプラグインの無効化

EC-CUBE をアップデート

git checkout composer.json composer.lock
hub checkout https://github.com/EC-CUBE/ec-cube/pull/5010
php ../composer.phar install --no-plugins --no-scripts
bin/console cache:clear --no-warmup

bin/console doctrine:schema:update --force --dump-sql
bin/console doctrine:migrations:migrate
bin/console s:run --env=dev

ECCUBE_ADMIN_DENY_HOSTS='["127.0.0.0","192.0.0.0"]'

bin/console doctrine:migrations:execute 20210412073123 --down

okazy · 2021-08-30T03:59:11Z

app/DoctrineMigrations/Version20210412073123.php

+    public function down(Schema $schema): void
+    {
+        if ($schema->hasTable('dtb_login_history')) {
+            $this->addSql('DROP TABLE dtb_login_history');


@chihiro-adachi
DROP TABLE してしまうと 500 エラーが発生してしまいます。
migration の役割ではなく、 schema:update の役割かと思います。
実行したかったのは下記ではないでしょうか？

Suggested change

$this->addSql('DROP TABLE dtb_login_history');

$this->addSql('DELETE FROM dtb_login_history');

chihiro-adachi · 2021-08-30T06:11:25Z

@okazy
ありがとうございます。修正しました。

※少々古くなっていたので、rebaseして4.1ブランチへPR先を付け替えています。

okazy · 2021-08-30T09:00:42Z

IP拒否リストのマージもテストしました。

マージ前プラグイン

マージ前本体

マージ後

okazy

動作、ソースコード共に問題ありませんでした！

okazy · 2021-08-30T09:02:29Z

ありがとうございます！マージしました。

chihiro-adachi changed the title ~~プラグインからのマイグレーションを追加~~ ログイン履歴機能のマイグレーションを追加 Apr 12, 2021

chihiro-adachi requested review from kiy0taka and okazy April 12, 2021 08:35

okazy added the enhancement 機能追加 label Apr 26, 2021

okazy added this to the 4.1 milestone Apr 26, 2021

okazy added the Status: ready-for-merge label Apr 26, 2021

okazy changed the base branch from 4.1-feature to 4.1 August 30, 2021 02:33

okazy changed the base branch from 4.1 to 4.1-feature August 30, 2021 02:34

okazy reviewed Aug 30, 2021

View reviewed changes

chihiro-adachi added 5 commits August 30, 2021 15:07

プラグインからのマイグレーションを追加

3c5d927

jsonの{}と見間違うので

d2f7f49

downを実装

ac5b9b2

複数登録時に正しく出力できない不具合を修正

000f637

dropするとエラーになるため、deleteに変更

b057295

chihiro-adachi force-pushed the add-migration branch from 2132d4d to b057295 Compare August 30, 2021 06:10

chihiro-adachi changed the base branch from 4.1-feature to 4.1 August 30, 2021 06:10

okazy approved these changes Aug 30, 2021

View reviewed changes

okazy merged commit d6c45a4 into EC-CUBE:4.1 Aug 30, 2021

matsuoshi mentioned this pull request Sep 10, 2021

【週刊】取り込んだプルリクエスト #4595

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ログイン履歴機能のマイグレーションを追加 #5010

ログイン履歴機能のマイグレーションを追加 #5010

chihiro-adachi commented Apr 12, 2021 •

edited

Loading

okazy commented Apr 15, 2021

chihiro-adachi commented Apr 15, 2021

matsuoshi commented Apr 21, 2021

codecov-commenter commented Apr 22, 2021 •

edited

Loading

chihiro-adachi commented Apr 22, 2021

matsuoshi commented Apr 23, 2021

okazy commented Aug 30, 2021 •

edited

Loading

okazy Aug 30, 2021

chihiro-adachi commented Aug 30, 2021

okazy commented Aug 30, 2021

okazy left a comment

okazy commented Aug 30, 2021

	$this->addSql('DROP TABLE dtb_login_history');
	$this->addSql('DELETE FROM dtb_login_history');

ログイン履歴機能のマイグレーションを追加 #5010

ログイン履歴機能のマイグレーションを追加 #5010

Conversation

chihiro-adachi commented Apr 12, 2021 • edited Loading

概要(Overview・Refs Issue)

方針(Policy)

実装に関する補足(Appendix)

テスト（Test)

相談（Discussion）

マイナーバージョン互換性保持のための制限事項チェックリスト

レビュワー確認項目

okazy commented Apr 15, 2021

chihiro-adachi commented Apr 15, 2021

matsuoshi commented Apr 21, 2021

codecov-commenter commented Apr 22, 2021 • edited Loading

Codecov Report

chihiro-adachi commented Apr 22, 2021

matsuoshi commented Apr 23, 2021

okazy commented Aug 30, 2021 • edited Loading

機能自体の検証手順

4.0.6-p1 -> 4.1 の検証手順

4.0.6-p1 -> 4.1 の検証手順（拒否リスト、down）

okazy Aug 30, 2021

Choose a reason for hiding this comment

chihiro-adachi commented Aug 30, 2021

okazy commented Aug 30, 2021

マージ前プラグイン

マージ前本体

マージ後

okazy left a comment

Choose a reason for hiding this comment

okazy commented Aug 30, 2021

chihiro-adachi commented Apr 12, 2021 •

edited

Loading

codecov-commenter commented Apr 22, 2021 •

edited

Loading

okazy commented Aug 30, 2021 •

edited

Loading