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

Split deferred_user_data into two API endpoints. #3975

Merged
merged 4 commits into from
Mar 15, 2023

Conversation

akash5100
Copy link
Contributor

@akash5100 akash5100 commented Mar 10, 2023

Summary

Description of the change(s) you made

This pull request addresses the performance issue by splitting the deferred user settings function into two separate functions. settingsDeferredUserApiToken() function retrieves the API token, and settingsDeferredUserSpaceByKind() retrieves space used by kind with throttling to avoid excessive requests.

The fetchDeferredUserData() function has been updated to retrieve both API token and space used by kind separately and then commit the result to the session using Promise.all.

Manual verification steps performed

  1. Run the local development server
  2. log in as a user
  3. Go to the settings page and notice 2 API endpoints getting called.

Screenshots (if applicable)

Before:

Screenshot from 2023-03-10 12-52-35
Screenshot from 2023-03-10 12-52-42

After:

Screenshot from 2023-03-10 12-51-53
Screenshot from 2023-03-10 12-52-02
Screenshot from 2023-03-10 12-52-05

Does this introduce any tech-debt items?


Reviewer guidance

How can a reviewer test these changes?

Are there any risky areas that deserve extra testing?

References

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

@akash5100 akash5100 marked this pull request as draft March 10, 2023 08:01
@akash5100
Copy link
Contributor Author

Hi @bjester, can you review the PR?

@vkWeb
Copy link
Member

vkWeb commented Mar 12, 2023

@akash5100 If this is ready for review, please mark it as "ready for review". Keeping the PR in draft signals that you are still working on the PR.

@akash5100 akash5100 marked this pull request as ready for review March 12, 2023 16:48
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.

Thanks @akash5100! It's nearly ready to merge. I left a few comments for things that need changed.

@akash5100 akash5100 requested a review from bjester March 15, 2023 15:45
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.

Manual testing looks good! Thanks @akash5100 and @vkWeb for helping out.

@bjester bjester merged commit 1a27ce2 into learningequality:unstable Mar 15, 2023
@akash5100 akash5100 deleted the bug_fix branch March 16, 2023 01:53
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.

Request to retrieve API token can take a long time
3 participants