mirror/cypress
1
0
Fork 0
mirror of https://github.com/cypress-io/cypress.git synced 2026-04-25 00:19:11 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
92f0cae3492fc197d664aa6907257e09305f6b79
cypress/packages/server/lib/request.coffee
T
Brian Mann 71f07c2512 server: rename packages/app -> packages/server
2017-05-09 13:51:45 -04:00

439 lines
13 KiB
CoffeeScript
Raw Blame History

_ = require("lodash")
r = require("request")
rp = require("request-promise")
url = require("url")
tough = require("tough-cookie")
moment = require("moment")
Promise = require("bluebird")
statusCode = require("./util/status_code")
Cookies = require("./automation/cookies")
Cookie = tough.Cookie
CookieJar = tough.CookieJar
process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0"
getOriginalHeaders = (req = {}) ->
## the request instance holds an instance
## of the original ClientRequest
## as the 'req' property which holds the
## original headers
req.req?.headers ? req.headers
pick = (resp = {}) ->
req = resp.request ? {}
headers = getOriginalHeaders(req)
{
"Request Body": req.body ? null
"Request Headers": headers
"Request URL": req.href
"Response Body": resp.body ? null
"Response Headers": resp.headers
"Response Status": resp.statusCode
}
setCookies = (cookies, jar, headers, url) =>
return if _.isEmpty(cookies)
if jar
cookies.forEach (c) ->
jar.setCookie(c, url, {ignoreError: true})
else
headers.Cookie = createCookieString(cookies)
newCookieJar = ->
j = new CookieJar(undefined, {looseMode: true})
## match the same api signature as @request
{
_jar: j
toJSON: ->
j.toJSON()
setCookie: (cookieOrStr, uri, options) ->
j.setCookieSync(cookieOrStr, uri, options)
getCookieString: (uri) ->
j.getCookieStringSync(uri, {expire: false})
getCookies: (uri) ->
j.getCookiesSync(uri, {expire: false})
}
convertToJarCookie = (cookies = []) ->
_.map cookies, (cookie) ->
props = {
key: cookie.name
path: cookie.path
value: cookie.value
secure: cookie.secure
httpOnly: cookie.httpOnly
hostOnly: cookie.hostOnly
}
## hostOnly is the default when
## NO DOMAIN= attribute was set
##
## so if we are not hostOnly then
## this cookie WAS created with
## a Domain= attribute and therefore
## which lessens whichs domains this
## cookie may be sent, and therefore
## we need to set props.domain else
## the domain would be implied by URL
if not cookie.hostOnly
## https://github.com/salesforce/tough-cookie/issues/26
## we need to strip the leading dot
## on domains else tough cookie will not
## properly send these cookies.
## we get dot leading domains from the
## chrome cookie API's
props.domain = _.trimStart(cookie.domain, ".")
## if we have an expiry then this
## is the number of seconds since the epoch
## that this cookie expires. we need to convert
## this to a JS date object
if cookie.expiry?
props.expires = moment.unix(cookie.expiry).toDate()
return new Cookie(props)
reduceCookieToArray = (c) ->
_.reduce c, (memo, val, key) ->
memo.push [key.trim(), val.trim()].join("=")
memo
, []
createCookieString = (c) ->
reduceCookieToArray(c).join("; ")
module.exports = (options = {}) ->
defaults = {
timeout: options.timeout ? 20000
# forever: true
}
r = r.defaults(defaults)
rp = rp.defaults(defaults)
return {
r: require("request")
rp: require("request-promise")
reduceCookieToArray: reduceCookieToArray
createCookieString: createCookieString
create: (strOrOpts, promise) ->
switch
when _.isString(strOrOpts)
opts = {
url: strOrOpts
}
else
opts = strOrOpts
opts.url = url.parse(opts.url)
## parse port into a legit number
## to fix issue with request
## https://github.com/cypress-io/cypress/issues/222
if p = opts.url.port
opts.url.port = _.toNumber(p)
if promise
rp(opts)
else
r(opts)
contentTypeIsJson: (response) ->
## TODO: use https://github.com/jshttp/type-is for this
response?.headers?["content-type"]?.includes("application/json")
parseJsonBody: (body) ->
try
JSON.parse(body)
catch e
body
normalizeResponse: (push, response) ->
req = response.request ? {}
push(response)
response = _.pick(response, "statusCode", "body", "headers")
## normalize status
response.status = response.statusCode
delete response.statusCode
_.extend(response, {
## normalize what is an ok status code
statusText: statusCode.getText(response.status)
isOkStatusCode: statusCode.isOk(response.status)
requestHeaders: getOriginalHeaders(req)
requestBody: req.body
})
## if body is a string and content type is json
## try to convert the body to JSON
if _.isString(response.body) and @contentTypeIsJson(response)
response.body = @parseJsonBody(response.body)
return response
setJarCookies: (jar, automationFn) ->
setCookie = (cookie) ->
cookie.name = cookie.key
## TODO: fix this
return if cookie.name and cookie.name.startsWith("__cypress")
## tough-cookie will return us a cookie that looks like this....
# { key: 'secret-session',
# value: 's%3AxMYoMAXnnMN2pzjYKJx21Id9zjQOaPsT.aKJv1mlfNlCEtrPUjgt48KX0c7xNiB%2Bb0fLijmi48dY',
# domain: 'session.foobar.com',
# path: '/',
# httpOnly: true,
# extensions: [ 'SameSite=Strict' ],
# hostOnly: true,
# creation: '2016-09-04T18:48:06.882Z',
# lastAccessed: '2016-09-04T18:48:06.882Z',
# name: 'secret-session' }
#
# { key: '2293-session',
# value: 'true',
# domain: 'localhost',
# path: '/',
# hostOnly: true,
# creation: '2016-09-05T03:03:20.780Z',
# lastAccessed: '2016-09-05T03:03:20.780Z',
# name: '2293-session' }
switch
when cookie.maxAge?
## when we have maxAge
## prefer that
## unix returns us time in seconds
## from the epoc + we add that
## to maxAge since thats relative seconds
## from now
cookie.expiry = moment().unix() + cookie.maxAge
when ex = cookie.expires
## tough cookie provides javascript date
## formatted expires
cookie.expiry = moment(ex).unix()
automationFn("set:cookie", cookie)
.then ->
## the automation may return us null in
## the case an expired cookie is removed
Cookies.normalizeCookieProps(cookie)
Promise.try ->
store = jar.toJSON()
## this likely needs
## to be an 'each' not a map
## since we need to set cookies
## in sequence and not all at once
## because cookies could have colliding
## values which need to be set in order
Promise.each(store.cookies, setCookie)
sendStream: (headers, automationFn, options = {}) ->
_.defaults options, {
headers: {}
jar: true
}
if ua = headers["user-agent"]
options.headers["user-agent"] = ua
## create a new jar instance
## unless its falsy or already set
if options.jar is true
options.jar = newCookieJar()
_.extend options, {
strictSSL: false
}
self = @
if jar = options.jar
followRedirect = options.followRedirect
options.followRedirect = (incomingRes) ->
## if we have a cookie jar
req = @
newUrl = url.resolve(options.url, incomingRes.headers.location)
## and when we know we should follow the redirect
## we need to override the init method and
## first set the existing jar cookies on the browser
## and then grab the cookies for the new url
req.init = _.wrap req.init, (orig, opts) =>
self.setJarCookies(jar, automationFn)
.then ->
automationFn("get:cookies", {url: newUrl, includeHostOnly: true})
.then(convertToJarCookie)
.then (cookies) ->
setCookies(cookies, jar, null, newUrl)
.then ->
orig.call(req, opts)
followRedirect.call(req, incomingRes)
send = =>
str = @create(options)
str.getJar = -> options.jar
str
automationFn("get:cookies", {url: options.url, includeHostOnly: true})
.then(convertToJarCookie)
.then (cookies) ->
setCookies(cookies, options.jar, options.headers, options.url)
.then(send)
send: (headers, automationFn, options = {}) ->
_.defaults options, {
headers: {}
gzip: true
jar: true
cookies: true
followRedirect: true
}
if ua = headers["user-agent"]
options.headers["user-agent"] = ua
## normalize case sensitivity
## to be lowercase
if a = options.headers.Accept
delete options.headers.Accept
options.headers.accept = a
## https://github.com/cypress-io/cypress/issues/338
_.defaults(options.headers, {
accept: "*/*"
})
## create a new jar instance
## unless its falsy or already set
if options.jar is true
options.jar = newCookieJar()
_.extend options, {
strictSSL: false
simple: false
resolveWithFullResponse: true
}
## https://github.com/cypress-io/cypress/issues/322
## either turn these both on or off
options.followAllRedirects = options.followRedirect
if options.form is true
## reset form to whatever body is
## and nuke body
options.form = options.body
delete options.json
delete options.body
send = =>
ms = Date.now()
self = @
redirects = []
requestResponses = []
push = (response) ->
requestResponses.push(pick(response))
if options.followRedirect
options.followRedirect = (incomingRes) ->
newUrl = url.resolve(options.url, incomingRes.headers.location)
## normalize the url
redirects.push([incomingRes.statusCode, newUrl].join(": "))
push(incomingRes)
## if we have a cookie jar
if jar = options.jar
req = @
## and when we know we should follow the redirect
## we need to override the init method and
## first set the existing jar cookies on the browser
## and then grab the cookies for the new url
req.init = _.wrap req.init, (orig, opts) =>
self.setJarCookies(options.jar, automationFn)
.then ->
automationFn("get:cookies", {url: newUrl, includeHostOnly: true})
.then(convertToJarCookie)
.then (cookies) ->
setCookies(cookies, jar, null, newUrl)
.then ->
orig.call(req, opts)
## cause the redirect to happen
## but swallow up the incomingRes
## so we can build an array of responses
return true
@create(options, true)
.then(@normalizeResponse.bind(@, push))
.then (resp) =>
## TODO: move duration somewhere...?
## does node store this somewhere?
## we could probably calculate this ourselves
## by using the date headers
resp.duration = Date.now() - ms
resp.allRequestResponses = requestResponses
if redirects.length
resp.redirects = redirects
if options.followRedirect is false and (loc = resp.headers.location)
## resolve the new location head against
## the current url
resp.redirectedToUrl = url.resolve(options.url, loc)
if options.jar
@setJarCookies(options.jar, automationFn)
.return(resp)
else
resp
if c = options.cookies
## if we have a cookie object then just
## send the request up!
if _.isObject(c)
setCookies(c, null, options.headers)
send()
else
## else go get the cookies first
## then make the request
## TODO: we can simply use the 'url' property on the cookies API
## which automatically pulls all of the cookies that would be
## set for that url!
automationFn("get:cookies", {url: options.url, includeHostOnly: true})
.then(convertToJarCookie)
.then (cookies) ->
setCookies(cookies, options.jar, options.headers, options.url)
.then(send)
else
send()
}
Reference in New Issue View Git Blame Copy Permalink