noflo/spec/OutPort.coffee

Flow-Based Programming environment for JavaScript

if typeof process isnt 'undefined' and process.execPath and process.execPath.match /node|iojs/
  chai = require 'chai' unless chai
  noflo = require '../src/lib/NoFlo.coffee'
else
  noflo = require 'noflo'

describe 'Outport Port', ->
  describe 'with addressable ports', ->
    s1 = s2 = s3 = null
    beforeEach ->
      s1 = new noflo.internalSocket.InternalSocket
      s2 = new noflo.internalSocket.InternalSocket
      s3 = new noflo.internalSocket.InternalSocket

    it 'should be able to send to a specific port', ->
      p = new noflo.OutPort
        addressable: true
      p.attach s1
      p.attach s2
      p.attach s3
      chai.expect(p.listAttached()).to.eql [0, 1, 2]
      s1.on 'data', ->
        chai.expect(true).to.equal false
      s2.on 'data', (data) ->
        chai.expect(data).to.equal 'some-data'
      s3.on 'data', ->
        chai.expect(true).to.equal false
      p.send 'some-data', 1

    it 'should be able to send to index 0', (done) ->
      p = new noflo.OutPort
        addressable: true
      p.attach s1
      s1.on 'data', (data) ->
        chai.expect(data).to.equal 'my-data'
        done()
      p.send 'my-data', 0

    it 'should throw an error when sent data without address', ->
      chai.expect(-> p.send('some-data')).to.throw

    it 'should throw an error when a specific port is requested with non-addressable port', ->
      p = new noflo.OutPort
      p.attach s1
      p.attach s2
      p.attach s3
      chai.expect(-> p.send('some-data', 1)).to.throw

    it 'should give correct port index when detaching a connection', (done) ->
      p = new noflo.OutPort
        addressable: true
      p.attach s1, 3
      p.attach s2, 1
      p.attach s3, 5
      expectedSockets = [s2, s3]
      expected = [1, 5]
      expectedAttached = [
        [3, 5]
        [3]
      ]
      p.on 'detach', (socket, index) ->
        chai.expect(socket).to.equal expectedSockets.shift()
        chai.expect(index).to.equal expected.shift()
        chai.expect(p.isAttached(index)).to.equal false
        atts = expectedAttached.shift()
        chai.expect(p.listAttached()).to.eql atts
        for att in atts
          chai.expect(p.isAttached(att)).to.equal true
        done() unless expected.length
      p.detach s2
      p.detach s3

  describe 'with caching ports', ->
    s1 = s2 = s3 = null
    beforeEach ->
      s1 = new noflo.internalSocket.InternalSocket
      s2 = new noflo.internalSocket.InternalSocket
      s3 = new noflo.internalSocket.InternalSocket

    it 'should repeat the previously sent value on attach event', (done) ->
      p = new noflo.OutPort
        caching: true

      s1.once 'data', (data) ->
        chai.expect(data).to.equal 'foo'

      s2.once 'data', (data) ->
        chai.expect(data).to.equal 'foo'
        # Next value should be different
        s2.once 'data', (data) ->
          chai.expect(data).to.equal 'bar'
          done()

      p.attach s1
      p.send 'foo'
      p.disconnect()

      p.attach s2

      p.send 'bar'
      p.disconnect()


    it 'should support addressable ports', (done) ->
      p = new noflo.OutPort
        addressable: true
        caching: true

      p.attach s1
      p.attach s2

      s1.on 'data', ->
        chai.expect(true).to.equal false
      s2.on 'data', (data) ->
        chai.expect(data).to.equal 'some-data'
      s3.on 'data', (data) ->
        chai.expect(data).to.equal 'some-data'
        done()

      p.send 'some-data', 1
      p.disconnect 1
      p.detach s2
      p.attach s3, 1

  describe 'with IP objects', ->
    s1 = s2 = s3 = null
    beforeEach ->
      s1 = new noflo.internalSocket.InternalSocket
      s2 = new noflo.internalSocket.InternalSocket
      s3 = new noflo.internalSocket.InternalSocket

    it 'should send data IPs and substreams', (done) ->
      p = new noflo.OutPort
      p.attach s1
      expectedEvents = [
        'data'
        'openBracket'
        'data'
        'closeBracket'
      ]
      count = 0
      s1.on 'ip', (data) ->
        count++
        chai.expect(data).to.be.an 'object'
        chai.expect(data.type).to.equal expectedEvents.shift()
        chai.expect(data.data).to.equal 'my-data' if data.type is 'data'
        done() if count is 4
      p.data 'my-data'
      p.openBracket()
      .data 'my-data'
      .closeBracket()

    it 'should send non-clonable objects by reference', (done) ->
      p = new noflo.OutPort
      p.attach s1
      p.attach s2
      p.attach s3

      obj =
        foo: 123
        bar:
          boo: 'baz'
        func: -> this.foo = 456

      s1.on 'ip', (data) ->
        chai.expect(data).to.be.an 'object'
        chai.expect(data.data).to.equal obj
        chai.expect(data.data.func).to.be.a 'function'
        s2.on 'ip', (data) ->
          chai.expect(data).to.be.an 'object'
          chai.expect(data.data).to.equal obj
          chai.expect(data.data.func).to.be.a 'function'
          s3.on 'ip', (data) ->
            chai.expect(data).to.be.an 'object'
            chai.expect(data.data).to.equal obj
            chai.expect(data.data.func).to.be.a 'function'
            done()

      p.data obj,
        clonable: false # default

    it 'should clone clonable objects on fan-out', (done) ->
      p = new noflo.OutPort
      p.attach s1
      p.attach s2
      p.attach s3

      obj =
        foo: 123
        bar:
          boo: 'baz'
        func: -> this.foo = 456

      s1.on 'ip', (data) ->
        chai.expect(data).to.be.an 'object'
        # First send is non-cloning
        chai.expect(data.data).to.equal obj
        chai.expect(data.data.func).to.be.a 'function'
        s2.on 'ip', (data) ->
          chai.expect(data).to.be.an 'object'
          chai.expect(data.data).to.not.equal obj
          chai.expect(data.data.foo).to.equal obj.foo
          chai.expect(data.data.bar).to.eql obj.bar
          chai.expect(data.data.func).to.be.undefined
          s3.on 'ip', (data) ->
            chai.expect(data).to.be.an 'object'
            chai.expect(data.data).to.not.equal obj
            chai.expect(data.data.foo).to.equal obj.foo
            chai.expect(data.data.bar).to.eql obj.bar
            chai.expect(data.data.func).to.be.undefined
            done()

      p.data obj,
        clonable: true