refactor: [M3-8101] - Use `network-transfer/prices` endpoint for transfer overage pricing #10566

mjac0bs · 2024-06-11T16:28:59Z

Description 📝

This PR is a follow up to #10468 and uses the newly added network-transfer/prices endpoint to fetch network transfer overage pricing from the API, finishing off the transition for OBJ to dynamic pricing data.

Loading and error states are addressed, especially in the OMC Create Bucket drawer, which I missed in the first PR - see Reproduction steps in the Testing section.

Changes 🔄

Created the necessary api-v4 endpoint, query, and interface to use the network-transfer/prices endpoint.
Created the necessary factories and endpoint in the MSW to support a mocked response to the API endpoint.
Added UX for error handling in the unlikely event that network transfer pricing cannot be calculated: disable primary action button and display tooltip error.
Added loading state for network transfer pricing.
Updated unit tests.

Target release date 🗓️

6/24

Preview 📷

Before	After

n/a
n/a

How to test 🧪

Prerequisites

For OMC, ensure you have the account capability with the necessary tags on your prod account. We are depending on this and not the LD flag.

Reproduction steps

(How to reproduce the issue, if applicable)

To observe that we were missing loading and error state in the OMC Create Bucket drawer, use the React Query dev tools to "Trigger loading" and "Trigger error" states for the [ "network-transfer", "prices"] and ["object-storage", "types"] endpoints. Observe the primary action button does not have loading or error state.

Verification steps

(How to verify changes)

Test the following with the OMC feature enabled (tags on account) and disabled (no OMC tags on account):
- Go to http://localhost:3000/object-storage/buckets/create.
- Select a regularly priced region (e.g. us-east), Jakarta, and Sao Paulo. For each, confirm that outbound transfer overage pricing (the second price) matches production.
- Confirm you can still create a bucket.
- Confirm that loading and error states are present by toggling in RQ dev tools as described above, or block the network requests.

As an Author I have considered 🤔

Check all that apply

mjac0bs · 2024-06-11T16:42:15Z

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

+    data: objTypes,
+    isError: isErrorObjTypes,
+    isInitialLoading: isLoadingObjTypes,
  } = useObjectStorageTypesQuery(isOpen);
-
-  const isInvalidPrice = !types || isErrorTypes;
+  const {
+    data: transferTypes,
+    isError: isErrorTransferTypes,
+    isInitialLoading: isLoadingTransferTypes,
+  } = useNetworkTransferPricesQuery(isOpen);
+
+  const isErrorTypes = isErrorTransferTypes || isErrorObjTypes;
+  const isLoadingTypes = isLoadingTransferTypes || isLoadingObjTypes;
+  const isInvalidPrice =
+    !objTypes || !transferTypes || isErrorTypes || isErrorTransferTypes;


These additions are made twice (once here, once in the next file) since we currently have two create bucket drawer components.

mjac0bs · 2024-06-11T16:44:59Z

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

+              (showGDPRCheckbox && !hasSignedAgreement) ||
+              isErrorTypes,
            label: 'Create Bucket',
-            loading: isLoading,
+            loading:
+              isLoading || Boolean(formik.values.region && isLoadingTypes),
+            tooltipText:
+              !isLoadingTypes && isInvalidPrice
+                ? PRICES_RELOAD_ERROR_NOTICE_TEXT
+                : '',


I didn't add the loading and error state for the Create button in the initial PR for the first type of overage pricing in the OMC drawer - I forgot we had two drawers - so it has been added here now.

(OveragePricing is shared between the original and OMC drawer, so we were fine there.)

mjac0bs · 2024-06-11T16:46:21Z

packages/manager/src/utilities/pricing/constants.ts

Now being returned from API.

mjac0bs · 2024-06-11T16:46:31Z

packages/manager/src/utilities/pricing/dynamicPricing.ts

Now being returned from API.

github-actions · 2024-06-11T16:56:23Z

Coverage Report: ❌
Base Coverage: 82.76%
Current Coverage: 82.75%

cpathipa

LGTM!

mjac0bs added 6 commits June 11, 2024 08:20

Add network transfer prices endpoint

bc59d52

Use new endpoint in OveragePricing

74a50a6

Add factories, MSW endpoint, and test coverage

acf29be

Clean up now that prod API endpoint is as expected

f143262

Add error and loading state to Create Bucket drawer

f23b364

Add loading and error state to OMC drawer

f1c6ae9

mjac0bs self-assigned this Jun 11, 2024

mjac0bs requested a review from a team as a code owner June 11, 2024 16:29

mjac0bs requested review from jdamore-linode and hana-akamai and removed request for a team June 11, 2024 16:29

mjac0bs changed the title ~~refactor: [M3-8101] - Use network-transfer/pricing endpoint for transfer overage pricing~~ refactor: [M3-8101] - Use network-transfer/prices endpoint for transfer overage pricing Jun 11, 2024

Add changesets

6529698

mjac0bs added @linode/api-v4 Changes are made to the @linode/api-v4 package Ready for Review DC-Specific Pricing labels Jun 11, 2024

mjac0bs commented Jun 11, 2024

View reviewed changes

mjac0bs requested a review from cpathipa June 11, 2024 17:09

cpathipa approved these changes Jun 13, 2024

View reviewed changes

Merge branch 'develop' into M3-8101-use-network-overage-pricing-endpoint

8fb311f

mjac0bs added Add'tl Approval Needed Waiting on another approval! and removed Ready for Review labels Jun 13, 2024

hana-akamai approved these changes Jun 13, 2024

View reviewed changes

hana-akamai added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! labels Jun 13, 2024

mjac0bs merged commit ee2707c into linode:develop Jun 13, 2024
18 checks passed

This was referenced Jun 21, 2024

Release v1.122.0 - release → staging #10601

Merged

Release v1.122.0 - staging → master #10608

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: [M3-8101] - Use `network-transfer/prices` endpoint for transfer overage pricing #10566

refactor: [M3-8101] - Use `network-transfer/prices` endpoint for transfer overage pricing #10566

mjac0bs commented Jun 11, 2024 •

edited

Loading

mjac0bs Jun 11, 2024

mjac0bs Jun 11, 2024

mjac0bs Jun 11, 2024

mjac0bs Jun 11, 2024

github-actions bot commented Jun 11, 2024 •

edited

Loading

cpathipa left a comment

refactor: [M3-8101] - Use network-transfer/prices endpoint for transfer overage pricing #10566

refactor: [M3-8101] - Use network-transfer/prices endpoint for transfer overage pricing #10566

Conversation

mjac0bs commented Jun 11, 2024 • edited Loading

Description 📝

Changes 🔄

Target release date 🗓️

Preview 📷

How to test 🧪

Prerequisites

Reproduction steps

Verification steps

As an Author I have considered 🤔

mjac0bs Jun 11, 2024

Choose a reason for hiding this comment

mjac0bs Jun 11, 2024

Choose a reason for hiding this comment

mjac0bs Jun 11, 2024

Choose a reason for hiding this comment

mjac0bs Jun 11, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 11, 2024 • edited Loading

cpathipa left a comment

Choose a reason for hiding this comment

refactor: [M3-8101] - Use `network-transfer/prices` endpoint for transfer overage pricing #10566

refactor: [M3-8101] - Use `network-transfer/prices` endpoint for transfer overage pricing #10566

mjac0bs commented Jun 11, 2024 •

edited

Loading

github-actions bot commented Jun 11, 2024 •

edited

Loading