Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New/feedback enhancement #450

Open
wants to merge 24 commits into
base: new/feedback-enhancement
Choose a base branch
from

Conversation

coskun-kilinc
Copy link

Description

This pull request overhauls the existing feedback API, replacing Stages with Feedback Comment templates and adding feedback groups.

includes significant changes to the API structure, particularly focusing on feedback-related entities and endpoints. The changes involve the removal of certain APIs and entities, updates to existing ones, and modifications to the installation script for additional packages.

API Structure Changes:

  • app/api/api_root.rb: Replaced FeedbackApi::StageApi with FeedbackApi::FeedbackGroupApi and removed FeedbackApi::CriterionApi and FeedbackApi::CriterionOptionApi mounts. Updated authentication helpers accordingly.
  • app/api/entities/feedback_entities/criterion_entity.rb: Removed the CriterionEntity class.
  • app/api/entities/feedback_entities/criterion_option_entity.rb: Removed the CriterionOptionEntity class.
  • app/api/entities/feedback_entities/feedback_comment_entity.rb: Removed the FeedbackCommentEntity class.
  • app/api/entities/feedback_entities/feedback_comment_template_entity.rb: Added a new FeedbackCommentTemplateEntity class.

Endpoint Changes:

  • app/api/feedback_api/criterion_api.rb: Removed the entire CriterionApi class and its associated endpoints.
  • app/api/feedback_api/criterion_option_api.rb: Removed the entire CriterionOptionApi class and its associated endpoints.
  • app/api/feedback_api/feedback_comment_template_api.rb: Updated the FeedbackCommentTemplateApi class to use new parameters and logic for handling feedback comment templates.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Unit tests for all new classes

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation if appropriate
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have created or extended unit tests to address my new additions
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

If you have any questions, please contact @macite or @jakerenzella.

macite and others added 24 commits December 15, 2022 16:36
Stage will be used to sequence a number of feedback rounds when
reviewing a particular student submission. This commit adds the ability
to post and get stages.

Co-authored-by: ugonj <ugonj@users.noreply.github.com>
Co-authored-by: wakedreamer <wakedreamer@users.noreply.github.com>
Added feedback folder loading into application. No module needed
in the model. Using a module for the feedback api folder.

Co-authored-by: ugonj <ugonj@users.noreply.github.com>
Co-authored-by: wakedreamer <wakedreamer@users.noreply.github.com>
Co-authored-by: ublefo <ublefo@users.noreply.github.com>
changed task comment fail to needs improvement added migration

fix
…ncement

Merge latest changes from dev branch into backend Tutor feedback branch
The code changes add the Stage model to the Feedback API, allowing for the creation and updating of stages.
The code changes add a new table called "stages" to the schema.rb file.
This table includes columns for "title", "order", and "task_definition_id".
The code changes include the addition of tests for
the FeedbackGroup model and updated tests for the
FeedbackCommentTemplate model. These tests ensure
that a valid feedback group can be created and
that invalid feedback groups are handled
correctly.
The code changes include the addition of factories
and tests for the FeedbackGroup and
FeedbackCommentTemplate models. These factories
allow for the creation of valid feedback groups
and comment templates, and the tests ensure that
the models are functioning correctly.
The code changes include the addition of the
FeedbackGroup and FeedbackCommentTemplate models,
along with their corresponding tests. These models
allow for the creation of valid feedback groups
and comment templates, and the tests ensure their
proper functionality.
This commit updates the feedback feature api
endpoints for compatibity with revised models and
database schema.
- Modified `feedback_comment_template.rb`,
  `feedback_group.rb`, and `task_definition.rb`
  models to align with the new feedback structure.
- Removed outdated migrations related to stages
  and criterion options and introduced new
  migrations for Feedback Groups and Feedback
  Comment Templates.
- Updated schema to reflect the new feedback
  group/template structure.
- Refactored factories for
  `FeedbackCommentTemplate` and `FeedbackGroup` to
  align with the new model relationships.
- Deleted obsolete tests and introduced new tests
  for `FeedbackCommentTemplate` and
  `FeedbackGroup` to ensure correct functionality.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants