Let ports know their name and the nodename for easier debugging

CHANGES.md

@@ -1,6 +1,10 @@
 NoFlo ChangeLog
 ===============
 
+## 0.4.2 (git master)
+
+* Easier debugging: port errors now contain the name of the NoFlo graph node and the port
+
 ## 0.4.1 (September 25th 2013)
 
 * NoFlo components can now implement a `shutdown` method which is called when they're removed from a network

spec/Network.coffee

@@ -106,6 +106,15 @@ describe 'NoFlo Network', ->
       chai.expect(n.processes.Merge).to.be.an 'Object'
       chai.expect(n.processes.Callback).to.exist
       chai.expect(n.processes.Callback).to.be.an 'Object'
+    it 'the ports of the processes should know the node names', ->
+      for name, port of n.processes.Callback.component.inPorts
+        chai.expect(port.name).to.equal name
+        chai.expect(port.node).to.equal 'Callback'
+        chai.expect(port.getId()).to.equal "Callback #{name.toUpperCase()}"
+      for name, port of n.processes.Callback.component.outPorts
+        chai.expect(port.name).to.equal name
+        chai.expect(port.node).to.equal 'Callback'
+        chai.expect(port.getId()).to.equal "Callback #{name.toUpperCase()}"
 
     it 'should contain one connection', ->
       chai.expect(n.connections).to.not.be.empty
@@ -129,6 +138,15 @@ describe 'NoFlo Network', ->
         g.renameNode 'Callback', 'Func'
       it 'shouldn\'t have the process in the old location', ->
         chai.expect(n.processes.Callback).to.be.undefined
+      it 'should have informed the ports of their new node name', ->
+        for name, port of n.processes.Func.component.inPorts
+          chai.expect(port.name).to.equal name
+          chai.expect(port.node).to.equal 'Func'
+          chai.expect(port.getId()).to.equal "Func #{name.toUpperCase()}"
+        for name, port of n.processes.Func.component.outPorts
+          chai.expect(port.name).to.equal name
+          chai.expect(port.node).to.equal 'Func'
+          chai.expect(port.getId()).to.equal "Func #{name.toUpperCase()}"
 
   describe "Nodes are added first, then edges, then initializers (i.e. IIPs), and in order of definition order within each", ->
     g = null

spec/Port.coffee

@@ -13,9 +13,22 @@ describe 'Untyped port instance', ->
 
 describe 'Port instance', ->
   p = null
-  it 'should retain the given type', ->
-    p = new port.Port 'string'
-    chai.expect(p.type).to.equal 'string'
+  describe 'initially', ->
+    it 'should retain the given type', ->
+      p = new port.Port 'string'
+      chai.expect(p.type).to.equal 'string'
+    it 'should not have a name', ->
+      chai.expect(p.name).to.be.a 'null'
+    it 'should not have a node name', ->
+      chai.expect(p.node).to.be.a 'null'
+    it 'should return "Port" as identifier', ->
+      chai.expect(p.getId()).to.equal 'Port'
+
+  describe 'with given name and node', ->
+    it 'should return correct ID', ->
+      p.name = 'out'
+      p.node = 'Foo'
+      chai.expect(p.getId()).to.equal 'Foo OUT'
 
   describe 'without attached socket', ->
     it 'should not be attached initially', ->

src/lib/ArrayPort.coffee

@@ -19,26 +19,26 @@ class ArrayPort extends port.Port
   connect: (socketId = null) ->
     if socketId is null
       unless @sockets.length
-        throw new Error "No sockets available"
+        throw new Error "#{@getId()}: No connections available"
       @sockets.forEach (socket) ->
         socket.connect()
       return
 
     unless @sockets[socketId]
-      throw new Error "No socket '#{socketId}' available"
+      throw new Error "#{@getId()}: No connection '#{socketId}' available"
 
     @sockets[socketId].connect()
 
   beginGroup: (group, socketId = null) ->
     if socketId is null
       unless @sockets.length
-        throw new Error "No sockets available"
+        throw new Error "#{@getId()}: No connections available"
       @sockets.forEach (socket, index) =>
         @beginGroup group, index
       return
 
     unless @sockets[socketId]
-      throw new Error "No socket '#{socketId}' available"
+      throw new Error "#{@getId()}: No connection '#{socketId}' available"
 
     return @sockets[socketId].beginGroup group if @isConnected socketId
 
