chore: type-safe msw endpoint helper #288
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
kantord
reviewed
Feb 11, 2025
| http.get("*/api/v1/workspaces/:name/custom-instructions", () => { | ||
| return HttpResponse.json({ prompt: "initial prompt from server" }); | ||
| }), | ||
| http.get( |
There was a problem hiding this comment.
Not a required change for this PR, but I am kinda wondering if we could even make a single wrapper function that can be used like this:
mockEndpoint("..etc...", () => {
return HttpResponse.json(...etc...)
})There was a problem hiding this comment.
Probably yes, I didn't want to dive too deep in on this attempt — it's a little fussy because MSW's http has methods for each HTTP method (put,post,get) etc, and we'd have to do a little glue work to support all of them correctly, but eventually it would be possible.
kantord
approved these changes
Feb 11, 2025
Pull Request Test Coverage Report for Build 13259167234Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
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.
This is a supporting PR for #287 — while refactoring mocking, I noticed a few issues with our use of MSW, specifically around overly permissive wildcards, and aprtial path matches.
This PR introduces a type-safe helper,
mswEndpoint()that uses thepathsdefined in the OpenAPI json to limit the user input.