Generic modules in Plugins (bluebird)

---

I just tried to run one of my plugins in 0.9 beta which is running fine on 0.8 but it fails as it can’t load the bluebird promise module.

< 14:42:48.239 [pimatic] Cannot find module 'bluebird'
< 14:42:48.292 [pimatic] Error: Cannot find module 'bluebird'
< 14:42:48.292 [pimatic]>    at Function.Module._resolveFilename (module.js:325:15)
< 14:42:48.292 [pimatic]>    at Function.Module._load (module.js:276:25)
< 14:42:48.292 [pimatic]>    at Module.require (module.js:353:17)
< 14:42:48.292 [pimatic]>    at require (internal/module.js:12:17)
< 14:42:48.292 [pimatic]>    at Object.<anonymous> (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic-orvibo/orvibo-node.js:27:15)
< 14:42:48.292 [pimatic]>    at Module._compile (module.js:409:26)
< 14:42:48.292 [pimatic]>    at Object.Module._extensions..js (module.js:416:10)
< 14:42:48.292 [pimatic]>    at Module.load (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic-mobile-frontend/node_modules/nap/node_modules/coffee-script/lib/coffee-script/register.js:45:36)
< 14:42:48.292 [pimatic]>    at Function.Module._load (module.js:300:12)
< 14:42:48.292 [pimatic]>    at Module.require (module.js:353:17)
< 14:42:48.292 [pimatic]>    at require (internal/module.js:12:17)
< 14:42:48.292 [pimatic]>    at module.exports (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic-orvibo/orvibo.coffee:30:16)
< 14:42:48.292 [pimatic]>    at PluginManager.module.exports.PluginManager.loadPlugin (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic/lib/plugins.coffee:86:16)
< 14:42:48.292 [pimatic]>    at /Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic/lib/plugins.coffee:462:25
< 14:42:48.292 [pimatic]>    at tryCatcher (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic/node_modules/bluebird/js/release/util.js:16:23)
< 14:42:48.292 [pimatic]>    at Promise.module.exports.Promise._settlePromiseFromHandler (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic/node_modules/bluebird/js/release/promise.js:502:31)
< 14:42:48.292 [pimatic]>    at Promise.module.exports.Promise._settlePromise (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic/node_modules/bluebird/js/release/promise.js:559:18)
< 14:42:48.292 [pimatic]>    at Promise.module.exports.Promise._settlePromiseCtx (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic/node_modules/bluebird/js/release/promise.js:596:10)
< 14:42:48.292 [pimatic]>    at Async._drainQueue (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic/node_modules/bluebird/js/release/async.js:143:12)
< 14:42:48.292 [pimatic]>    at Async._drainQueues (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic/node_modules/bluebird/js/release/async.js:148:10)
< 14:42:48.292 [pimatic]>    at Immediate.__dirname.drainQueues [as _onImmediate] (/Users/thex/Dropbox/projects/pimatic/pimatic-beta/node_modules/pimatic/node_modules/bluebird/js/release/async.js:17:14)
< 14:42:48.292 [pimatic]>    at processImmediate [as _immediateCallback] (timers.js:383:17)

It gets loaded via Promise = env.require 'bluebird' just like my netatmo plugin does it which is running fine.

Thus my general question, how should a plugin handle such generic libraries. I don’t want to add it to the npm config, then each plugin would install its own bluebird library…

Ideas? Best practices?

@thex said in Generic modules in Plugins (bluebird):

Ideas? Best practices?

This must be a problem with your pimatic setup. Using “env.require” should work.

EDIT: Unfortunately, your project pimatic-orvibois empty, so it is difficult to tell what is going wrong with your code.

EDIT2: Your netamo plugin v0.0.5 works fine with v0.9. This is also using Promise = env.require 'bluebird'. So, I guess it is bug in your orvibo plugin or your pimatic v0.9 setup is incomplete.

Sorry published the orvibo plugin just now.

In the same pimatic setup netatmo plugin is working fine but orvibo not.

For now I have added bluebird to the dependencies which fixes the “symptoms”. Root cause still not clear to me.

@thex said in Generic modules in Plugins (bluebird):

In the same pimatic setup netatmo plugin is working fine but orvibo not.

Thanks for sharing. Just tried your orvibo plugin which loads fine into my pimatic v0.9 setup. I also have the netatmo plugin loaded. It’s strange why it does not work for you.

@thex I have filed a PR fixing some typos. I noticed that you’re using implicit global variables in orvibo-node.js. You shouldn’t do that as it may have unexpected side effects. Use local variables instead. I haven’t changed this with my PR, howver, as I wasn’t 100% sure about the correct declaration scopes and I am not able to fully test the code without having a device in place.

@thex I think I have found the solution for the problem. In package.json you have defined a dependency on bluebird. If you haven’t fully installed pimatic-orvibo or removed the node_modulesdirectory inside the pimatic-orvibo directory, this raises the error eventhough the package is not required! I have extended my PR and this should get you going. https://github.com/thexperiments/pimatic-orvibo/pull/1

Thanks for the corrections. However as said I added bluebird to package.json after it didn’t work so that npm would install bluebird just for the plugin.

Found the “problem”. I am also using bluebird in the JS part which currently doesn’t have access to env.
Added the dependancy again for now, this way it should work and I currently don’t have the motivation to rewrite it as it is working good and bluebird is pretty lightweight.

Also fixed another bug which would crash pimatic if the network connection drops out. New version is published.

@thex said in Generic modules in Plugins (bluebird):

I currently don’t have the motivation to rewrite it as it is working good and bluebird is pretty lightweight

It is very easy to get rid of this. I have filed a PR for this which also replaces the implicit global decls with local variables.