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

Implement feedback object hierarchy #4373

Merged

Conversation

ozer550
Copy link
Member

@ozer550 ozer550 commented Dec 28, 2023

Summary

Create utility functions and classes to support the Feeback project.

Description of the change(s) you made

  • Add required classes to implement feedback object hierarchy.
  • Add unit tests related to implemented classes.
  • Add constants involved with the feedback mechanism.

Manual verification steps performed

  • Run frontend tests

Reviewer guidance

How can a reviewer test these changes?

  • Run the feedbackUtils.spec.js test file.

References

closes #4366

Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

*/
export class FlagFeedbackEvent extends BaseFlagFeedback {
constructor({ target_topic_id, ...baseFeedbackParams }) {
super({ target_topic_id, ...baseFeedbackParams });
Copy link
Member Author

@ozer550 ozer550 Dec 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vkWeb mentioned that, it seems like target_topic_id can be ommited here. We can access the parent_id field of the contentNode to access the target_topic_id.

@ozer550 ozer550 requested a review from bjester December 28, 2023 07:27
@vkWeb vkWeb mentioned this pull request Dec 29, 2023
25 tasks
Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing blocking. The most important aspect to revisit would be the URL handling, as I mentioned, but that would be easiest once the APIs are actually built.

* @param {string} params.target_channel_id - The ID of the target channel for the feedback event.
* @param {Object} baseFeedbackParams - Additional parameters inherited from the base feedbackclass.
*/
// eslint-disable-next-line no-unused-vars
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What was eslint complaining about here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently the BaseFeedbackEvent is not being used anywhere as the recommendations core classes like ReccommendationInteractionEvent and ReccommendationEvent class are still to be added! Hence its suggesting to remove the unused class.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this file is treated as an ES module, meaning if variables aren't used in the file then this would occur. Nothing is exported from this module, so doing that could perhaps resolve it?

.swp Outdated Show resolved Hide resolved
flagFeedbackEvent.getDataObject()
);
});
});
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job on writing up some tests!

@bjester bjester self-assigned this Mar 12, 2024
@bjester bjester merged commit 9303b92 into learningequality:unstable May 1, 2024
13 checks passed
@akolson akolson mentioned this pull request Aug 13, 2024
@akolson akolson mentioned this pull request Oct 1, 2024
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.

Implement Core Feedback Object Hierarchy
2 participants