feat: [M3-8335] - Link Account Limit ticket in more flows with error notice by mjac0bs · Pull Request #10684 · linode/manager

mjac0bs · 2024-07-16T20:29:46Z

Description 📝

#10620 focused on the creation of the new account limit support ticket, linking to it from the Linode Create flow, and providing test coverage.

This ticket will link to the the account limit support ticket from the "contact Support" text on the Volumes, NodeBalancers, Firewall, Kubernetes (LKE create and Add a Node Pool), and Database create flows. Currently, the link in these flows takes users to a general support ticket.

Changes 🔄

Removes the global intercept on the text "contact Support" and "open a support ticket"
Links to an account limit ticket for Create flows listed above when the expected error text is present in the error message
Fixes a bug in a handleGeneralError Formik util that didn't account for the APIError reason being a string or JSX

Target release date 🗓️

8/5/24

Preview 📷

Videos 🎥

Flow	Limit Error
Volumes	Screen.Recording.2024-07-16.at.2.04.16.PM.mov
NodeBalancers	Screen.Recording.2024-07-16.at.2.07.46.PM.mov
LKE Create - Thing Limit	Screen.Recording.2024-07-16.at.2.04.50.PM.mov
LKE Create - Rep Limit	Screen.Recording.2024-07-17.at.11.50.54.AM.mov
LKE Add Node Pool - Thing Limit	Screen.Recording.2024-07-16.at.2.06.47.PM.mov
LKE Add Node Pool - Rep Limit	Screen.Recording.2024-07-16.at.2.06.47.PM.mov
Firewalls	Screen.Recording.2024-07-16.at.2.08.42.PM.mov
Databases	Screen.Recording.2024-07-16.at.2.07.12.PM.mov

How to test 🧪

Prerequisites

(How to setup test environment)

Please test this on your dev account so we don't bother Customer Support with real tickets.
Check out this PR and switch your environment to dev.
Log into admin and be ready to change some things on your dev account.

Verification steps

(How to verify changes)

In admin, set your thing limit to 0.
For each of the above create flows (Volumes, NBs, LKE Create + Add a Node Pool, Firewalls, Databases):
Fill out the create form and try to create the entity.
Confirm that the UI displays an error notice when user has reached a limit on their account: You’ve reached a limit for the number of active services on your account. Please contact Support to request an increase and provide the total number of services you may need.
Click on the "contact Support" link and confirm that you are redirected to the Account Limit ticket and the expected fields show.
- The Linode plan field should only show for Linode and LKE account limit tickets.
- The correct entity should be shown in the "total entities" field, with the correct number of existing entities from your account as helper text.
For LKE only, setting your reputation to 0 should result in the error: A limit on your account is preventing the deployment of the selected service. To request access, please contact Support and provide the service name. You should also link to an account limit support ticket.
Verify that this test isn't flaking in CI:

yarn cy:run -s "cypress/e2e/core/helpAndSupport/open-support-ticket.spec.ts"

As an Author I have considered 🤔

Check all that apply

github-actions · 2024-07-16T20:57:24Z

Coverage Report: ✅
Base Coverage: 82.42%
Current Coverage: 82.5%

mjac0bs · 2024-07-17T19:12:22Z

+  const generalError =
+    typeof _apiErrors[0].reason !== 'string'
+      ? _apiErrors[0].reason
+      : _apiErrors
+          .reduce(
+            (result, { field, reason }) =>
+              field ? result : [...result, reason],
+            []
+          )
+          .join(',');


The misleading string type of _apiErrors was resulting in [Object object] being displayed to the user in any case where the error was already globally intercepted converted to JSX, as support errors were.

I'm proposing that we remove the global intercept for support tickets in this PR, but we still global intercept for verification and migrate errors, so I left the change in this util.

mjac0bs · 2024-07-17T19:27:35Z

-    {
-      condition: (e) => {
-        return (
-          (!!e.reason.match(/.*open a support ticket/i) ||
-            !!e.reason.match(/contact Support/i)) &&
-          !e.field
-        );
-      },
-      replacementText: <SupportError errors={errors} />,
-    },


Ultimately, I think we should remove this and handle support errors at the component level. As we begin to add more ticket types, it will depend on the context of the component which type of ticket we link to, so it is no longer useful to override at a global level to open a general support ticket. Additionally, our lack of type safety for a reason that is either string or JSX adds complexity and errors (see the [Object object] in Volume Create; another place this happens is the Configuration dialog when hitting a VLAN limit). We could mitigate these if we leave the construction of JSX to ErrorMessage.tsx and SupportTicketGeneralError.tsx.

If we do this here, in this PR, some API errors not covered in this PR will no longer link directly to a support ticket. If we're okay with that for now, we can proceed and create a follow up ticket to use ErrorMessage with general errors throughout the app - or at least where we think "contact support" API errors are likely.

I'm good with this! The interceptor solution was handy, but I'm much more sold on handling at the component level.

I remember @hkhalil-akamai saying we might even be able to remove the migration and verification interceptors as well because they might not be returned by the API nowadays, but I might be wrong. We can investigate that at a later point.

AzureLatte

Test passed

bnussman-akamai

Looks great! I like how we're handling errors at the component level now.

