]> git.immae.eu Git - github/fretlink/purs-loader.git/blobdiff - src/index.js
Watch foreign modules on compilation error
[github/fretlink/purs-loader.git] / src / index.js
index c73fdd5e88cc2c76f925abd85353d28b80f61d2a..be809c685ac5959cc011388259cea1026578102c 100644 (file)
 'use strict'
 
-const debug = require('debug')('purs-loader')
+const debug_ = require('debug');
+
+const debug = debug_('purs-loader');
+
+const debugVerbose = debug_('purs-loader:verbose');
+
 const loaderUtils = require('loader-utils')
+
 const Promise = require('bluebird')
-const fs = Promise.promisifyAll(require('fs'))
+
 const path = require('path')
-const jsStringEscape = require('js-string-escape')
-const PsModuleMap = require('./PsModuleMap');
-const Psc = require('./Psc');
-const PscIde = require('./PscIde');
+
+const PsModuleMap = require('./purs-module-map');
+
+const compile = require('./compile');
+
+const bundle = require('./bundle');
+
+const ide = require('./ide');
+
+const toJavaScript = require('./to-javascript');
+
+const sourceMaps = require('./source-maps');
+
 const dargs = require('./dargs');
 
-const requireRegex = /require\(['"]\.\.\/([\w\.]+)['"]\)/g
+const utils = require('./utils');
+
+const spawn = require('cross-spawn').sync
+
+const eol = require('os').EOL
+
+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) {
-  const callback = this.async()
-  const config = this.options
-  const query = loaderUtils.parseQuery(this.query)
-  const webpackOptions = this.options.purescriptLoader || {}
+  this.cacheable && this.cacheable();
+
+  const webpackContext = (this.options && this.options.context) || this.rootContext;
+
+  const callback = this.async();
+
+  const loaderOptions = loaderUtils.getOptions(this) || {};
+
+  const srcOption = (pscPackage => {
+    const srcPath = path.join('src', '**', '*.purs');
+
+    const bowerPath = path.join('bower_components', 'purescript-*', 'src', '**', '*.purs');
+
+    if (CACHE_VAR.srcOption.length > 0) {
+      return CACHE_VAR.srcOption;
+    }
+    else if (pscPackage) {
+      const pscPackageCommand = 'psc-package';
+
+      const pscPackageArgs = ['sources'];
+
+      const loaderSrc = loaderOptions.src || [
+        srcPath
+      ];
+
+      debug('psc-package %s %o', pscPackageCommand, pscPackageArgs);
+
+      const cmd = spawn(pscPackageCommand, pscPackageArgs);
+
+      if (cmd.error) {
+        throw new Error(cmd.error);
+      }
+      else if (cmd.status !== 0) {
+        const error = cmd.stdout.toString();
+
+        throw new Error(error);
+      }
+      else {
+        const result = cmd.stdout.toString().split(eol).filter(v => v != '').concat(loaderSrc);
+
+        debug('psc-package result: %o', result);
+
+        CACHE_VAR.srcOption = result;
+
+        return result;
+      }
+    }
+    else {
+      const result = loaderOptions.src || [
+        bowerPath,
+        srcPath
+      ];
+
+      CACHE_VAR.srcOption = result;
+
+      return result;
+    }
+  })(loaderOptions.pscPackage);
 
   const options = Object.assign({
-    context: config.context,
-    psc: 'psc',
+    context: webpackContext,
+    psc: null,
     pscArgs: {},
-    pscBundle: 'psc-bundle',
+    pscBundle: null,
     pscBundleArgs: {},
+    pscIdeClient: null,
+    pscIdeClientArgs: {},
+    pscIdeServer: null,
+    pscIdeServerArgs: {},
     pscIde: false,
-    pscIdeColors: webpackOptions.psc === 'psa' || query.psc === 'psa',
-    pscIdeArgs: {},
+    pscIdeColors: loaderOptions.psc === 'psa',
+    pscPackage: false,
     bundleOutput: 'output/bundle.js',
     bundleNamespace: 'PS',
     bundle: false,
     warnings: true,
+    watch: false,
     output: 'output',
-    src: [
-      path.join('src', '**', '*.purs'),
-      path.join('bower_components', 'purescript-*', 'src', '**', '*.purs')
-    ]
-  }, webpackOptions, query)
-
-  this.cacheable && this.cacheable()
-
-  let cache = config.purescriptLoaderCache = config.purescriptLoaderCache || {
-    rebuild: false,
-    deferred: [],
-    bundleModules: []
-  }
+    src: []
+  }, loaderOptions, {
+    src: srcOption
+  });
+
+  if (!CACHE_VAR.installed) {
+    debugVerbose('installing purs-loader with options: %O', options);
 
-  if (!config.purescriptLoaderInstalled) {
-    config.purescriptLoaderInstalled = true
+    CACHE_VAR.installed = true;
 
-    // invalidate loader cache when bundle is marked as invalid (in watch mode)
+    // invalidate loader CACHE_VAR when bundle is marked as invalid (in watch mode)
     this._compiler.plugin('invalid', () => {
-      debug('invalidating loader cache');
+      debugVerbose('invalidating loader CACHE_VAR');
 
-      cache = config.purescriptLoaderCache = {
+      CACHE_VAR = {
         rebuild: options.pscIde,
         deferred: [],
         bundleModules: [],
-        ideServer: cache.ideServer,
-        psModuleMap: cache.psModuleMap
-      }
-    })
+        ideServer: CACHE_VAR.ideServer,
+        psModuleMap: CACHE_VAR.psModuleMap,
+        warnings: [],
+        errors: [],
+        compilationStarted: false,
+        compilationFinished: false,
+        compilationFailed: false,
+        installed: CACHE_VAR.installed,
+        srcOption: []
+      };
+    });
 
     // add psc warnings to webpack compilation warnings
     this._compiler.plugin('after-compile', (compilation, callback) => {
-      if (options.warnings && cache.warnings) {
-        compilation.warnings.unshift(`PureScript compilation:\n${cache.warnings}`)
-        cache.warnings = null;
-      }
+      CACHE_VAR.warnings.forEach(warning => {
+        compilation.warnings.push(warning);
+      });
 
-      if (cache.errors) {
-        compilation.errors.unshift(`PureScript compilation:\n${cache.errors}`)
-        cache.errors = null;
-      }
+      CACHE_VAR.errors.forEach(error => {
+        compilation.errors.push(error);
+      });
 
       callback()
-    })
+    });
   }
 
