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 the Recommendations adapter. It also moves and deletes some redundant files.

Manual verification steps performed

NA

References

Closes #4302

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

@akolson
Copy link
Member Author

akolson commented Sep 28, 2023

cc @akash5100

@akolson akolson requested a review from ozer550 September 29, 2023 06:06
pass


class RecommendationsBackendFatory(BackendFactory):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
class RecommendationsBackendFatory(BackendFactory):
class RecommendationsBackendFactory(BackendFactory):

Copy link
Member Author

Choose a reason for hiding this comment

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

Nice spot @akash5100. I will make the changes to this

@abstractmethod
def make_request(self, url: str, params=None) -> Union[bytes, str, Dict]:
""" Makes an HTTP request to a given URL using the specified method. """
def make_request(self, request) -> Union[bytes, str, Dict]:
Copy link
Contributor

@akash5100 akash5100 Sep 29, 2023

Choose a reason for hiding this comment

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

Suggested change
def make_request(self, request) -> Union[bytes, str, Dict]:
def make_request(self, request: requests.Request) -> requests.Response:

If we are going to use requests.Request object to make request, in the base class should we add this?

and here:

def request(self) -> requests.Request: 

as this method is used to create requests.Request object. and

def response(self) -> Union[bytes, str, Dict]:

this will return response (Json, Str, Binary)

Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think @akolson @ozer550?

Copy link
Member Author

Choose a reason for hiding this comment

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

Hi @akash5100! Please refer to our discussion on slack. The object we are referring to here is the POJO equivalent in Java but this time in python. Also, we can alter the return type of the abstract method in our implementations to return whatever we want.

Copy link
Member Author

Choose a reason for hiding this comment

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

We'll clean this up so we can return either an object or array + any other that we anticipate being returned by the backends

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay, thanks

Copy link
Member Author

Choose a reason for hiding this comment

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

Alternatively, we can create base backend objects(Which i think is better)from which we can create the other specific backend objects.

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-adapter 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 RecommendationsAdapter [Boilerplate]

3 participants