BC-8329 - fix meta tag extractor

apps/server/src/modules/board/board-api.module.ts

@@ -2,14 +2,14 @@ import { AuthorizationModule } from '@modules/authorization';
 import { forwardRef, Module } from '@nestjs/common';
 import { CourseRepo } from '@shared/repo';
 import { LoggerModule } from '@src/core/logger';
+import { BoardModule } from './board.module';
 import {
 	BoardController,
 	BoardSubmissionController,
 	CardController,
 	ColumnController,
 	ElementController,
 } from './controller';
-import { BoardModule } from './board.module';
 import { BoardNodePermissionService } from './service';
 import { BoardUc, CardUc, ColumnUc, ElementUc, SubmissionItemUc } from './uc';
 import { RoomMemberModule } from '../room-member';

apps/server/src/modules/board/controller/api-test/content-element-update-content.spec.ts

@@ -90,7 +90,7 @@ describe(`content element update content (api)`, () => {
 			};
 		};
 
-		it('should return status 201', async () => {
+		it('should return status 200', async () => {
 			const { loggedInClient, richTextElement } = await setup();
 
 			const response = await loggedInClient.patch(`${richTextElement.id}/content`, {
@@ -100,7 +100,7 @@ describe(`content element update content (api)`, () => {
 				},
 			});
 
-			expect(response.statusCode).toEqual(201);
+			expect(response.statusCode).toEqual(200);
 		});
 
 		it('should actually change content of the element', async () => {
@@ -159,7 +159,7 @@ describe(`content element update content (api)`, () => {
 			expect(result.alternativeText).toEqual('rich text 1 some more text');
 		});
 
-		it('should return status 201', async () => {
+		it('should return status 200', async () => {
 			const { loggedInClient, submissionContainerElement } = await setup();
 			const response = await loggedInClient.patch(`${submissionContainerElement.id}/content`, {
 				data: {
@@ -168,7 +168,7 @@ describe(`content element update content (api)`, () => {
 				},
 			});
 
-			expect(response.statusCode).toEqual(201);
+			expect(response.statusCode).toEqual(200);
 		});
 
 		it('should not change dueDate when not proviced in submission container element without dueDate', async () => {

apps/server/src/modules/board/controller/dto/element/link-element.response.ts

@@ -3,10 +3,11 @@ import { ContentElementType } from '../../../domain';
 import { TimestampsResponse } from '../timestamps.response';
 
 export class LinkElementContent {
-	constructor({ url, title, description, imageUrl }: LinkElementContent) {
+	constructor({ url, title, description, originalImageUrl, imageUrl }: LinkElementContent) {
 		this.url = url;
 		this.title = title;
 		this.description = description;
+		this.originalImageUrl = originalImageUrl;
 		this.imageUrl = imageUrl;
 	}
 
@@ -19,6 +20,9 @@ export class LinkElementContent {
 	@ApiPropertyOptional()
 	description?: string;
 
+	@ApiPropertyOptional()
+	originalImageUrl?: string;
+
 	@ApiPropertyOptional()
 	imageUrl?: string;
 }

apps/server/src/modules/board/controller/dto/element/update-element-content.body.params.ts

@@ -52,6 +52,11 @@ export class LinkContentBody {
 	@IsOptional()
 	@ApiProperty({})
 	imageUrl?: string;
+
+	@IsString()
+	@IsOptional()
+	@ApiProperty({})
+	originalImageUrl?: string;
 }
 
 export class LinkElementContentBody extends ElementContentBody {

apps/server/src/modules/board/controller/element.controller.ts

@@ -74,7 +74,7 @@ export class ElementController {
 		DrawingElementContentBody
 	)
 	@ApiResponse({
-		status: 201,
+		status: 200,
 		schema: {
 			oneOf: [
 				{ $ref: getSchemaPath(ExternalToolElementResponse) },
@@ -89,7 +89,7 @@ export class ElementController {
 	@ApiResponse({ status: 400, type: ApiValidationError })
 	@ApiResponse({ status: 403, type: ForbiddenException })
 	@ApiResponse({ status: 404, type: NotFoundException })
-	@HttpCode(201)
+	@HttpCode(200)
 	@Patch(':contentElementId/content')
 	async updateElement(
 		@Param() urlParams: ContentElementUrlParams,

apps/server/src/modules/board/controller/mapper/link-element-response.mapper.ts

@@ -22,6 +22,7 @@ export class LinkElementResponseMapper implements BaseResponseMapper {
 				url: element.url,
 				title: element.title,
 				description: element.description,
+				originalImageUrl: element.originalImageUrl,
 				imageUrl: element.imageUrl,
 			}),
 		});

apps/server/src/modules/board/domain/link-element.do.spec.ts

@@ -21,6 +21,7 @@ describe('LinkElement', () => {
 			title: 'Example',
 			description: 'Example description',
 			imageUrl: 'https://example.com/image.jpg',
+			originalImageUrl: 'https://example.com/image.jpg',
 		});
 	});
 
@@ -68,6 +69,15 @@ describe('LinkElement', () => {
 		expect(linkElement.imageUrl).toBe('https://newurl.com/newimage.jpg');
 	});
 
+	it('should return originalImageUrl', () => {
+		expect(linkElement.originalImageUrl).toBe('https://example.com/image.jpg');
+	});
+
+	it('should set originalImageUrl', () => {
+		linkElement.originalImageUrl = 'https://newurl.com/newimage.jpg';
+		expect(linkElement.originalImageUrl).toBe('https://newurl.com/newimage.jpg');
+	});
+
 	it('should not have child', () => {
 		expect(linkElement.canHaveChild()).toBe(false);
 	});

apps/server/src/modules/board/domain/link-element.do.ts

@@ -34,6 +34,14 @@ export class LinkElement extends BoardNode<LinkElementProps> {
 		this.props.imageUrl = value;
 	}
 
+	get originalImageUrl(): string {
+		return this.props.originalImageUrl ?? '';
+	}
+
+	set originalImageUrl(value: string) {
+		this.props.originalImageUrl = value;
+	}
+
 	canHaveChild(): boolean {
 		return false;
 	}

apps/server/src/modules/board/domain/types/board-node-props.ts

@@ -49,6 +49,7 @@ export interface LinkElementProps extends BoardNodeProps {
 	title: string;
 	url: string;
 	description?: string;
+	originalImageUrl?: string;
 	imageUrl?: string;
 }
 

apps/server/src/modules/board/repo/entity/board-node.entity.ts

@@ -80,6 +80,9 @@ export class BoardNodeEntity extends BaseEntityWithTimestamps implements BoardNo
 	@Property({ type: 'string', nullable: true })
 	imageUrl: string | undefined;
 
+	@Property({ type: 'string', nullable: true })
+	originalImageUrl: string | undefined;
+
 	// FileElement
 	// --------------------------------------------------------------------------
 	@Property({ type: 'string', nullable: true })

apps/server/src/modules/board/service/internal/content-element-update.service.spec.ts

@@ -1,17 +1,15 @@
 import { createMock, DeepMocked } from '@golevelup/ts-jest';
 import { Test, TestingModule } from '@nestjs/testing';
 import { InputFormat } from '@shared/domain/types';
-import { ContentElementUpdateService } from './content-element-update.service';
 import {
+	DrawingContentBody,
+	ExternalToolContentBody,
 	FileContentBody,
 	LinkContentBody,
 	RichTextContentBody,
-	DrawingContentBody,
 	SubmissionContainerContentBody,
-	ExternalToolContentBody,
 } from '../../controller/dto';
 import { BoardNodeRepo } from '../../repo';
-
 import {
 	drawingElementFactory,
 	externalToolElementFactory,
@@ -20,6 +18,7 @@ import {
 	richTextElementFactory,
 	submissionContainerElementFactory,
 } from '../../testing';
+import { ContentElementUpdateService } from './content-element-update.service';
 
 describe('ContentElementUpdateService', () => {
 	let module: TestingModule;

apps/server/src/modules/board/uc/element.uc.spec.ts

@@ -1,22 +1,21 @@
 import { createMock, DeepMocked } from '@golevelup/ts-jest';
+import { Action } from '@modules/authorization';
 import { HttpService } from '@nestjs/axios';
 import { Test, TestingModule } from '@nestjs/testing';
 import { InputFormat } from '@shared/domain/types';
 import { setupEntities, userFactory } from '@shared/testing';
 import { Logger } from '@src/core/logger';
-import { Action } from '@modules/authorization';
-import { ElementUc } from './element.uc';
-import { BoardNodePermissionService, BoardNodeAuthorizableService, BoardNodeService } from '../service';
+import { RichTextContentBody } from '../controller/dto';
 import { BoardNodeFactory } from '../domain';
-
+import { BoardNodeAuthorizableService, BoardNodePermissionService, BoardNodeService } from '../service';
 import {
 	boardNodeAuthorizableFactory,
-	richTextElementFactory,
 	drawingElementFactory,
+	richTextElementFactory,
 	submissionContainerElementFactory,
 	submissionItemFactory,
 } from '../testing';
-import { RichTextContentBody } from '../controller/dto';
+import { ElementUc } from './element.uc';
 
 describe(ElementUc.name, () => {
 	let module: TestingModule;

apps/server/src/modules/meta-tag-extractor/controller/dto/meta-tag-extractor.response.ts

@@ -4,11 +4,21 @@ import { IsString, IsUrl } from 'class-validator';
 import { MetaDataEntityType } from '../../types';
 
 export class MetaTagExtractorResponse {
-	constructor({ url, title, description, imageUrl, type, parentTitle, parentType }: MetaTagExtractorResponse) {
+	constructor({
+		url,
+		title,
+		description,
+		originalImageUrl,
+		imageUrl,
+		type,
+		parentTitle,
+		parentType,
+	}: MetaTagExtractorResponse) {
 		this.url = url;
 		this.title = title;
 		this.description = description;
 		this.imageUrl = imageUrl;
+		this.originalImageUrl = originalImageUrl;
 		this.type = type;
 		this.parentTitle = parentTitle;
 		this.parentType = parentType;
@@ -26,6 +36,10 @@ export class MetaTagExtractorResponse {
 	@DecodeHtmlEntities()
 	description?: string;
 
+	@ApiProperty()
+	@IsString()
+	originalImageUrl?: string;
+
 	@ApiProperty()
 	@IsString()
 	imageUrl?: string;

apps/server/src/modules/meta-tag-extractor/controller/meta-tag-extractor.controller.ts

@@ -1,6 +1,6 @@
-import { CurrentUser, ICurrentUser, JwtAuthentication } from '@infra/auth-guard';
 import { Body, Controller, InternalServerErrorException, Post, UnauthorizedException } from '@nestjs/common';
 import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { CurrentUser, ICurrentUser, JwtAuthentication } from '@src/infra/auth-guard';
 import { MetaTagExtractorUc } from '../uc';
 import { MetaTagExtractorResponse } from './dto';
 import { GetMetaTagDataBody } from './post-link-url.body.params';
@@ -21,8 +21,7 @@ export class MetaTagExtractorController {
 		@Body() bodyParams: GetMetaTagDataBody
 	): Promise<MetaTagExtractorResponse> {
 		const result = await this.metaTagExtractorUc.getMetaData(currentUser.userId, bodyParams.url);
-		const imageUrl = result.image?.url;
-		const response = new MetaTagExtractorResponse({ ...result, imageUrl });
+		const response = new MetaTagExtractorResponse({ ...result });
 		return response;
 	}
 }

apps/server/src/modules/meta-tag-extractor/interface/url-handler.ts

@@ -1,6 +1,6 @@
 import { MetaData } from '../types';
 
 export interface UrlHandler {
-	doesUrlMatch(url: string): boolean;
-	getMetaData(url: string): Promise<MetaData | undefined>;
+	doesUrlMatch(url: URL): boolean;
+	getMetaData(url: URL): Promise<MetaData | undefined>;
 }

apps/server/src/modules/meta-tag-extractor/loggable/invalid-link-url.loggable.spec.ts

@@ -0,0 +1,23 @@
+import { InvalidLinkUrlLoggableException } from './invalid-link-url.loggable';
+
+describe('InvalidLinkUrlLoggableException', () => {
+	it('should implement Loggable interface', () => {
+		const exception = new InvalidLinkUrlLoggableException('http://invalid.url', 'Invalid URL');
+		expect(typeof exception.getLogMessage).toBe('function');
+	});
+
+	it('should return correct log message', () => {
+		const url = 'http://invalid.url';
+		const message = 'Invalid URL';
+		const exception = new InvalidLinkUrlLoggableException(url, message);
+
+		expect(exception.getLogMessage()).toEqual({
+			type: 'INVALID_LINK_URL',
+			message,
+			stack: exception.stack,
+			data: {
+				url,
+			},
+		});
+	});
+});

apps/server/src/modules/meta-tag-extractor/loggable/invalid-link-url.loggable.ts

@@ -0,0 +1,19 @@
+import { BadRequestException } from '@nestjs/common';
+import { ErrorLogMessage, Loggable, LogMessage, ValidationErrorLogMessage } from '@src/core/logger';
+
+export class InvalidLinkUrlLoggableException extends BadRequestException implements Loggable {
+	constructor(private readonly url: string, readonly message: string) {
+		super();
+	}
+
+	getLogMessage(): LogMessage | ErrorLogMessage | ValidationErrorLogMessage {
+		return {
+			type: 'INVALID_LINK_URL',
+			message: this.message,
+			stack: this.stack,
+			data: {
+				url: this.url,
+			},
+		};
+	}
+}

apps/server/src/modules/meta-tag-extractor/meta-tag-extractor.module.ts

@@ -11,6 +11,7 @@ import { createConfigModuleOptions } from '@src/config';
 import { LoggerModule } from '@src/core/logger';
 import metaTagExtractorConfig from './meta-tag-extractor.config';
 import { MetaTagExtractorService } from './service';
+import { MetaTagExternalUrlService } from './service/meta-tag-external-url.service';
 import { MetaTagInternalUrlService } from './service/meta-tag-internal-url.service';
 import { BoardUrlHandler, CourseUrlHandler, LessonUrlHandler, TaskUrlHandler } from './service/url-handler';
 
@@ -28,6 +29,7 @@ import { BoardUrlHandler, CourseUrlHandler, LessonUrlHandler, TaskUrlHandler } f
 	],
 	providers: [
 		MetaTagExtractorService,
+		MetaTagExternalUrlService,
 		MetaTagInternalUrlService,
 		TaskUrlHandler,
 		LessonUrlHandler,