Merged PR 466: [PBI1220残]退避テーブル対応（月の途中で退会したアカウントの集計対応）

## 概要
[Task2767: [PBI1220残]退避テーブル対応（月の途中で退会したアカウントの集計対応）](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2767)

アカウント削除時に以下のテーブルの削除対象データを退避する処理を追加しました。
・ライセンステーブル
・ライセンス割り当て履歴テーブル

## レビューポイント
なし

## UIの変更
なし

## 動作確認状況
UT,ローカル動作確認を実施済み

## 補足
なし

dictation_server/src/common/test/utility.ts

@@ -1,6 +1,6 @@
 import { v4 as uuidv4 } from 'uuid';
 import { DataSource } from 'typeorm';
-import { User } from '../../repositories/users/entity/user.entity';
+import { User, UserArchive } from '../../repositories/users/entity/user.entity';
 import { Account } from '../../repositories/accounts/entity/account.entity';
 import { ADMIN_ROLES, USER_ROLES } from '../../constants';
 
@@ -368,3 +368,14 @@ export const getUser = async (
 export const getUsers = async (dataSource: DataSource): Promise<User[]> => {
   return await dataSource.getRepository(User).find();
 };
+
+/**
+ * テスト ユーティリティ: ユーザー退避テーブルの内容を取得する
+ * @param dataSource データソース
+ * @returns ユーザー退避テーブルの内容
+ */
+export const getUserArchive = async (
+  dataSource: DataSource,
+): Promise<UserArchive[]> => {
+  return await dataSource.getRepository(UserArchive).find();
+};

dictation_server/src/features/accounts/accounts.service.spec.ts

@@ -35,6 +35,7 @@ import {
   makeTestUser,
   makeHierarchicalAccounts,
   getUser,
+  getUserArchive,
 } from '../../common/test/utility';
 import { AccountsService } from './accounts.service';
 import { Context, makeContext } from '../../common/log';
@@ -59,7 +60,10 @@ import { AdB2cService } from '../../gateways/adb2c/adb2c.service';
 import { BlobstorageService } from '../../gateways/blobstorage/blobstorage.service';
 import { UserGroupsRepositoryService } from '../../repositories/user_groups/user_groups.repository.service';
 import {
+  createLicenseAllocationHistory,
   createOrder,
+  getLicenseArchive,
+  getLicenseAllocationHistoryArchive,
   selectLicense,
   selectOrderLicense,
 } from '../licenses/test/utility';
@@ -5350,6 +5354,28 @@ describe('deleteAccountAndData', () => {
     const user = await makeTestUser(source, {
       account_id: tier5Accounts.account.id,
     });
+    // ライセンス作成
+    await createLicense(
+      source,
+      1,
+      new Date(),
+      tier5Accounts.account.id,
+      LICENSE_TYPE.NORMAL,
+      LICENSE_ALLOCATED_STATUS.UNALLOCATED,
+      null,
+      user.id,
+      null,
+      null,
+    );
+    await createLicenseAllocationHistory(
+      source,
+      1,
+      user.id,
+      1,
+      tier5Accounts.account.id,
+      'NONE',
+    );
+
     // ADB2Cユーザーの削除成功
     overrideAdB2cService(service, {
       deleteUsers: jest.fn(),
@@ -5371,6 +5397,16 @@ describe('deleteAccountAndData', () => {
 
     const userRecord = await getUser(source, user.id);
     expect(userRecord).toBe(null);
+
+    const UserArchive = await getUserArchive(source);
+    expect(UserArchive.length).toBe(2);
+
+    const LicenseArchive = await getLicenseArchive(source);
+    expect(LicenseArchive.length).toBe(1);
+
+    const LicenseAllocationHistoryArchive =
+      await getLicenseAllocationHistoryArchive(source);
+    expect(LicenseAllocationHistoryArchive.length).toBe(1);
   });
   it('アカウントの削除に失敗した場合はエラーを返す', async () => {
     const module = await makeTestingModule(source);

dictation_server/src/features/licenses/test/utility.ts

@@ -5,6 +5,8 @@ import {
   CardLicenseIssue,
   LicenseAllocationHistory,
   LicenseOrder,
+  LicenseArchive,
+  LicenseAllocationHistoryArchive,
 } from '../../../repositories/licenses/entity/license.entity';
 
 export const createLicense = async (
@@ -189,3 +191,25 @@ export const selectOrderLicense = async (
   });
   return { orderLicense };
 };
+
+/**
+ * テスト ユーティリティ: ライセンス退避テーブルの内容を取得する
+ * @param dataSource データソース
+ * @returns ライセンス退避テーブルの内容
+ */
+export const getLicenseArchive = async (
+  dataSource: DataSource,
+): Promise<LicenseArchive[]> => {
+  return await dataSource.getRepository(LicenseArchive).find();
+};
+
+/**
+ * テスト ユーティリティ: ライセンス割り当て履歴退避テーブルの内容を取得する
+ * @param dataSource データソース
+ * @returns ライセンス割り当て履歴退避テーブルの内容
+ */
+export const getLicenseAllocationHistoryArchive = async (
+  dataSource: DataSource,
+): Promise<LicenseAllocationHistoryArchive[]> => {
+  return await dataSource.getRepository(LicenseAllocationHistoryArchive).find();
+};

dictation_server/src/repositories/accounts/accounts.repository.service.ts

@@ -12,7 +12,13 @@ import {
 } from 'typeorm';
 import { User, UserArchive } from '../users/entity/user.entity';
 import { Account } from './entity/account.entity';
-import { License, LicenseOrder } from '../licenses/entity/license.entity';
+import {
+  License,
+  LicenseAllocationHistory,
+  LicenseAllocationHistoryArchive,
+  LicenseArchive,
+  LicenseOrder,
+} from '../licenses/entity/license.entity';
 import { SortCriteria } from '../sort_criteria/entity/sort_criteria.entity';
 import {
   getDirection,
@@ -923,6 +929,39 @@ export class AccountsRepositoryService {
         .into(UserArchive)
         .values(users)
         .execute();
+
+      // 削除対象のライセンスを退避テーブルに退避
+      const licenses = await this.dataSource.getRepository(License).find({
+        where: {
+          account_id: accountId,
+        },
+      });
+      const licenseArchiveRepo = entityManager.getRepository(LicenseArchive);
+      await licenseArchiveRepo
+        .createQueryBuilder()
+        .insert()
+        .into(LicenseArchive)
+        .values(licenses)
+        .execute();
+
+      // 削除対象のライセンス割り当て履歴を退避テーブルに退避
+      const licenseHistories = await this.dataSource
+        .getRepository(LicenseAllocationHistory)
+        .find({
+          where: {
+            account_id: accountId,
+          },
+        });
+      const licenseHistoryArchiveRepo = entityManager.getRepository(
+        LicenseAllocationHistoryArchive,
+      );
+      await licenseHistoryArchiveRepo
+        .createQueryBuilder()
+        .insert()
+        .into(LicenseAllocationHistoryArchive)
+        .values(licenseHistories)
+        .execute();
+
       // アカウントを削除
       // アカウントを削除することで、外部キー制約がで紐づいている関連テーブルのデータも削除される
       const accountRepo = entityManager.getRepository(Account);

dictation_server/src/repositories/licenses/entity/license.entity.ts

@@ -7,6 +7,7 @@ import {
   OneToOne,
   JoinColumn,
   ManyToOne,
+  PrimaryColumn,
 } from 'typeorm';
 import { User } from '../../users/entity/user.entity';
 
@@ -188,3 +189,90 @@ export class LicenseAllocationHistory {
   @JoinColumn({ name: 'license_id' })
   license?: License;
 }
+
+@Entity({ name: 'licenses_archive' })
+export class LicenseArchive {
+  @PrimaryColumn()
+  id: number;
+
+  @Column({ nullable: true })
+  expiry_date: Date;
+
+  @Column()
+  account_id: number;
+
+  @Column()
+  type: string;
+
+  @Column()
+  status: string;
+
+  @Column({ nullable: true })
+  allocated_user_id: number;
+
+  @Column({ nullable: true })
+  order_id: number;
+
+  @Column({ nullable: true })
+  deleted_at: Date;
+
+  @Column({ nullable: true })
+  delete_order_id: number;
+
+  @Column({ nullable: true })
+  created_by: string;
+
+  @Column()
+  created_at: Date;
+
+  @Column({ nullable: true })
+  updated_by: string;
+
+  @Column()
+  updated_at: Date;
+
+  @CreateDateColumn()
+  archived_at: Date;
+}
+
+@Entity({ name: 'license_allocation_history_archive' })
+export class LicenseAllocationHistoryArchive {
+  @PrimaryColumn()
+  id: number;
+
+  @Column()
+  user_id: number;
+
+  @Column()
+  license_id: number;
+
+  @Column()
+  is_allocated: boolean;
+
+  @Column()
+  account_id: number;
+
+  @Column()
+  executed_at: Date;
+
+  @Column()
+  switch_from_type: string;
+
+  @Column({ nullable: true })
+  deleted_at: Date;
+
+  @Column({ nullable: true })
+  created_by: string;
+
+  @Column()
+  created_at: Date;
+
+  @Column({ nullable: true })
+  updated_by: string;
+
+  @Column()
+  updated_at: Date;
+
+  @CreateDateColumn()
+  archived_at: Date;
+}

dictation_server/src/repositories/licenses/licenses.repository.module.ts

@@ -6,6 +6,8 @@ import {
   License,
   LicenseOrder,
   LicenseAllocationHistory,
+  LicenseArchive,
+  LicenseAllocationHistoryArchive,
 } from './entity/license.entity';
 import { LicensesRepositoryService } from './licenses.repository.service';
 
@@ -17,6 +19,8 @@ import { LicensesRepositoryService } from './licenses.repository.service';
       CardLicense,
       CardLicenseIssue,
       LicenseAllocationHistory,
+      LicenseArchive,
+      LicenseAllocationHistoryArchive,
     ]),
   ],
   providers: [LicensesRepositoryService],