test(atomic): POC - cache API requests #4468
Conversation
y-lakhdar
requested review from
louis-bompart,
fbeaudoincoveo and
alexprudhomme
Pull Request ReportPR Title❌ Title should follow the conventional commit spec: Example: Live demo linksBundle Size
SSR Progress
Detailed logssearch : buildInteractiveResultsearch : buildInteractiveInstantResult search : buildInteractiveRecentResult search : buildInteractiveCitation search : buildGeneratedAnswer recommendation : missing SSR support case-assist : missing SSR support insight : missing SSR support commerce : missing SSR support |
y-lakhdar
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
| @@ -19,3 +20,13 @@ export const makeAxeBuilder: Parameters< | |||
|
|
|||
| await use(makeAxeBuilder); | |||
| }; | |||
|
|
|||
| base.beforeEach(async ({page}) => { | |||
| await page.route(/commerce\/v2\/search/, cacheHandler); | |||
There was a problem hiding this comment.
We also currently have playwright tests that call non-commerce API endpoints, so we'd have to modify this accordingly.
There was a problem hiding this comment.
Yes. We also need to handle request to the listing endpoint.
|
|
||
| export const cacheHandler = async (route: Route, request: Request) => { | ||
| console.log('intercepted ---', request.url()); | ||
| const {clientId, ...rest} = request.postDataJSON(); |
There was a problem hiding this comment.
If we want to handle search API requests too, I think we could do:
const {clientId, analytics, ...rest} = request.postDataJSON();although this might be too broad...
another option would be to filter out non-static params case-by-case, based on the request.url
| @@ -0,0 +1,40 @@ | |||
| import {APIResponse, Request, Route} from '@playwright/test'; | |||
| import {createHash} from 'crypto'; | |||
There was a problem hiding this comment.
I remember you talked about browser compat for crypto.
fwiw: globalThis.crypto.subtle.digest would probably do a similar trick as createHash, for both NodeJS & the browser
y-lakhdar
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
| export const cacheHandler = async (route: Route, request: Request) => { | ||
| console.log('intercepted ---', request.url()); | ||
| const {clientId, ...rest} = request.postDataJSON(); | ||
| const key = hashRequest(request.url(), JSON.stringify(rest)); |
There was a problem hiding this comment.
question: Are you using the same authentication for each requests? Two exact request with the same payload may have different response depending on the authentication used.
There was a problem hiding this comment.
Good point! IIRC it's the same authentication for all test suites. I don't foresee the need of changing the authentication for specific tests since we target a public endpoint.
Use Playwright routing capabilities to intercept and cache HTTPS requests.
This does not change the way we do tests. The only change is that all fixtures need to pull the
testobject from the base-fixture rather than directly from@playwright/test.For details: https://docs.google.com/document/d/1EgDvTyny5YBQgIUIvAZmTJG_OochTZdpikui6pjoT_M/edit#heading=h.uu6jdy7o7j5b