nik/OMDSCloud
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
622 Commits 1 Branch 50 Tags
Commit Graph

14 Commits

Author SHA1 Message Date
湯本 開
cf56239da2 Merged PR 669: Pipeline上でdocker-composeを用いてMySQLを起動する方法を調査する 
## 概要
[Task3427: Pipeline上でdocker-composeを用いてMySQLを起動する方法を調査する](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/3427)

- MySQLでUnitTestを実施する仕組みを作成
  - DevContainerにUnitTestからのみアクセスされるMySQLが動くコンテナ( `test_mysql_db` )を追加
  - テストでMySQLを使用し、上記 `test_mysql_db` に対してアクセスするよう構成
  - テストの前処理で `test_mysql_db` の全てのテーブルをTRUNCATEする処理を実行し、データをクリアする
    - 常にテスト用MySQLは起動しているが、テスト実行前にクリアされるので空っぽ前提の状態でテストを実施できる
  - 実際にMySQLを使用して実行されるテストを1つ追加
    - `users.service.spec.ts | UsersService.createUser` が対象
- Pipeline上でDevContainerを起動し、DevContainer内で `npm ci` `(UnitTest用DBへの) migration` `npm run test` を行う仕組みを作成
  - Pipelineを追加
    - **StagingPipelineでテスト・ステップを切り出し**
  - Pipelineテスト用DevContainer（のdocker-compose.yml）を作成
    - 構成は通常の物と同一だが、ネットワーク設定だけ外部のMySQLやRedisと通信しない前提に変更している
  - テストの実行環境を自己ホストではなく、一般で提供されているマシンに変更
    - 自己ホストのマシンにdocker-composeが入ってない/ビルド後のクリア処理が大変等の理由
- テストで使用する環境変数を `.env.test` という別環境変数に切り出し
  - そうすることで、PipelineでKeyVaultへのアクセスをする必要がなくなる
- **migrationの漏れを修正**
  - テストが通らないことで発覚したmigration漏れを修正
- **テストコードを修正**
  - **Date型のミリ秒単位の誤差を setMillseconds(0) を用いることで0にセットするコードを追加（ライセンス付近）**

## レビューポイント
- **WIPレビュー以降の追加の修正で違和感のある箇所はないか**
  - コミット履歴等で追っていただいた方が楽かと思います
  - 直近の`Merge branch 'develop' into feature/3427/poc-mysql-test` 以降がWIP以降に変更されたコードです
- **レビュー通過後、developのPipelineについては手動で同等のコードに変更→PRをdevelopにマージ予定だが進め方として問題はないか**
- [※WIPでレビュー済み] テスト用DevContainerを別途作成したが、現行のDevContainerを使用するよう頑張った方がいいか？
  - [※WIPでレビュー済み] CI/CDの実行速度面を考慮し、使用されないMySQLとRedisのサービスとネットワーク作成が同居しているdocker-compose.ymlの実行を避けたが、管理対象は増えているので議論の余地はある
- [※WIPでレビュー済み] MySQLでUnitTestを実行する際に懸念事項はないか
- [※WIPでレビュー済み] Dockerを起動する関係でCI/CDのスピードが数分遅くなると思われるが、許容可能か
- [※WIPでレビュー済み] `.env.test` に置き換えて問題ないか

## 動作確認状況
- ローカル＆Pipelineで実行して確認済
 2024-01-23 07:58:42 +00:00
saito.k
45b2cad30c Merged PR 624: クエリログに追跡用IDと実行日時を追加する（各作業まとめブランチ） 
## 概要
[Task3309: 修正をまとめる用のブランチ](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/3309)

- 元PBI or タスクへのリンク（内容・目的などはそちらにあるはず）
- 何をどう変更したか、追加したライブラリなど
- このPull Requestでの対象/対象外
- 影響範囲（他の機能にも影響があるか）

## レビューポイント
- 特にレビューしてほしい箇所
- 軽微なものや自明なものは記載不要
- 修正範囲が大きい場合などに記載
- 全体的にや仕様を満たしているか等は本当に必要な時のみ記載

