N21-1824 Course resync

apps/server/src/migrations/mikro-orm/Migration20240719115036.ts

@@ -0,0 +1,69 @@
+import { Migration } from '@mikro-orm/migrations-mongodb';
+
+export class Migration20240719115036 extends Migration {
+	async up(): Promise<void> {
+		await this.driver.aggregate('groups', [
+			{ $match: { externalSource_externalId: { $exists: true } } },
+			{
+				$set: {
+					externalSource: {
+						externalId: '$externalSource_externalId',
+						system: '$externalSource_system',
+					},
+				},
+			},
+			{ $merge: 'groups' },
+		]);
+		console.info(
+			`Migrate fields externalSource_externalId and externalSource_system to nested document externalSource`
+		);
+
+		await this.driver.nativeUpdate(
+			'groups',
+			{},
+			{
+				$unset: { externalSource_externalId: '', externalSource_system: '' },
+			}
+		);
+		console.info(`Removed fields externalSource_externalId and externalSource_system`);
+
+		await this.driver.aggregate('groups', [
+			{ $match: { externalSource: { $exists: true } } },
+			{
+				$set: {
+					externalSource: {
+						lastSyncedAt: new Date(),
+					},
+				},
+			},
+			{ $merge: 'groups' },
+		]);
+
+		console.info(`Updated nested document externalSource. Added nested field lastSyncedAt`);
+	}
+
+	async down(): Promise<void> {
+		await this.driver.aggregate('groups', [
+			{ $match: { externalSource: { $exists: true } } },
+			{
+				$set: {
+					externalSource_externalId: '$externalSource.externalId',
+					externalSource_system: '$externalSource.system',
+				},
+			},
+			{ $merge: 'groups' },
+		]);
+		console.info(
+			`Rollback: Migrate fields externalSource_externalId and externalSource_system to nested document externalSource`
+		);
+
+		await this.driver.nativeUpdate(
+			'groups',
+			{ externalSource: { $exists: true } },
+			{
+				$unset: { externalSource: '' },
+			}
+		);
+		console.info(`Removed externalSource nested document`);
+	}
+}

apps/server/src/modules/group/entity/group.entity.ts

@@ -1,5 +1,4 @@
-import { Collection, Embedded, Entity, Enum, ManyToOne, OneToMany, Property } from '@mikro-orm/core';
-import { Course as CourseEntity } from '@shared/domain/entity';
+import { Embedded, Entity, Enum, ManyToOne, Property } from '@mikro-orm/core';
 import { BaseEntityWithTimestamps } from '@shared/domain/entity/base.entity';
 import { ExternalSourceEmbeddable } from '@shared/domain/entity/external-source.embeddable';
 import { SchoolEntity } from '@shared/domain/entity/school.entity';