@@ -49,13 +49,13 @@ class ArrayPort extends port.Port
   send: (data, socketId = null) ->
     if socketId is null
       unless @sockets.length
-        throw new Error "No sockets available"
+        throw new Error "#{@getId()}: No connections available"
       @sockets.forEach (socket, index) =>
         @send data, index
       return
 
     unless @sockets[socketId]
-      throw new Error "No socket '#{socketId}' available"
+      throw new Error "#{@getId()}: No connection '#{socketId}' available"
 
     return @sockets[socketId].send data if @isConnected socketId
 
@@ -66,20 +66,20 @@ class ArrayPort extends port.Port
   endGroup: (socketId = null) ->
     if socketId is null
       unless @sockets.length
-        throw new Error "No sockets available"
+        throw new Error "#{@getId()}: No connections available"
       @sockets.forEach (socket, index) =>
         @endGroup index
       return
 
     unless @sockets[socketId]
-      throw new Error "No socket '#{socketId}' available"
+      throw new Error "#{@getId()}: No connection '#{socketId}' available"
 
     do @sockets[socketId].endGroup
 
   disconnect: (socketId = null) ->
     if socketId is null
       unless @sockets.length
-        throw new Error "No sockets available"
+        throw new Error "#{@getId()}: No connections available"
       for socket in @sockets
         socket.disconnect()
       return

src/lib/Network.coffee

@@ -153,6 +153,14 @@ class Network extends EventEmitter
       instance.nodeId = node.id
       process.component = instance
 
+      # Inform the ports of the node name
+      for name, port of process.component.inPorts
+        port.node = node.id
+        port.name = name
+      for name, port of process.component.outPorts
+        port.node = node.id
+        port.name = name
+
       @subscribeSubgraph node.id, instance if instance.isSubgraph()
 
       # Store and return the process instance
@@ -167,7 +175,16 @@ class Network extends EventEmitter
   renameNode: (oldId, newId) ->
     process = @getNode oldId
     return unless process
+
+    # Inform the process of its ID
     process.id = newId
+
+    # Inform the ports of the node name
+    for name, port of process.component.inPorts
+      port.node = newId
+    for name, port of process.component.outPorts
+      port.node = newId
+
     @processes[newId] = process
     delete @processes[oldId]
 

src/lib/Port.coffee

@@ -14,9 +14,16 @@ class Port extends EventEmitter
     @type = 'all' unless @type
     @socket = null
     @from = null
+    @node = null
+    @name = null
+
+  getId: ->
+    unless @node and @name
+      return 'Port'
+    "#{@node} #{@name.toUpperCase()}"
 
   attach: (socket) ->
-    throw new Error "#{@name}: Socket already attached #{@socket.getId()} - #{socket.getId()}" if @isAttached()
+    throw new Error "#{@getId()}: Socket already attached #{@socket.getId()} - #{socket.getId()}" if @isAttached()
     @socket = socket
 
     @attachSocket socket
@@ -38,11 +45,11 @@ class Port extends EventEmitter
       @emit "disconnect", socket, localId
 
   connect: ->
-    throw new Error "No connection available" unless @socket
+    throw new Error "#{@getId()}: No connection available" unless @socket
     do @socket.connect
 
   beginGroup: (group) ->
-    throw new Error "No connection available" unless @socket
+    throw new Error "#{@getId()}: No connection available" unless @socket
 
     return @socket.beginGroup group if @isConnected()
 
@@ -51,7 +58,7 @@ class Port extends EventEmitter
     do @socket.connect
 
   send: (data) ->
-    throw new Error "No connection available" unless @socket
+    throw new Error "#{@getId()}: No connection available" unless @socket
 
     return @socket.send data if @isConnected()
 
@@ -60,11 +67,11 @@ class Port extends EventEmitter
     do @socket.connect
 
   endGroup: ->
-    throw new Error "No connection available" unless @socket
+    throw new Error "#{@getId()}: No connection available" unless @socket
     do @socket.endGroup
 
   disconnect: ->
-    throw new Error "No connection available" unless @socket
+    throw new Error "#{@getId()}: No connection available" unless @socket
     @socket.disconnect()
 
   detach: (socket) ->