meteor-postcss icon indicating copy to clipboard operation
meteor-postcss copied to clipboard

Remove app-module-path-node dependency

Open martijnwalraven opened this issue 8 years ago • 33 comments

We tracked down an issue with the Todos app to the use of app-module-path-node in this package. Because app-module-path-node patches Node internals to modify module resolution, the Cordova code ends up with a faulty version of a package installed in the app's node_modules directory instead of the local one.

Modifying module resolution in this way could potentially break other parts of the build tool too, as it allows apps to override versions of packages we ship in the dev bundle.

Is there any way you can get rid of this dependency? I'm not sure what made you rely on this behavior, but we may be able to help you find a better way to accomplish this without globally modifying Node internals.

martijnwalraven avatar Apr 29 '16 01:04 martijnwalraven

This is a remnant of the old version based on meteorhacks:npm If I'll be able to read from /node_modules it shouldn't be a problem to remove it. And I think this is possible without this dependency. I'll try it asap. Thanks for the info.

juliancwirko avatar Apr 29 '16 05:04 juliancwirko

Great, thanks for looking into this!

martijnwalraven avatar Apr 29 '16 05:04 martijnwalraven

From minify-css.js plugin I try to get to the main node_modules in the app. So I try to do something like: path.resolve(process.cwd(), 'node_modules'); to be able to require PostCSS plugins installed in the app. And in the minify-css.js I want to do: Npm.require(appsNodeModulesPath + '/' + pluginName). It seems to be good path, but it stucked at:

While minifying app stylesheet:
   module.js:338:15: Cannot find module
   '/home/jul/workspace/meteor/postcss-demo/packages/meteor-postcss/.npm/plugin/minifier-postcss/node_modules/home/jul/workspace/meteor/postcss-demo/node_modules/postcss-safe-parser/'

So the path is not resolved as it should here in module.js :/ Also I wonder how will it behave when downloaded from Atmosphere.

Any ideas how to Npm.require from main node_modules in the package's minify-css.js plugin? :) Thanks.

juliancwirko avatar Apr 29 '16 05:04 juliancwirko

@tmeasday @benjamn: Do you know what the best way would be to require PostCSS plugins installed in the app?

martijnwalraven avatar Apr 29 '16 13:04 martijnwalraven

I've tried it in many different ways, I can only think of relative path to node_modules but then it will not work when bundled. I thought that it will be simpler :/ It appears that Node can't resolve this in its module.js.

And of course with app-module-path it is possible because it overwrites Module._nodeModulePaths, anyway this whole approach to PostCSS isn't a very good solution. It is rather a hacky way to achieve something which is really useful in the Front-end world, although underestimated ;)

Unfortunatelly for me it's hard to say what we could do with this problem.

juliancwirko avatar Apr 30 '16 07:04 juliancwirko

@juliancwirko can you provide instructions on how to reproduce what you are seeing (maybe push a branch and I'll play with it?)

tmeasday avatar May 02 '16 17:05 tmeasday

@tmeasday ok, so I've created a brach with changes. I've removed app-module-path dependency and here I need to resolve path to node_modules in the app, and it's ok. But when minifier runs there is a problem in module.js

Oh, and I require plugins like here and here

juliancwirko avatar May 02 '16 19:05 juliancwirko

@benjamn it seems that passing an absolute path into Npm.require or our require() doesn't work. I'm not sure if that's by design or otherwise, but it'd be an easy workaround for this problem if there was a way to do so.

One way would probably be to create an npm package that is simply a requirer:

// in the requirer npm package
module.exports.require = require;

// in the app / build plugin
require('requirer').require(absolutePath);

Why would that work (I think)? Because inside an npm package, require is just npm's default

tmeasday avatar May 02 '16 23:05 tmeasday

I've been scratching my head over non-informative Cordova build errors and through a ton of trial and error I've been able to isolate the errors to this package. Removing this package from my project results in reliable, successful builds on all platforms. For more information on the issues I ran into, please refer to this issue posted on the Meteor issue tracker.

If you need any additional information from my end, I am happy to oblige.

joncursi avatar May 14 '16 03:05 joncursi

I can confirm that npm install [email protected] seems to put a bandaid over this problem. Any updated guidance on how to handle this issue?

joncursi avatar May 14 '16 04:05 joncursi

Hmm, this seems to have dropped off the radar. Will surface it again.

tmeasday avatar May 17 '16 18:05 tmeasday

Thanks @tmeasday!

joncursi avatar May 17 '16 19:05 joncursi

See https://github.com/meteor/meteor/issues/7073

tmeasday avatar May 17 '16 22:05 tmeasday

@juliancwirko do you want to try using the new inputFile.require(id) API in the 1.3.3 beta: https://github.com/meteor/meteor/issues/7073#issuecomment-220744577 ?

Also, I think that there's a uglier way to do this that would work in older 1.3 versions too, is that correct @benjamn?

tmeasday avatar May 21 '16 05:05 tmeasday

@tmeasday that is awesome, I'll try it asap

juliancwirko avatar May 21 '16 09:05 juliancwirko

@tmeasday @benjamn I don't know if I understand it corectly but I would like to import some modules installed in the app without access to input css file. Is there documentation or usage example somewhere?

juliancwirko avatar May 21 '16 19:05 juliancwirko

@juliancwirko why do you not have access to an input css file?

tmeasday avatar May 21 '16 22:05 tmeasday

@tmeasday I probably misunderstood this. I'll try to explain. I'll use your reproduction repo.

So, You add aws-sdk here so it should be installed on the application level. Then you want to import it in the plugin (in the package) here. Here at the beginning of the file you aren't in the context of the input file. Am I right?

Could you rewrite your reproduction repo with these changes? Or maybe you will be able to explain it a a little bit? It would be very appreciated. Many thanks.

juliancwirko avatar May 21 '16 22:05 juliancwirko

I mean, sure it doesn't directly solve the problem as stated, but a build plugin doesn't need to import until it has some files to operate on, right?

tmeasday avatar May 21 '16 22:05 tmeasday

The reason it works like this is because a build plugin can also be set to operate on a package, so you can't just import the one time blindly.

tmeasday avatar May 21 '16 22:05 tmeasday

Ok, I think I understand it now. So I should require all plugins in the loop with every single css file. I probably could rewrite it that way. I wonder if it will be fast enought. Let's supose we have 15 PostCSS plugins and 30 css files. It gives 450 require calls each app rebuild ;) But maybe it is still performant. I am not sure.

juliancwirko avatar May 21 '16 22:05 juliancwirko

I'm not sure what makes the most sense, but FYI if you require something with the exact same path, it's a no-op.

tmeasday avatar May 21 '16 22:05 tmeasday

Ok, cool. So I try to rewrite it soon. Thank you :)

