Add Cypress.Buffer

Author: BlueWinds

cli/types/cypress-eventemitter.d.ts

@@ -28,7 +28,6 @@ interface NodeEventEmitter {
   eventNames(): Array<string | symbol>
 }
 
-// The Buffer type is automatically imported for the browser by webpack
-// and we use it for dealing with binary data, especially around the
+// We use the Buffer class for dealing with binary data, especially around the
 // selectFile interface.
-type BufferType = import("buffer/").Buffer
+type BufferModule = import("buffer/")

cli/types/cypress.d.ts

@@ -231,6 +231,15 @@ declare namespace Cypress {
      *    Cypress.Blob.method()
      */
     Blob: BlobUtil.BlobUtilStatic
+    /**
+     * Cypress automatically includes a Buffer library and exposes it as Cypress.Buffer.
+     *
+     * @see https://on.cypress.io/buffer
+     * @see https://github.com/feross/buffer
+     * @example
+     *    Cypress.Blob.method()
+     */
+    Buffer: BufferModule
     /**
      * Cypress automatically includes minimatch and exposes it as Cypress.minimatch.
      *
@@ -668,7 +677,7 @@ declare namespace Cypress {
      * @param {FileReference} files - The file(s) to select or drag onto this element.
      * @see https://on.cypress.io/selectfile
      * @example
-     *    cy.get('input[type=file]').selectFile(Buffer.from('text'))
+     *    cy.get('input[type=file]').selectFile(Cypress.Buffer.from('text'))
      *    cy.get('input[type=file]').selectFile({
      *      fileName: 'users.json',
      *      fileContents: [{name: 'John Doe'}]
@@ -5666,10 +5675,11 @@ declare namespace Cypress {
     stderr: string
   }
 
-  type FileReference = string | BufferType | FileReferenceObject
+  type FileReference = string | BufferModule.Buffer | FileReferenceObject
   interface FileReferenceObject {
     /*
-     * Buffers and strings will be used as-is. All other types will have `JSON.stringify()` applied.
+     * Buffers will be used as-is, while strings will be interpreted as an alias or a file path.
+     * All other types will have `Buffer.from(JSON.stringify())` applied.
      */
     contents: any
     fileName?: string

packages/driver/cypress/integration/commands/actions/selectFile_spec.js

@@ -20,7 +20,7 @@ function getFileContents (subject) {
 describe('src/cy/commands/actions/selectFile', () => {
   beforeEach(() => {
     cy.visit('/fixtures/files-form.html')
-    cy.wrap(Buffer.from('foo')).as('foo')
+    cy.wrap(Cypress.Buffer.from('foo')).as('foo')
   })
 
   context('#selectFile', () => {
@@ -50,10 +50,10 @@ describe('src/cy/commands/actions/selectFile', () => {
           contents: '@foo',
           fileName: 'foo.txt',
         }, {
-          contents: Buffer.from('{"a":"bar"}'),
+          contents: Cypress.Buffer.from('{"a":"bar"}'),
           fileName: 'bar.json',
         },
-        Buffer.from('baz'),
+        Cypress.Buffer.from('baz'),
       ])
 
       cy.get('#multiple')

packages/driver/cypress/integration/util/buffer_spec.js

@@ -0,0 +1,7 @@
+describe('Cypress.Buffer', () => {
+  it('matches the type returned from readFile', () => {
+    cy.readFile('cypress/fixtures/app.js', null).then((buffer) => {
+      expect(Cypress.Buffer.isBuffer(buffer)).to.be.true
+    })
+  })
+})

packages/driver/src/cypress.ts

@@ -692,6 +692,7 @@ $Cypress.prototype.SelectorPlayground = $SelectorPlayground
 $Cypress.prototype.utils = $utils
 $Cypress.prototype._ = _
 $Cypress.prototype.Blob = blobUtil
+$Cypress.prototype.Buffer = Buffer
 $Cypress.prototype.Promise = Promise
 $Cypress.prototype.minimatch = minimatch
 $Cypress.prototype.sinon = sinon