N21-2203 handle policies-info error responses (#5262)

* handle policies-info error responses
* fix everything
---------
Co-authored-by: Marvin Öhlerking <[email protected]>

apps/server/src/infra/schulconnex-client/index.ts

@@ -1,6 +1,4 @@
 export { SchulconnexRestClientOptions } from './schulconnex-rest-client-options';
-export { SchulconnexClientModule } from './schulconnex-client.module';
 export { SchulconnexRestClient } from './schulconnex-rest-client';
 export * from './response';
-export { schulconnexResponseFactory, schulconnexPoliciesInfoResponseFactory } from './testing';
 export { SchulconnexClientConfig } from './schulconnex-client-config';

apps/server/src/infra/schulconnex-client/response/policies-info/index.ts

@@ -2,3 +2,7 @@ export { SchulconnexPoliciesInfoTargetResponse } from './schulconnex-policies-in
 export { SchulconnexPoliciesInfoResponse } from './schulconnex-policies-info-response';
 export { SchulconnexPoliciesInfoActionType } from './schulconnex-policies-info-action-type';
 export { SchulconnexPoliciesInfoPermissionResponse } from './schulconnex-policies-info-permission-response';
+export { SchulconnexPoliciesInfoAccessControlResponse } from './schulconnex-policies-info-access-control-response';
+export { SchulconnexPoliciesInfoErrorDescriptionResponse } from './schulconnex-policies-info-error-description-response';
+export { SchulconnexPoliciesInfoLicenseResponse } from './schulconnex-policies-info-license-response';
+export { SchulconnexPoliciesInfoErrorResponse } from './schulconnex-policies-info-error-response';

apps/server/src/infra/schulconnex-client/response/policies-info/schulconnex-policies-info-access-control-response.ts

@@ -0,0 +1,13 @@
+import { Type } from 'class-transformer';
+import { IsObject, IsString, ValidateNested } from 'class-validator';
+import { SchulconnexPoliciesInfoErrorDescriptionResponse } from './schulconnex-policies-info-error-description-response';
+
+export class SchulconnexPoliciesInfoAccessControlResponse {
+	@IsString()
+	'@type'!: string;
+
+	@IsObject()
+	@ValidateNested()
+	@Type(() => SchulconnexPoliciesInfoErrorDescriptionResponse)
+	error!: SchulconnexPoliciesInfoErrorDescriptionResponse;
+}

apps/server/src/infra/schulconnex-client/response/policies-info/schulconnex-policies-info-error-description-response.ts

@@ -0,0 +1,9 @@
+import { IsString } from 'class-validator';
+
+export class SchulconnexPoliciesInfoErrorDescriptionResponse {
+	@IsString()
+	code!: string;
+
+	@IsString()
+	value!: string;
+}

apps/server/src/infra/schulconnex-client/response/policies-info/schulconnex-policies-info-error-response.ts

@@ -0,0 +1,10 @@
+import { Type } from 'class-transformer';
+import { IsObject, ValidateNested } from 'class-validator';
+import { SchulconnexPoliciesInfoAccessControlResponse } from './schulconnex-policies-info-access-control-response';
+
+export class SchulconnexPoliciesInfoErrorResponse {
+	@IsObject()
+	@ValidateNested()
+	@Type(() => SchulconnexPoliciesInfoAccessControlResponse)
+	access_control!: SchulconnexPoliciesInfoAccessControlResponse;
+}

apps/server/src/infra/schulconnex-client/response/policies-info/schulconnex-policies-info-license-response.ts

@@ -0,0 +1,16 @@
+import { Type } from 'class-transformer';
+import { IsArray, IsObject, ValidateNested } from 'class-validator';
+import { SchulconnexPoliciesInfoPermissionResponse } from './schulconnex-policies-info-permission-response';
+import { SchulconnexPoliciesInfoTargetResponse } from './schulconnex-policies-info-target-response';
+
+export class SchulconnexPoliciesInfoLicenseResponse {
+	@IsObject()
+	@ValidateNested()
+	@Type(() => SchulconnexPoliciesInfoTargetResponse)
+	target!: SchulconnexPoliciesInfoTargetResponse;
+
+	@IsArray()
+	@ValidateNested({ each: true })
+	@Type(() => SchulconnexPoliciesInfoPermissionResponse)
+	permission!: SchulconnexPoliciesInfoPermissionResponse[];
+}

apps/server/src/infra/schulconnex-client/response/policies-info/schulconnex-policies-info-permission-response.ts

@@ -1,7 +1,8 @@
-import { IsArray } from 'class-validator';
+import { IsArray, IsString } from 'class-validator';
 import { SchulconnexPoliciesInfoActionType } from './schulconnex-policies-info-action-type';
 
 export class SchulconnexPoliciesInfoPermissionResponse {
 	@IsArray()
+	@IsString({ each: true })
 	action!: SchulconnexPoliciesInfoActionType[];
 }

apps/server/src/infra/schulconnex-client/response/policies-info/schulconnex-policies-info-response.ts

@@ -1,16 +1,19 @@
-import { Type } from 'class-transformer';
-import { IsArray, IsObject, ValidateNested } from 'class-validator';
-import { SchulconnexPoliciesInfoPermissionResponse } from './schulconnex-policies-info-permission-response';
-import { SchulconnexPoliciesInfoTargetResponse } from './schulconnex-policies-info-target-response';
+import { PolymorphicArrayTransform } from '@shared/controller';
+import { ClassConstructor } from 'class-transformer';
+import { IsArray, ValidateNested } from 'class-validator';
+import { SchulconnexPoliciesInfoErrorResponse } from './schulconnex-policies-info-error-response';
+import { SchulconnexPoliciesInfoLicenseResponse } from './schulconnex-policies-info-license-response';
 
-export class SchulconnexPoliciesInfoResponse {
-	@IsObject()
-	@ValidateNested()
-	@Type(() => SchulconnexPoliciesInfoTargetResponse)
-	target!: SchulconnexPoliciesInfoTargetResponse;
+const policiesInfoDiscriminator = (
+	obj: unknown
+): ClassConstructor<SchulconnexPoliciesInfoLicenseResponse | SchulconnexPoliciesInfoErrorResponse> =>
+	typeof obj === 'object' && obj !== null && 'target' in obj && 'permission' in obj
+		? SchulconnexPoliciesInfoLicenseResponse
+		: SchulconnexPoliciesInfoErrorResponse;
 
+export class SchulconnexPoliciesInfoResponse {
 	@IsArray()
 	@ValidateNested({ each: true })
-	@Type(() => SchulconnexPoliciesInfoPermissionResponse)
-	permission!: SchulconnexPoliciesInfoPermissionResponse[];
+	@PolymorphicArrayTransform(policiesInfoDiscriminator)
+	data!: (SchulconnexPoliciesInfoLicenseResponse | SchulconnexPoliciesInfoErrorResponse)[];
 }

apps/server/src/infra/schulconnex-client/response/schulconnex-person-response.ts

@@ -2,6 +2,7 @@ import { Type } from 'class-transformer';
 import { IsObject, IsOptional, ValidateNested } from 'class-validator';
 import { SchulconnexGeburtResponse } from './schulconnex-geburt-response';
 import { SchulconnexNameResponse } from './schulconnex-name-response';
+import 'reflect-metadata';
 
 export class SchulconnexPersonResponse {
 	@IsObject()

apps/server/src/infra/schulconnex-client/schulconnex-api.interface.ts

@@ -6,5 +6,5 @@ export interface SchulconnexApiInterface {
 
 	getPersonenInfo(params: SchulconnexPersonenInfoParams): Promise<SchulconnexResponse[]>;
 
-	getPoliciesInfo(accessToken: string, options?: { overrideUrl: string }): Promise<SchulconnexPoliciesInfoResponse[]>;
+	getPoliciesInfo(accessToken: string, options?: { overrideUrl: string }): Promise<SchulconnexPoliciesInfoResponse>;
 }

apps/server/src/infra/schulconnex-client/schulconnex-rest-client.spec.ts

@@ -5,10 +5,14 @@ import { axiosResponseFactory } from '@shared/testing';
 import { Logger } from '@src/core/logger';
 import { of } from 'rxjs';
 import { SchulconnexConfigurationMissingLoggable } from './loggable';
-import { SchulconnexPoliciesInfoResponse, SchulconnexResponse } from './response';
+import {
+	SchulconnexPoliciesInfoLicenseResponse,
+	SchulconnexPoliciesInfoResponse,
+	SchulconnexResponse,
+} from './response';
 import { SchulconnexRestClient } from './schulconnex-rest-client';
 import { SchulconnexRestClientOptions } from './schulconnex-rest-client-options';
-import { schulconnexPoliciesInfoResponseFactory, schulconnexResponseFactory } from './testing';
+import { schulconnexPoliciesInfoLicenseResponseFactory, schulconnexResponseFactory } from './testing';
 
 describe(SchulconnexRestClient.name, () => {
 	let client: SchulconnexRestClient;
@@ -199,7 +203,8 @@ describe(SchulconnexRestClient.name, () => {
 		describe('when requesting policies-info', () => {
 			const setup = () => {
 				const accessToken = 'accessToken';
-				const response: SchulconnexPoliciesInfoResponse[] = schulconnexPoliciesInfoResponseFactory.buildList(1);
+				const response: SchulconnexPoliciesInfoLicenseResponse[] =
+					schulconnexPoliciesInfoLicenseResponseFactory.buildList(1);
 
 				httpService.get.mockReturnValueOnce(of(axiosResponseFactory.build({ data: response })));
 
@@ -224,7 +229,7 @@ describe(SchulconnexRestClient.name, () => {
 			it('should return the response', async () => {
 				const { accessToken } = setup();
 
-				const result: SchulconnexPoliciesInfoResponse[] = await client.getPoliciesInfo(accessToken);
+				const result: SchulconnexPoliciesInfoResponse = await client.getPoliciesInfo(accessToken);
 
 				expect(result).toBeDefined();
 			});
@@ -234,7 +239,8 @@ describe(SchulconnexRestClient.name, () => {
 			const setup = () => {
 				const accessToken = 'accessToken';
 				const customUrl = 'https://override.url/policies-info';
-				const response: SchulconnexPoliciesInfoResponse[] = schulconnexPoliciesInfoResponseFactory.buildList(1);
+				const response: SchulconnexPoliciesInfoLicenseResponse[] =
+					schulconnexPoliciesInfoLicenseResponseFactory.buildList(1);
 
 				httpService.get.mockReturnValueOnce(of(axiosResponseFactory.build({ data: response })));
 

apps/server/src/infra/schulconnex-client/schulconnex-rest-client.ts

@@ -8,7 +8,12 @@ import QueryString from 'qs';
 import { lastValueFrom, Observable } from 'rxjs';
 import { SchulconnexConfigurationMissingLoggable } from './loggable';
 import { SchulconnexPersonenInfoParams } from './request';
-import { SchulconnexPoliciesInfoResponse, SchulconnexResponse } from './response';
+import {
+	SchulconnexPoliciesInfoErrorResponse,
+	SchulconnexPoliciesInfoLicenseResponse,
+	SchulconnexPoliciesInfoResponse,
+	SchulconnexResponse,
+} from './response';
 import { SchulconnexApiInterface } from './schulconnex-api.interface';
 import { SchulconnexRestClientOptions } from './schulconnex-rest-client-options';
 
@@ -51,15 +56,18 @@ export class SchulconnexRestClient implements SchulconnexApiInterface {
 	public async getPoliciesInfo(
 		accessToken: string,
 		options?: { overrideUrl: string }
-	): Promise<SchulconnexPoliciesInfoResponse[]> {
+	): Promise<SchulconnexPoliciesInfoResponse> {
 		const url: URL = new URL(options?.overrideUrl ?? `${this.SCHULCONNEX_API_BASE_URL}/policies-info`);
 
-		const response: Promise<SchulconnexPoliciesInfoResponse[]> = this.getRequest<SchulconnexPoliciesInfoResponse[]>(
-			url,
-			accessToken
-		);
+		const response: (SchulconnexPoliciesInfoLicenseResponse | SchulconnexPoliciesInfoErrorResponse)[] =
+			await this.getRequest<(SchulconnexPoliciesInfoLicenseResponse | SchulconnexPoliciesInfoErrorResponse)[]>(
+				url,
+				accessToken
+			);
 
-		return response;
+		const responseObject: SchulconnexPoliciesInfoResponse = { data: response };
+
+		return responseObject;
 	}
 
 	private checkOptions(): boolean {

apps/server/src/infra/schulconnex-client/testing/index.ts

@@ -1,2 +1,6 @@
 export { schulconnexResponseFactory } from './schulconnex-response-factory';
-export { schulconnexPoliciesInfoResponseFactory } from './schulconnex-policies-info-response-factory';
+export {
+	schulconnexPoliciesInfoLicenseResponseFactory,
+	schulconnexPoliciesInfoErrorResponseFactory,
+	schulconnexPoliciesInfoResponseFactory,
+} from './schulconnex-policies-info-response.factory';

apps/server/src/infra/schulconnex-client/testing/schulconnex-policies-info-response.factory.ts

@@ -0,0 +1,41 @@
+import { Factory } from 'fishery';
+import {
+	SchulconnexPoliciesInfoActionType,
+	SchulconnexPoliciesInfoErrorResponse,
+	SchulconnexPoliciesInfoLicenseResponse,
+	SchulconnexPoliciesInfoResponse,
+} from '../response';
+
+export const schulconnexPoliciesInfoLicenseResponseFactory = Factory.define<SchulconnexPoliciesInfoLicenseResponse>(
+	() => {
+		return {
+			target: {
+				uid: 'bildungscloud',
+				partOf: '',
+			},
+			permission: [
+				{
+					action: [SchulconnexPoliciesInfoActionType.EXECUTE],
+				},
+			],
+		};
+	}
+);
+
+export const schulconnexPoliciesInfoErrorResponseFactory = Factory.define<SchulconnexPoliciesInfoErrorResponse>(() => {
+	return {
+		access_control: {
+			'@type': 'bilo error mock',
+			error: {
+				code: '500',
+				value: 'something went wrong',
+			},
+		},
+	};
+});
+
+export const schulconnexPoliciesInfoResponseFactory = Factory.define<SchulconnexPoliciesInfoResponse>(() => {
+	return {
+		data: [schulconnexPoliciesInfoLicenseResponseFactory.build(), schulconnexPoliciesInfoErrorResponseFactory.build()],
+	};
+});

apps/server/src/modules/idp-console/idp-console.module.ts

@@ -1,6 +1,6 @@
 import { ConsoleWriterModule } from '@infra/console';
 import { RabbitMQWrapperModule } from '@infra/rabbitmq';
-import { SchulconnexClientModule } from '@infra/schulconnex-client';
+import { SchulconnexClientModule } from '@infra/schulconnex-client/schulconnex-client.module';
 import { MikroOrmModule } from '@mikro-orm/nestjs';
 import { defaultMikroOrmOptions } from '@modules/server';
 import { SynchronizationEntity, SynchronizationModule } from '@modules/synchronization';

apps/server/src/modules/idp-console/uc/synchronization.uc.spec.ts

@@ -1,5 +1,6 @@
 import { createMock, DeepMocked } from '@golevelup/ts-jest';
-import { SchulconnexResponse, schulconnexResponseFactory, SchulconnexRestClient } from '@infra/schulconnex-client';
+import { SchulconnexResponse, SchulconnexRestClient } from '@infra/schulconnex-client';
+import { schulconnexResponseFactory } from '@infra/schulconnex-client/testing';
 import {
 	Synchronization,
 	synchronizationFactory,

apps/server/src/modules/oauth/index.ts

@@ -1,3 +1,2 @@
-export * from './oauth.module';
 export * from './interface';
 export * from './service';

apps/server/src/modules/provisioning/loggable/index.ts

@@ -5,3 +5,4 @@ export * from './school-name-required-loggable-exception';
 export * from './group-role-unknown.loggable';
 export { SchoolExternalToolCreatedLoggable } from './school-external-tool-created.loggable';
 export { FetchingPoliciesInfoFailedLoggable } from './fetching-policies-info-failed.loggable';
+export { PoliciesInfoErrorResponseLoggable } from './policies-info-error-response-loggable';

apps/server/src/modules/provisioning/loggable/policies-info-error-response-loggable.spec.ts

@@ -0,0 +1,31 @@
+import { SchulconnexPoliciesInfoErrorResponse } from '@infra/schulconnex-client';
+import { schulconnexPoliciesInfoErrorResponseFactory } from '@infra/schulconnex-client/testing';
+import { PoliciesInfoErrorResponseLoggable } from './policies-info-error-response-loggable';
+
+describe(PoliciesInfoErrorResponseLoggable.name, () => {
+	describe('getLogMessage', () => {
+		const setup = () => {
+			const errorResponse: SchulconnexPoliciesInfoErrorResponse = schulconnexPoliciesInfoErrorResponseFactory.build();
+
+			const loggable: PoliciesInfoErrorResponseLoggable = new PoliciesInfoErrorResponseLoggable(errorResponse);
+
+			return {
+				loggable,
+				errorResponse,
+			};
+		};
+
+		it('should return the correct log message', () => {
+			const { loggable, errorResponse } = setup();
+
+			expect(loggable.getLogMessage()).toEqual({
+				message: 'The /policies-info endpoint returned an error for a media source.',
+				data: {
+					type: errorResponse.access_control['@type'],
+					code: errorResponse.access_control.error.code,
+					value: errorResponse.access_control.error.value,
+				},
+			});
+		});
+	});
+});

apps/server/src/modules/provisioning/loggable/policies-info-error-response-loggable.ts

@@ -0,0 +1,17 @@
+import { SchulconnexPoliciesInfoErrorResponse } from '@infra/schulconnex-client';
+import { Loggable, LoggableMessage } from '@shared/common/loggable/interfaces';
+
+export class PoliciesInfoErrorResponseLoggable implements Loggable {
+	constructor(private readonly item: SchulconnexPoliciesInfoErrorResponse) {}
+
+	getLogMessage(): LoggableMessage {
+		return {
+			message: 'The /policies-info endpoint returned an error for a media source.',
+			data: {
+				type: this.item.access_control['@type'],
+				code: this.item.access_control.error.code,
+				value: this.item.access_control.error.value,
+			},
+		};
+	}
+}

apps/server/src/modules/provisioning/provisioning.module.ts

@@ -10,7 +10,7 @@ import { SchoolExternalToolModule } from '@modules/tool/school-external-tool';
 import { UserModule } from '@modules/user';
 import { Module } from '@nestjs/common';
 import { LoggerModule } from '@src/core/logger';
-import { SchulconnexClientModule } from '@src/infra/schulconnex-client';
+import { SchulconnexClientModule } from '@src/infra/schulconnex-client/schulconnex-client.module';
 import { ClassModule } from '../class';
 import { UserLicenseModule } from '../user-license';
 import { ProvisioningService } from './service/provisioning.service';

apps/server/src/modules/provisioning/strategy/sanis/index.ts

@@ -1,2 +1,2 @@
-export * from './sanis.strategy';
+export { SanisProvisioningStrategy } from './sanis.strategy';
 export { SchulconnexResponseMapper } from './schulconnex-response-mapper';