## UIの変更
- Before/Afterのスクショなど
- スクショ置き場

## 動作確認状況
- ローカルで確認、develop環境で確認など

## 補足
- 相談、参考資料などがあれば
 2023-12-13 01:07:36 +00:00
makabe.t
b8b3416795 Merged PR 625: セレクトのクエリに追跡用のIDと実行日時の情報を追加する 
## 概要
[Task3288: セレクトのクエリに追跡用のIDと実行日時の情報を追加する](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/3288)

- リポジトリ内でのDB操作でSelect文となる部分にコメント（追跡ID_日時）を追加しました。
  - `find`, `fineOne`, `count`を対象にしています。
- コメントを追加するにあたってContextをリポジトリメソッドの引数に追加しています。

## レビューポイント
- 対応箇所の漏れはないでしょうか？
- コメントのつけ方は適切でしょうか？

## UIの変更
- なし

## 動作確認状況
- ローカルで確認
 2023-12-13 00:00:15 +00:00
saito.k
5ef222134e IPアドレス追加に伴う修正漏れ対応 2023-12-12 15:46:37 +09:00
saito.k
f1583cf783 Merged PR 611: 操作を特定できる文字列を追跡用のIDに追加する（IPアドレスもログに出力する） 
## 概要
[Task3265: IPアドレスを追跡用のIDに追加する](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/3265)

- MiddlewareでUUIDを発行しリクエストのヘッダに追加する
- 各コントローラーではヘッダからUUIDとIPアドレスを取得する
  - 取得したUUIDとADB2Cの外部IDでトラッキングIDを作成する
  - 作成したトラッキングIDとIPアドレスの繋がりをログに出力する。

## レビューポイント
- ADB2Cの外部IDがない場合にUnauthorized Userという文字列を入れているがほかの表現のほうが良いか
  - 外部IDもオプショナルにして入れなくてもよくする？
-

## UIの変更
- Before/Afterのスクショなど
- スクショ置き場

## 動作確認状況
- ローカルで確認

## 補足
- 相談、参考資料などがあれば
 2023-12-12 04:11:36 +00:00
水本 祐希
d7bb56af54 Merged PR 580: [Sp20]既存APIのログを強化（外部連携API以外） 
## 概要
[Task2295: [Sp20]既存APIのログを強化（外部連携API以外）](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2295)

- 何をどう変更したか、追加したライブラリなど
誰が操作したのかを追えるようにログを強化

## レビューポイント
- 特にレビューしてほしい箇所
特になし

## 動作確認状況
- ユニットテスト
 2023-11-17 02:54:18 +00:00
makabe.t
8a2ca2b786 Merged PR 519: 代行操作で使用するAPIのガード修正＋ログ修正 
## 概要
[Task2907: 代行操作で使用するAPIのガード修正＋ログ修正](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2907)

- 代行操作するAPIについてガードに代行操作許可の設定を追加しました。
  - ガードの引数で設定したAPIだけが代行操作許可となるように設定しています。
- APIのバリデーションで意図せぬエラーが発生する問題に対処しました。

※ログは未適用なのでガードの設定だけ確認をお願いします。

## レビューポイント
- ガードを設定する対象は適切か
- ガード内での代行操作許可のロジックはホワイトリスト形式の実装として適切か
  - アクセストークンが代行操作用の（代行操作ユーザーIDがある）場合には、ガードで代行操作が許可されているかをチェックするようにしています。

※ログの代行操作への適用は未実装です。

## UIの変更
- なし

## 動作確認状況
- ローカルで確認
 2023-11-07 08:41:47 +00:00
saito.k
f553bfc95b Merged PR 501: strictNullChecks修正①（accounts,auth,Repositoiesのaccounts,common） 
## 概要
[Task2835: 修正①（accounts,auth,Repositoiesのaccounts,common）](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2835)

- features
  - accounts
  - auth
- common
- repositories
  - accounts
- 各entity
  - Nullableの項目の`@Column`デコレータに`type`を追加しないとTypeORMがエラーになりテストが通らないので追加
    - https://qiita.com/maruware/items/08c9ad594e14e4ea1497#%E5%95%8F%E9%A1%8C