@@ -37,7 +36,7 @@ export class GroupEntity extends BaseEntityWithTimestamps {
 	@Enum()
 	type: GroupEntityTypes;
 
-	@Embedded(() => ExternalSourceEmbeddable, { nullable: true })
+	@Embedded(() => ExternalSourceEmbeddable, { nullable: true, object: true })
 	externalSource?: ExternalSourceEmbeddable;
 
 	@Embedded(() => GroupValidPeriodEmbeddable, { nullable: true })
@@ -49,9 +48,6 @@ export class GroupEntity extends BaseEntityWithTimestamps {
 	@ManyToOne(() => SchoolEntity, { nullable: true })
 	organization?: SchoolEntity;
 
-	@OneToMany(() => CourseEntity, (course: CourseEntity) => course.syncedWithGroup)
-	syncedCourses: Collection<CourseEntity> = new Collection<CourseEntity>(this);
-
 	constructor(props: GroupEntityProps) {
 		super();
 		if (props.id) {

apps/server/src/modules/group/repo/group-domain.mapper.ts

@@ -70,6 +70,7 @@ export class GroupDomainMapper {
 		const externalSourceEntity: ExternalSourceEmbeddable = new ExternalSourceEmbeddable({
 			externalId: externalSource.externalId,
 			system: em.getReference(SystemEntity, externalSource.systemId),
+			lastSyncedAt: externalSource.lastSyncedAt,
 		});
 
 		return externalSourceEntity;
@@ -79,6 +80,7 @@ export class GroupDomainMapper {
 		const externalSource: ExternalSource = new ExternalSource({
 			externalId: entity.externalId,
 			systemId: entity.system.id,
+			lastSyncedAt: entity.lastSyncedAt,
 		});
 
 		return externalSource;

apps/server/src/modules/group/repo/group.repo.spec.ts

@@ -68,6 +68,7 @@ describe('GroupRepo', () => {
 					externalSource: new ExternalSource({
 						externalId: group.externalSource?.externalId ?? '',
 						systemId: group.externalSource?.system.id ?? '',
+						lastSyncedAt: group.externalSource?.lastSyncedAt ?? new Date(2024, 1, 1),
 					}),
 					users: [
 						new GroupUser({
@@ -676,6 +677,7 @@ describe('GroupRepo', () => {
 					externalSource: new ExternalSource({
 						externalId: groupEntity.externalSource?.externalId ?? '',
 						systemId: groupEntity.externalSource?.system.id ?? '',
+						lastSyncedAt: groupEntity.externalSource?.lastSyncedAt ?? new Date(2024, 1, 1),
 					}),
 					users: [
 						new GroupUser({

apps/server/src/modules/group/repo/group.repo.ts

@@ -40,7 +40,7 @@ export class GroupRepo extends BaseDomainObjectRepo<Group, GroupEntity> {
 		const entity: GroupEntity | null = await this.em.findOne(GroupEntity, {
 			externalSource: {
 				externalId,
-				system: systemId,
+				system: new ObjectId(systemId),
 			},
 		});
 

apps/server/src/modules/group/repo/group.scope.ts

@@ -21,7 +21,7 @@ export class GroupScope extends Scope<GroupEntity> {
 
 	bySystemId(id: EntityId | undefined): this {
 		if (id) {
-			this.addQuery({ externalSource: { system: id } });
+			this.addQuery({ externalSource: { system: new ObjectId(id) } });
 		}
 		return this;
 	}

apps/server/src/modules/group/uc/class-group.uc.spec.ts

@@ -5,8 +5,8 @@ import { ClassService } from '@modules/class';
 import { Class } from '@modules/class/domain';
 import { classFactory } from '@modules/class/domain/testing/factory/class.factory';
 import { ClassGroupUc } from '@modules/group/uc/class-group.uc';
+import { CourseDoService } from '@modules/learnroom';
 import { Course } from '@modules/learnroom/domain';
-import { CourseDoService } from '@modules/learnroom/service/course-do.service';
 import { courseFactory } from '@modules/learnroom/testing';
 import { SchoolYearService } from '@modules/legacy-school';
 import { ProvisioningConfig } from '@modules/provisioning';

apps/server/src/modules/group/uc/class-group.uc.ts

@@ -1,8 +1,8 @@
 import { AuthorizationContextBuilder, AuthorizationService } from '@modules/authorization';
 import { ClassService } from '@modules/class';
 import { Class } from '@modules/class/domain';
+import { CourseDoService } from '@modules/learnroom';
 import { Course } from '@modules/learnroom/domain';
-import { CourseDoService } from '@modules/learnroom/service/course-do.service';
 import { SchoolYearService } from '@modules/legacy-school';
 import { ProvisioningConfig } from '@modules/provisioning';
 import { School, SchoolService, SchoolYear } from '@modules/school/domain';

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

@@ -5,6 +5,7 @@ export {
 	CourseCopyService,
 	CourseGroupService,
 	CourseService,
+	CourseDoService,
 	DashboardService,
 	RoomsService,
 } from './service';

apps/server/src/modules/provisioning/strategy/oidc/service/schulconnex-course-sync.service.spec.ts

@@ -1,8 +1,8 @@
 import { createMock, DeepMocked } from '@golevelup/ts-jest';
 import { ObjectId } from '@mikro-orm/mongodb';
 import { Group, GroupUser } from '@modules/group';
+import { CourseDoService } from '@modules/learnroom';
 import { Course } from '@modules/learnroom/domain';
-import { CourseDoService } from '@modules/learnroom/service/course-do.service';
 import { courseFactory } from '@modules/learnroom/testing';
 import { RoleDto, RoleService } from '@modules/role';
 import { Test, TestingModule } from '@nestjs/testing';
@@ -181,7 +181,11 @@ describe(SchulconnexCourseSyncService.name, () => {
 			const setup = () => {
 				const studentUserId = new ObjectId().toHexString();
 				const teacherUserId = new ObjectId().toHexString();
-				const course: Course = courseFactory.build({ teacherIds: [teacherUserId], studentIds: [studentUserId] });
+				const course: Course = courseFactory.build({
+					teacherIds: [teacherUserId],
+					studentIds: [studentUserId],
+					syncedWithGroup: new ObjectId().toHexString(),
+				});
 				const studentRoleId: string = new ObjectId().toHexString();
 				const studentRole: RoleDto = roleDtoFactory.build({ id: studentRoleId });
 				const teacherRole: RoleDto = roleDtoFactory.build();
@@ -205,7 +209,7 @@ describe(SchulconnexCourseSyncService.name, () => {
 				};
 			};
 
-			it('should keep the last teacher, remove all students and break the sync with the group', async () => {
+			it('should keep the last teacher, remove all students', async () => {
 				const { course, newGroup, teacherUserId } = setup();
 
 				await service.synchronizeCourseWithGroup(newGroup, newGroup);
@@ -218,7 +222,7 @@ describe(SchulconnexCourseSyncService.name, () => {
 						untilDate: newGroup.validUntil,
 						studentIds: [],
 						teacherIds: [teacherUserId],
-						syncedWithGroup: undefined,
+						syncedWithGroup: course.syncedWithGroup,
 					}),
 				]);
 			});

apps/server/src/modules/provisioning/strategy/oidc/service/schulconnex-course-sync.service.ts

@@ -1,5 +1,5 @@
 import { Group, GroupUser } from '@modules/group';
-import { CourseDoService } from '@modules/learnroom/service/course-do.service';
+import { CourseDoService } from '@modules/learnroom';
 import { RoleDto, RoleService } from '@modules/role';
 import { Injectable } from '@nestjs/common';
 import { RoleName } from '@shared/domain/interface';
@@ -38,7 +38,6 @@ export class SchulconnexCourseSyncService {
 				} else {
 					// Remove all remaining students and break the link, when the last teacher of the group should be removed
 					course.students = [];
-					course.syncedWithGroup = undefined;
 				}
 			});