Componnet Review for file-uploader

[LovleenKala]

Ontrack Component review

Team Member Name : Lovleen Kala

Component Name

File Uploader

List of Files in this Component:

file-uploader.component.html

file-uploader.component.scss

file-uploader.coffee

Component purpose

The File Uploader component provides a interface for uploading files within the OnTrack platform. It is designed to handle various file formats, validate file types, and trigger events for successful uploads. This component is crucial for managing group-related files, such as CSV imports for group sets and student data.
This component is being used in:

Group Set Editor: Used for bulk importing student data via CSV files.
Group Member List: Supports adding multiple members to a group by uploading a CSV file.
CSV Upload Modal: Provides the main interface for uploading CSV files within modals.
Portfolio Add Extra Files Step: Enables students to upload additional files as part of their portfolio submission process.
Portfolio Learning Summary Report Step: Allows instructors and students to upload supporting documents for learning summary reports.
Upload Submission Modal: Facilitates assignment and project file submissions by students.
Task ILO Alignment Editor: Supports uploading task-related documents for alignment with intended learning outcomes (ILOs).
Student File Upload Screen: Provides a direct file upload interface for students to add required documents for assessment.

Before Migration:

Component outcomes and interactions

The File Uploader component interacts with the Group Set Editor and Group Member List components, csv-upload-modal, portfolio-add-extra-files-step,portfolio-learning-summary-report-step, upload-submission-modal, task-ilo-alignment-edior. It takes in file objects and uploads them to a specified endpoint, triggering success and completion events. It can pass the uploaded file data to the parent component for further processing.

Expected Outcomes:

Successful file upload triggers an 'on-success' event.
Completion of the entire upload triggers an 'on-complete' event.
Error handling for unsupported file types or exceeding file size limits.

Data Objects:

File Object: Represents the uploaded file.
Upload Progress: Tracks the progress of the current upload.
Upload Status: Indicates the current state (uploading, completed, failed).

Component migration plan

I aim on following the migration guide in order to migrate this componnet. After completing the code I plan on testing all the components with the parent components to make sure that everything works.

Discussion with Client (Andrew Cain)

Finally you will need to take the feedback from Andrew and Discuss any addtional considertions he
may have with this component before writing any code.

[aditya993388]

The documentation provides a clear and easy to understand overview of the File Uploader component’s role within the OnTrack platform. The purpose of the FileUploader is clearly described, with a focus on its role in handling uploads for group and portfolio modules.
The diagram showing how file-uploader interacts with components is very helpful and gives a clear picture.

However, there are so suggestions that I would like to make

1. It would be great if you fix grammar and a few typos for better understanding.("severla other componnets" ,"task-ilo-alignment-edior" )
2. You could consider briefly mentioning how this component is used in the student file upload screen, maybe referencing the “Before Migration” screenshot. This way the description and the UI will help in a great understanding
3. It would be more helpful if the migration plan clearly mentioned the exact parent components that will be tested, like Unit-Group-Set-Editor or Group-Set-Manager.

Aside from these minor suggestions, the documentation is very well-written. Excellent work!

[amriith]

Hi @LovleenKala – great work on documenting the migration plan and outlining the component’s responsibilities!

1. You've done a great job describing the component’s role and its significance within OnTrack, especially how it supports various parent components.

2. Listing out all the interacting components and expected events (on-success, on-complete) provides a clear understanding of its scope.

3. Good to see you’re planning to follow the migration guide and validate the component with parent modules post-migration.

[giangnht19]

Hi @LovleenKala - great job on file-uploader migration document
You've effectively highlighted its role within the OnTrack platform, especially how it supports key parent components and handles group-related uploads. Listing all the interacting components and expected events like on-success and on-complete gives a solid understanding of its scope and functionality. It’s also reassuring to see that you're planning to follow the migration guide and validate the component post-migration, which reflects a thoughtful and thorough approach.

[returnMarcco]

Marking this as stale. Will clear this PR off the MSPlanner ticket. Recommending this PR to be closed.