[REFERENCE] feat: introduce Gateway Aggregation / Backend-for-Frontend abstraction via LearnerPortalBFFAPIView #572
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
adamstankiewicz
changed the title
adamstankiewicz
force-pushed
the
ags/poc-learner-portal-bff
branch
2 times, most recently
from
fcb96e8 to
023a9d7
Compare
adamstankiewicz
commented
Oct 9, 2024
Comment on lines
+8
to
+16
| def get_request_id(): | ||
| """ | ||
| Helper to get the request id - usually set via an X-Request-ID header | ||
| """ | ||
| request = crum.get_current_request() | ||
| if request is not None and request.headers is not None: | ||
| return request.headers.get('X-Request-ID') | ||
| else: | ||
| return None |
There was a problem hiding this comment.
[inform] Replicated from here
adamstankiewicz
force-pushed
the
ags/poc-learner-portal-bff
branch
from
023a9d7 to
4dabe51
Compare
…n via LearnerPortalBFFAPIView
adamstankiewicz
force-pushed
the
ags/poc-learner-portal-bff
branch
from
4dabe51 to
52aa2d9
Compare
4 tasks
adamstankiewicz
commented
Oct 11, 2024
Comment on lines
+135
to
+144
| { | ||
| 'uuid': subscription_license.get('uuid'), | ||
| 'status': subscription_license.get('status'), | ||
| 'user_email': subscription_license.get('user_email'), | ||
| 'activation_date': subscription_license.get('activation_date'), | ||
| 'last_remind_date': subscription_license.get('last_remind_date'), | ||
| 'revoked_date': subscription_license.get('revoked_date'), | ||
| 'activation_key': subscription_license.get('activation_key'), | ||
| 'subscription_plan': subscription_license.get('subscription_plan', {}), | ||
| } |
There was a problem hiding this comment.
[inform] Extract only the fields the frontend really needs.
adamstankiewicz
commented
Oct 11, 2024
| and customer_agreement.get('net_days_until_expiration') > 0 | ||
| ) | ||
| idp_or_univeral_link_enabled = ( | ||
| # TODO: IDP from customer |
There was a problem hiding this comment.
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
[Context] Tech Spec
This PR introduces the
LearnerPortalBFFAPIViewas part of a new Gateway Aggregation / Backend-for-Frontend (BFF) abstraction. This new view aims to simplify the interaction between the frontend and multiple backend services, enhancing the overall architecture and making it easier to manage and extend.Key features
High-level overview
LearnerPortalBFFAPIViewexposes a POST API endpoint with a dynamicpage_routeroute parameter.HandlerContext, passing the originatingrequestandpage_routeas attributes. TheHandlerContextis responsible for keeping a shared data structure that the route handlers can mutate while loading/processing data. It also exposes anadd_errorhelper method for route handlers to use to aggregate errors. This shared context is passed to the appropriate route-specific handler (e.g.,DashboardHandler). The route handler's implementedload_and_processmethod is called, which mutates the shared context for the route handler.LearnerDashboardResponseBuilder), which exposes a.build()method called, extracting the pertinent metadata from the shared context object to return in the response. This is a clean separation of concerns between loading/processing dependent data vs. creating the desired response structure.Response.Jira
ENT-9427
Merge checklist:
./manage.py makemigrationshas been runPost merge: