Don’t pass package.json and options over IPC (#1304)

* Don’t pass package.json over IPC * Add backward compatibility getter for asset.package
parcel-bundler · May 6, 2018 · 2f7be14 · 2f7be14
1 parent 98a293f
commit 2f7be14
Show file tree

Hide file tree

Showing 30 changed files with 133 additions and 103 deletions.
diff --git a/src/Asset.js b/src/Asset.js
@@ -5,6 +5,8 @@ const objectHash = require('./utils/objectHash');
 const md5 = require('./utils/md5');
 const isURL = require('./utils/is-url');
 const config = require('./utils/config');
+const syncPromise = require('./utils/syncPromise');
+const logger = require('./Logger');
 
 let ASSET_ID = 1;
 
@@ -15,12 +17,11 @@ let ASSET_ID = 1;
  * for subclasses to implement.
  */
 class Asset {
-  constructor(name, pkg, options) {
+  constructor(name, options) {
     this.id = ASSET_ID++;
     this.name = name;
     this.basename = path.basename(this.name);
     this.relativeName = path.relative(options.rootDir, this.name);
-    this.package = pkg || {};
     this.options = options;
     this.encoding = 'utf8';
     this.type = path.extname(this.name).slice(1);
@@ -98,13 +99,35 @@ class Asset {
     );
 
     parsed.pathname = this.options.parser
-      .getAsset(resolved, this.package, this.options)
+      .getAsset(resolved, this.options)
       .generateBundleName();
 
     return URL.format(parsed);
   }
 
+  get package() {
+    logger.warn(
+      '`asset.package` is deprecated. Please use `await asset.getPackage()` instead.'
+    );
+    return syncPromise(this.getPackage());
+  }
+
+  async getPackage() {
+    if (!this._package) {
+      this._package = await this.getConfig(['package.json']);
+    }
+
+    return this._package;
+  }
+
   async getConfig(filenames, opts = {}) {
+    if (opts.packageKey) {
+      let pkg = await this.getPackage();
+      if (pkg && pkg[opts.packageKey]) {
+        return pkg[opts.packageKey];
+      }
+    }
+
     // Resolve the config file
     let conf = await config.resolve(opts.path || this.name, filenames);
     if (conf) {

diff --git a/src/Bundler.js b/src/Bundler.js
@@ -357,12 +357,16 @@ class Bundler extends EventEmitter {
   }
 
   async resolveAsset(name, parent) {
-    let {path, pkg} = await this.resolver.resolve(name, parent);
+    let {path} = await this.resolver.resolve(name, parent);
+    return this.getLoadedAsset(path);
+  }
+
+  getLoadedAsset(path) {
     if (this.loadedAssets.has(path)) {
       return this.loadedAssets.get(path);
     }
 
-    let asset = this.parser.getAsset(path, pkg, this.options);
+    let asset = this.parser.getAsset(path, this.options);
     this.loadedAssets.set(path, asset);
 
     this.watch(path, asset);
@@ -490,7 +494,7 @@ class Bundler extends EventEmitter {
     let startTime = Date.now();
     let processed = this.cache && (await this.cache.read(asset.name));
     if (!processed || asset.shouldInvalidate(processed.cacheData)) {
-      processed = await this.farm.run(asset.name, asset.package, this.options);
+      processed = await this.farm.run(asset.name);
       if (this.cache) {
         this.cache.write(asset.name, processed);
       }

diff --git a/src/Parser.js b/src/Parser.js
@@ -75,10 +75,10 @@ class Parser {
     return parser;
   }
 
-  getAsset(filename, pkg, options = {}) {
+  getAsset(filename, options = {}) {
     let Asset = this.findParser(filename);
     options.parser = this;
-    return new Asset(filename, pkg, options);
+    return new Asset(filename, options);
   }
 }
 

diff --git a/src/Pipeline.js b/src/Pipeline.js
@@ -11,8 +11,13 @@ class Pipeline {
     this.parser = new Parser(options);
   }
 
-  async process(path, pkg, options) {
-    let asset = this.parser.getAsset(path, pkg, options);
+  async process(path, isWarmUp) {
+    let options = this.options;
+    if (isWarmUp) {
+      options = Object.assign({isWarmUp}, options);
+    }
+
+    let asset = this.parser.getAsset(path, options);
     let generated = await this.processAsset(asset);
     let generatedMap = {};
     for (let rendition of generated) {
@@ -51,7 +56,7 @@ class Pipeline {
       );
       if (!(asset instanceof AssetType)) {
         let opts = Object.assign({rendition}, asset.options);
-        let subAsset = new AssetType(asset.name, asset.package, opts);
+        let subAsset = new AssetType(asset.name, opts);
         subAsset.contents = value;
         subAsset.dependencies = asset.dependencies;
 

diff --git a/src/assets/CSSAsset.js b/src/assets/CSSAsset.js
@@ -9,8 +9,8 @@ const IMPORT_RE = /@import/;
 const PROTOCOL_RE = /^[a-z]+:/;
 
 class CSSAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'css';
   }
 

diff --git a/src/assets/CoffeeScriptAsset.js b/src/assets/CoffeeScriptAsset.js
@@ -2,8 +2,8 @@ const Asset = require('../Asset');
 const localRequire = require('../utils/localRequire');
 
 class CoffeeScriptAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
   }
 

diff --git a/src/assets/GLSLAsset.js b/src/assets/GLSLAsset.js
@@ -5,8 +5,8 @@ const promisify = require('../utils/promisify');
 const Resolver = require('../Resolver');
 
 class GLSLAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
   }
 

diff --git a/src/assets/GlobAsset.js b/src/assets/GlobAsset.js
@@ -4,8 +4,8 @@ const micromatch = require('micromatch');
 const path = require('path');
 
 class GlobAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = null; // allows this asset to be included in any type bundle
   }
 

diff --git a/src/assets/GraphqlAsset.js b/src/assets/GraphqlAsset.js
@@ -2,8 +2,8 @@ const Asset = require('../Asset');
 const localRequire = require('../utils/localRequire');
 
 class GraphqlAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
   }
 

diff --git a/src/assets/HTMLAsset.js b/src/assets/HTMLAsset.js
@@ -73,8 +73,8 @@ const OPTIONS = {
 };
 
 class HTMLAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'html';
     this.isAstDirty = false;
   }

diff --git a/src/assets/JSAsset.js b/src/assets/JSAsset.js
@@ -21,8 +21,8 @@ const SW_RE = /\bnavigator\s*\.\s*serviceWorker\s*\.\s*register\s*\(/;
 const WORKER_RE = /\bnew\s*Worker\s*\(/;
 
 class JSAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
     this.globals = new Map();
     this.isAstDirty = false;
@@ -106,8 +106,15 @@ class JSAsset extends Asset {
   async transform() {
     if (this.options.target === 'browser') {
       if (this.dependencies.has('fs') && FS_RE.test(this.contents)) {
-        await this.parseIfNeeded();
-        this.traverse(fsVisitor);
+        // Check if we should ignore fs calls
+        // See https://github.com/defunctzombie/node-browser-resolve#skip
+        let pkg = await this.getPackage();
+        let ignore = pkg && pkg.browser && pkg.browser.fs === false;
+
+        if (!ignore) {
+          await this.parseIfNeeded();
+          this.traverse(fsVisitor);
+        }
       }
 
       if (GLOBAL_RE.test(this.contents)) {

diff --git a/src/assets/JSONAsset.js b/src/assets/JSONAsset.js
@@ -4,8 +4,8 @@ const json5 = require('json5');
 const {minify} = require('uglify-es');
 
 class JSONAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
   }
 

diff --git a/src/assets/LESSAsset.js b/src/assets/LESSAsset.js
@@ -3,8 +3,8 @@ const localRequire = require('../utils/localRequire');
 const promisify = require('../utils/promisify');
 
 class LESSAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'css';
   }
 
@@ -13,10 +13,9 @@ class LESSAsset extends Asset {
     let less = await localRequire('less', this.name);
     let render = promisify(less.render.bind(less));
 
-    let opts = Object.assign(
-      {},
-      this.package.less || (await this.getConfig(['.lessrc', '.lessrc.js']))
-    );
+    let opts =
+      (await this.getConfig(['.lessrc', '.lessrc.js'], {packageKey: 'less'})) ||
+      {};
     opts.filename = this.name;
     opts.plugins = (opts.plugins || []).concat(urlPlugin(this));
 

diff --git a/src/assets/PugAsset.js b/src/assets/PugAsset.js
@@ -3,8 +3,8 @@ const Asset = require('../Asset');
 const localRequire = require('../utils/localRequire');
 
 class PugAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'html';
   }
 

diff --git a/src/assets/ReasonAsset.js b/src/assets/ReasonAsset.js
@@ -3,8 +3,8 @@ const fs = require('../utils/fs');
 const localRequire = require('../utils/localRequire');
 
 class ReasonAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
   }
 

diff --git a/src/assets/RustAsset.js b/src/assets/RustAsset.js
@@ -18,8 +18,8 @@ let rustInstalled = false;
 let wasmGCInstalled = false;
 
 class RustAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'wasm';
   }
 

diff --git a/src/assets/SASSAsset.js b/src/assets/SASSAsset.js
@@ -7,8 +7,8 @@ const Resolver = require('../Resolver');
 const syncPromise = require('../utils/syncPromise');
 
 class SASSAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'css';
   }
 
@@ -21,10 +21,9 @@ class SASSAsset extends Asset {
       rootDir: this.options.rootDir
     });
 
-    let opts = Object.assign(
-      {},
-      this.package.sass || (await this.getConfig(['.sassrc', '.sassrc.js']))
-    );
+    let opts =
+      (await this.getConfig(['.sassrc', '.sassrc.js'], {packageKey: 'sass'})) ||
+      {};
     opts.includePaths = (opts.includePaths || []).concat(
       path.dirname(this.name)
     );

diff --git a/src/assets/StylusAsset.js b/src/assets/StylusAsset.js
@@ -7,17 +7,17 @@ const syncPromise = require('../utils/syncPromise');
 const URL_RE = /^(?:url\s*\(\s*)?['"]?(?:[#/]|(?:https?:)?\/\/)/i;
 
 class StylusAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'css';
   }
 
   async parse(code) {
     // stylus should be installed locally in the module that's being required
     let stylus = await localRequire('stylus', this.name);
-    let opts =
-      this.package.stylus ||
-      (await this.getConfig(['.stylusrc', '.stylusrc.js']));
+    let opts = await this.getConfig(['.stylusrc', '.stylusrc.js'], {
+      packageKey: 'stylus'
+    });
     let style = stylus(code, opts);
     style.set('filename', this.name);
     style.set('include css', true);

diff --git a/src/assets/TOMLAsset.js b/src/assets/TOMLAsset.js
@@ -3,8 +3,8 @@ const toml = require('toml');
 const serializeObject = require('../utils/serializeObject');
 
 class TOMLAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
   }
 

diff --git a/src/assets/TypeScriptAsset.js b/src/assets/TypeScriptAsset.js
@@ -2,8 +2,8 @@ const Asset = require('../Asset');
 const localRequire = require('../utils/localRequire');
 
 class TypeScriptAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
   }
 

diff --git a/src/assets/VueAsset.js b/src/assets/VueAsset.js
@@ -4,8 +4,8 @@ const md5 = require('../utils/md5');
 const {minify} = require('uglify-es');
 
 class VueAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
   }
 

diff --git a/src/assets/WebManifestAsset.js b/src/assets/WebManifestAsset.js
@@ -1,8 +1,8 @@
 const Asset = require('../Asset');
 
 class WebManifestAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'webmanifest';
   }
 

diff --git a/src/assets/YAMLAsset.js b/src/assets/YAMLAsset.js
@@ -3,8 +3,8 @@ const yaml = require('js-yaml');
 const serializeObject = require('../utils/serializeObject');
 
 class YAMLAsset extends Asset {
-  constructor(name, pkg, options) {
-    super(name, pkg, options);
+  constructor(name, options) {
+    super(name, options);
     this.type = 'js';
   }