Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use matchesRoutePreflight method in Cypress

Best JavaScript code snippet using cypress

request.js

Source:request.js

1"use strict";2var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {3    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }4    return new (P || (P = Promise))(function (resolve, reject) {5        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }6        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }7        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }8        step((generator = generator.apply(thisArg, _arguments || [])).next());9    });10};11var __importDefault = (this && this.__importDefault) || function (mod) {12    return (mod && mod.__esModule) ? mod : { "default": mod };13};14Object.defineProperty(exports, "__esModule", { value: true });15exports.InterceptRequest = void 0;16const lodash_1 = __importDefault(require("lodash"));17const network_1 = require("../../../../network");18const debug_1 = __importDefault(require("debug"));19const url_1 = __importDefault(require("url"));20const types_1 = require("../../types");21const route_matching_1 = require("../route-matching");22const util_1 = require("../util");23const intercepted_request_1 = require("../intercepted-request");24const debug = (0, debug_1.default)('cypress:net-stubbing:server:intercept-request');25/**26 * Called when a new request is received in the proxy layer.27 */28const InterceptRequest = function () {29    return __awaiter(this, void 0, void 0, function* () {30        if ((0, route_matching_1.matchesRoutePreflight)(this.netStubbingState.routes, this.req)) {31            // send positive CORS preflight response32            return (0, util_1.sendStaticResponse)(this, {33                statusCode: 204,34                headers: {35                    'access-control-max-age': '-1',36                    'access-control-allow-credentials': 'true',37                    'access-control-allow-origin': this.req.headers.origin || '*',38                    'access-control-allow-methods': this.req.headers['access-control-request-method'] || '*',39                    'access-control-allow-headers': this.req.headers['access-control-request-headers'] || '*',40                },41            });42        }43        const matchingRoutes = [];44        const populateMatchingRoutes = (prevRoute) => {45            const route = (0, route_matching_1.getRouteForRequest)(this.netStubbingState.routes, this.req, prevRoute);46            if (!route) {47                return;48            }49            matchingRoutes.push(route);50            populateMatchingRoutes(route);51        };52        populateMatchingRoutes();53        if (!matchingRoutes.length) {54            // not intercepted, carry on normally...55            return this.next();56        }57        const request = new intercepted_request_1.InterceptedRequest({58            continueRequest: this.next,59            onError: this.onError,60            onResponse: (incomingRes, resStream) => {61                (0, util_1.setDefaultHeaders)(this.req, incomingRes);62                this.onResponse(incomingRes, resStream);63            },64            req: this.req,65            res: this.res,66            socket: this.socket,67            state: this.netStubbingState,68            matchingRoutes,69        });70        debug('intercepting request %o', { requestId: request.id, req: lodash_1.default.pick(this.req, 'url') });71        // attach requestId to the original req object for later use72        this.req.requestId = request.id;73        this.netStubbingState.requests[request.id] = request;74        const req = lodash_1.default.extend(lodash_1.default.pick(request.req, types_1.SERIALIZABLE_REQ_PROPS), {75            url: request.req.proxiedUrl,76        });77        request.res.once('finish', () => __awaiter(this, void 0, void 0, function* () {78            request.handleSubscriptions({79                eventName: 'after:response',80                data: request.includeBodyInAfterResponse ? {81                    finalResBody: request.res.body,82                } : {},83                mergeChanges: lodash_1.default.noop,84            });85            debug('request/response finished, cleaning up %o', { requestId: request.id });86            delete this.netStubbingState.requests[request.id];87        }));88        const ensureBody = () => {89            return new Promise((resolve) => {90                if (req.body) {91                    return resolve();92                }93                request.req.pipe((0, network_1.concatStream)((reqBody) => {94                    req.body = reqBody;95                    resolve();96                }));97            });98        };99        yield ensureBody();100        if (!lodash_1.default.isString(req.body) && !lodash_1.default.isBuffer(req.body)) {101            throw new Error('req.body must be a string or a Buffer');102        }103        const bodyEncoding = (0, util_1.getBodyEncoding)(req);104        const bodyIsBinary = bodyEncoding === 'binary';105        if (bodyIsBinary) {106            debug('req.body contained non-utf8 characters, treating as binary content %o', { requestId: request.id, req: lodash_1.default.pick(this.req, 'url') });107        }108        // leave the requests that send a binary buffer unchanged109        // but we can work with the "normal" string requests110        if (!bodyIsBinary) {111            req.body = req.body.toString('utf8');112        }113        request.req.body = req.body;114        const mergeChanges = (before, after) => {115            if (before.headers['content-length'] === after.headers['content-length']) {116                // user did not purposely override content-length, let's set it117                after.headers['content-length'] = String(Buffer.from(after.body).byteLength);118            }119            // resolve and propagate any changes to the URL120            request.req.proxiedUrl = after.url = url_1.default.resolve(request.req.proxiedUrl, after.url);121            (0, util_1.mergeWithPreservedBuffers)(before, lodash_1.default.pick(after, types_1.SERIALIZABLE_REQ_PROPS));122            (0, util_1.mergeDeletedHeaders)(before, after);123        };124        const modifiedReq = yield request.handleSubscriptions({125            eventName: 'before:request',126            data: req,127            mergeChanges,128        });129        mergeChanges(req, modifiedReq);130        // @ts-ignore131        mergeChanges(request.req, req);132        if (request.responseSent) {133            // request has been fulfilled with a response already, do not send the request outgoing134            // @see https://github.com/cypress-io/cypress/issues/15841135            return this.end();136        }137        return request.continueRequest();138    });139};...

route-matching.js

Source:route-matching.js

...117/**118 * Is this a CORS preflight request that could be for an existing route?119 * If there is a matching route with method = 'OPTIONS', returns false.120 */121function matchesRoutePreflight(routes, req) {122    if (!isPreflightRequest(req)) {123        return false;124    }125    let hasCorsOverride = false;126    const matchingRoutes = lodash_1.default.filter(routes, ({ routeMatcher }) => {127        // omit headers from matching since preflight req will not send headers128        const preflightMatcher = lodash_1.default.omit(routeMatcher, 'method', 'headers', 'auth');129        if (!_doesRouteMatch(preflightMatcher, req)) {130            return false;131        }132        if (routeMatcher.method && /options/i.test(String(routeMatcher.method))) {133            hasCorsOverride = true;134        }135        return true;...

Using AI Code Generation

1describe('My First Test', () => {2  it('Does not do much!', () => {3    cy.contains('type').click()4    cy.url().should('include', '/commands/actions')5    cy.get('.action-email')6      .type('

Using AI Code Generation

1Cypress.Commands.add('matchesRoutePreflight', (route) => {2  cy.intercept(route, (req) => {3    if (req.method === 'OPTIONS') {4      req.reply((res) => {5        res.send(200);6      });7    }8  });9});

Using AI Code Generation

1  .request({2    headers: {3    },4  })5  .then((response) => {6    expect(response.status).to.eq(200)7    expect(response).to.have.property('headers')8    expect(response.headers).to.have.property('access-control-allow-credentials', 'true')9    expect(response.headers).to.have.property('access-control-allow-headers')10    expect(response.headers['access-control-allow-headers']).to.include('accept')11    expect(response.headers['access-control-allow-headers']).to.include('content-type')12    expect(response.headers['access-control-allow-headers']).to.include('origin')13  })

Using AI Code Generation

1describe('test', () => {2  it('test', () => {3    cy.intercept('GET', '/test').as('test')4    cy.get('.network-btn').click()5    cy.wait('@test').then((interception) => {6      expect(interception.response.statusCode).to.equal(200)7      expect(interception.response.body).to.include('test')8      expect(interception.respo

Using AI Code Generation

1describe('test', () => {2  it('test', () => {3      expect(response).to.have.property('status', 200)4      expect(response).to.have.property('isPreflight', true)5      expect(response).to.have.property('body', '')6      expect(response).to.have.property('headers')7      expect(response.headers).to.have.property('access-control-allow-origin', '*')8      expect(response.headers).to.have.property('access-control-allow-headers', 'Authorization, Content-Type, If-Match, If-None-Match, If-Unmodified-Since, X-Requested-With, X-HTTP-Method-Override')9      expect(response.headers).to.have.property('access-control-allow-methods', 'DELETE, GET, PATCH, POST, PUT')10      expect(response.headers).to.have.property('access-control-expose-headers', 'Location, Content-Range')11    })12  })13})14describe('test', () => {15  it('test', () => {16      expect(response).to.have.property('status', 200)17      expect(response).to.have.property('isPreflight', true)18      expect(response).to.have.property('body', '')19      expect(response).to.have.property('headers')20      expect(response.headers).to.have.property('access-control-allow-origin', '*')21      expect(response.headers).to.have.property('access-control-allow-headers', 'Authorization, Content-Type, If-Match, If-None-Match, If-Unmodified-Since, X-Requested-With, X-HTTP-Method-Override')22      expect(response.headers).to.have.property('access-control-allow-methods', 'DELETE, GET, PATCH, POST, PUT')23      expect(response.headers).to.have.property('access-control-expose-headers', 'Location, Content-Range')24    })25  })26})27describe('test', () => {28  it('test', () => {29      expect(response).to

Using AI Code Generation

1describe('test', () => {2  it('test', () => {3      if (req.matchesRoutePreflight()) {4        req.reply({ statusCode: 200 });5      } else {6        req.reply({ statusCode: 200, body: 'test' });7      }8    });9  });10});11import '@cypress/code-coverage/support';12module.exports = (on, config) => {13  on('task', {14    log(message) {15      console.log(message);16      return null;17    },18  });19};

Using AI Code Generation

1describe('test', () => {2  it('test', () => {3    cy.server();4    cy.route('POST', 'comments/*').as('postComment');5    cy.get('.network-post').click();6    cy.wait('@postComment').should((xhr) => {7      expect(xhr.response.body).to.have.property('name', 'Using POST in cy.route()');8      expect(xhr.response.body).to.have.property('email', '

Cypress Tutorial

Cypress is a renowned Javascript-based open-source, easy-to-use end-to-end testing framework primarily used for testing web applications. Cypress is a relatively new player in the automation testing space and has been gaining much traction lately, as evidenced by the number of Forks (2.7K) and Stars (42.1K) for the project. LambdaTest’s Cypress Tutorial covers step-by-step guides that will help you learn from the basics till you run automation tests on LambdaTest.

Chapters:

What is Cypress? -
Why Cypress? - Learn why Cypress might be a good choice for testing your web applications.
Features of Cypress Testing - Learn about features that make Cypress a powerful and flexible tool for testing web applications.
Cypress Drawbacks - Although Cypress has many strengths, it has a few limitations that you should be aware of.
Cypress Architecture - Learn more about Cypress architecture and how it is designed to be run directly in the browser, i.e., it does not have any additional servers.
Browsers Supported by Cypress - Cypress is built on top of the Electron browser, supporting all modern web browsers. Learn browsers that support Cypress.
Selenium vs Cypress: A Detailed Comparison - Compare and explore some key differences in terms of their design and features.
Cypress Learning: Best Practices - Take a deep dive into some of the best practices you should use to avoid anti-patterns in your automation tests.
How To Run Cypress Tests on LambdaTest? - Set up a LambdaTest account, and now you are all set to learn how to run Cypress tests.

Certification

You can elevate your expertise with end-to-end testing using the Cypress automation framework and stay one step ahead in your career by earning a Cypress certification. Check out our Cypress 101 Certification.