-  const psModuleName = PsModuleMap.match(source)
+  const psModuleName = PsModuleMap.matchModule(source);
+
   const psModule = {
     name: psModuleName,
-    load: js => callback(null, js),
+    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,
+    cache: CACHE_VAR,
+    emitWarning: warning => {
+      if (options.warnings && warning.length) {
+        CACHE_VAR.warnings.push(warning);
+      }
+    },
+    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_VAR.errors.push(new utils.PscError(pscMessage, modules));
+      }
+    }
   }
 
-  debug('loader called', psModule.name)
+  debug('loading %s', psModule.name);
 
   if (options.bundle) {
-    cache.bundleModules.push(psModule.name)
+    CACHE_VAR.bundleModules.push(psModule.name);
   }
 
-  if (cache.rebuild) {
-    return PscIde.connect(psModule)
-      .then(PscIde.rebuild)
-      .then(toJavaScript)
-      .then(psModule.load)
-      .catch(psModule.reject)
-  }
+  if (CACHE_VAR.rebuild) {
+    const connect = () => {
+      if (!CACHE_VAR.ideServer) {
+        CACHE_VAR.ideServer = true;
 
-  if (cache.compilationFinished) {
-    return toJavaScript(psModule).then(psModule.load).catch(psModule.reject)
-  }
+        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);
+      }
+    };
 
-  // We need to wait for compilation to finish before the loaders run so that
-  // references to compiled output are valid.
-  cache.deferred.push(psModule)
-
-  if (!cache.compilationStarted) {
-    return Psc.compile(psModule)
-       .then(() => PsModuleMap.makeMap(options.src).then(map => {
-         debug('rebuilt module map');
-         cache.psModuleMap = map;
-       }))
-      .then(() => Promise.map(cache.deferred, psModule => {
-        if (typeof cache.ideServer === 'object') cache.ideServer.kill()
-        return toJavaScript(psModule).then(psModule.load)
-      }))
+    const rebuild = () =>
+      ide.rebuild(psModule)
+      .then(() =>
+        toJavaScript(psModule)
+          .then(js => sourceMaps(psModule, js))
+          .then(psModule.load)
+          .catch(psModule.reject)
+      )
       .catch(error => {
-        cache.deferred[0].reject(error)
-        cache.deferred.slice(1).forEach(psModule => psModule.reject(true))
+        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);
+
+          psModule.reject(error);
+        }
       })
+    ;
+
+    connect().then(rebuild);
   }
-}
+  else if (CACHE_VAR.compilationFinished) {
+    debugVerbose('compilation is already finished, loading module %s', psModule.name);
 
-function updatePsModuleMap(psModule) {
-  const options = psModule.options
-  const cache = psModule.cache
-  const filePurs = psModule.srcPath
-  if (!cache.psModuleMap) {
-    debug('module mapping does not exist');
-    return PsModuleMap.makeMap(options.src).then(map => {
-      cache.psModuleMap = map;
-      return cache.psModuleMap;
-    });
+    toJavaScript(psModule)
+      .then(js => sourceMaps(psModule, js))
+      .then(psModule.load)
+      .catch(psModule.reject);
   }
   else {
-    return PsModuleMap.makeMapEntry(filePurs).then(result => {
-      const map = Object.assign(cache.psModuleMap, result)
-      cache.psModuleMap = map;
-      return cache.psModuleMap;
-    });
-  }
-}
+    // 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.
 
-// 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.name)
-
-  return Promise.props({
-    js: fs.readFileAsync(jsPath, 'utf8'),
-    psModuleMap: updatePsModuleMap(psModule)
-  }).then(result => {
-    let js = ''
-
-    if (options.bundle) {
-      // if bundling, return a reference to the bundle
-      js = 'module.exports = require("'
-             + jsStringEscape(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.
-      js = result.js
-        .replace(requireRegex, (m, p1) => {
-          return 'require("' + jsStringEscape(result.psModuleMap[p1].src) + '")'
+    CACHE_VAR.deferred.push(psModule);
+
+    if (!CACHE_VAR.compilationStarted) {
+      CACHE_VAR.compilationStarted = true;
+
+      compile(psModule)
+        .then(() => {
+          CACHE_VAR.compilationFinished = true;
         })
-        .replace(/require\(['"]\.\/foreign['"]\)/g, (m, p1) => {
-          return 'require("' + jsStringEscape(result.psModuleMap[psModule.name].ffi) + '")'
+        .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;
 
-    return js
-  })
+          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 complation has started. Nothing to do but wait until it is
+      // done before loading all of the modules.
+    }
+  }
 }