test(feedback): Write some test for feedback utils and error returns #12519
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
ryan953
commented
Jun 18, 2024
ryan953
commented
Jun 18, 2024
| const timeout = setTimeout(() => reject('Unable to determine if Feedback was correctly sent.'), 5_000); | ||
|
|
||
| const timeout = setTimeout(() => { | ||
| reject(new Error('Unable to determine if Feedback was correctly sent.')); |
There was a problem hiding this comment.
This updates the thrown type to be Error instead of string so that users can consistently check & optionally render error values.
Now all problems return as Error objects, and can be used like:
try {
await sendFeedback(...);
} catch (error) {
console.log(error.message); // instead of: `'message' in error ? error.message : error`
}
There was a problem hiding this comment.
Hmm, will this break for us (+ existing users) that expect the rejection to be a string? I think we use the rejected value directly as the error message in our error toast.
There was a problem hiding this comment.
I removed the return/error type changes.
ryan953
commented
Jun 18, 2024
Comment on lines
+9
to
+14
| const isolationUser = getIsolationScope().getUser(); | ||
| if (isolationUser && Object.keys(isolationUser).length) { | ||
| return isolationUser; | ||
| } | ||
| const globalUser = getGlobalScope().getUser(); | ||
| return globalUser; |
There was a problem hiding this comment.
testing these two scopes was hard to do directly :(
ryan953
commented
Jun 18, 2024
| it('should return the empty user if no explicit user is set', () => { | ||
| getCurrentScope().setUser(null); | ||
|
|
||
| expect(getUser()).toEqual({ email: undefined, id: undefined, ip_address: undefined, username: undefined }); |
There was a problem hiding this comment.
getUser() surprisingly has the return type User | undefined but when nothing is set we're getting a default empty user.
billyvg
approved these changes
Jun 24, 2024
| import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core'; | ||
| import type { User } from '@sentry/types'; | ||
|
|
||
| export function getUser(): User | undefined { |
There was a problem hiding this comment.
Wonder if we do anything similar in other integrations
ryan953
force-pushed
the
ryan953/feedback-tests
branch
from
ca6b0bd
to
d63238a
Compare
size-limit report 📦
|
|
stale |
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.
Before submitting a pull request, please take a look at our
Contributing guidelines and verify:
yarn lint) & (yarn test).