VACMS-10626: Drupalize new homepage components #11016

dsasser · 2022-09-30T19:26:59Z

Description

Closes #10626

New Block Types:
Benefit Promo
News Promo

New entityqueues:
Home page news spotlight
Home page hero

New Menus:
Other Search Tools
Popular on VA.gov

QA steps

Create benefit promo block: https://pr11016-b9g0h6rk9avw9mnrfirx6ypjsgssems7.ci.cms.va.gov/block/add/benefit_promo
Create news promo block: https://pr11016-b9g0h6rk9avw9mnrfirx6ypjsgssems7.ci.cms.va.gov/block/add/news_promo
Add new benefit promo block to hero entityqueue: https://pr11016-b9g0h6rk9avw9mnrfirx6ypjsgssems7.ci.cms.va.gov/admin/structure/entityqueue/home_page_hero/home_page_hero?destination=/admin/structure/entityqueue
Add new news promo block to spotlight entityqueue: https://pr11016-b9g0h6rk9avw9mnrfirx6ypjsgssems7.ci.cms.va.gov/admin/structure/entityqueue/home_page_news_spotlight/home_page_news_spotlight?destination=/admin/structure/entityqueue
Add one or more links to other-search-tools menu: https://pr11016-b9g0h6rk9avw9mnrfirx6ypjsgssems7.ci.cms.va.gov/admin/structure/menu/manage/other-search-tools
Add one or more links to the popular-on-va-gov menu: https://pr11016-b9g0h6rk9avw9mnrfirx6ypjsgssems7.ci.cms.va.gov/admin/structure/menu/manage/popular-on-va-gov

Run GraphQL queries:
Validate GraphQL queries provide expected output:

query homePageHeroQuery {
  entitySubqueueById(id: "home_page_hero") {
    ... on EntitySubqueueHomePageHero {
      itemsOfEntitySubqueueHomePageHero {
        entity {
          entityId
          ... on BlockContentBenefitPromo {
            entityId
            entityLabel
            fieldPromoHeadline
            fieldPromoText
            fieldPromoCta {
              entity {
                ... on ParagraphButton {
                  fieldButtonLink {
                    url {
                      path
                    }
                  }
                  fieldButtonLabel
                }
              }
            }
          }
        }
      }
    }
  }
}