## レビューポイント
- コメントとして記載

## UIの変更
- Before/Afterのスクショなど
- スクショ置き場

## 動作確認状況
- ローカルで確認、develop環境で確認など

## 補足
- レビュー完了後、TODOコメント(strictNullChecks対応)は削除します
 2023-10-19 07:13:56 +00:00
saito.k
d258d569f7 Merged PR 483: strictNullCheck修正④（gateways ,notification） 
## 概要
[Task2838: 修正④（gateways ,notification）](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2838)

- strictNullCheckの対応
  - gateways配下
  - feartures
    - notification

## レビューポイント

## UIの変更
- Before/Afterのスクショなど
- スクショ置き場

## 動作確認状況
- ローカルで確認、develop環境で確認など

## 補足
- 相談、参考資料などがあれば
 2023-10-16 01:34:28 +00:00
saito.k
370d143c2c Merged PR 473: strictNullCheckの対応を部分的に行う 
## 概要
[Task2795: 部分的に修正を行う](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2795)

- strictNullChecks対応
  - features
    - template
    - workflow
  - gateways
    - adb2c
  - repositories
    - template
    - workflow

## レビューポイント
- entityの修正内容
  - nullを追加する項目はあってるか
- adb2cの環境変数を取得している箇所
  - getOrThrowで値が取得できなければエラーになる関数があったので使用しています。
![image.png](https://dev.azure.com/ODMSCloud/6023ff7b-d41c-4fa7-9c6f-f576ba48c07c/_apis/git/repositories/302da463-a2d7-40f9-b2bb-6e8edf324fa9/pullRequests/473/attachments/image.png)

## UIの変更
- Before/Afterのスクショなど
- スクショ置き場

## 動作確認状況
- ローカルでテストが通ることを確認

## 補足
- 相談、参考資料などがあれば
 2023-10-13 04:07:18 +00:00
makabe.t
ecc44e58e0 Merged PR 438: API実装（テンプレートファイルアップロード完了API） 
## 概要
[Task2655: API実装（テンプレートファイルアップロード完了API）](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2655)

- テンプレートファイルのアップロード完了APIとテストを実装しました。

## レビューポイント
- テストケースは適切か
- 保存時のリポジトリ処理は適切か

## UIの変更
- なし

## 動作確認状況
- ローカルで確認
 2023-09-25 07:50:19 +00:00
makabe.t
f928aa4fd2 Merged PR 424: API実装（テンプレートファイル一覧取得API） 
## 概要
[Task2650: API実装（テンプレートファイル一覧取得API）](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2650)

- テンプレートファイル一覧取得APIとテストを実装しました。

## レビューポイント
- サービスの配置、リポジトリの呼び出しは適切か
- テストケースは適切か
- テスト用にtemplates配下にテンプレートファイル追加関数を追加したが適切か

## UIの変更
- なし

## 動作確認状況
- ローカルで確認
 2023-09-21 08:30:21 +00:00
makabe.t
b38d2c44f7 Merged PR 428: API IF修正 
## 概要
[Task2714: API IF修正](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2714)

- 以下のAPIのIFを修正しました。
  - テンプレートファイル一覧取得API
  - テンプレートファイルアップロード完了API

## レビューポイント
- 想定通りの修正となっているか。

## UIの変更
- なし

## 動作確認状況
- ローカルで確認
 2023-09-21 04:51:00 +00:00
makabe.t
cec740f65e Merged PR 418: API IF実装 
## 概要
[Task2649: API IF実装](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2649)

- テンプレートファイル周りで以下のAPIIFを実装し、OpenAPIを更新しました。
  - テンプレートファイル一覧取得API
  - テンプレートファイルアップロード先取得API
  - テンプレートファイルアップロード完了API

## レビューポイント
- 各APIのパスは適切か
- パラメータは適切か

## UIの変更
- なし

## 動作確認状況
- ローカルで確認
 2023-09-20 01:41:14 +00:00