-
Notifications
You must be signed in to change notification settings - Fork 8
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
Show BCD mapping progress on front page #819
Conversation
288a534
to
204f502
Compare
204f502
to
acd7f2d
Compare
This is a temporary feature. The plan is to manually update the score in the storage bucket and have the frontend query that. App deployers will have to update the score manually. This should only last through December.
acd7f2d
to
c736e79
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the timeframe on the how long we will need to display this number? Was it estimated to be just from now until the end of the year or early 2025, or will it always be needed? Why mark it as disabled rather than remove the code?
The idea is to remove the code but we can easily turn this feature off while we wait for the next engineer to do the deployment (or if we need to turn it off beforehand for any other reasons) Timeframe: this ideally would go away by mid December. |
What's the procedure to disable showing this text? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but I had one clarification question in a reply to an earlier comment.
Good question. I have added instructions to the DEPLOYMENT.md on how to handle this |
This is a temporary feature. The plan is to manually update the score in the storage bucket and have the frontend query that.
App deployers will have to update the score manually. This should only last through December.
The BCD mapping progress will be hosted in a publicly exposed GCS bucket. The changes modify the frontend configuration so that the URL for json is passed in. We add a new
WEB_FEATURES_PROGRESS_URL
environment variable. This is where app deployers can configure the setting. (Just like the other frontend settings)The data will have the following form:
{"bcd_map_progress": number}
Users will see this percentage on the overview page. When the mapping is complete, we can turn off the feature by setting the body to
{"is_disabled": true}
in the GCS bucket.Architecture of changes:
webstatus-overview-content
This is the visual component that we added the percentage to. This is responsible for the presentation layer for this change via a new
renderMappingPercentage
.webstatus-webfeature-progress-service
This is a new service that maintains the business logic to get the data from the GCS bucket. It communicates to consumers via a new context
webFeatureProgressContext
. While webstatus-overview-content is the only consumer, we could easily support other visual components by having them consume the data from the context. And each of those visual components can have their own presentation.Other changes:
webfeatures
on startup. The bucket has a file calledprogress.json
like staging and prod.