dev: api integration tests #907
Merged
+309
−9
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
tefkah
commented
Jan 21, 2025
Comment on lines
+64
to
+67
| defaultValues: { | ||
| // default to 1 day from now, mostly to make testing easier | ||
| expiration: new Date(Date.now() + 1000 * 60 * 60 * 24), | ||
| }, |
There was a problem hiding this comment.
i didn't want to write the code to navigate the date picker, so i took the easy way out and set a default time instead. let me know if the default time should be longer or if we should do this differently.
tefkah
commented
Jan 21, 2025
| @@ -530,12 +548,19 @@ export const siteApi = contract.router( | |||
| }, | |||
| }, | |||
| { | |||
| strictStatusCodes: true, | |||
There was a problem hiding this comment.
this makes the return types from the api client more legible. instead of getting
type Response =
| { status: 200, body: {...}}
| { status: 201 | 202 | ...., body: any} you get
type Response = { status: 200, body: {...}}
tefkah
commented
Jan 21, 2025
Comment on lines
+559
to
+564
| commonResponses: { | ||
| // this makes sure that 400 is always a valid response code | ||
| 400: zodErrorSchema, | ||
| 403: z.string(), | ||
| 404: z.string(), | ||
| }, |
There was a problem hiding this comment.
did not know this was an option, now every route has the correct error responses at least.
tefkah
commented
Jan 21, 2025
| }); | ||
|
|
||
| client = initClient(siteApi, { | ||
| baseUrl: `http://localhost:3000/`, |
There was a problem hiding this comment.
this might need to be an env var
tefkah
requested review from
kalilsn,
3mcd and
allisonking
and removed request for
kalilsn
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.
Issue(s) Resolved
Mostly want this before implementing #887 in the API.
High-level Explanation of PR
Adds integration tests for the API. For now just very basic tests: create a pub, get a pub. Should add more in depth tests later.
Roughly:
ts-restclientOther than the initial setup, these tests are quite fast as they don't really use the UI at all.
I chose not to use
playwrights built in API client, as it's not typed and is more error prone when it comes to routes. The goal is more to test API responses rather than how it interacts with any client.Test Plan
Screenshots (if applicable)
Notes