Revert "Use websockets to stub large XHR response bodies instead of h…

…ea… (#5525)" This reverts commit 249db45.
cypress-io · Mar 11, 2020 · d77c106 · d77c106
1 parent df30ae6
commit d77c106
Show file tree

Hide file tree

Showing 12 changed files with 45 additions and 336 deletions.
diff --git a/packages/driver/src/cy/commands/navigation.coffee b/packages/driver/src/cy/commands/navigation.coffee
@@ -86,7 +86,7 @@ cannotVisitDifferentOrigin = (origin, previousUrlVisited, remoteUrl, existingUrl
       previousUrl: previousUrlVisited
       attemptedUrl: origin
     }
-  } 
+  }
 
   $errUtils.throwErrByPath("visit.cannot_visit_different_origin", errOpts)
 
@@ -294,6 +294,10 @@ normalizeTimeoutOptions = (options) ->
 module.exports = (Commands, Cypress, cy, state, config) ->
   reset()
 
+  Cypress.on "test:before:run:async", ->
+    ## reset any state on the backend
+    Cypress.backend('reset:server:state')
+
   Cypress.on("test:before:run", reset)
 
   Cypress.on "stability:changed", (bool, event) ->

diff --git a/packages/driver/src/cy/commands/xhr.coffee b/packages/driver/src/cy/commands/xhr.coffee
@@ -88,9 +88,6 @@ startXhrServer = (cy, state, config) ->
     xhrUrl: config("xhrUrl")
     stripOrigin: stripOrigin
 
-    emitIncoming: (id, route) ->
-      Cypress.backend('incoming:xhr', id, route)
-
     ## shouldnt these stubs be called routes?
     ## rename everything related to stubs => routes
     onSend: (xhr, stack, route) =>
@@ -252,10 +249,6 @@ module.exports = (Commands, Cypress, cy, state, config) ->
   ## correctly
   Cypress.on("window:unload", cancelPendingXhrs)
 
-  Cypress.on "test:before:run:async", ->
-    ## reset any state on the backend
-    Cypress.backend('reset:server:state')
-
   Cypress.on "test:before:run", ->
     ## reset the existing server
     reset()
@@ -266,7 +259,7 @@ module.exports = (Commands, Cypress, cy, state, config) ->
     ## window such as if the last test ended
     ## with a cross origin window
     try
-      server = startXhrServer(cy, state, config, Cypress)
+      server = startXhrServer(cy, state, config)
     catch err
       ## in this case, just don't bind to the server
       server = null

diff --git a/packages/driver/src/cypress/server.coffee b/packages/driver/src/cypress/server.coffee
@@ -11,8 +11,11 @@ props                    = "onreadystatechange onload onerror".split(" ")
 
 restoreFn = null
 
-setHeader = (xhr, key, val) ->
+setHeader = (xhr, key, val, transformer) ->
   if val?
+    if transformer
+      val = transformer(val)
+
     key = "X-Cypress-" + _.capitalize(key)
     xhr.setRequestHeader(key, encodeURI(val))
 
@@ -174,30 +177,18 @@ create = (options = {}) ->
       hasEnabledStubs and route and route.response?
 
     applyStubProperties: (xhr, route) ->
-      responseToString = =>
-        if not _.isString(route.response)
-          return JSON.stringify(route.response)
-
-        route.response
-
-      response = responseToString()
-
-      headers = {
-        "id": xhr.id
-        "status": route.status
-        "matched": route.url + ""
-        "delay": route.delay
-        "headers": transformHeaders(route.headers)
-      }
-
-      if response.length > 4096
-        options.emitIncoming(xhr.id, response)
-        headers.responseDeferred = true
-      else
-        headers.response = response
-
-      _.map headers, (v, k) =>
-        setHeader(xhr, k, v)
+      responser = if _.isObject(route.response) then JSON.stringify else null
+
+      ## add header properties for the xhr's id
+      ## and the testId
+      setHeader(xhr, "id", xhr.id)
+      # setHeader(xhr, "testId", options.testId)
+
+      setHeader(xhr, "status",   route.status)
+      setHeader(xhr, "response", route.response, responser)
+      setHeader(xhr, "matched",  route.url + "")
+      setHeader(xhr, "delay",    route.delay)
+      setHeader(xhr, "headers",  route.headers, transformHeaders)
 
     route: (attrs = {}) ->
       warnOnStubDeprecation(attrs, "route")

