fix(cy.intercept): allow fixtures to define null encoding when used in static response (#19379)

Author: emilyrohrbough

packages/driver/cypress/integration/commands/net_stubbing_spec.ts

@@ -1319,6 +1319,61 @@ describe('network stubbing', function () {
         cy.contains('#result', '""').should('be.visible')
       })
 
+      // @see https://github.com/cypress-io/cypress/issues/19330
+      // @see https://github.com/cypress-io/cypress/issues/19344
+      it('load fixture as Buffer when encoding is null', function () {
+        // call through normally on everything
+        cy.spy(Cypress, 'backend')
+
+        cy.intercept('/fixtures/media/small.mp4', {
+          fixture: 'media/small.mp4,null',
+        }).as('video')
+
+        cy.visit('/fixtures/video.html')
+        .then(() => {
+          // @ts-ignore .getCall is a Sinon spy command
+          expect(Cypress.backend.getCall(0)).to.be.calledWithMatch(
+            'net',
+            'route:added',
+            {
+              staticResponse: {
+                fixture: {
+                  filePath: 'media/small.mp4',
+                  encoding: null,
+                },
+              },
+            },
+          )
+        })
+      })
+
+      it('load fixture with specified encoding', function () {
+        // call through normally on everything
+        cy.spy(Cypress, 'backend')
+
+        cy.intercept('non-existing-image.png', {
+          headers: { 'content-type': 'image/jpeg' },
+          fixture: 'media/cypress.png,base64',
+        }).as('video')
+
+        cy.visit('/fixtures/img-embed.html')
+        .then(() => {
+          // @ts-ignore .getCall is a Sinon spy command
+          expect(Cypress.backend.getCall(0)).to.be.calledWithMatch(
+            'net',
+            'route:added',
+            {
+              staticResponse: {
+                fixture: {
+                  filePath: 'media/cypress.png',
+                  encoding: 'base64',
+                },
+              },
+            },
+          )
+        })
+      })
+
       // @see https://github.com/cypress-io/cypress/issues/8623
       it('works with images', function () {
         cy.visit('/fixtures/img-embed.html')

packages/driver/cypress/integration/cy/net-stubbing/static-response-utils-spec.ts

@@ -0,0 +1,78 @@
+const {
+  getBackendStaticResponse,
+} = require('../../../../src/cy/net-stubbing/static-response-utils')
+
+describe('driver/src/cy/net-stubbing/static-response-utils', () => {
+  describe('.getBackendStaticResponse', () => {
+    describe('delay', () => {
+      it('does not set delay when delayMS is not provided', () => {
+        const staticResponse = getBackendStaticResponse({})
+
+        expect(staticResponse).to.not.have.property('delay')
+      })
+
+      it('sets delay', () => {
+        const staticResponse = getBackendStaticResponse({ delayMs: 200 })
+
+        expect(staticResponse).to.have.property('delay', 200)
+      })
+    })
+
+    describe('fixtures', () => {
+      it('does not set fixtures data when fixtures string is not provided', () => {
+        const staticResponse = getBackendStaticResponse({})
+
+        expect(staticResponse).to.not.have.property('fixtures')
+      })
+
+      it('parses fixture string without file encoding', () => {
+        const staticResponse = getBackendStaticResponse({ fixture: 'file.html' })
+
+        expect(staticResponse.fixture).to.deep.equal({
+          filePath: 'file.html',
+          encoding: undefined,
+        })
+      })
+
+      it('parses fixture string with file encoding', () => {
+        const staticResponse = getBackendStaticResponse({ fixture: 'file.html,utf8' })
+
+        expect(staticResponse.fixture).to.deep.equal({
+          filePath: 'file.html',
+          encoding: 'utf8',
+        })
+      })
+
+      it('parses fixture string with file encoding set as null to indicate Buffer', () => {
+        const staticResponse = getBackendStaticResponse({ fixture: 'file.html,null' })
+
+        expect(staticResponse.fixture).to.deep.equal({
+          filePath: 'file.html',
+          encoding: null,
+        })
+      })
+    })
+
+    describe('body', () => {
+      it('does not set body when body is undefined', () => {
+        const staticResponse = getBackendStaticResponse({})
+
+        expect(staticResponse).to.not.have.property('body')
+      })
+
+      it('sets body when body is provided as a string', () => {
+        const staticResponse = getBackendStaticResponse({ body: 'body' })
+
+        expect(staticResponse.body).to.eq('body')
+      })
+
+      it('sets body when body is provided as a ArrayBuffer', () => {
+        const buffer = new ArrayBuffer(8)
+        const staticResponse = getBackendStaticResponse({ body: buffer })
+
+        expect(staticResponse.body).to.be.a('arraybuffer')
+        expect(staticResponse.body).to.eq(buffer)
+      })
+    })
+  })
+})

packages/driver/src/cy/net-stubbing/static-response-utils.ts

@@ -95,7 +95,7 @@ export function parseStaticResponseShorthand (statusCodeOrBody: number | string
 function getFixtureOpts (fixture: string): FixtureOpts {
   const [filePath, encoding] = fixture.split(',')
 
-  return { filePath, encoding }
+  return { filePath, encoding: encoding === 'null' ? null : encoding }
 }
 
 export function getBackendStaticResponse (staticResponse: Readonly<StaticResponse>): BackendStaticResponseWithArrayBuffer {

packages/net-stubbing/lib/internal-types.ts

@@ -7,7 +7,7 @@ import type {
 } from './external-types'
 
 export type FixtureOpts = {
-  encoding: string
+  encoding: string | null
   filePath: string
 }
 

packages/server/lib/fixture.js

@@ -165,7 +165,7 @@ module.exports = {
 
       return obj
     }).catch((err) => {
-      throw new Error(`'${fixture}' is not a valid JavaScript object.${err.toString()}`)
+      throw new Error(`'${fixture}' is not a valid JavaScript object.\n${err.toString()}`)
     })
   },
 
@@ -190,10 +190,16 @@ module.exports = {
   parseHtml (p, fixture) {
     return fs.readFileAsync(p, 'utf8')
     .bind(this)
+    .catch((err) => {
+      throw new Error(`Unable to parse '${fixture}'.\n${err.toString()}`)
+    })
   },
 
   parse (p, fixture, encoding) {
     return fs.readFileAsync(p, encoding)
     .bind(this)
+    .catch((err) => {
+      throw new Error(`Unable to parse '${fixture}'.\n${err.toString()}`)
+    })
   },
 }

packages/server/test/unit/fixture_spec.js

@@ -215,7 +215,7 @@ ParseError: Unterminated string constant\
       .then(() => {
         throw new Error('should have failed but did not')
       }).catch((err) => {
-        expect(err.message).to.eq(`'bad_js.js' is not a valid JavaScript object.\n${e}`)
+        expect(err.message).to.eq(`'bad_js.js' is not a valid JavaScript object.\n\n${e}`)
       })
     })
   })