upcoming: [M3-8012] - Fix PG event text formatting

[carrillo-erik]

Description 📝

This PR updates the types and constants for action events for Placement Groups. Specifically, the action events are updated with a present-tense and imperative-style for consistency with other entity events. These changes resolve issues with Placement Group events missing the link and username.

Changes 🔄

List any change relevant to the reviewer.

• Remove the d and ed from events to make them consistent with other entity action events.
  (Ex. placement_group_created becomes placement_group_create and placement_group_unassigned becomes placement_group_unassign.

Preview 📷

Before	After

How to test 🧪

Prerequisites

(How to setup test environment)

• Have the placement-group customer tag on the user account used for testing.
• Using the Cloud Manager Dev Tools:
  • Enable the Placement Groups feature flag
  • Switch to Dev environment
  • Disable the MSW

Verification steps

(How to verify changes)

• Verify the following events emit an event that is formatted properly (with link and username).
  • placement_group_create
  • placement_group_assign
  • placement_group_unassign
  • placement_group_update
  • placement_group_delete

As an Author I have considered 🤔

Check all that apply

• 👀 Doing a self review
• ❔ Our contribution guidelines
• 🤏 Splitting feature into small PRs
• ➕ Adding a changeset
• 🧪 Providing/Improving test coverage
• 🔐 Removing all sensitive information from the code and PR description
• 🚩 Using a feature flag to protect the release
• 👣 Providing comprehensive reproduction steps
• 📑 Providing or updating our documentation
• 🕛 Scheduling a pair reviewing session
• 📱 Providing mobile support
• ♿ Providing accessibility support

[github-actions]

Coverage Report: ✅
Base Coverage: 81.82%
Current Coverage: 81.82%

[mjac0bs]

✅ Confirmed that the PG event verb tenses are consistent with our existing events.
✅ Confirmed that user name, the correct action for create/update/delete/unassign, and correct linkable entities show up in the events lists.

A couple of questions about consistency with toasts, which are slightly tangential to this event PR, so I'll approve once there's clarity with the assign/assigned events:

• Can we punctuate consistently in toasts? This has been a cafe discussion before, so I'm mentioning here. I think they can be considered a sentence (subject and verb, even if it is a fragment) with a period.

Has period (delete only):

Does not have period (everything else):

• Is it an intentional choice (for brevity, maybe) to not mention what the linode has been assigned/unassigned from in the toasts? (e.g. 'Linode successfully unassigned from Placement Group.') This differs from the event message, which does mention a PG.
  

[carrillo-erik]

After removing the placement_group_assigned event, the events were manually tested. The image below depicts a workflow starting from the Create Linode form.

1. A Placement Group is created
2. The Linode is created and is assigned to the newly create Placement Group.
3. A new stand alone Linode instance is created in the same region as the Placement Group from step 2.
4. From the Placement Group details page, the Linode instance from step 3 is assigned via thePlacementGroupAssignLinodeDrawer.
5. The event message formatting (entity label, username, and entity links) is verified in the Events page.

[carrillo-erik]

• Can we punctuate consistently in toasts? This has been a cafe discussion before, so I'm mentioning here. I think they can be considered a sentence (subject and verb, even if it is a fragment) with a period.
• Is it an intentional choice (for brevity, maybe) to not mention what the linode has been assigned/unassigned from in the toasts? (e.g. 'Linode successfully unassigned from Placement Group.') This differs from the event message, which does mention a PG.

@mjac0bs I have updated the toast notifications to include the entity label and punctuation as suggested.

[mjac0bs]

Thanks for the updates -- confirmed that the event messages and their corresponding toasts are looking consistent. How does a placement group become compliant or non-compliant?

The CI e2e failures are unrelated, and I believe they could be fixed by merging in develop.

[carrillo-erik]

How does a placement group become compliant or non-compliant?

From the API docs:

My understanding is that we don't trigger these events and just listen to them. We have logic that prevents the assignment of Linodes that would break compliance and the user is shown a toast notification of the failure. There's actions that take place in the backend that are async, which is where these might get triggered. Maybe @abailly-akamai can chime in and correct me where I'm wrong.

[abailly-akamai]

@carrillo-erik @mjac0bs sounds right to me. We just really want to populate those events. A placement group can fall out of compliance for reasons out of our control (usually due to availability, hardware failure etc). Completely async. On top of that event, the user will see a non-compliant status for the PG in Cloud Manager.