diff --git a/packages/server/__snapshots__/4_xhr_spec.coffee.js b/packages/server/__snapshots__/4_xhr_spec.coffee.js
@@ -71,71 +71,6 @@ exports['e2e xhr / passes in global mode'] = `
 
 exports['e2e xhr / passes through CLI'] = `
 
-====================================================================================================
-
-  (Run Starting)
-
-  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
-  │ Cypress:    1.2.3                                                                              │
-  │ Browser:    FooBrowser 88                                                                      │
-  │ Specs:      1 found (xhr_spec.coffee)                                                          │
-  │ Searched:   cypress/integration/xhr_spec.coffee                                                │
-  └────────────────────────────────────────────────────────────────────────────────────────────────┘
-
-
-────────────────────────────────────────────────────────────────────────────────────────────────────
-                                                                                                    
-  Running:  xhr_spec.coffee                                                                 (1 of 1)
-
-
-  xhrs
-    ✓ can encode + decode headers
-    ✓ ensures that request headers + body go out and reach the server unscathed
-    ✓ does not inject into json's contents from http server even requesting text/html
-    ✓ does not inject into json's contents from file server even requesting text/html
-    ✓ works prior to visit
-    ✓ can stub a 100kb response
-    ✓ spawns tasks with original NODE_OPTIONS
-    server with 1 visit
-      ✓ response body
-      ✓ request body
-      ✓ aborts
-
-
-  10 passing
-
-
-  (Results)
-
-  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
-  │ Tests:        10                                                                               │
-  │ Passing:      10                                                                               │
-  │ Failing:      0                                                                                │
-  │ Pending:      0                                                                                │
-  │ Skipped:      0                                                                                │
-  │ Screenshots:  0                                                                                │
-  │ Video:        true                                                                             │
-  │ Duration:     X seconds                                                                        │
-  │ Spec Ran:     xhr_spec.coffee                                                                  │
-  └────────────────────────────────────────────────────────────────────────────────────────────────┘
-
-
-  (Video)
-
-  -  Started processing:  Compressing to 32 CRF                                                     
-  -  Finished processing: /XXX/XXX/XXX/cypress/videos/xhr_spec.coffee.mp4                 (X second)
-
-
-====================================================================================================
-
-  (Run Finished)
-
-
-       Spec                                              Tests  Passing  Failing  Pending  Skipped  
-  ┌────────────────────────────────────────────────────────────────────────────────────────────────┐
-  │ ✔  xhr_spec.coffee                          XX:XX       10       10        -        -        - │
-  └────────────────────────────────────────────────────────────────────────────────────────────────┘
-    ✔  All specs passed!                        XX:XX       10       10        -        -        -  
 
 
 `
diff --git a/packages/server/lib/controllers/xhrs.coffee b/packages/server/lib/controllers/xhrs.coffee
@@ -18,7 +18,7 @@ isValidJSON = (text) ->
   return false
 
 module.exports = {
-  handle: (req, res, getDeferredResponse, config, next) ->
+  handle: (req, res, config, next) ->
     get = (val, def) ->
       decodeURI(req.get(val) ? def)
 
@@ -27,10 +27,6 @@ module.exports = {
     headers  = get("x-cypress-headers", null)
     response = get("x-cypress-response", "")
 
-    if get("x-cypress-responsedeferred", "")
-      id = get("x-cypress-id")
-      response = getDeferredResponse(id)
-
     respond = =>
       ## figure out the stream interface and pipe these
       ## chunks to the response
@@ -63,10 +59,6 @@ module.exports = {
         .set(headers)
         .status(status)
         .end(chunk)
-      .catch { testEndedBeforeResponseReceived: true }, ->
-        res
-        .socket
-        .destroy()
       .catch (err) ->
         res
         .status(400)
@@ -92,15 +84,10 @@ module.exports = {
       {data: bytes, encoding: encoding}
 
   getResponse: (resp, config) ->
-    if resp.then
-      return resp
-      .then (data) =>
-        { data }
-
     if fixturesRe.test(resp)
-      return @_get(resp, config)
-
-    Promise.resolve({data: resp})
+      @_get(resp, config)
+    else
+      Promise.resolve({data: resp})
 
   parseContentType: (response) ->
     ret = (type) ->

diff --git a/packages/server/lib/routes.js b/packages/server/lib/routes.js
@@ -12,7 +12,7 @@ const client = require('./controllers/client')
 const files = require('./controllers/files')
 const staticCtrl = require('./controllers/static')
 
-module.exports = ({ app, config, getDeferredResponse, getRemoteState, networkProxy, project, onError }) => {
+module.exports = ({ app, config, getRemoteState, networkProxy, project, onError }) => {
   // routing for the actual specs which are processed automatically
   // this could be just a regular .js file or a .coffee file
   app.get('/__cypress/tests', (req, res, next) => {
@@ -49,7 +49,7 @@ module.exports = ({ app, config, getDeferredResponse, getRemoteState, networkPro
   })
 
   app.all('/__cypress/xhrs/*', (req, res, next) => {
-    xhrs.handle(req, res, getDeferredResponse, config, next)
+    xhrs.handle(req, res, config, next)
   })
 
   app.get('/__root/*', (req, res) => {

diff --git a/packages/server/lib/server.coffee b/packages/server/lib/server.coffee
@@ -33,7 +33,6 @@ logger       = require("./logger")
 Socket       = require("./socket")
 Request      = require("./request")
 fileServer   = require("./file_server")
-XhrServer    = require("./xhr_ws_server")
 templateEngine = require("./template_engine")
 
 DEFAULT_DOMAIN_NAME    = "localhost"
@@ -177,7 +176,6 @@ class Server
       ## TODO: might not be needed anymore
       @_request = Request({timeout: config.responseTimeout})
       @_nodeProxy = httpProxy.createProxyServer()
-      @_xhrServer = XhrServer.create()
 
       getRemoteState = => @_getRemoteState()
 
@@ -190,7 +188,6 @@ class Server
       @createRoutes({
         app
         config
-        getDeferredResponse: @_xhrServer.getDeferredResponse
         getRemoteState
         networkProxy: @_networkProxy
         onError
@@ -742,14 +739,13 @@ class Server
   startWebsockets: (automation, config, options = {}) ->
     options.onResolveUrl = @_onResolveUrl.bind(@)
     options.onRequest    = @_onRequest.bind(@)
-    options.onIncomingXhr = @_xhrServer.onIncomingXhr
 
     options.onResetServerState = =>
-      @_xhrServer.reset()
       @_networkProxy.reset()
 
     @_socket = new Socket(config)
     @_socket.startListening(@_server, automation, config, options)
     @_normalizeReqUrl(@_server)
+    # handleListeners(@_server)
 
 module.exports = Server
diff --git a/packages/server/lib/socket.js b/packages/server/lib/socket.js
@@ -147,7 +147,6 @@ class Socket {
 
     _.defaults(options, {
       socketId: null,
-      onIncomingXhr () {},
       onResetServerState () {},
       onSetRunnables () {},
       onMocha () {},
@@ -375,8 +374,6 @@ class Socket {
               return firefoxUtil.log()
             case 'firefox:force:gc':
               return firefoxUtil.collectGarbage()
-            case 'incoming:xhr':
-              return options.onIncomingXhr(args[0], args[1])
             case 'get:fixture':
               return fixture.get(config.fixturesFolder, args[0], args[1])
             case 'read:file':

diff --git a/packages/server/lib/xhr_ws_server.ts b/packages/server/lib/xhr_ws_server.ts