department-of-veterans-affairs / va.gov-cms

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
98 stars 68 forks source link

Add VA web components to injected header #11313

Closed wesrowe closed 4 months ago

wesrowe commented 2 years ago

Description

User story

AS A PO/PM I WANT to ensure all web components are available to the injected header SO THAT the injected header can't be broken by the accidental addition of a web component that's not properly imported.

Engineering notes / background

Branch "draft": injected-header-web-components (diff).

Analytics considerations

Quality / testing notes

Daniel has extensive functional testing notes in comments on Discovery ticket 11260.

Basic verification needed:

Acceptance criteria

jtmst commented 1 year ago

Issues with getting flipper logic to work in the proxy-redirect app are slowing this ticket down. Its crucial that we have flippers in order to test this in prod, but the current config forces a 5 second render delay before it can appropriately load in the feature toggles. More work needs done to ensure this is safe to merge

jilladams commented 1 year ago

@jtmst when you get a chance, could you update recent status? I know last week you mentioned in scrum, but I've lost mental track.

jtmst commented 1 year ago

I'm fairly confident that we won't be able to feature flag the functionality here, only the test data. I'll need to make sure the team is confident in the proposed fix before merging and likely prep a revert PR just in case before merging. Will bring to up with team tomorrow

jilladams commented 1 year ago

Note from planning: let's vet our current state of affairs with Platform front-end for any potential insights.

jilladams commented 1 year ago

Launch plan:

  1. Prep a revert PR, just in case
  2. Merge the original PR with tomorrow's daily deploy, to ship the web component package itself to injected header sites
  3. Watch launch & propagation to injected sites - will tell us if the package itself causes any issue
  4. If that causes problems: roll back with the revert PR
  5. Then: enable a test feature flag to enable an invisible test VA modal component that will appear in the DOM, to confirm it all works.
jilladams commented 1 year ago

Merged/deployed today, headers no longer show on TeamSites, rolling back. Platform thread for OOB deploy: https://dsva.slack.com/archives/CBU0KDSB1/p1688067509766669 Postmortem will be forthcoming.

humancompanion-usds commented 1 year ago

@jilladams and @jtmst - The Design System Team and I might be able to help with Cypress tests for the injected header. Brooks had a way of doing this. Let me know if that is of use here.

jilladams commented 1 year ago

Thanks @humancompanion-usds ! You'll be tagged in on the postmortem, and would appreciate any suggestions re: additional action items, etc. in this direction.

jilladams commented 1 year ago

Per post-mortem: we do not have a means of testing pre-prod. We need to regroup re: roll forward plan. Given FE staffing, with Josh moving to AP now / Chris joining, we are opting to move this out of sprint until a more fully staffed point to revisit that plan.

jilladams commented 1 year ago

From 7/5 sprint planning: DaveC proposal to verify with DS for buy-in: We will not try to add web components to injected header prior to the federal header. Notes in the federal header epic re: how we may be able to manage this moving forward.

from https://github.com/department-of-veterans-affairs/va.gov-cms/issues/14078

  • there will not be (hopefully; DC consulting DST) VA web components in the injected FedHead
    • Instead: we are hoping to build our own web component for managing the header that can be contributed to the USWDS
  • we'll fork
  • we'll update VAgov first, then make a plan to roll out to injected sites
    • note: this may be a complicated coordination effort, as it seems like injectee sites frequently had to alter their own css styles
jilladams commented 9 months ago

Anecdotally: Matt Dingee mentioned yesterday in context of federal header project that some DS folks have tried a couple times to get web components working for injected header and have hit walls each time. Right now the trending thought is that we try to deliver a flattened header for injection instead.

FranECross commented 4 months ago

Closing this ticket because the decision was made to provide a flattened header for injection.