Merged PR 460: Author一覧取得API実装

## 概要
[Task2748: Author一覧取得API実装](https://paruru.nds-tyo.co.jp:8443/tfs/ReciproCollection/fa4924a4-d079-4fab-9fb5-a9a11eb205f0/_workitems/edit/2748)

- Author一覧を取得するAPIとテストを実装しました。

## レビューポイント
- テストケースは適切か

## UIの変更
- なし

## 動作確認状況
- ローカルで確認
This commit is contained in:
makabe.t 2023-10-05 07:49:55 +00:00
parent c4c2038e6e
commit 964077a480
4 changed files with 188 additions and 2 deletions

View File

@ -231,9 +231,9 @@ export class AccountsController {
const { userId } = jwt.decode(accessToken, { json: true }) as AccessToken;
const context = makeContext(userId);
console.log(context.trackingId);
const authors = await this.accountService.getAuthors(context, userId);
return { authors: [] };
return { authors };
}
@ApiResponse({

View File

@ -66,6 +66,7 @@ import { WorktypesRepositoryService } from '../../repositories/worktypes/worktyp
import { AdB2cUser } from '../../gateways/adb2c/types/types';
import { Worktype } from '../../repositories/worktypes/entity/worktype.entity';
import { AccountsRepositoryService } from '../../repositories/accounts/accounts.repository.service';
import { UsersRepositoryService } from '../../repositories/users/users.repository.service';
describe('createAccount', () => {
let source: DataSource = null;
@ -5204,3 +5205,110 @@ describe('getAccountInfo', () => {
}
});
});
describe('getAuthors', () => {
let source: DataSource = null;
beforeEach(async () => {
source = new DataSource({
type: 'sqlite',
database: ':memory:',
logging: false,
entities: [__dirname + '/../../**/*.entity{.ts,.js}'],
synchronize: true, // trueにすると自動的にmigrationが行われるため注意
});
return source.initialize();
});
afterEach(async () => {
await source.destroy();
source = null;
});
it('アカウント内のAuthorユーザーの一覧を取得できる', async () => {
const module = await makeTestingModule(source);
// 第五階層のアカウント作成
const { account, admin } = await makeTestAccount(source, { tier: 5 });
const { id: userId1 } = await makeTestUser(source, {
account_id: account.id,
role: USER_ROLES.AUTHOR,
author_id: 'AUTHOR_ID_1',
});
const { id: userId2 } = await makeTestUser(source, {
account_id: account.id,
role: USER_ROLES.AUTHOR,
author_id: 'AUTHOR_ID_2',
});
const { id: userId3 } = await makeTestUser(source, {
account_id: account.id,
role: USER_ROLES.TYPIST,
});
// 作成したデータを確認
{
const users = await getUsers(source);
expect(users.length).toBe(4);
expect(users[1].id).toBe(userId1);
expect(users[2].id).toBe(userId2);
expect(users[3].id).toBe(userId3);
}
const service = module.get<AccountsService>(AccountsService);
const context = makeContext(admin.external_id);
const authors = await service.getAuthors(context, admin.external_id);
//実行結果を確認
{
expect(authors.length).toBe(2);
expect(authors[0].id).toBe(userId1);
expect(authors[0].authorId).toBe('AUTHOR_ID_1');
expect(authors[1].id).toBe(userId2);
expect(authors[1].authorId).toBe('AUTHOR_ID_2');
}
});
it('アカウント内のAuthorユーザーの一覧を取得できる0件', async () => {
const module = await makeTestingModule(source);
// 第五階層のアカウント作成
const { admin } = await makeTestAccount(source, { tier: 5 });
// 作成したデータを確認
{
const users = await getUsers(source);
expect(users.length).toBe(1);
}
const service = module.get<AccountsService>(AccountsService);
const context = makeContext(admin.external_id);
const authors = await service.getAuthors(context, admin.external_id);
//実行結果を確認
{
expect(authors.length).toBe(0);
}
});
it('DBアクセスに失敗した場合、500エラーとなる', async () => {
const module = await makeTestingModule(source);
// 第五階層のアカウント作成
const { admin } = await makeTestAccount(source, { tier: 5 });
const service = module.get<AccountsService>(AccountsService);
const context = makeContext(admin.external_id);
//DBアクセスに失敗するようにする
const usersService = module.get<UsersRepositoryService>(
UsersRepositoryService,
);
usersService.findAuthorUsers = jest.fn().mockRejectedValue('DB failed');
//実行結果を確認
try {
await service.getAuthors(context, admin.external_id);
} catch (e) {
if (e instanceof HttpException) {
expect(e.getStatus()).toEqual(HttpStatus.INTERNAL_SERVER_ERROR);
expect(e.getResponse()).toEqual(makeErrorResponse('E009999'));
} else {
fail();
}
}
});
});

View File

@ -32,6 +32,7 @@ import {
GetOptionItemsResponse,
GetPartnersResponse,
PostWorktypeOptionItem,
Author,
} from './types/types';
import {
DateWithZeroTime,
@ -554,6 +555,64 @@ export class AccountsService {
}
}
/**
* Authorを取得する
* @param context
* @param externalId
* @returns authors
*/
async getAuthors(context: Context, externalId: string): Promise<Author[]> {
this.logger.log(
`[IN] [${context.trackingId}] ${this.getAuthors.name} | params: { externalId: ${externalId} };`,
);
try {
const { account } = await this.usersRepository.findUserByExternalId(
externalId,
);
if (!account) {
throw new AccountNotFoundError(
`account not found. externalId: ${externalId}`,
);
}
const authorUsers = await this.usersRepository.findAuthorUsers(
account.id,
);
const authors = authorUsers.map((x) => {
return {
id: x.id,
authorId: x.author_id,
};
});
return authors;
} catch (e) {
this.logger.error(`error=${e}`);
if (e instanceof Error) {
switch (e.constructor) {
case AccountNotFoundError:
throw new HttpException(
makeErrorResponse('E010501'),
HttpStatus.BAD_REQUEST,
);
default:
throw new HttpException(
makeErrorResponse('E009999'),
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
throw new HttpException(
makeErrorResponse('E009999'),
HttpStatus.INTERNAL_SERVER_ERROR,
);
} finally {
this.logger.log(`[OUT] [${context.trackingId}] ${this.getAuthors.name}`);
}
}
/**
*
* @param companyName

View File

@ -375,6 +375,25 @@ export class UsersRepositoryService {
});
}
/**
* Authorユーザーを取得する
* @param accountId
* @returns author users
*/
async findAuthorUsers(accountId: number): Promise<User[]> {
return await this.dataSource.transaction(async (entityManager) => {
const repo = entityManager.getRepository(User);
const authors = await repo.find({
where: {
account_id: accountId,
role: USER_ROLES.AUTHOR,
deleted_at: IsNull(),
},
});
return authors;
});
}
/**
* UserID指定のユーザーとソート条件を同時に削除する
* @param userId