Skip to content

Conversation

@akolson
Copy link
Member

@akolson akolson commented Sep 28, 2023

Summary

Description of the change(s) you made

This PR adds Recommendations backend with its boilerplate.

Manual verification steps performed

Not applicable under the circumstances

Does this introduce any tech-debt items?


Reviewer guidance

How can a reviewer test these changes?

  • Code review

References

Closes #4296

Comments


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

class Recommendations(Backend):

def connect(self) -> None:
return super().connect()
Copy link
Member

Choose a reason for hiding this comment

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

I was just curious, assuming that we would be needing this connect method we might want to check in other functions that request, and make_request if the connection is currently alive? if its not then we may want to establish the connection first? I believe this should not be needed in the class code itself and should be handled by the developer while using the class but a safety check before making requests can be useful?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes @ozer550 you raise a great point. I am fine with either removing it or it remaining. Though the latter enforces what needs to be done and rids the make_request from any connection detail(Single responsibility pattern!!). I am almost certain all backends have some form of connection. Its very unlikely that they keep their door open to you all the time 🙂

Copy link
Member

Choose a reason for hiding this comment

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

yes, this makes sense! I think we should let it remain here.

Copy link
Member Author

@akolson akolson left a comment

Choose a reason for hiding this comment

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

Added some comments

class Recommendations(Backend):

def connect(self) -> None:
return super().connect()
Copy link
Member Author

Choose a reason for hiding this comment

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

Yes @ozer550 you raise a great point. I am fine with either removing it or it remaining. Though the latter enforces what needs to be done and rids the make_request from any connection detail(Single responsibility pattern!!). I am almost certain all backends have some form of connection. Its very unlikely that they keep their door open to you all the time 🙂

Copy link
Member

@ozer550 ozer550 left a comment

Choose a reason for hiding this comment

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

LGTM!

@akolson akolson merged commit 109ca3c into learningequality:unstable Sep 29, 2023
@akolson akolson mentioned this pull request Aug 13, 2024
@akolson akolson mentioned this pull request Oct 1, 2024
@akolson akolson deleted the add-recommendations-backend-boilerplate branch October 31, 2024 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement the Recommendations backend [boilerplate]

2 participants