Skip to content

Enable POST data body override on native automation#8428

Closed
akcyp wants to merge 1 commit intoDevExpress:masterfrom
akcyp:master
Closed

Enable POST data body override on native automation#8428
akcyp wants to merge 1 commit intoDevExpress:masterfrom
akcyp:master

Conversation

@akcyp
Copy link

@akcyp akcyp commented Jul 31, 2025 •
edited
Loading

Purpose

Currently overriding POST data body is only possible when running tests with --disable-native-automation.
Take a look at following example:

// tests/test.ts
import { RequestHook, Selector } from 'testcafe';
import { ResponseEvent, RequestEvent } from 'testcafe-hammerhead';

class TestHook extends RequestHook {
  constructor() {
    super([
      { url: /echo.free.beeceptor.com/, method: 'POST' },
    ], {
      includeBody: true,
      includeHeaders: true,
    });
  }

  async onRequest(requestEvent: RequestEvent & { requestOptions: any }) {
    const mockPostData = Buffer.from(JSON.stringify({ test: 'override' }));
    requestEvent.requestOptions.body = mockPostData;
    requestEvent.requestOptions.headers['content-length'] = mockPostData.length.toString();
  }
  
  async onResponse(responseEvent: ResponseEvent) {}
}

fixture `TestCafe API`
    .page `http://localhost:5500/`
    .requestHooks(new TestHook());

test('API', async t => {
  const content = await Selector('#output').innerText;
  await t.wait(500);
  await t.expect(content).eql('{"test":"override"}');
});
<!-- index.html served at localhost:5500 -->
<!DOCTYPE html>
<html lang="en">
<body>
  <div id="output"></div>
  <script>
      async function main() {
        const response = await fetch('https://echo.free.beeceptor.com', {
          method: 'POST',
          body: JSON.stringify({
            example: 'payload',
          }),
        });
        const output = await response.json();
        document.querySelector('#output').innerHTML = output.rawBody;
      }
      main();
  </script>
</body>
</html>

This PR will allow this value to be overridden in RequestHooks also when running tests on native automation.

Approach

Based on https://chromedevtools.github.io/devtools-protocol/tot/Fetch/#method-continueRequest we can achieve this feature by just adding postData encoded to base64 to contineRequest props.
This is already done at _createContinueEventArgs to fix upload-like requests:

private _createContinueEventArgs (event: Protocol.Fetch.RequestPausedEvent, reqOpts: any): ContinueRequestArgs {
    const continueEventArgs = {
        postData: this._getUploadPostData(event),
    };

    if (reqOpts)
        Object.assign(continueEventArgs, this._getRequestOptionsModifiedByRequestHook(event, reqOpts));

    return continueEventArgs;
}

The only thing I've noticed that could be improved is that in the case of --disable-native-automation, we need to explicitly correct the content-length header.
In the case of native automation, after implementing this feature, the user shouldn't change it, as it leads to query failures, so the example RequestHook would look like this:

class TestHook extends RequestHook {
  constructor() {
    super([
      { url: /echo.free.beeceptor.com/, method: 'POST' },
    ], {
      includeBody: true,
      includeHeaders: true,
    });
  }

  async onRequest(requestEvent: RequestEvent & { requestOptions: any }) {
    const mockResponse = Buffer.from(JSON.stringify({ test: 'override' }));
    requestEvent.requestOptions.body = mockResponse;
-    requestEvent.requestOptions.headers['content-length'] = mockResponse.length.toString();
  }

Pre-Merge TODO

  • Write tests for your proposed changes
  • Make sure that existing tests do not fail

@testcafe-need-response-bot testcafe-need-response-bot bot added the STATE: Need response An issue that requires a response or attention from the team. label Jul 31, 2025
@Bayheck Bayheck added STATE: PR Review Pending A note that this PR will be reviewed. and removed STATE: Need response An issue that requires a response or attention from the team. labels Aug 5, 2025
@github-actions
Copy link

github-actions bot commented Aug 5, 2025

Thank you for your contribution to TestCafe. When a member of the TestCafe team becomes available, they will review this PR.

@github-actions
Copy link

github-actions bot commented Feb 2, 2026

This pull request has been automatically marked as stale because it has not had any activity for a long period. It will be closed and archived if no further activity occurs. However, we may return to this pull request in the future. If it is still relevant or you have any additional information regarding it, please leave a comment and we will keep it open.

@github-actions github-actions bot added the STATE: Stale An outdated issue that will be automatically closed by the Stale bot. label Feb 2, 2026
@github-actions
Copy link

github-actions bot commented Feb 12, 2026

We're closing this pull request after a prolonged period of inactivity. If it is still relevant, please ask for this pull request to be reopened. Thank you.

@github-actions github-actions bot closed this Feb 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

STATE: PR Review Pending A note that this PR will be reviewed. STATE: Stale An outdated issue that will be automatically closed by the Stale bot.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@akcyp @Bayheck