fix: [M3-9022, M3-9027] - Filter regions by endpoints and fix unavailable regions #11432

jaalah-akamai · 2024-12-17T23:26:55Z

Description 📝

Warning notices for unavailable Gen2 regions are not displaying the region names due to inconsistencies in error response formats.
Regions displayed in the Object Gen2 create drawer and Access Keys list are not being filtered based on user endpoint capabilities.

Note

This code relies on the /endpoints, which is activated through customer tags and capabilities. If endpoints is not available, we fallback to using regions and clusters for bucket retrieval.

Changes 🔄

Regions themselves have capabilities, therefore we need to filter those by what is returned from the object-storage/endpoints endpoint. This has to be done in 3 places:
1. The create bucket drawer when selecting a region
2. The access key /object-storage/access-keys page when displaying regions
3. The access key drawer when selecting "Show All"
For the unavailable regions, instead of passing the entire region to the component we only need the labels. This helped with some of the type differences.
New useObjectStorageRegions hook that filters regions by endpoints if user has Gen2 capabilities, otherwise falls back to all regions for backwards compatibility for legacy and multi-cluster.

Target release date 🗓️

Before 12/20 (Friday)

Preview 📷

Before	After

	Gen2 regions should no longer be displayed if you don't have permission to access the cluster
	Gen2 regions showing!

How to test 🧪

Prerequisites

(How to setup test environment)

See me and I'll get you added to the engineering account with capabilities

Reproduction steps

(How to reproduce the issue, if applicable)

Go to /object-storage/buckets in PROD and observe unavailable regions derived from our endpoints are not displayed due to difference in how we formatted the errors.

Verification steps

(How to verify changes)

View locally or with preview link and observe unavailable regions should be displaying appropriately.
After creating a gen2 bucket, try creating an access key in that same region. You should see the bucket appear.

Author Checklists

As an Author, to speed up the review process, I 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

I have read and considered all applicable items listed above.

As an Author, before moving this PR from Draft to Open, I confirmed ✅

All unit tests are passing
TypeScript compilation succeeded without errors
Code passes all linting rules

jaalah-akamai · 2024-12-17T23:39:23Z

packages/manager/src/features/ObjectStorage/BucketLanding/OMC_BucketLanding.tsx

