Fix/10036-duplicate-survey-triggers #10167
Open
+274
−395
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Build files for 256306d are ready:
|
|
Size Change: +94 B (0%) Total Size: 2 MB
ℹ️ View Unchanged
|
aaemnnosttv
commented
Feb 5, 2025
Comment on lines
+47
to
+51
| jest.mock( 'react-use', () => ( { | ||
| ...jest.requireActual( 'react-use' ), | ||
| useIntersection: () => ( { | ||
| isIntersecting: true, | ||
| } ), |
There was a problem hiding this comment.
Not sure how this wasn't broken before. The addition of requireActual here is something we do elsewhere and is necessary to preserve the normal function of other hooks from the package. Without this, the test was failing with useMountedState is not a function.
| @@ -91,12 +86,6 @@ export default { | |||
| '^/google-site-kit/v1/core/user/data/survey-trigger' | |||
| ) | |||
| ); | |||
| fetchMock.postOnce( | |||
| new RegExp( | |||
| '^/google-site-kit/v1/core/user/data/survey-timeout' | |||
There was a problem hiding this comment.
This endpoint has been entirely removed.
Comment on lines
+121
to
+123
| yield commonActions.await( | ||
| dispatch( CORE_USER ).triggerSurvey( 'fpm_setup_completed' ) | ||
| ); |
There was a problem hiding this comment.
While this seems unrelated, it fixes stability issues in other tests where submitChanges is awaited where additional arbitrary waits were necessary.
Comment on lines
+42
to
+45
| const args = ttl ? { ttl } : {}; | ||
| return API.set( 'core', 'user', 'survey-trigger', { | ||
| triggerID, | ||
| ...args, |
There was a problem hiding this comment.
I originally added the ttl unconditionally but it would have required many tests to be updated as there were several the have toHaveFetched with a specific body. Rather than modifying the tests to assert a partial (as some have been here), we pass it if it's a non-falsy value. It defaults to 0 and has no effect if it's not a positive value, so this should be safe.
|
|
||
| function lockSurveyTrigger( triggerID ) { |
There was a problem hiding this comment.
As simple "private" (self-describing) actions, these don't need doc blocks.
| error: false, | ||
| }; | ||
| } finally { | ||
| yield unlockSurveyTrigger( triggerID ); |
There was a problem hiding this comment.
This ensures the lock is always released regardless of when the return happens without duplicating throughout.
| @@ -41,13 +37,8 @@ export const mockSurveyEndpoints = () => { | |||
| body: {}, | |||
| } ); | |||
|
|
|||
| fetchMock.getOnce( surveyTimeoutEndpoint, { | |||
There was a problem hiding this comment.
This mock was incorrect to start with since the survey-timeout endpoint was POST only – survey-timeouts has GET.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Addresses issue:
Relevant technical choices
survey-triggersurvey-timeoutendpoint entirelyNote: a few unrelated instabilities remain in JS + E2E tests
PR Author Checklist
Do not alter or remove anything below. The following sections will be managed by moderators only.
Code Reviewer Checklist
Merge Reviewer Checklist