heading towards a solid v1.0

[coolaj86]

This is the direction I'm heading:

https://github.com/coolaj86/node-nat-upnp/blob/v1.0/lib/nat-upnp/ssdp.js

• switched from shimmed EventEmitter promise-ish things to proper Promises using global.Promise || require('bluebird').Promise
• pulled the async code out of the constructor (since you can't pass callbacks or return promises from a constructor) and moved it to an init()
• removed mutual dependencies

I plan to switch it to return however many IGDs respond.

[indutny]

I have a different idea. ;)

What if we would use ReadableStream with objectMode: true?

[coolaj86]

I'm not familiar with objectMode, but Promises are a standard part of JavaScript now and they got there because that's what the community wanted and needed.

I've had arguments about the global JSON when it first became a thing, then forEach, then 'use strict'; and now Promise. In the end, standard JavaScript will always win - so I don't want to do a bunch of jiggery-pokery to an EventEmitter type thing when it's not designed to handle the case of promises and we have a standard for it and it can be shimmed easily in platforms that aren't up to date without consequence - just like forEach and JSON back in the day.

I think that Promises have a place and EventEmitters have a place and the right tool should get used for the appropriate job. I feel like for others looking at the code in 6 months or a year when the Promise resistance dies will appreciate that it's clean and concise and not jiggery-poked.

So far the only use I've encountered for EventEmitters in the code is getMappings, because the Google Fiber NetworkBox comes preconfigured with something like 100 port mappings (all for various games and services available in their port-forward dropdown box, all pointing to an empty host string on port 0) and it takes a minute or two to get them all. I won't be surprised if other routers behave similarly, so waiting for the callback feels as though the callback was never called, but it's actually just a really long wait.

[indutny]

It is not that I'm advocating against promises. This thing is technically a stream, there is even a WG proposal for such stuff in ES.

[coolaj86]

I'm misunderstanding then. What's the stream?

The UPnP search is simply 1-to-1 request / response in a single packet with a possibility of an erroneous response (which is highly unlikely and easily filtered - excepting the case of a legitimate malicious device on your home network spoofing as an IGD - but if they had considered that, they wouldn't have used UDP).

The UPnP Port Mapping is, again, 1-to-1. Listing port mapping is also 1-to-1, but occurs potentially a hundred or more times.