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

Show BCD mapping progress on front page #819

Merged
merged 5 commits into from
Oct 28, 2024
Merged

Conversation

jcscottiii
Copy link
Collaborator

@jcscottiii jcscottiii commented Oct 24, 2024

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:

  • Automatically populate the local GCS emulator with a bucket called webfeatures on startup. The bucket has a file called progress.json like staging and prod.
  • Modify Makefile to forward the ports to the GCS emulator.
  • Make GCS emulator a pre-requisite for the frontend to come up by modifying frontend/skaffold.yaml
  • Adding instructions that the app deployer will need to follow to update the value

@jcscottiii jcscottiii force-pushed the jcscotiii/track-progress branch 2 times, most recently from 288a534 to 204f502 Compare October 25, 2024 15:29
@jcscottiii jcscottiii marked this pull request as ready for review October 25, 2024 15:29
@jcscottiii jcscottiii linked an issue Oct 25, 2024 that may be closed by this pull request
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.
@jcscottiii jcscottiii changed the base branch from jcscottiii/change-auth-container to main October 25, 2024 22:17
Copy link
Collaborator

@jrobbins jrobbins left a 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?

@jcscottiii
Copy link
Collaborator Author

jcscottiii commented Oct 25, 2024

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.

@jrobbins
Copy link
Collaborator

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)

What's the procedure to disable showing this text?

Copy link
Collaborator

@jrobbins jrobbins left a 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.

@jcscottiii
Copy link
Collaborator Author

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)

What's the procedure to disable showing this text?

Good question. I have added instructions to the DEPLOYMENT.md on how to handle this

@jcscottiii jcscottiii added this pull request to the merge queue Oct 28, 2024
Merged via the queue into main with commit 75f646a Oct 28, 2024
6 checks passed
@jcscottiii jcscottiii deleted the jcscotiii/track-progress branch October 28, 2024 19:31
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.

[ENHANCEMENT] Show the % of BCD keys mapped
2 participants