EW-1060 common cartridge export via cc-microservice #5351
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
psachmann
reviewed
Dec 10, 2024
...c/modules/common-cartridge/common-cartridge-client/lesson-client/mapper/lesson-dto.mapper.ts
Outdated
Show resolved
Hide resolved
psachmann
approved these changes
Dec 11, 2024
| public readonly tasks!: string[]; | ||
|
|
||
| @IsArray() | ||
| @ApiProperty({ |
There was a problem hiding this comment.
discuss if @ApiProperty or @ApiPropertyOptional
Comment on lines
15
to
18
|
|
||
| timeStamps: TimestampResponseDto; | ||
|
|
||
| constructor( | ||
| id: string, | ||
| title: string, | ||
| height: number, | ||
| elements: CardResponseElementsInnerDto[], | ||
| visibilitySettings: VisibilitySettingsResponseDto, | ||
| timestamps: TimestampResponseDto | ||
| ) { | ||
| this.id = id; | ||
| this.title = title; | ||
| this.height = height; | ||
| this.elements = elements; | ||
| this.visibilitySettings = visibilitySettings; | ||
| this.timeStamps = timestamps; | ||
| constructor(props: Readonly<CardResponseDto>) { |
There was a problem hiding this comment.
accessibility modifier missing((is this new esLint rules)).
same for all dto files
Comment on lines
10
to
11
| required: true, | ||
| nullable: false, |
There was a problem hiding this comment.
default from ApiProperty can be removed
otherwise ApiPropertyOptional
| } | ||
|
|
||
| public mapTaskToResource(task: BoardTaskDto, version: CommonCartridgeVersion): CommonCartridgeResourceProps { | ||
| const intendedUse = (() => { |
There was a problem hiding this comment.
Missing return type on function
There was a problem hiding this comment.
Suggested change
| const intendedUse = (() => { | |
| const intendedUse = (() => { | |
| ``` const intendedUse = ((): CommonCartridgeIntendedUseType => { |
| task: LessonLinkedTaskDto, | ||
| version: CommonCartridgeVersion | ||
| ): CommonCartridgeResourceProps { | ||
| const intendedUse = (() => { |
Comment on lines
+116
to
+117
| if (key === 'title') title = value; | ||
| if (key === 'url') url = value; |
There was a problem hiding this comment.
missing test case ( coverage )
There was a problem hiding this comment.
it is a part of the bug in EW-1090. it will be solved also there.
| allowedAttributes: {}, | ||
| }).slice(0, 20); | ||
|
|
||
| return title.length > 20 ? `${title}...` : title; |
There was a problem hiding this comment.
missing test case ( coverage )
| this.addComponentToOrganization(content, lessonsOrganization); | ||
| }); | ||
|
|
||
| lesson.linkedTasks?.forEach((task) => { |
There was a problem hiding this comment.
test case when empty
| identifier: createIdentifier(columnId), | ||
| }); | ||
|
|
||
| if (column.cards?.length) { |
There was a problem hiding this comment.
test case when no cards
Comment on lines
16
to
23
| import { BoardTaskDto } from '../common-cartridge-client/room-client/dto/board-task.dto'; | ||
| import { createIdentifier } from '../export/utils'; | ||
| import { BoardElementDto } from '../common-cartridge-client/room-client/dto/board-element.dto'; | ||
| import { BoardElementDtoType } from '../common-cartridge-client/room-client/enums/board-element.enum'; | ||
| import { CardResponseDto } from '../common-cartridge-client/card-client/dto/card-response.dto'; | ||
| import { CardResponseElementsInnerDto } from '../common-cartridge-client/card-client/types/card-response-elements-inner.type'; | ||
| import { RichTextElementResponseDto } from '../common-cartridge-client/card-client/dto/rich-text-element-response.dto'; | ||
| import { LinkElementResponseDto } from '../common-cartridge-client/card-client/dto/link-element-response.dto'; |
There was a problem hiding this comment.
index file for Dtos no deep import
Comment on lines
+25
to
30
| const isRichTextElement = (reference: unknown): reference is RichTextElementResponseDto => | ||
| reference instanceof RichTextElementResponseDto; | ||
|
|
||
| const isLinkElement = (reference: unknown): reference is LinkElementResponseDto => | ||
| reference instanceof LinkElementResponseDto; | ||
|
|
There was a problem hiding this comment.
move into the class
There was a problem hiding this comment.
it is just used in this service. not necessary to move it to a separate class.
There was a problem hiding this comment.
i mean inside the service class
Comment on lines
1
to
245
| hidden: faker.datatype.boolean(), | ||
| }; | ||
| }); | ||
|
|
||
| export const lessonContentFactory = Factory.define<LessonContentDto>(({ sequence }) => { | ||
| return { | ||
| id: sequence.toString(), | ||
| type: faker.lorem.word(), | ||
| content: { text: 'text' }, | ||
| title: faker.lorem.sentence(), | ||
| component: 'text', | ||
| hidden: faker.datatype.boolean(), | ||
| }; | ||
| }); | ||
|
|
||
| export const lessonFactory = Factory.define<LessonDto>(({ sequence }) => { | ||
| return { | ||
| lessonId: sequence.toString(), | ||
| name: faker.lorem.word(), | ||
| courseId: undefined, | ||
| courseGroupId: faker.string.uuid(), | ||
| hidden: faker.datatype.boolean(), | ||
| position: faker.number.int(), | ||
| contents: [lessonContentFactory.build(), lernstoreContentFactory.build()], | ||
| materials: [], | ||
| linkedTasks: [lessonLinkedTaskFactory.build(), lessonLinkedTaskFactory.build()], | ||
| }; | ||
| }); | ||
|
|
||
| export const boardLessonFactory = Factory.define<BoardLessonDto>(() => { | ||
| return { | ||
| id: faker.string.uuid(), | ||
| name: faker.lorem.word(), | ||
| courseName: undefined, | ||
| hidden: faker.datatype.boolean(), | ||
| numberOfPublishedTasks: faker.number.int(), | ||
| numberOfDraftTasks: faker.number.int(), | ||
| numberOfPlannedTasks: faker.number.int(), | ||
| createdAt: faker.date.recent().toISOString(), | ||
| updatedAt: faker.date.recent().toISOString(), | ||
| }; | ||
| }); | ||
|
|
||
| export const boardTaskFactory = Factory.define<BoardTaskDto>(({ sequence }) => { | ||
| return { | ||
| id: sequence.toString(), | ||
| name: faker.lorem.word(), | ||
| createdAt: faker.date.recent().toISOString(), | ||
| updatedAt: faker.date.recent().toISOString(), | ||
| availableDate: faker.date.recent().toISOString(), | ||
| courseName: undefined, | ||
| description: faker.lorem.word(), | ||
| displayColor: faker.lorem.word(), | ||
| dueDate: faker.date.recent().toISOString(), | ||
| status: new BoardTaskStatusDto({ | ||
| submitted: faker.number.int(), | ||
| maxSubmissions: faker.number.int(), | ||
| graded: faker.number.int(), | ||
| isDraft: faker.datatype.boolean(), | ||
| isSubstitutionTeacher: faker.datatype.boolean(), | ||
| isFinished: faker.datatype.boolean(), | ||
| }), | ||
| }; | ||
| }); | ||
|
|
||
| export const boardCloumnBoardFactory = Factory.define<BoardColumnBoardDto>(() => { | ||
| return { | ||
| id: faker.string.uuid(), | ||
| title: faker.lorem.word(), | ||
| published: faker.datatype.boolean(), | ||
| createdAt: faker.date.recent().toISOString(), | ||
| updatedAt: faker.date.recent().toISOString(), | ||
| columnBoardId: faker.string.uuid(), | ||
| layout: BoardLayout.COLUMNS, | ||
| }; | ||
| }); | ||
|
|
||
| export const roomFactory = Factory.define<RoomBoardDto>(({ sequence }) => { | ||
| return { | ||
| roomId: sequence.toString(), | ||
| title: faker.lorem.word(), | ||
| displayColor: faker.lorem.word(), | ||
| elements: [ | ||
| { | ||
| type: BoardElementDtoType.TASK, | ||
| content: boardTaskFactory.build(), | ||
| }, | ||
| { | ||
| type: BoardElementDtoType.LESSON, | ||
| content: boardLessonFactory.build(), | ||
| }, | ||
| { | ||
| type: BoardElementDtoType.COLUMN_BOARD, | ||
| content: boardCloumnBoardFactory.build(), | ||
| }, | ||
| ], | ||
| isArchived: faker.datatype.boolean(), | ||
| isSynchronized: faker.datatype.boolean(), | ||
| }; | ||
| }); |
There was a problem hiding this comment.
each class separate file
| @@ -1,4 +1,4 @@ | |||
| import { ApiProperty } from '@nestjs/swagger'; | |||
| import { ApiExtraModels, ApiProperty, getSchemaPath } from '@nestjs/swagger'; | |||
There was a problem hiding this comment.
each class separate file
There was a problem hiding this comment.
it will be solved in EW-1090
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Courses can now be exported in Common Cartridge format using the CC microservice. This export process has been transferred to the Common Cartridge microservice, which collects all course data via http from the schulcloud-server.
Links to Tickets or other pull requests
Ticket
Changes
Datasecurity
Deployment
New Repos, NPM pakages or vendor scripts
Approval for review
generate-client:serverwas executed in vue frontend and changes were tested and put in a PR with the same branch name.