Use Mock Service Worker #427
Conversation
And instead rely on the service worker mock
✅ Deploy Preview for bldrs-share ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
This works when I test it locally on my machines (both primary and secondary with a clean directory) but not in GitHub actions. I'll need to take a look at this later. |
|
Did you see #421? We introduced https://github.com/bldrs-ai/Share/blob/main/__mocks__/%40octokit/rest.js That achieves a similar goal and gives us more explicit control of preconditions for tests. One reason for having the MockOctokit was to enable localhost serving during dev. I often hit GH rate limit for comments without it. Now realizing the name is confusing. LocalOctokit? |
|
@pablo-mayrgundter I did not see #421 prior to this PR, thank you for pointing that out. I'm not sure I understand your statement about controlling test preconditions, do you mean being able to set expected request paths per individual test? If not, can you elaborate? https://www.danieljcafonso.com/configuring_msw MSW intercepts requests made in the browser, meaning if you define a route handler (and corresponding response), it will be handled locally and not touch the Internet despite the target URL having an external URL -- GitHub rate limits won't come into play. MSW's request interception allows us to have a single code path regardless of whether we're running in a local development environment, a CI/CD pipeline, or in production. As part of the testing for the authentication features, I need to be able to assert against headers (or their lack thereof) and send back line level responses (e.g. 401 Unauthorized) that are processed natively by Octokit. Function-level mocking of Octokit doesn't get me there and it would get fairly messy (and fragile) to inject a HTTP client instance into Octokit to achieve the same level of functionality, if that's even possible. |
There was a problem hiding this comment.
Per convo, please merge in #421 where we mocked out Octokit to make sure this still services that test case.
We only care if an unexpected call is made to api.github.com, as opposed to the default of raising a console warning about everything. The presence of a MSW console error/warning means that we are trying to exercise GitHub API functionality that we haven't yet mocked. Currently, we're raising a console error but as our confidence increases, we can change this to throw an exception that will halt execution.
|
@pablo-mayrgundter PTAL, I've merged in the code from #421 and added logic to the build process to delete the MSW static asset from non-development builds. |
Mock Service Worker is a tool for mocking APIs by operating as a service worker and intercepting network requests.
This PR replaces the existing Octokit mock (and its associated conditionals) with the native Octokit library and interception of specific URLs to achieve the same mocking functionality as before.
MSW will allow us to mock other network calls in the future as we expand the functionality of Share.
No changes to unit tests were necessary and all continue to pass as before.