fix: [M3-8739] - Fix MSW 2.0 initial mock store and support ticket seeder bugs #11090
Conversation
mjac0bs
requested review from
hana-akamai and
cpathipa
and removed request for
a team
mjac0bs
changed the title
|
Coverage Report: ✅ |
|
|
||
| // Return the existing mockState if it includes all keys from the empty store; | ||
| // else, discard the existing mockState because we've introduced new values. | ||
| if (emptyStoreKeys.every((key) => mockStateKeys.includes(key))) { |
There was a problem hiding this comment.
Fix: Ensure that every empty store key is represented in mock state.
Note: I didn't compare the number of keys in the empty store and mock state, because mock state seems to always get an id key added that is not part of the empty store. (See screenshots in testing section to see it.) I am not quite sure the purpose of the id but am sure they're useful for something and maybe @abailly-akamai can clarify.
There was a problem hiding this comment.
@mjac0bs it is how IndexedDB works - it's meant to behave like a DB to it has auto ID increment. We're not really using indexedDB the way it's supposed to, I just used this storage solution as a blob store
mjac0bs
force-pushed
the
M3-8739-fix-msw2-creation-of-initial-mock-store
branch
from
7fc4177 to
2580fdf
Compare
cpathipa
added
Approved
There was a problem hiding this comment.
Thanks @mjac0bs ! confirmed this fixes the error we were seeing
Cloud Manager E2E
|
||||||||||||||||||||||||
| Project |
Cloud Manager E2E
|
| Run status |
|
| Run duration | 45m 50s |
| Commit |
|
| Committer | Mariah Jacobs |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
4
|
Pending
|
2
|
Skipped
|
0
|
Passing
|
438
|
Description 📝
This PR fixes an existing bug in the way the MSW2.0 was creating the initial mock store. It made itself known after #10937 was merged because that's the first time that many of us already had an existing store, and now new values were being added to it.
🐛 Bug:
When we are trying to create our initial mock store and access
initialContext.supportRepliesorinitialContext.supportTickets, developers were encountering a console error and white screen if they already had an existing IndexedDB that did not havesupportRepliesorsupportTicketsin the mockStore. This could be worked around by clearing the Application data in the browser console to reset the IndexedDB, but it would continue to happen in the future with every new set of values we track in the store.❓ Why:
This was happening due to the logic in
createInitialMockStore. We already had old mock state (even when it is just a bunch of empty lists), so we return it asinitialContext. It doesn't includesupportRepliesorsupportTickets. When we have new values, we need theinitialContextto be the emptyStore, which has the empty key-value pair for those new values.🔧 Fix:
Adding a conditional check ensure the mockState and emptyStore keys are the same before returning that mockState. If the keys aren't the same, there's new entities to include in the mock store, so disregard the old store.
Changes 🔄
createInitialMockStoreto return an emptyStore if there's new values to create in the storeremoveSeederfunction for consistency - it was an oversight in the original PR.How to test 🧪
Prerequisites
(How to setup test environment)
Reproduction steps
packages/manager/src/mocks/types.tsand makesupportTicketsandsupportRepliesoptional types.packages/manager/src/mocks/mockState.tsand comment outsupportRepliesandsupportTicketsin theemptyStore.supportRepliesandsupportTickets(browser dev tools > Application > Storage > IndexedDB > mockStateVerification steps
(How to verify changes)
git restore .supportRepliesandsupportTicketsVideo
Screen.Recording.2024-10-10.at.4.52.32.PM.mov
Screen.Recording.2024-10-10.at.4.54.20.PM.mov
As an Author I have considered 🤔
Check all that apply