refactor: reduce duplicate workflow update calls #2129
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nsprenkle
changed the title
nsprenkle
force-pushed
the
nsprenkle/reduce-duplicate-update-calls
branch
from
69aede9 to
9499741
Compare
nsprenkle
force-pushed
the
nsprenkle/reduce-duplicate-update-calls
branch
3 times, most recently
from
5f2005c to
36b0b77
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2129 +/- ##
=======================================
Coverage 94.95% 94.95%
=======================================
Files 191 191
Lines 20608 20618 +10
Branches 1863 1867 +4
=======================================
+ Hits 19568 19578 +10
Misses 777 777
Partials 263 263
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
nsprenkle
requested review from
mattcarter,
jansenk,
muselesscreator,
leangseu-edx and
jszewczulak
nsprenkle
force-pushed
the
nsprenkle/reduce-duplicate-update-calls
branch
2 times, most recently
from
8635c6e to
96f905b
Compare
leangseu-edx
approved these changes
Jan 12, 2024
nsprenkle
force-pushed
the
nsprenkle/reduce-duplicate-update-calls
branch
from
96f905b to
112c8ee
Compare
Previously, anything that requested a workflow would cause a workflow update and refresh. This changes that logic to: 1. Only init workflow API once through load of ORA block (reloaded each time the page / ORA MFE load). 2. On load, update workflow. 3. Calls for workflow info reference cached workflow. 4. Try to update workflow when none found. Note we can still manually refresh workflow info with either get_workflow_info or update_workflow_status.
Within the new MFE calls, we need to consistently leverage the API version of workflow calls to take advantage of the cached workflow state.
nsprenkle
force-pushed
the
nsprenkle/reduce-duplicate-update-calls
branch
from
112c8ee to
969ae6e
Compare
BryanttV
pushed a commit
to eduNEXT/edx-ora2
that referenced
this pull request
Feb 6, 2024
* feat: remove duplicate workflow lookups Previously, anything that requested a workflow would cause a workflow update and refresh. This changes that logic to: 1. Only init workflow API once through load of ORA block (reloaded each time the page / ORA MFE load). 2. On load, update workflow. 3. Calls for workflow info reference cached workflow. 4. Try to update workflow when none found. Note we can still manually refresh workflow info with either get_workflow_info or update_workflow_status. * refactor: call the API version of get_workflow_info Within the new MFE calls, we need to consistently leverage the API version of workflow calls to take advantage of the cached workflow state. * docs: typo fixes and docstring updates * feat: remove no-longer-needed function_trace * fix: cache workflow on update_workflow_status * fix: remove unnecessary update in tests * style: more consistent return statements * test: refactor mocking to fix tests * chore: bump ORA to 6.0.28
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TL;DR - Reduce the number of duplicate workflow updates from common ORA data load patterns.
What changed?
Asking for a
workflowfrom theWorkflowAPIcalledget_workflow_infowhich would update the workflow before fetching workflow information. Since many of the other fields onWorkflowAPIreferenced thatworkflowproperty, asking for any of this information would cause additional refreshes of the workflow, needlessly.Loading the ORA MFE, I was averaging over 20 workflow refreshes and a local load time of ~500ms.
This PR begins to add a few refactors aimed at reducing how frequently we call a workflow update to (ideally) once per user action, calling cached workflow info any time between those actions.
workflowproperty onWorkflowAPIto return last-fetched workflow data instead of re-updating/fetching.workflowonWorkflowAPIinit (e.g. XBlock / MFE load)WorkflowAPIis initialized by memoizingworkflow_dataonOpenassessmentBlockandORADataAccessoron fetch / update.workflowwhen a workflow is not present (this is not ideal from a performance standpoint but appears to fix a large number of tests).Other changes:
gradesaccessor fromWorkflowAPI.NOTE that this does mean it is more possible to get stale workflows so it is up to each endpoint / caller to determine if they need to refresh the workflow state on a per-action basis.
Developer Checklist
Testing Instructions
Reviewer Checklist
Collectively, these should be completed by reviewers of this PR:
FYI: @openedx/content-aurora