upcoming: [M3-8019] – Add Encrypted/Not Encrypted status to Linode Detail summary header

[dwiley-akamai]

Description 📝

Add Encrypted/Not Encrypted status to Linode Detail summary header.

Changes 🔄

• Add lke_cluster_id to Linode interface, update mocks and several test files accordingly
• Add Encrypted and Not Encrypted status to Linode Detail summary header

Target release date 🗓️

6/10

Preview 📷

Screenshots

Encrypted:

Unencrypted & is LKE Linode:

Unencrypted & is standard Linode:

How to test 🧪

To test each of the three cases outlined by the screenshots, it'll be easiest to use the MSW and make adjustments to these lines:

manager/packages/manager/src/mocks/serverHandlers.ts

Lines 768 to 778 in 0e2d367

	http.get('*/linode/instances/:id', async ({ params }) => {
	const id = Number(params.id);
	return HttpResponse.json(
	linodeFactory.build({
	backups: { enabled: false },
	id,
	label: 'Gecko Edge Test',
	region: 'us-edge-1',
	})
	);
	}),

      linodeFactory.build({
        backups: { enabled: false },
        disk_encryption: 'disabled', // change to 'enabled' to see encrypted state
        id,
        label: 'Gecko Edge Test',
        lke_cluster_id: null, // change to a number to see the LKE Linode state
        region: 'us-edge-1',
      })

Prerequisites

1. Have the linode_disk_encryption tag on your account
2. Point at the alpha/dev environment
3. Have the Linode Disk Encryption (LDE) flag in our dev tool toggled on

Verification steps

Without the tag and/or with the LDE flag in our dev tool toggled off, you should not see any LDE-related things in the UI. Otherwise,

1. Navigate to a Linode Details page
2. Confirm the displayed encryption status matches what the disk_encryption field in the linode detail network request indicates (enabled --> Encrypted, disabled --> Not Encrypted)
3. If "Not Encrypted", standard Linodes should have a tooltip that reads: "Use Rebuild to enable or disable disk encryption." LKE Linodes should have a tooltip that reads: "To enable disk encryption, delete the node pool and create a new node pool. New node pools are always encrypted."
4. Ensure the header looks clean as you shrink and expand the viewport (made some styling adjustments to accommodate the encrypted status)

As an Author I have considered 🤔

• 👀 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: 82.35%
Current Coverage: 82.36%

[mjac0bs]

• Confirmed that with the LDE flag in our dev tool toggled off, I do not see any LDE-related things in the UI.
• Confirmed the displayed encryption status matches what the disk_encryption field in the linode detail network request indicates (enabled --> Encrypted, disabled --> Not Encrypted).
• Confirmed the tooltip matches the screenshots in the Preview section for standard vs LKE linodes.
• Confirmed the encrypted status and tooltip look good upon screen resizing.
• Confirmed no styling regressions to the encryption status on the LKE details page.

Thanks for the test coverage too! Left a few minor comments.

[mjac0bs]

Should this be an Added changeset?

[dwiley-akamai]

From my perspective, for the api-v4 package, "Added" indicates a newly-created type or interface, whereas "Changed" would include existing types and interfaces being expanded with new properties. Open to changing this based on additional thoughts, but it's probably a good Cafe item so a convention can be set.

[mjac0bs]

Your perspective makes sense - I am curious to hear what other members of the team think fits best here. Totally possible that I'm just thinking about it differently.

[mjac0bs]

(In support of leaving this changeset as is, I can add a comment to our next changelog doc when the team reviews pre-release just to clarify our convention, and we won't need to dedicate any cafe time.)

[mjac0bs]

This copy feels a little strange when it begins with the two verbs next to each other. Would something like Rebuild your Linode to enable or disable disk encryption. be better here?

[dwiley-akamai]

Will bring this to UX for consideration 👀

[dwiley-akamai]

Revised to Rebuild this Linode to enable or disable disk encryption. after revisiting the copy with UX 🚀

[hkhalil-akamai]

Verified detail header correctly reflects disk_encryption value and layout scales with the window as expected.

Approved pending @mjac0bs' comments regarding changelog and copy wording.

[mjac0bs]

Approving, pending we follow up on possible copy update (pending UX feedback) in this ticket or a future one. 🚀