#haraka

hi all, if I want to test making plugins as a package, is that code in the master branch on github?

yes. I haven't tried it though so you're in a bit of a no mans land.

that’s fine

I’m planning on replacing my current private mail setup with haraka and I’m working on a plugin to do auth against mongo

so, haraka can’t load a plugin if the module is installed in the directory created with “haraka -i”

There may be bugs around that.

You may be best off waiting for ultimatt to arrive - he's the one who updated the plugin code to allow for node_modules to work.

(he's US west coast)

sounds good

I’m taking a look at making a patch, but if it’s already done I can wait

well, I made it work…but it’s a real hack job

yo ho ho

quick question on access.domains - how does the parsing work if I have a few blank lines, some # comments, a few lines of domain rules and then repeat the pattern a few times? Does it care about the blanks/comments in the middle of the file (my read of the source says it doesn't)

no, it doesn't

care about blank / empty lines

danke

bitte

ultimatt: are you working on anything to load plugins from modules stored in the node_modules folder of a haraka config directory?

bmonty: no

that could be interesting...rather than stuffing modules into plugin dir

and ~haraka/plugins

that’s what I was thinking

baudehlo mentioned you may have been working on it

what I've added is making haraka/plugins a bit more like npm

in that now haraka/plugins/plugin_name can be a dir instead of a file

ie, haraka/plugins/plugin_name/index.js

and there's an open PR to increase that support, to also look for a package.json file and follow it's directives

so that plugins could be "npm installed"

which I think works better than having Haraka depend on globally installed modules

how do you manage version dependencies?

i’ve been messing around with it

IE, when haraka/package.json expects a newer version?

that’s a horrible hack I came up with

ohhhhhh, you're loading npm modules from Haraka/node_modules

not $GLOBAL_NODE/node_modules

I see

umm, that's better than what I thought you were talking about

bmonty: wouldn't it be a bit less hacky if you used process.env('HARAKA_DIR') instead of process.cwd() ??

possibly, I didn’t know about HARAKA_DIR

Otherwise it looks OK.

well, it's still sorta hacky

as it doesn't have the "npm module awareness"

I'm not sure I follow?

it's only going to work for certain npm modules

I’d like to have it look at packages.json

but making that work is a huge change to the plugin loader

bmonty: exactly

full_paths.push(path.resolve(pp, name) + '/' + name + '.js')

So basically - it requires that the plugin have <plugin_name>.js in it's root to work correctly.

that's a step forward, but it really ought to be doing the same resolution of names as this:

_smf_: yes

Instead of reading index.js or whatever is defined in packages.js

there’s a package for the loader that npm uses

you can depend on it and get the same functionality

actually, I think require is smart enough to use packages.json as well

that sounds promising...

I was just having trouble fooling the plugin loader into believing a plugin exists in the first place

your change helps in that regard

Anyway - having a plugin work correctly from <haraka_install_dir>/node_modules/<package_name> would be pretty nice.

agreed.

bmonty, "here’s a package for the loader that npm uses" <--- got a URL for that?

bmonty: check out the HARAKA_DIR environment variable. It always gets set, so is likely much safer than process.cwd().

ultimatt: https://www.npmjs.com/package/read-package-json

_smf_: I’ll check that out

bmonty: excellent, thanks

ultimatt: but, I don’t think it’s needed

well, the goal here is to make our plugin logic simpler

so that ./plugins or ../node_modules/ will load a npm module

and obey the *same* rules as npm module

the code at the top of plugins._load_and_compile_plugin is the problem I think

which means that within a npm package, we'll honor dir/index.js, or dir/bin.js, or whatever package.json points to

it only looks for a .js file

right, but what if my npm package is foo/bar.js?

I think it could be modified to try for the package.json instead of .js

require knows how to read the package.json

loading the module isn’t really the issue…it’s getting haraka to think the module exists :)

actually, both are issues

if _get_plugin_paths() is modified to add ../node_modules

then the only issue remaining is making sure we follow npm semantics

bmonty/ultimatt: I just checked; bmonty is right. If you do a: var foo = require('./foo') and 'foo' is a directory containing index.js then it reads index.js

_smf_, I know, I made that change.

but what about when the file isn't named index.js, and isn't named package/package.js?

that's when npm module loading will fail

and that's when we want to read package.json and follow the 'bin' directive

or 'main'

basically, obey the same semantics as 'read-package-json'

ultimatt: it's main, not bin.

bin is what npm installes in the bin directory

right

Ok - bmonty is right; require() honours package.json

I've just tried it.

If you create foo/package.json and add main: 'lib/foo.js'

I was just looking for the reference on that

I know I read it earlier today

Then create the necessary directories and file; doing a require('./foo') will read package.json, find main and then load lib/foo.js

excellent

So - it should be as easy as adding ../node_modules/plugin_name to the paths.

And changing the require() to just load the basename without any extension

_load_and_compile_plugin needs some updating to make that work

I tried to load a .js file

it*

and if the file doesn’t exist it throws an error

I’m thinking I could add a check for package.json in the catch block

actually, the haraka path is at process.env.HARAKA

_smf_: doesn’t look like HARAKA_DIR gets defined

ah

ok

and optionally, process.env.HARAKA_PLUGIN_PATH

Ooops - sorry; yeah; process.env('HARAKA');

process.env.HARAKA works

bmonty: in load_and_compile_plugin

You should be able to just change this:

rf = fs.readFileSync(fp[i]);

to

rf = require(fp[i]);

and this: https://github.com/baudehlo/Haraka/pull/1056

And it should still work I think.

right?