EW-1071 Common Cartridge microservice creates boards during import

apps/server/src/infra/boards-client/boards-client.adapter.spec.ts

@@ -0,0 +1,107 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { createMock } from '@golevelup/ts-jest';
+import { faker } from '@faker-js/faker';
+import { axiosResponseFactory } from '@testing/factory/axios-response.factory';
+import { BoardsClientAdapter } from './boards-client.adapter';
+import { BoardApi, BoardResponse, CreateBoardBodyParams, CreateBoardResponse } from './generated';
+
+describe(BoardsClientAdapter.name, () => {
+	let module: TestingModule;
+	let sut: BoardsClientAdapter;
+
+	const boardApiMock = createMock<BoardApi>();
+
+	beforeAll(async () => {
+		module = await Test.createTestingModule({
+			providers: [
+				BoardsClientAdapter,
+				{
+					provide: BoardApi,
+					useValue: boardApiMock,
+				},
+			],
+		}).compile();
+		sut = module.get(BoardsClientAdapter);
+	});
+
+	afterAll(async () => {
+		await module.close();
+	});
+
+	beforeEach(() => {
+		jest.clearAllMocks();
+	});
+
+	it('should be defined', () => {
+		expect(sut).toBeDefined();
+	});
+
+	describe('createBoard', () => {
+		describe('when called', () => {
+			const setup = () => {
+				const params: CreateBoardBodyParams = {
+					title: faker.lorem.words(),
+					layout: 'columns',
+					parentId: faker.string.uuid(),
+					parentType: 'course',
+				};
+				const responseData: CreateBoardResponse = {
+					id: faker.string.uuid(),
+				};
+
+				boardApiMock.boardControllerCreateBoard.mockResolvedValue(axiosResponseFactory.build({ data: responseData }));
+
+				return {
+					params,
+					responseData,
+				};
+			};
+
+			it('should call boardApi.boardControllerCreateBoard', async () => {
+				const { params, responseData } = setup();
+
+				const response = await sut.createBoard(params);
+
+				expect(response).toEqual(responseData);
+				expect(boardApiMock.boardControllerCreateBoard).toHaveBeenCalledWith(params);
+			});
+		});
+	});
+
+	describe('getBoardSkeletonById', () => {
+		describe('when called', () => {
+			const setup = () => {
+				const boardId = faker.string.uuid();
+				const responseData: BoardResponse = {
+					id: boardId,
+					title: faker.lorem.words(),
+					layout: 'columns',
+					columns: [],
+					isVisible: true,
+					timestamps: {
+						createdAt: faker.date.recent().toISOString(),
+						lastUpdatedAt: faker.date.recent().toISOString(),
+					},
+				};
+
+				boardApiMock.boardControllerGetBoardSkeleton.mockResolvedValue(
+					axiosResponseFactory.build({ data: responseData })
+				);
+
+				return {
+					boardId,
+					responseData,
+				};
+			};
+
+			it('should call boardApi.boardControllerGetBoardSkeleton', async () => {
+				const { boardId, responseData } = setup();
+
+				const response = await sut.getBoardSkeletonById(boardId);
+
+				expect(response).toEqual(responseData);
+				expect(boardApiMock.boardControllerGetBoardSkeleton).toHaveBeenCalledWith(boardId);
+			});
+		});
+	});
+});

apps/server/src/infra/boards-client/boards-client.adapter.ts

@@ -0,0 +1,19 @@
+import { Injectable } from '@nestjs/common';
+import { BoardApi, BoardResponse, CreateBoardBodyParams, CreateBoardResponse } from './generated';
+
+@Injectable()
+export class BoardsClientAdapter {
+	constructor(private readonly boardApi: BoardApi) {}
+
+	public async createBoard(params: CreateBoardBodyParams): Promise<CreateBoardResponse> {
+		const response = await this.boardApi.boardControllerCreateBoard(params);
+
+		return response.data;
+	}
+
+	public async getBoardSkeletonById(boardId: string): Promise<BoardResponse> {
+		const response = await this.boardApi.boardControllerGetBoardSkeleton(boardId);
+
+		return response.data;
+	}
+}

apps/server/src/infra/boards-client/boards-client.config.ts