hana-akamai

UI displays contact support error notice and expected fields show in the support modal ✅

Non-blocking: If it's not too complicated, what are your thoughts on replacing the word entity with the actual entity?

mjac0bs · 2024-07-18T18:17:41Z

Non-blocking: If it's not too complicated, what are your thoughts on replacing the word entity with the actual entity?

@hana-linode That would be ideal, agreed. It felt like it would be more complicated than it's worth when I was first implementing, but I'll revisit now that this is a much smaller PR. 👀

…flows

mjac0bs · 2024-07-19T19:42:22Z

Non-blocking: If it's not too complicated, what are your thoughts on replacing the word entity with the actual entity?

@hana-linode That would be ideal, agreed. It felt like it would be more complicated than it's worth when I was first implementing, but I'll revisit now that this is a much smaller PR. 👀

The way that we're converting special ticket type form fields into one description field makes this messier than I'd like. I'm going to hold off on it unless we get feedback from customers/Support that 'entities' is confusing.

mjac0bs added 8 commits July 16, 2024 11:58

Conditionally show the Linode plan type field

fed3a1f

Fix Volumes bug and render general errors

43616f8

Link account limit ticket in Create Cluster flow

38a4432

Link account limit ticket in Add a Node Pool flow

225a89d

Lint

d5cf090

Link account limit ticket in NodeBalancer Create flow

a88a562

Link account limit ticket in Create Firewall flow

f1c6a18

Link account limit ticket in Create Database flow

9a19d3f

mjac0bs self-assigned this Jul 16, 2024

mjac0bs requested a review from a team as a code owner July 16, 2024 20:29

mjac0bs requested review from bnussman-akamai and hana-akamai and removed request for a team July 16, 2024 20:29

mjac0bs added the Work in Progress label Jul 16, 2024

mjac0bs added 2 commits July 16, 2024 14:31

Another attempt to fix the CI flake for open-support-ticket.spec.ts

6535834

Added changeset: Account Limit support ticket to remaining create flows

ffb6bc3

mjac0bs requested a review from a team as a code owner July 16, 2024 21:34

mjac0bs requested review from AzureLatte and removed request for a team July 16, 2024 21:34

mjac0bs added 2 commits July 17, 2024 11:53

Remove global interception of support error

5343fae

Fix variable name

49e4420

mjac0bs commented Jul 17, 2024

View reviewed changes

mjac0bs added Ready for Review and removed Work in Progress labels Jul 17, 2024

AzureLatte approved these changes Jul 18, 2024

View reviewed changes

bnussman-akamai approved these changes Jul 18, 2024

View reviewed changes

hana-akamai approved these changes Jul 18, 2024

View reviewed changes

hana-akamai added Approved Multiple approvals and ready to merge! and removed Ready for Review labels Jul 18, 2024

mjac0bs added 3 commits July 19, 2024 12:22

Address feedback: replace generic 'entities' with entity name

e1db32b

Merge branch 'develop' into M3-8335-add-account-limit-ticket-to-more-…

8152cef

…flows

Revert e1db32b; this is a pain with formatDescription

0f02ac8

mjac0bs merged commit 173d823 into linode:develop Jul 19, 2024

This was referenced Aug 1, 2024

Release v1.125.0 - release → staging #10741

Merged

Release v1.125.0 - staging → master #10748

Merged

hkhalil-akamai mentioned this pull request Aug 28, 2024

refactor: [M3-6852] - Remove global error interceptors #10850

Merged

Navigation Menu

Uh oh!

feat: [M3-8335] - Link Account Limit ticket in more flows with error notice - #10684

feat: [M3-8335] - Link Account Limit ticket in more flows with error notice#10684
mjac0bs merged 15 commits into
linode:developfrom
mjac0bs:M3-8335-add-account-limit-ticket-to-more-flows

mjac0bs commented Jul 16, 2024 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 16, 2024 •

edited

Loading

Uh oh!

mjac0bs Jul 17, 2024

Uh oh!

mjac0bs Jul 17, 2024

Uh oh!

bnussman-akamai Jul 18, 2024

Uh oh!

AzureLatte left a comment

Uh oh!

bnussman-akamai left a comment

Uh oh!

hana-akamai left a comment

Uh oh!

mjac0bs commented Jul 18, 2024

Uh oh!

mjac0bs commented Jul 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

mjac0bs commented Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description 📝

Changes 🔄

Target release date 🗓️

Preview 📷

How to test 🧪

Prerequisites

Verification steps

As an Author I have considered 🤔

Uh oh!

github-actions Bot commented Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mjac0bs Jul 17, 2024

Choose a reason for hiding this comment

Uh oh!

mjac0bs Jul 17, 2024

Choose a reason for hiding this comment

Uh oh!

bnussman-akamai Jul 18, 2024

Choose a reason for hiding this comment

Uh oh!

AzureLatte left a comment

Choose a reason for hiding this comment

Uh oh!

bnussman-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

hana-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

mjac0bs commented Jul 18, 2024

Uh oh!

mjac0bs commented Jul 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mjac0bs commented Jul 16, 2024 •

edited

Loading

github-actions Bot commented Jul 16, 2024 •

edited

Loading