change: [M3-8583] - Add support ticket mocks to MSW 2.0 #10937

mjac0bs · 2024-09-13T21:22:22Z

Description 📝

This PR adds CRUD request handlers and seeding for support tickets to MSW 2.0.

Preview 📷

Mocked Data

Mock Request	Result
`getSupportTickets`
`createSupportTicket` and `getSupportTicket`
`createSupportTicketReply`
events from `createSupportTicket` and `createSupportTicketReply`
`closeSupportTicket`

How to test 🧪

Verification steps

(How to verify changes)

Check out this PR and use our dev tools to toggle the MSW on.
Change the "Base preset" to CRUD.
Go to http://localhost:3000/support/tickets?type=open and http://localhost:3000/support/tickets?type=closed and confirm that none of your real support tickets are visible.
Click Open New Ticket, fill out the support ticket modal, and submit.
Confirm that your mock ticket shows up as an open ticket.
Confirm that you can Add Update to your mock ticket.
Confirm that you can close your ticket, and the status updates accordingly.
Confirm that you can seed 100 support tickets using the MSW preset seeder.

As an Author I have considered 🤔

Check all that apply

mjac0bs · 2024-10-04T22:05:40Z

packages/manager/src/mocks/presets/crud/seeds/index.ts

+export const dbSeeders = [
+  linodesSeeder,
+  placementGroupSeeder,
+  supportTicketsSeeder,


Do we want the ability to seed support tickets to test pagination, or should this really just be reserved for certain entities?

sure! you've built it, it may come handy!

mjac0bs · 2024-10-04T22:13:11Z

packages/manager/src/mocks/presets/crud/handlers/supportTickets.ts

+        // TODO: handle dynamic entity selection
+        entity: {
+          id: 1,
+          label: 'mock-linode-1',
+          type: 'linode',
+          url: '/v4/linode/instances/1',
+        },


I wasn't sure how best to handle the entities associated with a support ticket. To mock the dropdown in the open support ticket dialog, we'd need to mock the get requests for all products. For the time being, it populates real account data.

I guess, when we create a support ticket, we could also mock create a linode so that the mock-linode-1 link would send us to the mock linode details page. It just won't match up with whatever entity the user selects when creating the ticket.

I think that's quite ok! it makes sense to have this populated by our actual products. We could mock that but that's extra work for little value

github-actions · 2024-10-04T22:25:14Z

Coverage Report: ✅
Base Coverage: 86.95%
Current Coverage: 86.95%

abailly-akamai

thanks! looks good although something is missing

in dev-tools/load.ts we need this added to mergedContext

 supportReplies: [
   ...initialContext.supportReplies,
   ...(seedContext?.supportReplies || []),
],
supportTickets: [
  ...initialContext.supportTickets,
  ...(seedContext?.supportTickets || []),
],

abailly-akamai · 2024-10-07T14:04:44Z

packages/manager/src/mocks/presets/crud/handlers/supportTickets.ts

+        // TODO: handle dynamic entity selection
+        entity: {
+          id: 1,
+          label: 'mock-linode-1',
+          type: 'linode',
+          url: '/v4/linode/instances/1',
+        },


I think that's quite ok! it makes sense to have this populated by our actual products. We could mock that but that's extra work for little value

abailly-akamai · 2024-10-07T14:05:14Z

packages/manager/src/mocks/presets/crud/seeds/index.ts

+export const dbSeeders = [
+  linodesSeeder,
+  placementGroupSeeder,
+  supportTicketsSeeder,


sure! you've built it, it may come handy!

mjac0bs · 2024-10-07T15:47:45Z

in dev-tools/load.ts we need this added to mergedContext

@abailly-akamai Thank you! I hadn't noticed this file. Made the change in e4915c1, but still trying to better understand what is happening here. When we enable dev tools, we want both the seeded data and the user-generated data to be part of context, but then we're passing all that context when setting up which handlers and preset to use (const baseHandlers = resolveMockPreset(mswPreset, mergedContext);), even though the CRUD preset is the only one that will use anything but initialContext? Basically just trying to understand how this set up works and how things were seemingly mostly working with the supportTickets and supportReplies missed in load.ts.

abailly-akamai · 2024-10-07T20:01:03Z

@mjac0bs if my memory serves me well, this is necessary to set things up. When i pulled your PR, the new properties were not populated in the store, so the mocking was not working. supportTickets and supportTickets were not part of the initial state. You probably did not noticed it since you may not have destroyed your indexedDB and once it was populated once it started working for you.

the logic in load.ts is a part of the code that needs improvement, I'll give you that :D
would be happy to see it get improved

abailly-akamai

Great! thank you for adding this one

verified seeing ✅
verified crud operations ✅

dwiley-akamai

Newly-created mock ticket shows up as an open ticket ✅
Can Add Update to mock ticket ✅ (note about this below)
Can close ticket, and the status updates accordingly ✅
Can seed 100 support tickets using the MSW preset seeder ✅

When the ticket update is added, should it show as coming from test-account too as opposed to Customer Support?

Screen.Recording.2024-10-07.at.5.19.43.PM.mov

mjac0bs · 2024-10-07T22:00:02Z

@dwiley-akamai Sure, that would be more accurate. I overwrote a few values for the support ticket reply factory in the createSupportTicketReply handler so now the reply doesn't look like it's coming from the wrong user. Thanks for catching.

dwiley-akamai

🚀

cypress · 2024-10-08T15:31:04Z

Cloud Manager E2E Run #6639

Run Properties: Failed #6639 • 25ee2727bd: change: [M3-8583] - Add support ticket mocks to MSW 2.0 (#10937)

Project	`Cloud Manager E2E`
Run status	`Failed #6639`
Run duration	`28m 41s`
Commit	`25ee2727bd: change: [M3-8583] - Add support ticket mocks to MSW 2.0 (#10937)`
Committer	`Mariah Jacobs`
View all properties for this run ↗︎

Test results
Failures	`1`
Flaky	`3`
Pending	`2`
Skipped	`0`
Passing	`428`

Tests for review

cypress/e2e/core/linodes/clone-linode.spec.ts • 1 failed test

View Output Video

Test		Artifacts
clone linode > can clone a Linode from Linode details page		`Screenshots` `Video`

placementGroups/delete-placement-groups.spec.ts • 1 flaky test

View Output Video

Test		Artifacts
Placement Group deletion > can delete with Linodes assigned when unexpected error show up and retry		`Screenshots` `Video`

parentChild/account-switching.spec.ts • 1 flaky test

View Output Video

Test		Artifacts
Parent/Child account switching > From Parent to Child > can switch from Parent account user to Proxy account user from Billing page		`Screenshots` `Video`

volumes/create-volume.smoke.spec.ts • 1 flaky test

View Output Video

Test		Artifacts
volumes > does not allow creation of a volume with invalid pricing from volumes landing		`Screenshots` `Video`

mjac0bs added the Work in Progress label Sep 13, 2024

mjac0bs self-assigned this Sep 13, 2024

github-actions bot added the Stale label Sep 29, 2024

mjac0bs added 7 commits October 4, 2024 13:55

Add getSupportTickets and createSupportTicket mocks

1b902d9

Mock getSupportTicket and getSupportTicketReplies requests

c925c60

Fix getSupportTicket mock req, add closeSupportTicket req

038461d

Mock createSupportTicketReply

fd80fcf

Clean up createSupportTicket req, fix getSupportTicketReplies req

e04f746

Add events

4b2b3e7

Uncomment seeder

2fccb3e

mjac0bs force-pushed the M3-8583-add-msw2-mocks-for-support-tickets branch from 485262a to 2fccb3e Compare October 4, 2024 21:10

linode deleted a comment from github-actions bot Oct 4, 2024

mjac0bs removed Stale Work in Progress labels Oct 4, 2024

mjac0bs marked this pull request as ready for review October 4, 2024 21:56

mjac0bs requested a review from a team as a code owner October 4, 2024 21:56

mjac0bs requested review from dwiley-akamai and abailly-akamai and removed request for a team October 4, 2024 21:56

mjac0bs added 2 commits October 4, 2024 14:58

Clean up in create request

213dbdb

Added changeset: Add support ticket mocks to MSW 2.0

73b0cc9

mjac0bs commented Oct 4, 2024

View reviewed changes

mjac0bs added the Ready for Review label Oct 4, 2024

abailly-akamai reviewed Oct 7, 2024

View reviewed changes

Address feedback: add new entities to mergedContext in load function

e4915c1

mjac0bs requested a review from abailly-akamai October 7, 2024 17:26

abailly-akamai approved these changes Oct 7, 2024

View reviewed changes

mjac0bs added the Add'tl Approval Needed Waiting on another approval! label Oct 7, 2024

dwiley-akamai reviewed Oct 7, 2024

View reviewed changes

Address feedback: mock support ticket reply more accurately

a2a19be

dwiley-akamai approved these changes Oct 8, 2024

View reviewed changes

mjac0bs added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! Ready for Review labels Oct 8, 2024

mjac0bs merged commit 25ee272 into linode:develop Oct 8, 2024
20 checks passed

This was referenced Oct 10, 2024

Release v1.130.0 - release → staging #11087

Merged

fix: [M3-8739] - Fix MSW 2.0 initial mock store and support ticket seeder bugs #11090

Merged

Release v1.130.0- staging → master #11095

Merged

change: [M3-8583] - Add support ticket mocks to MSW 2.0 #10937

change: [M3-8583] - Add support ticket mocks to MSW 2.0 #10937

Uh oh!

Conversation

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

Uh oh!

Description 📝

Preview 📷

How to test 🧪

Verification steps

As an Author I have considered 🤔

Uh oh!

mjac0bs Oct 4, 2024

Choose a reason for hiding this comment

Uh oh!

abailly-akamai Oct 7, 2024

Choose a reason for hiding this comment

Uh oh!

mjac0bs Oct 4, 2024

Choose a reason for hiding this comment

Uh oh!

abailly-akamai Oct 7, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abailly-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

abailly-akamai Oct 7, 2024

Choose a reason for hiding this comment

Uh oh!

abailly-akamai Oct 7, 2024

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

abailly-akamai commented Oct 7, 2024

Uh oh!

abailly-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

dwiley-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

mjac0bs commented Oct 7, 2024

Uh oh!

dwiley-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cypress bot commented Oct 8, 2024

Cloud Manager E2E Run #6639

Tests for review

Uh oh!

Uh oh!

mjac0bs commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Oct 4, 2024 •

edited

Loading

mjac0bs commented Oct 7, 2024 •

edited

Loading