@@ -0,0 +1,3 @@
+export interface BoardsClientConfig {
+	API_HOST: string;
+}

apps/server/src/infra/boards-client/boards-client.module.spec.ts

@@ -0,0 +1,60 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { ConfigModule } from '@nestjs/config';
+import { faker } from '@faker-js/faker';
+import { Request } from 'express';
+import { createMock } from '@golevelup/ts-jest';
+import { REQUEST } from '@nestjs/core';
+import { BoardsClientAdapter } from './boards-client.adapter';
+import { BoardsClientConfig } from './boards-client.config';
+import { BoardsClientModule } from './boards-client.module';
+
+describe(BoardsClientModule.name, () => {
+	let module: TestingModule;
+
+	const requestMock = createMock<Request>({
+		headers: {
+			authorization: `Bearer ${faker.string.alphanumeric(42)}`,
+		},
+	});
+
+	beforeEach(async () => {
+		module = await Test.createTestingModule({
+			imports: [
+				BoardsClientModule,
+				ConfigModule.forRoot({
+					isGlobal: true,
+					load: [
+						(): BoardsClientConfig => {
+							return {
+								API_HOST: faker.internet.url(),
+							};
+						},
+					],
+				}),
+			],
+		})
+			.overrideProvider(REQUEST)
+			.useValue(requestMock)
+			.compile();
+	});
+
+	afterAll(async () => {
+		await module.close();
+	});
+
+	beforeEach(() => {
+		jest.clearAllMocks();
+	});
+
+	it('should be defined', () => {
+		expect(module).toBeDefined();
+	});
+
+	describe('when resolving dependencies', () => {
+		it('should resolve BoardsClientAdapter', async () => {
+			const adapter = await module.resolve(BoardsClientAdapter);
+
+			expect(adapter).toBeInstanceOf(BoardsClientAdapter);
+		});
+	});
+});

apps/server/src/infra/boards-client/boards-client.module.ts

@@ -0,0 +1,31 @@
+import { Module, Scope } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { REQUEST } from '@nestjs/core';
+import { JwtExtractor } from '@shared/common';
+import { Request } from 'express';
+import { BoardsClientAdapter } from './boards-client.adapter';
+import { BoardsClientConfig } from './boards-client.config';
+import { Configuration, BoardApi } from './generated';
+
+@Module({
+	providers: [
+		BoardsClientAdapter,
+		{
+			provide: BoardApi,
+			scope: Scope.REQUEST,
+			useFactory: (configService: ConfigService<BoardsClientConfig, true>, request: Request): BoardApi => {
+				const basePath = configService.getOrThrow<string>('API_HOST');
+				const accessToken = JwtExtractor.extractJwtFromRequest(request);
+				const configuration = new Configuration({
+					basePath: `${basePath}/v3`,
+					accessToken,
+				});
+
+				return new BoardApi(configuration);
+			},
+			inject: [ConfigService, REQUEST],
+		},
+	],
+	exports: [BoardsClientAdapter],
+})
+export class BoardsClientModule {}

apps/server/src/modules/common-cartridge/common-cartridge-client/board-client/board-api-client/.openapi-generator/FILES → apps/server/src/infra/boards-client/generated/.openapi-generator/FILES

@@ -1,24 +1,19 @@
-.gitignore
-.npmignore
-api.ts
-api/board-api.ts
-base.ts
-common.ts
-configuration.ts
-git_push.sh
-index.ts
-models/api-validation-error.ts
-models/board-context-response.ts
-models/board-external-reference-type.ts
-models/board-layout.ts
-models/board-parent-type.ts
-models/board-response.ts
-models/card-skeleton-response.ts
-models/column-response.ts
-models/copy-api-response.ts
-models/create-board-body-params.ts
-models/create-board-response.ts
-models/index.ts
-models/timestamps-response.ts
-models/update-board-title-params.ts
-models/visibility-body-params.ts
+.gitignore
+.npmignore
+.openapi-generator-ignore
+api.ts
+api/board-api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+models/board-layout.ts
+models/board-parent-type.ts
+models/board-response.ts
+models/card-skeleton-response.ts
+models/column-response.ts
+models/create-board-body-params.ts
+models/create-board-response.ts
+models/index.ts
+models/timestamps-response.ts