X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=src%2Findex.js;h=be809c685ac5959cc011388259cea1026578102c;hb=c69d78d9010e224f1a31b1acfa24db346d535cb6;hp=0a25ccdbced715eaa79c03407969bddb50de84cf;hpb=7de41f10b4ff0f0d6b45d59bee0f166c3cfe3f9f;p=github%2Ffretlink%2Fpurs-loader.git diff --git a/src/index.js b/src/index.js index 0a25ccd..be809c6 100644 --- a/src/index.js +++ b/src/index.js @@ -1,465 +1,405 @@ 'use strict' -const colors = require('chalk') -const debug = require('debug')('purs-loader') -const loaderUtils = require('loader-utils') -const globby = require('globby') -const Promise = require('bluebird') -const fs = Promise.promisifyAll(require('fs')) -const spawn = require('child_process').spawn -const path = require('path') -const retryPromise = require('promise-retry') +const debug_ = require('debug'); -const psModuleRegex = /(?:^|\n)module\s+([\w\.]+)/i -const requireRegex = /require\(['"]\.\.\/([\w\.]+)['"]\)/g +const debug = debug_('purs-loader'); -module.exports = function purescriptLoader(source, map) { - const callback = this.async() - const config = this.options - const query = loaderUtils.parseQuery(this.query) - const webpackOptions = this.options.purescriptLoader || {} +const debugVerbose = debug_('purs-loader:verbose'); - const options = Object.assign({ - context: config.context, - psc: 'psc', - pscArgs: {}, - pscBundle: 'psc-bundle', - pscBundleArgs: {}, - pscIdeColors: webpackOptions.psc === 'psa' || query.psc === 'psa', - pscIdeArgs: {}, - bundleOutput: 'output/bundle.js', - bundleNamespace: 'PS', - bundle: false, - warnings: true, - output: 'output', - src: [ - path.join('src', '**', '*.purs'), - path.join('bower_components', 'purescript-*', 'src', '**', '*.purs') - ], - ffi: [ - path.join('src', '**', '*.js'), - path.join('bower_components', 'purescript-*', 'src', '**', '*.js') - ], - }, webpackOptions, query) - - this.cacheable && this.cacheable() - - let cache = config.purescriptLoaderCache = config.purescriptLoaderCache || { - rebuild: false, - deferred: [], - bundleModules: [], - } +const loaderUtils = require('loader-utils') - if (!config.purescriptLoaderInstalled) { - config.purescriptLoaderInstalled = true +const Promise = require('bluebird') - // invalidate loader cache when bundle is marked as invalid (in watch mode) - this._compiler.plugin('invalid', () => { - cache = config.purescriptLoaderCache = { - rebuild: true, - deferred: [], - ideServer: cache.ideServer - } - }) +const path = require('path') - // add psc warnings to webpack compilation warnings - this._compiler.plugin('after-compile', (compilation, callback) => { - if (options.warnings && cache.warnings && cache.warnings.length) { - compilation.warnings.unshift(`PureScript compilation:\n${cache.warnings.join('')}`) - } +const PsModuleMap = require('./purs-module-map'); - if (cache.errors && cache.errors.length) { - compilation.errors.unshift(`PureScript compilation:\n${cache.errors.join('\n')}`) - } +const compile = require('./compile'); - callback() - }) - } +const bundle = require('./bundle'); - const psModuleName = match(psModuleRegex, source) - const psModule = { - name: psModuleName, - load: js => callback(null, js), - reject: error => callback(error), - srcPath: this.resourcePath, - srcDir: path.dirname(this.resourcePath), - jsPath: path.resolve(path.join(options.output, psModuleName, 'index.js')), - options: options, - cache: cache, - } +const ide = require('./ide'); - if (options.bundle) { - cache.bundleModules.push(psModule.name) - } +const toJavaScript = require('./to-javascript'); - if (cache.rebuild) { - return connectIdeServer(psModule) - .then(rebuild) - .then(toJavaScript) - .then(psModule.load) - .catch(psModule.reject) - } +const sourceMaps = require('./source-maps'); - if (cache.compilation && cache.compilation.length) { - return toJavaScript(psModule).then(psModule.load).catch(psModule.reject) - } +const dargs = require('./dargs'); - // We need to wait for compilation to finish before the loaders run so that - // references to compiled output are valid. - cache.deferred.push(psModule) +const utils = require('./utils'); - if (!cache.compilation) { - return compile(psModule) - .then(() => Promise.map(cache.deferred, psModule => { - if (typeof cache.ideServer === 'object') cache.ideServer.kill() - return toJavaScript(psModule).then(psModule.load) - })) - .catch(error => { - cache.deferred[0].reject(error) - cache.deferred.slice(1).forEach(psModule => psModule.reject(true)) - }) - } -} +const spawn = require('cross-spawn').sync -// The actual loader is executed *after* purescript compilation. -function toJavaScript(psModule) { - const options = psModule.options - const cache = psModule.cache - const bundlePath = path.resolve(options.bundleOutput) - const jsPath = cache.bundle ? bundlePath : psModule.jsPath - - debug('loading JavaScript for', psModule.srcPath) - - return Promise.props({ - js: fs.readFileAsync(jsPath, 'utf8'), - psModuleMap: psModuleMap(options.src, cache) - }).then(result => { - let js = '' - - if (options.bundle) { - // if bundling, return a reference to the bundle - js = 'module.exports = require("' - + path.relative(psModule.srcDir, options.bundleOutput) - + '")["' + psModule.name + '"]' - } else { - // replace require paths to output files generated by psc with paths - // to purescript sources, which are then also run through this loader. - const foreignRequire = 'require("' + path.resolve( - path.join(psModule.options.output, psModule.name, 'foreign.js') - ) + '")' - - js = result.js - .replace(requireRegex, (m, p1) => { - return 'require("' + result.psModuleMap[p1] + '")' - }) - .replace(/require\(['"]\.\/foreign['"]\)/g, foreignRequire) - } +const eol = require('os').EOL - return js - }) -} - -function compile(psModule) { - const options = psModule.options - const cache = psModule.cache - const stderr = [] - - if (cache.compilation) return Promise.resolve(cache.compilation) - - cache.compilation = [] - cache.warnings = [] - cache.errors = [] +var CACHE_VAR = { + rebuild: false, + deferred: [], + bundleModules: [], + ideServer: null, + psModuleMap: null, + warnings: [], + errors: [], + compilationStarted: false, + compilationFinished: false, + compilationFailed: false, + installed: false, + srcOption: [] +}; +module.exports = function purescriptLoader(source, map) { + this.cacheable && this.cacheable(); - const args = dargs(Object.assign({ - _: options.src, - ffi: options.ffi, - output: options.output, - }, options.pscArgs)) + const webpackContext = (this.options && this.options.context) || this.rootContext; - debug('spawning compiler %s %o', options.psc, args) + const callback = this.async(); - return (new Promise((resolve, reject) => { - console.log('\nCompiling PureScript...') + const loaderOptions = loaderUtils.getOptions(this) || {}; - const compilation = spawn(options.psc, args) + const srcOption = (pscPackage => { + const srcPath = path.join('src', '**', '*.purs'); - compilation.stderr.on('data', data => stderr.push(data.toString())) + const bowerPath = path.join('bower_components', 'purescript-*', 'src', '**', '*.purs'); - compilation.on('close', code => { - console.log('Finished compiling PureScript.') - if (code !== 0) { - cache.compilation = cache.errors = stderr - reject(true) - } else { - cache.compilation = cache.warnings = stderr - resolve(psModule) - } - }) - })) - .then(compilerOutput => { - if (options.bundle) { - return bundle(options, cache).then(() => psModule) + if (CACHE_VAR.srcOption.length > 0) { + return CACHE_VAR.srcOption; } - return psModule - }) -} + else if (pscPackage) { + const pscPackageCommand = 'psc-package'; -function rebuild(psModule) { - const options = psModule.options - const cache = psModule.cache + const pscPackageArgs = ['sources']; - debug('attempting rebuild with psc-ide-client %s', psModule.srcPath) + const loaderSrc = loaderOptions.src || [ + srcPath + ]; - const request = (body) => new Promise((resolve, reject) => { - const args = dargs(options.pscIdeArgs) - const ideClient = spawn('psc-ide-client', args) + debug('psc-package %s %o', pscPackageCommand, pscPackageArgs); - ideClient.stdout.once('data', data => { - const res = JSON.parse(data.toString()) - debug(res) + const cmd = spawn(pscPackageCommand, pscPackageArgs); - if (!Array.isArray(res.result)) { - return res.resultType === 'success' - ? resolve(psModule) - : reject(res.result) + if (cmd.error) { + throw new Error(cmd.error); } + else if (cmd.status !== 0) { + const error = cmd.stdout.toString(); - Promise.map(res.result, (item, i) => { - debug(item) - return formatIdeResult(item, options, i, res.result.length) - }) - .then(compileMessages => { - if (res.resultType === 'error') { - cache.errors = compileMessages - reject(res.result) - } else { - cache.warnings = compileMessages - resolve(psModule) - } - }) - }) + throw new Error(error); + } + else { + const result = cmd.stdout.toString().split(eol).filter(v => v != '').concat(loaderSrc); - ideClient.stderr.once('data', data => reject(data.toString())) + debug('psc-package result: %o', result); - ideClient.stdin.write(JSON.stringify(body)) - ideClient.stdin.write('\n') - }) + CACHE_VAR.srcOption = result; - return request({ - command: 'rebuild', - params: { - file: psModule.srcPath, - } - }).catch(res => { - if (res.resultType === 'error') { - if (res.result.some(item => item.errorCode === 'UnknownModule')) { - console.log('Unknown module, attempting full recompile') - return compile(psModule).then(() => request({ command: 'load' })) + return result; } } - return Promise.resolve(psModule) - }) -} + else { + const result = loaderOptions.src || [ + bowerPath, + srcPath + ]; -function formatIdeResult(result, options, index, length) { - const srcPath = path.relative(options.context, result.filename) - const pos = result.position - const fileAndPos = `${srcPath}:${pos.startLine}:${pos.startColumn}` - let numAndErr = `[${index+1}/${length} ${result.errorCode}]` - numAndErr = options.pscIdeColors ? colors.yellow(numAndErr) : numAndErr - - return fs.readFileAsync(result.filename, 'utf8').then(source => { - const lines = source.split('\n').slice(pos.startLine - 1, pos.endLine) - const endsOnNewline = pos.endColumn === 1 && pos.startLine !== pos.endLine - const up = options.pscIdeColors ? colors.red('^') : '^' - const down = options.pscIdeColors ? colors.red('v') : 'v' - let trimmed = lines.slice(0) - - if (endsOnNewline) { - lines.splice(lines.length - 1, 1) - pos.endLine = pos.endLine - 1 - pos.endColumn = lines[lines.length - 1].length || 1 - } + CACHE_VAR.srcOption = result; - // strip newlines at the end - if (endsOnNewline) { - trimmed = lines.reverse().reduce((trimmed, line, i) => { - if (i === 0 && line === '') trimmed.trimming = true - if (!trimmed.trimming) trimmed.push(line) - if (trimmed.trimming && line !== '') { - trimmed.trimming = false - trimmed.push(line) - } - return trimmed - }, []).reverse() - pos.endLine = pos.endLine - (lines.length - trimmed.length) - pos.endColumn = trimmed[trimmed.length - 1].length || 1 + return result; } + })(loaderOptions.pscPackage); - const spaces = ' '.repeat(String(pos.endLine).length) - let snippet = trimmed.map((line, i) => { - return ` ${pos.startLine + i} ${line}` - }).join('\n') - - if (trimmed.length === 1) { - snippet += `\n ${spaces} ${' '.repeat(pos.startColumn - 1)}${up.repeat(pos.endColumn - pos.startColumn + 1)}` - } else { - snippet = ` ${spaces} ${' '.repeat(pos.startColumn - 1)}${down}\n${snippet}` - snippet += `\n ${spaces} ${' '.repeat(pos.endColumn - 1)}${up}` - } + const options = Object.assign({ + context: webpackContext, + psc: null, + pscArgs: {}, + pscBundle: null, + pscBundleArgs: {}, + pscIdeClient: null, + pscIdeClientArgs: {}, + pscIdeServer: null, + pscIdeServerArgs: {}, + pscIde: false, + pscIdeColors: loaderOptions.psc === 'psa', + pscPackage: false, + bundleOutput: 'output/bundle.js', + bundleNamespace: 'PS', + bundle: false, + warnings: true, + watch: false, + output: 'output', + src: [] + }, loaderOptions, { + src: srcOption + }); - return Promise.resolve( - `\n${numAndErr} ${fileAndPos}\n\n${snippet}\n\n${result.message}` - ) - }) -} + if (!CACHE_VAR.installed) { + debugVerbose('installing purs-loader with options: %O', options); -function bundle(options, cache) { - if (cache.bundle) return Promise.resolve(cache.bundle) + CACHE_VAR.installed = true; - const stdout = [] - const stderr = cache.bundle = [] + // invalidate loader CACHE_VAR when bundle is marked as invalid (in watch mode) + this._compiler.plugin('invalid', () => { + debugVerbose('invalidating loader CACHE_VAR'); - const args = dargs(Object.assign({ - _: [path.join(options.output, '*', '*.js')], - output: options.bundleOutput, - namespace: options.bundleNamespace, - }, options.pscBundleArgs)) + CACHE_VAR = { + rebuild: options.pscIde, + deferred: [], + bundleModules: [], + ideServer: CACHE_VAR.ideServer, + psModuleMap: CACHE_VAR.psModuleMap, + warnings: [], + errors: [], + compilationStarted: false, + compilationFinished: false, + compilationFailed: false, + installed: CACHE_VAR.installed, + srcOption: [] + }; + }); - cache.bundleModules.forEach(name => args.push('--module', name)) + // add psc warnings to webpack compilation warnings + this._compiler.plugin('after-compile', (compilation, callback) => { + CACHE_VAR.warnings.forEach(warning => { + compilation.warnings.push(warning); + }); - debug('spawning bundler %s %o', options.pscBundle, args.join(' ')) + CACHE_VAR.errors.forEach(error => { + compilation.errors.push(error); + }); - return (new Promise((resolve, reject) => { - console.log('Bundling PureScript...') + callback() + }); + } - const compilation = spawn(options.pscBundle, args) + const psModuleName = PsModuleMap.matchModule(source); - compilation.stdout.on('data', data => stdout.push(data.toString())) - compilation.stderr.on('data', data => stderr.push(data.toString())) - compilation.on('close', code => { - if (code !== 0) { - cache.errors.concat(stderr) - return reject(true) + const psModule = { + name: psModuleName, + source: source, + load: ({js, map}) => callback(null, js, map), + reject: error => callback(error), + srcPath: this.resourcePath, + remainingRequest: loaderUtils.getRemainingRequest(this), + srcDir: path.dirname(this.resourcePath), + jsPath: path.resolve(path.join(options.output, psModuleName, 'index.js')), + options: options, + cache: CACHE_VAR, + emitWarning: warning => { + if (options.warnings && warning.length) { + CACHE_VAR.warnings.push(warning); } - cache.bundle = stderr - resolve(fs.appendFileAsync('output/bundle.js', `module.exports = ${options.bundleNamespace}`)) - }) - })) -} - -// map of PS module names to their source path -function psModuleMap(globs, cache) { - if (cache.psModuleMap) return Promise.resolve(cache.psModuleMap) - - return globby(globs).then(paths => { - return Promise - .props(paths.reduce((map, file) => { - map[file] = fs.readFileAsync(file, 'utf8') - return map - }, {})) - .then(srcMap => { - cache.psModuleMap = Object.keys(srcMap).reduce((map, file) => { - const source = srcMap[file] - const psModuleName = match(psModuleRegex, source) - map[psModuleName] = path.resolve(file) - return map - }, {}) - return cache.psModuleMap - }) - }) -} - -function connectIdeServer(psModule) { - const options = psModule.options - const cache = psModule.cache - - if (cache.ideServer) return Promise.resolve(psModule) + }, + emitError: pscMessage => { + if (pscMessage.length) { + const modules = []; + + const matchErrorsSeparator = /\n(?=Error)/; + const errors = pscMessage.split(matchErrorsSeparator); + for (const error of errors) { + const matchErrLocation = /at (.+\.purs):(\d+):(\d+) - (\d+):(\d+) \(line \2, column \3 - line \4, column \5\)/; + const [, filename] = matchErrLocation.exec(error) || []; + if (!filename) continue; + + const baseModulePath = path.join(this.rootContext, filename); + this.addDependency(baseModulePath); + + const foreignModulesErrorCodes = [ + 'ErrorParsingFFIModule', + 'MissingFFIImplementations', + 'UnusedFFIImplementations', + 'MissingFFIModule' + ]; + for (const code of foreignModulesErrorCodes) { + if (error.includes(code)) { + const resolved = utils.resolveForeignModule(baseModulePath); + this.addDependency(resolved); + } + } + + const matchErrModuleName = /in module ((?:\w+\.)*\w+)/; + const [, baseModuleName] = matchErrModuleName.exec(error) || []; + if (!baseModuleName) continue; + + const matchMissingModuleName = /Module ((?:\w+\.)*\w+) was not found/; + const matchMissingImportFromModuleName = /Cannot import value \w+ from module ((?:\w+\.)*\w+)/; + for (const re of [matchMissingModuleName, matchMissingImportFromModuleName]) { + const [, targetModuleName] = re.exec(error) || []; + if (targetModuleName) { + const resolved = utils.resolvePursModule({ + baseModulePath, + baseModuleName, + targetModuleName + }); + this.addDependency(resolved); + } + } + + const desc = { + name: baseModuleName, + filename: baseModulePath + }; + + if (typeof this.describePscError === 'function') { + const { dependencies = [], details } = this.describePscError(error, desc); + + for (const dep of dependencies) { + this.addDependency(dep); + } + + Object.assign(desc, details); + } + + modules.push(desc); + } - cache.ideServer = true + CACHE_VAR.errors.push(new utils.PscError(pscMessage, modules)); + } + } + } - const connect = () => new Promise((resolve, reject) => { - const args = dargs(options.pscIdeArgs) + debug('loading %s', psModule.name); - debug('attempting to connect to psc-ide-server', args) + if (options.bundle) { + CACHE_VAR.bundleModules.push(psModule.name); + } - const ideClient = spawn('psc-ide-client', args) + if (CACHE_VAR.rebuild) { + const connect = () => { + if (!CACHE_VAR.ideServer) { + CACHE_VAR.ideServer = true; + + return ide.connect(psModule) + .then(ideServer => { + CACHE_VAR.ideServer = ideServer; + return psModule; + }) + .then(ide.loadWithRetry) + .catch(error => { + if (CACHE_VAR.ideServer.kill) { + debug('ide failed to initially load modules, stopping the ide server process'); + + CACHE_VAR.ideServer.kill(); + } + + CACHE_VAR.ideServer = null; + + return Promise.reject(error); + }) + ; + } + else { + return Promise.resolve(psModule); + } + }; + + const rebuild = () => + ide.rebuild(psModule) + .then(() => + toJavaScript(psModule) + .then(js => sourceMaps(psModule, js)) + .then(psModule.load) + .catch(psModule.reject) + ) + .catch(error => { + if (error instanceof ide.UnknownModuleError) { + // Store the modules that trigger a recompile due to an + // unknown module error. We need to wait until compilation is + // done before loading these files. + + CACHE_VAR.deferred.push(psModule); + + if (!CACHE_VAR.compilationStarted) { + CACHE_VAR.compilationStarted = true; + + return compile(psModule) + .then(() => { + CACHE_VAR.compilationFinished = true; + }) + .then(() => + Promise.map(CACHE_VAR.deferred, psModule => + ide.load(psModule) + .then(() => toJavaScript(psModule)) + .then(js => sourceMaps(psModule, js)) + .then(psModule.load) + ) + ) + .catch(error => { + CACHE_VAR.compilationFailed = true; + + CACHE_VAR.deferred[0].reject(error); + + CACHE_VAR.deferred.slice(1).forEach(psModule => { + psModule.reject(new Error('purs-loader failed')); + }) + }) + ; + } else if (CACHE_VAR.compilationFailed) { + CACHE_VAR.deferred.pop().reject(new Error('purs-loader failed')); + } else { + // The compilation has started. We must wait until it is + // done in order to ensure the module map contains all of + // the unknown modules. + } + } + else { + debug('ide rebuild failed due to an unhandled error: %o', error); - ideClient.stderr.on('data', data => { - debug(data.toString()) - cache.ideServer = false - reject(true) - }) - ideClient.stdout.once('data', data => { - debug(data.toString()) - if (data.toString()[0] === '{') { - const res = JSON.parse(data.toString()) - if (res.resultType === 'success') { - cache.ideServer = ideServer - resolve(psModule) - } else { - cache.ideServer = ideServer - reject(true) + psModule.reject(error); } - } else { - cache.ideServer = false - reject(true) - } - }) - ideClient.stdin.resume() - ideClient.stdin.write(JSON.stringify({ command: 'load' })) - ideClient.stdin.write('\n') - }) - - const args = dargs(Object.assign({ - outputDirectory: options.output, - }, options.pscIdeArgs)) - - debug('attempting to start psc-ide-server', args) - - const ideServer = cache.ideServer = spawn('psc-ide-server', []) - ideServer.stderr.on('data', data => { - debug(data.toString()) - }) - - return retryPromise((retry, number) => { - return connect().catch(error => { - if (!cache.ideServer && number === 9) { - debug(error) - - console.log( - 'failed to connect to or start psc-ide-server, ' + - 'full compilation will occur on rebuild' - ) + }) + ; - return Promise.resolve(psModule) - } + connect().then(rebuild); + } + else if (CACHE_VAR.compilationFinished) { + debugVerbose('compilation is already finished, loading module %s', psModule.name); - return retry(error) - }) - }, { - retries: 9, - factor: 1, - minTimeout: 333, - maxTimeout: 333, - }) -} + toJavaScript(psModule) + .then(js => sourceMaps(psModule, js)) + .then(psModule.load) + .catch(psModule.reject); + } + else { + // The compilation has not finished yet. We need to wait for + // compilation to finish before the loaders run so that references + // to compiled output are valid. Push the modules into the CACHE_VAR to + // be loaded once the complation is complete. -function match(regex, str) { - const matches = str.match(regex) - return matches && matches[1] -} + CACHE_VAR.deferred.push(psModule); + + if (!CACHE_VAR.compilationStarted) { + CACHE_VAR.compilationStarted = true; -function dargs(obj) { - return Object.keys(obj).reduce((args, key) => { - const arg = '--' + key.replace(/[A-Z]/g, '-$&').toLowerCase(); - const val = obj[key] + compile(psModule) + .then(() => { + CACHE_VAR.compilationFinished = true; + }) + .then(() => { + if (options.bundle) { + return bundle(options, CACHE_VAR.bundleModules); + } + }) + .then(() => + Promise.map(CACHE_VAR.deferred, psModule => + toJavaScript(psModule) + .then(js => sourceMaps(psModule, js)) + .then(psModule.load) + ) + ) + .catch(error => { + CACHE_VAR.compilationFailed = true; - if (key === '_') val.forEach(v => args.push(v)) - else if (Array.isArray(val)) val.forEach(v => args.push(arg, v)) - else args.push(arg, obj[key]) + CACHE_VAR.deferred[0].reject(error); - return args - }, []) + CACHE_VAR.deferred.slice(1).forEach(psModule => { + psModule.reject(new Error('purs-loader failed')); + }) + }) + ; + } else if (CACHE_VAR.compilationFailed) { + CACHE_VAR.deferred.pop().reject(new Error('purs-loader failed')); + } else { + // The complation has started. Nothing to do but wait until it is + // done before loading all of the modules. + } + } }