+
+    // Single pass through errors to collect all region labels
+    errors.forEach((error) => {
+      if ('endpoint' in error && error.endpoint) {


The error here can be either a Gen1 or Gen2 error - hence the type guard to check if the property exists.

error: BucketError | BucketErrorGen2

jaalah-akamai · 2024-12-17T23:41:27Z

packages/manager/src/features/ObjectStorage/BucketLanding/OMC_BucketLanding.tsx

-interface UnavailableRegionsDisplayProps {
-  unavailableRegions: Region[];
+interface UnavailableRegionLabelsProps {
+  regionLabels: string[];


No need for an array of Region's since all we need are the label's. This allowed for cleaner typings since error formats are different. We couldn't pull from unavailableRegion.label since that wasn't a property on the new endpoint errors.

jaalah-akamai · 2024-12-17T23:45:33Z

@cpathipa @coliu-akamai I'll get you access to the account for testing

github-actions · 2024-12-18T00:01:04Z

Coverage Report: ✅
Base Coverage: 86.85%
Current Coverage: 86.85%

…rol helper text spacing

jaalah-akamai · 2024-12-18T15:02:19Z

packages/manager/src/components/RegionSelect/RegionSelect.utils.tsx

+  'de-fra-2',
+  'sg-sin-2',
+]);
+


This is because we cannot add these to our OBJ data centers list in api until GA or until OBJ region capabilities is customer aware.

victoriaroan

vgood here: All looks good to me! I tested with both a user who has access to the limited access regions and a user who does not, and both functioned as expected/desired.

I'm only somewhat proficient with react and not at all with typescript, so my actual code review might not count for much, but I don't see anything glaringly wrong. 🙂 And as mentioned, functionality is good 👍

...ges/manager/src/features/ObjectStorage/AccessKeyLanding/AccessKeyTable/HostNameTableCell.tsx

packages/ui/src/components/TextField/TextField.tsx

coliu-akamai

gonna review the functionality after retro! in between a lot of meetings today 😅

packages/manager/src/features/ObjectStorage/AccessKeyLanding/OMC_AccessKeyDrawer.tsx

coliu-akamai · 2024-12-18T20:05:26Z

functionality looking good too! will give a final approval/check after custom hook changes are pushed up 🚀

coliu-akamai

reconfirming functionality + code review, thank you!

packages/manager/src/components/RegionSelect/RegionSelect.utils.tsx

… use id" This reverts commit 3eb4ebc.

linode-gh-bot · 2024-12-19T03:53:59Z

Cloud Manager UI test results

🎉 466 passing tests on test run #12 ↗︎

❌ Failing	✅ Passing	↪️ Skipped	🕐 Duration
`0 Failing`	`466 Passing`	`2 Skipped`	`97m 48s`

jaalah-akamai · 2024-12-19T13:51:48Z

packages/manager/src/components/RegionSelect/RegionSelect.tsx

@@ -61,6 +63,7 @@ export const RegionSelect = <

  const regionOptions = getRegionOptions({
    currentCapability,
+    isObjectStorageGen2Enabled,


This is temporary as noted in getRegionOptions until APINext makes Gen2 region capabilities customer-aware.

jaalah-akamai · 2024-12-19T13:52:17Z

packages/manager/src/components/RegionSelect/RegionSelect.tsx

@@ -114,7 +117,7 @@ export const RegionSelect = <
            <RegionOption
              disabledOptions={disabledRegions[region.id]}
              item={region}
-              key={key}
+              key={`${region.id}-${key}`}


key which is the region label is no longer specific enough since we now can have multiple endpoints per region

jaalah-akamai · 2024-12-19T13:53:14Z

packages/manager/src/features/ObjectStorage/BucketLanding/BucketRateLimitTable.tsx

@@ -60,9 +60,10 @@ export const BucketRateLimitTable = ({
    <Box>
      <FormLabel>
        <Typography
+          {...typographyProps}


Moved the spreading of props to the top to allow overrides

jaalah-akamai · 2024-12-19T13:55:29Z

packages/manager/src/features/ObjectStorage/BucketLanding/OMC_BucketLanding.tsx

-            regionsAffected.map((thisRegion) => (
-              <li key={thisRegion}>{thisRegion}</li>
+            regionsAffected.map((thisRegion, idx) => (
+              <li key={`${thisRegion}-${idx}`}>{thisRegion}</li>


Same issue as above - multiple endpoints can exist in a region

coliu-akamai

✅ functionality as specified
✅ user without gen2 flags/capabilities doesn't see gen 2 regions (whoops typo)

thank you!

cpathipa

Confirming bucket and access create flow are working as expected for legacy and gen1

cypress · 2024-12-19T15:42:17Z

Cloud Manager E2E Run #7002

Run Properties: Failed #7002 • ce7a06f613: Merge pull request #11432 from jaalah-akamai/M3-9022

Project	`Cloud Manager E2E`
Branch Review	`staging`
Run status	`Failed #7002`
Run duration	`30m 25s`
Commit	`ce7a06f613: Merge pull request #11432 from jaalah-akamai/M3-9022`
Committer	`Jaalah Ramos`
View all properties for this run ↗︎

Test results
Failures	`2`
Flaky	`3`
Pending	`2`
Skipped	`0`
Passing	`464`
View all changes introduced in this branch ↗︎

Tests for review

cypress/e2e/core/linodes/rebuild-linode.spec.ts • 2 failed tests

View Output Video

Test		Artifacts
rebuild linode > rebuilds a linode from Community StackScript		`Screenshots` `Video`
rebuild linode > rebuilds a linode from Account StackScript		`Screenshots` `Video`

switch-linode-state.spec.ts • 1 flaky test

View Output Video

Test		Artifacts
switch linode state > powers off a linode from landing page		`Screenshots` `Video`

resize-linode.spec.ts • 2 flaky tests

View Output Video

Test		Artifacts
resize linode > resizes a linode by increasing size when offline: cold migration		`Screenshots` `Video`
resize linode > resizes a linode by decreasing size		`Screenshots` `Video`

fix: [M3-9022] - Filter regions by endpoints and fix unavailable regions

bd5dda2

jaalah-akamai requested a review from a team as a code owner December 17, 2024 23:26

jaalah-akamai requested review from carrillo-erik and hkhalil-akamai and removed request for a team December 17, 2024 23:26

jaalah-akamai added the Hotfix Hotfix: This is going to staging label Dec 17, 2024

jaalah-akamai changed the base branch from develop to staging December 17, 2024 23:27

jaalah-akamai requested review from cpathipa and coliu-akamai December 17, 2024 23:27

jaalah-akamai self-assigned this Dec 17, 2024

jaalah added 3 commits December 17, 2024 18:30

Add changesets

aa399e8

Bump package.json

38e6d86

Update changelog

319772f

jaalah-akamai added the Release → Staging Pre-Release: Release → Staging label Dec 17, 2024

jaalah-akamai commented Dec 17, 2024

View reviewed changes

Merge branch 'staging' of github.com:linode/manager into M3-9022

a274a1a

jaalah-akamai changed the title ~~fix: [M3-9022] - Filter regions by endpoints and fix unavailable regions~~ fix: [M3-9022, M3-9027] - Filter regions by endpoints and fix unavailable regions Dec 18, 2024

jaalah added 5 commits December 17, 2024 20:29

Add filtering for access key create

110c529

Add gen2 regions to whitelist to bypass filters

59a1844

Add ability to use sx prop for helper text

2baabcb

Adjust spacing

266d330

Added changeset: sxHelperText prop to TextField component to cont…

4dbcf16

…rol helper text spacing

jaalah-akamai commented Dec 18, 2024

View reviewed changes

victoriaroan approved these changes Dec 18, 2024

View reviewed changes

abailly-akamai reviewed Dec 18, 2024

View reviewed changes

...ges/manager/src/features/ObjectStorage/AccessKeyLanding/AccessKeyTable/HostNameTableCell.tsx Outdated Show resolved Hide resolved

packages/ui/src/components/TextField/TextField.tsx Outdated Show resolved Hide resolved

coliu-akamai reviewed Dec 18, 2024

View reviewed changes

packages/manager/src/features/ObjectStorage/AccessKeyLanding/OMC_AccessKeyDrawer.tsx Outdated Show resolved Hide resolved

jaalah added 2 commits December 18, 2024 15:52

Latest changes @alban-akamai

f4ea05e

Comment update

cfd79b3

coliu-akamai previously approved these changes Dec 18, 2024

View reviewed changes

Feature flag whitelist

c61f83a

jaalah-akamai dismissed coliu-akamai’s stale review via c61f83a December 18, 2024 22:29

coliu-akamai reviewed Dec 18, 2024

View reviewed changes

packages/manager/src/components/RegionSelect/RegionSelect.utils.tsx Show resolved Hide resolved

jaalah-akamai added the Add'tl Approval Needed Waiting on another approval! label Dec 18, 2024

jaalah added 5 commits December 18, 2024 21:54

Using the key which is actually the label is not unique. Must use id

daa2cfa

Using the key which is actually the label is not unique. Must use id

3eb4ebc

Revert "Using the key which is actually the label is not unique. Must…

55ac380

… use id" This reverts commit 3eb4ebc.

Using the key which is actually the label is not unique. Must use id

47a03bc

Remove sxHelperText @alban-akamai

caeff0b

jaalah-akamai commented Dec 19, 2024

View reviewed changes

bnussman-akamai approved these changes Dec 19, 2024

View reviewed changes

coliu-akamai approved these changes Dec 19, 2024

View reviewed changes

jaalah-akamai merged commit ce7a06f into linode:staging Dec 19, 2024
22 of 23 checks passed

jaalah-akamai mentioned this pull request Dec 19, 2024

Release v1.133.1 - staging → master #11441

Merged

cpathipa reviewed Dec 19, 2024

View reviewed changes

bnussman-akamai mentioned this pull request Dec 20, 2024

hotfix: Incorrect Region Options #11449

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: [M3-9022, M3-9027] - Filter regions by endpoints and fix unavailable regions #11432

fix: [M3-9022, M3-9027] - Filter regions by endpoints and fix unavailable regions #11432

jaalah-akamai commented Dec 17, 2024 •

edited

Loading

jaalah-akamai Dec 17, 2024 •

edited

Loading

jaalah-akamai Dec 17, 2024 •

edited

Loading

jaalah-akamai commented Dec 17, 2024

github-actions bot commented Dec 18, 2024 •

edited

Loading

jaalah-akamai Dec 18, 2024 •

edited by bnussman-akamai

Loading

victoriaroan left a comment

coliu-akamai left a comment

coliu-akamai commented Dec 18, 2024

coliu-akamai left a comment

linode-gh-bot commented Dec 19, 2024

jaalah-akamai Dec 19, 2024

jaalah-akamai Dec 19, 2024

jaalah-akamai Dec 19, 2024

jaalah-akamai Dec 19, 2024

coliu-akamai left a comment •

edited

Loading

cpathipa left a comment

cypress bot commented Dec 19, 2024

fix: [M3-9022, M3-9027] - Filter regions by endpoints and fix unavailable regions #11432

fix: [M3-9022, M3-9027] - Filter regions by endpoints and fix unavailable regions #11432

Conversation

jaalah-akamai commented Dec 17, 2024 • edited Loading

Description 📝

Changes 🔄

Target release date 🗓️

Preview 📷

How to test 🧪

Prerequisites

Reproduction steps

Verification steps

As an Author, to speed up the review process, I considered 🤔

As an Author, before moving this PR from Draft to Open, I confirmed ✅

jaalah-akamai Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

jaalah-akamai Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

jaalah-akamai commented Dec 17, 2024

github-actions bot commented Dec 18, 2024 • edited Loading

jaalah-akamai Dec 18, 2024 • edited by bnussman-akamai Loading

Choose a reason for hiding this comment

victoriaroan left a comment

Choose a reason for hiding this comment

coliu-akamai left a comment

Choose a reason for hiding this comment

coliu-akamai commented Dec 18, 2024

coliu-akamai left a comment

Choose a reason for hiding this comment

linode-gh-bot commented Dec 19, 2024

Cloud Manager UI test results

🎉 466 passing tests on test run #12 ↗︎

jaalah-akamai Dec 19, 2024

Choose a reason for hiding this comment

jaalah-akamai Dec 19, 2024

Choose a reason for hiding this comment

jaalah-akamai Dec 19, 2024

Choose a reason for hiding this comment

jaalah-akamai Dec 19, 2024

Choose a reason for hiding this comment

coliu-akamai left a comment • edited Loading

Choose a reason for hiding this comment

cpathipa left a comment

Choose a reason for hiding this comment

cypress bot commented Dec 19, 2024

Cloud Manager E2E Run #7002

Tests for review

jaalah-akamai commented Dec 17, 2024 •

edited

Loading

jaalah-akamai Dec 17, 2024 •

edited

Loading

jaalah-akamai Dec 17, 2024 •

edited

Loading

github-actions bot commented Dec 18, 2024 •

edited

Loading

jaalah-akamai Dec 18, 2024 •

edited by bnussman-akamai

Loading

coliu-akamai left a comment •

edited

Loading