query homePageNewsSpotlightQuery {
  entitySubqueueById(id: "home_page_news_spotlight") {
    ... on EntitySubqueueHomePageNewsSpotlight {
      itemsOfEntitySubqueueHomePageNewsSpotlight {
        entity {
          entityId
          ... on BlockContentNewsPromo {
            entityId
            entityLabel
            fieldPromoHeadline
            fieldPromoText
            fieldPromoLink {
              entity {
                ... on ParagraphLinkTeaser {
                  fieldLink {
                    url {
                      path
                    }
                    title
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}


query homePageOtherSearchToolsMenuQuery {
  menuByName(name: "other-search-tools") {
    name
    links {
      label
      url {
        path
      }
      links {
        label
        url {
          path
        }
      }
    }
  }
}

query homePagePopularOnVaGovMenuQuery {
  menuByName(name: "popular-on-va-gov") {
    name
    links {
      label
      url {
        path
      }
      links {
        label
        url {
          path
        }
      }
    }
  }
}

Definition of Done

Documentation has been updated, if applicable.
Tests have been added if necessary.
Automated tests have passed.
Code Quality Tests have passed.
Acceptance Criteria in related issue are met.
Manual Code Review Approved.

Select Team for PR review

Is this PR blocked by another PR?

DO NOT MERGE

Does this PR need review from a Product Owner

Needs PO review

CMS user-facing annoucement

Is an announcement needed to let editors know of this change?

Yes, and it's written in issue ____ and queued for publication.
- Merge and ping the UX writer so they are ready to publish after deployment
Yes, but it hasn't yet been written
- Don't merge yet -- ping the UX writer to write and queue content
No announcement is needed for this code change.
- Merge & carry on unburdened by announcements

ndouglas · 2022-10-04T13:03:59Z

I noticed you encountered a test failure on Cypress. It's failing as a result of a 502 error, and I'm paying attention to these (see #10614 ), but haven't gotten much traction yet 😭

dsasser · 2022-10-04T15:18:19Z

Yeah I'm not sure what to make of that. I ran at least 3 different builds yesterday, each had unique test failures unrelated to my changes either in behat, cypress, or both, and this is just the latest of them.

swirtSJW

Thank you for the awesome QA steps. Made it a breeze.

A handful of questions.

I don't see perms on this. Are those still being determined and coming later?

config/sync/core.entity_form_display.block_content.benefit_promo.default.yml

swirtSJW · 2022-10-04T17:01:57Z

tests/behat/drupal-spec-tool/menus.feature

-| VA Wichita health care | va-wichita-health-care | VISN 15 \| va.gov/wichita-health-care |
-| VA Wilkes-Barre health care | va-wilkes-barre-health-care | VISN 4 \| va.gov/wilkes-barre-health-care |
-| VA Wilmington health care | va-wilmington-health-care | VISN 4 \| va.gov/wilmington-health-care |
+  Scenario: Menus


If you have any behat auto formatter running on your IDE we want to shut that down. It should take raw from the spectool Otherwise it makes it look like all these lines changed.

I don't have anything auto-formatting behat tests, these are copy/pasted from the spec tool directly. It is possible I copied some surrounding text or otherwise made a boo boo here. I'll correct the formatting so changes are easier to detect (I have a change to make in the content model anyway).

The other possibility is that menu tests have never been exported from airtable and so the formatting is just a result of the switch from google sheet to airtable... but i am pretty sure we did an export of all of them so that the switch only happened once in one PR that was just for that purpose.

swirtSJW · 2022-10-04T17:13:02Z

config/sync/core.entity_form_display.block_content.benefit_promo.default.yml

+      counter_position: after
+      js_prevent_submit: true
+      count_html_characters: true
+      textcount_status_message: 'Maxlength: <span class="maxlength_count">@maxlength</span><br />Used: <span class="current_count">@current_length</span><br />Remaining: <span class="remaining_count">@remaining_count</span>'


Do we want to stick with the established pattern on the rest of the site?

I was unaware there was a pattern, that is good to know. The character limits have not come back from Michelle yet, so I added some extremely generous limits for the time being to satisfy the AC as well as to help communicate that the limits have not been properly tuned for the context.

swirtSJW · 2022-10-04T17:20:03Z

config/sync/core.entity_form_display.block_content.benefit_promo.default.yml

@@ -0,0 +1,79 @@
+uuid: dc8c65f9-4223-4e21-b201-a979b27118ae


Wondering about some missing elements

do we need gudance?

guidance text?

should reuse the existing guidance

Revision log will need to be added to the yml by hand.

Do we need moderation control?

I don't know, who decides that?

Correct, I don't have guidance text provided, so it is not included in the PR

I don't know, who decides that?

I'll fix the revision settings so they match

I don't know, who decides that?

I think most of these would come from UX. @BlakeOrgan as he comes up to speed or @EWashb . For some of these they should stick with existing patterns unless there is reason to deviate.

I understand there is some need to get the fields out there so that the FE work can get started. I think it is acceptable to kick the UX part down the road in the form of another ticket if decisions on them are not ready to be finalized.

I agree with @swirtSJW. If you need to get the build out right now for the next tech step that's fine as long as it's not going out to editors like this. I would agree that we need some UX input on the writing here and should try not to deviate from existing patterns too much.

If you need to get the build out right now for the next tech step that's fine as long as it's not going out to editors like this.

I'm not sure how I can get this out without affecting the editors. Once this is merged, the new block types will be visible in the CMS.

UX Design input is in the ACs for this issue, but it wasn't clearly specified how that would be incorporated into the flow of this ticket. So, in order to get the UX design feedback kicked off as early as possible, I PR'd what I could based on the information I had available.

For some of these they should stick with existing patterns unless there is reason to deviate.
I appreciate this is the goal, but it is really difficult to see patterns when I touch so little of the code, and deviations exist. Please do what you can do call out specific deviations from patterns that you see, as it will help me learn those over time.

@dsasser is there something I can do for you now to help get this over the finish line? Are you on a timeline to have this out before the end of the sprint?

swirtSJW · 2022-10-04T17:27:09Z

config/sync/core.entity_form_display.block_content.news_promo.default.yml

@@ -0,0 +1,79 @@
+uuid: c9e89373-ad1e-4d92-98c5-5ef003aaa3fc


I'm a bit confused that both News Promo and Benefit Promo seem to be the same content shape. Is there a reason to keep them as distinct content types? (future plans for them to diverge?)

Similar feedback to guidance text and form elements missing like on the Benefit promo.

That is a good question, honestly. I gave it a good amount of thought while developing, and I ended up keeping the blocks separate because of my concern that keeping the field settings in lock-step might prevent us from having unique treatments/validations for the different situations, if that makes sense. I was concerned that the somewhat fluid details were lending themselves to having the most flexibility on the CMS side, erroring on the side of caution if you will.

Also, it didn't really occur to me that the content models could be identical (it took several iterations before I was satisfied) until they were already established. Looking back, yeah it definitely makes sense to combine them, providing we are ok with that from a UX perspective.

Makes sense.. and yes if there is a strong likelyhood of fluid changes to one but not the other down the road, then I am happy to support that unknown.

swirtSJW · 2022-10-04T17:40:26Z

config/sync/core.entity_view_display.block_content.benefit_promo.default.yml

+dependencies:
+  config:
+    - block_content.type.benefit_promo
+    - field.field.block_content.benefit_promo.field_owner


I think we want to go with field_administration rather than field_owner
According to the spec tool we have 51 instances of field_administration and 9 instance of field_owner.
field_owner was. I wish I could recall the rationale for moving away from field_owner, I don't recall.

It looks like in most cases the field_owner is applied to non-node entities (except for one outlier which I know was a mistake that snuck through) I could have my arm twisted to stick to that pattern since I don't recall the original rationale.

I was unaware of this pattern, thank you for pointing it out. I'll move to field_administration then.

swirtSJW · 2022-10-04T17:48:01Z

config/sync/system.menu.popular-on-va-gov.yml

@@ -0,0 +1,8 @@
+uuid: 9a594b0d-1ab2-44eb-8b0b-92e92dba96c5


I am not seeing anyone assigned to this menu

Thanks for pointing this out. I don't have a great grasp on permissions/workbench access yet. As a result, permissions have not been setup. We have a meeting tomorrow to discuss this where I hope to confirm some of my assumptions about how the sections + workbench access. I should have been more clear in the QA steps that permissions were not yet ready.

I'm also fine with punting perms down the road with a followup ticket if we are just trying to get the content model out there so FE work can get unblocked.

…put.

…locks.

dsasser · 2022-10-05T21:27:39Z

Closing to move to integration branch.

va-cms-bot had a problem deploying to Tugboat September 30, 2022 19:27 Error

va-cms-bot temporarily deployed to Tugboat September 30, 2022 19:28 Destroyed

va-cms-bot temporarily deployed to Tugboat September 30, 2022 19:53 Destroyed

va-cms-bot temporarily deployed to Tugboat October 3, 2022 16:47 Destroyed

va-cms-bot temporarily deployed to Tugboat October 3, 2022 19:42 Destroyed

va-cms-bot temporarily deployed to Tugboat October 3, 2022 20:24 Destroyed

dsasser marked this pull request as ready for review October 3, 2022 21:41

va-cms-bot temporarily deployed to Tugboat October 3, 2022 21:42 Destroyed

va-cms-bot temporarily deployed to Tugboat October 4, 2022 16:38 Destroyed

swirtSJW reviewed Oct 4, 2022

View reviewed changes

dsasser added 18 commits October 5, 2022 10:11

VACMS-10626: Add new benefits promo block type.

cad55b7

VACMS-10626: Add new home page hero entityqueue.

c3e2034

VAMCS-10626: Add owner field to benefit promo block.

5361cf4

VACMS-10626: Use select form widget for owner field.

1f4b93e

VACMS-10626: Add other search tools menu.

9f812e6

VACMS-10626: Add popular on va.gov menu.

5ce2a0b

VACMS-10626: Add news promo custom block and related fields.

3ad3bd6

VACMS-10626: Add feature toggle for new homepage version.

038773d

VACMS-10626: Add homepage news spotlight entityqueue.

7a2ec87

VACMS-10626: Add content model test changes.

c40b279

VACMS-10626: Add menus test updates.

3358287

VACMS-10626: Add custom block fields to behat tests.

d5d0d1d

VACMS-10626: Update custom block fields behat test from spec tool out…

c01d6d5

…put.

VACMS-10626: Update form display for news promo block.

e406264

VACMS-10626: Swap out link teaser for cta paragraph on news promo block.

cd03d53

VACMS-10626: Remove field_owner from new block types.

1eb3f7a

VACMS-10626: Add field_administration section field to new blocks.

c5f7a53

VACMS-10626: Update guidance and character count formatting for new b…

3f65849

…locks.

va-cms-bot temporarily deployed to Tugboat October 5, 2022 17:21 Destroyed

dsasser closed this Oct 5, 2022

va-cms-bot temporarily deployed to Tugboat October 5, 2022 21:35 Destroyed

dsasser mentioned this pull request Oct 5, 2022

VACMS-10626: Drupalize new homepage components #11114

Merged

26 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VACMS-10626: Drupalize new homepage components #11016

VACMS-10626: Drupalize new homepage components #11016

dsasser commented Sep 30, 2022 •

edited

Loading

ndouglas commented Oct 4, 2022

dsasser commented Oct 4, 2022

swirtSJW left a comment

swirtSJW Oct 4, 2022

dsasser Oct 4, 2022

swirtSJW Oct 5, 2022

swirtSJW Oct 4, 2022

dsasser Oct 4, 2022

swirtSJW Oct 4, 2022

dsasser Oct 4, 2022

swirtSJW Oct 4, 2022

EWashb Oct 4, 2022

dsasser Oct 4, 2022

EWashb Oct 4, 2022

swirtSJW Oct 4, 2022

swirtSJW Oct 4, 2022

dsasser Oct 4, 2022

swirtSJW Oct 4, 2022

swirtSJW Oct 4, 2022

dsasser Oct 4, 2022

swirtSJW Oct 4, 2022

dsasser Oct 4, 2022

swirtSJW Oct 4, 2022

dsasser commented Oct 5, 2022

VACMS-10626: Drupalize new homepage components #11016

VACMS-10626: Drupalize new homepage components #11016

Conversation

dsasser commented Sep 30, 2022 • edited Loading

Description

QA steps

Definition of Done

Select Team for PR review

Is this PR blocked by another PR?

Does this PR need review from a Product Owner

CMS user-facing annoucement

ndouglas commented Oct 4, 2022

dsasser commented Oct 4, 2022

swirtSJW left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dsasser commented Oct 5, 2022

dsasser commented Sep 30, 2022 •

edited

Loading