|
| 1 | +'use strict' |
| 2 | +Object.defineProperty(exports, '__esModule', { value: true }) |
| 3 | +exports.DeferredSourceMapCache = void 0 |
| 4 | + |
| 5 | +const tslib_1 = require('tslib') |
| 6 | +const lodash_1 = tslib_1.__importDefault(require('lodash')) |
| 7 | +const debug_1 = tslib_1.__importDefault(require('debug')) |
| 8 | +const async_rewriters_1 = require('./async-rewriters') |
| 9 | +const sourceMaps = tslib_1.__importStar(require('./util/source-maps')) |
| 10 | +const url_1 = tslib_1.__importDefault(require('url')) |
| 11 | +const debug = (0, debug_1.default)('cypress:rewriter:deferred-source-map-cache') |
| 12 | +const caseInsensitiveGet = (obj, lowercaseProperty) => { |
| 13 | + for (let key of Object.keys(obj)) { |
| 14 | + if (key.toLowerCase() === lowercaseProperty) { |
| 15 | + return obj[key] |
| 16 | + } |
| 17 | + } |
| 18 | +} |
| 19 | +const getSourceMapHeader = (headers) => { |
| 20 | + // sourcemap has precedence |
| 21 | + // @see https://searchfox.org/mozilla-central/rev/dc4560dcaafd79375b9411fdbbaaebb0a59a93ac/devtools/shared/DevToolsUtils.js#611-619 |
| 22 | + return caseInsensitiveGet(headers, 'sourcemap') || caseInsensitiveGet(headers, 'x-sourcemap') |
| 23 | +} |
| 24 | + |
| 25 | +/** |
| 26 | + * Holds on to data necessary to rewrite user JS to maybe generate a sourcemap at a later time, |
| 27 | + * potentially composed with the user's own sourcemap if one is present. |
| 28 | + * |
| 29 | + * The purpose of this is to avoid wasting CPU time and network I/O on generating, composing, and |
| 30 | + * sending a sourcemap along with every single rewritten JS snippet, since the source maps are |
| 31 | + * going to be unused and discarded most of the time. |
| 32 | + */ |
| 33 | +class DeferredSourceMapCache { |
| 34 | + constructor (requestLib) { |
| 35 | + this._idCounter = 0 |
| 36 | + this.requests = [] |
| 37 | + this.defer = (request) => { |
| 38 | + if (this._getRequestById(request.uniqueId)) { |
| 39 | + // prevent duplicate uniqueIds from ever existing |
| 40 | + throw new Error(`Deferred sourcemap key "${request.uniqueId}" is not unique`) |
| 41 | + } |
| 42 | + |
| 43 | + // remove existing requests for this URL since they will not be loaded again |
| 44 | + this._removeRequestsByUrl(request.url) |
| 45 | + this.requests.push(request) |
| 46 | + } |
| 47 | + |
| 48 | + this.requestLib = requestLib |
| 49 | + } |
| 50 | + _removeRequestsByUrl (url) { |
| 51 | + lodash_1.default.remove(this.requests, { url }) |
| 52 | + } |
| 53 | + _getRequestById (uniqueId) { |
| 54 | + return lodash_1.default.find(this.requests, { uniqueId }) |
| 55 | + } |
| 56 | + async _getInputSourceMap (request, headers) { |
| 57 | + // prefer inline sourceMappingURL over headers |
| 58 | + const sourceMapUrl = sourceMaps.getMappingUrl(request.js) || getSourceMapHeader(request.resHeaders) |
| 59 | + |
| 60 | + if (!sourceMapUrl) { |
| 61 | + return |
| 62 | + } |
| 63 | + |
| 64 | + // try to decode it as a base64 string |
| 65 | + const inline = sourceMaps.tryDecodeInlineUrl(sourceMapUrl) |
| 66 | + |
| 67 | + if (inline) { |
| 68 | + return inline |
| 69 | + } |
| 70 | + |
| 71 | + // try to load it from the web |
| 72 | + const req = { |
| 73 | + url: url_1.default.resolve(request.url, sourceMapUrl), |
| 74 | + // TODO: this assumes that the sourcemap is on the same base domain, so it's safe to send the same headers |
| 75 | + // the browser sent for this sourcemap request - but if sourcemap is on a different domain, this will not |
| 76 | + // be true. need to use browser's cookiejar instead. |
| 77 | + headers, |
| 78 | + timeout: 5000, |
| 79 | + } |
| 80 | + |
| 81 | + try { |
| 82 | + const { body } = await this.requestLib(req, true) |
| 83 | + |
| 84 | + return body |
| 85 | + } catch (error) { |
| 86 | + // eslint-disable-next-line no-console |
| 87 | + debug('got an error loading user-provided sourcemap, serving proxy-generated sourcemap only %o', { url: request.url, headers, error }) |
| 88 | + } |
| 89 | + } |
| 90 | + async resolve (uniqueId, headers) { |
| 91 | + const request = this._getRequestById(uniqueId) |
| 92 | + |
| 93 | + if (!request) { |
| 94 | + throw new Error(`Missing request with ID '${uniqueId}'`) |
| 95 | + } |
| 96 | + |
| 97 | + if (request.sourceMap) { |
| 98 | + return request.sourceMap |
| 99 | + } |
| 100 | + |
| 101 | + if (!request.js) { |
| 102 | + throw new Error('Missing JS for source map rewrite') |
| 103 | + } |
| 104 | + |
| 105 | + const inputSourceMap = await this._getInputSourceMap(request, headers) |
| 106 | + |
| 107 | + // cache the sourceMap so we don't need to regenerate it |
| 108 | + request.sourceMap = await (0, async_rewriters_1.rewriteJsSourceMapAsync)(request.url, request.js, inputSourceMap) |
| 109 | + delete request.js // won't need this again |
| 110 | + delete request.resHeaders |
| 111 | + |
| 112 | + return request.sourceMap |
| 113 | + } |
| 114 | +} |
| 115 | +exports.DeferredSourceMapCache = DeferredSourceMapCache |
0 commit comments