microsoft/vscode-react-native
Publicmirrored fromhttps://github.com/microsoft/vscode-react-nativeAvailable
src/debugger/scriptImporter.ts
126lines · modecode
| 1 | // Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | // Licensed under the MIT license. See LICENSE file in the project root for details. |
| 3 | |
| 4 | import {FileSystem} from "../common/node/fileSystem"; |
| 5 | import { logger } from "vscode-chrome-debug-core"; |
| 6 | import { ensurePackagerRunning } from "../common/packagerStatus"; |
| 7 | import path = require("path"); |
| 8 | import Q = require("q"); |
| 9 | import {Request} from "../common/node/request"; |
| 10 | import {SourceMapUtil} from "./sourceMap"; |
| 11 | import url = require("url"); |
| 12 | import * as semver from "semver"; |
| 13 | import {ReactNativeProjectHelper} from "../common/reactNativeProjectHelper"; |
| 14 | |
| 15 | export interface DownloadedScript { |
| 16 | contents: string; |
| 17 | filepath: string; |
| 18 | } |
| 19 | |
| 20 | interface IStrictUrl extends url.Url { |
| 21 | pathname: string; |
| 22 | href: string; |
| 23 | } |
| 24 | |
| 25 | export class ScriptImporter { |
| 26 | public static DEBUGGER_WORKER_FILE_BASENAME = "debuggerWorker"; |
| 27 | public static DEBUGGER_WORKER_FILENAME = ScriptImporter.DEBUGGER_WORKER_FILE_BASENAME + ".js"; |
| 28 | private packagerAddress: string; |
| 29 | private packagerPort: number; |
| 30 | private sourcesStoragePath: string; |
| 31 | private packagerRemoteRoot?: string; |
| 32 | private packagerLocalRoot?: string; |
| 33 | private sourceMapUtil: SourceMapUtil; |
| 34 | |
| 35 | constructor(packagerAddress: string, packagerPort: number, sourcesStoragePath: string, packagerRemoteRoot?: string, packagerLocalRoot?: string) { |
| 36 | this.packagerAddress = packagerAddress; |
| 37 | this.packagerPort = packagerPort; |
| 38 | this.sourcesStoragePath = sourcesStoragePath; |
| 39 | this.packagerRemoteRoot = packagerRemoteRoot; |
| 40 | this.packagerLocalRoot = packagerLocalRoot; |
| 41 | this.sourceMapUtil = new SourceMapUtil(); |
| 42 | } |
| 43 | |
| 44 | public downloadAppScript(scriptUrlString: string): Q.Promise<DownloadedScript> { |
| 45 | const parsedScriptUrl = url.parse(scriptUrlString); |
| 46 | const overriddenScriptUrlString = (parsedScriptUrl.hostname === "localhost") ? this.overridePackagerPort(scriptUrlString) : scriptUrlString; |
| 47 | // We'll get the source code, and store it locally to have a better debugging experience |
| 48 | return Request.request(overriddenScriptUrlString, true).then(scriptBody => { |
| 49 | // Extract sourceMappingURL from body |
| 50 | let scriptUrl = <IStrictUrl>url.parse(overriddenScriptUrlString); // scriptUrl = "http://localhost:8081/index.ios.bundle?platform=ios&dev=true" |
| 51 | let sourceMappingUrl = this.sourceMapUtil.getSourceMapURL(scriptUrl, scriptBody); // sourceMappingUrl = "http://localhost:8081/index.ios.map?platform=ios&dev=true" |
| 52 | |
| 53 | let waitForSourceMapping = Q<void>(void 0); |
| 54 | if (sourceMappingUrl) { |
| 55 | /* handle source map - request it and store it locally */ |
| 56 | waitForSourceMapping = this.writeAppSourceMap(sourceMappingUrl, scriptUrl) |
| 57 | .then(() => { |
| 58 | scriptBody = this.sourceMapUtil.updateScriptPaths(scriptBody, <IStrictUrl>sourceMappingUrl); |
| 59 | }); |
| 60 | } |
| 61 | |
| 62 | return waitForSourceMapping |
| 63 | .then(() => this.writeAppScript(scriptBody, scriptUrl)) |
| 64 | .then((scriptFilePath: string) => { |
| 65 | logger.verbose(`Script ${overriddenScriptUrlString} downloaded to ${scriptFilePath}`); |
| 66 | return { contents: scriptBody, filepath: scriptFilePath }; |
| 67 | }); |
| 68 | }); |
| 69 | } |
| 70 | |
| 71 | public downloadDebuggerWorker(sourcesStoragePath: string, projectRootPath: string): Q.Promise<void> { |
| 72 | const errPackagerNotRunning = new RangeError(`Cannot attach to packager. Are you sure there is a packager and it is running in the port ${this.packagerPort}? If your packager is configured to run in another port make sure to add that to the setting.json.`); |
| 73 | |
| 74 | return ensurePackagerRunning(this.packagerAddress, this.packagerPort, errPackagerNotRunning) |
| 75 | .then(() => { |
| 76 | return ReactNativeProjectHelper.getReactNativeVersion(projectRootPath); |
| 77 | }) |
| 78 | .then((rnVersion: string) => { |
| 79 | let newPackager = ""; |
| 80 | const isHaulProject = ReactNativeProjectHelper.isHaulProject(projectRootPath); |
| 81 | if (semver.gte(rnVersion, "0.50.0") && !isHaulProject) { |
| 82 | newPackager = "debugger-ui/"; |
| 83 | } |
| 84 | let debuggerWorkerURL = `http://${this.packagerAddress}:${this.packagerPort}/${newPackager}${ScriptImporter.DEBUGGER_WORKER_FILENAME}`; |
| 85 | let debuggerWorkerLocalPath = path.join(sourcesStoragePath, ScriptImporter.DEBUGGER_WORKER_FILENAME); |
| 86 | logger.verbose("About to download: " + debuggerWorkerURL + " to: " + debuggerWorkerLocalPath); |
| 87 | |
| 88 | return Request.request(debuggerWorkerURL, true) |
| 89 | .then((body: string) => { |
| 90 | return new FileSystem().writeFile(debuggerWorkerLocalPath, body); |
| 91 | }); |
| 92 | }); |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Writes the script file to the project temporary location. |
| 97 | */ |
| 98 | private writeAppScript(scriptBody: string, scriptUrl: IStrictUrl): Q.Promise<String> { |
| 99 | let scriptFilePath = path.join(this.sourcesStoragePath, path.basename(scriptUrl.pathname)); // scriptFilePath = "$TMPDIR/index.ios.bundle" |
| 100 | return new FileSystem().writeFile(scriptFilePath, scriptBody) |
| 101 | .then(() => scriptFilePath); |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Writes the source map file to the project temporary location. |
| 106 | */ |
| 107 | private writeAppSourceMap(sourceMapUrl: IStrictUrl, scriptUrl: IStrictUrl): Q.Promise<void> { |
| 108 | return Request.request(sourceMapUrl.href, true) |
| 109 | .then((sourceMapBody: string) => { |
| 110 | let sourceMappingLocalPath = path.join(this.sourcesStoragePath, path.basename(sourceMapUrl.pathname)); // sourceMappingLocalPath = "$TMPDIR/index.ios.map" |
| 111 | let scriptFileRelativePath = path.basename(scriptUrl.pathname); // scriptFileRelativePath = "index.ios.bundle" |
| 112 | let updatedContent = this.sourceMapUtil.updateSourceMapFile(sourceMapBody, scriptFileRelativePath, this.sourcesStoragePath, this.packagerRemoteRoot, this.packagerLocalRoot); |
| 113 | return new FileSystem().writeFile(sourceMappingLocalPath, updatedContent); |
| 114 | }); |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Changes the port of the url to be the one configured as this.packagerPort |
| 119 | */ |
| 120 | private overridePackagerPort(urlToOverride: string): string { |
| 121 | let components = url.parse(urlToOverride); |
| 122 | components.port = this.packagerPort.toString(); |
| 123 | delete components.host; // We delete the host, if not the port change will be ignored |
| 124 | return url.format(components); |
| 125 | } |
| 126 | } |
| 127 | |