juliancwirko avatar May 21 '16 22:05 juliancwirko

@tmeasday one more problem ;) I think that this is implemented only in compiler-plugin.js and not in the minifier-plugin.js

Unfortunatelly I need it in the minifier-plugin.js

juliancwirko avatar May 22 '16 09:05 juliancwirko

any updates on this issue? We're still not able to make a build with Meteor 1.3.5.1 :/

v3rron avatar Jul 30 '16 17:07 v3rron

I can confirm that npm install [email protected] seems to put a bandaid over this problem. @v3rron Try installing [email protected]. This allowed me to build again.

emilbryggare avatar Aug 12 '16 01:08 emilbryggare

This is addressed by https://github.com/juliancwirko/meteor-postcss/pull/32, because it uses another regular NPM package to do importing. This in fact is then just a fancy requirer @tmeasday was talking about.

The issue is that I am observing some random failures to find a node module. Restarting Meteor helps. But it is just unclear why it happens that this package then cannot find it. I do not modify node_modules at all. It is just random.

mitar avatar May 04 '18 07:05 mitar

@mitar ok, I'll test it and release new major version with your changes, thanks!

juliancwirko avatar May 04 '18 12:05 juliancwirko

I'll close it. Feel free to comment here if needed. Thanks!

juliancwirko avatar May 04 '18 15:05 juliancwirko

I think I managed to break this package. Sorry. It worked when I had fork inside packages, but now that it is published, it does not really work. The issue is that @tmeasday's idea does not really work. I made the NPM package print module.paths before require call and you will see why it does not:

[ '/home/mitar/.meteor/packages/juliancwirko_postcss/.2.0.1.1h3wuhm.m6do++os+web.browser+web.cordova/plugin.minifier-postcss.os/npm/node_modules/meteor/minifier-postcss/node_modules/postcss-load-plugins/lib/node_modules',
  '/home/mitar/.meteor/packages/juliancwirko_postcss/.2.0.1.1h3wuhm.m6do++os+web.browser+web.cordova/plugin.minifier-postcss.os/npm/node_modules/meteor/minifier-postcss/node_modules/postcss-load-plugins/node_modules',
  '/home/mitar/.meteor/packages/juliancwirko_postcss/.2.0.1.1h3wuhm.m6do++os+web.browser+web.cordova/plugin.minifier-postcss.os/npm/node_modules/meteor/minifier-postcss/node_modules',
  '/home/mitar/.meteor/packages/juliancwirko_postcss/.2.0.1.1h3wuhm.m6do++os+web.browser+web.cordova/plugin.minifier-postcss.os/npm/node_modules/meteor/node_modules',
  '/home/mitar/.meteor/packages/juliancwirko_postcss/.2.0.1.1h3wuhm.m6do++os+web.browser+web.cordova/plugin.minifier-postcss.os/npm/node_modules',
  '/home/mitar/.meteor/packages/juliancwirko_postcss/.2.0.1.1h3wuhm.m6do++os+web.browser+web.cordova/plugin.minifier-postcss.os/node_modules',
  '/home/mitar/.meteor/packages/juliancwirko_postcss/.2.0.1.1h3wuhm.m6do++os+web.browser+web.cordova/node_modules',
  '/home/mitar/.meteor/packages/juliancwirko_postcss/node_modules',
  '/home/mitar/.meteor/packages/node_modules',
  '/home/mitar/.meteor/node_modules',
  '/home/mitar/node_modules',
  '/home/node_modules',
  '/node_modules' ]

See, search path is from installed module inside home directory, not from inside my package app. So this is why require does not find packages inside node_modules inside the app.

mitar avatar May 05 '18 06:05 mitar