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

Core functionality of connect and make_request methods on Backend class #4494

Conversation

AlexVelezLl
Copy link
Member

@AlexVelezLl AlexVelezLl commented Apr 1, 2024

Summary

Description of the change(s) you made

Implements the core funcitonlity and error handling of the connect and make_request methods on the Backend class.

Manual verification steps performed

Created various sub-classes of the Backend class testing its connect and make_requests methods.


Reviewer guidance

How can a reviewer test these changes?

Play with the Backend class, making sub-classes in the test_base.py file

References

Closes #4447


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

@AlexVelezLl AlexVelezLl marked this pull request as ready for review April 1, 2024 16:06
@AlexVelezLl AlexVelezLl requested a review from akolson April 1, 2024 16:06
@akolson akolson requested a review from bjester April 2, 2024 14:05
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.

For the most part, it looks great! Mostly some small things. The most important things that could use attention are:

  1. the issue with url_prefix="", *args, **kwargs
  2. exception logging
  3. retry behavior
  4. repeat calls to __init__

contentcuration/automation/utils/appnexus/base.py Outdated Show resolved Hide resolved
contentcuration/automation/utils/appnexus/base.py Outdated Show resolved Hide resolved
contentcuration/automation/utils/appnexus/base.py Outdated Show resolved Hide resolved
contentcuration/automation/utils/appnexus/base.py Outdated Show resolved Hide resolved
contentcuration/automation/utils/appnexus/base.py Outdated Show resolved Hide resolved
contentcuration/automation/utils/appnexus/base.py Outdated Show resolved Hide resolved
@rtibbles
Copy link
Member

rtibbles commented Apr 4, 2024

I have merged #4499 so rebasing this PR on the current search-recommendations branch should fix the build issue that was observed here!

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.

Looking great! Sorry for the late followup. I responded to your question about the timeouts.

@AlexVelezLl
Copy link
Member Author

Thank you @bjester!! Just added the timeout to the backend request 👐.

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.

Revisiting this I caught more things. Sorry for the back and forth. I think this will be the last before approval.

contentcuration/automation/utils/appnexus/base.py Outdated Show resolved Hide resolved
contentcuration/automation/utils/appnexus/base.py Outdated Show resolved Hide resolved
contentcuration/automation/utils/appnexus/base.py Outdated Show resolved Hide resolved
@AlexVelezLl
Copy link
Member Author

Thank you @bjester! I have addressed the comments 👐.

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.

Nice work!

@bjester bjester merged commit c77b320 into learningequality:search-recommendations May 16, 2024
13 checks passed
@AlexVelezLl AlexVelezLl deleted the backend-abstract-class branch May 16, 2024 15:47
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.

None yet

4 participants