implement type casting for command flags

hpi-schul-cloud · virgilchiriac · Feb 5, 2025 · Jan 15, 2025 · Jan 20, 2025 · Jan 20, 2025
commit 7b8eccfd7a6b58cfc9df884c29ec99ac8cd425fe
diff --git a/apps/server/src/modules/deletion-console/deletion-execution.console.ts b/apps/server/src/modules/deletion-console/deletion-execution.console.ts
@@ -14,11 +14,13 @@ export class DeletionExecutionConsole {
 		options: [
 			{
 				flags: '-l, --limit <value>',
+				fn: (value: string) => (value ? Number(value) : undefined),
 				description: 'Limit of the requested deletion executions that should be performed.',
 				required: false,
 			},
 			{
 				flags: '-f, --runFailed <value>',
+				fn: (value: string) => /^(true|yes|1)$/i.test(value),
 				description: 'Limit of the requested deletion executions that should be performed.',
 				required: false,
 			},
@@ -31,10 +33,7 @@ export class DeletionExecutionConsole {
 		let result: DeletionExecutionTriggerResult;
 
 		try {
-			const limit = options.limit ? Number(options.limit) : undefined;
-			const runFailed = options.runFailed ?? false;
-			await this.deletionExecutionUc.triggerDeletionExecution(limit, runFailed);
-
+			await this.deletionExecutionUc.triggerDeletionExecution(options.limit, options.runFailed);
 			result = DeletionExecutionTriggerResultBuilder.buildSuccess();
 		} catch (err) {
 			result = DeletionExecutionTriggerResultBuilder.buildFailure(err as Error);

diff --git a/Dockerfile b/Dockerfile

 ENV NODE_ENV=production
 ENV NO_COLOR="true"
 CMD npm run start
diff --git a/Dockerfile.filepreview b/Dockerfile.filepreview
 ARG BASE_IMAGE
 FROM $BASE_IMAGE

 RUN apk add --no-cache imagemagick imagemagick-heic imagemagick-jpeg imagemagick-pdf imagemagick-raw imagemagick-svg imagemagick-tiff imagemagick-webp
diff --git a/apps/server/src/apps/board-collaboration.app.ts b/apps/server/src/apps/board-collaboration.app.ts

 // application imports
 import { LegacyLogger, Logger } from '@core/logger';
 import { RedisIoAdapter } from '@infra/socketio';
 import { BoardCollaborationModule } from '@modules/board/board-collaboration.app.module';
 import { ExpressAdapter } from '@nestjs/platform-express';
 import { SwaggerDocumentOptions } from '@nestjs/swagger';
diff --git a/apps/server/src/apps/deletion-console.app.ts b/apps/server/src/apps/deletion-console.app.ts
 import { DeletionConsoleModule } from '@modules/deletion-console/deletion-console.app.module';
 import { BootstrapConsole } from 'nestjs-console';

 async function run() {
 	const bootstrap = new BootstrapConsole({
 		module: DeletionConsoleModule,
 		useDecorators: true,
diff --git a/apps/server/src/apps/h5p-editor.app.ts b/apps/server/src/apps/h5p-editor.app.ts
 /* istanbul ignore file */
 /* eslint-disable no-console */
 import { NestFactory } from '@nestjs/core';
 import { ExpressAdapter } from '@nestjs/platform-express';
 import express from 'express';

diff --git a/apps/server/src/apps/h5p-library-management.app.ts b/apps/server/src/apps/h5p-library-management.app.ts
 /* istanbul ignore file */
 /* eslint-disable no-console */
 import { LegacyLogger } from '@core/logger';
 import { H5PLibraryManagementService } from '@modules/h5p-library-management';
 import { H5PLibraryManagementModule } from '@modules/h5p-library-management/h5p-library-management.app.module';
 import { NestFactory } from '@nestjs/core';
diff --git a/apps/server/src/apps/helpers/app-start-loggable.ts b/apps/server/src/apps/helpers/app-start-loggable.ts
 export class AppStartLoggable implements Loggable {
 	constructor(private readonly info: AppStartInfo) {}

 	getLogMessage(): LogMessage {
 		const data: LogMessageData = { appName: this.info.appName };

 		if (this.info.port !== undefined) {
diff --git a/apps/server/src/apps/helpers/metrics/prometheus-metrics.ts b/apps/server/src/apps/helpers/metrics/prometheus-metrics.ts
 export class PrometheusMetricsSetupStateLoggable implements Loggable {
 	constructor(private readonly state: PrometheusMetricsSetupState) {}

 	getLogMessage(): LogMessage {
 		return {
 			message: 'Setting up Prometheus metrics...',
 			data: {
 	}
 }

 export const addPrometheusMetricsMiddlewaresIfEnabled = (logger: Logger, app: Express) => {
 	if (!PrometheusMetricsConfig.instance.isEnabled) {
 		logger.debug(
 			new PrometheusMetricsSetupStateLoggable(
 	);
 };

 export const createAndStartPrometheusMetricsAppIfEnabled = (logger: Logger) => {
 	if (!PrometheusMetricsConfig.instance.isEnabled) {
 		logger.debug(
 			new PrometheusMetricsSetupStateLoggable(PrometheusMetricsSetupState.FEATURE_DISABLED_APP_WILL_NOT_BE_CREATED)
diff --git a/apps/server/src/apps/helpers/metrics/prometheus/config.ts b/apps/server/src/apps/helpers/metrics/prometheus/config.ts
 		this._collectMetricsRouteMetrics = Configuration.get('PROMETHEUS_METRICS_COLLECT_METRICS_ROUTE_METRICS') as boolean;
 	}

 	public static get instance() {
 		if (this._instance === undefined) {
 			this._instance = new this();
 		}
diff --git a/apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts b/apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts
 import { DeletionRequestBodyProps } from '../controller/dto';
 import { DeletionLogStatisticBuilder, DeletionTargetRefBuilder } from '../controller/dto/builder';
 import { DeletionRequestUc } from './deletion-request.uc';
 import objectContaining = jasmine.objectContaining;

 describe(DeletionRequestUc.name, () => {
 	let module: TestingModule;
 				return { deletionRequest };
 			};
 			it('should call deletionRequestService.countPendingDeletionRequests', async () => {
 				deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);

 				await uc.executeDeletionRequests();

 			});

 			it('should call deletionRequestService.findAllItemsToExecute', async () => {
 				deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);

 				await uc.executeDeletionRequests();


 			it('should call deletionRequestService.markDeletionRequestAsPending to update status of deletionRequests', async () => {
 				const { deletionRequest } = setup();
 				deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);
 				deletionRequestService.findAllItemsToExecute.mockResolvedValueOnce([deletionRequest]);

 				await uc.executeDeletionRequests();

 			it('should call eventBus.publish', async () => {
 				const { deletionRequest } = setup();
 				deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);
 				deletionRequestService.findAllItemsToExecute.mockResolvedValueOnce([deletionRequest]);

 				await uc.executeDeletionRequests();
 			const setup = () => {
 				const deletionRequestToExecute = deletionRequestFactory.build({ deleteAfter: new Date('2023-01-01') });

 				deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);
 				deletionRequestService.findAllItemsToExecute.mockResolvedValueOnce([deletionRequestToExecute]);
 				eventBus.publish.mockRejectedValueOnce(new Error());

	ENV NODE_ENV=production
	ENV NO_COLOR="true"
	CMD npm run start
Check warning on line 27 in Dockerfile GitHub Actions / build_and_push JSON arguments recommended for ENTRYPOINT/CMD to prevent unintended behavior related to OS signals `JSONArgsRecommended: JSON arguments recommended for CMD to prevent unintended behavior related to OS signals More info: https://docs.docker.com/go/dockerfile/rule/json-args-recommended/`
	ARG BASE_IMAGE
	FROM $BASE_IMAGE
Check warning on line 2 in Dockerfile.filepreview GitHub Actions / build_and_push Default value for global ARG results in an empty or invalid base image name `InvalidDefaultArgInFrom: Default value for ARG $BASE_IMAGE results in empty or invalid base image name More info: https://docs.docker.com/go/dockerfile/rule/invalid-default-arg-in-from/`

	RUN apk add --no-cache imagemagick imagemagick-heic imagemagick-jpeg imagemagick-pdf imagemagick-raw imagemagick-svg imagemagick-tiff imagemagick-webp

	// application imports
	import { LegacyLogger, Logger } from '@core/logger';
	import { RedisIoAdapter } from '@infra/socketio';
Check warning on line 10 in apps/server/src/apps/board-collaboration.app.ts GitHub Actions / nest_lint `'@infra/socketio' import is restricted from being used by a pattern. apps-modules may NOT import from @apps, @infra, @shared, or migrations`
	import { BoardCollaborationModule } from '@modules/board/board-collaboration.app.module';
	import { ExpressAdapter } from '@nestjs/platform-express';
	import { SwaggerDocumentOptions } from '@nestjs/swagger';
	import { DeletionConsoleModule } from '@modules/deletion-console/deletion-console.app.module';
	import { BootstrapConsole } from 'nestjs-console';

	async function run() {
Check warning on line 5 in apps/server/src/apps/deletion-console.app.ts GitHub Actions / nest_lint `Missing return type on function`
	const bootstrap = new BootstrapConsole({
	module: DeletionConsoleModule,
	useDecorators: true,
	/* istanbul ignore file */
	/* eslint-disable no-console */
	import { NestFactory } from '@nestjs/core';
Check warning on line 3 in apps/server/src/apps/h5p-editor.app.ts GitHub Actions / nest_lint `Filename 'h5p-editor.app.ts' does not match kebabcase`
	import { ExpressAdapter } from '@nestjs/platform-express';
	import express from 'express';
	/* istanbul ignore file */
	/* eslint-disable no-console */
	import { LegacyLogger } from '@core/logger';
Check warning on line 3 in apps/server/src/apps/h5p-library-management.app.ts GitHub Actions / nest_lint `Filename 'h5p-library-management.app.ts' does not match kebabcase`
	import { H5PLibraryManagementService } from '@modules/h5p-library-management';
	import { H5PLibraryManagementModule } from '@modules/h5p-library-management/h5p-library-management.app.module';
	import { NestFactory } from '@nestjs/core';
	export class AppStartLoggable implements Loggable {
	constructor(private readonly info: AppStartInfo) {}

	getLogMessage(): LogMessage {
Check warning on line 13 in apps/server/src/apps/helpers/app-start-loggable.ts GitHub Actions / nest_lint `Missing accessibility modifier on method definition getLogMessage`
	const data: LogMessageData = { appName: this.info.appName };

	if (this.info.port !== undefined) {
	export class PrometheusMetricsSetupStateLoggable implements Loggable {
	constructor(private readonly state: PrometheusMetricsSetupState) {}

	getLogMessage(): LogMessage {
Check warning on line 22 in apps/server/src/apps/helpers/metrics/prometheus-metrics.ts GitHub Actions / nest_lint `Missing accessibility modifier on method definition getLogMessage`
	return {
	message: 'Setting up Prometheus metrics...',
	data: {
	}
	}

	export const addPrometheusMetricsMiddlewaresIfEnabled = (logger: Logger, app: Express) => {
Check warning on line 32 in apps/server/src/apps/helpers/metrics/prometheus-metrics.ts GitHub Actions / nest_lint `Missing return type on function`
	if (!PrometheusMetricsConfig.instance.isEnabled) {
	logger.debug(
	new PrometheusMetricsSetupStateLoggable(
	);
	};

	export const createAndStartPrometheusMetricsAppIfEnabled = (logger: Logger) => {
Check warning on line 52 in apps/server/src/apps/helpers/metrics/prometheus-metrics.ts GitHub Actions / nest_lint `Missing return type on function`
	if (!PrometheusMetricsConfig.instance.isEnabled) {
	logger.debug(
	new PrometheusMetricsSetupStateLoggable(PrometheusMetricsSetupState.FEATURE_DISABLED_APP_WILL_NOT_BE_CREATED)
	this._collectMetricsRouteMetrics = Configuration.get('PROMETHEUS_METRICS_COLLECT_METRICS_ROUTE_METRICS') as boolean;
	}

	public static get instance() {
Check warning on line 44 in apps/server/src/apps/helpers/metrics/prometheus/config.ts GitHub Actions / nest_lint `Public accessibility modifier on get property accessor instance` Check warning on line 44 in apps/server/src/apps/helpers/metrics/prometheus/config.ts GitHub Actions / nest_lint `Missing return type on function`
	if (this._instance === undefined) {
	this._instance = new this();
	}
	import { DeletionRequestBodyProps } from '../controller/dto';
	import { DeletionLogStatisticBuilder, DeletionTargetRefBuilder } from '../controller/dto/builder';
	import { DeletionRequestUc } from './deletion-request.uc';
	import objectContaining = jasmine.objectContaining;
Check failure on line 20 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint `'objectContaining' is defined but never used`

	describe(DeletionRequestUc.name, () => {
	let module: TestingModule;
	return { deletionRequest };
	};
	it('should call deletionRequestService.countPendingDeletionRequests', async () => {
	deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);
Check failure on line 164 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint Unsafe member access .mockResolvedValue on an `any` value Check failure on line 164 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint Unsafe call of an `any` typed value

	await uc.executeDeletionRequests();

	});

	it('should call deletionRequestService.findAllItemsToExecute', async () => {
	deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);
Check failure on line 172 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint Unsafe member access .mockResolvedValue on an `any` value Check failure on line 172 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint Unsafe call of an `any` typed value

	await uc.executeDeletionRequests();


	it('should call deletionRequestService.markDeletionRequestAsPending to update status of deletionRequests', async () => {
	const { deletionRequest } = setup();
	deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);
Check failure on line 181 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint Unsafe member access .mockResolvedValue on an `any` value Check failure on line 181 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint Unsafe call of an `any` typed value
	deletionRequestService.findAllItemsToExecute.mockResolvedValueOnce([deletionRequest]);

	await uc.executeDeletionRequests();

	it('should call eventBus.publish', async () => {
	const { deletionRequest } = setup();
	deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);
Check failure on line 191 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint Unsafe member access .mockResolvedValue on an `any` value Check failure on line 191 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint Unsafe call of an `any` typed value
	deletionRequestService.findAllItemsToExecute.mockResolvedValueOnce([deletionRequest]);

	await uc.executeDeletionRequests();
	const setup = () => {
	const deletionRequestToExecute = deletionRequestFactory.build({ deleteAfter: new Date('2023-01-01') });

	deletionRequestService.countPendingDeletionRequests.mockResolvedValue(0);
Check failure on line 206 in apps/server/src/modules/deletion/api/uc/deletion-request.uc.spec.ts GitHub Actions / nest_lint Unsafe member access .mockResolvedValue on an `any` value
	deletionRequestService.findAllItemsToExecute.mockResolvedValueOnce([deletionRequestToExecute]);
	eventBus.publish.mockRejectedValueOnce(new Error());