N21-2062 renaming lizenz-info and skip on error (#5132)

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

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

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

@@ -15,4 +15,4 @@ export { SchulconnexResponseValidationGroups } from './schulconnex-response-vali
 export { SchulconnexErreichbarkeitenResponse } from './schulconnex-erreichbarkeiten-response';
 export { SchulconnexCommunicationType } from './schulconnex-communication-type';
 export { SchulconnexLaufzeitResponse, lernperiodeFormat } from './schulconnex-laufzeit-response';
-export * from './lizenz-info';
+export * from './policies-info';

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

@@ -0,0 +1,4 @@
+export { SchulconnexPoliciesInfoTargetResponse } from './schulconnex-policies-info-target-response';
+export { SchulconnexPoliciesInfoResponse } from './schulconnex-policies-info-response';
+export { SchulconnexPoliciesInfoActionType } from './schulconnex-policies-info-action-type';
+export { SchulconnexPoliciesInfoPermissionResponse } from './schulconnex-policies-info-permission-response';

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

@@ -0,0 +1,3 @@
+export enum SchulconnexPoliciesInfoActionType {
+	EXECUTE = 'execute',
+}

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

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

apps/server/src/infra/schulconnex-client/response/policies-info/schulconnex-policies-info-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 SchulconnexPoliciesInfoResponse {
+	@IsObject()
+	@ValidateNested()
+	@Type(() => SchulconnexPoliciesInfoTargetResponse)
+	target!: SchulconnexPoliciesInfoTargetResponse;
+
+	@IsArray()
+	@ValidateNested({ each: true })
+	@Type(() => SchulconnexPoliciesInfoPermissionResponse)
+	permission!: SchulconnexPoliciesInfoPermissionResponse[];
+}

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

@@ -1,6 +1,6 @@
 import { IsOptional, IsString } from 'class-validator';
 
-export class SchulconnexLizenzInfoTargetResponse {
+export class SchulconnexPoliciesInfoTargetResponse {
 	@IsString()
 	uid!: string;
 

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

@@ -1,10 +1,10 @@
 import { SchulconnexPersonenInfoParams } from './request';
-import { SchulconnexLizenzInfoResponse, SchulconnexResponse } from './response';
+import { SchulconnexPoliciesInfoResponse, SchulconnexResponse } from './response';
 
 export interface SchulconnexApiInterface {
 	getPersonInfo(accessToken: string, options?: { overrideUrl: string }): Promise<SchulconnexResponse>;
 
 	getPersonenInfo(params: SchulconnexPersonenInfoParams): Promise<SchulconnexResponse[]>;
 
-	getLizenzInfo(accessToken: string, options?: { overrideUrl: string }): Promise<SchulconnexLizenzInfoResponse[]>;
+	getPoliciesInfo(accessToken: string, options?: { overrideUrl: string }): Promise<SchulconnexPoliciesInfoResponse[]>;
 }

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

@@ -5,11 +5,10 @@ import { axiosResponseFactory } from '@shared/testing';
 import { Logger } from '@src/core/logger';
 import { of } from 'rxjs';
 import { SchulconnexConfigurationMissingLoggable } from './loggable';
-import { SchulconnexLizenzInfoResponse, SchulconnexResponse } from './response';
+import { SchulconnexPoliciesInfoResponse, SchulconnexResponse } from './response';
 import { SchulconnexRestClient } from './schulconnex-rest-client';
 import { SchulconnexRestClientOptions } from './schulconnex-rest-client-options';
-import { schulconnexResponseFactory } from './testing';
-import { schulconnexLizenzInfoResponseFactory } from './testing/schulconnex-lizenz-info-response-factory';
+import { schulconnexPoliciesInfoResponseFactory, schulconnexResponseFactory } from './testing';
 
 describe(SchulconnexRestClient.name, () => {
 	let client: SchulconnexRestClient;
@@ -196,11 +195,11 @@ describe(SchulconnexRestClient.name, () => {
 		});
 	});
 
-	describe('getLizenzInfo', () => {
-		describe('when requesting lizenz-info', () => {
+	describe('getPoliciesInfo', () => {
+		describe('when requesting policies-info', () => {
 			const setup = () => {
 				const accessToken = 'accessToken';
-				const response: SchulconnexLizenzInfoResponse[] = schulconnexLizenzInfoResponseFactory.buildList(1);
+				const response: SchulconnexPoliciesInfoResponse[] = schulconnexPoliciesInfoResponseFactory.buildList(1);
 
 				httpService.get.mockReturnValueOnce(of(axiosResponseFactory.build({ data: response })));
 
@@ -212,9 +211,9 @@ describe(SchulconnexRestClient.name, () => {
 			it('should make a request to a SchulConneX-API', async () => {
 				const { accessToken } = setup();
 
-				await client.getLizenzInfo(accessToken);
+				await client.getPoliciesInfo(accessToken);
 
-				expect(httpService.get).toHaveBeenCalledWith(`${options.apiUrl ?? ''}/lizenz-info`, {
+				expect(httpService.get).toHaveBeenCalledWith(`${options.apiUrl ?? ''}/policies-info`, {
 					headers: {
 						Authorization: `Bearer ${accessToken}`,
 						'Accept-Encoding': 'gzip',
@@ -225,7 +224,7 @@ describe(SchulconnexRestClient.name, () => {
 			it('should return the response', async () => {
 				const { accessToken } = setup();
 
-				const result: SchulconnexLizenzInfoResponse[] = await client.getLizenzInfo(accessToken);
+				const result: SchulconnexPoliciesInfoResponse[] = await client.getPoliciesInfo(accessToken);
 
 				expect(result).toBeDefined();
 			});
@@ -234,8 +233,8 @@ describe(SchulconnexRestClient.name, () => {
 		describe('when overriding the url', () => {
 			const setup = () => {
 				const accessToken = 'accessToken';
-				const customUrl = 'https://override.url/lizenz-info';
-				const response: SchulconnexLizenzInfoResponse[] = schulconnexLizenzInfoResponseFactory.buildList(1);
+				const customUrl = 'https://override.url/policies-info';
+				const response: SchulconnexPoliciesInfoResponse[] = schulconnexPoliciesInfoResponseFactory.buildList(1);
 
 				httpService.get.mockReturnValueOnce(of(axiosResponseFactory.build({ data: response })));
 
@@ -248,7 +247,7 @@ describe(SchulconnexRestClient.name, () => {
 			it('should make a request to a SchulConneX-API', async () => {
 				const { accessToken, customUrl } = setup();
 
-				await client.getLizenzInfo(accessToken, { overrideUrl: customUrl });
+				await client.getPoliciesInfo(accessToken, { overrideUrl: customUrl });
 
 				expect(httpService.get).toHaveBeenCalledWith(customUrl, expect.anything());
 			});

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

@@ -8,7 +8,7 @@ import QueryString from 'qs';
 import { lastValueFrom, Observable } from 'rxjs';
 import { SchulconnexConfigurationMissingLoggable } from './loggable';
 import { SchulconnexPersonenInfoParams } from './request';
-import { SchulconnexLizenzInfoResponse, SchulconnexResponse } from './response';
+import { SchulconnexPoliciesInfoResponse, SchulconnexResponse } from './response';
 import { SchulconnexApiInterface } from './schulconnex-api.interface';
 import { SchulconnexRestClientOptions } from './schulconnex-rest-client-options';
 
@@ -48,13 +48,13 @@ export class SchulconnexRestClient implements SchulconnexApiInterface {
 		return response;
 	}
 
-	public async getLizenzInfo(
+	public async getPoliciesInfo(
 		accessToken: string,
 		options?: { overrideUrl: string }
-	): Promise<SchulconnexLizenzInfoResponse[]> {
-		const url: URL = new URL(options?.overrideUrl ?? `${this.SCHULCONNEX_API_BASE_URL}/lizenz-info`);
+	): Promise<SchulconnexPoliciesInfoResponse[]> {
+		const url: URL = new URL(options?.overrideUrl ?? `${this.SCHULCONNEX_API_BASE_URL}/policies-info`);
 
-		const response: Promise<SchulconnexLizenzInfoResponse[]> = this.getRequest<SchulconnexLizenzInfoResponse[]>(
+		const response: Promise<SchulconnexPoliciesInfoResponse[]> = this.getRequest<SchulconnexPoliciesInfoResponse[]>(
 			url,
 			accessToken
 		);

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

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

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

@@ -0,0 +1,16 @@
+import { Factory } from 'fishery';
+import { SchulconnexPoliciesInfoActionType, SchulconnexPoliciesInfoResponse } from '../response';
+
+export const schulconnexPoliciesInfoResponseFactory = Factory.define<SchulconnexPoliciesInfoResponse>(() => {
+	return {
+		target: {
+			uid: 'bildungscloud',
+			partOf: '',
+		},
+		permission: [
+			{
+				action: [SchulconnexPoliciesInfoActionType.EXECUTE],
+			},
+		],
+	};
+});

apps/server/src/modules/provisioning/loggable/fetching-policies-info-failed.loggable.spec.ts

@@ -0,0 +1,31 @@
+import { ExternalUserDto } from '../dto';
+import { FetchingPoliciesInfoFailedLoggable } from './fetching-policies-info-failed.loggable';
+
+describe(FetchingPoliciesInfoFailedLoggable.name, () => {
+	describe('getLogMessage', () => {
+		const setup = () => {
+			const externalUserDto: ExternalUserDto = {
+				externalId: 'someId',
+			};
+			const policiesInfoEndpoint = 'someEndpoint';
+
+			const loggable = new FetchingPoliciesInfoFailedLoggable(externalUserDto, policiesInfoEndpoint);
+
+			return { loggable, externalUserDto, policiesInfoEndpoint };
+		};
+
+		it('should return a loggable message', () => {
+			const { loggable, externalUserDto, policiesInfoEndpoint } = setup();
+
+			const message = loggable.getLogMessage();
+
+			expect(message).toEqual({
+				message: 'Could not fetch policies info for user. The provisioning of licenses will be skipped.',
+				data: {
+					externalUserId: externalUserDto.externalId,
+					policiesInfoEndpoint,
+				},
+			});
+		});
+	});
+});

apps/server/src/modules/provisioning/loggable/fetching-policies-info-failed.loggable.ts

@@ -0,0 +1,16 @@
+import { ErrorLogMessage, Loggable, LogMessage, ValidationErrorLogMessage } from '@src/core/logger';
+import { ExternalUserDto } from '../dto';
+
+export class FetchingPoliciesInfoFailedLoggable implements Loggable {
+	constructor(private readonly user: ExternalUserDto, private readonly policiesInfoEndpoint: string) {}
+
+	getLogMessage(): LogMessage | ErrorLogMessage | ValidationErrorLogMessage {
+		return {
+			message: 'Could not fetch policies info for user. The provisioning of licenses will be skipped.',
+			data: {
+				externalUserId: this.user.externalId,
+				policiesInfoEndpoint: this.policiesInfoEndpoint,
+			},
+		};
+	}
+}

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

@@ -2,3 +2,4 @@ export * from './user-for-group-not-found.loggable';
 export * from './school-for-group-not-found.loggable';
 export * from './group-role-unknown.loggable';
 export { SchoolExternalToolCreatedLoggable } from './school-external-tool-created.loggable';
+export { FetchingPoliciesInfoFailedLoggable } from './fetching-policies-info-failed.loggable';

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

@@ -1,7 +1,7 @@
 export interface ProvisioningConfig {
 	FEATURE_SCHULCONNEX_COURSE_SYNC_ENABLED: boolean;
 	FEATURE_SCHULCONNEX_MEDIA_LICENSE_ENABLED: boolean;
-	PROVISIONING_SCHULCONNEX_LIZENZ_INFO_URL: string;
+	PROVISIONING_SCHULCONNEX_POLICIES_INFO_URL: string;
 	FEATURE_SANIS_GROUP_PROVISIONING_ENABLED: boolean;
 	FEATURE_OTHER_GROUPUSERS_PROVISIONING_ENABLED: boolean;
 }