feat: add & expose courseware.use_learning_sequences_api flag #27993
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
kdmccormick
force-pushed
the
kdmccormick/courseware-use-learning-seq-api-waffle
branch
from
a68d841 to
32e768f
Compare
doctoryes
approved these changes
Jun 22, 2021
| button, etc. This has been done so far using the Course Blocks API. | ||
| We are switching the views to instead use the Learning Sequences API, | ||
| which we expect to be significantly faster. We are putting the transition | ||
| behind a flag, for now, to allow incremental rollout and comparison testing. |
There was a problem hiding this comment.
Nit: Should this docstring (or the waffle flag comments above) say anything about incrementally honoring this flag in courseware calls? We'll have an interim period where this flag will be somewhat misleading - making someone reading the code to think that it actually controls the whether the Learning Sequences API is used - when it doesn't yet in all cases.
There was a problem hiding this comment.
Agreed! I'll call that out better.
Add a Waffle Flag. When enabled, the courseware pages of the Learning MFE should use the Learning Sequences HTTP API instead of the Course Blocks HTTP API in order to load course structure data. We expect that this switchover will lead to performance improvements and a more comprehensible system. (We are putting the switchover behind a temporary flag in order to enable debugging, incremental rollout, and comparison testing.) The flag is exposed to the MFE via the Course API. As of this commit, the new flag is not enabled in any environment, and the MFE does not have any code to act on the flag's value. So, this commit on its own should have no production impact. TNL-8330
kdmccormick
force-pushed
the
kdmccormick/courseware-use-learning-seq-api-waffle
branch
from
32e768f to
9ea561f
Compare
|
Your PR has finished running tests. There were no failures. |
kdmccormick
deleted the
kdmccormick/courseware-use-learning-seq-api-waffle
branch
|
EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production. |
|
EdX Release Notice: This PR has been deployed to the production environment. |
blarghmatey
pushed a commit
to mitodl/edx-platform
that referenced
this pull request
Aug 2, 2021
…x#27993) Add a Waffle Flag. When enabled, the courseware pages of the Learning MFE should use the Learning Sequences HTTP API instead of the Course Blocks HTTP API in order to load course structure data. We expect that this switchover will lead to performance improvements and a more comprehensible system. (We are putting the switchover behind a temporary flag in order to enable debugging, incremental rollout, and comparison testing.) The flag is exposed to the MFE via the Course API. As of this commit, the new flag is not enabled in any environment, and the MFE does not have any code to act on the flag's value. So, this commit on its own should have no production impact. TNL-8330
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.
Description
Supporting information
TNL-8330
Deadline
Soft deadline of 6/25 (weekly goal)