RFC: Add testing mechanism #134
Merged
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
I will write a changeset and tests if peeps are on board with this :)
🦋 Changeset detectedLatest commit: fa9dd2f The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
72636c
commented
Jun 25, 2024
Comment on lines
+70
to
+72
| const { destination, stdoutMock } = createDestination({ | ||
| mock: config.environment === 'test', | ||
| }); |
There was a problem hiding this comment.
Fielding opinions on this interface and the stdoutMock name in particular
Comment on lines
+80
to
+91
| /** | ||
| * Convenience method to retrieve a solitary logging call. | ||
| * | ||
| * Throws an error if more or less than 1 call has been recorded. | ||
| * | ||
| * This may be asserted against in a test case. | ||
| * | ||
| * ```typescript | ||
| * expect(stdoutMock.onlyCall()).toMatchSnapshot(); | ||
| * ``` | ||
| */ | ||
| onlyCall: (): object => { |
There was a problem hiding this comment.
Can we think of any other convenience methods worth implementing in a first cut?
Comment on lines
+30
to
+34
| export const createDestination = Object.assign( | ||
| (opts: CreateDestinationOptions) => { | ||
| const stdoutMock = createStdoutMock( | ||
| typeof opts.mock === 'object' ? opts.mock : DEFAULT_MOCK_OPTIONS, | ||
| ); |
There was a problem hiding this comment.
There is inherent overhead here in us initialising a stdoutMock even in production where opts.mock: false. However this should be truly negligible overhead that is only incurred once on startup.
AaronMoat
approved these changes
Jun 26, 2024
Merged
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.
I will write a changeset and tests if peeps are on board with this :)