How do I set http referer with cypress?

When using Cypress for automated testing, it is sometimes necessary to set the Referer header in HTTP requests. The Referer header indicates the source address of the request. In Cypress, you can set the Referer by modifying the request configuration in your test script. Below are the specific methods:

1. Setting Referer with cy.request()

If you need to send an HTTP request directly in your test, you can use the cy.request() method. This method allows you to customize request headers, including Referer. For example:

javascript
describe('Set Referer in cy.request', () => {
  it('sends a request with a custom referer', () => {
    cy.request({
      url: 'https://api.example.com/data',
      headers: {
        'Referer': 'https://custom-referer.com'
      }
    }).then((response) => {
      expect(response.status).to.eq(200);
    });
  });
});

In this example, we send an HTTP request to https://api.example.com/data with a custom Referer, and then verify that the response status code is 200.

2. Setting Referer with cy.visit() and onBeforeLoad

If you need to set the Referer when visiting a page, you can achieve this using the onBeforeLoad option of the cy.visit() method:

javascript
describe('Set Referer in cy.visit', () => {
  it('visits a page with a custom referer', () => {
    cy.visit('https://example.com', {
      onBeforeLoad: (win) => {
        Object.defineProperty(win.document, 'referrer', {
          value: 'https://custom-referer.com'
        });
      }
    });

    // Perform other related test assertions
  });
});

In this example, before visiting https://example.com, we use Object.defineProperty to modify the referrer property of window.document, simulating the browser sending a request with a custom Referer.

Summary

By using the above two methods, you can set or modify the Referer header in HTTP requests when performing automated testing with Cypress. This is particularly useful when testing behaviors that require verifying requests from different sources or conducting security tests.