Expose Container constructor

[d6u]

So we can use bluebird's Promise.promisifyAll[1*] method like so:

var Promise = require('bluebird')
Promise.promisifyAll(Docker.Container.prototype)

// later on
Docker.createContainer(function(container) {
    container.startAsync().then(function () { ... }); // startAsync is one of the promisified methods
})

1 - https://github.com/petkaantonov/bluebird/blob/master/API.md#promisepromisifyallobject-target--object-options---object

[apocas]

Not sure about this one.

If we going to expose things, it is going to be everything or nothing.
Don't want to create a big mess in terms of usage.

Now, I'm not sure if we should expose them for this use case.

[d6u]

@apocas I updates the request, now it exposes all constructors (let me know if I missed any).

Basically what Promise.promisifyAll will do is to convert traditional node.js callback API to promise API. The the following:

docker.listImages({}, function (err, images) {
  docker.createContainer({}, function (err, container) {
    container.start(function (err) {
      container.exec({}, function(err, exec) {
        exec.start({}, function (err, stream) {
          // ...
        });
      });
    });
  });
});

can becomes:

docker.listImagesAsync()
  .then(function (images) {
    return docker.createContainerAsync();
  })
  .tap(function (container) {
    return container.startAsync();
  })
  .then(function (container) {
    return container.execAsync();
  })
  .then(function (exec) {
    return exec.startAsync()
  })
  .then(function (stream) {
    // ...
  })
  .catch(function () {
    // catch all errors here
  });

which is flat when nesting a lot of callbacks. Without exposing constructors, I am currently doing:

Promise.promisifyAll(Docker.prototype);

var _getContainer = Docker.prototype.getContainer;

Docker.prototype.getContainer = function () {
  var container = _getContainer.apply(this, arguments);
  if (!container.startAsync) {
    Promise.promisifyAll(Object.getPrototypeOf(container));
  }
  return container;
}

[apocas]

Have you checked https://www.npmjs.com/package/dockerode-promise from @lightsofapollo ?

[d6u]

dockerode-promise is nice, but bluebird is more popular and provides more useful API. Do you think it would be more consistent if I create another npm package, like dockerode-promise, to wrap around dockerode?

[apocas]

Yeah exactly.
I would prefer to push that into something to like "dockerode-bluebird" leaving dockerode lighter and focused just on abstracting Docker :)

[d6u]

I see, thanks.

[amitaibu]

@daiweilu I believe the result of this is https://github.com/daiweilu/Dockership , correct?

[d6u]

@amitaibu Not exactly, https://github.com/daiweilu/Dockership/blob/master/lib/promisified/docker-promisified.js is the file that convert Dockerode into promise style.

[amitaibu]

👍

[apocas]

Awesome! There were a few people asking for this 👍

[sheerun]

Please include promise interface into this repository. Promise-wrapping packages quickly become out of date...

[KristerV]

+1 sheerun. Why are callback still a thing...

[nwalters512]

I'd like to second this. All of the "wrapped" versions haven't been updated in over a year. Trying to do anything complex with this quickly leads to callback hell.

[apocas]

I will expose all the constructors to make all of you promise lovers happier :)

I'm not saying that what we have right now leads to a callback hell, I continue to say that really depends on the writer's habits, schools, patterns, taste, ...

Just want Dockerode to be a really good base structure to everyone :)

[apocas]

Here we go:
8585228

Happy to announce that I implemented a promises based interface :)
Please comment and contribute, I really want feedback before even thinking on publishing it.

https://github.com/apocas/dockerode#promises-yet-to-be-published

[sheerun]

Looks fine to me :)

…

On Thu, Mar 2, 2017 at 4:46 AM, Pedro Dias ***@***.***> wrote: Here we go: 8585228 <8585228> Happy to announce that I implemented a promises based interface :) Please comment and contribute, I really want feedback before even thinking on publishing it. https://github.com/apocas/dockerode#promises-yet-to-be-published — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#108 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAR2DbJQteEXFOW7Ue_Sedi_-q1YxUaiks5rhjuhgaJpZM4DB8-P> .

[apocas]

Feedback needed: #339